MessageTimestamper Class

Properties   Methods   Events   Config Settings   Errors  

The MessageTimestamper class timestamps data and stores it in the PKCS#7 format.

Syntax

MessageTimestamper

Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.

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.

DataFileName Property (MessageTimestamper Class)

A file name to be saved together with the timestamped data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDataFileName();
int SetDataFileName(const char* lpszDataFileName);

Unicode (Windows)
LPWSTR GetDataFileName();
INT SetDataFileName(LPCWSTR lpszDataFileName);

char* secureblackbox_messagetimestamper_getdatafilename(void* lpObj);
int secureblackbox_messagetimestamper_setdatafilename(void* lpObj, const char* lpszDataFileName);

QString GetDataFileName();
int SetDataFileName(QString qsDataFileName);

Default Value

""

Remarks

Use this property to provide a file name to be stored in the timestamp together with the timestamped data. This is only informational and does not necessarily need to match the file name provided via InputFile.

Data Type

String

DataURI Property (MessageTimestamper Class)

The URI to be included with the timestamped data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDataURI();
int SetDataURI(const char* lpszDataURI);

Unicode (Windows)
LPWSTR GetDataURI();
INT SetDataURI(LPCWSTR lpszDataURI);

char* secureblackbox_messagetimestamper_getdatauri(void* lpObj);
int secureblackbox_messagetimestamper_setdatauri(void* lpObj, const char* lpszDataURI);

QString GetDataURI();
int SetDataURI(QString qsDataURI);

Default Value

""

Remarks

Use this property to provide a URI to be saved alongside the timestamped data. This value is only informational.

Data Type

String

Detached Property (MessageTimestamper Class)

Specifies whether a detached timestamp should be produced.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDetached();
int SetDetached(int bDetached);

Unicode (Windows)
BOOL GetDetached();
INT SetDetached(BOOL bDetached);

int secureblackbox_messagetimestamper_getdetached(void* lpObj);
int secureblackbox_messagetimestamper_setdetached(void* lpObj, int bDetached);

bool GetDetached();
int SetDetached(bool bDetached);

Default Value

FALSE

Remarks

Set this property to true to produce a detached timestamp, i.e. kept separately and alongside the timestamped document.

Data Type

Boolean

FIPSMode Property (MessageTimestamper 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_messagetimestamper_getfipsmode(void* lpObj);
int secureblackbox_messagetimestamper_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

HashAlgorithm Property (MessageTimestamper Class)

Specifies the hash algorithm to be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHashAlgorithm();
int SetHashAlgorithm(const char* lpszHashAlgorithm);

Unicode (Windows)
LPWSTR GetHashAlgorithm();
INT SetHashAlgorithm(LPCWSTR lpszHashAlgorithm);

char* secureblackbox_messagetimestamper_gethashalgorithm(void* lpObj);
int secureblackbox_messagetimestamper_sethashalgorithm(void* lpObj, const char* lpszHashAlgorithm);

QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);

Default Value

"SHA256"

Remarks

This property specifies the hash algorithm to used for calculating the signature.

Data Type

String

InputBytes Property (MessageTimestamper Class)

Use this property to pass the input to class in the byte array form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_messagetimestamper_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_messagetimestamper_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (MessageTimestamper Class)

A path to the source file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_messagetimestamper_getinputfile(void* lpObj);
int secureblackbox_messagetimestamper_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

Use this property to provide a path to the file containing the data to be timestamped.

Data Type

String

InputIsHash Property (MessageTimestamper Class)

Specifies whether the input source contains the hash of the data or the actual data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputIsHash();
int SetInputIsHash(int bInputIsHash);

Unicode (Windows)
BOOL GetInputIsHash();
INT SetInputIsHash(BOOL bInputIsHash);

int secureblackbox_messagetimestamper_getinputishash(void* lpObj);
int secureblackbox_messagetimestamper_setinputishash(void* lpObj, int bInputIsHash);

bool GetInputIsHash();
int SetInputIsHash(bool bInputIsHash);

Default Value

FALSE

Remarks

Use this property to tell the component whether the input source contains the actual data or its hash.

This property is not available at design time.

Data Type

Boolean

OutputBytes Property (MessageTimestamper Class)

