AuthenticodeVerifier Class

Properties   Methods   Events   Config Settings   Errors  

The AuthenticodeVerifier class verifies digital signatures over executable files (EXE) and dynamically linked libraries (DLL).

Class Name

SecureBlackbox_AuthenticodeVerifier

Procedural Interface

 secureblackbox_authenticodeverifier_open();
 secureblackbox_authenticodeverifier_close($res);
 secureblackbox_authenticodeverifier_register_callback($res, $id, $function);
 secureblackbox_authenticodeverifier_get_last_error($res);
 secureblackbox_authenticodeverifier_get_last_error_code($res);
 secureblackbox_authenticodeverifier_set($res, $id, $index, $value);
 secureblackbox_authenticodeverifier_get($res, $id, $index);
 secureblackbox_authenticodeverifier_do_config($res, $configurationstring);
 secureblackbox_authenticodeverifier_do_doaction($res, $actionid, $actionparams);
 secureblackbox_authenticodeverifier_do_reset($res);
 secureblackbox_authenticodeverifier_do_verify($res);

Remarks

Use this component to verify signatures created over executable files. AuthenticodeVerifier verifier = new AuthenticodeVerifier(); // Select the file which contains the executable that is timestamped verifier.setInputFile("signedExecutable.exe"); verifier.verify(); // Verify System.out.println("Validation result: " + verifier.getSignatureValidationResult() + "Signing time: " + verifier.getValidatedSigningTime() + "TSA Certificate: " + verifier.getSigningCertificate().getSubjectRDN()); // Validation result: 0 // 0 == svtValid // Signing time: 2024-05-17 12:37:24 // 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.

ActualChecksum Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the executable's checksum computed during signature verification.

Object Oriented Interface

public function getActualChecksum();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 1 );

Default Value

0

Remarks

Use this property to get the actual checksum of the executable.

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

Data Type

Integer

AllSignaturesValid Property (SecureBlackbox_AuthenticodeVerifier Class)

The cumulative validity of all signatures.

Object Oriented Interface

public function getAllSignaturesValid();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 2 );

Default Value

false

Remarks

Use this property to check if all the signatures found in the message or document are valid.

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

Data Type

Boolean

BlockedCertCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 3 );


