CertificateValidator Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TsbxCertificateValidator

Remarks

This is a powerful and configurable component 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 component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

BlockedCertCount Property (CertificateValidator Component)

The number of records in the BlockedCert arrays.

Syntax

__property int BlockedCertCount = { read=FBlockedCertCount, write=FSetBlockedCertCount };

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 (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray BlockedCertBytes[int BlockedCertIndex] = { read=FBlockedCertBytes };

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 (CertificateValidator Component)

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

Syntax

__property __int64 BlockedCertHandle[int BlockedCertIndex] = { read=FBlockedCertHandle, write=FSetBlockedCertHandle };

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 (CertificateValidator Component)

Enables or disables validation result caching.

Syntax

__property bool CacheValidationResults = { read=FCacheValidationResults, write=FSetCacheValidationResults };

Default Value

false

Remarks

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

Data Type

Boolean

CertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray CertBytes = { read=FCertBytes };

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 (CertificateValidator Component)

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

Syntax

__property __int64 CertHandle = { read=FCertHandle, write=FSetCertHandle };

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 (CertificateValidator Component)

The details of a certificate chain validation outcome.

Syntax

__property int ChainValidationDetails = { read=FChainValidationDetails };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorChainValidationResults ChainValidationResult = { read=FChainValidationResult };

enum TsbxCertificateValidatorChainValidationResults {
  cvtValid=0,
  cvtValidButUntrusted=1,
  cvtInvalid=2,
  cvtCantBeEstablished=3
};

Default Value

cvtValid

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 (CertificateValidator Component)

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

Syntax

__property bool CheckTrustedLists = { read=FCheckTrustedLists, write=FSetCheckTrustedLists };

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 (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray CurrentCACertBytes = { read=FCurrentCACertBytes };

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 (CertificateValidator Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool CurrentCACertCA = { read=FCurrentCACertCA };

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 (CertificateValidator Component)

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

Syntax

__property DynamicArray CurrentCACertCAKeyID = { read=FCurrentCACertCAKeyID };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorCurrentCACertCertTypes CurrentCACertCertType = { read=FCurrentCACertCertType };

enum TsbxCertificateValidatorCurrentCACertCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

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 component 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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertCRLDistributionPoints = { read=FCurrentCACertCRLDistributionPoints };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertCurve = { read=FCurrentCACertCurve };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertFingerprint = { read=FCurrentCACertFingerprint };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertFriendlyName = { read=FCurrentCACertFriendlyName };

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 (CertificateValidator Component)

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

Syntax

__property __int64 CurrentCACertHandle = { read=FCurrentCACertHandle };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertHashAlgorithm = { read=FCurrentCACertHashAlgorithm };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertIssuer = { read=FCurrentCACertIssuer };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertIssuerRDN = { read=FCurrentCACertIssuerRDN };

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 (CertificateValidator Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String CurrentCACertKeyAlgorithm = { read=FCurrentCACertKeyAlgorithm };

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 (CertificateValidator Component)

Returns the length of the public key in bits.

Syntax

__property int CurrentCACertKeyBits = { read=FCurrentCACertKeyBits };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertKeyFingerprint = { read=FCurrentCACertKeyFingerprint };

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 (CertificateValidator Component)

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

Syntax

__property int CurrentCACertKeyUsage = { read=FCurrentCACertKeyUsage };

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 (CertificateValidator Component)

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

Syntax

__property bool CurrentCACertKeyValid = { read=FCurrentCACertKeyValid };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertOCSPLocations = { read=FCurrentCACertOCSPLocations };

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 (CertificateValidator Component)

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

Syntax

__property bool CurrentCACertOCSPNoCheck = { read=FCurrentCACertOCSPNoCheck };

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 (CertificateValidator Component)

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

Syntax

__property int CurrentCACertOrigin = { read=FCurrentCACertOrigin };

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 (CertificateValidator Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String CurrentCACertPolicyIDs = { read=FCurrentCACertPolicyIDs };

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 (CertificateValidator Component)

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

Syntax

__property DynamicArray CurrentCACertPrivateKeyBytes = { read=FCurrentCACertPrivateKeyBytes };

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 (CertificateValidator Component)

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

Syntax

__property bool CurrentCACertPrivateKeyExists = { read=FCurrentCACertPrivateKeyExists };

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 (CertificateValidator Component)

Indicates whether the private key is extractable (exportable).

Syntax

__property bool CurrentCACertPrivateKeyExtractable = { read=FCurrentCACertPrivateKeyExtractable };

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 (CertificateValidator Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray CurrentCACertPublicKeyBytes = { read=FCurrentCACertPublicKeyBytes };

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 (CertificateValidator Component)

Indicates whether the certificate is qualified.

Syntax

__property bool CurrentCACertQualified = { read=FCurrentCACertQualified };

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 (CertificateValidator Component)

Returns a simplified qualified status of the certificate.

Syntax

__property TsbxCertificateValidatorCurrentCACertQualifiedStatements CurrentCACertQualifiedStatements = { read=FCurrentCACertQualifiedStatements };

enum TsbxCertificateValidatorCurrentCACertQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

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 (CertificateValidator Component)

A list of qualifiers.

Syntax

__property String CurrentCACertQualifiers = { read=FCurrentCACertQualifiers };

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 (CertificateValidator Component)

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

Syntax

__property bool CurrentCACertSelfSigned = { read=FCurrentCACertSelfSigned };

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 (CertificateValidator Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray CurrentCACertSerialNumber = { read=FCurrentCACertSerialNumber };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertSigAlgorithm = { read=FCurrentCACertSigAlgorithm };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorCurrentCACertSources CurrentCACertSource = { read=FCurrentCACertSource };

enum TsbxCertificateValidatorCurrentCACertSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertSubject = { read=FCurrentCACertSubject };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertSubjectAlternativeName = { read=FCurrentCACertSubjectAlternativeName };

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 (CertificateValidator Component)

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

Syntax

__property DynamicArray CurrentCACertSubjectKeyID = { read=FCurrentCACertSubjectKeyID };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertSubjectRDN = { read=FCurrentCACertSubjectRDN };

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 (CertificateValidator Component)

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.

Syntax

__property bool CurrentCACertValid = { read=FCurrentCACertValid };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertValidFrom = { read=FCurrentCACertValidFrom };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCACertValidTo = { read=FCurrentCACertValidTo };

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 (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray CurrentCertBytes = { read=FCurrentCertBytes };

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 (CertificateValidator Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool CurrentCertCA = { read=FCurrentCertCA };

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 (CertificateValidator Component)

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

Syntax

__property DynamicArray CurrentCertCAKeyID = { read=FCurrentCertCAKeyID };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorCurrentCertCertTypes CurrentCertCertType = { read=FCurrentCertCertType };

enum TsbxCertificateValidatorCurrentCertCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

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 component 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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertCRLDistributionPoints = { read=FCurrentCertCRLDistributionPoints };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertCurve = { read=FCurrentCertCurve };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertFingerprint = { read=FCurrentCertFingerprint };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertFriendlyName = { read=FCurrentCertFriendlyName };

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 (CertificateValidator Component)

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

Syntax

__property __int64 CurrentCertHandle = { read=FCurrentCertHandle };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertHashAlgorithm = { read=FCurrentCertHashAlgorithm };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertIssuer = { read=FCurrentCertIssuer };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertIssuerRDN = { read=FCurrentCertIssuerRDN };

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 (CertificateValidator Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String CurrentCertKeyAlgorithm = { read=FCurrentCertKeyAlgorithm };

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 (CertificateValidator Component)

Returns the length of the public key in bits.

Syntax

__property int CurrentCertKeyBits = { read=FCurrentCertKeyBits };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertKeyFingerprint = { read=FCurrentCertKeyFingerprint };

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 (CertificateValidator Component)

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

Syntax

__property int CurrentCertKeyUsage = { read=FCurrentCertKeyUsage };

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 (CertificateValidator Component)

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

Syntax

__property bool CurrentCertKeyValid = { read=FCurrentCertKeyValid };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertOCSPLocations = { read=FCurrentCertOCSPLocations };

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 (CertificateValidator Component)

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

Syntax

__property bool CurrentCertOCSPNoCheck = { read=FCurrentCertOCSPNoCheck };

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 (CertificateValidator Component)

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

Syntax

__property int CurrentCertOrigin = { read=FCurrentCertOrigin };

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 (CertificateValidator Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String CurrentCertPolicyIDs = { read=FCurrentCertPolicyIDs };

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 (CertificateValidator Component)

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

Syntax

__property DynamicArray CurrentCertPrivateKeyBytes = { read=FCurrentCertPrivateKeyBytes };

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 (CertificateValidator Component)

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

Syntax

__property bool CurrentCertPrivateKeyExists = { read=FCurrentCertPrivateKeyExists };

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 (CertificateValidator Component)

Indicates whether the private key is extractable (exportable).

Syntax

__property bool CurrentCertPrivateKeyExtractable = { read=FCurrentCertPrivateKeyExtractable };

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 (CertificateValidator Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray CurrentCertPublicKeyBytes = { read=FCurrentCertPublicKeyBytes };

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 (CertificateValidator Component)

Indicates whether the certificate is qualified.

Syntax

__property bool CurrentCertQualified = { read=FCurrentCertQualified };

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 (CertificateValidator Component)

Returns a simplified qualified status of the certificate.

Syntax

__property TsbxCertificateValidatorCurrentCertQualifiedStatements CurrentCertQualifiedStatements = { read=FCurrentCertQualifiedStatements };

enum TsbxCertificateValidatorCurrentCertQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

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 (CertificateValidator Component)

A list of qualifiers.

Syntax

__property String CurrentCertQualifiers = { read=FCurrentCertQualifiers };

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 (CertificateValidator Component)

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

Syntax

__property bool CurrentCertSelfSigned = { read=FCurrentCertSelfSigned };

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 (CertificateValidator Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray CurrentCertSerialNumber = { read=FCurrentCertSerialNumber };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertSigAlgorithm = { read=FCurrentCertSigAlgorithm };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorCurrentCertSources CurrentCertSource = { read=FCurrentCertSource };

enum TsbxCertificateValidatorCurrentCertSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertSubject = { read=FCurrentCertSubject };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertSubjectAlternativeName = { read=FCurrentCertSubjectAlternativeName };

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 (CertificateValidator Component)

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

Syntax

__property DynamicArray CurrentCertSubjectKeyID = { read=FCurrentCertSubjectKeyID };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertSubjectRDN = { read=FCurrentCertSubjectRDN };

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 (CertificateValidator Component)

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.

Syntax

__property bool CurrentCertValid = { read=FCurrentCertValid };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertValidFrom = { read=FCurrentCertValidFrom };

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 (CertificateValidator Component)

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

Syntax

__property String CurrentCertValidTo = { read=FCurrentCertValidTo };

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 (CertificateValidator Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

GracePeriod Property (CertificateValidator Component)

Specifies a grace period to apply during certificate validation.

Syntax

__property int GracePeriod = { read=FGracePeriod, write=FSetGracePeriod };

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 (CertificateValidator Component)

Contains the validation details of the moment.

Syntax

__property int InterimValidationDetails = { read=FInterimValidationDetails, write=FSetInterimValidationDetails };

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 (CertificateValidator Component)

Contains the validation status of the moment.

Syntax

__property TsbxCertificateValidatorInterimValidationResults InterimValidationResult = { read=FInterimValidationResult, write=FSetInterimValidationResult };

enum TsbxCertificateValidatorInterimValidationResults {
  cvtValid=0,
  cvtValidButUntrusted=1,
  cvtInvalid=2,
  cvtCantBeEstablished=3
};

Default Value

cvtValid

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 (CertificateValidator Component)

The number of records in the KnownCert arrays.

Syntax

__property int KnownCertCount = { read=FKnownCertCount, write=FSetKnownCertCount };

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 (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray KnownCertBytes[int KnownCertIndex] = { read=FKnownCertBytes };

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 (CertificateValidator Component)

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

Syntax

__property __int64 KnownCertHandle[int KnownCertIndex] = { read=FKnownCertHandle, write=FSetKnownCertHandle };

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 (CertificateValidator Component)

The number of records in the KnownCRL arrays.

Syntax

__property int KnownCRLCount = { read=FKnownCRLCount, write=FSetKnownCRLCount };

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 (CertificateValidator Component)

Returns the raw CRL data in DER format.

Syntax

__property DynamicArray KnownCRLBytes[int KnownCRLIndex] = { read=FKnownCRLBytes };

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 (CertificateValidator Component)

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

Syntax

__property __int64 KnownCRLHandle[int KnownCRLIndex] = { read=FKnownCRLHandle, write=FSetKnownCRLHandle };

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 (CertificateValidator Component)

The number of records in the KnownOCSP arrays.

Syntax

__property int KnownOCSPCount = { read=FKnownOCSPCount, write=FSetKnownOCSPCount };

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 (CertificateValidator Component)

A buffer containing the raw OCSP response data.

Syntax

__property DynamicArray KnownOCSPBytes[int KnownOCSPIndex] = { read=FKnownOCSPBytes };

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 (CertificateValidator Component)

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

Syntax

__property __int64 KnownOCSPHandle[int KnownOCSPIndex] = { read=FKnownOCSPHandle, write=FSetKnownOCSPHandle };

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 (CertificateValidator Component)

Specifies the maximum time the validation process may take.

Syntax

__property int MaxValidationTime = { read=FMaxValidationTime, write=FSetMaxValidationTime };

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 (CertificateValidator Component)

Switches the component to offline mode.

Syntax

__property bool OfflineMode = { read=FOfflineMode, write=FSetOfflineMode };

Default Value

false

Remarks

When working in offline mode, the component 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 (CertificateValidator Component)

The IP address of the proxy server.

Syntax

__property String ProxyAddress = { read=FProxyAddress, write=FSetProxyAddress };

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (CertificateValidator Component)

The authentication type used by the proxy server.

Syntax

__property TsbxCertificateValidatorProxyAuthentications ProxyAuthentication = { read=FProxyAuthentication, write=FSetProxyAuthentication };

enum TsbxCertificateValidatorProxyAuthentications {
  patNoAuthentication=0,
  patBasic=1,
  patDigest=2,
  patNTLM=3
};

Default Value

patNoAuthentication

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (CertificateValidator Component)

The password to authenticate to the proxy server.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (CertificateValidator Component)

The port on the proxy server to connect to.

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (CertificateValidator Component)

The type of the proxy server.

Syntax

__property TsbxCertificateValidatorProxyProxyTypes ProxyProxyType = { read=FProxyProxyType, write=FSetProxyProxyType };

enum TsbxCertificateValidatorProxyProxyTypes {
  cptNone=0,
  cptSocks4=1,
  cptSocks5=2,
  cptWebTunnel=3,
  cptHTTP=4
};

Default Value

cptNone

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (CertificateValidator Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

__property String ProxyRequestHeaders = { read=FProxyRequestHeaders, write=FSetProxyRequestHeaders };

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (CertificateValidator Component)

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

Syntax

__property String ProxyResponseBody = { read=FProxyResponseBody, write=FSetProxyResponseBody };

Default Value

""

Remarks

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

Data Type

String

ProxyResponseHeaders Property (CertificateValidator Component)

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

Syntax

__property String ProxyResponseHeaders = { read=FProxyResponseHeaders, write=FSetProxyResponseHeaders };

Default Value

""

Remarks

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

Data Type

String

ProxyUseIPv6 Property (CertificateValidator Component)

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

Syntax

__property bool ProxyUseIPv6 = { read=FProxyUseIPv6, write=FSetProxyUseIPv6 };

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (CertificateValidator Component)

Specifies the username credential for proxy authentication.

Syntax

__property String ProxyUsername = { read=FProxyUsername, write=FSetProxyUsername };

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

QualifiedInfoAddress Property (CertificateValidator Component)

Contains the address of the TSL provider.

Syntax

__property String QualifiedInfoAddress = { read=FQualifiedInfoAddress };

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 (CertificateValidator Component)

The list of custom TrustedLists to use.

Syntax

__property String QualifiedInfoCustomTrustedLists = { read=FQualifiedInfoCustomTrustedLists, write=FSetQualifiedInfoCustomTrustedLists };

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 (CertificateValidator Component)

Contains the TLS download log.

Syntax

__property String QualifiedInfoDownloadLog = { read=FQualifiedInfoDownloadLog };

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 (CertificateValidator Component)

Contains the URI of the provider information.

Syntax

__property String QualifiedInfoInformationURI = { read=FQualifiedInfoInformationURI };

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 (CertificateValidator Component)

The preferred language(s) for TSL data.

Syntax

__property String QualifiedInfoLanguages = { read=FQualifiedInfoLanguages, write=FSetQualifiedInfoLanguages };

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 (CertificateValidator Component)

Returns the next update date and time of the TSL.

Syntax

__property String QualifiedInfoNextUpdate = { read=FQualifiedInfoNextUpdate };

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 (CertificateValidator Component)

Contains the name of the TSL provider.

Syntax

__property String QualifiedInfoProvider = { read=FQualifiedInfoProvider };

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 (CertificateValidator Component)

Indicates whether the certificate is qualified.

Syntax

__property bool QualifiedInfoQualified = { read=FQualifiedInfoQualified };

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 (CertificateValidator Component)

A list of qualifiers.

Syntax

__property String QualifiedInfoQualifiers = { read=FQualifiedInfoQualifiers };

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 (CertificateValidator Component)

Contains the name of the TSL service.

Syntax

__property String QualifiedInfoServiceName = { read=FQualifiedInfoServiceName };

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 (CertificateValidator Component)

Contains the TSL service type identifier.

Syntax

__property String QualifiedInfoServiceTypeId = { read=FQualifiedInfoServiceTypeId };

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 (CertificateValidator Component)

The source of qualified information.

Syntax

__property TsbxCertificateValidatorQualifiedInfoSources QualifiedInfoSource = { read=FQualifiedInfoSource };

enum TsbxCertificateValidatorQualifiedInfoSources {
  qisUnknown=0,
  qisCertificate=1,
  qisTSL=2,
  qisBoth=3
};

Default Value

qisUnknown

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 (CertificateValidator Component)

Indicates a qualified electronic signature.

Syntax

__property TsbxCertificateValidatorQualifiedInfoStatus QualifiedInfoStatus = { read=FQualifiedInfoStatus };

enum TsbxCertificateValidatorQualifiedInfoStatus {
  sqsUnknown=0,
  sqsNone=1,
  sqsGranted=2,
  sqsWithdrawn=3,
  sqsSetByNationalLaw=4,
  sqsDeprecatedByNationalLaw=5,
  sqsRecognizedAtNationalLevel=6,
  sqsDeprecatedAtNationalLevel=7,
  sqsUnderSupervision=8,
  sqsSupervisionInCessation=9,
  sqsSupervisionCeased=10,
  sqsSupervisionRevoked=11,
  sqsAccredited=12,
  sqsAccreditationCeased=13,
  sqsAccreditationRevoked=14,
  sqsInAccordance=15,
  sqsExpired=16,
  sqsSuspended=17,
  sqsRevoked=18,
  sqsNotInAccordance=19
};

Default Value

sqsUnknown

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 (CertificateValidator Component)

Contains the trade name of the TSL provider.

Syntax

__property String QualifiedInfoTradeName = { read=FQualifiedInfoTradeName };

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 (CertificateValidator Component)

Indicates whether the certificate is trusted.

Syntax

__property bool QualifiedInfoTrusted = { read=FQualifiedInfoTrusted };

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 (CertificateValidator Component)

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

Syntax

__property bool QualifiedInfoUseDefaultTrustedLists = { read=FQualifiedInfoUseDefaultTrustedLists, write=FSetQualifiedInfoUseDefaultTrustedLists };

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 (CertificateValidator Component)

Contains the TLS validation log.

Syntax

__property String QualifiedInfoValidationLog = { read=FQualifiedInfoValidationLog };

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 (CertificateValidator Component)

Contains the XML of the TSL.

Syntax

__property String QualifiedInfoXML = { read=FQualifiedInfoXML };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorRevocationChecks RevocationCheck = { read=FRevocationCheck, write=FSetRevocationCheck };

enum TsbxCertificateValidatorRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorSocketDNSModes SocketDNSMode = { read=FSocketDNSMode, write=FSetSocketDNSMode };

enum TsbxCertificateValidatorSocketDNSModes {
  dmAuto=0,
  dmPlatform=1,
  dmOwn=2,
  dmOwnSecure=3
};

Default Value

dmAuto

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 (CertificateValidator Component)

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

Syntax

__property int SocketDNSPort = { read=FSocketDNSPort, write=FSetSocketDNSPort };

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (CertificateValidator Component)

The timeout (in milliseconds) for each DNS query.

Syntax

__property int SocketDNSQueryTimeout = { read=FSocketDNSQueryTimeout, write=FSetSocketDNSQueryTimeout };

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 (CertificateValidator Component)

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

Syntax

__property String SocketDNSServers = { read=FSocketDNSServers, write=FSetSocketDNSServers };

Default Value

""

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (CertificateValidator Component)

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

Syntax

__property int SocketDNSTotalTimeout = { read=FSocketDNSTotalTimeout, write=FSetSocketDNSTotalTimeout };

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 (CertificateValidator Component)

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

Syntax

__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (CertificateValidator Component)

The local network interface to bind the socket to.

Syntax

__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (CertificateValidator Component)

The local port number to bind the socket to.

Syntax

__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (CertificateValidator Component)

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

Syntax

__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (CertificateValidator Component)

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

Syntax

__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };

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 (CertificateValidator Component)

Enables or disables IP protocol version 6.

Syntax

__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSClientCertCount Property (CertificateValidator Component)

The number of records in the TLSClientCert arrays.

Syntax

__property int TLSClientCertCount = { read=FTLSClientCertCount, write=FSetTLSClientCertCount };

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 (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TLSClientCertBytes[int TLSClientCertIndex] = { read=FTLSClientCertBytes };

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 (CertificateValidator Component)

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

Syntax

__property __int64 TLSClientCertHandle[int TLSClientCertIndex] = { read=FTLSClientCertHandle, write=FSetTLSClientCertHandle };

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 (CertificateValidator Component)

The number of records in the TLSServerCert arrays.

Syntax

__property int TLSServerCertCount = { read=FTLSServerCertCount };

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 (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes };

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 (CertificateValidator Component)

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

Syntax

__property String TLSServerCertFingerprint[int TLSServerCertIndex] = { read=FTLSServerCertFingerprint };

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 (CertificateValidator Component)

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

Syntax

__property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle };

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 (CertificateValidator Component)

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

Syntax

__property String TLSServerCertIssuer[int TLSServerCertIndex] = { read=FTLSServerCertIssuer };

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 (CertificateValidator Component)

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

Syntax

__property String TLSServerCertIssuerRDN[int TLSServerCertIndex] = { read=FTLSServerCertIssuerRDN };

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 (CertificateValidator Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String TLSServerCertKeyAlgorithm[int TLSServerCertIndex] = { read=FTLSServerCertKeyAlgorithm };

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 (CertificateValidator Component)

Returns the length of the public key in bits.

Syntax

__property int TLSServerCertKeyBits[int TLSServerCertIndex] = { read=FTLSServerCertKeyBits };

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 (CertificateValidator Component)

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

Syntax

__property int TLSServerCertKeyUsage[int TLSServerCertIndex] = { read=FTLSServerCertKeyUsage };

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 (CertificateValidator Component)

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

Syntax

__property bool TLSServerCertSelfSigned[int TLSServerCertIndex] = { read=FTLSServerCertSelfSigned };

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 (CertificateValidator Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray TLSServerCertSerialNumber[int TLSServerCertIndex] = { read=FTLSServerCertSerialNumber };

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 (CertificateValidator Component)

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

Syntax

__property String TLSServerCertSigAlgorithm[int TLSServerCertIndex] = { read=FTLSServerCertSigAlgorithm };

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 (CertificateValidator Component)

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

Syntax

__property String TLSServerCertSubject[int TLSServerCertIndex] = { read=FTLSServerCertSubject };

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 (CertificateValidator Component)

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

Syntax

__property String TLSServerCertSubjectRDN[int TLSServerCertIndex] = { read=FTLSServerCertSubjectRDN };

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 (CertificateValidator Component)

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

Syntax

__property String TLSServerCertValidFrom[int TLSServerCertIndex] = { read=FTLSServerCertValidFrom };

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 (CertificateValidator Component)

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

Syntax

__property String TLSServerCertValidTo[int TLSServerCertIndex] = { read=FTLSServerCertValidTo };

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 (CertificateValidator Component)

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

Syntax

__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (CertificateValidator Component)

Selects the base configuration for the TLS settings.

Syntax

__property TsbxCertificateValidatorTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };

enum TsbxCertificateValidatorTLSBaseConfigurations {
  stpcDefault=0,
  stpcCompatible=1,
  stpcComprehensiveInsecure=2,
  stpcHighlySecure=3
};

Default Value

stpcDefault

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 (CertificateValidator Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };

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 (CertificateValidator Component)

Enables or disables certificate-based client authentication.

Syntax

__property TsbxCertificateValidatorTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth };

enum TsbxCertificateValidatorTLSClientAuths {
  ccatNoAuth=0,
  ccatRequestCert=1,
  ccatRequireCert=2
};

Default Value

ccatNoAuth

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 (CertificateValidator Component)

Defines the elliptic curves to enable.

Syntax

__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (CertificateValidator Component)

Provides access to TLS extensions.

Syntax

__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (CertificateValidator Component)

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

Syntax

__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (CertificateValidator Component)

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

Syntax

__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };

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 (CertificateValidator Component)

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

Syntax

__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };

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 (CertificateValidator Component)

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

Syntax

__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };

Default Value

""

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (CertificateValidator Component)

Selects the renegotiation attack prevention mechanism.

Syntax

__property TsbxCertificateValidatorTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };

enum TsbxCertificateValidatorTLSRenegotiationAttackPreventionModes {
  crapmCompatible=0,
  crapmStrict=1,
  crapmAuto=2
};

Default Value

crapmAuto

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };

enum TsbxCertificateValidatorTLSRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

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 (CertificateValidator Component)

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.

Syntax

__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (CertificateValidator Component)

Specifies the TLS mode to use.

Syntax

__property TsbxCertificateValidatorTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };

enum TsbxCertificateValidatorTLSTLSModes {
  smDefault=0,
  smNoTLS=1,
  smExplicitTLS=2,
  smImplicitTLS=3,
  smMixedTLS=4
};

Default Value

smDefault

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (CertificateValidator Component)

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

Syntax

__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (CertificateValidator Component)

Enables or disables the TLS session resumption capability.

Syntax

__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (CertificateValidator Component)

The SSL/TLS versions to enable by default.

Syntax

__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (CertificateValidator Component)

The number of records in the TrustedCert arrays.

Syntax

__property int TrustedCertCount = { read=FTrustedCertCount, write=FSetTrustedCertCount };

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 (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TrustedCertBytes[int TrustedCertIndex] = { read=FTrustedCertBytes };

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 (CertificateValidator Component)

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

Syntax

__property __int64 TrustedCertHandle[int TrustedCertIndex] = { read=FTrustedCertHandle, write=FSetTrustedCertHandle };

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 (CertificateValidator Component)

The number of records in the UsedCert arrays.

Syntax

__property int UsedCertCount = { read=FUsedCertCount };

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 (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray UsedCertBytes[int UsedCertIndex] = { read=FUsedCertBytes };

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 (CertificateValidator Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool UsedCertCA[int UsedCertIndex] = { read=FUsedCertCA };

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 (CertificateValidator Component)

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

Syntax

__property DynamicArray UsedCertCAKeyID[int UsedCertIndex] = { read=FUsedCertCAKeyID };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorUsedCertCertTypes UsedCertCertType[int UsedCertIndex] = { read=FUsedCertCertType };

enum TsbxCertificateValidatorUsedCertCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

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 component 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 (CertificateValidator Component)

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

Syntax

__property String UsedCertCRLDistributionPoints[int UsedCertIndex] = { read=FUsedCertCRLDistributionPoints };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertCurve[int UsedCertIndex] = { read=FUsedCertCurve };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertFingerprint[int UsedCertIndex] = { read=FUsedCertFingerprint };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertFriendlyName[int UsedCertIndex] = { read=FUsedCertFriendlyName };

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 (CertificateValidator Component)

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

Syntax

__property __int64 UsedCertHandle[int UsedCertIndex] = { read=FUsedCertHandle };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertHashAlgorithm[int UsedCertIndex] = { read=FUsedCertHashAlgorithm };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertIssuer[int UsedCertIndex] = { read=FUsedCertIssuer };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertIssuerRDN[int UsedCertIndex] = { read=FUsedCertIssuerRDN };

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 (CertificateValidator Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String UsedCertKeyAlgorithm[int UsedCertIndex] = { read=FUsedCertKeyAlgorithm };

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 (CertificateValidator Component)

Returns the length of the public key in bits.

Syntax

__property int UsedCertKeyBits[int UsedCertIndex] = { read=FUsedCertKeyBits };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertKeyFingerprint[int UsedCertIndex] = { read=FUsedCertKeyFingerprint };

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 (CertificateValidator Component)

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

Syntax

__property int UsedCertKeyUsage[int UsedCertIndex] = { read=FUsedCertKeyUsage };

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 (CertificateValidator Component)

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

Syntax

__property bool UsedCertKeyValid[int UsedCertIndex] = { read=FUsedCertKeyValid };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertOCSPLocations[int UsedCertIndex] = { read=FUsedCertOCSPLocations };

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 (CertificateValidator Component)

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

Syntax

__property bool UsedCertOCSPNoCheck[int UsedCertIndex] = { read=FUsedCertOCSPNoCheck };

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 (CertificateValidator Component)

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

Syntax

__property int UsedCertOrigin[int UsedCertIndex] = { read=FUsedCertOrigin };

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 (CertificateValidator Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String UsedCertPolicyIDs[int UsedCertIndex] = { read=FUsedCertPolicyIDs };

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 (CertificateValidator Component)

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

Syntax

__property DynamicArray UsedCertPrivateKeyBytes[int UsedCertIndex] = { read=FUsedCertPrivateKeyBytes };

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 (CertificateValidator Component)

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

Syntax

__property bool UsedCertPrivateKeyExists[int UsedCertIndex] = { read=FUsedCertPrivateKeyExists };

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 (CertificateValidator Component)

Indicates whether the private key is extractable (exportable).

Syntax

__property bool UsedCertPrivateKeyExtractable[int UsedCertIndex] = { read=FUsedCertPrivateKeyExtractable };

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 (CertificateValidator Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray UsedCertPublicKeyBytes[int UsedCertIndex] = { read=FUsedCertPublicKeyBytes };

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 (CertificateValidator Component)

Indicates whether the certificate is qualified.

Syntax

__property bool UsedCertQualified[int UsedCertIndex] = { read=FUsedCertQualified };

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 (CertificateValidator Component)

Returns a simplified qualified status of the certificate.

Syntax

__property TsbxCertificateValidatorUsedCertQualifiedStatements UsedCertQualifiedStatements[int UsedCertIndex] = { read=FUsedCertQualifiedStatements };

enum TsbxCertificateValidatorUsedCertQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

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 (CertificateValidator Component)

A list of qualifiers.

Syntax

__property String UsedCertQualifiers[int UsedCertIndex] = { read=FUsedCertQualifiers };

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 (CertificateValidator Component)

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

Syntax

__property bool UsedCertSelfSigned[int UsedCertIndex] = { read=FUsedCertSelfSigned };

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 (CertificateValidator Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray UsedCertSerialNumber[int UsedCertIndex] = { read=FUsedCertSerialNumber };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertSigAlgorithm[int UsedCertIndex] = { read=FUsedCertSigAlgorithm };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorUsedCertSources UsedCertSource[int UsedCertIndex] = { read=FUsedCertSource };

enum TsbxCertificateValidatorUsedCertSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertSubject[int UsedCertIndex] = { read=FUsedCertSubject };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertSubjectAlternativeName[int UsedCertIndex] = { read=FUsedCertSubjectAlternativeName };

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 (CertificateValidator Component)

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

Syntax

__property DynamicArray UsedCertSubjectKeyID[int UsedCertIndex] = { read=FUsedCertSubjectKeyID };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertSubjectRDN[int UsedCertIndex] = { read=FUsedCertSubjectRDN };

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 (CertificateValidator Component)

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.

Syntax

__property bool UsedCertValid[int UsedCertIndex] = { read=FUsedCertValid };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertValidFrom[int UsedCertIndex] = { read=FUsedCertValidFrom };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCertValidTo[int UsedCertIndex] = { read=FUsedCertValidTo };

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 (CertificateValidator Component)

The number of records in the UsedCRL arrays.

Syntax

__property int UsedCRLCount = { read=FUsedCRLCount };

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 (CertificateValidator Component)

Returns the raw CRL data in DER format.

Syntax

__property DynamicArray UsedCRLBytes[int UsedCRLIndex] = { read=FUsedCRLBytes };

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 (CertificateValidator Component)

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

Syntax

__property __int64 UsedCRLHandle[int UsedCRLIndex] = { read=FUsedCRLHandle };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCRLIssuer[int UsedCRLIndex] = { read=FUsedCRLIssuer };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCRLIssuerRDN[int UsedCRLIndex] = { read=FUsedCRLIssuerRDN };

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 (CertificateValidator Component)

The URL that the CRL was downloaded from.

Syntax

__property String UsedCRLLocation[int UsedCRLIndex] = { read=FUsedCRLLocation };

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 (CertificateValidator Component)

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

Syntax

__property String UsedCRLNextUpdate[int UsedCRLIndex] = { read=FUsedCRLNextUpdate };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorUsedCRLSources UsedCRLSource[int UsedCRLIndex] = { read=FUsedCRLSource };

enum TsbxCertificateValidatorUsedCRLSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

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 (CertificateValidator Component)

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

Syntax

__property String UsedCRLThisUpdate[int UsedCRLIndex] = { read=FUsedCRLThisUpdate };

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 (CertificateValidator Component)

The number of records in the UsedOCSP arrays.

Syntax

__property int UsedOCSPCount = { read=FUsedOCSPCount };

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 (CertificateValidator Component)

A buffer containing the raw OCSP response data.

Syntax

__property DynamicArray UsedOCSPBytes[int UsedOCSPIndex] = { read=FUsedOCSPBytes };

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 (CertificateValidator Component)

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

Syntax

__property __int64 UsedOCSPHandle[int UsedOCSPIndex] = { read=FUsedOCSPHandle };

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 (CertificateValidator Component)

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

Syntax

__property String UsedOCSPIssuer[int UsedOCSPIndex] = { read=FUsedOCSPIssuer };

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 (CertificateValidator Component)

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

Syntax

__property String UsedOCSPIssuerRDN[int UsedOCSPIndex] = { read=FUsedOCSPIssuerRDN };

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 (CertificateValidator Component)

The location of the OCSP responder.

Syntax

__property String UsedOCSPLocation[int UsedOCSPIndex] = { read=FUsedOCSPLocation };

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 (CertificateValidator Component)

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

Syntax

__property String UsedOCSPProducedAt[int UsedOCSPIndex] = { read=FUsedOCSPProducedAt };

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 (CertificateValidator Component)

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

Syntax

__property TsbxCertificateValidatorUsedOCSPSources UsedOCSPSource[int UsedOCSPIndex] = { read=FUsedOCSPSource };

enum TsbxCertificateValidatorUsedOCSPSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

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 (CertificateValidator Component)

Enables or disables the use of the system certificates.

Syntax

__property bool UseSystemCertificates = { read=FUseSystemCertificates, write=FSetUseSystemCertificates };

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 (CertificateValidator Component)

Contains the complete log of the certificate validation routine.

Syntax

__property String ValidationLog = { read=FValidationLog };

Default Value

""

Remarks

Use this property to access the chain validation log produced by the component. 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 (CertificateValidator Component)

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

Syntax

__property String ValidationMoment = { read=FValidationMoment, write=FSetValidationMoment };

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 (CertificateValidator Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (CertificateValidator Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. 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;....

Common ActionIDs:

GetQualifiedStatus Method (CertificateValidator Component)

Obtains the qualified information for Certificate .

Syntax

void __fastcall GetQualifiedStatus();

Remarks

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

GetTrustedListProperty Method (CertificateValidator Component)

Returns a specific TrustedList property.

Syntax

String __fastcall GetTrustedListProperty(String PropName, String 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 (CertificateValidator Component)

Refreshes the certificate cache.

Syntax

void __fastcall RefreshCache();

Remarks

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

Reset Method (CertificateValidator Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

ResetCache Method (CertificateValidator Component)

Clears all data contained in the validation cache.

Syntax

void __fastcall ResetCache();

Remarks

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

Terminate Method (CertificateValidator Component)

Terminates the validation process.

Syntax

void __fastcall Terminate();

Remarks

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

Validate Method (CertificateValidator Component)

Validates the certificate chain.

Syntax

int __fastcall Validate();

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 (CertificateValidator Component)

Validates an e-mail signing certificate.

Syntax

int __fastcall ValidateForSMIME(String 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 (CertificateValidator Component)

Validates a server-side SSL/TLS certificate.

Syntax

int __fastcall ValidateForSSL(String URL, String 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 (CertificateValidator Component)

Marks the end of a single certificate processing step.

Syntax

typedef struct {
  String Cert;
  int Validity;
  int ValidationDetails;
} TsbxCertificateValidatorAfterCertificateProcessingEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorAfterCertificateProcessingEvent)(System::TObject* Sender, TsbxCertificateValidatorAfterCertificateProcessingEventParams *e);
__property TsbxCertificateValidatorAfterCertificateProcessingEvent OnAfterCertificateProcessing = { read=FOnAfterCertificateProcessing, write=FOnAfterCertificateProcessing };

Remarks

This event is fired when the component 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 (CertificateValidator Component)

Marks the end of a single certificate validation step.

Syntax

typedef struct {
  String Cert;
  String CACert;
  int Validity;
  int ValidationDetails;
} TsbxCertificateValidatorAfterCertificateValidationEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorAfterCertificateValidationEvent)(System::TObject* Sender, TsbxCertificateValidatorAfterCertificateValidationEventParams *e);
__property TsbxCertificateValidatorAfterCertificateValidationEvent OnAfterCertificateValidation = { read=FOnAfterCertificateValidation, write=FOnAfterCertificateValidation };

Remarks

This event is fired when the component 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 (CertificateValidator Component)

Fires when a CA certificate is about to be downloaded.

Syntax

typedef struct {
  String Cert;
  String Location;
} TsbxCertificateValidatorBeforeCACertificateDownloadEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeCACertificateDownloadEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeCACertificateDownloadEventParams *e);
__property TsbxCertificateValidatorBeforeCACertificateDownloadEvent OnBeforeCACertificateDownload = { read=FOnBeforeCACertificateDownload, write=FOnBeforeCACertificateDownload };

Remarks

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

BeforeCertificateProcessing Event (CertificateValidator Component)

Reports the start of certificate processing.

Syntax

typedef struct {
  String Cert;
  int Validity;
  int ValidationDetails;
} TsbxCertificateValidatorBeforeCertificateProcessingEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeCertificateProcessingEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeCertificateProcessingEventParams *e);
__property TsbxCertificateValidatorBeforeCertificateProcessingEvent OnBeforeCertificateProcessing = { read=FOnBeforeCertificateProcessing, write=FOnBeforeCertificateProcessing };

Remarks

This event is fired when the component 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 (CertificateValidator Component)

Reports the start of certificate validation.

Syntax

typedef struct {
  String Cert;
  String CACert;
} TsbxCertificateValidatorBeforeCertificateValidationEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeCertificateValidationEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeCertificateValidationEventParams *e);
__property TsbxCertificateValidatorBeforeCertificateValidationEvent OnBeforeCertificateValidation = { read=FOnBeforeCertificateValidation, write=FOnBeforeCertificateValidation };

Remarks

This event is fired when the component 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 (CertificateValidator Component)

Fires when a CRL is about to be downloaded.

Syntax

typedef struct {
  String Cert;
  String CACert;
  String Location;
} TsbxCertificateValidatorBeforeCRLDownloadEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeCRLDownloadEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeCRLDownloadEventParams *e);
__property TsbxCertificateValidatorBeforeCRLDownloadEvent OnBeforeCRLDownload = { read=FOnBeforeCRLDownload, write=FOnBeforeCRLDownload };

Remarks

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

BeforeOCSPDownload Event (CertificateValidator Component)

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

Syntax

typedef struct {
  String Cert;
  String CACert;
  String Location;
} TsbxCertificateValidatorBeforeOCSPDownloadEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeOCSPDownloadEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeOCSPDownloadEventParams *e);
__property TsbxCertificateValidatorBeforeOCSPDownloadEvent OnBeforeOCSPDownload = { read=FOnBeforeOCSPDownload, write=FOnBeforeOCSPDownload };

Remarks

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

CACertificateDownloaded Event (CertificateValidator Component)

Marks the success of a certificate download.

Syntax

typedef struct {
  String Cert;
  String Location;
} TsbxCertificateValidatorCACertificateDownloadedEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorCACertificateDownloadedEvent)(System::TObject* Sender, TsbxCertificateValidatorCACertificateDownloadedEventParams *e);
__property TsbxCertificateValidatorCACertificateDownloadedEvent OnCACertificateDownloaded = { read=FOnCACertificateDownloaded, write=FOnCACertificateDownloaded };

Remarks

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

CACertificateNeeded Event (CertificateValidator Component)

Requests a missing certificate from the user.

Syntax

typedef struct {
  String Cert;
} TsbxCertificateValidatorCACertificateNeededEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorCACertificateNeededEvent)(System::TObject* Sender, TsbxCertificateValidatorCACertificateNeededEventParams *e);
__property TsbxCertificateValidatorCACertificateNeededEvent OnCACertificateNeeded = { read=FOnCACertificateNeeded, write=FOnCACertificateNeeded };

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 (CertificateValidator Component)

Marks the success of a CRL download.

Syntax

typedef struct {
  String Cert;
  String CACert;
  String Location;
} TsbxCertificateValidatorCRLDownloadedEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorCRLDownloadedEvent)(System::TObject* Sender, TsbxCertificateValidatorCRLDownloadedEventParams *e);
__property TsbxCertificateValidatorCRLDownloadedEvent OnCRLDownloaded = { read=FOnCRLDownloaded, write=FOnCRLDownloaded };

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 (CertificateValidator Component)

Requests a missing CRL from the user.

Syntax

typedef struct {
  String Cert;
  String CACert;
} TsbxCertificateValidatorCRLNeededEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorCRLNeededEvent)(System::TObject* Sender, TsbxCertificateValidatorCRLNeededEventParams *e);
__property TsbxCertificateValidatorCRLNeededEvent OnCRLNeeded = { read=FOnCRLNeeded, write=FOnCRLNeeded };

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 (CertificateValidator Component)

Information about errors during certificate validation.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxCertificateValidatorErrorEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorErrorEvent)(System::TObject* Sender, TsbxCertificateValidatorErrorEventParams *e);
__property TsbxCertificateValidatorErrorEvent OnError = { read=FOnError, write=FOnError };

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 (CertificateValidator Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxCertificateValidatorNotificationEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorNotificationEvent)(System::TObject* Sender, TsbxCertificateValidatorNotificationEventParams *e);
__property TsbxCertificateValidatorNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.

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

OCSPDownloaded Event (CertificateValidator Component)

Marks the success of an OCSP request.

Syntax

typedef struct {
  String Cert;
  String CACert;
  String Location;
} TsbxCertificateValidatorOCSPDownloadedEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorOCSPDownloadedEvent)(System::TObject* Sender, TsbxCertificateValidatorOCSPDownloadedEventParams *e);
__property TsbxCertificateValidatorOCSPDownloadedEvent OnOCSPDownloaded = { read=FOnOCSPDownloaded, write=FOnOCSPDownloaded };

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 (CertificateValidator Component)

Fires when a remote TLS party requests a client certificate.

Syntax

typedef struct {
  String Host;
  String CANames;
} TsbxCertificateValidatorTLSCertNeededEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorTLSCertNeededEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSCertNeededEventParams *e);
__property TsbxCertificateValidatorTLSCertNeededEvent OnTLSCertNeeded = { read=FOnTLSCertNeeded, write=FOnTLSCertNeeded };

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 (CertificateValidator Component)

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

Syntax

typedef struct {
  String ServerHost;
  String ServerIP;
  bool Accept;
} TsbxCertificateValidatorTLSCertValidateEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorTLSCertValidateEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSCertValidateEventParams *e);
__property TsbxCertificateValidatorTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate };

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, components 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 component, and can be adjusted if needed.

TLSEstablished Event (CertificateValidator Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

typedef struct {
  String Host;
  String Version;
  String Ciphersuite;
  DynamicArray ConnectionId;
  bool Abort;
} TsbxCertificateValidatorTLSEstablishedEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorTLSEstablishedEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSEstablishedEventParams *e);
__property TsbxCertificateValidatorTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished };

Remarks

The component 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 (CertificateValidator Component)

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

Syntax

typedef struct {
  String Host;
  bool Abort;
} TsbxCertificateValidatorTLSHandshakeEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorTLSHandshakeEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSHandshakeEventParams *e);
__property TsbxCertificateValidatorTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake };

Remarks

The component 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 (CertificateValidator Component)

Reports the graceful closure of a TLS connection.

Syntax

typedef struct {
  String Host;
} TsbxCertificateValidatorTLSShutdownEventParams;
typedef void __fastcall (__closure *TsbxCertificateValidatorTLSShutdownEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSShutdownEventParams *e);
__property TsbxCertificateValidatorTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown };

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

The component 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 component, access to these internal properties is provided through the Config method.

CertificateValidator Config Settings

TrustedLists Config Settings

Base Config Settings

Trappable Errors (CertificateValidator Component)

CertificateValidator Errors