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 LoadIDPMetadata method or its stream-based variant. Most IDPs let you download their metadata in XML format. The metadata file contains general parameters of the IdP endpoint, such as its web address and algorithm requirements.

   
   Copy
    server.LoadIDPMetadata("their_metadata.xml"); // contains "<?xml version="1.0"?><md:EntityDescriptor ID="ab12" ... </md:EntityDescriptor>";   

• Configure the main server capabilities:

   
   Copy
    // 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:

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

   
   Copy
    server.SaveMetadata("my_metadata.xml");

 
 Copy
  server.Start();

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

ArtifactResolutionService Property (SAMLSPServer Class)

The location of the artifact resolution service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArtifactResolutionService();
int SetArtifactResolutionService(const char* lpszArtifactResolutionService);

Unicode (Windows)
LPWSTR GetArtifactResolutionService();
INT SetArtifactResolutionService(LPCWSTR lpszArtifactResolutionService);

char* secureblackbox_samlspserver_getartifactresolutionservice(void* lpObj);
int secureblackbox_samlspserver_setartifactresolutionservice(void* lpObj, const char* lpszArtifactResolutionService);

QString GetArtifactResolutionService();
int SetArtifactResolutionService(QString qsArtifactResolutionService);

Default Value

"/sp/ArtifactResolutionService"

Remarks

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

Data Type

String

AssertionConsumerService Property (SAMLSPServer Class)

The location of the Assertion Consumer Service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionConsumerService();
int SetAssertionConsumerService(const char* lpszAssertionConsumerService);

Unicode (Windows)
LPWSTR GetAssertionConsumerService();
INT SetAssertionConsumerService(LPCWSTR lpszAssertionConsumerService);

char* secureblackbox_samlspserver_getassertionconsumerservice(void* lpObj);
int secureblackbox_samlspserver_setassertionconsumerservice(void* lpObj, const char* lpszAssertionConsumerService);

QString GetAssertionConsumerService();
int SetAssertionConsumerService(QString qsAssertionConsumerService);

Default Value

"/sp/AssertionConsumerService"

Remarks

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

Data Type

String

AssertionConsumerServiceBindings Property (SAMLSPServer Class)

Bindings supported by the Assertion Consumer Service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionConsumerServiceBindings();
int SetAssertionConsumerServiceBindings(const char* lpszAssertionConsumerServiceBindings);

Unicode (Windows)
LPWSTR GetAssertionConsumerServiceBindings();
INT SetAssertionConsumerServiceBindings(LPCWSTR lpszAssertionConsumerServiceBindings);

char* secureblackbox_samlspserver_getassertionconsumerservicebindings(void* lpObj);
int secureblackbox_samlspserver_setassertionconsumerservicebindings(void* lpObj, const char* lpszAssertionConsumerServiceBindings);

QString GetAssertionConsumerServiceBindings();
int SetAssertionConsumerServiceBindings(QString qsAssertionConsumerServiceBindings);

Default Value

"+Artifact,+POST,+Redirect"

Remarks

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

Data Type

String