secureblackbox_authenticodeverifier_set($res, 3, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 4 , $blockedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

BlockedCertHandle Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getBlockedCertHandle($blockedcertindex);


public function setBlockedCertHandle($blockedcertindex, $value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 12 , $blockedcertindex);


secureblackbox_authenticodeverifier_set($res, 12, $value , $blockedcertindex);

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

This property is not available at design time.

Data Type

Long64

CertCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the Cert arrays.

Object Oriented Interface

public function getCertCount();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 43 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 44 , $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_AuthenticodeVerifier Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getCertCA($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 45 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertCAKeyID($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 46 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertCertType($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 47 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 48 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertCurve($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 49 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertFingerprint($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 50 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertFriendlyName($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 51 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 52 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 53 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertIssuer($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 54 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertIssuerRDN($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 55 , $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_AuthenticodeVerifier Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCertKeyAlgorithm($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 56 , $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_AuthenticodeVerifier Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getCertKeyBits($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 57 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertKeyFingerprint($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 58 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 59 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertKeyValid($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 60 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 61 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertOCSPNoCheck($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 62 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertOrigin($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 63 , $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_AuthenticodeVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCertPolicyIDs($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 64 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertPrivateKeyBytes($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 65 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertPrivateKeyExists($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 66 , $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_AuthenticodeVerifier Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getCertPrivateKeyExtractable($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 67 , $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_AuthenticodeVerifier Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCertPublicKeyBytes($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 68 , $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_AuthenticodeVerifier Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getCertQualified($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 69 , $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_AuthenticodeVerifier Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getCertQualifiedStatements($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 70 , $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_AuthenticodeVerifier Class)

A list of qualifiers.

Object Oriented Interface

public function getCertQualifiers($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 71 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 72 , $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_AuthenticodeVerifier Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCertSerialNumber($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 73 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertSigAlgorithm($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 74 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 75 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 76 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 77 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertSubjectKeyID($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 78 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertSubjectRDN($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 79 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 80 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertValidFrom($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 81 , $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_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCertValidTo($certindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 82 , $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

CRLCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the CRL arrays.

Object Oriented Interface

public function getCRLCount();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 83 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CRLBytes
• CRLCAKeyID
• CRLEntryCount
• CRLHandle
• CRLIssuer
• CRLIssuerRDN
• CRLLocation
• CRLNextUpdate
• CRLSigAlgorithm
• CRLSource
• CRLTBS
• CRLThisUpdate

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

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

Data Type

Integer

CRLBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getCRLBytes($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 84 , $crlindex);

Remarks

Returns the raw CRL data in DER format.

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

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

Data Type

Byte Array

CRLCAKeyID Property (SecureBlackbox_AuthenticodeVerifier Class)

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

Object Oriented Interface

public function getCRLCAKeyID($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 85 , $crlindex);

Remarks

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

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

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

Data Type

Byte Array

CRLEntryCount Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the number of certificate status entries in the CRL.

Object Oriented Interface

public function getCRLEntryCount($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 86 , $crlindex);

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

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

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

Data Type

Integer

CRLHandle Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCRLHandle($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 87 , $crlindex);

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

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

Data Type

Long64

CRLIssuer Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCRLIssuer($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 88 , $crlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CRLIssuerRDN Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getCRLIssuerRDN($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 89 , $crlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CRLLocation Property (SecureBlackbox_AuthenticodeVerifier Class)

The URL that the CRL was downloaded from.

Object Oriented Interface

public function getCRLLocation($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 90 , $crlindex);

Default Value

''

Remarks

The URL that the CRL was downloaded from.

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

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

Data Type

String

CRLNextUpdate Property (SecureBlackbox_AuthenticodeVerifier Class)

The planned time and date of the next version of this CRL to be published.

Object Oriented Interface

public function getCRLNextUpdate($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 91 , $crlindex);

Default Value

''

Remarks

The planned time and date of the next version of this CRL to be published.

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

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

Data Type

String

CRLSigAlgorithm Property (SecureBlackbox_AuthenticodeVerifier Class)

The public key algorithm that was used by the CA to sign this CRL.

Object Oriented Interface

public function getCRLSigAlgorithm($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 92 , $crlindex);

Default Value

'0'

Remarks

The public key algorithm that was used by the CA to sign this CRL.

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

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

Data Type

String

CRLSource Property (SecureBlackbox_AuthenticodeVerifier 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 getCRLSource($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 93 , $crlindex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

CRLTBS Property (SecureBlackbox_AuthenticodeVerifier Class)

The to-be-signed part of the CRL (the CRL without the signature part).

Object Oriented Interface

public function getCRLTBS($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 94 , $crlindex);

Remarks

The to-be-signed part of the CRL (the CRL without the signature part).

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

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

Data Type

Byte Array

CRLThisUpdate Property (SecureBlackbox_AuthenticodeVerifier Class)

The date and time at which this version of the CRL was published.

Object Oriented Interface

public function getCRLThisUpdate($crlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 95 , $crlindex);

Default Value

''

Remarks

The date and time at which this version of the CRL was published.

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

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

Data Type

String

FIPSMode Property (SecureBlackbox_AuthenticodeVerifier Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 96 );


secureblackbox_authenticodeverifier_set($res, 96, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

IgnoreChainValidationErrors Property (SecureBlackbox_AuthenticodeVerifier Class)

Makes the class tolerant to chain validation errors.

Object Oriented Interface

public function getIgnoreChainValidationErrors();


public function setIgnoreChainValidationErrors($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 97 );


secureblackbox_authenticodeverifier_set($res, 97, $value );

Default Value

false

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

Data Type

Boolean

InputBytes Property (SecureBlackbox_AuthenticodeVerifier 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_authenticodeverifier_get($res, 98 );


secureblackbox_authenticodeverifier_set($res, 98, $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_AuthenticodeVerifier Class)

A path to the signed executable.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 99 );


secureblackbox_authenticodeverifier_set($res, 99, $value );

Default Value

''

Remarks

A path to the file containing the signed executable. The input can alternatively be provided via InputStream.

Data Type

String

KnownCertCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 100 );


secureblackbox_authenticodeverifier_set($res, 100, $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_AuthenticodeVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 101 , $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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 109 , $knowncertindex);


secureblackbox_authenticodeverifier_set($res, 109, $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

KnownCRLCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 140 );


secureblackbox_authenticodeverifier_set($res, 140, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 141 , $knowncrlindex);

Remarks

Returns the raw CRL data in DER format.

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

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

Data Type

Byte Array

KnownCRLHandle Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getKnownCRLHandle($knowncrlindex);


public function setKnownCRLHandle($knowncrlindex, $value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 144 , $knowncrlindex);


secureblackbox_authenticodeverifier_set($res, 144, $value , $knowncrlindex);

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

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 153 );


secureblackbox_authenticodeverifier_set($res, 153, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 154 , $knownocspindex);

Remarks

A buffer containing the raw OCSP response data.

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

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

Data Type

Byte Array

KnownOCSPHandle Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getKnownOCSPHandle($knownocspindex);


public function setKnownOCSPHandle($knownocspindex, $value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 156 , $knownocspindex);


secureblackbox_authenticodeverifier_set($res, 156, $value , $knownocspindex);

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

This property is not available at design time.

Data Type

Long64

OCSPCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the OCSP arrays.

Object Oriented Interface

public function getOCSPCount();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 163 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• OCSPBytes
• OCSPEntryCount
• OCSPHandle
• OCSPIssuer
• OCSPIssuerRDN
• OCSPLocation
• OCSPProducedAt
• OCSPSigAlgorithm
• OCSPSource

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

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

Data Type

Integer

OCSPBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getOCSPBytes($ocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 164 , $ocspindex);

Remarks

A buffer containing the raw OCSP response data.

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

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

Data Type

Byte Array

OCSPEntryCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of SingleResponse elements contained in this OCSP response.

Object Oriented Interface

public function getOCSPEntryCount($ocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 165 , $ocspindex);

Default Value

0

Remarks

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

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

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

Data Type

Integer

OCSPHandle Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getOCSPHandle($ocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 166 , $ocspindex);

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

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

Data Type

Long64

OCSPIssuer Property (SecureBlackbox_AuthenticodeVerifier Class)

Indicates the issuer of this response (a CA or its authorized representative).

Object Oriented Interface

public function getOCSPIssuer($ocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 167 , $ocspindex);

Default Value

''

Remarks

Indicates the issuer of this response (a CA or its authorized representative).

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

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

Data Type

String

OCSPIssuerRDN Property (SecureBlackbox_AuthenticodeVerifier Class)

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

Object Oriented Interface

public function getOCSPIssuerRDN($ocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 168 , $ocspindex);

Default Value

''

Remarks

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

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

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

Data Type

String

OCSPLocation Property (SecureBlackbox_AuthenticodeVerifier Class)

The location of the OCSP responder.

Object Oriented Interface

public function getOCSPLocation($ocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 169 , $ocspindex);

Default Value

''

Remarks

The location of the OCSP responder.

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

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

Data Type

String

OCSPProducedAt Property (SecureBlackbox_AuthenticodeVerifier Class)

Specifies the time when the response was produced, in UTC.

Object Oriented Interface

public function getOCSPProducedAt($ocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 170 , $ocspindex);

Default Value

''

Remarks

Specifies the time when the response was produced, in UTC.

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

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

Data Type

String

OCSPSigAlgorithm Property (SecureBlackbox_AuthenticodeVerifier Class)

The public key algorithm that was used by the CA to sign this OCSP response.

Object Oriented Interface

public function getOCSPSigAlgorithm($ocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 171 , $ocspindex);

Default Value

'0'

Remarks

The public key algorithm that was used by the CA to sign this OCSP response.

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

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

Data Type

String

OCSPSource Property (SecureBlackbox_AuthenticodeVerifier 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 getOCSPSource($ocspindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 172 , $ocspindex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

OfflineMode Property (SecureBlackbox_AuthenticodeVerifier Class)

Switches the class to offline mode.

Object Oriented Interface

public function getOfflineMode();


public function setOfflineMode($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 173 );


secureblackbox_authenticodeverifier_set($res, 173, $value );

Default Value

false

Remarks

When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

Profile Property (SecureBlackbox_AuthenticodeVerifier Class)

Specifies a pre-defined profile to apply when creating the signature.

Object Oriented Interface

public function getProfile();


public function setProfile($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 174 );


secureblackbox_authenticodeverifier_set($res, 174, $value );

Default Value

''

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

ProxyAddress Property (SecureBlackbox_AuthenticodeVerifier Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 175 );


secureblackbox_authenticodeverifier_set($res, 175, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_AuthenticodeVerifier Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 176 );


secureblackbox_authenticodeverifier_set($res, 176, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_AuthenticodeVerifier Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 177 );


secureblackbox_authenticodeverifier_set($res, 177, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_AuthenticodeVerifier Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 178 );


secureblackbox_authenticodeverifier_set($res, 178, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_AuthenticodeVerifier Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 179 );


secureblackbox_authenticodeverifier_set($res, 179, $value );

Default Value

0

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_AuthenticodeVerifier Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 180 );


secureblackbox_authenticodeverifier_set($res, 180, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 181 );


secureblackbox_authenticodeverifier_set($res, 181, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getProxyResponseHeaders();


public function setProxyResponseHeaders($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 182 );


secureblackbox_authenticodeverifier_set($res, 182, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getProxyUseIPv6();


public function setProxyUseIPv6($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 183 );


secureblackbox_authenticodeverifier_set($res, 183, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_AuthenticodeVerifier Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 184 );


secureblackbox_authenticodeverifier_set($res, 184, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

RevocationCheck Property (SecureBlackbox_AuthenticodeVerifier Class)

Specifies the kind(s) of revocation check to perform for all chain certificates.

Object Oriented Interface

public function getRevocationCheck();


public function setRevocationCheck($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 185 );


secureblackbox_authenticodeverifier_set($res, 185, $value );

Default Value

1

Remarks

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

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.

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

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

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

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

Integer

SigChainValidationDetails Property (SecureBlackbox_AuthenticodeVerifier Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getSigChainValidationDetails();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 186 );

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

SigChainValidationResult Property (SecureBlackbox_AuthenticodeVerifier Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getSigChainValidationResult();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 187 );

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

SigClaimedSigningTime Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the signature's claimed signing time.

Object Oriented Interface

public function getSigClaimedSigningTime();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 188 );

Default Value

''

Remarks

Returns the signature's claimed signing time.

Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by a trusted timestamp and may be forfeited or wrong. Use SigValidatedSigningTime 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

SigDescription Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns a human-readable signature description.

Object Oriented Interface

public function getSigDescription();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 189 );

Default Value

''

Remarks

Returns a human-readable signature description.

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

Data Type

String

SigErrorCode Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the error code returned by the signature validation routine.

Object Oriented Interface

public function getSigErrorCode();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 190 );

Default Value

0

Remarks

Returns the error code returned by the signature validation routine.

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

Data Type

Integer

SigErrorMessage Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the error message returned by the signature validation routine.

Object Oriented Interface

public function getSigErrorMessage();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 191 );

Default Value

''

Remarks

Returns the error message returned by the signature validation routine.

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

Data Type

String

SigFileHashAlgorithm Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the algorithm that was used to hash the executable.

Object Oriented Interface

public function getSigFileHashAlgorithm();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 192 );

Default Value

''

Remarks

Returns the algorithm that was used to hash the executable.

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

Data Type

String

SigHandle Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSigHandle();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 193 );

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

SigHashAlgorithm Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the hash algorithm used when generating the signature.

Object Oriented Interface

public function getSigHashAlgorithm();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 194 );

Default Value

''

Remarks

Returns the hash algorithm used when generating the signature.

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

Data Type

String

SigSignatureBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the binary representation of the inner PKCS7 signature.

Object Oriented Interface

public function getSigSignatureBytes();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 195 );

Remarks

Returns the binary representation of the inner PKCS7 signature.

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

Data Type

Byte Array

SigSignatureValidationResult Property (SecureBlackbox_AuthenticodeVerifier Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getSigSignatureValidationResult();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 196 );

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

Data Type

Integer

SigStatementType Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the signature statement type.

Object Oriented Interface

public function getSigStatementType();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 197 );

Default Value

0

Remarks

Returns the signature statement type.

Available options:

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

Data Type

Integer

SigURL Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the URL included in the signature by the signer.

Object Oriented Interface

public function getSigURL();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 198 );

Default Value

''

Remarks

Returns the URL included in the signature by the signer.

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

Data Type

String

SigValidatedSigningTime Property (SecureBlackbox_AuthenticodeVerifier Class)

Contains the certified signing time.

Object Oriented Interface

public function getSigValidatedSigningTime();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 199 );

Default Value

''

Remarks

Contains the certified signing time.

Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.

SigClaimedSigningTime returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

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

Data Type

String

SigValidationLog Property (SecureBlackbox_AuthenticodeVerifier Class)

Contains the signing certificate's chain validation log.

Object Oriented Interface

public function getSigValidationLog();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 200 );

Default Value

''

Remarks

Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.

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

Data Type

String

Signed Property (SecureBlackbox_AuthenticodeVerifier Class)

Indicates whether the executable is signed.

Object Oriented Interface

public function getSigned();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 201 );

Default Value

false

Remarks

Check this property after calling Verify to find out whether or not the provided executable is signed.

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

Data Type

Boolean

SignedAttributeCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the SignedAttribute arrays.

Object Oriented Interface

public function getSignedAttributeCount();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 202 );

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

The object identifier of the attribute.

Object Oriented Interface

public function getSignedAttributeOID($signedattributeindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 203 , $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_AuthenticodeVerifier Class)

The value of the attribute.

Object Oriented Interface

public function getSignedAttributeValue($signedattributeindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 204 , $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_AuthenticodeVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 205 );

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

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getSigningCertCA();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 206 );

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

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

Object Oriented Interface

public function getSigningCertCAKeyID();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 207 );

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

SigningCertCRLDistributionPoints Property (SecureBlackbox_AuthenticodeVerifier 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_authenticodeverifier_get($res, 209 );

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

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

Object Oriented Interface

public function getSigningCertCurve();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 210 );

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

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

Object Oriented Interface

public function getSigningCertFingerprint();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 211 );

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

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

Object Oriented Interface

public function getSigningCertFriendlyName();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 212 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 213 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 214 );

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

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

Object Oriented Interface

public function getSigningCertIssuer();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 215 );

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

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

Object Oriented Interface

public function getSigningCertIssuerRDN();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 216 );

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

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getSigningCertKeyAlgorithm();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 217 );

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

Returns the length of the public key in bits.

Object Oriented Interface

public function getSigningCertKeyBits();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 218 );

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

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

Object Oriented Interface

public function getSigningCertKeyFingerprint();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 219 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 220 );

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

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

Object Oriented Interface

public function getSigningCertKeyValid();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 221 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 222 );

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

SigningCertPolicyIDs Property (SecureBlackbox_AuthenticodeVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getSigningCertPolicyIDs();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 225 );

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

SigningCertPublicKeyBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getSigningCertPublicKeyBytes();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 229 );

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

SigningCertSelfSigned Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSigningCertSelfSigned();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 233 );

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

Returns the certificate's serial number.

Object Oriented Interface

public function getSigningCertSerialNumber();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 234 );

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

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

Object Oriented Interface

public function getSigningCertSigAlgorithm();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 235 );

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

SigningCertSubject Property (SecureBlackbox_AuthenticodeVerifier 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_authenticodeverifier_get($res, 237 );

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

SigningCertSubjectKeyID Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSigningCertSubjectKeyID();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 239 );

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

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

Object Oriented Interface

public function getSigningCertSubjectRDN();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 240 );

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

SigningCertValidFrom Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSigningCertValidFrom();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 242 );

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

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

Object Oriented Interface

public function getSigningCertValidTo();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 243 );

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

SocketDNSMode Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSocketDNSMode();


public function setSocketDNSMode($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 244 );


secureblackbox_authenticodeverifier_set($res, 244, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSPort Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSocketDNSPort();


public function setSocketDNSPort($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 245 );


secureblackbox_authenticodeverifier_set($res, 245, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (SecureBlackbox_AuthenticodeVerifier Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 246 );


secureblackbox_authenticodeverifier_set($res, 246, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSocketDNSServers();


public function setSocketDNSServers($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 247 );


secureblackbox_authenticodeverifier_set($res, 247, $value );

Default Value

''

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 248 );


secureblackbox_authenticodeverifier_set($res, 248, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSocketIncomingSpeedLimit();


public function setSocketIncomingSpeedLimit($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 249 );


secureblackbox_authenticodeverifier_set($res, 249, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_AuthenticodeVerifier Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 250 );


secureblackbox_authenticodeverifier_set($res, 250, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_AuthenticodeVerifier Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 251 );


secureblackbox_authenticodeverifier_set($res, 251, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSocketOutgoingSpeedLimit();


public function setSocketOutgoingSpeedLimit($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 252 );


secureblackbox_authenticodeverifier_set($res, 252, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getSocketTimeout();


public function setSocketTimeout($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 253 );


secureblackbox_authenticodeverifier_set($res, 253, $value );

Default Value

60000

Remarks

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

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (SecureBlackbox_AuthenticodeVerifier Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 254 );


secureblackbox_authenticodeverifier_set($res, 254, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SpecifiedChecksum Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the checksum of the executable.

Object Oriented Interface

public function getSpecifiedChecksum();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 255 );

Default Value

0

Remarks

Use this property to get the checksum of the executable as included by the signer.

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

Data Type

Integer

TimestampAccuracy Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTimestampAccuracy();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 256 );

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

Returns the raw timestamp data in DER format.

Object Oriented Interface

public function getTimestampBytes();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 257 );

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

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

Object Oriented Interface

public function getTimestampCertificateIndex();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 258 );

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

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getTimestampChainValidationDetails();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 259 );

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

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getTimestampChainValidationResult();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 260 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 261 );

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

Use this property to get the timestamp entity label.

Object Oriented Interface

public function getTimestampEntityLabel();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 262 );

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

Returns the timestamp's hash algorithm.

Object Oriented Interface

public function getTimestampHashAlgorithm();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 263 );

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

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

Object Oriented Interface

public function getTimestampParentEntity();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 264 );

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

Returns the timestamp's serial number.

Object Oriented Interface

public function getTimestampSerialNumber();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 265 );

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

