SAMLSPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLSPServer class represents a SAML service provider.

Syntax

SAMLSPServer

Remarks

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

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

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

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

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

  • Configure the main server capabilities:

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

  • Personalize the server:

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

  • Optionally, save metadata to an XML file. This will let you send/upload it to the IdP, so they could set your SP up. Some IdPs can download the metadata right from your SP using the MetadataURL that you've provided above, in which case saving it to a file is not necessary. server.SaveMetadata("my_metadata.xml");
You are now ready to start the server: server.Start(); The server should now be running on the local system, listening to incoming connections on the port that you have specified above (80). Use your browser to check if the server is responding by navigating to the metadata URL (http://127.0.0.1:80/sp/metadata). If the server has been set up right, you should see something like this:

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

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

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

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

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

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

Property List


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

ActiveTells whether the server is active and ready to process requests.
BaseDirBase directory on the server.
BindingKeyContains a private key to sign the redirect binding requests.
DecryptionCertificateThe certificate to be used to decrypt assertions.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
HandshakeTimeoutSpecifies the handshake timeout in milliseconds.
HostSpecifies the host address of the SP server.
IdPServicesPopulates a list of services supported by the IdP.
IdPSettingsPopulates a list of SAML IdP entity settings.
IssuerName identifier of the issuer of the SP's requests.
KnownCertificatesAdditional certificates for chain validation.
KnownKeysPublic keys for low-level signature validation.
LogoutPageSpecifies the location of the logout page.
MetadataURLThe SP's metadata location.
MetaSigningCertificateSpecifies the metadata signing certificate.
OfflineModeEnables the Offline mode.
PinnedClientPopulates the pinned client details.
PinnedClientChainContains the certificate chain of the pinned client.
PortSpecifies the listening port number.
ProtectedResourcesSpecifies the list of protected resources.
RedirectOnLogoutPageSpecifies the location to redirect the user on logout.
SecurityProvides access to the SAML security properties.
SenderChainContains the certificate chain of the message sender.
SigningCertificateThe certificate for signing the SP requests.
SigningChainThe signing certificate chain.
SocketSettingsManages network connection settings.
SPServicesPopulates a list of services supported by the SP.
SPSettingsPopulates a list of SAML SP entity settings.
TLSServerChainThe server's TLS certificates.
TLSSettingsManages TLS layer settings.
URLSpecifies 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.

AddIdPServiceRegisters an IdP service in the IdPServices list.
AddSPServiceRegisters an SP service in the SPServices list.
CleanupCleans up the server environment by purging expired sessions and cleaning caches.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
DropClientTerminates a client connection.
ExportSettingsSaves the SP or IdP configuration to an XML metadata file.
GetClientBufferAcquires a piece of operation data.
GetProviderPropertyReturns the value of a custom provider property.
GetRequestBytesReturns the contents of the connected client's HTTP request.
GetRequestHeaderReturns a request header value.
GetResponseHeaderReturns a response header value.
GetSessionPropertyReturns the value of a custom session property.
ImportSettingsLoads 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.
InitiateArtifactResolveInitiates the artifact resolution protocol.
InitiateAttributeQueryInitiates the attribute query.
InitiateAuthStarts SP-initiated SAML authentication flow.
InitiateLogoutStarts SP-initiated SAML logout flow.
ListClientsEnumerates the connected clients.
PinClientTakes a snapshot of the connection's properties.
ProcessArtifactProcesses an artifact request received from the IdP service at one of artifact receiver endpoints.
ProcessArtifactResolveRequestProcesses an artifact request received from the SP service at one of the ARS endpoints.
ProcessAssertionProcesses assertion received from the IdP service at one of the ACS endpoints.
ProcessGenericRequestProcesses a generic HTTP SAML request.
ProcessLogoutRequestProcesses logout request received from the IdP service at one of the SLS endpoints.
ResetResets the class settings.
SetClientBufferCommits a data buffer to the connection.
SetProviderPropertySets the value of a custom provider property.
SetResponseHeaderSets a response header.
SetSessionPropertySets the value of a custom provider session property.
StartStarts the SP server.
StopStops 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.

AcceptReports an incoming connection.
ArtifactReceivedThe server fires this event upon receiving an Artifact message from the other side.
ArtifactResolveRequestPreparedThis event is fired when a new artifact resolution request message has been prepared by the class.
ArtifactResolveRequestReceivedReports receipt of ArtifactResolveRequest message.
AssertionReceivedThis event is fired when an assertion is received from the IdP.
AttributeQueryPreparedNotifies the application of the preparation of an AttributeQuery.
AuthnRequestPreparedThis event is fired when a new authentication request message has been prepared.
ConnectReports an accepted connection.
DisconnectFires to report a disconnected client.
EncryptedNotifies the application that the assertion is encrypted and provides recipient certificate details.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the server protocol.
LogoutRequestPreparedThis event is fired when a new logout request has been prepared.
LogoutRequestReceivedThe class uses this event to notify the application about an incoming SAML Logout Request message.
LogoutResponsePreparedThe class uses this event to notify the application about the Logout Response message being ready to be sent.
LogoutResponseReceivedThe class uses this event to notify the application about an incoming SAML LogoutResponse message.
NotificationThis event notifies the application about an underlying control flow event.
ProcessingCompletedThis event notifies the application of the completion of request or response processing.
ReadArtifactRequests content identified by an artifact from the application.
ResourceCloseTells the application that it can close the opened resource.
ResourceOpenRequests the application to open the requested resource.
ResourceReadRequests the application to read from an opened resource.
ResourceRequestNotifies the application that a server resource is requested.
ResourceWriteRequests the application to write to an opened resource.
SAMLMessagePreparedThis event is fired when a SAML message has been prepared and is ready to be dispatched.
SAMLMessageReceivedThe server fires this event for every SAML message it receives.
SessionCreatedThis event is fired when a new session has been established.
SessionDestroyedThis event is fired when the SP server has closed a session.
SessionEventNotifies the application about SAML session events.
SessionInfoNeededThis event is fired in OfflineMode to request the session ID for the current flow.
SessionStateRetrieveThis event fires to retrieve session state information from the application.
SessionStateSaveThis event passes a session state object to the application for safekeeping.
SignatureFoundSignifies the start of signature validation.
SignatureValidatedReports the signature validation result.
TLSCertValidateFires when a client certificate needs to be validated.
TLSEstablishedReports the setup of a TLS session.
TLSHandshakeFires when a newly established client connection initiates a TLS handshake.
TLSPSKRequests a pre-shared key for TLS-PSK.
TLSShutdownReports closure of a TLS session.
UserAuthCompletedNotifies the application about the success of user authentication flow.
UserAuthFailedNotifies the application about failure of user authentication flow.
UserAuthStartNotifies the application about the start of user authentication flow.
UserLogoutCompletedNotifies the application about the completion of user logout flow.
UserLogoutStartNotifies the application about the start of user logout flow.

Config Settings


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

AllowOptionsResponseWithoutAuthEnables unauthenticated responses to OPTIONS requests.
AttributeConsumingServiceTBD.
AuthDigestExpireSpecifies digest expiration time for digest authentication.
BoundPortThe port that was bound by the server.
ContactPersonThe ContactPerson entry of the provider metadata.
DualStackAllows the use of ip4 and ip6 simultaneously.
HandshakeTimeoutThe HTTPS handshake timeout.
HomePageSpecifies the home page resource name.
IDPAQSTBD.
IDPARSTBD.
IDPSLSTBD.
IDPSSOTBD.
MaxIssueInstantTimeDiffThe maximum issue-instant time delta.
OrganizationDisplayNameThe OrganizationDisplayName entry of the provider metadata.
OrganizationLangThe OrganizationLang key of the provider metadata.
OrganizationNameThe OrganizationName element of the provider metadata.
OrganizationURLThe OrganizationURL element of the provider metadata.
PortRangeFromThe lower bound of allowed port scope to listen on.
PortRangeToThe higher bound of allowed port scope to listen on.
RequestFilterThe request string modifier.
SAMLActionTBD.
SAMLBufferTBD.
SAMLResourceProtectedTBD.
SAMLResourceSpecialTBD.
SAMLStringTBD.
SendBufferSizeThe network send buffer size.
ServerNameSpecifies the server name for the created responses.
SessionTimeoutThe HTTP session timeout.
SessionTTLThe SAML session time-to-live value.
SignatureAlgorithmTBD.
TempPathPath for storing temporary files.
UseZeroIndexForDefaultServicesTBD.
WantAssertionsSignedTBD.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
PKICacheSpecifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePathSpecifies the file system path where cached PKI data is stored.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCachingSpecifies whether reuse of loaded CRL objects is enabled.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOCSPResponseObjectCachingSpecifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrderSpecifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparatorSpecifies the separator used between descriptors in RDN.

Active Property (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();
int secureblackbox_samlspserver_getactive(void* lpObj);
bool GetActive();

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 (SAMLSPServer Class)

Base directory on the server.

Syntax

ANSI (Cross Platform)
char* GetBaseDir();
int SetBaseDir(const char* lpszBaseDir); Unicode (Windows) LPWSTR GetBaseDir();
INT SetBaseDir(LPCWSTR lpszBaseDir);
char* secureblackbox_samlspserver_getbasedir(void* lpObj);
int secureblackbox_samlspserver_setbasedir(void* lpObj, const char* lpszBaseDir);
QString GetBaseDir();
int SetBaseDir(QString qsBaseDir);

Default Value

""

Remarks

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

Data Type

String

BindingKey Property (SAMLSPServer Class)

Contains a private key to sign the redirect binding requests.

Syntax

SecureBlackboxCryptoKey* GetBindingKey();
int SetBindingKey(SecureBlackboxCryptoKey* val);
int64 secureblackbox_samlspserver_getbindingkeyhandle(void* lpObj);
int secureblackbox_samlspserver_setbindingkeyhandle(void* lpObj, int64 lBindingKeyHandle);
int secureblackbox_samlspserver_getbindingkeykey(void* lpObj, char** lpBindingKeyKey, int* lenBindingKeyKey);
qint64 GetBindingKeyHandle();
int SetBindingKeyHandle(qint64 lBindingKeyHandle); QByteArray GetBindingKeyKey();

Remarks

Use this property to set the signing key for the redirect binding object. This is used to sign the content of the redirect binding.

Note that when using the redirect binding, the outgoing SAML message must not be signed in parallel with a certificate. Any assertions may still be signed.

This property is not available at design time.

Data Type

SecureBlackboxCryptoKey

DecryptionCertificate Property (SAMLSPServer Class)

The certificate to be used to decrypt assertions.

Syntax

SecureBlackboxCertificate* GetDecryptionCertificate();
int SetDecryptionCertificate(SecureBlackboxCertificate* val);
int secureblackbox_samlspserver_getdecryptioncertbytes(void* lpObj, char** lpDecryptionCertBytes, int* lenDecryptionCertBytes);
int64 secureblackbox_samlspserver_getdecryptioncerthandle(void* lpObj);
int secureblackbox_samlspserver_setdecryptioncerthandle(void* lpObj, int64 lDecryptionCertHandle);
QByteArray GetDecryptionCertBytes();

qint64 GetDecryptionCertHandle();
int SetDecryptionCertHandle(qint64 lDecryptionCertHandle);

Remarks

Use this property to provide the certificate to be used for decrypting assertions included in IdP (Identity Provider) responses. This certificate should have a private key associated with it.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

ExternalCrypto Property (SAMLSPServer Class)

Provides access to external signing and DC parameters.

Syntax

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_samlspserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_samlspserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_samlspserver_getexternalcryptodata(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_samlspserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_samlspserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_samlspserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_samlspserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_samlspserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_samlspserver_getexternalcryptomode(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_samlspserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID); QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams); QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData); bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation); QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm); QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID); QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret); int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (SAMLSPServer Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_samlspserver_getfipsmode(void* lpObj);
int secureblackbox_samlspserver_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

HandshakeTimeout Property (SAMLSPServer Class)

Specifies the handshake timeout in milliseconds.

Syntax

ANSI (Cross Platform)
int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout); Unicode (Windows) INT GetHandshakeTimeout();
INT SetHandshakeTimeout(INT iHandshakeTimeout);
int secureblackbox_samlspserver_gethandshaketimeout(void* lpObj);
int secureblackbox_samlspserver_sethandshaketimeout(void* lpObj, int iHandshakeTimeout);
int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout);

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

Host Property (SAMLSPServer Class)

Specifies the host address of the SP server.

Syntax

ANSI (Cross Platform)
char* GetHost();
int SetHost(const char* lpszHost); Unicode (Windows) LPWSTR GetHost();
INT SetHost(LPCWSTR lpszHost);
char* secureblackbox_samlspserver_gethost(void* lpObj);
int secureblackbox_samlspserver_sethost(void* lpObj, const char* lpszHost);
QString GetHost();
int SetHost(QString qsHost);

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

IdPServices Property (SAMLSPServer Class)

Populates a list of services supported by the IdP.

Syntax

int secureblackbox_samlspserver_getidpservicecount(void* lpObj);
int secureblackbox_samlspserver_getidpservicebindingtype(void* lpObj, int idpserviceindex);
char* secureblackbox_samlspserver_getidpserviceentityid(void* lpObj, int idpserviceindex);
char* secureblackbox_samlspserver_getidpservicelocation(void* lpObj, int idpserviceindex);
int secureblackbox_samlspserver_getidpservicepriority(void* lpObj, int idpserviceindex);
int secureblackbox_samlspserver_getidpserviceservice(void* lpObj, int idpserviceindex);
int secureblackbox_samlspserver_getidpserviceserviceindex(void* lpObj, int idpserviceindex);
int GetIdPServiceCount();

int GetIdPServiceBindingType(int iIdPServiceIndex);

QString GetIdPServiceEntityID(int iIdPServiceIndex);

QString GetIdPServiceLocation(int iIdPServiceIndex);

int GetIdPServicePriority(int iIdPServiceIndex);

int GetIdPServiceService(int iIdPServiceIndex);

int GetIdPServiceServiceIndex(int iIdPServiceIndex);

Remarks

Use this property to access the list of services supported by the IdP. In the SAMLIdPServer, this is the list of services supported by the IdP. In the SAMLSPServer, this is the list of services advertised by the remote IdP server. These can be loaded from the respective IdP's metadata or set manually via AddIdPService method.

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

Data Type

SecureBlackboxSAMLServiceInfo

IdPSettings Property (SAMLSPServer Class)

Populates a list of SAML IdP entity settings.

Syntax

SecureBlackboxSAMLEntity* GetIdPSettings();

char* secureblackbox_samlspserver_getidpcontactperson(void* lpObj);
int secureblackbox_samlspserver_setidpcontactperson(void* lpObj, const char* lpszIdPContactPerson);
char* secureblackbox_samlspserver_getidpencryptionkey(void* lpObj);
int secureblackbox_samlspserver_setidpencryptionkey(void* lpObj, const char* lpszIdPEncryptionKey);
char* secureblackbox_samlspserver_getidpencryptionmethods(void* lpObj);
int secureblackbox_samlspserver_setidpencryptionmethods(void* lpObj, const char* lpszIdPEncryptionMethods);
char* secureblackbox_samlspserver_getidpentityid(void* lpObj);
int secureblackbox_samlspserver_setidpentityid(void* lpObj, const char* lpszIdPEntityID);
int secureblackbox_samlspserver_getidpflags(void* lpObj);
int secureblackbox_samlspserver_setidpflags(void* lpObj, int iIdPFlags);
char* secureblackbox_samlspserver_getidpidpssolink(void* lpObj);
int secureblackbox_samlspserver_setidpidpssolink(void* lpObj, const char* lpszIdPIdPSSOLink);
char* secureblackbox_samlspserver_getidpnameidformats(void* lpObj);
int secureblackbox_samlspserver_setidpnameidformats(void* lpObj, const char* lpszIdPNameIDFormats);
char* secureblackbox_samlspserver_getidporganizationdisplayname(void* lpObj);
int secureblackbox_samlspserver_setidporganizationdisplayname(void* lpObj, const char* lpszIdPOrganizationDisplayName);
char* secureblackbox_samlspserver_getidporganizationlang(void* lpObj);
int secureblackbox_samlspserver_setidporganizationlang(void* lpObj, const char* lpszIdPOrganizationLang);
char* secureblackbox_samlspserver_getidporganizationname(void* lpObj);
int secureblackbox_samlspserver_setidporganizationname(void* lpObj, const char* lpszIdPOrganizationName);
char* secureblackbox_samlspserver_getidporganizationurl(void* lpObj);
int secureblackbox_samlspserver_setidporganizationurl(void* lpObj, const char* lpszIdPOrganizationURL);
int secureblackbox_samlspserver_getidpsignaturevalidationresult(void* lpObj);
int secureblackbox_samlspserver_getidpsigned(void* lpObj);
char* secureblackbox_samlspserver_getidpsignedwith(void* lpObj);
char* secureblackbox_samlspserver_getidpsigningkey(void* lpObj);
int secureblackbox_samlspserver_setidpsigningkey(void* lpObj, const char* lpszIdPSigningKey);
char* secureblackbox_samlspserver_getidpvaliduntil(void* lpObj);
int secureblackbox_samlspserver_setidpvaliduntil(void* lpObj, const char* lpszIdPValidUntil);
QString GetIdPContactPerson();
int SetIdPContactPerson(QString qsIdPContactPerson); QString GetIdPEncryptionKey();
int SetIdPEncryptionKey(QString qsIdPEncryptionKey); QString GetIdPEncryptionMethods();
int SetIdPEncryptionMethods(QString qsIdPEncryptionMethods); QString GetIdPEntityID();
int SetIdPEntityID(QString qsIdPEntityID); int GetIdPFlags();
int SetIdPFlags(int iIdPFlags); QString GetIdPIdPSSOLink();
int SetIdPIdPSSOLink(QString qsIdPIdPSSOLink); QString GetIdPNameIDFormats();
int SetIdPNameIDFormats(QString qsIdPNameIDFormats); QString GetIdPOrganizationDisplayName();
int SetIdPOrganizationDisplayName(QString qsIdPOrganizationDisplayName); QString GetIdPOrganizationLang();
int SetIdPOrganizationLang(QString qsIdPOrganizationLang); QString GetIdPOrganizationName();
int SetIdPOrganizationName(QString qsIdPOrganizationName); QString GetIdPOrganizationURL();
int SetIdPOrganizationURL(QString qsIdPOrganizationURL); int GetIdPSignatureValidationResult(); bool GetIdPSigned(); QString GetIdPSignedWith(); QString GetIdPSigningKey();
int SetIdPSigningKey(QString qsIdPSigningKey); QString GetIdPValidUntil();
int SetIdPValidUntil(QString qsIdPValidUntil);

Remarks

Use this property to get or set properties of a SAML IdP entity. These properties can be adjusted manually or loaded from the respective metadata file.

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

Data Type

SecureBlackboxSAMLEntity

Issuer Property (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
char* GetIssuer();
int SetIssuer(const char* lpszIssuer); Unicode (Windows) LPWSTR GetIssuer();
INT SetIssuer(LPCWSTR lpszIssuer);
char* secureblackbox_samlspserver_getissuer(void* lpObj);
int secureblackbox_samlspserver_setissuer(void* lpObj, const char* lpszIssuer);
QString GetIssuer();
int SetIssuer(QString qsIssuer);

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

KnownCertificates Property (SAMLSPServer Class)

Additional certificates for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates();
int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_samlspserver_getknowncertcount(void* lpObj);
int secureblackbox_samlspserver_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_samlspserver_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_samlspserver_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_samlspserver_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); QByteArray GetKnownCertBytes(int iKnownCertIndex); qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

KnownKeys Property (SAMLSPServer Class)

Public keys for low-level signature validation.

Syntax

int secureblackbox_samlspserver_getknownkeycount(void* lpObj);
int secureblackbox_samlspserver_setknownkeycount(void* lpObj, int iKnownKeyCount);
int64 secureblackbox_samlspserver_getknownkeyhandle(void* lpObj, int knownkeyindex);
int secureblackbox_samlspserver_setknownkeyhandle(void* lpObj, int knownkeyindex, int64 lKnownKeyHandle);
int GetKnownKeyCount();
int SetKnownKeyCount(int iKnownKeyCount); qint64 GetKnownKeyHandle(int iKnownKeyIndex);
int SetKnownKeyHandle(int iKnownKeyIndex, qint64 lKnownKeyHandle);

Remarks

Use this property to supply a list of public keys that might be needed for redirect binding signature validation.

This property is not available at design time.

Data Type

SecureBlackboxCryptoKey

LogoutPage Property (SAMLSPServer Class)

Specifies the location of the logout page.

Syntax

ANSI (Cross Platform)
char* GetLogoutPage();
int SetLogoutPage(const char* lpszLogoutPage); Unicode (Windows) LPWSTR GetLogoutPage();
INT SetLogoutPage(LPCWSTR lpszLogoutPage);
char* secureblackbox_samlspserver_getlogoutpage(void* lpObj);
int secureblackbox_samlspserver_setlogoutpage(void* lpObj, const char* lpszLogoutPage);
QString GetLogoutPage();
int SetLogoutPage(QString qsLogoutPage);

Default Value

"/sp/logout"

Remarks

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

Data Type

String

MetadataURL Property (SAMLSPServer Class)

The SP's metadata location.

Syntax

ANSI (Cross Platform)
char* GetMetadataURL();
int SetMetadataURL(const char* lpszMetadataURL); Unicode (Windows) LPWSTR GetMetadataURL();
INT SetMetadataURL(LPCWSTR lpszMetadataURL);
char* secureblackbox_samlspserver_getmetadataurl(void* lpObj);
int secureblackbox_samlspserver_setmetadataurl(void* lpObj, const char* lpszMetadataURL);
QString GetMetadataURL();
int SetMetadataURL(QString qsMetadataURL);

Default Value

"/sp/metadata"

Remarks

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

Data Type

String

MetaSigningCertificate Property (SAMLSPServer Class)

Specifies the metadata signing certificate.

Syntax

SecureBlackboxCertificate* GetMetaSigningCertificate();
int SetMetaSigningCertificate(SecureBlackboxCertificate* val);
int secureblackbox_samlspserver_getmetasigningcertbytes(void* lpObj, char** lpMetaSigningCertBytes, int* lenMetaSigningCertBytes);
int64 secureblackbox_samlspserver_getmetasigningcerthandle(void* lpObj);
int secureblackbox_samlspserver_setmetasigningcerthandle(void* lpObj, int64 lMetaSigningCertHandle);
QByteArray GetMetaSigningCertBytes();

qint64 GetMetaSigningCertHandle();
int SetMetaSigningCertHandle(qint64 lMetaSigningCertHandle);

Remarks

Use this property to specify the certificate to be used to sign the SP's metadata. This certificate should have a private key associated with it.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

OfflineMode Property (SAMLSPServer Class)

Enables the Offline mode.

Syntax

ANSI (Cross Platform)
int GetOfflineMode();
int SetOfflineMode(int bOfflineMode); Unicode (Windows) BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);
int secureblackbox_samlspserver_getofflinemode(void* lpObj);
int secureblackbox_samlspserver_setofflinemode(void* lpObj, int bOfflineMode);
bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);

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

PinnedClient Property (SAMLSPServer Class)

Populates the pinned client details.

Syntax

SecureBlackboxTLSConnectionInfo* GetPinnedClient();

