Struct secureblackbox::CertificateValidator

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

secureblackbox::CertificateValidator

Remarks

This is a powerful and configurable struct 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 revocation_check in accordance with your revocation check preferences.
• Enable use_system_certificates property to trust certificates that are trusted by the operating system. Copy any certificates that are not available in the standard system locations to known_certificates and trusted_certificates collections (see Note 1 below).
• Optionally, adjust tls_settings and socket_settings.
• Adjust validation_moment 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 validate_for_ssl 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 on_before_certificate_processing, on_after_certificate_processing, and on_crl_downloaded events. It may also ask you for missing objects using on_crl_needed or on_ca_certificate_needed events. In each such event handler you can access the currently validated certificate via the current_certificate property, and the interim validity figures via the interim_validation_result and interim_validation_details 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:

• chain_validation_result 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.
• chain_validation_details 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 validation_log 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 trusted_certificates and known_certificates collections to have your chains validate fully in Linux and macOS projects.

Note 2: The offline_mode 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 use_system_certificates property, it allows to make sure that any content provided via known_certificates, known_crls, and known_ocsps represents the complete set of validation information required to validate the chain.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the CertificateValidator struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of CertificateValidator when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

blocked_cert_count property (CertificateValidator Struct)

The number of records in the BlockedCert arrays.

Syntax

fn blocked_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_blocked_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• blocked_cert_bytes
• blocked_cert_handle

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

Data Type

i32

blocked_cert_bytes property (CertificateValidator Struct)

Returns the raw certificate data in DER format.

Syntax

fn blocked_cert_bytes(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

blocked_cert_handle property (CertificateValidator Struct)

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

Syntax

fn blocked_cert_handle(&self , BlockedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_blocked_cert_handle(&self, BlockedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

cache_validation_results property (CertificateValidator Struct)

Enables or disables validation result caching.

Syntax

fn cache_validation_results(&self ) -> Result<bool, SecureBlackboxError> 
fn set_cache_validation_results(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

cert_bytes property (CertificateValidator Struct)

Returns the raw certificate data in DER format.

Syntax

fn cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

cert_handle property (CertificateValidator Struct)

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

Syntax

fn cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

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());

Data Type

i64

chain_validation_details property (CertificateValidator Struct)

The details of a certificate chain validation outcome.

Syntax

fn chain_validation_details(&self ) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

chain_validation_result property (CertificateValidator Struct)

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

Syntax

fn chain_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

0

Remarks

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

i32

check_trusted_lists property (CertificateValidator Struct)

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

Syntax

fn check_trusted_lists(&self ) -> Result<bool, SecureBlackboxError> 
fn set_check_trusted_lists(&self, value : bool) ->  Option<SecureBlackboxError> 

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

bool

current_ca_cert_bytes property (CertificateValidator Struct)

Returns the raw certificate data in DER format.

Syntax

fn current_ca_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

current_ca_cert_ca property (CertificateValidator Struct)

Indicates whether the certificate has a CA capability.

Syntax

fn current_ca_cert_ca(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

current_ca_cert_ca_key_id property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_ca_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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

This property is read-only.

Data Type

Vec

current_ca_cert_cert_type property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_cert_type(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

i32

current_ca_cert_crl_distribution_points property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_crl_distribution_points(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_curve property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_curve(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_fingerprint property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_fingerprint(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_friendly_name property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_friendly_name(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_handle property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

current_ca_cert_hash_algorithm property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

current_ca_cert_issuer property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_issuer(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

current_ca_cert_issuer_rdn property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_issuer_rdn(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_key_algorithm property (CertificateValidator Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn current_ca_cert_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the current_ca_cert_key_bits, current_ca_cert_curve, and current_ca_cert_public_key_bytes properties to get more details about the key the certificate contains.

This property is read-only.

Data Type

String

current_ca_cert_key_bits property (CertificateValidator Struct)

Returns the length of the public key in bits.

Syntax

fn current_ca_cert_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

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

This property is read-only.

Data Type

i32

current_ca_cert_key_fingerprint property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_key_fingerprint(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

current_ca_cert_key_usage property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_key_usage(&self ) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

current_ca_cert_key_valid property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_key_valid(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

current_ca_cert_ocsp_locations property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_ocsp_locations(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_ocsp_no_check property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_ocsp_no_check(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

current_ca_cert_origin property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_origin(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

current_ca_cert_policy_i_ds property (CertificateValidator Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

fn current_ca_cert_policy_i_ds(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_private_key_bytes property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_private_key_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

current_ca_cert_private_key_exists property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_private_key_exists(&self ) -> Result<bool, SecureBlackboxError> 

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 current_ca_cert_private_key_bytes, 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.

Data Type

bool

current_ca_cert_private_key_extractable property (CertificateValidator Struct)

Indicates whether the private key is extractable (exportable).

Syntax

fn current_ca_cert_private_key_extractable(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

Data Type

bool

current_ca_cert_public_key_bytes property (CertificateValidator Struct)

Contains the certificate's public key in DER format.

Syntax

fn current_ca_cert_public_key_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

current_ca_cert_qualified property (CertificateValidator Struct)

Indicates whether the certificate is qualified.

Syntax

fn current_ca_cert_qualified(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

current_ca_cert_qualified_statements property (CertificateValidator Struct)

Returns a simplified qualified status of the certificate.

Syntax

fn current_ca_cert_qualified_statements(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

This property is read-only.

Data Type

i32

current_ca_cert_qualifiers property (CertificateValidator Struct)

A list of qualifiers.

Syntax

fn current_ca_cert_qualifiers(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_self_signed property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_self_signed(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

current_ca_cert_serial_number property (CertificateValidator Struct)

Returns the certificate's serial number.

Syntax

fn current_ca_cert_serial_number(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

current_ca_cert_sig_algorithm property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_sig_algorithm(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_source property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_source(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

current_ca_cert_subject property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_subject(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

current_ca_cert_subject_alternative_name property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_subject_alternative_name(&self ) -> Result<String, SecureBlackboxError> 

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

Data Type

String

current_ca_cert_subject_key_id property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_subject_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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 current_ca_cert_subject_key_id and current_ca_cert_ca_key_id 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.

Data Type

Vec

current_ca_cert_subject_rdn property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_subject_rdn(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_ca_cert_valid property (CertificateValidator Struct)

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

fn current_ca_cert_valid(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

current_ca_cert_valid_from property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_valid_from(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

current_ca_cert_valid_to property (CertificateValidator Struct)

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

Syntax

fn current_ca_cert_valid_to(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

current_cert_bytes property (CertificateValidator Struct)

Returns the raw certificate data in DER format.

Syntax

fn current_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

current_cert_ca property (CertificateValidator Struct)

Indicates whether the certificate has a CA capability.

Syntax

fn current_cert_ca(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

current_cert_ca_key_id property (CertificateValidator Struct)

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

Syntax

fn current_cert_ca_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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

This property is read-only.

Data Type

Vec

current_cert_cert_type property (CertificateValidator Struct)

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

Syntax

fn current_cert_cert_type(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

i32

current_cert_crl_distribution_points property (CertificateValidator Struct)

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

Syntax

fn current_cert_crl_distribution_points(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_curve property (CertificateValidator Struct)

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

Syntax

fn current_cert_curve(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_fingerprint property (CertificateValidator Struct)

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

Syntax

fn current_cert_fingerprint(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_friendly_name property (CertificateValidator Struct)

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

Syntax

fn current_cert_friendly_name(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_handle property (CertificateValidator Struct)

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

Syntax

fn current_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

current_cert_hash_algorithm property (CertificateValidator Struct)

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

Syntax

fn current_cert_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

current_cert_issuer property (CertificateValidator Struct)

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

Syntax

fn current_cert_issuer(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

current_cert_issuer_rdn property (CertificateValidator Struct)

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

Syntax

fn current_cert_issuer_rdn(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_key_algorithm property (CertificateValidator Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn current_cert_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the current_cert_key_bits, current_cert_curve, and current_cert_public_key_bytes properties to get more details about the key the certificate contains.

This property is read-only.

Data Type

String

current_cert_key_bits property (CertificateValidator Struct)

Returns the length of the public key in bits.

Syntax

fn current_cert_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

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

This property is read-only.

Data Type

i32

current_cert_key_fingerprint property (CertificateValidator Struct)

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

Syntax

fn current_cert_key_fingerprint(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

current_cert_key_usage property (CertificateValidator Struct)

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

Syntax

fn current_cert_key_usage(&self ) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

current_cert_key_valid property (CertificateValidator Struct)

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

Syntax

fn current_cert_key_valid(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

current_cert_ocsp_locations property (CertificateValidator Struct)

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

Syntax

fn current_cert_ocsp_locations(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_ocsp_no_check property (CertificateValidator Struct)

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

Syntax

fn current_cert_ocsp_no_check(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

current_cert_origin property (CertificateValidator Struct)

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

Syntax

fn current_cert_origin(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

current_cert_policy_i_ds property (CertificateValidator Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

fn current_cert_policy_i_ds(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_private_key_bytes property (CertificateValidator Struct)

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

Syntax

fn current_cert_private_key_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

current_cert_private_key_exists property (CertificateValidator Struct)

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

Syntax

fn current_cert_private_key_exists(&self ) -> Result<bool, SecureBlackboxError> 

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 current_cert_private_key_bytes, 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.

Data Type

bool

current_cert_private_key_extractable property (CertificateValidator Struct)

Indicates whether the private key is extractable (exportable).

Syntax

fn current_cert_private_key_extractable(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

Data Type

bool

current_cert_public_key_bytes property (CertificateValidator Struct)

Contains the certificate's public key in DER format.

Syntax

fn current_cert_public_key_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

current_cert_qualified property (CertificateValidator Struct)

Indicates whether the certificate is qualified.

Syntax

fn current_cert_qualified(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

current_cert_qualified_statements property (CertificateValidator Struct)

Returns a simplified qualified status of the certificate.

Syntax

fn current_cert_qualified_statements(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

This property is read-only.

Data Type

i32

current_cert_qualifiers property (CertificateValidator Struct)

A list of qualifiers.

Syntax

fn current_cert_qualifiers(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_self_signed property (CertificateValidator Struct)

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

Syntax

fn current_cert_self_signed(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

current_cert_serial_number property (CertificateValidator Struct)

Returns the certificate's serial number.

Syntax

fn current_cert_serial_number(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

current_cert_sig_algorithm property (CertificateValidator Struct)

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

Syntax

fn current_cert_sig_algorithm(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_source property (CertificateValidator Struct)

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

Syntax

fn current_cert_source(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

current_cert_subject property (CertificateValidator Struct)

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

Syntax

fn current_cert_subject(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

current_cert_subject_alternative_name property (CertificateValidator Struct)

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

Syntax

fn current_cert_subject_alternative_name(&self ) -> Result<String, SecureBlackboxError> 

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

Data Type

String

current_cert_subject_key_id property (CertificateValidator Struct)

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

Syntax

fn current_cert_subject_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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 current_cert_subject_key_id and current_cert_ca_key_id 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.

Data Type

Vec

current_cert_subject_rdn property (CertificateValidator Struct)

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

Syntax

fn current_cert_subject_rdn(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

current_cert_valid property (CertificateValidator Struct)

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

fn current_cert_valid(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

current_cert_valid_from property (CertificateValidator Struct)

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

Syntax

fn current_cert_valid_from(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

current_cert_valid_to property (CertificateValidator Struct)

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

Syntax

fn current_cert_valid_to(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

fips_mode property (CertificateValidator Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

grace_period property (CertificateValidator Struct)

Specifies a grace period to apply during certificate validation.

Syntax

fn grace_period(&self ) -> Result<i32, SecureBlackboxError> 
fn set_grace_period(&self, value : i32) ->  Option<SecureBlackboxError> 

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

i32

interim_validation_details property (CertificateValidator Struct)

Contains the validation details of the moment.

Syntax

fn interim_validation_details(&self ) -> Result<i32, SecureBlackboxError> 
fn set_interim_validation_details(&self, value : i32) ->  Option<SecureBlackboxError> 

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:

Data Type

i32

interim_validation_result property (CertificateValidator Struct)

Contains the validation status of the moment.

Syntax

fn interim_validation_result(&self ) -> Result<i32, SecureBlackboxError> 
fn set_interim_validation_result(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

0

Remarks

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

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

Data Type

i32

known_cert_count property (CertificateValidator Struct)

The number of records in the KnownCert arrays.

Syntax

fn known_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_cert_bytes
• known_cert_handle

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

Data Type

i32

known_cert_bytes property (CertificateValidator Struct)

Returns the raw certificate data in DER format.

Syntax

fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

known_cert_handle property (CertificateValidator Struct)

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

Syntax

fn known_cert_handle(&self , KnownCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_cert_handle(&self, KnownCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

known_crl_count property (CertificateValidator Struct)

The number of records in the KnownCRL arrays.

Syntax

fn known_crl_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_crl_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_crl_bytes
• known_crl_handle

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

Data Type

i32

known_crl_bytes property (CertificateValidator Struct)

Returns the raw CRL data in DER format.

Syntax

fn known_crl_bytes(&self , KnownCRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

known_crl_handle property (CertificateValidator Struct)

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

Syntax

fn known_crl_handle(&self , KnownCRLIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_crl_handle(&self, KnownCRLIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

known_ocsp_count property (CertificateValidator Struct)

The number of records in the KnownOCSP arrays.

Syntax

fn known_ocsp_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_ocsp_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_ocsp_bytes
• known_ocsp_handle

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

Data Type

i32

known_ocsp_bytes property (CertificateValidator Struct)

A buffer containing the raw OCSP response data.

Syntax

fn known_ocsp_bytes(&self , KnownOCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

known_ocsp_handle property (CertificateValidator Struct)

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

Syntax

fn known_ocsp_handle(&self , KnownOCSPIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_ocsp_handle(&self, KnownOCSPIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

max_validation_time property (CertificateValidator Struct)

Specifies the maximum time the validation process may take.

Syntax

fn max_validation_time(&self ) -> Result<i32, SecureBlackboxError> 
fn set_max_validation_time(&self, value : i32) ->  Option<SecureBlackboxError> 

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

i32

offline_mode property (CertificateValidator Struct)

Switches the struct to offline mode.

Syntax

fn offline_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_offline_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

When working in offline mode, the struct 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 known_certificates, known_crls, and other related properties.

Data Type

bool

proxy_address property (CertificateValidator Struct)

The IP address of the proxy server.

Syntax

fn proxy_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

proxy_authentication property (CertificateValidator Struct)

The authentication type used by the proxy server.

Syntax

fn proxy_authentication(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_authentication(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuthentication
1   // Basic
2   // Digest
3   // NTLM

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

i32

proxy_password property (CertificateValidator Struct)

The password to authenticate to the proxy server.

Syntax

fn proxy_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

proxy_port property (CertificateValidator Struct)

The port on the proxy server to connect to.

Syntax

fn proxy_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

i32

proxy_type property (CertificateValidator Struct)

The type of the proxy server.

Syntax

fn proxy_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Socks4
2   // Socks5
3   // WebTunnel
4   // HTTP

Default Value

0

Remarks

The type of the proxy server.

Data Type

i32

proxy_request_headers property (CertificateValidator Struct)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

fn proxy_request_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_request_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_request_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

proxy_response_body property (CertificateValidator Struct)

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

Syntax

fn proxy_response_body(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_body(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_body_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

proxy_response_headers property (CertificateValidator Struct)

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

Syntax

fn proxy_response_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

proxy_use_ipv6 property (CertificateValidator Struct)

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

Syntax

fn proxy_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_proxy_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

proxy_username property (CertificateValidator Struct)

Specifies the username credential for proxy authentication.

Syntax

fn proxy_username(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_username(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_username_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

qualified_info_address property (CertificateValidator Struct)

Contains the address of the TSL provider.

Syntax

fn qualified_info_address(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_custom_trusted_lists property (CertificateValidator Struct)

The list of custom TrustedLists to use.

Syntax

fn qualified_info_custom_trusted_lists(&self ) -> Result<String, SecureBlackboxError> 
fn set_qualified_info_custom_trusted_lists(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_qualified_info_custom_trusted_lists_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

qualified_info_download_log property (CertificateValidator Struct)

Contains the TLS download log.

Syntax

fn qualified_info_download_log(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_information_uri property (CertificateValidator Struct)

Contains the URI of the provider information.

Syntax

fn qualified_info_information_uri(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_languages property (CertificateValidator Struct)

The preferred language(s) for TSL data.

Syntax

fn qualified_info_languages(&self ) -> Result<String, SecureBlackboxError> 
fn set_qualified_info_languages(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_qualified_info_languages_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

qualified_info_next_update property (CertificateValidator Struct)

Returns the next update date and time of the TSL.

Syntax

fn qualified_info_next_update(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_provider property (CertificateValidator Struct)

Contains the name of the TSL provider.

Syntax

fn qualified_info_provider(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_qualified property (CertificateValidator Struct)

Indicates whether the certificate is qualified.

Syntax

fn qualified_info_qualified(&self ) -> Result<bool, SecureBlackboxError> 

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

bool

qualified_info_qualifiers property (CertificateValidator Struct)

A list of qualifiers.

Syntax

fn qualified_info_qualifiers(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_service_name property (CertificateValidator Struct)

Contains the name of the TSL service.

Syntax

fn qualified_info_service_name(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_service_type_id property (CertificateValidator Struct)

Contains the TSL service type identifier.

Syntax

fn qualified_info_service_type_id(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_source property (CertificateValidator Struct)

The source of qualified information.

Syntax

fn qualified_info_source(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Certificate
2   // TSL
3   // Both

Default Value

0

Remarks

The source of qualified information.

Available options:

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

This property is read-only.

Data Type

i32

qualified_info_status property (CertificateValidator Struct)

Indicates a qualified electronic signature.

Syntax

fn qualified_info_status(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // None
2   // Granted
3   // Withdrawn
4   // SetByNationalLaw
5   // DeprecatedByNationalLaw
6   // RecognizedAtNationalLevel
7   // DeprecatedAtNationalLevel
8   // UnderSupervision
9   // SupervisionInCessation
10   // SupervisionCeased
11   // SupervisionRevoked
12   // Accredited
13   // AccreditationCeased
14   // AccreditationRevoked
15   // InAccordance
16   // Expired
17   // Suspended
18   // Revoked
19   // NotInAccordance

Default Value

0

Remarks

Indicates a qualified electronic signature.

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

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

The following qualified statuses are supported:

This property is read-only.

Data Type

i32

qualified_info_trade_name property (CertificateValidator Struct)

Contains the trade name of the TSL provider.

Syntax

fn qualified_info_trade_name(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_trusted property (CertificateValidator Struct)

Indicates whether the certificate is trusted.

Syntax

fn qualified_info_trusted(&self ) -> Result<bool, SecureBlackboxError> 

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

bool

qualified_info_use_default_trusted_lists property (CertificateValidator Struct)

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

Syntax

fn qualified_info_use_default_trusted_lists(&self ) -> Result<bool, SecureBlackboxError> 
fn set_qualified_info_use_default_trusted_lists(&self, value : bool) ->  Option<SecureBlackboxError> 

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

bool

qualified_info_validation_log property (CertificateValidator Struct)

Contains the TLS validation log.

Syntax

fn qualified_info_validation_log(&self ) -> Result<String, SecureBlackboxError> 

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

qualified_info_xml property (CertificateValidator Struct)

Contains the XML of the TSL.

Syntax

fn qualified_info_xml(&self ) -> Result<String, SecureBlackboxError> 

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

revocation_check property (CertificateValidator Struct)

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

Syntax

fn revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

1

Remarks

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

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

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

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

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

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

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

Data Type

i32

socket_dns_mode property (CertificateValidator Struct)

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

Syntax

fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Auto
1   // Platform
2   // Own
3   // OwnSecure

Default Value

0

Remarks

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

Data Type

i32

socket_dns_port property (CertificateValidator Struct)

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

Syntax

fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_dns_query_timeout property (CertificateValidator Struct)

The timeout (in milliseconds) for each DNS query.

Syntax

fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_query_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_dns_servers property (CertificateValidator Struct)

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

Syntax

fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_dns_servers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_dns_servers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

socket_dns_total_timeout property (CertificateValidator Struct)

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

Syntax

fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_total_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_incoming_speed_limit property (CertificateValidator Struct)

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

Syntax

fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_incoming_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_local_address property (CertificateValidator Struct)

The local network interface to bind the socket to.

Syntax

fn socket_local_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_local_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_local_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (CertificateValidator Struct)

The local port number to bind the socket to.

Syntax

fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_local_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (CertificateValidator Struct)

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

Syntax

fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_outgoing_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_timeout property (CertificateValidator Struct)

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

Syntax

fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

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

i32

socket_use_ipv6 property (CertificateValidator Struct)

Enables or disables IP protocol version 6.

Syntax

fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_socket_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

tls_client_cert_count property (CertificateValidator Struct)

The number of records in the TLSClientCert arrays.

Syntax

fn tls_client_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_client_cert_bytes
• tls_client_cert_handle

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

Data Type

i32

tls_client_cert_bytes property (CertificateValidator Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_client_cert_bytes(&self , TLSClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

tls_client_cert_handle property (CertificateValidator Struct)

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

Syntax

fn tls_client_cert_handle(&self , TLSClientCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_tls_client_cert_handle(&self, TLSClientCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

tls_server_cert_count property (CertificateValidator Struct)

The number of records in the TLSServerCert arrays.

Syntax

fn tls_server_cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_fingerprint
• tls_server_cert_handle
• tls_server_cert_issuer
• tls_server_cert_issuer_rdn
• tls_server_cert_key_algorithm
• tls_server_cert_key_bits
• tls_server_cert_key_usage
• tls_server_cert_self_signed
• tls_server_cert_serial_number
• tls_server_cert_sig_algorithm
• tls_server_cert_subject
• tls_server_cert_subject_rdn
• tls_server_cert_valid_from
• tls_server_cert_valid_to

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

This property is read-only.

Data Type

i32

tls_server_cert_bytes property (CertificateValidator Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

tls_server_cert_fingerprint property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_fingerprint(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

tls_server_cert_handle property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

tls_server_cert_issuer property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_issuer(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

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.

Data Type

String

tls_server_cert_issuer_rdn property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_issuer_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

tls_server_cert_key_algorithm property (CertificateValidator Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn tls_server_cert_key_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the tls_key_bits, tls_curve, and tls_public_key_bytes 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.

Data Type

String

tls_server_cert_key_bits property (CertificateValidator Struct)

Returns the length of the public key in bits.

Syntax

fn tls_server_cert_key_bits(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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 tls_public_key_bytes or tls_private_key_bytes 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.

Data Type

i32

tls_server_cert_key_usage property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_key_usage(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

tls_server_cert_self_signed property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_self_signed(&self , TLSServerCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

tls_server_cert_serial_number property (CertificateValidator Struct)

Returns the certificate's serial number.

Syntax

fn tls_server_cert_serial_number(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

tls_server_cert_sig_algorithm property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_sig_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

tls_server_cert_subject property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_subject(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

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.

Data Type

String

tls_server_cert_subject_rdn property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_subject_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

tls_server_cert_valid_from property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_valid_from(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

tls_server_cert_valid_to property (CertificateValidator Struct)

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

Syntax

fn tls_server_cert_valid_to(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

tls_auto_validate_certificates property (CertificateValidator Struct)

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

Syntax

fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_auto_validate_certificates(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

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

Data Type

bool

tls_base_configuration property (CertificateValidator Struct)

Selects the base configuration for the TLS settings.

Syntax

fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

Default Value

0

Remarks

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

Data Type

i32

tls_ciphersuites property (CertificateValidator Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_ciphersuites(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_ciphersuites_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

tls_client_auth property (CertificateValidator Struct)

Enables or disables certificate-based client authentication.

Syntax

fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_auth(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

i32

tls_extensions property (CertificateValidator Struct)

Provides access to TLS extensions.

Syntax

fn tls_extensions(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_extensions(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_extensions_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (CertificateValidator Struct)

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

Syntax

fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_force_resume_if_destination_changes(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

tls_groups property (CertificateValidator Struct)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

fn tls_groups(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_groups(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_groups_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

• SECT163K1
• SECT163R1
• SECT163R2
• SECT193R1
• SECT193R2
• SECT233K1
• SECT233R1
• SECT239K1
• SECT283K1
• SECT283R1
• SECT409K1
• SECT409R1
• SECT571K1
• SECT571R1
• SECP160K1
• SECP160R1
• SECP160R2
• SECP192K1
• SECP192R1
• SECP224K1
• SECP224R1
• SECP256K1
• SECP256R1
• SECP384R1
• SECP521R1
• BRAINPOOLP256R1
• BRAINPOOLP384R1
• BRAINPOOLP512R1
• X25519
• X448

Finite field-based groups:

• FFDHE2048
• FFDHE3072
• FFDHE4096
• FFDHE6144
• FFDHE8192

Post-Quantum and Hybrid groups:

• MLKEM512
• MLKEM768
• MLKEM1024
• SECP256R1MLKEM768
• X25519MLKEM768
• SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

String

tls_pre_shared_identity property (CertificateValidator Struct)

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

Syntax

fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_identity(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_identity_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key property (CertificateValidator Struct)

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

Syntax

fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key_ciphersuite property (CertificateValidator Struct)

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

Syntax

fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_renegotiation_attack_prevention_mode property (CertificateValidator Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

i32

tls_revocation_check property (CertificateValidator Struct)

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

Syntax

fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

1

Remarks

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

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

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

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

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

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

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

Data Type

i32

tls_ssl_options property (CertificateValidator Struct)

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

fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_ssl_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

i32

tls_mode property (CertificateValidator Struct)

Specifies the TLS mode to use.

Syntax

fn tls_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

i32

tls_use_extended_master_secret property (CertificateValidator Struct)

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

Syntax

fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_extended_master_secret(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

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

Data Type

bool

tls_use_session_resumption property (CertificateValidator Struct)

Enables or disables the TLS session resumption capability.

Syntax

fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_session_resumption(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (CertificateValidator Struct)

The SSL/TLS versions to enable by default.

Syntax

fn tls_versions(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_versions(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

Data Type

i32

trusted_cert_count property (CertificateValidator Struct)

The number of records in the TrustedCert arrays.

Syntax

fn trusted_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_trusted_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• trusted_cert_bytes
• trusted_cert_handle

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

Data Type

i32

trusted_cert_bytes property (CertificateValidator Struct)

Returns the raw certificate data in DER format.

Syntax

fn trusted_cert_bytes(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

trusted_cert_handle property (CertificateValidator Struct)

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

Syntax

fn trusted_cert_handle(&self , TrustedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_trusted_cert_handle(&self, TrustedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

used_cert_count property (CertificateValidator Struct)

The number of records in the UsedCert arrays.

Syntax

fn used_cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• used_cert_bytes
• used_cert_ca
• used_cert_ca_key_id
• used_cert_cert_type
• used_cert_crl_distribution_points
• used_cert_curve
• used_cert_fingerprint
• used_cert_friendly_name
• used_cert_handle
• used_cert_hash_algorithm
• used_cert_issuer
• used_cert_issuer_rdn
• used_cert_key_algorithm
• used_cert_key_bits
• used_cert_key_fingerprint
• used_cert_key_usage
• used_cert_key_valid
• used_cert_ocsp_locations
• used_cert_ocsp_no_check
• used_cert_origin
• used_cert_policy_i_ds
• used_cert_private_key_bytes
• used_cert_private_key_exists
• used_cert_private_key_extractable
• used_cert_public_key_bytes
• used_cert_qualified
• used_cert_qualified_statements
• used_cert_qualifiers
• used_cert_self_signed
• used_cert_serial_number
• used_cert_sig_algorithm
• used_cert_source
• used_cert_subject
• used_cert_subject_alternative_name
• used_cert_subject_key_id
• used_cert_subject_rdn
• used_cert_valid
• used_cert_valid_from
• used_cert_valid_to

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

This property is read-only.

Data Type

i32

used_cert_bytes property (CertificateValidator Struct)

Returns the raw certificate data in DER format.

Syntax

fn used_cert_bytes(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_cert_ca property (CertificateValidator Struct)

Indicates whether the certificate has a CA capability.

Syntax

fn used_cert_ca(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_ca_key_id property (CertificateValidator Struct)

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

Syntax

fn used_cert_ca_key_id(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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

Data Type

Vec

used_cert_cert_type property (CertificateValidator Struct)

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

Syntax

fn used_cert_cert_type(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

Default Value

0

Remarks

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

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

Use the CertificateManager struct 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.

Data Type

i32

used_cert_crl_distribution_points property (CertificateValidator Struct)

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

Syntax

fn used_cert_crl_distribution_points(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_curve property (CertificateValidator Struct)

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

Syntax

fn used_cert_curve(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_fingerprint property (CertificateValidator Struct)

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

Syntax

fn used_cert_fingerprint(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_friendly_name property (CertificateValidator Struct)

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

Syntax

fn used_cert_friendly_name(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_handle property (CertificateValidator Struct)

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

Syntax

fn used_cert_handle(&self , UsedCertIndex : i32) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

used_cert_hash_algorithm property (CertificateValidator Struct)

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

Syntax

fn used_cert_hash_algorithm(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

Data Type

String

used_cert_issuer property (CertificateValidator Struct)

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

Syntax

fn used_cert_issuer(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

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.

Data Type

String

used_cert_issuer_rdn property (CertificateValidator Struct)

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

Syntax

fn used_cert_issuer_rdn(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_key_algorithm property (CertificateValidator Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn used_cert_key_algorithm(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the used_cert_key_bits, used_cert_curve, and used_cert_public_key_bytes 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.

Data Type

String

used_cert_key_bits property (CertificateValidator Struct)

Returns the length of the public key in bits.

Syntax

fn used_cert_key_bits(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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 used_cert_public_key_bytes or used_cert_private_key_bytes 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.

Data Type

i32

used_cert_key_fingerprint property (CertificateValidator Struct)

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

Syntax

fn used_cert_key_fingerprint(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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 used_cert_fingerprint property. The key fingerprint 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.

Data Type

String

used_cert_key_usage property (CertificateValidator Struct)

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

Syntax

fn used_cert_key_usage(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

used_cert_key_valid property (CertificateValidator Struct)

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

Syntax

fn used_cert_key_valid(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_ocsp_locations property (CertificateValidator Struct)

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

Syntax

fn used_cert_ocsp_locations(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_ocsp_no_check property (CertificateValidator Struct)

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

Syntax

fn used_cert_ocsp_no_check(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_origin property (CertificateValidator Struct)

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

Syntax

fn used_cert_origin(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

used_cert_policy_i_ds property (CertificateValidator Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

fn used_cert_policy_i_ds(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_private_key_bytes property (CertificateValidator Struct)

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

Syntax

fn used_cert_private_key_bytes(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_cert_private_key_exists property (CertificateValidator Struct)

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

Syntax

fn used_cert_private_key_exists(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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 used_cert_private_key_bytes, 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.

Data Type

bool

used_cert_private_key_extractable property (CertificateValidator Struct)

Indicates whether the private key is extractable (exportable).

Syntax

fn used_cert_private_key_extractable(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_public_key_bytes property (CertificateValidator Struct)

Contains the certificate's public key in DER format.

Syntax

fn used_cert_public_key_bytes(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_cert_qualified property (CertificateValidator Struct)

Indicates whether the certificate is qualified.

Syntax

fn used_cert_qualified(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_qualified_statements property (CertificateValidator Struct)

Returns a simplified qualified status of the certificate.

Syntax

fn used_cert_qualified_statements(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

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

This property is read-only.

Data Type

i32

used_cert_qualifiers property (CertificateValidator Struct)

A list of qualifiers.

Syntax

fn used_cert_qualifiers(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_self_signed property (CertificateValidator Struct)

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

Syntax

fn used_cert_self_signed(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_serial_number property (CertificateValidator Struct)

Returns the certificate's serial number.

Syntax

fn used_cert_serial_number(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_cert_sig_algorithm property (CertificateValidator Struct)

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

Syntax

fn used_cert_sig_algorithm(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_source property (CertificateValidator Struct)

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

Syntax

fn used_cert_source(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

0

Remarks

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

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

This property is read-only.

Data Type

i32

used_cert_subject property (CertificateValidator Struct)

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

Syntax

fn used_cert_subject(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

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.

Data Type

String

used_cert_subject_alternative_name property (CertificateValidator Struct)

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

Syntax

fn used_cert_subject_alternative_name(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

Data Type

String

used_cert_subject_key_id property (CertificateValidator Struct)

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

Syntax

fn used_cert_subject_key_id(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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 used_cert_subject_key_id and used_cert_ca_key_id 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.

Data Type

Vec

used_cert_subject_rdn property (CertificateValidator Struct)

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

Syntax

fn used_cert_subject_rdn(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_valid property (CertificateValidator Struct)

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

fn used_cert_valid(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_valid_from property (CertificateValidator Struct)

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

Syntax

fn used_cert_valid_from(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_valid_to property (CertificateValidator Struct)

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

Syntax

fn used_cert_valid_to(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_crl_count property (CertificateValidator Struct)

The number of records in the UsedCRL arrays.

Syntax

fn used_crl_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• used_crl_bytes
• used_crl_handle
• used_crl_issuer
• used_crl_issuer_rdn
• used_crl_location
• used_crl_next_update
• used_crl_source
• used_crl_this_update

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

This property is read-only.

Data Type

i32

used_crl_bytes property (CertificateValidator Struct)

Returns the raw CRL data in DER format.

Syntax

fn used_crl_bytes(&self , UsedCRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_crl_handle property (CertificateValidator Struct)

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

Syntax

fn used_crl_handle(&self , UsedCRLIndex : i32) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

used_crl_issuer property (CertificateValidator Struct)

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

Syntax

fn used_crl_issuer(&self , UsedCRLIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_crl_issuer_rdn property (CertificateValidator Struct)

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

Syntax

fn used_crl_issuer_rdn(&self , UsedCRLIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_crl_location property (CertificateValidator Struct)

The URL that the CRL was downloaded from.

Syntax

fn used_crl_location(&self , UsedCRLIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_crl_next_update property (CertificateValidator Struct)

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

Syntax

fn used_crl_next_update(&self , UsedCRLIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_crl_source property (CertificateValidator Struct)

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

Syntax

fn used_crl_source(&self , UsedCRLIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

0

Remarks

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

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

This property is read-only.

Data Type

i32

used_crl_this_update property (CertificateValidator Struct)

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

Syntax

fn used_crl_this_update(&self , UsedCRLIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_ocsp_count property (CertificateValidator Struct)

The number of records in the UsedOCSP arrays.

Syntax

fn used_ocsp_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• used_ocsp_bytes
• used_ocsp_handle
• used_ocsp_issuer
• used_ocsp_issuer_rdn
• used_ocsp_location
• used_ocsp_produced_at
• used_ocsp_source

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

This property is read-only.

Data Type

i32

used_ocsp_bytes property (CertificateValidator Struct)

A buffer containing the raw OCSP response data.

Syntax

fn used_ocsp_bytes(&self , UsedOCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_ocsp_handle property (CertificateValidator Struct)

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

Syntax

fn used_ocsp_handle(&self , UsedOCSPIndex : i32) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

used_ocsp_issuer property (CertificateValidator Struct)

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

Syntax

fn used_ocsp_issuer(&self , UsedOCSPIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_ocsp_issuer_rdn property (CertificateValidator Struct)

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

Syntax

fn used_ocsp_issuer_rdn(&self , UsedOCSPIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_ocsp_location property (CertificateValidator Struct)

The location of the OCSP responder.

Syntax

fn used_ocsp_location(&self , UsedOCSPIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_ocsp_produced_at property (CertificateValidator Struct)

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

Syntax

fn used_ocsp_produced_at(&self , UsedOCSPIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_ocsp_source property (CertificateValidator Struct)

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

Syntax

fn used_ocsp_source(&self , UsedOCSPIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

0

Remarks

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

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

This property is read-only.

Data Type

i32

use_system_certificates property (CertificateValidator Struct)

Enables or disables the use of the system certificates.

Syntax

fn use_system_certificates(&self ) -> Result<bool, SecureBlackboxError> 
fn set_use_system_certificates(&self, value : bool) ->  Option<SecureBlackboxError> 

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

bool

validation_log property (CertificateValidator Struct)

Contains the complete log of the certificate validation routine.

Syntax

fn validation_log(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Use this property to access the chain validation log produced by the struct. 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.

Data Type

String

validation_moment property (CertificateValidator Struct)

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

Syntax

fn validation_moment(&self ) -> Result<String, SecureBlackboxError> 
fn set_validation_moment(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_validation_moment_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

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

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

do_action method (CertificateValidator Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. 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:

get_qualified_status method (CertificateValidator Struct)

Obtains the qualified information for Certificate .

Syntax

fn get_qualified_status(&self) -> Result<(), SecureBlackboxError>

Remarks

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

get_trusted_list_property method (CertificateValidator Struct)

Returns a specific TrustedList property.

Syntax

fn get_trusted_list_property(&self, prop_name : &str, language : &str) ->  Result<String, SecureBlackboxError>

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

refresh_cache method (CertificateValidator Struct)

Refreshes the certificate cache.

Syntax

fn refresh_cache(&self) -> Result<(), SecureBlackboxError>

Remarks

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

reset method (CertificateValidator Struct)

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

reset_cache method (CertificateValidator Struct)

Clears all data contained in the validation cache.

Syntax

fn reset_cache(&self) -> Result<(), SecureBlackboxError>

Remarks

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

terminate method (CertificateValidator Struct)

Terminates the validation process.

Syntax

fn terminate(&self) -> Result<(), SecureBlackboxError>

Remarks

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

validate method (CertificateValidator Struct)

Validates the certificate chain.

Syntax

fn validate(&self) ->  Result<i32, SecureBlackboxError>

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 chain_validation_result property. Another property, chain_validation_details, provides insight into the reasons that contributed to that decision. Use validation_log to get a detailed step-by-step log of the entire validation process.

validate_for_smime method (CertificateValidator Struct)

Validates an e-mail signing certificate.

Syntax

fn validate_for_smime(&self, email_address : &str) ->  Result<i32, SecureBlackboxError>

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.

validate_for_ssl method (CertificateValidator Struct)

Validates a server-side SSL/TLS certificate.

Syntax

fn validate_for_ssl(&self, url : &str, ip_address : &str) ->  Result<i32, SecureBlackboxError>

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.

on_after_certificate_processing event (CertificateValidator Struct)

Marks the end of a single certificate processing step.

Syntax

// CertificateValidatorAfterCertificateProcessingEventArgs carries the CertificateValidator AfterCertificateProcessing event's parameters.
pub struct CertificateValidatorAfterCertificateProcessingEventArgs {
  fn cert(&self) -> &String
  fn validity(&self) -> i32
  fn validation_details(&self) -> i32
}

// CertificateValidatorAfterCertificateProcessingEvent defines the signature of the CertificateValidator AfterCertificateProcessing event's handler function.
pub trait CertificateValidatorAfterCertificateProcessingEvent {
  fn on_after_certificate_processing(&self, sender : CertificateValidator, e : &mut CertificateValidatorAfterCertificateProcessingEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_after_certificate_processing(&self) -> &'a dyn CertificateValidatorAfterCertificateProcessingEvent;
  pub fn set_on_after_certificate_processing(&mut self, value : &'a dyn CertificateValidatorAfterCertificateProcessingEvent);
  ...
}

Remarks

This event is fired when the struct 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 on_after_certificate_validation 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 interim_validation_result and interim_validation_details properties.

Validity status:

Validation details:

on_after_certificate_validation event (CertificateValidator Struct)

Marks the end of a single certificate validation step.

Syntax

// CertificateValidatorAfterCertificateValidationEventArgs carries the CertificateValidator AfterCertificateValidation event's parameters.
pub struct CertificateValidatorAfterCertificateValidationEventArgs {
  fn cert(&self) -> &String
  fn ca_cert(&self) -> &String
  fn validity(&self) -> i32
  fn validation_details(&self) -> i32
}

// CertificateValidatorAfterCertificateValidationEvent defines the signature of the CertificateValidator AfterCertificateValidation event's handler function.
pub trait CertificateValidatorAfterCertificateValidationEvent {
  fn on_after_certificate_validation(&self, sender : CertificateValidator, e : &mut CertificateValidatorAfterCertificateValidationEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_after_certificate_validation(&self) -> &'a dyn CertificateValidatorAfterCertificateValidationEvent;
  pub fn set_on_after_certificate_validation(&mut self, value : &'a dyn CertificateValidatorAfterCertificateValidationEvent);
  ...
}

Remarks

This event is fired when the struct 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 interim_validation_result and interim_validation_details properties.

Validity status:

Validation details:

on_before_ca_certificate_download event (CertificateValidator Struct)

Fires when a CA certificate is about to be downloaded.

Syntax

// CertificateValidatorBeforeCACertificateDownloadEventArgs carries the CertificateValidator BeforeCACertificateDownload event's parameters.
pub struct CertificateValidatorBeforeCACertificateDownloadEventArgs {
  fn cert(&self) -> &String
  fn location(&self) -> &String
}

// CertificateValidatorBeforeCACertificateDownloadEvent defines the signature of the CertificateValidator BeforeCACertificateDownload event's handler function.
pub trait CertificateValidatorBeforeCACertificateDownloadEvent {
  fn on_before_ca_certificate_download(&self, sender : CertificateValidator, e : &mut CertificateValidatorBeforeCACertificateDownloadEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_before_ca_certificate_download(&self) -> &'a dyn CertificateValidatorBeforeCACertificateDownloadEvent;
  pub fn set_on_before_ca_certificate_download(&mut self, value : &'a dyn CertificateValidatorBeforeCACertificateDownloadEvent);
  ...
}

Remarks

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

on_before_certificate_processing event (CertificateValidator Struct)

Reports the start of certificate processing.

Syntax

// CertificateValidatorBeforeCertificateProcessingEventArgs carries the CertificateValidator BeforeCertificateProcessing event's parameters.
pub struct CertificateValidatorBeforeCertificateProcessingEventArgs {
  fn cert(&self) -> &String
  fn validity(&self) -> i32
  fn validation_details(&self) -> i32
}

// CertificateValidatorBeforeCertificateProcessingEvent defines the signature of the CertificateValidator BeforeCertificateProcessing event's handler function.
pub trait CertificateValidatorBeforeCertificateProcessingEvent {
  fn on_before_certificate_processing(&self, sender : CertificateValidator, e : &mut CertificateValidatorBeforeCertificateProcessingEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_before_certificate_processing(&self) -> &'a dyn CertificateValidatorBeforeCertificateProcessingEvent;
  pub fn set_on_before_certificate_processing(&mut self, value : &'a dyn CertificateValidatorBeforeCertificateProcessingEvent);
  ...
}

Remarks

This event is fired when the struct 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 on_after_certificate_validation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.

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

Validity and ValidationDetails specify the current validation status.

Validity status:

Validation details:

on_before_certificate_validation event (CertificateValidator Struct)

Reports the start of certificate validation.

Syntax

// CertificateValidatorBeforeCertificateValidationEventArgs carries the CertificateValidator BeforeCertificateValidation event's parameters.
pub struct CertificateValidatorBeforeCertificateValidationEventArgs {
  fn cert(&self) -> &String
  fn ca_cert(&self) -> &String
}

// CertificateValidatorBeforeCertificateValidationEvent defines the signature of the CertificateValidator BeforeCertificateValidation event's handler function.
pub trait CertificateValidatorBeforeCertificateValidationEvent {
  fn on_before_certificate_validation(&self, sender : CertificateValidator, e : &mut CertificateValidatorBeforeCertificateValidationEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_before_certificate_validation(&self) -> &'a dyn CertificateValidatorBeforeCertificateValidationEvent;
  pub fn set_on_before_certificate_validation(&mut self, value : &'a dyn CertificateValidatorBeforeCertificateValidationEvent);
  ...
}

Remarks

This event is fired when the struct 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 on_after_certificate_validation marks the end of the certificate validation step.

on_before_crl_download event (CertificateValidator Struct)

Fires when a CRL is about to be downloaded.

Syntax

// CertificateValidatorBeforeCRLDownloadEventArgs carries the CertificateValidator BeforeCRLDownload event's parameters.
pub struct CertificateValidatorBeforeCRLDownloadEventArgs {
  fn cert(&self) -> &String
  fn ca_cert(&self) -> &String
  fn location(&self) -> &String
}

// CertificateValidatorBeforeCRLDownloadEvent defines the signature of the CertificateValidator BeforeCRLDownload event's handler function.
pub trait CertificateValidatorBeforeCRLDownloadEvent {
  fn on_before_crl_download(&self, sender : CertificateValidator, e : &mut CertificateValidatorBeforeCRLDownloadEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_before_crl_download(&self) -> &'a dyn CertificateValidatorBeforeCRLDownloadEvent;
  pub fn set_on_before_crl_download(&mut self, value : &'a dyn CertificateValidatorBeforeCRLDownloadEvent);
  ...
}

Remarks

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

on_before_ocsp_download event (CertificateValidator Struct)

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

Syntax

// CertificateValidatorBeforeOCSPDownloadEventArgs carries the CertificateValidator BeforeOCSPDownload event's parameters.
pub struct CertificateValidatorBeforeOCSPDownloadEventArgs {
  fn cert(&self) -> &String
  fn ca_cert(&self) -> &String
  fn location(&self) -> &String
}

// CertificateValidatorBeforeOCSPDownloadEvent defines the signature of the CertificateValidator BeforeOCSPDownload event's handler function.
pub trait CertificateValidatorBeforeOCSPDownloadEvent {
  fn on_before_ocsp_download(&self, sender : CertificateValidator, e : &mut CertificateValidatorBeforeOCSPDownloadEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_before_ocsp_download(&self) -> &'a dyn CertificateValidatorBeforeOCSPDownloadEvent;
  pub fn set_on_before_ocsp_download(&mut self, value : &'a dyn CertificateValidatorBeforeOCSPDownloadEvent);
  ...
}

Remarks

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

on_ca_certificate_downloaded event (CertificateValidator Struct)

Marks the success of a certificate download.

Syntax

// CertificateValidatorCACertificateDownloadedEventArgs carries the CertificateValidator CACertificateDownloaded event's parameters.
pub struct CertificateValidatorCACertificateDownloadedEventArgs {
  fn cert(&self) -> &String
  fn location(&self) -> &String
}

// CertificateValidatorCACertificateDownloadedEvent defines the signature of the CertificateValidator CACertificateDownloaded event's handler function.
pub trait CertificateValidatorCACertificateDownloadedEvent {
  fn on_ca_certificate_downloaded(&self, sender : CertificateValidator, e : &mut CertificateValidatorCACertificateDownloadedEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_ca_certificate_downloaded(&self) -> &'a dyn CertificateValidatorCACertificateDownloadedEvent;
  pub fn set_on_ca_certificate_downloaded(&mut self, value : &'a dyn CertificateValidatorCACertificateDownloadedEvent);
  ...
}

Remarks

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

on_ca_certificate_needed event (CertificateValidator Struct)

Requests a missing certificate from the user.

Syntax

// CertificateValidatorCACertificateNeededEventArgs carries the CertificateValidator CACertificateNeeded event's parameters.
pub struct CertificateValidatorCACertificateNeededEventArgs {
  fn cert(&self) -> &String
}

// CertificateValidatorCACertificateNeededEvent defines the signature of the CertificateValidator CACertificateNeeded event's handler function.
pub trait CertificateValidatorCACertificateNeededEvent {
  fn on_ca_certificate_needed(&self, sender : CertificateValidator, e : &mut CertificateValidatorCACertificateNeededEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_ca_certificate_needed(&self) -> &'a dyn CertificateValidatorCACertificateNeededEvent;
  pub fn set_on_ca_certificate_needed(&mut self, value : &'a dyn CertificateValidatorCACertificateNeededEvent);
  ...
}

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 known_certificates collection to make it available to the validator.

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

on_crl_downloaded event (CertificateValidator Struct)

Marks the success of a CRL download.

Syntax

// CertificateValidatorCRLDownloadedEventArgs carries the CertificateValidator CRLDownloaded event's parameters.
pub struct CertificateValidatorCRLDownloadedEventArgs {
  fn cert(&self) -> &String
  fn ca_cert(&self) -> &String
  fn location(&self) -> &String
}

// CertificateValidatorCRLDownloadedEvent defines the signature of the CertificateValidator CRLDownloaded event's handler function.
pub trait CertificateValidatorCRLDownloadedEvent {
  fn on_crl_downloaded(&self, sender : CertificateValidator, e : &mut CertificateValidatorCRLDownloadedEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_crl_downloaded(&self) -> &'a dyn CertificateValidatorCRLDownloadedEvent;
  pub fn set_on_crl_downloaded(&mut self, value : &'a dyn CertificateValidatorCRLDownloadedEvent);
  ...
}

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 on_before_crl_download event.

on_crl_needed event (CertificateValidator Struct)

Requests a missing CRL from the user.

Syntax

// CertificateValidatorCRLNeededEventArgs carries the CertificateValidator CRLNeeded event's parameters.
pub struct CertificateValidatorCRLNeededEventArgs {
  fn cert(&self) -> &String
  fn ca_cert(&self) -> &String
}

// CertificateValidatorCRLNeededEvent defines the signature of the CertificateValidator CRLNeeded event's handler function.
pub trait CertificateValidatorCRLNeededEvent {
  fn on_crl_needed(&self, sender : CertificateValidator, e : &mut CertificateValidatorCRLNeededEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_crl_needed(&self) -> &'a dyn CertificateValidatorCRLNeededEvent;
  pub fn set_on_crl_needed(&mut self, value : &'a dyn CertificateValidatorCRLNeededEvent);
  ...
}

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 known_crls collection to make it available to the validator.

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

on_error event (CertificateValidator Struct)

Information about errors during certificate validation.

Syntax

// CertificateValidatorErrorEventArgs carries the CertificateValidator Error event's parameters.
pub struct CertificateValidatorErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// CertificateValidatorErrorEvent defines the signature of the CertificateValidator Error event's handler function.
pub trait CertificateValidatorErrorEvent {
  fn on_error(&self, sender : CertificateValidator, e : &mut CertificateValidatorErrorEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_error(&self) -> &'a dyn CertificateValidatorErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn CertificateValidatorErrorEvent);
  ...
}

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.

on_notification event (CertificateValidator Struct)

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

Syntax

// CertificateValidatorNotificationEventArgs carries the CertificateValidator Notification event's parameters.
pub struct CertificateValidatorNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// CertificateValidatorNotificationEvent defines the signature of the CertificateValidator Notification event's handler function.
pub trait CertificateValidatorNotificationEvent {
  fn on_notification(&self, sender : CertificateValidator, e : &mut CertificateValidatorNotificationEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_notification(&self) -> &'a dyn CertificateValidatorNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn CertificateValidatorNotificationEvent);
  ...
}

Remarks

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

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

on_ocsp_downloaded event (CertificateValidator Struct)

Marks the success of an OCSP request.

Syntax

// CertificateValidatorOCSPDownloadedEventArgs carries the CertificateValidator OCSPDownloaded event's parameters.
pub struct CertificateValidatorOCSPDownloadedEventArgs {
  fn cert(&self) -> &String
  fn ca_cert(&self) -> &String
  fn location(&self) -> &String
}

// CertificateValidatorOCSPDownloadedEvent defines the signature of the CertificateValidator OCSPDownloaded event's handler function.
pub trait CertificateValidatorOCSPDownloadedEvent {
  fn on_ocsp_downloaded(&self, sender : CertificateValidator, e : &mut CertificateValidatorOCSPDownloadedEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_ocsp_downloaded(&self) -> &'a dyn CertificateValidatorOCSPDownloadedEvent;
  pub fn set_on_ocsp_downloaded(&mut self, value : &'a dyn CertificateValidatorOCSPDownloadedEvent);
  ...
}

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 on_before_ocsp_download event.

on_tls_cert_needed event (CertificateValidator Struct)

Fires when a remote TLS party requests a client certificate.

Syntax

// CertificateValidatorTLSCertNeededEventArgs carries the CertificateValidator TLSCertNeeded event's parameters.
pub struct CertificateValidatorTLSCertNeededEventArgs {
  fn host(&self) -> &String
  fn ca_names(&self) -> &String
}

// CertificateValidatorTLSCertNeededEvent defines the signature of the CertificateValidator TLSCertNeeded event's handler function.
pub trait CertificateValidatorTLSCertNeededEvent {
  fn on_tls_cert_needed(&self, sender : CertificateValidator, e : &mut CertificateValidatorTLSCertNeededEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_tls_cert_needed(&self) -> &'a dyn CertificateValidatorTLSCertNeededEvent;
  pub fn set_on_tls_cert_needed(&mut self, value : &'a dyn CertificateValidatorTLSCertNeededEvent);
  ...
}

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 tls_client_chain 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 on_tls_handshake event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.

on_tls_cert_validate event (CertificateValidator Struct)

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

Syntax

// CertificateValidatorTLSCertValidateEventArgs carries the CertificateValidator TLSCertValidate event's parameters.
pub struct CertificateValidatorTLSCertValidateEventArgs {
  fn server_host(&self) -> &String
  fn server_ip(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// CertificateValidatorTLSCertValidateEvent defines the signature of the CertificateValidator TLSCertValidate event's handler function.
pub trait CertificateValidatorTLSCertValidateEvent {
  fn on_tls_cert_validate(&self, sender : CertificateValidator, e : &mut CertificateValidatorTLSCertValidateEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_tls_cert_validate(&self) -> &'a dyn CertificateValidatorTLSCertValidateEvent;
  pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn CertificateValidatorTLSCertValidateEvent);
  ...
}

Remarks

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

on_tls_established event (CertificateValidator Struct)

Fires when a TLS handshake with Host successfully completes.

Syntax

// CertificateValidatorTLSEstablishedEventArgs carries the CertificateValidator TLSEstablished event's parameters.
pub struct CertificateValidatorTLSEstablishedEventArgs {
  fn host(&self) -> &String
  fn version(&self) -> &String
  fn ciphersuite(&self) -> &String
  fn connection_id(&self) -> &[u8]
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// CertificateValidatorTLSEstablishedEvent defines the signature of the CertificateValidator TLSEstablished event's handler function.
pub trait CertificateValidatorTLSEstablishedEvent {
  fn on_tls_established(&self, sender : CertificateValidator, e : &mut CertificateValidatorTLSEstablishedEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_tls_established(&self) -> &'a dyn CertificateValidatorTLSEstablishedEvent;
  pub fn set_on_tls_established(&mut self, value : &'a dyn CertificateValidatorTLSEstablishedEvent);
  ...
}

Remarks

The struct 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.

on_tls_handshake event (CertificateValidator Struct)

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

Syntax

// CertificateValidatorTLSHandshakeEventArgs carries the CertificateValidator TLSHandshake event's parameters.
pub struct CertificateValidatorTLSHandshakeEventArgs {
  fn host(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// CertificateValidatorTLSHandshakeEvent defines the signature of the CertificateValidator TLSHandshake event's handler function.
pub trait CertificateValidatorTLSHandshakeEvent {
  fn on_tls_handshake(&self, sender : CertificateValidator, e : &mut CertificateValidatorTLSHandshakeEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_tls_handshake(&self) -> &'a dyn CertificateValidatorTLSHandshakeEvent;
  pub fn set_on_tls_handshake(&mut self, value : &'a dyn CertificateValidatorTLSHandshakeEvent);
  ...
}

Remarks

The struct 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 on_tls_established event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.

on_tls_shutdown event (CertificateValidator Struct)

Reports the graceful closure of a TLS connection.

Syntax

// CertificateValidatorTLSShutdownEventArgs carries the CertificateValidator TLSShutdown event's parameters.
pub struct CertificateValidatorTLSShutdownEventArgs {
  fn host(&self) -> &String
}

// CertificateValidatorTLSShutdownEvent defines the signature of the CertificateValidator TLSShutdown event's handler function.
pub trait CertificateValidatorTLSShutdownEvent {
  fn on_tls_shutdown(&self, sender : CertificateValidator, e : &mut CertificateValidatorTLSShutdownEventArgs);
}

impl <'a> CertificateValidator<'a> {
  pub fn on_tls_shutdown(&self) -> &'a dyn CertificateValidatorTLSShutdownEvent;
  pub fn set_on_tls_shutdown(&mut self, value : &'a dyn CertificateValidatorTLSShutdownEvent);
  ...
}

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

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

CertificateValidator Config Settings

TrustedLists Config Settings

Base Config Settings

Trappable Errors (CertificateValidator Struct)

CertificateValidator Errors