SAMLIdPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLIdPServer class represents a SAML identity provider.

Class Name

SecureBlackbox_SAMLIdPServer

Procedural Interface

 secureblackbox_samlidpserver_open();
 secureblackbox_samlidpserver_close($res);
 secureblackbox_samlidpserver_register_callback($res, $id, $function);
 secureblackbox_samlidpserver_get_last_error($res);
 secureblackbox_samlidpserver_get_last_error_code($res);
 secureblackbox_samlidpserver_set($res, $id, $index, $value);
 secureblackbox_samlidpserver_get($res, $id, $index);
 secureblackbox_samlidpserver_do_addidpservice($res, $service, $bindingtype, $location, $priority, $index);
 secureblackbox_samlidpserver_do_addsp($res, $entityid, $idpssolink);
 secureblackbox_samlidpserver_do_addspservice($res, $service, $bindingtype, $location, $priority, $index, $entityid);
 secureblackbox_samlidpserver_do_completeauth($res, $connectionid, $sessionid, $sp, $relaystate, $tag);
 secureblackbox_samlidpserver_do_config($res, $configurationstring);
 secureblackbox_samlidpserver_do_doaction($res, $actionid, $actionparams);
 secureblackbox_samlidpserver_do_dropclient($res, $connectionid, $forced);
 secureblackbox_samlidpserver_do_exportsettings($res, $idp, $index);
 secureblackbox_samlidpserver_do_getproviderproperty($res, $name);
 secureblackbox_samlidpserver_do_getrequestbytes($res, $connectionid, $requestfilter);
 secureblackbox_samlidpserver_do_getrequestheader($res, $connectionid, $headername);
 secureblackbox_samlidpserver_do_getresponseheader($res, $connectionid, $headername);
 secureblackbox_samlidpserver_do_getsessionproperty($res, $sessionid, $name);
 secureblackbox_samlidpserver_do_importsettings($res, $metadata, $idp);
 secureblackbox_samlidpserver_do_initiateauth($res, $connectionid, $sessionid, $tag);
 secureblackbox_samlidpserver_do_initiatelogout($res, $connectionid, $sessionid, $sp, $tag);
 secureblackbox_samlidpserver_do_listclients($res);
 secureblackbox_samlidpserver_do_pinclient($res, $connectionid);
 secureblackbox_samlidpserver_do_processartifactresolverequest($res, $connectionid, $sessionid, $request, $tag);
 secureblackbox_samlidpserver_do_processattributequery($res, $connectionid, $sessionid, $request, $tag);
 secureblackbox_samlidpserver_do_processgenericrequest($res, $connectionid, $sessionid, $url, $httpmethod, $request, $tag);
 secureblackbox_samlidpserver_do_processlogoutrequest($res, $connectionid, $sessionid, $request, $tag);
 secureblackbox_samlidpserver_do_processsignonrequest($res, $connectionid, $sessionid, $request, $tag);
 secureblackbox_samlidpserver_do_processsignonresponse($res, $connectionid, $sessionid, $response, $tag);
 secureblackbox_samlidpserver_do_removesp($res, $index);
 secureblackbox_samlidpserver_do_reset($res);
 secureblackbox_samlidpserver_do_setclientbuffer($res, $connectionid, $value);
 secureblackbox_samlidpserver_do_setproviderproperty($res, $name, $value);
 secureblackbox_samlidpserver_do_setresponseheader($res, $connectionid, $headername, $value);
 secureblackbox_samlidpserver_do_setsessionproperty($res, $sessionid, $name, $value);
 secureblackbox_samlidpserver_do_start($res);
 secureblackbox_samlidpserver_do_stop($res);

Remarks

The identity provider in the SAML (Security Assertion Markup Language) exchange flow represents the server that issues authentication assertions for single sign-on (SSO).

Requests received by the IdP server from known service providers (SP) are processed automatically, in accordance with known SP metadata and IdP options. If the request is correct, the client is redirected to the IdP for authentication. The authentication algorithm depends on the IdP options and may be reduced to a simple IP check, X.509 certificate authentication, or login credentials check. TBD: article comparing two approaches to working with SAML (reader/writer and servers)

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getActive();

Procedural Interface

secureblackbox_samlidpserver_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

AllowIDPSSO Property (SecureBlackbox_SAMLIdPServer Class)

Specifies if IdP-initiated Single Sign-On (SSO) is allowed.

Object Oriented Interface

public function getAllowIDPSSO();


public function setAllowIDPSSO($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 2 );


secureblackbox_samlidpserver_set($res, 2, $value );

Default Value

false

Remarks

Set this property to true to allow IdP-initiated Single Sign-Ons. Use the IdPSSOLink parameter of AddSP method to add sign-on URLs.

Data Type

Boolean

BaseDir Property (SecureBlackbox_SAMLIdPServer Class)

Base directory on the server.

Object Oriented Interface

public function getBaseDir();


public function setBaseDir($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 3 );


secureblackbox_samlidpserver_set($res, 3, $value );

Default Value

''

Remarks

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

Data Type

String

