MessageTimestampVerifier Class

Properties   Methods   Events   Config Settings   Errors  

The MessageTimestampVerifier class verifies message timestamps.

Class Name

SecureBlackbox_MessageTimestampVerifier

Procedural Interface

 secureblackbox_messagetimestampverifier_open();
 secureblackbox_messagetimestampverifier_close($res);
 secureblackbox_messagetimestampverifier_register_callback($res, $id, $function);
 secureblackbox_messagetimestampverifier_get_last_error($res);
 secureblackbox_messagetimestampverifier_get_last_error_code($res);
 secureblackbox_messagetimestampverifier_set($res, $id, $index, $value);
 secureblackbox_messagetimestampverifier_get($res, $id, $index);
 secureblackbox_messagetimestampverifier_do_config($res, $configurationstring);
 secureblackbox_messagetimestampverifier_do_doaction($res, $actionid, $actionparams);
 secureblackbox_messagetimestampverifier_do_verify($res);
 secureblackbox_messagetimestampverifier_do_verifydetached($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.

CertCount Property (SecureBlackbox_MessageTimestampVerifier Class)

The number of records in the Cert arrays.

Object Oriented Interface

public function getCertCount();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 1 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertBytes
• CertCA
• CertCAKeyID
• CertCRLDistributionPoints
• CertCurve
• CertFingerprint
• CertFriendlyName
• CertHandle
• CertHashAlgorithm
• CertIssuer
• CertIssuerRDN
• CertKeyAlgorithm
• CertKeyBits
• CertKeyFingerprint
• CertKeyUsage
• CertKeyValid
• CertOCSPLocations
• CertPolicyIDs
• CertPublicKeyBytes
• CertSelfSigned
• CertSerialNumber
• CertSigAlgorithm
• CertSubject
• CertSubjectKeyID
• CertSubjectRDN
• CertValidFrom
• CertValidTo

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

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

Data Type

Integer

CertBytes Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 2 , $certindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

CertCA Property (SecureBlackbox_MessageTimestampVerifier Class)

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Object Oriented Interface

public function getCertCA($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 3 , $certindex);

Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

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

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

Data Type

Boolean

CertCAKeyID Property (SecureBlackbox_MessageTimestampVerifier Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Object Oriented Interface

public function getCertCAKeyID($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 4 , $certindex);

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

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

Data Type

Byte Array

CertCRLDistributionPoints Property (SecureBlackbox_MessageTimestampVerifier Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Object Oriented Interface

public function getCertCRLDistributionPoints($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 5 , $certindex);

Default Value

''

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

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

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

Data Type

String

CertCurve Property (SecureBlackbox_MessageTimestampVerifier Class)

Specifies the elliptic curve of the EC public key.

Object Oriented Interface

public function getCertCurve($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 6 , $certindex);

Default Value

''

Remarks

Specifies the elliptic curve of the EC public key.

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

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

Data Type

String

CertFingerprint Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getCertFingerprint($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 7 , $certindex);

Remarks

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

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

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

Data Type

Byte Array

CertFriendlyName Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains an associated alias (friendly name) of the certificate.

Object Oriented Interface

public function getCertFriendlyName($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 8 , $certindex);

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate.

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

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

Data Type

String

CertHandle Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getCertHandle($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 9 , $certindex);

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

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

Data Type

Long64

CertHashAlgorithm Property (SecureBlackbox_MessageTimestampVerifier Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Object Oriented Interface

public function getCertHashAlgorithm($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 10 , $certindex);

Default Value

''

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

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

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

Data Type

String

CertIssuer Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getCertIssuer($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 11 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CertIssuerRDN Property (SecureBlackbox_MessageTimestampVerifier Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Object Oriented Interface

public function getCertIssuerRDN($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 12 , $certindex);

Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

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

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

Data Type

String

CertKeyAlgorithm Property (SecureBlackbox_MessageTimestampVerifier Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCertKeyAlgorithm($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 13 , $certindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

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

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

Data Type

String

CertKeyBits Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the length of the public key.

Object Oriented Interface

public function getCertKeyBits($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 14 , $certindex);

Default Value

0

Remarks

Returns the length of the public key.

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

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

Data Type

Integer

CertKeyFingerprint Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns a fingerprint of the public key contained in the certificate.

Object Oriented Interface

public function getCertKeyFingerprint($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 15 , $certindex);

Remarks

Returns a fingerprint of the public key contained in the certificate.

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

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

Data Type

Byte Array

CertKeyUsage Property (SecureBlackbox_MessageTimestampVerifier 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 getCertKeyUsage($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 16 , $certindex);

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

Data Type

Integer

CertKeyValid Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Object Oriented Interface

public function getCertKeyValid($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 17 , $certindex);

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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

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

Data Type

Boolean

CertOCSPLocations Property (SecureBlackbox_MessageTimestampVerifier Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Object Oriented Interface

public function getCertOCSPLocations($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 18 , $certindex);

Default Value

''

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

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

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

Data Type

String

CertPolicyIDs Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCertPolicyIDs($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 21 , $certindex);

Default Value

''

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

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

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

Data Type

String

CertPublicKeyBytes Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCertPublicKeyBytes($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 25 , $certindex);

Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

CertSelfSigned Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getCertSelfSigned($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 27 , $certindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

CertSerialNumber Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCertSerialNumber($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 28 , $certindex);

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

CertSigAlgorithm Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getCertSigAlgorithm($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 29 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CertSubject Property (SecureBlackbox_MessageTimestampVerifier 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 getCertSubject($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 30 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CertSubjectKeyID Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Object Oriented Interface

public function getCertSubjectKeyID($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 32 , $certindex);

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

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

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

Data Type

Byte Array

CertSubjectRDN Property (SecureBlackbox_MessageTimestampVerifier Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Object Oriented Interface

public function getCertSubjectRDN($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 33 , $certindex);

Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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

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

Data Type

String

CertValidFrom Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getCertValidFrom($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 34 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CertValidTo Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getCertValidTo($certindex);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 35 , $certindex);

Default Value

''

Remarks

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

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

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

Data Type

String

DataBytes Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getDataBytes();


public function setDataBytes($value);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 36 );


secureblackbox_messagetimestampverifier_set($res, 36, $value );

Remarks

Assign a byte array containing the original timestamped data to this property.

This property is not available at design time.

Data Type

Byte Array

DataFile Property (SecureBlackbox_MessageTimestampVerifier Class)

The name of the file containing the originally timestamped data.

Object Oriented Interface

public function getDataFile();


public function setDataFile($value);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 37 );


secureblackbox_messagetimestampverifier_set($res, 37, $value );

Default Value

''

Remarks

Use this property to provide the original data when validating detached timestamps with VerifyDetached.

Data Type

String

DataFileName Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the data filename as recorded in the timestamp.

Object Oriented Interface

public function getDataFileName();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 38 );

Default Value

''

Remarks

This read-only property returns the file name of the timestamped data as recorded in the timestamp by its creator. It only carries an informational purpose.

This property is read-only.

Data Type

String

DataURI Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the data URI as recorded in the timestamp.

Object Oriented Interface

public function getDataURI();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 39 );

Default Value

''

Remarks

This read-only property returns the URI of the timestamped data as recorded in the timestamp by its creator. It only carries an informational purpose.

This property is read-only.

Data Type

String

FIPSMode Property (SecureBlackbox_MessageTimestampVerifier Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 40 );


secureblackbox_messagetimestampverifier_set($res, 40, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_MessageTimestampVerifier 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_messagetimestampverifier_get($res, 41 );


secureblackbox_messagetimestampverifier_set($res, 41, $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_MessageTimestampVerifier Class)

Path to the file containing the timestamped message.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 42 );


secureblackbox_messagetimestampverifier_set($res, 42, $value );

Default Value

''

Remarks

Use this property to provide a file containing the timestamped data, either enveloping or detached.

Data Type

String

OutputBytes Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 43 );

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

Path to the file to save the extracted data to.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 44 );


secureblackbox_messagetimestampverifier_set($res, 44, $value );

Default Value

''

Remarks

Use this property when validating enveloping timestamps to specify the output file where the extracted message should be saved.

Data Type

String

SignatureValidationResult Property (SecureBlackbox_MessageTimestampVerifier Class)

The signature validation result.

Object Oriented Interface

public function getSignatureValidationResult();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 45 );

Default Value

0

Remarks

Use this property to check the result of the most recent signature validation.

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

Data Type

Integer

SigningCertBytes Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 46 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertCA Property (SecureBlackbox_MessageTimestampVerifier Class)

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Object Oriented Interface

public function getSigningCertCA();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 47 );

Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

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

Data Type

Boolean

SigningCertCAKeyID Property (SecureBlackbox_MessageTimestampVerifier Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Object Oriented Interface

public function getSigningCertCAKeyID();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 48 );

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

Data Type

Byte Array

SigningCertCRLDistributionPoints Property (SecureBlackbox_MessageTimestampVerifier Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Object Oriented Interface

public function getSigningCertCRLDistributionPoints();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 49 );

Default Value

''

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

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

Data Type

String

SigningCertCurve Property (SecureBlackbox_MessageTimestampVerifier Class)

Specifies the elliptic curve of the EC public key.

Object Oriented Interface

public function getSigningCertCurve();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 50 );

Default Value

''

Remarks

Specifies the elliptic curve of the EC public key.

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

Data Type

String

SigningCertFingerprint Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getSigningCertFingerprint();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 51 );

Remarks

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

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

Data Type

Byte Array

SigningCertFriendlyName Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains an associated alias (friendly name) of the certificate.

Object Oriented Interface

public function getSigningCertFriendlyName();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 52 );

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate.

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

Data Type

String

SigningCertHandle Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getSigningCertHandle();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 53 );

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 read-only and not available at design time.

Data Type

Long64

SigningCertHashAlgorithm Property (SecureBlackbox_MessageTimestampVerifier Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Object Oriented Interface

public function getSigningCertHashAlgorithm();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 54 );

Default Value

''

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

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

Data Type

String

SigningCertIssuer Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getSigningCertIssuer();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 55 );

Default Value

''

Remarks

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

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

Data Type

String

SigningCertIssuerRDN Property (SecureBlackbox_MessageTimestampVerifier Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Object Oriented Interface

public function getSigningCertIssuerRDN();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 56 );

Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

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

Data Type

String

SigningCertKeyAlgorithm Property (SecureBlackbox_MessageTimestampVerifier Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getSigningCertKeyAlgorithm();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 57 );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

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

Data Type

String

SigningCertKeyBits Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the length of the public key.

Object Oriented Interface

public function getSigningCertKeyBits();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 58 );

Default Value

0

Remarks

Returns the length of the public key.

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

Data Type

Integer

SigningCertKeyFingerprint Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns a fingerprint of the public key contained in the certificate.

Object Oriented Interface

public function getSigningCertKeyFingerprint();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 59 );

