DTLSServer Class

Properties   Methods   Events   Config 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.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Active Property (DTLSServer Class)

Indicates whether the server is active and is listening to new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();

int secureblackbox_dtlsserver_getactive(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBoundPort();

Unicode (Windows)
INT GetBoundPort();

int secureblackbox_dtlsserver_getboundport(void* lpObj);

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

• C++
• C
• Qt

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

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

EO_LOCAL(0), 
EO_REMOTE(1)

int secureblackbox_dtlsserver_geterrororigin(void* lpObj);
int secureblackbox_dtlsserver_seterrororigin(void* lpObj, int iErrorOrigin);

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

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

ErrorSeverity Property (DTLSServer Class)

The severity of the error that happened.

Syntax

• C++
• C
• Qt

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

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

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

int secureblackbox_dtlsserver_geterrorseverity(void* lpObj);
int secureblackbox_dtlsserver_seterrorseverity(void* lpObj, int iErrorSeverity);

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

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

This property is not available at design time.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

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

Default Value

""

Remarks

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

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

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

Data Type

String

ExternalCryptoCustomParams Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_getexternalcryptodata(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_dtlsserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

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

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (DTLSServer Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

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

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

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

Default Value

""

Remarks

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

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

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

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

Example:

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

Data Type

String

ExternalCryptoKeySecret Property (DTLSServer Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

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

Default Value

""

Remarks

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

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (DTLSServer Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

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

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

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_dtlsserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

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

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (DTLSServer Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

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

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

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

int secureblackbox_dtlsserver_getexternalcryptomode(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

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

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_dtlsserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (DTLSServer Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_dtlsserver_getfipsmode(void* lpObj);
int secureblackbox_dtlsserver_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

Host Property (DTLSServer Class)

The host to bind the listening port to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHost();
int SetHost(const char* lpszHost);

Unicode (Windows)
LPWSTR GetHost();
INT SetHost(LPCWSTR lpszHost);

char* secureblackbox_dtlsserver_gethost(void* lpObj);
int secureblackbox_dtlsserver_sethost(void* lpObj, const char* lpszHost);

QString GetHost();
int SetHost(QString qsHost);

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

Data Type

String

PinnedClientAddress Property (DTLSServer Class)

The client's IP address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientAddress();

Unicode (Windows)
LPWSTR GetPinnedClientAddress();

char* secureblackbox_dtlsserver_getpinnedclientaddress(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientChainValidationDetails();

Unicode (Windows)
INT GetPinnedClientChainValidationDetails();

int secureblackbox_dtlsserver_getpinnedclientchainvalidationdetails(void* lpObj);

int GetPinnedClientChainValidationDetails();

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientChainValidationResult();

Unicode (Windows)
INT GetPinnedClientChainValidationResult();

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1), 
CVT_INVALID(2), 
CVT_CANT_BE_ESTABLISHED(3)

int secureblackbox_dtlsserver_getpinnedclientchainvalidationresult(void* lpObj);

int GetPinnedClientChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCiphersuite();

Unicode (Windows)
LPWSTR GetPinnedClientCiphersuite();

char* secureblackbox_dtlsserver_getpinnedclientciphersuite(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientClientAuthenticated();

Unicode (Windows)
BOOL GetPinnedClientClientAuthenticated();

int secureblackbox_dtlsserver_getpinnedclientclientauthenticated(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientDigestAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientDigestAlgorithm();

char* secureblackbox_dtlsserver_getpinnedclientdigestalgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientEncryptionAlgorithm();

char* secureblackbox_dtlsserver_getpinnedclientencryptionalgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientID();

Unicode (Windows)
LONG64 GetPinnedClientID();

int64 secureblackbox_dtlsserver_getpinnedclientid(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientKeyExchangeAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientKeyExchangeAlgorithm();

char* secureblackbox_dtlsserver_getpinnedclientkeyexchangealgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientKeyExchangeKeyBits();

Unicode (Windows)
INT GetPinnedClientKeyExchangeKeyBits();

int secureblackbox_dtlsserver_getpinnedclientkeyexchangekeybits(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientNamedECCurve();

Unicode (Windows)
LPWSTR GetPinnedClientNamedECCurve();

char* secureblackbox_dtlsserver_getpinnedclientnamedeccurve(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientPFSCipher();

Unicode (Windows)
BOOL GetPinnedClientPFSCipher();

int secureblackbox_dtlsserver_getpinnedclientpfscipher(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientPort();

Unicode (Windows)
INT GetPinnedClientPort();

int secureblackbox_dtlsserver_getpinnedclientport(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientPreSharedIdentity();

Unicode (Windows)
LPWSTR GetPinnedClientPreSharedIdentity();

char* secureblackbox_dtlsserver_getpinnedclientpresharedidentity(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientPublicKeyBits();

Unicode (Windows)
INT GetPinnedClientPublicKeyBits();

int secureblackbox_dtlsserver_getpinnedclientpublickeybits(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientResumedSession();

Unicode (Windows)
BOOL GetPinnedClientResumedSession();

int secureblackbox_dtlsserver_getpinnedclientresumedsession(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientSecureConnection();

Unicode (Windows)
BOOL GetPinnedClientSecureConnection();

int secureblackbox_dtlsserver_getpinnedclientsecureconnection(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetPinnedClientSignatureAlgorithm();

char* secureblackbox_dtlsserver_getpinnedclientsignaturealgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientSymmetricBlockSize();

Unicode (Windows)
INT GetPinnedClientSymmetricBlockSize();

int secureblackbox_dtlsserver_getpinnedclientsymmetricblocksize(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientSymmetricKeyBits();

Unicode (Windows)
INT GetPinnedClientSymmetricKeyBits();

int secureblackbox_dtlsserver_getpinnedclientsymmetrickeybits(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientTotalBytesReceived();

Unicode (Windows)
LONG64 GetPinnedClientTotalBytesReceived();

int64 secureblackbox_dtlsserver_getpinnedclienttotalbytesreceived(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientTotalBytesSent();

Unicode (Windows)
LONG64 GetPinnedClientTotalBytesSent();

int64 secureblackbox_dtlsserver_getpinnedclienttotalbytessent(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientValidationLog();

Unicode (Windows)
LPWSTR GetPinnedClientValidationLog();

char* secureblackbox_dtlsserver_getpinnedclientvalidationlog(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientVersion();

Unicode (Windows)
LPWSTR GetPinnedClientVersion();

char* secureblackbox_dtlsserver_getpinnedclientversion(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertCount();

Unicode (Windows)
INT GetPinnedClientCertCount();

int secureblackbox_dtlsserver_getpinnedclientcertcount(void* lpObj);

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

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

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

Data Type

Integer

PinnedClientCertBytes Property (DTLSServer Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertBytes(int iPinnedClientCertIndex, char* &lpPinnedClientCertBytes, int &lenPinnedClientCertBytes);

Unicode (Windows)
INT GetPinnedClientCertBytes(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertBytes, INT &lenPinnedClientCertBytes);

int secureblackbox_dtlsserver_getpinnedclientcertbytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertBytes, int* lenPinnedClientCertBytes);

QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex);

Remarks

Returns the 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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex, char* &lpPinnedClientCertCAKeyID, int &lenPinnedClientCertCAKeyID);

Unicode (Windows)
INT GetPinnedClientCertCAKeyID(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertCAKeyID, INT &lenPinnedClientCertCAKeyID);

int secureblackbox_dtlsserver_getpinnedclientcertcakeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertCAKeyID, int* lenPinnedClientCertCAKeyID);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertFingerprint(int iPinnedClientCertIndex, char* &lpPinnedClientCertFingerprint, int &lenPinnedClientCertFingerprint);

Unicode (Windows)
INT GetPinnedClientCertFingerprint(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertFingerprint, INT &lenPinnedClientCertFingerprint);

int secureblackbox_dtlsserver_getpinnedclientcertfingerprint(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertFingerprint, int* lenPinnedClientCertFingerprint);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedClientCertHandle(int iPinnedClientCertIndex);

Unicode (Windows)
LONG64 GetPinnedClientCertHandle(INT iPinnedClientCertIndex);

int64 secureblackbox_dtlsserver_getpinnedclientcerthandle(void* lpObj, int pinnedclientcertindex);

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.

 
 Copy
  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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertIssuer(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertIssuer(INT iPinnedClientCertIndex);

char* secureblackbox_dtlsserver_getpinnedclientcertissuer(void* lpObj, int pinnedclientcertindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertIssuerRDN(INT iPinnedClientCertIndex);

char* secureblackbox_dtlsserver_getpinnedclientcertissuerrdn(void* lpObj, int pinnedclientcertindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertKeyAlgorithm(INT iPinnedClientCertIndex);

char* secureblackbox_dtlsserver_getpinnedclientcertkeyalgorithm(void* lpObj, int pinnedclientcertindex);

QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);

Default Value

"0"

Remarks

Specifies the public key algorithm 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

String

PinnedClientCertKeyBits Property (DTLSServer Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex);

Unicode (Windows)
INT GetPinnedClientCertKeyBits(INT iPinnedClientCertIndex);

int secureblackbox_dtlsserver_getpinnedclientcertkeybits(void* lpObj, int pinnedclientcertindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex, char* &lpPinnedClientCertKeyFingerprint, int &lenPinnedClientCertKeyFingerprint);

Unicode (Windows)
INT GetPinnedClientCertKeyFingerprint(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertKeyFingerprint, INT &lenPinnedClientCertKeyFingerprint);

int secureblackbox_dtlsserver_getpinnedclientcertkeyfingerprint(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertKeyFingerprint, int* lenPinnedClientCertKeyFingerprint);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex);

Unicode (Windows)
INT GetPinnedClientCertKeyUsage(INT iPinnedClientCertIndex);

int secureblackbox_dtlsserver_getpinnedclientcertkeyusage(void* lpObj, int pinnedclientcertindex);

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:

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex, char* &lpPinnedClientCertPublicKeyBytes, int &lenPinnedClientCertPublicKeyBytes);

Unicode (Windows)
INT GetPinnedClientCertPublicKeyBytes(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertPublicKeyBytes, INT &lenPinnedClientCertPublicKeyBytes);

int secureblackbox_dtlsserver_getpinnedclientcertpublickeybytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertPublicKeyBytes, int* lenPinnedClientCertPublicKeyBytes);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex);

Unicode (Windows)
BOOL GetPinnedClientCertSelfSigned(INT iPinnedClientCertIndex);

int secureblackbox_dtlsserver_getpinnedclientcertselfsigned(void* lpObj, int pinnedclientcertindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex, char* &lpPinnedClientCertSerialNumber, int &lenPinnedClientCertSerialNumber);

Unicode (Windows)
INT GetPinnedClientCertSerialNumber(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertSerialNumber, INT &lenPinnedClientCertSerialNumber);

int secureblackbox_dtlsserver_getpinnedclientcertserialnumber(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSerialNumber, int* lenPinnedClientCertSerialNumber);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertSigAlgorithm(INT iPinnedClientCertIndex);

char* secureblackbox_dtlsserver_getpinnedclientcertsigalgorithm(void* lpObj, int pinnedclientcertindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertSubject(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertSubject(INT iPinnedClientCertIndex);

char* secureblackbox_dtlsserver_getpinnedclientcertsubject(void* lpObj, int pinnedclientcertindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex, char* &lpPinnedClientCertSubjectKeyID, int &lenPinnedClientCertSubjectKeyID);

Unicode (Windows)
INT GetPinnedClientCertSubjectKeyID(INT iPinnedClientCertIndex, LPSTR &lpPinnedClientCertSubjectKeyID, INT &lenPinnedClientCertSubjectKeyID);

int secureblackbox_dtlsserver_getpinnedclientcertsubjectkeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSubjectKeyID, int* lenPinnedClientCertSubjectKeyID);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertSubjectRDN(INT iPinnedClientCertIndex);

char* secureblackbox_dtlsserver_getpinnedclientcertsubjectrdn(void* lpObj, int pinnedclientcertindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertValidFrom(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertValidFrom(INT iPinnedClientCertIndex);

char* secureblackbox_dtlsserver_getpinnedclientcertvalidfrom(void* lpObj, int pinnedclientcertindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedClientCertValidTo(int iPinnedClientCertIndex);

Unicode (Windows)
LPWSTR GetPinnedClientCertValidTo(INT iPinnedClientCertIndex);

char* secureblackbox_dtlsserver_getpinnedclientcertvalidto(void* lpObj, int pinnedclientcertindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPort();
int SetPort(int iPort);

Unicode (Windows)
INT GetPort();
INT SetPort(INT iPort);

int secureblackbox_dtlsserver_getport(void* lpObj);
int secureblackbox_dtlsserver_setport(void* lpObj, int iPort);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPortRangeFrom();
int SetPortRangeFrom(int iPortRangeFrom);

Unicode (Windows)
INT GetPortRangeFrom();
INT SetPortRangeFrom(INT iPortRangeFrom);

int secureblackbox_dtlsserver_getportrangefrom(void* lpObj);
int secureblackbox_dtlsserver_setportrangefrom(void* lpObj, int iPortRangeFrom);

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.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

Integer

PortRangeTo Property (DTLSServer Class)

Specifies the upper limit of the listening port range for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPortRangeTo();
int SetPortRangeTo(int iPortRangeTo);

Unicode (Windows)
INT GetPortRangeTo();
INT SetPortRangeTo(INT iPortRangeTo);

int secureblackbox_dtlsserver_getportrangeto(void* lpObj);
int secureblackbox_dtlsserver_setportrangeto(void* lpObj, int iPortRangeTo);

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.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

Integer

ServerCertCount Property (DTLSServer Class)

The number of records in the ServerCert arrays.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_dtlsserver_getservercertcount(void* lpObj);
int secureblackbox_dtlsserver_setservercertcount(void* lpObj, int iServerCertCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerCertBytes
• ServerCertHandle

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

This property is not available at design time.

Data Type

Integer

ServerCertBytes Property (DTLSServer Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

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

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

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

QByteArray GetServerCertBytes(int iServerCertIndex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ServerCertHandle Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int64 secureblackbox_dtlsserver_getservercerthandle(void* lpObj, int servercertindex);
int secureblackbox_dtlsserver_setservercerthandle(void* lpObj, int servercertindex, int64 lServerCertHandle);

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

Default Value

0

Remarks

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

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

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

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

This property is not available at design time.

Data Type

Long64

SocketIncomingSpeedLimit Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_dtlsserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_dtlsserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

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

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (DTLSServer Class)

The local network interface to bind the socket to.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_dtlsserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

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

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (DTLSServer Class)

The local port number to bind the socket to.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_dtlsserver_getsocketlocalport(void* lpObj);
int secureblackbox_dtlsserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);

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

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_dtlsserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_dtlsserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

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

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_dtlsserver_getsockettimeout(void* lpObj);
int secureblackbox_dtlsserver_setsockettimeout(void* lpObj, int iSocketTimeout);

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

Default Value

60000

Remarks

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

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

Data Type

Integer

SocketUseIPv6 Property (DTLSServer Class)

Enables or disables IP protocol version 6.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_dtlsserver_getsocketuseipv6(void* lpObj);
int secureblackbox_dtlsserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

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

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSAutoValidateCertificates Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_dtlsserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_dtlsserver_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

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

Default Value

TRUE

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (DTLSServer Class)

Selects the base configuration for the TLS settings.

Syntax

• C++
• C
• Qt

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

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

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

int secureblackbox_dtlsserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_dtlsserver_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

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

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (DTLSServer Class)

A list of ciphersuites separated with commas or semicolons.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_gettlsciphersuites(void* lpObj);
int secureblackbox_dtlsserver_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

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

Default Value

""

Remarks

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

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

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

Data Type

String

TLSECCurves Property (DTLSServer Class)

Defines the elliptic curves to enable.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_gettlseccurves(void* lpObj);
int secureblackbox_dtlsserver_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

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

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (DTLSServer Class)

Provides access to TLS extensions.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_gettlsextensions(void* lpObj);
int secureblackbox_dtlsserver_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

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

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_dtlsserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_dtlsserver_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_dtlsserver_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_gettlspresharedkey(void* lpObj);
int secureblackbox_dtlsserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_dtlsserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_dtlsserver_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

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

Default Value

""

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (DTLSServer Class)

Selects the renegotiation attack prevention mechanism.

Syntax

• C++
• C
• Qt

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

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

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

int secureblackbox_dtlsserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_dtlsserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

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

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (DTLSServer Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int secureblackbox_dtlsserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_dtlsserver_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

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

Default Value

1

Remarks

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

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

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

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

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

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

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

This property is not available at design time.

Data Type