MessageSigner Class

Properties   Methods   Events   Config Settings   Errors  

The MessageSigner class digitally signs data and stores it in the PKCS#7 format.

Class Name

SecureBlackbox_MessageSigner

Procedural Interface

 secureblackbox_messagesigner_open();
 secureblackbox_messagesigner_close($res);
 secureblackbox_messagesigner_register_callback($res, $id, $function);
 secureblackbox_messagesigner_get_last_error($res);
 secureblackbox_messagesigner_get_last_error_code($res);
 secureblackbox_messagesigner_set($res, $id, $index, $value);
 secureblackbox_messagesigner_get($res, $id, $index);
 secureblackbox_messagesigner_do_config($res, $configurationstring);
 secureblackbox_messagesigner_do_countersign($res);
 secureblackbox_messagesigner_do_doaction($res, $actionid, $actionparams);
 secureblackbox_messagesigner_do_extractasyncdata($res, $asyncreply);
 secureblackbox_messagesigner_do_sign($res);
 secureblackbox_messagesigner_do_signasyncbegin($res);
 secureblackbox_messagesigner_do_signasyncend($res, $asyncreply);
 secureblackbox_messagesigner_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.

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.

ClaimedSigningTime Property (SecureBlackbox_MessageSigner Class)

The signing time from the signer's computer.

Object Oriented Interface

public function getClaimedSigningTime();


public function setClaimedSigningTime($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 1 );


secureblackbox_messagesigner_set($res, 1, $value );

Default Value

''

Remarks

Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.

Data Type

String

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 2 );


secureblackbox_messagesigner_set($res, 2, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 3 );


secureblackbox_messagesigner_set($res, 3, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getExternalCryptoData();


public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 4 );


secureblackbox_messagesigner_set($res, 4, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();


public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 5 );


secureblackbox_messagesigner_set($res, 5, $value );

Default Value

false

Remarks

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

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

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_MessageSigner Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 6 );


secureblackbox_messagesigner_set($res, 6, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getExternalCryptoKeyID();


public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 7 );


secureblackbox_messagesigner_set($res, 7, $value );

Default Value

''

Remarks

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

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

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

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

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SecureBlackbox_MessageSigner Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 8 );


secureblackbox_messagesigner_set($res, 8, $value );

Default Value

''

Remarks

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

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SecureBlackbox_MessageSigner Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 9 );


secureblackbox_messagesigner_set($res, 9, $value );

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_MessageSigner Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 10 );


secureblackbox_messagesigner_set($res, 10, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 11 );


secureblackbox_messagesigner_set($res, 11, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_MessageSigner Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 12 );


secureblackbox_messagesigner_set($res, 12, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (SecureBlackbox_MessageSigner Class)

Specifies the hash algorithm to be used.

Object Oriented Interface

public function getHashAlgorithm();


public function setHashAlgorithm($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 13 );


secureblackbox_messagesigner_set($res, 13, $value );

Default Value

'SHA256'

Remarks

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

Data Type

String

InputBytes Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 14 );


secureblackbox_messagesigner_set($res, 14, $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_MessageSigner Class)

A path to the source file.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 15 );


secureblackbox_messagesigner_set($res, 15, $value );

Default Value

''

Remarks

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

Data Type

String

InputIsHash Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 16 );


secureblackbox_messagesigner_set($res, 16, $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

MACAlgorithm Property (SecureBlackbox_MessageSigner Class)

Specifies the keyed MAC algorithm to use.

Object Oriented Interface

public function getMACAlgorithm();


public function setMACAlgorithm($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 17 );


secureblackbox_messagesigner_set($res, 17, $value );

Default Value

'SHA256'

Remarks

This property specifies the MAC algorithm to use for calculating the MAC signature.

Data Type

String

OutputBytes Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_messagesigner_get($res, 18 );

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_MessageSigner Class)

A path to the output file.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 19 );


secureblackbox_messagesigner_set($res, 19, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyAddress Property (SecureBlackbox_MessageSigner Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 20 );


secureblackbox_messagesigner_set($res, 20, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_MessageSigner Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 21 );


secureblackbox_messagesigner_set($res, 21, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_MessageSigner Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 22 );


secureblackbox_messagesigner_set($res, 22, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_MessageSigner Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 23 );


secureblackbox_messagesigner_set($res, 23, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_MessageSigner Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 24 );


secureblackbox_messagesigner_set($res, 24, $value );

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

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 25 );


