# Struct secureblackbox::CertificateValidator

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

## Syntax

```text
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](#revocation_check-property-certificatevalidator-struct) in accordance with your revocation check preferences.
- Enable [use_system_certificates](#use_system_certificates-property-certificatevalidator-struct) 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](#validation_moment-property-certificatevalidator-struct) 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](#validate-method-certificatevalidator-struct) or [validate_for_ssl](#validate_for_ssl-method-certificatevalidator-struct) 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_before_certificate_processing-event-certificatevalidator-struct), [on_after_certificate_processing](#on_after_certificate_processing-event-certificatevalidator-struct), and [on_crl_downloaded](#on_crl_downloaded-event-certificatevalidator-struct) events. It may also ask you for missing objects using [on_crl_needed](#on_crl_needed-event-certificatevalidator-struct) or [on_ca_certificate_needed](#on_ca_certificate_needed-event-certificatevalidator-struct) 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](#interim_validation_result-property-certificatevalidator-struct) and [interim_validation_details](#interim_validation_details-property-certificatevalidator-struct) property.

The return of the [validate](#validate-method-certificatevalidator-struct) (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](#chain_validation_result-property-certificatevalidator-struct) 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](#chain_validation_details-property-certificatevalidator-struct) 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](#validation_log-property-certificatevalidator-struct) 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](#offline_mode-property-certificatevalidator-struct) 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](#use_system_certificates-property-certificatevalidator-struct) 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.*

|  |  |
| --- | --- |
| [blocked_cert_count](#blocked_cert_count-property-certificatevalidator-struct) | The number of records in the BlockedCert arrays. |
| [blocked_cert_bytes](#blocked_cert_bytes-property-certificatevalidator-struct) | Returns the raw certificate data in DER format. |
| [blocked_cert_handle](#blocked_cert_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [cache_validation_results](#cache_validation_results-property-certificatevalidator-struct) | Enables or disables validation result caching. |
| [cert_bytes](#cert_bytes-property-certificatevalidator-struct) | Returns the raw certificate data in DER format. |
| [cert_handle](#cert_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [chain_validation_details](#chain_validation_details-property-certificatevalidator-struct) | The details of a certificate chain validation outcome. |
| [chain_validation_result](#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. |
| [check_trusted_lists](#check_trusted_lists-property-certificatevalidator-struct) | Specifies whether the struct should attempt to validate chain trust via a known Trusted List. |
| [current_ca_cert_bytes](#current_ca_cert_bytes-property-certificatevalidator-struct) | Returns the raw certificate data in DER format. |
| [current_ca_cert_ca](#current_ca_cert_ca-property-certificatevalidator-struct) | Indicates whether the certificate has a CA capability. |
| [current_ca_cert_ca_key_id](#current_ca_cert_ca_key_id-property-certificatevalidator-struct) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| [current_ca_cert_cert_type](#current_ca_cert_cert_type-property-certificatevalidator-struct) | Returns the type of the entity contained in the Certificate object. |
| [current_ca_cert_crl_distribution_points](#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. |
| [current_ca_cert_curve](#current_ca_cert_curve-property-certificatevalidator-struct) | Specifies the elliptic curve associated with the certificate's public key. |
| [current_ca_cert_fingerprint](#current_ca_cert_fingerprint-property-certificatevalidator-struct) | Contains the fingerprint (a hash imprint) of this certificate. |
| [current_ca_cert_friendly_name](#current_ca_cert_friendly_name-property-certificatevalidator-struct) | Contains an associated alias (friendly name) of the certificate. |
| [current_ca_cert_handle](#current_ca_cert_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [current_ca_cert_hash_algorithm](#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). |
| [current_ca_cert_issuer](#current_ca_cert_issuer-property-certificatevalidator-struct) | The common name of the certificate issuer (CA), typically a company name. |
| [current_ca_cert_issuer_rdn](#current_ca_cert_issuer_rdn-property-certificatevalidator-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [current_ca_cert_key_algorithm](#current_ca_cert_key_algorithm-property-certificatevalidator-struct) | Specifies the public key algorithm of this certificate. |
| [current_ca_cert_key_bits](#current_ca_cert_key_bits-property-certificatevalidator-struct) | Returns the length of the public key in bits. |
| [current_ca_cert_key_fingerprint](#current_ca_cert_key_fingerprint-property-certificatevalidator-struct) | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| [current_ca_cert_key_usage](#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. |
| [current_ca_cert_key_valid](#current_ca_cert_key_valid-property-certificatevalidator-struct) | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| [current_ca_cert_ocsp_locations](#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. |
| [current_ca_cert_ocsp_no_check](#current_ca_cert_ocsp_no_check-property-certificatevalidator-struct) | Accessor to the value of the certificate's ocsp-no-check extension. |
| [current_ca_cert_origin](#current_ca_cert_origin-property-certificatevalidator-struct) | Returns the location that the certificate was taken or loaded from. |
| [current_ca_cert_policy_i_ds](#current_ca_cert_policy_i_ds-property-certificatevalidator-struct) | Contains identifiers (OIDs) of the applicable certificate policies. |
| [current_ca_cert_private_key_bytes](#current_ca_cert_private_key_bytes-property-certificatevalidator-struct) | Returns the certificate's private key in DER-encoded format. |
| [current_ca_cert_private_key_exists](#current_ca_cert_private_key_exists-property-certificatevalidator-struct) | Indicates whether the certificate has a usable private key associated with it. |
| [current_ca_cert_private_key_extractable](#current_ca_cert_private_key_extractable-property-certificatevalidator-struct) | Indicates whether the private key is extractable (exportable). |
| [current_ca_cert_public_key_bytes](#current_ca_cert_public_key_bytes-property-certificatevalidator-struct) | Contains the certificate's public key in DER format. |
| [current_ca_cert_qualified](#current_ca_cert_qualified-property-certificatevalidator-struct) | Indicates whether the certificate is qualified. |
| [current_ca_cert_qualified_statements](#current_ca_cert_qualified_statements-property-certificatevalidator-struct) | Returns a simplified qualified status of the certificate. |
| [current_ca_cert_qualifiers](#current_ca_cert_qualifiers-property-certificatevalidator-struct) | A list of qualifiers. |
| [current_ca_cert_self_signed](#current_ca_cert_self_signed-property-certificatevalidator-struct) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [current_ca_cert_serial_number](#current_ca_cert_serial_number-property-certificatevalidator-struct) | Returns the certificate's serial number. |
| [current_ca_cert_sig_algorithm](#current_ca_cert_sig_algorithm-property-certificatevalidator-struct) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [current_ca_cert_source](#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. |
| [current_ca_cert_subject](#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. |
| [current_ca_cert_subject_alternative_name](#current_ca_cert_subject_alternative_name-property-certificatevalidator-struct) | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| [current_ca_cert_subject_key_id](#current_ca_cert_subject_key_id-property-certificatevalidator-struct) | Contains a unique identifier of the certificate's cryptographic key. |
| [current_ca_cert_subject_rdn](#current_ca_cert_subject_rdn-property-certificatevalidator-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [current_ca_cert_valid](#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. |
| [current_ca_cert_valid_from](#current_ca_cert_valid_from-property-certificatevalidator-struct) | The time point at which the certificate becomes valid, in UTC. |
| [current_ca_cert_valid_to](#current_ca_cert_valid_to-property-certificatevalidator-struct) | The time point at which the certificate expires, in UTC. |
| [current_cert_bytes](#current_cert_bytes-property-certificatevalidator-struct) | Returns the raw certificate data in DER format. |
| [current_cert_ca](#current_cert_ca-property-certificatevalidator-struct) | Indicates whether the certificate has a CA capability. |
| [current_cert_ca_key_id](#current_cert_ca_key_id-property-certificatevalidator-struct) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| [current_cert_cert_type](#current_cert_cert_type-property-certificatevalidator-struct) | Returns the type of the entity contained in the Certificate object. |
| [current_cert_crl_distribution_points](#current_cert_crl_distribution_points-property-certificatevalidator-struct) | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| [current_cert_curve](#current_cert_curve-property-certificatevalidator-struct) | Specifies the elliptic curve associated with the certificate's public key. |
| [current_cert_fingerprint](#current_cert_fingerprint-property-certificatevalidator-struct) | Contains the fingerprint (a hash imprint) of this certificate. |
| [current_cert_friendly_name](#current_cert_friendly_name-property-certificatevalidator-struct) | Contains an associated alias (friendly name) of the certificate. |
| [current_cert_handle](#current_cert_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [current_cert_hash_algorithm](#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). |
| [current_cert_issuer](#current_cert_issuer-property-certificatevalidator-struct) | The common name of the certificate issuer (CA), typically a company name. |
| [current_cert_issuer_rdn](#current_cert_issuer_rdn-property-certificatevalidator-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [current_cert_key_algorithm](#current_cert_key_algorithm-property-certificatevalidator-struct) | Specifies the public key algorithm of this certificate. |
| [current_cert_key_bits](#current_cert_key_bits-property-certificatevalidator-struct) | Returns the length of the public key in bits. |
| [current_cert_key_fingerprint](#current_cert_key_fingerprint-property-certificatevalidator-struct) | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| [current_cert_key_usage](#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. |
| [current_cert_key_valid](#current_cert_key_valid-property-certificatevalidator-struct) | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| [current_cert_ocsp_locations](#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. |
| [current_cert_ocsp_no_check](#current_cert_ocsp_no_check-property-certificatevalidator-struct) | Accessor to the value of the certificate's ocsp-no-check extension. |
| [current_cert_origin](#current_cert_origin-property-certificatevalidator-struct) | Returns the location that the certificate was taken or loaded from. |
| [current_cert_policy_i_ds](#current_cert_policy_i_ds-property-certificatevalidator-struct) | Contains identifiers (OIDs) of the applicable certificate policies. |
| [current_cert_private_key_bytes](#current_cert_private_key_bytes-property-certificatevalidator-struct) | Returns the certificate's private key in DER-encoded format. |
| [current_cert_private_key_exists](#current_cert_private_key_exists-property-certificatevalidator-struct) | Indicates whether the certificate has a usable private key associated with it. |
| [current_cert_private_key_extractable](#current_cert_private_key_extractable-property-certificatevalidator-struct) | Indicates whether the private key is extractable (exportable). |
| [current_cert_public_key_bytes](#current_cert_public_key_bytes-property-certificatevalidator-struct) | Contains the certificate's public key in DER format. |
| [current_cert_qualified](#current_cert_qualified-property-certificatevalidator-struct) | Indicates whether the certificate is qualified. |
| [current_cert_qualified_statements](#current_cert_qualified_statements-property-certificatevalidator-struct) | Returns a simplified qualified status of the certificate. |
| [current_cert_qualifiers](#current_cert_qualifiers-property-certificatevalidator-struct) | A list of qualifiers. |
| [current_cert_self_signed](#current_cert_self_signed-property-certificatevalidator-struct) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [current_cert_serial_number](#current_cert_serial_number-property-certificatevalidator-struct) | Returns the certificate's serial number. |
| [current_cert_sig_algorithm](#current_cert_sig_algorithm-property-certificatevalidator-struct) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [current_cert_source](#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. |
| [current_cert_subject](#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. |
| [current_cert_subject_alternative_name](#current_cert_subject_alternative_name-property-certificatevalidator-struct) | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| [current_cert_subject_key_id](#current_cert_subject_key_id-property-certificatevalidator-struct) | Contains a unique identifier of the certificate's cryptographic key. |
| [current_cert_subject_rdn](#current_cert_subject_rdn-property-certificatevalidator-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [current_cert_valid](#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. |
| [current_cert_valid_from](#current_cert_valid_from-property-certificatevalidator-struct) | The time point at which the certificate becomes valid, in UTC. |
| [current_cert_valid_to](#current_cert_valid_to-property-certificatevalidator-struct) | The time point at which the certificate expires, in UTC. |
| [fips_mode](#fips_mode-property-certificatevalidator-struct) | Reserved. |
| [grace_period](#grace_period-property-certificatevalidator-struct) | Specifies a grace period to apply during certificate validation. |
| [interim_validation_details](#interim_validation_details-property-certificatevalidator-struct) | Contains the validation details of the moment. |
| [interim_validation_result](#interim_validation_result-property-certificatevalidator-struct) | Contains the validation status of the moment. |
| [known_cert_count](#known_cert_count-property-certificatevalidator-struct) | The number of records in the KnownCert arrays. |
| [known_cert_bytes](#known_cert_bytes-property-certificatevalidator-struct) | Returns the raw certificate data in DER format. |
| [known_cert_handle](#known_cert_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [known_crl_count](#known_crl_count-property-certificatevalidator-struct) | The number of records in the KnownCRL arrays. |
| [known_crl_bytes](#known_crl_bytes-property-certificatevalidator-struct) | Returns the raw CRL data in DER format. |
| [known_crl_handle](#known_crl_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [known_ocsp_count](#known_ocsp_count-property-certificatevalidator-struct) | The number of records in the KnownOCSP arrays. |
| [known_ocsp_bytes](#known_ocsp_bytes-property-certificatevalidator-struct) | A buffer containing the raw OCSP response data. |
| [known_ocsp_handle](#known_ocsp_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [max_validation_time](#max_validation_time-property-certificatevalidator-struct) | Specifies the maximum time the validation process may take. |
| [offline_mode](#offline_mode-property-certificatevalidator-struct) | Switches the struct to offline mode. |
| [proxy_address](#proxy_address-property-certificatevalidator-struct) | The IP address of the proxy server. |
| [proxy_authentication](#proxy_authentication-property-certificatevalidator-struct) | The authentication type used by the proxy server. |
| [proxy_password](#proxy_password-property-certificatevalidator-struct) | The password to authenticate to the proxy server. |
| [proxy_port](#proxy_port-property-certificatevalidator-struct) | The port on the proxy server to connect to. |
| [proxy_type](#proxy_type-property-certificatevalidator-struct) | The type of the proxy server. |
| [proxy_request_headers](#proxy_request_headers-property-certificatevalidator-struct) | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| [proxy_response_body](#proxy_response_body-property-certificatevalidator-struct) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| [proxy_response_headers](#proxy_response_headers-property-certificatevalidator-struct) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| [proxy_use_ipv6](#proxy_use_ipv6-property-certificatevalidator-struct) | Specifies whether IPv6 should be used when connecting through the proxy. |
| [proxy_username](#proxy_username-property-certificatevalidator-struct) | Specifies the username credential for proxy authentication. |
| [qualified_info_address](#qualified_info_address-property-certificatevalidator-struct) | Contains the address of the TSL provider. |
| [qualified_info_custom_trusted_lists](#qualified_info_custom_trusted_lists-property-certificatevalidator-struct) | The list of custom TrustedLists to use. |
| [qualified_info_download_log](#qualified_info_download_log-property-certificatevalidator-struct) | Contains the TLS download log. |
| [qualified_info_information_uri](#qualified_info_information_uri-property-certificatevalidator-struct) | Contains the URI of the provider information. |
| [qualified_info_languages](#qualified_info_languages-property-certificatevalidator-struct) | The preferred language(s) for TSL data. |
| [qualified_info_next_update](#qualified_info_next_update-property-certificatevalidator-struct) | Returns the next update date and time of the TSL. |
| [qualified_info_provider](#qualified_info_provider-property-certificatevalidator-struct) | Contains the name of the TSL provider. |
| [qualified_info_qualified](#qualified_info_qualified-property-certificatevalidator-struct) | Indicates whether the certificate is qualified. |
| [qualified_info_qualifiers](#qualified_info_qualifiers-property-certificatevalidator-struct) | A list of qualifiers. |
| [qualified_info_service_name](#qualified_info_service_name-property-certificatevalidator-struct) | Contains the name of the TSL service. |
| [qualified_info_service_type_id](#qualified_info_service_type_id-property-certificatevalidator-struct) | Contains the TSL service type identifier. |
| [qualified_info_source](#qualified_info_source-property-certificatevalidator-struct) | The source of qualified information. |
| [qualified_info_status](#qualified_info_status-property-certificatevalidator-struct) | Indicates a qualified electronic signature. |
| [qualified_info_trade_name](#qualified_info_trade_name-property-certificatevalidator-struct) | Contains the trade name of the TSL provider. |
| [qualified_info_trusted](#qualified_info_trusted-property-certificatevalidator-struct) | Indicates whether the certificate is trusted. |
| [qualified_info_use_default_trusted_lists](#qualified_info_use_default_trusted_lists-property-certificatevalidator-struct) | Use this setting to enable or disable the use of the default TrustedLists. |
| [qualified_info_validation_log](#qualified_info_validation_log-property-certificatevalidator-struct) | Contains the TLS validation log. |
| [qualified_info_xml](#qualified_info_xml-property-certificatevalidator-struct) | Contains the XML of the TSL. |
| [revocation_check](#revocation_check-property-certificatevalidator-struct) | Specifies the kind(s) of revocation check to perform for all chain certificates. |
| [socket_dns_mode](#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. |
| [socket_dns_port](#socket_dns_port-property-certificatevalidator-struct) | Specifies the port number to be used for sending queries to the DNS server. |
| [socket_dns_query_timeout](#socket_dns_query_timeout-property-certificatevalidator-struct) | The timeout (in milliseconds) for each DNS query. |
| [socket_dns_servers](#socket_dns_servers-property-certificatevalidator-struct) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| [socket_dns_total_timeout](#socket_dns_total_timeout-property-certificatevalidator-struct) | The timeout (in milliseconds) for the whole resolution process. |
| [socket_incoming_speed_limit](#socket_incoming_speed_limit-property-certificatevalidator-struct) | The maximum number of bytes to read from the socket, per second. |
| [socket_local_address](#socket_local_address-property-certificatevalidator-struct) | The local network interface to bind the socket to. |
| [socket_local_port](#socket_local_port-property-certificatevalidator-struct) | The local port number to bind the socket to. |
| [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property-certificatevalidator-struct) | The maximum number of bytes to write to the socket, per second. |
| [socket_timeout](#socket_timeout-property-certificatevalidator-struct) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| [socket_use_ipv6](#socket_use_ipv6-property-certificatevalidator-struct) | Enables or disables IP protocol version 6. |
| [tls_client_cert_count](#tls_client_cert_count-property-certificatevalidator-struct) | The number of records in the TLSClientCert arrays. |
| [tls_client_cert_bytes](#tls_client_cert_bytes-property-certificatevalidator-struct) | Returns the raw certificate data in DER format. |
| [tls_client_cert_handle](#tls_client_cert_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [tls_server_cert_count](#tls_server_cert_count-property-certificatevalidator-struct) | The number of records in the TLSServerCert arrays. |
| [tls_server_cert_bytes](#tls_server_cert_bytes-property-certificatevalidator-struct) | Returns the raw certificate data in DER format. |
| [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property-certificatevalidator-struct) | Contains the fingerprint (a hash imprint) of this certificate. |
| [tls_server_cert_handle](#tls_server_cert_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [tls_server_cert_issuer](#tls_server_cert_issuer-property-certificatevalidator-struct) | The common name of the certificate issuer (CA), typically a company name. |
| [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property-certificatevalidator-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property-certificatevalidator-struct) | Specifies the public key algorithm of this certificate. |
| [tls_server_cert_key_bits](#tls_server_cert_key_bits-property-certificatevalidator-struct) | Returns the length of the public key in bits. |
| [tls_server_cert_key_usage](#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. |
| [tls_server_cert_self_signed](#tls_server_cert_self_signed-property-certificatevalidator-struct) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [tls_server_cert_serial_number](#tls_server_cert_serial_number-property-certificatevalidator-struct) | Returns the certificate's serial number. |
| [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property-certificatevalidator-struct) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [tls_server_cert_subject](#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. |
| [tls_server_cert_subject_rdn](#tls_server_cert_subject_rdn-property-certificatevalidator-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [tls_server_cert_valid_from](#tls_server_cert_valid_from-property-certificatevalidator-struct) | The time point at which the certificate becomes valid, in UTC. |
| [tls_server_cert_valid_to](#tls_server_cert_valid_to-property-certificatevalidator-struct) | The time point at which the certificate expires, in UTC. |
| [tls_auto_validate_certificates](#tls_auto_validate_certificates-property-certificatevalidator-struct) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| [tls_base_configuration](#tls_base_configuration-property-certificatevalidator-struct) | Selects the base configuration for the TLS settings. |
| [tls_ciphersuites](#tls_ciphersuites-property-certificatevalidator-struct) | A list of ciphersuites separated with commas or semicolons. |
| [tls_client_auth](#tls_client_auth-property-certificatevalidator-struct) | Enables or disables certificate-based client authentication. |
| [tls_extensions](#tls_extensions-property-certificatevalidator-struct) | Provides access to TLS extensions. |
| [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property-certificatevalidator-struct) | Whether to force TLS session resumption when the destination address changes. |
| [tls_groups](#tls_groups-property-certificatevalidator-struct) | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| [tls_pre_shared_identity](#tls_pre_shared_identity-property-certificatevalidator-struct) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| [tls_pre_shared_key](#tls_pre_shared_key-property-certificatevalidator-struct) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| [tls_pre_shared_key_ciphersuite](#tls_pre_shared_key_ciphersuite-property-certificatevalidator-struct) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property-certificatevalidator-struct) | Selects the renegotiation attack prevention mechanism. |
| [tls_revocation_check](#tls_revocation_check-property-certificatevalidator-struct) | Specifies the kind(s) of revocation check to perform. |
| [tls_ssl_options](#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. |
| [tls_mode](#tls_mode-property-certificatevalidator-struct) | Specifies the TLS mode to use. |
| [tls_use_extended_master_secret](#tls_use_extended_master_secret-property-certificatevalidator-struct) | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| [tls_use_session_resumption](#tls_use_session_resumption-property-certificatevalidator-struct) | Enables or disables the TLS session resumption capability. |
| [tls_versions](#tls_versions-property-certificatevalidator-struct) | The SSL/TLS versions to enable by default. |
| [trusted_cert_count](#trusted_cert_count-property-certificatevalidator-struct) | The number of records in the TrustedCert arrays. |
| [trusted_cert_bytes](#trusted_cert_bytes-property-certificatevalidator-struct) | Returns the raw certificate data in DER format. |
| [trusted_cert_handle](#trusted_cert_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [used_cert_count](#used_cert_count-property-certificatevalidator-struct) | The number of records in the UsedCert arrays. |
| [used_cert_bytes](#used_cert_bytes-property-certificatevalidator-struct) | Returns the raw certificate data in DER format. |
| [used_cert_ca](#used_cert_ca-property-certificatevalidator-struct) | Indicates whether the certificate has a CA capability. |
| [used_cert_ca_key_id](#used_cert_ca_key_id-property-certificatevalidator-struct) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| [used_cert_cert_type](#used_cert_cert_type-property-certificatevalidator-struct) | Returns the type of the entity contained in the Certificate object. |
| [used_cert_crl_distribution_points](#used_cert_crl_distribution_points-property-certificatevalidator-struct) | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| [used_cert_curve](#used_cert_curve-property-certificatevalidator-struct) | Specifies the elliptic curve associated with the certificate's public key. |
| [used_cert_fingerprint](#used_cert_fingerprint-property-certificatevalidator-struct) | Contains the fingerprint (a hash imprint) of this certificate. |
| [used_cert_friendly_name](#used_cert_friendly_name-property-certificatevalidator-struct) | Contains an associated alias (friendly name) of the certificate. |
| [used_cert_handle](#used_cert_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [used_cert_hash_algorithm](#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). |
| [used_cert_issuer](#used_cert_issuer-property-certificatevalidator-struct) | The common name of the certificate issuer (CA), typically a company name. |
| [used_cert_issuer_rdn](#used_cert_issuer_rdn-property-certificatevalidator-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [used_cert_key_algorithm](#used_cert_key_algorithm-property-certificatevalidator-struct) | Specifies the public key algorithm of this certificate. |
| [used_cert_key_bits](#used_cert_key_bits-property-certificatevalidator-struct) | Returns the length of the public key in bits. |
| [used_cert_key_fingerprint](#used_cert_key_fingerprint-property-certificatevalidator-struct) | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| [used_cert_key_usage](#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. |
| [used_cert_key_valid](#used_cert_key_valid-property-certificatevalidator-struct) | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| [used_cert_ocsp_locations](#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. |
| [used_cert_ocsp_no_check](#used_cert_ocsp_no_check-property-certificatevalidator-struct) | Accessor to the value of the certificate's ocsp-no-check extension. |
| [used_cert_origin](#used_cert_origin-property-certificatevalidator-struct) | Returns the location that the certificate was taken or loaded from. |
| [used_cert_policy_i_ds](#used_cert_policy_i_ds-property-certificatevalidator-struct) | Contains identifiers (OIDs) of the applicable certificate policies. |
| [used_cert_private_key_bytes](#used_cert_private_key_bytes-property-certificatevalidator-struct) | Returns the certificate's private key in DER-encoded format. |
| [used_cert_private_key_exists](#used_cert_private_key_exists-property-certificatevalidator-struct) | Indicates whether the certificate has a usable private key associated with it. |
| [used_cert_private_key_extractable](#used_cert_private_key_extractable-property-certificatevalidator-struct) | Indicates whether the private key is extractable (exportable). |
| [used_cert_public_key_bytes](#used_cert_public_key_bytes-property-certificatevalidator-struct) | Contains the certificate's public key in DER format. |
| [used_cert_qualified](#used_cert_qualified-property-certificatevalidator-struct) | Indicates whether the certificate is qualified. |
| [used_cert_qualified_statements](#used_cert_qualified_statements-property-certificatevalidator-struct) | Returns a simplified qualified status of the certificate. |
| [used_cert_qualifiers](#used_cert_qualifiers-property-certificatevalidator-struct) | A list of qualifiers. |
| [used_cert_self_signed](#used_cert_self_signed-property-certificatevalidator-struct) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [used_cert_serial_number](#used_cert_serial_number-property-certificatevalidator-struct) | Returns the certificate's serial number. |
| [used_cert_sig_algorithm](#used_cert_sig_algorithm-property-certificatevalidator-struct) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [used_cert_source](#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. |
| [used_cert_subject](#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. |
| [used_cert_subject_alternative_name](#used_cert_subject_alternative_name-property-certificatevalidator-struct) | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| [used_cert_subject_key_id](#used_cert_subject_key_id-property-certificatevalidator-struct) | Contains a unique identifier of the certificate's cryptographic key. |
| [used_cert_subject_rdn](#used_cert_subject_rdn-property-certificatevalidator-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [used_cert_valid](#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. |
| [used_cert_valid_from](#used_cert_valid_from-property-certificatevalidator-struct) | The time point at which the certificate becomes valid, in UTC. |
| [used_cert_valid_to](#used_cert_valid_to-property-certificatevalidator-struct) | The time point at which the certificate expires, in UTC. |
| [used_crl_count](#used_crl_count-property-certificatevalidator-struct) | The number of records in the UsedCRL arrays. |
| [used_crl_bytes](#used_crl_bytes-property-certificatevalidator-struct) | Returns the raw CRL data in DER format. |
| [used_crl_handle](#used_crl_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [used_crl_issuer](#used_crl_issuer-property-certificatevalidator-struct) | The common name of the CRL issuer (CA), typically a company name. |
| [used_crl_issuer_rdn](#used_crl_issuer_rdn-property-certificatevalidator-struct) | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
| [used_crl_location](#used_crl_location-property-certificatevalidator-struct) | The URL that the CRL was downloaded from. |
| [used_crl_next_update](#used_crl_next_update-property-certificatevalidator-struct) | The planned time and date of the next version of this CRL to be published. |
| [used_crl_source](#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. |
| [used_crl_this_update](#used_crl_this_update-property-certificatevalidator-struct) | The date and time at which this version of the CRL was published. |
| [used_ocsp_count](#used_ocsp_count-property-certificatevalidator-struct) | The number of records in the UsedOCSP arrays. |
| [used_ocsp_bytes](#used_ocsp_bytes-property-certificatevalidator-struct) | A buffer containing the raw OCSP response data. |
| [used_ocsp_handle](#used_ocsp_handle-property-certificatevalidator-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [used_ocsp_issuer](#used_ocsp_issuer-property-certificatevalidator-struct) | Indicates the issuer of this response (a CA or its authorized representative). |
| [used_ocsp_issuer_rdn](#used_ocsp_issuer_rdn-property-certificatevalidator-struct) | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
| [used_ocsp_location](#used_ocsp_location-property-certificatevalidator-struct) | The location of the OCSP responder. |
| [used_ocsp_produced_at](#used_ocsp_produced_at-property-certificatevalidator-struct) | Specifies the time when the response was produced, in UTC. |
| [used_ocsp_source](#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. |
| [use_system_certificates](#use_system_certificates-property-certificatevalidator-struct) | Enables or disables the use of the system certificates. |
| [validation_log](#validation_log-property-certificatevalidator-struct) | Contains the complete log of the certificate validation routine. |
| [validation_moment](#validation_moment-property-certificatevalidator-struct) | The time point at which chain validity is to be established. |

## Method List

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

|  |  |
| --- | --- |
| [config](#config-method-certificatevalidator-struct) | Sets or retrieves a configuration setting. |
| [do_action](#do_action-method-certificatevalidator-struct) | Performs an additional action. |
| [get_qualified_status](#get_qualified_status-method-certificatevalidator-struct) | Obtains the qualified information for Certificate . |
| [get_trusted_list_property](#get_trusted_list_property-method-certificatevalidator-struct) | Returns a specific TrustedList property. |
| [refresh_cache](#refresh_cache-method-certificatevalidator-struct) | Refreshes the certificate cache. |
| [reset](#reset-method-certificatevalidator-struct) | Resets the struct settings. |
| [reset_cache](#reset_cache-method-certificatevalidator-struct) | Clears all data contained in the validation cache. |
| [terminate](#terminate-method-certificatevalidator-struct) | Terminates the validation process. |
| [validate](#validate-method-certificatevalidator-struct) | Validates the certificate chain. |
| [validate_for_smime](#validate_for_smime-method-certificatevalidator-struct) | Validates an e-mail signing certificate. |
| [validate_for_ssl](#validate_for_ssl-method-certificatevalidator-struct) | Validates a server-side SSL/TLS certificate. |

## 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.*

|  |  |
| --- | --- |
| [on_after_certificate_processing](#on_after_certificate_processing-event-certificatevalidator-struct) | Marks the end of a single certificate processing step. |
| [on_after_certificate_validation](#on_after_certificate_validation-event-certificatevalidator-struct) | Marks the end of a single certificate validation step. |
| [on_before_ca_certificate_download](#on_before_ca_certificate_download-event-certificatevalidator-struct) | Fires when a CA certificate is about to be downloaded. |
| [on_before_certificate_processing](#on_before_certificate_processing-event-certificatevalidator-struct) | Reports the start of certificate processing. |
| [on_before_certificate_validation](#on_before_certificate_validation-event-certificatevalidator-struct) | Reports the start of certificate validation. |
| [on_before_crl_download](#on_before_crl_download-event-certificatevalidator-struct) | Fires when a CRL is about to be downloaded. |
| [on_before_ocsp_download](#on_before_ocsp_download-event-certificatevalidator-struct) | Fires when a certificate's OCSP status is about to be requested. |
| [on_ca_certificate_downloaded](#on_ca_certificate_downloaded-event-certificatevalidator-struct) | Marks the success of a certificate download. |
| [on_ca_certificate_needed](#on_ca_certificate_needed-event-certificatevalidator-struct) | Requests a missing certificate from the user. |
| [on_crl_downloaded](#on_crl_downloaded-event-certificatevalidator-struct) | Marks the success of a CRL download. |
| [on_crl_needed](#on_crl_needed-event-certificatevalidator-struct) | Requests a missing CRL from the user. |
| [on_error](#on_error-event-certificatevalidator-struct) | Information about errors during certificate validation. |
| [on_notification](#on_notification-event-certificatevalidator-struct) | This event notifies the application about an underlying control flow event. |
| [on_ocsp_downloaded](#on_ocsp_downloaded-event-certificatevalidator-struct) | Marks the success of an OCSP request. |
| [on_tls_cert_needed](#on_tls_cert_needed-event-certificatevalidator-struct) | Fires when a remote TLS party requests a client certificate. |
| [on_tls_cert_validate](#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. |
| [on_tls_established](#on_tls_established-event-certificatevalidator-struct) | Fires when a TLS handshake with Host successfully completes. |
| [on_tls_handshake](#on_tls_handshake-event-certificatevalidator-struct) | Fires when a new TLS handshake is initiated, before the handshake commences. |
| [on_tls_shutdown](#on_tls_shutdown-event-certificatevalidator-struct) | Reports the graceful closure of a TLS connection. |

## Config Settings

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

|  |  |
| --- | --- |
| [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. |
| [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. |
| [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. |
| [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. |
| [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. |
| [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. |
| [CacheValidityTime](#CacheValidityTime) | Time period during which to keep validation cache. |
| [CheckStrongAlgorithmForTrusted](#CheckStrongAlgorithmForTrusted) | Whether to check a 'strong' hash algorithm for trusted certificates. |
| [CheckValidityPeriodForTrusted](#CheckValidityPeriodForTrusted) | Whether to check validity period for trusted certificates. |
| [CrossCertificationValidationStrategy](#CrossCertificationValidationStrategy) | Defines how the cross certification validation is performed. |
| [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. |
| [DislikeOpenEndedOCSPs](#DislikeOpenEndedOCSPs) | Tells the struct to discourage OCSP responses without an explicit NextUpdate parameter. |
| [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. |
| [EvaluateSystemTrustForSelfSignedCertificates](#EvaluateSystemTrustForSelfSignedCertificates) | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. |
| [EvaluateSystemTrustForSSL](#EvaluateSystemTrustForSSL) | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. |
| [ForceCompleteChainValidationForTrusted](#ForceCompleteChainValidationForTrusted) | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| [ForceRevocationCheckForRoot](#ForceRevocationCheckForRoot) | Whether to check revocation info for root certificates. |
| [IgnoreBadOCSPChains](#IgnoreBadOCSPChains) | Whether to ignore bad OCSP chains during validation. |
| [IgnoreCABasicConstraints](#IgnoreCABasicConstraints) | Whether to ignore the Basic Constraints extension for the CA certificates. |
| [IgnoreCAKeyUsage](#IgnoreCAKeyUsage) | Whether to ignore Key Usage extension for CA certificates. |
| [IgnoreCANameConstraints](#IgnoreCANameConstraints) | Whether to ignore the Name Constraints extension for the CA certificates. |
| [IgnoreChainLoops](#IgnoreChainLoops) | Whether chain loops should be ignored. |
| [IgnoreCRLIssuerKeyID](#IgnoreCRLIssuerKeyID) | Tells the validator to ignore malformed CRL issuer key IDs. |
| [IgnoreOCSPNoCheckExtension](#IgnoreOCSPNoCheckExtension) | Whether the OCSP NoCheck extension should be ignored. |
| [IgnoreRevocationKeyUsage](#IgnoreRevocationKeyUsage) | Whether to check the CA certs used to sign revocation info. |
| [IgnoreSSLKeyUsage](#IgnoreSSLKeyUsage) | Whether to check the CA certs used in SSL/TLS. |
| [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. |
| [ImplicitlyTrustSelfSignedCertificates](#ImplicitlyTrustSelfSignedCertificates) | Whether to trust self-signed certificates. |
| [LookupCRLByNameIfDPNotPresent](#LookupCRLByNameIfDPNotPresent) | Whether to look for implicit CRL Distribution Points. |
| [PromoteLongOCSPResponses](#PromoteLongOCSPResponses) | Whether long OCSP responses are requested. |
| [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. |
| [RevocationMomentGracePeriod](#RevocationMomentGracePeriod) | Grace period for revocation information propagation. |
| [SkipSubjectNameIfAltNameExists](#SkipSubjectNameIfAltNameExists) | Whether to check CommonName if SubjectAltName is present. |
| [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. |
| [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| [UseValidationCache](#UseValidationCache) | Enables or disable the use of the product-wide certificate chain validation cache. |
| [ValidateInvalidCertificates](#ValidateInvalidCertificates) | Whether to do all checks on invalid certificates. |
| [WeakAlgorithmHandlingMode](#WeakAlgorithmHandlingMode) | How to handle certificates signed with a 'weak' hash algorithm. |
| [CustomTrustedLists](#CustomTrustedLists) | Specifies the custom TrustedLists. |
| [CustomTSLs](#CustomTSLs) | Specifies the custom TrustedLists. |
| [DistributionPoints](#DistributionPoints) | Contains XML content of distribution points of the TSL used. |
| [HistoricalInformationPeriod](#HistoricalInformationPeriod) | Contains historical information period of the TSL used. |
| [LegalNotices](#LegalNotices) | Contains XML content of legal notices of the TSL used. |
| [ListIssueDateTime](#ListIssueDateTime) | Contains list issue date and time of the TSL used. |
| [NextUpdate](#NextUpdate) | Contains next update date and time of the TSL used. |
| [Policies](#Policies) | Contains XML content of policies of the TSL used. |
| [QualifiedStatus](#QualifiedStatus) | Indicates a qualified electronic signature. |
| [SchemeExtensions](#SchemeExtensions) | Contains XML content of scheme extensions of the TSL used. |
| [SchemeInformationURI](#SchemeInformationURI) | Contains XML content of scheme information URI of the TSL used. |
| [SchemeName](#SchemeName) | Contains XML content of scheme name of the TSL used. |
| [SchemeOperatorAddress](#SchemeOperatorAddress) | Contains XML content of scheme operator address of the TSL used. |
| [SchemeOperatorName](#SchemeOperatorName) | Contains XML content of scheme operator name of the TSL used. |
| [SchemeTerritory](#SchemeTerritory) | Contains scheme territory of the TSL used. |
| [SchemeTypeCommunityRules](#SchemeTypeCommunityRules) | Contains XML content of scheme type/community/rules of the TSL used. |
| [SequenceNumber](#SequenceNumber) | Contains sequence number of the TSL used. |
| [StatusDeterminationApproach](#StatusDeterminationApproach) | Contains status determination approach of the TSL used. |
| [TSLContent](#TSLContent) | Specifies the TrustedList content. |
| [TSLContentHex](#TSLContentHex) | Specifies the TrustedList content. |
| [TSLDistributionPoints](#TSLDistributionPoints) | Contains XML content of distribution points of the TSL used. |
| [TSLDistributionPoints\[Idx\]](#TSLDistributionPoints[Idx]) | Contains distribution point of the specified index of the TSL used. |
| [TSLHistoricalInformationPeriod](#TSLHistoricalInformationPeriod) | Contains historical information period of the TSL used. |
| [TSLLegalNotices](#TSLLegalNotices) | Contains XML content of legal notices of the TSL used. |
| [TSLLegalNotices\[lang\]](#TSLLegalNotices[lang]) | Contains legal notices for the specified language of the TSL used. |
| [TSLListIssueDateTime](#TSLListIssueDateTime) | Contains list issue date and time of the TSL used. |
| [TSLNextUpdate](#TSLNextUpdate) | Contains next update date and time of the TSL used. |
| [TSLPolicies](#TSLPolicies) | Contains XML content of policies of the TSL used. |
| [TSLPolicies\[lang\]](#TSLPolicies[lang]) | Contains policies for the specified language of the TSL used. |
| [TSLSchemeExtensions](#TSLSchemeExtensions) | Contains XML content of scheme extensions of the TSL used. |
| [TSLSchemeExtensions\[Idx\]](#TSLSchemeExtensions[Idx]) | Contains XML content of scheme extension of the specified index of the TSL used. |
| [TSLSchemeInformationURI](#TSLSchemeInformationURI) | Contains XML content of scheme information URI of the TSL used. |
| [TSLSchemeInformationURI\[lang\]](#TSLSchemeInformationURI[lang]) | Contains scheme information URI for the specified language of the TSL used. |
| [TSLSchemeName](#TSLSchemeName) | Contains XML content of scheme name of the TSL used. |
| [TSLSchemeName\[lang\]](#TSLSchemeName[lang]) | Contains scheme name for the specified language of the TSL used. |
| [TSLSchemeOperatorAddress](#TSLSchemeOperatorAddress) | Contains XML content of scheme operator address of the TSL used. |
| [TSLSchemeOperatorName](#TSLSchemeOperatorName) | Contains XML content of scheme operator name of the TSL used. |
| [TSLSchemeOperatorName\[lang\]](#TSLSchemeOperatorName[lang]) | Contains scheme operator name for the specified language of the TSL used. |
| [TSLSchemeTerritory](#TSLSchemeTerritory) | Contains scheme territory of the TSL used. |
| [TSLSchemeTypeCommunityRules](#TSLSchemeTypeCommunityRules) | Contains XML content of scheme type/community/rules of the TSL used. |
| [TSLSchemeTypeCommunityRules\[lang\]](#TSLSchemeTypeCommunityRules[lang]) | Contains scheme type/community/rules for the specified language of the TSL used. |
| [TSLSequenceNumber](#TSLSequenceNumber) | Contains sequence number of the TSL used. |
| [TSLsRetrieveLog](#TSLsRetrieveLog) | Contains the complete log of the TSLs retrieve. |
| [TSLStatusDeterminationApproach](#TSLStatusDeterminationApproach) | Contains status determination approach of the TSL used. |
| [TSLsValidationLog](#TSLsValidationLog) | Contains the complete log of the TSLs validation. |
| [TSLTSPAdditionalServiceInformation](#TSLTSPAdditionalServiceInformation) | Contains additional service information of the TSP service used. |
| [TSLTSPAddress](#TSLTSPAddress) | Contains XML content of the address of the TSP used. |
| [TSLTSPHistoryInstance](#TSLTSPHistoryInstance) | Indicates that TSP service history instance used. |
| [TSLTSPHistoryInstanceAdditionalServiceInformation](#TSLTSPHistoryInstanceAdditionalServiceInformation) | Contains additional service information of the TSP service history instance used. |
| [TSLTSPHistoryInstanceQualifiers](#TSLTSPHistoryInstanceQualifiers) | Contains list of qualifiers of the TSP service history instance used. |
| [TSLTSPHistoryInstanceServiceInformationExtensions](#TSLTSPHistoryInstanceServiceInformationExtensions) | Contains XML content of information extensions of the TSP service history instance used. |
| [TSLTSPHistoryInstanceServiceInformationExtensions\[Idx\]](#TSLTSPHistoryInstanceServiceInformationExtensions[Idx]) | Contains XML content of information extension of the specified index of the TSP service history instance used. |
| [TSLTSPHistoryInstanceServiceName](#TSLTSPHistoryInstanceServiceName) | Contains XML content of name of the TSP service history instance used. |
| [TSLTSPHistoryInstanceServiceName\[lang\]](#TSLTSPHistoryInstanceServiceName[lang]) | Contains name for the specified language of the TSP service history instance used. |
| [TSLTSPHistoryInstanceServiceStatus](#TSLTSPHistoryInstanceServiceStatus) | Contains status of the TSP service history instance used. |
| [TSLTSPHistoryInstanceServiceStatusStartingTime](#TSLTSPHistoryInstanceServiceStatusStartingTime) | Contains status starting time of the TSP service history instance used. |
| [TSLTSPHistoryInstanceServiceTypeIdentifier](#TSLTSPHistoryInstanceServiceTypeIdentifier) | Contains type identifier of the TSP service history instance used. |
| [TSLTSPHistoryInstanceXML](#TSLTSPHistoryInstanceXML) | Contains XML content of the TSP service history instance used. |
| [TSLTSPInformationExtensions](#TSLTSPInformationExtensions) | Contains XML content of information extensions of the TSP used. |
| [TSLTSPInformationExtensions\[Idx\]](#TSLTSPInformationExtensions[Idx]) | Contains XML content of information extension of the specified index of the TSP used. |
| [TSLTSPInformationURI](#TSLTSPInformationURI) | Contains XML content of information URI of the TSP used. |
| [TSLTSPInformationURI\[lang\]](#TSLTSPInformationURI[lang]) | Contains information URI for the specified language of the TSP used. |
| [TSLTSPName](#TSLTSPName) | Contains XML content of name of the TSP used. |
| [TSLTSPName\[lang\]](#TSLTSPName[lang]) | Contains name for the specified language of the TSP used. |
| [TSLTSPSchemeServiceDefinitionURI](#TSLTSPSchemeServiceDefinitionURI) | Contains XML content of scheme service definition URI of the TSP service used. |
| [TSLTSPSchemeServiceDefinitionURI\[lang\]](#TSLTSPSchemeServiceDefinitionURI[lang]) | Contains scheme service definition URI for the specified language of the TSP service used. |
| [TSLTSPServiceDefinitionURI](#TSLTSPServiceDefinitionURI) | Contains XML content of definition URI of the TSP service used. |
| [TSLTSPServiceDefinitionURI\[lang\]](#TSLTSPServiceDefinitionURI[lang]) | Contains definition URI for the specified language of the TSP service used. |
| [TSLTSPServiceInformationExtensions](#TSLTSPServiceInformationExtensions) | Contains XML content of information extensions of the TSP service used. |
| [TSLTSPServiceInformationExtensions\[Idx\]](#TSLTSPServiceInformationExtensions[Idx]) | Contains XML content of information extension of the specified index of the TSP service used. |
| [TSLTSPServiceName](#TSLTSPServiceName) | Contains XML content of name of the TSP service used. |
| [TSLTSPServiceName\[lang\]](#TSLTSPServiceName[lang]) | Contains name for the specified language of the TSP service used. |
| [TSLTSPServiceQualifiers](#TSLTSPServiceQualifiers) | Contains list of qualifiers of the TSP service used. |
| [TSLTSPServiceStatus](#TSLTSPServiceStatus) | Contains status of the TSP service used. |
| [TSLTSPServiceStatusStartingTime](#TSLTSPServiceStatusStartingTime) | Contains status starting time of the TSP service used. |
| [TSLTSPServiceSupplyPoints](#TSLTSPServiceSupplyPoints) | Contains XML content of the supply points of the TSP service used. |
| [TSLTSPServiceTypeIdentifier](#TSLTSPServiceTypeIdentifier) | Contains type identifier of the TSP service used. |
| [TSLTSPServiceXML](#TSLTSPServiceXML) | Contains XML content of the TSP service used. |
| [TSLTSPTradeName](#TSLTSPTradeName) | Contains XML content of trade name of the TSP used. |
| [TSLTSPTradeName\[lang\]](#TSLTSPTradeName[lang]) | Contains trade name for the specified language of the TSP used. |
| [TSLTSPXML](#TSLTSPXML) | Contains XML content of the TSP used. |
| [TSLType](#TSLType) | Contains TSL type of the TSL used. |
| [TSLVersionIdentifier](#TSLVersionIdentifier) | Contains version identifier of the TSL used. |
| [TSLXML](#TSLXML) | Contains XML content of the TSL used. |
| [TSPAdditionalServiceInformation](#TSPAdditionalServiceInformation) | Contains additional service information of the TSP service used. |
| [TSPAddress](#TSPAddress) | Contains XML content of the address of the TSP used. |
| [TSPHistoryInstance](#TSPHistoryInstance) | Indicates that TSP service history instance used. |
| [TSPHistoryInstanceAdditionalServiceInformation](#TSPHistoryInstanceAdditionalServiceInformation) | Contains additional service information of the TSP service history instance used. |
| [TSPHistoryInstanceQualifiers](#TSPHistoryInstanceQualifiers) | Contains list of qualifiers of the TSP service history instance used. |
| [TSPHistoryInstanceServiceInformationExtensions](#TSPHistoryInstanceServiceInformationExtensions) | Contains XML content of information extensions of the TSP service history instance used. |
| [TSPHistoryInstanceServiceName](#TSPHistoryInstanceServiceName) | Contains XML content of name of the TSP service history instance used. |
| [TSPHistoryInstanceServiceStatus](#TSPHistoryInstanceServiceStatus) | Contains status of the TSP service history instance used. |
| [TSPHistoryInstanceServiceStatusStartingTime](#TSPHistoryInstanceServiceStatusStartingTime) | Contains status starting time of the TSP service history instance used. |
| [TSPHistoryInstanceServiceTypeIdentifier](#TSPHistoryInstanceServiceTypeIdentifier) | Contains type identifier of the TSP service history instance used. |
| [TSPHistoryInstanceXML](#TSPHistoryInstanceXML) | Contains XML content of the TSP service history instance used. |
| [TSPInformationExtensions](#TSPInformationExtensions) | Contains XML content of information extensions of the TSP used. |
| [TSPInformationURI](#TSPInformationURI) | Contains XML content of information URI of the TSP used. |
| [TSPName](#TSPName) | Contains XML content of name of the TSP used. |
| [TSPSchemeServiceDefinitionURI](#TSPSchemeServiceDefinitionURI) | Contains XML content of scheme service definition URI of the TSP service used. |
| [TSPServiceDefinitionURI](#TSPServiceDefinitionURI) | Contains XML content of definition URI of the TSP service used. |
| [TSPServiceInformationExtensions](#TSPServiceInformationExtensions) | Contains XML content of information extensions of the TSP service used. |
| [TSPServiceName](#TSPServiceName) | Contains XML content of name of the TSP service used. |
| [TSPServiceQualifiers](#TSPServiceQualifiers) | Contains list of qualifiers of the TSP service used. |
| [TSPServiceStatus](#TSPServiceStatus) | Contains status of the TSP service used. |
| [TSPServiceStatusStartingTime](#TSPServiceStatusStartingTime) | Contains status starting time of the TSP service used. |
| [TSPServiceSupplyPoints](#TSPServiceSupplyPoints) | Contains XML content of the supply points of the TSP service used. |
| [TSPServiceTypeIdentifier](#TSPServiceTypeIdentifier) | Contains type identifier of the TSP service used. |
| [TSPServiceXML](#TSPServiceXML) | Contains XML content of the TSP service used. |
| [TSPTradeName](#TSPTradeName) | Contains XML content of trade name of the TSP used. |
| [TSPXML](#TSPXML) | Contains XML content of the TSP used. |
| [Type](#Type) | Contains TSL type of the TSL used. |
| [VersionIdentifier](#VersionIdentifier) | Contains version identifier of the TSL used. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the struct. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server structs. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server structs. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client structs created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client structs should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# blocked_cert_count property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The number of records in the BlockedCert arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [blocked_cert_handle](#blocked_cert_handle-property-certificatevalidator-struct)

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

## Data Type

i32

# blocked_cert_bytes property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
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](#blocked_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# blocked_cert_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#blocked_cert_count-property-certificatevalidator-struct) property.

## Data Type

i64

# cache_validation_results property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Enables or disables validation result caching.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

## Data Type

i64

# chain_validation_details property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The details of a certificate chain validation outcome.

## Syntax

*Rust Syntax*

```text
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:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

