CertificateValidator Class

Properties   Methods   Events   Config Settings   Errors  

The CertificateValidator class provides fine-grained validation of X.509 certificates.

Class Name

SecureBlackbox_CertificateValidator

Procedural Interface

 secureblackbox_certificatevalidator_open();
 secureblackbox_certificatevalidator_close($res);
 secureblackbox_certificatevalidator_register_callback($res, $id, $function);
 secureblackbox_certificatevalidator_get_last_error($res);
 secureblackbox_certificatevalidator_get_last_error_code($res);
 secureblackbox_certificatevalidator_set($res, $id, $index, $value);
 secureblackbox_certificatevalidator_get($res, $id, $index);
 secureblackbox_certificatevalidator_do_config($res, $configurationstring);
 secureblackbox_certificatevalidator_do_doaction($res, $actionid, $actionparams);
 secureblackbox_certificatevalidator_do_getqualifiedstatus($res);
 secureblackbox_certificatevalidator_do_gettrustedlistproperty($res, $propname, $language);
 secureblackbox_certificatevalidator_do_refreshcache($res);
 secureblackbox_certificatevalidator_do_reset($res);
 secureblackbox_certificatevalidator_do_resetcache($res);
 secureblackbox_certificatevalidator_do_terminate($res);
 secureblackbox_certificatevalidator_do_validate($res);
 secureblackbox_certificatevalidator_do_validateforsmime($res, $emailaddress);
 secureblackbox_certificatevalidator_do_validateforssl($res, $url, $ipaddress);

Remarks

This is a powerful and configurable class which can be used to validate all kinds of certificates and their chains.

The purpose of CertificateValidator is to validate certificate chains according to the X.509 specification. It supports a variety of technologies, including CRL and OCSP services, and can provide a comprehensive output on the certificate cryptographic validity, chain integrity, and trust levels. CertificateValidator is used internally in many other SecureBlackbox components, such as PDFSigner, HTTPClient, and OfficeVerifier.

To validate a certificate, please tune up the component as following:

• Assign the certificate to be validated to the Certificate property.
• Set RevocationCheck in accordance with your revocation check preferences.
• Enable UseSystemCertificates property to trust certificates that are trusted by the operating system. Copy any certificates that are not available in the standard system locations to KnownCertificates and TrustedCertificates collections (see Note 1 below).
• Optionally, adjust TLSSettings and SocketSettings.
• Adjust ValidationMoment if you would like to check the certificate validity at a different moment in time. Leave it unchanged to validate the certificate at the current time moment.
• Call Validate or ValidateForSSL method to initiate chain validation.

Depending on the complexity of the chain and the configuration of the component, the validation routine may take certain amount of time. The validator reports chain validation progress using a selection of events, such as BeforeCertificateProcessing, AfterCertificateProcessing, and CRLDownloaded events. It may also ask you for missing objects using CRLNeeded or CACertificateNeeded events. In each such event handler you can access the currently validated certificate via the CurrentCertificate property, and the interim validity figures via the InterimValidationResult and InterimValidationDetails property.

The return of the Validate (or similar) method indicates the completion of the validation procedure. The outcome of the chain validation is represented with the two parameters:

• ChainValidationResult reports the general validation outcome: valid, valid-but-untrusted, invalid, and unknown. As a rule, only the valid result can be taken as a good reason to consider the chain valid.
• ChainValidationDetails provides insights into the factors that caused the validation to fail.

Apart from these two parameters, you can check the low-level validation details by consulting the ValidationLog property. The validation log is often a great source for tracking and reacting to various validation issues.

Note 1: On Windows, CertificateValidator can use CA and ROOT system stores to look for any missing CA certificates and trust anchors. No similar functionality is currently available for other platforms, so in most cases you must provide your own list of trusted and CA certificates via TrustedCertificates and KnownCertificates collections to have your chains validate fully in Linux and macOS projects.

Note 2: The OfflineMode property is a handy way to check the completeness of your revocation/validation information. When the offline mode is on, CertificateValidator won't go online for any missing certificates, CRLs, and OCSP responses. Paired with a switched-off UseSystemCertificates property, it allows to make sure that any content provided via KnownCertificates, KnownCRLs, and KnownOCSPs represents the complete set of validation information required to validate the chain.

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.

BlockedCertCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 1 );


secureblackbox_certificatevalidator_set($res, 1, $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_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 2 , $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_CertificateValidator 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_certificatevalidator_get($res, 10 , $blockedcertindex);


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

CacheValidationResults Property (SecureBlackbox_CertificateValidator Class)

Enables or disables validation result caching.

Object Oriented Interface

public function getCacheValidationResults();


public function setCacheValidationResults($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 41 );


secureblackbox_certificatevalidator_set($res, 41, $value );

Default Value

false

Remarks

Set this property to True to enable caching of validation results.

Data Type

Boolean

CertBytes Property (SecureBlackbox_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 42 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCertHandle();


public function setCertHandle($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 50 );


secureblackbox_certificatevalidator_set($res, 50, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

ChainValidationDetails Property (SecureBlackbox_CertificateValidator Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getChainValidationDetails();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 81 );

Default Value

0

Remarks

Use the value(s) returned by this property to identify 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

ChainValidationResult Property (SecureBlackbox_CertificateValidator Class)

The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.

Object Oriented Interface

public function getChainValidationResult();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 82 );

Default Value

0

Remarks

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

CheckTrustedLists Property (SecureBlackbox_CertificateValidator Class)

Specifies whether the class should attempt to validate chain trust via a known Trusted List.

Object Oriented Interface

public function getCheckTrustedLists();


public function setCheckTrustedLists($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 83 );


secureblackbox_certificatevalidator_set($res, 83, $value );

Default Value

false

Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

Data Type

Boolean

CurrentCACertBytes Property (SecureBlackbox_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCurrentCACertBytes();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 84 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CurrentCACertCA Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getCurrentCACertCA();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 85 );

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

CurrentCACertCAKeyID Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertCAKeyID();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 86 );

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 CurrentCACertSubjectKeyID 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

CurrentCACertCertType Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertCertType();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 87 );

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

CurrentCACertCRLDistributionPoints Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertCRLDistributionPoints();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 88 );

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

CurrentCACertCurve Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertCurve();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 89 );

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

CurrentCACertFingerprint Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertFingerprint();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 90 );

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

CurrentCACertFriendlyName Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertFriendlyName();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 91 );

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

CurrentCACertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertHandle();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 92 );

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

CurrentCACertHashAlgorithm Property (SecureBlackbox_CertificateValidator 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 getCurrentCACertHashAlgorithm();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 93 );

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 CurrentCACertSigAlgorithm 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

CurrentCACertIssuer Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertIssuer();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 94 );

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

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

Data Type

String

CurrentCACertIssuerRDN Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertIssuerRDN();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 95 );

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