secureblackbox_messagesigner_set($res, 25, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 26 );


secureblackbox_messagesigner_set($res, 26, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 27 );


secureblackbox_messagesigner_set($res, 27, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 28 );


secureblackbox_messagesigner_set($res, 28, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (SecureBlackbox_MessageSigner Class)

Enables or disables proxy-driven connection.

Object Oriented Interface

public function getProxyUseProxy();


public function setProxyUseProxy($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 29 );


secureblackbox_messagesigner_set($res, 29, $value );

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_MessageSigner Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 30 );


secureblackbox_messagesigner_set($res, 30, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

RecipientCertBytes Property (SecureBlackbox_MessageSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getRecipientCertBytes();

Procedural Interface

secureblackbox_messagesigner_get($res, 31 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

RecipientCertHandle Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getRecipientCertHandle();


public function setRecipientCertHandle($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 38 );


secureblackbox_messagesigner_set($res, 38, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

SignatureType Property (SecureBlackbox_MessageSigner Class)

Specifies the kind of signature to create.

Object Oriented Interface

public function getSignatureType();


public function setSignatureType($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 65 );


secureblackbox_messagesigner_set($res, 65, $value );

Default Value

2

Remarks

Possible values:

Data Type

Integer

SignedAttributeCount Property (SecureBlackbox_MessageSigner Class)

The number of records in the SignedAttribute arrays.

Object Oriented Interface

public function getSignedAttributeCount();


public function setSignedAttributeCount($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 66 );


secureblackbox_messagesigner_set($res, 66, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignedAttributeOID
• SignedAttributeValue

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

This property is not available at design time.

Data Type

Integer

SignedAttributeOID Property (SecureBlackbox_MessageSigner Class)

The object identifier of the attribute.

Object Oriented Interface

public function getSignedAttributeOID($signedattributeindex);


public function setSignedAttributeOID($signedattributeindex, $value);

Procedural Interface

secureblackbox_messagesigner_get($res, 67 , $signedattributeindex);


secureblackbox_messagesigner_set($res, 67, $value , $signedattributeindex);

Default Value

''

Remarks

The object identifier of the attribute.

The $signedattributeindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignedAttributeCount property.

This property is not available at design time.

Data Type

String

SignedAttributeValue Property (SecureBlackbox_MessageSigner Class)

The value of the attribute.

Object Oriented Interface

public function getSignedAttributeValue($signedattributeindex);


public function setSignedAttributeValue($signedattributeindex, $value);

Procedural Interface

secureblackbox_messagesigner_get($res, 68 , $signedattributeindex);


secureblackbox_messagesigner_set($res, 68, $value , $signedattributeindex);

Remarks

The value of the attribute.

The $signedattributeindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignedAttributeCount property.

This property is not available at design time.

Data Type

Byte Array

SigningCertBytes Property (SecureBlackbox_MessageSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_messagesigner_get($res, 69 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getSigningCertHandle();


public function setSigningCertHandle($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 76 );


secureblackbox_messagesigner_set($res, 76, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SecureBlackbox_MessageSigner Class)

The number of records in the SigningChain arrays.

Object Oriented Interface

public function getSigningChainCount();


public function setSigningChainCount($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 103 );


secureblackbox_messagesigner_set($res, 103, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SecureBlackbox_MessageSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningChainBytes($signingchainindex);

Procedural Interface

secureblackbox_messagesigner_get($res, 104 , $signingchainindex);

Remarks

Returns the raw certificate data in DER format.

The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

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

Data Type

Byte Array

SigningChainHandle Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getSigningChainHandle($signingchainindex);


public function setSigningChainHandle($signingchainindex, $value);

Procedural Interface

secureblackbox_messagesigner_get($res, 111 , $signingchainindex);


secureblackbox_messagesigner_set($res, 111, $value , $signingchainindex);

Default Value

0

Remarks

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

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

The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

SocketDNSMode Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 138 );


secureblackbox_messagesigner_set($res, 138, $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_MessageSigner 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_messagesigner_get($res, 139 );


secureblackbox_messagesigner_set($res, 139, $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_MessageSigner Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 140 );


secureblackbox_messagesigner_set($res, 140, $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_MessageSigner 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_messagesigner_get($res, 141 );


secureblackbox_messagesigner_set($res, 141, $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_MessageSigner Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 142 );


secureblackbox_messagesigner_set($res, 142, $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_MessageSigner 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_messagesigner_get($res, 143 );


secureblackbox_messagesigner_set($res, 143, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_MessageSigner Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 144 );


secureblackbox_messagesigner_set($res, 144, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_MessageSigner Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 145 );


secureblackbox_messagesigner_set($res, 145, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 146 );


secureblackbox_messagesigner_set($res, 146, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 147 );


secureblackbox_messagesigner_set($res, 147, $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_MessageSigner Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 148 );


secureblackbox_messagesigner_set($res, 148, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TimestampServer Property (SecureBlackbox_MessageSigner Class)

The address of the timestamping server.

Object Oriented Interface

public function getTimestampServer();


public function setTimestampServer($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 149 );


secureblackbox_messagesigner_set($res, 149, $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

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

The number of records in the TLSClientCert arrays.

Object Oriented Interface

public function getTLSClientCertCount();


public function setTLSClientCertCount($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 150 );


secureblackbox_messagesigner_set($res, 150, $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_MessageSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSClientCertBytes($tlsclientcertindex);

Procedural Interface

secureblackbox_messagesigner_get($res, 151 , $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_MessageSigner 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_messagesigner_get($res, 158 , $tlsclientcertindex);


secureblackbox_messagesigner_set($res, 158, $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_MessageSigner Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();

Procedural Interface

secureblackbox_messagesigner_get($res, 185 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_messagesigner_get($res, 186 , $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

TLSServerCertHandle Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 193 , $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

TLSAutoValidateCertificates Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 220 );


secureblackbox_messagesigner_set($res, 220, $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_MessageSigner Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 221 );


secureblackbox_messagesigner_set($res, 221, $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_MessageSigner Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 222 );


secureblackbox_messagesigner_set($res, 222, $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

TLSECCurves Property (SecureBlackbox_MessageSigner Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 223 );


secureblackbox_messagesigner_set($res, 223, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_MessageSigner Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 224 );


secureblackbox_messagesigner_set($res, 224, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 225 );


secureblackbox_messagesigner_set($res, 225, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 226 );


secureblackbox_messagesigner_set($res, 226, $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_MessageSigner 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_messagesigner_get($res, 227 );


secureblackbox_messagesigner_set($res, 227, $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_MessageSigner Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 228 );


secureblackbox_messagesigner_set($res, 228, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_MessageSigner Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 229 );


secureblackbox_messagesigner_set($res, 229, $value );

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 230 );


secureblackbox_messagesigner_set($res, 230, $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_MessageSigner 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_messagesigner_get($res, 231 );


secureblackbox_messagesigner_set($res, 231, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_MessageSigner Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 232 );


secureblackbox_messagesigner_set($res, 232, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_MessageSigner 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_messagesigner_get($res, 233 );


secureblackbox_messagesigner_set($res, 233, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_MessageSigner Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 234 );


secureblackbox_messagesigner_set($res, 234, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_MessageSigner Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 235 );


secureblackbox_messagesigner_set($res, 235, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UnsignedAttributeCount Property (SecureBlackbox_MessageSigner Class)

The number of records in the UnsignedAttribute arrays.

Object Oriented Interface

public function getUnsignedAttributeCount();


public function setUnsignedAttributeCount($value);

Procedural Interface

secureblackbox_messagesigner_get($res, 236 );


secureblackbox_messagesigner_set($res, 236, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UnsignedAttributeOID
• UnsignedAttributeValue

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

This property is not available at design time.

Data Type

Integer

UnsignedAttributeOID Property (SecureBlackbox_MessageSigner Class)

The object identifier of the attribute.

Object Oriented Interface

public function getUnsignedAttributeOID($unsignedattributeindex);


public function setUnsignedAttributeOID($unsignedattributeindex, $value);

Procedural Interface

secureblackbox_messagesigner_get($res, 237 , $unsignedattributeindex);


secureblackbox_messagesigner_set($res, 237, $value , $unsignedattributeindex);

Default Value

''

Remarks

The object identifier of the attribute.

The $unsignedattributeindex parameter specifies the index of the item in the array. The size of the array is controlled by the UnsignedAttributeCount property.

This property is not available at design time.

Data Type

String

UnsignedAttributeValue Property (SecureBlackbox_MessageSigner Class)

The value of the attribute.

Object Oriented Interface

public function getUnsignedAttributeValue($unsignedattributeindex);


public function setUnsignedAttributeValue($unsignedattributeindex, $value);

Procedural Interface

secureblackbox_messagesigner_get($res, 238 , $unsignedattributeindex);


secureblackbox_messagesigner_set($res, 238, $value , $unsignedattributeindex);

Remarks

The value of the attribute.

The $unsignedattributeindex parameter specifies the index of the item in the array. The size of the array is controlled by the UnsignedAttributeCount property.

This property is not available at design time.

Data Type

Byte Array

Config Method (SecureBlackbox_MessageSigner Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_messagesigner_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.

Countersign Method (SecureBlackbox_MessageSigner Class)

Countersigns an existing signature.

Object Oriented Interface

public function doCountersign();

Procedural Interface

secureblackbox_messagesigner_do_countersign($res);

Remarks

Use this method to certify an existing document signature. Countersigning doesn't alter the existing signatures or the signed document itself.

DoAction Method (SecureBlackbox_MessageSigner Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_messagesigner_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;....

ExtractAsyncData Method (SecureBlackbox_MessageSigner Class)

Extracts user data from the DC signing service response.

Object Oriented Interface

public function doExtractAsyncData($asyncreply);

Procedural Interface

secureblackbox_messagesigner_do_extractasyncdata($res, $asyncreply);

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

Sign Method (SecureBlackbox_MessageSigner Class)

Signs the data.

Object Oriented Interface

public function doSign();

Procedural Interface

secureblackbox_messagesigner_do_sign($res);

Remarks

This method signs the data provided via InputFile (or InputStream) with SigningCertificate, and saves the signature in OutputFile (OutputStream). Set the desired signature variant via SignatureType property.

The class automatically timestamps the created signature if a TimestampServer is provided.

SignAsyncBegin Method (SecureBlackbox_MessageSigner Class)

Initiates the asynchronous signing operation.

Object Oriented Interface

public function doSignAsyncBegin();

Procedural Interface

secureblackbox_messagesigner_do_signasyncbegin($res);

Remarks

When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in OutputFile (or OutputStream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.

Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to InputFile (or InputStream), and call SignAsyncEnd to finalize the signing.

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to SignAsyncEnd and expect it to recover the correct response from the batch automatically.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

SignAsyncEnd Method (SecureBlackbox_MessageSigner Class)

Completes the asynchronous signing operation.

Object Oriented Interface

public function doSignAsyncEnd($asyncreply);

Procedural Interface

secureblackbox_messagesigner_do_signasyncend($res, $asyncreply);

Remarks

When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.

Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior SignAsyncBegin call to InputFile (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to OutputFile (or OutputStream).

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (SignAsyncBegin) stage.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

Timestamp Method (SecureBlackbox_MessageSigner Class)

Timestamps a signature.

Object Oriented Interface

public function doTimestamp();

Procedural Interface

secureblackbox_messagesigner_do_timestamp($res);

Remarks

This method timestamps an existing PKCS#7 signature with TimestampServer. Pass your existing signature via InputFile (or InputStream), and collect the timestamped variant from OutputFile (OutputStream).

Error Event (SecureBlackbox_MessageSigner Class)

Information about errors during PKCS#7 message signing.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_messagesigner_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.

ExternalSign Event (SecureBlackbox_MessageSigner Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_messagesigner_register_callback($res, 2, array($this, 'fireExternalSign'));

Parameter List

 'operationid'
 'hashalgorithm'
 'pars'
 'data'
 'signeddata'

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

Notification Event (SecureBlackbox_MessageSigner Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_messagesigner_register_callback($res, 3, 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_MessageSigner 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_messagesigner_register_callback($res, 4, 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_MessageSigner Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_messagesigner_register_callback($res, 5, 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_MessageSigner 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_messagesigner_register_callback($res, 6, 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_MessageSigner Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_messagesigner_register_callback($res, 7, 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_MessageSigner Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_messagesigner_register_callback($res, 8, 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_MessageSigner Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_messagesigner_register_callback($res, 9, 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 (MessageSigner 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.

MessageSigner Config Settings

Base Config Settings

Trappable Errors (MessageSigner Class)

MessageSigner Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)