BindingKeyHandle Property (SecureBlackbox_SAMLIdPServer 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_samlidpserver_get($res, 9 );


secureblackbox_samlidpserver_set($res, 9, $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_SAMLIdPServer Class)

The byte array representation of the key.

Object Oriented Interface

public function getBindingKeyKey();

Procedural Interface

secureblackbox_samlidpserver_get($res, 12 );

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

EncryptionCertBytes Property (SecureBlackbox_SAMLIdPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getEncryptionCertBytes();

Procedural Interface

secureblackbox_samlidpserver_get($res, 19 );

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_SAMLIdPServer 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_samlidpserver_get($res, 27 );


secureblackbox_samlidpserver_set($res, 27, $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 58 );


secureblackbox_samlidpserver_set($res, 58, $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 59 );


secureblackbox_samlidpserver_set($res, 59, $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_SAMLIdPServer 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_samlidpserver_get($res, 60 );


secureblackbox_samlidpserver_set($res, 60, $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_SAMLIdPServer 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_samlidpserver_get($res, 61 );


secureblackbox_samlidpserver_set($res, 61, $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_SAMLIdPServer Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 62 );


secureblackbox_samlidpserver_set($res, 62, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_SAMLIdPServer 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_samlidpserver_get($res, 63 );


secureblackbox_samlidpserver_set($res, 63, $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_SAMLIdPServer Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 64 );


secureblackbox_samlidpserver_set($res, 64, $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_SAMLIdPServer Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 65 );


secureblackbox_samlidpserver_set($res, 65, $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_SAMLIdPServer Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 66 );


secureblackbox_samlidpserver_set($res, 66, $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_SAMLIdPServer 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_samlidpserver_get($res, 67 );


secureblackbox_samlidpserver_set($res, 67, $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_SAMLIdPServer Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 68 );


secureblackbox_samlidpserver_set($res, 68, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HandshakeTimeout Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the handshake timeout in milliseconds.

Object Oriented Interface

public function getHandshakeTimeout();


public function setHandshakeTimeout($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 69 );


secureblackbox_samlidpserver_set($res, 69, $value );

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

Host Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the host address of the IdP server.

Object Oriented Interface

public function getHost();


public function setHost($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 70 );


secureblackbox_samlidpserver_set($res, 70, $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_SAMLIdPServer Class)

The number of records in the IdPService arrays.

Object Oriented Interface

public function getIdPServiceCount();

Procedural Interface

secureblackbox_samlidpserver_get($res, 71 );

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_SAMLIdPServer Class)

Specifies the type of SAML binding that this endpoint accepts.

Object Oriented Interface

public function getIdPServiceBindingType($idpserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 72 , $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_SAMLIdPServer Class)

Represents the SAML entity ID.

Object Oriented Interface

public function getIdPServiceEntityID($idpserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 73 , $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_SAMLIdPServer Class)

The location (URL) of the endpoint.

Object Oriented Interface

public function getIdPServiceLocation($idpserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 74 , $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_SAMLIdPServer 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_samlidpserver_get($res, 75 , $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_SAMLIdPServer Class)

The kind of the service being provided at this endpoint.

Object Oriented Interface

public function getIdPServiceService($idpserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 76 , $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_SAMLIdPServer Class)

The index of this endpoint.

Object Oriented Interface

public function getIdPServiceServiceIndex($idpserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 77 , $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_SAMLIdPServer Class)

The contact person or persons for the entity.

Object Oriented Interface

public function getIdPContactPerson();


public function setIdPContactPerson($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 78 );


secureblackbox_samlidpserver_set($res, 78, $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_SAMLIdPServer Class)

Contains the entity's encryption key.

Object Oriented Interface

public function getIdPEncryptionKey();


public function setIdPEncryptionKey($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 79 );


secureblackbox_samlidpserver_set($res, 79, $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. TBD:

This property is not available at design time.

Data Type

String

IdPEncryptionMethods Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the list of encryption methods supported by the entity.

Object Oriented Interface

public function getIdPEncryptionMethods();


public function setIdPEncryptionMethods($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 80 );


secureblackbox_samlidpserver_set($res, 80, $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_SAMLIdPServer Class)

Represents the SAML entity ID.

Object Oriented Interface

public function getIdPEntityID();


public function setIdPEntityID($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 81 );


secureblackbox_samlidpserver_set($res, 81, $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_SAMLIdPServer Class)

Adjusts secondary entity properties.

Object Oriented Interface

public function getIdPFlags();


public function setIdPFlags($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 82 );


secureblackbox_samlidpserver_set($res, 82, $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_SAMLIdPServer 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_samlidpserver_get($res, 83 );


secureblackbox_samlidpserver_set($res, 83, $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. TBD:

This property is not available at design time.

Data Type

String

IdPNameIDFormats Property (SecureBlackbox_SAMLIdPServer Class)

The list of NameID formats supported by this entity.

Object Oriented Interface

public function getIdPNameIDFormats();


public function setIdPNameIDFormats($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 84 );


secureblackbox_samlidpserver_set($res, 84, $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_SAMLIdPServer Class)

The friendly name of the organization that maintains the entity.

Object Oriented Interface

public function getIdPOrganizationDisplayName();


public function setIdPOrganizationDisplayName($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 85 );


secureblackbox_samlidpserver_set($res, 85, $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_SAMLIdPServer Class)

The language preferred by the organization.

Object Oriented Interface

public function getIdPOrganizationLang();


public function setIdPOrganizationLang($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 86 );


secureblackbox_samlidpserver_set($res, 86, $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_SAMLIdPServer Class)

The name of the organization that maintains the entity.

Object Oriented Interface

public function getIdPOrganizationName();


public function setIdPOrganizationName($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 87 );


secureblackbox_samlidpserver_set($res, 87, $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_SAMLIdPServer Class)

The web URL of the organization that maintains the entity.

Object Oriented Interface

public function getIdPOrganizationURL();


public function setIdPOrganizationURL($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 88 );


secureblackbox_samlidpserver_set($res, 88, $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_SAMLIdPServer Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getIdPSignatureValidationResult();

Procedural Interface

secureblackbox_samlidpserver_get($res, 89 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getIdPSigned();

Procedural Interface

secureblackbox_samlidpserver_get($res, 90 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getIdPSignedWith();

Procedural Interface

secureblackbox_samlidpserver_get($res, 91 );

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_SAMLIdPServer Class)

Contains the entity's signing key.

Object Oriented Interface

public function getIdPSigningKey();


public function setIdPSigningKey($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 92 );


secureblackbox_samlidpserver_set($res, 92, $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.

TBD: TBD: rename to SigningCert? and EncryptionKey to EncryptionCert?

This property is not available at design time.

Data Type

String

IdPValidUntil Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the expiration time of the SAML entity information.

Object Oriented Interface

public function getIdPValidUntil();


public function setIdPValidUntil($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 93 );


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

IdPSSOPage Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the relative URL of the IdP-initiated SSO page.

Object Oriented Interface

public function getIdPSSOPage();


public function setIdPSSOPage($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 94 );


secureblackbox_samlidpserver_set($res, 94, $value );

Default Value

'/idpsso'

Remarks

Use this property to specify the address of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP). TBD:

Data Type

String

IdPSSOPageTemplate Property (SecureBlackbox_SAMLIdPServer Class)

The content of the IdP-initiated SSO page.

Object Oriented Interface

public function getIdPSSOPageTemplate();


public function setIdPSSOPageTemplate($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 95 );


secureblackbox_samlidpserver_set($res, 95, $value );

Default Value

''

Remarks

Use this property to specify the content of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP).

Data Type

String

KnownCertCount Property (SecureBlackbox_SAMLIdPServer Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 96 );


secureblackbox_samlidpserver_set($res, 96, $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_SAMLIdPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 97 , $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_SAMLIdPServer 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_samlidpserver_get($res, 105 , $knowncertindex);


secureblackbox_samlidpserver_set($res, 105, $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_SAMLIdPServer Class)

The number of records in the KnownKey arrays.

Object Oriented Interface

public function getKnownKeyCount();


public function setKnownKeyCount($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 136 );


secureblackbox_samlidpserver_set($res, 136, $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_SAMLIdPServer 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_samlidpserver_get($res, 142 , $knownkeyindex);


secureblackbox_samlidpserver_set($res, 142, $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

LoginAttemptsLimit Property (SecureBlackbox_SAMLIdPServer Class)

The maximum number of login attempts.

Object Oriented Interface

public function getLoginAttemptsLimit();


public function setLoginAttemptsLimit($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 152 );


secureblackbox_samlidpserver_set($res, 152, $value );

Default Value

3

Remarks

Use this property to set the maximum number of login attempts.

Data Type

Integer

MetadataURL Property (SecureBlackbox_SAMLIdPServer Class)

The IdP's metadata location.

Object Oriented Interface

public function getMetadataURL();


public function setMetadataURL($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 153 );


secureblackbox_samlidpserver_set($res, 153, $value );

Default Value

'/idp/metadata'

Remarks

This property specifies the metadata URL of this Identity Provider (IdP).

Data Type

String

MetaSigningCertBytes Property (SecureBlackbox_SAMLIdPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getMetaSigningCertBytes();

Procedural Interface

secureblackbox_samlidpserver_get($res, 154 );

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_SAMLIdPServer 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_samlidpserver_get($res, 162 );


secureblackbox_samlidpserver_set($res, 162, $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_SAMLIdPServer Class)

Enables the Offline mode.

Object Oriented Interface

public function getOfflineMode();


public function setOfflineMode($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 193 );


secureblackbox_samlidpserver_set($res, 193, $value );

Default Value

true

Remarks

In the Offline mode the server does not open the listening port. Instead, it expects incoming requests to be routed by the application via calls to ProcessSignOnRequest, ProcessLogoutRequest, ProcessSignOnResponse, 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 requests.

Data Type

Boolean

PinnedClientAEADCipher Property (SecureBlackbox_SAMLIdPServer Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Object Oriented Interface

public function getPinnedClientAEADCipher();

Procedural Interface

secureblackbox_samlidpserver_get($res, 194 );

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_SAMLIdPServer Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getPinnedClientChainValidationDetails();

Procedural Interface

secureblackbox_samlidpserver_get($res, 195 );

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_SAMLIdPServer Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getPinnedClientChainValidationResult();

Procedural Interface

secureblackbox_samlidpserver_get($res, 196 );

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_SAMLIdPServer Class)

The cipher suite employed by this connection.

Object Oriented Interface

public function getPinnedClientCiphersuite();

Procedural Interface

secureblackbox_samlidpserver_get($res, 197 );

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_SAMLIdPServer Class)

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getPinnedClientClientAuthenticated();

Procedural Interface

secureblackbox_samlidpserver_get($res, 198 );

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_SAMLIdPServer Class)

Specifies whether client authentication was requested during this connection.

Object Oriented Interface

public function getPinnedClientClientAuthRequested();

Procedural Interface

secureblackbox_samlidpserver_get($res, 199 );

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_SAMLIdPServer Class)

Indicates whether the connection has been established fully.

Object Oriented Interface

public function getPinnedClientConnectionEstablished();

Procedural Interface

secureblackbox_samlidpserver_get($res, 200 );

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_SAMLIdPServer Class)

The unique identifier assigned to this connection.

Object Oriented Interface

public function getPinnedClientConnectionID();

Procedural Interface

secureblackbox_samlidpserver_get($res, 201 );

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_SAMLIdPServer Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getPinnedClientDigestAlgorithm();

Procedural Interface

secureblackbox_samlidpserver_get($res, 202 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientEncryptionAlgorithm();

Procedural Interface

secureblackbox_samlidpserver_get($res, 203 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientExportable();

Procedural Interface

secureblackbox_samlidpserver_get($res, 204 );

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_SAMLIdPServer Class)

The client connection's unique identifier.

Object Oriented Interface

public function getPinnedClientID();

Procedural Interface

secureblackbox_samlidpserver_get($res, 205 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_samlidpserver_get($res, 206 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientKeyExchangeKeyBits();

Procedural Interface

secureblackbox_samlidpserver_get($res, 207 );

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_SAMLIdPServer Class)

The elliptic curve used in this connection.

Object Oriented Interface

public function getPinnedClientNamedECCurve();

Procedural Interface

secureblackbox_samlidpserver_get($res, 208 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientPFSCipher();

Procedural Interface

secureblackbox_samlidpserver_get($res, 209 );

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_SAMLIdPServer 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_samlidpserver_get($res, 210 );

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_SAMLIdPServer 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_samlidpserver_get($res, 211 );

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_SAMLIdPServer Class)

The length of the public key.

Object Oriented Interface

public function getPinnedClientPublicKeyBits();

Procedural Interface

secureblackbox_samlidpserver_get($res, 212 );

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_SAMLIdPServer Class)

The client's IP address.

Object Oriented Interface

public function getPinnedClientRemoteAddress();

Procedural Interface

secureblackbox_samlidpserver_get($res, 213 );

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_SAMLIdPServer Class)

The remote port of the client connection.

Object Oriented Interface

public function getPinnedClientRemotePort();

Procedural Interface

secureblackbox_samlidpserver_get($res, 214 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientResumedSession();

Procedural Interface

secureblackbox_samlidpserver_get($res, 215 );

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_SAMLIdPServer Class)

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getPinnedClientSecureConnection();

Procedural Interface

secureblackbox_samlidpserver_get($res, 216 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientServerAuthenticated();

Procedural Interface

secureblackbox_samlidpserver_get($res, 217 );

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_SAMLIdPServer Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getPinnedClientSignatureAlgorithm();

Procedural Interface

secureblackbox_samlidpserver_get($res, 218 );

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_SAMLIdPServer Class)

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getPinnedClientSymmetricBlockSize();

Procedural Interface

secureblackbox_samlidpserver_get($res, 219 );

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_SAMLIdPServer Class)

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getPinnedClientSymmetricKeyBits();

Procedural Interface

secureblackbox_samlidpserver_get($res, 220 );

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_SAMLIdPServer Class)

The total number of bytes received over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesReceived();

Procedural Interface

secureblackbox_samlidpserver_get($res, 221 );

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_SAMLIdPServer Class)

The total number of bytes sent over this connection.

Object Oriented Interface

public function getPinnedClientTotalBytesSent();

Procedural Interface

secureblackbox_samlidpserver_get($res, 222 );

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_SAMLIdPServer Class)

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getPinnedClientValidationLog();

Procedural Interface

secureblackbox_samlidpserver_get($res, 223 );

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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientVersion();

Procedural Interface

secureblackbox_samlidpserver_get($res, 224 );

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_SAMLIdPServer Class)

The number of records in the PinnedClientCert arrays.

Object Oriented Interface

public function getPinnedClientCertCount();

Procedural Interface

secureblackbox_samlidpserver_get($res, 225 );

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_SAMLIdPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getPinnedClientCertBytes($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 226 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertCAKeyID($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 228 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertFingerprint($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 232 , $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_SAMLIdPServer 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_samlidpserver_get($res, 234 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertIssuer($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 236 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertIssuerRDN($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 237 , $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_SAMLIdPServer Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getPinnedClientCertKeyAlgorithm($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 238 , $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_SAMLIdPServer Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getPinnedClientCertKeyBits($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 239 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertKeyFingerprint($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 240 , $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_SAMLIdPServer 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_samlidpserver_get($res, 241 , $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_SAMLIdPServer Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getPinnedClientCertPublicKeyBytes($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 250 , $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_SAMLIdPServer 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_samlidpserver_get($res, 254 , $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_SAMLIdPServer Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getPinnedClientCertSerialNumber($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 255 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertSigAlgorithm($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 256 , $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_SAMLIdPServer 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_samlidpserver_get($res, 258 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertSubjectKeyID($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 260 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertSubjectRDN($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 261 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertValidFrom($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 263 , $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getPinnedClientCertValidTo($pinnedclientcertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 264 , $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_SAMLIdPServer Class)

The listening port number.

Object Oriented Interface

public function getPort();


public function setPort($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 265 );


secureblackbox_samlidpserver_set($res, 265, $value );

Default Value

80

Remarks

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

Data Type

Integer

SecurityCanonicalizationMethod Property (SecureBlackbox_SAMLIdPServer Class)

The canonicalization method to use in the signature.

Object Oriented Interface

public function getSecurityCanonicalizationMethod();


public function setSecurityCanonicalizationMethod($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 266 );


secureblackbox_samlidpserver_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_SAMLIdPServer Class)

The digest method to use.

Object Oriented Interface

public function getSecurityDigestMethod();


public function setSecurityDigestMethod($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 267 );


secureblackbox_samlidpserver_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_SAMLIdPServer Class)

The encryption method used to encrypt the assertion.

Object Oriented Interface

public function getSecurityEncryptionMethod();


public function setSecurityEncryptionMethod($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 268 );


secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Provides access to secondary security parameters and tweaks.

Object Oriented Interface

public function getSecurityFlags();


public function setSecurityFlags($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 269 );


secureblackbox_samlidpserver_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):

• ssfSignatureAfterIssuer (0x00000001) - Signature after issuer
• ssfSignatureBeforeDescriptor (0x00000002) - Signature before descriptor
• ssfKeyDataIssuerSerial (0x00000004) - Include the IssuerSerial key data element
• ssfKeyDataSKI (0x00000008) - Include the SubjectKeyIdentifier key data element
• ssfKeyDataSubjectName (0x00000010) - Include the SubjectName key data element
• ssfKeyDataCertificate (0x00000020) - Include the Certificate key data element
• ssfKeyDataCRL (0x00000040) - Include the CRL key data element

The following flags can be used with SAMLSPServer only

• ssfSignAuthnRequests (0x00010000) - Sign authentication requests
• ssfSignArtifactResolveRequests (0x00020000) - Sign artifact resolve requests
• ssfSignLogoutRequests (0x00040000) - Sign logout requests

The following flags can be used with SAMLIdPServer only

• ssfSignAssertions (0x00080000) - Sign outgoing assertions
• ssfSignResponses (0x00100000) - Sign all responses
• ssfEncryptAssertions (0x00200000) - Encrypt generated assertions

TBD define enum

This property is not available at design time.

Data Type

Integer

SecuritySigMethod Property (SecureBlackbox_SAMLIdPServer Class)

The signature method to use.

Object Oriented Interface

public function getSecuritySigMethod();


public function setSecuritySigMethod($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 270 );


secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Specifies the signature validation policy.

Object Oriented Interface

public function getSecuritySignaturePolicy();


public function setSecuritySignaturePolicy($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 271 );


secureblackbox_samlidpserver_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_SAMLIdPServer Class)

The number of records in the SenderChain arrays.

Object Oriented Interface

public function getSenderCertCount();

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSenderChainBytes($sendercertindex);

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer 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_samlidpserver_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_SAMLIdPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer 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_samlidpserver_get($res, 320 );


secureblackbox_samlidpserver_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_SAMLIdPServer Class)

The number of records in the SigningChain arrays.

Object Oriented Interface

public function getSigningChainCount();


public function setSigningChainCount($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 351 );


secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningChainBytes($signingchainindex);

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer 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_samlidpserver_get($res, 360 , $signingchainindex);


secureblackbox_samlidpserver_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

SignOnPageTemplate Property (SecureBlackbox_SAMLIdPServer Class)

Defines the default authentication template (login page).

Object Oriented Interface

public function getSignOnPageTemplate();


public function setSignOnPageTemplate($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 391 );


secureblackbox_samlidpserver_set($res, 391, $value );

Default Value

''

Remarks

This property contains the HTML code of the authentication form. You can use it to control the appearance of the login page.

Data Type

String

SocketIncomingSpeedLimit Property (SecureBlackbox_SAMLIdPServer 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_samlidpserver_get($res, 397 );


secureblackbox_samlidpserver_set($res, 397, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_SAMLIdPServer Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 398 );


secureblackbox_samlidpserver_set($res, 398, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_SAMLIdPServer Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 399 );


secureblackbox_samlidpserver_set($res, 399, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_SAMLIdPServer 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_samlidpserver_get($res, 400 );


secureblackbox_samlidpserver_set($res, 400, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_SAMLIdPServer 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_samlidpserver_get($res, 401 );


secureblackbox_samlidpserver_set($res, 401, $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_SAMLIdPServer Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 402 );


secureblackbox_samlidpserver_set($res, 402, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SPServiceCount Property (SecureBlackbox_SAMLIdPServer Class)

The number of records in the SPService arrays.

Object Oriented Interface

public function getSPServiceCount();

Procedural Interface

secureblackbox_samlidpserver_get($res, 403 );

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_SAMLIdPServer Class)

Specifies the type of SAML binding that this endpoint accepts.

Object Oriented Interface

public function getSPServiceBindingType($spserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 404 , $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_SAMLIdPServer Class)

Represents the SAML entity ID.

Object Oriented Interface

public function getSPServiceEntityID($spserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 405 , $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_SAMLIdPServer Class)

The location (URL) of the endpoint.

Object Oriented Interface

public function getSPServiceLocation($spserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 406 , $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_SAMLIdPServer 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_samlidpserver_get($res, 407 , $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_SAMLIdPServer Class)

The kind of the service being provided at this endpoint.

Object Oriented Interface

public function getSPServiceService($spserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 408 , $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_SAMLIdPServer Class)

The index of this endpoint.

Object Oriented Interface

public function getSPServiceServiceIndex($spserviceindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 409 , $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

SPCount Property (SecureBlackbox_SAMLIdPServer Class)

The number of records in the SP arrays.

Object Oriented Interface

public function getSPCount();


public function setSPCount($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 410 );


secureblackbox_samlidpserver_set($res, 410, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SPContactPerson
• SPEncryptionKey
• SPEncryptionMethods
• SPEntityID
• SPFlags
• SPIdPSSOLink
• SPNameIDFormats
• SPOrganizationDisplayName
• SPOrganizationLang
• SPOrganizationName
• SPOrganizationURL
• SPServiceBindingType
• SPServiceEntityID
• SPServiceLocation
• SPServicePriority
• SPServiceService
• SPServiceServiceIndex
• SPSignatureValidationResult
• SPSigned
• SPSignedWith
• SPSigningKey
• SPValidUntil

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

This property is not available at design time.

Data Type

Integer

SPContactPerson Property (SecureBlackbox_SAMLIdPServer Class)

The contact person or persons for the entity.

Object Oriented Interface

public function getSPContactPerson($spindex);


public function setSPContactPerson($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 411 , $spindex);


secureblackbox_samlidpserver_set($res, 411, $value , $spindex);

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.

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

This property is not available at design time.

Data Type

String

SPEncryptionKey Property (SecureBlackbox_SAMLIdPServer Class)

Contains the entity's encryption key.

Object Oriented Interface

public function getSPEncryptionKey($spindex);


public function setSPEncryptionKey($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 412 , $spindex);


secureblackbox_samlidpserver_set($res, 412, $value , $spindex);

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. TBD:

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

This property is not available at design time.

Data Type

String

SPEncryptionMethods Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the list of encryption methods supported by the entity.

Object Oriented Interface

public function getSPEncryptionMethods($spindex);


public function setSPEncryptionMethods($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 413 , $spindex);


secureblackbox_samlidpserver_set($res, 413, $value , $spindex);

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

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

This property is not available at design time.

Data Type

String

SPEntityID Property (SecureBlackbox_SAMLIdPServer Class)

Represents the SAML entity ID.

Object Oriented Interface

public function getSPEntityID($spindex);


public function setSPEntityID($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 414 , $spindex);


secureblackbox_samlidpserver_set($res, 414, $value , $spindex);

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

This property is not available at design time.

Data Type

String

SPFlags Property (SecureBlackbox_SAMLIdPServer Class)

Adjusts secondary entity properties.

Object Oriented Interface

public function getSPFlags($spindex);


public function setSPFlags($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 415 , $spindex);


secureblackbox_samlidpserver_set($res, 415, $value , $spindex);

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.

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

This property is not available at design time.

Data Type

Integer

SPIdPSSOLink Property (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function getSPIdPSSOLink($spindex);


public function setSPIdPSSOLink($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 416 , $spindex);


secureblackbox_samlidpserver_set($res, 416, $value , $spindex);

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. TBD:

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

This property is not available at design time.

Data Type

String

SPNameIDFormats Property (SecureBlackbox_SAMLIdPServer Class)

The list of NameID formats supported by this entity.

Object Oriented Interface

public function getSPNameIDFormats($spindex);


public function setSPNameIDFormats($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 417 , $spindex);


secureblackbox_samlidpserver_set($res, 417, $value , $spindex);

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

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

This property is not available at design time.

Data Type

String

SPOrganizationDisplayName Property (SecureBlackbox_SAMLIdPServer Class)

The friendly name of the organization that maintains the entity.

Object Oriented Interface

public function getSPOrganizationDisplayName($spindex);


public function setSPOrganizationDisplayName($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 418 , $spindex);


secureblackbox_samlidpserver_set($res, 418, $value , $spindex);

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.

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

This property is not available at design time.

Data Type

String

SPOrganizationLang Property (SecureBlackbox_SAMLIdPServer Class)

The language preferred by the organization.

Object Oriented Interface

public function getSPOrganizationLang($spindex);


public function setSPOrganizationLang($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 419 , $spindex);


secureblackbox_samlidpserver_set($res, 419, $value , $spindex);

Default Value

''

Remarks

The language preferred by the organization.

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

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

This property is not available at design time.

Data Type

String

SPOrganizationName Property (SecureBlackbox_SAMLIdPServer Class)

The name of the organization that maintains the entity.

Object Oriented Interface

public function getSPOrganizationName($spindex);


public function setSPOrganizationName($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 420 , $spindex);


secureblackbox_samlidpserver_set($res, 420, $value , $spindex);

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.

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

This property is not available at design time.

Data Type

String

SPOrganizationURL Property (SecureBlackbox_SAMLIdPServer Class)

The web URL of the organization that maintains the entity.

Object Oriented Interface

public function getSPOrganizationURL($spindex);


public function setSPOrganizationURL($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 421 , $spindex);


secureblackbox_samlidpserver_set($res, 421, $value , $spindex);

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.

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

This property is not available at design time.

Data Type

String

SPSignatureValidationResult Property (SecureBlackbox_SAMLIdPServer Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getSPSignatureValidationResult($spindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 422 , $spindex);

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

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

Data Type

Integer

SPSigned Property (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function getSPSigned($spindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 423 , $spindex);

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.

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

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

Data Type

Boolean

SPSignedWith Property (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function getSPSignedWith($spindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 424 , $spindex);

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.

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

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

Data Type

String

SPSigningKey Property (SecureBlackbox_SAMLIdPServer Class)

Contains the entity's signing key.

Object Oriented Interface

public function getSPSigningKey($spindex);


public function setSPSigningKey($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 425 , $spindex);


secureblackbox_samlidpserver_set($res, 425, $value , $spindex);

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.

TBD: TBD: rename to SigningCert? and EncryptionKey to EncryptionCert?

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

This property is not available at design time.

Data Type

String

SPValidUntil Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the expiration time of the SAML entity information.

Object Oriented Interface

public function getSPValidUntil($spindex);


public function setSPValidUntil($spindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 426 , $spindex);


secureblackbox_samlidpserver_set($res, 426, $value , $spindex);

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.

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

This property is not available at design time.

Data Type

String

TLSServerCertCount Property (SecureBlackbox_SAMLIdPServer Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();


public function setTLSServerCertCount($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 427 );


secureblackbox_samlidpserver_set($res, 427, $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_SAMLIdPServer Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_samlidpserver_get($res, 428 , $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_SAMLIdPServer 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_samlidpserver_get($res, 436 , $tlsservercertindex);


secureblackbox_samlidpserver_set($res, 436, $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_SAMLIdPServer 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_samlidpserver_get($res, 467 );


secureblackbox_samlidpserver_set($res, 467, $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_SAMLIdPServer Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 468 );


secureblackbox_samlidpserver_set($res, 468, $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_SAMLIdPServer Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 469 );


secureblackbox_samlidpserver_set($res, 469, $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_SAMLIdPServer Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();


public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 470 );


secureblackbox_samlidpserver_set($res, 470, $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_SAMLIdPServer Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 471 );


secureblackbox_samlidpserver_set($res, 471, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_SAMLIdPServer Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 472 );


secureblackbox_samlidpserver_set($res, 472, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_SAMLIdPServer 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_samlidpserver_get($res, 473 );


secureblackbox_samlidpserver_set($res, 473, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_SAMLIdPServer 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_samlidpserver_get($res, 474 );


secureblackbox_samlidpserver_set($res, 474, $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_SAMLIdPServer 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_samlidpserver_get($res, 475 );


secureblackbox_samlidpserver_set($res, 475, $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_SAMLIdPServer Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 476 );


secureblackbox_samlidpserver_set($res, 476, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_SAMLIdPServer Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 477 );


secureblackbox_samlidpserver_set($res, 477, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 478 );


secureblackbox_samlidpserver_set($res, 478, $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. 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.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_SAMLIdPServer 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_samlidpserver_get($res, 479 );


secureblackbox_samlidpserver_set($res, 479, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 480 );


secureblackbox_samlidpserver_set($res, 480, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_SAMLIdPServer 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_samlidpserver_get($res, 481 );


secureblackbox_samlidpserver_set($res, 481, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_SAMLIdPServer Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 482 );


secureblackbox_samlidpserver_set($res, 482, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_SAMLIdPServer Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 483 );


secureblackbox_samlidpserver_set($res, 483, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

URL Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the base URL of this IdP server.

Object Oriented Interface

public function getURL();


public function setURL($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 484 );


secureblackbox_samlidpserver_set($res, 484, $value );

Default Value

''

Remarks

Use this property to set the base URL for this Identity Provider (IdP) server.

Data Type

String

UserCount Property (SecureBlackbox_SAMLIdPServer Class)

The number of records in the User arrays.

Object Oriented Interface

public function getUserCount();


public function setUserCount($value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 485 );


secureblackbox_samlidpserver_set($res, 485, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCertificate
• UserData
• UserEmail
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOtpAlgorithm
• UserOTPLen
• UserOtpValue
• UserOutgoingSpeedLimit
• UserPassword
• UserSharedSecret
• UserSSHKey
• UserUsername

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (SecureBlackbox_SAMLIdPServer Class)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Object Oriented Interface

public function getUserAssociatedData($userindex);


public function setUserAssociatedData($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 486 , $userindex);


secureblackbox_samlidpserver_set($res, 486, $value , $userindex);

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

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

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (SecureBlackbox_SAMLIdPServer Class)

Base path for this user in the server's file system.

Object Oriented Interface

public function getUserBasePath($userindex);


public function setUserBasePath($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 487 , $userindex);


secureblackbox_samlidpserver_set($res, 487, $value , $userindex);

Default Value

''

Remarks

Base path for this user in the server's file system.

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

This property is not available at design time.

Data Type

String

UserCertificate Property (SecureBlackbox_SAMLIdPServer Class)

Contains the user's certificate.

Object Oriented Interface

public function getUserCertificate($userindex);


public function setUserCertificate($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 488 , $userindex);


secureblackbox_samlidpserver_set($res, 488, $value , $userindex);

Remarks

Contains the user's certificate.

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

This property is not available at design time.

Data Type

Byte Array

UserData Property (SecureBlackbox_SAMLIdPServer Class)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Object Oriented Interface

public function getUserData($userindex);


public function setUserData($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 489 , $userindex);


secureblackbox_samlidpserver_set($res, 489, $value , $userindex);

Default Value

''

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

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

This property is not available at design time.

Data Type

String

UserEmail Property (SecureBlackbox_SAMLIdPServer Class)

The user's email address.

Object Oriented Interface

public function getUserEmail($userindex);


public function setUserEmail($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 490 , $userindex);


secureblackbox_samlidpserver_set($res, 490, $value , $userindex);

Default Value

''

Remarks

The user's email address.

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

This property is not available at design time.

Data Type

String

UserHandle Property (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function getUserHandle($userindex);


public function setUserHandle($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 491 , $userindex);


secureblackbox_samlidpserver_set($res, 491, $value , $userindex);

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

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Object Oriented Interface

public function getUserHashAlgorithm($userindex);


public function setUserHashAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 492 , $userindex);


secureblackbox_samlidpserver_set($res, 492, $value , $userindex);

Default Value

''

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

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

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the incoming speed limit for this user.

Object Oriented Interface

public function getUserIncomingSpeedLimit($userindex);


public function setUserIncomingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 493 , $userindex);


secureblackbox_samlidpserver_set($res, 493, $value , $userindex);

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

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

This property is not available at design time.

Data Type

Integer

UserOtpAlgorithm Property (SecureBlackbox_SAMLIdPServer Class)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Object Oriented Interface

public function getUserOtpAlgorithm($userindex);


public function setUserOtpAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 494 , $userindex);


secureblackbox_samlidpserver_set($res, 494, $value , $userindex);

Default Value

0

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

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

This property is not available at design time.

Data Type

Integer

UserOTPLen Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the length of the user's OTP password.

Object Oriented Interface

public function getUserOTPLen($userindex);


public function setUserOTPLen($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 495 , $userindex);


secureblackbox_samlidpserver_set($res, 495, $value , $userindex);

Default Value

0

Remarks

Specifies the length of the user's OTP password.

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

This property is not available at design time.

Data Type

Integer

UserOtpValue Property (SecureBlackbox_SAMLIdPServer Class)

The user's time interval (TOTP) or Counter (HOTP).

Object Oriented Interface

public function getUserOtpValue($userindex);


public function setUserOtpValue($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 496 , $userindex);


secureblackbox_samlidpserver_set($res, 496, $value , $userindex);

Default Value

0

Remarks

The user's time interval (TOTP) or Counter (HOTP).

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

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (SecureBlackbox_SAMLIdPServer Class)

Specifies the outgoing speed limit for this user.

Object Oriented Interface

public function getUserOutgoingSpeedLimit($userindex);


public function setUserOutgoingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 497 , $userindex);


secureblackbox_samlidpserver_set($res, 497, $value , $userindex);

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

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

This property is not available at design time.

Data Type

Integer

UserPassword Property (SecureBlackbox_SAMLIdPServer Class)

The user's authentication password.

Object Oriented Interface

public function getUserPassword($userindex);


public function setUserPassword($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 498 , $userindex);


secureblackbox_samlidpserver_set($res, 498, $value , $userindex);

Default Value

''

Remarks

The user's authentication password.

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

This property is not available at design time.

Data Type

String

UserSharedSecret Property (SecureBlackbox_SAMLIdPServer Class)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Object Oriented Interface

public function getUserSharedSecret($userindex);


public function setUserSharedSecret($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 499 , $userindex);


secureblackbox_samlidpserver_set($res, 499, $value , $userindex);

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

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

This property is not available at design time.

Data Type

Byte Array

UserSSHKey Property (SecureBlackbox_SAMLIdPServer Class)

Contains the user's SSH key.

Object Oriented Interface

public function getUserSSHKey($userindex);


public function setUserSSHKey($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 500 , $userindex);


secureblackbox_samlidpserver_set($res, 500, $value , $userindex);

Remarks

Contains the user's SSH key.

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

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (SecureBlackbox_SAMLIdPServer Class)

The registered name (login) of the user.

Object Oriented Interface

public function getUserUsername($userindex);


public function setUserUsername($userindex, $value);

Procedural Interface

secureblackbox_samlidpserver_get($res, 501 , $userindex);


secureblackbox_samlidpserver_set($res, 501, $value , $userindex);

Default Value

''

Remarks

The registered name (login) of the user.

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

This property is not available at design time.

Data Type

String

AddIdPService Method (SecureBlackbox_SAMLIdPServer Class)

Registers an IdP service in the IdPServices list.

Object Oriented Interface

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

Procedural Interface

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

Remarks

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

AddSP Method (SecureBlackbox_SAMLIdPServer Class)

Registers an SP entity in SPSettings list.

Object Oriented Interface

public function doAddSP($entityid, $idpssolink);

Procedural Interface

secureblackbox_samlidpserver_do_addsp($res, $entityid, $idpssolink);

Remarks

This method adds an empty entry to the SPSettings list of known service providers. When registering a service provider manually (v.s. importing it from its metadata with a ImportSettings call), make sure to register all the individual SP service endpoints (assertion consumer services, single logout services, and so on) manually using the AddSPService method.

Once you have added the SP entry to the list, you can edit it using the SPSettings property.

AddSPService Method (SecureBlackbox_SAMLIdPServer Class)

Registers an SP service in the SPServices list.

Object Oriented Interface

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

Procedural Interface

secureblackbox_samlidpserver_do_addspservice($res, $service, $bindingtype, $location, $priority, $index, $entityid);

Remarks

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

CompleteAuth Method (SecureBlackbox_SAMLIdPServer Class)

Initiates transfer of the authentication fact (assertion) to the IdP.

Object Oriented Interface

public function doCompleteAuth($connectionid, $sessionid, $sp, $relaystate, $tag);

Procedural Interface

secureblackbox_samlidpserver_do_completeauth($res, $connectionid, $sessionid, $sp, $relaystate, $tag);

Remarks

Use this method to pass a SAML assertion to a chosen SP after completion of the IdP-initiated SSO process.

Calling this method is equivalent to navigating to the SP-specific IdP link on the web server running the SAML IdP service.

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.

Config Method (SecureBlackbox_SAMLIdPServer Class)

This method sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

DropClient Method (SecureBlackbox_SAMLIdPServer Class)

Terminates a client connection.

Object Oriented Interface

public function doDropClient($connectionid, $forced);

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer Class)

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

Object Oriented Interface

public function doExportSettings($idp, $index);

Procedural Interface

secureblackbox_samlidpserver_do_exportsettings($res, $idp, $index);

Remarks

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

When exporting IdP settings, adjust the identity provider configuration as required in IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.

When exporting SP settings, provide the index of the service provider in the SPSettings list.

GetProviderProperty Method (SecureBlackbox_SAMLIdPServer Class)

Returns the value of a custom provider property.

Object Oriented Interface

public function doGetProviderProperty($name);

Procedural Interface

secureblackbox_samlidpserver_do_getproviderproperty($res, $name);

Remarks

This method, together with SetProviderProperty, provides an extensible way of managing the Identity 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_SAMLIdPServer Class)

Obtains a pending connection buffer.

Object Oriented Interface

public function doGetRequestBytes($connectionid, $requestfilter);

Procedural Interface

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

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. TBD: Possibly rename to GetRequestBytes (and align with declaration in HTTPServer)

GetRequestHeader Method (SecureBlackbox_SAMLIdPServer Class)

Returns a request header value.

Object Oriented Interface

public function doGetRequestHeader($connectionid, $headername);

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Returns a response header value.

Object Oriented Interface

public function doGetResponseHeader($connectionid, $headername);

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Returns the value of a custom session property.

Object Oriented Interface

public function doGetSessionProperty($sessionid, $name);

Procedural Interface

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

Remarks

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

TBD:

ImportSettings Method (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function doImportSettings($metadata, $idp);

Procedural Interface

secureblackbox_samlidpserver_do_importsettings($res, $metadata, $idp);

Remarks

The Service provider (SP) may have a lot of different options and requirements for interactions with the Identity provider (IdP). 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 such file generated by the service provider.

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

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

InitiateAuth Method (SecureBlackbox_SAMLIdPServer Class)

Starts IdP-initiated SAML authentication flow.

Object Oriented Interface

public function doInitiateAuth($connectionid, $sessionid, $tag);

Procedural Interface

secureblackbox_samlidpserver_do_initiateauth($res, $connectionid, $sessionid, $tag);

Remarks

Use this method to initiate SAML authentication flow on the IdP side.

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.

Once the user has been authenticated, you can use ProcessSignOnRequest to generate SAML assertions for specific SPs.

InitiateLogout Method (SecureBlackbox_SAMLIdPServer Class)

Starts IdP-initiated SAML logout flow.

Object Oriented Interface

public function doInitiateLogout($connectionid, $sessionid, $sp, $tag);

Procedural Interface

secureblackbox_samlidpserver_do_initiatelogout($res, $connectionid, $sessionid, $sp, $tag);

Remarks

Use this method to initiate SAML logout flow on the IdP side. Pass the index of the logout endpoint that you want to use to the SPServiceIndex parameter.

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.

ListClients Method (SecureBlackbox_SAMLIdPServer Class)

Enumerates the connected clients.

Object Oriented Interface

public function doListClients();

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Takes a snapshot of the connection's properties.

Object Oriented Interface

public function doPinClient($connectionid);

Procedural Interface

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

ProcessArtifactResolveRequest Method (SecureBlackbox_SAMLIdPServer 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_samlidpserver_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.

ProcessAttributeQuery Method (SecureBlackbox_SAMLIdPServer Class)

Processes an attribute request received from the SP service at one of the AQS endpoints.

Object Oriented Interface

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

Procedural Interface

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

Remarks

Use this method to pass a SAML attribute request received at one of the AttributeQueryService 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_SAMLIdPServer Class)

Processes a generic HTTP SAML request.

Object Oriented Interface

public function doProcessGenericRequest($connectionid, $sessionid, $url, $httpmethod, $request, $tag);

Procedural Interface

secureblackbox_samlidpserver_do_processgenericrequest($res, $connectionid, $sessionid, $url, $httpmethod, $request, $tag);

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.

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.

ProcessLogoutRequest Method (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

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

Procedural Interface

secureblackbox_samlidpserver_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 returned 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.

ProcessSignOnRequest Method (SecureBlackbox_SAMLIdPServer Class)

Processes a single sign-on request received from the SP service at one of the SSO endpoints.

Object Oriented Interface

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

Procedural Interface

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

Remarks

Use this method to pass a SAML Single Sign-On request received at one of the SingleSignOnService 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.

ProcessSignOnResponse Method (SecureBlackbox_SAMLIdPServer Class)

Processes the submission of the login form previously generated by the IdP server.

Object Oriented Interface

public function doProcessSignOnResponse($connectionid, $sessionid, $response, $tag);

Procedural Interface

secureblackbox_samlidpserver_do_processsignonresponse($res, $connectionid, $sessionid, $response, $tag);

Remarks

Use this method to pass the login form data that was received from the user in response to the presented login form, to the IdP server. If the provided data matches the form, the credentials are passed to the application via the UserAuthVerifyCredentials event.

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. TBD:

RemoveSP Method (SecureBlackbox_SAMLIdPServer Class)

Removes an SP from the list of trusted service providers.

Object Oriented Interface

public function doRemoveSP($index);

Procedural Interface

secureblackbox_samlidpserver_do_removesp($res, $index);

Remarks

Use this method to remove information about a service provider from the SPSettings list. The IdP server will be unable to process any further requests from this provider once it is removed. TBD

Reset Method (SecureBlackbox_SAMLIdPServer Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_samlidpserver_do_reset($res);

Remarks

Reset is a generic method available in every class.

SetClientBuffer Method (SecureBlackbox_SAMLIdPServer Class)

Commits a data buffer to the connection.

Object Oriented Interface

public function doSetClientBuffer($connectionid, $value);

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Sets the value of a custom provider property.

Object Oriented Interface

public function doSetProviderProperty($name, $value);

Procedural Interface

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

Remarks

This method, together with GetProviderProperty, provides an extensible way of managing the Identity 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_SAMLIdPServer Class)

Sets a response header.

Object Oriented Interface

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

Procedural Interface

secureblackbox_samlidpserver_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_SAMLIdPServer Class)

Sets the value of a custom provider session property.

Object Oriented Interface

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

Procedural Interface

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

Remarks

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

TBD:

Start Method (SecureBlackbox_SAMLIdPServer Class)

Starts the IdP server.

Object Oriented Interface

public function doStart();

Procedural Interface

secureblackbox_samlidpserver_do_start($res);

Remarks

Use this method to start listening for incoming connections.

Stop Method (SecureBlackbox_SAMLIdPServer Class)

Stops the IdP server.

Object Oriented Interface

public function doStop();

Procedural Interface

secureblackbox_samlidpserver_do_stop($res);

Remarks

Call this method to stop listening for incoming connections.

Accept Event (SecureBlackbox_SAMLIdPServer Class)

Reports an incoming connection.

Object Oriented Interface

public function fireAccept($param);

Procedural Interface

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

ArtifactResolveRequestPrepared Event (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function fireArtifactResolveRequestPrepared($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 2, array($this, 'fireArtifactResolveRequestPrepared'));

Parameter List

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

Remarks

TBD

ArtifactResolveRequestReceived Event (SecureBlackbox_SAMLIdPServer Class)

TBD.

Object Oriented Interface

public function fireArtifactResolveRequestReceived($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 3, array($this, 'fireArtifactResolveRequestReceived'));

Parameter List

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

Remarks

AssertionPrepared Event (SecureBlackbox_SAMLIdPServer Class)

This event fires when a new assertion has been created by the IdP server.

Object Oriented Interface

public function fireAssertionPrepared($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 4, array($this, 'fireAssertionPrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'sp'
 'body'
 'auth'
 'nameid'
 'nameidformat'
 'sessionindex'
 'validfrom'
 'validto'

Remarks

The component fires this event when it has prepared an assertion to be sent to the other side as part of the authentication process. This event may fire from within ProcessSignOnRequest and ProcessSignOnResponse calls when working in OfflineMode, and at any time otherwise.

The RequestID parameter contains the request ID, in response to which the assertion was created. The NameID parameter contains the name identifier of the authenticated user, and SessionIndex the unique session index of the new session. TBD:

AttributeQueryReceived Event (SecureBlackbox_SAMLIdPServer Class)

TBD.

Object Oriented Interface

public function fireAttributeQueryReceived($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 5, array($this, 'fireAttributeQueryReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'sp'
 'isencrypted'
 'issigned'
 'attributes'
 'action'

Remarks

AuthnRequestReceived Event (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function fireAuthnRequestReceived($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 6, array($this, 'fireAuthnRequestReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'sp'
 'isencrypted'
 'issigned'
 'forceauthn'
 'noninteractive'
 'authenticated'
 'action'

Remarks

The event reports the details of the received AuthnRequest message. The ForceAuthn and NonInteractive parameters contain optional suggestions included in the request. The Authenticated parameter specifies whether the user has already been authenticated within this session. All the three parameters can be adjusted in the event handler to direct the authentication logic in the required direction.

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

Connect Event (SecureBlackbox_SAMLIdPServer Class)

Reports an accepted connection.

Object Oriented Interface

public function fireConnect($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 7, 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_SAMLIdPServer Class)

Fires to report a disconnected client.

Object Oriented Interface

public function fireDisconnect($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 8, array($this, 'fireDisconnect'));

Parameter List

 'connectionid'

Remarks

The class fires this event when a connected client disconnects.

Error Event (SecureBlackbox_SAMLIdPServer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 9, 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_SAMLIdPServer Class)

Handles remote or external signing initiated by the server protocol.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 10, 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(); };

LogoutRequestReceived Event (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function fireLogoutRequestReceived($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 11, array($this, 'fireLogoutRequestReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'sp'
 'isencrypted'
 'issigned'
 'nameid'
 'action'

Remarks

The SAML IdP server fires this event when a SAML logout request is received at one of the single logout service endpoints.

TBD

LogoutResponsePrepared Event (SecureBlackbox_SAMLIdPServer 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_samlidpserver_register_callback($res, 12, array($this, 'fireLogoutResponsePrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'sp'
 'body'
 'nameid'

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.

MetadataPrepared Event (SecureBlackbox_SAMLIdPServer Class)

Passes a prepared metadata object to the application.

Object Oriented Interface

public function fireMetadataPrepared($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 13, array($this, 'fireMetadataPrepared'));

Parameter List

 'connectionid'
 'metadata'

Remarks

The class uses this event to notify the application about the prepared metadata object and let the user code adjust it if needed. This event may fire from within an ExportSettings call, or in response to the incoming metadata request if the server is operating in standalone mode.

The suggested metadata object is provided through the Metadata parameter. The application can adjust it as required if it needs to.

Notification Event (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

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

ProcessingCompleted Event (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function fireProcessingCompleted($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 15, 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 ProcessSignOnRequest, ProcessSignOnResponse, 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 web page containing a login form.
• 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.

ResourceClose Event (SecureBlackbox_SAMLIdPServer Class)

Tells the application that it can close the opened resource.

Object Oriented Interface

public function fireResourceClose($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 16, array($this, 'fireResourceClose'));

Parameter List

 'connectionid'
 'sessionid'

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_SAMLIdPServer Class)

Requests the application to open the requested resource.

Object Oriented Interface

public function fireResourceOpen($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 17, array($this, 'fireResourceOpen'));

Parameter List

 'connectionid'
 'sessionid'
 '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_SAMLIdPServer Class)

Requests the application to read from an opened resource.

Object Oriented Interface

public function fireResourceRead($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 18, array($this, 'fireResourceRead'));

Parameter List

 'connectionid'
 'sessionid'
 '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_SAMLIdPServer Class)

Notifies the application that a server resource is requested.

Object Oriented Interface

public function fireResourceRequest($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 19, array($this, 'fireResourceRequest'));

Parameter List

 'connectionid'
 'sessionid'
 'url'
 'httpmethod'
 '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:

SAMLMessagePrepared Event (SecureBlackbox_SAMLIdPServer 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_samlidpserver_register_callback($res, 20, array($this, 'fireSAMLMessagePrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'destination'
 'inresponseto'
 'requestbody'
 'messagetype'
 'messagebody'
 '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_SAMLIdPServer Class)

The server fires this event for every SAML message it receives.

Object Oriented Interface

public function fireSAMLMessageReceived($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 21, array($this, 'fireSAMLMessageReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'messagetype'
 'messageid'
 'issuer'
 'issueinstant'
 'messagebody'
 'action'

Remarks

Subscribe to this event to be notified about incoming SAML messages.

The MessageType, MessageID, Issuer, and MessageBody parameters provide the details

Set Action property as required to let the component know how to proceed.

TBD: consider adding Signed parameter, for redirect bindings and message-level signatures

SessionCreated Event (SecureBlackbox_SAMLIdPServer Class)

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

Object Oriented Interface

public function fireSessionCreated($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 22, 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_SAMLIdPServer Class)

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

Object Oriented Interface

public function fireSessionDestroyed($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 23, array($this, 'fireSessionDestroyed'));

Parameter List

 'connectionid'
 'sessionid'

Remarks

ConnectionID contains the identifier of the closed session.

SessionEvent Event (SecureBlackbox_SAMLIdPServer Class)

Notifies the application about the change of SAML session stage.

Object Oriented Interface

public function fireSessionEvent($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 24, array($this, 'fireSessionEvent'));

Parameter List

 'connectionid'
 'sessionid'
 'eventtext'

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

TBD

SessionInfoNeeded Event (SecureBlackbox_SAMLIdPServer 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_samlidpserver_register_callback($res, 25, array($this, 'fireSessionInfoNeeded'));

Parameter List

 'connectionid'
 'sessionid'

Remarks

TBD

SessionStateRetrieve Event (SecureBlackbox_SAMLIdPServer Class)

TBD.

Object Oriented Interface

public function fireSessionStateRetrieve($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 26, array($this, 'fireSessionStateRetrieve'));

Parameter List

 'connectionid'
 'sessionid'
 'sessionstate'

Remarks

TBD

SessionStateSave Event (SecureBlackbox_SAMLIdPServer Class)

TBD.

Object Oriented Interface

public function fireSessionStateSave($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 27, array($this, 'fireSessionStateSave'));

Parameter List

 'connectionid'
 'sessionid'
 'sessionstate'

Remarks

TBD

SignatureFound Event (SecureBlackbox_SAMLIdPServer Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 28, array($this, 'fireSignatureFound'));

Parameter List

 'connectionid'
 'sessionid'
 'messagetype'
 'messageid'
 'entityid'
 'scope'
 '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_SAMLIdPServer Class)

Reports the signature validation result.

Object Oriented Interface

public function fireSignatureValidated($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 29, array($this, 'fireSignatureValidated'));

Parameter List

 'connectionid'
 'sessionid'
 'messagetype'
 'messageid'
 'scope'
 '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:

SignOnPagePrepared Event (SecureBlackbox_SAMLIdPServer Class)

The server fires this event upon preparing the sign-on page.

Object Oriented Interface

public function fireSignOnPagePrepared($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 30, array($this, 'fireSignOnPagePrepared'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'request'
 'pagedata'
 'redirect'

Remarks

The IdP server fires this event to notify the application that the sign-on page (login form) has been formed and is ready to be flushed. Use SignOnPageTemplate to assign the sign-on page template.

The form body is returned via the FormData parameter. You can adjust it in the event handler as required. The Redirect parameter advises whether the form should be returned as a Location header of the HTTP response with the 302 status, or as an HTTP body of text/html type.

SignOnResponseReceived Event (SecureBlackbox_SAMLIdPServer Class)

TBD.

Object Oriented Interface

public function fireSignOnResponseReceived($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 31, array($this, 'fireSignOnResponseReceived'));

Parameter List

 'connectionid'
 'sessionid'
 'requestid'
 'responsedata'
 'action'

Remarks

TLSCertValidate Event (SecureBlackbox_SAMLIdPServer Class)

Fires when a client certificate needs to be validated.

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 32, 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_SAMLIdPServer Class)

Reports the setup of a TLS session.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 33, 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_SAMLIdPServer Class)

Fires when a newly established client connection initiates a TLS handshake.

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 34, 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_SAMLIdPServer Class)

Requests a pre-shared key for TLS-PSK.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 35, 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_SAMLIdPServer Class)

Reports closure of a TLS session.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 36, 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_SAMLIdPServer Class)

Notifies the application about the success of user authentication flow.

Object Oriented Interface

public function fireUserAuthCompleted($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 37, array($this, 'fireUserAuthCompleted'));

Parameter List

 'connectionid'
 'sessionid'
 'sp'
 'auth'
 'username'
 'nameid'
 'nameidformat'
 'sessionindex'
 'assertionttl'

Remarks

TBD

UserAuthFailed Event (SecureBlackbox_SAMLIdPServer Class)

Notifies the application about the failure of user authentication flow.

Object Oriented Interface

public function fireUserAuthFailed($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 38, array($this, 'fireUserAuthFailed'));

Parameter List

 'connectionid'
 'sessionid'
 'sp'
 'auth'
 'username'
 'canretry'
 'tryagain'

Remarks

TBD - consider adding RequestID to this and other Auth events.

UserAuthStart Event (SecureBlackbox_SAMLIdPServer Class)

Notifies the application about the start of user authentication flow.

Object Oriented Interface

public function fireUserAuthStart($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 39, array($this, 'fireUserAuthStart'));

Parameter List

 'connectionid'
 'sessionid'
 'sp'
 'supportedauths'
 'selectedauth'
 'action'

Remarks

Set Action to Auto to proceed with the default sign on page based on SignOnPageTemplate, or to Custom to supply (or redirect to) your own authentication landing. TBD

UserAuthVerifyCredentials Event (SecureBlackbox_SAMLIdPServer Class)

Passes user credentials to the application for verification.

Object Oriented Interface

public function fireUserAuthVerifyCredentials($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 40, array($this, 'fireUserAuthVerifyCredentials'));

Parameter List

 'connectionid'
 'sessionid'
 'claimedusername'
 'claimedpassword'
 'claimedbody'
 'accept'
 'username'

Remarks

Subscribe to this event to be notified about authentication attempts and adjust the acceptance result as required. This event fires after the user credentials have been validated against the configured database, and the value of the Accept parameter reflects the outcome of the validation.

The Username and Password parameters contain the provided credentials, and the Body parameter contains the unparsed form data.

UserLogoutCompleted Event (SecureBlackbox_SAMLIdPServer Class)

Notifies the application about the completion of user logout flow.

Object Oriented Interface

public function fireUserLogoutCompleted($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 41, array($this, 'fireUserLogoutCompleted'));

Parameter List

 'connectionid'
 'sessionid'
 'sp'
 'username'
 'nameid'
 'sessionindex'
 'partial'

Remarks

TBD

UserLogoutStart Event (SecureBlackbox_SAMLIdPServer Class)

Notifies the application about the start of user logout flow.

Object Oriented Interface

public function fireUserLogoutStart($param);

Procedural Interface

secureblackbox_samlidpserver_register_callback($res, 42, array($this, 'fireUserLogoutStart'));

Parameter List

 'connectionid'
 'sessionid'
 'sp'
 'username'
 'nameid'
 'sessionindex'
 'secondary'
 'action'

Remarks

TBD

Config Settings (SAMLIdPServer 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.

SAMLIdPServer Config Settings

Base Config Settings

Trappable Errors (SAMLIdPServer Class)

SAMLIdPServer Errors