MessageVerifier Class

Properties   Methods   Events   Config Settings   Errors  

The MessageVerifier class verifies digital signatures of data stored in the PKCS#7 format.

Class Name

SecureBlackbox_MessageVerifier

Procedural Interface

 secureblackbox_messageverifier_open();
 secureblackbox_messageverifier_close($res);
 secureblackbox_messageverifier_register_callback($res, $id, $function);
 secureblackbox_messageverifier_get_last_error($res);
 secureblackbox_messageverifier_get_last_error_code($res);
 secureblackbox_messageverifier_set($res, $id, $index, $value);
 secureblackbox_messageverifier_get($res, $id, $index);
 secureblackbox_messageverifier_do_checksignaturetype($res);
 secureblackbox_messageverifier_do_config($res, $configurationstring);
 secureblackbox_messageverifier_do_doaction($res, $actionid, $actionparams);
 secureblackbox_messageverifier_do_reset($res);
 secureblackbox_messageverifier_do_verify($res);
 secureblackbox_messageverifier_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. MessageVerifier verifier = new MessageVerifier(); // Select the file which contains the signed message verifier.setInputFile("signedMessage.bin"); if (verifier.checkSignatureType() == Constants.stPKCS7Detached) { // To verify a detached signature, we need // to provide both the signature and the original data verifier.setDataFile("message.txt"); verifier.verifyDetached(); } else { // To verify an enveloping signature, we need // to provide the location to extract the data verifier.setOutputFile("output.txt"); verifier.verify(); } System.out.println("Validation result: " + verifier.getSignatureValidationResult() + "\n" + "Signing time: " + verifier.getValidatedSigningTime() + "\n" + "TSA certificate: " + verifier.getSigningCertificate().getSubjectRDN()); // Output: // // Validation result: 0 // 0 == svtValid // Signing time: 2024-05-16 15:18:35 // TSA certificate: /CN=Test Certificate

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

The number of records in the Cert arrays.

Object Oriented Interface

public function getCertCount();

Procedural Interface