Remarks

Returns a fingerprint of the public key contained in the certificate.

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

Data Type

Byte Array

SigningCertKeyUsage Property (SecureBlackbox_MessageTimestampVerifier 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 getSigningCertKeyUsage();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 60 );

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:

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

Data Type

Integer

SigningCertKeyValid Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Object Oriented Interface

public function getSigningCertKeyValid();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 61 );

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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

Data Type

Boolean

SigningCertOCSPLocations Property (SecureBlackbox_MessageTimestampVerifier Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Object Oriented Interface

public function getSigningCertOCSPLocations();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 62 );

Default Value

''

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

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

Data Type

String

SigningCertOCSPNoCheck Property (SecureBlackbox_MessageTimestampVerifier Class)

Accessor to the value of the certificate's ocsp-no-check extension.

Object Oriented Interface

public function getSigningCertOCSPNoCheck();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 63 );

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

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

Data Type

Boolean

SigningCertOrigin Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the origin of this certificate.

Object Oriented Interface

public function getSigningCertOrigin();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 64 );

Default Value

0

Remarks

Returns the origin of this certificate.

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

Data Type

Integer

SigningCertPolicyIDs Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getSigningCertPolicyIDs();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 65 );

Default Value

''

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

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

Data Type

String

SigningCertPrivateKeyBytes Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains the certificate's private key.

