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

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

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

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

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

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Active Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxSAMLServiceInfo>* GetIdPServices();

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCryptoKey>* GetKnownKeys();
int SetKnownKeys(SecureBlackboxList<SecureBlackboxCryptoKey>* val);

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

SecureBlackboxSAMLSecuritySettings* GetSecurity();

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

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetSenderChain();

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

• C++
• C
• Qt

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

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetSigningChain();
int SetSigningChain(SecureBlackboxList<SecureBlackboxCertificate>* val);

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

• C++
• C
• Qt

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

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxSAMLServiceInfo>* GetSPServices();

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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:

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

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

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

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

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

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

• C++
• C
• Qt

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:

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

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

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

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

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

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

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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:

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

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

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

• C++
• C
• Qt

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.

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

• C++
• C
• Qt

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.

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

• C++
• C
• Qt

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.

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

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

• C++
• C
• Qt

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.

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

• C++
• C
• Qt

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.

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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:

AssertionReceived Event (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

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:

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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:

LogoutResponsePrepared Event (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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:

Notification Event (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

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:

ProcessingCompleted Event (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

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.

ReadArtifact Event (SAMLSPServer Class)

Requests content identified by an artifact from the application.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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:

ResourceRead Event (SAMLSPServer Class)

Requests the application to read from an opened resource.

Syntax

• C++
• C
• Qt

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:

ResourceRequest Event (SAMLSPServer Class)

Notifies the application that a server resource is requested.

Syntax

• C++
• C
• Qt

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;