SAMLSPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLSPServer class represents a SAML service provider.

Class Name

SecureBlackbox_SAMLSPServer

Procedural Interface

 secureblackbox_samlspserver_open();
 secureblackbox_samlspserver_close($res);
 secureblackbox_samlspserver_register_callback($res, $id, $function);
 secureblackbox_samlspserver_get_last_error($res);
 secureblackbox_samlspserver_get_last_error_code($res);
 secureblackbox_samlspserver_set($res, $id, $index, $value);
 secureblackbox_samlspserver_get($res, $id, $index);
 secureblackbox_samlspserver_do_addidpservice($res, $service, $bindingtype, $location, $priority, $index);
 secureblackbox_samlspserver_do_addspservice($res, $service, $bindingtype, $location, $priority, $index);
 secureblackbox_samlspserver_do_cleanup($res);
 secureblackbox_samlspserver_do_config($res, $configurationstring);
 secureblackbox_samlspserver_do_doaction($res, $actionid, $actionparams);
 secureblackbox_samlspserver_do_dropclient($res, $connectionid, $forced);
 secureblackbox_samlspserver_do_exportsettings($res, $sp);
 secureblackbox_samlspserver_do_getclientbuffer($res, $connectionid, $handle);
 secureblackbox_samlspserver_do_getproviderproperty($res, $name);
 secureblackbox_samlspserver_do_getrequestbytes($res, $connectionid, $requestfilter);
 secureblackbox_samlspserver_do_getrequestheader($res, $connectionid, $headername);
 secureblackbox_samlspserver_do_getresponseheader($res, $connectionid, $headername);
 secureblackbox_samlspserver_do_getsessionproperty($res, $sessionid, $name);
 secureblackbox_samlspserver_do_importsettings($res, $metadata, $sp);
 secureblackbox_samlspserver_do_initiateartifactresolve($res, $connectionid, $sessionid, $idpserviceindex, $artifact, $tag);
 secureblackbox_samlspserver_do_initiateattributequery($res, $connectionid, $sessionid, $idpserviceindex, $nameid, $nameidformat, $attributes, $attrnameformats, $attrfriendlynames, $tag);
 secureblackbox_samlspserver_do_initiateauth($res, $connectionid, $sessionid, $idpserviceindex, $nameidformat, $relaystate, $tag);
 secureblackbox_samlspserver_do_initiatelogout($res, $connectionid, $sessionid, $idpserviceindex, $nameid, $sessionindex, $relaystate, $tag);
 secureblackbox_samlspserver_do_listclients($res);
 secureblackbox_samlspserver_do_pinclient($res, $connectionid);
 secureblackbox_samlspserver_do_processartifact($res, $connectionid, $sessionid, $request, $tag);
 secureblackbox_samlspserver_do_processartifactresolverequest($res, $connectionid, $sessionid, $request, $tag);
 secureblackbox_samlspserver_do_processassertion($res, $connectionid, $sessionid, $request, $tag);
 secureblackbox_samlspserver_do_processgenericrequest($res, $connectionid, $request);
 secureblackbox_samlspserver_do_processlogoutrequest($res, $connectionid, $sessionid, $request, $tag);
 secureblackbox_samlspserver_do_reset($res);
 secureblackbox_samlspserver_do_setclientbuffer($res, $connectionid, $handle, $value);
 secureblackbox_samlspserver_do_setproviderproperty($res, $name, $value);
 secureblackbox_samlspserver_do_setresponseheader($res, $connectionid, $headername, $value);
 secureblackbox_samlspserver_do_setsessionproperty($res, $sessionid, $name, $value);
 secureblackbox_samlspserver_do_start($res);
 secureblackbox_samlspserver_do_stop($res);

Remarks

The Service Provider in the SAML exchange flow represents the web server that receives and accepts authentication assertions issued by the Identity Provider for single sign-on (SSO). Most commonly, an SP server is part of the application responsible for communicating with an Identity Provider to establish the authenticity of application users.

SAMLSPServer provides easy means of integrating the SAML Service Provider functionality into your application. It presents a fully-features SP endpoint with its own HTTP(S) and assertion validation engines.

Please find below a step-by-step guide on setting up your own SAML SP endpoint.

• Register the IdP metadata using the ImportSettings method. Most IDPs let you download their metadata in XML format. The metadata file contains general parameters of the IdP endpoint, such as its web address and algorithm requirements.

  server.ImportSettings(metadataBytes, false); // contains "<?xml version="1.0"?><md:EntityDescriptor ID="ab12" ... </md:EntityDescriptor>";

• Configure the main server capabilities:

  // public server endpoint (use "https://" and/or port 443 if required) server.URL = "http://sp.myapp.com"; server.Port = 80; // IdP triggers this URL to pull metadata server.MetadataURL = '/sp/metadata'; // ACS is th "main" SP endpoint that receives assertions from the IdP server.AssertionConsumerService = '/sp/AssertionConsumerService'; server.SPToIDPBinding = csbtRedirect; // the SP will use HTTP redirect to forward the browser to the IdP when required server.AssertionConsumerServiceBindings = 'POST'; // and we want the IdP to use POST to submit its assertions server.PreferredIDPToSPBinding = csbtPOST; // Single logout service setup server.SingleLogoutService = '/sp/SingleLogoutService'; server.SingleLogoutServiceBindings = 'Redirect,POST,Artifact'; server.LogoutPage = '/sp/logout'; server.RedirectOnLogoutPage = 'https://www.nsoftware.com'; // The document root of the server on the local system server.BaseDir = "D:\\Inetpub\\SAMLSP"; // Security parameters: indicating that we want to sign both // the metadata and the requests server.SignAuthnRequests = true; server.SignMetadata = true; // We need to attach certificates to be able to sign. // Assume we have loaded our signing certificate into // a CertificateManager object. server.SigningCertificate = mgr.Certificate; server.MetaSigningCertificate = mgr.Certificate;

• Personalize the server:

  server.Config("OrganizationName=My Organization Ltd"); server.Config("OrganizationDisplayName=My Organization Pet Supplies"); server.Config("OrganizationURL=http://myorg.com"); server.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256"); server.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); server.Config("WantAssertionsSigned=true");

• Optionally, save metadata to an XML file. This will let you send/upload it to the IdP, so they could set your SP up. Some IdPs can download the metadata right from your SP using the MetadataURL that you've provided above, in which case saving it to a file is not necessary. server.SaveMetadata("my_metadata.xml");

You are now ready to start the server: server.Start(); The server should now be running on the local system, listening to incoming connections on the port that you have specified above (80). Use your browser to check if the server is responding by navigating to the metadata URL (http://127.0.0.1:80/sp/metadata). If the server has been set up right, you should see something like this:

Now let us actually try to use the SAML functionality. Copy an arbitrary file - for example, a recent photo of your cat - to the directory you provided earlier via the BaseDir property (D:\Inetpub\SAMLSP). Having copied the file (suppose it is called clifford.jpg), try to access it in your browser by navigating to http://127.0.0.1:80/clifford.jpg.

This is where SAML kicks in. Since you are not authenticated for the SP server yet (we have just launched it, so no one is), the server redirects your browser to the IdP endpoint for authentication. The address of the IdP is taken from the their_metadata.xml file that you have loaded at the very beginning.

Note: you can configure which resources to restrict access to using the ProtectedResources property. If ProtectedResources is empty, the server considers all the files in BaseDir and its subfolders to be protected.

It is now the IdP services turn to authenticate you. Most IdPs on this stage will present you with a login form. Yet, if you have signed in recently, the IdP may still remember you, in which case it will skip the form and proceed directly to the next step. After establishing and proving your identity, the IdP will generate an assertion, a signed proof that effectively states that the IdP knows who you are and have verified your identity rigorously. Think of the assertion as your unique pass to the resources protected by the SP. The IdP will then submit that assertion back to the SP at its AssertionConsumerService endpoint, again using your browser.

Note that the SP service knows nothing about how IdP authenticates you. All the SP is interested in is an assertion.

If the assertion is well-formed and its signature is valid, the SAML exchange completes. At this point the SP accepts the assertion and creates a session for you. You can now access the resources protected by the SP for as long as the session lasts. If this step succeeds, you should see the photo of your cat in your browser.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Active Property (SecureBlackbox_SAMLSPServer Class)

Tells whether the server is active and ready to process requests.

Object Oriented Interface

public function getActive();

Procedural Interface

secureblackbox_samlspserver_get($res, 1 );

Default Value

false

Remarks

This property indicates whether the IdP server is in an active state.

This property is read-only and not available at design time.

Data Type

Boolean

BaseDir Property (SecureBlackbox_SAMLSPServer Class)

Base directory on the server.

Object Oriented Interface

public function getBaseDir();
public function setBaseDir($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 2 );
secureblackbox_samlspserver_set($res, 2, $value );

Default Value

''

Remarks

Use this property to specify the base directory for the SP server.

Data Type

String

BindingKeyHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getBindingKeyHandle();
public function setBindingKeyHandle($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 8 );
secureblackbox_samlspserver_set($res, 8, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

BindingKeyKey Property (SecureBlackbox_SAMLSPServer Class)

The byte array representation of the key.

Object Oriented Interface

public function getBindingKeyKey();

Procedural Interface

secureblackbox_samlspserver_get($res, 11 );

Remarks

The byte array representation of the key. This may not be available for non-BindingKeyExportable keys.

This property is read-only and not available at design time.

Data Type

Byte Array

DecryptionCertBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getDecryptionCertBytes();

Procedural Interface

secureblackbox_samlspserver_get($res, 18 );

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

DecryptionCertHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getDecryptionCertHandle();
public function setDecryptionCertHandle($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 26 );
secureblackbox_samlspserver_set($res, 26, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_SAMLSPServer Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();
public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 57 );
secureblackbox_samlspserver_set($res, 57, $value );

Default Value

''

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_SAMLSPServer Class)

Custom parameters to be passed to the signing service (uninterpreted).

Object Oriented Interface

public function getExternalCryptoCustomParams();
public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 58 );
secureblackbox_samlspserver_set($res, 58, $value );

Default Value

''

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SecureBlackbox_SAMLSPServer Class)

Additional data to be included in the async state and mirrored back by the requestor.

Object Oriented Interface

public function getExternalCryptoData();
public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 59 );
secureblackbox_samlspserver_set($res, 59, $value );

Default Value

''

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();
public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 60 );
secureblackbox_samlspserver_set($res, 60, $value );

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_SAMLSPServer Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();
public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 61 );
secureblackbox_samlspserver_set($res, 61, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_SAMLSPServer Class)

The ID of the pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeyID();
public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 62 );
secureblackbox_samlspserver_set($res, 62, $value );

Default Value

''

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SecureBlackbox_SAMLSPServer Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();
public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 63 );
secureblackbox_samlspserver_set($res, 63, $value );

Default Value

''

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SecureBlackbox_SAMLSPServer Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();
public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 64 );
secureblackbox_samlspserver_set($res, 64, $value );

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_SAMLSPServer Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();
public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 65 );
secureblackbox_samlspserver_set($res, 65, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_SAMLSPServer Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();
public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 66 );
secureblackbox_samlspserver_set($res, 66, $value );

Default Value