This property is read-only.

## Data Type

i32

# chain_validation_result property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) 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

*Rust Syntax*

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

## Possible Values

```text
0   // Valid1   // ValidButUntrusted2   // Invalid3   // CantBeEstablished
```

## Default Value

0

## Remarks

Available options:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

## Data Type

i32

# check_trusted_lists property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Indicates whether the certificate has a CA capability.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#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](#current_ca_cert_subject_key_id-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // X509Certificate2   // X509CertificateRequest
```

## Default Value

0

## Remarks

Returns the type of the entity contained in the [Certificate](#Type_Certificate) object.

A [Certificate](#Type_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](#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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

|  |  |  |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 |  |
| SB_EC_SECP112R2 | SECP112R2 |  |
| SB_EC_SECP128R1 | SECP128R1 |  |
| SB_EC_SECP128R2 | SECP128R2 |  |
| SB_EC_SECP160K1 | SECP160K1 |  |
| SB_EC_SECP160R1 | SECP160R1 |  |
| SB_EC_SECP160R2 | SECP160R2 |  |
| SB_EC_SECP192K1 | SECP192K1 |  |
| SB_EC_SECP192R1 | SECP192R1 |  |
| SB_EC_SECP224K1 | SECP224K1 |  |
| SB_EC_SECP224R1 | SECP224R1 |  |
| SB_EC_SECP256K1 | SECP256K1 |  |
| SB_EC_SECP256R1 | SECP256R1 |  |
| SB_EC_SECP384R1 | SECP384R1 |  |
| SB_EC_SECP521R1 | SECP521R1 |  |
| SB_EC_SECT113R1 | SECT113R1 |  |
| SB_EC_SECT113R2 | SECT113R2 |  |
| SB_EC_SECT131R1 | SECT131R1 |  |
| SB_EC_SECT131R2 | SECT131R2 |  |
| SB_EC_SECT163K1 | SECT163K1 |  |
| SB_EC_SECT163R1 | SECT163R1 |  |
| SB_EC_SECT163R2 | SECT163R2 |  |
| SB_EC_SECT193R1 | SECT193R1 |  |
| SB_EC_SECT193R2 | SECT193R2 |  |
| SB_EC_SECT233K1 | SECT233K1 |  |
| SB_EC_SECT233R1 | SECT233R1 |  |
| SB_EC_SECT239K1 | SECT239K1 |  |
| SB_EC_SECT283K1 | SECT283K1 |  |
| SB_EC_SECT283R1 | SECT283R1 |  |
| SB_EC_SECT409K1 | SECT409K1 |  |
| SB_EC_SECT409R1 | SECT409R1 |  |
| SB_EC_SECT571K1 | SECT571K1 |  |
| SB_EC_SECT571R1 | SECT571R1 |  |
| SB_EC_PRIME192V1 | PRIME192V1 |  |
| SB_EC_PRIME192V2 | PRIME192V2 |  |
| SB_EC_PRIME192V3 | PRIME192V3 |  |
| SB_EC_PRIME239V1 | PRIME239V1 |  |
| SB_EC_PRIME239V2 | PRIME239V2 |  |
| SB_EC_PRIME239V3 | PRIME239V3 |  |
| SB_EC_PRIME256V1 | PRIME256V1 |  |
| SB_EC_C2PNB163V1 | C2PNB163V1 |  |
| SB_EC_C2PNB163V2 | C2PNB163V2 |  |
| SB_EC_C2PNB163V3 | C2PNB163V3 |  |
| SB_EC_C2PNB176W1 | C2PNB176W1 |  |
| SB_EC_C2TNB191V1 | C2TNB191V1 |  |
| SB_EC_C2TNB191V2 | C2TNB191V2 |  |
| SB_EC_C2TNB191V3 | C2TNB191V3 |  |
| SB_EC_C2ONB191V4 | C2ONB191V4 |  |
| SB_EC_C2ONB191V5 | C2ONB191V5 |  |
| SB_EC_C2PNB208W1 | C2PNB208W1 |  |
| SB_EC_C2TNB239V1 | C2TNB239V1 |  |
| SB_EC_C2TNB239V2 | C2TNB239V2 |  |
| SB_EC_C2TNB239V3 | C2TNB239V3 |  |
| SB_EC_C2ONB239V4 | C2ONB239V4 |  |
| SB_EC_C2ONB239V5 | C2ONB239V5 |  |
| SB_EC_C2PNB272W1 | C2PNB272W1 |  |
| SB_EC_C2PNB304W1 | C2PNB304W1 |  |
| SB_EC_C2TNB359V1 | C2TNB359V1 |  |
| SB_EC_C2PNB368W1 | C2PNB368W1 |  |
| SB_EC_C2TNB431R1 | C2TNB431R1 |  |
| SB_EC_NISTP192 | NISTP192 |  |
| SB_EC_NISTP224 | NISTP224 |  |
| SB_EC_NISTP256 | NISTP256 |  |
| SB_EC_NISTP384 | NISTP384 |  |
| SB_EC_NISTP521 | NISTP521 |  |
| SB_EC_NISTB163 | NISTB163 |  |
| SB_EC_NISTB233 | NISTB233 |  |
| SB_EC_NISTB283 | NISTB283 |  |
| SB_EC_NISTB409 | NISTB409 |  |
| SB_EC_NISTB571 | NISTB571 |  |
| SB_EC_NISTK163 | NISTK163 |  |
| SB_EC_NISTK233 | NISTK233 |  |
| SB_EC_NISTK283 | NISTK283 |  |
| SB_EC_NISTK409 | NISTK409 |  |
| SB_EC_NISTK571 | NISTK571 |  |
| SB_EC_GOSTCPTEST | GOSTCPTEST |  |
| SB_EC_GOSTCPA | GOSTCPA |  |
| SB_EC_GOSTCPB | GOSTCPB |  |
| SB_EC_GOSTCPC | GOSTCPC |  |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA |  |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB |  |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 |  |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 |  |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 |  |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 |  |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 |  |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 |  |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 |  |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 |  |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 |  |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 |  |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 |  |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 |  |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 |  |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 |  |
| SB_EC_CURVE25519 | CURVE25519 |  |
| SB_EC_CURVE448 | CURVE448 |  |

This property is read-only.

## Data Type

String

# current_ca_cert_fingerprint property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

This property is read-only.

## Data Type

i64

# current_ca_cert_hash_algorithm property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) 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

*Rust Syntax*

```text
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](#current_ca_cert_sig_algorithm-property-certificatevalidator-struct) to find out the hash algorithm that is part of the certificate signature.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

This property is read-only.

## Data Type

String

# current_ca_cert_issuer property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_ca_cert_issuer_rdn-property-certificatevalidator-struct).

This property is read-only.

## Data Type

String

# current_ca_cert_issuer_rdn property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Specifies the public key algorithm of this certificate.

## Syntax

*Rust Syntax*

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

## Default Value

"0"

## Remarks

Specifies the public key algorithm of this certificate.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [current_ca_cert_key_bits](#current_ca_cert_key_bits-property-certificatevalidator-struct), [current_ca_cert_curve](#current_ca_cert_curve-property-certificatevalidator-struct), and [current_ca_cert_public_key_bytes](#current_ca_cert_public_key_bytes-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

Returns the length of the public key in bits.

## Syntax

*Rust Syntax*

```text
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](#current_ca_cert_public_key_bytes-property-certificatevalidator-struct) or [current_ca_cert_private_key_bytes](#current_ca_cert_private_key_bytes-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_ca_cert_fingerprint-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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:

|  |  |  |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |

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

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#CertificateManager_m_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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_ca_cert_private_key_bytes-property-certificatevalidator-struct), 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-secureblackboxcertificatevalidator) Struct)

Indicates whether the private key is extractable (exportable).

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the certificate's public key in DER format.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Indicates whether the certificate is qualified.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Returns a simplified qualified status of the certificate.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // NonQualified1   // QualifiedHardware2   // 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-secureblackboxcertificatevalidator) Struct)

A list of qualifiers.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Returns the certificate's serial number.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // Signature2   // Document3   // User4   // Local5   // 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_ca_cert_subject_rdn-property-certificatevalidator-struct).

This property is read-only.

## Data Type

String

# current_ca_cert_subject_alternative_name property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_ca_cert_subject_rdn-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_ca_cert_subject_key_id-property-certificatevalidator-struct) and [current_ca_cert_ca_key_id](#current_ca_cert_ca_key_id-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) 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

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Indicates whether the certificate has a CA capability.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#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](#current_cert_subject_key_id-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // X509Certificate2   // X509CertificateRequest
```

## Default Value

0

## Remarks

Returns the type of the entity contained in the [Certificate](#Type_Certificate) object.

A [Certificate](#Type_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](#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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

|  |  |  |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 |  |
| SB_EC_SECP112R2 | SECP112R2 |  |
| SB_EC_SECP128R1 | SECP128R1 |  |
| SB_EC_SECP128R2 | SECP128R2 |  |
| SB_EC_SECP160K1 | SECP160K1 |  |
| SB_EC_SECP160R1 | SECP160R1 |  |
| SB_EC_SECP160R2 | SECP160R2 |  |
| SB_EC_SECP192K1 | SECP192K1 |  |
| SB_EC_SECP192R1 | SECP192R1 |  |
| SB_EC_SECP224K1 | SECP224K1 |  |
| SB_EC_SECP224R1 | SECP224R1 |  |
| SB_EC_SECP256K1 | SECP256K1 |  |
| SB_EC_SECP256R1 | SECP256R1 |  |
| SB_EC_SECP384R1 | SECP384R1 |  |
| SB_EC_SECP521R1 | SECP521R1 |  |
| SB_EC_SECT113R1 | SECT113R1 |  |
| SB_EC_SECT113R2 | SECT113R2 |  |
| SB_EC_SECT131R1 | SECT131R1 |  |
| SB_EC_SECT131R2 | SECT131R2 |  |
| SB_EC_SECT163K1 | SECT163K1 |  |
| SB_EC_SECT163R1 | SECT163R1 |  |
| SB_EC_SECT163R2 | SECT163R2 |  |
| SB_EC_SECT193R1 | SECT193R1 |  |
| SB_EC_SECT193R2 | SECT193R2 |  |
| SB_EC_SECT233K1 | SECT233K1 |  |
| SB_EC_SECT233R1 | SECT233R1 |  |
| SB_EC_SECT239K1 | SECT239K1 |  |
| SB_EC_SECT283K1 | SECT283K1 |  |
| SB_EC_SECT283R1 | SECT283R1 |  |
| SB_EC_SECT409K1 | SECT409K1 |  |
| SB_EC_SECT409R1 | SECT409R1 |  |
| SB_EC_SECT571K1 | SECT571K1 |  |
| SB_EC_SECT571R1 | SECT571R1 |  |
| SB_EC_PRIME192V1 | PRIME192V1 |  |
| SB_EC_PRIME192V2 | PRIME192V2 |  |
| SB_EC_PRIME192V3 | PRIME192V3 |  |
| SB_EC_PRIME239V1 | PRIME239V1 |  |
| SB_EC_PRIME239V2 | PRIME239V2 |  |
| SB_EC_PRIME239V3 | PRIME239V3 |  |
| SB_EC_PRIME256V1 | PRIME256V1 |  |
| SB_EC_C2PNB163V1 | C2PNB163V1 |  |
| SB_EC_C2PNB163V2 | C2PNB163V2 |  |
| SB_EC_C2PNB163V3 | C2PNB163V3 |  |
| SB_EC_C2PNB176W1 | C2PNB176W1 |  |
| SB_EC_C2TNB191V1 | C2TNB191V1 |  |
| SB_EC_C2TNB191V2 | C2TNB191V2 |  |
| SB_EC_C2TNB191V3 | C2TNB191V3 |  |
| SB_EC_C2ONB191V4 | C2ONB191V4 |  |
| SB_EC_C2ONB191V5 | C2ONB191V5 |  |
| SB_EC_C2PNB208W1 | C2PNB208W1 |  |
| SB_EC_C2TNB239V1 | C2TNB239V1 |  |
| SB_EC_C2TNB239V2 | C2TNB239V2 |  |
| SB_EC_C2TNB239V3 | C2TNB239V3 |  |
| SB_EC_C2ONB239V4 | C2ONB239V4 |  |
| SB_EC_C2ONB239V5 | C2ONB239V5 |  |
| SB_EC_C2PNB272W1 | C2PNB272W1 |  |
| SB_EC_C2PNB304W1 | C2PNB304W1 |  |
| SB_EC_C2TNB359V1 | C2TNB359V1 |  |
| SB_EC_C2PNB368W1 | C2PNB368W1 |  |
| SB_EC_C2TNB431R1 | C2TNB431R1 |  |
| SB_EC_NISTP192 | NISTP192 |  |
| SB_EC_NISTP224 | NISTP224 |  |
| SB_EC_NISTP256 | NISTP256 |  |
| SB_EC_NISTP384 | NISTP384 |  |
| SB_EC_NISTP521 | NISTP521 |  |
| SB_EC_NISTB163 | NISTB163 |  |
| SB_EC_NISTB233 | NISTB233 |  |
| SB_EC_NISTB283 | NISTB283 |  |
| SB_EC_NISTB409 | NISTB409 |  |
| SB_EC_NISTB571 | NISTB571 |  |
| SB_EC_NISTK163 | NISTK163 |  |
| SB_EC_NISTK233 | NISTK233 |  |
| SB_EC_NISTK283 | NISTK283 |  |
| SB_EC_NISTK409 | NISTK409 |  |
| SB_EC_NISTK571 | NISTK571 |  |
| SB_EC_GOSTCPTEST | GOSTCPTEST |  |
| SB_EC_GOSTCPA | GOSTCPA |  |
| SB_EC_GOSTCPB | GOSTCPB |  |
| SB_EC_GOSTCPC | GOSTCPC |  |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA |  |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB |  |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 |  |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 |  |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 |  |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 |  |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 |  |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 |  |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 |  |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 |  |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 |  |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 |  |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 |  |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 |  |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 |  |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 |  |
| SB_EC_CURVE25519 | CURVE25519 |  |
| SB_EC_CURVE448 | CURVE448 |  |

This property is read-only.

## Data Type

String

# current_cert_fingerprint property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

This property is read-only.

## Data Type

i64

# current_cert_hash_algorithm property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) 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

*Rust Syntax*

```text
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](#current_cert_sig_algorithm-property-certificatevalidator-struct) to find out the hash algorithm that is part of the certificate signature.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

This property is read-only.

## Data Type

String

# current_cert_issuer property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_cert_issuer_rdn-property-certificatevalidator-struct).

This property is read-only.

## Data Type

String

# current_cert_issuer_rdn property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Specifies the public key algorithm of this certificate.

## Syntax

*Rust Syntax*

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

## Default Value

"0"

## Remarks

Specifies the public key algorithm of this certificate.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [current_cert_key_bits](#current_cert_key_bits-property-certificatevalidator-struct), [current_cert_curve](#current_cert_curve-property-certificatevalidator-struct), and [current_cert_public_key_bytes](#current_cert_public_key_bytes-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

Returns the length of the public key in bits.

## Syntax

*Rust Syntax*

```text
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](#current_cert_public_key_bytes-property-certificatevalidator-struct) or [current_cert_private_key_bytes](#current_cert_private_key_bytes-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_cert_fingerprint-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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:

|  |  |  |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |

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

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#CertificateManager_m_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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_cert_private_key_bytes-property-certificatevalidator-struct), 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-secureblackboxcertificatevalidator) Struct)

Indicates whether the private key is extractable (exportable).

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the certificate's public key in DER format.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Indicates whether the certificate is qualified.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Returns a simplified qualified status of the certificate.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // NonQualified1   // QualifiedHardware2   // 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-secureblackboxcertificatevalidator) Struct)

A list of qualifiers.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Returns the certificate's serial number.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // Signature2   // Document3   // User4   // Local5   // 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_cert_subject_rdn-property-certificatevalidator-struct).

This property is read-only.

## Data Type

String

# current_cert_subject_alternative_name property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_cert_subject_rdn-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#current_cert_subject_key_id-property-certificatevalidator-struct) and [current_cert_ca_key_id](#current_cert_ca_key_id-property-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) 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

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Reserved.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Specifies a grace period to apply during certificate validation.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the validation details of the moment.

## Syntax

*Rust Syntax*

```text
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:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

## Data Type

i32

# interim_validation_result property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Contains the validation status of the moment.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Valid1   // ValidButUntrusted2   // Invalid3   // 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.

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

## Data Type

i32

# known_cert_count property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The number of records in the KnownCert arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [known_cert_handle](#known_cert_handle-property-certificatevalidator-struct)

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

## Data Type

i32

# known_cert_bytes property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
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](#known_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# known_cert_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#known_cert_count-property-certificatevalidator-struct) property.

## Data Type

i64

# known_crl_count property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The number of records in the KnownCRL arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [known_crl_handle](#known_crl_handle-property-certificatevalidator-struct)

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

## Data Type

i32

# known_crl_bytes property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns the raw CRL data in DER format.

## Syntax

*Rust Syntax*

```text
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](#known_crl_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# known_crl_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#known_crl_count-property-certificatevalidator-struct) property.

## Data Type

i64

# known_ocsp_count property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The number of records in the KnownOCSP arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [known_ocsp_handle](#known_ocsp_handle-property-certificatevalidator-struct)

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

## Data Type

i32

# known_ocsp_bytes property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

A buffer containing the raw OCSP response data.

## Syntax

*Rust Syntax*

```text
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](#known_ocsp_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# known_ocsp_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#known_ocsp_count-property-certificatevalidator-struct) property.

## Data Type

i64

# max_validation_time property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Specifies the maximum time the validation process may take.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Switches the struct to offline mode.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The IP address of the proxy server.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The authentication type used by the proxy server.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // NoAuthentication1   // Basic2   // Digest3   // NTLM
```

## Default Value

0

## Remarks

The authentication type used by the proxy server.

|  |  |
| --- | --- |
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |

## Data Type

i32

# proxy_password property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The password to authenticate to the proxy server.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The port on the proxy server to connect to.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The type of the proxy server.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // None1   // Socks42   // Socks53   // WebTunnel4   // HTTP
```

## Default Value

0

## Remarks

The type of the proxy server.

|  |  |
| --- | --- |
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |

## Data Type

i32

# proxy_request_headers property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Contains HTTP request headers for WebTunnel and HTTP proxy.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Specifies the username credential for proxy authentication.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the address of the TSL provider.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The list of custom TrustedLists to use.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the TLS download log.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the URI of the provider information.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The preferred language(s) for TSL data.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Returns the next update date and time of the TSL.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the name of the TSL provider.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Indicates whether the certificate is qualified.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

A list of qualifiers.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the name of the TSL service.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the TSL service type identifier.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The source of qualified information.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // Certificate2   // TSL3   // Both
```

## Default Value

0

## Remarks

The source of qualified information.

Available options:

|  |  |  |
| --- | --- | --- |
| qisUnknown | 0 | The source is unknown |
| qisCertificate | 1 | The information was taken from the certificate |
| qisTSL | 2 | The information was taken from an online TSL |
| qisBoth | 3 | The information was taken from both the certificate and an online TSL |

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

Indicates a qualified electronic signature.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // None2   // Granted3   // Withdrawn4   // SetByNationalLaw5   // DeprecatedByNationalLaw6   // RecognizedAtNationalLevel7   // DeprecatedAtNationalLevel8   // UnderSupervision9   // SupervisionInCessation10   // SupervisionCeased11   // SupervisionRevoked12   // Accredited13   // AccreditationCeased14   // AccreditationRevoked15   // InAccordance16   // Expired17   // Suspended18   // Revoked19   // 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:

|  |  |  |
| --- | --- | --- |
| sqsUnknown | 0 | Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI. |
| sqsNone | 1 | None |
| sqsGranted | 2 | Granted |
| sqsWithdrawn | 3 | Withdrawn |
| sqsSetByNationalLaw | 4 | Set by national law |
| sqsDeprecatedByNationalLaw | 5 | Deprecated by national law |
| sqsRecognizedAtNationalLevel | 6 | Recognized at national level |
| sqsDeprecatedAtNationalLevel | 7 | Deprecated at national level |
| sqsUnderSupervision | 8 | Under supervision |
| sqsSupervisionInCessation | 9 | Supervision in cessation |
| sqsSupervisionCeased | 10 | Supervision ceased |
| sqsSupervisionRevoked | 11 | Supervision revoked |
| sqsAccredited | 12 | Accredited |
| sqsAccreditationCeased | 13 | Accreditation ceased |
| sqsAccreditationRevoked | 14 | Accreditation revoked |
| sqsInAccordance | 15 | Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
| sqsExpired | 16 | Deprecated. The subject service is no longer overseen by the scheme, e.g. due to nonrenewal or withdrawal by the TSP, or cessation of the service or the scheme's operations. |
| sqsSuspended | 17 | Deprecated. The subject service's status is temporarily uncertain whilst checks are made by the scheme operator (typically e.g. while a revocation request is being investigated or if action is required to resolve a deficiency in the service fulfilling the scheme's criteria. |
| sqsRevoked | 18 | Deprecated. The subject service's approved status has been revoked because it is no longer in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
| sqsNotInAccordance | 19 | Deprecated. The subject service is not in accordance with the scheme's specific status determination criteria (only for use in negative approval schemes). |

This property is read-only.

## Data Type

i32

# qualified_info_trade_name property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Contains the trade name of the TSL provider.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Indicates whether the certificate is trusted.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the TLS validation log.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the XML of the TSL.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // None1   // Auto2   // AllCRL3   // AllOCSP4   // AllCRLAndOCSP5   // AnyCRL6   // AnyOCSP7   // AnyCRLOrOCSP8   // 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.

|  |  |  |
| --- | --- | --- |
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |

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

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Auto1   // Platform2   // Own3   // 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.

|  |  |
| --- | --- |
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |

## Data Type

i32

# socket_dns_port property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The timeout (in milliseconds) for each DNS query.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The local network interface to bind the socket to.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The local port number to bind the socket to.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Enables or disables IP protocol version 6.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The number of records in the TLSClientCert arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [tls_client_cert_handle](#tls_client_cert_handle-property-certificatevalidator-struct)

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

## Data Type

i32

# tls_client_cert_bytes property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
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](#tls_client_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# tls_client_cert_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#tls_client_cert_count-property-certificatevalidator-struct) property.

## Data Type

i64

# tls_server_cert_count property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The number of records in the TLSServerCert arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property-certificatevalidator-struct)
- [tls_server_cert_handle](#tls_server_cert_handle-property-certificatevalidator-struct)
- [tls_server_cert_issuer](#tls_server_cert_issuer-property-certificatevalidator-struct)
- [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property-certificatevalidator-struct)
- [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property-certificatevalidator-struct)
- [tls_server_cert_key_bits](#tls_server_cert_key_bits-property-certificatevalidator-struct)
- [tls_server_cert_key_usage](#tls_server_cert_key_usage-property-certificatevalidator-struct)
- [tls_server_cert_self_signed](#tls_server_cert_self_signed-property-certificatevalidator-struct)
- [tls_server_cert_serial_number](#tls_server_cert_serial_number-property-certificatevalidator-struct)
- [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property-certificatevalidator-struct)
- [tls_server_cert_subject](#tls_server_cert_subject-property-certificatevalidator-struct)
- [tls_server_cert_subject_rdn](#tls_server_cert_subject_rdn-property-certificatevalidator-struct)
- [tls_server_cert_valid_from](#tls_server_cert_valid_from-property-certificatevalidator-struct)
- [tls_server_cert_valid_to](#tls_server_cert_valid_to-property-certificatevalidator-struct)

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

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# tls_server_cert_fingerprint property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i64

# tls_server_cert_issuer property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#CertificateValidator_p_TLSIssuerRDN).

The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_issuer_rdn property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_key_algorithm property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Specifies the public key algorithm of this certificate.

## Syntax

*Rust Syntax*

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

## Default Value

"0"

## Remarks

Specifies the public key algorithm of this certificate.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [tls_key_bits](#CertificateValidator_p_TLSKeyBits), [tls_curve](#CertificateValidator_p_TLSCurve), and [tls_public_key_bytes](#CertificateValidator_p_TLSPublicKeyBytes) properties to get more details about the key the certificate contains.

The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_key_bits property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns the length of the public key in bits.

## Syntax

*Rust Syntax*

```text
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](#CertificateValidator_p_TLSPublicKeyBytes) or [tls_private_key_bytes](#CertificateValidator_p_TLSPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer.

The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# tls_server_cert_key_usage property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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:

|  |  |  |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |

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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# tls_server_cert_self_signed property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

bool

# tls_server_cert_serial_number property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns the certificate's serial number.

## Syntax

*Rust Syntax*

```text
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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# tls_server_cert_sig_algorithm property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_subject property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#CertificateValidator_p_TLSSubjectRDN).

The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_subject_rdn property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_valid_from property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_valid_to property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#tls_server_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# tls_auto_validate_certificates property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Selects the base configuration for the TLS settings.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Default1   // Compatible2   // ComprehensiveInsecure3   // 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.

|  |  |  |
| --- | --- | --- |
| stpcDefault | 0 |  |
| stpcCompatible | 1 |  |
| stpcComprehensiveInsecure | 2 |  |
| stpcHighlySecure | 3 |  |

## Data Type

i32

# tls_ciphersuites property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

A list of ciphersuites separated with commas or semicolons.

## Syntax

*Rust Syntax*

```text
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](#tls_base_configuration-property-certificatevalidator-struct). 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-secureblackboxcertificatevalidator) Struct)

Enables or disables certificate-based client authentication.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // NoAuth1   // RequestCert2   // RequireCert
```

## Default Value

0

## Remarks

Enables or disables certificate-based client authentication.

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

|  |  |  |
| --- | --- | --- |
| ccatNoAuth | 0 |  |
| ccatRequestCert | 1 |  |
| ccatRequireCert | 2 |  |

## Data Type

i32

# tls_extensions property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Provides access to TLS extensions.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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:

```text
  // 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Selects the renegotiation attack prevention mechanism.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Compatible1   // Strict2   // Auto
```

## Default Value

2

## Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

|  |  |  |
| --- | --- | --- |
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |

## Data Type

i32

# tls_revocation_check property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // None1   // Auto2   // AllCRL3   // AllOCSP4   // AllCRLAndOCSP5   // AnyCRL6   // AnyOCSP7   // AnyCRLOrOCSP8   // 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.

|  |  |  |
| --- | --- | --- |
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |

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

*Rust Syntax*

```text
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

|  |  |  |
| --- | --- | --- |
| 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. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |

## Data Type

i32

# tls_mode property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Specifies the TLS mode to use.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Default1   // NoTLS2   // ExplicitTLS3   // ImplicitTLS4   // MixedTLS
```

## Default Value

0

## Remarks

Specifies the TLS mode to use.

|  |  |  |
| --- | --- | --- |
| smDefault | 0 |  |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |

## Data Type

i32

# tls_use_extended_master_secret property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Enables or disables the TLS session resumption capability.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

The SSL/TLS versions to enable by default.

## Syntax

*Rust Syntax*

```text
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.

|  |  |  |
| --- | --- | --- |
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |

## Data Type

i32

# trusted_cert_count property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The number of records in the TrustedCert arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [trusted_cert_handle](#trusted_cert_handle-property-certificatevalidator-struct)

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

## Data Type

i32

# trusted_cert_bytes property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
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](#trusted_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# trusted_cert_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#trusted_cert_count-property-certificatevalidator-struct) property.

## Data Type

i64

# used_cert_count property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The number of records in the UsedCert arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [used_cert_ca](#used_cert_ca-property-certificatevalidator-struct)
- [used_cert_ca_key_id](#used_cert_ca_key_id-property-certificatevalidator-struct)
- [used_cert_cert_type](#used_cert_cert_type-property-certificatevalidator-struct)
- [used_cert_crl_distribution_points](#used_cert_crl_distribution_points-property-certificatevalidator-struct)
- [used_cert_curve](#used_cert_curve-property-certificatevalidator-struct)
- [used_cert_fingerprint](#used_cert_fingerprint-property-certificatevalidator-struct)
- [used_cert_friendly_name](#used_cert_friendly_name-property-certificatevalidator-struct)
- [used_cert_handle](#used_cert_handle-property-certificatevalidator-struct)
- [used_cert_hash_algorithm](#used_cert_hash_algorithm-property-certificatevalidator-struct)
- [used_cert_issuer](#used_cert_issuer-property-certificatevalidator-struct)
- [used_cert_issuer_rdn](#used_cert_issuer_rdn-property-certificatevalidator-struct)
- [used_cert_key_algorithm](#used_cert_key_algorithm-property-certificatevalidator-struct)
- [used_cert_key_bits](#used_cert_key_bits-property-certificatevalidator-struct)
- [used_cert_key_fingerprint](#used_cert_key_fingerprint-property-certificatevalidator-struct)
- [used_cert_key_usage](#used_cert_key_usage-property-certificatevalidator-struct)
- [used_cert_key_valid](#used_cert_key_valid-property-certificatevalidator-struct)
- [used_cert_ocsp_locations](#used_cert_ocsp_locations-property-certificatevalidator-struct)
- [used_cert_ocsp_no_check](#used_cert_ocsp_no_check-property-certificatevalidator-struct)
- [used_cert_origin](#used_cert_origin-property-certificatevalidator-struct)
- [used_cert_policy_i_ds](#used_cert_policy_i_ds-property-certificatevalidator-struct)
- [used_cert_private_key_bytes](#used_cert_private_key_bytes-property-certificatevalidator-struct)
- [used_cert_private_key_exists](#used_cert_private_key_exists-property-certificatevalidator-struct)
- [used_cert_private_key_extractable](#used_cert_private_key_extractable-property-certificatevalidator-struct)
- [used_cert_public_key_bytes](#used_cert_public_key_bytes-property-certificatevalidator-struct)
- [used_cert_qualified](#used_cert_qualified-property-certificatevalidator-struct)
- [used_cert_qualified_statements](#used_cert_qualified_statements-property-certificatevalidator-struct)
- [used_cert_qualifiers](#used_cert_qualifiers-property-certificatevalidator-struct)
- [used_cert_self_signed](#used_cert_self_signed-property-certificatevalidator-struct)
- [used_cert_serial_number](#used_cert_serial_number-property-certificatevalidator-struct)
- [used_cert_sig_algorithm](#used_cert_sig_algorithm-property-certificatevalidator-struct)
- [used_cert_source](#used_cert_source-property-certificatevalidator-struct)
- [used_cert_subject](#used_cert_subject-property-certificatevalidator-struct)
- [used_cert_subject_alternative_name](#used_cert_subject_alternative_name-property-certificatevalidator-struct)
- [used_cert_subject_key_id](#used_cert_subject_key_id-property-certificatevalidator-struct)
- [used_cert_subject_rdn](#used_cert_subject_rdn-property-certificatevalidator-struct)
- [used_cert_valid](#used_cert_valid-property-certificatevalidator-struct)
- [used_cert_valid_from](#used_cert_valid_from-property-certificatevalidator-struct)
- [used_cert_valid_to](#used_cert_valid_to-property-certificatevalidator-struct)

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

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# used_cert_ca property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Indicates whether the certificate has a CA capability.

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

bool

# used_cert_ca_key_id property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#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](#used_cert_subject_key_id-property-certificatevalidator-struct) 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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# used_cert_cert_type property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // X509Certificate2   // X509CertificateRequest
```

## Default Value

0

## Remarks

Returns the type of the entity contained in the [Certificate](#Type_Certificate) object.

A [Certificate](#Type_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](#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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# used_cert_crl_distribution_points property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_curve property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

|  |  |  |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 |  |
| SB_EC_SECP112R2 | SECP112R2 |  |
| SB_EC_SECP128R1 | SECP128R1 |  |
| SB_EC_SECP128R2 | SECP128R2 |  |
| SB_EC_SECP160K1 | SECP160K1 |  |
| SB_EC_SECP160R1 | SECP160R1 |  |
| SB_EC_SECP160R2 | SECP160R2 |  |
| SB_EC_SECP192K1 | SECP192K1 |  |
| SB_EC_SECP192R1 | SECP192R1 |  |
| SB_EC_SECP224K1 | SECP224K1 |  |
| SB_EC_SECP224R1 | SECP224R1 |  |
| SB_EC_SECP256K1 | SECP256K1 |  |
| SB_EC_SECP256R1 | SECP256R1 |  |
| SB_EC_SECP384R1 | SECP384R1 |  |
| SB_EC_SECP521R1 | SECP521R1 |  |
| SB_EC_SECT113R1 | SECT113R1 |  |
| SB_EC_SECT113R2 | SECT113R2 |  |
| SB_EC_SECT131R1 | SECT131R1 |  |
| SB_EC_SECT131R2 | SECT131R2 |  |
| SB_EC_SECT163K1 | SECT163K1 |  |
| SB_EC_SECT163R1 | SECT163R1 |  |
| SB_EC_SECT163R2 | SECT163R2 |  |
| SB_EC_SECT193R1 | SECT193R1 |  |
| SB_EC_SECT193R2 | SECT193R2 |  |
| SB_EC_SECT233K1 | SECT233K1 |  |
| SB_EC_SECT233R1 | SECT233R1 |  |
| SB_EC_SECT239K1 | SECT239K1 |  |
| SB_EC_SECT283K1 | SECT283K1 |  |
| SB_EC_SECT283R1 | SECT283R1 |  |
| SB_EC_SECT409K1 | SECT409K1 |  |
| SB_EC_SECT409R1 | SECT409R1 |  |
| SB_EC_SECT571K1 | SECT571K1 |  |
| SB_EC_SECT571R1 | SECT571R1 |  |
| SB_EC_PRIME192V1 | PRIME192V1 |  |
| SB_EC_PRIME192V2 | PRIME192V2 |  |
| SB_EC_PRIME192V3 | PRIME192V3 |  |
| SB_EC_PRIME239V1 | PRIME239V1 |  |
| SB_EC_PRIME239V2 | PRIME239V2 |  |
| SB_EC_PRIME239V3 | PRIME239V3 |  |
| SB_EC_PRIME256V1 | PRIME256V1 |  |
| SB_EC_C2PNB163V1 | C2PNB163V1 |  |
| SB_EC_C2PNB163V2 | C2PNB163V2 |  |
| SB_EC_C2PNB163V3 | C2PNB163V3 |  |
| SB_EC_C2PNB176W1 | C2PNB176W1 |  |
| SB_EC_C2TNB191V1 | C2TNB191V1 |  |
| SB_EC_C2TNB191V2 | C2TNB191V2 |  |
| SB_EC_C2TNB191V3 | C2TNB191V3 |  |
| SB_EC_C2ONB191V4 | C2ONB191V4 |  |
| SB_EC_C2ONB191V5 | C2ONB191V5 |  |
| SB_EC_C2PNB208W1 | C2PNB208W1 |  |
| SB_EC_C2TNB239V1 | C2TNB239V1 |  |
| SB_EC_C2TNB239V2 | C2TNB239V2 |  |
| SB_EC_C2TNB239V3 | C2TNB239V3 |  |
| SB_EC_C2ONB239V4 | C2ONB239V4 |  |
| SB_EC_C2ONB239V5 | C2ONB239V5 |  |
| SB_EC_C2PNB272W1 | C2PNB272W1 |  |
| SB_EC_C2PNB304W1 | C2PNB304W1 |  |
| SB_EC_C2TNB359V1 | C2TNB359V1 |  |
| SB_EC_C2PNB368W1 | C2PNB368W1 |  |
| SB_EC_C2TNB431R1 | C2TNB431R1 |  |
| SB_EC_NISTP192 | NISTP192 |  |
| SB_EC_NISTP224 | NISTP224 |  |
| SB_EC_NISTP256 | NISTP256 |  |
| SB_EC_NISTP384 | NISTP384 |  |
| SB_EC_NISTP521 | NISTP521 |  |
| SB_EC_NISTB163 | NISTB163 |  |
| SB_EC_NISTB233 | NISTB233 |  |
| SB_EC_NISTB283 | NISTB283 |  |
| SB_EC_NISTB409 | NISTB409 |  |
| SB_EC_NISTB571 | NISTB571 |  |
| SB_EC_NISTK163 | NISTK163 |  |
| SB_EC_NISTK233 | NISTK233 |  |
| SB_EC_NISTK283 | NISTK283 |  |
| SB_EC_NISTK409 | NISTK409 |  |
| SB_EC_NISTK571 | NISTK571 |  |
| SB_EC_GOSTCPTEST | GOSTCPTEST |  |
| SB_EC_GOSTCPA | GOSTCPA |  |
| SB_EC_GOSTCPB | GOSTCPB |  |
| SB_EC_GOSTCPC | GOSTCPC |  |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA |  |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB |  |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 |  |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 |  |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 |  |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 |  |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 |  |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 |  |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 |  |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 |  |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 |  |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 |  |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 |  |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 |  |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 |  |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 |  |
| SB_EC_CURVE25519 | CURVE25519 |  |
| SB_EC_CURVE448 | CURVE448 |  |

The *UsedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [UsedCertCount](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_fingerprint property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_friendly_name property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i64

# used_cert_hash_algorithm property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) 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

*Rust Syntax*

```text
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](#used_cert_sig_algorithm-property-certificatevalidator-struct) to find out the hash algorithm that is part of the certificate signature.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

The *UsedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [UsedCertCount](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_issuer property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_issuer_rdn-property-certificatevalidator-struct).

The *UsedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [UsedCertCount](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_issuer_rdn property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_key_algorithm property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Specifies the public key algorithm of this certificate.

## Syntax

*Rust Syntax*

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

## Default Value

"0"

## Remarks

Specifies the public key algorithm of this certificate.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [used_cert_key_bits](#used_cert_key_bits-property-certificatevalidator-struct), [used_cert_curve](#used_cert_curve-property-certificatevalidator-struct), and [used_cert_public_key_bytes](#used_cert_public_key_bytes-property-certificatevalidator-struct) 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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_key_bits property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns the length of the public key in bits.

## Syntax

*Rust Syntax*

```text
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](#used_cert_public_key_bytes-property-certificatevalidator-struct) or [used_cert_private_key_bytes](#used_cert_private_key_bytes-property-certificatevalidator-struct) 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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# used_cert_key_fingerprint property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_fingerprint-property-certificatevalidator-struct) 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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_key_usage property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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:

|  |  |  |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |

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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# used_cert_key_valid property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

bool

# used_cert_ocsp_locations property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#CertificateManager_m_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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_ocsp_no_check property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

bool

# used_cert_origin property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# used_cert_policy_i_ds property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_private_key_bytes property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# used_cert_private_key_exists property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_private_key_bytes-property-certificatevalidator-struct), 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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

bool

# used_cert_private_key_extractable property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Indicates whether the private key is extractable (exportable).

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

bool

# used_cert_public_key_bytes property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Contains the certificate's public key in DER format.

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# used_cert_qualified property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Indicates whether the certificate is qualified.

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

bool

# used_cert_qualified_statements property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns a simplified qualified status of the certificate.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // NonQualified1   // QualifiedHardware2   // 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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# used_cert_qualifiers property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

A list of qualifiers.

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_self_signed property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

bool

# used_cert_serial_number property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Returns the certificate's serial number.

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# used_cert_sig_algorithm property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_source property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // Signature2   // Document3   // User4   // Local5   // 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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# used_cert_subject property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_subject_rdn-property-certificatevalidator-struct).

The *UsedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [UsedCertCount](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_subject_alternative_name property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_subject_rdn-property-certificatevalidator-struct) 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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_subject_key_id property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_subject_key_id-property-certificatevalidator-struct) and [used_cert_ca_key_id](#used_cert_ca_key_id-property-certificatevalidator-struct) 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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# used_cert_subject_rdn property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_valid property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) 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

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

bool

# used_cert_valid_from property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_cert_valid_to property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_cert_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_crl_count property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The number of records in the UsedCRL arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [used_crl_handle](#used_crl_handle-property-certificatevalidator-struct)
- [used_crl_issuer](#used_crl_issuer-property-certificatevalidator-struct)
- [used_crl_issuer_rdn](#used_crl_issuer_rdn-property-certificatevalidator-struct)
- [used_crl_location](#used_crl_location-property-certificatevalidator-struct)
- [used_crl_next_update](#used_crl_next_update-property-certificatevalidator-struct)
- [used_crl_source](#used_crl_source-property-certificatevalidator-struct)
- [used_crl_this_update](#used_crl_this_update-property-certificatevalidator-struct)

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

Returns the raw CRL data in DER format.

## Syntax

*Rust Syntax*

```text
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](#used_crl_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# used_crl_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#used_crl_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i64

# used_crl_issuer property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_crl_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_crl_issuer_rdn property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_crl_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_crl_location property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The URL that the CRL was downloaded from.

## Syntax

*Rust Syntax*

```text
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](#used_crl_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_crl_next_update property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_crl_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_crl_source property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // Signature2   // Document3   // User4   // Local5   // 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](#used_crl_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# used_crl_this_update property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_crl_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_ocsp_count property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The number of records in the UsedOCSP arrays.

## Syntax

*Rust Syntax*

```text
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_bytes-property-certificatevalidator-struct)
- [used_ocsp_handle](#used_ocsp_handle-property-certificatevalidator-struct)
- [used_ocsp_issuer](#used_ocsp_issuer-property-certificatevalidator-struct)
- [used_ocsp_issuer_rdn](#used_ocsp_issuer_rdn-property-certificatevalidator-struct)
- [used_ocsp_location](#used_ocsp_location-property-certificatevalidator-struct)
- [used_ocsp_produced_at](#used_ocsp_produced_at-property-certificatevalidator-struct)
- [used_ocsp_source](#used_ocsp_source-property-certificatevalidator-struct)

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

A buffer containing the raw OCSP response data.

## Syntax

*Rust Syntax*

```text
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](#used_ocsp_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

Vec

# used_ocsp_handle property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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.

```text
  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](#used_ocsp_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i64

# used_ocsp_issuer property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_ocsp_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_ocsp_issuer_rdn property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_ocsp_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_ocsp_location property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

The location of the OCSP responder.

## Syntax

*Rust Syntax*

```text
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](#used_ocsp_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_ocsp_produced_at property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#used_ocsp_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

String

# used_ocsp_source property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Unknown1   // Signature2   // Document3   // User4   // Local5   // 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](#used_ocsp_count-property-certificatevalidator-struct) property.

This property is read-only.

## Data Type

i32

# use_system_certificates property ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Enables or disables the use of the system certificates.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Contains the complete log of the certificate validation routine.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
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](#config-settings-certificatevalidator-struct) 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](#config-settings-certificatevalidator-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# do_action method ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Performs an additional action.

## Syntax

*Rust Syntax*

```text
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:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

# get_qualified_status method ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Obtains the qualified information for Certificate .

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Returns a specific TrustedList property.

## Syntax

*Rust Syntax*

```text
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-secureblackboxcertificatevalidator) Struct)

Refreshes the certificate cache.

## Syntax

*Rust Syntax*

```text
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](#cache_validation_results-property-certificatevalidator-struct) is on).

# reset method ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Resets the struct settings.

## Syntax

*Rust Syntax*

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

## Remarks

reset is a generic method available in every struct.

# reset_cache method ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Clears all data contained in the validation cache.

## Syntax

*Rust Syntax*

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

## Remarks

Use this method to clear the validation cache (only makes sense if [cache_validation_results](#cache_validation_results-property-certificatevalidator-struct) is on).

# terminate method ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Terminates the validation process.

## Syntax

*Rust Syntax*

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

## Remarks

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

# validate method ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Validates the certificate chain.

## Syntax

*Rust Syntax*

```text
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](#chain_validation_result-property-certificatevalidator-struct) property. Another property, [chain_validation_details](#chain_validation_details-property-certificatevalidator-struct), provides insight into the reasons that contributed to that decision. Use [validation_log](#validation_log-property-certificatevalidator-struct) to get a detailed step-by-step log of the entire validation process.

# validate_for_smime method ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Validates an e-mail signing certificate.

## Syntax

*Rust Syntax*

```text
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](#validate-method-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

Validates a server-side SSL/TLS certificate.

## Syntax

*Rust Syntax*

```text
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](#validate-method-certificatevalidator-struct) 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-secureblackboxcertificatevalidator) Struct)

Marks the end of a single certificate processing step.

## Syntax

*Rust Syntax*

```text
// 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](#on_after_certificate_validation-event-certificatevalidator-struct) 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](#interim_validation_result-property-certificatevalidator-struct) and [interim_validation_details](#interim_validation_details-property-certificatevalidator-struct) properties.

Validity status:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Validation details:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

# on_after_certificate_validation event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Marks the end of a single certificate validation step.

## Syntax

*Rust Syntax*

```text
// 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](#interim_validation_result-property-certificatevalidator-struct) and [interim_validation_details](#interim_validation_details-property-certificatevalidator-struct) properties.

Validity status:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Validation details:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

# on_before_ca_certificate_download event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Fires when a CA certificate is about to be downloaded.

## Syntax

*Rust Syntax*

```text
// 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-secureblackboxcertificatevalidator) Struct)

Reports the start of certificate processing.

## Syntax

*Rust Syntax*

```text
// 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](#on_after_certificate_validation-event-certificatevalidator-struct) 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](#on_after_certificate_processing-event-certificatevalidator-struct) marks the end of the certificate processing.

*Validity* and *ValidationDetails* specify the current validation status.

Validity status:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Validation details:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

# on_before_certificate_validation event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Reports the start of certificate validation.

## Syntax

*Rust Syntax*

```text
// 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](#on_after_certificate_validation-event-certificatevalidator-struct) marks the end of the certificate validation step.

# on_before_crl_download event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Fires when a CRL is about to be downloaded.

## Syntax

*Rust Syntax*

```text
// 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
// 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-secureblackboxcertificatevalidator) Struct)

Marks the success of a certificate download.

## Syntax

*Rust Syntax*

```text
// 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](#on_before_ca_certificate_download-event-certificatevalidator-struct) event.

# on_ca_certificate_needed event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Requests a missing certificate from the user.

## Syntax

*Rust Syntax*

```text
// 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-secureblackboxcertificatevalidator) Struct)

Marks the success of a CRL download.

## Syntax

*Rust Syntax*

```text
// 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](#on_before_crl_download-event-certificatevalidator-struct) event.

# on_crl_needed event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Requests a missing CRL from the user.

## Syntax

*Rust Syntax*

```text
// 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-secureblackboxcertificatevalidator) Struct)

Information about errors during certificate validation.

## Syntax

*Rust Syntax*

```text
// 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
// 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:

|  |  |
| --- | --- |
| DownloadTSL | This event is fired if a Trusted List is requested. The EventParam parameter contains the URL value from where to retrieve the TrustedList. The downloaded Trusted List content should be assigned to the TSLContent or TSLContentHex configuration settings. The struct automatically downloads Trusted List if [offline_mode](#offline_mode-property-certificatevalidator-struct) is disabled and no Trusted List content is provided. It is important to note that if you are caching the Trusted List content, you should check the NextUpdate field of the Trusted List and update it in a timely manner, otherwise the outdated Trusted List will be discarded. |
| StoreTSL | This event is fired if the Trusted List should be stored for offline usage. The EventParam parameter contains the URL value from where the Trusted List was retrieved. The TrustedList content could be read using TSLContent or TSLContentHex configuration settings. |

# on_ocsp_downloaded event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Marks the success of an OCSP request.

## Syntax

*Rust Syntax*

```text
// 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](#on_before_ocsp_download-event-certificatevalidator-struct) event.

# on_tls_cert_needed event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Fires when a remote TLS party requests a client certificate.

## Syntax

*Rust Syntax*

```text
// 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](#on_tls_handshake-event-certificatevalidator-struct) event for the given host and, if the certificate was accepted, succeeded by the [on_tls_established](#on_tls_established-event-certificatevalidator-struct) event.

# on_tls_cert_validate event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
// 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-secureblackboxcertificatevalidator) Struct)

Fires when a TLS handshake with Host successfully completes.

## Syntax

*Rust Syntax*

```text
// 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-secureblackboxcertificatevalidator) Struct)

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

## Syntax

*Rust Syntax*

```text
// 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](#on_tls_established-event-certificatevalidator-struct) event. If the server chooses to request a client certificate, the [on_tls_cert_needed](#on_tls_cert_needed-event-certificatevalidator-struct) event will also be fired.

# on_tls_shutdown event ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

Reports the graceful closure of a TLS connection.

## Syntax

*Rust Syntax*

```text
// 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-secureblackboxcertificatevalidator) 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](#config-method-certificatevalidator-struct) method.

### CertificateValidator Config Settings

**CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched.

The default value is 0, which disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched.

The default value is 0, which disables the CRL ratio check. Values are interpreted in the 0..100 range. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.

The default value is 0, which disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.

**CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response ratio check. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.

**CacheValidityTime**: Time period during which to keep validation cache. The validity period of the cached validation results in milliseconds.

**CheckStrongAlgorithmForTrusted**: Whether to check a 'strong' hash algorithm for trusted certificates.Whether to check a 'strong' hash algorithm for trusted certificates.

**CheckValidityPeriodForTrusted**: Whether to check validity period for trusted certificates.Whether to check validity period for trusted certificates.

**CrossCertificationValidationStrategy**: Defines how the cross certification validation is performed. This property tells the struct how to perform the cross certification validation. Supported values: csvSmart = 0 csvOptimistic = 1 csvPessimistic = 2 csvNoCrossCertification = 3

 In the optimistic strategy, positive validation results are kept, and negative ones are ignored. If there are no good certificates in the chain, the validation proceeds using self-signed certificates. Smart is the same as optimistic.

 In the pessimistic strategy, even one negative validation result makes the whole process to fail.

**DeltaCRLPreference**: Specifies whether complete or delta CRLs are preferred.Use this setting to specify which CRL type should be preferred during revocation checks.

The default value is **dcrlpPreferDelta** (0).

Supported values:

- **dcrlpPreferDelta** (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
- **dcrlpPreferComplete** (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.

**DislikeOpenEndedOCSPs**: Tells the struct to discourage OCSP responses without an explicit NextUpdate parameter.When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the struct is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022).

**EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is disabled by default, because enabling it may prevent the AdES components from collecting full revocation information required for long-term validation (LTV) signatures.

**EvaluateSystemTrustForSelfSignedCertificates**: Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) for self-signed certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

**EvaluateSystemTrustForSSL**: Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) specifically for SSL/TLS certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

**ForceCompleteChainValidationForTrusted**: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.

**ForceRevocationCheckForRoot**: Whether to check revocation info for root certificates.Specifies if revocation information should be checked for the root certificate.

**IgnoreBadOCSPChains**: Whether to ignore bad OCSP chains during validation.Whether to ignore bad OCSP chains during validation.

**IgnoreCABasicConstraints**: Whether to ignore the Basic Constraints extension for the CA certificates.Whether to ignore the Basic Constraints extension for the CA certificates.

**IgnoreCAKeyUsage**: Whether to ignore Key Usage extension for CA certificates.Whether to ignore Key Usage extension for CA certificates.

**IgnoreCANameConstraints**: Whether to ignore the Name Constraints extension for the CA certificates.Whether to ignore the Name Constraints extension for the CA certificates.

**IgnoreChainLoops**: Whether chain loops should be ignored.Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves.

**IgnoreCRLIssuerKeyID**: Tells the validator to ignore malformed CRL issuer key IDs.Another compatibility/tolerance tweak that tells the validator to ignore the issuer key identifier values recorded in the processed CRLs (occasionally it is recorded there wrongly).

**IgnoreOCSPNoCheckExtension**: Whether the OCSP NoCheck extension should be ignored.Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.

**IgnoreRevocationKeyUsage**: Whether to check the CA certs used to sign revocation info.Whether the issuer (CA) certificates should be checked if their key usage extension (when available) allows using them to sign revocation information.

**IgnoreSSLKeyUsage**: Whether to check the CA certs used in SSL/TLS.Whether the issuer (CA) certificates should be checked if their key usage extension (when available) allows using these certificates in SSL protocol communications.

**IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the struct should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the struct should trust the certificates residing in the Trusted Root Certification Authorities store.

If [IgnoreSystemTrust](#IgnoreSystemTrust) is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the trusted_certificates property) are considered trusted.

**ImplicitlyTrustSelfSignedCertificates**: Whether to trust self-signed certificates. Set this property to True to implicitly trust all self-signed certificates.

**LookupCRLByNameIfDPNotPresent**: Whether to look for implicit CRL Distribution Points. Whether to look for implicit CRL Distribution Points (DPs) if no DPs are available.

**PromoteLongOCSPResponses**: Whether long OCSP responses are requested. Set this property to True to force the struct to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

**RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Disabled.

Supported values are case-insensitive:

|  |  |
| --- | --- |
| Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. This value is the default. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. |
| Default | Applies the component default freshness settings. For this component, Default is equivalent to Disabled. |
| Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. |
| Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. |
| N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. |
| crl:<maxAge>;<ratio>;<overlap>,ocsp:<maxAge>;<ratio>;<overlap> | Sets the CRL and OCSP response freshness values explicitly. |

Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.

**RevocationMomentGracePeriod**: Grace period for revocation information propagation.Use this property to specify the grace period (in seconds). Grace period allows the certificate revocation information to propagate through the revocation process.

**SkipSubjectNameIfAltNameExists**: Whether to check CommonName if SubjectAltName is present. RFC 6125 requires that the SubjectAltName (SAN) extension should be checked if it is present. In such case, SubjectName.CommonName (CN) should not be checked. This contradicts to some existing certificates where, for instance, CN contains "a.com" and SAN is "www.a.com".

**UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages.

**UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

**UseValidationCache**: Enables or disable the use of the product-wide certificate chain validation cache.Use this property to enable or disable the use of the global chain validation cache. If enabled, the struct will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the struct, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start.

**ValidateInvalidCertificates**: Whether to do all checks on invalid certificates.If ValidateInvalidCertificates is True and certain certificate check determines that the certificate is not valid, further checks are done anyway. This allows to create a full validation report.

When ValidateInvalidCertificates is False and a certificate is found to be not valid, further checks of this certificate are not performed.

**WeakAlgorithmHandlingMode**: How to handle certificates signed with a 'weak' hash algorithm. Defines how to handle the certificates signed using a 'weak' hash algorithm.

Supported values: wahmIgnore = 0 wahmWarning = 1 wahmError = 2

### TrustedLists Config Settings

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

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

**DistributionPoints**: Contains XML content of distribution points of the TSL used.Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate.

**HistoricalInformationPeriod**: Contains historical information period of the TSL used.Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate.

**LegalNotices**: Contains XML content of legal notices of the TSL used.Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate.

**ListIssueDateTime**: Contains list issue date and time of the TSL used.Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate.

**NextUpdate**: Contains next update date and time of the TSL used.Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate.

**Policies**: Contains XML content of policies of the TSL used.Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate.

**QualifiedStatus**: 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. This property return TSP service status URI.

**SchemeExtensions**: Contains XML content of scheme extensions of the TSL used.Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate.

**SchemeInformationURI**: Contains XML content of scheme information URI of the TSL used.Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate.

**SchemeName**: Contains XML content of scheme name of the TSL used.Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate.

**SchemeOperatorAddress**: Contains XML content of scheme operator address of the TSL used.Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate.

**SchemeOperatorName**: Contains XML content of scheme operator name of the TSL used.Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate.

**SchemeTerritory**: Contains scheme territory of the TSL used.Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate.

**SchemeTypeCommunityRules**: Contains XML content of scheme type/community/rules of the TSL used.Use this property to get XML content of multilingual scheme type/community/rules of the TSL used to obtain the qualified status of the certificate.

**SequenceNumber**: Contains sequence number of the TSL used.Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate.

**StatusDeterminationApproach**: Contains status determination approach of the TSL used.Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate.

**TSLContent**: Specifies the TrustedList content.Assign or read this property in your [on_notification](#on_notification-event-certificatevalidator-struct) event handler with the Trusted List content.

**TSLContentHex**: Specifies the TrustedList content.Assign or read this property in your [on_notification](#on_notification-event-certificatevalidator-struct) event handler with the Trusted List content in Hex encoding.

**TSLDistributionPoints**: Contains XML content of distribution points of the TSL used.Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate.

**TSLDistributionPoints[Idx]**: Contains distribution point of the specified index of the TSL used.Use this property to get distribution point of the specified index of the TSL used to obtain the qualified status of the certificate.

**TSLHistoricalInformationPeriod**: Contains historical information period of the TSL used.Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate.

**TSLLegalNotices**: Contains XML content of legal notices of the TSL used.Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate.

**TSLLegalNotices[lang]**: Contains legal notices for the specified language of the TSL used.Use this property to get legal notices for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

**TSLListIssueDateTime**: Contains list issue date and time of the TSL used.Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate.

**TSLNextUpdate**: Contains next update date and time of the TSL used.Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate.

**TSLPolicies**: Contains XML content of policies of the TSL used.Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate.

**TSLPolicies[lang]**: Contains policies for the specified language of the TSL used.Use this property to get policies for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeExtensions**: Contains XML content of scheme extensions of the TSL used.Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeExtensions[Idx]**: Contains XML content of scheme extension of the specified index of the TSL used.Use this property to get XML content of scheme extension of the specified index of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeInformationURI**: Contains XML content of scheme information URI of the TSL used.Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeInformationURI[lang]**: Contains scheme information URI for the specified language of the TSL used.Use this property to get scheme information URI for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeName**: Contains XML content of scheme name of the TSL used.Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeName[lang]**: Contains scheme name for the specified language of the TSL used.Use this property to get scheme name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeOperatorAddress**: Contains XML content of scheme operator address of the TSL used.Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeOperatorName**: Contains XML content of scheme operator name of the TSL used.Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeOperatorName[lang]**: Contains scheme operator name for the specified language of the TSL used.Use this property to get scheme operator name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeTerritory**: Contains scheme territory of the TSL used.Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeTypeCommunityRules**: Contains XML content of scheme type/community/rules of the TSL used.Use this property to get XML content of multilingual scheme type/community/rules of the TSL used to obtain the qualified status of the certificate.

**TSLSchemeTypeCommunityRules[lang]**: Contains scheme type/community/rules for the specified language of the TSL used.Use this property to get scheme type/community/rules for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

**TSLSequenceNumber**: Contains sequence number of the TSL used.Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate.

**TSLsRetrieveLog**: Contains the complete log of the TSLs retrieve.Use this property to access the TSLs retrieve log produced by the struct. The log can be very useful when investigating issues with TSL retrieve.

**TSLStatusDeterminationApproach**: Contains status determination approach of the TSL used.Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate.

**TSLsValidationLog**: Contains the complete log of the TSLs validation.Use this property to access the TSLs validation log produced by the struct. The log can be very useful when investigating issues with TSL validation.

**TSLTSPAdditionalServiceInformation**: Contains additional service information of the TSP service used.Use this property to get the list of additional service information of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

**TSLTSPAddress**: Contains XML content of the address of the TSP used.Use this property to get XML content of the address of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLTSPHistoryInstance**: Indicates that TSP service history instance used.Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance.

**TSLTSPHistoryInstanceAdditionalServiceInformation**: Contains additional service information of the TSP service history instance used.Use this property to get the list of additional service information of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

**TSLTSPHistoryInstanceQualifiers**: Contains list of qualifiers of the TSP service history instance used.Use this property to get the list of qualifiers of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

**TSLTSPHistoryInstanceServiceInformationExtensions**: Contains XML content of information extensions of the TSP service history instance used.Use this property to get XML content of information extensions of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPHistoryInstanceServiceInformationExtensions[Idx]**: Contains XML content of information extension of the specified index of the TSP service history instance used.Use this property to get XML content of information extension of the specified index of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPHistoryInstanceServiceName**: Contains XML content of name of the TSP service history instance used.Use this property to get XML content of multilingual name of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPHistoryInstanceServiceName[lang]**: Contains name for the specified language of the TSP service history instance used.Use this property to get the name for the specified language code (e.g. 'en') of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPHistoryInstanceServiceStatus**: Contains status of the TSP service history instance used.Use this property to get the status of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPHistoryInstanceServiceStatusStartingTime**: Contains status starting time of the TSP service history instance used.Use this property to get the status starting time of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPHistoryInstanceServiceTypeIdentifier**: Contains type identifier of the TSP service history instance used.Use this property to get type identifier of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPHistoryInstanceXML**: Contains XML content of the TSP service history instance used.Use this property to get XML content of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPInformationExtensions**: Contains XML content of information extensions of the TSP used.Use this property to get XML content of information extensions of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLTSPInformationExtensions[Idx]**: Contains XML content of information extension of the specified index of the TSP used.Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLTSPInformationURI**: Contains XML content of information URI of the TSP used.Use this property to get XML content of multilingual information URI of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLTSPInformationURI[lang]**: Contains information URI for the specified language of the TSP used.Use this property to get the information URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLTSPName**: Contains XML content of name of the TSP used.Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLTSPName[lang]**: Contains name for the specified language of the TSP used.Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLTSPSchemeServiceDefinitionURI**: Contains XML content of scheme service definition URI of the TSP service used.Use this property to get XML content of multilingual scheme service definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPSchemeServiceDefinitionURI[lang]**: Contains scheme service definition URI for the specified language of the TSP service used.Use this property to get the scheme service definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceDefinitionURI**: Contains XML content of definition URI of the TSP service used.Use this property to get XML content of multilingual definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceDefinitionURI[lang]**: Contains definition URI for the specified language of the TSP service used.Use this property to get the definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceInformationExtensions**: Contains XML content of information extensions of the TSP service used.Use this property to get XML content of information extensions of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceInformationExtensions[Idx]**: Contains XML content of information extension of the specified index of the TSP service used.Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceName**: Contains XML content of name of the TSP service used.Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceName[lang]**: Contains name for the specified language of the TSP service used.Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceQualifiers**: Contains list of qualifiers of the TSP service used.Use this property to get the list of qualifiers of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

**TSLTSPServiceStatus**: Contains status of the TSP service used.Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceStatusStartingTime**: Contains status starting time of the TSP service used.Use this property to get the status starting time of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceSupplyPoints**: Contains XML content of the supply points of the TSP service used.Use this property to get XML content of the supply points of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceTypeIdentifier**: Contains type identifier of the TSP service used.Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPServiceXML**: Contains XML content of the TSP service used.Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSLTSPTradeName**: Contains XML content of trade name of the TSP used.Use this property to get XML content of multilingual trade name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLTSPTradeName[lang]**: Contains trade name for the specified language of the TSP used.Use this property to get the trade name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLTSPXML**: Contains XML content of the TSP used.Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSLType**: Contains TSL type of the TSL used.Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate.

**TSLVersionIdentifier**: Contains version identifier of the TSL used.Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate.

**TSLXML**: Contains XML content of the TSL used.Use this property to get XML content of the TSL used to obtain the qualified status of the certificate.

**TSPAdditionalServiceInformation**: Contains additional service information of the TSP service used.Use this property to get the list of additional service information of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

**TSPAddress**: Contains XML content of the address of the TSP used.Use this property to get XML content of the address of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSPHistoryInstance**: Indicates that TSP service history instance used.Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance.

**TSPHistoryInstanceAdditionalServiceInformation**: Contains additional service information of the TSP service history instance used.Use this property to get the list of additional service information of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

**TSPHistoryInstanceQualifiers**: Contains list of qualifiers of the TSP service history instance used.Use this property to get the list of qualifiers of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

**TSPHistoryInstanceServiceInformationExtensions**: Contains XML content of information extensions of the TSP service history instance used.Use this property to get XML content of information extensions of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPHistoryInstanceServiceName**: Contains XML content of name of the TSP service history instance used.Use this property to get XML content of multilingual name of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPHistoryInstanceServiceStatus**: Contains status of the TSP service history instance used.Use this property to get the status of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPHistoryInstanceServiceStatusStartingTime**: Contains status starting time of the TSP service history instance used.Use this property to get the status starting time of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPHistoryInstanceServiceTypeIdentifier**: Contains type identifier of the TSP service history instance used.Use this property to get type identifier of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPHistoryInstanceXML**: Contains XML content of the TSP service history instance used.Use this property to get XML content of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPInformationExtensions**: Contains XML content of information extensions of the TSP used.Use this property to get XML content of information extensions of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSPInformationURI**: Contains XML content of information URI of the TSP used.Use this property to get XML content of multilingual information URI of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSPName**: Contains XML content of name of the TSP used.Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSPSchemeServiceDefinitionURI**: Contains XML content of scheme service definition URI of the TSP service used.Use this property to get XML content of multilingual scheme service definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPServiceDefinitionURI**: Contains XML content of definition URI of the TSP service used.Use this property to get XML content of multilingual definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPServiceInformationExtensions**: Contains XML content of information extensions of the TSP service used.Use this property to get XML content of information extensions of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPServiceName**: Contains XML content of name of the TSP service used.Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPServiceQualifiers**: Contains list of qualifiers of the TSP service used.Use this property to get the list of qualifiers of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

**TSPServiceStatus**: Contains status of the TSP service used.Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPServiceStatusStartingTime**: Contains status starting time of the TSP service used.Use this property to get the status starting time of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPServiceSupplyPoints**: Contains XML content of the supply points of the TSP service used.Use this property to get XML content of the supply points of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPServiceTypeIdentifier**: Contains type identifier of the TSP service used.Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPServiceXML**: Contains XML content of the TSP service used.Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

**TSPTradeName**: Contains XML content of trade name of the TSP used.Use this property to get XML content of multilingual trade name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**TSPXML**: Contains XML content of the TSP used.Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

**Type**: Contains TSL type of the TSL used.Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate.

**VersionIdentifier**: Contains version identifier of the TSL used.Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate.

### Base Config Settings

**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.

**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

**CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the struct.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the struct.Use this property to get cookies from the internal cookie storage of the struct and/or restore them back between application sessions.

**DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

**EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

**GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the structs that have its *CookieCaching* property set to "global".

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

**HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other structs.

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

|  |  |  |
| --- | --- | --- |
| time |  | Current time |
| level |  | Level |
| package |  | Package name |
| module |  | Module name |
| class |  | Class name |
| method |  | Method name |
| threadid |  | Thread Id |
| contenttype |  | Content type |
| content |  | Content |
| all |  | All details |

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-package |  | Exclude a package specified in the value |
| exclude-module |  | Exclude a module specified in the value |
| exclude-class |  | Exclude a class specified in the value |
| exclude-method |  | Exclude a method specified in the value |
| include-package |  | Include a package specified in the value |
| include-module |  | Include a module specified in the value |
| include-class |  | Include a class specified in the value |
| include-method |  | Include a method specified in the value |

**LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | None (by default) |
| fatal |  | Severe errors that cause premature termination. |
| error |  | Other runtime errors or unexpected conditions. |
| warning |  | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". |
| info |  | Interesting runtime events (startup/shutdown). |
| debug |  | Detailed information on flow of through the system. |
| trace |  | More detailed information. |

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

**LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No rotation |
| deleteolder |  | Delete older entries from the cache upon reaching LogMaxEventCount |
| keepolder |  | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |

**MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

**MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

**OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example:

```text
PKICachePath=C:\Temp\cache
```

 In this example, the cached PKI data is stored in the C:\Temp\cache directory.

**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the struct. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

**StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the struct) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the struct is set to "*local*", the property returns/restores the rules from/to the internal storage of the struct. If *StaticDNS* of the struct is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the structs.

**TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

**UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

**UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax:

```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```

**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

# Trappable Errors ([CertificateValidator](#struct-secureblackboxcertificatevalidator) Struct)

### CertificateValidator Errors

|  |  |
| --- | --- |
| 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) |
| 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) |
| 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) |
| 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) |
| 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) |
| 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) |
| 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) |
| 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) |
| 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |