SAMLSPServer Class
Properties Methods Events Config Settings Errors
The SAMLSPServer class represents a SAML service provider.
Class Name
SecureBlackbox_SAMLSPServer
Procedural Interface
secureblackbox_samlspserver_open(); secureblackbox_samlspserver_close($res); secureblackbox_samlspserver_register_callback($res, $id, $function); secureblackbox_samlspserver_get_last_error($res); secureblackbox_samlspserver_get_last_error_code($res); secureblackbox_samlspserver_set($res, $id, $index, $value); secureblackbox_samlspserver_get($res, $id, $index); secureblackbox_samlspserver_do_addidpservice($res, $service, $bindingtype, $location, $priority, $index); secureblackbox_samlspserver_do_addspservice($res, $service, $bindingtype, $location, $priority, $index); secureblackbox_samlspserver_do_config($res, $configurationstring); secureblackbox_samlspserver_do_doaction($res, $actionid, $actionparams); secureblackbox_samlspserver_do_exportsettings($res, $sp); secureblackbox_samlspserver_do_getclientbuffer($res, $connectionid); secureblackbox_samlspserver_do_getproviderproperty($res, $name); secureblackbox_samlspserver_do_importsettings($res, $metadata, $sp); secureblackbox_samlspserver_do_initiateartifactresolve($res, $connectionid, $sessionid, $idpserviceindex, $artifact); secureblackbox_samlspserver_do_initiateattributequery($res, $connectionid, $sessionid, $idpserviceindex, $attributes); secureblackbox_samlspserver_do_initiateauth($res, $connectionid, $sessionid, $idpserviceindex, $relaystate); secureblackbox_samlspserver_do_initiatelogout($res, $connectionid, $sessionid, $idpserviceindex, $relaystate); secureblackbox_samlspserver_do_processartifactresolverequest($res, $connectionid, $sessionid, $request); secureblackbox_samlspserver_do_processassertion($res, $connectionid, $sessionid, $request); secureblackbox_samlspserver_do_processgenericrequest($res, $connectionid, $sessionid, $request); secureblackbox_samlspserver_do_processlogoutrequest($res, $connectionid, $sessionid, $request); secureblackbox_samlspserver_do_setclientbuffer($res, $connectionid, $value); secureblackbox_samlspserver_do_setproviderproperty($res, $name, $value); secureblackbox_samlspserver_do_start($res); secureblackbox_samlspserver_do_stop($res);
Remarks
The Service Provider in the SAML exchange flow represents the web server that receives and accepts authentication assertions issued by the Identity Provider for single sign-on (SSO). Most commonly, an SP server is part of the application responsible for communicating with an Identity Provider to establish the authenticity of application users.
SAMLSPServer provides easy means of integrating the SAML Service Provider functionality into your application. It presents a fully-features SP endpoint with its own HTTP(S) and assertion validation engines.
Please find below a step-by-step guide on setting up your own SAML SP endpoint.
- Register the IdP metadata using the ImportSettings method.
Most IDPs let you download their metadata in XML format. The metadata file contains general
parameters of the IdP endpoint, such as its web address and algorithm requirements.
server.ImportSettings(metadataBytes, false); // contains "<?xml version="1.0"?><md:EntityDescriptor ID="ab12" ... </md:EntityDescriptor>";
- Configure the main server capabilities:
// public server endpoint (use "https://" and/or port 443 if required) server.URL = "http://sp.myapp.com"; server.Port = 80; // IdP triggers this URL to pull metadata server.MetadataURL = '/sp/metadata'; // ACS is th "main" SP endpoint that receives assertions from the IdP server.AssertionConsumerService = '/sp/AssertionConsumerService'; server.SPToIDPBinding = csbtRedirect; // the SP will use HTTP redirect to forward the browser to the IdP when required server.AssertionConsumerServiceBindings = 'POST'; // and we want the IdP to use POST to submit its assertions server.PreferredIDPToSPBinding = csbtPOST; // Single logout service setup server.SingleLogoutService = '/sp/SingleLogoutService'; server.SingleLogoutServiceBindings = 'Redirect,POST,Artifact'; server.LogoutPage = '/sp/logout'; server.RedirectOnLogoutPage = 'https://www.nsoftware.com'; // The document root of the server on the local system server.BaseDir = "D:\\Inetpub\\SAMLSP"; // Security parameters: indicating that we want to sign both // the metadata and the requests server.SignAuthnRequests = true; server.SignMetadata = true; // We need to attach certificates to be able to sign. // Assume we have loaded our signing certificate into // a CertificateManager object. server.SigningCertificate = mgr.Certificate; server.MetaSigningCertificate = mgr.Certificate;
- Personalize the server:
server.Config("OrganizationName=My Organization Ltd"); server.Config("OrganizationDisplayName=My Organization Pet Supplies"); server.Config("OrganizationURL=http://myorg.com"); server.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256"); server.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); server.Config("WantAssertionsSigned=true");
- Optionally, save metadata to an XML file. This will let you send/upload it to the IdP,
so they could set your SP up. Some IdPs can download the metadata right from your SP
using the MetadataURL that you've provided above, in which case saving it to a file
is not necessary.
server.SaveMetadata("my_metadata.xml");
server.Start();
The server should now be running on the local system, listening to incoming connections on the port that you
have specified above (80). Use your browser to check if the server is responding by navigating
to the metadata URL (http://127.0.0.1:80/sp/metadata). If the server has been set up right,
you should see something like this:
Now let us actually try to use the SAML functionality. Copy an arbitrary file - for example, a recent photo of your cat - to the directory you provided earlier via the BaseDir property (D:\Inetpub\SAMLSP). Having copied the file (suppose it is called clifford.jpg), try to access it in your browser by navigating to http://127.0.0.1:80/clifford.jpg.
This is where SAML kicks in. Since you are not authenticated for the SP server yet (we have just launched it, so no one is), the server redirects your browser to the IdP endpoint for authentication. The address of the IdP is taken from the their_metadata.xml file that you have loaded at the very beginning.
Note: you can configure which resources to restrict access to using the ProtectedResources property. If ProtectedResources is empty, the server considers all the files in BaseDir and its subfolders to be protected.
It is now the IdP services turn to authenticate you. Most IdPs on this stage will present you with a login form. Yet, if you have signed in recently, the IdP may still remember you, in which case it will skip the form and proceed directly to the next step. After establishing and proving your identity, the IdP will generate an assertion, a signed proof that effectively states that the IdP knows who you are and have verified your identity rigorously. Think of the assertion as your unique pass to the resources protected by the SP. The IdP will then submit that assertion back to the SP at its AssertionConsumerService endpoint, again using your browser.
Note that the SP service knows nothing about how IdP authenticates you. All the SP is interested in is an assertion.
If the assertion is well-formed and its signature is valid, the SAML exchange completes. At this point the SP accepts the assertion and creates a session for you. You can now access the resources protected by the SP for as long as the session lasts. If this step succeeds, you should see the photo of your cat in your browser.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Active | Tells whether the server is active and ready to process requests. |
BaseDir | Base directory on the server. |
DecryptionCertBytes | Returns raw certificate data in DER format. |
DecryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ExternalCryptoAsyncDocumentID | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
ExternalCryptoMethod | Specifies the asynchronous signing method. |
ExternalCryptoMode | Specifies the external cryptography mode. |
ExternalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
FIPSMode | Reserved. |
Host | Specifies the host address of the SP server. |
IdPServiceCount | The number of records in the IdPService arrays. |
IdPServiceBindingType | Specifies the type of SAML binding that this endpoint accepts. |
IdPServiceEntityID | Represents the SAML entity ID. |
IdPServiceIndex | The index of this endpoint. |
IdPServiceLocation | The location (URL) of the endpoint. |
IdPServicePriority | The priority of the endpoint in relation to other endpoints with the same Location . |
IdPServiceService | The kind of the service being provided at this endpoint. |
IdPContactPerson | The contact person or persons for the entity. |
IdPEncryptionKey | Contains the entity's encryption key. |
IdPEncryptionMethods | Specifies the list of encryption methods supported by the entity. |
IdPEntityID | Represents the SAML entity ID. |
IdPFlags | Adjusts secondary entity properties. |
IdPNameIDFormats | The list of NameID formats supported by this entity. |
IdPOrganizationDisplayName | The friendly name of the organization that maintains the entity. |
IdPOrganizationLang | The language preferred by the organization. |
IdPOrganizationName | The name of the organization that maintains the entity. |
IdPOrganizationURL | The web URL of the organization that maintains the entity. |
IdPSignatureValidationResult | The outcome of the cryptographic signature validation. |
IdPSigned | Specifies whether the SAML entity information is or should be signed. |
IdPSignedWith | Contains the certificate or key that was used to sign the settings (metadata) document. |
IdPSigningKey | Contains the entity's signing key. |
IdPValidUntil | Specifies the expiration time of the SAML entity information. |
Issuer | Name identifier of the issuer of the SP's requests. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
LogoutPage | Specifies the location of the logout page. |
MetadataURL | The SP's metadata location. |
MetaSigningCertBytes | Returns raw certificate data in DER format. |
MetaSigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
OfflineMode | Enables the Offline mode. |
Port | Specifies the listening port number. |
PreferredIDPToSPBinding | Specifies the preferred IdP to SP binding. |
ProtectedResources | Specifies the list of protected resources. |
RedirectOnLogoutPage | Specifies the location to redirect the user on logout. |
SecurityCanonicalizationMethod | The canonicalization method to use in the signature. |
SecurityDigestMethod | The digest method to use. |
SecurityEncryptionMethod | The encryption method used to encrypt the assertion. |
SecurityFlags | Provides access to secondary security parameters and tweaks. |
SecuritySigMethod | The signature method to use. |
SenderCertCount | The number of records in the SenderChain arrays. |
SenderChainBytes | Returns raw certificate data in DER format. |
SenderChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningCertBytes | Returns raw certificate data in DER format. |
SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningChainCount | The number of records in the SigningChain arrays. |
SigningChainBytes | Returns raw certificate data in DER format. |
SigningChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningFlags | Adjusts signing behaviour. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
SPServiceCount | The number of records in the SPService arrays. |
SPServiceBindingType | Specifies the type of SAML binding that this endpoint accepts. |
SPServiceEntityID | Represents the SAML entity ID. |
SPServiceIndex | The index of this endpoint. |
SPServiceLocation | The location (URL) of the endpoint. |
SPServicePriority | The priority of the endpoint in relation to other endpoints with the same Location . |
SPServiceService | The kind of the service being provided at this endpoint. |
SPContactPerson | The contact person or persons for the entity. |
SPEncryptionKey | Contains the entity's encryption key. |
SPEncryptionMethods | Specifies the list of encryption methods supported by the entity. |
SPEntityID | Represents the SAML entity ID. |
SPFlags | Adjusts secondary entity properties. |
SPNameIDFormats | The list of NameID formats supported by this entity. |
SPOrganizationDisplayName | The friendly name of the organization that maintains the entity. |
SPOrganizationLang | The language preferred by the organization. |
SPOrganizationName | The name of the organization that maintains the entity. |
SPOrganizationURL | The web URL of the organization that maintains the entity. |
SPSignatureValidationResult | The outcome of the cryptographic signature validation. |
SPSigned | Specifies whether the SAML entity information is or should be signed. |
SPSignedWith | Contains the certificate or key that was used to sign the settings (metadata) document. |
SPSigningKey | Contains the entity's signing key. |
SPValidUntil | Specifies the expiration time of the SAML entity information. |
SPToIDPBinding | Specifies the IdP to SP binding to use. |
TLSServerCertCount | The number of records in the TLSServerCert arrays. |
TLSServerCertBytes | Returns raw certificate data in DER format. |
TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSClientAuth | Enables or disables certificate-based client authentication. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSExtensions | Provides access to TLS extensions. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | 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. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
TLSVersions | The SSL/TLS versions to enable by default. |
URL | Specifies the base URL of this SP server. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddIdPService | Registers an IdP service in the IdPServices list. |
AddSPService | Registers an SP service in the SPServices list. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
ExportSettings | Saves the SP or IdP configuration to an XML metadata file. |
GetClientBuffer | Obtains a pending connection buffer. |
GetProviderProperty | Returns the value of a custom provider property. |
ImportSettings | Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call. |
InitiateArtifactResolve | TBD. |
InitiateAttributeQuery | TBD. |
InitiateAuth | Starts SP-initiated SAML authentication flow. |
InitiateLogout | Starts SP-initiated SAML logout flow. |
ProcessArtifactResolveRequest | Processes an artifact request received from the SP service at one of the ARS endpoints. |
ProcessAssertion | Processes assertion received from the IdP service at one of the ACS endpoints. |
ProcessGenericRequest | Processes a generic HTTP SAML request. |
ProcessLogoutRequest | Processes logout request received from the IdP service at one of the SLS endpoints. |
SetClientBuffer | Commits a data buffer to the connection. |
SetProviderProperty | Sets the value of a custom provider property. |
Start | Starts the SP server. |
Stop | Stops the IdP server. |
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.
Accept | Reports an incoming connection. |
ArtifactResolveRequestPrepared | This event is fired when a new authentication request message has been prepared. |
ArtifactResolveRequestReceived | TBD. |
AssertionReceived | This event is fired when a new assertion has been received. |
AttributeQueryPrepared | This event is fired when a new attribute query message has been prepared. |
AuthnRequestPrepared | This event is fired when a new authentication request message has been prepared. |
Connect | Reports an accepted connection. |
Disconnect | Fires to report a disconnected client. |
Encrypted | Notifies the application that the assertion is encrypted and provides recipient certificate details. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
LogoutRequestPrepared | This event is fired when a new logout request has been prepared. |
LogoutRequestReceived | TBD. |
MetadataPrepared | Passes a prepared metadata object to the application. |
Notification | This event notifies the application about an underlying control flow event. |
ProcessingCompleted | This event notifies the application of the completion of request or response processing. |
ResourceClose | Tells the application that it can close the opened resource. |
ResourceOpen | Requests the application to open the requested resource. |
ResourceRead | Requests the application to read from an opened resource. |
ResourceRequest | Notifies the application that a server resource is requested. |
SAMLMessagePrepared | The server fires this event when it is ready to submit a SAML response body. |
SAMLMessageReceived | The server fires this event upon receiving a valid SAML message. |
SessionCreated | This event is fired when a new session has been established. |
SessionDestroyed | This event is fired when the SP server has closed a session. |
SessionEvent | Notifies the application about the change of SAML session stage. |
SessionInfoNeeded | This event is fired in OfflineMode to request the session ID for the current flow. |
SessionStateRetrieve | TBD. |
SessionStateSave | TBD. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Reports the signature validation result. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowOptionsResponseWithoutAuth | Enables unauthenticated responses to OPTIONS requests. |
AuthDigestExpire | Specifies digest expiration time for digest authentication. |
BoundPort | The port that was bound by the server. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
HandshakeTimeout | The HTTPS handshake timeout. |
HomePage | Specifies the home page resource name. |
MaxIssueInstantTimeDiff | The maximum issue-instant time delta. |
PortRangeFrom | The lower bound of allowed port scope to listen on. |
PortRangeTo | The higher bound of allowed port scope to listen on. |
RequestFilter | The request string modifier. |
SendBufferSize | The network send buffer size. |
ServerName | Specifies the server name for the created responses. |
SessionTimeout | The HTTP session timeout. |
SessionTTL | The SAML session time-to-live value. |
TempPath | Path for storing temporary files. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
Active Property (SecureBlackbox_SAMLSPServer Class)
Tells whether the server is active and ready to process requests.
Object Oriented Interface
public function getActive();
Procedural Interface
secureblackbox_samlspserver_get($res, 1 );
Default Value
false
Remarks
This property indicates whether the IdP server is in an active state.
This property is read-only and not available at design time.
Data Type
Boolean
BaseDir Property (SecureBlackbox_SAMLSPServer Class)
Base directory on the server.
Object Oriented Interface
public function getBaseDir(); public function setBaseDir($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 2 ); secureblackbox_samlspserver_set($res, 2, $value );
Default Value
''
Remarks
Use this property to specify the base directory for the SP server.
Data Type
String
DecryptionCertBytes Property (SecureBlackbox_SAMLSPServer Class)
Returns raw certificate data in DER format.
Object Oriented Interface
public function getDecryptionCertBytes();
Procedural Interface
secureblackbox_samlspserver_get($res, 3 );
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
DecryptionCertHandle Property (SecureBlackbox_SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Object Oriented Interface
public function getDecryptionCertHandle(); public function setDecryptionCertHandle($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 11 ); secureblackbox_samlspserver_set($res, 11, $value );
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
ExternalCryptoAsyncDocumentID Property (SecureBlackbox_SAMLSPServer Class)
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Object Oriented Interface
public function getExternalCryptoAsyncDocumentID(); public function setExternalCryptoAsyncDocumentID($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 39 ); secureblackbox_samlspserver_set($res, 39, $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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
Data Type
String
ExternalCryptoCustomParams Property (SecureBlackbox_SAMLSPServer Class)
Custom parameters to be passed to the signing service (uninterpreted).
Object Oriented Interface
public function getExternalCryptoCustomParams(); public function setExternalCryptoCustomParams($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 40 ); secureblackbox_samlspserver_set($res, 40, $value );
Default Value
''
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
This property is not available at design time.
Data Type
String
ExternalCryptoData Property (SecureBlackbox_SAMLSPServer Class)
Additional data to be included in the async state and mirrored back by the requestor.
Object Oriented Interface
public function getExternalCryptoData(); public function setExternalCryptoData($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 41 ); secureblackbox_samlspserver_set($res, 41, $value );
Default Value
''
Remarks
Additional data to be included in the async state and mirrored back by the requestor
This property is not available at design time.
Data Type
String
ExternalCryptoExternalHashCalculation Property (SecureBlackbox_SAMLSPServer Class)
Specifies whether the message hash is to be calculated at the external endpoint.
Object Oriented Interface
public function getExternalCryptoExternalHashCalculation(); public function setExternalCryptoExternalHashCalculation($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 42 ); secureblackbox_samlspserver_set($res, 42, $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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.
Data Type
Boolean
ExternalCryptoHashAlgorithm Property (SecureBlackbox_SAMLSPServer Class)
Specifies the request's signature hash algorithm.
Object Oriented Interface
public function getExternalCryptoHashAlgorithm(); public function setExternalCryptoHashAlgorithm($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 43 ); secureblackbox_samlspserver_set($res, 43, $value );
Default Value
'SHA256'
Remarks
Specifies the request's signature hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Data Type
String
ExternalCryptoKeyID Property (SecureBlackbox_SAMLSPServer Class)
The ID of the pre-shared key used for DC request authentication.
Object Oriented Interface
public function getExternalCryptoKeyID(); public function setExternalCryptoKeyID($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 44 ); secureblackbox_samlspserver_set($res, 44, $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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
Data Type
String
ExternalCryptoKeySecret Property (SecureBlackbox_SAMLSPServer Class)
The pre-shared key used for DC request authentication.
Object Oriented Interface
public function getExternalCryptoKeySecret(); public function setExternalCryptoKeySecret($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 45 ); secureblackbox_samlspserver_set($res, 45, $value );
Default Value
''
Remarks
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the ExternalCryptoKeyID topic.
Data Type
String
ExternalCryptoMethod Property (SecureBlackbox_SAMLSPServer Class)
Specifies the asynchronous signing method.
Object Oriented Interface
public function getExternalCryptoMethod(); public function setExternalCryptoMethod($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 46 ); secureblackbox_samlspserver_set($res, 46, $value );
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Data Type
Integer
ExternalCryptoMode Property (SecureBlackbox_SAMLSPServer Class)
Specifies the external cryptography mode.
Object Oriented Interface
public function getExternalCryptoMode(); public function setExternalCryptoMode($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 47 ); secureblackbox_samlspserver_set($res, 47, $value );
Default Value
0
Remarks
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
This property is not available at design time.
Data Type
Integer
ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_SAMLSPServer Class)
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
Object Oriented Interface
public function getExternalCryptoPublicKeyAlgorithm(); public function setExternalCryptoPublicKeyAlgorithm($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 48 ); secureblackbox_samlspserver_set($res, 48, $value );
Default Value
''
Remarks
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Data Type
String
FIPSMode Property (SecureBlackbox_SAMLSPServer Class)
Reserved.
Object Oriented Interface
public function getFIPSMode(); public function setFIPSMode($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 49 ); secureblackbox_samlspserver_set($res, 49, $value );
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
Host Property (SecureBlackbox_SAMLSPServer Class)
Specifies the host address of the SP server.
Object Oriented Interface
public function getHost(); public function setHost($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 50 ); secureblackbox_samlspserver_set($res, 50, $value );
Default Value
''
Remarks
Use this property to specify the IP address on which to listen to incoming connections. To specify the listening port number, use Port.
Data Type
String
IdPServiceCount Property (SecureBlackbox_SAMLSPServer Class)
The number of records in the IdPService arrays.
Object Oriented Interface
public function getIdPServiceCount();
Procedural Interface
secureblackbox_samlspserver_get($res, 51 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- IdPServiceBindingType
- IdPServiceEntityID
- IdPServiceIndex
- IdPServiceLocation
- IdPServicePriority
- IdPServiceService
This property is read-only and not available at design time.
Data Type
Integer
IdPServiceBindingType Property (SecureBlackbox_SAMLSPServer Class)
Specifies the type of SAML binding that this endpoint accepts.
Object Oriented Interface
public function getIdPServiceBindingType($idpserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 52 , $idpserviceindex);
Default Value
0
Remarks
Specifies the type of SAML binding that this endpoint accepts.
Use this property to specify the binding type to use with this endpoint.
The $idpserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.
This property is read-only and not available at design time.
Data Type
Integer
IdPServiceEntityID Property (SecureBlackbox_SAMLSPServer Class)
Represents the SAML entity ID.
Object Oriented Interface
public function getIdPServiceEntityID($idpserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 53 , $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
IdPServiceIndex Property (SecureBlackbox_SAMLSPServer Class)
The index of this endpoint.
Object Oriented Interface
public function getIdPServiceIndex($idpserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 54 , $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
IdPServiceLocation Property (SecureBlackbox_SAMLSPServer Class)
The location (URL) of the endpoint.
Object Oriented Interface
public function getIdPServiceLocation($idpserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 55 , $idpserviceindex);
Default Value
''
Remarks
The location (URL) of the endpoint.
The $idpserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.
This property is read-only and not available at design time.
Data Type
String
IdPServicePriority Property (SecureBlackbox_SAMLSPServer Class)
The priority of the endpoint in relation to other endpoints with the same Location .
Object Oriented Interface
public function getIdPServicePriority($idpserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 56 , $idpserviceindex);
Default Value
-1
Remarks
The priority of the endpoint in relation to other endpoints with the same IdPLocation.
Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.
Leave all priorities at -1 to omit generation of the Default attribute.
The $idpserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.
This property is read-only and not available at design time.
Data Type
Integer
IdPServiceService Property (SecureBlackbox_SAMLSPServer Class)
The kind of the service being provided at this endpoint.
Object Oriented Interface
public function getIdPServiceService($idpserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 57 , $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
IdPContactPerson Property (SecureBlackbox_SAMLSPServer Class)
The contact person or persons for the entity.
Object Oriented Interface
public function getIdPContactPerson(); public function setIdPContactPerson($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 58 ); secureblackbox_samlspserver_set($res, 58, $value );
Default Value
''
Remarks
The contact person or persons for the entity.
SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.
Each record contains a semicolon-separated list of contact person parameters, for example:
Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678
You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.
This property is not available at design time.
Data Type
String
IdPEncryptionKey Property (SecureBlackbox_SAMLSPServer Class)
Contains the entity's encryption key.
Object Oriented Interface
public function getIdPEncryptionKey(); public function setIdPEncryptionKey($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 59 ); secureblackbox_samlspserver_set($res, 59, $value );
Remarks
Contains the entity's encryption key.
This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).
Requests sent to the endpoint can be encrypted with the provided key or certificate.
This property is not available at design time.
Data Type
Byte Array
IdPEncryptionMethods Property (SecureBlackbox_SAMLSPServer Class)
Specifies the list of encryption methods supported by the entity.
Object Oriented Interface
public function getIdPEncryptionMethods(); public function setIdPEncryptionMethods($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 60 ); secureblackbox_samlspserver_set($res, 60, $value );
Default Value
''
Remarks
Specifies the list of encryption methods supported by the entity.
This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.
Examples of algorithms supported by this property:
- http://www.w3.org/2009/xmlenc11#aes128-gcm
- http://www.w3.org/2001/04/xmlenc#aes256-cbc
This property is not available at design time.
Data Type
String
IdPEntityID Property (SecureBlackbox_SAMLSPServer Class)
Represents the SAML entity ID.
Object Oriented Interface
public function getIdPEntityID(); public function setIdPEntityID($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 61 ); secureblackbox_samlspserver_set($res, 61, $value );
Default Value
''
Remarks
Represents the SAML entity ID.
Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).
This property is not available at design time.
Data Type
String
IdPFlags Property (SecureBlackbox_SAMLSPServer Class)
Adjusts secondary entity properties.
Object Oriented Interface
public function getIdPFlags(); public function setIdPFlags($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 62 ); secureblackbox_samlspserver_set($res, 62, $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
IdPNameIDFormats Property (SecureBlackbox_SAMLSPServer Class)
The list of NameID formats supported by this entity.
Object Oriented Interface
public function getIdPNameIDFormats(); public function setIdPNameIDFormats($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 63 ); secureblackbox_samlspserver_set($res, 63, $value );
Default Value
''
Remarks
The list of NameID formats supported by this entity.
Use this setting to get or set the list of NameID formats supported by the entity.
Use SAML notation for the formats:
- urn:oasis:names:tc:SAML:2.0:nameid-format:transient
- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
This property is not available at design time.
Data Type
String
IdPOrganizationDisplayName Property (SecureBlackbox_SAMLSPServer Class)
The friendly name of the organization that maintains the entity.
Object Oriented Interface
public function getIdPOrganizationDisplayName(); public function setIdPOrganizationDisplayName($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 64 ); secureblackbox_samlspserver_set($res, 64, $value );
Default Value
''
Remarks
The friendly name of the organization that maintains the entity.
Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.
This property is not available at design time.
Data Type
String
IdPOrganizationLang Property (SecureBlackbox_SAMLSPServer Class)
The language preferred by the organization.
Object Oriented Interface
public function getIdPOrganizationLang(); public function setIdPOrganizationLang($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 65 ); secureblackbox_samlspserver_set($res, 65, $value );
Default Value
''
Remarks
The language preferred by the organization.
This optional setting can be used to adjust the preferred language of the owning organization.
This property is not available at design time.
Data Type
String
IdPOrganizationName Property (SecureBlackbox_SAMLSPServer Class)
The name of the organization that maintains the entity.
Object Oriented Interface
public function getIdPOrganizationName(); public function setIdPOrganizationName($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 66 ); secureblackbox_samlspserver_set($res, 66, $value );
Default Value
''
Remarks
The name of the organization that maintains the entity.
Use this setting to get or set the name of the organization that maintains the SAML entity.
This property is not available at design time.
Data Type
String
IdPOrganizationURL Property (SecureBlackbox_SAMLSPServer Class)
The web URL of the organization that maintains the entity.
Object Oriented Interface
public function getIdPOrganizationURL(); public function setIdPOrganizationURL($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 67 ); secureblackbox_samlspserver_set($res, 67, $value );
Default Value
''
Remarks
The web URL of the organization that maintains the entity.
Use this setting to get or set the web address of the organization responsible for this SAML entity.
This property is not available at design time.
Data Type
String
IdPSignatureValidationResult Property (SecureBlackbox_SAMLSPServer Class)
The outcome of the cryptographic signature validation.
Object Oriented Interface
public function getIdPSignatureValidationResult();
Procedural Interface
secureblackbox_samlspserver_get($res, 68 );
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
This property is read-only and not available at design time.
Data Type
Integer
IdPSigned Property (SecureBlackbox_SAMLSPServer Class)
Specifies whether the SAML entity information is or should be signed.
Object Oriented Interface
public function getIdPSigned();
Procedural Interface
secureblackbox_samlspserver_get($res, 69 );
Default Value
false
Remarks
Specifies whether the SAML entity information is or should be signed.
Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.
This property is read-only and not available at design time.
Data Type
Boolean
IdPSignedWith Property (SecureBlackbox_SAMLSPServer Class)
Contains the certificate or key that was used to sign the settings (metadata) document.
Object Oriented Interface
public function getIdPSignedWith();
Procedural Interface
secureblackbox_samlspserver_get($res, 70 );
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
Byte Array
IdPSigningKey Property (SecureBlackbox_SAMLSPServer Class)
Contains the entity's signing key.
Object Oriented Interface
public function getIdPSigningKey(); public function setIdPSigningKey($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 71 ); secureblackbox_samlspserver_set($res, 71, $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 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 SigningCertificate setting (for this-party settings).
Messages sent by the endpoint can be signed with the provided key or certificate.
This property is not available at design time.
Data Type
Byte Array
IdPValidUntil Property (SecureBlackbox_SAMLSPServer Class)
Specifies the expiration time of the SAML entity information.
Object Oriented Interface
public function getIdPValidUntil(); public function setIdPValidUntil($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 72 ); secureblackbox_samlspserver_set($res, 72, $value );
Default Value
''
Remarks
Specifies the expiration time of the SAML entity information.
This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.
This property is not available at design time.
Data Type
String
Issuer Property (SecureBlackbox_SAMLSPServer Class)
Name identifier of the issuer of the SP's requests.
Object Oriented Interface
public function getIssuer(); public function setIssuer($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 73 ); secureblackbox_samlspserver_set($res, 73, $value );
Default Value
''
Remarks
Use this property to set the name identifier of this Service Provider (SP) to be used in its requests.
Data Type
String
KnownCertCount Property (SecureBlackbox_SAMLSPServer Class)
The number of records in the KnownCert arrays.
Object Oriented Interface
public function getKnownCertCount(); public function setKnownCertCount($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 74 ); secureblackbox_samlspserver_set($res, 74, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCertCount - 1.This property is not available at design time.
Data Type
Integer
KnownCertBytes Property (SecureBlackbox_SAMLSPServer Class)
Returns raw certificate data in DER format.
Object Oriented Interface
public function getKnownCertBytes($knowncertindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 75 , $knowncertindex);
Remarks
Returns raw certificate data in DER format.
The $knowncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownCertHandle Property (SecureBlackbox_SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Object Oriented Interface
public function getKnownCertHandle($knowncertindex); public function setKnownCertHandle($knowncertindex, $value);
Procedural Interface
secureblackbox_samlspserver_get($res, 83 , $knowncertindex); secureblackbox_samlspserver_set($res, 83, $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
LogoutPage Property (SecureBlackbox_SAMLSPServer Class)
Specifies the location of the logout page.
Object Oriented Interface
public function getLogoutPage(); public function setLogoutPage($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 111 ); secureblackbox_samlspserver_set($res, 111, $value );
Default Value
'/sp/logout'
Remarks
Use this property to specify the relative URL of the logout page.
Data Type
String
MetadataURL Property (SecureBlackbox_SAMLSPServer Class)
The SP's metadata location.
Object Oriented Interface
public function getMetadataURL(); public function setMetadataURL($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 112 ); secureblackbox_samlspserver_set($res, 112, $value );
Default Value
'/sp/metadata'
Remarks
This property specifies the metadata URL of this Service Provider (SP).
Data Type
String
MetaSigningCertBytes Property (SecureBlackbox_SAMLSPServer Class)
Returns raw certificate data in DER format.
Object Oriented Interface
public function getMetaSigningCertBytes();
Procedural Interface
secureblackbox_samlspserver_get($res, 113 );
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
MetaSigningCertHandle Property (SecureBlackbox_SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Object Oriented Interface
public function getMetaSigningCertHandle(); public function setMetaSigningCertHandle($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 121 ); secureblackbox_samlspserver_set($res, 121, $value );
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
OfflineMode Property (SecureBlackbox_SAMLSPServer Class)
Enables the Offline mode.
Object Oriented Interface
public function getOfflineMode(); public function setOfflineMode($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 149 ); secureblackbox_samlspserver_set($res, 149, $value );
Default Value
true
Remarks
In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be relayed by the application via calls to ProcessAssertion, ProcessLogoutRequest ProcessArtifactResolveRequest, and other similar methods.
The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML traffic.
Data Type
Boolean
Port Property (SecureBlackbox_SAMLSPServer Class)
Specifies the listening port number.
Object Oriented Interface
public function getPort(); public function setPort($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 150 ); secureblackbox_samlspserver_set($res, 150, $value );
Default Value
80
Remarks
Use this property to specify the port number on which the SP server should listen for incoming connections. To specify the server's IP address use Host.
Data Type
Integer
PreferredIDPToSPBinding Property (SecureBlackbox_SAMLSPServer Class)
Specifies the preferred IdP to SP binding.
Object Oriented Interface
public function getPreferredIDPToSPBinding(); public function setPreferredIDPToSPBinding($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 151 ); secureblackbox_samlspserver_set($res, 151, $value );
Default Value
4
Remarks
Specifies the preferred binding (message exchange mechanism) used for communication with Identity Provider (IdP).
csbtNone | 0 | |
csbtSOAP | 1 | |
csbtPAOS | 2 | |
csbtRedirect | 3 | |
csbtPOST | 4 | |
csbtArtifact | 5 |
Data Type
Integer
ProtectedResources Property (SecureBlackbox_SAMLSPServer Class)
Specifies the list of protected resources.
Object Oriented Interface
public function getProtectedResources(); public function setProtectedResources($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 152 ); secureblackbox_samlspserver_set($res, 152, $value );
Default Value
''
Remarks
This property contains a set of relative URLs of the protected resources offered by this Service Provider (SP).
Data Type
String
RedirectOnLogoutPage Property (SecureBlackbox_SAMLSPServer Class)
Specifies the location to redirect the user on logout.
Object Oriented Interface
public function getRedirectOnLogoutPage(); public function setRedirectOnLogoutPage($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 153 ); secureblackbox_samlspserver_set($res, 153, $value );
Default Value
'https://nsoftware.com'
Remarks
Use this property to specify the page where to redirect the user on logout.
Data Type
String
SecurityCanonicalizationMethod Property (SecureBlackbox_SAMLSPServer Class)
The canonicalization method to use in the signature.
Object Oriented Interface
public function getSecurityCanonicalizationMethod(); public function setSecurityCanonicalizationMethod($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 154 ); secureblackbox_samlspserver_set($res, 154, $value );
Default Value
''
Remarks
The canonicalization method to use in the signature.
The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)
This property is not available at design time.
Data Type
String
SecurityDigestMethod Property (SecureBlackbox_SAMLSPServer Class)
The digest method to use.
Object Oriented Interface
public function getSecurityDigestMethod(); public function setSecurityDigestMethod($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 155 ); secureblackbox_samlspserver_set($res, 155, $value );
Default Value
''
Remarks
The digest method to use.
The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.
This property is not available at design time.
Data Type
String
SecurityEncryptionMethod Property (SecureBlackbox_SAMLSPServer Class)
The encryption method used to encrypt the assertion.
Object Oriented Interface
public function getSecurityEncryptionMethod(); public function setSecurityEncryptionMethod($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 156 ); secureblackbox_samlspserver_set($res, 156, $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:
SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 | |
SB_XML_ENCRYPTION_ALGORITHM_DES | DES | |
SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | |
SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | |
SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | |
SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | |
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |
This property is not available at design time.
Data Type
String
SecurityFlags Property (SecureBlackbox_SAMLSPServer Class)
Provides access to secondary security parameters and tweaks.
Object Oriented Interface
public function getSecurityFlags(); public function setSecurityFlags($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 157 ); secureblackbox_samlspserver_set($res, 157, $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:
- 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
This property is not available at design time.
Data Type
Integer
SecuritySigMethod Property (SecureBlackbox_SAMLSPServer Class)
The signature method to use.
Object Oriented Interface
public function getSecuritySigMethod(); public function setSecuritySigMethod($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 158 ); secureblackbox_samlspserver_set($res, 158, $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
SenderCertCount Property (SecureBlackbox_SAMLSPServer Class)
The number of records in the SenderChain arrays.
Object Oriented Interface
public function getSenderCertCount();
Procedural Interface
secureblackbox_samlspserver_get($res, 159 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SenderCertCount - 1.This property is read-only and not available at design time.
Data Type
Integer
SenderChainBytes Property (SecureBlackbox_SAMLSPServer Class)
Returns raw certificate data in DER format.
Object Oriented Interface
public function getSenderChainBytes($sendercertindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 160 , $sendercertindex);
Remarks
Returns raw certificate data in DER format.
The $sendercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
SenderChainHandle Property (SecureBlackbox_SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Object Oriented Interface
public function getSenderChainHandle($sendercertindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 168 , $sendercertindex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The $sendercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
SigningCertBytes Property (SecureBlackbox_SAMLSPServer Class)
Returns raw certificate data in DER format.
Object Oriented Interface
public function getSigningCertBytes();
Procedural Interface
secureblackbox_samlspserver_get($res, 196 );
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertHandle Property (SecureBlackbox_SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Object Oriented Interface
public function getSigningCertHandle(); public function setSigningCertHandle($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 204 ); secureblackbox_samlspserver_set($res, 204, $value );
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
SigningChainCount Property (SecureBlackbox_SAMLSPServer Class)
The number of records in the SigningChain arrays.
Object Oriented Interface
public function getSigningChainCount(); public function setSigningChainCount($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 232 ); secureblackbox_samlspserver_set($res, 232, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SigningChainCount - 1.This property is not available at design time.
Data Type
Integer
SigningChainBytes Property (SecureBlackbox_SAMLSPServer Class)
Returns raw certificate data in DER format.
Object Oriented Interface
public function getSigningChainBytes($signingchainindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 233 , $signingchainindex);
Remarks
Returns raw certificate data in DER format.
The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningChainHandle Property (SecureBlackbox_SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Object Oriented Interface
public function getSigningChainHandle($signingchainindex); public function setSigningChainHandle($signingchainindex, $value);
Procedural Interface
secureblackbox_samlspserver_get($res, 241 , $signingchainindex); secureblackbox_samlspserver_set($res, 241, $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
SigningFlags Property (SecureBlackbox_SAMLSPServer Class)
Adjusts signing behaviour.
Object Oriented Interface
public function getSigningFlags(); public function setSigningFlags($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 269 ); secureblackbox_samlspserver_set($res, 269, $value );
Default Value
0
Remarks
Use this bit mask property to adjust what entities are going to be signed by the server. The following flags are supported:
- 1 - ssfSignAuthnRequests - sign authentication requests
- 2 - ssfSignArtifactResolveRequests - sign artifact resolve requests
- 4 - ssfSignLogoutRequests - sign logout requests
Data Type
Integer
SocketIncomingSpeedLimit Property (SecureBlackbox_SAMLSPServer Class)
The maximum number of bytes to read from the socket, per second.
Object Oriented Interface
public function getSocketIncomingSpeedLimit(); public function setSocketIncomingSpeedLimit($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 275 ); secureblackbox_samlspserver_set($res, 275, $value );
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (SecureBlackbox_SAMLSPServer Class)
The local network interface to bind the socket to.
Object Oriented Interface
public function getSocketLocalAddress(); public function setSocketLocalAddress($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 276 ); secureblackbox_samlspserver_set($res, 276, $value );
Default Value
''
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (SecureBlackbox_SAMLSPServer Class)
The local port number to bind the socket to.
Object Oriented Interface
public function getSocketLocalPort(); public function setSocketLocalPort($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 277 ); secureblackbox_samlspserver_set($res, 277, $value );
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (SecureBlackbox_SAMLSPServer Class)
The maximum number of bytes to write to the socket, per second.
Object Oriented Interface
public function getSocketOutgoingSpeedLimit(); public function setSocketOutgoingSpeedLimit($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 278 ); secureblackbox_samlspserver_set($res, 278, $value );
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (SecureBlackbox_SAMLSPServer Class)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Object Oriented Interface
public function getSocketTimeout(); public function setSocketTimeout($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 279 ); secureblackbox_samlspserver_set($res, 279, $value );
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
Integer
SocketUseIPv6 Property (SecureBlackbox_SAMLSPServer Class)
Enables or disables IP protocol version 6.
Object Oriented Interface
public function getSocketUseIPv6(); public function setSocketUseIPv6($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 280 ); secureblackbox_samlspserver_set($res, 280, $value );
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
SPServiceCount Property (SecureBlackbox_SAMLSPServer Class)
The number of records in the SPService arrays.
Object Oriented Interface
public function getSPServiceCount();
Procedural Interface
secureblackbox_samlspserver_get($res, 281 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- SPServiceBindingType
- SPServiceEntityID
- SPServiceIndex
- SPServiceLocation
- SPServicePriority
- SPServiceService
This property is read-only and not available at design time.
Data Type
Integer
SPServiceBindingType Property (SecureBlackbox_SAMLSPServer Class)
Specifies the type of SAML binding that this endpoint accepts.
Object Oriented Interface
public function getSPServiceBindingType($spserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 282 , $spserviceindex);
Default Value
0
Remarks
Specifies the type of SAML binding that this endpoint accepts.
Use this property to specify the binding type to use with this endpoint.
The $spserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.
This property is read-only and not available at design time.
Data Type
Integer
SPServiceEntityID Property (SecureBlackbox_SAMLSPServer Class)
Represents the SAML entity ID.
Object Oriented Interface
public function getSPServiceEntityID($spserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 283 , $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
SPServiceIndex Property (SecureBlackbox_SAMLSPServer Class)
The index of this endpoint.
Object Oriented Interface
public function getSPServiceIndex($spserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 284 , $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
SPServiceLocation Property (SecureBlackbox_SAMLSPServer Class)
The location (URL) of the endpoint.
Object Oriented Interface
public function getSPServiceLocation($spserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 285 , $spserviceindex);
Default Value
''
Remarks
The location (URL) of the endpoint.
The $spserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.
This property is read-only and not available at design time.
Data Type
String
SPServicePriority Property (SecureBlackbox_SAMLSPServer Class)
The priority of the endpoint in relation to other endpoints with the same Location .
Object Oriented Interface
public function getSPServicePriority($spserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 286 , $spserviceindex);
Default Value
-1
Remarks
The priority of the endpoint in relation to other endpoints with the same SPLocation.
Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.
Leave all priorities at -1 to omit generation of the Default attribute.
The $spserviceindex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.
This property is read-only and not available at design time.
Data Type
Integer
SPServiceService Property (SecureBlackbox_SAMLSPServer Class)
The kind of the service being provided at this endpoint.
Object Oriented Interface
public function getSPServiceService($spserviceindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 287 , $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
SPContactPerson Property (SecureBlackbox_SAMLSPServer Class)
The contact person or persons for the entity.
Object Oriented Interface
public function getSPContactPerson(); public function setSPContactPerson($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 288 ); secureblackbox_samlspserver_set($res, 288, $value );
Default Value
''
Remarks
The contact person or persons for the entity.
SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.
Each record contains a semicolon-separated list of contact person parameters, for example:
Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678
You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.
This property is not available at design time.
Data Type
String
SPEncryptionKey Property (SecureBlackbox_SAMLSPServer Class)
Contains the entity's encryption key.
Object Oriented Interface
public function getSPEncryptionKey(); public function setSPEncryptionKey($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 289 ); secureblackbox_samlspserver_set($res, 289, $value );
Remarks
Contains the entity's encryption key.
This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).
Requests sent to the endpoint can be encrypted with the provided key or certificate.
This property is not available at design time.
Data Type
Byte Array
SPEncryptionMethods Property (SecureBlackbox_SAMLSPServer Class)
Specifies the list of encryption methods supported by the entity.
Object Oriented Interface
public function getSPEncryptionMethods(); public function setSPEncryptionMethods($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 290 ); secureblackbox_samlspserver_set($res, 290, $value );
Default Value
''
Remarks
Specifies the list of encryption methods supported by the entity.
This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.
Examples of algorithms supported by this property:
- http://www.w3.org/2009/xmlenc11#aes128-gcm
- http://www.w3.org/2001/04/xmlenc#aes256-cbc
This property is not available at design time.
Data Type
String
SPEntityID Property (SecureBlackbox_SAMLSPServer Class)
Represents the SAML entity ID.
Object Oriented Interface
public function getSPEntityID(); public function setSPEntityID($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 291 ); secureblackbox_samlspserver_set($res, 291, $value );
Default Value
''
Remarks
Represents the SAML entity ID.
Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).
This property is not available at design time.
Data Type
String
SPFlags Property (SecureBlackbox_SAMLSPServer Class)
Adjusts secondary entity properties.
Object Oriented Interface
public function getSPFlags(); public function setSPFlags($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 292 ); secureblackbox_samlspserver_set($res, 292, $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
SPNameIDFormats Property (SecureBlackbox_SAMLSPServer Class)
The list of NameID formats supported by this entity.
Object Oriented Interface
public function getSPNameIDFormats(); public function setSPNameIDFormats($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 293 ); secureblackbox_samlspserver_set($res, 293, $value );
Default Value
''
Remarks
The list of NameID formats supported by this entity.
Use this setting to get or set the list of NameID formats supported by the entity.
Use SAML notation for the formats:
- urn:oasis:names:tc:SAML:2.0:nameid-format:transient
- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
This property is not available at design time.
Data Type
String
SPOrganizationDisplayName Property (SecureBlackbox_SAMLSPServer Class)
The friendly name of the organization that maintains the entity.
Object Oriented Interface
public function getSPOrganizationDisplayName(); public function setSPOrganizationDisplayName($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 294 ); secureblackbox_samlspserver_set($res, 294, $value );
Default Value
''
Remarks
The friendly name of the organization that maintains the entity.
Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.
This property is not available at design time.
Data Type
String
SPOrganizationLang Property (SecureBlackbox_SAMLSPServer Class)
The language preferred by the organization.
Object Oriented Interface
public function getSPOrganizationLang(); public function setSPOrganizationLang($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 295 ); secureblackbox_samlspserver_set($res, 295, $value );
Default Value
''
Remarks
The language preferred by the organization.
This optional setting can be used to adjust the preferred language of the owning organization.
This property is not available at design time.
Data Type
String
SPOrganizationName Property (SecureBlackbox_SAMLSPServer Class)
The name of the organization that maintains the entity.
Object Oriented Interface
public function getSPOrganizationName(); public function setSPOrganizationName($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 296 ); secureblackbox_samlspserver_set($res, 296, $value );
Default Value
''
Remarks
The name of the organization that maintains the entity.
Use this setting to get or set the name of the organization that maintains the SAML entity.
This property is not available at design time.
Data Type
String
SPOrganizationURL Property (SecureBlackbox_SAMLSPServer Class)
The web URL of the organization that maintains the entity.
Object Oriented Interface
public function getSPOrganizationURL(); public function setSPOrganizationURL($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 297 ); secureblackbox_samlspserver_set($res, 297, $value );
Default Value
''
Remarks
The web URL of the organization that maintains the entity.
Use this setting to get or set the web address of the organization responsible for this SAML entity.
This property is not available at design time.
Data Type
String
SPSignatureValidationResult Property (SecureBlackbox_SAMLSPServer Class)
The outcome of the cryptographic signature validation.
Object Oriented Interface
public function getSPSignatureValidationResult();
Procedural Interface
secureblackbox_samlspserver_get($res, 298 );
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
This property is read-only and not available at design time.
Data Type
Integer
SPSigned Property (SecureBlackbox_SAMLSPServer Class)
Specifies whether the SAML entity information is or should be signed.
Object Oriented Interface
public function getSPSigned();
Procedural Interface
secureblackbox_samlspserver_get($res, 299 );
Default Value
false
Remarks
Specifies whether the SAML entity information is or should be signed.
Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.
This property is read-only and not available at design time.
Data Type
Boolean
SPSignedWith Property (SecureBlackbox_SAMLSPServer Class)
Contains the certificate or key that was used to sign the settings (metadata) document.
Object Oriented Interface
public function getSPSignedWith();
Procedural Interface
secureblackbox_samlspserver_get($res, 300 );
Remarks
Contains the certificate or key that was used to sign the settings (metadata) document.
This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.
The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the SPSignatureValidationResult setting.
This property is read-only and not available at design time.
Data Type
Byte Array
SPSigningKey Property (SecureBlackbox_SAMLSPServer Class)
Contains the entity's signing key.
Object Oriented Interface
public function getSPSigningKey(); public function setSPSigningKey($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 301 ); secureblackbox_samlspserver_set($res, 301, $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 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 SigningCertificate setting (for this-party settings).
Messages sent by the endpoint can be signed with the provided key or certificate.
This property is not available at design time.
Data Type
Byte Array
SPValidUntil Property (SecureBlackbox_SAMLSPServer Class)
Specifies the expiration time of the SAML entity information.
Object Oriented Interface
public function getSPValidUntil(); public function setSPValidUntil($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 302 ); secureblackbox_samlspserver_set($res, 302, $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
SPToIDPBinding Property (SecureBlackbox_SAMLSPServer Class)
Specifies the IdP to SP binding to use.
Object Oriented Interface
public function getSPToIDPBinding(); public function setSPToIDPBinding($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 303 ); secureblackbox_samlspserver_set($res, 303, $value );
Default Value
3
Remarks
Specifies the binding (message exchange mechanism) used for communication with Identity Provider (IdP) that is actually used during the session.
To specify the preferred binding, use PreferredIDPToSPBinding.
csbtNone | 0 | |
csbtSOAP | 1 | |
csbtPAOS | 2 | |
csbtRedirect | 3 | |
csbtPOST | 4 | |
csbtArtifact | 5 |
Data Type
Integer
TLSServerCertCount Property (SecureBlackbox_SAMLSPServer Class)
The number of records in the TLSServerCert arrays.
Object Oriented Interface
public function getTLSServerCertCount(); public function setTLSServerCertCount($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 304 ); secureblackbox_samlspserver_set($res, 304, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSServerCertCount - 1.This property is not available at design time.
Data Type
Integer
TLSServerCertBytes Property (SecureBlackbox_SAMLSPServer Class)
Returns raw certificate data in DER format.
Object Oriented Interface
public function getTLSServerCertBytes($tlsservercertindex);
Procedural Interface
secureblackbox_samlspserver_get($res, 305 , $tlsservercertindex);
Remarks
Returns raw certificate data in DER format.
The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TLSServerCertHandle Property (SecureBlackbox_SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Object Oriented Interface
public function getTLSServerCertHandle($tlsservercertindex); public function setTLSServerCertHandle($tlsservercertindex, $value);
Procedural Interface
secureblackbox_samlspserver_get($res, 313 , $tlsservercertindex); secureblackbox_samlspserver_set($res, 313, $value , $tlsservercertindex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is not available at design time.
Data Type
Long64
TLSAutoValidateCertificates Property (SecureBlackbox_SAMLSPServer Class)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Object Oriented Interface
public function getTLSAutoValidateCertificates(); public function setTLSAutoValidateCertificates($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 341 ); secureblackbox_samlspserver_set($res, 341, $value );
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (SecureBlackbox_SAMLSPServer Class)
Selects the base configuration for the TLS settings.
Object Oriented Interface
public function getTLSBaseConfiguration(); public function setTLSBaseConfiguration($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 342 ); secureblackbox_samlspserver_set($res, 342, $value );
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (SecureBlackbox_SAMLSPServer Class)
A list of ciphersuites separated with commas or semicolons.
Object Oriented Interface
public function getTLSCiphersuites(); public function setTLSCiphersuites($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 343 ); secureblackbox_samlspserver_set($res, 343, $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 that allow to blanketly enable or disable all ciphersuites at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
String
TLSClientAuth Property (SecureBlackbox_SAMLSPServer Class)
Enables or disables certificate-based client authentication.
Object Oriented Interface
public function getTLSClientAuth(); public function setTLSClientAuth($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 344 ); secureblackbox_samlspserver_set($res, 344, $value );
Default Value
0
Remarks
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;
Data Type
Integer
TLSECCurves Property (SecureBlackbox_SAMLSPServer Class)
Defines the elliptic curves to enable.
Object Oriented Interface
public function getTLSECCurves(); public function setTLSECCurves($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 345 ); secureblackbox_samlspserver_set($res, 345, $value );
Default Value
''
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (SecureBlackbox_SAMLSPServer Class)
Provides access to TLS extensions.
Object Oriented Interface
public function getTLSExtensions(); public function setTLSExtensions($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 346 ); secureblackbox_samlspserver_set($res, 346, $value );
Default Value
''
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (SecureBlackbox_SAMLSPServer Class)
Whether to force TLS session resumption when the destination address changes.
Object Oriented Interface
public function getTLSForceResumeIfDestinationChanges(); public function setTLSForceResumeIfDestinationChanges($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 347 ); secureblackbox_samlspserver_set($res, 347, $value );
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (SecureBlackbox_SAMLSPServer Class)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Object Oriented Interface
public function getTLSPreSharedIdentity(); public function setTLSPreSharedIdentity($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 348 ); secureblackbox_samlspserver_set($res, 348, $value );
Default Value
''
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is not available at design time.
Data Type
String
TLSPreSharedKey Property (SecureBlackbox_SAMLSPServer Class)
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Object Oriented Interface
public function getTLSPreSharedKey(); public function setTLSPreSharedKey($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 349 ); secureblackbox_samlspserver_set($res, 349, $value );
Default Value
''
Remarks
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
This property is not available at design time.
Data Type
String
TLSPreSharedKeyCiphersuite Property (SecureBlackbox_SAMLSPServer Class)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Object Oriented Interface
public function getTLSPreSharedKeyCiphersuite(); public function setTLSPreSharedKeyCiphersuite($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 350 ); secureblackbox_samlspserver_set($res, 350, $value );
Default Value
''
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_SAMLSPServer Class)
Selects renegotiation attack prevention mechanism.
Object Oriented Interface
public function getTLSRenegotiationAttackPreventionMode(); public function setTLSRenegotiationAttackPreventionMode($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 351 ); secureblackbox_samlspserver_set($res, 351, $value );
Default Value
2
Remarks
Selects renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
Integer
TLSRevocationCheck Property (SecureBlackbox_SAMLSPServer Class)
Specifies the kind(s) of revocation check to perform.
Object Oriented Interface
public function getTLSRevocationCheck(); public function setTLSRevocationCheck($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 352 ); secureblackbox_samlspserver_set($res, 352, $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.
crcNone | 0 | No revocation checking |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP | 3 | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP | 4 | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL | 5 | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP | 6 | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP | 7 | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
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 faster OCSP route and only demand one source to succeed) is a good choice for most of 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_SAMLSPServer Class)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Object Oriented Interface
public function getTLSSSLOptions(); public function setTLSSSLOptions($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 353 ); secureblackbox_samlspserver_set($res, 353, $value );
Default Value
16
Remarks
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. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (SecureBlackbox_SAMLSPServer Class)
Specifies the TLS mode to use.
Object Oriented Interface
public function getTLSTLSMode(); public function setTLSTLSMode($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 354 ); secureblackbox_samlspserver_set($res, 354, $value );
Default Value
0
Remarks
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (SecureBlackbox_SAMLSPServer Class)
Enables Extended Master Secret Extension, as defined in RFC 7627.
Object Oriented Interface
public function getTLSUseExtendedMasterSecret(); public function setTLSUseExtendedMasterSecret($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 355 ); secureblackbox_samlspserver_set($res, 355, $value );
Default Value
false
Remarks
Enables Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (SecureBlackbox_SAMLSPServer Class)
Enables or disables TLS session resumption capability.
Object Oriented Interface
public function getTLSUseSessionResumption(); public function setTLSUseSessionResumption($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 356 ); secureblackbox_samlspserver_set($res, 356, $value );
Default Value
false
Remarks
Enables or disables TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (SecureBlackbox_SAMLSPServer Class)
The SSL/TLS versions to enable by default.
Object Oriented Interface
public function getTLSVersions(); public function setTLSVersions($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 357 ); secureblackbox_samlspserver_set($res, 357, $value );
Default Value
16
Remarks
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Data Type
Integer
URL Property (SecureBlackbox_SAMLSPServer Class)
Specifies the base URL of this SP server.
Object Oriented Interface
public function getURL(); public function setURL($value);
Procedural Interface
secureblackbox_samlspserver_get($res, 358 ); secureblackbox_samlspserver_set($res, 358, $value );
Default Value
''
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
Please make sure the URL you provide here aligns well with the relative endpoint resource paths, such as AssertionConsumerService or ArtifactResolutionService. The two parts (the URL and the endpoint paths) are concatenated to produce full endpoint URLs. Please double check that only one of the parts includes the slash character in it: either the endpoint paths at the beginning (the default configuration), or the base URL at the end.
Data Type
String
AddIdPService Method (SecureBlackbox_SAMLSPServer Class)
Registers an IdP service in the IdPServices list.
Object Oriented Interface
public function doAddIdPService($service, $bindingtype, $location, $priority, $index);
Procedural Interface
secureblackbox_samlspserver_do_addidpservice($res, $service, $bindingtype, $location, $priority, $index);
Remarks
Use this method to add an entry to the list of services and their locations provided by the IdP. TBD
spsUnknown | 0 | The service is of unknown or unsupported type |
spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
AddSPService Method (SecureBlackbox_SAMLSPServer Class)
Registers an SP service in the SPServices list.
Object Oriented Interface
public function doAddSPService($service, $bindingtype, $location, $priority, $index);
Procedural Interface
secureblackbox_samlspserver_do_addspservice($res, $service, $bindingtype, $location, $priority, $index);
Remarks
Use this method to add an entry to the list of services and their locations provided by the SP. TBD
spsUnknown | 0 | The service is of unknown or unsupported type |
spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
Config Method (SecureBlackbox_SAMLSPServer Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
secureblackbox_samlspserver_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DoAction Method (SecureBlackbox_SAMLSPServer Class)
Performs an additional action.
Object Oriented Interface
public function doDoAction($actionid, $actionparams);
Procedural Interface
secureblackbox_samlspserver_do_doaction($res, $actionid, $actionparams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insencitive) 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;....
ExportSettings Method (SecureBlackbox_SAMLSPServer Class)
Saves the SP or IdP configuration to an XML metadata file.
Object Oriented Interface
public function doExportSettings($sp);
Procedural Interface
secureblackbox_samlspserver_do_exportsettings($res, $sp);
Remarks
Use this method to save the Service Provider (SP) or Identity Provider (IdP) configuration in the form of XML metadata. The SP metadata file may then be transferred to identity providers (IdP) to let them know about the SP configuration.
Adjust the provider configuration as required in SPSettings or IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.
GetClientBuffer Method (SecureBlackbox_SAMLSPServer Class)
Obtains a pending connection buffer.
Object Oriented Interface
public function doGetClientBuffer($connectionid);
Procedural Interface
secureblackbox_samlspserver_do_getclientbuffer($res, $connectionid);
Remarks
Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.
GetProviderProperty Method (SecureBlackbox_SAMLSPServer Class)
Returns the value of a custom provider property.
Object Oriented Interface
public function doGetProviderProperty($name);
Procedural Interface
secureblackbox_samlspserver_do_getproviderproperty($res, $name);
Remarks
This method, together with SetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
ImportSettings Method (SecureBlackbox_SAMLSPServer Class)
Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call.
Object Oriented Interface
public function doImportSettings($metadata, $sp);
Procedural Interface
secureblackbox_samlspserver_do_importsettings($res, $metadata, $sp);
Remarks
The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP.
The Metadata parameter contains metadata in the form of byte array. Set SP parameter to true to indicate that it is the Service Provider's own settings that are being loaded.
The loaded metadata is populated in the SPSettings or IdPSettings object (depending on the value of the SP parameter).
InitiateArtifactResolve Method (SecureBlackbox_SAMLSPServer Class)
TBD.
Object Oriented Interface
public function doInitiateArtifactResolve($connectionid, $sessionid, $idpserviceindex, $artifact);
Procedural Interface
secureblackbox_samlspserver_do_initiateartifactresolve($res, $connectionid, $sessionid, $idpserviceindex, $artifact);
Remarks
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
InitiateAttributeQuery Method (SecureBlackbox_SAMLSPServer Class)
TBD.
Object Oriented Interface
public function doInitiateAttributeQuery($connectionid, $sessionid, $idpserviceindex, $attributes);
Procedural Interface
secureblackbox_samlspserver_do_initiateattributequery($res, $connectionid, $sessionid, $idpserviceindex, $attributes);
Remarks
TBD: we may need another event (some "ClarifyAttributes") to request more details about attributes.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
InitiateAuth Method (SecureBlackbox_SAMLSPServer Class)
Starts SP-initiated SAML authentication flow.
Object Oriented Interface
public function doInitiateAuth($connectionid, $sessionid, $idpserviceindex, $relaystate);
Procedural Interface
secureblackbox_samlspserver_do_initiateauth($res, $connectionid, $sessionid, $idpserviceindex, $relaystate);
Remarks
Use this method to initiate SAML authentication flow on the SP side. Pass the index of the single sign-on service that you want to use to the IdPServiceIndex parameter. Leave it empty to let the component pick up the best one automatically. Use RelayState to pass the callback URL to the IdP service. This will be mirrored back by the IDP in its response.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
InitiateLogout Method (SecureBlackbox_SAMLSPServer Class)
Starts SP-initiated SAML logout flow.
Object Oriented Interface
public function doInitiateLogout($connectionid, $sessionid, $idpserviceindex, $relaystate);
Procedural Interface
secureblackbox_samlspserver_do_initiatelogout($res, $connectionid, $sessionid, $idpserviceindex, $relaystate);
Remarks
Use this method to initiate SAML logout flow on the SP side. Pass the index of the single logout service that you want to use to the IdPServiceIndex parameter.
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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode. TBD
ProcessArtifactResolveRequest Method (SecureBlackbox_SAMLSPServer Class)
Processes an artifact request received from the SP service at one of the ARS endpoints.
Object Oriented Interface
public function doProcessArtifactResolveRequest($connectionid, $sessionid, $request);
Procedural Interface
secureblackbox_samlspserver_do_processartifactresolverequest($res, $connectionid, $sessionid, $request);
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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessAssertion Method (SecureBlackbox_SAMLSPServer Class)
Processes assertion received from the IdP service at one of the ACS endpoints.
Object Oriented Interface
public function doProcessAssertion($connectionid, $sessionid, $request);
Procedural Interface
secureblackbox_samlspserver_do_processassertion($res, $connectionid, $sessionid, $request);
Remarks
Use this method to pass a SAML assertion received at one of the AssertionConsumerService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessGenericRequest Method (SecureBlackbox_SAMLSPServer Class)
Processes a generic HTTP SAML request.
Object Oriented Interface
public function doProcessGenericRequest($connectionid, $sessionid, $request);
Procedural Interface
secureblackbox_samlspserver_do_processgenericrequest($res, $connectionid, $sessionid, $request);
Remarks
Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine.
The Request parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers. The generated response contains a full HTTP response that should be supplied back to the requestor. You can edit some parts of the response (for example, by adding some custom HTTP headers).
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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessLogoutRequest Method (SecureBlackbox_SAMLSPServer Class)
Processes logout request received from the IdP service at one of the SLS endpoints.
Object Oriented Interface
public function doProcessLogoutRequest($connectionid, $sessionid, $request);
Procedural Interface
secureblackbox_samlspserver_do_processlogoutrequest($res, $connectionid, $sessionid, $request);
Remarks
Use this method to pass a SAML logout request received at one of the SingleLogoutService endpoints.
An SLS endpoint may receive requests of two kinds: LogoutRequest and LogoutResponse. If Request contains a LogoutRequest, the content generated by this method will contain a corresponding LogoutResponse. If Request contains a LogoutResponse, the generated content is empty.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
SetClientBuffer Method (SecureBlackbox_SAMLSPServer Class)
Commits a data buffer to the connection.
Object Oriented Interface
public function doSetClientBuffer($connectionid, $value);
Procedural Interface
secureblackbox_samlspserver_do_setclientbuffer($res, $connectionid, $value);
Remarks
Use this method from your ReadFile event handler to commit a chunk of file data to the server component.
SetProviderProperty Method (SecureBlackbox_SAMLSPServer Class)
Sets the value of a custom provider property.
Object Oriented Interface
public function doSetProviderProperty($name, $value);
Procedural Interface
secureblackbox_samlspserver_do_setproviderproperty($res, $name, $value);
Remarks
This method, together with GetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
Start Method (SecureBlackbox_SAMLSPServer Class)
Starts the SP server.
Object Oriented Interface
public function doStart();
Procedural Interface
secureblackbox_samlspserver_do_start($res);
Remarks
Use this method to start listening for incoming connections.
Stop Method (SecureBlackbox_SAMLSPServer Class)
Stops the IdP server.
Object Oriented Interface
public function doStop();
Procedural Interface
secureblackbox_samlspserver_do_stop($res);
Remarks
Call this method to stop listening for incoming connections.
Accept Event (SecureBlackbox_SAMLSPServer Class)
Reports an incoming connection.
Object Oriented Interface
public function fireAccept($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 1, array($this, 'fireAccept'));
Parameter List
'remoteaddress'
'remoteport'
'accept'
Remarks
This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.
Subscribe to Connect event to be notified of every connection that has been set up.
ArtifactResolveRequestPrepared Event (SecureBlackbox_SAMLSPServer Class)
This event is fired when a new authentication request message has been prepared.
Object Oriented Interface
public function fireArtifactResolveRequestPrepared($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 2, array($this, 'fireArtifactResolveRequestPrepared'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'artifact'
Remarks
TBD
ArtifactResolveRequestReceived Event (SecureBlackbox_SAMLSPServer Class)
TBD.
Object Oriented Interface
public function fireArtifactResolveRequestReceived($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 3, array($this, 'fireArtifactResolveRequestReceived'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'isencrypted'
'issigned'
'artifact'
'action'
Remarks
AssertionReceived Event (SecureBlackbox_SAMLSPServer Class)
This event is fired when a new assertion has been received.
Object Oriented Interface
public function fireAssertionReceived($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 4, array($this, 'fireAssertionReceived'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'isencrypted'
'issigned'
'nameid'
'sessionindex'
'action'
Remarks
The AssertionReceived event notifies the application that an assertion has been received at the ACS endpoint. In OfflineMode this event may fire in response to a ProcessAssertion call. In online mode it can fire at any time while the server is active.
The ConnectionID and SessionID specify the IDs of the current client connection and HTTP session. The RequestID contains the ID of the original AuthnRequest message, if it was sent by the service provider. The IsEncrypted and IsSigned parameters indicate the security properties of the assertion. The NameID parameter contains the unique name identifier of the authenticated principal, and the SessionIndex contains the SAML session identifier. In rare cases SessionIndex may contain multiple indices, if the SP has more than one session at the IdP.
AttributeQueryPrepared Event (SecureBlackbox_SAMLSPServer Class)
This event is fired when a new attribute query message has been prepared.
Object Oriented Interface
public function fireAttributeQueryPrepared($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 5, array($this, 'fireAttributeQueryPrepared'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'attributes'
Remarks
TBD
AuthnRequestPrepared Event (SecureBlackbox_SAMLSPServer Class)
This event is fired when a new authentication request message has been prepared.
Object Oriented Interface
public function fireAuthnRequestPrepared($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 6, array($this, 'fireAuthnRequestPrepared'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'forceauthn'
'noninteractive'
Remarks
TBD
Connect Event (SecureBlackbox_SAMLSPServer Class)
Reports an accepted connection.
Object Oriented Interface
public function fireConnect($param);
Procedural Interface
secureblackbox_samlspserver_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_SAMLSPServer Class)
Fires to report a disconnected client.
Object Oriented Interface
public function fireDisconnect($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 8, array($this, 'fireDisconnect'));
Parameter List
'connectionid'
Remarks
The class fires this event when a connected client disconnects.
Encrypted Event (SecureBlackbox_SAMLSPServer Class)
Notifies the application that the assertion is encrypted and provides recipient certificate details.
Object Oriented Interface
public function fireEncrypted($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 9, array($this, 'fireEncrypted'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'issuerrdn'
'serialnumber'
'subjectkeyid'
'needcredential'
'skipthis'
Remarks
The class fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.
This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate property (depending on encryption method used), or sets SkipThis to true.
The IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own OnEncrypted event loop.
The NeedCredential parameter specifies whether the correct credential is already available to the class or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the DecryptionCertificate property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.
Error Event (SecureBlackbox_SAMLSPServer Class)
Information about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 10, array($this, 'fireError'));
Parameter List
'connectionid'
'errorcode'
'description'
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section.
ExternalSign Event (SecureBlackbox_SAMLSPServer Class)
Handles remote or external signing initiated by the server protocol.
Object Oriented Interface
public function fireExternalSign($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 11, 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 component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for 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 a .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
LogoutRequestPrepared Event (SecureBlackbox_SAMLSPServer Class)
This event is fired when a new logout request has been prepared.
Object Oriented Interface
public function fireLogoutRequestPrepared($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 12, array($this, 'fireLogoutRequestPrepared'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'nameid'
Remarks
TBD
LogoutRequestReceived Event (SecureBlackbox_SAMLSPServer Class)
TBD.
Object Oriented Interface
public function fireLogoutRequestReceived($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 13, array($this, 'fireLogoutRequestReceived'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'isencrypted'
'issigned'
'nameid'
'action'
Remarks
MetadataPrepared Event (SecureBlackbox_SAMLSPServer Class)
Passes a prepared metadata object to the application.
Object Oriented Interface
public function fireMetadataPrepared($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 14, 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_SAMLSPServer Class)
This event notifies the application about an underlying control flow event.
Object Oriented Interface
public function fireNotification($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 15, 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 component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
ProcessingCompleted Event (SecureBlackbox_SAMLSPServer Class)
This event notifies the application of the completion of request or response processing.
Object Oriented Interface
public function fireProcessingCompleted($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 16, array($this, 'fireProcessingCompleted'));
Parameter List
'connectionid'
'sessionid'
'processingresult'
'response'
'redirect'
Remarks
The component fires ProcessingCompleted to notify the application about completion of an earlier initiated processing operation. It is only fired in OfflineMode in response to calls such as ProcessAssertion, ProcessLogoutRequest, or similar. The main purpose of this event is to notify the application of the outcomes of the processing and return any prepared SAML entity for subsequent relay to the browser.
This event is fired strictly once for each Process* call, with the ConnectionID matching the value passed to the Process* method.
The SessionID parameter contains the identifier of the current virtual session. It may differ to the value passed to the Process* method if the session information was provided on the fly via the SessionInfoNeeded event. The ProcessingResult indicates the type of deliverable that was created during the processing (see below for possible values). The Response parameter contains the body of the deliverable. This can take one of the forms:
- a self-submitting form containing a SAML message.
- a redirect URL.
- a SOAP XML response.
- an empty string if ProcessingResult is set to sprSuccess.
The Redirect parameter indicates whether the value of Response should be passed to the browser within the 302 Location header, or as a document body.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
ResourceClose Event (SecureBlackbox_SAMLSPServer Class)
Tells the application that it can close the opened resource.
Object Oriented Interface
public function fireResourceClose($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 17, array($this, 'fireResourceClose'));
Parameter List
'connectionid'
Remarks
The class uses this event to notify the application that it can now close the resource opened earlier in its ResourceOpen handler.
After closing the resource, set the OperationStatus according to the outcome of the operation.
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceOpen Event (SecureBlackbox_SAMLSPServer Class)
Requests the application to open the requested resource.
Object Oriented Interface
public function fireResourceOpen($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 18, array($this, 'fireResourceOpen'));
Parameter List
'connectionid'
'url'
'operationstatus'
Remarks
The class fires this event in virtualized mode if the application had returned the fraCustom modifier from the earlier ResourceRequest event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent ResourceRead event calls. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRead Event (SecureBlackbox_SAMLSPServer Class)
Requests the application to read from an opened resource.
Object Oriented Interface
public function fireResourceRead($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 19, array($this, 'fireResourceRead'));
Parameter List
'connectionid'
'size'
'operationstatus'
Remarks
The class fires this event in virtualized mode to request another chunk of data from the resource opened earlier. The handler of this event should read up to Size bytes from the object, and pass them to the component with a SetClientBuffer call.
Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ResourceRead calls are needed.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRequest Event (SecureBlackbox_SAMLSPServer Class)
Notifies the application that a server resource is requested.
Object Oriented Interface
public function fireResourceRequest($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 20, array($this, 'fireResourceRequest'));
Parameter List
'connectionid'
'url'
'resprotected'
'resspecial'
'action'
Remarks
The class uses this event to notify the application that the connection has requested a server resource.
The URL parameter specifies the resource requested. ResProtected is set to true if the resource is protected by SAML. ResSpecial is set to true if the request is a SAML resource, such as the metadata or an Assertion Consumer Service page. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request).
Choose Action as one of the following values:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
SAMLMessagePrepared Event (SecureBlackbox_SAMLSPServer Class)
The server fires this event when it is ready to submit a SAML response body.
Object Oriented Interface
public function fireSAMLMessagePrepared($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 21, array($this, 'fireSAMLMessagePrepared'));
Parameter List
'connectionid'
'sessionid'
'inresponseto'
'requestbody'
'messagetype'
'messagebody'
'success'
Remarks
Subscribe to this event to be notified about authentication requests being received. The component can fire this event from ProcessSignOnRequest and ProcessGenericRequest calls in OfflineMode, or asynchronously in online mode.
Set Action property in accordance with desired handling option. TBD TODO: we may need to include the Destination parameter
SAMLMessageReceived Event (SecureBlackbox_SAMLSPServer Class)
The server fires this event upon receiving a valid SAML message.
Object Oriented Interface
public function fireSAMLMessageReceived($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 22, array($this, 'fireSAMLMessageReceived'));
Parameter List
'connectionid'
'sessionid'
'messagetype'
'messageid'
'issuer'
'issueinstant'
'messagebody'
'relaystate'
'action'
Remarks
Subscribe to this event to be notified about SAML messages received. The component can fire this event from ProcessAssertion and ProcessGenericRequest calls in OfflineMode, or asynchronously in online mode.
Set Action property in accordance with desired handling option. TBD
SessionCreated Event (SecureBlackbox_SAMLSPServer Class)
This event is fired when a new session has been established.
Object Oriented Interface
public function fireSessionCreated($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 23, array($this, 'fireSessionCreated'));
Parameter List
'connectionid'
'sessionid'
Remarks
ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.
SessionDestroyed Event (SecureBlackbox_SAMLSPServer Class)
This event is fired when the SP server has closed a session.
Object Oriented Interface
public function fireSessionDestroyed($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 24, array($this, 'fireSessionDestroyed'));
Parameter List
'connectionid'
'sessionid'
Remarks
ConnectionID contains the identifier of the closed session.
SessionEvent Event (SecureBlackbox_SAMLSPServer Class)
Notifies the application about the change of SAML session stage.
Object Oriented Interface
public function fireSessionEvent($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 25, 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
SessionInfoNeeded Event (SecureBlackbox_SAMLSPServer Class)
This event is fired in OfflineMode to request the session ID for the current flow.
Object Oriented Interface
public function fireSessionInfoNeeded($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 26, array($this, 'fireSessionInfoNeeded'));
Parameter List
'connectionid'
'sessionid'
Remarks
TBD
SessionStateRetrieve Event (SecureBlackbox_SAMLSPServer Class)
TBD.
Object Oriented Interface
public function fireSessionStateRetrieve($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 27, array($this, 'fireSessionStateRetrieve'));
Parameter List
'connectionid'
'sessionid'
'sessionstate'
Remarks
TBD
SessionStateSave Event (SecureBlackbox_SAMLSPServer Class)
TBD.
Object Oriented Interface
public function fireSessionStateSave($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 28, array($this, 'fireSessionStateSave'));
Parameter List
'connectionid'
'sessionid'
'sessionstate'
Remarks
TBD
SignatureFound Event (SecureBlackbox_SAMLSPServer Class)
Signifies the start of signature validation.
Object Oriented Interface
public function fireSignatureFound($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 29, array($this, 'fireSignatureFound'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'scope'
'issuerrdn'
'serialnumber'
'subjectkeyid'
'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.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
The details of the reported signature are populated in the Security object. For assertion signatures, you can update the details by pinning the assertion.
The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the SigningCertificate property and the associated certificates from the Certificates collection, and pass them to the CertificateValidator component to validate its chain.
Use the Validate parameter to tell the reader whether it should validate the signature.
SignatureValidated Event (SecureBlackbox_SAMLSPServer Class)
Reports the signature validation result.
Object Oriented Interface
public function fireSignatureValidated($param);
Procedural Interface
secureblackbox_samlspserver_register_callback($res, 30, array($this, 'fireSignatureValidated'));
Parameter List
'connectionid'
'sessionid'
'requestid'
'scope'
'issuerrdn'
'serialnumber'
'subjectkeyid'
'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.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
Config Settings (SAMLSPServer Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.SAMLSPServer Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (SAMLSPServer Class)
SAMLSPServer Errors
1048577 | Invalid parameter value (SB_ERROR_INVALID_PARAMETER) |
1048578 | Class is configured incorrectly (SB_ERROR_INVALID_SETUP) |
1048579 | Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) |
1048580 | Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) |
1048581 | Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) |
1048581 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
30408705 | Invalid binging name (SB_ERROR_SAML_INVALID_BINDING_NAME) |
30408706 | Invalid binding type (SB_ERROR_SAML_INVALID_BINDING_TYPE) |
30408707 | Base directory not set (SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET) |