The time point incorporated into the timestamp.

Object Oriented Interface

public function getTimestampTime();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 266 );

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

Returns the type of the timestamp.

Object Oriented Interface

public function getTimestampTimestampType();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 267 );

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

This value uniquely identifies the Timestamp Authority (TSA).

Object Oriented Interface

public function getTimestampTSAName();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 268 );

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

Contains the TSA certificate chain validation log.

Object Oriented Interface

public function getTimestampValidationLog();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 269 );

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

Contains the timestamp validation outcome.

Object Oriented Interface

public function getTimestampValidationResult();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 270 );

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

Indicates whether or not the signature is timestamped.

Object Oriented Interface

public function getTimestamped();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 271 );

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

TLSClientCertCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the TLSClientCert arrays.

Object Oriented Interface

public function getTLSClientCertCount();


public function setTLSClientCertCount($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 272 );


secureblackbox_authenticodeverifier_set($res, 272, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSClientCertBytes
• TLSClientCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSClientCertBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSClientCertBytes($tlsclientcertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 273 , $tlsclientcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TLSClientCertHandle Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSClientCertHandle($tlsclientcertindex);


public function setTLSClientCertHandle($tlsclientcertindex, $value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 281 , $tlsclientcertindex);


secureblackbox_authenticodeverifier_set($res, 281, $value , $tlsclientcertindex);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

TLSServerCertCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 312 );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

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

Data Type

Integer

TLSServerCertBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 313 , $tlsservercertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TLSServerCertFingerprint Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertFingerprint($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 319 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

TLSServerCertHandle Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertHandle($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 321 , $tlsservercertindex);

Default Value

0

Remarks

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

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

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

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

Data Type

Long64

TLSServerCertIssuer Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertIssuer($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 323 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

TLSServerCertIssuerRDN Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertIssuerRDN($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 324 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

TLSServerCertKeyAlgorithm Property (SecureBlackbox_AuthenticodeVerifier Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getTLSServerCertKeyAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 325 , $tlsservercertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

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

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

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

Data Type

String

TLSServerCertKeyBits Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getTLSServerCertKeyBits($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 326 , $tlsservercertindex);

Default Value

0

Remarks

Returns the length of the public key in bits.

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

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

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

Data Type

Integer

TLSServerCertKeyUsage Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertKeyUsage($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 328 , $tlsservercertindex);

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

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

Data Type

Integer

TLSServerCertSelfSigned Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertSelfSigned($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 341 , $tlsservercertindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

TLSServerCertSerialNumber Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getTLSServerCertSerialNumber($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 342 , $tlsservercertindex);

Remarks

Returns the certificate's serial number.

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

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

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

Data Type

Byte Array

TLSServerCertSigAlgorithm Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertSigAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 343 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

TLSServerCertSubject Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertSubject($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 345 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

TLSServerCertSubjectRDN Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertSubjectRDN($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 348 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

TLSServerCertValidFrom Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertValidFrom($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 350 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

TLSServerCertValidTo Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSServerCertValidTo($tlsservercertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 351 , $tlsservercertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

TLSAutoValidateCertificates Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSAutoValidateCertificates();


public function setTLSAutoValidateCertificates($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 352 );


secureblackbox_authenticodeverifier_set($res, 352, $value );

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (SecureBlackbox_AuthenticodeVerifier Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 353 );


secureblackbox_authenticodeverifier_set($res, 353, $value );

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_AuthenticodeVerifier Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 354 );


secureblackbox_authenticodeverifier_set($res, 354, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

TLSClientAuth Property (SecureBlackbox_AuthenticodeVerifier Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();


public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 355 );


secureblackbox_authenticodeverifier_set($res, 355, $value );

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

Integer

TLSECCurves Property (SecureBlackbox_AuthenticodeVerifier Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 356 );


secureblackbox_authenticodeverifier_set($res, 356, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_AuthenticodeVerifier Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 357 );


secureblackbox_authenticodeverifier_set($res, 357, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSForceResumeIfDestinationChanges();


public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 358 );


secureblackbox_authenticodeverifier_set($res, 358, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSPreSharedIdentity();


public function setTLSPreSharedIdentity($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 359 );


secureblackbox_authenticodeverifier_set($res, 359, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSPreSharedKey();


public function setTLSPreSharedKey($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 360 );


secureblackbox_authenticodeverifier_set($res, 360, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 361 );


secureblackbox_authenticodeverifier_set($res, 361, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_AuthenticodeVerifier Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 362 );


secureblackbox_authenticodeverifier_set($res, 362, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 363 );


secureblackbox_authenticodeverifier_set($res, 363, $value );

Default Value

1

Remarks

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

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

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

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

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

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSSSLOptions();


public function setTLSSSLOptions($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 364 );


secureblackbox_authenticodeverifier_set($res, 364, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_AuthenticodeVerifier Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 365 );


secureblackbox_authenticodeverifier_set($res, 365, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 366 );


secureblackbox_authenticodeverifier_set($res, 366, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_AuthenticodeVerifier Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 367 );


secureblackbox_authenticodeverifier_set($res, 367, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_AuthenticodeVerifier Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 368 );


secureblackbox_authenticodeverifier_set($res, 368, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_AuthenticodeVerifier Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 369 );


secureblackbox_authenticodeverifier_set($res, 369, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertBytes
• TrustedCertHandle

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 370 , $trustedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TrustedCertHandle Property (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function getTrustedCertHandle($trustedcertindex);


public function setTrustedCertHandle($trustedcertindex, $value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 378 , $trustedcertindex);


secureblackbox_authenticodeverifier_set($res, 378, $value , $trustedcertindex);

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

This property is not available at design time.

Data Type

Long64

TSACertBytes Property (SecureBlackbox_AuthenticodeVerifier Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTSACertBytes();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 409 );

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

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getTSACertCA();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 410 );

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

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

Object Oriented Interface

public function getTSACertCAKeyID();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 411 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 413 );

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

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

Object Oriented Interface

public function getTSACertCurve();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 414 );

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

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

Object Oriented Interface

public function getTSACertFingerprint();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 415 );

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

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

Object Oriented Interface

public function getTSACertFriendlyName();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 416 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 417 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 418 );

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

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

Object Oriented Interface

public function getTSACertIssuer();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 419 );

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

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

Object Oriented Interface

public function getTSACertIssuerRDN();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 420 );

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

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getTSACertKeyAlgorithm();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 421 );

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

Returns the length of the public key in bits.

Object Oriented Interface

public function getTSACertKeyBits();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 422 );

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

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

Object Oriented Interface

public function getTSACertKeyFingerprint();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 423 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 424 );

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

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

Object Oriented Interface

public function getTSACertKeyValid();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 425 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 426 );

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

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getTSACertPolicyIDs();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 429 );

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

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getTSACertPublicKeyBytes();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 433 );

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

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

Object Oriented Interface

public function getTSACertSelfSigned();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 437 );

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