BaseDir Property (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

ClientAuth Property (SAMLSPServer Class)

Enables or disables certificate-based client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientAuth();
int SetClientAuth(int iClientAuth);

Unicode (Windows)
INT GetClientAuth();
INT SetClientAuth(INT iClientAuth);

CCAT_NO_AUTH(0), 
CCAT_REQUEST_CERT(1), 
CCAT_REQUIRE_CERT(2)

int secureblackbox_samlspserver_getclientauth(void* lpObj);
int secureblackbox_samlspserver_setclientauth(void* lpObj, int iClientAuth);

int GetClientAuth();
int SetClientAuth(int iClientAuth);

Default Value

0

Remarks

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

Data Type

Integer

EncryptionCertBytes Property (SAMLSPServer Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertBytes(char* &lpEncryptionCertBytes, int &lenEncryptionCertBytes);

Unicode (Windows)
INT GetEncryptionCertBytes(LPSTR &lpEncryptionCertBytes, INT &lenEncryptionCertBytes);

int secureblackbox_samlspserver_getencryptioncertbytes(void* lpObj, char** lpEncryptionCertBytes, int* lenEncryptionCertBytes);

QByteArray GetEncryptionCertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

EncryptionCertHandle Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetEncryptionCertHandle();
int SetEncryptionCertHandle(int64 lEncryptionCertHandle);

Unicode (Windows)
LONG64 GetEncryptionCertHandle();
INT SetEncryptionCertHandle(LONG64 lEncryptionCertHandle);

int64 secureblackbox_samlspserver_getencryptioncerthandle(void* lpObj);
int secureblackbox_samlspserver_setencryptioncerthandle(void* lpObj, int64 lEncryptionCertHandle);

qint64 GetEncryptionCertHandle();
int SetEncryptionCertHandle(qint64 lEncryptionCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

ErrorOrigin Property (SAMLSPServer Class)

Indicates the endpoint where the error originates from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetErrorOrigin();
int SetErrorOrigin(int iErrorOrigin);

Unicode (Windows)
INT GetErrorOrigin();
INT SetErrorOrigin(INT iErrorOrigin);

EO_LOCAL(0), 
EO_REMOTE(1)

int secureblackbox_samlspserver_geterrororigin(void* lpObj);
int secureblackbox_samlspserver_seterrororigin(void* lpObj, int iErrorOrigin);

int GetErrorOrigin();
int SetErrorOrigin(int iErrorOrigin);

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

ErrorSeverity Property (SAMLSPServer Class)

The severity of the error that happened.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetErrorSeverity();
int SetErrorSeverity(int iErrorSeverity);

Unicode (Windows)
INT GetErrorSeverity();
INT SetErrorSeverity(INT iErrorSeverity);

ES_INFO(0), 
ES_WARNING(1), 
ES_FATAL(2)

int secureblackbox_samlspserver_geterrorseverity(void* lpObj);
int secureblackbox_samlspserver_seterrorseverity(void* lpObj, int iErrorSeverity);

int GetErrorSeverity();
int SetErrorSeverity(int iErrorSeverity);

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

This property is not available at design time.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_samlspserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

""

Remarks

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

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

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

Data Type

String

ExternalCryptoCustomParams Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_samlspserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_samlspserver_getexternalcryptodata(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SAMLSPServer Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_samlspserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SAMLSPServer Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_samlspserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_samlspserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

Default Value

""

Remarks

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

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example:

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SAMLSPServer Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_samlspserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SAMLSPServer Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_samlspserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (SAMLSPServer Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

int secureblackbox_samlspserver_getexternalcryptomode(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_samlspserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_samlspserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (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

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

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

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

MetaSigningCertBytes Property (SAMLSPServer Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMetaSigningCertBytes(char* &lpMetaSigningCertBytes, int &lenMetaSigningCertBytes);

Unicode (Windows)
INT GetMetaSigningCertBytes(LPSTR &lpMetaSigningCertBytes, INT &lenMetaSigningCertBytes);

int secureblackbox_samlspserver_getmetasigningcertbytes(void* lpObj, char** lpMetaSigningCertBytes, int* lenMetaSigningCertBytes);

QByteArray GetMetaSigningCertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

MetaSigningCertHandle Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMetaSigningCertHandle();
int SetMetaSigningCertHandle(int64 lMetaSigningCertHandle);

Unicode (Windows)
LONG64 GetMetaSigningCertHandle();
INT SetMetaSigningCertHandle(LONG64 lMetaSigningCertHandle);

int64 secureblackbox_samlspserver_getmetasigningcerthandle(void* lpObj);
int secureblackbox_samlspserver_setmetasigningcerthandle(void* lpObj, int64 lMetaSigningCertHandle);

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

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

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

FALSE

Remarks

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

The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML traffic.

Data Type

Boolean

Port Property (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

PreferredIDPToSPBinding Property (SAMLSPServer Class)

Specifies the preferred IdP to SP binding.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPreferredIDPToSPBinding();
int SetPreferredIDPToSPBinding(int iPreferredIDPToSPBinding);

Unicode (Windows)
INT GetPreferredIDPToSPBinding();
INT SetPreferredIDPToSPBinding(INT iPreferredIDPToSPBinding);

CSBT_NONE(0), 
CSBT_SOAP(1), 
CSBT_PAOS(2), 
CSBT_REDIRECT(3), 
CSBT_POST(4), 
CSBT_ARTIFACT(5)

int secureblackbox_samlspserver_getpreferredidptospbinding(void* lpObj);
int secureblackbox_samlspserver_setpreferredidptospbinding(void* lpObj, int iPreferredIDPToSPBinding);

int GetPreferredIDPToSPBinding();
int SetPreferredIDPToSPBinding(int iPreferredIDPToSPBinding);

Default Value

4

Remarks

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

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://secureblackbox.com"

Remarks

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

Data Type

String

ServerCertCount Property (SAMLSPServer Class)

The number of records in the ServerCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertCount();
int SetServerCertCount(int iServerCertCount);

Unicode (Windows)
INT GetServerCertCount();
INT SetServerCertCount(INT iServerCertCount);

int secureblackbox_samlspserver_getservercertcount(void* lpObj);
int secureblackbox_samlspserver_setservercertcount(void* lpObj, int iServerCertCount);

int GetServerCertCount();
int SetServerCertCount(int iServerCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerCertBytes
• ServerCertHandle

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

This property is not available at design time.

Data Type

Integer

ServerCertBytes Property (SAMLSPServer Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerCertBytes(int iServerCertIndex, char* &lpServerCertBytes, int &lenServerCertBytes);

Unicode (Windows)
INT GetServerCertBytes(INT iServerCertIndex, LPSTR &lpServerCertBytes, INT &lenServerCertBytes);

int secureblackbox_samlspserver_getservercertbytes(void* lpObj, int servercertindex, char** lpServerCertBytes, int* lenServerCertBytes);

QByteArray GetServerCertBytes(int iServerCertIndex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ServerCertHandle Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetServerCertHandle(int iServerCertIndex);
int SetServerCertHandle(int iServerCertIndex, int64 lServerCertHandle);

Unicode (Windows)
LONG64 GetServerCertHandle(INT iServerCertIndex);
INT SetServerCertHandle(INT iServerCertIndex, LONG64 lServerCertHandle);

int64 secureblackbox_samlspserver_getservercerthandle(void* lpObj, int servercertindex);
int secureblackbox_samlspserver_setservercerthandle(void* lpObj, int servercertindex, int64 lServerCertHandle);

qint64 GetServerCertHandle(int iServerCertIndex);
int SetServerCertHandle(int iServerCertIndex, qint64 lServerCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

SigCanonicalizationMethod Property (SAMLSPServer Class)

The canonicalization method to use in the signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigCanonicalizationMethod();
int SetSigCanonicalizationMethod(const char* lpszSigCanonicalizationMethod);

Unicode (Windows)
LPWSTR GetSigCanonicalizationMethod();
INT SetSigCanonicalizationMethod(LPCWSTR lpszSigCanonicalizationMethod);

char* secureblackbox_samlspserver_getsigcanonicalizationmethod(void* lpObj);
int secureblackbox_samlspserver_setsigcanonicalizationmethod(void* lpObj, const char* lpszSigCanonicalizationMethod);

QString GetSigCanonicalizationMethod();
int SetSigCanonicalizationMethod(QString qsSigCanonicalizationMethod);

Default Value

""

Remarks

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

Data Type

String

SigDigestMethod Property (SAMLSPServer Class)

The digest method to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigDigestMethod();
int SetSigDigestMethod(const char* lpszSigDigestMethod);

Unicode (Windows)
LPWSTR GetSigDigestMethod();
INT SetSigDigestMethod(LPCWSTR lpszSigDigestMethod);

char* secureblackbox_samlspserver_getsigdigestmethod(void* lpObj);
int secureblackbox_samlspserver_setsigdigestmethod(void* lpObj, const char* lpszSigDigestMethod);

QString GetSigDigestMethod();
int SetSigDigestMethod(QString qsSigDigestMethod);

Default Value

""

Remarks

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

Data Type

String

SigMethod Property (SAMLSPServer Class)

The signature method to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigMethod();
int SetSigMethod(const char* lpszSigMethod);

Unicode (Windows)
LPWSTR GetSigMethod();
INT SetSigMethod(LPCWSTR lpszSigMethod);

char* secureblackbox_samlspserver_getsigmethod(void* lpObj);
int secureblackbox_samlspserver_setsigmethod(void* lpObj, const char* lpszSigMethod);

QString GetSigMethod();
int SetSigMethod(QString qsSigMethod);

Default Value

""

Remarks

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

Data Type

String

SignArtifactResolveRequests Property (SAMLSPServer Class)

Specifies whether to sign artifact resolution requests.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignArtifactResolveRequests();
int SetSignArtifactResolveRequests(int bSignArtifactResolveRequests);

Unicode (Windows)
BOOL GetSignArtifactResolveRequests();
INT SetSignArtifactResolveRequests(BOOL bSignArtifactResolveRequests);

int secureblackbox_samlspserver_getsignartifactresolverequests(void* lpObj);
int secureblackbox_samlspserver_setsignartifactresolverequests(void* lpObj, int bSignArtifactResolveRequests);

bool GetSignArtifactResolveRequests();
int SetSignArtifactResolveRequests(bool bSignArtifactResolveRequests);

Default Value

FALSE

Remarks

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

Data Type

Boolean

SignAuthnRequests Property (SAMLSPServer Class)

Specifies whether to sign Authn requests.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignAuthnRequests();
int SetSignAuthnRequests(int bSignAuthnRequests);

Unicode (Windows)
BOOL GetSignAuthnRequests();
INT SetSignAuthnRequests(BOOL bSignAuthnRequests);

int secureblackbox_samlspserver_getsignauthnrequests(void* lpObj);
int secureblackbox_samlspserver_setsignauthnrequests(void* lpObj, int bSignAuthnRequests);

bool GetSignAuthnRequests();
int SetSignAuthnRequests(bool bSignAuthnRequests);

Default Value

FALSE

Remarks

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

Data Type

Boolean

SigningCertBytes Property (SAMLSPServer Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertBytes(char* &lpSigningCertBytes, int &lenSigningCertBytes);

Unicode (Windows)
INT GetSigningCertBytes(LPSTR &lpSigningCertBytes, INT &lenSigningCertBytes);

int secureblackbox_samlspserver_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);

QByteArray GetSigningCertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSigningCertHandle();
int SetSigningCertHandle(int64 lSigningCertHandle);

Unicode (Windows)
LONG64 GetSigningCertHandle();
INT SetSigningCertHandle(LONG64 lSigningCertHandle);

int64 secureblackbox_samlspserver_getsigningcerthandle(void* lpObj);
int secureblackbox_samlspserver_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);

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

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SAMLSPServer Class)

The number of records in the SigningChain arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);

Unicode (Windows)
INT GetSigningChainCount();
INT SetSigningChainCount(INT iSigningChainCount);

int secureblackbox_samlspserver_getsigningchaincount(void* lpObj);
int secureblackbox_samlspserver_setsigningchaincount(void* lpObj, int iSigningChainCount);

int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SAMLSPServer Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningChainBytes(int iSigningChainIndex, char* &lpSigningChainBytes, int &lenSigningChainBytes);

Unicode (Windows)
INT GetSigningChainBytes(INT iSigningChainIndex, LPSTR &lpSigningChainBytes, INT &lenSigningChainBytes);

int secureblackbox_samlspserver_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);

QByteArray GetSigningChainBytes(int iSigningChainIndex);

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

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

Data Type

Byte Array

SigningChainHandle Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, int64 lSigningChainHandle);

Unicode (Windows)
LONG64 GetSigningChainHandle(INT iSigningChainIndex);
INT SetSigningChainHandle(INT iSigningChainIndex, LONG64 lSigningChainHandle);

int64 secureblackbox_samlspserver_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_samlspserver_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);

qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

SignLogoutRequests Property (SAMLSPServer Class)

Specifies whether to sign Logout requests.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignLogoutRequests();
int SetSignLogoutRequests(int bSignLogoutRequests);

Unicode (Windows)
BOOL GetSignLogoutRequests();
INT SetSignLogoutRequests(BOOL bSignLogoutRequests);

int secureblackbox_samlspserver_getsignlogoutrequests(void* lpObj);
int secureblackbox_samlspserver_setsignlogoutrequests(void* lpObj, int bSignLogoutRequests);

bool GetSignLogoutRequests();
int SetSignLogoutRequests(bool bSignLogoutRequests);

Default Value

FALSE

Remarks

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

Data Type

Boolean

SignMetadata Property (SAMLSPServer Class)

Specifies whether to sign the metadata.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignMetadata();
int SetSignMetadata(int bSignMetadata);

Unicode (Windows)
BOOL GetSignMetadata();
INT SetSignMetadata(BOOL bSignMetadata);

int secureblackbox_samlspserver_getsignmetadata(void* lpObj);
int secureblackbox_samlspserver_setsignmetadata(void* lpObj, int bSignMetadata);

bool GetSignMetadata();
int SetSignMetadata(bool bSignMetadata);

Default Value

FALSE

Remarks

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

Data Type

Boolean

SingleLogoutService Property (SAMLSPServer Class)

The URL of the single logout service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSingleLogoutService();
int SetSingleLogoutService(const char* lpszSingleLogoutService);

Unicode (Windows)
LPWSTR GetSingleLogoutService();
INT SetSingleLogoutService(LPCWSTR lpszSingleLogoutService);

char* secureblackbox_samlspserver_getsinglelogoutservice(void* lpObj);
int secureblackbox_samlspserver_setsinglelogoutservice(void* lpObj, const char* lpszSingleLogoutService);

QString GetSingleLogoutService();
int SetSingleLogoutService(QString qsSingleLogoutService);

Default Value

"/sp/SingleLogoutService"

Remarks

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

Data Type

String

SingleLogoutServiceBindings Property (SAMLSPServer Class)

Defines single logout service bindings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSingleLogoutServiceBindings();
int SetSingleLogoutServiceBindings(const char* lpszSingleLogoutServiceBindings);

Unicode (Windows)
LPWSTR GetSingleLogoutServiceBindings();
INT SetSingleLogoutServiceBindings(LPCWSTR lpszSingleLogoutServiceBindings);

char* secureblackbox_samlspserver_getsinglelogoutservicebindings(void* lpObj);
int secureblackbox_samlspserver_setsinglelogoutservicebindings(void* lpObj, const char* lpszSingleLogoutServiceBindings);

QString GetSingleLogoutServiceBindings();
int SetSingleLogoutServiceBindings(QString qsSingleLogoutServiceBindings);

Default Value

"+Artifact,+POST,+Redirect"

Remarks

Use this property to specify the single logout service bindings.

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

Data Type

String

SocketIncomingSpeedLimit Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Unicode (Windows)
INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);

int secureblackbox_samlspserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_samlspserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SAMLSPServer Class)

The local network interface to bind the socket to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress);

Unicode (Windows)
LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);

char* secureblackbox_samlspserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_samlspserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SAMLSPServer Class)

The local port number to bind the socket to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Unicode (Windows)
INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);

int secureblackbox_samlspserver_getsocketlocalport(void* lpObj);
int secureblackbox_samlspserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);

int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Unicode (Windows)
INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);

int secureblackbox_samlspserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_samlspserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SAMLSPServer Class)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Unicode (Windows)
INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);

int secureblackbox_samlspserver_getsockettimeout(void* lpObj);
int secureblackbox_samlspserver_setsockettimeout(void* lpObj, int iSocketTimeout);

int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (SAMLSPServer Class)

Enables or disables IP protocol version 6.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6);

Unicode (Windows)
BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);

int secureblackbox_samlspserver_getsocketuseipv6(void* lpObj);
int secureblackbox_samlspserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SPToIDPBinding Property (SAMLSPServer Class)

Specifies the IdP to SP binding to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSPToIDPBinding();
int SetSPToIDPBinding(int iSPToIDPBinding);

Unicode (Windows)
INT GetSPToIDPBinding();
INT SetSPToIDPBinding(INT iSPToIDPBinding);

CSBT_NONE(0), 
CSBT_SOAP(1), 
CSBT_PAOS(2), 
CSBT_REDIRECT(3), 
CSBT_POST(4), 
CSBT_ARTIFACT(5)

int secureblackbox_samlspserver_getsptoidpbinding(void* lpObj);
int secureblackbox_samlspserver_setsptoidpbinding(void* lpObj, int iSPToIDPBinding);

