SAMLIdPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLIdPServer class represents a SAML identity provider.

Syntax

SAMLIdPServer

Remarks

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

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

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 (SAMLIdPServer 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_samlidpserver_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

AllowIDPSSO Property (SAMLIdPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAllowIDPSSO();
int SetAllowIDPSSO(int bAllowIDPSSO);

Unicode (Windows)
BOOL GetAllowIDPSSO();
INT SetAllowIDPSSO(BOOL bAllowIDPSSO);

int secureblackbox_samlidpserver_getallowidpsso(void* lpObj);
int secureblackbox_samlidpserver_setallowidpsso(void* lpObj, int bAllowIDPSSO);

bool GetAllowIDPSSO();
int SetAllowIDPSSO(bool bAllowIDPSSO);

Default Value

FALSE

Remarks

Set this property to true to allow IdP-initiated Single Sign-Ons. Use AddIdPSSOLink method to add sign-on URLs.

Data Type

Boolean

ArtifactResolutionService Property (SAMLIdPServer 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_samlidpserver_getartifactresolutionservice(void* lpObj);
int secureblackbox_samlidpserver_setartifactresolutionservice(void* lpObj, const char* lpszArtifactResolutionService);

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

Default Value

"/idp/ArtifactResolutionService"

Remarks

Use this property to specify the location of the artifact resolution service of this Identity Provider (IdP).

Data Type

String

AttributeQueryService Property (SAMLIdPServer Class)

The location of the AttributeQuery service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttributeQueryService();
int SetAttributeQueryService(const char* lpszAttributeQueryService);

Unicode (Windows)
LPWSTR GetAttributeQueryService();
INT SetAttributeQueryService(LPCWSTR lpszAttributeQueryService);

char* secureblackbox_samlidpserver_getattributequeryservice(void* lpObj);
int secureblackbox_samlidpserver_setattributequeryservice(void* lpObj, const char* lpszAttributeQueryService);

QString GetAttributeQueryService();
int SetAttributeQueryService(QString qsAttributeQueryService);

Default Value

"/idp/AttributeQueryService"

Remarks

Use this property to specify the relative URL of the AttributeQuery service provided by this Identity Provider (IdP).

Data Type

String

AuthFormTemplate Property (SAMLIdPServer Class)

Defines the default authentication template (login page).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthFormTemplate();
int SetAuthFormTemplate(const char* lpszAuthFormTemplate);

Unicode (Windows)
LPWSTR GetAuthFormTemplate();
INT SetAuthFormTemplate(LPCWSTR lpszAuthFormTemplate);

char* secureblackbox_samlidpserver_getauthformtemplate(void* lpObj);
int secureblackbox_samlidpserver_setauthformtemplate(void* lpObj, const char* lpszAuthFormTemplate);

QString GetAuthFormTemplate();
int SetAuthFormTemplate(QString qsAuthFormTemplate);

Default Value

""

Remarks

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

Data Type

String

ClientAuth Property (SAMLIdPServer 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_samlidpserver_getclientauth(void* lpObj);
int secureblackbox_samlidpserver_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

EncryptAssertions Property (SAMLIdPServer Class)

Specifies whether to encrypt assertions included into the IdP response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptAssertions();
int SetEncryptAssertions(int bEncryptAssertions);

Unicode (Windows)
BOOL GetEncryptAssertions();
INT SetEncryptAssertions(BOOL bEncryptAssertions);

int secureblackbox_samlidpserver_getencryptassertions(void* lpObj);
int secureblackbox_samlidpserver_setencryptassertions(void* lpObj, int bEncryptAssertions);

bool GetEncryptAssertions();
int SetEncryptAssertions(bool bEncryptAssertions);

Default Value

FALSE

Remarks

Set this property to True to force the class to encrypt the assertions included into the server's response.

Data Type

Boolean

EncryptionCertBytes Property (SAMLIdPServer Class)

Returns 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_samlidpserver_getencryptioncertbytes(void* lpObj, char** lpEncryptionCertBytes, int* lenEncryptionCertBytes);

QByteArray GetEncryptionCertBytes();

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

EncryptionCertHandle Property (SAMLIdPServer 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_samlidpserver_getencryptioncerthandle(void* lpObj);
int secureblackbox_samlidpserver_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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

ErrorOrigin Property (SAMLIdPServer 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_samlidpserver_geterrororigin(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_geterrorseverity(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_samlidpserver_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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SAMLIdPServer 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_samlidpserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getexternalcryptodata(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_samlidpserver_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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SAMLIdPServer 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_samlidpserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_samlidpserver_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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

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

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

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SAMLIdPServer 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_samlidpserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getexternalcryptomode(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Provide 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_samlidpserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (SAMLIdPServer 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_samlidpserver_getfipsmode(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Specifies the host address of the IdP 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_samlidpserver_gethost(void* lpObj);
int secureblackbox_samlidpserver_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

IDPSSOPage Property (SAMLIdPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIDPSSOPage();
int SetIDPSSOPage(const char* lpszIDPSSOPage);

Unicode (Windows)
LPWSTR GetIDPSSOPage();
INT SetIDPSSOPage(LPCWSTR lpszIDPSSOPage);

char* secureblackbox_samlidpserver_getidpssopage(void* lpObj);
int secureblackbox_samlidpserver_setidpssopage(void* lpObj, const char* lpszIDPSSOPage);

QString GetIDPSSOPage();
int SetIDPSSOPage(QString qsIDPSSOPage);

Default Value

"/idpsso"

Remarks

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

Data Type

String

IDPSSOPageContent Property (SAMLIdPServer Class)

The content of the IdP-initiated SSO page.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIDPSSOPageContent();
int SetIDPSSOPageContent(const char* lpszIDPSSOPageContent);

Unicode (Windows)
LPWSTR GetIDPSSOPageContent();
INT SetIDPSSOPageContent(LPCWSTR lpszIDPSSOPageContent);

char* secureblackbox_samlidpserver_getidpssopagecontent(void* lpObj);
int secureblackbox_samlidpserver_setidpssopagecontent(void* lpObj, const char* lpszIDPSSOPageContent);

QString GetIDPSSOPageContent();
int SetIDPSSOPageContent(QString qsIDPSSOPageContent);

Default Value

""

Remarks

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

Data Type

String

LoginAttemptsLimit Property (SAMLIdPServer Class)

The maximum number of login attempts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLoginAttemptsLimit();
int SetLoginAttemptsLimit(int iLoginAttemptsLimit);

Unicode (Windows)
INT GetLoginAttemptsLimit();
INT SetLoginAttemptsLimit(INT iLoginAttemptsLimit);

int secureblackbox_samlidpserver_getloginattemptslimit(void* lpObj);
int secureblackbox_samlidpserver_setloginattemptslimit(void* lpObj, int iLoginAttemptsLimit);

int GetLoginAttemptsLimit();
int SetLoginAttemptsLimit(int iLoginAttemptsLimit);

Default Value

3

Remarks

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

Data Type

Integer

MetadataURL Property (SAMLIdPServer Class)

The IdP'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_samlidpserver_getmetadataurl(void* lpObj);
int secureblackbox_samlidpserver_setmetadataurl(void* lpObj, const char* lpszMetadataURL);

QString GetMetadataURL();
int SetMetadataURL(QString qsMetadataURL);

Default Value

"/idp/metadata"

Remarks

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

Data Type

String

MetaSigningCertBytes Property (SAMLIdPServer Class)

Returns 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_samlidpserver_getmetasigningcertbytes(void* lpObj, char** lpMetaSigningCertBytes, int* lenMetaSigningCertBytes);

QByteArray GetMetaSigningCertBytes();

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

MetaSigningCertHandle Property (SAMLIdPServer 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_samlidpserver_getmetasigningcerthandle(void* lpObj);
int secureblackbox_samlidpserver_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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

OfflineMode Property (SAMLIdPServer 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_samlidpserver_getofflinemode(void* lpObj);
int secureblackbox_samlidpserver_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 requests.

Data Type

Boolean

Port Property (SAMLIdPServer Class)

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_samlidpserver_getport(void* lpObj);
int secureblackbox_samlidpserver_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 IdP server should listen for incoming connections. To specify server's IP address use Host.

Data Type

Integer

PreferredSingleLogoutResponseBinding Property (SAMLIdPServer Class)

Specifies the preferred single logout response binding.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPreferredSingleLogoutResponseBinding();
int SetPreferredSingleLogoutResponseBinding(int iPreferredSingleLogoutResponseBinding);

Unicode (Windows)
INT GetPreferredSingleLogoutResponseBinding();
INT SetPreferredSingleLogoutResponseBinding(INT iPreferredSingleLogoutResponseBinding);

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

int secureblackbox_samlidpserver_getpreferredsinglelogoutresponsebinding(void* lpObj);
int secureblackbox_samlidpserver_setpreferredsinglelogoutresponsebinding(void* lpObj, int iPreferredSingleLogoutResponseBinding);

int GetPreferredSingleLogoutResponseBinding();
int SetPreferredSingleLogoutResponseBinding(int iPreferredSingleLogoutResponseBinding);

Default Value

3

Remarks

This value is used by the Identity Provider (IdP) when the default binding is not specified in Service Provider's (SP) metadata file.

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

Data Type

Integer

PreferredSingleSignOnResponseBinding Property (SAMLIdPServer Class)

Specifies preferred SSO response binding.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPreferredSingleSignOnResponseBinding();
int SetPreferredSingleSignOnResponseBinding(int iPreferredSingleSignOnResponseBinding);

Unicode (Windows)
INT GetPreferredSingleSignOnResponseBinding();
INT SetPreferredSingleSignOnResponseBinding(INT iPreferredSingleSignOnResponseBinding);

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

int secureblackbox_samlidpserver_getpreferredsinglesignonresponsebinding(void* lpObj);
int secureblackbox_samlidpserver_setpreferredsinglesignonresponsebinding(void* lpObj, int iPreferredSingleSignOnResponseBinding);

int GetPreferredSingleSignOnResponseBinding();
int SetPreferredSingleSignOnResponseBinding(int iPreferredSingleSignOnResponseBinding);

Default Value

4

Remarks

This value is used by the Identity Provider (IdP) when the default binding is not specified in Service Provider's (SP) metadata file.

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

Data Type

Integer

ServerCertCount Property (SAMLIdPServer 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_samlidpserver_getservercertcount(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Returns 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_samlidpserver_getservercertbytes(void* lpObj, int servercertindex, char** lpServerCertBytes, int* lenServerCertBytes);

QByteArray GetServerCertBytes(int iServerCertIndex);

Remarks

Returns 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 (SAMLIdPServer 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_samlidpserver_getservercerthandle(void* lpObj, int servercertindex);
int secureblackbox_samlidpserver_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. 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 (SAMLIdPServer 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_samlidpserver_getsigcanonicalizationmethod(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getsigdigestmethod(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getsigmethod(void* lpObj);
int secureblackbox_samlidpserver_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

SignAssertions Property (SAMLIdPServer Class)

Specifies whether the assertions included in IdP responses should be signed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignAssertions();
int SetSignAssertions(int bSignAssertions);

Unicode (Windows)
BOOL GetSignAssertions();
INT SetSignAssertions(BOOL bSignAssertions);

int secureblackbox_samlidpserver_getsignassertions(void* lpObj);
int secureblackbox_samlidpserver_setsignassertions(void* lpObj, int bSignAssertions);

bool GetSignAssertions();
int SetSignAssertions(bool bSignAssertions);

Default Value

FALSE

Remarks

Set this property to True to automatically sign the assertions included into the Identity Provider (IdP) responses.

Data Type

Boolean

SigningCertBytes Property (SAMLIdPServer Class)

Returns 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_samlidpserver_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);

QByteArray GetSigningCertBytes();

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (SAMLIdPServer 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_samlidpserver_getsigningcerthandle(void* lpObj);
int secureblackbox_samlidpserver_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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SAMLIdPServer 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_samlidpserver_getsigningchaincount(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Returns 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_samlidpserver_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);

QByteArray GetSigningChainBytes(int iSigningChainIndex);

Remarks

Returns raw certificate data in DER format.

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

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

Data Type

Byte Array

SigningChainHandle Property (SAMLIdPServer 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_samlidpserver_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_samlidpserver_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. 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

SignMetadata Property (SAMLIdPServer Class)

Specifies whether the IdP's metadata should be signed.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_samlidpserver_getsignmetadata(void* lpObj);
int secureblackbox_samlidpserver_setsignmetadata(void* lpObj, int bSignMetadata);

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

Default Value

FALSE

Remarks

Set this property to True to sign the Identity Provider's (IdP) metadata before saving it. Do not forget to assign the signing certificate to the MetaSigningCertificate property.

Data Type

Boolean

SignResponse Property (SAMLIdPServer Class)

Specifies whether the IdP responses should be signed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignResponse();
int SetSignResponse(int bSignResponse);

Unicode (Windows)
BOOL GetSignResponse();
INT SetSignResponse(BOOL bSignResponse);

int secureblackbox_samlidpserver_getsignresponse(void* lpObj);
int secureblackbox_samlidpserver_setsignresponse(void* lpObj, int bSignResponse);

bool GetSignResponse();
int SetSignResponse(bool bSignResponse);

Default Value

FALSE

Remarks

Set this property to True to automatically sign the responses sent by this IdP server.

Data Type

Boolean

SingleLogoutService Property (SAMLIdPServer 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_samlidpserver_getsinglelogoutservice(void* lpObj);
int secureblackbox_samlidpserver_setsinglelogoutservice(void* lpObj, const char* lpszSingleLogoutService);

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

Default Value

"/idp/SingleLogoutService"

Remarks

This property specifies the relative URL of the single logout service.

Data Type

String

SingleLogoutServiceBindings Property (SAMLIdPServer 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_samlidpserver_getsinglelogoutservicebindings(void* lpObj);
int secureblackbox_samlidpserver_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

SingleSignOnService Property (SAMLIdPServer Class)

The URL of the single logout service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSingleSignOnService();
int SetSingleSignOnService(const char* lpszSingleSignOnService);

Unicode (Windows)
LPWSTR GetSingleSignOnService();
INT SetSingleSignOnService(LPCWSTR lpszSingleSignOnService);

char* secureblackbox_samlidpserver_getsinglesignonservice(void* lpObj);
int secureblackbox_samlidpserver_setsinglesignonservice(void* lpObj, const char* lpszSingleSignOnService);

QString GetSingleSignOnService();
int SetSingleSignOnService(QString qsSingleSignOnService);

Default Value

"/idp/SingleSignOnService"

Remarks

This property specifies the relative URL of the single logout (SSO) service.

Data Type

String

SingleSignOnServiceBindings Property (SAMLIdPServer Class)

Defines single sign-on service bindings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSingleSignOnServiceBindings();
int SetSingleSignOnServiceBindings(const char* lpszSingleSignOnServiceBindings);

Unicode (Windows)
LPWSTR GetSingleSignOnServiceBindings();
INT SetSingleSignOnServiceBindings(LPCWSTR lpszSingleSignOnServiceBindings);

char* secureblackbox_samlidpserver_getsinglesignonservicebindings(void* lpObj);
int secureblackbox_samlidpserver_setsinglesignonservicebindings(void* lpObj, const char* lpszSingleSignOnServiceBindings);

QString GetSingleSignOnServiceBindings();
int SetSingleSignOnServiceBindings(QString qsSingleSignOnServiceBindings);

Default Value

"+Artifact,+POST,+Redirect"

Remarks

Use this property to specify the single sign-on service bindings.

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

Data Type

String

SocketIncomingSpeedLimit Property (SAMLIdPServer 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_samlidpserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getsocketlocalport(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getsockettimeout(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_getsocketuseipv6(void* lpObj);
int secureblackbox_samlidpserver_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

TLSAutoValidateCertificates Property (SAMLIdPServer 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_samlidpserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_samlidpserver_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 on offer, tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (SAMLIdPServer 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_samlidpserver_gettlsciphersuites(void* lpObj);
int secureblackbox_samlidpserver_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 that allow to blanketly enable or disable all ciphersuites at once.

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

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

Data Type

String

TLSECCurves Property (SAMLIdPServer 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_samlidpserver_gettlseccurves(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_gettlsextensions(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Contains the pre-shared 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_samlidpserver_gettlspresharedkey(void* lpObj);
int secureblackbox_samlidpserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SAMLIdPServer 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_samlidpserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Selects 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_samlidpserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_samlidpserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

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

Default Value

0

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SAMLIdPServer 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_samlidpserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_samlidpserver_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. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SAMLIdPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_samlidpserver_gettlsssloptions(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_gettlstlsmode(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Enables 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_samlidpserver_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_samlidpserver_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SAMLIdPServer Class)

Enables or disables 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_samlidpserver_gettlsusesessionresumption(void* lpObj);
int secureblackbox_samlidpserver_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

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

Default Value

FALSE

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SAMLIdPServer 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_samlidpserver_gettlsversions(void* lpObj);
int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Specifies the base URL of this IdP 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_samlidpserver_geturl(void* lpObj);
int secureblackbox_samlidpserver_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 Identity Provider (IdP) server.

Data Type

String

AddIdPSSOLink Method (SAMLIdPServer Class)

Adds an SSO URL to the list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddIdPSSOLink(int iSPIndex, const char* lpszURL, const char* lpszRelayState);

Unicode (Windows)
INT AddIdPSSOLink(INT iSPIndex, LPCWSTR lpszURL, LPCWSTR lpszRelayState);

int secureblackbox_samlidpserver_addidpssolink(void* lpObj, int iSPIndex, const char* lpszURL, const char* lpszRelayState);

int AddIdPSSOLink(int iSPIndex, const QString& qsURL, const QString& qsRelayState);

Remarks

Use this method to add a new single sign-on (SSO) link. The method returns the index of the new link in the internal list of SSO links.

SPIndex specifies the index of the service provider configuration, URL contains the relative URL for the SSO, and RelayState contains the value of the corresponding SAML parameter.

According to SAML 2.0 specification, the RelayState parameter may be used by the SAML binding in order to convey and preserve state information. If this parameter is present in a SAML request message, the responding party must include the same exact parameter into the response to this request.

In many applications, when using IdP-initiated single sign-on, the IdP uses RelayState to indicate to the SP the URL to which it should redirect after the successful sign-on.

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.

AddUser Method (SAMLIdPServer Class)

Registers known user credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddUser(const char* lpszLogin, const char* lpszPassword);

Unicode (Windows)
INT AddUser(LPCWSTR lpszLogin, LPCWSTR lpszPassword);

int secureblackbox_samlidpserver_adduser(void* lpObj, const char* lpszLogin, const char* lpszPassword);

int AddUser(const QString& qsLogin, const QString& qsPassword);

Remarks

Call this method to register a pair of known user's credentials with the server.

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

AddUserWithEmail Method (SAMLIdPServer Class)

Registers known user credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddUserWithEmail(const char* lpszLogin, const char* lpszEmail, const char* lpszPassword);

Unicode (Windows)
INT AddUserWithEmail(LPCWSTR lpszLogin, LPCWSTR lpszEmail, LPCWSTR lpszPassword);

int secureblackbox_samlidpserver_adduserwithemail(void* lpObj, const char* lpszLogin, const char* lpszEmail, const char* lpszPassword);

int AddUserWithEmail(const QString& qsLogin, const QString& qsEmail, const QString& qsPassword);

Remarks

Call this method to register known user's credentials with the server. In addition to Login and Password this method also associates an Email address with this user.

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

ClearUsers Method (SAMLIdPServer Class)

Clears the database of registered users.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ClearUsers();

Unicode (Windows)
INT ClearUsers();

int secureblackbox_samlidpserver_clearusers(void* lpObj);

int ClearUsers();

Remarks

Use this method to remove all stored user credential details.

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 (SAMLIdPServer 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_samlidpserver_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 (SAMLIdPServer 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_samlidpserver_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 insencitive) of the action is provided in the ActionID parameter.

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

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.

GetProviderProperty Method (SAMLIdPServer 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_samlidpserver_getproviderproperty(void* lpObj, const char* lpszName);

QString GetProviderProperty(const QString& qsName);

Remarks

This method, together with SetProviderProperty, provides an extensible way of managing the Identity Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

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.

LoadSPMetadata Method (SAMLIdPServer Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT LoadSPMetadata(LPCWSTR lpszFileName);

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

int LoadSPMetadata(const QString& qsFileName);

Remarks

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

FileName specifies the metadata file name.

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 (SAMLIdPServer 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_samlidpserver_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.

RemoveIdPSSOLink Method (SAMLIdPServer Class)

Removes the specified SSO link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveIdPSSOLink(int iIndex);

Unicode (Windows)
INT RemoveIdPSSOLink(INT iIndex);

int secureblackbox_samlidpserver_removeidpssolink(void* lpObj, int iIndex);

int RemoveIdPSSOLink(int iIndex);

Remarks

Multiple URLs may be used on an IdP to initiate the single sign-on (SSO) session. You can add new links using AddIdPSSOLink, and remove ones that are no longer needed with RemoveIdPSSOLink.

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

RemoveSP Method (SAMLIdPServer Class)

Removes an SP from the list of trusted service providers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveSP(int iIndex);

Unicode (Windows)
INT RemoveSP(INT iIndex);

int secureblackbox_samlidpserver_removesp(void* lpObj, int iIndex);

int RemoveSP(int iIndex);

Remarks

Use this method to remove information about a service provider from the server.

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

RemoveUser Method (SAMLIdPServer Class)

Unregister user credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveUser(const char* lpszLogin);

Unicode (Windows)
INT RemoveUser(LPCWSTR lpszLogin);

int secureblackbox_samlidpserver_removeuser(void* lpObj, const char* lpszLogin);

int RemoveUser(const QString& qsLogin);

Remarks

Use this method to 'forget' the credentials of the user specified by the Login.

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

SaveMetadata Method (SAMLIdPServer Class)

Saves the IdP 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_samlidpserver_savemetadata(void* lpObj, const char* lpszFileName);

int SaveMetadata(const QString& qsFileName);

Remarks

Use this method to save the Identity Provider (IdP) configuration in the form of XML metadata in the file specified by FileName. This file may be transferred to service providers (SP) 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 (SAMLIdPServer Class)

Saves the IdP configuration to a metadata file.

Syntax

• C++
• C
• Qt

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

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

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

int SaveMetadataToStream(SecureBlackboxStream* sStream);

Remarks

Use this method to save the Identity Provider (IdP) configuration in the form of XML metadata into the Stream. This metadata may be transferred to service providers (SP) 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.)

SetProviderProperty Method (SAMLIdPServer 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_samlidpserver_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 Identity Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

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

Starts the IdP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Start();

Unicode (Windows)
INT Start();

int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Stops the IdP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Stop();

Unicode (Windows)
INT Stop();

int secureblackbox_samlidpserver_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 (SAMLIdPServer Class)

Reports an incoming connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAccept(SAMLIdPServerAcceptEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  int Accept;
  int reserved;
} SAMLIdPServerAcceptEventParams;


Unicode (Windows)
virtual INT FireAccept(SAMLIdPServerAcceptEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  BOOL Accept;
  INT reserved;
} SAMLIdPServerAcceptEventParams;

#define EID_SAMLIDPSERVER_ACCEPT 1

virtual INT SECUREBLACKBOX_CALL FireAccept(LPSTR &lpszRemoteAddress, INT &iRemotePort, BOOL &bAccept);

class SAMLIdPServerAcceptEventParams {
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(SAMLIdPServerAcceptEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireAccept(SAMLIdPServerAcceptEventParams *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.

AssertionCreated Event (SAMLIdPServer Class)

Notifies the application about the creation of a new assertion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAssertionCreated(SAMLIdPServerAssertionCreatedEventParams *e);

typedef struct {
  int64 ConnectionID;
  int AssertionOrigin;
  const char *AssertionType;
  char *Content;
  int reserved;
} SAMLIdPServerAssertionCreatedEventParams;


Unicode (Windows)
virtual INT FireAssertionCreated(SAMLIdPServerAssertionCreatedEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  INT AssertionOrigin;
  LPCWSTR AssertionType;
  LPWSTR Content;
  INT reserved;
} SAMLIdPServerAssertionCreatedEventParams;

#define EID_SAMLIDPSERVER_ASSERTIONCREATED 2

virtual INT SECUREBLACKBOX_CALL FireAssertionCreated(LONG64 &lConnectionID, INT &iAssertionOrigin, LPSTR &lpszAssertionType, LPSTR &lpszContent);

class SAMLIdPServerAssertionCreatedEventParams {
public:
  qint64 ConnectionID();

  int AssertionOrigin();

  const QString &AssertionType();

  const QString &Content();
  void SetContent(const QString &qsContent);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AssertionCreated(SAMLIdPServerAssertionCreatedEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireAssertionCreated(SAMLIdPServerAssertionCreatedEventParams *e) {...}

Remarks

Use this event to track the creation of a new SAML assertion (upon request from the browser or the SP).

The ConnectionID identifies the connection that requested the assertion. AssertionOrigin and AssertionType specify the type of assertion that was prepared and its disposition, and Content contains the body of the assertion. You can alter the body if required, but please keep in mind that changes may invalidate signed assertions.

AssertionReceived Event (SAMLIdPServer Class)

Notifies the application about the receipt of an assertion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAssertionReceived(SAMLIdPServerAssertionReceivedEventParams *e);

typedef struct {
  int64 ConnectionID;
  int AssertionOrigin;
  char *Content;
  int reserved;
} SAMLIdPServerAssertionReceivedEventParams;


Unicode (Windows)
virtual INT FireAssertionReceived(SAMLIdPServerAssertionReceivedEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  INT AssertionOrigin;
  LPWSTR Content;
  INT reserved;
} SAMLIdPServerAssertionReceivedEventParams;

#define EID_SAMLIDPSERVER_ASSERTIONRECEIVED 3

virtual INT SECUREBLACKBOX_CALL FireAssertionReceived(LONG64 &lConnectionID, INT &iAssertionOrigin, LPSTR &lpszContent);

class SAMLIdPServerAssertionReceivedEventParams {
public:
  qint64 ConnectionID();

  int AssertionOrigin();

  const QString &Content();
  void SetContent(const QString &qsContent);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AssertionReceived(SAMLIdPServerAssertionReceivedEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireAssertionReceived(SAMLIdPServerAssertionReceivedEventParams *e) {...}

Remarks

Use this event to track the receipt of a SAML assertion from the remote party.

The ConnectionID identifies the connection that requested the assertion. AssertionOrigin specifies the disposition of the assertion, and Content contains its body. You can alter the body if required, but please keep in mind that changes may invalidate signed assertions.

Connect Event (SAMLIdPServer Class)

Reports an accepted connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnect(SAMLIdPServerConnectEventParams *e);

typedef struct {
  int64 ConnectionId;
  const char *RemoteAddress;
  int RemotePort;
  int reserved;
} SAMLIdPServerConnectEventParams;


Unicode (Windows)
virtual INT FireConnect(SAMLIdPServerConnectEventParams *e);

typedef struct {
  LONG64 ConnectionId;
  LPCWSTR RemoteAddress;
  INT RemotePort;
  INT reserved;
} SAMLIdPServerConnectEventParams;

#define EID_SAMLIDPSERVER_CONNECT 4

virtual INT SECUREBLACKBOX_CALL FireConnect(LONG64 &lConnectionId, LPSTR &lpszRemoteAddress, INT &iRemotePort);

class SAMLIdPServerConnectEventParams {
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(SAMLIdPServerConnectEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireConnect(SAMLIdPServerConnectEventParams *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 (SAMLIdPServer Class)

Fires to report a disconnected client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnect(SAMLIdPServerDisconnectEventParams *e);

typedef struct {
  int64 ConnectionID;
  int reserved;
} SAMLIdPServerDisconnectEventParams;


Unicode (Windows)
virtual INT FireDisconnect(SAMLIdPServerDisconnectEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  INT reserved;
} SAMLIdPServerDisconnectEventParams;

#define EID_SAMLIDPSERVER_DISCONNECT 5

virtual INT SECUREBLACKBOX_CALL FireDisconnect(LONG64 &lConnectionID);

class SAMLIdPServerDisconnectEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnect(SAMLIdPServerDisconnectEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireDisconnect(SAMLIdPServerDisconnectEventParams *e) {...}

Remarks

The class fires this event when a connected client disconnects.

Error Event (SAMLIdPServer Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SAMLIdPServerErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SAMLIdPServerErrorEventParams;


Unicode (Windows)
virtual INT FireError(SAMLIdPServerErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SAMLIdPServerErrorEventParams;

#define EID_SAMLIDPSERVER_ERROR 6

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class SAMLIdPServerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SAMLIdPServerErrorEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireError(SAMLIdPServerErrorEventParams *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 (SAMLIdPServer Class)

Handles remote or external signing initiated by the server protocol.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireExternalSign(SAMLIdPServerExternalSignEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} SAMLIdPServerExternalSignEventParams;


Unicode (Windows)
virtual INT FireExternalSign(SAMLIdPServerExternalSignEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} SAMLIdPServerExternalSignEventParams;

#define EID_SAMLIDPSERVER_EXTERNALSIGN 7

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LONG64 &lConnectionID, LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);

class SAMLIdPServerExternalSignEventParams {
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(SAMLIdPServerExternalSignEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireExternalSign(SAMLIdPServerExternalSignEventParams *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 component via SignedData parameter.

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

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

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

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

MetadataRequest Event (SAMLIdPServer Class)

Notifies the application about the metadata request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMetadataRequest(SAMLIdPServerMetadataRequestEventParams *e);

typedef struct {
  int64 ConnectionID;
  char *Metadata;
  int reserved;
} SAMLIdPServerMetadataRequestEventParams;


Unicode (Windows)
virtual INT FireMetadataRequest(SAMLIdPServerMetadataRequestEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPWSTR Metadata;
  INT reserved;
} SAMLIdPServerMetadataRequestEventParams;

#define EID_SAMLIDPSERVER_METADATAREQUEST 8

virtual INT SECUREBLACKBOX_CALL FireMetadataRequest(LONG64 &lConnectionID, LPSTR &lpszMetadata);

class SAMLIdPServerMetadataRequestEventParams {
public:
  qint64 ConnectionID();

  const QString &Metadata();
  void SetMetadata(const QString &qsMetadata);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MetadataRequest(SAMLIdPServerMetadataRequestEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireMetadataRequest(SAMLIdPServerMetadataRequestEventParams *e) {...}

Remarks

The class uses this event to notify the application about an incoming metadata request. The suggested metadata text is provided through the Metadata parameter. The application can adjust it as required if it needs to.

Notification Event (SAMLIdPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(SAMLIdPServerNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} SAMLIdPServerNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(SAMLIdPServerNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} SAMLIdPServerNotificationEventParams;

#define EID_SAMLIDPSERVER_NOTIFICATION 9

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class SAMLIdPServerNotificationEventParams {
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(SAMLIdPServerNotificationEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireNotification(SAMLIdPServerNotificationEventParams *e) {...}

Remarks

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

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

SessionClosed Event (SAMLIdPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSessionClosed(SAMLIdPServerSessionClosedEventParams *e);

typedef struct {
  int64 ConnectionID;
  int reserved;
} SAMLIdPServerSessionClosedEventParams;


Unicode (Windows)
virtual INT FireSessionClosed(SAMLIdPServerSessionClosedEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  INT reserved;
} SAMLIdPServerSessionClosedEventParams;

#define EID_SAMLIDPSERVER_SESSIONCLOSED 10

virtual INT SECUREBLACKBOX_CALL FireSessionClosed(LONG64 &lConnectionID);

class SAMLIdPServerSessionClosedEventParams {
public:
  qint64 ConnectionID();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SessionClosed(SAMLIdPServerSessionClosedEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireSessionClosed(SAMLIdPServerSessionClosedEventParams *e) {...}

Remarks

ConnectionID contains the identifier of the closed session.

SessionEstablished Event (SAMLIdPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSessionEstablished(SAMLIdPServerSessionEstablishedEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *Username;
  int reserved;
} SAMLIdPServerSessionEstablishedEventParams;


Unicode (Windows)
virtual INT FireSessionEstablished(SAMLIdPServerSessionEstablishedEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR Username;
  INT reserved;
} SAMLIdPServerSessionEstablishedEventParams;

#define EID_SAMLIDPSERVER_SESSIONESTABLISHED 11

virtual INT SECUREBLACKBOX_CALL FireSessionEstablished(LONG64 &lConnectionID, LPSTR &lpszUsername);

class SAMLIdPServerSessionEstablishedEventParams {
public:
  qint64 ConnectionID();

  const QString &Username();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SessionEstablished(SAMLIdPServerSessionEstablishedEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireSessionEstablished(SAMLIdPServerSessionEstablishedEventParams *e) {...}

Remarks

ConnectionID contains the identifier of the new session, Username specifies the client's address and Username.

VerifyCredentials Event (SAMLIdPServer Class)

Passes user credentials to the application for verification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireVerifyCredentials(SAMLIdPServerVerifyCredentialsEventParams *e);

typedef struct {
  int64 ConnectionID;
  const char *Username;
  const char *Password;
  const char *Body;
  int Accept;
  int reserved;
} SAMLIdPServerVerifyCredentialsEventParams;


Unicode (Windows)
virtual INT FireVerifyCredentials(SAMLIdPServerVerifyCredentialsEventParams *e);

typedef struct {
  LONG64 ConnectionID;
  LPCWSTR Username;
  LPCWSTR Password;
  LPCWSTR Body;
  BOOL Accept;
  INT reserved;
} SAMLIdPServerVerifyCredentialsEventParams;

#define EID_SAMLIDPSERVER_VERIFYCREDENTIALS 12

virtual INT SECUREBLACKBOX_CALL FireVerifyCredentials(LONG64 &lConnectionID, LPSTR &lpszUsername, LPSTR &lpszPassword, LPSTR &lpszBody, BOOL &bAccept);

class SAMLIdPServerVerifyCredentialsEventParams {
public:
  qint64 ConnectionID();

  const QString &Username();

  const QString &Password();

  const QString &Body();

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void VerifyCredentials(SAMLIdPServerVerifyCredentialsEventParams *e);

// Or, subclass SAMLIdPServer and override this emitter function.
virtual int FireVerifyCredentials(SAMLIdPServerVerifyCredentialsEventParams *e) {...}

Remarks

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

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

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The SAMLIdPServer class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the SAMLIdPServer class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (SAMLIdPServer Class)

SAMLIdPServer Config Settings

Base Config Settings

Trappable Errors (SAMLIdPServer Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SAMLIdPServer Errors