''

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (SecureBlackbox_SAMLSPServer Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 67 );
secureblackbox_samlspserver_set($res, 67, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HandshakeTimeout Property (SecureBlackbox_SAMLSPServer Class)

Specifies the handshake timeout in milliseconds.

Object Oriented Interface

public function getHandshakeTimeout();
public function setHandshakeTimeout($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 68 );
secureblackbox_samlspserver_set($res, 68, $value );

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

Host Property (SecureBlackbox_SAMLSPServer Class)

Specifies the host address of the SP server.

Object Oriented Interface

public function getHost();
public function setHost($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 69 );
secureblackbox_samlspserver_set($res, 69, $value );

Default Value

''

Remarks

Use this property to specify the IP address on which to listen to incoming connections. To specify the listening port number, use Port.

Data Type

String

IdPServiceCount Property (SecureBlackbox_SAMLSPServer Class)

The number of records in the IdPService arrays.

Object Oriented Interface

public function getIdPServiceCount();

Procedural Interface

secureblackbox_samlspserver_get($res, 70 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• IdPServiceBindingType
• IdPServiceEntityID
• IdPServiceLocation
• IdPServicePriority
• IdPServiceService
• IdPServiceServiceIndex

The array indices start at 0 and end at IdPServiceCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

IdPServiceBindingType Property (SecureBlackbox_SAMLSPServer Class)

Specifies the type of SAML binding that this endpoint accepts.

Object Oriented Interface

public function getIdPServiceBindingType($idpserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 71 , $idpserviceindex);

Default Value

0

Remarks

Specifies the type of SAML binding that this endpoint accepts.

Use this property to specify the binding type to use with this endpoint.

The $idpserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

IdPServiceEntityID Property (SecureBlackbox_SAMLSPServer Class)

Represents the SAML entity ID.

Object Oriented Interface

public function getIdPServiceEntityID($idpserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 72 , $idpserviceindex);

Default Value

''

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

The $idpserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only and not available at design time.

Data Type

String

IdPServiceLocation Property (SecureBlackbox_SAMLSPServer Class)

The location (URL) of the endpoint.

Object Oriented Interface

public function getIdPServiceLocation($idpserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 73 , $idpserviceindex);

Default Value

''

Remarks

The location (URL) of the endpoint.

The $idpserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only and not available at design time.

Data Type

String

IdPServicePriority Property (SecureBlackbox_SAMLSPServer Class)

The priority of the endpoint in relation to other endpoints with the same Location .

Object Oriented Interface

public function getIdPServicePriority($idpserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 74 , $idpserviceindex);

Default Value

-1

Remarks

The priority of the endpoint in relation to other endpoints with the same IdPLocation.

Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.

Leave all priorities at -1 to omit generation of the Default attribute.

The $idpserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

IdPServiceService Property (SecureBlackbox_SAMLSPServer Class)

The kind of the service being provided at this endpoint.

Object Oriented Interface

public function getIdPServiceService($idpserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 75 , $idpserviceindex);

Default Value

0

Remarks

The kind of the service being provided at this endpoint.

The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService.

The $idpserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

IdPServiceServiceIndex Property (SecureBlackbox_SAMLSPServer Class)

The index of this endpoint.

Object Oriented Interface

public function getIdPServiceServiceIndex($idpserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 76 , $idpserviceindex);

Default Value

0

Remarks

The index of this endpoint.

For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.

The $idpserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

IdPContactPerson Property (SecureBlackbox_SAMLSPServer Class)

The contact person or persons for the entity.

Object Oriented Interface

public function getIdPContactPerson();
public function setIdPContactPerson($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 77 );
secureblackbox_samlspserver_set($res, 77, $value );

Default Value

''

Remarks

The contact person or persons for the entity.

SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.

Each record contains a semicolon-separated list of contact person parameters, for example:

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678

You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.

This property is not available at design time.

Data Type

String

IdPEncryptionKey Property (SecureBlackbox_SAMLSPServer Class)

Contains the entity's encryption key.

Object Oriented Interface

public function getIdPEncryptionKey();
public function setIdPEncryptionKey($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 78 );
secureblackbox_samlspserver_set($res, 78, $value );

Default Value

''

Remarks

Contains the entity's encryption key.

This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).

Requests sent to the endpoint can be encrypted with the provided key or certificate.

This property is not available at design time.

Data Type

String

IdPEncryptionMethods Property (SecureBlackbox_SAMLSPServer Class)

Specifies the list of encryption methods supported by the entity.

Object Oriented Interface

public function getIdPEncryptionMethods();
public function setIdPEncryptionMethods($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 79 );
secureblackbox_samlspserver_set($res, 79, $value );

Default Value

''

Remarks

Specifies the list of encryption methods supported by the entity.

This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.

Examples of algorithms supported by this property:

• http://www.w3.org/2009/xmlenc11#aes128-gcm
• http://www.w3.org/2001/04/xmlenc#aes256-cbc

This property is not available at design time.

Data Type

String

IdPEntityID Property (SecureBlackbox_SAMLSPServer Class)

Represents the SAML entity ID.

Object Oriented Interface

public function getIdPEntityID();
public function setIdPEntityID($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 80 );
secureblackbox_samlspserver_set($res, 80, $value );

Default Value

''

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

This property is not available at design time.

Data Type

String

IdPFlags Property (SecureBlackbox_SAMLSPServer Class)

Adjusts secondary entity properties.

Object Oriented Interface

public function getIdPFlags();
public function setIdPFlags($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 81 );
secureblackbox_samlspserver_set($res, 81, $value );

Default Value

0

Remarks

Adjusts secondary entity properties.

Use this bit mask property to adjust certain secondary settings. The following flags are supported:

• 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in.

This property is not available at design time.

Data Type

Integer

IdPIdPSSOLink Property (SecureBlackbox_SAMLSPServer Class)

Contains a local server page link that triggers SAML authentication to the SP.

Object Oriented Interface

public function getIdPIdPSSOLink();
public function setIdPIdPSSOLink($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 82 );
secureblackbox_samlspserver_set($res, 82, $value );

Default Value

''

Remarks

Contains a local server page link that triggers SAML authentication to the SP.

This property specifies the web link that initiates the transfer of SAML authentication fact to the SP.

One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider.

This property is not available at design time.

Data Type

String

IdPNameIDFormats Property (SecureBlackbox_SAMLSPServer Class)

The list of NameID formats supported by this entity.

Object Oriented Interface

public function getIdPNameIDFormats();
public function setIdPNameIDFormats($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 83 );
secureblackbox_samlspserver_set($res, 83, $value );

Default Value

''

Remarks

The list of NameID formats supported by this entity.

Use this setting to get or set the list of NameID formats supported by the entity.

Use SAML notation for the formats:

• urn:oasis:names:tc:SAML:2.0:nameid-format:transient
• urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
• urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

This property is not available at design time.

Data Type

String

IdPOrganizationDisplayName Property (SecureBlackbox_SAMLSPServer Class)

The friendly name of the organization that maintains the entity.

Object Oriented Interface

public function getIdPOrganizationDisplayName();
public function setIdPOrganizationDisplayName($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 84 );
secureblackbox_samlspserver_set($res, 84, $value );

Default Value

''

Remarks

The friendly name of the organization that maintains the entity.

Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.

This property is not available at design time.

Data Type

String

IdPOrganizationLang Property (SecureBlackbox_SAMLSPServer Class)

The language preferred by the organization.

Object Oriented Interface

public function getIdPOrganizationLang();
public function setIdPOrganizationLang($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 85 );
secureblackbox_samlspserver_set($res, 85, $value );

Default Value

''

Remarks

The language preferred by the organization.

This optional setting can be used to adjust the preferred language of the owning organization.

This property is not available at design time.

Data Type

String

IdPOrganizationName Property (SecureBlackbox_SAMLSPServer Class)

The name of the organization that maintains the entity.

Object Oriented Interface

public function getIdPOrganizationName();
public function setIdPOrganizationName($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 86 );
secureblackbox_samlspserver_set($res, 86, $value );

Default Value

''

Remarks

The name of the organization that maintains the entity.

Use this setting to get or set the name of the organization that maintains the SAML entity.

This property is not available at design time.

Data Type

String

IdPOrganizationURL Property (SecureBlackbox_SAMLSPServer Class)

The web URL of the organization that maintains the entity.

Object Oriented Interface

public function getIdPOrganizationURL();
public function setIdPOrganizationURL($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 87 );
secureblackbox_samlspserver_set($res, 87, $value );

Default Value

''

Remarks

The web URL of the organization that maintains the entity.

Use this setting to get or set the web address of the organization responsible for this SAML entity.

This property is not available at design time.

Data Type

String

IdPSignatureValidationResult Property (SecureBlackbox_SAMLSPServer Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getIdPSignatureValidationResult();

Procedural Interface

secureblackbox_samlspserver_get($res, 88 );

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only and not available at design time.

Data Type

Integer

IdPSigned Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether the SAML entity information is or should be signed.

Object Oriented Interface

public function getIdPSigned();

Procedural Interface

secureblackbox_samlspserver_get($res, 89 );

Default Value

false

Remarks

Specifies whether the SAML entity information is or should be signed.

Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.

This property is read-only and not available at design time.

Data Type

Boolean

IdPSignedWith Property (SecureBlackbox_SAMLSPServer Class)

Contains the certificate or key that was used to sign the settings (metadata) document.

Object Oriented Interface

public function getIdPSignedWith();

Procedural Interface

secureblackbox_samlspserver_get($res, 90 );

Default Value

''

Remarks

Contains the certificate or key that was used to sign the settings (metadata) document.

This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.

The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the IdPSignatureValidationResult setting.

This property is read-only and not available at design time.

Data Type

String

IdPSigningKey Property (SecureBlackbox_SAMLSPServer Class)

Contains the entity's signing key.

Object Oriented Interface

public function getIdPSigningKey();
public function setIdPSigningKey($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 91 );
secureblackbox_samlspserver_set($res, 91, $value );

Default Value

''

Remarks

Contains the entity's signing key.

This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key.

The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates.

This property is not available at design time.

Data Type

String

IdPValidUntil Property (SecureBlackbox_SAMLSPServer Class)

Specifies the expiration time of the SAML entity information.

Object Oriented Interface

public function getIdPValidUntil();
public function setIdPValidUntil($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 92 );
secureblackbox_samlspserver_set($res, 92, $value );

Default Value

''

Remarks

Specifies the expiration time of the SAML entity information.

This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.

This property is not available at design time.

Data Type

String

Issuer Property (SecureBlackbox_SAMLSPServer Class)

Name identifier of the issuer of the SP's requests.

Object Oriented Interface

public function getIssuer();
public function setIssuer($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 93 );
secureblackbox_samlspserver_set($res, 93, $value );

Default Value

''

Remarks

Use this property to set the name identifier of this Service Provider (SP) to be used in its requests.

Data Type

String

KnownCertCount Property (SecureBlackbox_SAMLSPServer Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();
public function setKnownCertCount($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 94 );
secureblackbox_samlspserver_set($res, 94, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

The array indices start at 0 and end at KnownCertCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 95 , $knowncertindex);

Remarks

Returns the raw certificate data in DER format.

The $knowncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCertHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getKnownCertHandle($knowncertindex);
public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface

secureblackbox_samlspserver_get($res, 103 , $knowncertindex);
secureblackbox_samlspserver_set($res, 103, $value , $knowncertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $knowncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

KnownKeyCount Property (SecureBlackbox_SAMLSPServer Class)

The number of records in the KnownKey arrays.

Object Oriented Interface

public function getKnownKeyCount();
public function setKnownKeyCount($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 134 );
secureblackbox_samlspserver_set($res, 134, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownKeyHandle

The array indices start at 0 and end at KnownKeyCount - 1.

This property is not available at design time.

Data Type

Integer

KnownKeyHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getKnownKeyHandle($knownkeyindex);
public function setKnownKeyHandle($knownkeyindex, $value);

Procedural Interface

secureblackbox_samlspserver_get($res, 140 , $knownkeyindex);
secureblackbox_samlspserver_set($res, 140, $value , $knownkeyindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $knownkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownKeyCount property.

This property is not available at design time.

Data Type

Long64

LogoutPage Property (SecureBlackbox_SAMLSPServer Class)

Specifies the location of the logout page.

Object Oriented Interface

public function getLogoutPage();
public function setLogoutPage($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 150 );
secureblackbox_samlspserver_set($res, 150, $value );

Default Value

'/sp/logout'

Remarks

Use this property to specify the relative URL of the logout page.

Data Type

String

MetadataURL Property (SecureBlackbox_SAMLSPServer Class)

The SP's metadata location.

Object Oriented Interface

public function getMetadataURL();
public function setMetadataURL($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 151 );
secureblackbox_samlspserver_set($res, 151, $value );

Default Value

'/sp/metadata'

Remarks

This property specifies the metadata URL of this Service Provider (SP).

Data Type

String

MetaSigningCertBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getMetaSigningCertBytes();

Procedural Interface

secureblackbox_samlspserver_get($res, 152 );

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

MetaSigningCertHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getMetaSigningCertHandle();
public function setMetaSigningCertHandle($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 160 );
secureblackbox_samlspserver_set($res, 160, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

OfflineMode Property (SecureBlackbox_SAMLSPServer Class)

Enables the Offline mode.

Object Oriented Interface

public function getOfflineMode();
public function setOfflineMode($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 191 );
secureblackbox_samlspserver_set($res, 191, $value );

Default Value

true

Remarks

In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be relayed by the application via calls to ProcessAssertion, ProcessLogoutRequest ProcessArtifactResolveRequest, and other similar methods.

The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML traffic.

Data Type

Boolean

PinnedClientAEADCipher Property (SecureBlackbox_SAMLSPServer Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Object Oriented Interface

public function getPinnedClientAEADCipher();

Procedural Interface

secureblackbox_samlspserver_get($res, 192 );

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientChainValidationDetails Property (SecureBlackbox_SAMLSPServer Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getPinnedClientChainValidationDetails();

Procedural Interface

secureblackbox_samlspserver_get($res, 193 );

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientChainValidationResult Property (SecureBlackbox_SAMLSPServer Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getPinnedClientChainValidationResult();

Procedural Interface

secureblackbox_samlspserver_get($res, 194 );

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientCiphersuite Property (SecureBlackbox_SAMLSPServer Class)

The cipher suite employed by this connection.

Object Oriented Interface

public function getPinnedClientCiphersuite();

Procedural Interface

secureblackbox_samlspserver_get($res, 195 );

Default Value

''

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientClientAuthenticated Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getPinnedClientClientAuthenticated();

Procedural Interface

secureblackbox_samlspserver_get($res, 196 );

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientClientAuthRequested Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether client authentication was requested during this connection.

Object Oriented Interface

public function getPinnedClientClientAuthRequested();

Procedural Interface

secureblackbox_samlspserver_get($res, 197 );

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientConnectionEstablished Property (SecureBlackbox_SAMLSPServer Class)

Indicates whether the connection has been established fully.

Object Oriented Interface

public function getPinnedClientConnectionEstablished();

Procedural Interface

secureblackbox_samlspserver_get($res, 198 );

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientConnectionID Property (SecureBlackbox_SAMLSPServer Class)

The unique identifier assigned to this connection.

Object Oriented Interface

public function getPinnedClientConnectionID();

Procedural Interface

secureblackbox_samlspserver_get($res, 199 );

Remarks

The unique identifier assigned to this connection.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientDigestAlgorithm Property (SecureBlackbox_SAMLSPServer Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getPinnedClientDigestAlgorithm();

Procedural Interface

secureblackbox_samlspserver_get($res, 200 );

Default Value

''

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientEncryptionAlgorithm Property (SecureBlackbox_SAMLSPServer Class)

The symmetric encryption algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getPinnedClientEncryptionAlgorithm();

Procedural Interface

secureblackbox_samlspserver_get($res, 201 );

Default Value

''

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientExportable Property (SecureBlackbox_SAMLSPServer Class)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Object Oriented Interface

public function getPinnedClientExportable();

Procedural Interface

secureblackbox_samlspserver_get($res, 202 );

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientID Property (SecureBlackbox_SAMLSPServer Class)

The client connection's unique identifier.

Object Oriented Interface

public function getPinnedClientID();

Procedural Interface

secureblackbox_samlspserver_get($res, 203 );

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

This property is read-only and not available at design time.

Data Type

Long64

PinnedClientKeyExchangeAlgorithm Property (SecureBlackbox_SAMLSPServer Class)

The key exchange algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getPinnedClientKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_samlspserver_get($res, 204 );

Default Value

''

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientKeyExchangeKeyBits Property (SecureBlackbox_SAMLSPServer Class)

The length of the key exchange key of a TLS-enabled connection.

Object Oriented Interface

public function getPinnedClientKeyExchangeKeyBits();

Procedural Interface

secureblackbox_samlspserver_get($res, 205 );

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientNamedECCurve Property (SecureBlackbox_SAMLSPServer Class)

The elliptic curve used in this connection.

Object Oriented Interface

public function getPinnedClientNamedECCurve();

Procedural Interface

secureblackbox_samlspserver_get($res, 206 );

Default Value

''

Remarks

The elliptic curve used in this connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientPFSCipher Property (SecureBlackbox_SAMLSPServer Class)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Object Oriented Interface

public function getPinnedClientPFSCipher();

Procedural Interface

secureblackbox_samlspserver_get($res, 207 );

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientPreSharedIdentity Property (SecureBlackbox_SAMLSPServer Class)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Object Oriented Interface

public function getPinnedClientPreSharedIdentity();

Procedural Interface

secureblackbox_samlspserver_get($res, 208 );

Default Value

''

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is read-only and not available at design time.

Data Type

String

PinnedClientPreSharedIdentityHint Property (SecureBlackbox_SAMLSPServer Class)

A hint professed by the server to help the client select the PSK identity to use.

Object Oriented Interface

public function getPinnedClientPreSharedIdentityHint();

Procedural Interface

secureblackbox_samlspserver_get($res, 209 );

Default Value

''

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only and not available at design time.

Data Type

String

PinnedClientPublicKeyBits Property (SecureBlackbox_SAMLSPServer Class)

The length of the public key.

Object Oriented Interface

public function getPinnedClientPublicKeyBits();

Procedural Interface

secureblackbox_samlspserver_get($res, 210 );

Default Value

0

Remarks

The length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientRemoteAddress Property (SecureBlackbox_SAMLSPServer Class)

The client's IP address.

Object Oriented Interface

public function getPinnedClientRemoteAddress();

Procedural Interface

secureblackbox_samlspserver_get($res, 211 );

Default Value

''

Remarks

The client's IP address.

This property is read-only and not available at design time.

Data Type

String

PinnedClientRemotePort Property (SecureBlackbox_SAMLSPServer Class)

The remote port of the client connection.

Object Oriented Interface

public function getPinnedClientRemotePort();

Procedural Interface

secureblackbox_samlspserver_get($res, 212 );

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientResumedSession Property (SecureBlackbox_SAMLSPServer Class)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Object Oriented Interface

public function getPinnedClientResumedSession();

Procedural Interface

secureblackbox_samlspserver_get($res, 213 );

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientSecureConnection Property (SecureBlackbox_SAMLSPServer Class)

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getPinnedClientSecureConnection();

Procedural Interface

secureblackbox_samlspserver_get($res, 214 );

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientServerAuthenticated Property (SecureBlackbox_SAMLSPServer Class)

Indicates whether server authentication was performed during a TLS-enabled connection.

Object Oriented Interface

public function getPinnedClientServerAuthenticated();

Procedural Interface

secureblackbox_samlspserver_get($res, 215 );

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientSignatureAlgorithm Property (SecureBlackbox_SAMLSPServer Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getPinnedClientSignatureAlgorithm();

Procedural Interface

secureblackbox_samlspserver_get($res, 216 );

Default Value

''

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only and not available at design time.

Data Type

String

PinnedClientSymmetricBlockSize Property (SecureBlackbox_SAMLSPServer Class)

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getPinnedClientSymmetricBlockSize();

Procedural Interface

secureblackbox_samlspserver_get($res, 217 );

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientSymmetricKeyBits Property (SecureBlackbox_SAMLSPServer Class)

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getPinnedClientSymmetricKeyBits();

Procedural Interface

secureblackbox_samlspserver_get($res, 218 );

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientTotalBytesReceived Property (SecureBlackbox_SAMLSPServer Class)

The total number of bytes received over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesReceived();

Procedural Interface

secureblackbox_samlspserver_get($res, 219 );

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only and not available at design time.

Data Type

Long64

PinnedClientTotalBytesSent Property (SecureBlackbox_SAMLSPServer Class)

The total number of bytes sent over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesSent();

Procedural Interface

secureblackbox_samlspserver_get($res, 220 );

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only and not available at design time.

Data Type

Long64

PinnedClientValidationLog Property (SecureBlackbox_SAMLSPServer Class)

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getPinnedClientValidationLog();

Procedural Interface

secureblackbox_samlspserver_get($res, 221 );

Default Value

''

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only and not available at design time.

Data Type

String

PinnedClientVersion Property (SecureBlackbox_SAMLSPServer Class)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Object Oriented Interface

public function getPinnedClientVersion();

Procedural Interface

secureblackbox_samlspserver_get($res, 222 );

Default Value

''

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertCount Property (SecureBlackbox_SAMLSPServer Class)

The number of records in the PinnedClientCert arrays.

Object Oriented Interface

public function getPinnedClientCertCount();

Procedural Interface

secureblackbox_samlspserver_get($res, 223 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedClientCertBytes
• PinnedClientCertCAKeyID
• PinnedClientCertFingerprint
• PinnedClientCertHandle
• PinnedClientCertIssuer
• PinnedClientCertIssuerRDN
• PinnedClientCertKeyAlgorithm
• PinnedClientCertKeyBits
• PinnedClientCertKeyFingerprint
• PinnedClientCertKeyUsage
• PinnedClientCertPublicKeyBytes
• PinnedClientCertSelfSigned
• PinnedClientCertSerialNumber
• PinnedClientCertSigAlgorithm
• PinnedClientCertSubject
• PinnedClientCertSubjectKeyID
• PinnedClientCertSubjectRDN
• PinnedClientCertValidFrom
• PinnedClientCertValidTo

The array indices start at 0 and end at PinnedClientCertCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientCertBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getPinnedClientCertBytes($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 224 , $pinnedclientcertindex);

Remarks

Returns the raw certificate data in DER format.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertCAKeyID Property (SecureBlackbox_SAMLSPServer Class)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Object Oriented Interface

public function getPinnedClientCertCAKeyID($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 226 , $pinnedclientcertindex);

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the PinnedClientCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertFingerprint Property (SecureBlackbox_SAMLSPServer Class)

Contains the fingerprint (a hash imprint) of this certificate.

Object Oriented Interface

public function getPinnedClientCertFingerprint($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 230 , $pinnedclientcertindex);

Default Value

''

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getPinnedClientCertHandle($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 232 , $pinnedclientcertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Long64

PinnedClientCertIssuer Property (SecureBlackbox_SAMLSPServer Class)

The common name of the certificate issuer (CA), typically a company name.

Object Oriented Interface

public function getPinnedClientCertIssuer($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 234 , $pinnedclientcertindex);

Default Value

''

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via PinnedClientCertIssuerRDN.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertIssuerRDN Property (SecureBlackbox_SAMLSPServer Class)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Object Oriented Interface

public function getPinnedClientCertIssuerRDN($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 235 , $pinnedclientcertindex);

Default Value

''

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertKeyAlgorithm Property (SecureBlackbox_SAMLSPServer Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getPinnedClientCertKeyAlgorithm($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 236 , $pinnedclientcertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the PinnedClientCertKeyBits, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes properties to get more details about the key the certificate contains.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertKeyBits Property (SecureBlackbox_SAMLSPServer Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getPinnedClientCertKeyBits($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 237 , $pinnedclientcertindex);

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PinnedClientCertPublicKeyBytes or PinnedClientCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientCertKeyFingerprint Property (SecureBlackbox_SAMLSPServer Class)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Object Oriented Interface

public function getPinnedClientCertKeyFingerprint($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 238 , $pinnedclientcertindex);

Default Value

''

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the PinnedClientCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertKeyUsage Property (SecureBlackbox_SAMLSPServer Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Object Oriented Interface

public function getPinnedClientCertKeyUsage($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 239 , $pinnedclientcertindex);

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Integer

PinnedClientCertPublicKeyBytes Property (SecureBlackbox_SAMLSPServer Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getPinnedClientCertPublicKeyBytes($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 248 , $pinnedclientcertindex);

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertSelfSigned Property (SecureBlackbox_SAMLSPServer Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Object Oriented Interface

public function getPinnedClientCertSelfSigned($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 252 , $pinnedclientcertindex);

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedClientCertSerialNumber Property (SecureBlackbox_SAMLSPServer Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getPinnedClientCertSerialNumber($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 253 , $pinnedclientcertindex);

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertSigAlgorithm Property (SecureBlackbox_SAMLSPServer Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Object Oriented Interface

public function getPinnedClientCertSigAlgorithm($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 254 , $pinnedclientcertindex);

Default Value

''

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertSubject Property (SecureBlackbox_SAMLSPServer Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Object Oriented Interface

public function getPinnedClientCertSubject($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 256 , $pinnedclientcertindex);

Default Value

''

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via PinnedClientCertSubjectRDN.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertSubjectKeyID Property (SecureBlackbox_SAMLSPServer Class)

Contains a unique identifier of the certificate's cryptographic key.

Object Oriented Interface

public function getPinnedClientCertSubjectKeyID($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 258 , $pinnedclientcertindex);

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The PinnedClientCertSubjectKeyID and PinnedClientCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedClientCertSubjectRDN Property (SecureBlackbox_SAMLSPServer Class)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Object Oriented Interface

public function getPinnedClientCertSubjectRDN($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 259 , $pinnedclientcertindex);

Default Value

''

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertValidFrom Property (SecureBlackbox_SAMLSPServer Class)

The time point at which the certificate becomes valid, in UTC.

Object Oriented Interface

public function getPinnedClientCertValidFrom($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 261 , $pinnedclientcertindex);

Default Value

''

Remarks

The time point at which the certificate becomes valid, in UTC.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

PinnedClientCertValidTo Property (SecureBlackbox_SAMLSPServer Class)

The time point at which the certificate expires, in UTC.

Object Oriented Interface

public function getPinnedClientCertValidTo($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 262 , $pinnedclientcertindex);

Default Value

''

Remarks

The time point at which the certificate expires, in UTC.

The $pinnedclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only and not available at design time.

Data Type

String

Port Property (SecureBlackbox_SAMLSPServer Class)

Specifies the listening port number.

Object Oriented Interface

public function getPort();
public function setPort($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 263 );
secureblackbox_samlspserver_set($res, 263, $value );

Default Value

80

Remarks

Use this property to specify the port number on which the SP server should listen for incoming connections. To specify the server's IP address use Host.

Data Type

Integer

ProtectedResources Property (SecureBlackbox_SAMLSPServer Class)

Specifies the list of protected resources.

Object Oriented Interface

public function getProtectedResources();
public function setProtectedResources($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 264 );
secureblackbox_samlspserver_set($res, 264, $value );

Default Value

''

Remarks

This property contains a set of relative URLs of the protected resources offered by this Service Provider (SP).

Data Type

String

RedirectOnLogoutPage Property (SecureBlackbox_SAMLSPServer Class)

Specifies the location to redirect the user on logout.

Object Oriented Interface

public function getRedirectOnLogoutPage();
public function setRedirectOnLogoutPage($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 265 );
secureblackbox_samlspserver_set($res, 265, $value );

Default Value

'https://nsoftware.com'

Remarks

Use this property to specify the page where to redirect the user on logout.

Data Type

String

SecurityCanonicalizationMethod Property (SecureBlackbox_SAMLSPServer Class)

The canonicalization method to use in the signature.

Object Oriented Interface

public function getSecurityCanonicalizationMethod();
public function setSecurityCanonicalizationMethod($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 266 );
secureblackbox_samlspserver_set($res, 266, $value );

Default Value

''

Remarks

The canonicalization method to use in the signature.

The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)

This property is not available at design time.

Data Type

String

SecurityDigestMethod Property (SecureBlackbox_SAMLSPServer Class)

The digest method to use.

Object Oriented Interface

public function getSecurityDigestMethod();
public function setSecurityDigestMethod($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 267 );
secureblackbox_samlspserver_set($res, 267, $value );

Default Value

''

Remarks

The digest method to use.

The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.

This property is not available at design time.

Data Type

String

SecurityEncryptionMethod Property (SecureBlackbox_SAMLSPServer Class)

The encryption method used to encrypt the assertion.

Object Oriented Interface

public function getSecurityEncryptionMethod();
public function setSecurityEncryptionMethod($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 268 );
secureblackbox_samlspserver_set($res, 268, $value );

Default Value

'AES256'

Remarks

The encryption method used to encrypt the assertion.

This property contains the encryption algorithm used to encrypt the XML assertion.

Supported values:

This property is not available at design time.

Data Type

String

SecurityFlags Property (SecureBlackbox_SAMLSPServer Class)

Provides access to secondary security parameters and tweaks.

Object Oriented Interface

public function getSecurityFlags();
public function setSecurityFlags($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 269 );
secureblackbox_samlspserver_set($res, 269, $value );

Default Value

1

Remarks

Provides access to secondary security parameters and tweaks.

This property is a bitwise combination of zero or more flags. The following flags are currently supported: The following flags can be used with any SAML component (although they may not apply in all modes of use):

This property is not available at design time.

Data Type

Integer

SecuritySigMethod Property (SecureBlackbox_SAMLSPServer Class)

The signature method to use.

Object Oriented Interface

public function getSecuritySigMethod();
public function setSecuritySigMethod($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 270 );
secureblackbox_samlspserver_set($res, 270, $value );

Default Value

''

Remarks

The signature method to use.

The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

This property is not available at design time.

Data Type

String

SecuritySignaturePolicy Property (SecureBlackbox_SAMLSPServer Class)

Specifies the signature validation policy.

Object Oriented Interface

public function getSecuritySignaturePolicy();
public function setSecuritySignaturePolicy($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 271 );
secureblackbox_samlspserver_set($res, 271, $value );

Default Value

0

Remarks

Specifies the signature validation policy.

Use this property to specify the signature validation policy for the component.

This property is not available at design time.

Data Type

Integer

SenderCertCount Property (SecureBlackbox_SAMLSPServer Class)

The number of records in the SenderChain arrays.

Object Oriented Interface

public function getSenderCertCount();

Procedural Interface

secureblackbox_samlspserver_get($res, 272 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SenderChainBytes
• SenderChainHandle

The array indices start at 0 and end at SenderCertCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SenderChainBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSenderChainBytes($sendercertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 273 , $sendercertindex);

Remarks

Returns the raw certificate data in DER format.

The $sendercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

SenderChainHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getSenderChainHandle($sendercertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 281 , $sendercertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $sendercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.

This property is read-only and not available at design time.

Data Type

Long64

SigningCertBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_samlspserver_get($res, 312 );

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getSigningCertHandle();
public function setSigningCertHandle($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 320 );
secureblackbox_samlspserver_set($res, 320, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SecureBlackbox_SAMLSPServer Class)

The number of records in the SigningChain arrays.

Object Oriented Interface

public function getSigningChainCount();
public function setSigningChainCount($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 351 );
secureblackbox_samlspserver_set($res, 351, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

The array indices start at 0 and end at SigningChainCount - 1.

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningChainBytes($signingchainindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 352 , $signingchainindex);

Remarks

Returns the raw certificate data in DER format.

The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningChainHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getSigningChainHandle($signingchainindex);
public function setSigningChainHandle($signingchainindex, $value);

Procedural Interface

secureblackbox_samlspserver_get($res, 360 , $signingchainindex);
secureblackbox_samlspserver_set($res, 360, $value , $signingchainindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

SocketIncomingSpeedLimit Property (SecureBlackbox_SAMLSPServer Class)

The maximum number of bytes to read from the socket, per second.

Object Oriented Interface

public function getSocketIncomingSpeedLimit();
public function setSocketIncomingSpeedLimit($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 396 );
secureblackbox_samlspserver_set($res, 396, $value );

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_SAMLSPServer Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();
public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 397 );
secureblackbox_samlspserver_set($res, 397, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_SAMLSPServer Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();
public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 398 );
secureblackbox_samlspserver_set($res, 398, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_SAMLSPServer Class)

The maximum number of bytes to write to the socket, per second.

Object Oriented Interface

public function getSocketOutgoingSpeedLimit();
public function setSocketOutgoingSpeedLimit($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 399 );
secureblackbox_samlspserver_set($res, 399, $value );

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (SecureBlackbox_SAMLSPServer Class)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Object Oriented Interface

public function getSocketTimeout();
public function setSocketTimeout($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 400 );
secureblackbox_samlspserver_set($res, 400, $value );

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (SecureBlackbox_SAMLSPServer Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();
public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 401 );
secureblackbox_samlspserver_set($res, 401, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SPServiceCount Property (SecureBlackbox_SAMLSPServer Class)

The number of records in the SPService arrays.

Object Oriented Interface

public function getSPServiceCount();

Procedural Interface

secureblackbox_samlspserver_get($res, 402 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SPServiceBindingType
• SPServiceEntityID
• SPServiceLocation
• SPServicePriority
• SPServiceService
• SPServiceServiceIndex

The array indices start at 0 and end at SPServiceCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SPServiceBindingType Property (SecureBlackbox_SAMLSPServer Class)

Specifies the type of SAML binding that this endpoint accepts.

Object Oriented Interface

public function getSPServiceBindingType($spserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 403 , $spserviceindex);

Default Value

0

Remarks

Specifies the type of SAML binding that this endpoint accepts.

Use this property to specify the binding type to use with this endpoint.

The $spserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

SPServiceEntityID Property (SecureBlackbox_SAMLSPServer Class)

Represents the SAML entity ID.

Object Oriented Interface

public function getSPServiceEntityID($spserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 404 , $spserviceindex);

Default Value

''

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

The $spserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only and not available at design time.

Data Type

String

SPServiceLocation Property (SecureBlackbox_SAMLSPServer Class)

The location (URL) of the endpoint.

Object Oriented Interface

public function getSPServiceLocation($spserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 405 , $spserviceindex);

Default Value

''

Remarks

The location (URL) of the endpoint.

The $spserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only and not available at design time.

Data Type

String

SPServicePriority Property (SecureBlackbox_SAMLSPServer Class)

The priority of the endpoint in relation to other endpoints with the same Location .

Object Oriented Interface

public function getSPServicePriority($spserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 406 , $spserviceindex);

Default Value

-1

Remarks

The priority of the endpoint in relation to other endpoints with the same SPLocation.

Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.

Leave all priorities at -1 to omit generation of the Default attribute.

The $spserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

SPServiceService Property (SecureBlackbox_SAMLSPServer Class)

The kind of the service being provided at this endpoint.

Object Oriented Interface

public function getSPServiceService($spserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 407 , $spserviceindex);

Default Value

0

Remarks

The kind of the service being provided at this endpoint.

The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService.

The $spserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

SPServiceServiceIndex Property (SecureBlackbox_SAMLSPServer Class)

The index of this endpoint.

Object Oriented Interface

public function getSPServiceServiceIndex($spserviceindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 408 , $spserviceindex);

Default Value

0

Remarks

The index of this endpoint.

For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.

The $spserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

SPContactPerson Property (SecureBlackbox_SAMLSPServer Class)

The contact person or persons for the entity.

Object Oriented Interface

public function getSPContactPerson();
public function setSPContactPerson($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 409 );
secureblackbox_samlspserver_set($res, 409, $value );

Default Value

''

Remarks

The contact person or persons for the entity.

SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.

Each record contains a semicolon-separated list of contact person parameters, for example:

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678

You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.

This property is not available at design time.

Data Type

String

SPEncryptionKey Property (SecureBlackbox_SAMLSPServer Class)

Contains the entity's encryption key.

Object Oriented Interface

public function getSPEncryptionKey();
public function setSPEncryptionKey($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 410 );
secureblackbox_samlspserver_set($res, 410, $value );

Default Value

''

Remarks

Contains the entity's encryption key.

This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).

Requests sent to the endpoint can be encrypted with the provided key or certificate.

This property is not available at design time.

Data Type

String

SPEncryptionMethods Property (SecureBlackbox_SAMLSPServer Class)

Specifies the list of encryption methods supported by the entity.

Object Oriented Interface

public function getSPEncryptionMethods();
public function setSPEncryptionMethods($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 411 );
secureblackbox_samlspserver_set($res, 411, $value );

Default Value

''

Remarks

Specifies the list of encryption methods supported by the entity.

This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.

Examples of algorithms supported by this property:

• http://www.w3.org/2009/xmlenc11#aes128-gcm
• http://www.w3.org/2001/04/xmlenc#aes256-cbc

This property is not available at design time.

Data Type

String

SPEntityID Property (SecureBlackbox_SAMLSPServer Class)

Represents the SAML entity ID.

Object Oriented Interface

public function getSPEntityID();
public function setSPEntityID($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 412 );
secureblackbox_samlspserver_set($res, 412, $value );

Default Value

''

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

This property is not available at design time.

Data Type

String

SPFlags Property (SecureBlackbox_SAMLSPServer Class)

Adjusts secondary entity properties.

Object Oriented Interface

public function getSPFlags();
public function setSPFlags($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 413 );
secureblackbox_samlspserver_set($res, 413, $value );

Default Value

0

Remarks

Adjusts secondary entity properties.

Use this bit mask property to adjust certain secondary settings. The following flags are supported:

• 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in.

This property is not available at design time.

Data Type

Integer

SPIdPSSOLink Property (SecureBlackbox_SAMLSPServer Class)

Contains a local server page link that triggers SAML authentication to the SP.

Object Oriented Interface

public function getSPIdPSSOLink();
public function setSPIdPSSOLink($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 414 );
secureblackbox_samlspserver_set($res, 414, $value );

Default Value

''

Remarks

Contains a local server page link that triggers SAML authentication to the SP.

This property specifies the web link that initiates the transfer of SAML authentication fact to the SP.

One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider.

This property is not available at design time.

Data Type

String

SPNameIDFormats Property (SecureBlackbox_SAMLSPServer Class)

The list of NameID formats supported by this entity.

Object Oriented Interface

public function getSPNameIDFormats();
public function setSPNameIDFormats($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 415 );
secureblackbox_samlspserver_set($res, 415, $value );

Default Value

''

Remarks

The list of NameID formats supported by this entity.

Use this setting to get or set the list of NameID formats supported by the entity.

Use SAML notation for the formats:

• urn:oasis:names:tc:SAML:2.0:nameid-format:transient
• urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
• urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

This property is not available at design time.

Data Type

String

SPOrganizationDisplayName Property (SecureBlackbox_SAMLSPServer Class)

The friendly name of the organization that maintains the entity.

Object Oriented Interface

public function getSPOrganizationDisplayName();
public function setSPOrganizationDisplayName($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 416 );
secureblackbox_samlspserver_set($res, 416, $value );

Default Value

''

Remarks

The friendly name of the organization that maintains the entity.

Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.

This property is not available at design time.

Data Type

String

SPOrganizationLang Property (SecureBlackbox_SAMLSPServer Class)

The language preferred by the organization.

Object Oriented Interface

public function getSPOrganizationLang();
public function setSPOrganizationLang($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 417 );
secureblackbox_samlspserver_set($res, 417, $value );

Default Value

''

Remarks

The language preferred by the organization.

This optional setting can be used to adjust the preferred language of the owning organization.

This property is not available at design time.

Data Type

String

SPOrganizationName Property (SecureBlackbox_SAMLSPServer Class)

The name of the organization that maintains the entity.

Object Oriented Interface

public function getSPOrganizationName();
public function setSPOrganizationName($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 418 );
secureblackbox_samlspserver_set($res, 418, $value );

Default Value

''

Remarks

The name of the organization that maintains the entity.

Use this setting to get or set the name of the organization that maintains the SAML entity.

This property is not available at design time.

Data Type

String

SPOrganizationURL Property (SecureBlackbox_SAMLSPServer Class)

The web URL of the organization that maintains the entity.

Object Oriented Interface

public function getSPOrganizationURL();
public function setSPOrganizationURL($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 419 );
secureblackbox_samlspserver_set($res, 419, $value );

Default Value

''

Remarks

The web URL of the organization that maintains the entity.

Use this setting to get or set the web address of the organization responsible for this SAML entity.

This property is not available at design time.

Data Type

String

SPSignatureValidationResult Property (SecureBlackbox_SAMLSPServer Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getSPSignatureValidationResult();

Procedural Interface

secureblackbox_samlspserver_get($res, 420 );

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only and not available at design time.

Data Type

Integer

SPSigned Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether the SAML entity information is or should be signed.

Object Oriented Interface

public function getSPSigned();

Procedural Interface

secureblackbox_samlspserver_get($res, 421 );

Default Value

false

Remarks

Specifies whether the SAML entity information is or should be signed.

Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.

This property is read-only and not available at design time.

Data Type

Boolean

SPSignedWith Property (SecureBlackbox_SAMLSPServer Class)

Contains the certificate or key that was used to sign the settings (metadata) document.

Object Oriented Interface

public function getSPSignedWith();

Procedural Interface

secureblackbox_samlspserver_get($res, 422 );

Default Value

''

Remarks

Contains the certificate or key that was used to sign the settings (metadata) document.

This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.

The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the SPSignatureValidationResult setting.

This property is read-only and not available at design time.

Data Type

String

SPSigningKey Property (SecureBlackbox_SAMLSPServer Class)

Contains the entity's signing key.

Object Oriented Interface

public function getSPSigningKey();
public function setSPSigningKey($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 423 );
secureblackbox_samlspserver_set($res, 423, $value );

Default Value

''

Remarks

Contains the entity's signing key.

This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key.

The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates.

This property is not available at design time.

Data Type

String

SPValidUntil Property (SecureBlackbox_SAMLSPServer Class)

Specifies the expiration time of the SAML entity information.

Object Oriented Interface

public function getSPValidUntil();
public function setSPValidUntil($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 424 );
secureblackbox_samlspserver_set($res, 424, $value );

Default Value

''

Remarks

Specifies the expiration time of the SAML entity information.

This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.

This property is not available at design time.

Data Type

String

TLSServerCertCount Property (SecureBlackbox_SAMLSPServer Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();
public function setTLSServerCertCount($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 425 );
secureblackbox_samlspserver_set($res, 425, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertHandle

The array indices start at 0 and end at TLSServerCertCount - 1.

This property is not available at design time.

Data Type

Integer

TLSServerCertBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 426 , $tlsservercertindex);

Remarks

Returns the raw certificate data in DER format.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

TLSServerCertHandle Property (SecureBlackbox_SAMLSPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getTLSServerCertHandle($tlsservercertindex);
public function setTLSServerCertHandle($tlsservercertindex, $value);

Procedural Interface

secureblackbox_samlspserver_get($res, 434 , $tlsservercertindex);
secureblackbox_samlspserver_set($res, 434, $value , $tlsservercertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is not available at design time.

Data Type

Long64

TLSAutoValidateCertificates Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Object Oriented Interface

public function getTLSAutoValidateCertificates();
public function setTLSAutoValidateCertificates($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 465 );
secureblackbox_samlspserver_set($res, 465, $value );

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (SecureBlackbox_SAMLSPServer Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();
public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 466 );
secureblackbox_samlspserver_set($res, 466, $value );

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_SAMLSPServer Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();
public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 467 );
secureblackbox_samlspserver_set($res, 467, $value );

Default Value

''

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSClientAuth Property (SecureBlackbox_SAMLSPServer Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();
public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 468 );
secureblackbox_samlspserver_set($res, 468, $value );

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

Integer

TLSECCurves Property (SecureBlackbox_SAMLSPServer Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();
public function setTLSECCurves($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 469 );
secureblackbox_samlspserver_set($res, 469, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_SAMLSPServer Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();
public function setTLSExtensions($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 470 );
secureblackbox_samlspserver_set($res, 470, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_SAMLSPServer Class)

Whether to force TLS session resumption when the destination address changes.

Object Oriented Interface

public function getTLSForceResumeIfDestinationChanges();
public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 471 );
secureblackbox_samlspserver_set($res, 471, $value );

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_SAMLSPServer Class)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Object Oriented Interface

public function getTLSPreSharedIdentity();
public function setTLSPreSharedIdentity($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 472 );
secureblackbox_samlspserver_set($res, 472, $value );

Default Value

''

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (SecureBlackbox_SAMLSPServer Class)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Object Oriented Interface

public function getTLSPreSharedKey();
public function setTLSPreSharedKey($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 473 );
secureblackbox_samlspserver_set($res, 473, $value );

Default Value

''

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SecureBlackbox_SAMLSPServer Class)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();
public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 474 );
secureblackbox_samlspserver_set($res, 474, $value );

Default Value

''

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_SAMLSPServer Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();
public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 475 );
secureblackbox_samlspserver_set($res, 475, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_SAMLSPServer Class)

Specifies the kind(s) of revocation check to perform.

Object Oriented Interface

public function getTLSRevocationCheck();
public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 476 );
secureblackbox_samlspserver_set($res, 476, $value );

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_SAMLSPServer Class)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Object Oriented Interface

public function getTLSSSLOptions();
public function setTLSSSLOptions($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 477 );
secureblackbox_samlspserver_set($res, 477, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_SAMLSPServer Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();
public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 478 );
secureblackbox_samlspserver_set($res, 478, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_SAMLSPServer Class)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();
public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 479 );
secureblackbox_samlspserver_set($res, 479, $value );

Default Value

false

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_SAMLSPServer Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();
public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 480 );
secureblackbox_samlspserver_set($res, 480, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_SAMLSPServer Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();
public function setTLSVersions($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 481 );
secureblackbox_samlspserver_set($res, 481, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

URL Property (SecureBlackbox_SAMLSPServer Class)

Specifies the base URL of this SP server.

Object Oriented Interface

public function getURL();
public function setURL($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 482 );
secureblackbox_samlspserver_set($res, 482, $value );

Default Value

''

Remarks

Use this property to set the base URL for this Service Provider (SP) server.

Please make sure the URL you provide here aligns well with the relative endpoint resource paths, such as AssertionConsumerService or ArtifactResolutionService. The two parts (the URL and the endpoint paths) are concatenated to produce full endpoint URLs. Please double check that only one of the parts includes the slash character in it: either the endpoint paths at the beginning (the default configuration), or the base URL at the end.

Data Type

String

AddIdPService Method (SecureBlackbox_SAMLSPServer Class)

Registers an IdP service in the IdPServices list.

Object Oriented Interface

public function doAddIdPService($service, $bindingtype, $location, $priority, $index);

Procedural Interface

secureblackbox_samlspserver_do_addidpservice($res, $service, $bindingtype, $location, $priority, $index);

Remarks

Use this method to add an entry to the list of known external SAML services and their locations.

The service provider needs to be knowledgeable of the external IdP services that it needs to use. That information can either be provided in the form of a metadata file (see ImportSettings), or registered manually using this method.

When using this method, make sure to register all the services you expect to work with. Note that if the same IdP service is available through several different transports (bindings), you will need to register each (service, transport) pair individually:

sp.AddIdPService(spsSingleSignOnService, csbtPOST, "https://idp.identityserver/saml/sso", -1, -1); sp.AddIdPService(spsSingleSignOnService, csbtRedirect, "https://idp.identityserver/saml/sso", -1, -1);

Use the Service parameter to specify the service to register:

The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for SSO and SLS services to use POST or Redirect bindings. This information is typically provided by the identity provider.

The Location parameter specifies the absolute URL of the respective SAML web endpoint.

The Priority parameter specifies the relative priority of the transport among several identical services. The actual transport used may be different to the specified priority, as the request received from the SP (such as AuthnRequest) may explicitly request a specific transport to use.

The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.

Note that this method registers a known service - something that the service provider should be aware of. This is different to the purpose of the AddSPService method, which registers the service provider's own service.

AddSPService Method (SecureBlackbox_SAMLSPServer Class)

Registers an SP service in the SPServices list.

Object Oriented Interface

public function doAddSPService($service, $bindingtype, $location, $priority, $index);

Procedural Interface

secureblackbox_samlspserver_do_addspservice($res, $service, $bindingtype, $location, $priority, $index);

Remarks

Use this method to add an entry to the list of SAML services and their locations provided by the SP.

A service provider can provide a variety of SAML services through a selection of endpoints, each supporting one or more transports (or bindings). Typical examples are an assertion consumer service or a single logout service, each of which can be served independently on the same or different endpoints, via a POST or Redirect transports (or both).

Each AddSPService call registers a single service offered via a single transport. If you would like to have the same service to be available using several different transports, you need to register each combination individually, even if the service runs at the same web endpoint:

sp.AddSPService(spsAssertionConsumerService, csbtPOST, '/saml/acs', -1, 1); sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2);

Use the Service parameter to specify the service to register:

The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for ACS service to use POST binding (due to the size of assertions), and SLS to either use POST or Redirect.

The Location parameter specifies an absolute or relative path to the service within the SAML web service:

sp.AddSPService(spsAssertionConsumerService, csbtPOST, 'https://app.com/saml/acs', -1, 1); // absolute path sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2); // relative path

The Priority parameter is nominal as it only specifies the relative priority of the transport in the SP metadata. The actual transport used, among those supported, depends on the choice of the external identity provider. Pass -1 to stick with the default priority.

The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.

Note that this method registers the service provider's own service - something that the service provider provides. This is different to AddIdPService method, which registers a foreign identity provider's service - something that the service provider should be aware of.

Cleanup Method (SecureBlackbox_SAMLSPServer Class)

Cleans up the server environment by purging expired sessions and cleaning caches.

Object Oriented Interface

public function doCleanup();

Procedural Interface

secureblackbox_samlspserver_do_cleanup($res);

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

Config Method (SecureBlackbox_SAMLSPServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_samlspserver_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (SecureBlackbox_SAMLSPServer Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_samlspserver_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

DropClient Method (SecureBlackbox_SAMLSPServer Class)

Terminates a client connection.

Object Oriented Interface

public function doDropClient($connectionid, $forced);

Procedural Interface

secureblackbox_samlspserver_do_dropclient($res, $connectionid, $forced);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

ExportSettings Method (SecureBlackbox_SAMLSPServer Class)

Saves the SP or IdP configuration to an XML metadata file.

Object Oriented Interface

public function doExportSettings($sp);

Procedural Interface

secureblackbox_samlspserver_do_exportsettings($res, $sp);

Remarks

Use this method to save the Service Provider (SP) or Identity Provider (IdP) configuration in the form of XML metadata. The SP metadata file may then be transferred to identity providers (IdP) to let them know about the SP configuration.

Adjust the provider configuration as required in SPSettings or IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.

GetClientBuffer Method (SecureBlackbox_SAMLSPServer Class)

Acquires a piece of operation data.

Object Oriented Interface

public function doGetClientBuffer($connectionid, $handle);

Procedural Interface

secureblackbox_samlspserver_do_getclientbuffer($res, $connectionid, $handle);

Remarks

Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.

A typical place to call this method is inside the ResourceWrite event handler, when implementing customized file transfers.

GetProviderProperty Method (SecureBlackbox_SAMLSPServer Class)

Returns the value of a custom provider property.

Object Oriented Interface

public function doGetProviderProperty($name);

Procedural Interface

secureblackbox_samlspserver_do_getproviderproperty($res, $name);

Remarks

This method, together with SetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

GetRequestBytes Method (SecureBlackbox_SAMLSPServer Class)

Returns the contents of the connected client's HTTP request.

Object Oriented Interface

public function doGetRequestBytes($connectionid, $requestfilter);

Procedural Interface

secureblackbox_samlspserver_do_getrequestbytes($res, $connectionid, $requestfilter);

Remarks

Use this method to get the body of the client's HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

GetRequestHeader Method (SecureBlackbox_SAMLSPServer Class)

Returns a request header value.

Object Oriented Interface

public function doGetRequestHeader($connectionid, $headername);

Procedural Interface

secureblackbox_samlspserver_do_getrequestheader($res, $connectionid, $headername);

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

GetResponseHeader Method (SecureBlackbox_SAMLSPServer Class)

Returns a response header value.

Object Oriented Interface

public function doGetResponseHeader($connectionid, $headername);

Procedural Interface

secureblackbox_samlspserver_do_getresponseheader($res, $connectionid, $headername);

Remarks

Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.

GetSessionProperty Method (SecureBlackbox_SAMLSPServer Class)

Returns the value of a custom session property.

Object Oriented Interface

public function doGetSessionProperty($sessionid, $name);

Procedural Interface

secureblackbox_samlspserver_do_getsessionproperty($res, $sessionid, $name);

Remarks

This method, together with SetSessionProperty, provides an extensible way of managing the Service Provider's session properties that are not available through the primary properties and events of the component. These methods can be called on any active browser session. Use SessionCreated and SessionDestroyed events to get notifications about session creation and disposal.

The following properties are supported for SP sessions and can be passed to the Name parameter of this method:

• Authenticated: whether the session has been authenticated with the IdP service.
• AuthnRequestID: the AuthnRequest ID.
• Expires: the web session expiration time.
• LogoutRequestID: the LogoutRequest ID.
• NameID: the NameID of the user.
• NameIDFormat: the format of the NameID of the user.
• FormattedNameID: the formatted version of the NameID.
• RelayState: the current (last) relay state entry.
• Session: the session ID (the same as you pass as parameter).
• SAMLSession: the browser cookie that corresponds to the session.
• SessionIndex: a list of cross-network session indexes assigned to this session.
• URL: the current request's URL.
• UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.
• Stage: the current session stage (or epoch).

ImportSettings Method (SecureBlackbox_SAMLSPServer Class)

Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call.

Object Oriented Interface

public function doImportSettings($metadata, $sp);

Procedural Interface

secureblackbox_samlspserver_do_importsettings($res, $metadata, $sp);

Remarks

The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP.

The Metadata parameter contains metadata in the form of byte array. Set SP parameter to true to indicate that it is the Service Provider's own settings that are being loaded.

The loaded metadata is populated in the SPSettings or IdPSettings object (depending on the value of the SP parameter).

InitiateArtifactResolve Method (SecureBlackbox_SAMLSPServer Class)

Initiates the artifact resolution protocol.

Object Oriented Interface

public function doInitiateArtifactResolve($connectionid, $sessionid, $idpserviceindex, $artifact, $tag);

Procedural Interface

secureblackbox_samlspserver_do_initiateartifactresolve($res, $connectionid, $sessionid, $idpserviceindex, $artifact, $tag);

Remarks

Use this event to initiate the artifact resolution protocol for Artifact. Specify the desired SP service endpoint via the IdPServiceIndex parameter.

You can use this method with or without the OfflineMode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

InitiateAttributeQuery Method (SecureBlackbox_SAMLSPServer Class)

Initiates the attribute query.

Object Oriented Interface

public function doInitiateAttributeQuery($connectionid, $sessionid, $idpserviceindex, $nameid, $nameidformat, $attributes, $attrnameformats, $attrfriendlynames, $tag);

Procedural Interface

secureblackbox_samlspserver_do_initiateattributequery($res, $connectionid, $sessionid, $idpserviceindex, $nameid, $nameidformat, $attributes, $attrnameformats, $attrfriendlynames, $tag);

Remarks

Use this event to initiate the attribute query for user NameID. Specify the desired Attributes as a list of CRLF-separated attribute names. AttrNameFormats and AttrFriendlyNames can also be provided in the same way.

Specify the IdP AQS endpoint via the IdPServiceIndex parameter.

You can use this method with or without the OfflineMode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

InitiateAuth Method (SecureBlackbox_SAMLSPServer Class)

Starts SP-initiated SAML authentication flow.

Object Oriented Interface

public function doInitiateAuth($connectionid, $sessionid, $idpserviceindex, $nameidformat, $relaystate, $tag);

Procedural Interface

secureblackbox_samlspserver_do_initiateauth($res, $connectionid, $sessionid, $idpserviceindex, $nameidformat, $relaystate, $tag);

Remarks

Use this method to initiate SAML authentication flow on the SP side. Pass the index of the single sign-on service that you want to use to the IdPServiceIndex parameter. Leave it empty to let the component pick up the best one automatically. Use RelayState to pass the callback URL to the IdP service. This will be mirrored back by the IDP in its response.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the OfflineMode.

InitiateLogout Method (SecureBlackbox_SAMLSPServer Class)

Starts SP-initiated SAML logout flow.

Object Oriented Interface

public function doInitiateLogout($connectionid, $sessionid, $idpserviceindex, $nameid, $sessionindex, $relaystate, $tag);

Procedural Interface

secureblackbox_samlspserver_do_initiatelogout($res, $connectionid, $sessionid, $idpserviceindex, $nameid, $sessionindex, $relaystate, $tag);

Remarks

Use this method to initiate SAML logout flow on the SP side. Pass the index of the single logout service that you want to use to the IdPServiceIndex parameter.

Use IdPServiceIndex to specify the identity provider's service that you want to use for signing out. Provide the existing SAML session details in one of the following ways:

• as an HTTP SessionID: in this case the component will try to pick the matching SAML session from its session cache.
• as a known NameID.
• as a known SAML SessionIndex.

You can use a combination of the above.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

Use RelayState to pass a value to the IdP that you want to be mirrored back in the IdP's response. The Tag value will be similarly mirrored, but in the component's events, such as ProcessingCompleted.

You can use this method with or without the OfflineMode.

ListClients Method (SecureBlackbox_SAMLSPServer Class)

Enumerates the connected clients.

Object Oriented Interface

public function doListClients();

Procedural Interface

secureblackbox_samlspserver_do_listclients($res);

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (SecureBlackbox_SAMLSPServer Class)

Takes a snapshot of the connection's properties.

Object Oriented Interface

public function doPinClient($connectionid);

Procedural Interface

secureblackbox_samlspserver_do_pinclient($res, $connectionid);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

ProcessArtifact Method (SecureBlackbox_SAMLSPServer Class)

Processes an artifact request received from the IdP service at one of artifact receiver endpoints.

Object Oriented Interface

public function doProcessArtifact($connectionid, $sessionid, $request, $tag);

Procedural Interface

secureblackbox_samlspserver_do_processartifact($res, $connectionid, $sessionid, $request, $tag);

Remarks

Use this method to pass a SAML artifact received at one of the artifact endpoints.

Artifact messages are typically very simple:

https://idp.server.com/sso/artifact?SAMLart=artifact

In response to the artifact received, the server initiates an artifact resolution protocol to retrieve the SAML message identified by the artifact. This will typically expose itself via an invocation of the ArtifactResolveRequestPrepared event, and, later on, of an event matching the type of the actual message received - such as AssertionReceived.

You can use this method with or without the OfflineMode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

ProcessArtifactResolveRequest Method (SecureBlackbox_SAMLSPServer Class)

Processes an artifact request received from the SP service at one of the ARS endpoints.

Object Oriented Interface

public function doProcessArtifactResolveRequest($connectionid, $sessionid, $request, $tag);

Procedural Interface

secureblackbox_samlspserver_do_processartifactresolverequest($res, $connectionid, $sessionid, $request, $tag);

Remarks

Use this method to pass a SAML artifact request received at one of the ArtifactResolutionService endpoints.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the OfflineMode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

ProcessAssertion Method (SecureBlackbox_SAMLSPServer Class)

Processes assertion received from the IdP service at one of the ACS endpoints.

Object Oriented Interface

public function doProcessAssertion($connectionid, $sessionid, $request, $tag);

Procedural Interface

secureblackbox_samlspserver_do_processassertion($res, $connectionid, $sessionid, $request, $tag);

Remarks

Use this method to pass a SAML assertion received at one of the AssertionConsumerService endpoints.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the OfflineMode.

ProcessGenericRequest Method (SecureBlackbox_SAMLSPServer Class)

Processes a generic HTTP SAML request.

Object Oriented Interface

public function doProcessGenericRequest($connectionid, $request);

Procedural Interface

secureblackbox_samlspserver_do_processgenericrequest($res, $connectionid, $request);

Remarks

Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine.

The Request parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers. The generated response contains a full HTTP response that should be supplied back to the requestor. You can edit some parts of the response (for example, by adding some custom HTTP headers).

You can use this method with or without the OfflineMode.

ProcessLogoutRequest Method (SecureBlackbox_SAMLSPServer Class)

Processes logout request received from the IdP service at one of the SLS endpoints.

Object Oriented Interface

public function doProcessLogoutRequest($connectionid, $sessionid, $request, $tag);

Procedural Interface

secureblackbox_samlspserver_do_processlogoutrequest($res, $connectionid, $sessionid, $request, $tag);

Remarks

Use this method to pass a SAML logout request received at one of the SingleLogoutService endpoints.

An SLS endpoint may receive requests of two kinds: LogoutRequest and LogoutResponse. If Request contains a LogoutRequest, the content generated by this method will contain a corresponding LogoutResponse. If Request contains a LogoutResponse, the generated content is empty.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the OfflineMode.

Reset Method (SecureBlackbox_SAMLSPServer Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_samlspserver_do_reset($res);

Remarks

Reset is a generic method available in every class.

SetClientBuffer Method (SecureBlackbox_SAMLSPServer Class)

Commits a data buffer to the connection.

Object Oriented Interface

public function doSetClientBuffer($connectionid, $handle, $value);

Procedural Interface

secureblackbox_samlspserver_do_setclientbuffer($res, $connectionid, $handle, $value);

Remarks

Use this method from your ReadFile event handler to commit a chunk of file data to the server component.

SetProviderProperty Method (SecureBlackbox_SAMLSPServer Class)

Sets the value of a custom provider property.

Object Oriented Interface

public function doSetProviderProperty($name, $value);

Procedural Interface

secureblackbox_samlspserver_do_setproviderproperty($res, $name, $value);

Remarks

This method, together with GetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

SetResponseHeader Method (SecureBlackbox_SAMLSPServer Class)

Sets a response header.

Object Oriented Interface

public function doSetResponseHeader($connectionid, $headername, $value);

Procedural Interface

secureblackbox_samlspserver_do_setresponseheader($res, $connectionid, $headername, $value);

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

SetSessionProperty Method (SecureBlackbox_SAMLSPServer Class)

Sets the value of a custom provider session property.

Object Oriented Interface

public function doSetSessionProperty($sessionid, $name, $value);

Procedural Interface

secureblackbox_samlspserver_do_setsessionproperty($res, $sessionid, $name, $value);

Remarks

This method, together with GetSessionProperty, provides an extensible way of managing the Service Provider's session settings that are not available through the primary properties and events of the component.

The following properties can be adjusted for each individual session:

• AuthnRequestID: the AuthnRequest ID.
• LogoutRequestID: the LogoutRequest ID.
• NameID: the NameID of the user.
• RelayState: the current (last) relay state entry.
• Session: the session ID (the same as you pass as parameter).
• SAMLSession: the browser cookie that corresponds to the session.
• SessionIndex: a collection of cross-network session indexes assigned to this session.
• URL: the current request's URL.
• UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.
• Expires: the web session expiration time. Set it to a moment in the past to enforce immediate session expiration.

Note: setting a session property invokes a call to SessionStateSave. The component does that to update the session state kept externally.

Note: changing session properties mindlessly may break the protocol flow. For example, changing AuthnRequestID to a different value may cause the Service Provider to reject the subsequent assertion message, as the incoming assertion will contain a now-unmatching In-Response-To entry.

Start Method (SecureBlackbox_SAMLSPServer Class)

Starts the SP server.

Object Oriented Interface

public function doStart();

Procedural Interface

secureblackbox_samlspserver_do_start($res);

Remarks

Use this method to start listening for incoming connections.

Stop Method (SecureBlackbox_SAMLSPServer Class)

Stops the IdP server.

Object Oriented Interface

public function doStop();

Procedural Interface

secureblackbox_samlspserver_do_stop($res);

Remarks

Call this method to stop listening for incoming connections.

Accept Event (SecureBlackbox_SAMLSPServer Class)

Reports an incoming connection.

Object Oriented Interface

public function fireAccept($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 1, array($this, 'fireAccept'));

Parameter List

 'remoteaddress'
 'remoteport'
 'accept'

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

ArtifactReceived Event (SecureBlackbox_SAMLSPServer Class)

The server fires this event upon receiving an Artifact message from the other side.

Object Oriented Interface

public function fireArtifactReceived($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 2, array($this, 'fireArtifactReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'issuer'
 'artifact'
 'action'

Remarks

The Artifact message is very simple and only contains the actual artifact (an opaque string). Depending on the choice of the Action parameter, the further flow may go as following:

• fraAuto: the server will prepare an ArtifactResolve request and sent it to the other side to retrieve the artifact.
• fraCustom: the server will acknowledge the receipt of the artifact, but it is the task of your code to request the message and pass it on to the server via ProcessGenericRequest method.
• fraReject: the server will discard the artifact.

Note that you still can choose fraAuto to let the server proceed, but alter the flow as required in further events, such as ArtifactResolveRequestPrepared.

In OfflineMode this event would typically be fired from ProcessArtifact call.

ArtifactResolveRequestPrepared Event (SecureBlackbox_SAMLSPServer Class)

This event is fired when a new artifact resolution request message has been prepared by the class.

Object Oriented Interface

public function fireArtifactResolveRequestPrepared($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 3, array($this, 'fireArtifactResolveRequestPrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'destination'
 'artifact'

Remarks

Subscribe to this event to be notified about preparation of artifact resolution requests. This is fired right after the resolution request has been prepared, and just before the component sends it out to the identity provider.

ArtifactResolveRequestReceived Event (SecureBlackbox_SAMLSPServer Class)

Reports receipt of ArtifactResolveRequest message.

Object Oriented Interface

public function fireArtifactResolveRequestReceived($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 4, array($this, 'fireArtifactResolveRequestReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'issuer'
 'isencrypted'
 'issigned'
 'artifact'
 'action'

Remarks

The component fires this event to report receipt of incoming artifact resolution request. The Artifact parameter contains the artifact identifier received.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

AssertionReceived Event (SecureBlackbox_SAMLSPServer Class)

This event is fired when an assertion is received from the IdP.

Object Oriented Interface

public function fireAssertionReceived($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 5, array($this, 'fireAssertionReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'issuer'
 'body'
 'isencrypted'
 'issigned'
 'auth'
 'nameid'
 'nameidformat'
 'sessionindex'
 'attributes'
 'validfrom'
 'validto'
 'relaystate'
 'action'

Remarks

The AssertionReceived event notifies the application that an assertion has been received at the ACS endpoint. In OfflineMode this event may fire in response to a ProcessAssertion call. In online mode it can fire at any time while the server is active.

The ConnectionID and SessionID specify the IDs of the current client connection and HTTP session. The RequestID contains the ID of the original AuthnRequest message, if it was sent by the service provider. The IsEncrypted and IsSigned parameters indicate the security properties of the assertion. The NameID parameter contains the unique name identifier of the authenticated principal, and the SessionIndex contains the SAML session identifier. In rare cases SessionIndex may contain multiple indices, if the SP has more than one session at the IdP.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

If the assertion is returned in response to this SP's AuthnRequest message, the RelayState parameter will contain the original relay state passed to the earlier InitiateAuth call.

AttributeQueryPrepared Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application of the preparation of an AttributeQuery.

Object Oriented Interface

public function fireAttributeQueryPrepared($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 6, array($this, 'fireAttributeQueryPrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'destination'
 'nameid'
 'nameidformat'
 'attributes'

Remarks

The component uses this event to notify the application of the completion of the preparation of the AttributeQuery message. The NameID and NameIDFormat parameters indicate the attribute subject, and the Attributes parameter contains a list of attributes being requested.

This event may be fired in response to a InitiateAttributeQuery call (in offline mode), or intermittently in online mode.

AuthnRequestPrepared Event (SecureBlackbox_SAMLSPServer Class)

This event is fired when a new authentication request message has been prepared.

Object Oriented Interface

public function fireAuthnRequestPrepared($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 7, array($this, 'fireAuthnRequestPrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'destination'
 'nameidformat'
 'forceauthn'
 'noninteractive'
 'relaystate'

Remarks

Subscribe to this event to get notified about assertion requests prepared by the service provider. This event may fire from InitiateAuth method when working in OfflineMode, or at any time when working as a standalone live web server.

You can adjust the RelayState as required in the event handler to pass on a state to the IdP. The IdP will return this state back to you together with its authentication assertion.

Connect Event (SecureBlackbox_SAMLSPServer Class)

Reports an accepted connection.

Object Oriented Interface

public function fireConnect($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 8, array($this, 'fireConnect'));

Parameter List

 'connectionid'
 'remoteaddress'
 'remoteport'

Remarks

The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as SessionClosed or SessionEstablished.

Disconnect Event (SecureBlackbox_SAMLSPServer Class)

Fires to report a disconnected client.

Object Oriented Interface

public function fireDisconnect($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 9, array($this, 'fireDisconnect'));

Parameter List

 'connectionid'

Remarks

The class fires this event when a connected client disconnects.

Encrypted Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application that the assertion is encrypted and provides recipient certificate details.

Object Oriented Interface

public function fireEncrypted($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 10, array($this, 'fireEncrypted'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'needcredential'
 'skipthis'

Remarks

The class fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.

This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate property (depending on encryption method used), or sets SkipThis to true.

The IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own OnEncrypted event loop.

The NeedCredential parameter specifies whether the correct credential is already available to the class or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the DecryptionCertificate property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.

Error Event (SecureBlackbox_SAMLSPServer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 11, array($this, 'fireError'));

Parameter List

 'connectionid'
 'sessionid'
 'errorcode'
 'fatal'
 'remote'
 'description'

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section.

ExternalSign Event (SecureBlackbox_SAMLSPServer Class)

Handles remote or external signing initiated by the server protocol.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 12, array($this, 'fireExternalSign'));

Parameter List

 'connectionid'
 'operationid'
 'hashalgorithm'
 'pars'
 'data'
 'signeddata'

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

LogoutRequestPrepared Event (SecureBlackbox_SAMLSPServer Class)

This event is fired when a new logout request has been prepared.

Object Oriented Interface

public function fireLogoutRequestPrepared($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 13, array($this, 'fireLogoutRequestPrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'destination'
 'nameid'
 'nameidformat'
 'sessionindex'
 'relaystate'

Remarks

The component uses this event to report completion of the LogoutRequest preparation. The NameID, NameIDFormat, and SessionIndex parameters indicate the subject that is being logged out. The SP parameter references the service provider involved.

The RelayState contains the relay state value that is going to be passed with the LogoutRequest to the remote party and mirrored back (if the protocol supports it).

LogoutRequestReceived Event (SecureBlackbox_SAMLSPServer Class)

The class uses this event to notify the application about an incoming SAML Logout Request message.

Object Oriented Interface

public function fireLogoutRequestReceived($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 14, array($this, 'fireLogoutRequestReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'issuer'
 'isencrypted'
 'issigned'
 'nameid'
 'nameidformat'
 'sessionindex'
 'action'

Remarks

The SAML SP server fires this event when a SAML logout request is received at a single logout service endpoint. The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

LogoutResponsePrepared Event (SecureBlackbox_SAMLSPServer Class)

The class uses this event to notify the application about the Logout Response message being ready to be sent.

Object Oriented Interface

public function fireLogoutResponsePrepared($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 15, array($this, 'fireLogoutResponsePrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'destination'
 'body'
 'nameid'
 'nameidformat'
 'sessionindex'

Remarks

The IdP server fires this event when it has prepared a Logout Response message and is ready to send it out to the SP.

LogoutResponseReceived Event (SecureBlackbox_SAMLSPServer Class)

The class uses this event to notify the application about an incoming SAML LogoutResponse message.

Object Oriented Interface

public function fireLogoutResponseReceived($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 16, array($this, 'fireLogoutResponseReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'issuer'
 'isencrypted'
 'issigned'
 'nameid'
 'nameidformat'
 'sessionindex'
 'relaystate'
 'action'

Remarks

The SAML SP server fires this event when a SAML logout response is received at a single logout service endpoint following the LogoutRequest sent earlier. The RelayState is a mirrored back value included in the request.

The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

Notification Event (SecureBlackbox_SAMLSPServer Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 17, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

ProcessingCompleted Event (SecureBlackbox_SAMLSPServer Class)

This event notifies the application of the completion of request or response processing.

Object Oriented Interface

public function fireProcessingCompleted($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 18, array($this, 'fireProcessingCompleted'));

Parameter List

 'connectionid'
 'sessionid'
 'tag'
 'processingresult'
 'response'
 'redirect'

Remarks

The component fires ProcessingCompleted to notify the application about completion of an earlier initiated processing operation. It is only fired in OfflineMode in response to calls such as ProcessAssertion, ProcessLogoutRequest, or similar. The main purpose of this event is to notify the application of the outcomes of the processing and return any prepared SAML entity for subsequent relay to the browser.

This event is fired strictly once for each Process* call, with the ConnectionID matching the value passed to the Process* method.

The SessionID parameter contains the identifier of the current virtual session. It may differ to the value passed to the Process* method if the session information was provided on the fly via the SessionInfoNeeded event. The ProcessingResult indicates the type of deliverable that was created during the processing (see below for possible values). The Response parameter contains the body of the deliverable. This can take one of the forms:

• a self-submitting form containing a SAML message.
• a redirect URL.
• a SOAP XML response.
• an empty string if ProcessingResult is set to sprSuccess.

The Redirect parameter indicates whether the value of Response should be passed to the browser within the 302 Location header, or as a document body.

ReadArtifact Event (SecureBlackbox_SAMLSPServer Class)

Requests content identified by an artifact from the application.

Object Oriented Interface

public function fireReadArtifact($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 19, array($this, 'fireReadArtifact'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'issuer'
 'artifact'
 'value'
 'skip'

Remarks

The component fires this event to request the content matching Artifact from the application. This is normally happens within the artifact resolution protocol between the SP and the IdP server.

The application must provide the requested artifact content via the Value parameter. The application can choose not to provide the artifact content (for example, if it doesn't have it) by setting Skip to true.

ResourceClose Event (SecureBlackbox_SAMLSPServer Class)

Tells the application that it can close the opened resource.

Object Oriented Interface

public function fireResourceClose($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 20, array($this, 'fireResourceClose'));

Parameter List

 'connectionid'
 'sessionid'
 'handle'

Remarks

The class uses this event to notify the application that it can now close the resource opened earlier in its ResourceOpen handler.

ResourceOpen Event (SecureBlackbox_SAMLSPServer Class)

Requests the application to open the requested resource.

Object Oriented Interface

public function fireResourceOpen($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 21, array($this, 'fireResourceOpen'));

Parameter List

 'connectionid'
 'sessionid'
 'url'
 'httpmethod'
 'operationstatus'
 'handle'

Remarks

The class fires this event in virtualized mode if the application had returned the fraCustom modifier from the earlier ResourceRequest event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent ResourceRead event calls. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ResourceRead Event (SecureBlackbox_SAMLSPServer Class)

Requests the application to read from an opened resource.

Object Oriented Interface

public function fireResourceRead($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 22, array($this, 'fireResourceRead'));

Parameter List

 'connectionid'
 'sessionid'
 'handle'
 'size'
 'operationstatus'

Remarks

The class fires this event in virtualized mode to request another chunk of data from the resource opened earlier. The handler of this event should read up to Size bytes from the object, and pass them to the component with a SetClientBuffer call.

Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ResourceRead calls are needed.

Set OperationStatus to one of the following values:

ResourceRequest Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application that a server resource is requested.

Object Oriented Interface

public function fireResourceRequest($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 23, array($this, 'fireResourceRequest'));

Parameter List

 'connectionid'
 'sessionid'
 'url'
 'httpmethod'
 'resprotected'
 'resspecial'
 'allowwriting'
 'action'

Remarks

The class uses this event to notify the application that the connection has requested a server resource.

The URL parameter specifies the resource requested. ResProtected is set to true if the resource is protected by SAML. ResSpecial is set to true if the request is a SAML resource, such as the metadata or an Assertion Consumer Service page. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request).

Choose Action as one of the following values:

ResourceWrite Event (SecureBlackbox_SAMLSPServer Class)

Requests the application to write to an opened resource.

Object Oriented Interface

public function fireResourceWrite($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 24, array($this, 'fireResourceWrite'));

Parameter List

 'connectionid'
 'sessionid'
 'handle'
 'operationstatus'

Remarks

The class fires this event in virtualized mode to pass another chunk of data to a resource opened earlier. This event is called for write-enabled requests, such as POST or PUT. The handler of this event should read the pending data using the GetClientBuffer method and write them to the opened file descriptor.

Use the OperationStatus parameter to return the operation result back to the server:

SAMLMessagePrepared Event (SecureBlackbox_SAMLSPServer Class)

This event is fired when a SAML message has been prepared and is ready to be dispatched.

Object Oriented Interface

public function fireSAMLMessagePrepared($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 25, array($this, 'fireSAMLMessagePrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'messageid'
 'destination'
 'issueinstant'
 'inresponseto'
 'requestbody'
 'messagetype'
 'messagebody'
 'relaystate'
 'success'

Remarks

Subscribe to this event to be notified about every SAML message that has been prepared by the server. This event is fired for every type of the outgoing message (e.g. SAMLResponse or LogoutRequest). The InResponseTo contains the ID of the message in response to which the current message is sent (if applicable). The RequestBody parameter contains the body of such request.

The MessageType parameter indicates the type of the message that has been prepared, such as SAMLResponse. The MessageBody contains the XML body of the message. The Success parameter indicates whether the message contains a positive statement or an error. Both the MessageBody and Success parameters are adjustable.

SAMLMessageReceived Event (SecureBlackbox_SAMLSPServer Class)

The server fires this event for every SAML message it receives.

Object Oriented Interface

public function fireSAMLMessageReceived($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 26, array($this, 'fireSAMLMessageReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'messageid'
 'issuer'
 'issueinstant'
 'inresponseto'
 'requestbody'
 'messagetype'
 'messagebody'
 'issigned'
 'relaystate'
 'action'

Remarks

Subscribe to this event to be notified about incoming SAML messages.

The MessageType, MessageID, Issuer, and MessageBody parameters provide the details of the message received. The RequestBody and InResponseTo contain a reference to the request that this message is a response to (if any).

Set Action property as required to let the component know how to proceed.

SessionCreated Event (SecureBlackbox_SAMLSPServer Class)

This event is fired when a new session has been established.

Object Oriented Interface

public function fireSessionCreated($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 27, array($this, 'fireSessionCreated'));

Parameter List

 'connectionid'
 'sessionid'

Remarks

ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.

SessionDestroyed Event (SecureBlackbox_SAMLSPServer Class)

This event is fired when the SP server has closed a session.

Object Oriented Interface

public function fireSessionDestroyed($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 28, array($this, 'fireSessionDestroyed'));

Parameter List

 'connectionid'
 'sessionid'

Remarks

ConnectionID contains the identifier of the closed session.

SessionEvent Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application about SAML session events.

Object Oriented Interface

public function fireSessionEvent($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 29, array($this, 'fireSessionEvent'));

Parameter List

 'connectionid'
 'sessionid'
 'eventtext'

Remarks

class uses this event to notify your code about events that happen within the lifeline of a SAML session. Handling it may be useful for development, logging, and monitoring purposes.

The SessionID parameter specifies the session ID, and the EventText parameter describes the event that happened. Below are a few typical examples of what EventText you can expect to get:

• Start
• AuthnRequestPrepared
• ResponseReceived
• ResourceSupplied
• LogoutRequestPrepared
• LogoutResponseReceived
• LogoutRequestReceived
• LogoutResponsePrepared
• ArtifactResolveRequestReceived
• ArtifactResponsePrepared
• Finish

SessionInfoNeeded Event (SecureBlackbox_SAMLSPServer Class)

This event is fired in OfflineMode to request the session ID for the current flow.

Object Oriented Interface

public function fireSessionInfoNeeded($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 30, array($this, 'fireSessionInfoNeeded'));

Parameter List

 'connectionid'
 'sessionid'

Remarks

SAML protocol is stateful, which means that SAML services need to keep session-related information between connections. When used in online mode - where the components listen and serve connections automatically - the components can use HTTP cookies to track connecting clients and maintain the session store at the background. However, when used in offline mode, the components do not have access to the HTTP layer and live too short for the session store to survive. That is why in offline mode the components rely on the application code to keep the session information for them.

The components use a collection of Session* events to exchange session information with the application:

• SessionCreated is called when the component establishes a new session. In offline mode, the application should associate the session ID with the connected user, for example by returning it as a cookie.
• SessionStateSave : the component passes the session state to the application and expects that the application saves it somewhere to return it back to the component at its request at some point in the future. The session state is an opaque string. The application can use a hash table to store a collection of (SessionID, SessionState) pairs over the lifetime of the SAML service. The server may fire SessionStateSave multiple times for the same SessionID. If this happens, the existing SessionID entry should be overwritten with the fresh session data.
• SessionStateRetrieve : the component passes a session ID to the application and expects it to return the session state saved in the hash table earlier. The application should not delete the state from the hash table, as it may be needed again.
• SessionInfoNeeded (this event): the component expects the application to return the session ID corresponding to the connection ID back to them. This event fires, for example, if the application calls ProcessLogoutRequest but passes an empty SessionID as a parameter.
• SessionDestroyed is called when a session is destroyed. The component can remove the session from the hash table upon receiving this event.

SessionStateRetrieve Event (SecureBlackbox_SAMLSPServer Class)

This event fires to retrieve session state information from the application.

Object Oriented Interface

public function fireSessionStateRetrieve($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 31, array($this, 'fireSessionStateRetrieve'));

Parameter List

 'connectionid'
 'sessionid'
 'sessionstate'

Remarks

The component fires this event to request a session state that was previously provided to the application via the SessionStateSave call.

See the SessionInfoNeeded topic for more details about session management in offline mode.

SessionStateSave Event (SecureBlackbox_SAMLSPServer Class)

This event passes a session state object to the application for safekeeping.

Object Oriented Interface

public function fireSessionStateSave($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 32, array($this, 'fireSessionStateSave'));

Parameter List

 'connectionid'
 'sessionid'
 'sessionstate'

Remarks

The component fires this event to pass a session state to the application. The application is expected to save the state object (which is an opaque string) in a hash table, and be ready to return it back to the component when it requests it using a SessionStateRetrieve call.

See the SessionInfoNeeded topic for more details about session management in offline mode.

SignatureFound Event (SecureBlackbox_SAMLSPServer Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 33, array($this, 'fireSignatureFound'));

Parameter List

 'connectionid'
 'sessionid'
 'scope'
 'signer'
 'targetid'
 'targettype'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'sigmethod'
 'digestmethod'
 'certfound'
 'validate'

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified message.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.

The details of the reported signature are populated in the Security object. For assertion signatures, you can update the details by pinning the assertion.

The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the SigningCertificate property and the associated certificates from the Certificates collection, and pass them to the CertificateValidator component to validate its chain.

Use the Validate parameter to tell the reader whether it should validate the signature.

SignatureValidated Event (SecureBlackbox_SAMLSPServer Class)

Reports the signature validation result.

Object Oriented Interface

public function fireSignatureValidated($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 34, array($this, 'fireSignatureValidated'));

Parameter List

 'connectionid'
 'sessionid'
 'scope'
 'signer'
 'targetid'
 'targettype'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'sigmethod'
 'digestmethod'
 'validationresult'

Remarks

This event is fired when the complete XML signature validation process is finished.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.

IssuerRDN returns the name of the signature issuer, SerialNumber identifies the signing certificate, SubjectKeyID contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, ValidationResult specifies whether signature is valid or not:

TLSCertValidate Event (SecureBlackbox_SAMLSPServer Class)

Fires when a client certificate needs to be validated.

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 35, array($this, 'fireTLSCertValidate'));

Parameter List

 'connectionid'
 'accept'

Remarks

The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (SecureBlackbox_SAMLSPServer Class)

Reports the setup of a TLS session.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 36, array($this, 'fireTLSEstablished'));

Parameter List

 'connectionid'

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (SecureBlackbox_SAMLSPServer Class)

Fires when a newly established client connection initiates a TLS handshake.

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 37, array($this, 'fireTLSHandshake'));

Parameter List

 'connectionid'
 'servername'
 'abort'

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (SecureBlackbox_SAMLSPServer Class)

Requests a pre-shared key for TLS-PSK.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 38, array($this, 'fireTLSPSK'));

Parameter List

 'connectionid'
 'identity'
 'psk'
 'ciphersuite'

Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (SecureBlackbox_SAMLSPServer Class)

Reports closure of a TLS session.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 39, array($this, 'fireTLSShutdown'));

Parameter List

 'connectionid'

Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

UserAuthCompleted Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application about the success of user authentication flow.

Object Oriented Interface

public function fireUserAuthCompleted($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 40, array($this, 'fireUserAuthCompleted'));

Parameter List

 'connectionid'
 'sessionid'
 'assertionbody'
 'auth'
 'nameid'
 'nameidformat'
 'sessionindex'
 'validfrom'
 'validto'
 'relaystate'

Remarks

Subscribe to this event to get notified about completion of user authentication flow. The NameID, NameIDFormat, SessionIndex, ValidFrom, and ValidTo parameters contain the session parameters as stated in the assertion, which is provided via the AssertionBody parameter. The Auth parameter contain the authentication mechanism used.

The RelayState matches the original relay state that was used on the initiation stage of the authentication.

UserAuthFailed Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application about failure of user authentication flow.

Object Oriented Interface

public function fireUserAuthFailed($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 41, array($this, 'fireUserAuthFailed'));

Parameter List

 'connectionid'
 'sessionid'
 'relaystate'

Remarks

The component fires this event to notify the application about failed user authentication flow. The RelayState parameter matches the one included with the AuthnRequest message.

UserAuthStart Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application about the start of user authentication flow.

Object Oriented Interface

public function fireUserAuthStart($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 42, array($this, 'fireUserAuthStart'));

Parameter List

 'connectionid'
 'sessionid'
 'idpserviceindex'
 'relaystate'

Remarks

The component invokes this event to signal the start of the user authentication flow. This happens shortly before the component proceeds to generation of AuthnRequest message.

The RelayState is an arbitrary string that will be passed to the IdP and mirrored back with the assertion. It is typically used to remember the URL of the resource or page that kicked in the SAML authentication flow.

UserLogoutCompleted Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application about the completion of user logout flow.

Object Oriented Interface

public function fireUserLogoutCompleted($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 43, array($this, 'fireUserLogoutCompleted'));

Parameter List

 'connectionid'
 'sessionid'
 'nameid'
 'sessionindex'
 'relaystate'

Remarks

Subscribe to this event to be notified about the completion of the logout flow.

UserLogoutStart Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application about the start of user logout flow.

Object Oriented Interface

public function fireUserLogoutStart($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 44, array($this, 'fireUserLogoutStart'));

Parameter List

 'connectionid'
 'sessionid'
 'idpserviceindex'
 'nameid'
 'sessionindex'
 'secondary'
 'relaystate'

Remarks

Subscribe to this event to get notified about the start of the user logout flow.

The logout process can be initiated on either the SP or IdP side. This event is fired at the earliest opportunity that this fact becomes known to the service provider: from within the InitiateLogout method, ProcessLogoutRequest method, or upon receiving a logout request at the SLS endpoint.

Independently of the timing and the stage of this event, the subsequent flow is the same: the logout protocol is initiated. The application will be notified of the completion of the protocol using the UserLogoutCompleted event. Note that the UserLogoutCompleted event may not fire if the connectivity to the IdP is lost prematurely or the IdP chooses not to respond. Due to that, it is reasonable to consider the user as logged out immediately after the current event fires.

The IdPServiceIndex parameter contains the index of the IdP service in the IdPServices collection. NameID indicates the name identifier of the user that is being logged out, and SessionIndex contain the unique SAML session identifier. The Secondary flag indicates whether the the SP is responding to IdP-initiated logout request.

The RelayState parameter is an optional SP-generated token that the IdP will return back in its LogoutResponse message. This is often set to the destination page where the browser should be redirected upon completion of the signout process.

Config Settings (SAMLSPServer Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SAMLSPServer Config Settings

Base Config Settings

Trappable Errors (SAMLSPServer Class)

SAMLSPServer Errors