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_config($res, $configurationstring);
 secureblackbox_samlspserver_do_doaction($res, $actionid, $actionparams);
 secureblackbox_samlspserver_do_getclientbuffer($res, $connectionid);
 secureblackbox_samlspserver_do_getproviderproperty($res, $name);
 secureblackbox_samlspserver_do_loadidpmetadata($res, $filename);
 secureblackbox_samlspserver_do_processgenericrequest($res, $request);
 secureblackbox_samlspserver_do_savemetadata($res, $filename);
 secureblackbox_samlspserver_do_setclientbuffer($res, $connectionid, $value);
 secureblackbox_samlspserver_do_setproviderproperty($res, $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 LoadIDPMetadata method or its stream-based variant. 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.LoadIDPMetadata("their_metadata.xml"); // 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

ArtifactResolutionService Property (SecureBlackbox_SAMLSPServer Class)

The location of the artifact resolution service.

Object Oriented Interface

public function getArtifactResolutionService();


public function setArtifactResolutionService($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 2 );


secureblackbox_samlspserver_set($res, 2, $value );

Default Value

'/sp/ArtifactResolutionService'

Remarks

Use this property to specify the location of the artifact resolution service of this Service Provider (SP).

Data Type

String

AssertionConsumerService Property (SecureBlackbox_SAMLSPServer Class)

The location of the Assertion Consumer Service.

Object Oriented Interface

public function getAssertionConsumerService();


public function setAssertionConsumerService($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 3 );


secureblackbox_samlspserver_set($res, 3, $value );

Default Value

'/sp/AssertionConsumerService'

Remarks

The Assertion Consumer Service (ACS) is the location that accepts SAML responses (artifacts) to establish a session based on assertions.

Data Type

String

AssertionConsumerServiceBindings Property (SecureBlackbox_SAMLSPServer Class)

Bindings supported by the Assertion Consumer Service.

Object Oriented Interface

public function getAssertionConsumerServiceBindings();


public function setAssertionConsumerServiceBindings($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 4 );


secureblackbox_samlspserver_set($res, 4, $value );

Default Value

'+Artifact,+POST,+Redirect'

Remarks

Use this property to specify the bindings for the Assertion Consumer Service (ACS) provided by this SP.

Data Type

String

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, 5 );


secureblackbox_samlspserver_set($res, 5, $value );

Default Value

''

Remarks

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

Data Type

String

ClientAuth Property (SecureBlackbox_SAMLSPServer Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getClientAuth();


public function setClientAuth($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 6 );


secureblackbox_samlspserver_set($res, 6, $value );

Default Value

0

Remarks

Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;

Data Type

Integer

EncryptionCertBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getEncryptionCertBytes();

Procedural Interface

secureblackbox_samlspserver_get($res, 7 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

EncryptionCertHandle Property (SecureBlackbox_SAMLSPServer Class)

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

Object Oriented Interface

public function getEncryptionCertHandle();


public function setEncryptionCertHandle($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 14 );


secureblackbox_samlspserver_set($res, 14, $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

ErrorOrigin Property (SecureBlackbox_SAMLSPServer Class)

Indicates the endpoint where the error originates from.

Object Oriented Interface

public function getErrorOrigin();


public function setErrorOrigin($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 41 );


secureblackbox_samlspserver_set($res, 41, $value );

Default Value

0

Remarks

Use this property to establish whether the reported error originates from a local or remote endpoint.

This property is not available at design time.

Data Type

Integer

ErrorSeverity Property (SecureBlackbox_SAMLSPServer Class)

The severity of the error that happened.

Object Oriented Interface

public function getErrorSeverity();


public function setErrorSeverity($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 42 );


secureblackbox_samlspserver_set($res, 42, $value );

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

This property is not available at design time.

Data Type

Integer

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, 43 );


secureblackbox_samlspserver_set($res, 43, $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, 44 );


secureblackbox_samlspserver_set($res, 44, $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, 45 );


secureblackbox_samlspserver_set($res, 45, $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, 46 );


secureblackbox_samlspserver_set($res, 46, $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, 47 );


secureblackbox_samlspserver_set($res, 47, $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, 48 );


secureblackbox_samlspserver_set($res, 48, $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, 49 );


secureblackbox_samlspserver_set($res, 49, $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, 50 );


secureblackbox_samlspserver_set($res, 50, $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, 51 );


secureblackbox_samlspserver_set($res, 51, $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, 52 );


secureblackbox_samlspserver_set($res, 52, $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, 53 );


secureblackbox_samlspserver_set($res, 53, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

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, 54 );


secureblackbox_samlspserver_set($res, 54, $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

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, 55 );


secureblackbox_samlspserver_set($res, 55, $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

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, 56 );


secureblackbox_samlspserver_set($res, 56, $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, 57 );


secureblackbox_samlspserver_set($res, 57, $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, 58 );

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, 65 );


secureblackbox_samlspserver_set($res, 65, $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, 92 );


secureblackbox_samlspserver_set($res, 92, $value );

Default Value

false

Remarks

In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be provided via the ProcessGenericRequest calls.

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

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, 93 );