int secureblackbox_samlspserver_getpinnedclientaeadcipher(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientchainvalidationdetails(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientchainvalidationresult(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientciphersuite(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientclientauthenticated(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientclientauthrequested(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientconnectionestablished(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientconnectionid(void* lpObj, char** lpPinnedClientConnectionID, int* lenPinnedClientConnectionID);
char* secureblackbox_samlspserver_getpinnedclientdigestalgorithm(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientencryptionalgorithm(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientexportable(void* lpObj);
int64 secureblackbox_samlspserver_getpinnedclientid(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientkeyexchangealgorithm(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientkeyexchangekeybits(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientnamedeccurve(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientpfscipher(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientpresharedidentity(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientpresharedidentityhint(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientpublickeybits(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientremoteaddress(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientremoteport(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientresumedsession(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientsecureconnection(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientserverauthenticated(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientsignaturealgorithm(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientsymmetricblocksize(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientsymmetrickeybits(void* lpObj);
int64 secureblackbox_samlspserver_getpinnedclienttotalbytesreceived(void* lpObj);
int64 secureblackbox_samlspserver_getpinnedclienttotalbytessent(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientvalidationlog(void* lpObj);
char* secureblackbox_samlspserver_getpinnedclientversion(void* lpObj);
bool GetPinnedClientAEADCipher();

int GetPinnedClientChainValidationDetails();

int GetPinnedClientChainValidationResult();

QString GetPinnedClientCiphersuite();

bool GetPinnedClientClientAuthenticated();

bool GetPinnedClientClientAuthRequested();

bool GetPinnedClientConnectionEstablished();

QByteArray GetPinnedClientConnectionID();

QString GetPinnedClientDigestAlgorithm();

QString GetPinnedClientEncryptionAlgorithm();

bool GetPinnedClientExportable();

qint64 GetPinnedClientID();

QString GetPinnedClientKeyExchangeAlgorithm();

int GetPinnedClientKeyExchangeKeyBits();

QString GetPinnedClientNamedECCurve();

bool GetPinnedClientPFSCipher();

QString GetPinnedClientPreSharedIdentity();

QString GetPinnedClientPreSharedIdentityHint();

int GetPinnedClientPublicKeyBits();

QString GetPinnedClientRemoteAddress();

int GetPinnedClientRemotePort();

bool GetPinnedClientResumedSession();

bool GetPinnedClientSecureConnection();

bool GetPinnedClientServerAuthenticated();

QString GetPinnedClientSignatureAlgorithm();

int GetPinnedClientSymmetricBlockSize();

int GetPinnedClientSymmetricKeyBits();

qint64 GetPinnedClientTotalBytesReceived();

qint64 GetPinnedClientTotalBytesSent();

QString GetPinnedClientValidationLog();

QString GetPinnedClientVersion();

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

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

Data Type

SecureBlackboxTLSConnectionInfo

PinnedClientChain Property (SAMLSPServer Class)

Contains the certificate chain of the pinned client.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetPinnedClientChain();

int secureblackbox_samlspserver_getpinnedclientcertcount(void* lpObj);
int secureblackbox_samlspserver_getpinnedclientcertbytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertBytes, int* lenPinnedClientCertBytes);
int secureblackbox_samlspserver_getpinnedclientcertcakeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertCAKeyID, int* lenPinnedClientCertCAKeyID);
char* secureblackbox_samlspserver_getpinnedclientcertfingerprint(void* lpObj, int pinnedclientcertindex);
int64 secureblackbox_samlspserver_getpinnedclientcerthandle(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlspserver_getpinnedclientcertissuer(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlspserver_getpinnedclientcertissuerrdn(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlspserver_getpinnedclientcertkeyalgorithm(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlspserver_getpinnedclientcertkeybits(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlspserver_getpinnedclientcertkeyfingerprint(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlspserver_getpinnedclientcertkeyusage(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlspserver_getpinnedclientcertpublickeybytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertPublicKeyBytes, int* lenPinnedClientCertPublicKeyBytes);
int secureblackbox_samlspserver_getpinnedclientcertselfsigned(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlspserver_getpinnedclientcertserialnumber(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSerialNumber, int* lenPinnedClientCertSerialNumber);
char* secureblackbox_samlspserver_getpinnedclientcertsigalgorithm(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlspserver_getpinnedclientcertsubject(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlspserver_getpinnedclientcertsubjectkeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSubjectKeyID, int* lenPinnedClientCertSubjectKeyID);
char* secureblackbox_samlspserver_getpinnedclientcertsubjectrdn(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlspserver_getpinnedclientcertvalidfrom(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlspserver_getpinnedclientcertvalidto(void* lpObj, int pinnedclientcertindex);
int GetPinnedClientCertCount();

QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex);

QString GetPinnedClientCertFingerprint(int iPinnedClientCertIndex);

qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex);

QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex);

QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex);

QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);

int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex);

QString GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex);

int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex);

bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex);

QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex);

QString GetPinnedClientCertSubject(int iPinnedClientCertIndex);

QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex);

QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex);

QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex);

QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);

Remarks

Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.

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

Data Type

SecureBlackboxCertificate

Port Property (SAMLSPServer Class)

Specifies the listening port number.

Syntax

ANSI (Cross Platform)
int GetPort();
int SetPort(int iPort); Unicode (Windows) INT GetPort();
INT SetPort(INT iPort);
int secureblackbox_samlspserver_getport(void* lpObj);
int secureblackbox_samlspserver_setport(void* lpObj, int iPort);
int GetPort();
int SetPort(int iPort);

Default Value

80

Remarks

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

Data Type

Integer

ProtectedResources Property (SAMLSPServer Class)

Specifies the list of protected resources.

Syntax

ANSI (Cross Platform)
char* GetProtectedResources();
int SetProtectedResources(const char* lpszProtectedResources); Unicode (Windows) LPWSTR GetProtectedResources();
INT SetProtectedResources(LPCWSTR lpszProtectedResources);
char* secureblackbox_samlspserver_getprotectedresources(void* lpObj);
int secureblackbox_samlspserver_setprotectedresources(void* lpObj, const char* lpszProtectedResources);
QString GetProtectedResources();
int SetProtectedResources(QString qsProtectedResources);

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 (SAMLSPServer Class)

Specifies the location to redirect the user on logout.

Syntax

ANSI (Cross Platform)
char* GetRedirectOnLogoutPage();
int SetRedirectOnLogoutPage(const char* lpszRedirectOnLogoutPage); Unicode (Windows) LPWSTR GetRedirectOnLogoutPage();
INT SetRedirectOnLogoutPage(LPCWSTR lpszRedirectOnLogoutPage);
char* secureblackbox_samlspserver_getredirectonlogoutpage(void* lpObj);
int secureblackbox_samlspserver_setredirectonlogoutpage(void* lpObj, const char* lpszRedirectOnLogoutPage);
QString GetRedirectOnLogoutPage();
int SetRedirectOnLogoutPage(QString qsRedirectOnLogoutPage);

Default Value

"https://nsoftware.com"

Remarks

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

Data Type

String

Security Property (SAMLSPServer Class)

Provides access to the SAML security properties.

Syntax

char* secureblackbox_samlspserver_getsecuritycanonicalizationmethod(void* lpObj);
int secureblackbox_samlspserver_setsecuritycanonicalizationmethod(void* lpObj, const char* lpszSecurityCanonicalizationMethod);
char* secureblackbox_samlspserver_getsecuritydigestmethod(void* lpObj);
int secureblackbox_samlspserver_setsecuritydigestmethod(void* lpObj, const char* lpszSecurityDigestMethod);
char* secureblackbox_samlspserver_getsecurityencryptionmethod(void* lpObj);
int secureblackbox_samlspserver_setsecurityencryptionmethod(void* lpObj, const char* lpszSecurityEncryptionMethod);
int secureblackbox_samlspserver_getsecurityflags(void* lpObj);
int secureblackbox_samlspserver_setsecurityflags(void* lpObj, int iSecurityFlags);
char* secureblackbox_samlspserver_getsecuritysigmethod(void* lpObj);
int secureblackbox_samlspserver_setsecuritysigmethod(void* lpObj, const char* lpszSecuritySigMethod);
int secureblackbox_samlspserver_getsecuritysignaturepolicy(void* lpObj);
int secureblackbox_samlspserver_setsecuritysignaturepolicy(void* lpObj, int iSecuritySignaturePolicy);
QString GetSecurityCanonicalizationMethod();
int SetSecurityCanonicalizationMethod(QString qsSecurityCanonicalizationMethod); QString GetSecurityDigestMethod();
int SetSecurityDigestMethod(QString qsSecurityDigestMethod); QString GetSecurityEncryptionMethod();
int SetSecurityEncryptionMethod(QString qsSecurityEncryptionMethod); int GetSecurityFlags();
int SetSecurityFlags(int iSecurityFlags); QString GetSecuritySigMethod();
int SetSecuritySigMethod(QString qsSecuritySigMethod); int GetSecuritySignaturePolicy();
int SetSecuritySignaturePolicy(int iSecuritySignaturePolicy);

Remarks

Use this property to access the security parameters of the server.

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

Data Type

SecureBlackboxSAMLSecuritySettings

SenderChain Property (SAMLSPServer Class)

Contains the certificate chain of the message sender.

Syntax

int secureblackbox_samlspserver_getsendercertcount(void* lpObj);
int secureblackbox_samlspserver_getsenderchainbytes(void* lpObj, int sendercertindex, char** lpSenderChainBytes, int* lenSenderChainBytes);
int64 secureblackbox_samlspserver_getsenderchainhandle(void* lpObj, int sendercertindex);
int GetSenderCertCount();

QByteArray GetSenderChainBytes(int iSenderCertIndex);

qint64 GetSenderChainHandle(int iSenderCertIndex);

Remarks

Use this property to access the certificate chain of the creator of the signed message or entity that is currently being processed. This property is only available from SignatureFound and SignatureValidated events.

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

Data Type

SecureBlackboxCertificate

SigningCertificate Property (SAMLSPServer Class)

The certificate for signing the SP requests.

Syntax

SecureBlackboxCertificate* GetSigningCertificate();
int SetSigningCertificate(SecureBlackboxCertificate* val);
int secureblackbox_samlspserver_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);
int64 secureblackbox_samlspserver_getsigningcerthandle(void* lpObj);
int secureblackbox_samlspserver_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);
QByteArray GetSigningCertBytes();

qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);

Remarks

Use this property to designate a certificate for signing the SP requests. The provided certificate must have a private key associated with it.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

SigningChain Property (SAMLSPServer Class)

The signing certificate chain.

Syntax

int secureblackbox_samlspserver_getsigningchaincount(void* lpObj);
int secureblackbox_samlspserver_setsigningchaincount(void* lpObj, int iSigningChainCount);
int secureblackbox_samlspserver_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);
int64 secureblackbox_samlspserver_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_samlspserver_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount); QByteArray GetSigningChainBytes(int iSigningChainIndex); qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

SocketSettings Property (SAMLSPServer Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_samlspserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_samlspserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_samlspserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_samlspserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_samlspserver_getsocketlocalport(void* lpObj);
int secureblackbox_samlspserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_samlspserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_samlspserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_samlspserver_getsockettimeout(void* lpObj);
int secureblackbox_samlspserver_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_samlspserver_getsocketuseipv6(void* lpObj);
int secureblackbox_samlspserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Data Type

SecureBlackboxSocketSettings

SPServices Property (SAMLSPServer Class)

Populates a list of services supported by the SP.

Syntax

int secureblackbox_samlspserver_getspservicecount(void* lpObj);
int secureblackbox_samlspserver_getspservicebindingtype(void* lpObj, int spserviceindex);
char* secureblackbox_samlspserver_getspserviceentityid(void* lpObj, int spserviceindex);
char* secureblackbox_samlspserver_getspservicelocation(void* lpObj, int spserviceindex);
int secureblackbox_samlspserver_getspservicepriority(void* lpObj, int spserviceindex);
int secureblackbox_samlspserver_getspserviceservice(void* lpObj, int spserviceindex);
int secureblackbox_samlspserver_getspserviceserviceindex(void* lpObj, int spserviceindex);
int GetSPServiceCount();

int GetSPServiceBindingType(int iSPServiceIndex);

QString GetSPServiceEntityID(int iSPServiceIndex);

QString GetSPServiceLocation(int iSPServiceIndex);

int GetSPServicePriority(int iSPServiceIndex);

int GetSPServiceService(int iSPServiceIndex);

int GetSPServiceServiceIndex(int iSPServiceIndex);

Remarks

Use this property to access the list of services supported by the SP. In the SAMLSPServer, this is the list of services supported by the SP. In the SAMLIdPServer, this is the list of services advertised by the remote SP server. These can be loaded from the respective SP's metadata or set manually via AddSPService method.

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

Data Type

SecureBlackboxSAMLServiceInfo

SPSettings Property (SAMLSPServer Class)

Populates a list of SAML SP entity settings.

Syntax

SecureBlackboxSAMLEntity* GetSPSettings();

char* secureblackbox_samlspserver_getspcontactperson(void* lpObj);
int secureblackbox_samlspserver_setspcontactperson(void* lpObj, const char* lpszSPContactPerson);
char* secureblackbox_samlspserver_getspencryptionkey(void* lpObj);
int secureblackbox_samlspserver_setspencryptionkey(void* lpObj, const char* lpszSPEncryptionKey);
char* secureblackbox_samlspserver_getspencryptionmethods(void* lpObj);
int secureblackbox_samlspserver_setspencryptionmethods(void* lpObj, const char* lpszSPEncryptionMethods);
char* secureblackbox_samlspserver_getspentityid(void* lpObj);
int secureblackbox_samlspserver_setspentityid(void* lpObj, const char* lpszSPEntityID);
int secureblackbox_samlspserver_getspflags(void* lpObj);
int secureblackbox_samlspserver_setspflags(void* lpObj, int iSPFlags);
char* secureblackbox_samlspserver_getspidpssolink(void* lpObj);
int secureblackbox_samlspserver_setspidpssolink(void* lpObj, const char* lpszSPIdPSSOLink);
char* secureblackbox_samlspserver_getspnameidformats(void* lpObj);
int secureblackbox_samlspserver_setspnameidformats(void* lpObj, const char* lpszSPNameIDFormats);
char* secureblackbox_samlspserver_getsporganizationdisplayname(void* lpObj);
int secureblackbox_samlspserver_setsporganizationdisplayname(void* lpObj, const char* lpszSPOrganizationDisplayName);
char* secureblackbox_samlspserver_getsporganizationlang(void* lpObj);
int secureblackbox_samlspserver_setsporganizationlang(void* lpObj, const char* lpszSPOrganizationLang);
char* secureblackbox_samlspserver_getsporganizationname(void* lpObj);
int secureblackbox_samlspserver_setsporganizationname(void* lpObj, const char* lpszSPOrganizationName);
char* secureblackbox_samlspserver_getsporganizationurl(void* lpObj);
int secureblackbox_samlspserver_setsporganizationurl(void* lpObj, const char* lpszSPOrganizationURL);
int secureblackbox_samlspserver_getspsignaturevalidationresult(void* lpObj);
int secureblackbox_samlspserver_getspsigned(void* lpObj);
char* secureblackbox_samlspserver_getspsignedwith(void* lpObj);
char* secureblackbox_samlspserver_getspsigningkey(void* lpObj);
int secureblackbox_samlspserver_setspsigningkey(void* lpObj, const char* lpszSPSigningKey);
char* secureblackbox_samlspserver_getspvaliduntil(void* lpObj);
int secureblackbox_samlspserver_setspvaliduntil(void* lpObj, const char* lpszSPValidUntil);
QString GetSPContactPerson();
int SetSPContactPerson(QString qsSPContactPerson); QString GetSPEncryptionKey();
int SetSPEncryptionKey(QString qsSPEncryptionKey); QString GetSPEncryptionMethods();
int SetSPEncryptionMethods(QString qsSPEncryptionMethods); QString GetSPEntityID();
int SetSPEntityID(QString qsSPEntityID); int GetSPFlags();
int SetSPFlags(int iSPFlags); QString GetSPIdPSSOLink();
int SetSPIdPSSOLink(QString qsSPIdPSSOLink); QString GetSPNameIDFormats();
int SetSPNameIDFormats(QString qsSPNameIDFormats); QString GetSPOrganizationDisplayName();
int SetSPOrganizationDisplayName(QString qsSPOrganizationDisplayName); QString GetSPOrganizationLang();
int SetSPOrganizationLang(QString qsSPOrganizationLang); QString GetSPOrganizationName();
int SetSPOrganizationName(QString qsSPOrganizationName); QString GetSPOrganizationURL();
int SetSPOrganizationURL(QString qsSPOrganizationURL); int GetSPSignatureValidationResult(); bool GetSPSigned(); QString GetSPSignedWith(); QString GetSPSigningKey();
int SetSPSigningKey(QString qsSPSigningKey); QString GetSPValidUntil();
int SetSPValidUntil(QString qsSPValidUntil);

Remarks

Use this property to get or set properties of a SAML SP entity. These properties can be adjusted manually or loaded from the respective metadata file.

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

Data Type

SecureBlackboxSAMLEntity

TLSServerChain Property (SAMLSPServer Class)

The server's TLS certificates.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int SetTLSServerChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_samlspserver_gettlsservercertcount(void* lpObj);
int secureblackbox_samlspserver_settlsservercertcount(void* lpObj, int iTLSServerCertCount);
int secureblackbox_samlspserver_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
int64 secureblackbox_samlspserver_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
int secureblackbox_samlspserver_settlsservercerthandle(void* lpObj, int tlsservercertindex, int64 lTLSServerCertHandle);
int GetTLSServerCertCount();
int SetTLSServerCertCount(int iTLSServerCertCount); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);
int SetTLSServerCertHandle(int iTLSServerCertIndex, qint64 lTLSServerCertHandle);

Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

TLSSettings Property (SAMLSPServer Class)

Manages TLS layer settings.

Syntax

SecureBlackboxTLSSettings* GetTLSSettings();

int secureblackbox_samlspserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_samlspserver_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_samlspserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_samlspserver_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_samlspserver_gettlsciphersuites(void* lpObj);
int secureblackbox_samlspserver_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_samlspserver_gettlsclientauth(void* lpObj);
int secureblackbox_samlspserver_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_samlspserver_gettlseccurves(void* lpObj);
int secureblackbox_samlspserver_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_samlspserver_gettlsextensions(void* lpObj);
int secureblackbox_samlspserver_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_samlspserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_samlspserver_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_samlspserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_samlspserver_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_samlspserver_gettlspresharedkey(void* lpObj);
int secureblackbox_samlspserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_samlspserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_samlspserver_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_samlspserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_samlspserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_samlspserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_samlspserver_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_samlspserver_gettlsssloptions(void* lpObj);
int secureblackbox_samlspserver_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_samlspserver_gettlstlsmode(void* lpObj);
int secureblackbox_samlspserver_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_samlspserver_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_samlspserver_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_samlspserver_gettlsusesessionresumption(void* lpObj);
int secureblackbox_samlspserver_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_samlspserver_gettlsversions(void* lpObj);
int secureblackbox_samlspserver_settlsversions(void* lpObj, int iTLSVersions);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates); int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites); int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth); QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves); QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions); bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges); QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity); QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey); QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite); int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret); bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption); int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Data Type

SecureBlackboxTLSSettings

URL Property (SAMLSPServer Class)

Specifies the base URL of this SP server.

Syntax

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL); Unicode (Windows) LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);
char* secureblackbox_samlspserver_geturl(void* lpObj);
int secureblackbox_samlspserver_seturl(void* lpObj, const char* lpszURL);
QString GetURL();
int SetURL(QString qsURL);

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 (SAMLSPServer Class)

Registers an IdP service in the IdPServices list.

Syntax

ANSI (Cross Platform)
int AddIdPService(int iService, int iBindingType, const char* lpszLocation, int iPriority, int iIndex);

Unicode (Windows)
INT AddIdPService(INT iService, INT iBindingType, LPCWSTR lpszLocation, INT iPriority, INT iIndex);
int secureblackbox_samlspserver_addidpservice(void* lpObj, int iService, int iBindingType, const char* lpszLocation, int iPriority, int iIndex);
int AddIdPService(int iService, int iBindingType, const QString& qsLocation, int iPriority, int iIndex);

Remarks

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

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

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

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

Use the Service parameter to specify the service to register:

spsUnknown0The service is of unknown or unsupported type

spsAssertionConsumerService1The assertion consumer service (SP side only)

spsSingleLogoutService2The single logout service (SP or IdP sides)

spsArtifactResolutionService3The artifact resolution service (SP or IdP sides)

spsAttributeQueryService4The attribute query service (IdP side only)

spsSingleSignOnService5The single sign-on service (IdP side only)

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

csbtNone0TBD

csbtSOAP1TBD

csbtPAOS2TBD

csbtRedirect3TBD

csbtPOST4TBD

csbtArtifact5TBD

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

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddSPService Method (SAMLSPServer Class)

Registers an SP service in the SPServices list.

Syntax

ANSI (Cross Platform)
int AddSPService(int iService, int iBindingType, const char* lpszLocation, int iPriority, int iIndex);

Unicode (Windows)
INT AddSPService(INT iService, INT iBindingType, LPCWSTR lpszLocation, INT iPriority, INT iIndex);
int secureblackbox_samlspserver_addspservice(void* lpObj, int iService, int iBindingType, const char* lpszLocation, int iPriority, int iIndex);
int AddSPService(int iService, int iBindingType, const QString& qsLocation, int iPriority, int iIndex);

Remarks

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

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

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

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

Use the Service parameter to specify the service to register:

spsUnknown0The service is of unknown or unsupported type

spsAssertionConsumerService1The assertion consumer service (SP side only)

spsSingleLogoutService2The single logout service (SP or IdP sides)

spsArtifactResolutionService3The artifact resolution service (SP or IdP sides)

spsAttributeQueryService4The attribute query service (IdP side only)

spsSingleSignOnService5The single sign-on service (IdP side only)

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

csbtNone0TBD

csbtSOAP1TBD

csbtPAOS2TBD

csbtRedirect3TBD

csbtPOST4TBD

csbtArtifact5TBD

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

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

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Cleanup Method (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
int Cleanup();

Unicode (Windows)
INT Cleanup();
int secureblackbox_samlspserver_cleanup(void* lpObj);
int Cleanup();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SAMLSPServer Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_samlspserver_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (SAMLSPServer Class)

Performs an additional action.

Syntax

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_samlspserver_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

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

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

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

Common ActionIDs:

ActionParametersReturned valueDescription
ResetTrustedListCachenonenoneClears the cached list of trusted lists.
ResetCertificateCachenonenoneClears the cached certificates.
ResetCRLCachenonenoneClears the cached CRLs.
ResetOCSPResponseCachenonenoneClears the cached OCSP responses.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DropClient Method (SAMLSPServer Class)

Terminates a client connection.

Syntax

ANSI (Cross Platform)
int DropClient(int64 lConnectionId, int bForced);

Unicode (Windows)
INT DropClient(LONG64 lConnectionId, BOOL bForced);
int secureblackbox_samlspserver_dropclient(void* lpObj, int64 lConnectionId, int bForced);
int DropClient(qint64 lConnectionId, bool bForced);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExportSettings Method (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
char* ExportSettings(int bSP);

Unicode (Windows)
LPWSTR ExportSettings(BOOL bSP);
char* secureblackbox_samlspserver_exportsettings(void* lpObj, int bSP);
QString ExportSettings(bool bSP);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetClientBuffer Method (SAMLSPServer Class)

Acquires a piece of operation data.

Syntax

ANSI (Cross Platform)
char* GetClientBuffer(int64 lConnectionID, const char* lpszHandle, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetClientBuffer(LONG64 lConnectionID, LPCWSTR lpszHandle, LPINT lpSize = NULL);
char* secureblackbox_samlspserver_getclientbuffer(void* lpObj, int64 lConnectionID, const char* lpszHandle, int *lpSize);
QByteArray GetClientBuffer(qint64 lConnectionID, const QString& qsHandle);

Remarks

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

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

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetProviderProperty Method (SAMLSPServer Class)

Returns the value of a custom provider property.

Syntax

ANSI (Cross Platform)
char* GetProviderProperty(const char* lpszName);

Unicode (Windows)
LPWSTR GetProviderProperty(LPCWSTR lpszName);
char* secureblackbox_samlspserver_getproviderproperty(void* lpObj, const char* lpszName);
QString GetProviderProperty(const QString& qsName);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetRequestBytes Method (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
char* GetRequestBytes(int64 lConnectionID, const char* lpszRequestFilter, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetRequestBytes(LONG64 lConnectionID, LPCWSTR lpszRequestFilter, LPINT lpSize = NULL);
char* secureblackbox_samlspserver_getrequestbytes(void* lpObj, int64 lConnectionID, const char* lpszRequestFilter, int *lpSize);
QByteArray GetRequestBytes(qint64 lConnectionID, const QString& qsRequestFilter);

Remarks

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

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetRequestHeader Method (SAMLSPServer Class)

Returns a request header value.

Syntax

ANSI (Cross Platform)
char* GetRequestHeader(int64 lConnectionId, const char* lpszHeaderName);

Unicode (Windows)
LPWSTR GetRequestHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
char* secureblackbox_samlspserver_getrequestheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName);
QString GetRequestHeader(qint64 lConnectionId, const QString& qsHeaderName);

Remarks

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetResponseHeader Method (SAMLSPServer Class)

Returns a response header value.

Syntax

ANSI (Cross Platform)
char* GetResponseHeader(int64 lConnectionId, const char* lpszHeaderName);

Unicode (Windows)
LPWSTR GetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
char* secureblackbox_samlspserver_getresponseheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName);
QString GetResponseHeader(qint64 lConnectionId, const QString& qsHeaderName);

Remarks

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetSessionProperty Method (SAMLSPServer Class)

Returns the value of a custom session property.

Syntax

ANSI (Cross Platform)
char* GetSessionProperty(const char* lpszSessionID, const char* lpszName);

Unicode (Windows)
LPWSTR GetSessionProperty(LPCWSTR lpszSessionID, LPCWSTR lpszName);
char* secureblackbox_samlspserver_getsessionproperty(void* lpObj, const char* lpszSessionID, const char* lpszName);
QString GetSessionProperty(const QString& qsSessionID, const QString& qsName);

Remarks

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ImportSettings Method (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.

Syntax

ANSI (Cross Platform)
int ImportSettings(const char* lpszMetadata, int bSP);

Unicode (Windows)
INT ImportSettings(LPCWSTR lpszMetadata, BOOL bSP);
int secureblackbox_samlspserver_importsettings(void* lpObj, const char* lpszMetadata, int bSP);
int ImportSettings(const QString& qsMetadata, bool bSP);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

InitiateArtifactResolve Method (SAMLSPServer Class)

Initiates the artifact resolution protocol.

Syntax

ANSI (Cross Platform)
int InitiateArtifactResolve(int64 lConnectionID, const char* lpszSessionID, int iIdPServiceIndex, const char* lpszArtifact, const char* lpszTag);

Unicode (Windows)
INT InitiateArtifactResolve(LONG64 lConnectionID, LPCWSTR lpszSessionID, INT iIdPServiceIndex, LPCWSTR lpszArtifact, LPCWSTR lpszTag);
int secureblackbox_samlspserver_initiateartifactresolve(void* lpObj, int64 lConnectionID, const char* lpszSessionID, int iIdPServiceIndex, const char* lpszArtifact, const char* lpszTag);
int InitiateArtifactResolve(qint64 lConnectionID, const QString& qsSessionID, int iIdPServiceIndex, const QString& qsArtifact, const QString& qsTag);

Remarks

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

sprUnknown0Unknown or undefined processing result

sprSuccess1The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser).

sprSAMLMessage2The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party.

sprSignOnPage3The processing was fully or partially successful. The output contains or redirects to a SAML login page.

sprResource4The processing was fully or partially successful. The output contains, or redirects to, a generic web resource.

sprSAMLError5The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party.

sprTransportError6The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser.

You can use this method with or without the OfflineMode.

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

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

InitiateAttributeQuery Method (SAMLSPServer Class)

Initiates the attribute query.

Syntax

ANSI (Cross Platform)
int InitiateAttributeQuery(int64 lConnectionID, const char* lpszSessionID, int iIdPServiceIndex, const char* lpszNameID, const char* lpszNameIDFormat, const char* lpszAttributes, const char* lpszAttrNameFormats, const char* lpszAttrFriendlyNames, const char* lpszTag);

Unicode (Windows)
INT InitiateAttributeQuery(LONG64 lConnectionID, LPCWSTR lpszSessionID, INT iIdPServiceIndex, LPCWSTR lpszNameID, LPCWSTR lpszNameIDFormat, LPCWSTR lpszAttributes, LPCWSTR lpszAttrNameFormats, LPCWSTR lpszAttrFriendlyNames, LPCWSTR lpszTag);
int secureblackbox_samlspserver_initiateattributequery(void* lpObj, int64 lConnectionID, const char* lpszSessionID, int iIdPServiceIndex, const char* lpszNameID, const char* lpszNameIDFormat, const char* lpszAttributes, const char* lpszAttrNameFormats, const char* lpszAttrFriendlyNames, const char* lpszTag);
int InitiateAttributeQuery(qint64 lConnectionID, const QString& qsSessionID, int iIdPServiceIndex, const QString& qsNameID, const QString& qsNameIDFormat, const QString& qsAttributes, const QString& qsAttrNameFormats, const QString& qsAttrFriendlyNames, const QString& qsTag);

Remarks

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

Specify the IdP AQS endpoint via the IdPServiceIndex parameter.

sprUnknown0Unknown or undefined processing result

sprSuccess1The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser).

sprSAMLMessage2The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party.

sprSignOnPage3The processing was fully or partially successful. The output contains or redirects to a SAML login page.

sprResource4The processing was fully or partially successful. The output contains, or redirects to, a generic web resource.

sprSAMLError5The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party.

sprTransportError6The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser.

You can use this method with or without the OfflineMode.

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

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

InitiateAuth Method (SAMLSPServer Class)

Starts SP-initiated SAML authentication flow.

Syntax

ANSI (Cross Platform)
int InitiateAuth(int64 lConnectionID, const char* lpszSessionID, int iIdPServiceIndex, const char* lpszNameIDFormat, const char* lpszRelayState, const char* lpszTag);

Unicode (Windows)
INT InitiateAuth(LONG64 lConnectionID, LPCWSTR lpszSessionID, INT iIdPServiceIndex, LPCWSTR lpszNameIDFormat, LPCWSTR lpszRelayState, LPCWSTR lpszTag);
int secureblackbox_samlspserver_initiateauth(void* lpObj, int64 lConnectionID, const char* lpszSessionID, int iIdPServiceIndex, const char* lpszNameIDFormat, const char* lpszRelayState, const char* lpszTag);
int InitiateAuth(qint64 lConnectionID, const QString& qsSessionID, int iIdPServiceIndex, const QString& qsNameIDFormat, const QString& qsRelayState, const QString& qsTag);

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.

sprUnknown0Unknown or undefined processing result

sprSuccess1The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser).

sprSAMLMessage2The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party.

sprSignOnPage3The processing was fully or partially successful. The output contains or redirects to a SAML login page.

sprResource4The processing was fully or partially successful. The output contains, or redirects to, a generic web resource.

sprSAMLError5The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party.

sprTransportError6The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser.

You can use this method with or without the OfflineMode.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

InitiateLogout Method (SAMLSPServer Class)

Starts SP-initiated SAML logout flow.

Syntax

ANSI (Cross Platform)
int InitiateLogout(int64 lConnectionID, const char* lpszSessionID, int iIdPServiceIndex, const char* lpszNameID, const char* lpszSessionIndex, const char* lpszRelayState, const char* lpszTag);

Unicode (Windows)
INT InitiateLogout(LONG64 lConnectionID, LPCWSTR lpszSessionID, INT iIdPServiceIndex, LPCWSTR lpszNameID, LPCWSTR lpszSessionIndex, LPCWSTR lpszRelayState, LPCWSTR lpszTag);
int secureblackbox_samlspserver_initiatelogout(void* lpObj, int64 lConnectionID, const char* lpszSessionID, int iIdPServiceIndex, const char* lpszNameID, const char* lpszSessionIndex, const char* lpszRelayState, const char* lpszTag);
int InitiateLogout(qint64 lConnectionID, const QString& qsSessionID, int iIdPServiceIndex, const QString& qsNameID, const QString& qsSessionIndex, const QString& qsRelayState, const QString& qsTag);

Remarks

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

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

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

You can use a combination of the above.

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

sprUnknown0Unknown or undefined processing result

sprSuccess1The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser).

sprSAMLMessage2The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party.

sprSignOnPage3The processing was fully or partially successful. The output contains or redirects to a SAML login page.

sprResource4The processing was fully or partially successful. The output contains, or redirects to, a generic web resource.

sprSAMLError5The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party.

sprTransportError6The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser.

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

You can use this method with or without the OfflineMode.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ListClients Method (SAMLSPServer Class)

Enumerates the connected clients.

Syntax

ANSI (Cross Platform)
char* ListClients();

Unicode (Windows)
LPWSTR ListClients();
char* secureblackbox_samlspserver_listclients(void* lpObj);
QString ListClients();

Remarks

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

PinClient Method (SAMLSPServer Class)

Takes a snapshot of the connection's properties.

Syntax

ANSI (Cross Platform)
int PinClient(int64 lConnectionId);

Unicode (Windows)
INT PinClient(LONG64 lConnectionId);
int secureblackbox_samlspserver_pinclient(void* lpObj, int64 lConnectionId);
int PinClient(qint64 lConnectionId);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ProcessArtifact Method (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
int ProcessArtifact(int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);

Unicode (Windows)
INT ProcessArtifact(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszRequest, LPCWSTR lpszTag);
int secureblackbox_samlspserver_processartifact(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);
int ProcessArtifact(qint64 lConnectionID, const QString& qsSessionID, const QString& qsRequest, const QString& qsTag);

Remarks

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

Artifact messages are typically very simple:

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

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

sprUnknown0Unknown or undefined processing result

sprSuccess1The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser).

sprSAMLMessage2The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party.

sprSignOnPage3The processing was fully or partially successful. The output contains or redirects to a SAML login page.

sprResource4The processing was fully or partially successful. The output contains, or redirects to, a generic web resource.

sprSAMLError5The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party.

sprTransportError6The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser.

You can use this method with or without the OfflineMode.

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

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ProcessArtifactResolveRequest Method (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
int ProcessArtifactResolveRequest(int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);

Unicode (Windows)
INT ProcessArtifactResolveRequest(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszRequest, LPCWSTR lpszTag);
int secureblackbox_samlspserver_processartifactresolverequest(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);
int ProcessArtifactResolveRequest(qint64 lConnectionID, const QString& qsSessionID, const QString& qsRequest, const QString& qsTag);

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.

sprUnknown0Unknown or undefined processing result

sprSuccess1The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser).

sprSAMLMessage2The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party.

sprSignOnPage3The processing was fully or partially successful. The output contains or redirects to a SAML login page.

sprResource4The processing was fully or partially successful. The output contains, or redirects to, a generic web resource.

sprSAMLError5The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party.

sprTransportError6The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser.

You can use this method with or without the OfflineMode.

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

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ProcessAssertion Method (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
int ProcessAssertion(int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);

Unicode (Windows)
INT ProcessAssertion(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszRequest, LPCWSTR lpszTag);
int secureblackbox_samlspserver_processassertion(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);
int ProcessAssertion(qint64 lConnectionID, const QString& qsSessionID, const QString& qsRequest, const QString& qsTag);

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.

sprUnknown0Unknown or undefined processing result

sprSuccess1The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser).

sprSAMLMessage2The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party.

sprSignOnPage3The processing was fully or partially successful. The output contains or redirects to a SAML login page.

sprResource4The processing was fully or partially successful. The output contains, or redirects to, a generic web resource.

sprSAMLError5The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party.

sprTransportError6The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser.

You can use this method with or without the OfflineMode.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ProcessGenericRequest Method (SAMLSPServer Class)

Processes a generic HTTP SAML request.

Syntax

ANSI (Cross Platform)
char* ProcessGenericRequest(int64 lConnectionID, const char* lpRequest, int lenRequest, int *lpSize = NULL);

Unicode (Windows)
LPSTR ProcessGenericRequest(LONG64 lConnectionID, LPCSTR lpRequest, INT lenRequest, LPINT lpSize = NULL);
char* secureblackbox_samlspserver_processgenericrequest(void* lpObj, int64 lConnectionID, const char* lpRequest, int lenRequest, int *lpSize);
QByteArray ProcessGenericRequest(qint64 lConnectionID, QByteArray qbaRequest);

Remarks

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

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

You can use this method with or without the OfflineMode.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ProcessLogoutRequest Method (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
int ProcessLogoutRequest(int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);

Unicode (Windows)
INT ProcessLogoutRequest(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszRequest, LPCWSTR lpszTag);
int secureblackbox_samlspserver_processlogoutrequest(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);
int ProcessLogoutRequest(qint64 lConnectionID, const QString& qsSessionID, const QString& qsRequest, const QString& qsTag);

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.

sprUnknown0Unknown or undefined processing result

sprSuccess1The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser).

sprSAMLMessage2The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party.

sprSignOnPage3The processing was fully or partially successful. The output contains or redirects to a SAML login page.

sprResource4The processing was fully or partially successful. The output contains, or redirects to, a generic web resource.

sprSAMLError5The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party.

sprTransportError6The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser.

You can use this method with or without the OfflineMode.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Reset Method (SAMLSPServer Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int secureblackbox_samlspserver_reset(void* lpObj);
int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetClientBuffer Method (SAMLSPServer Class)

Commits a data buffer to the connection.

Syntax

ANSI (Cross Platform)
int SetClientBuffer(int64 lConnectionID, const char* lpszHandle, const char* lpValue, int lenValue);

Unicode (Windows)
INT SetClientBuffer(LONG64 lConnectionID, LPCWSTR lpszHandle, LPCSTR lpValue, INT lenValue);
int secureblackbox_samlspserver_setclientbuffer(void* lpObj, int64 lConnectionID, const char* lpszHandle, const char* lpValue, int lenValue);
int SetClientBuffer(qint64 lConnectionID, const QString& qsHandle, QByteArray qbaValue);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetProviderProperty Method (SAMLSPServer Class)

Sets the value of a custom provider property.

Syntax

ANSI (Cross Platform)
int SetProviderProperty(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT SetProviderProperty(LPCWSTR lpszName, LPCWSTR lpszValue);
int secureblackbox_samlspserver_setproviderproperty(void* lpObj, const char* lpszName, const char* lpszValue);
int SetProviderProperty(const QString& qsName, const QString& qsValue);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetResponseHeader Method (SAMLSPServer Class)

Sets a response header.

Syntax

ANSI (Cross Platform)
int SetResponseHeader(int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue);

Unicode (Windows)
INT SetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName, LPCWSTR lpszValue);
int secureblackbox_samlspserver_setresponseheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue);
int SetResponseHeader(qint64 lConnectionId, const QString& qsHeaderName, const QString& qsValue);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetSessionProperty Method (SAMLSPServer Class)

Sets the value of a custom provider session property.

Syntax

ANSI (Cross Platform)
int SetSessionProperty(const char* lpszSessionID, const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT SetSessionProperty(LPCWSTR lpszSessionID, LPCWSTR lpszName, LPCWSTR lpszValue);
int secureblackbox_samlspserver_setsessionproperty(void* lpObj, const char* lpszSessionID, const char* lpszName, const char* lpszValue);
int SetSessionProperty(const QString& qsSessionID, const QString& qsName, const QString& qsValue);

Remarks

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

The following properties can be adjusted for each individual session:

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Start Method (SAMLSPServer Class)

Starts the SP server.

Syntax

ANSI (Cross Platform)
int Start();

Unicode (Windows)
INT Start();
int secureblackbox_samlspserver_start(void* lpObj);
int Start();

Remarks

Use this method to start listening for incoming connections.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Stop Method (SAMLSPServer Class)

Stops the IdP server.

Syntax

ANSI (Cross Platform)
int Stop();

Unicode (Windows)
INT Stop();
int secureblackbox_samlspserver_stop(void* lpObj);
int Stop();

Remarks

Call this method to stop listening for incoming connections.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Accept Event (SAMLSPServer Class)

Reports an incoming connection.

Syntax

ANSI (Cross Platform)
virtual int FireAccept(SAMLSPServerAcceptEventParams *e);
typedef struct {
const char *RemoteAddress;
int RemotePort;
int Accept; int reserved; } SAMLSPServerAcceptEventParams;
Unicode (Windows) virtual INT FireAccept(SAMLSPServerAcceptEventParams *e);
typedef struct {
LPCWSTR RemoteAddress;
INT RemotePort;
BOOL Accept; INT reserved; } SAMLSPServerAcceptEventParams;
#define EID_SAMLSPSERVER_ACCEPT 1

virtual INT SECUREBLACKBOX_CALL FireAccept(LPSTR &lpszRemoteAddress, INT &iRemotePort, BOOL &bAccept);
class SAMLSPServerAcceptEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Accept(SAMLSPServerAcceptEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireAccept(SAMLSPServerAcceptEventParams *e) {...}

Remarks

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

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

ArtifactReceived Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireArtifactReceived(SAMLSPServerArtifactReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Issuer;
const char *Artifact;
int Action; int reserved; } SAMLSPServerArtifactReceivedEventParams;
Unicode (Windows) virtual INT FireArtifactReceived(SAMLSPServerArtifactReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Issuer;
LPCWSTR Artifact;
INT Action; INT reserved; } SAMLSPServerArtifactReceivedEventParams;
#define EID_SAMLSPSERVER_ARTIFACTRECEIVED 2

virtual INT SECUREBLACKBOX_CALL FireArtifactReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszIssuer, LPSTR &lpszArtifact, INT &iAction);
class SAMLSPServerArtifactReceivedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Issuer();

  const QString &Artifact();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ArtifactReceived(SAMLSPServerArtifactReceivedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireArtifactReceived(SAMLSPServerArtifactReceivedEventParams *e) {...}

Remarks

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

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

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

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

ArtifactResolveRequestPrepared Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireArtifactResolveRequestPrepared(SAMLSPServerArtifactResolveRequestPreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Destination;
const char *Artifact; int reserved; } SAMLSPServerArtifactResolveRequestPreparedEventParams;
Unicode (Windows) virtual INT FireArtifactResolveRequestPrepared(SAMLSPServerArtifactResolveRequestPreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Destination;
LPCWSTR Artifact; INT reserved; } SAMLSPServerArtifactResolveRequestPreparedEventParams;
#define EID_SAMLSPSERVER_ARTIFACTRESOLVEREQUESTPREPARED 3

virtual INT SECUREBLACKBOX_CALL FireArtifactResolveRequestPrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszDestination, LPSTR &lpszArtifact);
class SAMLSPServerArtifactResolveRequestPreparedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Destination();

  const QString &Artifact();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ArtifactResolveRequestPrepared(SAMLSPServerArtifactResolveRequestPreparedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireArtifactResolveRequestPrepared(SAMLSPServerArtifactResolveRequestPreparedEventParams *e) {...}

Remarks

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

ArtifactResolveRequestReceived Event (SAMLSPServer Class)

Reports receipt of ArtifactResolveRequest message.

Syntax

ANSI (Cross Platform)
virtual int FireArtifactResolveRequestReceived(SAMLSPServerArtifactResolveRequestReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Issuer;
int IsEncrypted;
int IsSigned;
const char *Artifact;
int Action; int reserved; } SAMLSPServerArtifactResolveRequestReceivedEventParams;
Unicode (Windows) virtual INT FireArtifactResolveRequestReceived(SAMLSPServerArtifactResolveRequestReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Issuer;
BOOL IsEncrypted;
BOOL IsSigned;
LPCWSTR Artifact;
INT Action; INT reserved; } SAMLSPServerArtifactResolveRequestReceivedEventParams;
#define EID_SAMLSPSERVER_ARTIFACTRESOLVEREQUESTRECEIVED 4

virtual INT SECUREBLACKBOX_CALL FireArtifactResolveRequestReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszIssuer, BOOL &bIsEncrypted, BOOL &bIsSigned, LPSTR &lpszArtifact, INT &iAction);
class SAMLSPServerArtifactResolveRequestReceivedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Issuer();

  bool IsEncrypted();

  bool IsSigned();

  const QString &Artifact();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ArtifactResolveRequestReceived(SAMLSPServerArtifactResolveRequestReceivedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireArtifactResolveRequestReceived(SAMLSPServerArtifactResolveRequestReceivedEventParams *e) {...}

Remarks

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

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

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

AssertionReceived Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireAssertionReceived(SAMLSPServerAssertionReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Issuer;
const char *Body;
int IsEncrypted;
int IsSigned;
const char *Auth;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex;
const char *Attributes;
const char *ValidFrom;
const char *ValidTo;
const char *RelayState;
int Action; int reserved; } SAMLSPServerAssertionReceivedEventParams;
Unicode (Windows) virtual INT FireAssertionReceived(SAMLSPServerAssertionReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Issuer;
LPCWSTR Body;
BOOL IsEncrypted;
BOOL IsSigned;
LPCWSTR Auth;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex;
LPCWSTR Attributes;
LPCWSTR ValidFrom;
LPCWSTR ValidTo;
LPCWSTR RelayState;
INT Action; INT reserved; } SAMLSPServerAssertionReceivedEventParams;
#define EID_SAMLSPSERVER_ASSERTIONRECEIVED 5

virtual INT SECUREBLACKBOX_CALL FireAssertionReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszIssuer, LPSTR &lpszBody, BOOL &bIsEncrypted, BOOL &bIsSigned, LPSTR &lpszAuth, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, LPSTR &lpszAttributes, LPSTR &lpszValidFrom, LPSTR &lpszValidTo, LPSTR &lpszRelayState, INT &iAction);
class SAMLSPServerAssertionReceivedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Issuer();

  const QString &Body();

  bool IsEncrypted();

  bool IsSigned();

  const QString &Auth();

  const QString &NameID();

  const QString &NameIDFormat();

  const QString &SessionIndex();

  const QString &Attributes();

  const QString &ValidFrom();

  const QString &ValidTo();

  const QString &RelayState();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AssertionReceived(SAMLSPServerAssertionReceivedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireAssertionReceived(SAMLSPServerAssertionReceivedEventParams *e) {...}

Remarks

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

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

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

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

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

AttributeQueryPrepared Event (SAMLSPServer Class)

Notifies the application of the preparation of an AttributeQuery.

Syntax

ANSI (Cross Platform)
virtual int FireAttributeQueryPrepared(SAMLSPServerAttributeQueryPreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Destination;
const char *NameID;
const char *NameIDFormat;
const char *Attributes; int reserved; } SAMLSPServerAttributeQueryPreparedEventParams;
Unicode (Windows) virtual INT FireAttributeQueryPrepared(SAMLSPServerAttributeQueryPreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Destination;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR Attributes; INT reserved; } SAMLSPServerAttributeQueryPreparedEventParams;
#define EID_SAMLSPSERVER_ATTRIBUTEQUERYPREPARED 6

virtual INT SECUREBLACKBOX_CALL FireAttributeQueryPrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszDestination, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszAttributes);
class SAMLSPServerAttributeQueryPreparedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Destination();

  const QString &NameID();

  const QString &NameIDFormat();

  const QString &Attributes();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AttributeQueryPrepared(SAMLSPServerAttributeQueryPreparedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireAttributeQueryPrepared(SAMLSPServerAttributeQueryPreparedEventParams *e) {...}

Remarks

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

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

AuthnRequestPrepared Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireAuthnRequestPrepared(SAMLSPServerAuthnRequestPreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Destination;
const char *NameIDFormat;
int ForceAuthn;
int NonInteractive;
char *RelayState; int reserved; } SAMLSPServerAuthnRequestPreparedEventParams;
Unicode (Windows) virtual INT FireAuthnRequestPrepared(SAMLSPServerAuthnRequestPreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Destination;
LPCWSTR NameIDFormat;
BOOL ForceAuthn;
BOOL NonInteractive;
LPWSTR RelayState; INT reserved; } SAMLSPServerAuthnRequestPreparedEventParams;
#define EID_SAMLSPSERVER_AUTHNREQUESTPREPARED 7

virtual INT SECUREBLACKBOX_CALL FireAuthnRequestPrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszDestination, LPSTR &lpszNameIDFormat, BOOL &bForceAuthn, BOOL &bNonInteractive, LPSTR &lpszRelayState);
class SAMLSPServerAuthnRequestPreparedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Destination();

  const QString &NameIDFormat();

  bool ForceAuthn();

  bool NonInteractive();

  const QString &RelayState();
  void SetRelayState(const QString &qsRelayState);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void AuthnRequestPrepared(SAMLSPServerAuthnRequestPreparedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireAuthnRequestPrepared(SAMLSPServerAuthnRequestPreparedEventParams *e) {...}

Remarks

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

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

Connect Event (SAMLSPServer Class)

Reports an accepted connection.

Syntax

ANSI (Cross Platform)
virtual int FireConnect(SAMLSPServerConnectEventParams *e);
typedef struct {
int64 ConnectionId;
const char *RemoteAddress;
int RemotePort; int reserved; } SAMLSPServerConnectEventParams;
Unicode (Windows) virtual INT FireConnect(SAMLSPServerConnectEventParams *e);
typedef struct {
LONG64 ConnectionId;
LPCWSTR RemoteAddress;
INT RemotePort; INT reserved; } SAMLSPServerConnectEventParams;
#define EID_SAMLSPSERVER_CONNECT 8

virtual INT SECUREBLACKBOX_CALL FireConnect(LONG64 &lConnectionId, LPSTR &lpszRemoteAddress, INT &iRemotePort);
class SAMLSPServerConnectEventParams {
public:
  qint64 ConnectionId();

  const QString &RemoteAddress();

  int RemotePort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Connect(SAMLSPServerConnectEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireConnect(SAMLSPServerConnectEventParams *e) {...}

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 (SAMLSPServer Class)

Fires to report a disconnected client.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnect(SAMLSPServerDisconnectEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SAMLSPServerDisconnectEventParams;
Unicode (Windows) virtual INT FireDisconnect(SAMLSPServerDisconnectEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SAMLSPServerDisconnectEventParams;
#define EID_SAMLSPSERVER_DISCONNECT 9

virtual INT SECUREBLACKBOX_CALL FireDisconnect(LONG64 &lConnectionID);
class SAMLSPServerDisconnectEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Disconnect(SAMLSPServerDisconnectEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireDisconnect(SAMLSPServerDisconnectEventParams *e) {...}

Remarks

The class fires this event when a connected client disconnects.

Encrypted Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireEncrypted(SAMLSPServerEncryptedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int NeedCredential;
int SkipThis; int reserved; } SAMLSPServerEncryptedEventParams;
Unicode (Windows) virtual INT FireEncrypted(SAMLSPServerEncryptedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL NeedCredential;
BOOL SkipThis; INT reserved; } SAMLSPServerEncryptedEventParams;
#define EID_SAMLSPSERVER_ENCRYPTED 10

virtual INT SECUREBLACKBOX_CALL FireEncrypted(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bNeedCredential, BOOL &bSkipThis);
class SAMLSPServerEncryptedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool NeedCredential();

  bool SkipThis();
  void SetSkipThis(bool bSkipThis);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Encrypted(SAMLSPServerEncryptedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireEncrypted(SAMLSPServerEncryptedEventParams *e) {...}

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 (SAMLSPServer Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(SAMLSPServerErrorEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
int ErrorCode;
int Fatal;
int Remote;
const char *Description; int reserved; } SAMLSPServerErrorEventParams;
Unicode (Windows) virtual INT FireError(SAMLSPServerErrorEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
INT ErrorCode;
BOOL Fatal;
BOOL Remote;
LPCWSTR Description; INT reserved; } SAMLSPServerErrorEventParams;
#define EID_SAMLSPSERVER_ERROR 11

virtual INT SECUREBLACKBOX_CALL FireError(LONG64 &lConnectionID, LPSTR &lpszSessionID, INT &iErrorCode, BOOL &bFatal, BOOL &bRemote, LPSTR &lpszDescription);
class SAMLSPServerErrorEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  int ErrorCode();

  bool Fatal();

  bool Remote();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(SAMLSPServerErrorEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireError(SAMLSPServerErrorEventParams *e) {...}

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 (SAMLSPServer Class)

Handles remote or external signing initiated by the server protocol.

Syntax

ANSI (Cross Platform)
virtual int FireExternalSign(SAMLSPServerExternalSignEventParams *e);
typedef struct {
int64 ConnectionID;
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } SAMLSPServerExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(SAMLSPServerExternalSignEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } SAMLSPServerExternalSignEventParams;
#define EID_SAMLSPSERVER_EXTERNALSIGN 12

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LONG64 &lConnectionID, LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class SAMLSPServerExternalSignEventParams {
public:
  qint64 ConnectionID();

  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ExternalSign(SAMLSPServerExternalSignEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireExternalSign(SAMLSPServerExternalSignEventParams *e) {...}

Remarks

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

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

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

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

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

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

LogoutRequestPrepared Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireLogoutRequestPrepared(SAMLSPServerLogoutRequestPreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Destination;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex;
char *RelayState; int reserved; } SAMLSPServerLogoutRequestPreparedEventParams;
Unicode (Windows) virtual INT FireLogoutRequestPrepared(SAMLSPServerLogoutRequestPreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Destination;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex;
LPWSTR RelayState; INT reserved; } SAMLSPServerLogoutRequestPreparedEventParams;
#define EID_SAMLSPSERVER_LOGOUTREQUESTPREPARED 13

virtual INT SECUREBLACKBOX_CALL FireLogoutRequestPrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszDestination, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, LPSTR &lpszRelayState);
class SAMLSPServerLogoutRequestPreparedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Destination();

  const QString &NameID();

  const QString &NameIDFormat();

  const QString &SessionIndex();

  const QString &RelayState();
  void SetRelayState(const QString &qsRelayState);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void LogoutRequestPrepared(SAMLSPServerLogoutRequestPreparedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireLogoutRequestPrepared(SAMLSPServerLogoutRequestPreparedEventParams *e) {...}

Remarks

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

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

LogoutRequestReceived Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireLogoutRequestReceived(SAMLSPServerLogoutRequestReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Issuer;
int IsEncrypted;
int IsSigned;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex;
int Action; int reserved; } SAMLSPServerLogoutRequestReceivedEventParams;
Unicode (Windows) virtual INT FireLogoutRequestReceived(SAMLSPServerLogoutRequestReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Issuer;
BOOL IsEncrypted;
BOOL IsSigned;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex;
INT Action; INT reserved; } SAMLSPServerLogoutRequestReceivedEventParams;
#define EID_SAMLSPSERVER_LOGOUTREQUESTRECEIVED 14

virtual INT SECUREBLACKBOX_CALL FireLogoutRequestReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszIssuer, BOOL &bIsEncrypted, BOOL &bIsSigned, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, INT &iAction);
class SAMLSPServerLogoutRequestReceivedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Issuer();

  bool IsEncrypted();

  bool IsSigned();

  const QString &NameID();

  const QString &NameIDFormat();

  const QString &SessionIndex();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void LogoutRequestReceived(SAMLSPServerLogoutRequestReceivedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireLogoutRequestReceived(SAMLSPServerLogoutRequestReceivedEventParams *e) {...}

Remarks

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

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

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

LogoutResponsePrepared Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireLogoutResponsePrepared(SAMLSPServerLogoutResponsePreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Destination;
const char *Body;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex; int reserved; } SAMLSPServerLogoutResponsePreparedEventParams;
Unicode (Windows) virtual INT FireLogoutResponsePrepared(SAMLSPServerLogoutResponsePreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Destination;
LPCWSTR Body;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex; INT reserved; } SAMLSPServerLogoutResponsePreparedEventParams;
#define EID_SAMLSPSERVER_LOGOUTRESPONSEPREPARED 15

virtual INT SECUREBLACKBOX_CALL FireLogoutResponsePrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszDestination, LPSTR &lpszBody, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex);
class SAMLSPServerLogoutResponsePreparedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Destination();

  const QString &Body();

  const QString &NameID();

  const QString &NameIDFormat();

  const QString &SessionIndex();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void LogoutResponsePrepared(SAMLSPServerLogoutResponsePreparedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireLogoutResponsePrepared(SAMLSPServerLogoutResponsePreparedEventParams *e) {...}

Remarks

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

LogoutResponseReceived Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireLogoutResponseReceived(SAMLSPServerLogoutResponseReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Issuer;
int IsEncrypted;
int IsSigned;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex;
const char *RelayState;
int Action; int reserved; } SAMLSPServerLogoutResponseReceivedEventParams;
Unicode (Windows) virtual INT FireLogoutResponseReceived(SAMLSPServerLogoutResponseReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Issuer;
BOOL IsEncrypted;
BOOL IsSigned;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex;
LPCWSTR RelayState;
INT Action; INT reserved; } SAMLSPServerLogoutResponseReceivedEventParams;
#define EID_SAMLSPSERVER_LOGOUTRESPONSERECEIVED 16

virtual INT SECUREBLACKBOX_CALL FireLogoutResponseReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszIssuer, BOOL &bIsEncrypted, BOOL &bIsSigned, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, LPSTR &lpszRelayState, INT &iAction);
class SAMLSPServerLogoutResponseReceivedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Issuer();

  bool IsEncrypted();

  bool IsSigned();

  const QString &NameID();

  const QString &NameIDFormat();

  const QString &SessionIndex();

  const QString &RelayState();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void LogoutResponseReceived(SAMLSPServerLogoutResponseReceivedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireLogoutResponseReceived(SAMLSPServerLogoutResponseReceivedEventParams *e) {...}

Remarks

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

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

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

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

Notification Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireNotification(SAMLSPServerNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } SAMLSPServerNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(SAMLSPServerNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } SAMLSPServerNotificationEventParams;
#define EID_SAMLSPSERVER_NOTIFICATION 17

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class SAMLSPServerNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Notification(SAMLSPServerNotificationEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireNotification(SAMLSPServerNotificationEventParams *e) {...}

Remarks

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

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

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

SAMLResponderErrorTBD
SAMLSessionLogoutTBD
ListeningStartedNotifies the application that the server has started listening for incoming connections.
ListeningStoppedNotifies the application that the server has stopped listening to incoming connections.

ProcessingCompleted Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireProcessingCompleted(SAMLSPServerProcessingCompletedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *Tag;
int ProcessingResult;
const char *Response;
int Redirect; int reserved; } SAMLSPServerProcessingCompletedEventParams;
Unicode (Windows) virtual INT FireProcessingCompleted(SAMLSPServerProcessingCompletedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR Tag;
INT ProcessingResult;
LPCWSTR Response;
BOOL Redirect; INT reserved; } SAMLSPServerProcessingCompletedEventParams;
#define EID_SAMLSPSERVER_PROCESSINGCOMPLETED 18

virtual INT SECUREBLACKBOX_CALL FireProcessingCompleted(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszTag, INT &iProcessingResult, LPSTR &lpszResponse, BOOL &bRedirect);
class SAMLSPServerProcessingCompletedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &Tag();

  int ProcessingResult();

  const QString &Response();

  bool Redirect();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ProcessingCompleted(SAMLSPServerProcessingCompletedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireProcessingCompleted(SAMLSPServerProcessingCompletedEventParams *e) {...}

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.

sprUnknown0Unknown or undefined processing result

sprSuccess1The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser).

sprSAMLMessage2The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party.

sprSignOnPage3The processing was fully or partially successful. The output contains or redirects to a SAML login page.

sprResource4The processing was fully or partially successful. The output contains, or redirects to, a generic web resource.

sprSAMLError5The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party.

sprTransportError6The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser.

ReadArtifact Event (SAMLSPServer Class)

Requests content identified by an artifact from the application.

Syntax

ANSI (Cross Platform)
virtual int FireReadArtifact(SAMLSPServerReadArtifactEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *Issuer;
const char *Artifact;
char *Value;
int Skip; int reserved; } SAMLSPServerReadArtifactEventParams;
Unicode (Windows) virtual INT FireReadArtifact(SAMLSPServerReadArtifactEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR Issuer;
LPCWSTR Artifact;
LPWSTR Value;
BOOL Skip; INT reserved; } SAMLSPServerReadArtifactEventParams;
#define EID_SAMLSPSERVER_READARTIFACT 19

virtual INT SECUREBLACKBOX_CALL FireReadArtifact(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszIssuer, LPSTR &lpszArtifact, LPSTR &lpszValue, BOOL &bSkip);
class SAMLSPServerReadArtifactEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RequestID();

  const QString &Issuer();

  const QString &Artifact();

  const QString &Value();
  void SetValue(const QString &qsValue);

  bool Skip();
  void SetSkip(bool bSkip);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ReadArtifact(SAMLSPServerReadArtifactEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireReadArtifact(SAMLSPServerReadArtifactEventParams *e) {...}

Remarks

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

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

ResourceClose Event (SAMLSPServer Class)

Tells the application that it can close the opened resource.

Syntax

ANSI (Cross Platform)
virtual int FireResourceClose(SAMLSPServerResourceCloseEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *Handle; int reserved; } SAMLSPServerResourceCloseEventParams;
Unicode (Windows) virtual INT FireResourceClose(SAMLSPServerResourceCloseEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR Handle; INT reserved; } SAMLSPServerResourceCloseEventParams;
#define EID_SAMLSPSERVER_RESOURCECLOSE 20

virtual INT SECUREBLACKBOX_CALL FireResourceClose(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszHandle);
class SAMLSPServerResourceCloseEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &Handle();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ResourceClose(SAMLSPServerResourceCloseEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireResourceClose(SAMLSPServerResourceCloseEventParams *e) {...}

Remarks

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

ResourceOpen Event (SAMLSPServer Class)

Requests the application to open the requested resource.

Syntax

ANSI (Cross Platform)
virtual int FireResourceOpen(SAMLSPServerResourceOpenEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *URL;
const char *HttpMethod;
int OperationStatus;
char *Handle; int reserved; } SAMLSPServerResourceOpenEventParams;
Unicode (Windows) virtual INT FireResourceOpen(SAMLSPServerResourceOpenEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR URL;
LPCWSTR HttpMethod;
INT OperationStatus;
LPWSTR Handle; INT reserved; } SAMLSPServerResourceOpenEventParams;
#define EID_SAMLSPSERVER_RESOURCEOPEN 21

virtual INT SECUREBLACKBOX_CALL FireResourceOpen(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszURL, LPSTR &lpszHttpMethod, INT &iOperationStatus, LPSTR &lpszHandle);
class SAMLSPServerResourceOpenEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &URL();

  const QString &HttpMethod();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  const QString &Handle();
  void SetHandle(const QString &qsHandle);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ResourceOpen(SAMLSPServerResourceOpenEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireResourceOpen(SAMLSPServerResourceOpenEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

ResourceRead Event (SAMLSPServer Class)

Requests the application to read from an opened resource.

Syntax

ANSI (Cross Platform)
virtual int FireResourceRead(SAMLSPServerResourceReadEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *Handle;
int Size;
int OperationStatus; int reserved; } SAMLSPServerResourceReadEventParams;
Unicode (Windows) virtual INT FireResourceRead(SAMLSPServerResourceReadEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR Handle;
INT Size;
INT OperationStatus; INT reserved; } SAMLSPServerResourceReadEventParams;
#define EID_SAMLSPSERVER_RESOURCEREAD 22

virtual INT SECUREBLACKBOX_CALL FireResourceRead(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszHandle, INT &iSize, INT &iOperationStatus);
class SAMLSPServerResourceReadEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &Handle();

  int Size();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ResourceRead(SAMLSPServerResourceReadEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireResourceRead(SAMLSPServerResourceReadEventParams *e) {...}

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:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

ResourceRequest Event (SAMLSPServer Class)

Notifies the application that a server resource is requested.

Syntax

ANSI (Cross Platform)
virtual int FireResourceRequest(SAMLSPServerResourceRequestEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *URL;
const char *HttpMethod;
int ResProtected;
int ResSpecial;
int AllowWriting;
int Action; int reserved; } SAMLSPServerResourceRequestEventParams;
Unicode (Windows) virtual INT FireResourceRequest(SAMLSPServerResourceRequestEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR URL;
LPCWSTR HttpMethod;
BOOL ResProtected;
BOOL ResSpecial;
BOOL AllowWriting;
INT Action; INT reserved; } SAMLSPServerResourceRequestEventParams;
#define EID_SAMLSPSERVER_RESOURCEREQUEST 23

virtual INT SECUREBLACKBOX_CALL FireResourceRequest(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszURL, LPSTR &lpszHttpMethod, BOOL &bResProtected, BOOL &bResSpecial, BOOL &bAllowWriting, INT &iAction);
class SAMLSPServerResourceRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &URL();

  const QString &HttpMethod();

  bool ResProtected();
  void SetResProtected(bool bResProtected);

  bool ResSpecial();
  void SetResSpecial(bool bResSpecial);

  bool AllowWriting();
  void SetAllowWriting(bool bAllowWriting);

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ResourceRequest(SAMLSPServerResourceRequestEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireResourceRequest(SAMLSPServerResourceRequestEventParams *e) {...}

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

ResourceWrite Event (SAMLSPServer Class)

Requests the application to write to an opened resource.

Syntax

ANSI (Cross Platform)
virtual int FireResourceWrite(SAMLSPServerResourceWriteEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *Handle;
int OperationStatus; int reserved; } SAMLSPServerResourceWriteEventParams;
Unicode (Windows) virtual INT FireResourceWrite(SAMLSPServerResourceWriteEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR Handle;
INT OperationStatus; INT reserved; } SAMLSPServerResourceWriteEventParams;
#define EID_SAMLSPSERVER_RESOURCEWRITE 24

virtual INT SECUREBLACKBOX_CALL FireResourceWrite(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszHandle, INT &iOperationStatus);
class SAMLSPServerResourceWriteEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &Handle();

  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ResourceWrite(SAMLSPServerResourceWriteEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireResourceWrite(SAMLSPServerResourceWriteEventParams *e) {...}

Remarks

The class fires this event in virtualized mode to pass another chunk of data to a resource opened earlier. This event is called for write-enabled requests, such as POST or PUT. The handler of this event should read the pending data using the GetClientBuffer method and write them to the opened file descriptor.

Use the OperationStatus parameter to return the operation result back to the server:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

SAMLMessagePrepared Event (SAMLSPServer Class)

This event is fired when a SAML message has been prepared and is ready to be dispatched.

Syntax

ANSI (Cross Platform)
virtual int FireSAMLMessagePrepared(SAMLSPServerSAMLMessagePreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *MessageID;
const char *Destination;
const char *IssueInstant;
const char *InResponseTo;
const char *RequestBody;
const char *MessageType;
char *MessageBody;
char *RelayState;
int Success; int reserved; } SAMLSPServerSAMLMessagePreparedEventParams;
Unicode (Windows) virtual INT FireSAMLMessagePrepared(SAMLSPServerSAMLMessagePreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR MessageID;
LPCWSTR Destination;
LPCWSTR IssueInstant;
LPCWSTR InResponseTo;
LPCWSTR RequestBody;
LPCWSTR MessageType;
LPWSTR MessageBody;
LPWSTR RelayState;
BOOL Success; INT reserved; } SAMLSPServerSAMLMessagePreparedEventParams;
#define EID_SAMLSPSERVER_SAMLMESSAGEPREPARED 25

virtual INT SECUREBLACKBOX_CALL FireSAMLMessagePrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszMessageID, LPSTR &lpszDestination, LPSTR &lpszIssueInstant, LPSTR &lpszInResponseTo, LPSTR &lpszRequestBody, LPSTR &lpszMessageType, LPSTR &lpszMessageBody, LPSTR &lpszRelayState, BOOL &bSuccess);
class SAMLSPServerSAMLMessagePreparedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &MessageID();

  const QString &Destination();

  const QString &IssueInstant();

  const QString &InResponseTo();

  const QString &RequestBody();

  const QString &MessageType();

  const QString &MessageBody();
  void SetMessageBody(const QString &qsMessageBody);

  const QString &RelayState();
  void SetRelayState(const QString &qsRelayState);

  bool Success();
  void SetSuccess(bool bSuccess);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SAMLMessagePrepared(SAMLSPServerSAMLMessagePreparedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSAMLMessagePrepared(SAMLSPServerSAMLMessagePreparedEventParams *e) {...}

Remarks

Subscribe to this event to be notified about every SAML message that has been prepared by the server. This event is fired for every type of the outgoing message (e.g. SAMLResponse or LogoutRequest). The InResponseTo contains the ID of the message in response to which the current message is sent (if applicable). The RequestBody parameter contains the body of such request.

The MessageType parameter indicates the type of the message that has been prepared, such as SAMLResponse. The MessageBody contains the XML body of the message. The Success parameter indicates whether the message contains a positive statement or an error. Both the MessageBody and Success parameters are adjustable.

SAMLMessageReceived Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireSAMLMessageReceived(SAMLSPServerSAMLMessageReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *MessageID;
const char *Issuer;
const char *IssueInstant;
const char *InResponseTo;
const char *RequestBody;
const char *MessageType;
const char *MessageBody;
int IsSigned;
const char *RelayState;
int Action; int reserved; } SAMLSPServerSAMLMessageReceivedEventParams;
Unicode (Windows) virtual INT FireSAMLMessageReceived(SAMLSPServerSAMLMessageReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR MessageID;
LPCWSTR Issuer;
LPCWSTR IssueInstant;
LPCWSTR InResponseTo;
LPCWSTR RequestBody;
LPCWSTR MessageType;
LPCWSTR MessageBody;
BOOL IsSigned;
LPCWSTR RelayState;
INT Action; INT reserved; } SAMLSPServerSAMLMessageReceivedEventParams;
#define EID_SAMLSPSERVER_SAMLMESSAGERECEIVED 26

virtual INT SECUREBLACKBOX_CALL FireSAMLMessageReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszMessageID, LPSTR &lpszIssuer, LPSTR &lpszIssueInstant, LPSTR &lpszInResponseTo, LPSTR &lpszRequestBody, LPSTR &lpszMessageType, LPSTR &lpszMessageBody, BOOL &bIsSigned, LPSTR &lpszRelayState, INT &iAction);
class SAMLSPServerSAMLMessageReceivedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &MessageID();

  const QString &Issuer();

  const QString &IssueInstant();

  const QString &InResponseTo();

  const QString &RequestBody();

  const QString &MessageType();

  const QString &MessageBody();

  bool IsSigned();

  const QString &RelayState();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SAMLMessageReceived(SAMLSPServerSAMLMessageReceivedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSAMLMessageReceived(SAMLSPServerSAMLMessageReceivedEventParams *e) {...}

Remarks

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

The MessageType, MessageID, Issuer, and MessageBody parameters provide the details of the message received. The RequestBody and InResponseTo contain a reference to the request that this message is a response to (if any).

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

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

SessionCreated Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireSessionCreated(SAMLSPServerSessionCreatedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID; int reserved; } SAMLSPServerSessionCreatedEventParams;
Unicode (Windows) virtual INT FireSessionCreated(SAMLSPServerSessionCreatedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID; INT reserved; } SAMLSPServerSessionCreatedEventParams;
#define EID_SAMLSPSERVER_SESSIONCREATED 27

virtual INT SECUREBLACKBOX_CALL FireSessionCreated(LONG64 &lConnectionID, LPSTR &lpszSessionID);
class SAMLSPServerSessionCreatedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionCreated(SAMLSPServerSessionCreatedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSessionCreated(SAMLSPServerSessionCreatedEventParams *e) {...}

Remarks

ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.

SessionDestroyed Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireSessionDestroyed(SAMLSPServerSessionDestroyedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID; int reserved; } SAMLSPServerSessionDestroyedEventParams;
Unicode (Windows) virtual INT FireSessionDestroyed(SAMLSPServerSessionDestroyedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID; INT reserved; } SAMLSPServerSessionDestroyedEventParams;
#define EID_SAMLSPSERVER_SESSIONDESTROYED 28

virtual INT SECUREBLACKBOX_CALL FireSessionDestroyed(LONG64 &lConnectionID, LPSTR &lpszSessionID);
class SAMLSPServerSessionDestroyedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionDestroyed(SAMLSPServerSessionDestroyedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSessionDestroyed(SAMLSPServerSessionDestroyedEventParams *e) {...}

Remarks

ConnectionID contains the identifier of the closed session.

SessionEvent Event (SAMLSPServer Class)

Notifies the application about SAML session events.

Syntax

ANSI (Cross Platform)
virtual int FireSessionEvent(SAMLSPServerSessionEventEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *EventText; int reserved; } SAMLSPServerSessionEventEventParams;
Unicode (Windows) virtual INT FireSessionEvent(SAMLSPServerSessionEventEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR EventText; INT reserved; } SAMLSPServerSessionEventEventParams;
#define EID_SAMLSPSERVER_SESSIONEVENT 29

virtual INT SECUREBLACKBOX_CALL FireSessionEvent(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszEventText);
class SAMLSPServerSessionEventEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &EventText();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionEvent(SAMLSPServerSessionEventEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSessionEvent(SAMLSPServerSessionEventEventParams *e) {...}

Remarks

class uses this event to notify your code about events that happen within the lifeline of a SAML session. Handling it may be useful for development, logging, and monitoring purposes.

The SessionID parameter specifies the session ID, and the EventText parameter describes the event that happened. Below are a few typical examples of what EventText you can expect to get:

  • Start
  • AuthnRequestPrepared
  • ResponseReceived
  • ResourceSupplied
  • LogoutRequestPrepared
  • LogoutResponseReceived
  • LogoutRequestReceived
  • LogoutResponsePrepared
  • ArtifactResolveRequestReceived
  • ArtifactResponsePrepared
  • Finish

SessionInfoNeeded Event (SAMLSPServer Class)

This event is fired in OfflineMode to request the session ID for the current flow.

Syntax

ANSI (Cross Platform)
virtual int FireSessionInfoNeeded(SAMLSPServerSessionInfoNeededEventParams *e);
typedef struct {
int64 ConnectionID;
char *SessionID; int reserved; } SAMLSPServerSessionInfoNeededEventParams;
Unicode (Windows) virtual INT FireSessionInfoNeeded(SAMLSPServerSessionInfoNeededEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPWSTR SessionID; INT reserved; } SAMLSPServerSessionInfoNeededEventParams;
#define EID_SAMLSPSERVER_SESSIONINFONEEDED 30

virtual INT SECUREBLACKBOX_CALL FireSessionInfoNeeded(LONG64 &lConnectionID, LPSTR &lpszSessionID);
class SAMLSPServerSessionInfoNeededEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();
  void SetSessionID(const QString &qsSessionID);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionInfoNeeded(SAMLSPServerSessionInfoNeededEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSessionInfoNeeded(SAMLSPServerSessionInfoNeededEventParams *e) {...}

Remarks

SAML protocol is stateful, which means that SAML services need to keep session-related information between connections. When used in online mode - where the components listen and serve connections automatically - the components can use HTTP cookies to track connecting clients and maintain the session store at the background. However, when used in offline mode, the components do not have access to the HTTP layer and live too short for the session store to survive. That is why in offline mode the components rely on the application code to keep the session information for them.

The components use a collection of Session* events to exchange session information with the application:

  • SessionCreated is called when the component establishes a new session. In offline mode, the application should associate the session ID with the connected user, for example by returning it as a cookie.
  • SessionStateSave : the component passes the session state to the application and expects that the application saves it somewhere to return it back to the component at its request at some point in the future. The session state is an opaque string. The application can use a hash table to store a collection of (SessionID, SessionState) pairs over the lifetime of the SAML service. The server may fire SessionStateSave multiple times for the same SessionID. If this happens, the existing SessionID entry should be overwritten with the fresh session data.
  • SessionStateRetrieve : the component passes a session ID to the application and expects it to return the session state saved in the hash table earlier. The application should not delete the state from the hash table, as it may be needed again.
  • SessionInfoNeeded (this event): the component expects the application to return the session ID corresponding to the connection ID back to them. This event fires, for example, if the application calls ProcessLogoutRequest but passes an empty SessionID as a parameter.
  • SessionDestroyed is called when a session is destroyed. The component can remove the session from the hash table upon receiving this event.

SessionStateRetrieve Event (SAMLSPServer Class)

This event fires to retrieve session state information from the application.

Syntax

ANSI (Cross Platform)
virtual int FireSessionStateRetrieve(SAMLSPServerSessionStateRetrieveEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
char *SessionState; int reserved; } SAMLSPServerSessionStateRetrieveEventParams;
Unicode (Windows) virtual INT FireSessionStateRetrieve(SAMLSPServerSessionStateRetrieveEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPWSTR SessionState; INT reserved; } SAMLSPServerSessionStateRetrieveEventParams;
#define EID_SAMLSPSERVER_SESSIONSTATERETRIEVE 31

virtual INT SECUREBLACKBOX_CALL FireSessionStateRetrieve(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSessionState);
class SAMLSPServerSessionStateRetrieveEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &SessionState();
  void SetSessionState(const QString &qsSessionState);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionStateRetrieve(SAMLSPServerSessionStateRetrieveEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSessionStateRetrieve(SAMLSPServerSessionStateRetrieveEventParams *e) {...}

Remarks

The component fires this event to request a session state that was previously provided to the application via the SessionStateSave call.

See the SessionInfoNeeded topic for more details about session management in offline mode.

SessionStateSave Event (SAMLSPServer Class)

This event passes a session state object to the application for safekeeping.

Syntax

ANSI (Cross Platform)
virtual int FireSessionStateSave(SAMLSPServerSessionStateSaveEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *SessionState; int reserved; } SAMLSPServerSessionStateSaveEventParams;
Unicode (Windows) virtual INT FireSessionStateSave(SAMLSPServerSessionStateSaveEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR SessionState; INT reserved; } SAMLSPServerSessionStateSaveEventParams;
#define EID_SAMLSPSERVER_SESSIONSTATESAVE 32

virtual INT SECUREBLACKBOX_CALL FireSessionStateSave(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSessionState);
class SAMLSPServerSessionStateSaveEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &SessionState();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionStateSave(SAMLSPServerSessionStateSaveEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSessionStateSave(SAMLSPServerSessionStateSaveEventParams *e) {...}

Remarks

The component fires this event to pass a session state to the application. The application is expected to save the state object (which is an opaque string) in a hash table, and be ready to return it back to the component when it requests it using a SessionStateRetrieve call.

See the SessionInfoNeeded topic for more details about session management in offline mode.

SignatureFound Event (SAMLSPServer Class)

Signifies the start of signature validation.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureFound(SAMLSPServerSignatureFoundEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
int Scope;
const char *Signer;
const char *TargetID;
const char *TargetType;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
const char *SigMethod;
const char *DigestMethod;
int CertFound;
int Validate; int reserved; } SAMLSPServerSignatureFoundEventParams;
Unicode (Windows) virtual INT FireSignatureFound(SAMLSPServerSignatureFoundEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
INT Scope;
LPCWSTR Signer;
LPCWSTR TargetID;
LPCWSTR TargetType;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
LPCWSTR SigMethod;
LPCWSTR DigestMethod;
BOOL CertFound;
BOOL Validate; INT reserved; } SAMLSPServerSignatureFoundEventParams;
#define EID_SAMLSPSERVER_SIGNATUREFOUND 33

virtual INT SECUREBLACKBOX_CALL FireSignatureFound(LONG64 &lConnectionID, LPSTR &lpszSessionID, INT &iScope, LPSTR &lpszSigner, LPSTR &lpszTargetID, LPSTR &lpszTargetType, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszSigMethod, LPSTR &lpszDigestMethod, BOOL &bCertFound, BOOL &bValidate);
class SAMLSPServerSignatureFoundEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  int Scope();

  const QString &Signer();

  const QString &TargetID();

  const QString &TargetType();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  const QString &SigMethod();

  const QString &DigestMethod();

  bool CertFound();

  bool Validate();
  void SetValidate(bool bValidate);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SignatureFound(SAMLSPServerSignatureFoundEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSignatureFound(SAMLSPServerSignatureFoundEventParams *e) {...}

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.

sssUnknown0The scope of signature is unknown

sssMessage1The signature covers the entire SAML message

sssAssertion2The signature covers an assertion

sssBinding3The 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 (SAMLSPServer Class)

Reports the signature validation result.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureValidated(SAMLSPServerSignatureValidatedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
int Scope;
const char *Signer;
const char *TargetID;
const char *TargetType;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
const char *SigMethod;
const char *DigestMethod;
int ValidationResult; int reserved; } SAMLSPServerSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(SAMLSPServerSignatureValidatedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
INT Scope;
LPCWSTR Signer;
LPCWSTR TargetID;
LPCWSTR TargetType;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
LPCWSTR SigMethod;
LPCWSTR DigestMethod;
INT ValidationResult; INT reserved; } SAMLSPServerSignatureValidatedEventParams;
#define EID_SAMLSPSERVER_SIGNATUREVALIDATED 34

virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(LONG64 &lConnectionID, LPSTR &lpszSessionID, INT &iScope, LPSTR &lpszSigner, LPSTR &lpszTargetID, LPSTR &lpszTargetType, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszSigMethod, LPSTR &lpszDigestMethod, INT &iValidationResult);
class SAMLSPServerSignatureValidatedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  int Scope();

  const QString &Signer();

  const QString &TargetID();

  const QString &TargetType();

  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  const QString &SigMethod();

  const QString &DigestMethod();

  int ValidationResult();
  void SetValidationResult(int iValidationResult);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SignatureValidated(SAMLSPServerSignatureValidatedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSignatureValidated(SAMLSPServerSignatureValidatedEventParams *e) {...}

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.

sssUnknown0The scope of signature is unknown

sssMessage1The signature covers the entire SAML message

sssAssertion2The signature covers an assertion

sssBinding3The signature covers the binding

IssuerRDN returns the name of the signature issuer, SerialNumber identifies the signing certificate, SubjectKeyID contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, ValidationResult specifies whether signature is valid or not:
svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

TLSCertValidate Event (SAMLSPServer Class)

Fires when a client certificate needs to be validated.

Syntax

ANSI (Cross Platform)
virtual int FireTLSCertValidate(SAMLSPServerTLSCertValidateEventParams *e);
typedef struct {
int64 ConnectionID;
int Accept; int reserved; } SAMLSPServerTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(SAMLSPServerTLSCertValidateEventParams *e);
typedef struct {
LONG64 ConnectionID;
BOOL Accept; INT reserved; } SAMLSPServerTLSCertValidateEventParams;
#define EID_SAMLSPSERVER_TLSCERTVALIDATE 35

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LONG64 &lConnectionID, BOOL &bAccept);
class SAMLSPServerTLSCertValidateEventParams {
public:
  qint64 ConnectionID();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSCertValidate(SAMLSPServerTLSCertValidateEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireTLSCertValidate(SAMLSPServerTLSCertValidateEventParams *e) {...}

Remarks

The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (SAMLSPServer Class)

Reports the setup of a TLS session.

Syntax

ANSI (Cross Platform)
virtual int FireTLSEstablished(SAMLSPServerTLSEstablishedEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SAMLSPServerTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(SAMLSPServerTLSEstablishedEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SAMLSPServerTLSEstablishedEventParams;
#define EID_SAMLSPSERVER_TLSESTABLISHED 36

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LONG64 &lConnectionID);
class SAMLSPServerTLSEstablishedEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSEstablished(SAMLSPServerTLSEstablishedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireTLSEstablished(SAMLSPServerTLSEstablishedEventParams *e) {...}

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (SAMLSPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireTLSHandshake(SAMLSPServerTLSHandshakeEventParams *e);
typedef struct {
int64 ConnectionID;
const char *ServerName;
int Abort; int reserved; } SAMLSPServerTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(SAMLSPServerTLSHandshakeEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR ServerName;
BOOL Abort; INT reserved; } SAMLSPServerTLSHandshakeEventParams;
#define EID_SAMLSPSERVER_TLSHANDSHAKE 37

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LONG64 &lConnectionID, LPSTR &lpszServerName, BOOL &bAbort);
class SAMLSPServerTLSHandshakeEventParams {
public:
  qint64 ConnectionID();

  const QString &ServerName();

  bool Abort();
  void SetAbort(bool bAbort);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSHandshake(SAMLSPServerTLSHandshakeEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireTLSHandshake(SAMLSPServerTLSHandshakeEventParams *e) {...}

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (SAMLSPServer Class)

Requests a pre-shared key for TLS-PSK.

Syntax

ANSI (Cross Platform)
virtual int FireTLSPSK(SAMLSPServerTLSPSKEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Identity;
char *PSK;
char *Ciphersuite; int reserved; } SAMLSPServerTLSPSKEventParams;
Unicode (Windows) virtual INT FireTLSPSK(SAMLSPServerTLSPSKEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Identity;
LPWSTR PSK;
LPWSTR Ciphersuite; INT reserved; } SAMLSPServerTLSPSKEventParams;
#define EID_SAMLSPSERVER_TLSPSK 38

virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LONG64 &lConnectionID, LPSTR &lpszIdentity, LPSTR &lpszPSK, LPSTR &lpszCiphersuite);
class SAMLSPServerTLSPSKEventParams {
public:
  qint64 ConnectionID();

  const QString &Identity();

  const QString &PSK();
  void SetPSK(const QString &qsPSK);

  const QString &Ciphersuite();
  void SetCiphersuite(const QString &qsCiphersuite);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSPSK(SAMLSPServerTLSPSKEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireTLSPSK(SAMLSPServerTLSPSKEventParams *e) {...}

Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (SAMLSPServer Class)

Reports closure of a TLS session.

Syntax

ANSI (Cross Platform)
virtual int FireTLSShutdown(SAMLSPServerTLSShutdownEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SAMLSPServerTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(SAMLSPServerTLSShutdownEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SAMLSPServerTLSShutdownEventParams;
#define EID_SAMLSPSERVER_TLSSHUTDOWN 39

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LONG64 &lConnectionID);
class SAMLSPServerTLSShutdownEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSShutdown(SAMLSPServerTLSShutdownEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireTLSShutdown(SAMLSPServerTLSShutdownEventParams *e) {...}

Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

UserAuthCompleted Event (SAMLSPServer Class)

Notifies the application about the success of user authentication flow.

Syntax

ANSI (Cross Platform)
virtual int FireUserAuthCompleted(SAMLSPServerUserAuthCompletedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *AssertionBody;
const char *Auth;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex;
const char *ValidFrom;
const char *ValidTo;
const char *RelayState; int reserved; } SAMLSPServerUserAuthCompletedEventParams;
Unicode (Windows) virtual INT FireUserAuthCompleted(SAMLSPServerUserAuthCompletedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR AssertionBody;
LPCWSTR Auth;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex;
LPCWSTR ValidFrom;
LPCWSTR ValidTo;
LPCWSTR RelayState; INT reserved; } SAMLSPServerUserAuthCompletedEventParams;
#define EID_SAMLSPSERVER_USERAUTHCOMPLETED 40

virtual INT SECUREBLACKBOX_CALL FireUserAuthCompleted(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszAssertionBody, LPSTR &lpszAuth, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, LPSTR &lpszValidFrom, LPSTR &lpszValidTo, LPSTR &lpszRelayState);
class SAMLSPServerUserAuthCompletedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &AssertionBody();

  const QString &Auth();

  const QString &NameID();

  const QString &NameIDFormat();

  const QString &SessionIndex();

  const QString &ValidFrom();

  const QString &ValidTo();

  const QString &RelayState();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void UserAuthCompleted(SAMLSPServerUserAuthCompletedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireUserAuthCompleted(SAMLSPServerUserAuthCompletedEventParams *e) {...}

Remarks

Subscribe to this event to get notified about completion of user authentication flow. The NameID, NameIDFormat, SessionIndex, ValidFrom, and ValidTo parameters contain the session parameters as stated in the assertion, which is provided via the AssertionBody parameter. The Auth parameter contain the authentication mechanism used.

The RelayState matches the original relay state that was used on the initiation stage of the authentication.

UserAuthFailed Event (SAMLSPServer Class)

Notifies the application about failure of user authentication flow.

Syntax

ANSI (Cross Platform)
virtual int FireUserAuthFailed(SAMLSPServerUserAuthFailedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RelayState; int reserved; } SAMLSPServerUserAuthFailedEventParams;
Unicode (Windows) virtual INT FireUserAuthFailed(SAMLSPServerUserAuthFailedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RelayState; INT reserved; } SAMLSPServerUserAuthFailedEventParams;
#define EID_SAMLSPSERVER_USERAUTHFAILED 41

virtual INT SECUREBLACKBOX_CALL FireUserAuthFailed(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRelayState);
class SAMLSPServerUserAuthFailedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &RelayState();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void UserAuthFailed(SAMLSPServerUserAuthFailedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireUserAuthFailed(SAMLSPServerUserAuthFailedEventParams *e) {...}

Remarks

The component fires this event to notify the application about failed user authentication flow. The RelayState parameter matches the one included with the AuthnRequest message.

UserAuthStart Event (SAMLSPServer Class)

Notifies the application about the start of user authentication flow.

Syntax

ANSI (Cross Platform)
virtual int FireUserAuthStart(SAMLSPServerUserAuthStartEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
int IdPServiceIndex;
char *RelayState; int reserved; } SAMLSPServerUserAuthStartEventParams;
Unicode (Windows) virtual INT FireUserAuthStart(SAMLSPServerUserAuthStartEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
INT IdPServiceIndex;
LPWSTR RelayState; INT reserved; } SAMLSPServerUserAuthStartEventParams;
#define EID_SAMLSPSERVER_USERAUTHSTART 42

virtual INT SECUREBLACKBOX_CALL FireUserAuthStart(LONG64 &lConnectionID, LPSTR &lpszSessionID, INT &iIdPServiceIndex, LPSTR &lpszRelayState);
class SAMLSPServerUserAuthStartEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  int IdPServiceIndex();

  const QString &RelayState();
  void SetRelayState(const QString &qsRelayState);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void UserAuthStart(SAMLSPServerUserAuthStartEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireUserAuthStart(SAMLSPServerUserAuthStartEventParams *e) {...}

Remarks

The component invokes this event to signal the start of the user authentication flow. This happens shortly before the component proceeds to generation of AuthnRequest message.

The RelayState is an arbitrary string that will be passed to the IdP and mirrored back with the assertion. It is typically used to remember the URL of the resource or page that kicked in the SAML authentication flow.

UserLogoutCompleted Event (SAMLSPServer Class)

Notifies the application about the completion of user logout flow.

Syntax

ANSI (Cross Platform)
virtual int FireUserLogoutCompleted(SAMLSPServerUserLogoutCompletedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *NameID;
const char *SessionIndex;
const char *RelayState; int reserved; } SAMLSPServerUserLogoutCompletedEventParams;
Unicode (Windows) virtual INT FireUserLogoutCompleted(SAMLSPServerUserLogoutCompletedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR NameID;
LPCWSTR SessionIndex;
LPCWSTR RelayState; INT reserved; } SAMLSPServerUserLogoutCompletedEventParams;
#define EID_SAMLSPSERVER_USERLOGOUTCOMPLETED 43

virtual INT SECUREBLACKBOX_CALL FireUserLogoutCompleted(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszNameID, LPSTR &lpszSessionIndex, LPSTR &lpszRelayState);
class SAMLSPServerUserLogoutCompletedEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  const QString &NameID();

  const QString &SessionIndex();

  const QString &RelayState();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void UserLogoutCompleted(SAMLSPServerUserLogoutCompletedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireUserLogoutCompleted(SAMLSPServerUserLogoutCompletedEventParams *e) {...}

Remarks

Subscribe to this event to be notified about the completion of the logout flow.

UserLogoutStart Event (SAMLSPServer Class)

Notifies the application about the start of user logout flow.

Syntax

ANSI (Cross Platform)
virtual int FireUserLogoutStart(SAMLSPServerUserLogoutStartEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
int IdPServiceIndex;
const char *NameID;
const char *SessionIndex;
int Secondary;
char *RelayState; int reserved; } SAMLSPServerUserLogoutStartEventParams;
Unicode (Windows) virtual INT FireUserLogoutStart(SAMLSPServerUserLogoutStartEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
INT IdPServiceIndex;
LPCWSTR NameID;
LPCWSTR SessionIndex;
BOOL Secondary;
LPWSTR RelayState; INT reserved; } SAMLSPServerUserLogoutStartEventParams;
#define EID_SAMLSPSERVER_USERLOGOUTSTART 44

virtual INT SECUREBLACKBOX_CALL FireUserLogoutStart(LONG64 &lConnectionID, LPSTR &lpszSessionID, INT &iIdPServiceIndex, LPSTR &lpszNameID, LPSTR &lpszSessionIndex, BOOL &bSecondary, LPSTR &lpszRelayState);
class SAMLSPServerUserLogoutStartEventParams {
public:
  qint64 ConnectionID();

  const QString &SessionID();

  int IdPServiceIndex();

  const QString &NameID();

  const QString &SessionIndex();

  bool Secondary();

  const QString &RelayState();
  void SetRelayState(const QString &qsRelayState);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void UserLogoutStart(SAMLSPServerUserLogoutStartEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireUserLogoutStart(SAMLSPServerUserLogoutStartEventParams *e) {...}

Remarks

Subscribe to this event to get notified about the start of the user logout flow.

The logout process can be initiated on either the SP or IdP side. This event is fired at the earliest opportunity that this fact becomes known to the service provider: from within the InitiateLogout method, ProcessLogoutRequest method, or upon receiving a logout request at the SLS endpoint.

Independently of the timing and the stage of this event, the subsequent flow is the same: the logout protocol is initiated. The application will be notified of the completion of the protocol using the UserLogoutCompleted event. Note that the UserLogoutCompleted event may not fire if the connectivity to the IdP is lost prematurely or the IdP chooses not to respond. Due to that, it is reasonable to consider the user as logged out immediately after the current event fires.

The IdPServiceIndex parameter contains the index of the IdP service in the IdPServices collection. NameID indicates the name identifier of the user that is being logged out, and SessionIndex contain the unique SAML session identifier. The Secondary flag indicates whether the the SP is responding to IdP-initiated logout request.

The RelayState parameter is an optional SP-generated token that the IdP will return back in its LogoutResponse message. This is often set to the destination page where the browser should be redirected upon completion of the signout process.

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

Fields

Bytes
char* (read-only)

Default Value:

Returns the raw certificate data in DER format.

CA
int

Default Value: FALSE

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.

CAKeyID
char* (read-only)

Default Value:

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

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

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

CertType
int (read-only)

Default Value: 0

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

CRLDistributionPoints
char*

Default Value: ""

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

Curve
char*

Default Value: ""

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

Fingerprint
char* (read-only)

Default Value: ""

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

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

FriendlyName
char* (read-only)

Default Value: ""

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

Handle
int64

Default Value: 0

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());

HashAlgorithm
char*

Default Value: ""

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

Issuer
char* (read-only)

Default Value: ""

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

IssuerRDN
char*

Default Value: ""

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

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

KeyAlgorithm
char*

Default Value: "0"

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.

KeyBits
int (read-only)

Default Value: 0

Returns the length of the public key in bits.

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

KeyFingerprint
char* (read-only)

Default Value: ""

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

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

KeyUsage
int

Default Value: 0

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

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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

KeyValid
int (read-only)

Default Value: FALSE

Returns True if the certificate's key is cryptographically valid, and False otherwise.

OCSPLocations
char*

Default Value: ""

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

OCSPNoCheck
int

Default Value: FALSE

Accessor to the value of the certificate's ocsp-no-check extension.

Origin
int (read-only)

Default Value: 0

Returns the location that the certificate was taken or loaded from.

PolicyIDs
char*

Default Value: ""

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this field when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

PrivateKeyBytes
char* (read-only)

Default Value:

Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

PrivateKeyExists
int (read-only)

Default Value: FALSE

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

PrivateKeyExtractable
int (read-only)

Default Value: FALSE

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
char* (read-only)

Default Value:

Contains the certificate's public key in DER format.

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

Qualified
int (read-only)

Default Value: FALSE

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

QualifiedStatements
int

Default Value: 0

Returns a simplified qualified status of the certificate.

Qualifiers
char* (read-only)

Default Value: ""

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

SelfSigned
int (read-only)

Default Value: FALSE

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

SerialNumber
char*

Default Value:

Returns the certificate's serial number.

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

SigAlgorithm
char* (read-only)

Default Value: ""

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

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

Source
int (read-only)

Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Subject
char* (read-only)

Default Value: ""

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

SubjectAlternativeName
char*

Default Value: ""

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

SubjectKeyID
char*

Default Value:

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

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

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

SubjectRDN
char*

Default Value: ""

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

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

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

Valid
int (read-only)

Default Value: FALSE

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

ValidFrom
char*

Default Value: ""

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

ValidTo
char*

Default Value: ""

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

Constructors

Certificate()

Creates a new object with default field values.

CryptoKey Type

This container represents a cryptographic key.

Syntax

SecureBlackboxCryptoKey (declared in secureblackbox.h)

Remarks

This type is a universal placeholder for cryptographic keys.

The following fields are available:

Fields

Algorithm
char*

Default Value: ""

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_DESDES
SB_SYMMETRIC_ALGORITHM_3DES3DES
SB_SYMMETRIC_ALGORITHM_RC2RC2
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES192AES192
SB_SYMMETRIC_ALGORITHM_AES256AES256
SB_SYMMETRIC_ALGORITHM_IDENTITYIdentity
SB_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_SYMMETRIC_ALGORITHM_CAST128CAST128
SB_SYMMETRIC_ALGORITHM_IDEAIDEA
SB_SYMMETRIC_ALGORITHM_TWOFISHTwofish
SB_SYMMETRIC_ALGORITHM_TWOFISH128Twofish128
SB_SYMMETRIC_ALGORITHM_TWOFISH192Twofish192
SB_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256
SB_SYMMETRIC_ALGORITHM_CAMELLIACamellia
SB_SYMMETRIC_ALGORITHM_CAMELLIA128Camellia128
SB_SYMMETRIC_ALGORITHM_CAMELLIA192Camellia192
SB_SYMMETRIC_ALGORITHM_CAMELLIA256Camellia256
SB_SYMMETRIC_ALGORITHM_SERPENTSerpent
SB_SYMMETRIC_ALGORITHM_SERPENT128Serpent128
SB_SYMMETRIC_ALGORITHM_SERPENT192Serpent192
SB_SYMMETRIC_ALGORITHM_SERPENT256Serpent256
SB_SYMMETRIC_ALGORITHM_SEEDSEED
SB_SYMMETRIC_ALGORITHM_RABBITRabbit
SB_SYMMETRIC_ALGORITHM_SYMMETRICGeneric
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989GOST-28147-1989
SB_SYMMETRIC_ALGORITHM_CHACHA20ChaCha20
SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

Bits
int (read-only)

Default Value: 0

The length of the key in bits.

Curve
char*

Default Value: ""

This property specifies the name of the curve the EC key is built on.

Exportable
int (read-only)

Default Value: FALSE

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Fingerprint
char* (read-only)

Default Value: ""

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

Handle
int64

Default Value: 0

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());

ID
char*

Default Value:

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

IV
char*

Default Value:

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

Key
char* (read-only)

Default Value:

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

Nonce
char*

Default Value:

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

Private
int (read-only)

Default Value: FALSE

Returns True if the object hosts a private key, and False otherwise.

Public
int (read-only)

Default Value: FALSE

Returns True if the object hosts a public key, and False otherwise.

Subject
char*

Default Value:

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

Symmetric
int (read-only)

Default Value: FALSE

Returns True if the object contains a symmetric key, and False otherwise.

Valid
int (read-only)

Default Value: FALSE

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

Constructors

CryptoKey()

Creates an empty crypto key object.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

The following fields are available:

Fields

AsyncDocumentID
char*

Default Value: ""

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

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

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

CustomParams
char*

Default Value: ""

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

Data
char*

Default Value: ""

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

ExternalHashCalculation
int

Default Value: FALSE

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

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

HashAlgorithm
char*

Default Value: "SHA256"

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

KeyID
char*

Default Value: ""

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

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret 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";

KeySecret
char*

Default Value: ""

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 KeyID topic.

Method
int

Default Value: 0

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

Available options:

asmdPKCS10
asmdPKCS71

Mode
int

Default Value: 0

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with the OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

PublicKeyAlgorithm
char*

Default Value: ""

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

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

SAMLEntity Type

Represents SAML entity details.

Syntax

SecureBlackboxSAMLEntity (declared in secureblackbox.h)

Remarks

This type is a container for SAML SP or IdP entity parameters. These are often referred to as service metadata.

The following fields are available:

Fields

ContactPerson
char*

Default Value: ""

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.

EncryptionKey
char*

Default Value: ""

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.

EncryptionMethods
char*

Default Value: ""

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

EntityID
char*

Default Value: ""

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

Flags
int

Default Value: 0

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.

IdPSSOLink
char*

Default Value: ""

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

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

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

NameIDFormats
char*

Default Value: ""

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

OrganizationDisplayName
char*

Default Value: ""

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.

OrganizationLang
char*

Default Value: ""

The language preferred by the organization.

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

OrganizationName
char*

Default Value: ""

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.

OrganizationURL
char*

Default Value: ""

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.

SignatureValidationResult
int (read-only)

Default Value: 0

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

Signed
int (read-only)

Default Value: FALSE

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.

SignedWith
char* (read-only)

Default Value: ""

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 SignatureValidationResult setting.

SigningKey
char*

Default Value: ""

Contains the entity's signing key.

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

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

ValidUntil
char*

Default Value: ""

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.

Constructors

SAMLEntity()

Creates a new SAMLEntity object.

SAMLSecuritySettings Type

Represents SAML security settings for the message being viewed/edited.

Syntax

SecureBlackboxSAMLSecuritySettings (declared in secureblackbox.h)

Remarks

This type is a container for SAML security parameters.

The following fields are available:

Fields

CanonicalizationMethod
char*

Default Value: ""

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/)

DigestMethod
char*

Default Value: ""

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.

EncryptionMethod
char*

Default Value: "AES256"

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_RC4RC4
SB_XML_ENCRYPTION_ALGORITHM_DESDES
SB_XML_ENCRYPTION_ALGORITHM_3DES3DEST
SB_XML_ENCRYPTION_ALGORITHM_AES128AES128
SB_XML_ENCRYPTION_ALGORITHM_AES192AES192
SB_XML_ENCRYPTION_ALGORITHM_AES256AES256
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128Camellia128
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192Camellia192
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256Camellia256
SB_XML_ENCRYPTION_ALGORITHM_SEEDSEED

Flags
int

Default Value: 1

Provides access to secondary security parameters and tweaks.

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

ssfSignatureAfterIssuer1Place the Signature tag after the issuer tag in the XML document

ssfSignatureBeforeDescriptor2Place the Signature tag before the entity descriptor tag in the XML metadata

ssfKeyDataIssuerSerial4Include the IssuerSerial key data element

ssfKeyDataSKI8Include the SubjectKeyIdentifier key data element

ssfKeyDataSubjectName16Include the SubjectName key data element

ssfKeyDataCertificate32Include the Certificate key data element

ssfKeyDataCRL64Include the CRL key data element

ssfSignAuthnRequests65536Sign authentication requests (SP only)

ssfSignArtifactResolveRequests131072Sign artifact resolve requests

ssfSignLogoutRequests262144Sign logout requests

ssfSignAssertions524288Sign outgoing assertions (IdP only)

ssfSignResponses1048576Sign all responses (IdP only)

ssfEncryptAssertions2097152Encrypt generated assertions (IdP only)

SigMethod
char*

Default Value: ""

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.

SignaturePolicy
int

Default Value: 0

Specifies the signature validation policy.

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

Constructors

SAMLSecuritySettings()

Creates a new SAMLSecuritySettings object.

SAMLServiceInfo Type

Represents SAML service details.

Syntax

SecureBlackboxSAMLServiceInfo (declared in secureblackbox.h)

Remarks

This type is a container for SAML SP or IdP endpoint service parameters.

The following fields are available:

Fields

BindingType
int (read-only)

Default Value: 0

Specifies the type of SAML binding that this endpoint accepts.

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

EntityID
char* (read-only)

Default Value: ""

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

Location
char* (read-only)

Default Value: ""

The location (URL) of the endpoint.

Priority
int

Default Value: -1

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

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.

Service
int (read-only)

Default Value: 0

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.

ServiceIndex
int (read-only)

Default Value: 0

The index of this endpoint.

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

Constructors

SAMLServiceInfo()

Creates a new SAMLServiceInfo object.

SocketSettings Type

A container for the socket settings.

Syntax

SecureBlackboxSocketSettings (declared in secureblackbox.h)

Remarks

This type is a container for socket-layer parameters.

The following fields are available:

Fields

DNSMode
int

Default Value: 0

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

DNSPort
int

Default Value: 0

Specifies the port number to be used for sending queries to the DNS server.

DNSQueryTimeout
int

Default Value: 0

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

DNSServers
char*

Default Value: ""

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

DNSTotalTimeout
int

Default Value: 0

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

IncomingSpeedLimit
int

Default Value: 0

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

LocalAddress
char*

Default Value: ""

The local network interface to bind the socket to.

LocalPort
int

Default Value: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
int

Default Value: 0

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

Timeout
int

Default Value: 60000

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

UseIPv6
int

Default Value: FALSE

Enables or disables IP protocol version 6.

Constructors

SocketSettings()

Creates a new SocketSettings object.

TLSConnectionInfo Type

Contains information about a network connection.

Syntax

SecureBlackboxTLSConnectionInfo (declared in secureblackbox.h)

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

The following fields are available:

Fields

AEADCipher
int (read-only)

Default Value: FALSE

Indicates whether the encryption algorithm used is an AEAD cipher.

ChainValidationDetails
int (read-only)

Default Value: 0

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

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

ChainValidationResult
int (read-only)

Default Value: 0

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

Ciphersuite
char* (read-only)

Default Value: ""

The cipher suite employed by this connection.

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

ClientAuthenticated
int (read-only)

Default Value: FALSE

Specifies whether client authentication was performed during this connection.

ClientAuthRequested
int (read-only)

Default Value: FALSE

Specifies whether client authentication was requested during this connection.

ConnectionEstablished
int (read-only)

Default Value: FALSE

Indicates whether the connection has been established fully.

ConnectionID
char* (read-only)

Default Value:

The unique identifier assigned to this connection.

DigestAlgorithm
char* (read-only)

Default Value: ""

The digest algorithm used in a TLS-enabled connection.

EncryptionAlgorithm
char* (read-only)

Default Value: ""

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

Exportable
int (read-only)

Default Value: FALSE

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

ID
int64 (read-only)

Default Value: -1

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

KeyExchangeAlgorithm
char* (read-only)

Default Value: ""

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

KeyExchangeKeyBits
int (read-only)

Default Value: 0

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

NamedECCurve
char* (read-only)

Default Value: ""

The elliptic curve used in this connection.

PFSCipher
int (read-only)

Default Value: FALSE

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

PreSharedIdentity
char*

Default Value: ""

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

PreSharedIdentityHint
char* (read-only)

Default Value: ""

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

PublicKeyBits
int (read-only)

Default Value: 0

The length of the public key.

RemoteAddress
char* (read-only)

Default Value: ""

The client's IP address.

RemotePort
int (read-only)

Default Value: 0

The remote port of the client connection.

ResumedSession
int (read-only)

Default Value: FALSE

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

SecureConnection
int (read-only)

Default Value: FALSE

Indicates whether TLS or SSL is enabled for this connection.

ServerAuthenticated
int (read-only)

Default Value: FALSE

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

SignatureAlgorithm
char* (read-only)

Default Value: ""

The signature algorithm used in a TLS handshake.

SymmetricBlockSize
int (read-only)

Default Value: 0

The block size of the symmetric algorithm used.

SymmetricKeyBits
int (read-only)

Default Value: 0

The key length of the symmetric algorithm used.

TotalBytesReceived
int64 (read-only)

Default Value: 0

The total number of bytes received over this connection.

TotalBytesSent
int64 (read-only)

Default Value: 0

The total number of bytes sent over this connection.

ValidationLog
char* (read-only)

Default Value: ""

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

Version
char* (read-only)

Default Value: ""

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

Constructors

TLSConnectionInfo()

Creates a new TLSConnectionInfo object.

TLSSettings Type

A container for TLS connection settings.

Syntax

SecureBlackboxTLSSettings (declared in secureblackbox.h)

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

The following fields are available:

Fields

AutoValidateCertificates
int

Default Value: TRUE

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

BaseConfiguration
int

Default Value: 0

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

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

Ciphersuites
char*

Default Value: ""

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

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by 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

ClientAuth
int

Default Value: 0

Enables or disables certificate-based client authentication.

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

ccatNoAuth0
ccatRequestCert1
ccatRequireCert2

ECCurves
char*

Default Value: ""

Defines the elliptic curves to enable.

Extensions
char*

Default Value: ""

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
int

Default Value: FALSE

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

PreSharedIdentity
char*

Default Value: ""

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

PreSharedKey
char*

Default Value: ""

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

PreSharedKeyCiphersuite
char*

Default Value: ""

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

RenegotiationAttackPreventionMode
int

Default Value: 2

Selects the renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

RevocationCheck
int

Default Value: 1

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.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

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

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

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

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

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

SSLOptions
int

Default Value: 16

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

TLSMode
int

Default Value: 0

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, but allow plain data.

UseExtendedMasterSecret
int

Default Value: FALSE

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

UseSessionResumption
int

Default Value: FALSE

Enables or disables the TLS session resumption capability.

Versions
int

Default Value: 16

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

Constructors

TLSSettings()

Creates a new TLSSettings object.

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SAMLSPServer class.

Methods

GetCount This method returns the current size of the collection.

int GetCount() {}

SetCount This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.

int SetCount(int count) {}

Get This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.

T* Get(int index) {}

Set This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.

T* Set(int index, T* value) {}

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

AllowOptionsResponseWithoutAuth:   Enables unauthenticated responses to OPTIONS requests.

Set this property to true to allow the server serve OPTIONS requests without prior authentication of the client.

AuthDigestExpire:   Specifies digest expiration time for digest authentication.

Use this property to specify the digest expiration time for digest authentication, in seconds. The default setting is 20.

BoundPort:   The port that was bound by the server.

Returns the port number that was bound by the server.

ContactPerson:   The ContactPerson entry of the provider metadata.

Use this configuration setting to set or get the ContactPerson element of the provider metadata record.

DualStack:   Allows the use of ip4 and ip6 simultaneously.

This setting specifies a socket can use ip4 and ip6 simultaneously.

HandshakeTimeout:   The HTTPS handshake timeout.

The HTTPS handshake timeout in milliseconds.

HomePage:   Specifies the home page resource name.

Use this property to specify the home page (/) resource name.

IDPAQS:   TBD.

TBD

IDPARS:   TBD.

TBD

IDPSLS:   TBD.

TBD

IDPSSO:   TBD.

TBD

MaxIssueInstantTimeDiff:   The maximum issue-instant time delta.

This property specifies the maximum time delta for serving issue-instant requests, in milliseconds. The default value is 30000.

OrganizationDisplayName:   The OrganizationDisplayName entry of the provider metadata.

Use this property to provide or get the OrganizationDisplayName element of the provider metadata.

OrganizationLang:   The OrganizationLang key of the provider metadata.

Use this property to get or set the OrganizationLog element of the provider metadata.

OrganizationName:   The OrganizationName element of the provider metadata.

This configuration property allows you to set or get the OrganizationName element of the provider metadata.

OrganizationURL:   The OrganizationURL element of the provider metadata.

Use this configuration setting to set or get the OrganizationURL parameter of the provider metadata.

PortRangeFrom:   The lower bound of allowed port scope to listen on.

Specifies the lowest port number the server may use if dynamic allocation is used.

PortRangeTo:   The higher bound of allowed port scope to listen on.

Specifies the highest port number the server may use if dynamic allocation is used.

RequestFilter:   The request string modifier.

Use this property to tune up the request string as returned by GetRequestString method. Supported filters: params (request parameters only), params[Index] or params['Name'] (a specific request parameter), parts[Index] (the contents of a particular part of a multipart message). An empty request filter makes GetRequestString return the whole body of the request.

SAMLAction:   TBD.

TBD

SAMLBuffer:   TBD.

TBD

SAMLResourceProtected:   TBD.

TBD

SAMLResourceSpecial:   TBD.

TBD

SAMLString:   TBD.

TBD

SendBufferSize:   The network send buffer size.

Specifies the size of the output buffer.

ServerName:   Specifies the server name for the created responses.

Use this property to specify the server name to be included in the generated responses.

SessionTimeout:   The HTTP session timeout.

The HTTP session timeout in milliseconds.

SessionTTL:   The SAML session time-to-live value.

The SAML session time-to-live value, in milliseconds. The default value is 600000 (10 minutes).

SignatureAlgorithm:   TBD.

TBD

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

WantAssertionsSigned:   TBD.

TBD

Base Config Settings

ASN1UseGlobalTagCache:   Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins:   Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

DNSLocalSuffix:   The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HardwareCryptoUsePolicy:   The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

HttpVersion:   The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert:   Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter:   The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

OldClientSideRSAFallback:   Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache:   Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

certificateEnables caching of certificates.
crlEnables caching of Certificate Revocation Lists (CRLs).
ocspEnables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath:   Specifies the file system path where cached PKI data is stored.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

ProductVersion:   Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseCRLObjectCaching:   Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation:   Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOCSPResponseObjectCaching:   Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

XMLRDNDescriptorName[OID]:   Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]:   Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder:   Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator:   Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (SAMLSPServer Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SAMLSPServer Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)
30408705   Invalid binding name (SB_ERROR_SAML_INVALID_BINDING_NAME)
30408706   Invalid SAML binding type (SB_ERROR_SAML_INVALID_BINDING_TYPE)
30408707   Base directory not set (SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET)
30408708   Invalid parameter (SB_ERROR_SAML_INVALID_PARAM)
30408709   Invalid input data (SB_ERROR_SAML_INVALID_DATA)
30408710   Data is not loaded (SB_ERROR_SAML_NOT_LOADED)
30408711   New document is not created (SB_ERROR_SAML_NOT_CREATED)
30408716   Endpoint of unsupported type encountered or cannot find appropriate IdP service (SB_ERROR_SAML_INVALID_SERVICE)
30408717   Multiple endpoints of the same kind are not supported (SB_ERROR_SAML_MULTIPLE_ENDPOINTS_NOT_SUPPORTED)
30408718   Failed to process the request (SB_ERROR_SAML_PROCESSING_FAILED)
30408719   Session not found (SB_ERROR_SAML_SESSION_NOT_FOUND)