CurrentCACertKeyAlgorithm Property (SecureBlackbox_CertificateValidator Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCurrentCACertKeyAlgorithm();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 96 );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the CurrentCACertKeyBits, CurrentCACertCurve, and CurrentCACertPublicKeyBytes 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

CurrentCACertKeyBits Property (SecureBlackbox_CertificateValidator Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getCurrentCACertKeyBits();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 97 );

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 CurrentCACertPublicKeyBytes or CurrentCACertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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

Data Type

Integer

CurrentCACertKeyFingerprint Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertKeyFingerprint();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 98 );

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 CurrentCACertFingerprint 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

CurrentCACertKeyUsage Property (SecureBlackbox_CertificateValidator 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 getCurrentCACertKeyUsage();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 99 );

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

CurrentCACertKeyValid Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertKeyValid();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 100 );

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

CurrentCACertOCSPLocations Property (SecureBlackbox_CertificateValidator 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 getCurrentCACertOCSPLocations();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 101 );

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

CurrentCACertOCSPNoCheck Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertOCSPNoCheck();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 102 );

Default Value

false

Remarks

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

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

Data Type

Boolean

CurrentCACertOrigin Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertOrigin();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 103 );

Default Value

0

Remarks

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

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

Data Type

Integer

CurrentCACertPolicyIDs Property (SecureBlackbox_CertificateValidator Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCurrentCACertPolicyIDs();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 104 );

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

CurrentCACertPrivateKeyBytes Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertPrivateKeyBytes();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 105 );

Remarks

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

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

Data Type

Byte Array

CurrentCACertPrivateKeyExists Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertPrivateKeyExists();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 106 );

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 CurrentCACertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

Data Type

Boolean

CurrentCACertPrivateKeyExtractable Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getCurrentCACertPrivateKeyExtractable();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 107 );

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

Data Type

Boolean

CurrentCACertPublicKeyBytes Property (SecureBlackbox_CertificateValidator Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCurrentCACertPublicKeyBytes();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 108 );

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

CurrentCACertQualified Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getCurrentCACertQualified();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 109 );

Default Value

false

Remarks

Indicates whether the certificate is qualified.

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

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

Data Type

Boolean

CurrentCACertQualifiedStatements Property (SecureBlackbox_CertificateValidator Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getCurrentCACertQualifiedStatements();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 110 );

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

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

Data Type

Integer

CurrentCACertQualifiers Property (SecureBlackbox_CertificateValidator Class)

A list of qualifiers.

Object Oriented Interface

public function getCurrentCACertQualifiers();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 111 );

Default Value

''

Remarks

A list of qualifiers.

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

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

Data Type

String

CurrentCACertSelfSigned Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertSelfSigned();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 112 );

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

CurrentCACertSerialNumber Property (SecureBlackbox_CertificateValidator Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCurrentCACertSerialNumber();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 113 );

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

CurrentCACertSigAlgorithm Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertSigAlgorithm();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 114 );

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

CurrentCACertSource Property (SecureBlackbox_CertificateValidator 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 getCurrentCACertSource();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 115 );

Default Value

0

Remarks

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

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

Data Type

Integer

CurrentCACertSubject Property (SecureBlackbox_CertificateValidator 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 getCurrentCACertSubject();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 116 );

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

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

Data Type

String

CurrentCACertSubjectAlternativeName Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertSubjectAlternativeName();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 117 );

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 CurrentCACertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

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

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

Data Type

String

CurrentCACertSubjectKeyID Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertSubjectKeyID();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 118 );

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 CurrentCACertSubjectKeyID and CurrentCACertCAKeyID 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

CurrentCACertSubjectRDN Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertSubjectRDN();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 119 );

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

CurrentCACertValid Property (SecureBlackbox_CertificateValidator 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 getCurrentCACertValid();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 120 );

Default Value

false

Remarks

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

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

Data Type

Boolean

CurrentCACertValidFrom Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertValidFrom();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 121 );

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

CurrentCACertValidTo Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCACertValidTo();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 122 );

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

CurrentCertBytes Property (SecureBlackbox_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCurrentCertBytes();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 123 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CurrentCertCA Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getCurrentCertCA();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 124 );

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

CurrentCertCAKeyID Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertCAKeyID();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 125 );

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 CurrentCertSubjectKeyID 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

CurrentCertCertType Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertCertType();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 126 );

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

CurrentCertCRLDistributionPoints Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertCRLDistributionPoints();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 127 );

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

CurrentCertCurve Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertCurve();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 128 );

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

CurrentCertFingerprint Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertFingerprint();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 129 );

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

CurrentCertFriendlyName Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertFriendlyName();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 130 );

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

CurrentCertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertHandle();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 131 );

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

CurrentCertHashAlgorithm Property (SecureBlackbox_CertificateValidator 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 getCurrentCertHashAlgorithm();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 132 );

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 CurrentCertSigAlgorithm 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

CurrentCertIssuer Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertIssuer();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 133 );

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

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

Data Type

String

CurrentCertIssuerRDN Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertIssuerRDN();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 134 );

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

CurrentCertKeyAlgorithm Property (SecureBlackbox_CertificateValidator Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCurrentCertKeyAlgorithm();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 135 );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the CurrentCertKeyBits, CurrentCertCurve, and CurrentCertPublicKeyBytes 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

CurrentCertKeyBits Property (SecureBlackbox_CertificateValidator Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getCurrentCertKeyBits();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 136 );

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 CurrentCertPublicKeyBytes or CurrentCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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

Data Type

Integer

CurrentCertKeyFingerprint Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertKeyFingerprint();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 137 );

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 CurrentCertFingerprint 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

CurrentCertKeyUsage Property (SecureBlackbox_CertificateValidator 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 getCurrentCertKeyUsage();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 138 );

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

CurrentCertKeyValid Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertKeyValid();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 139 );

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

CurrentCertOCSPLocations Property (SecureBlackbox_CertificateValidator 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 getCurrentCertOCSPLocations();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 140 );

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

CurrentCertOCSPNoCheck Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertOCSPNoCheck();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 141 );

Default Value

false

Remarks

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

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

Data Type

Boolean

CurrentCertOrigin Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertOrigin();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 142 );

Default Value

0

Remarks

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

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

Data Type

Integer

CurrentCertPolicyIDs Property (SecureBlackbox_CertificateValidator Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCurrentCertPolicyIDs();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 143 );

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

CurrentCertPrivateKeyBytes Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertPrivateKeyBytes();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 144 );

Remarks

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

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

Data Type

Byte Array

CurrentCertPrivateKeyExists Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertPrivateKeyExists();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 145 );

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 CurrentCertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

Data Type

Boolean

CurrentCertPrivateKeyExtractable Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getCurrentCertPrivateKeyExtractable();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 146 );

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

Data Type

Boolean

CurrentCertPublicKeyBytes Property (SecureBlackbox_CertificateValidator Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCurrentCertPublicKeyBytes();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 147 );

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

CurrentCertQualified Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getCurrentCertQualified();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 148 );