int GetSPToIDPBinding();
int SetSPToIDPBinding(int iSPToIDPBinding);

Default Value

3

Remarks

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

To specify the preferred binding, use PreferredIDPToSPBinding.

Data Type

Integer

TLSAutoValidateCertificates Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(int bTLSAutoValidateCertificates);

Unicode (Windows)
BOOL GetTLSAutoValidateCertificates();
INT SetTLSAutoValidateCertificates(BOOL bTLSAutoValidateCertificates);

int secureblackbox_samlspserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_samlspserver_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);

Default Value

TRUE

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (SAMLSPServer Class)

Selects the base configuration for the TLS settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Unicode (Windows)
INT GetTLSBaseConfiguration();
INT SetTLSBaseConfiguration(INT iTLSBaseConfiguration);

STPC_DEFAULT(0), 
STPC_COMPATIBLE(1), 
STPC_COMPREHENSIVE_INSECURE(2), 
STPC_HIGHLY_SECURE(3)

int secureblackbox_samlspserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_samlspserver_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (SAMLSPServer Class)

A list of ciphersuites separated with commas or semicolons.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSCiphersuites();
int SetTLSCiphersuites(const char* lpszTLSCiphersuites);

Unicode (Windows)
LPWSTR GetTLSCiphersuites();
INT SetTLSCiphersuites(LPCWSTR lpszTLSCiphersuites);