secureblackbox_messageverifier_get($res, 1 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertBytes
• CertCA
• CertCAKeyID
• CertCertType
• CertCRLDistributionPoints
• CertCurve
• CertFingerprint
• CertFriendlyName
• CertHandle
• CertHashAlgorithm
• CertIssuer
• CertIssuerRDN
• CertKeyAlgorithm
• CertKeyBits
• CertKeyFingerprint
• CertKeyUsage
• CertKeyValid
• CertOCSPLocations
• CertOCSPNoCheck
• CertOrigin
• CertPolicyIDs
• CertPrivateKeyBytes
• CertPrivateKeyExists
• CertPrivateKeyExtractable
• CertPublicKeyBytes
• CertQualified
• CertQualifiedStatements
• CertQualifiers
• CertSelfSigned
• CertSerialNumber
• CertSigAlgorithm
• CertSource
• CertSubject
• CertSubjectAlternativeName
• CertSubjectKeyID
• CertSubjectRDN
• CertValid
• 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_MessageVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes($certindex);

Procedural Interface

secureblackbox_messageverifier_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_MessageVerifier Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getCertCA($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 3 , $certindex);

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

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

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

Object Oriented Interface

public function getCertCAKeyID($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 4 , $certindex);

Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the CertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID 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

Byte Array

CertCertType Property (SecureBlackbox_MessageVerifier Class)

Returns the type of the entity contained in the Certificate object.

Object Oriented Interface

public function getCertCertType($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 5 , $certindex);

Default Value

0

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

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

CertCRLDistributionPoints Property (SecureBlackbox_MessageVerifier Class)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Object Oriented Interface

public function getCertCRLDistributionPoints($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 6 , $certindex);

Default Value

''

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Specifies the elliptic curve associated with the certificate's public key.

Object Oriented Interface

public function getCertCurve($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 7 , $certindex);

Default Value

''

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC 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

String

CertFingerprint Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getCertFingerprint($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 8 , $certindex);

Default Value

''

Remarks

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

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

The $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

CertFriendlyName Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getCertFriendlyName($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 9 , $certindex);

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

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_MessageVerifier 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_messageverifier_get($res, 10 , $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_MessageVerifier Class)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Object Oriented Interface

public function getCertHashAlgorithm($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 11 , $certindex);

Default Value

''

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use CertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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

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

Object Oriented Interface

public function getCertIssuer($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 12 , $certindex);

Default Value

''

Remarks

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

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

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

Object Oriented Interface

public function getCertIssuerRDN($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 13 , $certindex);

Default Value

''

Remarks

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

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

The $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_MessageVerifier Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCertKeyAlgorithm($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 14 , $certindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the CertKeyBits, CertCurve, and CertPublicKeyBytes properties to get more details about the key the certificate contains.

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

Returns the length of the public key in bits.

Object Oriented Interface

public function getCertKeyBits($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 15 , $certindex);

Default Value

0

Remarks

Returns the length of the public key in bits.

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

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

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

Object Oriented Interface

public function getCertKeyFingerprint($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 16 , $certindex);

Default Value

''

Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the CertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same 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

CertKeyUsage Property (SecureBlackbox_MessageVerifier 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_messageverifier_get($res, 17 , $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:

Set this property before generating the certificate to propagate the key usage flags to the new 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

Integer

CertKeyValid Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getCertKeyValid($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 18 , $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_MessageVerifier Class)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Object Oriented Interface

public function getCertOCSPLocations($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 19 , $certindex);

Default Value

''

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

CertOCSPNoCheck Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getCertOCSPNoCheck($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 20 , $certindex);

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check 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

CertOrigin Property (SecureBlackbox_MessageVerifier Class)

Returns the location that the certificate was taken or loaded from.

Object Oriented Interface

public function getCertOrigin($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 21 , $certindex);

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

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

CertPolicyIDs Property (SecureBlackbox_MessageVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCertPolicyIDs($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 22 , $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.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

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

CertPrivateKeyBytes Property (SecureBlackbox_MessageVerifier Class)

Returns the certificate's private key in DER-encoded format.

Object Oriented Interface

public function getCertPrivateKeyBytes($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 23 , $certindex);

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

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

CertPrivateKeyExists Property (SecureBlackbox_MessageVerifier Class)

Indicates whether the certificate has a usable private key associated with it.

Object Oriented Interface

public function getCertPrivateKeyExists($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 24 , $certindex);

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from CertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

CertPrivateKeyExtractable Property (SecureBlackbox_MessageVerifier Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getCertPrivateKeyExtractable($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 25 , $certindex);

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

CertPublicKeyBytes Property (SecureBlackbox_MessageVerifier Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCertPublicKeyBytes($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 26 , $certindex);

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type 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

CertQualified Property (SecureBlackbox_MessageVerifier Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getCertQualified($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 27 , $certindex);

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

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

CertQualifiedStatements Property (SecureBlackbox_MessageVerifier Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getCertQualifiedStatements($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 28 , $certindex);

Default Value

0

Remarks

Returns a simplified qualified status 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

Integer

CertQualifiers Property (SecureBlackbox_MessageVerifier Class)

A list of qualifiers.

Object Oriented Interface

public function getCertQualifiers($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 29 , $certindex);

Default Value

''

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

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

CertSelfSigned Property (SecureBlackbox_MessageVerifier 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_messageverifier_get($res, 30 , $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_MessageVerifier Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCertSerialNumber($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 31 , $certindex);

Remarks

Returns the certificate's serial number.

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

The $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_MessageVerifier Class)

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

Object Oriented Interface

public function getCertSigAlgorithm($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 32 , $certindex);

Default Value

''

Remarks

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

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

The $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

CertSource Property (SecureBlackbox_MessageVerifier Class)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Object Oriented Interface

public function getCertSource($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 33 , $certindex);

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

CertSubject Property (SecureBlackbox_MessageVerifier 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_messageverifier_get($res, 34 , $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. This is part of a larger set of credentials available via CertSubjectRDN.

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

CertSubjectAlternativeName Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getCertSubjectAlternativeName($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 35 , $certindex);

Default Value

''

Remarks

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

Subject alternative names are used to provide additional names that are impractical to store in the main CertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

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

Contains a unique identifier of the certificate's cryptographic key.

Object Oriented Interface

public function getCertSubjectKeyID($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 36 , $certindex);

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The CertSubjectKeyID and CertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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

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

Object Oriented Interface

public function getCertSubjectRDN($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 37 , $certindex);

Default Value

''

Remarks

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

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

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

The $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

CertValid Property (SecureBlackbox_MessageVerifier Class)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Object Oriented Interface

public function getCertValid($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 38 , $certindex);

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

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

CertValidFrom Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getCertValidFrom($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 39 , $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_MessageVerifier Class)

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

Object Oriented Interface

public function getCertValidTo($certindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 40 , $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

ClaimedSigningTime Property (SecureBlackbox_MessageVerifier Class)

Returns a signature's claimed signing time.

Object Oriented Interface

public function getClaimedSigningTime();

Procedural Interface

secureblackbox_messageverifier_get($res, 41 );

Default Value

''

Remarks

Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by the signature and may be forfeited or wrong. Use ValidatedSigningTime to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC.

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

Data Type

String

ContentType Property (SecureBlackbox_MessageVerifier Class)

A content type property of the signed message.

Object Oriented Interface

public function getContentType();

Procedural Interface

secureblackbox_messageverifier_get($res, 42 );

Default Value

''

Remarks

Use this property to check the content type property of the processed signed message.

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

Data Type

String

DataBytes Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getDataBytes();


public function setDataBytes($value);

Procedural Interface

secureblackbox_messageverifier_get($res, 43 );


secureblackbox_messageverifier_set($res, 43, $value );

Remarks

When validating detached signatures, assign a byte array containing the signed data to this property.

This property is not available at design time.

Data Type

Byte Array

DataFile Property (SecureBlackbox_MessageVerifier Class)

The name of the file containing the original signed data.

Object Oriented Interface

public function getDataFile();


public function setDataFile($value);

Procedural Interface

secureblackbox_messageverifier_get($res, 44 );


secureblackbox_messageverifier_set($res, 44, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_MessageVerifier Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_messageverifier_get($res, 45 );


secureblackbox_messageverifier_set($res, 45, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (SecureBlackbox_MessageVerifier Class)

Hash algorithm which was used to calculate the signature.

Object Oriented Interface

public function getHashAlgorithm();


public function setHashAlgorithm($value);

Procedural Interface

secureblackbox_messageverifier_get($res, 46 );


secureblackbox_messageverifier_set($res, 46, $value );

Default Value

''

Remarks

Check this property after calling Verify or VerifyDetached to get the hash algorithm that was used to calculate the signature message digest.

Data Type

String

InputBytes Property (SecureBlackbox_MessageVerifier 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_messageverifier_get($res, 47 );


secureblackbox_messageverifier_set($res, 47, $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_MessageVerifier Class)

Path to the file containing the signed message.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_messageverifier_get($res, 48 );


secureblackbox_messageverifier_set($res, 48, $value );

Default Value

''

Remarks

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

Data Type

String

InputIsHash Property (SecureBlackbox_MessageVerifier 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_messageverifier_get($res, 49 );


secureblackbox_messageverifier_set($res, 49, $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

KnownCertCount Property (SecureBlackbox_MessageVerifier Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_messageverifier_get($res, 50 );


secureblackbox_messageverifier_set($res, 50, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SecureBlackbox_MessageVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 51 , $knowncertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getKnownCertHandle($knowncertindex);


public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface

secureblackbox_messageverifier_get($res, 59 , $knowncertindex);


secureblackbox_messageverifier_set($res, 59, $value , $knowncertindex);

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

This property is not available at design time.

Data Type

Long64

MACAlgorithm Property (SecureBlackbox_MessageVerifier Class)

Specifies the hash algorithm to be used.

Object Oriented Interface

public function getMACAlgorithm();

Procedural Interface

secureblackbox_messageverifier_get($res, 90 );

Default Value

'SHA256'

Remarks

This property specifies the MAC algorithm that was used to calculate an authenticated signature.

This property is read-only.

Data Type

String

OutputBytes Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_messageverifier_get($res, 91 );

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

Path to the file to save the extracted data to.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_messageverifier_get($res, 92 );


secureblackbox_messageverifier_set($res, 92, $value );

Default Value

''

Remarks

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

Data Type

String

SignatureType Property (SecureBlackbox_MessageVerifier Class)

The type of the processed signature.

Object Oriented Interface

public function getSignatureType();

Procedural Interface

secureblackbox_messageverifier_get($res, 93 );

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

SignatureValidationResult Property (SecureBlackbox_MessageVerifier Class)

The signature validation result.

Object Oriented Interface

public function getSignatureValidationResult();

Procedural Interface

secureblackbox_messageverifier_get($res, 94 );

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

SignedAttributeCount Property (SecureBlackbox_MessageVerifier Class)

The number of records in the SignedAttribute arrays.

Object Oriented Interface

public function getSignedAttributeCount();

Procedural Interface

secureblackbox_messageverifier_get($res, 95 );

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

Data Type

Integer

SignedAttributeOID Property (SecureBlackbox_MessageVerifier Class)

The object identifier of the attribute.

Object Oriented Interface

public function getSignedAttributeOID($signedattributeindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 96 , $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 read-only and not available at design time.

Data Type

String

SignedAttributeValue Property (SecureBlackbox_MessageVerifier Class)

The value of the attribute.

Object Oriented Interface

public function getSignedAttributeValue($signedattributeindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 97 , $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 read-only and not available at design time.

Data Type

Byte Array

SigningCertBytes Property (SecureBlackbox_MessageVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_messageverifier_get($res, 98 );

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

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getSigningCertCA();

Procedural Interface

secureblackbox_messageverifier_get($res, 99 );

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

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

Data Type

Boolean

SigningCertCAKeyID Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertCAKeyID();

Procedural Interface

secureblackbox_messageverifier_get($res, 100 );

Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SigningCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

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

Data Type

Byte Array

SigningCertCertType Property (SecureBlackbox_MessageVerifier Class)

Returns the type of the entity contained in the Certificate object.

Object Oriented Interface

public function getSigningCertCertType();

Procedural Interface

secureblackbox_messageverifier_get($res, 101 );

Default Value

0

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

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

Data Type

Integer

SigningCertCRLDistributionPoints Property (SecureBlackbox_MessageVerifier Class)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Object Oriented Interface

public function getSigningCertCRLDistributionPoints();

Procedural Interface

secureblackbox_messageverifier_get($res, 102 );

Default Value

''

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Data Type

String

SigningCertCurve Property (SecureBlackbox_MessageVerifier Class)

Specifies the elliptic curve associated with the certificate's public key.

Object Oriented Interface

public function getSigningCertCurve();

Procedural Interface

secureblackbox_messageverifier_get($res, 103 );

Default Value

''

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

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

Data Type

String

SigningCertFingerprint Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertFingerprint();

Procedural Interface

secureblackbox_messageverifier_get($res, 104 );

Default Value

''

Remarks

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

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

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

Data Type

String

SigningCertFriendlyName Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertFriendlyName();

Procedural Interface

secureblackbox_messageverifier_get($res, 105 );

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

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

Data Type

String

SigningCertHandle Property (SecureBlackbox_MessageVerifier 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_messageverifier_get($res, 106 );

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

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Object Oriented Interface

public function getSigningCertHashAlgorithm();

Procedural Interface

secureblackbox_messageverifier_get($res, 107 );

Default Value

''

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigningCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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

Data Type

String

SigningCertIssuer Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertIssuer();

Procedural Interface

secureblackbox_messageverifier_get($res, 108 );

Default Value

''

Remarks

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

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

Data Type

String

SigningCertIssuerRDN Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertIssuerRDN();

Procedural Interface

secureblackbox_messageverifier_get($res, 109 );

Default Value

''

Remarks

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

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

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

Data Type

String

SigningCertKeyAlgorithm Property (SecureBlackbox_MessageVerifier Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getSigningCertKeyAlgorithm();

Procedural Interface

secureblackbox_messageverifier_get($res, 110 );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the SigningCertKeyBits, SigningCertCurve, and SigningCertPublicKeyBytes properties to get more details about the key the certificate contains.

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

Data Type

String

SigningCertKeyBits Property (SecureBlackbox_MessageVerifier Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getSigningCertKeyBits();

Procedural Interface

secureblackbox_messageverifier_get($res, 111 );

Default Value

0

Remarks

Returns the length of the public key in bits.

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

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

Data Type

Integer

SigningCertKeyFingerprint Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertKeyFingerprint();

Procedural Interface

secureblackbox_messageverifier_get($res, 112 );

Default Value

''

Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the SigningCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

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

Data Type

String

SigningCertKeyUsage Property (SecureBlackbox_MessageVerifier 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_messageverifier_get($res, 113 );

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

Data Type

Integer

SigningCertKeyValid Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertKeyValid();

Procedural Interface

secureblackbox_messageverifier_get($res, 114 );

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

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Object Oriented Interface

public function getSigningCertOCSPLocations();

Procedural Interface

secureblackbox_messageverifier_get($res, 115 );

Default Value

''

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Data Type

String

SigningCertOCSPNoCheck Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertOCSPNoCheck();

Procedural Interface

secureblackbox_messageverifier_get($res, 116 );

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

Returns the location that the certificate was taken or loaded from.

Object Oriented Interface

public function getSigningCertOrigin();

Procedural Interface

secureblackbox_messageverifier_get($res, 117 );

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

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

Data Type

Integer

SigningCertPolicyIDs Property (SecureBlackbox_MessageVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getSigningCertPolicyIDs();

Procedural Interface

secureblackbox_messageverifier_get($res, 118 );

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.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

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

Data Type

String

SigningCertPrivateKeyBytes Property (SecureBlackbox_MessageVerifier Class)

Returns the certificate's private key in DER-encoded format.

Object Oriented Interface

public function getSigningCertPrivateKeyBytes();

Procedural Interface

secureblackbox_messageverifier_get($res, 119 );

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

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

Data Type

Byte Array

SigningCertPrivateKeyExists Property (SecureBlackbox_MessageVerifier Class)

Indicates whether the certificate has a usable private key associated with it.

Object Oriented Interface

public function getSigningCertPrivateKeyExists();

Procedural Interface

secureblackbox_messageverifier_get($res, 120 );

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from SigningCertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

Data Type

Boolean

SigningCertPrivateKeyExtractable Property (SecureBlackbox_MessageVerifier Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getSigningCertPrivateKeyExtractable();

Procedural Interface

secureblackbox_messageverifier_get($res, 121 );

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

Data Type

Boolean

SigningCertPublicKeyBytes Property (SecureBlackbox_MessageVerifier Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getSigningCertPublicKeyBytes();

Procedural Interface

secureblackbox_messageverifier_get($res, 122 );

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

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

Data Type

Byte Array

SigningCertQualified Property (SecureBlackbox_MessageVerifier Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getSigningCertQualified();

Procedural Interface

secureblackbox_messageverifier_get($res, 123 );

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

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

Data Type

Boolean

SigningCertQualifiedStatements Property (SecureBlackbox_MessageVerifier Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getSigningCertQualifiedStatements();

Procedural Interface

secureblackbox_messageverifier_get($res, 124 );

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

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

Data Type

Integer

SigningCertQualifiers Property (SecureBlackbox_MessageVerifier Class)

A list of qualifiers.

Object Oriented Interface

public function getSigningCertQualifiers();

Procedural Interface

secureblackbox_messageverifier_get($res, 125 );

Default Value

''

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

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

Data Type

String

SigningCertSelfSigned Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertSelfSigned();

Procedural Interface

secureblackbox_messageverifier_get($res, 126 );

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

Returns the certificate's serial number.

Object Oriented Interface

public function getSigningCertSerialNumber();

Procedural Interface

secureblackbox_messageverifier_get($res, 127 );

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

SigningCertSigAlgorithm Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertSigAlgorithm();

Procedural Interface

secureblackbox_messageverifier_get($res, 128 );

Default Value

''

Remarks

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

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

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

Data Type

String

SigningCertSource Property (SecureBlackbox_MessageVerifier Class)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Object Oriented Interface

public function getSigningCertSource();

Procedural Interface

secureblackbox_messageverifier_get($res, 129 );

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

Data Type

Integer

SigningCertSubject Property (SecureBlackbox_MessageVerifier 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_messageverifier_get($res, 130 );

Default Value

''

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SigningCertSubjectRDN.

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

Data Type

String

SigningCertSubjectAlternativeName Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertSubjectAlternativeName();

Procedural Interface

secureblackbox_messageverifier_get($res, 131 );

Default Value

''

Remarks

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

Subject alternative names are used to provide additional names that are impractical to store in the main SigningCertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

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

Data Type

String

SigningCertSubjectKeyID Property (SecureBlackbox_MessageVerifier Class)

Contains a unique identifier of the certificate's cryptographic key.

Object Oriented Interface

public function getSigningCertSubjectKeyID();

Procedural Interface

secureblackbox_messageverifier_get($res, 132 );

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SigningCertSubjectKeyID and SigningCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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

Data Type

Byte Array

SigningCertSubjectRDN Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertSubjectRDN();

Procedural Interface

secureblackbox_messageverifier_get($res, 133 );

Default Value

''

Remarks

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

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

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

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

Data Type

String

SigningCertValid Property (SecureBlackbox_MessageVerifier Class)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Object Oriented Interface

public function getSigningCertValid();

Procedural Interface

secureblackbox_messageverifier_get($res, 134 );

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

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

Data Type

Boolean

SigningCertValidFrom Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getSigningCertValidFrom();

Procedural Interface

secureblackbox_messageverifier_get($res, 135 );

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

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

Object Oriented Interface

public function getSigningCertValidTo();

Procedural Interface

secureblackbox_messageverifier_get($res, 136 );

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

TimestampAccuracy Property (SecureBlackbox_MessageVerifier Class)

This property indicates the accuracy of the included time mark, in microseconds.

Object Oriented Interface

public function getTimestampAccuracy();

Procedural Interface

secureblackbox_messageverifier_get($res, 137 );

Default Value

0

Remarks

This field indicates the accuracy of the included time mark, in microseconds.

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

Data Type

Long64

TimestampBytes Property (SecureBlackbox_MessageVerifier Class)

Returns the raw timestamp data in DER format.

Object Oriented Interface

public function getTimestampBytes();

Procedural Interface

secureblackbox_messageverifier_get($res, 138 );

Remarks

Returns the raw timestamp data in DER format.

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

Data Type

Byte Array

TimestampCertificateIndex Property (SecureBlackbox_MessageVerifier Class)

Returns the index of the TSA certificate in the Certificates collection.

Object Oriented Interface

public function getTimestampCertificateIndex();

Procedural Interface

secureblackbox_messageverifier_get($res, 139 );

Default Value

-1

Remarks

Returns the index of the TSA certificate in the Certificates collection.

Use this property to look up the TSA certificate in the Certificates collection.

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

Data Type

Integer

TimestampChainValidationDetails Property (SecureBlackbox_MessageVerifier Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getTimestampChainValidationDetails();

Procedural Interface

secureblackbox_messageverifier_get($res, 140 );

Default Value

0

Remarks

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

Returns a bit mask of the following options:

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

Data Type

Integer

TimestampChainValidationResult Property (SecureBlackbox_MessageVerifier Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getTimestampChainValidationResult();

Procedural Interface

secureblackbox_messageverifier_get($res, 141 );

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

TimestampContainsLongTermInfo Property (SecureBlackbox_MessageVerifier Class)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

Object Oriented Interface

public function getTimestampContainsLongTermInfo();

Procedural Interface

secureblackbox_messageverifier_get($res, 142 );

Default Value

false

Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

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

Data Type

Boolean

TimestampEntityLabel Property (SecureBlackbox_MessageVerifier Class)

Use this property to get the timestamp entity label.

Object Oriented Interface

public function getTimestampEntityLabel();

Procedural Interface

secureblackbox_messageverifier_get($res, 143 );

Default Value

''

Remarks

Use this property to get the timestamp entity label.

This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

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

Data Type

String

TimestampHashAlgorithm Property (SecureBlackbox_MessageVerifier Class)

Returns the timestamp's hash algorithm.

Object Oriented Interface

public function getTimestampHashAlgorithm();

Procedural Interface

secureblackbox_messageverifier_get($res, 144 );

Default Value

''

Remarks

Returns the timestamp's hash algorithm.

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

Data Type

String

TimestampParentEntity Property (SecureBlackbox_MessageVerifier Class)

Use this property to get the label of the timestamp's parent entity.

Object Oriented Interface

public function getTimestampParentEntity();

Procedural Interface

secureblackbox_messageverifier_get($res, 145 );

Default Value

''

Remarks

Use this property to get the label of the timestamp's parent entity.

This property references the EntityLabel of the object that the timestamp covers, typically a signature.

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

Data Type

String

TimestampSerialNumber Property (SecureBlackbox_MessageVerifier Class)

Returns the timestamp's serial number.

Object Oriented Interface

public function getTimestampSerialNumber();

Procedural Interface

secureblackbox_messageverifier_get($res, 146 );

Remarks

Returns the timestamp's serial number.

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

Data Type

Byte Array

TimestampTime Property (SecureBlackbox_MessageVerifier Class)

The time point incorporated into the timestamp.

Object Oriented Interface

public function getTimestampTime();

Procedural Interface

secureblackbox_messageverifier_get($res, 147 );

Default Value

''

Remarks

The time point incorporated into the timestamp.

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

Data Type

String

TimestampTimestampType Property (SecureBlackbox_MessageVerifier Class)

Returns the type of the timestamp.

Object Oriented Interface

public function getTimestampTimestampType();

Procedural Interface

secureblackbox_messageverifier_get($res, 148 );

Default Value

0

Remarks

Returns the type of the timestamp.

Available options:

Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).

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

Data Type

Integer

TimestampTSAName Property (SecureBlackbox_MessageVerifier Class)

This value uniquely identifies the Timestamp Authority (TSA).

Object Oriented Interface

public function getTimestampTSAName();

Procedural Interface

secureblackbox_messageverifier_get($res, 149 );

Default Value

''

Remarks

This value uniquely identifies the Timestamp Authority (TSA).

This property provides information about the entity that manages the TSA.

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

Data Type

String

TimestampValidationLog Property (SecureBlackbox_MessageVerifier Class)

Contains the TSA certificate chain validation log.

Object Oriented Interface

public function getTimestampValidationLog();

Procedural Interface

secureblackbox_messageverifier_get($res, 150 );

Default Value

''

Remarks

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

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

Data Type

String

TimestampValidationResult Property (SecureBlackbox_MessageVerifier Class)

Contains the timestamp validation outcome.

Object Oriented Interface

public function getTimestampValidationResult();

Procedural Interface

secureblackbox_messageverifier_get($res, 151 );

Default Value

0

Remarks

Contains the timestamp validation outcome.

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

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

Data Type

Integer

Timestamped Property (SecureBlackbox_MessageVerifier Class)

Indicates whether or not the signature is timestamped.

Object Oriented Interface

public function getTimestamped();

Procedural Interface

secureblackbox_messageverifier_get($res, 152 );

Default Value

false

Remarks

This property returns True if the signature is timestamped, and False otherwise.

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

Data Type

Boolean

TSACertBytes Property (SecureBlackbox_MessageVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTSACertBytes();

Procedural Interface

secureblackbox_messageverifier_get($res, 153 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

TSACertCA Property (SecureBlackbox_MessageVerifier Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getTSACertCA();

Procedural Interface

secureblackbox_messageverifier_get($res, 154 );

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

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

Data Type

Boolean

TSACertCAKeyID Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertCAKeyID();

Procedural Interface

secureblackbox_messageverifier_get($res, 155 );

Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the TSACertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

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

Data Type

Byte Array

TSACertCRLDistributionPoints Property (SecureBlackbox_MessageVerifier Class)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Object Oriented Interface

public function getTSACertCRLDistributionPoints();

Procedural Interface

secureblackbox_messageverifier_get($res, 157 );

Default Value

''

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Data Type

String

TSACertCurve Property (SecureBlackbox_MessageVerifier Class)

Specifies the elliptic curve associated with the certificate's public key.

Object Oriented Interface

public function getTSACertCurve();

Procedural Interface

secureblackbox_messageverifier_get($res, 158 );

Default Value

''

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

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

Data Type

String

TSACertFingerprint Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertFingerprint();

Procedural Interface

secureblackbox_messageverifier_get($res, 159 );

Default Value

''

Remarks

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

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

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

Data Type

String

TSACertFriendlyName Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertFriendlyName();

Procedural Interface

secureblackbox_messageverifier_get($res, 160 );

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

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

Data Type

String

TSACertHandle Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertHandle();

Procedural Interface

secureblackbox_messageverifier_get($res, 161 );

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

TSACertHashAlgorithm Property (SecureBlackbox_MessageVerifier Class)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Object Oriented Interface

public function getTSACertHashAlgorithm();

Procedural Interface

secureblackbox_messageverifier_get($res, 162 );

Default Value

''

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use TSACertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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

Data Type

String

TSACertIssuer Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertIssuer();

Procedural Interface

secureblackbox_messageverifier_get($res, 163 );

Default Value

''

Remarks

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

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

Data Type

String

TSACertIssuerRDN Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertIssuerRDN();

Procedural Interface

secureblackbox_messageverifier_get($res, 164 );

Default Value

''

Remarks

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

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

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

Data Type

String

TSACertKeyAlgorithm Property (SecureBlackbox_MessageVerifier Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getTSACertKeyAlgorithm();

Procedural Interface

secureblackbox_messageverifier_get($res, 165 );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the TSACertKeyBits, TSACertCurve, and TSACertPublicKeyBytes properties to get more details about the key the certificate contains.

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

Data Type

String

TSACertKeyBits Property (SecureBlackbox_MessageVerifier Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getTSACertKeyBits();

Procedural Interface

secureblackbox_messageverifier_get($res, 166 );

Default Value

0

Remarks

Returns the length of the public key in bits.

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

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

Data Type

Integer

TSACertKeyFingerprint Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertKeyFingerprint();

Procedural Interface

secureblackbox_messageverifier_get($res, 167 );

Default Value

''

Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the TSACertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

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

Data Type

String

TSACertKeyUsage Property (SecureBlackbox_MessageVerifier 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 getTSACertKeyUsage();

Procedural Interface

secureblackbox_messageverifier_get($res, 168 );

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

Data Type

Integer

TSACertKeyValid Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertKeyValid();

Procedural Interface

secureblackbox_messageverifier_get($res, 169 );

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

TSACertOCSPLocations Property (SecureBlackbox_MessageVerifier Class)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Object Oriented Interface

public function getTSACertOCSPLocations();

Procedural Interface

secureblackbox_messageverifier_get($res, 170 );

Default Value

''

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Data Type

String

TSACertPolicyIDs Property (SecureBlackbox_MessageVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getTSACertPolicyIDs();

Procedural Interface

secureblackbox_messageverifier_get($res, 173 );

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.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

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

Data Type

String

TSACertPublicKeyBytes Property (SecureBlackbox_MessageVerifier Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getTSACertPublicKeyBytes();

Procedural Interface

secureblackbox_messageverifier_get($res, 177 );

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

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

Data Type

Byte Array

TSACertSelfSigned Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertSelfSigned();

Procedural Interface

secureblackbox_messageverifier_get($res, 181 );

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

TSACertSerialNumber Property (SecureBlackbox_MessageVerifier Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getTSACertSerialNumber();

Procedural Interface

secureblackbox_messageverifier_get($res, 182 );

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

TSACertSigAlgorithm Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertSigAlgorithm();

Procedural Interface

secureblackbox_messageverifier_get($res, 183 );

Default Value

''

Remarks

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

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

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

Data Type

String

TSACertSubject Property (SecureBlackbox_MessageVerifier 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 getTSACertSubject();

Procedural Interface

secureblackbox_messageverifier_get($res, 185 );

Default Value

''

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via TSACertSubjectRDN.

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

Data Type

String

TSACertSubjectKeyID Property (SecureBlackbox_MessageVerifier Class)

Contains a unique identifier of the certificate's cryptographic key.

Object Oriented Interface

public function getTSACertSubjectKeyID();

Procedural Interface

secureblackbox_messageverifier_get($res, 187 );

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The TSACertSubjectKeyID and TSACertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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

Data Type

Byte Array

TSACertSubjectRDN Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertSubjectRDN();

Procedural Interface

secureblackbox_messageverifier_get($res, 188 );

Default Value

''

Remarks

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

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

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

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

Data Type

String

TSACertValidFrom Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertValidFrom();

Procedural Interface

secureblackbox_messageverifier_get($res, 190 );

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

TSACertValidTo Property (SecureBlackbox_MessageVerifier Class)

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

Object Oriented Interface

public function getTSACertValidTo();

Procedural Interface

secureblackbox_messageverifier_get($res, 191 );

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

UnsignedAttributeCount Property (SecureBlackbox_MessageVerifier Class)

The number of records in the UnsignedAttribute arrays.

Object Oriented Interface

public function getUnsignedAttributeCount();

Procedural Interface

secureblackbox_messageverifier_get($res, 192 );

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

Data Type

Integer

UnsignedAttributeOID Property (SecureBlackbox_MessageVerifier Class)

The object identifier of the attribute.

Object Oriented Interface

public function getUnsignedAttributeOID($unsignedattributeindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 193 , $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 read-only and not available at design time.

Data Type

String

UnsignedAttributeValue Property (SecureBlackbox_MessageVerifier Class)

The value of the attribute.

Object Oriented Interface

public function getUnsignedAttributeValue($unsignedattributeindex);

Procedural Interface

secureblackbox_messageverifier_get($res, 194 , $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 read-only and not available at design time.

Data Type

Byte Array

ValidatedSigningTime Property (SecureBlackbox_MessageVerifier Class)

Contains the certified signing time.

Object Oriented Interface

public function getValidatedSigningTime();

Procedural Interface

secureblackbox_messageverifier_get($res, 195 );

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

CheckSignatureType Method (SecureBlackbox_MessageVerifier Class)

Determines the signature kind.

Object Oriented Interface

public function doCheckSignatureType();

Procedural Interface

secureblackbox_messageverifier_do_checksignaturetype($res);

Remarks

Use this method to determine the kind of the signature stored in InputFile (InputStream).

Config Method (SecureBlackbox_MessageVerifier Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_messageverifier_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_MessageVerifier Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Reset Method (SecureBlackbox_MessageVerifier Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_messageverifier_do_reset($res);

Remarks

Reset is a generic method available in every class.

Verify Method (SecureBlackbox_MessageVerifier Class)

Verifies digitally signed data.

Object Oriented Interface

public function doVerify();

Procedural Interface

secureblackbox_messageverifier_do_verify($res);

Remarks

PKCS#7 and its successor, CMS, support two types of signatures: (1) enveloping signatures, where the signed data and its signature are combined in the same message, and (2) detached signatures, where the signature is stored as a separate entity. This method verifies enveloped signatures and extracts data contained in them. Use VerifyDetached to verify detached signatures.

This method expects the enveloping signature to be provided via InputFile or InputStream properties.

Note that this method only checks the integrity of the signature, i.e., that it is signed with the claimed certificate and has not been altered. It does not validate the signing certificate chain. To validate the certificate chain, either use CertificateValidator component together with MessageVerifier, or consider using CAdESVerifier component instead.

VerifyDetached Method (SecureBlackbox_MessageVerifier Class)

Verifies a detached signature.

Object Oriented Interface

public function doVerifyDetached();

Procedural Interface

secureblackbox_messageverifier_do_verifydetached($res);

Remarks

Use this method to verify detached signatures. Pass the signature via InputFile (or InputStream) property, and the original data via DataFile (DataStream).

Error Event (SecureBlackbox_MessageVerifier Class)

Information about errors during PKCS#7 message verification.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_messageverifier_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_MessageVerifier Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

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

RecipientFound Event (SecureBlackbox_MessageVerifier Class)

Fires to report a message addressee parameters.

Object Oriented Interface

public function fireRecipientFound($param);

Procedural Interface

secureblackbox_messageverifier_register_callback($res, 3, array($this, 'fireRecipientFound'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'certfound'

Remarks

This event is fired for each addressee the message is encrypted for. It may fire several times in a row if the message is encrypted for more than one recipient.

The IssuerRDN, SerialNumber, and SubjectKeyID parameters to identify the recipient's certificate. CertFound indicates if the specified certificate has been located in Certificates collection. If it wasn't, you might want to look up the certificate manually, and add it to the collection inside the event handler.

SignatureFound Event (SecureBlackbox_MessageVerifier Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_messageverifier_register_callback($res, 4, array($this, 'fireSignatureFound'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'certfound'
 'validatesignature'
 'validatechain'

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (SecureBlackbox_MessageVerifier Class)

Marks the completion of the signature validation routine.

Object Oriented Interface

public function fireSignatureValidated($param);

Procedural Interface

secureblackbox_messageverifier_register_callback($res, 5, array($this, 'fireSignatureValidated'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'validationresult'

Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

TimestampFound Event (SecureBlackbox_MessageVerifier Class)

Signifies the start of a timestamp validation routine.

Object Oriented Interface

public function fireTimestampFound($param);

Procedural Interface

secureblackbox_messageverifier_register_callback($res, 6, array($this, 'fireTimestampFound'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'certfound'
 'validatetimestamp'
 'validatechain'

Remarks

This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

TimestampValidated Event (SecureBlackbox_MessageVerifier Class)

Reports the completion of the timestamp validation routine.

Object Oriented Interface

public function fireTimestampValidated($param);

Procedural Interface

secureblackbox_messageverifier_register_callback($res, 7, array($this, 'fireTimestampValidated'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'time'
 'validationresult'
 'chainvalidationresult'
 'chainvalidationdetails'

Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.

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

MessageVerifier Config Settings

Base Config Settings

Trappable Errors (MessageVerifier Class)

MessageVerifier Errors