DTLSServer Class
Properties Methods Events Configuration Settings Errors
The DTLSServer class provides server-side functionality of the DTLS protocol.
Syntax
DTLSServer
Remarks
Use this component to receive data over a protected DTLS channel in your applcation.
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 | Indicates whether the server is active and is listening to new connections. |
| BoundPort | Indicates the bound listening port. |
| 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 | The host to bind the listening port to. |
| PinnedClientAddress | The client's IP address. |
| PinnedClientChainValidationDetails | The details of a certificate chain validation outcome. |
| PinnedClientChainValidationResult | The outcome of a certificate chain validation routine. |
| PinnedClientCiphersuite | The cipher suite employed by this connection. |
| PinnedClientClientAuthenticated | Specifies whether client authentication was performed during this connection. |
| PinnedClientDigestAlgorithm | The digest algorithm used in a TLS-enabled connection. |
| PinnedClientEncryptionAlgorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
| PinnedClientID | The client connection's unique identifier. |
| PinnedClientKeyExchangeAlgorithm | The key exchange algorithm used in a TLS-enabled connection. |
| PinnedClientKeyExchangeKeyBits | The length of the key exchange key of a TLS-enabled connection. |
| PinnedClientNamedECCurve | The elliptic curve used in this connection. |
| PinnedClientPFSCipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
| PinnedClientPort | The remote port of the client connection. |
| PinnedClientPreSharedIdentity | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| PinnedClientPublicKeyBits | The length of the public key. |
| PinnedClientResumedSession | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
| PinnedClientSecureConnection | Indicates whether TLS or SSL is enabled for this connection. |
| PinnedClientSignatureAlgorithm | The signature algorithm used in a TLS handshake. |
| PinnedClientSymmetricBlockSize | The block size of the symmetric algorithm used. |
| PinnedClientSymmetricKeyBits | The key length of the symmetric algorithm used. |
| PinnedClientTotalBytesReceived | The total number of bytes received over this connection. |
| PinnedClientTotalBytesSent | The total number of bytes sent over this connection. |
| PinnedClientValidationLog | Contains the server certificate's chain validation log. |
| PinnedClientVersion | Indicates the version of SSL/TLS protocol negotiated during this connection. |
| PinnedClientCertCount | The number of records in the PinnedClientCert arrays. |
| PinnedClientCertBytes | Returns raw certificate data in DER format. |
| PinnedClientCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| PinnedClientCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| PinnedClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| PinnedClientCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| PinnedClientCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| PinnedClientCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| PinnedClientCertKeyBits | Returns the length of the public key. |
| PinnedClientCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| PinnedClientCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| PinnedClientCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| PinnedClientCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| PinnedClientCertSerialNumber | Returns the certificate's serial number. |
| PinnedClientCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| PinnedClientCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| PinnedClientCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| PinnedClientCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| PinnedClientCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| PinnedClientCertValidTo | The time point at which the certificate expires, in UTC. |
| Port | Specifies the port number to listen for connections on. |
| PortRangeFrom | Specifies the lower limit of the listening port range for incoming connections. |
| PortRangeTo | Specifies the upper limit of the listening port range for incoming connections. |
| 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. |
| 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. |
| 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. |
| WebsiteName | Specifies the web site name to use in the certificate. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| BroadcastData | TBD. |
| BroadcastTest | TBD. |
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| DropClient | Terminates a client connection. |
| ExportKeyMaterial | TBD. |
| ListClients | Enumerates the connected clients. |
| PinClient | Takes a snapshot of the connection's properties. |
| ProcessPlainData | Process a plain data buffer to a connection client. |
| SendData | Sends a data buffer to a connection client. |
| SendKeepAlive | Sends a keep-alive packet. |
| SendPlainData | Sends a data buffer to a connection client. |
| SendText | Sends a text string to a client. |
| Start | Starts the DTLS server. |
| Stop | Stops the DTLS 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. |
| CertificateValidate | Fires when a client certificate needs to be validated. |
| Data | Supplies a data chunk received from a client. |
| Error | Information about errors during data delivery. |
| ExternalSign | Handles remote or external signing initiated by the server protocol. |
| Notification | This event notifies the application about an underlying control flow event. |
| PlainData | Supplies a plain data chunk received from a client. |
| TLSEstablished | Reports the setup of a TLS session. |
| TLSHandshake | TBD. |
| TLSPSK | Requests a pre-shared key for TLS-PSK. |
| TLSShutdown | Reports closure of a TLS session. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| ClientAuth | Enables or disables certificate-based client authentication. |
| DatagramSize | Specifies maximum size of the datagram. |
| DualStack | Allows the use of ip4 and ip6 simultaneously. |
| Host | The host to bind to. |
| RetransmissionInterval | Specifies value of the retransmission interval. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| SplitLongData | Specifies whether to split long datagrams into smaller ones. |
| WebsiteName | The website name for the TLS certificate. |
| 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 (DTLSServer Class)
Indicates whether the server is active and is listening to new connections.
Syntax
bool GetActive();
Default Value
false
Remarks
This read-only property returns True if the server is listening to incoming connections.
This property is read-only and not available at design time.
Data Type
Boolean
BoundPort Property (DTLSServer Class)
Indicates the bound listening port.
Syntax
int GetBoundPort();
Default Value
0
Remarks
Check this property to find out the port that has been allocated to the server by the system. The bound port always equals Port if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.
This property is read-only and not available at design time.
Data Type
Integer
ErrorOrigin Property (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer Class)
The host to bind the listening port to.
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.
Data Type
String
PinnedClientAddress Property (DTLSServer Class)
The client's IP address.
Syntax
QString GetPinnedClientAddress();
Default Value
""
Remarks
The client's IP address.
This property is read-only and not available at design time.
Data Type
String
PinnedClientChainValidationDetails Property (DTLSServer Class)
The details of a certificate chain validation outcome.
Syntax
int GetPinnedClientChainValidationDetails();
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest what 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 |
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientChainValidationResult Property (DTLSServer Class)
The outcome of a certificate chain validation routine.
Syntax
int GetPinnedClientChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
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.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCiphersuite Property (DTLSServer Class)
The cipher suite employed by this connection.
Syntax
QString GetPinnedClientCiphersuite();
Default Value
""
Remarks
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientClientAuthenticated Property (DTLSServer Class)
Specifies whether client authentication was performed during this connection.
Syntax
bool GetPinnedClientClientAuthenticated();
Default Value
false
Remarks
Specifies whether client authentication was performed during this connection.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientDigestAlgorithm Property (DTLSServer Class)
The digest algorithm used in a TLS-enabled connection.
Syntax
QString GetPinnedClientDigestAlgorithm();
Default Value
""
Remarks
The digest algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientEncryptionAlgorithm Property (DTLSServer Class)
The symmetric encryption algorithm used in a TLS-enabled connection.
Syntax
QString GetPinnedClientEncryptionAlgorithm();
Default Value
""
Remarks
The symmetric encryption algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientID Property (DTLSServer Class)
The client connection's unique identifier.
Syntax
qint64 GetPinnedClientID();
Default Value
-1
Remarks
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientKeyExchangeAlgorithm Property (DTLSServer Class)
The key exchange algorithm used in a TLS-enabled connection.
Syntax
QString GetPinnedClientKeyExchangeAlgorithm();
Default Value
""
Remarks
The key exchange algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientKeyExchangeKeyBits Property (DTLSServer Class)
The length of the key exchange key of a TLS-enabled connection.
Syntax
int GetPinnedClientKeyExchangeKeyBits();
Default Value
0
Remarks
The length of the key exchange key of a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientNamedECCurve Property (DTLSServer Class)
The elliptic curve used in this connection.
Syntax
QString GetPinnedClientNamedECCurve();
Default Value
""
Remarks
The elliptic curve used in this connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientPFSCipher Property (DTLSServer Class)
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
Syntax
bool GetPinnedClientPFSCipher();
Default Value
false
Remarks
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientPort Property (DTLSServer Class)
The remote port of the client connection.
Syntax
int GetPinnedClientPort();
Default Value
0
Remarks
The remote port of the client connection.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientPreSharedIdentity Property (DTLSServer Class)
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
QString GetPinnedClientPreSharedIdentity();
Default Value
""
Remarks
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is read-only and not available at design time.
Data Type
String
PinnedClientPublicKeyBits Property (DTLSServer Class)
The length of the public key.
Syntax
int GetPinnedClientPublicKeyBits();
Default Value
0
Remarks
The length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientResumedSession Property (DTLSServer Class)
Indicates whether a TLS-enabled connection was spawned from another TLS connection.
Syntax
bool GetPinnedClientResumedSession();
Default Value
false
Remarks
Indicates whether a TLS-enabled connection was spawned from another TLS connection
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientSecureConnection Property (DTLSServer Class)
Indicates whether TLS or SSL is enabled for this connection.
Syntax
bool GetPinnedClientSecureConnection();
Default Value
false
Remarks
Indicates whether TLS or SSL is enabled for this connection.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientSignatureAlgorithm Property (DTLSServer Class)
The signature algorithm used in a TLS handshake.
Syntax
QString GetPinnedClientSignatureAlgorithm();
Default Value
""
Remarks
The signature algorithm used in a TLS handshake.
This property is read-only and not available at design time.
Data Type
String
PinnedClientSymmetricBlockSize Property (DTLSServer Class)
The block size of the symmetric algorithm used.
Syntax
int GetPinnedClientSymmetricBlockSize();
Default Value
0
Remarks
The block size of the symmetric algorithm used.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientSymmetricKeyBits Property (DTLSServer Class)
The key length of the symmetric algorithm used.
Syntax
int GetPinnedClientSymmetricKeyBits();
Default Value
0
Remarks
The key length of the symmetric algorithm used.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientTotalBytesReceived Property (DTLSServer Class)
The total number of bytes received over this connection.
Syntax
qint64 GetPinnedClientTotalBytesReceived();
Default Value
0
Remarks
The total number of bytes received over this connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientTotalBytesSent Property (DTLSServer Class)
The total number of bytes sent over this connection.
Syntax
qint64 GetPinnedClientTotalBytesSent();
Default Value
0
Remarks
The total number of bytes sent over this connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientValidationLog Property (DTLSServer Class)
Contains the server certificate's chain validation log.
Syntax
QString GetPinnedClientValidationLog();
Default Value
""
Remarks
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only and not available at design time.
Data Type
String
PinnedClientVersion Property (DTLSServer Class)
Indicates the version of SSL/TLS protocol negotiated during this connection.
Syntax
QString GetPinnedClientVersion();
Default Value
""
Remarks
Indicates the version of SSL/TLS protocol negotiated during this connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertCount Property (DTLSServer Class)
The number of records in the PinnedClientCert arrays.
Syntax
int GetPinnedClientCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedClientCertBytes
- PinnedClientCertCAKeyID
- PinnedClientCertFingerprint
- PinnedClientCertHandle
- PinnedClientCertIssuer
- PinnedClientCertIssuerRDN
- PinnedClientCertKeyAlgorithm
- PinnedClientCertKeyBits
- PinnedClientCertKeyFingerprint
- PinnedClientCertKeyUsage
- PinnedClientCertPublicKeyBytes
- PinnedClientCertSelfSigned
- PinnedClientCertSerialNumber
- PinnedClientCertSigAlgorithm
- PinnedClientCertSubject
- PinnedClientCertSubjectKeyID
- PinnedClientCertSubjectRDN
- PinnedClientCertValidFrom
- PinnedClientCertValidTo
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertBytes Property (DTLSServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex);
Remarks
Returns raw certificate data in DER format.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertCAKeyID Property (DTLSServer Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex);
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertFingerprint Property (DTLSServer Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetPinnedClientCertFingerprint(int iPinnedClientCertIndex);
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertHandle Property (DTLSServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex);
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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientCertIssuer Property (DTLSServer Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex);
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertIssuerRDN Property (DTLSServer Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertKeyAlgorithm Property (DTLSServer Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);
Default Value
"0"
Remarks
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 |
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertKeyBits Property (DTLSServer Class)
Returns the length of the public key.
Syntax
int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex);
Default Value
0
Remarks
Returns the length of the public key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertKeyFingerprint Property (DTLSServer Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex);
Remarks
Returns a fingerprint of the public key contained in the certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertKeyUsage Property (DTLSServer Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex);
Default Value
0
Remarks
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 |
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertPublicKeyBytes Property (DTLSServer Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex);
Remarks
Contains the certificate's public key in DER format.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertSelfSigned Property (DTLSServer Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex);
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientCertSerialNumber Property (DTLSServer Class)
Returns the certificate's serial number.
Syntax
QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex);
Remarks
Returns the certificate's serial number.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertSigAlgorithm Property (DTLSServer Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex);
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertSubject Property (DTLSServer Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetPinnedClientCertSubject(int iPinnedClientCertIndex);
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertSubjectKeyID Property (DTLSServer Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex);
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertSubjectRDN Property (DTLSServer Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertValidFrom Property (DTLSServer Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertValidTo Property (DTLSServer Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
Port Property (DTLSServer Class)
Specifies the port number to listen for connections on.
Syntax
int GetPort();
int SetPort(int iPort);
Default Value
80
Remarks
Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.
Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Data Type
Integer
PortRangeFrom Property (DTLSServer Class)
Specifies the lower limit of the listening port range for incoming connections.
Syntax
int GetPortRangeFrom();
int SetPortRangeFrom(int iPortRangeFrom);
Default Value
0
Remarks
Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Data Type
Integer
PortRangeTo Property (DTLSServer Class)
Specifies the upper limit of the listening port range for incoming connections.
Syntax
int GetPortRangeTo();
int SetPortRangeTo(int iPortRangeTo);
Default Value
0
Remarks
Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.
Data Type
Integer
ServerCertCount Property (DTLSServer 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 (DTLSServer 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 (DTLSServer 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
SocketIncomingSpeedLimit Property (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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
TLSAutoValidateCertificates Property (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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 (DTLSServer 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
WebsiteName Property (DTLSServer Class)
Specifies the web site name to use in the certificate.
Syntax
QString GetWebsiteName();
int SetWebsiteName(QString qsWebsiteName);
Default Value
"SecureBlackbox"
Remarks
If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.
Data Type
String
BroadcastData Method (DTLSServer Class)
TBD.
Syntax
int BroadcastData(qint64 lConnectionID, QByteArray qbaData);
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.)
BroadcastTest Method (DTLSServer Class)
TBD.
Syntax
int BroadcastTest(qint64 lConnectionId, const QString& qsText);
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.)
Config Method (DTLSServer 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 (DTLSServer 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.
DropClient Method (DTLSServer Class)
Terminates a client connection.
Syntax
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
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.)
ExportKeyMaterial Method (DTLSServer Class)
TBD.
Syntax
int ExportKeyMaterial(qint64 lConnectionID, const QString& qsLbl, QByteArray qbaContext, int iLen);
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.)
ListClients Method (DTLSServer Class)
Enumerates the connected clients.
Syntax
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
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 (DTLSServer Class)
Takes a snapshot of the connection's properties.
Syntax
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
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.)
ProcessPlainData Method (DTLSServer Class)
Process a plain data buffer to a connection client.
Syntax
int ProcessPlainData(qint64 lConnectionID, QByteArray qbaBuffer);
Remarks
Use this method to process a plain data buffer to a connected client. Use ConnectionID to specify the client.
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.)
SendData Method (DTLSServer Class)
Sends a data buffer to a connection client.
Syntax
int SendData(qint64 lConnectionID, QByteArray qbaBuffer);
Remarks
Use this method to send a data buffer to a connected client. Use ConnectionID to specify the client.
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.)
SendKeepAlive Method (DTLSServer Class)
Sends a keep-alive packet.
Syntax
bool SendKeepAlive(qint64 lConnectionId);
Remarks
Use this method to send a keep-alive packet to a client. Keep alive is an empty packet; keep-alive signals sent occasionally can be used to keep connection up.
Error Handling
This method returns a Boolean 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.
SendPlainData Method (DTLSServer Class)
Sends a data buffer to a connection client.
Syntax
int SendPlainData(qint64 lConnectionID, QByteArray qbaBuffer);
Remarks
Use this method to send a data buffer to a connected client. Use ConnectionID to specify the client.
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.)
SendText Method (DTLSServer Class)
Sends a text string to a client.
Syntax
int SendText(qint64 lConnectionId, const QString& qsText);
Remarks
Use this method to send a text string to a connected client.
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 (DTLSServer Class)
Starts the DTLS server.
Syntax
int Start();
Remarks
Use this method to start listening for incoming data.
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 (DTLSServer Class)
Stops the DTLS server.
Syntax
int Stop();
Remarks
Call this method to stop listening for incoming data.
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 (DTLSServer Class)
Reports an incoming connection.
Syntax
class DTLSServerAcceptEventParams {
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(DTLSServerAcceptEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireAccept(DTLSServerAcceptEventParams *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.
CertificateValidate Event (DTLSServer Class)
Fires when a client certificate needs to be validated.
Syntax
class DTLSServerCertificateValidateEventParams {
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 CertificateValidate(DTLSServerCertificateValidateEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireCertificateValidate(DTLSServerCertificateValidateEventParams *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.
Data Event (DTLSServer Class)
Supplies a data chunk received from a client.
Syntax
class DTLSServerDataEventParams {
public:
qint64 ConnectionID();
const QByteArray &Buffer();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Data(DTLSServerDataEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireData(DTLSServerDataEventParams *e) {...}
Remarks
This event is fired to supply another piece of data received from a client. This event may fire multiple times.
Error Event (DTLSServer Class)
Information about errors during data delivery.
Syntax
class DTLSServerErrorEventParams {
public:
qint64 ConnectionID();
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(DTLSServerErrorEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireError(DTLSServerErrorEventParams *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 HTTPS section.
ExternalSign Event (DTLSServer Class)
Handles remote or external signing initiated by the server protocol.
Syntax
class DTLSServerExternalSignEventParams {
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(DTLSServerExternalSignEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireExternalSign(DTLSServerExternalSignEventParams *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
Notification Event (DTLSServer Class)
This event notifies the application about an underlying control flow event.
Syntax
class DTLSServerNotificationEventParams {
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(DTLSServerNotificationEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireNotification(DTLSServerNotificationEventParams *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.
PlainData Event (DTLSServer Class)
Supplies a plain data chunk received from a client.
Syntax
class DTLSServerPlainDataEventParams {
public:
qint64 ConnectionID();
const QByteArray &Buffer();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void PlainData(DTLSServerPlainDataEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FirePlainData(DTLSServerPlainDataEventParams *e) {...}
Remarks
This event is fired to supply another piece of plain data received from a client. This event may fire multiple times.
TLSEstablished Event (DTLSServer Class)
Reports the setup of a TLS session.
Syntax
class DTLSServerTLSEstablishedEventParams {
public:
qint64 ConnectionID();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void TLSEstablished(DTLSServerTLSEstablishedEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireTLSEstablished(DTLSServerTLSEstablishedEventParams *e) {...}
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (DTLSServer Class)
TBD.
Syntax
class DTLSServerTLSHandshakeEventParams {
public:
qint64 ConnectionID();
const QString &ServerName();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void TLSHandshake(DTLSServerTLSHandshakeEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireTLSHandshake(DTLSServerTLSHandshakeEventParams *e) {...}
Remarks
TBD
TLSPSK Event (DTLSServer Class)
Requests a pre-shared key for TLS-PSK.
Syntax
class DTLSServerTLSPSKEventParams {
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(DTLSServerTLSPSKEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireTLSPSK(DTLSServerTLSPSKEventParams *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 ciphersuite associated with that identity and their key.
TLSShutdown Event (DTLSServer Class)
Reports closure of a TLS session.
Syntax
class DTLSServerTLSShutdownEventParams {
public:
qint64 ConnectionID();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void TLSShutdown(DTLSServerTLSShutdownEventParams *e);
// Or, subclass DTLSServer and override this emitter function.
virtual int FireTLSShutdown(DTLSServerTLSShutdownEventParams *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.
Configuration Settings (DTLSServer 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.DTLSServer Configuration Settings | ||||||||||||||||||||||||||||||
ClientAuth:
Enables or disables certificate-based client authentication.Set this property to one of the below values to tune up the client authentication logic:
If this property is set to 1 or 2, the component will request certificates from the connecting clients. Depending on the setting, the clients that fail to provide their certificate in response will be allowed or disallowed to proceed with the connection. The server signals about a received certificate by firing its CertificateValidate event. Use PinClient method in the event handler to pin the client details, and access the provided certificate chain via the PinnedClientChain property. Note that this event is fired from the connecting clients threads, so please make sure you avoid bottlenecks in the event handler and put appropriate thread safety measures in place. Unlike the client-side components, the server component does not perform automated certificate validation against the local security policy. You must perform appropriate certificate validation steps in your CertificateValidate event handler. |
||||||||||||||||||||||||||||||
| DatagramSize: Specifies maximum size of the datagram.Use this property to get or set maximum size of the datagram. Data pieces larger than DatagramSize will be split into several smaller datagrams with lengths smaller (or equal) to the DatagramSize. | ||||||||||||||||||||||||||||||
| DualStack: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. | ||||||||||||||||||||||||||||||
| Host: The host to bind to.Specifies a specific interface the server should listen on. | ||||||||||||||||||||||||||||||
| RetransmissionInterval: Specifies value of the retransmission interval.Use this property to specify the period of time in milliseconds, after which the client will repeat sending. Set this property to 0 to disable the retransmission timer. Defaul value is 1000 (i.e. 1 second). | ||||||||||||||||||||||||||||||
| ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. | ||||||||||||||||||||||||||||||
| SplitLongData: Specifies whether to split long datagrams into smaller ones.If this prperty is set to True, datagrams larger than MaxDataSize will be split into smaller ones. Default value is True. | ||||||||||||||||||||||||||||||
| WebsiteName: The website name for the TLS certificate.Assign this property with a name to put in a self-generated TLS certificate. | ||||||||||||||||||||||||||||||
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 (DTLSServer Class)
DTLSServer 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) |