Returns the certificate's serial number.

Object Oriented Interface

public function getTSACertSerialNumber();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 438 );

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

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

Object Oriented Interface

public function getTSACertSigAlgorithm();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 439 );

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_AuthenticodeVerifier 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_authenticodeverifier_get($res, 441 );

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

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

Object Oriented Interface

public function getTSACertSubjectKeyID();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 443 );

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

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

Object Oriented Interface

public function getTSACertSubjectRDN();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 444 );

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

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

Object Oriented Interface

public function getTSACertValidFrom();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 446 );

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

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

Object Oriented Interface

public function getTSACertValidTo();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 447 );

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

The number of records in the UnsignedAttribute arrays.

Object Oriented Interface

public function getUnsignedAttributeCount();

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 448 );

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

The object identifier of the attribute.

Object Oriented Interface

public function getUnsignedAttributeOID($unsignedattributeindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 449 , $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_AuthenticodeVerifier Class)

The value of the attribute.

Object Oriented Interface

public function getUnsignedAttributeValue($unsignedattributeindex);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 450 , $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

ValidationMoment Property (SecureBlackbox_AuthenticodeVerifier Class)

The time point at which signature validity is to be established.

Object Oriented Interface

public function getValidationMoment();


public function setValidationMoment($value);

Procedural Interface