Object Oriented Interface

public function getSigningCertPrivateKeyBytes();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 66 );

Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

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

Data Type

Byte Array

SigningCertPrivateKeyExists Property (SecureBlackbox_MessageTimestampVerifier Class)

Indicates whether the certificate has an associated private key.

Object Oriented Interface

public function getSigningCertPrivateKeyExists();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 67 );

Default Value

false

Remarks

Indicates whether the certificate has an associated private key.

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

Data Type

Boolean

SigningCertPrivateKeyExtractable Property (SecureBlackbox_MessageTimestampVerifier Class)

Indicates whether the private key is extractable.

Object Oriented Interface

public function getSigningCertPrivateKeyExtractable();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 68 );

Default Value

false

Remarks

Indicates whether the private key is extractable.

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

Data Type

Boolean

SigningCertPublicKeyBytes Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getSigningCertPublicKeyBytes();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 69 );

Remarks

Contains the certificate's public key in DER format.

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

Data Type

Byte Array

SigningCertQualifiedStatements Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the qualified status of the certificate.

Object Oriented Interface

public function getSigningCertQualifiedStatements();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 70 );

Default Value

0

Remarks

Returns the qualified status of the certificate.

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

Data Type

Integer

SigningCertSelfSigned Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getSigningCertSelfSigned();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 71 );

