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.
Active | Tells whether the server is active and ready to process requests. |
AllowIDPSSO | Specifies if IdP-initiated Single Sign-On (SSO) is allowed. |
BaseDir | Base directory on the server. |
BindingKey | Contains a private key to sign the redirect binding requests. |
EncryptionCertificate | The certificate used to encrypt the assertions. |
ExternalCrypto | Provides access to external signing and DC parameters. |
FIPSMode | Reserved. |
HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
Host | Specifies the host address of the IdP server. |
IdPServices | Populates a list of services supported by the IdP. |
IdPSettings | Populates a list of SAML IdP entity settings. |
IdPSSOPage | Specifies the relative URL of the IdP-initiated SSO page. |
IdPSSOPageTemplate | The content of the IdP-initiated SSO page. |
KnownCertificates | Additional certificates for chain validation. |
KnownKeys | Public keys for low-level signature validation. |
LoginAttemptsLimit | The maximum number of login attempts. |
MetadataURL | The IdP's metadata location. |
MetaSigningCertificate | Specifies the metadata signing certificate. |
OfflineMode | Enables the Offline mode. |
PinnedClient | Populates the pinned client details. |
PinnedClientChain | Contains the certificate chain of the pinned client. |
Port | The listening port number. |
Security | Provides access to the SAML security properties. |
SenderChain | Contains the certificate chain of the message sender. |
SigningCertificate | The certificate to be used by the IdP's for signing. |
SigningChain | The signing certificate chain. |
SignOnPageTemplate | Defines the default authentication template (login page). |
SocketSettings | Manages network connection settings. |
SPServices | Populates a list of services supported by the SP. |
SPSettings | Populates a list of SAML SP entity settings. |
TLSServerChain | The server's TLS certificates. |
TLSSettings | Manages TLS layer settings. |
URL | Specifies the base URL of this IdP server. |
Users | A collection of known users. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddIdPService | Registers an IdP service in the IdPServices list. |
AddSP | Registers an SP entity in SPSettings list. |
AddSPService | Registers an SP service in the SPServices list. |
Cleanup | Cleans up the server environment by purging expired sessions and cleaning caches. |
CompleteAuth | Initiates transfer of the authentication fact (assertion) to the SP. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
DropClient | Terminates a client connection. |
ExportSettings | Saves the SP or IdP configuration to an XML metadata file. |
GetClientBuffer | Acquires a piece of operation data. |
GetProviderProperty | Returns the value of a custom provider property. |
GetRequestBytes | Returns the contents of the received HTTP request. |
GetRequestHeader | Returns a request header value. |
GetResponseHeader | Returns a response header value. |
GetSessionProperty | Returns the value of a custom session property. |
ImportSettings | Loads the metadata required for information exchange with the identity provider. Both local (IdP-side) and remote (SP-side) metadata can be loaded with this call. |
InitiateArtifactResolve | Initiates the artifact resolution protocol. |
InitiateAuth | Starts IdP-initiated SAML authentication flow. |
InitiateLogout | Starts IdP-initiated SAML logout flow. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
ProcessArtifact | Processes an artifact request received from the SP service at one of artifact receiver endpoints. |
ProcessArtifactResolveRequest | Processes an artifact request received from the SP service at one of the ARS endpoints. |
ProcessAttributeQuery | Processes an attribute request received from the SP service at one of the AQS endpoints. |
ProcessGenericRequest | Processes a generic HTTP SAML request. |
ProcessLogoutRequest | Processes logout request received from the SP service at one of the SLS endpoints. |
ProcessSignOnRequest | Processes a single sign-on request received from the SP service at one of the SSO endpoints. |
ProcessSignOnResponse | Processes the submission of the login form previously generated by the IdP server. |
RemoveSP | Removes an SP from the list of known service providers. |
Reset | Resets the class settings. |
SetClientBuffer | Commits a data buffer to the connection. |
SetProviderProperty | Sets the value of a custom provider property. |
SetResponseHeader | Sets a response header. |
SetSessionProperty | Sets the value of a custom provider session property. |
Start | Starts the IdP server. |
Stop | Stops the IdP server. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Accept | Reports an incoming connection. |
ArtifactReceived | The server fires this event upon receiving an Artifact message from the other side. |
ArtifactResolveRequestPrepared | This event is fired when a new artifact resolution request message has been prepared by the class. |
ArtifactResolveRequestReceived | Reports receipt of ArtifactResolveRequest message. |
AssertionPrepared | This event fires when a new assertion has been prepared by the IdP server. |
AttributeQueryReceived | Notifies the application about receipt of an AttributeQuery. |
AuthnRequestReceived | The server fires this event upon receiving an AuthnRequest message from the other side. |
Connect | Reports an accepted connection. |
Disconnect | Fires to report a disconnected client. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
LogoutRequestPrepared | This event is fired when a new logout request has been prepared. |
LogoutRequestReceived | The class uses this event to notify the application about an incoming SAML Logout Request message. |
LogoutResponsePrepared | The class uses this event to notify the application about the Logout Response message being ready to be sent. |
LogoutResponseReceived | The class uses this event to notify the application about an incoming SAML LogoutResponse message. |
NewAssertion | This event reports a new assertion initiated by the IdP server. |
Notification | This event notifies the application about an underlying control flow event. |
ProcessingCompleted | This event notifies the application of the completion of request or response processing. |
ReadArtifact | Requests content identified by an artifact from the application. |
ReadAttribute | Requests an attribute from the application. |
ResourceClose | Tells the application that it can close the opened resource. |
ResourceOpen | Requests the application to open the requested resource. |
ResourceRead | Requests the application to read from an opened resource. |
ResourceRequest | Notifies the application that a server resource is requested. |
ResourceWrite | Requests the application to write to an opened resource. |
SAMLMessagePrepared | This event is fired when a SAML message has been prepared and is ready to be dispatched. |
SAMLMessageReceived | The server fires this event for every SAML message it receives. |
SessionCreated | This event is fired when a new session has been established. |
SessionDestroyed | This event is fired when the IdP server has closed a session. |
SessionEvent | Notifies the application about SAML session events. |
SessionInfoNeeded | This event is fired in OfflineMode to request the session ID for the current flow. |
SessionStateRetrieve | This event fires to retrieve session state information from the application. |
SessionStateSave | This event passes a session state object to the application for safekeeping. |
SignatureFound | Notifies the application about the start of signature validation. |
SignatureValidated | Reports the signature validation result. |
SignOnPagePrepared | The server fires this event upon preparing the sign-on page. |
SignOnResponseReceived | Notifies the application about the received response to the sign-on page. |
TLSCertValidate | Fires when a client certificate needs to be validated. |
TLSEstablished | Reports the setup of a TLS session. |
TLSHandshake | Fires when a newly established client connection initiates a TLS handshake. |
TLSPSK | Requests a pre-shared key for TLS-PSK. |
TLSShutdown | Reports closure of a TLS session. |
UserAuthCompleted | Notifies the application about the success of user authentication flow. |
UserAuthFailed | Notifies the application about failure of user authentication flow. |
UserAuthStart | Notifies the application about the start of user authentication flow. |
UserAuthVerifyCredentials | Passes user credentials to the application for verification. |
UserLogoutCompleted | Notifies the application about the completion of user logout flow. |
UserLogoutStart | Notifies the application about the start of user logout flow. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowOptionsResponseWithoutAuth | Enables unauthenticated responses to OPTIONS requests. |
AssertionsOneTimeUse | Adds a one-time use condition to the assertion. |
AssertionsTTL | The assertions time-to-live value. |
AuthDigestExpire | Specifies digest expiration time for digest authentication. |
BoundPort | The port that was bound by the server. |
ContactPerson | The ContactPerson entry of the provider metadata. |
DefaultNameIDPolicyFormat | Default name ID policy format. |
DefaultPassiveAuthnContextClassRef | The default passive authentication context class. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
HandshakeTimeout | The HTTPS handshake timeout. |
HomePage | Specifies the home page resource name. |
MaxIssueInstantTimeDiff | The maximum issue-instant time delta. |
NotBeforeTimeout | The 'not-before' timeout to use. |
OrganizationDisplayName | The OrganizationDisplayName entry of the provider metadata. |
OrganizationLang | The OrganizationLang key of the provider metadata. |
OrganizationName | The OrganizationName element of the provider metadata. |
OrganizationURL | The OrganizationURL element of the provider metadata. |
PortRangeFrom | The lower bound of allowed port scope to listen on. |
PortRangeTo | The higher bound of allowed port scope to listen on. |
RequestFilter | The request string modifier. |
ServerName | Specifies the server name for the created responses. |
SessionTimeout | The HTTP session timeout. |
SessionTTL | The SAML session time-to-live value. |
SubjectConfirmationMethod | Subject confirmation method. |
TempPath | Path for storing temporary files. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
PKICachePath | Specifies the file system path where cached PKI data is stored. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
Active Property (SAMLIdPServer Class)
Tells whether the server is active and ready to process requests.
Syntax
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
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 the IdPSSOLink parameter of AddSP method to add sign-on URLs.
Data Type
Boolean
BaseDir Property (SAMLIdPServer Class)
Base directory on the server.
Syntax
ANSI (Cross Platform) char* GetBaseDir();
int SetBaseDir(const char* lpszBaseDir); Unicode (Windows) LPWSTR GetBaseDir();
INT SetBaseDir(LPCWSTR lpszBaseDir);
char* secureblackbox_samlidpserver_getbasedir(void* lpObj);
int secureblackbox_samlidpserver_setbasedir(void* lpObj, const char* lpszBaseDir);
QString GetBaseDir();
int SetBaseDir(QString qsBaseDir);
Default Value
""
Remarks
Use this property to specify the base directory for the SP server.
Data Type
String
BindingKey Property (SAMLIdPServer Class)
Contains a private key to sign the redirect binding requests.
Syntax
SecureBlackboxCryptoKey* GetBindingKey(); int SetBindingKey(SecureBlackboxCryptoKey* val);
int64 secureblackbox_samlidpserver_getbindingkeyhandle(void* lpObj);
int secureblackbox_samlidpserver_setbindingkeyhandle(void* lpObj, int64 lBindingKeyHandle);
int secureblackbox_samlidpserver_getbindingkeykey(void* lpObj, char** lpBindingKeyKey, int* lenBindingKeyKey);
qint64 GetBindingKeyHandle();
int SetBindingKeyHandle(qint64 lBindingKeyHandle); QByteArray GetBindingKeyKey();
Remarks
Use this property to set the signing key for the redirect binding object. This is used to sign the content of the redirect binding.
Note that when using the redirect binding, the outgoing SAML message must not be signed in parallel with a certificate. Any assertions may still be signed.
This property is not available at design time.
Data Type
EncryptionCertificate Property (SAMLIdPServer Class)
The certificate used to encrypt the assertions.
Syntax
SecureBlackboxCertificate* GetEncryptionCertificate(); int SetEncryptionCertificate(SecureBlackboxCertificate* val);
int secureblackbox_samlidpserver_getencryptioncertbytes(void* lpObj, char** lpEncryptionCertBytes, int* lenEncryptionCertBytes);
int64 secureblackbox_samlidpserver_getencryptioncerthandle(void* lpObj);
int secureblackbox_samlidpserver_setencryptioncerthandle(void* lpObj, int64 lEncryptionCertHandle);
QByteArray GetEncryptionCertBytes(); qint64 GetEncryptionCertHandle();
int SetEncryptionCertHandle(qint64 lEncryptionCertHandle);
Remarks
Use this property to provide the certificate to be used for encrypting the assertions included into the IdP responses.
The class encrypts assertions automatically if the certificate is set.
This property is not available at design time.
Data Type
ExternalCrypto Property (SAMLIdPServer Class)
Provides access to external signing and DC parameters.
Syntax
SecureBlackboxExternalCrypto* GetExternalCrypto();
char* secureblackbox_samlidpserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_samlidpserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_samlidpserver_getexternalcryptodata(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_samlidpserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_samlidpserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_samlidpserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_samlidpserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_samlidpserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_samlidpserver_getexternalcryptomode(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_samlidpserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_samlidpserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID); QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams); QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData); bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation); QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm); QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID); QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret); int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).
This property is read-only.
Data Type
FIPSMode Property (SAMLIdPServer Class)
Reserved.
Syntax
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
HandshakeTimeout Property (SAMLIdPServer Class)
Specifies the handshake timeout in milliseconds.
Syntax
ANSI (Cross Platform) int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout); Unicode (Windows) INT GetHandshakeTimeout();
INT SetHandshakeTimeout(INT iHandshakeTimeout);
int secureblackbox_samlidpserver_gethandshaketimeout(void* lpObj);
int secureblackbox_samlidpserver_sethandshaketimeout(void* lpObj, int iHandshakeTimeout);
int GetHandshakeTimeout();
int SetHandshakeTimeout(int iHandshakeTimeout);
Default Value
20000
Remarks
Use this property to set the TLS handshake timeout.
Data Type
Integer
Host Property (SAMLIdPServer Class)
Specifies the host address of the IdP server.
Syntax
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
IdPServices Property (SAMLIdPServer Class)
Populates a list of services supported by the IdP.
Syntax
SecureBlackboxList<SecureBlackboxSAMLServiceInfo>* GetIdPServices();
int secureblackbox_samlidpserver_getidpservicecount(void* lpObj);
int secureblackbox_samlidpserver_getidpservicebindingtype(void* lpObj, int idpserviceindex);
char* secureblackbox_samlidpserver_getidpserviceentityid(void* lpObj, int idpserviceindex);
char* secureblackbox_samlidpserver_getidpservicelocation(void* lpObj, int idpserviceindex);
int secureblackbox_samlidpserver_getidpservicepriority(void* lpObj, int idpserviceindex);
int secureblackbox_samlidpserver_getidpserviceservice(void* lpObj, int idpserviceindex);
int secureblackbox_samlidpserver_getidpserviceserviceindex(void* lpObj, int idpserviceindex);
int GetIdPServiceCount(); int GetIdPServiceBindingType(int iIdPServiceIndex); QString GetIdPServiceEntityID(int iIdPServiceIndex); QString GetIdPServiceLocation(int iIdPServiceIndex); int GetIdPServicePriority(int iIdPServiceIndex); int GetIdPServiceService(int iIdPServiceIndex); int GetIdPServiceServiceIndex(int iIdPServiceIndex);
Remarks
Use this property to access the list of services supported by the IdP. In the SAMLIdPServer, this is the list of services supported by the IdP. In the SAMLSPServer, this is the list of services advertised by the remote IdP server. These can be loaded from the respective IdP's metadata or set manually via AddIdPService method.
This property is read-only and not available at design time.
Data Type
IdPSettings Property (SAMLIdPServer Class)
Populates a list of SAML IdP entity settings.
Syntax
SecureBlackboxSAMLEntity* GetIdPSettings();
char* secureblackbox_samlidpserver_getidpcontactperson(void* lpObj);
int secureblackbox_samlidpserver_setidpcontactperson(void* lpObj, const char* lpszIdPContactPerson);
char* secureblackbox_samlidpserver_getidpencryptionkey(void* lpObj);
int secureblackbox_samlidpserver_setidpencryptionkey(void* lpObj, const char* lpszIdPEncryptionKey);
char* secureblackbox_samlidpserver_getidpencryptionmethods(void* lpObj);
int secureblackbox_samlidpserver_setidpencryptionmethods(void* lpObj, const char* lpszIdPEncryptionMethods);
char* secureblackbox_samlidpserver_getidpentityid(void* lpObj);
int secureblackbox_samlidpserver_setidpentityid(void* lpObj, const char* lpszIdPEntityID);
int secureblackbox_samlidpserver_getidpflags(void* lpObj);
int secureblackbox_samlidpserver_setidpflags(void* lpObj, int iIdPFlags);
char* secureblackbox_samlidpserver_getidpidpssolink(void* lpObj);
int secureblackbox_samlidpserver_setidpidpssolink(void* lpObj, const char* lpszIdPIdPSSOLink);
char* secureblackbox_samlidpserver_getidpnameidformats(void* lpObj);
int secureblackbox_samlidpserver_setidpnameidformats(void* lpObj, const char* lpszIdPNameIDFormats);
char* secureblackbox_samlidpserver_getidporganizationdisplayname(void* lpObj);
int secureblackbox_samlidpserver_setidporganizationdisplayname(void* lpObj, const char* lpszIdPOrganizationDisplayName);
char* secureblackbox_samlidpserver_getidporganizationlang(void* lpObj);
int secureblackbox_samlidpserver_setidporganizationlang(void* lpObj, const char* lpszIdPOrganizationLang);
char* secureblackbox_samlidpserver_getidporganizationname(void* lpObj);
int secureblackbox_samlidpserver_setidporganizationname(void* lpObj, const char* lpszIdPOrganizationName);
char* secureblackbox_samlidpserver_getidporganizationurl(void* lpObj);
int secureblackbox_samlidpserver_setidporganizationurl(void* lpObj, const char* lpszIdPOrganizationURL);
int secureblackbox_samlidpserver_getidpsignaturevalidationresult(void* lpObj);
int secureblackbox_samlidpserver_getidpsigned(void* lpObj);
char* secureblackbox_samlidpserver_getidpsignedwith(void* lpObj);
char* secureblackbox_samlidpserver_getidpsigningkey(void* lpObj);
int secureblackbox_samlidpserver_setidpsigningkey(void* lpObj, const char* lpszIdPSigningKey);
char* secureblackbox_samlidpserver_getidpvaliduntil(void* lpObj);
int secureblackbox_samlidpserver_setidpvaliduntil(void* lpObj, const char* lpszIdPValidUntil);
QString GetIdPContactPerson();
int SetIdPContactPerson(QString qsIdPContactPerson); QString GetIdPEncryptionKey();
int SetIdPEncryptionKey(QString qsIdPEncryptionKey); QString GetIdPEncryptionMethods();
int SetIdPEncryptionMethods(QString qsIdPEncryptionMethods); QString GetIdPEntityID();
int SetIdPEntityID(QString qsIdPEntityID); int GetIdPFlags();
int SetIdPFlags(int iIdPFlags); QString GetIdPIdPSSOLink();
int SetIdPIdPSSOLink(QString qsIdPIdPSSOLink); QString GetIdPNameIDFormats();
int SetIdPNameIDFormats(QString qsIdPNameIDFormats); QString GetIdPOrganizationDisplayName();
int SetIdPOrganizationDisplayName(QString qsIdPOrganizationDisplayName); QString GetIdPOrganizationLang();
int SetIdPOrganizationLang(QString qsIdPOrganizationLang); QString GetIdPOrganizationName();
int SetIdPOrganizationName(QString qsIdPOrganizationName); QString GetIdPOrganizationURL();
int SetIdPOrganizationURL(QString qsIdPOrganizationURL); int GetIdPSignatureValidationResult(); bool GetIdPSigned(); QString GetIdPSignedWith(); QString GetIdPSigningKey();
int SetIdPSigningKey(QString qsIdPSigningKey); QString GetIdPValidUntil();
int SetIdPValidUntil(QString qsIdPValidUntil);
Remarks
Use this property to get or set properties of a SAML IdP entity. These properties can be adjusted manually or loaded from the respective metadata file.
This property is read-only and not available at design time.
Data Type
IdPSSOPage Property (SAMLIdPServer Class)
Specifies the relative URL of the IdP-initiated SSO page.
Syntax
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
IdPSSOPageTemplate Property (SAMLIdPServer Class)
The content of the IdP-initiated SSO page.
Syntax
ANSI (Cross Platform) char* GetIdPSSOPageTemplate();
int SetIdPSSOPageTemplate(const char* lpszIdPSSOPageTemplate); Unicode (Windows) LPWSTR GetIdPSSOPageTemplate();
INT SetIdPSSOPageTemplate(LPCWSTR lpszIdPSSOPageTemplate);
char* secureblackbox_samlidpserver_getidpssopagetemplate(void* lpObj);
int secureblackbox_samlidpserver_setidpssopagetemplate(void* lpObj, const char* lpszIdPSSOPageTemplate);
QString GetIdPSSOPageTemplate();
int SetIdPSSOPageTemplate(QString qsIdPSSOPageTemplate);
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
KnownCertificates Property (SAMLIdPServer Class)
Additional certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_samlidpserver_getknowncertcount(void* lpObj);
int secureblackbox_samlidpserver_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_samlidpserver_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_samlidpserver_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_samlidpserver_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); QByteArray GetKnownCertBytes(int iKnownCertIndex); qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
Remarks
Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.
The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
This property is not available at design time.
Data Type
KnownKeys Property (SAMLIdPServer Class)
Public keys for low-level signature validation.
Syntax
SecureBlackboxList<SecureBlackboxCryptoKey>* GetKnownKeys(); int SetKnownKeys(SecureBlackboxList<SecureBlackboxCryptoKey>* val);
int secureblackbox_samlidpserver_getknownkeycount(void* lpObj);
int secureblackbox_samlidpserver_setknownkeycount(void* lpObj, int iKnownKeyCount);
int64 secureblackbox_samlidpserver_getknownkeyhandle(void* lpObj, int knownkeyindex);
int secureblackbox_samlidpserver_setknownkeyhandle(void* lpObj, int knownkeyindex, int64 lKnownKeyHandle);
int GetKnownKeyCount();
int SetKnownKeyCount(int iKnownKeyCount); qint64 GetKnownKeyHandle(int iKnownKeyIndex);
int SetKnownKeyHandle(int iKnownKeyIndex, qint64 lKnownKeyHandle);
Remarks
Use this property to supply a list of public keys that might be needed for redirect binding signature validation.
This property is not available at design time.
Data Type
LoginAttemptsLimit Property (SAMLIdPServer Class)
The maximum number of login attempts.
Syntax
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
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
MetaSigningCertificate Property (SAMLIdPServer Class)
Specifies the metadata signing certificate.
Syntax
SecureBlackboxCertificate* GetMetaSigningCertificate(); int SetMetaSigningCertificate(SecureBlackboxCertificate* val);
int secureblackbox_samlidpserver_getmetasigningcertbytes(void* lpObj, char** lpMetaSigningCertBytes, int* lenMetaSigningCertBytes);
int64 secureblackbox_samlidpserver_getmetasigningcerthandle(void* lpObj);
int secureblackbox_samlidpserver_setmetasigningcerthandle(void* lpObj, int64 lMetaSigningCertHandle);
QByteArray GetMetaSigningCertBytes(); qint64 GetMetaSigningCertHandle();
int SetMetaSigningCertHandle(qint64 lMetaSigningCertHandle);
Remarks
Use this property to specify the certificate to be used to sign the IdP's metadata.
This property is not available at design time.
Data Type
OfflineMode Property (SAMLIdPServer Class)
Enables the Offline mode.
Syntax
ANSI (Cross Platform) int GetOfflineMode();
int SetOfflineMode(int bOfflineMode); Unicode (Windows) BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);
int secureblackbox_samlidpserver_getofflinemode(void* lpObj);
int secureblackbox_samlidpserver_setofflinemode(void* lpObj, int bOfflineMode);
bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);
Default Value
TRUE
Remarks
In the Offline mode the server does not open the listening port. Instead, it expects incoming requests to be routed by the application via calls to ProcessSignOnRequest, ProcessLogoutRequest, ProcessSignOnResponse, and other similar methods.
The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML requests.
Data Type
Boolean
PinnedClient Property (SAMLIdPServer Class)
Populates the pinned client details.
Syntax
SecureBlackboxTLSConnectionInfo* GetPinnedClient();
int secureblackbox_samlidpserver_getpinnedclientaeadcipher(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientchainvalidationdetails(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientchainvalidationresult(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientciphersuite(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientclientauthenticated(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientclientauthrequested(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientconnectionestablished(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientconnectionid(void* lpObj, char** lpPinnedClientConnectionID, int* lenPinnedClientConnectionID);
char* secureblackbox_samlidpserver_getpinnedclientdigestalgorithm(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientencryptionalgorithm(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientexportable(void* lpObj);
int64 secureblackbox_samlidpserver_getpinnedclientid(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientkeyexchangealgorithm(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientkeyexchangekeybits(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientnamedeccurve(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientpfscipher(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientpresharedidentity(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientpresharedidentityhint(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientpublickeybits(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientremoteaddress(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientremoteport(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientresumedsession(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientsecureconnection(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientserverauthenticated(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientsignaturealgorithm(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientsymmetricblocksize(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientsymmetrickeybits(void* lpObj);
int64 secureblackbox_samlidpserver_getpinnedclienttotalbytesreceived(void* lpObj);
int64 secureblackbox_samlidpserver_getpinnedclienttotalbytessent(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientvalidationlog(void* lpObj);
char* secureblackbox_samlidpserver_getpinnedclientversion(void* lpObj);
bool GetPinnedClientAEADCipher(); int GetPinnedClientChainValidationDetails(); int GetPinnedClientChainValidationResult(); QString GetPinnedClientCiphersuite(); bool GetPinnedClientClientAuthenticated(); bool GetPinnedClientClientAuthRequested(); bool GetPinnedClientConnectionEstablished(); QByteArray GetPinnedClientConnectionID(); QString GetPinnedClientDigestAlgorithm(); QString GetPinnedClientEncryptionAlgorithm(); bool GetPinnedClientExportable(); qint64 GetPinnedClientID(); QString GetPinnedClientKeyExchangeAlgorithm(); int GetPinnedClientKeyExchangeKeyBits(); QString GetPinnedClientNamedECCurve(); bool GetPinnedClientPFSCipher(); QString GetPinnedClientPreSharedIdentity(); QString GetPinnedClientPreSharedIdentityHint(); int GetPinnedClientPublicKeyBits(); QString GetPinnedClientRemoteAddress(); int GetPinnedClientRemotePort(); bool GetPinnedClientResumedSession(); bool GetPinnedClientSecureConnection(); bool GetPinnedClientServerAuthenticated(); QString GetPinnedClientSignatureAlgorithm(); int GetPinnedClientSymmetricBlockSize(); int GetPinnedClientSymmetricKeyBits(); qint64 GetPinnedClientTotalBytesReceived(); qint64 GetPinnedClientTotalBytesSent(); QString GetPinnedClientValidationLog(); QString GetPinnedClientVersion();
Remarks
Use this property to access the details of the client connection previously pinned with PinClient method.
This property is read-only and not available at design time.
Data Type
SecureBlackboxTLSConnectionInfo
PinnedClientChain Property (SAMLIdPServer Class)
Contains the certificate chain of the pinned client.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetPinnedClientChain();
int secureblackbox_samlidpserver_getpinnedclientcertcount(void* lpObj);
int secureblackbox_samlidpserver_getpinnedclientcertbytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertBytes, int* lenPinnedClientCertBytes);
int secureblackbox_samlidpserver_getpinnedclientcertcakeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertCAKeyID, int* lenPinnedClientCertCAKeyID);
char* secureblackbox_samlidpserver_getpinnedclientcertfingerprint(void* lpObj, int pinnedclientcertindex);
int64 secureblackbox_samlidpserver_getpinnedclientcerthandle(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlidpserver_getpinnedclientcertissuer(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlidpserver_getpinnedclientcertissuerrdn(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlidpserver_getpinnedclientcertkeyalgorithm(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlidpserver_getpinnedclientcertkeybits(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlidpserver_getpinnedclientcertkeyfingerprint(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlidpserver_getpinnedclientcertkeyusage(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlidpserver_getpinnedclientcertpublickeybytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertPublicKeyBytes, int* lenPinnedClientCertPublicKeyBytes);
int secureblackbox_samlidpserver_getpinnedclientcertselfsigned(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlidpserver_getpinnedclientcertserialnumber(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSerialNumber, int* lenPinnedClientCertSerialNumber);
char* secureblackbox_samlidpserver_getpinnedclientcertsigalgorithm(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlidpserver_getpinnedclientcertsubject(void* lpObj, int pinnedclientcertindex);
int secureblackbox_samlidpserver_getpinnedclientcertsubjectkeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSubjectKeyID, int* lenPinnedClientCertSubjectKeyID);
char* secureblackbox_samlidpserver_getpinnedclientcertsubjectrdn(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlidpserver_getpinnedclientcertvalidfrom(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_samlidpserver_getpinnedclientcertvalidto(void* lpObj, int pinnedclientcertindex);
int GetPinnedClientCertCount(); QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex); QString GetPinnedClientCertFingerprint(int iPinnedClientCertIndex); qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex); QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex); QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex); QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex); int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex); QString GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex); int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex); bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex); QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex); QString GetPinnedClientCertSubject(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex); QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex); QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex); QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);
Remarks
Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.
This property is read-only and not available at design time.
Data Type
Port Property (SAMLIdPServer Class)
The listening port number.
Syntax
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
Security Property (SAMLIdPServer Class)
Provides access to the SAML security properties.
Syntax
SecureBlackboxSAMLSecuritySettings* GetSecurity();
char* secureblackbox_samlidpserver_getsecuritycanonicalizationmethod(void* lpObj);
int secureblackbox_samlidpserver_setsecuritycanonicalizationmethod(void* lpObj, const char* lpszSecurityCanonicalizationMethod);
char* secureblackbox_samlidpserver_getsecuritydigestmethod(void* lpObj);
int secureblackbox_samlidpserver_setsecuritydigestmethod(void* lpObj, const char* lpszSecurityDigestMethod);
char* secureblackbox_samlidpserver_getsecurityencryptionmethod(void* lpObj);
int secureblackbox_samlidpserver_setsecurityencryptionmethod(void* lpObj, const char* lpszSecurityEncryptionMethod);
int secureblackbox_samlidpserver_getsecurityflags(void* lpObj);
int secureblackbox_samlidpserver_setsecurityflags(void* lpObj, int iSecurityFlags);
char* secureblackbox_samlidpserver_getsecuritysigmethod(void* lpObj);
int secureblackbox_samlidpserver_setsecuritysigmethod(void* lpObj, const char* lpszSecuritySigMethod);
int secureblackbox_samlidpserver_getsecuritysignaturepolicy(void* lpObj);
int secureblackbox_samlidpserver_setsecuritysignaturepolicy(void* lpObj, int iSecuritySignaturePolicy);
QString GetSecurityCanonicalizationMethod();
int SetSecurityCanonicalizationMethod(QString qsSecurityCanonicalizationMethod); QString GetSecurityDigestMethod();
int SetSecurityDigestMethod(QString qsSecurityDigestMethod); QString GetSecurityEncryptionMethod();
int SetSecurityEncryptionMethod(QString qsSecurityEncryptionMethod); int GetSecurityFlags();
int SetSecurityFlags(int iSecurityFlags); QString GetSecuritySigMethod();
int SetSecuritySigMethod(QString qsSecuritySigMethod); int GetSecuritySignaturePolicy();
int SetSecuritySignaturePolicy(int iSecuritySignaturePolicy);
Remarks
Use this property to access the security parameters of the server.
This property is read-only and not available at design time.
Data Type
SecureBlackboxSAMLSecuritySettings
SenderChain Property (SAMLIdPServer Class)
Contains the certificate chain of the message sender.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetSenderChain();
int secureblackbox_samlidpserver_getsendercertcount(void* lpObj);
int secureblackbox_samlidpserver_getsenderchainbytes(void* lpObj, int sendercertindex, char** lpSenderChainBytes, int* lenSenderChainBytes);
int64 secureblackbox_samlidpserver_getsenderchainhandle(void* lpObj, int sendercertindex);
int GetSenderCertCount(); QByteArray GetSenderChainBytes(int iSenderCertIndex); qint64 GetSenderChainHandle(int iSenderCertIndex);
Remarks
Use this property to access the certificate chain of the creator of the signed message or entity that is currently being processed. This property is only available from SignatureFound and SignatureValidated events.
This property is read-only and not available at design time.
Data Type
SigningCertificate Property (SAMLIdPServer Class)
The certificate to be used by the IdP's for signing.
Syntax
SecureBlackboxCertificate* GetSigningCertificate(); int SetSigningCertificate(SecureBlackboxCertificate* val);
int secureblackbox_samlidpserver_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);
int64 secureblackbox_samlidpserver_getsigningcerthandle(void* lpObj);
int secureblackbox_samlidpserver_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);
QByteArray GetSigningCertBytes(); qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);
Remarks
Use this property to specify the certificate that shall be used for signing the assertions. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.
This property is not available at design time.
Data Type
SigningChain Property (SAMLIdPServer Class)
The signing certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetSigningChain(); int SetSigningChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_samlidpserver_getsigningchaincount(void* lpObj);
int secureblackbox_samlidpserver_setsigningchaincount(void* lpObj, int iSigningChainCount);
int secureblackbox_samlidpserver_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);
int64 secureblackbox_samlidpserver_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_samlidpserver_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount); QByteArray GetSigningChainBytes(int iSigningChainIndex); qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);
Remarks
Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
Data Type
SignOnPageTemplate Property (SAMLIdPServer Class)
Defines the default authentication template (login page).
Syntax
ANSI (Cross Platform) char* GetSignOnPageTemplate();
int SetSignOnPageTemplate(const char* lpszSignOnPageTemplate); Unicode (Windows) LPWSTR GetSignOnPageTemplate();
INT SetSignOnPageTemplate(LPCWSTR lpszSignOnPageTemplate);
char* secureblackbox_samlidpserver_getsignonpagetemplate(void* lpObj);
int secureblackbox_samlidpserver_setsignonpagetemplate(void* lpObj, const char* lpszSignOnPageTemplate);
QString GetSignOnPageTemplate();
int SetSignOnPageTemplate(QString qsSignOnPageTemplate);
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
SocketSettings Property (SAMLIdPServer Class)
Manages network connection settings.
Syntax
SecureBlackboxSocketSettings* GetSocketSettings();
int secureblackbox_samlidpserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_samlidpserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_samlidpserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_samlidpserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_samlidpserver_getsocketlocalport(void* lpObj);
int secureblackbox_samlidpserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_samlidpserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_samlidpserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_samlidpserver_getsockettimeout(void* lpObj);
int secureblackbox_samlidpserver_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_samlidpserver_getsocketuseipv6(void* lpObj);
int secureblackbox_samlidpserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
Data Type
SPServices Property (SAMLIdPServer Class)
Populates a list of services supported by the SP.
Syntax
SecureBlackboxList<SecureBlackboxSAMLServiceInfo>* GetSPServices();
int secureblackbox_samlidpserver_getspservicecount(void* lpObj);
int secureblackbox_samlidpserver_getspservicebindingtype(void* lpObj, int spserviceindex);
char* secureblackbox_samlidpserver_getspserviceentityid(void* lpObj, int spserviceindex);
char* secureblackbox_samlidpserver_getspservicelocation(void* lpObj, int spserviceindex);
int secureblackbox_samlidpserver_getspservicepriority(void* lpObj, int spserviceindex);
int secureblackbox_samlidpserver_getspserviceservice(void* lpObj, int spserviceindex);
int secureblackbox_samlidpserver_getspserviceserviceindex(void* lpObj, int spserviceindex);
int GetSPServiceCount(); int GetSPServiceBindingType(int iSPServiceIndex); QString GetSPServiceEntityID(int iSPServiceIndex); QString GetSPServiceLocation(int iSPServiceIndex); int GetSPServicePriority(int iSPServiceIndex); int GetSPServiceService(int iSPServiceIndex); int GetSPServiceServiceIndex(int iSPServiceIndex);
Remarks
Use this property to access the list of services supported by the SP. In the SAMLSPServer, this is the list of services supported by the SP. In the SAMLIdPServer, this is the list of services advertised by the remote SP server. These can be loaded from the respective SP's metadata or set manually via AddSPService method.
This property is read-only and not available at design time.
Data Type
SPSettings Property (SAMLIdPServer Class)
Populates a list of SAML SP entity settings.
Syntax
SecureBlackboxList<SecureBlackboxSAMLEntity>* GetSPSettings();
int secureblackbox_samlidpserver_getspcount(void* lpObj);
int secureblackbox_samlidpserver_setspcount(void* lpObj, int iSPCount);
char* secureblackbox_samlidpserver_getspcontactperson(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setspcontactperson(void* lpObj, int spindex, const char* lpszSPContactPerson);
char* secureblackbox_samlidpserver_getspencryptionkey(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setspencryptionkey(void* lpObj, int spindex, const char* lpszSPEncryptionKey);
char* secureblackbox_samlidpserver_getspencryptionmethods(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setspencryptionmethods(void* lpObj, int spindex, const char* lpszSPEncryptionMethods);
char* secureblackbox_samlidpserver_getspentityid(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setspentityid(void* lpObj, int spindex, const char* lpszSPEntityID);
int secureblackbox_samlidpserver_getspflags(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setspflags(void* lpObj, int spindex, int iSPFlags);
char* secureblackbox_samlidpserver_getspidpssolink(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setspidpssolink(void* lpObj, int spindex, const char* lpszSPIdPSSOLink);
char* secureblackbox_samlidpserver_getspnameidformats(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setspnameidformats(void* lpObj, int spindex, const char* lpszSPNameIDFormats);
char* secureblackbox_samlidpserver_getsporganizationdisplayname(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setsporganizationdisplayname(void* lpObj, int spindex, const char* lpszSPOrganizationDisplayName);
char* secureblackbox_samlidpserver_getsporganizationlang(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setsporganizationlang(void* lpObj, int spindex, const char* lpszSPOrganizationLang);
char* secureblackbox_samlidpserver_getsporganizationname(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setsporganizationname(void* lpObj, int spindex, const char* lpszSPOrganizationName);
char* secureblackbox_samlidpserver_getsporganizationurl(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setsporganizationurl(void* lpObj, int spindex, const char* lpszSPOrganizationURL);
int secureblackbox_samlidpserver_getspsignaturevalidationresult(void* lpObj, int spindex);
int secureblackbox_samlidpserver_getspsigned(void* lpObj, int spindex);
char* secureblackbox_samlidpserver_getspsignedwith(void* lpObj, int spindex);
char* secureblackbox_samlidpserver_getspsigningkey(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setspsigningkey(void* lpObj, int spindex, const char* lpszSPSigningKey);
char* secureblackbox_samlidpserver_getspvaliduntil(void* lpObj, int spindex);
int secureblackbox_samlidpserver_setspvaliduntil(void* lpObj, int spindex, const char* lpszSPValidUntil);
int GetSPCount();
int SetSPCount(int iSPCount); QString GetSPContactPerson(int iSPIndex);
int SetSPContactPerson(int iSPIndex, QString qsSPContactPerson); QString GetSPEncryptionKey(int iSPIndex);
int SetSPEncryptionKey(int iSPIndex, QString qsSPEncryptionKey); QString GetSPEncryptionMethods(int iSPIndex);
int SetSPEncryptionMethods(int iSPIndex, QString qsSPEncryptionMethods); QString GetSPEntityID(int iSPIndex);
int SetSPEntityID(int iSPIndex, QString qsSPEntityID); int GetSPFlags(int iSPIndex);
int SetSPFlags(int iSPIndex, int iSPFlags); QString GetSPIdPSSOLink(int iSPIndex);
int SetSPIdPSSOLink(int iSPIndex, QString qsSPIdPSSOLink); QString GetSPNameIDFormats(int iSPIndex);
int SetSPNameIDFormats(int iSPIndex, QString qsSPNameIDFormats); QString GetSPOrganizationDisplayName(int iSPIndex);
int SetSPOrganizationDisplayName(int iSPIndex, QString qsSPOrganizationDisplayName); QString GetSPOrganizationLang(int iSPIndex);
int SetSPOrganizationLang(int iSPIndex, QString qsSPOrganizationLang); QString GetSPOrganizationName(int iSPIndex);
int SetSPOrganizationName(int iSPIndex, QString qsSPOrganizationName); QString GetSPOrganizationURL(int iSPIndex);
int SetSPOrganizationURL(int iSPIndex, QString qsSPOrganizationURL); int GetSPSignatureValidationResult(int iSPIndex); bool GetSPSigned(int iSPIndex); QString GetSPSignedWith(int iSPIndex); QString GetSPSigningKey(int iSPIndex);
int SetSPSigningKey(int iSPIndex, QString qsSPSigningKey); QString GetSPValidUntil(int iSPIndex);
int SetSPValidUntil(int iSPIndex, QString qsSPValidUntil);
Remarks
Use this property to get or set properties of a SAML SP entity. These properties can be adjusted manually or loaded from the respective metadata file using ImportSettings method.
This property is read-only and not available at design time.
Data Type
TLSServerChain Property (SAMLIdPServer Class)
The server's TLS certificates.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain(); int SetTLSServerChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_samlidpserver_gettlsservercertcount(void* lpObj);
int secureblackbox_samlidpserver_settlsservercertcount(void* lpObj, int iTLSServerCertCount);
int secureblackbox_samlidpserver_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
int64 secureblackbox_samlidpserver_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
int secureblackbox_samlidpserver_settlsservercerthandle(void* lpObj, int tlsservercertindex, int64 lTLSServerCertHandle);
int GetTLSServerCertCount();
int SetTLSServerCertCount(int iTLSServerCertCount); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);
int SetTLSServerCertHandle(int iTLSServerCertIndex, qint64 lTLSServerCertHandle);
Remarks
Use this property to provide a list of TLS certificates for the server endpoint.
A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.
The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.
This property is not available at design time.
Data Type
TLSSettings Property (SAMLIdPServer Class)
Manages TLS layer settings.
Syntax
SecureBlackboxTLSSettings* GetTLSSettings();
int secureblackbox_samlidpserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_samlidpserver_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_samlidpserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_samlidpserver_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_samlidpserver_gettlsciphersuites(void* lpObj);
int secureblackbox_samlidpserver_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_samlidpserver_gettlsclientauth(void* lpObj);
int secureblackbox_samlidpserver_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_samlidpserver_gettlseccurves(void* lpObj);
int secureblackbox_samlidpserver_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_samlidpserver_gettlsextensions(void* lpObj);
int secureblackbox_samlidpserver_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_samlidpserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_samlidpserver_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_samlidpserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_samlidpserver_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_samlidpserver_gettlspresharedkey(void* lpObj);
int secureblackbox_samlidpserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_samlidpserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_samlidpserver_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_samlidpserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_samlidpserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_samlidpserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_samlidpserver_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_samlidpserver_gettlsssloptions(void* lpObj);
int secureblackbox_samlidpserver_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_samlidpserver_gettlstlsmode(void* lpObj);
int secureblackbox_samlidpserver_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_samlidpserver_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_samlidpserver_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_samlidpserver_gettlsusesessionresumption(void* lpObj);
int secureblackbox_samlidpserver_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_samlidpserver_gettlsversions(void* lpObj);
int secureblackbox_samlidpserver_settlsversions(void* lpObj, int iTLSVersions);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates); int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites); int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth); QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves); QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions); bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges); QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity); QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey); QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite); int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret); bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption); int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Data Type
URL Property (SAMLIdPServer Class)
Specifies the base URL of this IdP server.
Syntax
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
Users Property (SAMLIdPServer Class)
A collection of known users.
Syntax
SecureBlackboxList<SecureBlackboxUserAccount>* GetUsers(); int SetUsers(SecureBlackboxList<SecureBlackboxUserAccount>* val);
int secureblackbox_samlidpserver_getusercount(void* lpObj);
int secureblackbox_samlidpserver_setusercount(void* lpObj, int iUserCount);
int secureblackbox_samlidpserver_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_samlidpserver_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);
char* secureblackbox_samlidpserver_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);
int secureblackbox_samlidpserver_getusercertificate(void* lpObj, int userindex, char** lpUserCertificate, int* lenUserCertificate);
int secureblackbox_samlidpserver_setusercertificate(void* lpObj, int userindex, const char* lpUserCertificate, int lenUserCertificate);
char* secureblackbox_samlidpserver_getuserdata(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserdata(void* lpObj, int userindex, const char* lpszUserData);
char* secureblackbox_samlidpserver_getuseremail(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuseremail(void* lpObj, int userindex, const char* lpszUserEmail);
int64 secureblackbox_samlidpserver_getuserhandle(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);
char* secureblackbox_samlidpserver_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);
int secureblackbox_samlidpserver_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);
int secureblackbox_samlidpserver_getuserotpalgorithm(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserotpalgorithm(void* lpObj, int userindex, int iUserOtpAlgorithm);
int secureblackbox_samlidpserver_getuserotplen(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserotplen(void* lpObj, int userindex, int iUserOTPLen);
int secureblackbox_samlidpserver_getuserotpvalue(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserotpvalue(void* lpObj, int userindex, int iUserOtpValue);
int secureblackbox_samlidpserver_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);
char* secureblackbox_samlidpserver_getuserpassword(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);
int secureblackbox_samlidpserver_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_samlidpserver_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);
int secureblackbox_samlidpserver_getusersshkey(void* lpObj, int userindex, char** lpUserSSHKey, int* lenUserSSHKey);
int secureblackbox_samlidpserver_setusersshkey(void* lpObj, int userindex, const char* lpUserSSHKey, int lenUserSSHKey);
char* secureblackbox_samlidpserver_getuserusername(void* lpObj, int userindex);
int secureblackbox_samlidpserver_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);
int GetUserCount();
int SetUserCount(int iUserCount); QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData); QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath); QByteArray GetUserCertificate(int iUserIndex);
int SetUserCertificate(int iUserIndex, QByteArray qbaUserCertificate); QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData); QString GetUserEmail(int iUserIndex);
int SetUserEmail(int iUserIndex, QString qsUserEmail); qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle); QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm); int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit); int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm); int GetUserOTPLen(int iUserIndex);
int SetUserOTPLen(int iUserIndex, int iUserOTPLen); int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue); int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit); QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword); QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret); QByteArray GetUserSSHKey(int iUserIndex);
int SetUserSSHKey(int iUserIndex, QByteArray qbaUserSSHKey); QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);
Remarks
This property provides access to registered user database.
This property is not available at design time.
Data Type
AddIdPService Method (SAMLIdPServer Class)
Registers an IdP service in the IdPServices list.
Syntax
ANSI (Cross Platform) int AddIdPService(int iService, int iBindingType, const char* lpszLocation, int iPriority, int iIndex); Unicode (Windows) INT AddIdPService(INT iService, INT iBindingType, LPCWSTR lpszLocation, INT iPriority, INT iIndex);
int secureblackbox_samlidpserver_addidpservice(void* lpObj, int iService, int iBindingType, const char* lpszLocation, int iPriority, int iIndex);
int AddIdPService(int iService, int iBindingType, const QString& qsLocation, int iPriority, int iIndex);
Remarks
Use this method to add an entry to the list of services and their locations provided by the IdP.
An identity provider can provide a variety of identity services through a selection of endpoints, each supporting one or more transports (or bindings). Typical examples are a single sign-on or a single logout service, each of which can be served independently on the same or different endpoints, via a POST or Redirect transports (or both).
Each AddIdPService call registers a single service offered via a single transport. If you would like to have the same service to be available using several different transports, you need to register each combination individually, even if the service runs at the same web endpoint:
idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1);
idp.AddIdPService(spsSingleSignOnService, csbtPOST, "/saml/sso", -1, -1);
Use the Service parameter to specify the service to register:
spsUnknown | 0 | The service is of unknown or unsupported type |
spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for SSO and SLO services to support POST and Redirect bindings.
The Location parameter specifies an absolute or relative path to the service within the SAML web service:
idp.AddIdPService(spsSingleSignOnService, csbtPOST, "https://idp.identityserver/saml/sso", -1, -1); // absolute path
idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1); // relative path
The Priority parameter is nominal as it only specifies the relative priority of the transport in the IdP metadata. The actual transport used, among those supported, depends on the choice of the external service provider / application. Pass -1 to stick with the default priority.
The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.
Note that this method registers the identity provider's own service - something that the identity provider provides. This is different to AddSPService method, which registers a foreign service provider's service - something that the identity provider should be aware of.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddSP Method (SAMLIdPServer Class)
Registers an SP entity in SPSettings list.
Syntax
ANSI (Cross Platform) int AddSP(const char* lpszEntityID, const char* lpszIdPSSOLink); Unicode (Windows) INT AddSP(LPCWSTR lpszEntityID, LPCWSTR lpszIdPSSOLink);
int secureblackbox_samlidpserver_addsp(void* lpObj, const char* lpszEntityID, const char* lpszIdPSSOLink);
int AddSP(const QString& qsEntityID, const QString& qsIdPSSOLink);
Remarks
This method adds an empty entry to the SPSettings list of known service providers. When registering a service provider manually (v.s. importing it from its metadata with a ImportSettings call), make sure to register all the individual SP service endpoints (assertion consumer services, single logout services, and so on) manually using the AddSPService method.
Once you have added the SP entry to the list, you can edit it using the SPSettings property.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddSPService Method (SAMLIdPServer Class)
Registers an SP service in the SPServices list.
Syntax
ANSI (Cross Platform) int AddSPService(int iService, int iBindingType, const char* lpszLocation, int iPriority, int iIndex, const char* lpszEntityID); Unicode (Windows) INT AddSPService(INT iService, INT iBindingType, LPCWSTR lpszLocation, INT iPriority, INT iIndex, LPCWSTR lpszEntityID);
int secureblackbox_samlidpserver_addspservice(void* lpObj, int iService, int iBindingType, const char* lpszLocation, int iPriority, int iIndex, const char* lpszEntityID);
int AddSPService(int iService, int iBindingType, const QString& qsLocation, int iPriority, int iIndex, const QString& qsEntityID);
Remarks
Use this method to add an entry to the list of known external SAML services and their locations.
The identity provider needs to be knowledgeable of external SP services (applications) that it provides services to. That information can either be provided in the form of a metadata file (see ImportSettings), or registered manually using this method.
When using this method, make sure to register all the services you expect to work with. Note that if the same SP service is available through several different transports (bindings), you will need to register each (service, transport) pair individually:
idp.AddSPService(spsAssertionConsumerService, csbtPOST, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata");
idp.AddSPService(spsAssertionConsumerService, csbtRedirect, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata");
Use the Service parameter to specify the service to register:
spsUnknown | 0 | The service is of unknown or unsupported type |
spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for ACS service to use POST binding (due to the size of assertions), and SLS to either use POST or Redirect. This information is typically provided by the service provider.
The Location parameter specifies the absolute URL of the respective SAML web endpoint.
The Priority parameter specifies the relative priority of the transport among several identical services. The actual transport used may be different to the specified priority, as the request received from the SP (such as AuthnRequest) may explicitly request a specific transport to use.
The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.
The EntityID parameter provides a unique identifier of the service provider. It is common to use the URL of the provider's metadata file as the Entity ID, although that is not a requirement.
Note that this method registers a known service - something that the identity provider should be aware of. This is different to the purpose of the AddIdPService method, which registers the identity provider's own service.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Cleanup Method (SAMLIdPServer Class)
Cleans up the server environment by purging expired sessions and cleaning caches.
Syntax
ANSI (Cross Platform) int Cleanup(); Unicode (Windows) INT Cleanup();
int secureblackbox_samlidpserver_cleanup(void* lpObj);
int Cleanup();
Remarks
Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CompleteAuth Method (SAMLIdPServer Class)
Initiates transfer of the authentication fact (assertion) to the SP.
Syntax
ANSI (Cross Platform) int CompleteAuth(int64 lConnectionID, const char* lpszSessionID, int iSPServiceIndex, const char* lpszRelayState, const char* lpszTag); Unicode (Windows) INT CompleteAuth(LONG64 lConnectionID, LPCWSTR lpszSessionID, INT iSPServiceIndex, LPCWSTR lpszRelayState, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_completeauth(void* lpObj, int64 lConnectionID, const char* lpszSessionID, int iSPServiceIndex, const char* lpszRelayState, const char* lpszTag);
int CompleteAuth(qint64 lConnectionID, const QString& qsSessionID, int iSPServiceIndex, const QString& qsRelayState, const QString& qsTag);
Remarks
Use this method to pass a SAML assertion to a chosen SP after completion of the IdP-initiated SSO process.
Calling this method is equivalent to navigating to the SP-specific IdP link on the web server running the SAML IdP service.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Config Method (SAMLIdPServer Class)
Sets or retrieves a configuration setting.
Syntax
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
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 insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Common ActionIDs:
Action | Parameters | Returned value | Description |
ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
ResetCertificateCache | none | none | Clears the cached certificates. |
ResetCRLCache | none | none | Clears the cached CRLs. |
ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DropClient Method (SAMLIdPServer Class)
Terminates a client connection.
Syntax
ANSI (Cross Platform) int DropClient(int64 lConnectionId, int bForced); Unicode (Windows) INT DropClient(LONG64 lConnectionId, BOOL bForced);
int secureblackbox_samlidpserver_dropclient(void* lpObj, int64 lConnectionId, int bForced);
int DropClient(qint64 lConnectionId, bool bForced);
Remarks
Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ExportSettings Method (SAMLIdPServer Class)
Saves the SP or IdP configuration to an XML metadata file.
Syntax
ANSI (Cross Platform) char* ExportSettings(int bIdP, int iIndex); Unicode (Windows) LPWSTR ExportSettings(BOOL bIdP, INT iIndex);
char* secureblackbox_samlidpserver_exportsettings(void* lpObj, int bIdP, int iIndex);
QString ExportSettings(bool bIdP, int iIndex);
Remarks
Use this method to save the Identity Provider (IdP) or Service Provider (SP) configuration in the form of XML metadata. The IdP metadata file may then be transferred to identity providers (SP) to let them know about the IdP configuration.
When exporting IdP settings, adjust the identity provider configuration as required in IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.
When exporting SP settings, provide the index of the service provider in the SPSettings list.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetClientBuffer Method (SAMLIdPServer Class)
Acquires a piece of operation data.
Syntax
ANSI (Cross Platform) char* GetClientBuffer(int64 lConnectionID, const char* lpszHandle, int *lpSize = NULL); Unicode (Windows) LPSTR GetClientBuffer(LONG64 lConnectionID, LPCWSTR lpszHandle, LPINT lpSize = NULL);
char* secureblackbox_samlidpserver_getclientbuffer(void* lpObj, int64 lConnectionID, const char* lpszHandle, int *lpSize);
QByteArray GetClientBuffer(qint64 lConnectionID, const QString& qsHandle);
Remarks
Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.
A typical place to call this method is inside the ResourceWrite event handler, when implementing customized file transfers.
Error Handling (C++)
This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetProviderProperty Method (SAMLIdPServer Class)
Returns the value of a custom provider property.
Syntax
ANSI (Cross Platform) char* GetProviderProperty(const char* lpszName); Unicode (Windows) LPWSTR GetProviderProperty(LPCWSTR lpszName);
char* secureblackbox_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.
GetRequestBytes Method (SAMLIdPServer Class)
Returns the contents of the received HTTP request.
Syntax
ANSI (Cross Platform) char* GetRequestBytes(int64 lConnectionID, const char* lpszRequestFilter, int *lpSize = NULL); Unicode (Windows) LPSTR GetRequestBytes(LONG64 lConnectionID, LPCWSTR lpszRequestFilter, LPINT lpSize = NULL);
char* secureblackbox_samlidpserver_getrequestbytes(void* lpObj, int64 lConnectionID, const char* lpszRequestFilter, int *lpSize);
QByteArray GetRequestBytes(qint64 lConnectionID, const QString& qsRequestFilter);
Remarks
Use this method to get the body of the received HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.
Error Handling (C++)
This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetRequestHeader Method (SAMLIdPServer Class)
Returns a request header value.
Syntax
ANSI (Cross Platform) char* GetRequestHeader(int64 lConnectionId, const char* lpszHeaderName); Unicode (Windows) LPWSTR GetRequestHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
char* secureblackbox_samlidpserver_getrequestheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName);
QString GetRequestHeader(qint64 lConnectionId, const QString& qsHeaderName);
Remarks
Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetResponseHeader Method (SAMLIdPServer Class)
Returns a response header value.
Syntax
ANSI (Cross Platform) char* GetResponseHeader(int64 lConnectionId, const char* lpszHeaderName); Unicode (Windows) LPWSTR GetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
char* secureblackbox_samlidpserver_getresponseheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName);
QString GetResponseHeader(qint64 lConnectionId, const QString& qsHeaderName);
Remarks
Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetSessionProperty Method (SAMLIdPServer Class)
Returns the value of a custom session property.
Syntax
ANSI (Cross Platform) char* GetSessionProperty(const char* lpszSessionID, const char* lpszName); Unicode (Windows) LPWSTR GetSessionProperty(LPCWSTR lpszSessionID, LPCWSTR lpszName);
char* secureblackbox_samlidpserver_getsessionproperty(void* lpObj, const char* lpszSessionID, const char* lpszName);
QString GetSessionProperty(const QString& qsSessionID, const QString& qsName);
Remarks
This method, together with SetSessionProperty, provides an extensible way of managing the Identity Provider's session properties that are not available through the primary properties and events of the component. These methods can be called on any active browser session. Use SessionCreated and SessionDestroyed events to get notifications about session creation and disposal.
The following properties are supported for IdP sessions and can be passed to the Name parameter of this method:
- AuthnContextClassRef: the authentication context Auth class.
- AuthnRequestID: the AuthnRequest ID.
- Binding: the binding type used.
- Certificate: the certificate that signed the request (in base16 DER-encoded format).
- CustomAuthFlow: whether the session uses a custom authentication flow.
- Expires: the web session expiration time.
- LoggedIn: whether the user associated with this session has successfully undergone the authentication procedures.
- Login: the login name used by the user to authenticate themselves.
- LoginAttempts: the number of login attempts available for the user.
- LogoutRequestID: the LogoutRequest ID.
- NameID: the NameID of the user.
- NameIDFormat: the format of the NameID of the user.
- FormattedNameID: the formatted version of the NameID.
- NameIDPolicyFormat: the name ID policy format.
- NameIDPolicyIdentifier: the name ID policy identifier.
- RelayState: the current (last) relay state entry.
- ResponseLocation: the location where the response should be sent.
- Session: the session ID (the same as you pass as parameter).
- SessionIndex: the cross-network session index assigned to this session.
- SP: the entity ID of the service provider.
- URL: the current request's URL.
- UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ImportSettings Method (SAMLIdPServer Class)
Loads the metadata required for information exchange with the identity provider. Both local (IdP-side) and remote (SP-side) metadata can be loaded with this call.
Syntax
ANSI (Cross Platform) int ImportSettings(const char* lpszMetadata, int bIdP); Unicode (Windows) INT ImportSettings(LPCWSTR lpszMetadata, BOOL bIdP);
int secureblackbox_samlidpserver_importsettings(void* lpObj, const char* lpszMetadata, int bIdP);
int ImportSettings(const QString& qsMetadata, bool bIdP);
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.
The Metadata parameter contains metadata in the form of byte array. Set IdP parameter to true to indicate that it is the Identity Provider's own settings that are being loaded.
The loaded metadata is populated in the IdPSettings or SPSettings object (depending on the value of the IdP parameter).
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
InitiateArtifactResolve Method (SAMLIdPServer Class)
Initiates the artifact resolution protocol.
Syntax
ANSI (Cross Platform) int InitiateArtifactResolve(int64 lConnectionID, const char* lpszSessionID, int iSPServiceIndex, const char* lpszArtifact, const char* lpszTag); Unicode (Windows) INT InitiateArtifactResolve(LONG64 lConnectionID, LPCWSTR lpszSessionID, INT iSPServiceIndex, LPCWSTR lpszArtifact, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_initiateartifactresolve(void* lpObj, int64 lConnectionID, const char* lpszSessionID, int iSPServiceIndex, const char* lpszArtifact, const char* lpszTag);
int InitiateArtifactResolve(qint64 lConnectionID, const QString& qsSessionID, int iSPServiceIndex, const QString& qsArtifact, const QString& qsTag);
Remarks
Use this event to initiate the artifact resolution protocol for Artifact. Specify the desired SP service endpoint via the SPServiceIndex parameter.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
InitiateAuth Method (SAMLIdPServer Class)
Starts IdP-initiated SAML authentication flow.
Syntax
ANSI (Cross Platform) int InitiateAuth(int64 lConnectionID, const char* lpszSessionID, int iSPServiceIndex, const char* lpszTag); Unicode (Windows) INT InitiateAuth(LONG64 lConnectionID, LPCWSTR lpszSessionID, INT iSPServiceIndex, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_initiateauth(void* lpObj, int64 lConnectionID, const char* lpszSessionID, int iSPServiceIndex, const char* lpszTag);
int InitiateAuth(qint64 lConnectionID, const QString& qsSessionID, int iSPServiceIndex, const QString& qsTag);
Remarks
Use this method to initiate SAML authentication flow on the IdP side.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Once the user has been authenticated, you can use ProcessSignOnRequest to generate SAML assertions for specific SPs.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
InitiateLogout Method (SAMLIdPServer Class)
Starts IdP-initiated SAML logout flow.
Syntax
ANSI (Cross Platform) int InitiateLogout(int64 lConnectionID, const char* lpszSessionID, int iSPServiceIndex, const char* lpszTag); Unicode (Windows) INT InitiateLogout(LONG64 lConnectionID, LPCWSTR lpszSessionID, INT iSPServiceIndex, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_initiatelogout(void* lpObj, int64 lConnectionID, const char* lpszSessionID, int iSPServiceIndex, const char* lpszTag);
int InitiateLogout(qint64 lConnectionID, const QString& qsSessionID, int iSPServiceIndex, const QString& qsTag);
Remarks
Use this method to initiate SAML logout flow on the IdP side. Pass the index of the logout endpoint that you want to use to the SPServiceIndex parameter.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ListClients Method (SAMLIdPServer Class)
Enumerates the connected clients.
Syntax
ANSI (Cross Platform) char* ListClients(); Unicode (Windows) LPWSTR ListClients();
char* secureblackbox_samlidpserver_listclients(void* lpObj);
QString ListClients();
Remarks
This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
PinClient Method (SAMLIdPServer Class)
Takes a snapshot of the connection's properties.
Syntax
ANSI (Cross Platform) int PinClient(int64 lConnectionId); Unicode (Windows) INT PinClient(LONG64 lConnectionId);
int secureblackbox_samlidpserver_pinclient(void* lpObj, int64 lConnectionId);
int PinClient(qint64 lConnectionId);
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ProcessArtifact Method (SAMLIdPServer Class)
Processes an artifact request received from the SP service at one of artifact receiver endpoints.
Syntax
ANSI (Cross Platform) int ProcessArtifact(int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag); Unicode (Windows) INT ProcessArtifact(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszRequest, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_processartifact(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);
int ProcessArtifact(qint64 lConnectionID, const QString& qsSessionID, const QString& qsRequest, const QString& qsTag);
Remarks
Use this method to pass a SAML artifact received at one of the artifact endpoints.
Artifact messages are typically very simple:
https://idp.server.com/sso/artifact?SAMLart=artifact
In response to the artifact received, the server initiates an artifact resolution protocol to retrieve the SAML message identified by the artifact. This will typically expose itself via an invocation of the ArtifactResolveRequestPrepared event, and, later on, of an event matching the type of the actual message received - such as AuthnRequestReceived.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ProcessArtifactResolveRequest Method (SAMLIdPServer Class)
Processes an artifact request received from the SP service at one of the ARS endpoints.
Syntax
ANSI (Cross Platform) int ProcessArtifactResolveRequest(int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag); Unicode (Windows) INT ProcessArtifactResolveRequest(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszRequest, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_processartifactresolverequest(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);
int ProcessArtifactResolveRequest(qint64 lConnectionID, const QString& qsSessionID, const QString& qsRequest, const QString& qsTag);
Remarks
Use this method to pass a SAML artifact request received at one of the ArtifactResolutionService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ProcessAttributeQuery Method (SAMLIdPServer Class)
Processes an attribute request received from the SP service at one of the AQS endpoints.
Syntax
ANSI (Cross Platform) int ProcessAttributeQuery(int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag); Unicode (Windows) INT ProcessAttributeQuery(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszRequest, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_processattributequery(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);
int ProcessAttributeQuery(qint64 lConnectionID, const QString& qsSessionID, const QString& qsRequest, const QString& qsTag);
Remarks
Use this method to pass a SAML attribute request received at one of the AttributeQueryService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ProcessGenericRequest Method (SAMLIdPServer Class)
Processes a generic HTTP SAML request.
Syntax
ANSI (Cross Platform) char* ProcessGenericRequest(int64 lConnectionID, const char* lpRequest, int lenRequest, int *lpSize = NULL); Unicode (Windows) LPSTR ProcessGenericRequest(LONG64 lConnectionID, LPCSTR lpRequest, INT lenRequest, LPINT lpSize = NULL);
char* secureblackbox_samlidpserver_processgenericrequest(void* lpObj, int64 lConnectionID, const char* lpRequest, int lenRequest, int *lpSize);
QByteArray ProcessGenericRequest(qint64 lConnectionID, QByteArray qbaRequest);
Remarks
Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine.
The Request parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers.
You can use this method with or without the OfflineMode.
Error Handling (C++)
This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ProcessLogoutRequest Method (SAMLIdPServer Class)
Processes logout request received from the SP service at one of the SLS endpoints.
Syntax
ANSI (Cross Platform) int ProcessLogoutRequest(int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag); Unicode (Windows) INT ProcessLogoutRequest(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszRequest, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_processlogoutrequest(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);
int ProcessLogoutRequest(qint64 lConnectionID, const QString& qsSessionID, const QString& qsRequest, const QString& qsTag);
Remarks
Use this method to pass a SAML logout request received at one of the SingleLogoutService endpoints.
An SLS endpoint may receive requests of two kinds: LogoutRequest and LogoutResponse. If Request contains a LogoutRequest, the content generated by this method will contain a corresponding LogoutResponse. If Request contains a LogoutResponse, the returned content is empty.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ProcessSignOnRequest Method (SAMLIdPServer Class)
Processes a single sign-on request received from the SP service at one of the SSO endpoints.
Syntax
ANSI (Cross Platform) int ProcessSignOnRequest(int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag); Unicode (Windows) INT ProcessSignOnRequest(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszRequest, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_processsignonrequest(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszRequest, const char* lpszTag);
int ProcessSignOnRequest(qint64 lConnectionID, const QString& qsSessionID, const QString& qsRequest, const QString& qsTag);
Remarks
Use this method to pass a SAML Single Sign-On request received at one of the SingleSignOnService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ProcessSignOnResponse Method (SAMLIdPServer Class)
Processes the submission of the login form previously generated by the IdP server.
Syntax
ANSI (Cross Platform) int ProcessSignOnResponse(int64 lConnectionID, const char* lpszSessionID, const char* lpszResponse, const char* lpszTag); Unicode (Windows) INT ProcessSignOnResponse(LONG64 lConnectionID, LPCWSTR lpszSessionID, LPCWSTR lpszResponse, LPCWSTR lpszTag);
int secureblackbox_samlidpserver_processsignonresponse(void* lpObj, int64 lConnectionID, const char* lpszSessionID, const char* lpszResponse, const char* lpszTag);
int ProcessSignOnResponse(qint64 lConnectionID, const QString& qsSessionID, const QString& qsResponse, const QString& qsTag);
Remarks
Use this method to pass the login form data that was received from the user in response to the presented login form, to the IdP server. If the provided data matches the form, the credentials are passed to the application via the UserAuthVerifyCredentials event.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
RemoveSP Method (SAMLIdPServer Class)
Removes an SP from the list of known service providers.
Syntax
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 SPSettings list. The IdP server will be unable to process any further requests from this provider once it is removed.
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.)
Reset Method (SAMLIdPServer Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_samlidpserver_reset(void* lpObj);
int Reset();
Remarks
Reset is a generic method available in every class.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetClientBuffer Method (SAMLIdPServer Class)
Commits a data buffer to the connection.
Syntax
ANSI (Cross Platform) int SetClientBuffer(int64 lConnectionID, const char* lpszHandle, const char* lpValue, int lenValue); Unicode (Windows) INT SetClientBuffer(LONG64 lConnectionID, LPCWSTR lpszHandle, LPCSTR lpValue, INT lenValue);
int secureblackbox_samlidpserver_setclientbuffer(void* lpObj, int64 lConnectionID, const char* lpszHandle, const char* lpValue, int lenValue);
int SetClientBuffer(qint64 lConnectionID, const QString& qsHandle, QByteArray qbaValue);
Remarks
Use this method from your ResourceRead event handler to commit a chunk of file data to the server component.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetProviderProperty Method (SAMLIdPServer Class)
Sets the value of a custom provider property.
Syntax
ANSI (Cross Platform) int SetProviderProperty(const char* lpszName, const char* lpszValue); Unicode (Windows) INT SetProviderProperty(LPCWSTR lpszName, LPCWSTR lpszValue);
int secureblackbox_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.)
SetResponseHeader Method (SAMLIdPServer Class)
Sets a response header.
Syntax
ANSI (Cross Platform) int SetResponseHeader(int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue); Unicode (Windows) INT SetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName, LPCWSTR lpszValue);
int secureblackbox_samlidpserver_setresponseheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue);
int SetResponseHeader(qint64 lConnectionId, const QString& qsHeaderName, const QString& qsValue);
Remarks
Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetSessionProperty Method (SAMLIdPServer Class)
Sets the value of a custom provider session property.
Syntax
ANSI (Cross Platform) int SetSessionProperty(const char* lpszSessionID, const char* lpszName, const char* lpszValue); Unicode (Windows) INT SetSessionProperty(LPCWSTR lpszSessionID, LPCWSTR lpszName, LPCWSTR lpszValue);
int secureblackbox_samlidpserver_setsessionproperty(void* lpObj, const char* lpszSessionID, const char* lpszName, const char* lpszValue);
int SetSessionProperty(const QString& qsSessionID, const QString& qsName, const QString& qsValue);
Remarks
This method, together with GetSessionProperty, provides an extensible way of managing the Identity Provider's session settings that are not available through the primary properties and events of the component.
The following properties can be adjusted for each individual session:
- AuthnContextClassRef: the authentication context Auth class.
- AuthnRequestID: the AuthnRequest ID.
- Certificate: the certificate that signed the request (in base16 DER-encoded format).
- CustomAuthFlow: whether the session uses a custom authentication flow.
- Login: the login name used by the user to authenticate themselves.
- LoginAttempts: the number of login attempts available for the user.
- LogoutRequestID: the LogoutRequest ID.
- NameID: the NameID of the user.
- NameIDPolicyFormat: the name ID policy format.
- NameIDPolicyIdentifier: the name ID policy identifier.
- RelayState: the current (last) relay state entry.
- ResponseLocation: the location where the response should be sent.
- Session: the session ID (the same as you pass as parameter).
- SessionIndex: the cross-network session index assigned to this session.
- URL: the current request's URL.
- UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.
Note: setting a session property invokes a call to SessionStateSave. The component does that to update the session state kept externally.
Note: changing session properties mindlessly may break the protocol flow. For example, changing AuthnRequestID to a different value may cause the Service Provider to reject the subsequent assertion message, as it will contain a now-unmatching In-Response-To entry.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Start Method (SAMLIdPServer Class)
Starts the IdP server.
Syntax
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
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
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.
ArtifactReceived Event (SAMLIdPServer Class)
The server fires this event upon receiving an Artifact message from the other side.
Syntax
ANSI (Cross Platform) virtual int FireArtifactReceived(SAMLIdPServerArtifactReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
const char *Artifact;
int Action; int reserved; } SAMLIdPServerArtifactReceivedEventParams;
Unicode (Windows) virtual INT FireArtifactReceived(SAMLIdPServerArtifactReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
LPCWSTR Artifact;
INT Action; INT reserved; } SAMLIdPServerArtifactReceivedEventParams;
#define EID_SAMLIDPSERVER_ARTIFACTRECEIVED 2 virtual INT SECUREBLACKBOX_CALL FireArtifactReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, LPSTR &lpszArtifact, INT &iAction);
class SAMLIdPServerArtifactReceivedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); const QString &Artifact(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ArtifactReceived(SAMLIdPServerArtifactReceivedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireArtifactReceived(SAMLIdPServerArtifactReceivedEventParams *e) {...}
Remarks
The Artifact message is very simple and only contains the actual artifact (an opaque string). Depending on the choice of the Action parameter, the further flow may go as following:
- fraAuto: the server will prepare an ArtifactResolve request and sent it to the other side to retrieve the artifact.
- fraCustom: the server will acknowledge the receipt of the artifact, but it is the task of your code to request the message and pass it on to the server via ProcessGenericRequest method.
- fraReject: the server will discard the artifact.
Note that you still can choose fraAuto to let the server proceed, but alter the flow as required in further events, such as ArtifactResolveRequestPrepared.
In OfflineMode this event would typically be fired from ProcessArtifact call.
ArtifactResolveRequestPrepared Event (SAMLIdPServer Class)
This event is fired when a new artifact resolution request message has been prepared by the class.
Syntax
ANSI (Cross Platform) virtual int FireArtifactResolveRequestPrepared(SAMLIdPServerArtifactResolveRequestPreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
const char *Artifact; int reserved; } SAMLIdPServerArtifactResolveRequestPreparedEventParams;
Unicode (Windows) virtual INT FireArtifactResolveRequestPrepared(SAMLIdPServerArtifactResolveRequestPreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
LPCWSTR Artifact; INT reserved; } SAMLIdPServerArtifactResolveRequestPreparedEventParams;
#define EID_SAMLIDPSERVER_ARTIFACTRESOLVEREQUESTPREPARED 3 virtual INT SECUREBLACKBOX_CALL FireArtifactResolveRequestPrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, LPSTR &lpszArtifact);
class SAMLIdPServerArtifactResolveRequestPreparedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); const QString &Artifact(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ArtifactResolveRequestPrepared(SAMLIdPServerArtifactResolveRequestPreparedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireArtifactResolveRequestPrepared(SAMLIdPServerArtifactResolveRequestPreparedEventParams *e) {...}
Remarks
Subscribe to this event to be notified about preparation of artifact resolution requests. This is fired right after the resolution request has been prepared, and just before the component sends it out to the service provider.
ArtifactResolveRequestReceived Event (SAMLIdPServer Class)
Reports receipt of ArtifactResolveRequest message.
Syntax
ANSI (Cross Platform) virtual int FireArtifactResolveRequestReceived(SAMLIdPServerArtifactResolveRequestReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
int IsEncrypted;
int IsSigned;
const char *Artifact;
int Action; int reserved; } SAMLIdPServerArtifactResolveRequestReceivedEventParams;
Unicode (Windows) virtual INT FireArtifactResolveRequestReceived(SAMLIdPServerArtifactResolveRequestReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
BOOL IsEncrypted;
BOOL IsSigned;
LPCWSTR Artifact;
INT Action; INT reserved; } SAMLIdPServerArtifactResolveRequestReceivedEventParams;
#define EID_SAMLIDPSERVER_ARTIFACTRESOLVEREQUESTRECEIVED 4 virtual INT SECUREBLACKBOX_CALL FireArtifactResolveRequestReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, BOOL &bIsEncrypted, BOOL &bIsSigned, LPSTR &lpszArtifact, INT &iAction);
class SAMLIdPServerArtifactResolveRequestReceivedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); bool IsEncrypted(); bool IsSigned(); const QString &Artifact(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ArtifactResolveRequestReceived(SAMLIdPServerArtifactResolveRequestReceivedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireArtifactResolveRequestReceived(SAMLIdPServerArtifactResolveRequestReceivedEventParams *e) {...}
Remarks
The component fires this event to report receipt of incoming artifact resolution request. The Artifact parameter contains the artifact identifier received.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
AssertionPrepared Event (SAMLIdPServer Class)
This event fires when a new assertion has been prepared by the IdP server.
Syntax
ANSI (Cross Platform) virtual int FireAssertionPrepared(SAMLIdPServerAssertionPreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
const char *Body;
const char *Auth;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex;
const char *Attributes;
const char *ValidFrom;
const char *ValidTo; int reserved; } SAMLIdPServerAssertionPreparedEventParams;
Unicode (Windows) virtual INT FireAssertionPrepared(SAMLIdPServerAssertionPreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
LPCWSTR Body;
LPCWSTR Auth;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex;
LPCWSTR Attributes;
LPCWSTR ValidFrom;
LPCWSTR ValidTo; INT reserved; } SAMLIdPServerAssertionPreparedEventParams;
#define EID_SAMLIDPSERVER_ASSERTIONPREPARED 5 virtual INT SECUREBLACKBOX_CALL FireAssertionPrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, LPSTR &lpszBody, LPSTR &lpszAuth, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, LPSTR &lpszAttributes, LPSTR &lpszValidFrom, LPSTR &lpszValidTo);
class SAMLIdPServerAssertionPreparedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); const QString &Body(); const QString &Auth(); const QString &NameID(); const QString &NameIDFormat(); const QString &SessionIndex(); const QString &Attributes(); const QString &ValidFrom(); const QString &ValidTo(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AssertionPrepared(SAMLIdPServerAssertionPreparedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireAssertionPrepared(SAMLIdPServerAssertionPreparedEventParams *e) {...}
Remarks
The component fires this event when it has prepared an assertion to be sent to the SP as part of the authentication process. This event may fire from within ProcessSignOnRequest and ProcessSignOnResponse calls when working in OfflineMode, and at any time otherwise.
The RequestID parameter contains the request ID, in response to which the assertion was created. The SP parameter contains the identifier of the service provider where the assertion will be sent to. The Body parameter contains the assertion itself in XML format. The NameID parameter contains the name identifier of the authenticated user, and SessionIndex the unique session index of the new session. The ValidFrom and ValidTo parameters specify the validity period of the assertion.
AttributeQueryReceived Event (SAMLIdPServer Class)
Notifies the application about receipt of an AttributeQuery.
Syntax
ANSI (Cross Platform) virtual int FireAttributeQueryReceived(SAMLIdPServerAttributeQueryReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
int IsEncrypted;
int IsSigned;
const char *NameID;
const char *NameIDFormat;
const char *Attributes;
int Action; int reserved; } SAMLIdPServerAttributeQueryReceivedEventParams;
Unicode (Windows) virtual INT FireAttributeQueryReceived(SAMLIdPServerAttributeQueryReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
BOOL IsEncrypted;
BOOL IsSigned;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR Attributes;
INT Action; INT reserved; } SAMLIdPServerAttributeQueryReceivedEventParams;
#define EID_SAMLIDPSERVER_ATTRIBUTEQUERYRECEIVED 6 virtual INT SECUREBLACKBOX_CALL FireAttributeQueryReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, BOOL &bIsEncrypted, BOOL &bIsSigned, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszAttributes, INT &iAction);
class SAMLIdPServerAttributeQueryReceivedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); bool IsEncrypted(); bool IsSigned(); const QString &NameID(); const QString &NameIDFormat(); const QString &Attributes(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AttributeQueryReceived(SAMLIdPServerAttributeQueryReceivedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireAttributeQueryReceived(SAMLIdPServerAttributeQueryReceivedEventParams *e) {...}
Remarks
The component fires this event to notify the application of receipt of an AttributeQuery message. The parameters of the event detail the properties included in the request. The NameID and NameIDFormat specify the subject, and the Attributes string contains a list of attributes being requested.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
If the application chooses to process the request manually, the component will go ahead to fire ReadAttribute event repeatedly for each attribute in the list. The application must subscribe to the event and return the attribute parameters and values from there.
AuthnRequestReceived Event (SAMLIdPServer Class)
The server fires this event upon receiving an AuthnRequest message from the other side.
Syntax
ANSI (Cross Platform) virtual int FireAuthnRequestReceived(SAMLIdPServerAuthnRequestReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
int IsEncrypted;
int IsSigned;
char *NameIDFormat;
int ForceAuthn;
int NonInteractive;
int Authenticated;
int Action; int reserved; } SAMLIdPServerAuthnRequestReceivedEventParams;
Unicode (Windows) virtual INT FireAuthnRequestReceived(SAMLIdPServerAuthnRequestReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
BOOL IsEncrypted;
BOOL IsSigned;
LPWSTR NameIDFormat;
BOOL ForceAuthn;
BOOL NonInteractive;
BOOL Authenticated;
INT Action; INT reserved; } SAMLIdPServerAuthnRequestReceivedEventParams;
#define EID_SAMLIDPSERVER_AUTHNREQUESTRECEIVED 7 virtual INT SECUREBLACKBOX_CALL FireAuthnRequestReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, BOOL &bIsEncrypted, BOOL &bIsSigned, LPSTR &lpszNameIDFormat, BOOL &bForceAuthn, BOOL &bNonInteractive, BOOL &bAuthenticated, INT &iAction);
class SAMLIdPServerAuthnRequestReceivedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); bool IsEncrypted(); bool IsSigned(); const QString &NameIDFormat(); void SetNameIDFormat(const QString &qsNameIDFormat); bool ForceAuthn(); void SetForceAuthn(bool bForceAuthn); bool NonInteractive(); void SetNonInteractive(bool bNonInteractive); bool Authenticated(); void SetAuthenticated(bool bAuthenticated); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AuthnRequestReceived(SAMLIdPServerAuthnRequestReceivedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireAuthnRequestReceived(SAMLIdPServerAuthnRequestReceivedEventParams *e) {...}
Remarks
The event reports the details of the received AuthnRequest message. The ForceAuthn and NonInteractive parameters contain optional suggestions included in the request. The Authenticated parameter specifies whether the user has already been authenticated within this session. All the three parameters can be adjusted in the event handler to direct the authentication logic in the required direction.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
In OfflineMode this event would typically be fired from ProcessSignOnRequest call.
Connect Event (SAMLIdPServer Class)
Reports an accepted connection.
Syntax
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 8 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
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 9 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
ANSI (Cross Platform) virtual int FireError(SAMLIdPServerErrorEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
int ErrorCode;
int Fatal;
int Remote;
const char *Description; int reserved; } SAMLIdPServerErrorEventParams;
Unicode (Windows) virtual INT FireError(SAMLIdPServerErrorEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
INT ErrorCode;
BOOL Fatal;
BOOL Remote;
LPCWSTR Description; INT reserved; } SAMLIdPServerErrorEventParams;
#define EID_SAMLIDPSERVER_ERROR 10 virtual INT SECUREBLACKBOX_CALL FireError(LONG64 &lConnectionID, LPSTR &lpszSessionID, INT &iErrorCode, BOOL &bFatal, BOOL &bRemote, LPSTR &lpszDescription);
class SAMLIdPServerErrorEventParams { public: qint64 ConnectionID(); const QString &SessionID(); int ErrorCode(); bool Fatal(); bool Remote(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(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
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 11 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 class via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
LogoutRequestPrepared Event (SAMLIdPServer Class)
This event is fired when a new logout request has been prepared.
Syntax
ANSI (Cross Platform) virtual int FireLogoutRequestPrepared(SAMLIdPServerLogoutRequestPreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex;
char *RelayState; int reserved; } SAMLIdPServerLogoutRequestPreparedEventParams;
Unicode (Windows) virtual INT FireLogoutRequestPrepared(SAMLIdPServerLogoutRequestPreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex;
LPWSTR RelayState; INT reserved; } SAMLIdPServerLogoutRequestPreparedEventParams;
#define EID_SAMLIDPSERVER_LOGOUTREQUESTPREPARED 12 virtual INT SECUREBLACKBOX_CALL FireLogoutRequestPrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, LPSTR &lpszRelayState);
class SAMLIdPServerLogoutRequestPreparedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); const QString &NameID(); const QString &NameIDFormat(); const QString &SessionIndex(); const QString &RelayState(); void SetRelayState(const QString &qsRelayState); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void LogoutRequestPrepared(SAMLIdPServerLogoutRequestPreparedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireLogoutRequestPrepared(SAMLIdPServerLogoutRequestPreparedEventParams *e) {...}
Remarks
The component uses this event to report completion of the LogoutRequest preparation. The NameID, NameIDFormat, and SessionIndex parameters indicate the subject that is being logged out. The SP parameter references the service provider involved.
The RelayState contains the relay state value that is going to be passed with the LogoutRequest to the remote party and mirrored back (if the protocol supports it).
LogoutRequestReceived Event (SAMLIdPServer Class)
The class uses this event to notify the application about an incoming SAML Logout Request message.
Syntax
ANSI (Cross Platform) virtual int FireLogoutRequestReceived(SAMLIdPServerLogoutRequestReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
int IsEncrypted;
int IsSigned;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex;
int Action; int reserved; } SAMLIdPServerLogoutRequestReceivedEventParams;
Unicode (Windows) virtual INT FireLogoutRequestReceived(SAMLIdPServerLogoutRequestReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
BOOL IsEncrypted;
BOOL IsSigned;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex;
INT Action; INT reserved; } SAMLIdPServerLogoutRequestReceivedEventParams;
#define EID_SAMLIDPSERVER_LOGOUTREQUESTRECEIVED 13 virtual INT SECUREBLACKBOX_CALL FireLogoutRequestReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, BOOL &bIsEncrypted, BOOL &bIsSigned, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, INT &iAction);
class SAMLIdPServerLogoutRequestReceivedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); bool IsEncrypted(); bool IsSigned(); const QString &NameID(); const QString &NameIDFormat(); const QString &SessionIndex(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void LogoutRequestReceived(SAMLIdPServerLogoutRequestReceivedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireLogoutRequestReceived(SAMLIdPServerLogoutRequestReceivedEventParams *e) {...}
Remarks
The SAML IdP server fires this event when a SAML logout request is received at a single logout service endpoint. The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
LogoutResponsePrepared Event (SAMLIdPServer Class)
The class uses this event to notify the application about the Logout Response message being ready to be sent.
Syntax
ANSI (Cross Platform) virtual int FireLogoutResponsePrepared(SAMLIdPServerLogoutResponsePreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
const char *Body;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex; int reserved; } SAMLIdPServerLogoutResponsePreparedEventParams;
Unicode (Windows) virtual INT FireLogoutResponsePrepared(SAMLIdPServerLogoutResponsePreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
LPCWSTR Body;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex; INT reserved; } SAMLIdPServerLogoutResponsePreparedEventParams;
#define EID_SAMLIDPSERVER_LOGOUTRESPONSEPREPARED 14 virtual INT SECUREBLACKBOX_CALL FireLogoutResponsePrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, LPSTR &lpszBody, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex);
class SAMLIdPServerLogoutResponsePreparedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); const QString &Body(); const QString &NameID(); const QString &NameIDFormat(); const QString &SessionIndex(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void LogoutResponsePrepared(SAMLIdPServerLogoutResponsePreparedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireLogoutResponsePrepared(SAMLIdPServerLogoutResponsePreparedEventParams *e) {...}
Remarks
The IdP server fires this event when it has prepared a Logout Response message and is ready to send it out to the SP.
LogoutResponseReceived Event (SAMLIdPServer Class)
The class uses this event to notify the application about an incoming SAML LogoutResponse message.
Syntax
ANSI (Cross Platform) virtual int FireLogoutResponseReceived(SAMLIdPServerLogoutResponseReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
int IsEncrypted;
int IsSigned;
const char *NameID;
const char *NameIDFormat;
const char *SessionIndex;
const char *RelayState;
int Action; int reserved; } SAMLIdPServerLogoutResponseReceivedEventParams;
Unicode (Windows) virtual INT FireLogoutResponseReceived(SAMLIdPServerLogoutResponseReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
BOOL IsEncrypted;
BOOL IsSigned;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPCWSTR SessionIndex;
LPCWSTR RelayState;
INT Action; INT reserved; } SAMLIdPServerLogoutResponseReceivedEventParams;
#define EID_SAMLIDPSERVER_LOGOUTRESPONSERECEIVED 15 virtual INT SECUREBLACKBOX_CALL FireLogoutResponseReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, BOOL &bIsEncrypted, BOOL &bIsSigned, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, LPSTR &lpszRelayState, INT &iAction);
class SAMLIdPServerLogoutResponseReceivedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); bool IsEncrypted(); bool IsSigned(); const QString &NameID(); const QString &NameIDFormat(); const QString &SessionIndex(); const QString &RelayState(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void LogoutResponseReceived(SAMLIdPServerLogoutResponseReceivedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireLogoutResponseReceived(SAMLIdPServerLogoutResponseReceivedEventParams *e) {...}
Remarks
The SAML IdP server fires this event when a SAML logout response is received at a single logout service endpoint following the LogoutRequest sent earlier. The RelayState is a mirrored back value included in the request.
The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
NewAssertion Event (SAMLIdPServer Class)
This event reports a new assertion initiated by the IdP server.
Syntax
ANSI (Cross Platform) virtual int FireNewAssertion(SAMLIdPServerNewAssertionEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
int Reason;
char *AuthInstant;
char *AuthContext;
char *NameID;
char *NameIDFormat;
char *SessionIndex;
char *Attributes;
char *ValidFrom;
char *ValidTo;
int Sign;
int Encrypt; int reserved; } SAMLIdPServerNewAssertionEventParams;
Unicode (Windows) virtual INT FireNewAssertion(SAMLIdPServerNewAssertionEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
INT Reason;
LPWSTR AuthInstant;
LPWSTR AuthContext;
LPWSTR NameID;
LPWSTR NameIDFormat;
LPWSTR SessionIndex;
LPWSTR Attributes;
LPWSTR ValidFrom;
LPWSTR ValidTo;
BOOL Sign;
BOOL Encrypt; INT reserved; } SAMLIdPServerNewAssertionEventParams;
#define EID_SAMLIDPSERVER_NEWASSERTION 16 virtual INT SECUREBLACKBOX_CALL FireNewAssertion(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, INT &iReason, LPSTR &lpszAuthInstant, LPSTR &lpszAuthContext, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, LPSTR &lpszAttributes, LPSTR &lpszValidFrom, LPSTR &lpszValidTo, BOOL &bSign, BOOL &bEncrypt);
class SAMLIdPServerNewAssertionEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); int Reason(); const QString &AuthInstant(); void SetAuthInstant(const QString &qsAuthInstant); const QString &AuthContext(); void SetAuthContext(const QString &qsAuthContext); const QString &NameID(); void SetNameID(const QString &qsNameID); const QString &NameIDFormat(); void SetNameIDFormat(const QString &qsNameIDFormat); const QString &SessionIndex(); void SetSessionIndex(const QString &qsSessionIndex); const QString &Attributes(); void SetAttributes(const QString &qsAttributes); const QString &ValidFrom(); void SetValidFrom(const QString &qsValidFrom); const QString &ValidTo(); void SetValidTo(const QString &qsValidTo); bool Sign(); void SetSign(bool bSign); bool Encrypt(); void SetEncrypt(bool bEncrypt); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void NewAssertion(SAMLIdPServerNewAssertionEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireNewAssertion(SAMLIdPServerNewAssertionEventParams *e) {...}
Remarks
The component fires this event when it is about to preapre an assertion to be sent to the SP as part of the authentication or attribute request process. This event may fire from within the ProcessSignOnRequest and ProcessSignOnResponse calls when working in OfflineMode, and at any time otherwise.
The RequestID parameter contains the request ID, in response to which the assertion is being created. The SP parameter contains the identifier of the service provider where the assertion will be sent to.
The Reason parameter contains the reason for the assertion to be generated. This can be an authentication request or an attribute request being received. The AuthInstant, AuthContext, NameID, SessionIndex, Attributes, ValidFrom, and ValidTo parameters indicate the initial parameters of the new assertion. Further events, such as ReadAttribute or AssertionPrepared will be fired later on to clarify the contents of the assertion.
Notification Event (SAMLIdPServer Class)
This event notifies the application about an underlying control flow event.
Syntax
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 17 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 class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
This class can fire this event with the following EventID values:
ListeningStarted | Notifies the application that the server has started listening for incoming connections. |
ListeningStopped | Notifies the application that the server has stopped listening to incoming connections. |
ProcessingCompleted Event (SAMLIdPServer Class)
This event notifies the application of the completion of request or response processing.
Syntax
ANSI (Cross Platform) virtual int FireProcessingCompleted(SAMLIdPServerProcessingCompletedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *Tag;
int ProcessingResult;
const char *Response;
int Redirect; int reserved; } SAMLIdPServerProcessingCompletedEventParams;
Unicode (Windows) virtual INT FireProcessingCompleted(SAMLIdPServerProcessingCompletedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR Tag;
INT ProcessingResult;
LPCWSTR Response;
BOOL Redirect; INT reserved; } SAMLIdPServerProcessingCompletedEventParams;
#define EID_SAMLIDPSERVER_PROCESSINGCOMPLETED 18 virtual INT SECUREBLACKBOX_CALL FireProcessingCompleted(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszTag, INT &iProcessingResult, LPSTR &lpszResponse, BOOL &bRedirect);
class SAMLIdPServerProcessingCompletedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &Tag(); int ProcessingResult(); const QString &Response(); bool Redirect(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ProcessingCompleted(SAMLIdPServerProcessingCompletedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireProcessingCompleted(SAMLIdPServerProcessingCompletedEventParams *e) {...}
Remarks
The component fires ProcessingCompleted to notify the application about completion of an earlier initiated processing operation. It is only fired in OfflineMode in response to calls such as ProcessSignOnRequest, ProcessSignOnResponse, or similar. The main purpose of this event is to notify the application of the outcomes of the processing and return any prepared SAML entity for subsequent relay to the browser.
This event is fired strictly once for each Process* call, with the ConnectionID matching the value passed to the Process* method.
The SessionID parameter contains the identifier of the current virtual session. It may differ to the value passed to the Process* method if the session information was provided on the fly via the SessionInfoNeeded event. The ProcessingResult indicates the type of deliverable that was created during the processing (see below for possible values). The Response parameter contains the body of the deliverable. This can take one of the forms:
- a self-submitting form containing a SAML message.
- a redirect URL.
- a web page containing a login form.
- a SOAP XML response.
- an empty string if ProcessingResult is set to sprSuccess.
The Redirect parameter indicates whether the value of Response should be passed to the browser within the 302 Location header, or as a document body.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
ReadArtifact Event (SAMLIdPServer Class)
Requests content identified by an artifact from the application.
Syntax
ANSI (Cross Platform) virtual int FireReadArtifact(SAMLIdPServerReadArtifactEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
const char *Artifact;
char *Value;
int Skip; int reserved; } SAMLIdPServerReadArtifactEventParams;
Unicode (Windows) virtual INT FireReadArtifact(SAMLIdPServerReadArtifactEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
LPCWSTR Artifact;
LPWSTR Value;
BOOL Skip; INT reserved; } SAMLIdPServerReadArtifactEventParams;
#define EID_SAMLIDPSERVER_READARTIFACT 19 virtual INT SECUREBLACKBOX_CALL FireReadArtifact(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, LPSTR &lpszArtifact, LPSTR &lpszValue, BOOL &bSkip);
class SAMLIdPServerReadArtifactEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); const QString &Artifact(); const QString &Value(); void SetValue(const QString &qsValue); bool Skip(); void SetSkip(bool bSkip); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReadArtifact(SAMLIdPServerReadArtifactEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireReadArtifact(SAMLIdPServerReadArtifactEventParams *e) {...}
Remarks
The component fires this event to request the content matching Artifact from the application. This is normally happens within the artifact resolution protocol between an SP and the IdP server.
The application must provide the requested artifact content via the Value parameter. The application can choose not to provide the artifact content (for example, if it doesn't have it) by setting Skip to true.
ReadAttribute Event (SAMLIdPServer Class)
Requests an attribute from the application.
Syntax
ANSI (Cross Platform) virtual int FireReadAttribute(SAMLIdPServerReadAttributeEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
const char *NameID;
const char *NameIDFormat;
char *AttrName;
char *AttrNameFormat;
char *AttrFriendlyName;
char *Value;
int Skip; int reserved; } SAMLIdPServerReadAttributeEventParams;
Unicode (Windows) virtual INT FireReadAttribute(SAMLIdPServerReadAttributeEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
LPCWSTR NameID;
LPCWSTR NameIDFormat;
LPWSTR AttrName;
LPWSTR AttrNameFormat;
LPWSTR AttrFriendlyName;
LPWSTR Value;
BOOL Skip; INT reserved; } SAMLIdPServerReadAttributeEventParams;
#define EID_SAMLIDPSERVER_READATTRIBUTE 20 virtual INT SECUREBLACKBOX_CALL FireReadAttribute(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszAttrName, LPSTR &lpszAttrNameFormat, LPSTR &lpszAttrFriendlyName, LPSTR &lpszValue, BOOL &bSkip);
class SAMLIdPServerReadAttributeEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); const QString &NameID(); const QString &NameIDFormat(); const QString &AttrName(); void SetAttrName(const QString &qsAttrName); const QString &AttrNameFormat(); void SetAttrNameFormat(const QString &qsAttrNameFormat); const QString &AttrFriendlyName(); void SetAttrFriendlyName(const QString &qsAttrFriendlyName); const QString &Value(); void SetValue(const QString &qsValue); bool Skip(); void SetSkip(bool bSkip); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReadAttribute(SAMLIdPServerReadAttributeEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireReadAttribute(SAMLIdPServerReadAttributeEventParams *e) {...}
Remarks
The component fires this event to request an attribute from the application. This event can be invoked multiple times after the AttributeQueryReceived event has fired, to collect every attribute requested.
The application is expected to set the Value and, optionally, AttrNameFormat and AttrFriendlyName for every attribute requested. The AttrName mathes the name requested by the remote party, but the event handler can change it too if required.
If the application has no knowledge of or does not support the AttrName attribute, it can set Skip to true to avoid sending it.
ResourceClose Event (SAMLIdPServer Class)
Tells the application that it can close the opened resource.
Syntax
ANSI (Cross Platform) virtual int FireResourceClose(SAMLIdPServerResourceCloseEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *Handle; int reserved; } SAMLIdPServerResourceCloseEventParams;
Unicode (Windows) virtual INT FireResourceClose(SAMLIdPServerResourceCloseEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR Handle; INT reserved; } SAMLIdPServerResourceCloseEventParams;
#define EID_SAMLIDPSERVER_RESOURCECLOSE 21 virtual INT SECUREBLACKBOX_CALL FireResourceClose(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszHandle);
class SAMLIdPServerResourceCloseEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &Handle(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceClose(SAMLIdPServerResourceCloseEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireResourceClose(SAMLIdPServerResourceCloseEventParams *e) {...}
Remarks
The class uses this event to notify the application that it can now close the resource opened earlier in its ResourceOpen handler.
ResourceOpen Event (SAMLIdPServer Class)
Requests the application to open the requested resource.
Syntax
ANSI (Cross Platform) virtual int FireResourceOpen(SAMLIdPServerResourceOpenEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *URL;
const char *HttpMethod;
int OperationStatus;
char *Handle; int reserved; } SAMLIdPServerResourceOpenEventParams;
Unicode (Windows) virtual INT FireResourceOpen(SAMLIdPServerResourceOpenEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR URL;
LPCWSTR HttpMethod;
INT OperationStatus;
LPWSTR Handle; INT reserved; } SAMLIdPServerResourceOpenEventParams;
#define EID_SAMLIDPSERVER_RESOURCEOPEN 22 virtual INT SECUREBLACKBOX_CALL FireResourceOpen(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszURL, LPSTR &lpszHttpMethod, INT &iOperationStatus, LPSTR &lpszHandle);
class SAMLIdPServerResourceOpenEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &URL(); const QString &HttpMethod(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); const QString &Handle(); void SetHandle(const QString &qsHandle); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceOpen(SAMLIdPServerResourceOpenEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireResourceOpen(SAMLIdPServerResourceOpenEventParams *e) {...}
Remarks
The class fires this event in virtualized mode if the application had returned the fraCustom modifier from the earlier ResourceRequest event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent ResourceRead event calls. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRead Event (SAMLIdPServer Class)
Requests the application to read from an opened resource.
Syntax
ANSI (Cross Platform) virtual int FireResourceRead(SAMLIdPServerResourceReadEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *Handle;
int Size;
int OperationStatus; int reserved; } SAMLIdPServerResourceReadEventParams;
Unicode (Windows) virtual INT FireResourceRead(SAMLIdPServerResourceReadEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR Handle;
INT Size;
INT OperationStatus; INT reserved; } SAMLIdPServerResourceReadEventParams;
#define EID_SAMLIDPSERVER_RESOURCEREAD 23 virtual INT SECUREBLACKBOX_CALL FireResourceRead(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszHandle, INT &iSize, INT &iOperationStatus);
class SAMLIdPServerResourceReadEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &Handle(); int Size(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceRead(SAMLIdPServerResourceReadEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireResourceRead(SAMLIdPServerResourceReadEventParams *e) {...}
Remarks
The class fires this event in virtualized mode to request another chunk of data from the resource opened earlier. The handler of this event should read up to Size bytes from the object, and pass them to the component with a SetClientBuffer call.
Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ResourceRead calls are needed.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRequest Event (SAMLIdPServer Class)
Notifies the application that a server resource is requested.
Syntax
ANSI (Cross Platform) virtual int FireResourceRequest(SAMLIdPServerResourceRequestEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *URL;
const char *HttpMethod;
int ResProtected;
int ResSpecial;
int AllowWriting;
int Action; int reserved; } SAMLIdPServerResourceRequestEventParams;
Unicode (Windows) virtual INT FireResourceRequest(SAMLIdPServerResourceRequestEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR URL;
LPCWSTR HttpMethod;
BOOL ResProtected;
BOOL ResSpecial;
BOOL AllowWriting;
INT Action; INT reserved; } SAMLIdPServerResourceRequestEventParams;
#define EID_SAMLIDPSERVER_RESOURCEREQUEST 24 virtual INT SECUREBLACKBOX_CALL FireResourceRequest(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszURL, LPSTR &lpszHttpMethod, BOOL &bResProtected, BOOL &bResSpecial, BOOL &bAllowWriting, INT &iAction);
class SAMLIdPServerResourceRequestEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &URL(); const QString &HttpMethod(); bool ResProtected(); void SetResProtected(bool bResProtected); bool ResSpecial(); void SetResSpecial(bool bResSpecial); bool AllowWriting(); void SetAllowWriting(bool bAllowWriting); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceRequest(SAMLIdPServerResourceRequestEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireResourceRequest(SAMLIdPServerResourceRequestEventParams *e) {...}
Remarks
The class uses this event to notify the application that the connection has requested a server resource.
The URL parameter specifies the resource requested. ResProtected is set to true if the resource is protected by SAML. ResSpecial is set to true if the request is a SAML resource, such as the metadata or an Assertion Consumer Service page. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request).
This event may fire more than once for one resource if the client is forced to re-submit the request with a session cookie.
Choose Action as one of the following values:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
ResourceWrite Event (SAMLIdPServer Class)
Requests the application to write to an opened resource.
Syntax
ANSI (Cross Platform) virtual int FireResourceWrite(SAMLIdPServerResourceWriteEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *Handle;
int OperationStatus; int reserved; } SAMLIdPServerResourceWriteEventParams;
Unicode (Windows) virtual INT FireResourceWrite(SAMLIdPServerResourceWriteEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR Handle;
INT OperationStatus; INT reserved; } SAMLIdPServerResourceWriteEventParams;
#define EID_SAMLIDPSERVER_RESOURCEWRITE 25 virtual INT SECUREBLACKBOX_CALL FireResourceWrite(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszHandle, INT &iOperationStatus);
class SAMLIdPServerResourceWriteEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &Handle(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceWrite(SAMLIdPServerResourceWriteEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireResourceWrite(SAMLIdPServerResourceWriteEventParams *e) {...}
Remarks
The class fires this event in virtualized mode to pass another chunk of data to a resource opened earlier. This event is called for write-enabled requests, such as POST or PUT. The handler of this event should read the pending data using the GetClientBuffer method and write them to the opened file descriptor.
Use the OperationStatus parameter to return the operation result back to the server:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
SAMLMessagePrepared Event (SAMLIdPServer Class)
This event is fired when a SAML message has been prepared and is ready to be dispatched.
Syntax
ANSI (Cross Platform) virtual int FireSAMLMessagePrepared(SAMLIdPServerSAMLMessagePreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *MessageID;
const char *Destination;
const char *IssueInstant;
const char *InResponseTo;
const char *RequestBody;
const char *MessageType;
char *MessageBody;
int Success; int reserved; } SAMLIdPServerSAMLMessagePreparedEventParams;
Unicode (Windows) virtual INT FireSAMLMessagePrepared(SAMLIdPServerSAMLMessagePreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR MessageID;
LPCWSTR Destination;
LPCWSTR IssueInstant;
LPCWSTR InResponseTo;
LPCWSTR RequestBody;
LPCWSTR MessageType;
LPWSTR MessageBody;
BOOL Success; INT reserved; } SAMLIdPServerSAMLMessagePreparedEventParams;
#define EID_SAMLIDPSERVER_SAMLMESSAGEPREPARED 26 virtual INT SECUREBLACKBOX_CALL FireSAMLMessagePrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszMessageID, LPSTR &lpszDestination, LPSTR &lpszIssueInstant, LPSTR &lpszInResponseTo, LPSTR &lpszRequestBody, LPSTR &lpszMessageType, LPSTR &lpszMessageBody, BOOL &bSuccess);
class SAMLIdPServerSAMLMessagePreparedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &MessageID(); const QString &Destination(); const QString &IssueInstant(); const QString &InResponseTo(); const QString &RequestBody(); const QString &MessageType(); const QString &MessageBody(); void SetMessageBody(const QString &qsMessageBody); bool Success(); void SetSuccess(bool bSuccess); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SAMLMessagePrepared(SAMLIdPServerSAMLMessagePreparedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSAMLMessagePrepared(SAMLIdPServerSAMLMessagePreparedEventParams *e) {...}
Remarks
Subscribe to this event to be notified about every SAML message that has been prepared by the server. This event is fired for every type of the outgoing message (e.g. SAMLResponse, LogoutRequest, or IdP metadata). The InResponseTo contains the ID of the message in response to which the current message is sent (if applicable). The RequestBody parameter contains the body of such request.
The MessageType parameter indicates the type of the message that has been prepared, such as SAMLResponse. The MessageBody contains the XML body of the message. The Success parameter indicates whether the message contains a positive statement or an error. Both the MessageBody and Success parameters are adjustable.
SAMLMessageReceived Event (SAMLIdPServer Class)
The server fires this event for every SAML message it receives.
Syntax
ANSI (Cross Platform) virtual int FireSAMLMessageReceived(SAMLIdPServerSAMLMessageReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *MessageID;
const char *Issuer;
const char *IssueInstant;
const char *InResponseTo;
const char *RequestBody;
const char *MessageType;
const char *MessageBody;
int IsSigned;
int Action; int reserved; } SAMLIdPServerSAMLMessageReceivedEventParams;
Unicode (Windows) virtual INT FireSAMLMessageReceived(SAMLIdPServerSAMLMessageReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR MessageID;
LPCWSTR Issuer;
LPCWSTR IssueInstant;
LPCWSTR InResponseTo;
LPCWSTR RequestBody;
LPCWSTR MessageType;
LPCWSTR MessageBody;
BOOL IsSigned;
INT Action; INT reserved; } SAMLIdPServerSAMLMessageReceivedEventParams;
#define EID_SAMLIDPSERVER_SAMLMESSAGERECEIVED 27 virtual INT SECUREBLACKBOX_CALL FireSAMLMessageReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszMessageID, LPSTR &lpszIssuer, LPSTR &lpszIssueInstant, LPSTR &lpszInResponseTo, LPSTR &lpszRequestBody, LPSTR &lpszMessageType, LPSTR &lpszMessageBody, BOOL &bIsSigned, INT &iAction);
class SAMLIdPServerSAMLMessageReceivedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &MessageID(); const QString &Issuer(); const QString &IssueInstant(); const QString &InResponseTo(); const QString &RequestBody(); const QString &MessageType(); const QString &MessageBody(); bool IsSigned(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SAMLMessageReceived(SAMLIdPServerSAMLMessageReceivedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSAMLMessageReceived(SAMLIdPServerSAMLMessageReceivedEventParams *e) {...}
Remarks
Subscribe to this event to be notified about incoming SAML messages.
The MessageType, MessageID, Issuer, and MessageBody parameters provide the details of the message received. The RequestBody and InResponseTo contain a reference to the request that this message is a response to (if any).
Set Action property as required to let the component know how to proceed.
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
SessionCreated Event (SAMLIdPServer Class)
This event is fired when a new session has been established.
Syntax
ANSI (Cross Platform) virtual int FireSessionCreated(SAMLIdPServerSessionCreatedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID; int reserved; } SAMLIdPServerSessionCreatedEventParams;
Unicode (Windows) virtual INT FireSessionCreated(SAMLIdPServerSessionCreatedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID; INT reserved; } SAMLIdPServerSessionCreatedEventParams;
#define EID_SAMLIDPSERVER_SESSIONCREATED 28 virtual INT SECUREBLACKBOX_CALL FireSessionCreated(LONG64 &lConnectionID, LPSTR &lpszSessionID);
class SAMLIdPServerSessionCreatedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SessionCreated(SAMLIdPServerSessionCreatedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSessionCreated(SAMLIdPServerSessionCreatedEventParams *e) {...}
Remarks
ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.
SessionDestroyed Event (SAMLIdPServer Class)
This event is fired when the IdP server has closed a session.
Syntax
ANSI (Cross Platform) virtual int FireSessionDestroyed(SAMLIdPServerSessionDestroyedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID; int reserved; } SAMLIdPServerSessionDestroyedEventParams;
Unicode (Windows) virtual INT FireSessionDestroyed(SAMLIdPServerSessionDestroyedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID; INT reserved; } SAMLIdPServerSessionDestroyedEventParams;
#define EID_SAMLIDPSERVER_SESSIONDESTROYED 29 virtual INT SECUREBLACKBOX_CALL FireSessionDestroyed(LONG64 &lConnectionID, LPSTR &lpszSessionID);
class SAMLIdPServerSessionDestroyedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SessionDestroyed(SAMLIdPServerSessionDestroyedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSessionDestroyed(SAMLIdPServerSessionDestroyedEventParams *e) {...}
Remarks
ConnectionID contains the identifier of the closed session.
SessionEvent Event (SAMLIdPServer Class)
Notifies the application about SAML session events.
Syntax
ANSI (Cross Platform) virtual int FireSessionEvent(SAMLIdPServerSessionEventEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *EventText; int reserved; } SAMLIdPServerSessionEventEventParams;
Unicode (Windows) virtual INT FireSessionEvent(SAMLIdPServerSessionEventEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR EventText; INT reserved; } SAMLIdPServerSessionEventEventParams;
#define EID_SAMLIDPSERVER_SESSIONEVENT 30 virtual INT SECUREBLACKBOX_CALL FireSessionEvent(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszEventText);
class SAMLIdPServerSessionEventEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &EventText(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SessionEvent(SAMLIdPServerSessionEventEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSessionEvent(SAMLIdPServerSessionEventEventParams *e) {...}
Remarks
class uses this event to notify your code about events that happen within the lifeline of a SAML session. Handling it may be useful for development, logging, and monitoring purposes.
The SessionID parameter specifies the session ID, and the EventText parameter describes the event that happened. Below are a few typical examples of what EventText you can expect to get:
- Start
- IdPSSOReceived
- AuthnRequestReceived
- ChallengePrepared
- CredentialsReceived
- ResponsePrepared
- LoggedIn
- LogoutRequestReceived
- LogoutResponsePrepared
- ArtifactResolveReceived
- ArtifactResponsePrepared
- AttributeQueryReceived
- AttributeResponsePrepared
- Finish
SessionInfoNeeded Event (SAMLIdPServer Class)
This event is fired in OfflineMode to request the session ID for the current flow.
Syntax
ANSI (Cross Platform) virtual int FireSessionInfoNeeded(SAMLIdPServerSessionInfoNeededEventParams *e);
typedef struct {
int64 ConnectionID;
char *SessionID; int reserved; } SAMLIdPServerSessionInfoNeededEventParams;
Unicode (Windows) virtual INT FireSessionInfoNeeded(SAMLIdPServerSessionInfoNeededEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPWSTR SessionID; INT reserved; } SAMLIdPServerSessionInfoNeededEventParams;
#define EID_SAMLIDPSERVER_SESSIONINFONEEDED 31 virtual INT SECUREBLACKBOX_CALL FireSessionInfoNeeded(LONG64 &lConnectionID, LPSTR &lpszSessionID);
class SAMLIdPServerSessionInfoNeededEventParams { public: qint64 ConnectionID(); const QString &SessionID(); void SetSessionID(const QString &qsSessionID); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SessionInfoNeeded(SAMLIdPServerSessionInfoNeededEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSessionInfoNeeded(SAMLIdPServerSessionInfoNeededEventParams *e) {...}
Remarks
SAML protocol is stateful, which means that SAML services need to keep session-related information between connections. When used in online mode - where the components listen and serve connections automatically - the components can use HTTP cookies to track connecting clients and maintain the session store at the background. However, when used in offline mode, the components do not have access to the HTTP layer and live too short for the session store to survive. That is why in offline mode the components rely on the application code to keep the session information for them.
The components use a collection of Session* events to exchange session information with the application:
- SessionCreated is called when the component establishes a new session. In offline mode, the application should associate the session ID with the connected user, for example by returning it as a cookie.
- SessionStateSave : the component passes the session state to the application and expects that the application saves it somewhere to return it back to the component at its request at some point in the future. The session state is an opaque string. The application can use a hash table to store a collection of (SessionID, SessionState) pairs over the lifetime of the SAML service. The server may fire SessionStateSave multiple times for the same SessionID. If this happens, the existing SessionID entry should be overwritten with the fresh session data.
- SessionStateRetrieve : the component passes a session ID to the application and expects it to return the session state saved in the hash table earlier. The application should not delete the state from the hash table, as it may be needed again.
- SessionInfoNeeded (this event): the component expects the application to return the session ID corresponding to the connection ID back to them. This event fires, for example, if the application calls ProcessLogoutRequest but passes an empty SessionID as a parameter.
- SessionDestroyed is called when a session is destroyed. The component can remove the session from the hash table upon receiving this event.
SessionStateRetrieve Event (SAMLIdPServer Class)
This event fires to retrieve session state information from the application.
Syntax
ANSI (Cross Platform) virtual int FireSessionStateRetrieve(SAMLIdPServerSessionStateRetrieveEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
char *SessionState; int reserved; } SAMLIdPServerSessionStateRetrieveEventParams;
Unicode (Windows) virtual INT FireSessionStateRetrieve(SAMLIdPServerSessionStateRetrieveEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPWSTR SessionState; INT reserved; } SAMLIdPServerSessionStateRetrieveEventParams;
#define EID_SAMLIDPSERVER_SESSIONSTATERETRIEVE 32 virtual INT SECUREBLACKBOX_CALL FireSessionStateRetrieve(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSessionState);
class SAMLIdPServerSessionStateRetrieveEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &SessionState(); void SetSessionState(const QString &qsSessionState); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SessionStateRetrieve(SAMLIdPServerSessionStateRetrieveEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSessionStateRetrieve(SAMLIdPServerSessionStateRetrieveEventParams *e) {...}
Remarks
The component fires this event to request a session state that was previously provided to the application via the SessionStateSave call.
See the SessionInfoNeeded topic for more details about session management in offline mode.
SessionStateSave Event (SAMLIdPServer Class)
This event passes a session state object to the application for safekeeping.
Syntax
ANSI (Cross Platform) virtual int FireSessionStateSave(SAMLIdPServerSessionStateSaveEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *SessionState; int reserved; } SAMLIdPServerSessionStateSaveEventParams;
Unicode (Windows) virtual INT FireSessionStateSave(SAMLIdPServerSessionStateSaveEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR SessionState; INT reserved; } SAMLIdPServerSessionStateSaveEventParams;
#define EID_SAMLIDPSERVER_SESSIONSTATESAVE 33 virtual INT SECUREBLACKBOX_CALL FireSessionStateSave(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSessionState);
class SAMLIdPServerSessionStateSaveEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &SessionState(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SessionStateSave(SAMLIdPServerSessionStateSaveEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSessionStateSave(SAMLIdPServerSessionStateSaveEventParams *e) {...}
Remarks
The component fires this event to pass a session state to the application. The application is expected to save the state object (which is an opaque string) in a hash table, and be ready to return it back to the component when it requests it using a SessionStateRetrieve call.
See the SessionInfoNeeded topic for more details about session management in offline mode.
SignatureFound Event (SAMLIdPServer Class)
Notifies the application about the start of signature validation.
Syntax
ANSI (Cross Platform) virtual int FireSignatureFound(SAMLIdPServerSignatureFoundEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
int Scope;
const char *Signer;
const char *TargetID;
const char *TargetType;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
const char *SigMethod;
const char *DigestMethod;
int CertFound;
int Validate; int reserved; } SAMLIdPServerSignatureFoundEventParams;
Unicode (Windows) virtual INT FireSignatureFound(SAMLIdPServerSignatureFoundEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
INT Scope;
LPCWSTR Signer;
LPCWSTR TargetID;
LPCWSTR TargetType;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
LPCWSTR SigMethod;
LPCWSTR DigestMethod;
BOOL CertFound;
BOOL Validate; INT reserved; } SAMLIdPServerSignatureFoundEventParams;
#define EID_SAMLIDPSERVER_SIGNATUREFOUND 34 virtual INT SECUREBLACKBOX_CALL FireSignatureFound(LONG64 &lConnectionID, LPSTR &lpszSessionID, INT &iScope, LPSTR &lpszSigner, LPSTR &lpszTargetID, LPSTR &lpszTargetType, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszSigMethod, LPSTR &lpszDigestMethod, BOOL &bCertFound, BOOL &bValidate);
class SAMLIdPServerSignatureFoundEventParams { public: qint64 ConnectionID(); const QString &SessionID(); int Scope(); const QString &Signer(); const QString &TargetID(); const QString &TargetType(); const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); const QString &SigMethod(); const QString &DigestMethod(); bool CertFound(); bool Validate(); void SetValidate(bool bValidate); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignatureFound(SAMLIdPServerSignatureFoundEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSignatureFound(SAMLIdPServerSignatureFoundEventParams *e) {...}
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified message.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion. The TargetID and TargetType provide additional details.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
The details of the reported signature are populated in the Security object. For assertion signatures, you can update the details by pinning the assertion.
The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the SigningCertificate property and the associated certificates from the Certificates collection, and pass them to the CertificateValidator component to validate its chain.
Use the Validate parameter to tell the reader whether it should validate the signature.
SignatureValidated Event (SAMLIdPServer Class)
Reports the signature validation result.
Syntax
ANSI (Cross Platform) virtual int FireSignatureValidated(SAMLIdPServerSignatureValidatedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
int Scope;
const char *Signer;
const char *TargetID;
const char *TargetType;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
const char *SigMethod;
const char *DigestMethod;
int ValidationResult; int reserved; } SAMLIdPServerSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(SAMLIdPServerSignatureValidatedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
INT Scope;
LPCWSTR Signer;
LPCWSTR TargetID;
LPCWSTR TargetType;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
LPCWSTR SigMethod;
LPCWSTR DigestMethod;
INT ValidationResult; INT reserved; } SAMLIdPServerSignatureValidatedEventParams;
#define EID_SAMLIDPSERVER_SIGNATUREVALIDATED 35 virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(LONG64 &lConnectionID, LPSTR &lpszSessionID, INT &iScope, LPSTR &lpszSigner, LPSTR &lpszTargetID, LPSTR &lpszTargetType, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszSigMethod, LPSTR &lpszDigestMethod, INT &iValidationResult);
class SAMLIdPServerSignatureValidatedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); int Scope(); const QString &Signer(); const QString &TargetID(); const QString &TargetType(); const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); const QString &SigMethod(); const QString &DigestMethod(); int ValidationResult(); void SetValidationResult(int iValidationResult); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignatureValidated(SAMLIdPServerSignatureValidatedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSignatureValidated(SAMLIdPServerSignatureValidatedEventParams *e) {...}
Remarks
This event is fired when the signature validation process is completed.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion. The TargetID and TargetType parameters provide the details.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
SignOnPagePrepared Event (SAMLIdPServer Class)
The server fires this event upon preparing the sign-on page.
Syntax
ANSI (Cross Platform) virtual int FireSignOnPagePrepared(SAMLIdPServerSignOnPagePreparedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
const char *SP;
const char *Request;
char *PageData;
int Redirect; int reserved; } SAMLIdPServerSignOnPagePreparedEventParams;
Unicode (Windows) virtual INT FireSignOnPagePrepared(SAMLIdPServerSignOnPagePreparedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPCWSTR SP;
LPCWSTR Request;
LPWSTR PageData;
BOOL Redirect; INT reserved; } SAMLIdPServerSignOnPagePreparedEventParams;
#define EID_SAMLIDPSERVER_SIGNONPAGEPREPARED 36 virtual INT SECUREBLACKBOX_CALL FireSignOnPagePrepared(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszSP, LPSTR &lpszRequest, LPSTR &lpszPageData, BOOL &bRedirect);
class SAMLIdPServerSignOnPagePreparedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &SP(); const QString &Request(); const QString &PageData(); void SetPageData(const QString &qsPageData); bool Redirect(); void SetRedirect(bool bRedirect); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignOnPagePrepared(SAMLIdPServerSignOnPagePreparedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSignOnPagePrepared(SAMLIdPServerSignOnPagePreparedEventParams *e) {...}
Remarks
The IdP server fires this event to notify the application that the sign-on page (login form) has been formed and is ready to be flushed. Use SignOnPageTemplate to assign the sign-on page template.
The form body is returned via the PageData parameter. You can adjust it in the event handler as required. The Redirect parameter advises whether the form should be returned as a Location header of the HTTP response with the 302 status, or as an HTTP body of text/html type.
SignOnResponseReceived Event (SAMLIdPServer Class)
Notifies the application about the received response to the sign-on page.
Syntax
ANSI (Cross Platform) virtual int FireSignOnResponseReceived(SAMLIdPServerSignOnResponseReceivedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *RequestID;
char *ResponseData;
int Action; int reserved; } SAMLIdPServerSignOnResponseReceivedEventParams;
Unicode (Windows) virtual INT FireSignOnResponseReceived(SAMLIdPServerSignOnResponseReceivedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR RequestID;
LPWSTR ResponseData;
INT Action; INT reserved; } SAMLIdPServerSignOnResponseReceivedEventParams;
#define EID_SAMLIDPSERVER_SIGNONRESPONSERECEIVED 37 virtual INT SECUREBLACKBOX_CALL FireSignOnResponseReceived(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszRequestID, LPSTR &lpszResponseData, INT &iAction);
class SAMLIdPServerSignOnResponseReceivedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &RequestID(); const QString &ResponseData(); void SetResponseData(const QString &qsResponseData); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignOnResponseReceived(SAMLIdPServerSignOnResponseReceivedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireSignOnResponseReceived(SAMLIdPServerSignOnResponseReceivedEventParams *e) {...}
Remarks
The component uses this event to report that the login form previously generated by the component has been filled in and returned by the user. ResponseData contains the content submitted by the user (the URL-encoded form fields, or any authentication data if the custom authentication flow is used). The application that chose to use custom authentication process can use this data to authenticate the user.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
TLSCertValidate Event (SAMLIdPServer Class)
Fires when a client certificate needs to be validated.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertValidate(SAMLIdPServerTLSCertValidateEventParams *e);
typedef struct {
int64 ConnectionID;
int Accept; int reserved; } SAMLIdPServerTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(SAMLIdPServerTLSCertValidateEventParams *e);
typedef struct {
LONG64 ConnectionID;
BOOL Accept; INT reserved; } SAMLIdPServerTLSCertValidateEventParams;
#define EID_SAMLIDPSERVER_TLSCERTVALIDATE 38 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LONG64 &lConnectionID, BOOL &bAccept);
class SAMLIdPServerTLSCertValidateEventParams { public: qint64 ConnectionID(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertValidate(SAMLIdPServerTLSCertValidateEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireTLSCertValidate(SAMLIdPServerTLSCertValidateEventParams *e) {...}
Remarks
The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.
TLSEstablished Event (SAMLIdPServer Class)
Reports the setup of a TLS session.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(SAMLIdPServerTLSEstablishedEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SAMLIdPServerTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(SAMLIdPServerTLSEstablishedEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SAMLIdPServerTLSEstablishedEventParams;
#define EID_SAMLIDPSERVER_TLSESTABLISHED 39 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LONG64 &lConnectionID);
class SAMLIdPServerTLSEstablishedEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(SAMLIdPServerTLSEstablishedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireTLSEstablished(SAMLIdPServerTLSEstablishedEventParams *e) {...}
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (SAMLIdPServer Class)
Fires when a newly established client connection initiates a TLS handshake.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(SAMLIdPServerTLSHandshakeEventParams *e);
typedef struct {
int64 ConnectionID;
const char *ServerName;
int Abort; int reserved; } SAMLIdPServerTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(SAMLIdPServerTLSHandshakeEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR ServerName;
BOOL Abort; INT reserved; } SAMLIdPServerTLSHandshakeEventParams;
#define EID_SAMLIDPSERVER_TLSHANDSHAKE 40 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LONG64 &lConnectionID, LPSTR &lpszServerName, BOOL &bAbort);
class SAMLIdPServerTLSHandshakeEventParams { public: qint64 ConnectionID(); const QString &ServerName(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(SAMLIdPServerTLSHandshakeEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireTLSHandshake(SAMLIdPServerTLSHandshakeEventParams *e) {...}
Remarks
Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.
TLSPSK Event (SAMLIdPServer Class)
Requests a pre-shared key for TLS-PSK.
Syntax
ANSI (Cross Platform) virtual int FireTLSPSK(SAMLIdPServerTLSPSKEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Identity;
char *PSK;
char *Ciphersuite; int reserved; } SAMLIdPServerTLSPSKEventParams;
Unicode (Windows) virtual INT FireTLSPSK(SAMLIdPServerTLSPSKEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Identity;
LPWSTR PSK;
LPWSTR Ciphersuite; INT reserved; } SAMLIdPServerTLSPSKEventParams;
#define EID_SAMLIDPSERVER_TLSPSK 41 virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LONG64 &lConnectionID, LPSTR &lpszIdentity, LPSTR &lpszPSK, LPSTR &lpszCiphersuite);
class SAMLIdPServerTLSPSKEventParams { public: qint64 ConnectionID(); const QString &Identity(); const QString &PSK(); void SetPSK(const QString &qsPSK); const QString &Ciphersuite(); void SetCiphersuite(const QString &qsCiphersuite); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSPSK(SAMLIdPServerTLSPSKEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireTLSPSK(SAMLIdPServerTLSPSKEventParams *e) {...}
Remarks
The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.
Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.
TLSShutdown Event (SAMLIdPServer Class)
Reports closure of a TLS session.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(SAMLIdPServerTLSShutdownEventParams *e);
typedef struct {
int64 ConnectionID; int reserved; } SAMLIdPServerTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(SAMLIdPServerTLSShutdownEventParams *e);
typedef struct {
LONG64 ConnectionID; INT reserved; } SAMLIdPServerTLSShutdownEventParams;
#define EID_SAMLIDPSERVER_TLSSHUTDOWN 42 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LONG64 &lConnectionID);
class SAMLIdPServerTLSShutdownEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(SAMLIdPServerTLSShutdownEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireTLSShutdown(SAMLIdPServerTLSShutdownEventParams *e) {...}
Remarks
The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.
UserAuthCompleted Event (SAMLIdPServer Class)
Notifies the application about the success of user authentication flow.
Syntax
ANSI (Cross Platform) virtual int FireUserAuthCompleted(SAMLIdPServerUserAuthCompletedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *SP;
const char *Auth;
const char *Username;
char *NameID;
char *NameIDFormat;
char *SessionIndex;
int AssertionTTL; int reserved; } SAMLIdPServerUserAuthCompletedEventParams;
Unicode (Windows) virtual INT FireUserAuthCompleted(SAMLIdPServerUserAuthCompletedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR SP;
LPCWSTR Auth;
LPCWSTR Username;
LPWSTR NameID;
LPWSTR NameIDFormat;
LPWSTR SessionIndex;
INT AssertionTTL; INT reserved; } SAMLIdPServerUserAuthCompletedEventParams;
#define EID_SAMLIDPSERVER_USERAUTHCOMPLETED 43 virtual INT SECUREBLACKBOX_CALL FireUserAuthCompleted(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSP, LPSTR &lpszAuth, LPSTR &lpszUsername, LPSTR &lpszNameID, LPSTR &lpszNameIDFormat, LPSTR &lpszSessionIndex, INT &iAssertionTTL);
class SAMLIdPServerUserAuthCompletedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &SP(); const QString &Auth(); const QString &Username(); const QString &NameID(); void SetNameID(const QString &qsNameID); const QString &NameIDFormat(); void SetNameIDFormat(const QString &qsNameIDFormat); const QString &SessionIndex(); void SetSessionIndex(const QString &qsSessionIndex); int AssertionTTL(); void SetAssertionTTL(int iAssertionTTL); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UserAuthCompleted(SAMLIdPServerUserAuthCompletedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireUserAuthCompleted(SAMLIdPServerUserAuthCompletedEventParams *e) {...}
Remarks
Subscribe to this event to get notified about completion of user authentication flow. The NameID, NameIDFormat, SessionIndex, and AssertionTTL parameters contain the proposed session parameters. You can alter them in your event handler as required.
UserAuthFailed Event (SAMLIdPServer Class)
Notifies the application about failure of user authentication flow.
Syntax
ANSI (Cross Platform) virtual int FireUserAuthFailed(SAMLIdPServerUserAuthFailedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *SP;
const char *Auth;
const char *Username;
int CanRetry;
int TryAgain; int reserved; } SAMLIdPServerUserAuthFailedEventParams;
Unicode (Windows) virtual INT FireUserAuthFailed(SAMLIdPServerUserAuthFailedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR SP;
LPCWSTR Auth;
LPCWSTR Username;
BOOL CanRetry;
BOOL TryAgain; INT reserved; } SAMLIdPServerUserAuthFailedEventParams;
#define EID_SAMLIDPSERVER_USERAUTHFAILED 44 virtual INT SECUREBLACKBOX_CALL FireUserAuthFailed(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSP, LPSTR &lpszAuth, LPSTR &lpszUsername, BOOL &bCanRetry, BOOL &bTryAgain);
class SAMLIdPServerUserAuthFailedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &SP(); const QString &Auth(); const QString &Username(); bool CanRetry(); bool TryAgain(); void SetTryAgain(bool bTryAgain); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UserAuthFailed(SAMLIdPServerUserAuthFailedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireUserAuthFailed(SAMLIdPServerUserAuthFailedEventParams *e) {...}
Remarks
The component fires this event to notify the application about failed user authentication step - for example, if a wrong password was supplied.
The CanRetry parameter indicates whether another attempt of the same type can be performed. If you would like to use that opportunity, set TryAgain to true to restart the process.
UserAuthStart Event (SAMLIdPServer Class)
Notifies the application about the start of user authentication flow.
Syntax
ANSI (Cross Platform) virtual int FireUserAuthStart(SAMLIdPServerUserAuthStartEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *SP;
const char *SupportedAuths;
char *SelectedAuth;
int Action; int reserved; } SAMLIdPServerUserAuthStartEventParams;
Unicode (Windows) virtual INT FireUserAuthStart(SAMLIdPServerUserAuthStartEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR SP;
LPCWSTR SupportedAuths;
LPWSTR SelectedAuth;
INT Action; INT reserved; } SAMLIdPServerUserAuthStartEventParams;
#define EID_SAMLIDPSERVER_USERAUTHSTART 45 virtual INT SECUREBLACKBOX_CALL FireUserAuthStart(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSP, LPSTR &lpszSupportedAuths, LPSTR &lpszSelectedAuth, INT &iAction);
class SAMLIdPServerUserAuthStartEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &SP(); const QString &SupportedAuths(); const QString &SelectedAuth(); void SetSelectedAuth(const QString &qsSelectedAuth); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UserAuthStart(SAMLIdPServerUserAuthStartEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireUserAuthStart(SAMLIdPServerUserAuthStartEventParams *e) {...}
Remarks
Set Action to Auto to proceed with the default sign on page based on SignOnPageTemplate, or to Custom to supply (or redirect to) your own authentication landing. The SupportedAuths parameter contains the list of authentication methods supported by the server. If you are looking to use a particular authentication method, return it to the server via SelectedAuth parameter.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
UserAuthVerifyCredentials Event (SAMLIdPServer Class)
Passes user credentials to the application for verification.
Syntax
ANSI (Cross Platform) virtual int FireUserAuthVerifyCredentials(SAMLIdPServerUserAuthVerifyCredentialsEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *SP;
const char *ClaimedUsername;
const char *ClaimedPassword;
const char *ClaimedBody;
int Accept;
char *Username; int reserved; } SAMLIdPServerUserAuthVerifyCredentialsEventParams;
Unicode (Windows) virtual INT FireUserAuthVerifyCredentials(SAMLIdPServerUserAuthVerifyCredentialsEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR SP;
LPCWSTR ClaimedUsername;
LPCWSTR ClaimedPassword;
LPCWSTR ClaimedBody;
BOOL Accept;
LPWSTR Username; INT reserved; } SAMLIdPServerUserAuthVerifyCredentialsEventParams;
#define EID_SAMLIDPSERVER_USERAUTHVERIFYCREDENTIALS 46 virtual INT SECUREBLACKBOX_CALL FireUserAuthVerifyCredentials(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSP, LPSTR &lpszClaimedUsername, LPSTR &lpszClaimedPassword, LPSTR &lpszClaimedBody, BOOL &bAccept, LPSTR &lpszUsername);
class SAMLIdPServerUserAuthVerifyCredentialsEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &SP(); const QString &ClaimedUsername(); const QString &ClaimedPassword(); const QString &ClaimedBody(); bool Accept(); void SetAccept(bool bAccept); const QString &Username(); void SetUsername(const QString &qsUsername); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UserAuthVerifyCredentials(SAMLIdPServerUserAuthVerifyCredentialsEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireUserAuthVerifyCredentials(SAMLIdPServerUserAuthVerifyCredentialsEventParams *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.
UserLogoutCompleted Event (SAMLIdPServer Class)
Notifies the application about the completion of user logout flow.
Syntax
ANSI (Cross Platform) virtual int FireUserLogoutCompleted(SAMLIdPServerUserLogoutCompletedEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *SP;
const char *Username;
const char *NameID;
const char *SessionIndex;
int Partial; int reserved; } SAMLIdPServerUserLogoutCompletedEventParams;
Unicode (Windows) virtual INT FireUserLogoutCompleted(SAMLIdPServerUserLogoutCompletedEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR SP;
LPCWSTR Username;
LPCWSTR NameID;
LPCWSTR SessionIndex;
BOOL Partial; INT reserved; } SAMLIdPServerUserLogoutCompletedEventParams;
#define EID_SAMLIDPSERVER_USERLOGOUTCOMPLETED 47 virtual INT SECUREBLACKBOX_CALL FireUserLogoutCompleted(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSP, LPSTR &lpszUsername, LPSTR &lpszNameID, LPSTR &lpszSessionIndex, BOOL &bPartial);
class SAMLIdPServerUserLogoutCompletedEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &SP(); const QString &Username(); const QString &NameID(); const QString &SessionIndex(); bool Partial(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UserLogoutCompleted(SAMLIdPServerUserLogoutCompletedEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireUserLogoutCompleted(SAMLIdPServerUserLogoutCompletedEventParams *e) {...}
Remarks
Subscribe to this event to be notified about the logout flow completion.
UserLogoutStart Event (SAMLIdPServer Class)
Notifies the application about the start of user logout flow.
Syntax
ANSI (Cross Platform) virtual int FireUserLogoutStart(SAMLIdPServerUserLogoutStartEventParams *e);
typedef struct {
int64 ConnectionID;
const char *SessionID;
const char *SP;
const char *Username;
const char *NameID;
const char *SessionIndex;
int Secondary;
int Action; int reserved; } SAMLIdPServerUserLogoutStartEventParams;
Unicode (Windows) virtual INT FireUserLogoutStart(SAMLIdPServerUserLogoutStartEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR SessionID;
LPCWSTR SP;
LPCWSTR Username;
LPCWSTR NameID;
LPCWSTR SessionIndex;
BOOL Secondary;
INT Action; INT reserved; } SAMLIdPServerUserLogoutStartEventParams;
#define EID_SAMLIDPSERVER_USERLOGOUTSTART 48 virtual INT SECUREBLACKBOX_CALL FireUserLogoutStart(LONG64 &lConnectionID, LPSTR &lpszSessionID, LPSTR &lpszSP, LPSTR &lpszUsername, LPSTR &lpszNameID, LPSTR &lpszSessionIndex, BOOL &bSecondary, INT &iAction);
class SAMLIdPServerUserLogoutStartEventParams { public: qint64 ConnectionID(); const QString &SessionID(); const QString &SP(); const QString &Username(); const QString &NameID(); const QString &SessionIndex(); bool Secondary(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UserLogoutStart(SAMLIdPServerUserLogoutStartEventParams *e);
// Or, subclass SAMLIdPServer and override this emitter function. virtual int FireUserLogoutStart(SAMLIdPServerUserLogoutStartEventParams *e) {...}
Remarks
The component uses this event to notify the application about the start of user logout flow. The Secondary parameter indicates that the logout is initiated in response to request received from a remote party.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
Certificate Type
Encapsulates an individual X.509 certificate.
Syntax
SecureBlackboxCertificate (declared in secureblackbox.h)
Remarks
This type keeps and provides access to X.509 certificate details.
Fields
Bytes
char* (read-only)
Default Value:
Returns the raw certificate data in DER format.
CA
int
Default Value: FALSE
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.
CAKeyID
char* (read-only)
Default Value:
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
CertType
int (read-only)
Default Value: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
CRLDistributionPoints
char*
Default Value: ""
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
Curve
char*
Default Value: ""
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
Fingerprint
char* (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
FriendlyName
char* (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: ""
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Issuer
char* (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.
IssuerRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
KeyAlgorithm
char*
Default Value: "0"
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.
KeyBits
int (read-only)
Default Value: 0
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.
KeyFingerprint
char* (read-only)
Default Value: ""
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
KeyUsage
int
Default Value: 0
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this field before generating the certificate to propagate the key usage flags to the new certificate.
KeyValid
int (read-only)
Default Value: FALSE
Returns True if the certificate's key is cryptographically valid, and False otherwise.
OCSPLocations
char*
Default Value: ""
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
OCSPNoCheck
int
Default Value: FALSE
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the location that the certificate was taken or loaded from.
PolicyIDs
char*
Default Value: ""
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this field when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
PrivateKeyBytes
char* (read-only)
Default Value:
Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
PrivateKeyExists
int (read-only)
Default Value: FALSE
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
PrivateKeyExtractable
int (read-only)
Default Value: FALSE
Indicates whether the private key is extractable (exportable).
PublicKeyBytes
char* (read-only)
Default Value:
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
Qualified
int (read-only)
Default Value: FALSE
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
QualifiedStatements
int
Default Value: 0
Returns a simplified qualified status of the certificate.
Qualifiers
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
SelfSigned
int (read-only)
Default Value: FALSE
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
char*
Default Value:
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
SigAlgorithm
char* (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Subject
char* (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.
SubjectAlternativeName
char*
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
SubjectKeyID
char*
Default Value:
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
SubjectRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
Valid
int (read-only)
Default Value: FALSE
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
ValidFrom
char*
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
ValidTo
char*
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
Certificate()
Creates a new object with default field values.
CryptoKey Type
This container represents a cryptographic key.
Syntax
SecureBlackboxCryptoKey (declared in secureblackbox.h)
Remarks
This type is a universal placeholder for cryptographic keys.
Fields
Algorithm
char*
Default Value: ""
The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_DES | DES | |
SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | |
SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | |
SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | |
SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | |
SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | |
SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | |
SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | |
SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | |
SB_SYMMETRIC_ALGORITHM_SEED | SEED | |
SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | |
SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | |
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | |
SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Bits
int (read-only)
Default Value: 0
The length of the key in bits.
Curve
char*
Default Value: ""
This property specifies the name of the curve the EC key is built on.
Exportable
int (read-only)
Default Value: FALSE
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
Fingerprint
char* (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this key.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
ID
char*
Default Value:
Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).
IV
char*
Default Value:
The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.
Key
char* (read-only)
Default Value:
The byte array representation of the key. This may not be available for non-Exportable keys.
Nonce
char*
Default Value:
A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.
Private
int (read-only)
Default Value: FALSE
Returns True if the object hosts a private key, and False otherwise.
Public
int (read-only)
Default Value: FALSE
Returns True if the object hosts a public key, and False otherwise.
Subject
char*
Default Value:
Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.
Symmetric
int (read-only)
Default Value: FALSE
Returns True if the object contains a symmetric key, and False otherwise.
Valid
int (read-only)
Default Value: FALSE
Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.
Constructors
CryptoKey()
Creates an empty crypto key object.
ExternalCrypto Type
Specifies the parameters of external cryptographic calls.
Syntax
SecureBlackboxExternalCrypto (declared in secureblackbox.h)
Remarks
External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.
Fields
AsyncDocumentID
char*
Default Value: ""
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
CustomParams
char*
Default Value: ""
Custom parameters to be passed to the signing service (uninterpreted).
Data
char*
Default Value: ""
Additional data to be included in the async state and mirrored back by the requestor.
ExternalHashCalculation
int
Default Value: FALSE
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.
If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
HashAlgorithm
char*
Default Value: "SHA256"
Specifies the request's signature hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
KeyID
char*
Default Value: ""
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
KeySecret
char*
Default Value: ""
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the KeyID topic.
Method
int
Default Value: 0
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Mode
int
Default Value: 0
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with the OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
PublicKeyAlgorithm
char*
Default Value: ""
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Constructors
ExternalCrypto()
Creates a new ExternalCrypto object with default field values.
SAMLEntity Type
Represents SAML entity details.
Syntax
SecureBlackboxSAMLEntity (declared in secureblackbox.h)
Remarks
This type is a container for SAML SP or IdP entity parameters. These are often referred to as service metadata.
Fields
ContactPerson
char*
Default Value: ""
The contact person or persons for the entity.
SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.
Each record contains a semicolon-separated list of contact person parameters, for example:
Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678
You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.
EncryptionKey
char*
Default Value: ""
Contains the entity's encryption key.
This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).
Requests sent to the endpoint can be encrypted with the provided key or certificate.
EncryptionMethods
char*
Default Value: ""
Specifies the list of encryption methods supported by the entity.
This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.
Examples of algorithms supported by this property:
- http://www.w3.org/2009/xmlenc11#aes128-gcm
- http://www.w3.org/2001/04/xmlenc#aes256-cbc
EntityID
char*
Default Value: ""
Represents the SAML entity ID.
Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).
Flags
int
Default Value: 0
Adjusts secondary entity properties.
Use this bit mask property to adjust certain secondary settings. The following flags are supported:
- 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in.
IdPSSOLink
char*
Default Value: ""
Contains a local server page link that triggers SAML authentication to the SP.
This property specifies the web link that initiates the transfer of SAML authentication fact to the SP.
One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider.
NameIDFormats
char*
Default Value: ""
The list of NameID formats supported by this entity.
Use this setting to get or set the list of NameID formats supported by the entity.
Use SAML notation for the formats:
- urn:oasis:names:tc:SAML:2.0:nameid-format:transient
- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
OrganizationDisplayName
char*
Default Value: ""
The friendly name of the organization that maintains the entity.
Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.
OrganizationLang
char*
Default Value: ""
The language preferred by the organization.
This optional setting can be used to adjust the preferred language of the owning organization.
OrganizationName
char*
Default Value: ""
The name of the organization that maintains the entity.
Use this setting to get or set the name of the organization that maintains the SAML entity.
OrganizationURL
char*
Default Value: ""
The web URL of the organization that maintains the entity.
Use this setting to get or set the web address of the organization responsible for this SAML entity.
SignatureValidationResult
int (read-only)
Default Value: 0
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
Signed
int (read-only)
Default Value: FALSE
Specifies whether the SAML entity information is or should be signed.
Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.
SignedWith
char* (read-only)
Default Value: ""
Contains the certificate or key that was used to sign the settings (metadata) document.
This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.
The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the SignatureValidationResult setting.
SigningKey
char*
Default Value: ""
Contains the entity's signing key.
This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key.
The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates.
ValidUntil
char*
Default Value: ""
Specifies the expiration time of the SAML entity information.
This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.
Constructors
SAMLEntity()
Creates a new SAMLEntity object.
SAMLSecuritySettings Type
Represents SAML security settings for the message being viewed/edited.
Syntax
SecureBlackboxSAMLSecuritySettings (declared in secureblackbox.h)
Remarks
This type is a container for SAML security parameters.
Fields
CanonicalizationMethod
char*
Default Value: ""
The canonicalization method to use in the signature.
The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)
DigestMethod
char*
Default Value: ""
The digest method to use.
The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.
EncryptionMethod
char*
Default Value: "AES256"
The encryption method used to encrypt the assertion.
This property contains the encryption algorithm used to encrypt the XML assertion.
Supported values:
SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 | |
SB_XML_ENCRYPTION_ALGORITHM_DES | DES | |
SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | |
SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | |
SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | |
SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | |
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |
Flags
int
Default Value: 1
Provides access to secondary security parameters and tweaks.
This property is a bitwise combination of zero or more flags. The following flags are currently supported: The following flags can be used with any SAML component (although they may not apply in all modes of use):
ssfSignatureAfterIssuer | 1 | Place the Signature tag after the issuer tag in the XML document |
ssfSignatureBeforeDescriptor | 2 | Place the Signature tag before the entity descriptor tag in the XML metadata |
ssfKeyDataIssuerSerial | 4 | Include the IssuerSerial key data element |
ssfKeyDataSKI | 8 | Include the SubjectKeyIdentifier key data element |
ssfKeyDataSubjectName | 16 | Include the SubjectName key data element |
ssfKeyDataCertificate | 32 | Include the Certificate key data element |
ssfKeyDataCRL | 64 | Include the CRL key data element |
ssfSignAuthnRequests | 65536 | Sign authentication requests (SP only) |
ssfSignArtifactResolveRequests | 131072 | Sign artifact resolve requests |
ssfSignLogoutRequests | 262144 | Sign logout requests |
ssfSignAssertions | 524288 | Sign outgoing assertions (IdP only) |
ssfSignResponses | 1048576 | Sign all responses (IdP only) |
ssfEncryptAssertions | 2097152 | Encrypt generated assertions (IdP only) |
SigMethod
char*
Default Value: ""
The signature method to use.
The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.
SignaturePolicy
int
Default Value: 0
Specifies the signature validation policy.
Use this property to specify the signature validation policy for the component.
Constructors
SAMLSecuritySettings()
Creates a new SAMLSecuritySettings object.
SAMLServiceInfo Type
Represents SAML service details.
Syntax
SecureBlackboxSAMLServiceInfo (declared in secureblackbox.h)
Remarks
This type is a container for SAML SP or IdP endpoint service parameters.
Fields
BindingType
int (read-only)
Default Value: 0
Specifies the type of SAML binding that this endpoint accepts.
Use this property to specify the binding type to use with this endpoint.
EntityID
char* (read-only)
Default Value: ""
Represents the SAML entity ID.
Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).
Location
char* (read-only)
Default Value: ""
The location (URL) of the endpoint.
Priority
int
Default Value: -1
The priority of the endpoint in relation to other endpoints with the same Location.
Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.
Leave all priorities at -1 to omit generation of the Default attribute.
Service
int (read-only)
Default Value: 0
The kind of the service being provided at this endpoint.
The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService.
ServiceIndex
int (read-only)
Default Value: 0
The index of this endpoint.
For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.
Constructors
SAMLServiceInfo()
Creates a new SAMLServiceInfo object.
SocketSettings Type
A container for the socket settings.
Syntax
SecureBlackboxSocketSettings (declared in secureblackbox.h)
Remarks
This type is a container for socket-layer parameters.
Fields
DNSMode
int
Default Value: 0
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
DNSPort
int
Default Value: 0
Specifies the port number to be used for sending queries to the DNS server.
DNSQueryTimeout
int
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
DNSServers
char*
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
DNSTotalTimeout
int
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
IncomingSpeedLimit
int
Default Value: 0
The maximum number of bytes to read from the socket, per second.
LocalAddress
char*
Default Value: ""
The local network interface to bind the socket to.
LocalPort
int
Default Value: 0
The local port number to bind the socket to.
OutgoingSpeedLimit
int
Default Value: 0
The maximum number of bytes to write to the socket, per second.
Timeout
int
Default Value: 60000
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
UseIPv6
int
Default Value: FALSE
Enables or disables IP protocol version 6.
Constructors
SocketSettings()
Creates a new SocketSettings object.
TLSConnectionInfo Type
Contains information about a network connection.
Syntax
SecureBlackboxTLSConnectionInfo (declared in secureblackbox.h)
Remarks
Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.
Fields
AEADCipher
int (read-only)
Default Value: FALSE
Indicates whether the encryption algorithm used is an AEAD cipher.
ChainValidationDetails
int (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationResult
int (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
Ciphersuite
char* (read-only)
Default Value: ""
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
ClientAuthenticated
int (read-only)
Default Value: FALSE
Specifies whether client authentication was performed during this connection.
ClientAuthRequested
int (read-only)
Default Value: FALSE
Specifies whether client authentication was requested during this connection.
ConnectionEstablished
int (read-only)
Default Value: FALSE
Indicates whether the connection has been established fully.
ConnectionID
char* (read-only)
Default Value:
The unique identifier assigned to this connection.
DigestAlgorithm
char* (read-only)
Default Value: ""
The digest algorithm used in a TLS-enabled connection.
EncryptionAlgorithm
char* (read-only)
Default Value: ""
The symmetric encryption algorithm used in a TLS-enabled connection.
Exportable
int (read-only)
Default Value: FALSE
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
ID
int64 (read-only)
Default Value: -1
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
KeyExchangeAlgorithm
char* (read-only)
Default Value: ""
The key exchange algorithm used in a TLS-enabled connection.
KeyExchangeKeyBits
int (read-only)
Default Value: 0
The length of the key exchange key of a TLS-enabled connection.
NamedECCurve
char* (read-only)
Default Value: ""
The elliptic curve used in this connection.
PFSCipher
int (read-only)
Default Value: FALSE
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
PreSharedIdentity
char*
Default Value: ""
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedIdentityHint
char* (read-only)
Default Value: ""
A hint professed by the server to help the client select the PSK identity to use.
PublicKeyBits
int (read-only)
Default Value: 0
The length of the public key.
RemoteAddress
char* (read-only)
Default Value: ""
The client's IP address.
RemotePort
int (read-only)
Default Value: 0
The remote port of the client connection.
ResumedSession
int (read-only)
Default Value: FALSE
Indicates whether a TLS-enabled connection was spawned from another TLS connection
SecureConnection
int (read-only)
Default Value: FALSE
Indicates whether TLS or SSL is enabled for this connection.
ServerAuthenticated
int (read-only)
Default Value: FALSE
Indicates whether server authentication was performed during a TLS-enabled connection.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The signature algorithm used in a TLS handshake.
SymmetricBlockSize
int (read-only)
Default Value: 0
The block size of the symmetric algorithm used.
SymmetricKeyBits
int (read-only)
Default Value: 0
The key length of the symmetric algorithm used.
TotalBytesReceived
int64 (read-only)
Default Value: 0
The total number of bytes received over this connection.
TotalBytesSent
int64 (read-only)
Default Value: 0
The total number of bytes sent over this connection.
ValidationLog
char* (read-only)
Default Value: ""
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
Version
char* (read-only)
Default Value: ""
Indicates the version of SSL/TLS protocol negotiated during this connection.
Constructors
TLSConnectionInfo()
Creates a new TLSConnectionInfo object.
TLSSettings Type
A container for TLS connection settings.
Syntax
SecureBlackboxTLSSettings (declared in secureblackbox.h)
Remarks
The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
AutoValidateCertificates
int
Default Value: TRUE
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
BaseConfiguration
int
Default Value: 0
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Ciphersuites
char*
Default Value: ""
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
ClientAuth
int
Default Value: 0
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
ccatNoAuth | 0 | |
ccatRequestCert | 1 | |
ccatRequireCert | 2 |
ECCurves
char*
Default Value: ""
Defines the elliptic curves to enable.
Extensions
char*
Default Value: ""
Provides access to TLS extensions.
ForceResumeIfDestinationChanges
int
Default Value: FALSE
Whether to force TLS session resumption when the destination address changes.
PreSharedIdentity
char*
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedKey
char*
Default Value: ""
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
PreSharedKeyCiphersuite
char*
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
RenegotiationAttackPreventionMode
int
Default Value: 2
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
RevocationCheck
int
Default Value: 1
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
SSLOptions
int
Default Value: 16
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
TLSMode
int
Default Value: 0
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
UseExtendedMasterSecret
int
Default Value: FALSE
Enables the Extended Master Secret Extension, as defined in RFC 7627.
UseSessionResumption
int
Default Value: FALSE
Enables or disables the TLS session resumption capability.
Versions
int
Default Value: 16
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Constructors
TLSSettings()
Creates a new TLSSettings object.
UserAccount Type
A container for user account information.
Syntax
SecureBlackboxUserAccount (declared in secureblackbox.h)
Remarks
UserAccount objects are used to store user account information, such as logins and passwords.
Fields
AssociatedData
char*
Default Value:
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
BasePath
char*
Default Value: ""
Base path for this user in the server's file system.
Certificate
char*
Default Value:
Contains the user's certificate.
Data
char*
Default Value: ""
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Email
char*
Default Value: ""
The user's email address.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: ""
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:
SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
IncomingSpeedLimit
int
Default Value: 0
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
OtpAlgorithm
int
Default Value: 0
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.
oaHmac | 0 | |
oaTime | 1 |
OTPLen
int
Default Value: 0
Specifies the length of the user's OTP password.
OtpValue
int
Default Value: 0
The user's time interval (TOTP) or Counter (HOTP).
OutgoingSpeedLimit
int
Default Value: 0
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
Password
char*
Default Value: ""
The user's authentication password.
SharedSecret
char*
Default Value:
Contains the user's secret key, which is essentially a shared secret between the client and server.
Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.
SSHKey
char*
Default Value:
Contains the user's SSH key.
Username
char*
Default Value: ""
The registered name (login) of the user.
Constructors
UserAccount()
Creates a new UserAccount object
SecureBlackboxList Type
Syntax
SecureBlackboxList<T> (declared in secureblackbox.h)
Remarks
SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SAMLIdPServer class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
Config Settings (SAMLIdPServer Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.SAMLIdPServer Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
certificate | Enables caching of certificates. |
crl | Enables caching of Certificate Revocation Lists (CRLs). |
ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
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
1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |
30408705 | Invalid binding name (SB_ERROR_SAML_INVALID_BINDING_NAME) |
30408706 | Invalid SAML binding type (SB_ERROR_SAML_INVALID_BINDING_TYPE) |
30408707 | Base directory not set (SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET) |
30408708 | Invalid parameter (SB_ERROR_SAML_INVALID_PARAM) |
30408709 | Invalid input data (SB_ERROR_SAML_INVALID_DATA) |
30408710 | Data is not loaded (SB_ERROR_SAML_NOT_LOADED) |
30408711 | New document is not created (SB_ERROR_SAML_NOT_CREATED) |
30408716 | Endpoint of unsupported type encountered or cannot find appropriate IdP service (SB_ERROR_SAML_INVALID_SERVICE) |
30408717 | Multiple endpoints of the same kind are not supported (SB_ERROR_SAML_MULTIPLE_ENDPOINTS_NOT_SUPPORTED) |
30408718 | Failed to process the request (SB_ERROR_SAML_PROCESSING_FAILED) |
30408719 | Session not found (SB_ERROR_SAML_SESSION_NOT_FOUND) |