secureblackbox_samlspserver_set($res, 93, $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

PreferredIDPToSPBinding Property (SecureBlackbox_SAMLSPServer Class)

Specifies the preferred IdP to SP binding.

Object Oriented Interface

public function getPreferredIDPToSPBinding();


public function setPreferredIDPToSPBinding($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 94 );


secureblackbox_samlspserver_set($res, 94, $value );

Default Value

4

Remarks

Specifies the preferred binding (message exchange mechanism) used for communication with Identity Provider (IdP).

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, 95 );


secureblackbox_samlspserver_set($res, 95, $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, 96 );


secureblackbox_samlspserver_set($res, 96, $value );

Default Value

'https://secureblackbox.com'

Remarks

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

Data Type

String

ServerCertCount Property (SecureBlackbox_SAMLSPServer Class)

The number of records in the ServerCert arrays.

Object Oriented Interface

public function getServerCertCount();


public function setServerCertCount($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 97 );


secureblackbox_samlspserver_set($res, 97, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerCertBytes
• ServerCertHandle

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

This property is not available at design time.

Data Type

Integer

ServerCertBytes Property (SecureBlackbox_SAMLSPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getServerCertBytes($servercertindex);

Procedural Interface

secureblackbox_samlspserver_get($res, 98 , $servercertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ServerCertHandle Property (SecureBlackbox_SAMLSPServer Class)

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

Object Oriented Interface

public function getServerCertHandle($servercertindex);


public function setServerCertHandle($servercertindex, $value);

Procedural Interface

secureblackbox_samlspserver_get($res, 105 , $servercertindex);


secureblackbox_samlspserver_set($res, 105, $value , $servercertindex);

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 $servercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

This property is not available at design time.

Data Type

Long64

SigCanonicalizationMethod Property (SecureBlackbox_SAMLSPServer Class)

The canonicalization method to use in the signature.

Object Oriented Interface

public function getSigCanonicalizationMethod();


public function setSigCanonicalizationMethod($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 132 );


secureblackbox_samlspserver_set($res, 132, $value );

Default Value

''

Remarks

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

Data Type

String

SigDigestMethod Property (SecureBlackbox_SAMLSPServer Class)

The digest method to use.

Object Oriented Interface

public function getSigDigestMethod();


public function setSigDigestMethod($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 133 );


secureblackbox_samlspserver_set($res, 133, $value );

Default Value

''

Remarks

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

Data Type

String

SigMethod Property (SecureBlackbox_SAMLSPServer Class)

The signature method to use.

Object Oriented Interface

public function getSigMethod();


public function setSigMethod($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 134 );


secureblackbox_samlspserver_set($res, 134, $value );

Default Value

''

Remarks

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

Data Type

String

SignArtifactResolveRequests Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether to sign artifact resolution requests.

Object Oriented Interface

public function getSignArtifactResolveRequests();


public function setSignArtifactResolveRequests($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 135 );


secureblackbox_samlspserver_set($res, 135, $value );

Default Value

false

Remarks

Set this property to true to enable signing of artifact resolution requests.

Data Type

Boolean

SignAuthnRequests Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether to sign Authn requests.

Object Oriented Interface

public function getSignAuthnRequests();


public function setSignAuthnRequests($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 136 );


secureblackbox_samlspserver_set($res, 136, $value );

Default Value

false

Remarks

Set this property to true to enable signing of Authn requests.

Data Type

Boolean

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, 137 );

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, 144 );


secureblackbox_samlspserver_set($res, 144, $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, 171 );


secureblackbox_samlspserver_set($res, 171, $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, 172 , $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, 179 , $signingchainindex);


secureblackbox_samlspserver_set($res, 179, $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

SignLogoutRequests Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether to sign Logout requests.

Object Oriented Interface

public function getSignLogoutRequests();


public function setSignLogoutRequests($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 206 );


secureblackbox_samlspserver_set($res, 206, $value );

Default Value

false

Remarks

Set this property to true to enable signing of logout requests.

Data Type

Boolean

SignMetadata Property (SecureBlackbox_SAMLSPServer Class)

Specifies whether to sign the metadata.

Object Oriented Interface

public function getSignMetadata();


public function setSignMetadata($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 207 );


secureblackbox_samlspserver_set($res, 207, $value );

Default Value

false

Remarks

Set this property to True to enforce signing of the metadata before saving it. Do not forget to assign the signing certificate to the MetaSigningCertificate property.

Data Type

Boolean

SingleLogoutService Property (SecureBlackbox_SAMLSPServer Class)

The URL of the single logout service.

Object Oriented Interface

public function getSingleLogoutService();


public function setSingleLogoutService($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 208 );


secureblackbox_samlspserver_set($res, 208, $value );

Default Value

'/sp/SingleLogoutService'

Remarks

Use this property to specify the relative URL of the single logout service.

Data Type

String

SingleLogoutServiceBindings Property (SecureBlackbox_SAMLSPServer Class)

Defines single logout service bindings.

Object Oriented Interface

public function getSingleLogoutServiceBindings();


public function setSingleLogoutServiceBindings($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 209 );


secureblackbox_samlspserver_set($res, 209, $value );

Default Value

'+Artifact,+POST,+Redirect'

Remarks

Use this property to specify the single logout service bindings.

The binding is the mechanism of message exchange used by SAML requestors and responders.

Data Type

String

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, 215 );


secureblackbox_samlspserver_set($res, 215, $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, 216 );


secureblackbox_samlspserver_set($res, 216, $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, 217 );


secureblackbox_samlspserver_set($res, 217, $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, 218 );


secureblackbox_samlspserver_set($res, 218, $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, 219 );


secureblackbox_samlspserver_set($res, 219, $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, 220 );


secureblackbox_samlspserver_set($res, 220, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SPToIDPBinding Property (SecureBlackbox_SAMLSPServer Class)

Specifies the IdP to SP binding to use.

Object Oriented Interface

public function getSPToIDPBinding();


public function setSPToIDPBinding($value);

Procedural Interface

secureblackbox_samlspserver_get($res, 221 );


secureblackbox_samlspserver_set($res, 221, $value );

Default Value

3

Remarks

Specifies the binding (message exchange mechanism) used for communication with Identity Provider (IdP) that is actually used during the session.

To specify the preferred binding, use PreferredIDPToSPBinding.

Data Type

Integer

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, 222 );


secureblackbox_samlspserver_set($res, 222, $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, 223 );


secureblackbox_samlspserver_set($res, 223, $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, 224 );


secureblackbox_samlspserver_set($res, 224, $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

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, 225 );


secureblackbox_samlspserver_set($res, 225, $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, 226 );


secureblackbox_samlspserver_set($res, 226, $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, 227 );


secureblackbox_samlspserver_set($res, 227, $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, 228 );


secureblackbox_samlspserver_set($res, 228, $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, 229 );


secureblackbox_samlspserver_set($res, 229, $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, 230 );


secureblackbox_samlspserver_set($res, 230, $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, 231 );


secureblackbox_samlspserver_set($res, 231, $value );

Default Value

0

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, 232 );