Use this property to read the output the class object has produced.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_messagetimestamper_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (MessageTimestamper Class)

A path to the output file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_messagetimestamper_getoutputfile(void* lpObj);
int secureblackbox_messagetimestamper_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

Use this property to specify the file to save the timestamped message to.

Data Type

String

ProxyAddress Property (MessageTimestamper Class)

The IP address of the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress);

Unicode (Windows)
LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);

char* secureblackbox_messagetimestamper_getproxyaddress(void* lpObj);
int secureblackbox_messagetimestamper_setproxyaddress(void* lpObj, const char* lpszProxyAddress);

QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (MessageTimestamper Class)

The authentication type used by the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Unicode (Windows)
INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1), 
PAT_DIGEST(2), 
PAT_NTLM(3)

int secureblackbox_messagetimestamper_getproxyauthentication(void* lpObj);
int secureblackbox_messagetimestamper_setproxyauthentication(void* lpObj, int iProxyAuthentication);

int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (MessageTimestamper Class)

The password to authenticate to the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* secureblackbox_messagetimestamper_getproxypassword(void* lpObj);
int secureblackbox_messagetimestamper_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (MessageTimestamper Class)

The port on the proxy server to connect to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int secureblackbox_messagetimestamper_getproxyport(void* lpObj);
int secureblackbox_messagetimestamper_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (MessageTimestamper Class)

The type of the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Unicode (Windows)
INT GetProxyProxyType();
INT SetProxyProxyType(INT iProxyProxyType);

CPT_NONE(0), 
CPT_SOCKS_4(1), 
CPT_SOCKS_5(2), 
CPT_WEB_TUNNEL(3), 
CPT_HTTP(4)

int secureblackbox_messagetimestamper_getproxyproxytype(void* lpObj);
int secureblackbox_messagetimestamper_setproxyproxytype(void* lpObj, int iProxyProxyType);

int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Default Value

0

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

Data Type

Integer

ProxyRequestHeaders Property (MessageTimestamper Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders);

Unicode (Windows)
LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);

char* secureblackbox_messagetimestamper_getproxyrequestheaders(void* lpObj);
int secureblackbox_messagetimestamper_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);

QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (MessageTimestamper Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody);

Unicode (Windows)
LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);

char* secureblackbox_messagetimestamper_getproxyresponsebody(void* lpObj);
int secureblackbox_messagetimestamper_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);

QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (MessageTimestamper Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders);

Unicode (Windows)
LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);

char* secureblackbox_messagetimestamper_getproxyresponseheaders(void* lpObj);
int secureblackbox_messagetimestamper_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);

QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (MessageTimestamper Class)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6);

Unicode (Windows)
BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);

int secureblackbox_messagetimestamper_getproxyuseipv6(void* lpObj);
int secureblackbox_messagetimestamper_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);

bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);

Default Value

FALSE

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUseProxy Property (MessageTimestamper Class)

Enables or disables proxy-driven connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy);

Unicode (Windows)
BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);

int secureblackbox_messagetimestamper_getproxyuseproxy(void* lpObj);
int secureblackbox_messagetimestamper_setproxyuseproxy(void* lpObj, int bProxyUseProxy);

bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (MessageTimestamper Class)

Specifies the username credential for proxy authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername);

Unicode (Windows)
LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);

char* secureblackbox_messagetimestamper_getproxyusername(void* lpObj);
int secureblackbox_messagetimestamper_setproxyusername(void* lpObj, const char* lpszProxyUsername);

QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

SocketDNSMode Property (MessageTimestamper Class)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Unicode (Windows)
INT GetSocketDNSMode();
INT SetSocketDNSMode(INT iSocketDNSMode);

DM_AUTO(0), 
DM_PLATFORM(1), 
DM_OWN(2), 
DM_OWN_SECURE(3)

int secureblackbox_messagetimestamper_getsocketdnsmode(void* lpObj);
int secureblackbox_messagetimestamper_setsocketdnsmode(void* lpObj, int iSocketDNSMode);

int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

Integer

SocketDNSPort Property (MessageTimestamper Class)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Unicode (Windows)
INT GetSocketDNSPort();
INT SetSocketDNSPort(INT iSocketDNSPort);

