SAMLSPServer Class
Properties Methods Events Configuration Settings Errors
The SAMLSPServer class represents a SAML service provider.
Syntax
SAMLSPServer
Remarks
The service provider in the SAML (Security Assertion Markup Language) exchange flow represents the server that receives and accepts authentication assertions issued by the Identity Provider for single sign-on (SSO).
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. |
ArtifactResolutionService | The location of the artifact resolution service. |
AssertionConsumerService | The location of the Assertion Consumer Service. |
AssertionConsumerServiceBindings | Bindings supported by the Assertion Consumer Service. |
BaseDir | Base directory on the server. |
ClientAuth | Enables or disables certificate-based client authentication. |
EncryptionCertBytes | Returns raw certificate data in DER format. |
EncryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ErrorOrigin | Indicates the endpoint where the error originates from. |
ErrorSeverity | The severity of the error that happened. |
ExternalCryptoAsyncDocumentID | Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. |
ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
ExternalCryptoMethod | Specifies the asynchronous signing method. |
ExternalCryptoMode | Specifies the external cryptography mode. |
ExternalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
FIPSMode | Reserved. |
Host | Specifies the host address of the SP server. |
Issuer | Name identifier of the issuer of the SP's requests. |
LogoutPage | Specifies the location of the logout page. |
MetadataURL | The SP's metadata location. |
MetaSigningCertBytes | Returns raw certificate data in DER format. |
MetaSigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
OfflineMode | TBD. |
Port | Specifies the listening port number. |
PreferredIDPToSPBinding | Specifies the preferred IdP to SP binding. |
ProtectedResources | Specifies the list of protected resources. |
RedirectOnLogoutPage | Specifies the location to redirect the user on logout. |
ServerCertCount | The number of records in the ServerCert arrays. |
ServerCertBytes | Returns raw certificate data in DER format. |
ServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigCanonicalizationMethod | The canonicalization method to use in the signature. |
SigDigestMethod | The digest method to use. |
SigMethod | The signature method to use. |
SignArtifactResolveRequests | Specifies whether to sign artifact resolution requests. |
SignAuthnRequests | Specifies whether to sign Authn requests. |
SigningCertBytes | Returns raw certificate data in DER format. |
SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningChainCount | The number of records in the SigningChain arrays. |
SigningChainBytes | Returns raw certificate data in DER format. |
SigningChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SignLogoutRequests | Specifies whether to sign Logout requests. |
SignMetadata | Specifies whether to sign the metadata. |
SingleLogoutService | The URL of the single logout service. |
SingleLogoutServiceBindings | Defines single logout service bindings. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
SPToIDPBinding | Specifies the IdP to SP binding to use. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSExtensions | Provides access to TLS extensions. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | 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. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
TLSVersions | Th SSL/TLS versions to enable by default. |
URL | Specifies the base URL of this SP server. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
GetClientBuffer | Obtains a pending connection buffer. |
GetProviderProperty | TBD. |
LoadIDPMetadata | Loads the metadata required for information exchange with the identity provider. |
ProcessGenericRequest | TBD. |
SaveMetadata | Saves the SP configuration to a metadata file. |
SetClientBuffer | Commits a data buffer to the connection. |
SetProviderProperty | TBD. |
Start | Starts the SP 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. |
AssertionCreated | TBD. |
AssertionReceived | TBD. |
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. |
MetadataRequest | TBD. |
Notification | This event notifies the application about an underlying control flow event. |
ResourceClose | TBD. |
ResourceOpen | TBD. |
ResourceRead | TBD. |
ResourceRequest | TBD. |
SessionClosed | This event is fired when the SP server has closed a session. |
SessionEstablished | This event is fired when a new session has been established. |
SessionStageChanged | TBD. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
BoundPort | The port that was bound by the server. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
HandshakeTimeout | The HTTPS handshake timeout. |
MaxIssueInstantTimeDiff | The maximum issue-instant time delta. |
PortRangeFrom | The lower bound of allowed port scope to listen on. |
PortRangeTo | The higher bound of allowed port scope to listen on. |
SendBufferSize | The network send buffer size. |
ServerName | Specifies the server name for the created responses. |
SessionTimeout | The HTTP session timeout. |
SessionTTL | The SAML session time-to-live value. |
TempPath | Path for storing temporary files. |
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 (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
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. |
Tag | Allows to store any custom data. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
Active Property (SAMLSPServer Class)
Tells whether the server is active and ready to process requests.
Syntax
bool GetActive();
Default Value
false
Remarks
This property indicates whether the IdP server is in an active state.
This property is read-only and not available at design time.
Data Type
Boolean
ArtifactResolutionService Property (SAMLSPServer Class)
The location of the artifact resolution service.
Syntax
QString GetArtifactResolutionService();
int SetArtifactResolutionService(QString qsArtifactResolutionService);
Default Value
"/sp/ArtifactResolutionService"
Remarks
Use this property to specify the location of the artifact resolution service of this Service Provider (SP).
Data Type
String
AssertionConsumerService Property (SAMLSPServer Class)
The location of the Assertion Consumer Service.
Syntax
QString GetAssertionConsumerService();
int SetAssertionConsumerService(QString qsAssertionConsumerService);
Default Value
"/sp/AssertionConsumerService"
Remarks
The Assertion Consumer Service (ACS) is the location that accepts SAML responses (artifacts) to establish a session based on assertions.
Data Type
String
AssertionConsumerServiceBindings Property (SAMLSPServer Class)
Bindings supported by the Assertion Consumer Service.
Syntax
QString GetAssertionConsumerServiceBindings();
int SetAssertionConsumerServiceBindings(QString qsAssertionConsumerServiceBindings);
Default Value
"+Artifact,+POST,+Redirect"
Remarks
Use this property to specify the bindings for the Assertion Consumer Service (ACS) provided by this SP.
Data Type
String
BaseDir Property (SAMLSPServer Class)
Base directory on the server.
Syntax
QString GetBaseDir();
int SetBaseDir(QString qsBaseDir);
Default Value
""
Remarks
Use this property to specify the base directory for the SP server.
Data Type
String
ClientAuth Property (SAMLSPServer Class)
Enables or disables certificate-based client authentication.
Syntax
int GetClientAuth();
int SetClientAuth(int iClientAuth);
Possible Values
CCAT_NO_AUTH(0),
CCAT_REQUEST_CERT(1),
CCAT_REQUIRE_CERT(2)
Default Value
0
Remarks
Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;
Data Type
Integer
EncryptionCertBytes Property (SAMLSPServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetEncryptionCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertHandle Property (SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetEncryptionCertHandle();
int SetEncryptionCertHandle(qint64 lEncryptionCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
ErrorOrigin Property (SAMLSPServer Class)
Indicates the endpoint where the error originates from.
Syntax
int GetErrorOrigin();
int SetErrorOrigin(int iErrorOrigin);
Possible Values
EO_LOCAL(0),
EO_REMOTE(1)
Default Value
0
Remarks
Use this property to establish whether the reported error originates from a local or remote endpoint.
eoLocal | 0 | |
eoRemote | 1 |
This property is not available at design time.
Data Type
Integer
ErrorSeverity Property (SAMLSPServer Class)
The severity of the error that happened.
Syntax
int GetErrorSeverity();
int SetErrorSeverity(int iErrorSeverity);
Possible Values
ES_INFO(0),
ES_WARNING(1),
ES_FATAL(2)
Default Value
1
Remarks
Use this property to establish whether the error is fatal.
esWarning | 1 | |
esFatal | 2 |
This property is not available at design time.
Data Type
Integer
ExternalCryptoAsyncDocumentID Property (SAMLSPServer Class)
Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.
Syntax
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);
Default Value
""
Remarks
Specifies the document ID for SignAsyncEnd() call
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
Data Type
String
ExternalCryptoCustomParams Property (SAMLSPServer Class)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
This property is not available at design time.
Data Type
String
ExternalCryptoData Property (SAMLSPServer Class)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor
This property is not available at design time.
Data Type
String
ExternalCryptoExternalHashCalculation Property (SAMLSPServer Class)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);
Default Value
false
Remarks
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.
Data Type
Boolean
ExternalCryptoHashAlgorithm Property (SAMLSPServer Class)
Specifies the request's signature hash algorithm.
Syntax
QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);
Default Value
"SHA256"
Remarks
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 |
Data Type
String
ExternalCryptoKeyID Property (SAMLSPServer Class)
The ID of the pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);
Default Value
""
Remarks
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
Data Type
String
ExternalCryptoKeySecret Property (SAMLSPServer Class)
The pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);
Default Value
""
Remarks
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the ExternalCryptoKeyID topic.
Data Type
String
ExternalCryptoMethod Property (SAMLSPServer Class)
Specifies the asynchronous signing method.
Syntax
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);
Possible Values
ASMD_PKCS1(0),
ASMD_PKCS7(1)
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Data Type
Integer
ExternalCryptoMode Property (SAMLSPServer Class)
Specifies the external cryptography mode.
Syntax
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);
Possible Values
ECM_DEFAULT(0),
ECM_DISABLED(1),
ECM_GENERIC(2),
ECM_DCAUTH(3),
ECM_DCAUTH_JSON(4)
Default Value
0
Remarks
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 OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
This property is not available at design time.
Data Type
Integer
ExternalCryptoPublicKeyAlgorithm Property (SAMLSPServer Class)
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Default Value
""
Remarks
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
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 |
Data Type
String
FIPSMode Property (SAMLSPServer Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
Host Property (SAMLSPServer Class)
Specifies the host address of the SP server.
Syntax
QString GetHost();
int SetHost(QString qsHost);
Default Value
""
Remarks
Use this property to specify the IP address on which to listen to incoming connections. To specify the listening port number, use Port.
Data Type
String
Issuer Property (SAMLSPServer Class)
Name identifier of the issuer of the SP's requests.
Syntax
QString GetIssuer();
int SetIssuer(QString qsIssuer);
Default Value
""
Remarks
Use this property to set the name identifier of this Service Provider (SP) to be used in its requests.
Data Type
String
LogoutPage Property (SAMLSPServer Class)
Specifies the location of the logout page.
Syntax
QString GetLogoutPage();
int SetLogoutPage(QString qsLogoutPage);
Default Value
"/sp/logout"
Remarks
Use this property to specify the relative URL of the logout page.
Data Type
String
MetadataURL Property (SAMLSPServer Class)
The SP's metadata location.
Syntax
QString GetMetadataURL();
int SetMetadataURL(QString qsMetadataURL);
Default Value
"/sp/metadata"
Remarks
This property specifies the metadata URL of this Service Provider (SP).
Data Type
String
MetaSigningCertBytes Property (SAMLSPServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetMetaSigningCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
MetaSigningCertHandle Property (SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetMetaSigningCertHandle();
int SetMetaSigningCertHandle(qint64 lMetaSigningCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
OfflineMode Property (SAMLSPServer Class)
TBD.
Syntax
bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);
Default Value
false
Remarks
TBD.
Data Type
Boolean
Port Property (SAMLSPServer Class)
Specifies the listening port number.
Syntax
int GetPort();
int SetPort(int iPort);
Default Value
80
Remarks
Use this property to specify the port number on which the SP server should listen for incoming connections. To specify the server's IP address use Host.
Data Type
Integer
PreferredIDPToSPBinding Property (SAMLSPServer Class)
Specifies the preferred IdP to SP binding.
Syntax
int GetPreferredIDPToSPBinding();
int SetPreferredIDPToSPBinding(int iPreferredIDPToSPBinding);
Possible Values
CSBT_NONE(0),
CSBT_SOAP(1),
CSBT_PAOS(2),
CSBT_REDIRECT(3),
CSBT_POST(4),
CSBT_ARTIFACT(5)
Default Value
4
Remarks
Specifies the preferred binding (message exchange mechanism) used for communication with Identity Provider (IdP).
csbtNone | 0 | |
csbtSOAP | 1 | |
csbtPAOS | 2 | |
csbtRedirect | 3 | |
csbtPOST | 4 | |
csbtArtifact | 5 |
Data Type
Integer
ProtectedResources Property (SAMLSPServer Class)
Specifies the list of protected resources.
Syntax
QString GetProtectedResources();
int SetProtectedResources(QString qsProtectedResources);
Default Value
""
Remarks
This property contains a set of relative URLs of the protected resources offered by this Service Provider (SP).
Data Type
String
RedirectOnLogoutPage Property (SAMLSPServer Class)
Specifies the location to redirect the user on logout.
Syntax
QString GetRedirectOnLogoutPage();
int SetRedirectOnLogoutPage(QString qsRedirectOnLogoutPage);
Default Value
"https://secureblackbox.com"
Remarks
Use this property to specify the page where to redirect the user on logout.
Data Type
String
ServerCertCount Property (SAMLSPServer Class)
The number of records in the ServerCert arrays.
Syntax
int GetServerCertCount();
int SetServerCertCount(int iServerCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ServerCertCount - 1.This property is not available at design time.
Data Type
Integer
ServerCertBytes Property (SAMLSPServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetServerCertBytes(int iServerCertIndex);
Remarks
Returns raw certificate data in DER format.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertHandle Property (SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetServerCertHandle(int iServerCertIndex);
int SetServerCertHandle(int iServerCertIndex, qint64 lServerCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is not available at design time.
Data Type
Long64
SigCanonicalizationMethod Property (SAMLSPServer Class)
The canonicalization method to use in the signature.
Syntax
QString GetSigCanonicalizationMethod();
int SetSigCanonicalizationMethod(QString qsSigCanonicalizationMethod);
Default Value
""
Remarks
The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)
Data Type
String
SigDigestMethod Property (SAMLSPServer Class)
The digest method to use.
Syntax
QString GetSigDigestMethod();
int SetSigDigestMethod(QString qsSigDigestMethod);
Default Value
""
Remarks
The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.
Data Type
String
SigMethod Property (SAMLSPServer Class)
The signature method to use.
Syntax
QString GetSigMethod();
int SetSigMethod(QString qsSigMethod);
Default Value
""
Remarks
The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.
Data Type
String
SignArtifactResolveRequests Property (SAMLSPServer Class)
Specifies whether to sign artifact resolution requests.
Syntax
bool GetSignArtifactResolveRequests();
int SetSignArtifactResolveRequests(bool bSignArtifactResolveRequests);
Default Value
false
Remarks
Set this property to true to enable signing of artifact resolution requests.
Data Type
Boolean
SignAuthnRequests Property (SAMLSPServer Class)
Specifies whether to sign Authn requests.
Syntax
bool GetSignAuthnRequests();
int SetSignAuthnRequests(bool bSignAuthnRequests);
Default Value
false
Remarks
Set this property to true to enable signing of Authn requests.
Data Type
Boolean
SigningCertBytes Property (SAMLSPServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetSigningCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertHandle Property (SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
SigningChainCount Property (SAMLSPServer Class)
The number of records in the SigningChain arrays.
Syntax
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SigningChainCount - 1.This property is not available at design time.
Data Type
Integer
SigningChainBytes Property (SAMLSPServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetSigningChainBytes(int iSigningChainIndex);
Remarks
Returns raw certificate data in DER format.
The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningChainHandle Property (SAMLSPServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
This property is not available at design time.
Data Type
Long64
SignLogoutRequests Property (SAMLSPServer Class)
Specifies whether to sign Logout requests.
Syntax
bool GetSignLogoutRequests();
int SetSignLogoutRequests(bool bSignLogoutRequests);
Default Value
false
Remarks
Set this property to true to enable signing of logout requests.
Data Type
Boolean
SignMetadata Property (SAMLSPServer Class)
Specifies whether to sign the metadata.
Syntax
bool GetSignMetadata();
int SetSignMetadata(bool bSignMetadata);
Default Value
false
Remarks
Set this property to True to enforce signing of the metadata before saving it. Do not forget to assign the signing certificate to the MetaSigningCertificate property.
Data Type
Boolean
SingleLogoutService Property (SAMLSPServer Class)
The URL of the single logout service.
Syntax
QString GetSingleLogoutService();
int SetSingleLogoutService(QString qsSingleLogoutService);
Default Value
"/sp/SingleLogoutService"
Remarks
Use this property to specify the relative URL of the single logout service.
Data Type
String
SingleLogoutServiceBindings Property (SAMLSPServer Class)
Defines single logout service bindings.
Syntax
QString GetSingleLogoutServiceBindings();
int SetSingleLogoutServiceBindings(QString qsSingleLogoutServiceBindings);
Default Value
"+Artifact,+POST,+Redirect"
Remarks
Use this property to specify the single logout service bindings.
The binding is the mechanism of message exchange used by SAML requestors and responders.
Data Type
String
SocketIncomingSpeedLimit Property (SAMLSPServer Class)
The maximum number of bytes to read from the socket, per second.
Syntax
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (SAMLSPServer Class)
The local network interface to bind the socket to.
Syntax
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (SAMLSPServer Class)
The local port number to bind the socket to.
Syntax
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (SAMLSPServer Class)
The maximum number of bytes to write to the socket, per second.
Syntax
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (SAMLSPServer Class)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
Integer
SocketUseIPv6 Property (SAMLSPServer Class)
Enables or disables IP protocol version 6.
Syntax
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
SPToIDPBinding Property (SAMLSPServer Class)
Specifies the IdP to SP binding to use.
Syntax
int GetSPToIDPBinding();
int SetSPToIDPBinding(int iSPToIDPBinding);
Possible Values
CSBT_NONE(0),
CSBT_SOAP(1),
CSBT_PAOS(2),
CSBT_REDIRECT(3),
CSBT_POST(4),
CSBT_ARTIFACT(5)
Default Value
3
Remarks
Specifies the binding (message exchange mechanism) used for communication with Identity Provider (IdP) that is actually used during the session.
To specify the preferred binding, use PreferredIDPToSPBinding.
csbtNone | 0 | |
csbtSOAP | 1 | |
csbtPAOS | 2 | |
csbtRedirect | 3 | |
csbtPOST | 4 | |
csbtArtifact | 5 |
Data Type
Integer
TLSAutoValidateCertificates Property (SAMLSPServer Class)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (SAMLSPServer Class)
Selects the base configuration for the TLS settings.
Syntax
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (SAMLSPServer Class)
A list of ciphersuites separated with commas or semicolons.
Syntax
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
String
TLSECCurves Property (SAMLSPServer Class)
Defines the elliptic curves to enable.
Syntax
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (SAMLSPServer Class)
Provides access to TLS extensions.
Syntax
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (SAMLSPServer Class)
Whether to force TLS session resumption when the destination address changes.
Syntax
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (SAMLSPServer Class)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is not available at design time.
Data Type
String
TLSPreSharedKey Property (SAMLSPServer Class)
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);
Default Value
""
Remarks
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
This property is not available at design time.
Data Type
String
TLSPreSharedKeyCiphersuite Property (SAMLSPServer Class)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (SAMLSPServer Class)
Selects renegotiation attack prevention mechanism.
Syntax
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);
Possible Values
CRAPM_COMPATIBLE(0),
CRAPM_STRICT(1),
CRAPM_AUTO(2)
Default Value
0
Remarks
Selects 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. |
Data Type
Integer
TLSRevocationCheck Property (SAMLSPServer Class)
Specifies the kind(s) of revocation check to perform.
Syntax
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone (0) | No revocation checking |
crcAuto (1) | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL (2) | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP (3) | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP (4) | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL (5) | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP (6) | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP (7) | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL (8) | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
This property is not available at design time.
Data Type
Integer
TLSSSLOptions Property (SAMLSPServer Class)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);
Default Value
16
Remarks
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 use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) 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 handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (SAMLSPServer Class)
Specifies the TLS mode to use.
Syntax
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);
Possible Values
SM_DEFAULT(0),
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_MIXED_TLS(4)
Default Value
0
Remarks
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, allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (SAMLSPServer Class)
Enables Extended Master Secret Extension, as defined in RFC 7627.
Syntax
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);
Default Value
false
Remarks
Enables Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (SAMLSPServer Class)
Enables or disables TLS session resumption capability.
Syntax
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);
Default Value
false
Remarks
Enables or disables TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (SAMLSPServer Class)
Th SSL/TLS versions to enable by default.
Syntax
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Default Value
16
Remarks
Th 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 |
Data Type
Integer
URL Property (SAMLSPServer Class)
Specifies the base URL of this SP server.
Syntax
QString GetURL();
int SetURL(QString qsURL);
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
Data Type
String
Config Method (SAMLSPServer Class)
Sets or retrieves a configuration setting.
Syntax
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
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (SAMLSPServer Class)
Performs an additional action.
Syntax
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetClientBuffer Method (SAMLSPServer Class)
Obtains a pending connection buffer.
Syntax
QByteArray GetClientBuffer(qint64 lConnectionID);
Remarks
Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetProviderProperty Method (SAMLSPServer Class)
TBD.
Syntax
QString GetProviderProperty(const QString& qsName);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
LoadIDPMetadata Method (SAMLSPServer Class)
Loads the metadata required for information exchange with the identity provider.
Syntax
int LoadIDPMetadata(const QString& qsFileName);
Remarks
The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP.
FileName specifies the metadata file name.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ProcessGenericRequest Method (SAMLSPServer Class)
TBD.
Syntax
QByteArray ProcessGenericRequest(QByteArray qbaRequest);
Remarks
TBD
Error Handling
This method returns a Binary 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.
SaveMetadata Method (SAMLSPServer Class)
Saves the SP configuration to a metadata file.
Syntax
int SaveMetadata(const QString& qsFileName);
Remarks
Use this method to save the Service Provider (SP) configuration in the form of XML metadata in the file specified by FileName. This file may be transferred to identity providers (IdP) to adjust their interaction processes.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetClientBuffer Method (SAMLSPServer Class)
Commits a data buffer to the connection.
Syntax
int SetClientBuffer(qint64 lConnectionID, QByteArray qbaValue);
Remarks
Use this method from your ReadFile event handler to commit a chunk of file data to the server component.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetProviderProperty Method (SAMLSPServer Class)
TBD.
Syntax
int SetProviderProperty(const QString& qsName, const QString& qsValue);
Remarks
TBD
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Start Method (SAMLSPServer Class)
Starts the SP server.
Syntax
int Start();
Remarks
Use this method to start listening for incoming connections.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Stop Method (SAMLSPServer Class)
Stops the IdP server.
Syntax
int Stop();
Remarks
Call this method to stop listening for incoming connections.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Accept Event (SAMLSPServer Class)
Reports an incoming connection.
Syntax
class SAMLSPServerAcceptEventParams { public: const QString &RemoteAddress(); int RemotePort(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Accept(SAMLSPServerAcceptEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireAccept(SAMLSPServerAcceptEventParams *e) {...}
Remarks
This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.
Subscribe to Connect event to be notified of every connection that has been set up.
AssertionCreated Event (SAMLSPServer Class)
TBD.
Syntax
class SAMLSPServerAssertionCreatedEventParams { public: qint64 ConnectionID(); int AssertionOrigin(); const QString &AssertionType(); const QString &Content(); void SetContent(const QString &qsContent); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AssertionCreated(SAMLSPServerAssertionCreatedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireAssertionCreated(SAMLSPServerAssertionCreatedEventParams *e) {...}
Remarks
TBD.
AssertionReceived Event (SAMLSPServer Class)
TBD.
Syntax
class SAMLSPServerAssertionReceivedEventParams { public: qint64 ConnectionID(); int AssertionOrigin(); const QString &Content(); void SetContent(const QString &qsContent); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AssertionReceived(SAMLSPServerAssertionReceivedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireAssertionReceived(SAMLSPServerAssertionReceivedEventParams *e) {...}
Remarks
TBD.
Connect Event (SAMLSPServer Class)
Reports an accepted connection.
Syntax
class SAMLSPServerConnectEventParams { public: qint64 ConnectionId(); const QString &RemoteAddress(); int RemotePort(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connect(SAMLSPServerConnectEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireConnect(SAMLSPServerConnectEventParams *e) {...}
Remarks
The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as SessionClosed or SessionEstablished.
Disconnect Event (SAMLSPServer Class)
Fires to report a disconnected client.
Syntax
class SAMLSPServerDisconnectEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnect(SAMLSPServerDisconnectEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireDisconnect(SAMLSPServerDisconnectEventParams *e) {...}
Remarks
The class fires this event when a connected client disconnects.
Error Event (SAMLSPServer Class)
Information about errors during data delivery.
Syntax
class SAMLSPServerErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SAMLSPServerErrorEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireError(SAMLSPServerErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section.
ExternalSign Event (SAMLSPServer Class)
Handles remote or external signing initiated by the server protocol.
Syntax
class SAMLSPServerExternalSignEventParams { public: qint64 ConnectionID(); const QString &OperationId(); const QString &HashAlgorithm(); const QString &Pars(); const QString &Data(); const QString &SignedData(); void SetSignedData(const QString &qsSignedData); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ExternalSign(SAMLSPServerExternalSignEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireExternalSign(SAMLSPServerExternalSignEventParams *e) {...}
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
MetadataRequest Event (SAMLSPServer Class)
TBD.
Syntax
class SAMLSPServerMetadataRequestEventParams { public: qint64 ConnectionID(); const QString &Metadata(); void SetMetadata(const QString &qsMetadata); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void MetadataRequest(SAMLSPServerMetadataRequestEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireMetadataRequest(SAMLSPServerMetadataRequestEventParams *e) {...}
Remarks
TBD.
Notification Event (SAMLSPServer Class)
This event notifies the application about an underlying control flow event.
Syntax
class SAMLSPServerNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(SAMLSPServerNotificationEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireNotification(SAMLSPServerNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
ResourceClose Event (SAMLSPServer Class)
TBD.
Syntax
class SAMLSPServerResourceCloseEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceClose(SAMLSPServerResourceCloseEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireResourceClose(SAMLSPServerResourceCloseEventParams *e) {...}
Remarks
TBD.
The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceOpen Event (SAMLSPServer Class)
TBD.
Syntax
class SAMLSPServerResourceOpenEventParams { public: qint64 ConnectionID(); const QString &URL(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceOpen(SAMLSPServerResourceOpenEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireResourceOpen(SAMLSPServerResourceOpenEventParams *e) {...}
Remarks
TBD. 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 (SAMLSPServer Class)
TBD.
Syntax
class SAMLSPServerResourceReadEventParams { public: qint64 ConnectionID(); int Size(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceRead(SAMLSPServerResourceReadEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireResourceRead(SAMLSPServerResourceReadEventParams *e) {...}
Remarks
TBD.
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 ReadFile 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 (SAMLSPServer Class)
TBD.
Syntax
class SAMLSPServerResourceRequestEventParams { public: qint64 ConnectionID(); const QString &URL(); bool ResProtected(); void SetResProtected(bool bResProtected); bool ResSpecial(); void SetResSpecial(bool bResSpecial); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceRequest(SAMLSPServerResourceRequestEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireResourceRequest(SAMLSPServerResourceRequestEventParams *e) {...}
Remarks
TBD. 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.
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 |
SessionClosed Event (SAMLSPServer Class)
This event is fired when the SP server has closed a session.
Syntax
class SAMLSPServerSessionClosedEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SessionClosed(SAMLSPServerSessionClosedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSessionClosed(SAMLSPServerSessionClosedEventParams *e) {...}
Remarks
ConnectionID contains the identifier of the closed session.
SessionEstablished Event (SAMLSPServer Class)
This event is fired when a new session has been established.
Syntax
class SAMLSPServerSessionEstablishedEventParams { public: qint64 ConnectionID(); const QString &Username(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SessionEstablished(SAMLSPServerSessionEstablishedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSessionEstablished(SAMLSPServerSessionEstablishedEventParams *e) {...}
Remarks
ConnectionID contains the identifier of the new session, Username specifies the client's address and Username.
SessionStageChanged Event (SAMLSPServer Class)
TBD.
Syntax
class SAMLSPServerSessionStageChangedEventParams { public: qint64 ConnectionID(); const QString &Session(); const QString &Stage(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SessionStageChanged(SAMLSPServerSessionStageChangedEventParams *e);
// Or, subclass SAMLSPServer and override this emitter function. virtual int FireSessionStageChanged(SAMLSPServerSessionStageChangedEventParams *e) {...}
Remarks
TBD.
Configuration Settings (SAMLSPServer Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.SAMLSPServer Configuration Settings | ||||||||||||||||||||||||||||||
BoundPort: The port that was bound by the server.Returns the port number that was bound by the server. | ||||||||||||||||||||||||||||||
DualStack: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. | ||||||||||||||||||||||||||||||
HandshakeTimeout: The HTTPS handshake timeout.The HTTPS handshake timeout in milliseconds. | ||||||||||||||||||||||||||||||
MaxIssueInstantTimeDiff: The maximum issue-instant time delta.This property specifies the maximum time delta for serving issue-instant requests, in milliseconds. The default value is 30000. | ||||||||||||||||||||||||||||||
PortRangeFrom: The lower bound of allowed port scope to listen on.Specifies the lowest port number the server may use if dynamic allocation is used. | ||||||||||||||||||||||||||||||
PortRangeTo: The higher bound of allowed port scope to listen on.Specifies the highest port number the server may use if dynamic allocation is used. | ||||||||||||||||||||||||||||||
SendBufferSize: The network send buffer size.Specifies the size of the output buffer. | ||||||||||||||||||||||||||||||
ServerName: Specifies the server name for the created responses.Use this property to specify the server name to be included in the generated responses. | ||||||||||||||||||||||||||||||
SessionTimeout: The HTTP session timeout.The HTTP session timeout in milliseconds. | ||||||||||||||||||||||||||||||
SessionTTL: The SAML session time-to-live value.The SAML session time-to-live value, in milliseconds. The default value is 600000 (10 minutes). | ||||||||||||||||||||||||||||||
TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (SAMLSPServer Class)
SAMLSPServer Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
30408705 Invalid binging name (SB_ERROR_SAML_INVALID_BINDING_NAME) | |
30408706 Invalid binding type (SB_ERROR_SAML_INVALID_BINDING_TYPE) | |
30408707 Base directory not set (SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET) |