secureblackbox_samlspserver_set($res, 232, $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, 233 );


secureblackbox_samlspserver_set($res, 233, $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, 234 );


secureblackbox_samlspserver_set($res, 234, $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, 235 );


secureblackbox_samlspserver_set($res, 235, $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, 236 );


secureblackbox_samlspserver_set($res, 236, $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, 237 );


secureblackbox_samlspserver_set($res, 237, $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, 238 );


secureblackbox_samlspserver_set($res, 238, $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

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;....

GetClientBuffer Method (SecureBlackbox_SAMLSPServer Class)

Obtains a pending connection buffer.

Object Oriented Interface

public function doGetClientBuffer($connectionid);

Procedural Interface

secureblackbox_samlspserver_do_getclientbuffer($res, $connectionid);

Remarks

Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.

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

LoadIDPMetadata Method (SecureBlackbox_SAMLSPServer Class)

Loads the metadata required for information exchange with the identity provider.

Object Oriented Interface

public function doLoadIDPMetadata($filename);

Procedural Interface

secureblackbox_samlspserver_do_loadidpmetadata($res, $filename);

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.

FileName specifies the metadata file name.

ProcessGenericRequest Method (SecureBlackbox_SAMLSPServer Class)

Processes a generic HTTP SAML request.

Object Oriented Interface

public function doProcessGenericRequest($request);

Procedural Interface

secureblackbox_samlspserver_do_processgenericrequest($res, $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 returned value 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.

SaveMetadata Method (SecureBlackbox_SAMLSPServer Class)

Saves the SP configuration to a metadata file.

Object Oriented Interface

public function doSaveMetadata($filename);

Procedural Interface

secureblackbox_samlspserver_do_savemetadata($res, $filename);

Remarks

Use this method to save the Service Provider (SP) configuration in the form of XML metadata in the file specified by FileName. This file may be transferred to identity providers (IdP) to adjust their interaction processes.

SetClientBuffer Method (SecureBlackbox_SAMLSPServer Class)

Commits a data buffer to the connection.

Object Oriented Interface

public function doSetClientBuffer($connectionid, $value);

Procedural Interface

secureblackbox_samlspserver_do_setclientbuffer($res, $connectionid, $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

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.

AssertionCreated Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application about the creation of a new assertion.

Object Oriented Interface

public function fireAssertionCreated($param);

Procedural Interface

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

Parameter List

 'connectionid'
 'assertionorigin'
 'assertiontype'
 'content'

Remarks

Use this event to track the creation of a new SAML assertion (upon request from the browser or the IdP).

The ConnectionID identifies the connection that requested the assertion. AssertionOrigin and AssertionType specify the type of assertion that was prepared and its disposition, and Content contains the body of the assertion. You can alter the body if required, but please keep in mind that changes may invalidate signed assertions.

AssertionReceived Event (SecureBlackbox_SAMLSPServer Class)

Notifies the user code about the receipt of an assertion.

Object Oriented Interface

public function fireAssertionReceived($param);

Procedural Interface

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

Parameter List

 'connectionid'
 'assertionorigin'
 'content'

Remarks

Use this event to track the receipt of a SAML assertion from the remote party.

The ConnectionID identifies the connection that requested the assertion. AssertionOrigin specifies the disposition of the assertion, and Content contains its body. You can alter the body if required, but please keep in mind that changes may invalidate signed assertions.

Connect Event (SecureBlackbox_SAMLSPServer Class)

Reports an accepted connection.

Object Oriented Interface

public function fireConnect($param);

Procedural Interface

secureblackbox_samlspserver_register_callback($res, 4, 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, 5, array($this, 'fireDisconnect'));

Parameter List

 'connectionid'

Remarks

The class fires this event when a connected client disconnects.

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, 6, array($this, 'fireError'));

Parameter List

 'errorcode'
 '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, 7, 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(); };

MetadataRequest Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application about the metadata request.

Object Oriented Interface

public function fireMetadataRequest($param);

Procedural Interface

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

Parameter List

 'connectionid'
 'metadata'

Remarks

The class uses this event to notify the application about an incoming metadata request. The suggested metadata text is provided through the Metadata parameter. The application can adjust it as required if it needs to.

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, 9, 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.

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, 10, array($this, 'fireResourceClose'));

Parameter List

 'connectionid'

Remarks

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

After closing the resource, set the OperationStatus according to the outcome of the operation.

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, 11, array($this, 'fireResourceOpen'));