Default Value

false

Remarks

Indicates whether the certificate is qualified.

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

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

Data Type

Boolean

CurrentCertQualifiedStatements Property (SecureBlackbox_CertificateValidator Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getCurrentCertQualifiedStatements();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 149 );

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

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

Data Type

Integer

CurrentCertQualifiers Property (SecureBlackbox_CertificateValidator Class)

A list of qualifiers.

Object Oriented Interface

public function getCurrentCertQualifiers();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 150 );

Default Value

''

Remarks

A list of qualifiers.

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

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

Data Type

String

CurrentCertSelfSigned Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertSelfSigned();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 151 );

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

CurrentCertSerialNumber Property (SecureBlackbox_CertificateValidator Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getCurrentCertSerialNumber();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 152 );

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

CurrentCertSigAlgorithm Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertSigAlgorithm();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 153 );

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

CurrentCertSource Property (SecureBlackbox_CertificateValidator 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 getCurrentCertSource();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 154 );

Default Value

0

Remarks

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

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

Data Type

Integer

CurrentCertSubject Property (SecureBlackbox_CertificateValidator 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 getCurrentCertSubject();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 155 );

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

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

Data Type

String

CurrentCertSubjectAlternativeName Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertSubjectAlternativeName();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 156 );

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 CurrentCertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

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

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

Data Type

String

CurrentCertSubjectKeyID Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertSubjectKeyID();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 157 );

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 CurrentCertSubjectKeyID and CurrentCertCAKeyID 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

CurrentCertSubjectRDN Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertSubjectRDN();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 158 );

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

CurrentCertValid Property (SecureBlackbox_CertificateValidator 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 getCurrentCertValid();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 159 );

Default Value

false

Remarks

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

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

Data Type

Boolean

CurrentCertValidFrom Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertValidFrom();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 160 );

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

CurrentCertValidTo Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getCurrentCertValidTo();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 161 );

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

FIPSMode Property (SecureBlackbox_CertificateValidator Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 162 );


secureblackbox_certificatevalidator_set($res, 162, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

GracePeriod Property (SecureBlackbox_CertificateValidator Class)

Specifies a grace period to apply during certificate validation.

Object Oriented Interface

public function getGracePeriod();


public function setGracePeriod($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 163 );


secureblackbox_certificatevalidator_set($res, 163, $value );

Default Value

0

Remarks

Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.

Data Type

Integer

InterimValidationDetails Property (SecureBlackbox_CertificateValidator Class)

Contains the validation details of the moment.

Object Oriented Interface

public function getInterimValidationDetails();


public function setInterimValidationDetails($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 164 );


secureblackbox_certificatevalidator_set($res, 164, $value );

Default Value

0

Remarks

Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.

Use this property to check the interim validity details mid-flight.

The value of this property is a bit mask of the following options:

This property is not available at design time.

Data Type

Integer

InterimValidationResult Property (SecureBlackbox_CertificateValidator Class)

Contains the validation status of the moment.

Object Oriented Interface

public function getInterimValidationResult();


public function setInterimValidationResult($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 165 );


secureblackbox_certificatevalidator_set($res, 165, $value );

Default Value

0

Remarks

Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.

Use this property to check the interim validity status mid-flight.

This property is not available at design time.

Data Type

Integer

KnownCertCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 166 );


secureblackbox_certificatevalidator_set($res, 166, $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_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 167 , $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_CertificateValidator 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_certificatevalidator_get($res, 175 , $knowncertindex);


secureblackbox_certificatevalidator_set($res, 175, $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_CertificateValidator Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 206 );


secureblackbox_certificatevalidator_set($res, 206, $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_CertificateValidator Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 207 , $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_CertificateValidator 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_certificatevalidator_get($res, 210 , $knowncrlindex);


secureblackbox_certificatevalidator_set($res, 210, $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_CertificateValidator Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 219 );


secureblackbox_certificatevalidator_set($res, 219, $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_CertificateValidator Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 220 , $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_CertificateValidator 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_certificatevalidator_get($res, 222 , $knownocspindex);


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

MaxValidationTime Property (SecureBlackbox_CertificateValidator Class)

Specifies the maximum time the validation process may take.

Object Oriented Interface

public function getMaxValidationTime();


public function setMaxValidationTime($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 229 );


secureblackbox_certificatevalidator_set($res, 229, $value );

Default Value

0

Remarks

Use this property to limit the amount of time available for the validator to carry out the validation. If the validation process exceeds this time, it is terminated and the validation error is returned.

Data Type

Integer

OfflineMode Property (SecureBlackbox_CertificateValidator Class)

Switches the class to offline mode.

Object Oriented Interface

public function getOfflineMode();


public function setOfflineMode($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 230 );


secureblackbox_certificatevalidator_set($res, 230, $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

ProxyAddress Property (SecureBlackbox_CertificateValidator Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 231 );


secureblackbox_certificatevalidator_set($res, 231, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_CertificateValidator Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 232 );


secureblackbox_certificatevalidator_set($res, 232, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_CertificateValidator Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 233 );


secureblackbox_certificatevalidator_set($res, 233, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_CertificateValidator Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 234 );


secureblackbox_certificatevalidator_set($res, 234, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_CertificateValidator Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 235 );


secureblackbox_certificatevalidator_set($res, 235, $value );

Default Value

0

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_CertificateValidator Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 236 );


secureblackbox_certificatevalidator_set($res, 236, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 237 );


secureblackbox_certificatevalidator_set($res, 237, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_CertificateValidator 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_certificatevalidator_get($res, 238 );


secureblackbox_certificatevalidator_set($res, 238, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_CertificateValidator 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_certificatevalidator_get($res, 239 );


secureblackbox_certificatevalidator_set($res, 239, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_CertificateValidator Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 240 );


secureblackbox_certificatevalidator_set($res, 240, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

QualifiedInfoAddress Property (SecureBlackbox_CertificateValidator Class)

Contains the address of the TSL provider.

Object Oriented Interface

public function getQualifiedInfoAddress();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 241 );

Default Value

''

Remarks

Contains the address of the TSL provider.

Use this property to check the address of the TSL provider.

This property is read-only.

Data Type

String

QualifiedInfoCustomTrustedLists Property (SecureBlackbox_CertificateValidator Class)

The list of custom TrustedLists to use.

Object Oriented Interface

public function getQualifiedInfoCustomTrustedLists();


public function setQualifiedInfoCustomTrustedLists($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 242 );


secureblackbox_certificatevalidator_set($res, 242, $value );

Default Value

''

Remarks

The list of custom TrustedLists to use.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

Data Type

String

QualifiedInfoDownloadLog Property (SecureBlackbox_CertificateValidator Class)

Contains the TLS download log.

Object Oriented Interface

public function getQualifiedInfoDownloadLog();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 243 );

Default Value

''

Remarks

Contains the TLS download log.

This log may be useful in investigating TSL retrieval failures.

This property is read-only.

Data Type

String

QualifiedInfoInformationURI Property (SecureBlackbox_CertificateValidator Class)

Contains the URI of the provider information.

Object Oriented Interface

public function getQualifiedInfoInformationURI();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 244 );

Default Value

''

Remarks

Contains the URI of the provider information.

Use this property to get the URI of the TSL provider information.

This property is read-only.

Data Type

String

QualifiedInfoLanguages Property (SecureBlackbox_CertificateValidator Class)

The preferred language(s) for TSL data.

Object Oriented Interface

public function getQualifiedInfoLanguages();


public function setQualifiedInfoLanguages($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 245 );


secureblackbox_certificatevalidator_set($res, 245, $value );

Default Value

''

Remarks

The preferred language(s) for TSL data.

Use this property to pass a list of languages, in order of preference, which will be considered when returning TSL properties. Many trust providers return qualified information in several languages. By tuning up this property you can choose a selection of preferred languages (such as "it,en") in which you would like to read the qualified details.

Data Type

String

QualifiedInfoNextUpdate Property (SecureBlackbox_CertificateValidator Class)

Returns the next update date and time of the TSL.

Object Oriented Interface

public function getQualifiedInfoNextUpdate();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 246 );

Default Value

''

Remarks

Returns the next update date and time of the TSL.

Use this property to check the next update value for the TSL.

This property is read-only.

Data Type

String

QualifiedInfoProvider Property (SecureBlackbox_CertificateValidator Class)

Contains the name of the TSL provider.

Object Oriented Interface

public function getQualifiedInfoProvider();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 247 );

Default Value

''

Remarks

Contains the name of the TSL provider.

Use this property to check the name of the TSL provider.

This property is read-only.

Data Type

String

QualifiedInfoQualified Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getQualifiedInfoQualified();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 248 );

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to true if the certificate is confirmed by a TSL to be qualified.

This property is read-only.

Data Type

Boolean

QualifiedInfoQualifiers Property (SecureBlackbox_CertificateValidator Class)

A list of qualifiers.

Object Oriented Interface

public function getQualifiedInfoQualifiers();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 249 );

Default Value

''

Remarks

A list of qualifiers.

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

This property is read-only.

Data Type

String

QualifiedInfoServiceName Property (SecureBlackbox_CertificateValidator Class)

Contains the name of the TSL service.

Object Oriented Interface

public function getQualifiedInfoServiceName();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 250 );

Default Value

''

Remarks

Contains the name of the TSL service.

Use this property to check the name of the TSL service.

This property is read-only.

Data Type

String

QualifiedInfoServiceTypeId Property (SecureBlackbox_CertificateValidator Class)

Contains the TSL service type identifier.

Object Oriented Interface

public function getQualifiedInfoServiceTypeId();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 251 );

Default Value

''

Remarks

Contains the TSL service type identifier.

Use this property to check the service type identifier of the TSL.

This property is read-only.

Data Type

String

QualifiedInfoSource Property (SecureBlackbox_CertificateValidator Class)

The source of qualified information.

Object Oriented Interface

public function getQualifiedInfoSource();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 252 );

Default Value

0

Remarks

The source of qualified information.

Available options:

Use the Source property to establish the origin of the qualified information.

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

Data Type

Integer

QualifiedInfoStatus Property (SecureBlackbox_CertificateValidator Class)

Indicates a qualified electronic signature.

Object Oriented Interface

public function getQualifiedInfoStatus();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 253 );

Default Value

0

Remarks

Indicates a qualified electronic signature.

Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate.

Adjust UseDefaultTSLs property and/or CustomTSLs property before validating the signature/certificate to properly obtain TSP (Trust Service Provider) service status. Use Qualified* and TSL* config properties to obtain extended information.

The following qualified statuses are supported:

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

Data Type

Integer

QualifiedInfoTradeName Property (SecureBlackbox_CertificateValidator Class)

Contains the trade name of the TSL provider.

Object Oriented Interface

public function getQualifiedInfoTradeName();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 254 );

Default Value

''

Remarks

Contains the trade name of the TSL provider.

Use this property to check the trade name of the TSL provider.

This property is read-only.

Data Type

String

QualifiedInfoTrusted Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the certificate is trusted.

Object Oriented Interface

public function getQualifiedInfoTrusted();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 255 );

Default Value

false

Remarks

Indicates whether the certificate is trusted.

This property is set to true if the certificate is confirmed by a TSL to be trusted.

This property is read-only.

Data Type

Boolean

QualifiedInfoUseDefaultTrustedLists Property (SecureBlackbox_CertificateValidator Class)

Use this setting to enable or disable the use of the default TrustedLists.

Object Oriented Interface

public function getQualifiedInfoUseDefaultTrustedLists();


public function setQualifiedInfoUseDefaultTrustedLists($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 256 );


secureblackbox_certificatevalidator_set($res, 256, $value );

Default Value

true

Remarks

Use this setting to enable or disable the use of the default TrustedLists.

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

The following default TSLs are used: EU (European Union) TSL.

Data Type

Boolean

QualifiedInfoValidationLog Property (SecureBlackbox_CertificateValidator Class)

Contains the TLS validation log.

Object Oriented Interface

public function getQualifiedInfoValidationLog();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 257 );

Default Value

''

Remarks

Contains the TLS validation log.

This log may be useful in investigating TSL validation failures.

This property is read-only.

Data Type

String

QualifiedInfoXML Property (SecureBlackbox_CertificateValidator Class)

Contains the XML of the TSL.

Object Oriented Interface

public function getQualifiedInfoXML();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 258 );

Default Value

''

Remarks

Contains the XML of the TSL.

Use this property to obtain the original body of the TSL in XML format.

This property is read-only.

Data Type

String

RevocationCheck Property (SecureBlackbox_CertificateValidator 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_certificatevalidator_get($res, 259 );


secureblackbox_certificatevalidator_set($res, 259, $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

SocketDNSMode Property (SecureBlackbox_CertificateValidator 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_certificatevalidator_get($res, 260 );


secureblackbox_certificatevalidator_set($res, 260, $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_CertificateValidator 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_certificatevalidator_get($res, 261 );


secureblackbox_certificatevalidator_set($res, 261, $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_CertificateValidator Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 262 );


secureblackbox_certificatevalidator_set($res, 262, $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_CertificateValidator 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_certificatevalidator_get($res, 263 );


secureblackbox_certificatevalidator_set($res, 263, $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_CertificateValidator Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 264 );


secureblackbox_certificatevalidator_set($res, 264, $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_CertificateValidator 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_certificatevalidator_get($res, 265 );


secureblackbox_certificatevalidator_set($res, 265, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_CertificateValidator Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 266 );


secureblackbox_certificatevalidator_set($res, 266, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_CertificateValidator Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 267 );


secureblackbox_certificatevalidator_set($res, 267, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_CertificateValidator 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_certificatevalidator_get($res, 268 );


secureblackbox_certificatevalidator_set($res, 268, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_CertificateValidator 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_certificatevalidator_get($res, 269 );


secureblackbox_certificatevalidator_set($res, 269, $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_CertificateValidator Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 270 );


secureblackbox_certificatevalidator_set($res, 270, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSClientCertCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the TLSClientCert arrays.

Object Oriented Interface

public function getTLSClientCertCount();


public function setTLSClientCertCount($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 271 );


secureblackbox_certificatevalidator_set($res, 271, $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_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSClientCertBytes($tlsclientcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 272 , $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_CertificateValidator 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_certificatevalidator_get($res, 280 , $tlsclientcertindex);


secureblackbox_certificatevalidator_set($res, 280, $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_CertificateValidator Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 311 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 312 , $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_CertificateValidator Class)

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

Object Oriented Interface

public function getTLSServerCertFingerprint($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 318 , $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_CertificateValidator 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_certificatevalidator_get($res, 320 , $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_CertificateValidator Class)

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

Object Oriented Interface

public function getTLSServerCertIssuer($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 322 , $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_CertificateValidator Class)

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

Object Oriented Interface

public function getTLSServerCertIssuerRDN($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 323 , $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_CertificateValidator Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getTLSServerCertKeyAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 324 , $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_CertificateValidator Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getTLSServerCertKeyBits($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 325 , $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_CertificateValidator 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_certificatevalidator_get($res, 327 , $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_CertificateValidator 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_certificatevalidator_get($res, 340 , $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_CertificateValidator Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getTLSServerCertSerialNumber($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 341 , $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_CertificateValidator Class)

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

Object Oriented Interface

public function getTLSServerCertSigAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 342 , $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_CertificateValidator 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_certificatevalidator_get($res, 344 , $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_CertificateValidator Class)

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

Object Oriented Interface

public function getTLSServerCertSubjectRDN($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 347 , $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_CertificateValidator Class)

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

Object Oriented Interface

public function getTLSServerCertValidFrom($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 349 , $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_CertificateValidator Class)

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

Object Oriented Interface

public function getTLSServerCertValidTo($tlsservercertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 350 , $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_CertificateValidator 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_certificatevalidator_get($res, 351 );


secureblackbox_certificatevalidator_set($res, 351, $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_CertificateValidator Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 352 );


secureblackbox_certificatevalidator_set($res, 352, $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_CertificateValidator Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 353 );


secureblackbox_certificatevalidator_set($res, 353, $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_CertificateValidator Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();


public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 354 );


secureblackbox_certificatevalidator_set($res, 354, $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_CertificateValidator Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 355 );


secureblackbox_certificatevalidator_set($res, 355, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_CertificateValidator Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 356 );


secureblackbox_certificatevalidator_set($res, 356, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_CertificateValidator 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_certificatevalidator_get($res, 357 );


secureblackbox_certificatevalidator_set($res, 357, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_CertificateValidator 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_certificatevalidator_get($res, 358 );


secureblackbox_certificatevalidator_set($res, 358, $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_CertificateValidator 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_certificatevalidator_get($res, 359 );


secureblackbox_certificatevalidator_set($res, 359, $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_CertificateValidator Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 360 );


secureblackbox_certificatevalidator_set($res, 360, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_CertificateValidator Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 361 );


secureblackbox_certificatevalidator_set($res, 361, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 362 );


secureblackbox_certificatevalidator_set($res, 362, $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_CertificateValidator 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_certificatevalidator_get($res, 363 );


secureblackbox_certificatevalidator_set($res, 363, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_CertificateValidator Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 364 );


secureblackbox_certificatevalidator_set($res, 364, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_CertificateValidator 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_certificatevalidator_get($res, 365 );


secureblackbox_certificatevalidator_set($res, 365, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_CertificateValidator Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 366 );


secureblackbox_certificatevalidator_set($res, 366, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_CertificateValidator Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 367 );


secureblackbox_certificatevalidator_set($res, 367, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 368 );


secureblackbox_certificatevalidator_set($res, 368, $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_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 369 , $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_CertificateValidator 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_certificatevalidator_get($res, 377 , $trustedcertindex);


secureblackbox_certificatevalidator_set($res, 377, $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

UsedCertCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the UsedCert arrays.

Object Oriented Interface

public function getUsedCertCount();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 408 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UsedCertBytes
• UsedCertCA
• UsedCertCAKeyID
• UsedCertCertType
• UsedCertCRLDistributionPoints
• UsedCertCurve
• UsedCertFingerprint
• UsedCertFriendlyName
• UsedCertHandle
• UsedCertHashAlgorithm
• UsedCertIssuer
• UsedCertIssuerRDN
• UsedCertKeyAlgorithm
• UsedCertKeyBits
• UsedCertKeyFingerprint
• UsedCertKeyUsage
• UsedCertKeyValid
• UsedCertOCSPLocations
• UsedCertOCSPNoCheck
• UsedCertOrigin
• UsedCertPolicyIDs
• UsedCertPrivateKeyBytes
• UsedCertPrivateKeyExists
• UsedCertPrivateKeyExtractable
• UsedCertPublicKeyBytes
• UsedCertQualified
• UsedCertQualifiedStatements
• UsedCertQualifiers
• UsedCertSelfSigned
• UsedCertSerialNumber
• UsedCertSigAlgorithm
• UsedCertSource
• UsedCertSubject
• UsedCertSubjectAlternativeName
• UsedCertSubjectKeyID
• UsedCertSubjectRDN
• UsedCertValid
• UsedCertValidFrom
• UsedCertValidTo

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

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

Data Type

Integer

UsedCertBytes Property (SecureBlackbox_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getUsedCertBytes($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 409 , $usedcertindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

UsedCertCA Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getUsedCertCA($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 410 , $usedcertindex);

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

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

Data Type

Boolean

UsedCertCAKeyID Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertCAKeyID($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 411 , $usedcertindex);

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 UsedCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

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

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

Data Type

Byte Array

UsedCertCertType Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertCertType($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 412 , $usedcertindex);

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

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

Data Type

Integer

UsedCertCRLDistributionPoints Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertCRLDistributionPoints($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 413 , $usedcertindex);

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

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

Data Type

String

UsedCertCurve Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertCurve($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 414 , $usedcertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedCertFingerprint Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertFingerprint($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 415 , $usedcertindex);

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

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

Data Type

String

UsedCertFriendlyName Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertFriendlyName($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 416 , $usedcertindex);

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

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

Data Type

String

UsedCertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertHandle($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 417 , $usedcertindex);

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

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

Data Type

Long64

UsedCertHashAlgorithm Property (SecureBlackbox_CertificateValidator 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 getUsedCertHashAlgorithm($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 418 , $usedcertindex);

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 UsedCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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

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

Data Type

String

UsedCertIssuer Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertIssuer($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 419 , $usedcertindex);

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

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

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

Data Type

String

UsedCertIssuerRDN Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertIssuerRDN($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 420 , $usedcertindex);

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

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

Data Type

String

UsedCertKeyAlgorithm Property (SecureBlackbox_CertificateValidator Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getUsedCertKeyAlgorithm($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 421 , $usedcertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the UsedCertKeyBits, UsedCertCurve, and UsedCertPublicKeyBytes properties to get more details about the key the certificate contains.

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

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

Data Type

String

UsedCertKeyBits Property (SecureBlackbox_CertificateValidator Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getUsedCertKeyBits($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 422 , $usedcertindex);

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 UsedCertPublicKeyBytes or UsedCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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

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

Data Type

Integer

UsedCertKeyFingerprint Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertKeyFingerprint($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 423 , $usedcertindex);

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 UsedCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

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

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

Data Type

String

UsedCertKeyUsage Property (SecureBlackbox_CertificateValidator 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 getUsedCertKeyUsage($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 424 , $usedcertindex);

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

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

Data Type

Integer

UsedCertKeyValid Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertKeyValid($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 425 , $usedcertindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

UsedCertOCSPLocations Property (SecureBlackbox_CertificateValidator 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 getUsedCertOCSPLocations($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 426 , $usedcertindex);

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

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

Data Type

String

UsedCertOCSPNoCheck Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertOCSPNoCheck($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 427 , $usedcertindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

UsedCertOrigin Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertOrigin($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 428 , $usedcertindex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

UsedCertPolicyIDs Property (SecureBlackbox_CertificateValidator Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getUsedCertPolicyIDs($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 429 , $usedcertindex);

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

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

Data Type

String

UsedCertPrivateKeyBytes Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertPrivateKeyBytes($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 430 , $usedcertindex);

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

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

Data Type

Byte Array

UsedCertPrivateKeyExists Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertPrivateKeyExists($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 431 , $usedcertindex);

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

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

Data Type

Boolean

UsedCertPrivateKeyExtractable Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getUsedCertPrivateKeyExtractable($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 432 , $usedcertindex);

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

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

Data Type

Boolean

UsedCertPublicKeyBytes Property (SecureBlackbox_CertificateValidator Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getUsedCertPublicKeyBytes($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 433 , $usedcertindex);

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

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

Data Type

Byte Array

UsedCertQualified Property (SecureBlackbox_CertificateValidator Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getUsedCertQualified($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 434 , $usedcertindex);

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

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

Data Type

Boolean

UsedCertQualifiedStatements Property (SecureBlackbox_CertificateValidator Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getUsedCertQualifiedStatements($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 435 , $usedcertindex);

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

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

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

Data Type

Integer

UsedCertQualifiers Property (SecureBlackbox_CertificateValidator Class)

A list of qualifiers.

Object Oriented Interface

public function getUsedCertQualifiers($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 436 , $usedcertindex);

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

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

Data Type

String

UsedCertSelfSigned Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertSelfSigned($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 437 , $usedcertindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

UsedCertSerialNumber Property (SecureBlackbox_CertificateValidator Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getUsedCertSerialNumber($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 438 , $usedcertindex);

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

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

Data Type

Byte Array

UsedCertSigAlgorithm Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertSigAlgorithm($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 439 , $usedcertindex);

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

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

Data Type

String

UsedCertSource Property (SecureBlackbox_CertificateValidator 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 getUsedCertSource($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 440 , $usedcertindex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

UsedCertSubject Property (SecureBlackbox_CertificateValidator 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 getUsedCertSubject($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 441 , $usedcertindex);

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

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

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

Data Type

String

UsedCertSubjectAlternativeName Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertSubjectAlternativeName($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 442 , $usedcertindex);

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

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

Data Type

String

UsedCertSubjectKeyID Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertSubjectKeyID($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 443 , $usedcertindex);

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 UsedCertSubjectKeyID and UsedCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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

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

Data Type

Byte Array

UsedCertSubjectRDN Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertSubjectRDN($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 444 , $usedcertindex);

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

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

Data Type

String

UsedCertValid Property (SecureBlackbox_CertificateValidator 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 getUsedCertValid($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 445 , $usedcertindex);

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

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

Data Type

Boolean

UsedCertValidFrom Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertValidFrom($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 446 , $usedcertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedCertValidTo Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCertValidTo($usedcertindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 447 , $usedcertindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedCRLCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the UsedCRL arrays.

Object Oriented Interface

public function getUsedCRLCount();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 448 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UsedCRLBytes
• UsedCRLHandle
• UsedCRLIssuer
• UsedCRLIssuerRDN
• UsedCRLLocation
• UsedCRLNextUpdate
• UsedCRLSource
• UsedCRLThisUpdate

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

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

Data Type

Integer

UsedCRLBytes Property (SecureBlackbox_CertificateValidator Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getUsedCRLBytes($usedcrlindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 449 , $usedcrlindex);

Remarks

Returns the raw CRL data in DER format.

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

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

Data Type

Byte Array

UsedCRLHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCRLHandle($usedcrlindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 452 , $usedcrlindex);

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

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

Data Type

Long64

UsedCRLIssuer Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCRLIssuer($usedcrlindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 453 , $usedcrlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedCRLIssuerRDN Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCRLIssuerRDN($usedcrlindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 454 , $usedcrlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedCRLLocation Property (SecureBlackbox_CertificateValidator Class)

The URL that the CRL was downloaded from.

Object Oriented Interface

public function getUsedCRLLocation($usedcrlindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 455 , $usedcrlindex);

Default Value

''

Remarks

The URL that the CRL was downloaded from.

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

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

Data Type

String

UsedCRLNextUpdate Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCRLNextUpdate($usedcrlindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 456 , $usedcrlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedCRLSource Property (SecureBlackbox_CertificateValidator 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 getUsedCRLSource($usedcrlindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 458 , $usedcrlindex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

UsedCRLThisUpdate Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedCRLThisUpdate($usedcrlindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 460 , $usedcrlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedOCSPCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the UsedOCSP arrays.

Object Oriented Interface

public function getUsedOCSPCount();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 461 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UsedOCSPBytes
• UsedOCSPHandle
• UsedOCSPIssuer
• UsedOCSPIssuerRDN
• UsedOCSPLocation
• UsedOCSPProducedAt
• UsedOCSPSource

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

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

Data Type

Integer

UsedOCSPBytes Property (SecureBlackbox_CertificateValidator Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getUsedOCSPBytes($usedocspindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 462 , $usedocspindex);

Remarks

A buffer containing the raw OCSP response data.

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

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

Data Type

Byte Array

UsedOCSPHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedOCSPHandle($usedocspindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 464 , $usedocspindex);

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

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

Data Type

Long64

UsedOCSPIssuer Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedOCSPIssuer($usedocspindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 465 , $usedocspindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedOCSPIssuerRDN Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedOCSPIssuerRDN($usedocspindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 466 , $usedocspindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedOCSPLocation Property (SecureBlackbox_CertificateValidator Class)

The location of the OCSP responder.

Object Oriented Interface

public function getUsedOCSPLocation($usedocspindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 467 , $usedocspindex);

Default Value

''

Remarks

The location of the OCSP responder.

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

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

Data Type

String

UsedOCSPProducedAt Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getUsedOCSPProducedAt($usedocspindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 468 , $usedocspindex);

Default Value

''

Remarks

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

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

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

Data Type

String

UsedOCSPSource Property (SecureBlackbox_CertificateValidator 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 getUsedOCSPSource($usedocspindex);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 470 , $usedocspindex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

UseSystemCertificates Property (SecureBlackbox_CertificateValidator Class)

Enables or disables the use of the system certificates.

Object Oriented Interface

public function getUseSystemCertificates();


public function setUseSystemCertificates($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 471 );


secureblackbox_certificatevalidator_set($res, 471, $value );

Default Value

false

Remarks

Use this property to tell the validator to use (or not to use) the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

Data Type

Boolean

ValidationLog Property (SecureBlackbox_CertificateValidator Class)

Contains the complete log of the certificate validation routine.

Object Oriented Interface

public function getValidationLog();

Procedural Interface

secureblackbox_certificatevalidator_get($res, 472 );

Default Value

''

Remarks

Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.

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

Data Type

String

ValidationMoment Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function getValidationMoment();


public function setValidationMoment($value);

Procedural Interface

secureblackbox_certificatevalidator_get($res, 473 );


secureblackbox_certificatevalidator_set($res, 473, $value );

Default Value

''

Remarks

Use this property to specify the moment in time at which chain validity should be established. The time is in UTC. Leave the setting empty to stick to the current moment.

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

Data Type

String

Config Method (SecureBlackbox_CertificateValidator Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_certificatevalidator_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_CertificateValidator Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

GetQualifiedStatus Method (SecureBlackbox_CertificateValidator Class)

Obtains the qualified information for Certificate .

Object Oriented Interface

public function doGetQualifiedStatus();

Procedural Interface

secureblackbox_certificatevalidator_do_getqualifiedstatus($res);

Remarks

Use this method to obtain a fresh qualified status for the certificate.

GetTrustedListProperty Method (SecureBlackbox_CertificateValidator Class)

Returns a specific TrustedList property.

Object Oriented Interface

public function doGetTrustedListProperty($propname, $language);

Procedural Interface

secureblackbox_certificatevalidator_do_gettrustedlistproperty($res, $propname, $language);

Remarks

Use this method to obtain the value of a specific TrustedList property. Use the Language parameter to specify the language identifier (e.g. it) in which you would like to have the property returned (if supported by the TrustedList). Leave the parameter empty to return the value in the default language.

Please find a list of common TrustedList properties below:

• VersionIdentifier
• SequenceNumber
• Type
• SchemeName
• SchemeOperatorName
• SchemeOperatorAddress
• SchemeInformationURI
• StatusDeterminationApproach
• SchemeTypeCommunityRules
• SchemeTerritory
• Policies
• LegalNotices
• HistoricalInformationPeriod
• ListIssueDateTime
• NextUpdate
• DistributionPoints
• SchemeExtensions
• TSPXML
• TSPName
• TSPTradeName
• TSPInformationURI
• TSPAddress
• TSPInformationExtensions
• TSPServiceXML
• TSPServiceTypeIdentifier
• TSPServiceName
• TSPServiceStatus
• TSPServiceStatusStartingTime
• TSPSchemeServiceDefinitionURI
• TSPServiceDefinitionURI
• TSPServiceSupplyPoints
• TSPServiceInformationExtensions
• TSPServiceQualifiers
• TSPAdditionalServiceInformation
• TSPHistoryInstance
• TSPHistoryInstanceXML
• TSPHistoryInstanceServiceTypeIdentifier
• TSPHistoryInstanceServiceName
• TSPHistoryInstanceServiceStatus
• TSPHistoryInstanceServiceStatusStartingTime
• TSPHistoryInstanceServiceInformationExtensions
• TSPHistoryInstanceQualifiers
• TSPHistoryInstanceAdditionalServiceInformation

RefreshCache Method (SecureBlackbox_CertificateValidator Class)

Refreshes the certificate cache.

Object Oriented Interface

public function doRefreshCache();

Procedural Interface

secureblackbox_certificatevalidator_do_refreshcache($res);

Remarks

Use this method to remove obsolete information from the validation cache (only makes sense if CacheValidationResults is on).

Reset Method (SecureBlackbox_CertificateValidator Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_certificatevalidator_do_reset($res);

Remarks

Reset is a generic method available in every class.

ResetCache Method (SecureBlackbox_CertificateValidator Class)

Clears all data contained in the validation cache.

Object Oriented Interface

public function doResetCache();

Procedural Interface

secureblackbox_certificatevalidator_do_resetcache($res);

Remarks

Use this method to clear the validation cache (only makes sense if CacheValidationResults is on).

Terminate Method (SecureBlackbox_CertificateValidator Class)

Terminates the validation process.

Object Oriented Interface

public function doTerminate();

Procedural Interface

secureblackbox_certificatevalidator_do_terminate($res);

Remarks

Call this method if you would like to stop the validation process.

Validate Method (SecureBlackbox_CertificateValidator Class)

Validates the certificate chain.

Object Oriented Interface

public function doValidate();

Procedural Interface

secureblackbox_certificatevalidator_do_validate($res);

Remarks

Use this method to validate the certificate chain that starts with Certificate.

The chain validation is a multi-step process which includes validation of each certificate in the chain up to the trusted anchor. The ultimate goal of this process is to establish the integrity of the chain and its trustworthiness.

Depending on the component tuneup, the validation process may differ drastically, even for the same certificate: it may be more or less rigorous, may include or exclude revocation checks, and may be more or less tolerant to minor chain issues.

When this process is completed, the final decision on the validity of the checked certificate is returned from this method, and also saved in ChainValidationResult property. Another property, ChainValidationDetails, provides insight into the reasons that contributed to that decision. Use ValidationLog to get a detailed step-by-step log of the entire validation process.

ValidateForSMIME Method (SecureBlackbox_CertificateValidator Class)

Validates an e-mail signing certificate.

Object Oriented Interface

public function doValidateForSMIME($emailaddress);

Procedural Interface

secureblackbox_certificatevalidator_do_validateforsmime($res, $emailaddress);

Remarks

Use this method to validate an e-mail security certificate.

This is a variant of Validate method that performs some additional e-mail specific checks, imposed by e-mail certificate rules. This method returns the overall chain validation result.

ValidateForSSL Method (SecureBlackbox_CertificateValidator Class)

Validates a server-side SSL/TLS certificate.

Object Oriented Interface

public function doValidateForSSL($url, $ipaddress);

Procedural Interface

secureblackbox_certificatevalidator_do_validateforssl($res, $url, $ipaddress);

Remarks

Use this method to validate a server-side SSL/TLS certificate.

This is a variant of Validate method that performs some additional TLS-specific checks. It is important that you provide a correct URL or IPAddress for the check to return a reasonable and justified result.

This method returns the overall result of the chain validation.

AfterCertificateProcessing Event (SecureBlackbox_CertificateValidator Class)

Marks the end of a single certificate processing step.

Object Oriented Interface

public function fireAfterCertificateProcessing($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 1, array($this, 'fireAfterCertificateProcessing'));

Parameter List

 'cert'
 'validity'
 'validationdetails'

Remarks

This event is fired when the class has finished processing Cert, and returns its Validity status and ValidationDetails.

'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via AfterCertificateValidation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.

You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via InterimValidationResult and InterimValidationDetails properties.

Validity status:

Validation details:

AfterCertificateValidation Event (SecureBlackbox_CertificateValidator Class)

Marks the end of a single certificate validation step.

Object Oriented Interface

public function fireAfterCertificateValidation($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 2, array($this, 'fireAfterCertificateValidation'));

Parameter List

 'cert'
 'cacert'
 'validity'
 'validationdetails'

Remarks

This event is fired when the class has finished validation of Cert with CACert, and returns its Validity status and ValidationDetails.

'Validation', in this context, means a single validation of a certificate with its CA certificate. For certificates with multiple CAs, validations are grouped into 'processings.' Each processing, therefore, is a set of validations of the same certificate with all its CAs.

You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via InterimValidationResult and InterimValidationDetails properties.

Validity status:

Validation details:

BeforeCACertificateDownload Event (SecureBlackbox_CertificateValidator Class)

Fires when a CA certificate is about to be downloaded.

Object Oriented Interface

public function fireBeforeCACertificateDownload($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 3, array($this, 'fireBeforeCACertificateDownload'));

Parameter List

 'cert'
 'location'

Remarks

This event is fired when a CA certificate that is needed to validate Cert is about to be downloaded from Location.

BeforeCertificateProcessing Event (SecureBlackbox_CertificateValidator Class)

Reports the start of certificate processing.

Object Oriented Interface

public function fireBeforeCertificateProcessing($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 4, array($this, 'fireBeforeCertificateProcessing'));

Parameter List

 'cert'
 'validity'
 'validationdetails'

Remarks

This event is fired when the class is about to start the processing of Cert.

'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via AfterCertificateValidation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.

The firing of AfterCertificateProcessing marks the end of the certificate processing.

Validity and ValidationDetails specify the current validation status.

Validity status:

Validation details:

BeforeCertificateValidation Event (SecureBlackbox_CertificateValidator Class)

Reports the start of certificate validation.

Object Oriented Interface

public function fireBeforeCertificateValidation($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 5, array($this, 'fireBeforeCertificateValidation'));

Parameter List

 'cert'
 'cacert'

Remarks

This event is fired when the class is about to start validating Cert with CACert.

A 'validation' is a single step of validating a certificate with its CA certificate. A row of consecutive validations of the same certificate with different CAs are grouped into 'processings.'

The firing of AfterCertificateValidation marks the end of the certificate validation step.

BeforeCRLDownload Event (SecureBlackbox_CertificateValidator Class)

Fires when a CRL is about to be downloaded.

Object Oriented Interface

public function fireBeforeCRLDownload($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 6, array($this, 'fireBeforeCRLDownload'));

Parameter List

 'cert'
 'cacert'
 'location'

Remarks

This event is fired when a CRL (Certificate Revocation List) needed to validate Cert is going to be downloaded from Location.

BeforeOCSPDownload Event (SecureBlackbox_CertificateValidator Class)

Fires when a certificate's OCSP status is about to be requested.

Object Oriented Interface

public function fireBeforeOCSPDownload($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 7, array($this, 'fireBeforeOCSPDownload'));

Parameter List

 'cert'
 'cacert'
 'location'

Remarks

This event is fired when the validator is about to request a fresh revocation status from an OCSP responder.

CACertificateDownloaded Event (SecureBlackbox_CertificateValidator Class)

Marks the success of a certificate download.

Object Oriented Interface

public function fireCACertificateDownloaded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 8, array($this, 'fireCACertificateDownloaded'));

Parameter List

 'cert'
 'location'

Remarks

This event is fired when a CA certificate has been successfully downloaded from Location. This event is preceded with BeforeCACertificateDownload event.

CACertificateNeeded Event (SecureBlackbox_CertificateValidator Class)

Requests a missing certificate from the user.

Object Oriented Interface

public function fireCACertificateNeeded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 9, array($this, 'fireCACertificateNeeded'));

Parameter List

 'cert'

Remarks

This event is fired when a CA certificate that is needed to validate Cert is not found at any of the available locations. If you have access to the missing certificate, please add it to the KnownCertificates collection to make it available to the validator.

When this event fires, the CurrentCertificate property is assigned with the certificate being validated. It is the CA that issued that certificate that the validator is looking for.

CRLDownloaded Event (SecureBlackbox_CertificateValidator Class)

Marks the success of a CRL download.

Object Oriented Interface

public function fireCRLDownloaded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 10, array($this, 'fireCRLDownloaded'));

Parameter List

 'cert'
 'cacert'
 'location'

Remarks

This event is fired when a CRL containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with BeforeCRLDownload event.

CRLNeeded Event (SecureBlackbox_CertificateValidator Class)

Requests a missing CRL from the user.

Object Oriented Interface

public function fireCRLNeeded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 11, array($this, 'fireCRLNeeded'));

Parameter List

 'cert'
 'cacert'

Remarks

This event is fired when a CRL that is needed to validate Cert is not found at any of the available locations. If you have access to the missing CRL, please add it to the KnownCRLs collection to make it available to the validator.

When this event fires, the CurrentCertificate and CurrentCACertificate properties are assigned with the certificate being validated and its issuer certificate.

Error Event (SecureBlackbox_CertificateValidator Class)

Information about errors during certificate validation.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 12, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during certificate processing or online information retrieval.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the corresponding section.

Notification Event (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 13, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

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

OCSPDownloaded Event (SecureBlackbox_CertificateValidator Class)

Marks the success of an OCSP request.

Object Oriented Interface

public function fireOCSPDownloaded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 14, array($this, 'fireOCSPDownloaded'));

Parameter List

 'cert'
 'cacert'
 'location'

Remarks

This event is fired when an OCSP response containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with BeforeOCSPDownload event.

TLSCertNeeded Event (SecureBlackbox_CertificateValidator Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 15, 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_CertificateValidator 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_certificatevalidator_register_callback($res, 16, 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_CertificateValidator Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 17, 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_CertificateValidator Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 18, 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_CertificateValidator Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 19, 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 (CertificateValidator 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.

CertificateValidator Config Settings

TrustedLists Config Settings

Base Config Settings

Trappable Errors (CertificateValidator Class)

CertificateValidator Errors