char* secureblackbox_samlspserver_gettlsciphersuites(void* lpObj);
int secureblackbox_samlspserver_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);

Default Value

""

Remarks

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

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSECCurves Property (SAMLSPServer Class)

Defines the elliptic curves to enable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSECCurves();
int SetTLSECCurves(const char* lpszTLSECCurves);

Unicode (Windows)
LPWSTR GetTLSECCurves();
INT SetTLSECCurves(LPCWSTR lpszTLSECCurves);

char* secureblackbox_samlspserver_gettlseccurves(void* lpObj);
int secureblackbox_samlspserver_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SAMLSPServer Class)

Provides access to TLS extensions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSExtensions();
int SetTLSExtensions(const char* lpszTLSExtensions);

Unicode (Windows)
LPWSTR GetTLSExtensions();
INT SetTLSExtensions(LPCWSTR lpszTLSExtensions);

char* secureblackbox_samlspserver_gettlsextensions(void* lpObj);
int secureblackbox_samlspserver_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(int bTLSForceResumeIfDestinationChanges);

Unicode (Windows)
BOOL GetTLSForceResumeIfDestinationChanges();
INT SetTLSForceResumeIfDestinationChanges(BOOL bTLSForceResumeIfDestinationChanges);

int secureblackbox_samlspserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_samlspserver_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(const char* lpszTLSPreSharedIdentity);

Unicode (Windows)
LPWSTR GetTLSPreSharedIdentity();
INT SetTLSPreSharedIdentity(LPCWSTR lpszTLSPreSharedIdentity);

char* secureblackbox_samlspserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_samlspserver_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedKey();
int SetTLSPreSharedKey(const char* lpszTLSPreSharedKey);

Unicode (Windows)
LPWSTR GetTLSPreSharedKey();
INT SetTLSPreSharedKey(LPCWSTR lpszTLSPreSharedKey);

char* secureblackbox_samlspserver_gettlspresharedkey(void* lpObj);
int secureblackbox_samlspserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(const char* lpszTLSPreSharedKeyCiphersuite);

Unicode (Windows)
LPWSTR GetTLSPreSharedKeyCiphersuite();
INT SetTLSPreSharedKeyCiphersuite(LPCWSTR lpszTLSPreSharedKeyCiphersuite);

char* secureblackbox_samlspserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_samlspserver_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);

Default Value

""

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SAMLSPServer Class)

Selects the renegotiation attack prevention mechanism.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Unicode (Windows)
INT GetTLSRenegotiationAttackPreventionMode();
INT SetTLSRenegotiationAttackPreventionMode(INT iTLSRenegotiationAttackPreventionMode);

CRAPM_COMPATIBLE(0), 
CRAPM_STRICT(1), 
CRAPM_AUTO(2)

int secureblackbox_samlspserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_samlspserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Unicode (Windows)
INT GetTLSRevocationCheck();
INT SetTLSRevocationCheck(INT iTLSRevocationCheck);

CRC_NONE(0), 
CRC_AUTO(1), 
CRC_ALL_CRL(2), 
CRC_ALL_OCSP(3), 
CRC_ALL_CRLAND_OCSP(4), 
CRC_ANY_CRL(5), 
CRC_ANY_OCSP(6), 
CRC_ANY_CRLOR_OCSP(7), 
CRC_ANY_OCSPOR_CRL(8)

int secureblackbox_samlspserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_samlspserver_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Default Value

1

Remarks

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

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

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

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SAMLSPServer Class)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Unicode (Windows)
INT GetTLSSSLOptions();
INT SetTLSSSLOptions(INT iTLSSSLOptions);

int secureblackbox_samlspserver_gettlsssloptions(void* lpObj);
int secureblackbox_samlspserver_settlsssloptions(void* lpObj, int iTLSSSLOptions);

int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SAMLSPServer Class)

Specifies the TLS mode to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Unicode (Windows)
INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);

SM_DEFAULT(0), 
SM_NO_TLS(1), 
SM_EXPLICIT_TLS(2), 
SM_IMPLICIT_TLS(3), 
SM_MIXED_TLS(4)

int secureblackbox_samlspserver_gettlstlsmode(void* lpObj);
int secureblackbox_samlspserver_settlstlsmode(void* lpObj, int iTLSTLSMode);

int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret);

Unicode (Windows)
BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);

int secureblackbox_samlspserver_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_samlspserver_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SAMLSPServer Class)

Enables or disables the TLS session resumption capability.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption);

Unicode (Windows)
BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);

int secureblackbox_samlspserver_gettlsusesessionresumption(void* lpObj);
int secureblackbox_samlspserver_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);

Default Value

FALSE

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SAMLSPServer Class)

The SSL/TLS versions to enable by default.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Unicode (Windows)
INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);

int secureblackbox_samlspserver_gettlsversions(void* lpObj);
int secureblackbox_samlspserver_settlsversions(void* lpObj, int iTLSVersions);

int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

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

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.

GetClientBuffer Method (SAMLSPServer Class)

Obtains a pending connection buffer.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPSTR GetClientBuffer(LONG64 lConnectionID, LPINT lpSize = NULL);

char* secureblackbox_samlspserver_getclientbuffer(void* lpObj, int64 lConnectionID, int *lpSize);

QByteArray GetClientBuffer(qint64 lConnectionID);

Remarks

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

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.

LoadIDPMetadata Method (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadIDPMetadata(const char* lpszFileName);

Unicode (Windows)
INT LoadIDPMetadata(LPCWSTR lpszFileName);

int secureblackbox_samlspserver_loadidpmetadata(void* lpObj, const char* lpszFileName);

int LoadIDPMetadata(const QString& qsFileName);

Remarks

The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP.

FileName specifies the metadata file name.

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

LoadIDPMetadataFromStream Method (SAMLSPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadIDPMetadataFromStream(SecureBlackboxStream* sStream);

Unicode (Windows)
INT LoadIDPMetadataFromStream(SecureBlackboxStream* sStream);

int secureblackbox_samlspserver_loadidpmetadatafromstream(void* lpObj, SecureBlackboxStream* sStream);

int LoadIDPMetadataFromStream(SecureBlackboxStream* sStream);

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 as XML metadata. Use this method to load the metadata generated by the IdP from a stream.

Stream contains the metadata.

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

ProcessGenericRequest Method (SAMLSPServer Class)

Processes a generic HTTP SAML request.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPSTR ProcessGenericRequest(LPCSTR lpRequest, INT lenRequest, LPINT lpSize = NULL);

char* secureblackbox_samlspserver_processgenericrequest(void* lpObj, const char* lpRequest, int lenRequest, int *lpSize);

QByteArray ProcessGenericRequest(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 returned value contains a full HTTP response that should be supplied back to the requestor. You can edit some parts of the response (for example, by adding some custom HTTP headers).

You can use this method with or without the OfflineMode.

Error Handling (C++)

This method returns a Binary String 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.

SaveMetadata Method (SAMLSPServer Class)

Saves the SP configuration to a metadata file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveMetadata(const char* lpszFileName);

Unicode (Windows)
INT SaveMetadata(LPCWSTR lpszFileName);

int secureblackbox_samlspserver_savemetadata(void* lpObj, const char* lpszFileName);

int SaveMetadata(const QString& qsFileName);

Remarks

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

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

SaveMetadataToStream Method (SAMLSPServer Class)

Saves the SP configuration to a metadata file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveMetadataToStream(SecureBlackboxStream* sStream);

Unicode (Windows)
INT SaveMetadataToStream(SecureBlackboxStream* sStream);

int secureblackbox_samlspserver_savemetadatatostream(void* lpObj, SecureBlackboxStream* sStream);

int SaveMetadataToStream(SecureBlackboxStream* sStream);

Remarks

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

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