Parameter List

 'connectionid'
 'url'
 'operationstatus'

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, 12, array($this, 'fireResourceRead'));

Parameter List

 'connectionid'
 '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, 13, array($this, 'fireResourceRequest'));

Parameter List

 'connectionid'
 'url'
 'resprotected'
 'resspecial'
 '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:

SessionClosed Event (SecureBlackbox_SAMLSPServer Class)

This event is fired when the SP server has closed a session.

Object Oriented Interface

public function fireSessionClosed($param);

Procedural Interface

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

Parameter List

 'connectionid'

Remarks

ConnectionID contains the identifier of the closed session.

SessionEstablished Event (SecureBlackbox_SAMLSPServer Class)

This event is fired when a new session has been established.

Object Oriented Interface

public function fireSessionEstablished($param);

Procedural Interface

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

Parameter List

 'connectionid'
 'username'

Remarks

ConnectionID contains the identifier of the new session, Username specifies the client's address and Username.

SessionStageChanged Event (SecureBlackbox_SAMLSPServer Class)

Notifies the application about the change of SAML session stage.

Object Oriented Interface

public function fireSessionStageChanged($param);

Procedural Interface

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

Parameter List

 'connectionid'
 'session'
 'stage'

Remarks

class uses this method to notify your code about changed SAML session stage. The Session parameter specifies the session ID. The Stage parameter can take one of the following values:

• Start
• AuthnRequestSent
• ResponseReceived
• ResourceSupplied
• LogoutRequestSent
• LogoutResponseReceived
• LogoutRequestRecv
• LogoutResponseSent
• ArtifactResolveRecv
• ArtifactResponseSent
• Finish

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

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	30408705   Invalid binging name (SB_ERROR_SAML_INVALID_BINDING_NAME)
	30408706   Invalid binding type (SB_ERROR_SAML_INVALID_BINDING_TYPE)
	30408707   Base directory not set (SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET)