MessageTimestamper Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_MessageTimestamper

Procedural Interface

 secureblackbox_messagetimestamper_open();
 secureblackbox_messagetimestamper_close($res);
 secureblackbox_messagetimestamper_register_callback($res, $id, $function);
 secureblackbox_messagetimestamper_get_last_error($res);
 secureblackbox_messagetimestamper_get_last_error_code($res);
 secureblackbox_messagetimestamper_set($res, $id, $index, $value);
 secureblackbox_messagetimestamper_get($res, $id, $index);
 secureblackbox_messagetimestamper_do_config($res, $configurationstring);
 secureblackbox_messagetimestamper_do_doaction($res, $actionid, $actionparams);
 secureblackbox_messagetimestamper_do_reset($res);
 secureblackbox_messagetimestamper_do_timestamp($res);

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.

MessageTimestamper can timestamp binary data. The following output formats are supported: PKCS#7 TimestampedData, PKCS#7 TimestampToken (CMS), and PKCS#7 TSPReply (RFC3161).

The two principal properties that you need to set up are the TimestampServer, which should contain the address of the RFC3161-compliant TSA service, and the TimestampFormat, which should be set to the desired timestamp format.

Provide the input and output destinations via the InputFile and OutputFile properties. Depending on the TSA setup, you may also need to adjust the TLS properties (for example, provide a client certificate via the TLSClientChain collection).

Having set up the component, call the Timestamp method. MessageTimestamper will prepare the timestamp message and request the TSA service to timestamp it.

Note that MessageTimestamper creates standalone timestamps over binary messages. If you would rather timestamp an existing CMS signature, see MessageSigner or CAdESSigner components instead. MessageTimestamper timestamper = new MessageTimestamper(); timestamper.setTimestampFormat(Messagetimestamper.mtfRFC5544); //Configures the desired timestamp format. // Select the file which contains the message that will be timestamped timestamper.setInputFile("message.txt"); // Select the file where the timestamped message will be written timestamper.setOutputFile("timestampedMessage.bin"); // Specify the timestamping server timestamper.setTimestampServer("http://..."); timestamper.timestamp(); // Timestamp

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 (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getDataFileName();
public function setDataFileName($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 1 );
secureblackbox_messagetimestamper_set($res, 1, $value );

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 (SecureBlackbox_MessageTimestamper Class)

The URI to be included with the timestamped data.

Object Oriented Interface

public function getDataURI();
public function setDataURI($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 2 );
secureblackbox_messagetimestamper_set($res, 2, $value );

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 (SecureBlackbox_MessageTimestamper Class)

Specifies whether a detached timestamp should be produced.

Object Oriented Interface

public function getDetached();
public function setDetached($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 3 );
secureblackbox_messagetimestamper_set($res, 3, $value );

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 (SecureBlackbox_MessageTimestamper Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 4 );
secureblackbox_messagetimestamper_set($res, 4, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (SecureBlackbox_MessageTimestamper Class)

Specifies the hash algorithm to be used.

Object Oriented Interface

public function getHashAlgorithm();
public function setHashAlgorithm($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 5 );
secureblackbox_messagetimestamper_set($res, 5, $value );

Default Value

'SHA256'

Remarks

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

Data Type

String

InputBytes Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getInputBytes();
public function setInputBytes($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 6 );
secureblackbox_messagetimestamper_set($res, 6, $value );

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 (SecureBlackbox_MessageTimestamper Class)

A path to the source file.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 7 );
secureblackbox_messagetimestamper_set($res, 7, $value );

Default Value

''

Remarks

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

Data Type

String

InputIsHash Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getInputIsHash();
public function setInputIsHash($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 8 );
secureblackbox_messagetimestamper_set($res, 8, $value );

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 (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_messagetimestamper_get($res, 9 );

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the 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 (SecureBlackbox_MessageTimestamper Class)

A path to the output file.

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 10 );
secureblackbox_messagetimestamper_set($res, 10, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyAddress Property (SecureBlackbox_MessageTimestamper Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();
public function setProxyAddress($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 11 );
secureblackbox_messagetimestamper_set($res, 11, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_MessageTimestamper Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();
public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 12 );
secureblackbox_messagetimestamper_set($res, 12, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_MessageTimestamper Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 13 );
secureblackbox_messagetimestamper_set($res, 13, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_MessageTimestamper Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 14 );
secureblackbox_messagetimestamper_set($res, 14, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_MessageTimestamper Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();
public function setProxyProxyType($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 15 );
secureblackbox_messagetimestamper_set($res, 15, $value );

Default Value

0

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_MessageTimestamper Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();
public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 16 );
secureblackbox_messagetimestamper_set($res, 16, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getProxyResponseBody();
public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 17 );
secureblackbox_messagetimestamper_set($res, 17, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getProxyResponseHeaders();
public function setProxyResponseHeaders($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 18 );
secureblackbox_messagetimestamper_set($res, 18, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getProxyUseIPv6();
public function setProxyUseIPv6($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 19 );
secureblackbox_messagetimestamper_set($res, 19, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_MessageTimestamper Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();
public function setProxyUsername($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 20 );
secureblackbox_messagetimestamper_set($res, 20, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

SocketDNSMode Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getSocketDNSMode();
public function setSocketDNSMode($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 21 );
secureblackbox_messagetimestamper_set($res, 21, $value );

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 (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getSocketDNSPort();
public function setSocketDNSPort($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 22 );
secureblackbox_messagetimestamper_set($res, 22, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (SecureBlackbox_MessageTimestamper Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();
public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 23 );
secureblackbox_messagetimestamper_set($res, 23, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getSocketDNSServers();
public function setSocketDNSServers($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 24 );
secureblackbox_messagetimestamper_set($res, 24, $value );

Default Value

''

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();
public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 25 );
secureblackbox_messagetimestamper_set($res, 25, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getSocketIncomingSpeedLimit();
public function setSocketIncomingSpeedLimit($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 26 );
secureblackbox_messagetimestamper_set($res, 26, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_MessageTimestamper Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();
public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 27 );
secureblackbox_messagetimestamper_set($res, 27, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_MessageTimestamper Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();
public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 28 );
secureblackbox_messagetimestamper_set($res, 28, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getSocketOutgoingSpeedLimit();
public function setSocketOutgoingSpeedLimit($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 29 );
secureblackbox_messagetimestamper_set($res, 29, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getSocketTimeout();
public function setSocketTimeout($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 30 );
secureblackbox_messagetimestamper_set($res, 30, $value );

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 (SecureBlackbox_MessageTimestamper Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();
public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 31 );
secureblackbox_messagetimestamper_set($res, 31, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TimestampFormat Property (SecureBlackbox_MessageTimestamper Class)

Configures the desired timestamp format.

Object Oriented Interface

public function getTimestampFormat();
public function setTimestampFormat($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 32 );
secureblackbox_messagetimestamper_set($res, 32, $value );

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 (SecureBlackbox_MessageTimestamper Class)

The address of the timestamping server.

Object Oriented Interface

public function getTimestampServer();
public function setTimestampServer($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 33 );
secureblackbox_messagetimestamper_set($res, 33, $value );

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&ignorenonce=true

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.

The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.

All the parameters are optional.

Data Type

String

TLSClientCertCount Property (SecureBlackbox_MessageTimestamper Class)

The number of records in the TLSClientCert arrays.

Object Oriented Interface

public function getTLSClientCertCount();
public function setTLSClientCertCount($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 34 );
secureblackbox_messagetimestamper_set($res, 34, $value );

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 (SecureBlackbox_MessageTimestamper Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSClientCertBytes($tlsclientcertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 35 , $tlsclientcertindex);

Remarks

Returns the 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 (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getTLSClientCertHandle($tlsclientcertindex);
public function setTLSClientCertHandle($tlsclientcertindex, $value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 43 , $tlsclientcertindex);
secureblackbox_messagetimestamper_set($res, 43, $value , $tlsclientcertindex);

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 (SecureBlackbox_MessageTimestamper Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();

Procedural Interface

secureblackbox_messagetimestamper_get($res, 74 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertFingerprint
• TLSServerCertHandle
• TLSServerCertIssuer
• TLSServerCertIssuerRDN
• TLSServerCertKeyAlgorithm
• TLSServerCertKeyBits
• TLSServerCertKeyUsage
• TLSServerCertSelfSigned
• TLSServerCertSerialNumber
• TLSServerCertSigAlgorithm
• TLSServerCertSubject
• TLSServerCertSubjectRDN
• TLSServerCertValidFrom
• TLSServerCertValidTo

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 (SecureBlackbox_MessageTimestamper Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 75 , $tlsservercertindex);

Remarks

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

TLSServerCertFingerprint Property (SecureBlackbox_MessageTimestamper Class)

Contains the fingerprint (a hash imprint) of this certificate.

Object Oriented Interface

public function getTLSServerCertFingerprint($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 81 , $tlsservercertindex);

Default Value

''

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

String

TLSServerCertHandle Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getTLSServerCertHandle($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 83 , $tlsservercertindex);

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

TLSServerCertIssuer Property (SecureBlackbox_MessageTimestamper Class)

The common name of the certificate issuer (CA), typically a company name.

Object Oriented Interface

public function getTLSServerCertIssuer($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 85 , $tlsservercertindex);

Default Value

''

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via TLSIssuerRDN.

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

String

TLSServerCertIssuerRDN Property (SecureBlackbox_MessageTimestamper Class)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Object Oriented Interface

public function getTLSServerCertIssuerRDN($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 86 , $tlsservercertindex);

Default Value

''

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

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

String

TLSServerCertKeyAlgorithm Property (SecureBlackbox_MessageTimestamper Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getTLSServerCertKeyAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 87 , $tlsservercertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the TLSKeyBits, TLSCurve, and TLSPublicKeyBytes properties to get more details about the key the certificate contains.

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

String

TLSServerCertKeyBits Property (SecureBlackbox_MessageTimestamper Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getTLSServerCertKeyBits($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 88 , $tlsservercertindex);

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the TLSPublicKeyBytes or TLSPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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

Integer

TLSServerCertKeyUsage Property (SecureBlackbox_MessageTimestamper Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Object Oriented Interface

public function getTLSServerCertKeyUsage($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 90 , $tlsservercertindex);

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:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

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

Integer

TLSServerCertSelfSigned Property (SecureBlackbox_MessageTimestamper Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Object Oriented Interface

public function getTLSServerCertSelfSigned($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 103 , $tlsservercertindex);

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

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

Boolean

TLSServerCertSerialNumber Property (SecureBlackbox_MessageTimestamper Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getTLSServerCertSerialNumber($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 104 , $tlsservercertindex);

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

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

TLSServerCertSigAlgorithm Property (SecureBlackbox_MessageTimestamper Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Object Oriented Interface

public function getTLSServerCertSigAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 105 , $tlsservercertindex);

Default Value

''

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

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

String

TLSServerCertSubject Property (SecureBlackbox_MessageTimestamper Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Object Oriented Interface

public function getTLSServerCertSubject($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 107 , $tlsservercertindex);

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. This is part of a larger set of credentials available via TLSSubjectRDN.

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

String

TLSServerCertSubjectRDN Property (SecureBlackbox_MessageTimestamper Class)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Object Oriented Interface

public function getTLSServerCertSubjectRDN($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 110 , $tlsservercertindex);

Default Value

''

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

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

String

TLSServerCertValidFrom Property (SecureBlackbox_MessageTimestamper Class)

The time point at which the certificate becomes valid, in UTC.

Object Oriented Interface

public function getTLSServerCertValidFrom($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 112 , $tlsservercertindex);

Default Value

''

Remarks

The time point at which the certificate becomes valid, in UTC.

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

String

TLSServerCertValidTo Property (SecureBlackbox_MessageTimestamper Class)

The time point at which the certificate expires, in UTC.

Object Oriented Interface

public function getTLSServerCertValidTo($tlsservercertindex);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 113 , $tlsservercertindex);

Default Value

''

Remarks

The time point at which the certificate expires, in UTC.

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

String

TLSAutoValidateCertificates Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getTLSAutoValidateCertificates();
public function setTLSAutoValidateCertificates($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 114 );
secureblackbox_messagetimestamper_set($res, 114, $value );

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (SecureBlackbox_MessageTimestamper Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();
public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 115 );
secureblackbox_messagetimestamper_set($res, 115, $value );

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 (SecureBlackbox_MessageTimestamper Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();
public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 116 );
secureblackbox_messagetimestamper_set($res, 116, $value );

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

TLSClientAuth Property (SecureBlackbox_MessageTimestamper Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();
public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 117 );
secureblackbox_messagetimestamper_set($res, 117, $value );

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

Integer

TLSECCurves Property (SecureBlackbox_MessageTimestamper Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();
public function setTLSECCurves($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 118 );
secureblackbox_messagetimestamper_set($res, 118, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_MessageTimestamper Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();
public function setTLSExtensions($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 119 );
secureblackbox_messagetimestamper_set($res, 119, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getTLSForceResumeIfDestinationChanges();
public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 120 );
secureblackbox_messagetimestamper_set($res, 120, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getTLSPreSharedIdentity();
public function setTLSPreSharedIdentity($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 121 );
secureblackbox_messagetimestamper_set($res, 121, $value );

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 (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getTLSPreSharedKey();
public function setTLSPreSharedKey($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 122 );
secureblackbox_messagetimestamper_set($res, 122, $value );

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 (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();
public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 123 );
secureblackbox_messagetimestamper_set($res, 123, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_MessageTimestamper Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();
public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 124 );
secureblackbox_messagetimestamper_set($res, 124, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();
public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 125 );
secureblackbox_messagetimestamper_set($res, 125, $value );

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

Integer

TLSSSLOptions Property (SecureBlackbox_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.

Object Oriented Interface

public function getTLSSSLOptions();
public function setTLSSSLOptions($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 126 );
secureblackbox_messagetimestamper_set($res, 126, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_MessageTimestamper Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();
public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 127 );
secureblackbox_messagetimestamper_set($res, 127, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();
public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 128 );
secureblackbox_messagetimestamper_set($res, 128, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_MessageTimestamper Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();
public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 129 );
secureblackbox_messagetimestamper_set($res, 129, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_MessageTimestamper Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();
public function setTLSVersions($value);

Procedural Interface

secureblackbox_messagetimestamper_get($res, 130 );
secureblackbox_messagetimestamper_set($res, 130, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

Config Method (SecureBlackbox_MessageTimestamper Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_messagetimestamper_do_config($res, $configurationstring);

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.

DoAction Method (SecureBlackbox_MessageTimestamper Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_messagetimestamper_do_doaction($res, $actionid, $actionparams);

Remarks

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

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

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

Common ActionIDs:

Reset Method (SecureBlackbox_MessageTimestamper Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_messagetimestamper_do_reset($res);

Remarks

Reset is a generic method available in every class.

Timestamp Method (SecureBlackbox_MessageTimestamper Class)

Timestamps the data.

Object Oriented Interface

public function doTimestamp();

Procedural Interface

secureblackbox_messagetimestamper_do_timestamp($res);

Remarks

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

Error Event (SecureBlackbox_MessageTimestamper Class)

Information about errors during PKCS#7 message encryption.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_messagetimestamper_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_messagetimestamper_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

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

TimestampRequest Event (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function fireTimestampRequest($param);

Procedural Interface

secureblackbox_messagetimestamper_register_callback($res, 3, array($this, 'fireTimestampRequest'));

Parameter List

 'tsa'
 'timestamprequest'
 'timestampresponse'
 'suppressdefault'

Remarks

Subscribe to this event to 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 the TimestampServer property. Set the 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 (SecureBlackbox_MessageTimestamper Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_messagetimestamper_register_callback($res, 4, array($this, 'fireTLSCertNeeded'));

Parameter List

 'host'
 'canames'

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 parameter (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 (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_messagetimestamper_register_callback($res, 5, array($this, 'fireTLSCertValidate'));

Parameter List

 'serverhost'
 'serverip'
 'accept'

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes 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 class, and can be adjusted if needed.

TLSEstablished Event (SecureBlackbox_MessageTimestamper Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_messagetimestamper_register_callback($res, 6, array($this, 'fireTLSEstablished'));

Parameter List

 'host'
 'version'
 'ciphersuite'
 'connectionid'
 'abort'

Remarks

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

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

TLSHandshake Event (SecureBlackbox_MessageTimestamper Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_messagetimestamper_register_callback($res, 7, array($this, 'fireTLSHandshake'));

Parameter List

 'host'
 'abort'

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 by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSShutdown Event (SecureBlackbox_MessageTimestamper Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_messagetimestamper_register_callback($res, 8, array($this, 'fireTLSShutdown'));

Parameter List

 'host'

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)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

MessageTimestamper Config Settings

Base Config Settings

Trappable Errors (MessageTimestamper Class)

MessageTimestamper Errors