Default Value

false

Remarks

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

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

Data Type

Boolean

SigningCertSerialNumber Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getSigningCertSerialNumber();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 72 );

Remarks

Returns the certificate's serial number.

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

Data Type

Byte Array

SigningCertSigAlgorithm Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getSigningCertSigAlgorithm();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 73 );

Default Value

''

Remarks

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

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

Data Type

String

SigningCertSubject Property (SecureBlackbox_MessageTimestampVerifier 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 getSigningCertSubject();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 74 );

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 property is read-only and not available at design time.

Data Type

String

SigningCertSubjectAlternativeName Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Object Oriented Interface

public function getSigningCertSubjectAlternativeName();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 75 );

Default Value

''

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

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

Data Type

String

SigningCertSubjectKeyID Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Object Oriented Interface

public function getSigningCertSubjectKeyID();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 76 );

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

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

Data Type

Byte Array

SigningCertSubjectRDN Property (SecureBlackbox_MessageTimestampVerifier Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Object Oriented Interface

public function getSigningCertSubjectRDN();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 77 );

Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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

Data Type

String

SigningCertValidFrom Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getSigningCertValidFrom();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 78 );

Default Value

''

Remarks

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

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

Data Type

String

SigningCertValidTo Property (SecureBlackbox_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function getSigningCertValidTo();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 79 );

Default Value

''

Remarks

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

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

Data Type

String

TimestampFormat Property (SecureBlackbox_MessageTimestampVerifier Class)

Returns the format of the processed timestamp.

Object Oriented Interface

public function getTimestampFormat();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 80 );

Default Value

0

Remarks

Use this property to check the format of the processed timestamp blob.

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

Data Type

Integer

ValidatedSigningTime Property (SecureBlackbox_MessageTimestampVerifier Class)

Contains the certified signing time.

Object Oriented Interface

public function getValidatedSigningTime();

Procedural Interface

secureblackbox_messagetimestampverifier_get($res, 81 );

Default Value

''

Remarks

Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.

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

Data Type

String

Config Method (SecureBlackbox_MessageTimestampVerifier Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_messagetimestampverifier_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_MessageTimestampVerifier Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Verify Method (SecureBlackbox_MessageTimestampVerifier Class)

Verifies a timestamped message.

Object Oriented Interface

public function doVerify();

Procedural Interface

secureblackbox_messagetimestampverifier_do_verify($res);

Remarks

Use this method to verify the enveloping timestamped message provided via InputFile (or InputStream). The original message will be extracted and saved to OutputFile (OutputStream).

Use VerifyDetached to verify detached timestamps.

VerifyDetached Method (SecureBlackbox_MessageTimestampVerifier Class)

Verifies a detached timestamped message.

Object Oriented Interface

public function doVerifyDetached();

Procedural Interface

secureblackbox_messagetimestampverifier_do_verifydetached($res);

Remarks

Use this method to verify the detached timestamped message provided via InputFile (or InputStream). Please provide the original data via DataFile or DataStream property. You do not need to provide OutputFile and OutputStream, as no data is extracted during this call.

Use Verify to verify enveloping timestamps.

Error Event (SecureBlackbox_MessageTimestampVerifier Class)

Information about errors during PKCS#7 message encryption.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_messagetimestampverifier_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_MessageTimestampVerifier Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

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

Config Settings (MessageTimestampVerifier 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.

MessageTimestampVerifier Config Settings

Base Config Settings

Trappable Errors (MessageTimestampVerifier Class)

MessageTimestampVerifier 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)