int secureblackbox_messagetimestamper_getsocketdnsport(void* lpObj);
int secureblackbox_messagetimestamper_setsocketdnsport(void* lpObj, int iSocketDNSPort);

int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (MessageTimestamper Class)

The timeout (in milliseconds) for each DNS query.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Unicode (Windows)
INT GetSocketDNSQueryTimeout();
INT SetSocketDNSQueryTimeout(INT iSocketDNSQueryTimeout);

int secureblackbox_messagetimestamper_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_messagetimestamper_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);

int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketDNSServers Property (MessageTimestamper Class)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSocketDNSServers();
int SetSocketDNSServers(const char* lpszSocketDNSServers);

Unicode (Windows)
LPWSTR GetSocketDNSServers();
INT SetSocketDNSServers(LPCWSTR lpszSocketDNSServers);

char* secureblackbox_messagetimestamper_getsocketdnsservers(void* lpObj);
int secureblackbox_messagetimestamper_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);

QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (MessageTimestamper Class)

The timeout (in milliseconds) for the whole resolution process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Unicode (Windows)
INT GetSocketDNSTotalTimeout();
INT SetSocketDNSTotalTimeout(INT iSocketDNSTotalTimeout);

int secureblackbox_messagetimestamper_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_messagetimestamper_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);

int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (MessageTimestamper 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_messagetimestamper_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper 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_messagetimestamper_getsocketlocaladdress(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper 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_messagetimestamper_getsocketlocalport(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper 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_messagetimestamper_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper 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_messagetimestamper_getsockettimeout(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper 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_messagetimestamper_getsocketuseipv6(void* lpObj);
int secureblackbox_messagetimestamper_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

TimestampFormat Property (MessageTimestamper Class)

Configures the desired timestamp format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimestampFormat();
int SetTimestampFormat(int iTimestampFormat);

Unicode (Windows)
INT GetTimestampFormat();
INT SetTimestampFormat(INT iTimestampFormat);

MTF_UNKNOWN(0), 
MTF_RFC5544(1), 
MTF_CMS(2), 
MTF_TSPREPLY(3)

int secureblackbox_messagetimestamper_gettimestampformat(void* lpObj);
int secureblackbox_messagetimestamper_settimestampformat(void* lpObj, int iTimestampFormat);

int GetTimestampFormat();
int SetTimestampFormat(int iTimestampFormat);

Default Value

0

Remarks

Use this property to set the format in which you would like to obtain the timestamp.

This property is not available at design time.

Data Type

Integer

TimestampServer Property (MessageTimestamper Class)

The address of the timestamping server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTimestampServer();
int SetTimestampServer(const char* lpszTimestampServer);

Unicode (Windows)
LPWSTR GetTimestampServer();
INT SetTimestampServer(LPCWSTR lpszTimestampServer);

char* secureblackbox_messagetimestamper_gettimestampserver(void* lpObj);
int secureblackbox_messagetimestamper_settimestampserver(void* lpObj, const char* lpszTimestampServer);

QString GetTimestampServer();
int SetTimestampServer(QString qsTimestampServer);

Default Value

""

Remarks

Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.

SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.

If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:

http://user:password@timestamp.server.com/TsaService

For TSAs using certificate-based TLS authentication, provide the client certificate via the TLSClientChain property.

If this property is left empty, no timestamp will be added to the signature.

Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.

To employ the virtual service, assign an URI of the following format to this property:

virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256

Subscribe to Notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:

component.Config("TimestampResponse=308208ab...");

Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.

The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.

The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.

The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.

All the parameters are optional.

Data Type

String

TLSClientCertCount Property (MessageTimestamper Class)

The number of records in the TLSClientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount);

Unicode (Windows)
INT GetTLSClientCertCount();
INT SetTLSClientCertCount(INT iTLSClientCertCount);

int secureblackbox_messagetimestamper_gettlsclientcertcount(void* lpObj);
int secureblackbox_messagetimestamper_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);

int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSClientCertBytes
• TLSClientCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSClientCertBytes Property (MessageTimestamper Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSClientCertBytes(int iTLSClientCertIndex, char* &lpTLSClientCertBytes, int &lenTLSClientCertBytes);

Unicode (Windows)
INT GetTLSClientCertBytes(INT iTLSClientCertIndex, LPSTR &lpTLSClientCertBytes, INT &lenTLSClientCertBytes);

int secureblackbox_messagetimestamper_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);

QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex);

Remarks

Returns raw certificate data in DER format.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

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

Data Type

Byte Array

TLSClientCertHandle Property (MessageTimestamper Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, int64 lTLSClientCertHandle);

Unicode (Windows)
LONG64 GetTLSClientCertHandle(INT iTLSClientCertIndex);
INT SetTLSClientCertHandle(INT iTLSClientCertIndex, LONG64 lTLSClientCertHandle);

int64 secureblackbox_messagetimestamper_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_messagetimestamper_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);

qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);

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 TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is not available at design time.

Data Type

Long64

TLSServerCertCount Property (MessageTimestamper Class)

The number of records in the TLSServerCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSServerCertCount();

Unicode (Windows)
INT GetTLSServerCertCount();

int secureblackbox_messagetimestamper_gettlsservercertcount(void* lpObj);

int GetTLSServerCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertHandle

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

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

Data Type

Integer

TLSServerCertBytes Property (MessageTimestamper Class)

Returns raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSServerCertBytes(int iTLSServerCertIndex, char* &lpTLSServerCertBytes, int &lenTLSServerCertBytes);

Unicode (Windows)
INT GetTLSServerCertBytes(INT iTLSServerCertIndex, LPSTR &lpTLSServerCertBytes, INT &lenTLSServerCertBytes);

int secureblackbox_messagetimestamper_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);

QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);

Remarks

Returns raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertHandle Property (MessageTimestamper Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetTLSServerCertHandle(int iTLSServerCertIndex);

Unicode (Windows)
LONG64 GetTLSServerCertHandle(INT iTLSServerCertIndex);

int64 secureblackbox_messagetimestamper_gettlsservercerthandle(void* lpObj, int tlsservercertindex);

qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);

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 TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Long64

TLSAutoValidateCertificates Property (MessageTimestamper 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_messagetimestamper_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper 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_messagetimestamper_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_messagetimestamper_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

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

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (MessageTimestamper 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_messagetimestamper_gettlsciphersuites(void* lpObj);
int secureblackbox_messagetimestamper_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

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

Default Value

""

Remarks

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

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

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

Data Type

String

TLSECCurves Property (MessageTimestamper 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_messagetimestamper_gettlseccurves(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper 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_messagetimestamper_gettlsextensions(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper 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_messagetimestamper_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper 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_messagetimestamper_gettlspresharedidentity(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_messagetimestamper_gettlspresharedkey(void* lpObj);
int secureblackbox_messagetimestamper_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (MessageTimestamper 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_messagetimestamper_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_messagetimestamper_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 (MessageTimestamper Class)

Selects renegotiation attack prevention mechanism.

Syntax

• C++
• C
• Qt

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

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

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

int secureblackbox_messagetimestamper_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_messagetimestamper_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

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

Default Value

0

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (MessageTimestamper 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_messagetimestamper_gettlsrevocationcheck(void* lpObj);
int secureblackbox_messagetimestamper_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

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

Default Value

1

Remarks

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

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (MessageTimestamper Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_messagetimestamper_gettlsssloptions(void* lpObj);
int secureblackbox_messagetimestamper_settlsssloptions(void* lpObj, int iTLSSSLOptions);

int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (MessageTimestamper Class)

Specifies the TLS mode to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Unicode (Windows)
INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);

SM_DEFAULT(0), 
SM_NO_TLS(1), 
SM_EXPLICIT_TLS(2), 
SM_IMPLICIT_TLS(3), 
SM_MIXED_TLS(4)

int secureblackbox_messagetimestamper_gettlstlsmode(void* lpObj);
int secureblackbox_messagetimestamper_settlstlsmode(void* lpObj, int iTLSTLSMode);

int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (MessageTimestamper Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret);

Unicode (Windows)
BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);

int secureblackbox_messagetimestamper_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_messagetimestamper_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (MessageTimestamper Class)

Enables or disables TLS session resumption capability.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption);

Unicode (Windows)
BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);

int secureblackbox_messagetimestamper_gettlsusesessionresumption(void* lpObj);
int secureblackbox_messagetimestamper_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

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

Default Value

FALSE

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (MessageTimestamper Class)

The SSL/TLS versions to enable by default.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Unicode (Windows)
INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);

int secureblackbox_messagetimestamper_gettlsversions(void* lpObj);
int secureblackbox_messagetimestamper_settlsversions(void* lpObj, int iTLSVersions);

int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

Config Method (MessageTimestamper Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_messagetimestamper_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (MessageTimestamper Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_messagetimestamper_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insencitive) of the action is provided in the ActionID parameter.

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Timestamp Method (MessageTimestamper Class)

Timestamps the data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Timestamp();

Unicode (Windows)
INT Timestamp();

int secureblackbox_messagetimestamper_timestamp(void* lpObj);

int Timestamp();

Remarks

Call this method to timestamp the content provided in InputFile (or InputStream) with a trusted timestamp from TimestampServer.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (MessageTimestamper Class)

Information about errors during PKCS#7 message encryption.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_MESSAGETIMESTAMPER_ERROR 1

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

class MessageTimestamperErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass MessageTimestamper and override this emitter function.
virtual int FireError(MessageTimestamperErrorEventParams *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 Messages section.

Notification Event (MessageTimestamper Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_MESSAGETIMESTAMPER_NOTIFICATION 2

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

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

// Or, subclass MessageTimestamper and override this emitter function.
virtual int FireNotification(MessageTimestamperNotificationEventParams *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.

This class can fire this event with the following EventID values:

TimestampRequest Event (MessageTimestamper Class)

Fires when the class is ready to request a timestamp from an external TSA.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTimestampRequest(MessageTimestamperTimestampRequestEventParams *e);

typedef struct {
  const char *TSA;
  const char *TimestampRequest;
  char *TimestampResponse;
  int SuppressDefault;
  int reserved;
} MessageTimestamperTimestampRequestEventParams;


Unicode (Windows)
virtual INT FireTimestampRequest(MessageTimestamperTimestampRequestEventParams *e);

typedef struct {
  LPCWSTR TSA;
  LPCWSTR TimestampRequest;
  LPWSTR TimestampResponse;
  BOOL SuppressDefault;
  INT reserved;
} MessageTimestamperTimestampRequestEventParams;

#define EID_MESSAGETIMESTAMPER_TIMESTAMPREQUEST 3

virtual INT SECUREBLACKBOX_CALL FireTimestampRequest(LPSTR &lpszTSA, LPSTR &lpszTimestampRequest, LPSTR &lpszTimestampResponse, BOOL &bSuppressDefault);

class MessageTimestamperTimestampRequestEventParams {
public:
  const QString &TSA();

  const QString &TimestampRequest();

  const QString &TimestampResponse();
  void SetTimestampResponse(const QString &qsTimestampResponse);

  bool SuppressDefault();
  void SetSuppressDefault(bool bSuppressDefault);

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

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

// Or, subclass MessageTimestamper and override this emitter function.
virtual int FireTimestampRequest(MessageTimestamperTimestampRequestEventParams *e) {...}

Remarks

Subscribe to this event to be intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.

The TSA parameter indicates the timestamping service being used. It matches the value passed to TimestampServer property. Set SuppressDefault parameter to false if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.

TLSCertNeeded Event (MessageTimestamper Class)

Fires when a remote TLS party requests a client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSCertNeeded(MessageTimestamperTLSCertNeededEventParams *e);

typedef struct {
  const char *Host;
  const char *CANames;
  int reserved;
} MessageTimestamperTLSCertNeededEventParams;


Unicode (Windows)
virtual INT FireTLSCertNeeded(MessageTimestamperTLSCertNeededEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR CANames;
  INT reserved;
} MessageTimestamperTLSCertNeededEventParams;

#define EID_MESSAGETIMESTAMPER_TLSCERTNEEDED 4

virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);

class MessageTimestamperTLSCertNeededEventParams {
public:
  const QString &Host();

  const QString &CANames();

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

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

// Or, subclass MessageTimestamper and override this emitter function.
virtual int FireTLSCertNeeded(MessageTimestamperTLSCertNeededEventParams *e) {...}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (MessageTimestamper Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSCertValidate(MessageTimestamperTLSCertValidateEventParams *e);

typedef struct {
  const char *ServerHost;
  const char *ServerIP;
  int Accept;
  int reserved;
} MessageTimestamperTLSCertValidateEventParams;


Unicode (Windows)
virtual INT FireTLSCertValidate(MessageTimestamperTLSCertValidateEventParams *e);

typedef struct {
  LPCWSTR ServerHost;
  LPCWSTR ServerIP;
  BOOL Accept;
  INT reserved;
} MessageTimestamperTLSCertValidateEventParams;

#define EID_MESSAGETIMESTAMPER_TLSCERTVALIDATE 5

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);

class MessageTimestamperTLSCertValidateEventParams {
public:
  const QString &ServerHost();

  const QString &ServerIP();

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

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

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

// Or, subclass MessageTimestamper and override this emitter function.
virtual int FireTLSCertValidate(MessageTimestamperTLSCertValidateEventParams *e) {...}

Remarks

This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.

TLSEstablished Event (MessageTimestamper Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSEstablished(MessageTimestamperTLSEstablishedEventParams *e);

typedef struct {
  const char *Host;
  const char *Version;
  const char *Ciphersuite;
  const char *ConnectionId;
  int lenConnectionId;
  int Abort;
  int reserved;
} MessageTimestamperTLSEstablishedEventParams;


Unicode (Windows)
virtual INT FireTLSEstablished(MessageTimestamperTLSEstablishedEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR Version;
  LPCWSTR Ciphersuite;
  LPCSTR ConnectionId;
  INT lenConnectionId;
  BOOL Abort;
  INT reserved;
} MessageTimestamperTLSEstablishedEventParams;

#define EID_MESSAGETIMESTAMPER_TLSESTABLISHED 6

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);

class MessageTimestamperTLSEstablishedEventParams {
public:
  const QString &Host();

  const QString &Version();

  const QString &Ciphersuite();

  const QByteArray &ConnectionId();

  bool Abort();
  void SetAbort(bool bAbort);

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

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

// Or, subclass MessageTimestamper and override this emitter function.
virtual int FireTLSEstablished(MessageTimestamperTLSEstablishedEventParams *e) {...}

Remarks

The class uses this event to notify the application about successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (MessageTimestamper Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSHandshake(MessageTimestamperTLSHandshakeEventParams *e);

typedef struct {
  const char *Host;
  int Abort;
  int reserved;
} MessageTimestamperTLSHandshakeEventParams;


Unicode (Windows)
virtual INT FireTLSHandshake(MessageTimestamperTLSHandshakeEventParams *e);

typedef struct {
  LPCWSTR Host;
  BOOL Abort;
  INT reserved;
} MessageTimestamperTLSHandshakeEventParams;

#define EID_MESSAGETIMESTAMPER_TLSHANDSHAKE 7

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);

class MessageTimestamperTLSHandshakeEventParams {
public:
  const QString &Host();

  bool Abort();
  void SetAbort(bool bAbort);

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

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

// Or, subclass MessageTimestamper and override this emitter function.
virtual int FireTLSHandshake(MessageTimestamperTLSHandshakeEventParams *e) {...}

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.

TLSShutdown Event (MessageTimestamper Class)

Reports the graceful closure of a TLS connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTLSShutdown(MessageTimestamperTLSShutdownEventParams *e);

typedef struct {
  const char *Host;
  int reserved;
} MessageTimestamperTLSShutdownEventParams;


Unicode (Windows)
virtual INT FireTLSShutdown(MessageTimestamperTLSShutdownEventParams *e);

typedef struct {
  LPCWSTR Host;
  INT reserved;
} MessageTimestamperTLSShutdownEventParams;

#define EID_MESSAGETIMESTAMPER_TLSSHUTDOWN 8

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);

class MessageTimestamperTLSShutdownEventParams {
public:
  const QString &Host();

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

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

// Or, subclass MessageTimestamper and override this emitter function.
virtual int FireTLSShutdown(MessageTimestamperTLSShutdownEventParams *e) {...}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config Settings (MessageTimestamper Class)

MessageTimestamper Config Settings

Base Config Settings

Trappable Errors (MessageTimestamper Class)

Error Handling (C++)

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

MessageTimestamper Errors