secureblackbox_authenticodeverifier_get($res, 451 );


secureblackbox_authenticodeverifier_set($res, 451, $value );

Default Value

''

Remarks

Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).

The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

Data Type

String

Config Method (SecureBlackbox_AuthenticodeVerifier Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_authenticodeverifier_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_AuthenticodeVerifier Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_authenticodeverifier_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_AuthenticodeVerifier Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_authenticodeverifier_do_reset($res);

Remarks

Reset is a generic method available in every class.

Verify Method (SecureBlackbox_AuthenticodeVerifier Class)

Verifies a digitally signed executable.

Object Oriented Interface

public function doVerify();

Procedural Interface

secureblackbox_authenticodeverifier_do_verify($res);

Remarks

Use this method to verify all signatures in the executable provided via InputFile or via InputStream.

During the verification process, the SignatureFound, SignatureValidated, TimestampFound and TimestampValidated events are fired to provide details about the signatures and timestamps.

After this method is executed, the Signature property contains information about the last verified signature.

ChainElementDownload Event (SecureBlackbox_AuthenticodeVerifier Class)

Fires when there is a need to download a chain element from an online source.

Object Oriented Interface

public function fireChainElementDownload($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 1, array($this, 'fireChainElementDownload'));

Parameter List

 'kind'
 'certrdn'
 'cacertrdn'
 'location'
 'action'

Remarks

Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.

ChainElementNeeded Event (SecureBlackbox_AuthenticodeVerifier Class)

Fires when an element required to validate the chain was not located.

Object Oriented Interface

public function fireChainElementNeeded($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 2, array($this, 'fireChainElementNeeded'));

Parameter List

 'kind'
 'certrdn'
 'cacertrdn'

Remarks

Subscribe to this event to be notified about missing validation elements. Use the KnownCRLs, KnownCertificates, and KnownOCSPs properties in the event handler to provide the missing piece.

ChainValidated Event (SecureBlackbox_AuthenticodeVerifier Class)

Reports the completion of a certificate chain validation.

Object Oriented Interface

public function fireChainValidated($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 3, array($this, 'fireChainValidated'));

Parameter List

 'subjectrdn'
 'validationresult'
 'validationdetails'

Remarks

This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.

ValidationResult set to 0 (zero) indicates successful chain validation.

Any other value reports a failure, and ValidationDetails provides more details on its reasons.

ChainValidationProgress Event (SecureBlackbox_AuthenticodeVerifier Class)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Object Oriented Interface

public function fireChainValidationProgress($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 4, array($this, 'fireChainValidationProgress'));

Parameter List

 'eventkind'
 'certrdn'
 'cacertrdn'
 'action'

Remarks

Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.

Error Event (SecureBlackbox_AuthenticodeVerifier Class)

Information about errors during ASiC signature verification.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during ASiC signature verification.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 6, 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.

SignatureFound Event (SecureBlackbox_AuthenticodeVerifier Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 7, 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_AuthenticodeVerifier Class)

Marks the completion of the signature validation routine.

Object Oriented Interface

public function fireSignatureValidated($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 8, 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_AuthenticodeVerifier Class)

Signifies the start of a timestamp validation routine.

Object Oriented Interface

public function fireTimestampFound($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 9, 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_AuthenticodeVerifier Class)

Reports the completion of the timestamp validation routine.

Object Oriented Interface

public function fireTimestampValidated($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 10, 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.

TLSCertNeeded Event (SecureBlackbox_AuthenticodeVerifier Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 11, array($this, 'fireTLSCertNeeded'));

Parameter List

 'host'
 'canames'

Remarks

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

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

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

TLSCertValidate Event (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 12, array($this, 'fireTLSCertValidate'));

Parameter List

 'serverhost'
 'serverip'
 'accept'

Remarks

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

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

TLSEstablished Event (SecureBlackbox_AuthenticodeVerifier Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 13, array($this, 'fireTLSEstablished'));

Parameter List

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

Remarks

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

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

TLSHandshake Event (SecureBlackbox_AuthenticodeVerifier Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 14, array($this, 'fireTLSHandshake'));

Parameter List

 'host'
 'abort'

Remarks

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

TLSShutdown Event (SecureBlackbox_AuthenticodeVerifier Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_authenticodeverifier_register_callback($res, 15, array($this, 'fireTLSShutdown'));

Parameter List

 'host'

Remarks

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

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

AuthenticodeVerifier Config Settings

Base Config Settings

Trappable Errors (AuthenticodeVerifier Class)

AuthenticodeSigner Errors