# Struct secureblackbox::JAdESVerifier

The JAdESVerifier struct verifies signatures over JSON objects.

## Syntax

```text
secureblackbox::JAdESVerifier
```

## Remarks

Use JAdESVerifier to validate electronic signatures over JSON structures. Generic (JWS) and JAdES (JSON Advanced Electronic Signatures) are supported.

```text
JAdESVerifier verifier = new JAdESVerifier();

verifier.setInputFile("SignedFile.scs");

if (verifier.isDetached()){

  // To verify a detached signature, we need
  // to provide both the signature and the original data
  verifier.setDataFile("MyExe.exe");

  verifier.verify();
}
else {

  // To verify an enveloping signature, we need
  // to provide the location to extract the data
  verifier.setOutputFile("output.exe");

  verifier.verify();
}

// The outcome of the cryptographic signature validation
for (int idx = 0 ; idx < verifier.getSignatures().size() ; idx++) {

  System.out.println("Signature " + (idx + 1));
  System.out.println("  Timestamp:         " + verifier.getSignatures().item(idx).getValidatedSigningTime());
  System.out.print("  Validation Result: " + verifier.getSignatures().item(idx).getSignatureValidationResult() + ", ");

  switch (verifier.getSignatures().item(idx).getSignatureValidationResult()) {
    case svtValid:
      System.out.println("The signature is valid.");
      break;
    case svtCorrupted:
      System.out.println("The signature is corrupted.");
      break;
    case svtSignerNotFound:
      System.out.println("Failed to acquire the signing certificate. The signature cannot be validated.");
      break;
    case svtFailure:
      System.out.println("General failure.");
      break;
    default:
      System.out.println("Signature validity is unknown.");
      break;
  }
}
```

JAdESVerifier validates each signature from two perspectives: the integrity and validity of the signature itself (i.e. its correspondence to the JSON data it covers), and the validity and trustworthiness of the signing certificate chain. These two signature aspects are generally independent of each other: the signature may be valid but the chain may not be trusted, or, the other way round, the chain may be trusted, but the integrity of the signature may be violated. Under normal circumstances both the signature **and** the chain must be valid for the signature to be considered good.

To initiate the validation, assign the path to the signed JSON file to the [input_file](#input_file-property-jadesverifier-struct) property (alternatively, you can provide it in a memory buffer via [input_bytes](#input_bytes-property-jadesverifier-struct) or [input_string](#input_string-property-jadesverifier-struct) property), and call [verify](#verify-method-jadesverifier-struct) method. For every signature located in the document, JAdESVerifier will fire the [on_signature_found](#on_signature_found-event-jadesverifier-struct) event. This event lets you specify whether you want JAdESVerifier to validate the signature, the chain, or both.

Note: it does not mean that any of the two is optional. This API lets you be flexible in how you validate documents in your code, to allow for a variety of validation scenarios. For example, if your trust environment relies on certificate pinning, validating the chain by JAdESVerifier internally may cause unnecessary burden on the system, in which case (but not in others!) it may be reasonable to disable it in the event handler.

Once [on_signature_found](#on_signature_found-event-jadesverifier-struct) returns, JAdESVerifier proceeds to the signature validation routine in accordance with the provided settings. Upon completion of the validation, [on_signature_validated](#on_signature_validated-event-jadesverifier-struct) event is fired, and the validation results are separately provided via [signature_validation_result](#signature_validation_result-property-jadesverifier-struct) and chain_validation_result properties of the relevant signature object. Other information about the signature can be accessed via the signatures property.

### Useful settings and properties

The following properties of JAdESVerifier may be handy when working with this component:

- [offline_mode](#offline_mode-property-jadesverifier-struct) lets you validate the JSON object without contacting online revocation sources. Paired with switched off system trust settings, it can be used to establish the long-term validity of the signed object and the completeness of validation material included in it.
- [revocation_check](#revocation_check-property-jadesverifier-struct) lets you adjust the revocation checking preferences.
- validated_signing_time returns the signing time as recorded in the embedded signature timestamp. This is in contrast to claimed_signing_time, which returns the signing time as specified by the signer.
- validation_log is a great way to find out the details of chain validation failures. This property returns a comprehensive validation log that reports all the issues encountered during the validation.

By default, JAdESVerifier uses the system trust settings to establish certificate chain validity. You can configure it to use your own, custom validation environment by providing the necessary trust elements via known_certificates, trusted_certificates, known_crls, and other similar properties.

### 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 JAdESVerifier struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of JAdESVerifier 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.*

|  |  |
| --- | --- |
| [all_signatures_valid](#all_signatures_valid-property-jadesverifier-struct) | The cumulative validity of all signatures. |
| [auto_validate_signatures](#auto_validate_signatures-property-jadesverifier-struct) | Specifies whether struct should validate any present signatures when the JWS/JAdES signature is opened. |
| [blocked_cert_count](#blocked_cert_count-property-jadesverifier-struct) | The number of records in the BlockedCert arrays. |
| [blocked_cert_bytes](#blocked_cert_bytes-property-jadesverifier-struct) | Returns the raw certificate data in DER format. |
| [blocked_cert_handle](#blocked_cert_handle-property-jadesverifier-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [cert_count](#cert_count-property-jadesverifier-struct) | The number of records in the Cert arrays. |
| [cert_bytes](#cert_bytes-property-jadesverifier-struct) | Returns the raw certificate data in DER format. |
| [cert_ca](#cert_ca-property-jadesverifier-struct) | Indicates whether the certificate has a CA capability. |
| [cert_ca_key_id](#cert_ca_key_id-property-jadesverifier-struct) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| [cert_type](#cert_type-property-jadesverifier-struct) | Returns the type of the entity contained in the Certificate object. |
| [cert_crl_distribution_points](#cert_crl_distribution_points-property-jadesverifier-struct) | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| [cert_curve](#cert_curve-property-jadesverifier-struct) | Specifies the elliptic curve associated with the certificate's public key. |
| [cert_fingerprint](#cert_fingerprint-property-jadesverifier-struct) | Contains the fingerprint (a hash imprint) of this certificate. |
| [cert_friendly_name](#cert_friendly_name-property-jadesverifier-struct) | Contains an associated alias (friendly name) of the certificate. |
| [cert_handle](#cert_handle-property-jadesverifier-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [cert_hash_algorithm](#cert_hash_algorithm-property-jadesverifier-struct) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). |
| [cert_issuer](#cert_issuer-property-jadesverifier-struct) | The common name of the certificate issuer (CA), typically a company name. |
| [cert_issuer_rdn](#cert_issuer_rdn-property-jadesverifier-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [cert_key_algorithm](#cert_key_algorithm-property-jadesverifier-struct) | Specifies the public key algorithm of this certificate. |
| [cert_key_bits](#cert_key_bits-property-jadesverifier-struct) | Returns the length of the public key in bits. |
| [cert_key_fingerprint](#cert_key_fingerprint-property-jadesverifier-struct) | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| [cert_key_usage](#cert_key_usage-property-jadesverifier-struct) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| [cert_key_valid](#cert_key_valid-property-jadesverifier-struct) | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| [cert_ocsp_locations](#cert_ocsp_locations-property-jadesverifier-struct) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. |
| [cert_ocsp_no_check](#cert_ocsp_no_check-property-jadesverifier-struct) | Accessor to the value of the certificate's ocsp-no-check extension. |
| [cert_origin](#cert_origin-property-jadesverifier-struct) | Returns the location that the certificate was taken or loaded from. |
| [cert_policy_i_ds](#cert_policy_i_ds-property-jadesverifier-struct) | Contains identifiers (OIDs) of the applicable certificate policies. |
| [cert_private_key_bytes](#cert_private_key_bytes-property-jadesverifier-struct) | Returns the certificate's private key in DER-encoded format. |
| [cert_private_key_exists](#cert_private_key_exists-property-jadesverifier-struct) | Indicates whether the certificate has a usable private key associated with it. |
| [cert_private_key_extractable](#cert_private_key_extractable-property-jadesverifier-struct) | Indicates whether the private key is extractable (exportable). |
| [cert_public_key_bytes](#cert_public_key_bytes-property-jadesverifier-struct) | Contains the certificate's public key in DER format. |
| [cert_qualified](#cert_qualified-property-jadesverifier-struct) | Indicates whether the certificate is qualified. |
| [cert_qualified_statements](#cert_qualified_statements-property-jadesverifier-struct) | Returns a simplified qualified status of the certificate. |
| [cert_qualifiers](#cert_qualifiers-property-jadesverifier-struct) | A list of qualifiers. |
| [cert_self_signed](#cert_self_signed-property-jadesverifier-struct) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [cert_serial_number](#cert_serial_number-property-jadesverifier-struct) | Returns the certificate's serial number. |
| [cert_sig_algorithm](#cert_sig_algorithm-property-jadesverifier-struct) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [cert_source](#cert_source-property-jadesverifier-struct) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| [cert_subject](#cert_subject-property-jadesverifier-struct) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| [cert_subject_alternative_name](#cert_subject_alternative_name-property-jadesverifier-struct) | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| [cert_subject_key_id](#cert_subject_key_id-property-jadesverifier-struct) | Contains a unique identifier of the certificate's cryptographic key. |
| [cert_subject_rdn](#cert_subject_rdn-property-jadesverifier-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [cert_valid](#cert_valid-property-jadesverifier-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. |
| [cert_valid_from](#cert_valid_from-property-jadesverifier-struct) | The time point at which the certificate becomes valid, in UTC. |
| [cert_valid_to](#cert_valid_to-property-jadesverifier-struct) | The time point at which the certificate expires, in UTC. |
| [check_trusted_lists](#check_trusted_lists-property-jadesverifier-struct) | Specifies whether the struct should attempt to validate chain trust via a known Trusted List. |
| [compact_form](#compact_form-property-jadesverifier-struct) | Specifies if the JWS compact serialization to be used. |
| [content_type](#content_type-property-jadesverifier-struct) | Specifies payload content type. |
| [crl_count](#crl_count-property-jadesverifier-struct) | The number of records in the CRL arrays. |
| [crl_bytes](#crl_bytes-property-jadesverifier-struct) | Returns the raw CRL data in DER format. |
| [crlca_key_id](#crlca_key_id-property-jadesverifier-struct) | A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
| [crl_entry_count](#crl_entry_count-property-jadesverifier-struct) | Returns the number of certificate status entries in the CRL. |
| [crl_handle](#crl_handle-property-jadesverifier-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [crl_issuer](#crl_issuer-property-jadesverifier-struct) | The common name of the CRL issuer (CA), typically a company name. |
| [crl_issuer_rdn](#crl_issuer_rdn-property-jadesverifier-struct) | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
| [crl_location](#crl_location-property-jadesverifier-struct) | The URL that the CRL was downloaded from. |
| [crl_next_update](#crl_next_update-property-jadesverifier-struct) | The planned time and date of the next version of this CRL to be published. |
| [crl_sig_algorithm](#crl_sig_algorithm-property-jadesverifier-struct) | The public key algorithm that was used by the CA to sign this CRL. |
| [crl_source](#crl_source-property-jadesverifier-struct) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| [crltbs](#crltbs-property-jadesverifier-struct) | The to-be-signed part of the CRL (the CRL without the signature part). |
| [crl_this_update](#crl_this_update-property-jadesverifier-struct) | The date and time at which this version of the CRL was published. |
| [data_bytes](#data_bytes-property-jadesverifier-struct) | Use this property to pass a payload or an object data to struct in the byte array form. |
| [data_file](#data_file-property-jadesverifier-struct) | A path to a file containing a payload or an object data. |
| [data_string](#data_string-property-jadesverifier-struct) | Use this property to pass a payload or an object data to struct in the string form. |
| [detached](#detached-property-jadesverifier-struct) | Specifies whether a detached signature should be produced or verified. |
| [extract_payload](#extract_payload-property-jadesverifier-struct) | Specifies whether a payload should be extracted. |
| [fips_mode](#fips_mode-property-jadesverifier-struct) | Reserved. |
| [flattened_signature](#flattened_signature-property-jadesverifier-struct) | Specifies if the flattened signature to be used. |
| [ignore_chain_validation_errors](#ignore_chain_validation_errors-property-jadesverifier-struct) | Makes the struct tolerant to chain validation errors. |
| [input_bytes](#input_bytes-property-jadesverifier-struct) | Use this property to pass the input to struct in byte array form. |
| [input_file](#input_file-property-jadesverifier-struct) | The file to be signed. |
| [input_string](#input_string-property-jadesverifier-struct) | Use this property to pass the input to struct in the string form. |
| [known_cert_count](#known_cert_count-property-jadesverifier-struct) | The number of records in the KnownCert arrays. |
| [known_cert_bytes](#known_cert_bytes-property-jadesverifier-struct) | Returns the raw certificate data in DER format. |
| [known_cert_handle](#known_cert_handle-property-jadesverifier-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [known_crl_count](#known_crl_count-property-jadesverifier-struct) | The number of records in the KnownCRL arrays. |
| [known_crl_bytes](#known_crl_bytes-property-jadesverifier-struct) | Returns the raw CRL data in DER format. |
| [known_crl_handle](#known_crl_handle-property-jadesverifier-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [known_ocsp_count](#known_ocsp_count-property-jadesverifier-struct) | The number of records in the KnownOCSP arrays. |
| [known_ocsp_bytes](#known_ocsp_bytes-property-jadesverifier-struct) | A buffer containing the raw OCSP response data. |
| [known_ocsp_handle](#known_ocsp_handle-property-jadesverifier-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [ocsp_count](#ocsp_count-property-jadesverifier-struct) | The number of records in the OCSP arrays. |
| [ocsp_bytes](#ocsp_bytes-property-jadesverifier-struct) | A buffer containing the raw OCSP response data. |
| [ocsp_entry_count](#ocsp_entry_count-property-jadesverifier-struct) | The number of SingleResponse elements contained in this OCSP response. |
| [ocsp_handle](#ocsp_handle-property-jadesverifier-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [ocsp_issuer](#ocsp_issuer-property-jadesverifier-struct) | Indicates the issuer of this response (a CA or its authorized representative). |
| [ocsp_issuer_rdn](#ocsp_issuer_rdn-property-jadesverifier-struct) | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
| [ocsp_location](#ocsp_location-property-jadesverifier-struct) | The location of the OCSP responder. |
| [ocsp_produced_at](#ocsp_produced_at-property-jadesverifier-struct) | Specifies the time when the response was produced, in UTC. |
| [ocsp_sig_algorithm](#ocsp_sig_algorithm-property-jadesverifier-struct) | The public key algorithm that was used by the CA to sign this OCSP response. |
| [ocsp_source](#ocsp_source-property-jadesverifier-struct) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| [offline_mode](#offline_mode-property-jadesverifier-struct) | Switches the struct to offline mode. |
| [output_bytes](#output_bytes-property-jadesverifier-struct) | Use this property to read the output the struct object has produced. |
| [output_file](#output_file-property-jadesverifier-struct) | Defines where to save the signature. |
| [output_string](#output_string-property-jadesverifier-struct) | Use this property to read the output the struct object has produced. |
| [profile](#profile-property-jadesverifier-struct) | Specifies a pre-defined profile to apply when creating the signature. |
| [proxy_address](#proxy_address-property-jadesverifier-struct) | The IP address of the proxy server. |
| [proxy_authentication](#proxy_authentication-property-jadesverifier-struct) | The authentication type used by the proxy server. |
| [proxy_password](#proxy_password-property-jadesverifier-struct) | The password to authenticate to the proxy server. |
| [proxy_port](#proxy_port-property-jadesverifier-struct) | The port on the proxy server to connect to. |
| [proxy_type](#proxy_type-property-jadesverifier-struct) | The type of the proxy server. |
| [proxy_request_headers](#proxy_request_headers-property-jadesverifier-struct) | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| [proxy_response_body](#proxy_response_body-property-jadesverifier-struct) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| [proxy_response_headers](#proxy_response_headers-property-jadesverifier-struct) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| [proxy_use_ipv6](#proxy_use_ipv6-property-jadesverifier-struct) | Specifies whether IPv6 should be used when connecting through the proxy. |
| [proxy_username](#proxy_username-property-jadesverifier-struct) | Specifies the username credential for proxy authentication. |
| [revocation_check](#revocation_check-property-jadesverifier-struct) | Specifies the kind(s) of revocation check to perform for all chain certificates. |
| [signature_count](#signature_count-property-jadesverifier-struct) | The number of records in the Signature arrays. |
| [signature_chain_validation_details](#signature_chain_validation_details-property-jadesverifier-struct) | The details of a certificate chain validation outcome. |
| [signature_chain_validation_result](#signature_chain_validation_result-property-jadesverifier-struct) | The outcome of a certificate chain validation routine. |
| [signature_claimed_signing_time](#signature_claimed_signing_time-property-jadesverifier-struct) | The signing time from the signer's computer. |
| [signature_compatibility_errors](#signature_compatibility_errors-property-jadesverifier-struct) | Returns compatibility errors encountered during validation. |
| [signature_contains_long_term_info](#signature_contains_long_term_info-property-jadesverifier-struct) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| [signature_content_type](#signature_content_type-property-jadesverifier-struct) | Specifies payload content type. |
| [signature_countersigned](#signature_countersigned-property-jadesverifier-struct) | Indicates if the signature is countersigned. |
| [signature_entity_label](#signature_entity_label-property-jadesverifier-struct) | Use this property to get the signature entity label. |
| [signature_handle](#signature_handle-property-jadesverifier-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [signature_hash_algorithm](#signature_hash_algorithm-property-jadesverifier-struct) | Specifies the hash algorithm to be used. |
| [signature_issuer_rdn](#signature_issuer_rdn-property-jadesverifier-struct) | The Relative Distinguished Name of the signing certificate's issuer. |
| [signature_jades_version](#signature_jades_version-property-jadesverifier-struct) | Specifies JAdES version. |
| [signature_last_archival_time](#signature_last_archival_time-property-jadesverifier-struct) | Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. |
| [signature_level](#signature_level-property-jadesverifier-struct) | Specifies the signature kind and level. |
| [signature_object_type](#signature_object_type-property-jadesverifier-struct) | Specifies signature object content type. |
| [signature_parent_entity](#signature_parent_entity-property-jadesverifier-struct) | Use this property to get the parent signature label. |
| [signature_policy_hash](#signature_policy_hash-property-jadesverifier-struct) | The signature policy hash value. |
| [signature_policy_hash_algorithm](#signature_policy_hash_algorithm-property-jadesverifier-struct) | The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash. |
| [signature_policy_id](#signature_policy_id-property-jadesverifier-struct) | The policy ID that was included or to be included into the signature. |
| [signature_policy_uri](#signature_policy_uri-property-jadesverifier-struct) | The signature policy URI that was included in the signature. |
| [signature_serial_number](#signature_serial_number-property-jadesverifier-struct) | The serial number of the signing certificate. |
| [signature_bytes](#signature_bytes-property-jadesverifier-struct) | Returns the binary representation of the JSON/JAdES signature. |
| [signature_validation_result](#signature_validation_result-property-jadesverifier-struct) | The outcome of the cryptographic signature validation. |
| [signature_signed_data](#signature_signed_data-property-jadesverifier-struct) | The sigD header parameter in JSON format that was included or to be included into the signature. |
| [signature_signed_data_type](#signature_signed_data_type-property-jadesverifier-struct) | Specifies the type of signed data. |
| [signature_subject_key_id](#signature_subject_key_id-property-jadesverifier-struct) | Contains the subject key identifier of the signing certificate. |
| [signature_subject_rdn](#signature_subject_rdn-property-jadesverifier-struct) | Contains information about the person owning the signing certificate. |
| [signature_timestamped](#signature_timestamped-property-jadesverifier-struct) | Use this property to establish whether the signature contains an embedded timestamp. |
| [signature_validated_signing_time](#signature_validated_signing_time-property-jadesverifier-struct) | Contains the certified signing time. |
| [signature_validation_log](#signature_validation_log-property-jadesverifier-struct) | Contains the complete log of the certificate validation routine. |
| [socket_dns_mode](#socket_dns_mode-property-jadesverifier-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-jadesverifier-struct) | Specifies the port number to be used for sending queries to the DNS server. |
| [socket_dns_query_timeout](#socket_dns_query_timeout-property-jadesverifier-struct) | The timeout (in milliseconds) for each DNS query. |
| [socket_dns_servers](#socket_dns_servers-property-jadesverifier-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-jadesverifier-struct) | The timeout (in milliseconds) for the whole resolution process. |
| [socket_incoming_speed_limit](#socket_incoming_speed_limit-property-jadesverifier-struct) | The maximum number of bytes to read from the socket, per second. |
| [socket_local_address](#socket_local_address-property-jadesverifier-struct) | The local network interface to bind the socket to. |
| [socket_local_port](#socket_local_port-property-jadesverifier-struct) | The local port number to bind the socket to. |
| [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property-jadesverifier-struct) | The maximum number of bytes to write to the socket, per second. |
| [socket_timeout](#socket_timeout-property-jadesverifier-struct) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| [socket_use_ipv6](#socket_use_ipv6-property-jadesverifier-struct) | Enables or disables IP protocol version 6. |
| [timestamp_count](#timestamp_count-property-jadesverifier-struct) | The number of records in the Timestamp arrays. |
| [timestamp_accuracy](#timestamp_accuracy-property-jadesverifier-struct) | This property indicates the accuracy of the included time mark, in microseconds. |
| [timestamp_bytes](#timestamp_bytes-property-jadesverifier-struct) | Returns the raw timestamp data in DER format. |
| [timestamp_certificate_index](#timestamp_certificate_index-property-jadesverifier-struct) | Returns the index of the TSA certificate in the Certificates collection. |
| [timestamp_chain_validation_details](#timestamp_chain_validation_details-property-jadesverifier-struct) | The details of a certificate chain validation outcome. |
| [timestamp_chain_validation_result](#timestamp_chain_validation_result-property-jadesverifier-struct) | The outcome of a certificate chain validation routine. |
| [timestamp_contains_long_term_info](#timestamp_contains_long_term_info-property-jadesverifier-struct) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| [timestamp_entity_label](#timestamp_entity_label-property-jadesverifier-struct) | Use this property to get the timestamp entity label. |
| [timestamp_hash_algorithm](#timestamp_hash_algorithm-property-jadesverifier-struct) | Returns the timestamp's hash algorithm. |
| [timestamp_parent_entity](#timestamp_parent_entity-property-jadesverifier-struct) | Use this property to get the label of the timestamp's parent entity. |
| [timestamp_serial_number](#timestamp_serial_number-property-jadesverifier-struct) | Returns the timestamp's serial number. |
| [timestamp_time](#timestamp_time-property-jadesverifier-struct) | The time point incorporated into the timestamp. |
| [timestamp_type](#timestamp_type-property-jadesverifier-struct) | Returns the type of the timestamp. |
| [timestamp_tsa_name](#timestamp_tsa_name-property-jadesverifier-struct) | This value uniquely identifies the Timestamp Authority (TSA). |
| [timestamp_validation_log](#timestamp_validation_log-property-jadesverifier-struct) | Contains the TSA certificate chain validation log. |
| [timestamp_validation_result](#timestamp_validation_result-property-jadesverifier-struct) | Contains the timestamp validation outcome. |
| [tls_client_cert_count](#tls_client_cert_count-property-jadesverifier-struct) | The number of records in the TLSClientCert arrays. |
| [tls_client_cert_bytes](#tls_client_cert_bytes-property-jadesverifier-struct) | Returns the raw certificate data in DER format. |
| [tls_client_cert_handle](#tls_client_cert_handle-property-jadesverifier-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-jadesverifier-struct) | The number of records in the TLSServerCert arrays. |
| [tls_server_cert_bytes](#tls_server_cert_bytes-property-jadesverifier-struct) | Returns the raw certificate data in DER format. |
| [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property-jadesverifier-struct) | Contains the fingerprint (a hash imprint) of this certificate. |
| [tls_server_cert_handle](#tls_server_cert_handle-property-jadesverifier-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-jadesverifier-struct) | The common name of the certificate issuer (CA), typically a company name. |
| [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property-jadesverifier-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property-jadesverifier-struct) | Specifies the public key algorithm of this certificate. |
| [tls_server_cert_key_bits](#tls_server_cert_key_bits-property-jadesverifier-struct) | Returns the length of the public key in bits. |
| [tls_server_cert_key_usage](#tls_server_cert_key_usage-property-jadesverifier-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-jadesverifier-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-jadesverifier-struct) | Returns the certificate's serial number. |
| [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property-jadesverifier-struct) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [tls_server_cert_subject](#tls_server_cert_subject-property-jadesverifier-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-jadesverifier-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-jadesverifier-struct) | The time point at which the certificate becomes valid, in UTC. |
| [tls_server_cert_valid_to](#tls_server_cert_valid_to-property-jadesverifier-struct) | The time point at which the certificate expires, in UTC. |
| [tls_auto_validate_certificates](#tls_auto_validate_certificates-property-jadesverifier-struct) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| [tls_base_configuration](#tls_base_configuration-property-jadesverifier-struct) | Selects the base configuration for the TLS settings. |
| [tls_ciphersuites](#tls_ciphersuites-property-jadesverifier-struct) | A list of ciphersuites separated with commas or semicolons. |
| [tls_client_auth](#tls_client_auth-property-jadesverifier-struct) | Enables or disables certificate-based client authentication. |
| [tls_extensions](#tls_extensions-property-jadesverifier-struct) | Provides access to TLS extensions. |
| [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property-jadesverifier-struct) | Whether to force TLS session resumption when the destination address changes. |
| [tls_groups](#tls_groups-property-jadesverifier-struct) | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| [tls_pre_shared_identity](#tls_pre_shared_identity-property-jadesverifier-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-jadesverifier-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-jadesverifier-struct) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property-jadesverifier-struct) | Selects the renegotiation attack prevention mechanism. |
| [tls_revocation_check](#tls_revocation_check-property-jadesverifier-struct) | Specifies the kind(s) of revocation check to perform. |
| [tls_ssl_options](#tls_ssl_options-property-jadesverifier-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-jadesverifier-struct) | Specifies the TLS mode to use. |
| [tls_use_extended_master_secret](#tls_use_extended_master_secret-property-jadesverifier-struct) | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| [tls_use_session_resumption](#tls_use_session_resumption-property-jadesverifier-struct) | Enables or disables the TLS session resumption capability. |
| [tls_versions](#tls_versions-property-jadesverifier-struct) | The SSL/TLS versions to enable by default. |
| [trusted_cert_count](#trusted_cert_count-property-jadesverifier-struct) | The number of records in the TrustedCert arrays. |
| [trusted_cert_bytes](#trusted_cert_bytes-property-jadesverifier-struct) | Returns the raw certificate data in DER format. |
| [trusted_cert_handle](#trusted_cert_handle-property-jadesverifier-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [validation_moment](#validation_moment-property-jadesverifier-struct) | The time point at which signature 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.*

|  |  |
| --- | --- |
| [close](#close-method-jadesverifier-struct) | Closes an opened JWS/JAdES signature. |
| [config](#config-method-jadesverifier-struct) | Sets or retrieves a configuration setting. |
| [do_action](#do_action-method-jadesverifier-struct) | Performs an additional action. |
| [open](#open-method-jadesverifier-struct) | Opens a JSON for verifying or removing signatures. |
| [reset](#reset-method-jadesverifier-struct) | Resets the struct settings. |
| [revalidate](#revalidate-method-jadesverifier-struct) | Revalidates a signature in accordance with current settings. |
| [select_info](#select_info-method-jadesverifier-struct) | Select signature information for a specific entity. |
| [unsign](#unsign-method-jadesverifier-struct) | Deletes a signature from the JWS/JAdES signature. |
| [verify](#verify-method-jadesverifier-struct) | Verifies the JWS/JAdES signature. |

## 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_chain_element_download](#on_chain_element_download-event-jadesverifier-struct) | Fires when there is a need to download a chain element from an online source. |
| [on_chain_element_needed](#on_chain_element_needed-event-jadesverifier-struct) | Fires when an element required to validate the chain was not located. |
| [on_chain_element_store](#on_chain_element_store-event-jadesverifier-struct) | This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature. |
| [on_chain_validated](#on_chain_validated-event-jadesverifier-struct) | Reports the completion of a certificate chain validation. |
| [on_chain_validation_progress](#on_chain_validation_progress-event-jadesverifier-struct) | This event is fired multiple times during chain validation to report various stages of the validation procedure. |
| [on_error](#on_error-event-jadesverifier-struct) | Information about errors during signing. |
| [on_http_header_field_needed](#on_http_header_field_needed-event-jadesverifier-struct) | This event is fired when HTTP header field value is required. |
| [on_loaded](#on_loaded-event-jadesverifier-struct) | This event is fired when the JSON has been loaded into memory. |
| [on_notification](#on_notification-event-jadesverifier-struct) | This event notifies the application about an underlying control flow event. |
| [on_object_needed](#on_object_needed-event-jadesverifier-struct) | This event is fired when object is required. |
| [on_object_validate](#on_object_validate-event-jadesverifier-struct) | This event is fired when object should be verified by user. |
| [on_signature_found](#on_signature_found-event-jadesverifier-struct) | Signifies the start of signature validation. |
| [on_signature_validated](#on_signature_validated-event-jadesverifier-struct) | Marks the completion of the signature validation routine. |
| [on_timestamp_found](#on_timestamp_found-event-jadesverifier-struct) | Signifies the start of a timestamp validation routine. |
| [on_timestamp_validated](#on_timestamp_validated-event-jadesverifier-struct) | Reports the completion of the timestamp validation routine. |
| [on_tls_cert_needed](#on_tls_cert_needed-event-jadesverifier-struct) | Fires when a remote TLS party requests a client certificate. |
| [on_tls_cert_validate](#on_tls_cert_validate-event-jadesverifier-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-jadesverifier-struct) | Fires when a TLS handshake with Host successfully completes. |
| [on_tls_handshake](#on_tls_handshake-event-jadesverifier-struct) | Fires when a new TLS handshake is initiated, before the handshake commences. |
| [on_tls_shutdown](#on_tls_shutdown-event-jadesverifier-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.*

|  |  |
| --- | --- |
| [AsyncDocumentID](#AsyncDocumentID) | Specifies the document ID for SignAsyncEnd() call. |
| [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. |
| [CertThumbprint](#CertThumbprint) | Specifies the certificate thumbprint. |
| [CertURL](#CertURL) | Specifies the certificate URL. |
| [ChainCurrentCACert](#ChainCurrentCACert) | Returns the current CA certificate. |
| [ChainCurrentCert](#ChainCurrentCert) | Returns the certificate that is currently being validated. |
| [ChainCurrentCRL](#ChainCurrentCRL) | Returns the current CRL. |
| [ChainCurrentCRLSize](#ChainCurrentCRLSize) | Returns the size of the current CRL. |
| [ChainCurrentOCSP](#ChainCurrentOCSP) | Returns the current OCSP response. |
| [ChainCurrentOCSPSigner](#ChainCurrentOCSPSigner) | Returns the signer of the current OCSP object. |
| [ChainInterimDetails](#ChainInterimDetails) | Returns the current interim validation details. |
| [ChainInterimResult](#ChainInterimResult) | Returns the current interim validation result. |
| [CheckValidityPeriodForTrusted](#CheckValidityPeriodForTrusted) | Whether to check validity period for trusted certificates. |
| [CustomTrustedLists](#CustomTrustedLists) | Specifies the custom TrustedLists. |
| [CustomTSLs](#CustomTSLs) | Specifies the custom TrustedLists. |
| [DataBase64](#DataBase64) | Specifies whether data is Base64-URL-encoded. |
| [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. |
| [ForceCompleteChainValidation](#ForceCompleteChainValidation) | Whether to check the CA certificates when the signing certificate is invalid. |
| [ForceCompleteChainValidationForTrusted](#ForceCompleteChainValidationForTrusted) | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| [GracePeriod](#GracePeriod) | Specifies a grace period to apply during revocation information checks. |
| [IgnoreChainLoops](#IgnoreChainLoops) | Whether chain loops should be ignored. |
| [IgnoreChainValidationErrors](#IgnoreChainValidationErrors) | Whether to ignore any certificate chain validation issues. |
| [IgnoreOCSPNoCheckExtension](#IgnoreOCSPNoCheckExtension) | Whether the OCSP NoCheck extension should be ignored. |
| [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. |
| [ImplicitlyTrustSelfSignedCertificates](#ImplicitlyTrustSelfSignedCertificates) | Whether to trust self-signed certificates. |
| [JAdESOptions](#JAdESOptions) | Specifies the JAdES options. |
| [KeyId](#KeyId) | Specifies Key ID. |
| [PolicyDescription](#PolicyDescription) | signature policy description. |
| [PolicyExplicitText](#PolicyExplicitText) | The explicit text of the user notice. |
| [PolicyUNNumbers](#PolicyUNNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. |
| [PolicyUNOrganization](#PolicyUNOrganization) | The organization part of the NoticeReference qualifier. |
| [ProductionPlace](#ProductionPlace) | Identifies the place of the signature production. |
| [PromoteLongOCSPResponses](#PromoteLongOCSPResponses) | Whether long OCSP responses are requested. |
| [ProtectedHeader](#ProtectedHeader) | Specifies the protected header. |
| [PSSUsed](#PSSUsed) | Whether to use RSASSA-PSS algorithm. |
| [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. |
| [SchemeParams](#SchemeParams) | The algorithm scheme parameters to employ. |
| [SignerAttrs](#SignerAttrs) | Identifies the signer attributes. |
| [SignerCommitments](#SignerCommitments) | Identifies the signer commitments. |
| [SigPolicyDescription](#SigPolicyDescription) | signature policy description. |
| [SigPolicyExplicitText](#SigPolicyExplicitText) | The explicit text of the user notice. |
| [SigPolicyHash](#SigPolicyHash) | The EPES policy hash. |
| [SigPolicyHashAlgorithm](#SigPolicyHashAlgorithm) | The hash algorithm that was used to generate the EPES policy hash. |
| [SigPolicyID](#SigPolicyID) | The EPES policy ID. |
| [SigPolicyNoticeNumbers](#SigPolicyNoticeNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. |
| [SigPolicyNoticeOrganization](#SigPolicyNoticeOrganization) | The organization part of the NoticeReference qualifier. |
| [SigPolicyURI](#SigPolicyURI) | The EPES policy URI. |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [ThumbprintHashAlgorithm](#ThumbprintHashAlgorithm) | Specifies the thumbprint hash algorithm. |
| [TimestampResponse](#TimestampResponse) | A base16-encoded timestamp response received from a TSA. |
| [TLSChainValidationDetails](#TLSChainValidationDetails) | Contains the advanced details of the TLS server certificate validation. |
| [TLSChainValidationResult](#TLSChainValidationResult) | Contains the result of the TLS server certificate validation. |
| [TLSClientAuthRequested](#TLSClientAuthRequested) | Indicates whether the TLS server requests client authentication. |
| [TLSValidationLog](#TLSValidationLog) | Contains the log of the TLS server certificate validation. |
| [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. |
| [TspAttemptCount](#TspAttemptCount) | Specifies the number of timestamping request attempts. |
| [TspHashAlgorithm](#TspHashAlgorithm) | Sets a specific hash algorithm for use with the timestamping service. |
| [TspReqPolicy](#TspReqPolicy) | Sets a request policy ID to include in the timestamping request. |
| [UnprotectedHeader](#UnprotectedHeader) | Specifies the unprotected header. |
| [UseDefaultTrustedLists](#UseDefaultTrustedLists) | Enables or disables the use of the default TrustedLists. |
| [UseDefaultTSLs](#UseDefaultTSLs) | Enables or disables the use of the default TrustedLists. |
| [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. |
| [UsePSS](#UsePSS) | Whether to use RSASSA-PSS algorithm. |
| [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. |
| [UseValidationCache](#UseValidationCache) | Enables or disable the use of the product-wide certificate chain validation cache. |
| [UseValidatorSettingsForTLSValidation](#UseValidatorSettingsForTLSValidation) | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. |
| [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. |

# all_signatures_valid property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The cumulative validity of all signatures.

## Syntax

*Rust Syntax*

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

## Default Value

false

## Remarks

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

This property is read-only.

## Data Type

bool

# auto_validate_signatures property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies whether struct should validate any present signatures when the JWS/JAdES signature is opened.

## Syntax

*Rust Syntax*

```text
fn auto_validate_signatures(&self ) -> Result<bool, SecureBlackboxError> fn set_auto_validate_signatures(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

true

## Remarks

This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the [revalidate](#revalidate-method-jadesverifier-struct) method.

## Data Type

bool

# blocked_cert_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct)
- [blocked_cert_handle](#blocked_cert_handle-property-jadesverifier-struct)

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

## Data Type

i32

# blocked_cert_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# blocked_cert_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

## Data Type

i64

# cert_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The number of records in the Cert arrays.

## Syntax

*Rust Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [cert_bytes](#cert_bytes-property-jadesverifier-struct)
- [cert_ca](#cert_ca-property-jadesverifier-struct)
- [cert_ca_key_id](#cert_ca_key_id-property-jadesverifier-struct)
- [cert_crl_distribution_points](#cert_crl_distribution_points-property-jadesverifier-struct)
- [cert_curve](#cert_curve-property-jadesverifier-struct)
- [cert_fingerprint](#cert_fingerprint-property-jadesverifier-struct)
- [cert_friendly_name](#cert_friendly_name-property-jadesverifier-struct)
- [cert_handle](#cert_handle-property-jadesverifier-struct)
- [cert_hash_algorithm](#cert_hash_algorithm-property-jadesverifier-struct)
- [cert_issuer](#cert_issuer-property-jadesverifier-struct)
- [cert_issuer_rdn](#cert_issuer_rdn-property-jadesverifier-struct)
- [cert_key_algorithm](#cert_key_algorithm-property-jadesverifier-struct)
- [cert_key_bits](#cert_key_bits-property-jadesverifier-struct)
- [cert_key_fingerprint](#cert_key_fingerprint-property-jadesverifier-struct)
- [cert_key_usage](#cert_key_usage-property-jadesverifier-struct)
- [cert_key_valid](#cert_key_valid-property-jadesverifier-struct)
- [cert_ocsp_locations](#cert_ocsp_locations-property-jadesverifier-struct)
- [cert_ocsp_no_check](#cert_ocsp_no_check-property-jadesverifier-struct)
- [cert_origin](#cert_origin-property-jadesverifier-struct)
- [cert_policy_i_ds](#cert_policy_i_ds-property-jadesverifier-struct)
- [cert_private_key_bytes](#cert_private_key_bytes-property-jadesverifier-struct)
- [cert_private_key_exists](#cert_private_key_exists-property-jadesverifier-struct)
- [cert_private_key_extractable](#cert_private_key_extractable-property-jadesverifier-struct)
- [cert_public_key_bytes](#cert_public_key_bytes-property-jadesverifier-struct)
- [cert_qualified](#cert_qualified-property-jadesverifier-struct)
- [cert_qualified_statements](#cert_qualified_statements-property-jadesverifier-struct)
- [cert_qualifiers](#cert_qualifiers-property-jadesverifier-struct)
- [cert_self_signed](#cert_self_signed-property-jadesverifier-struct)
- [cert_serial_number](#cert_serial_number-property-jadesverifier-struct)
- [cert_sig_algorithm](#cert_sig_algorithm-property-jadesverifier-struct)
- [cert_source](#cert_source-property-jadesverifier-struct)
- [cert_subject](#cert_subject-property-jadesverifier-struct)
- [cert_subject_alternative_name](#cert_subject_alternative_name-property-jadesverifier-struct)
- [cert_subject_key_id](#cert_subject_key_id-property-jadesverifier-struct)
- [cert_subject_rdn](#cert_subject_rdn-property-jadesverifier-struct)
- [cert_type](#cert_type-property-jadesverifier-struct)
- [cert_valid](#cert_valid-property-jadesverifier-struct)
- [cert_valid_from](#cert_valid_from-property-jadesverifier-struct)
- [cert_valid_to](#cert_valid_to-property-jadesverifier-struct)

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

This property is read-only.

## Data Type

i32

# cert_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
fn cert_bytes(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Returns the raw certificate data in DER format.

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# cert_ca property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Indicates whether the certificate has a CA capability.

## Syntax

*Rust Syntax*

```text
fn cert_ca(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# cert_ca_key_id property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_ca_key_id(&self , CertIndex : 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 [cert_subject_key_id](#cert_subject_key_id-property-jadesverifier-struct) setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# cert_type property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_type(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# cert_crl_distribution_points property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_crl_distribution_points(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_curve property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_curve(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_fingerprint property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_fingerprint(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_friendly_name property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_friendly_name(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_handle(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i64

# cert_hash_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 cert_hash_algorithm(&self , CertIndex : 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 [cert_sig_algorithm](#cert_sig_algorithm-property-jadesverifier-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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_issuer property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_issuer(&self , CertIndex : 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 [cert_issuer_rdn](#cert_issuer_rdn-property-jadesverifier-struct).

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_issuer_rdn property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_issuer_rdn(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_key_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies the public key algorithm of this certificate.

## Syntax

*Rust Syntax*

```text
fn cert_key_algorithm(&self , CertIndex : 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 [cert_key_bits](#cert_key_bits-property-jadesverifier-struct), [cert_curve](#cert_curve-property-jadesverifier-struct), and [cert_public_key_bytes](#cert_public_key_bytes-property-jadesverifier-struct) properties to get more details about the key the certificate contains.

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_key_bits property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the length of the public key in bits.

## Syntax

*Rust Syntax*

```text
fn cert_key_bits(&self , CertIndex : 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 [cert_public_key_bytes](#cert_public_key_bytes-property-jadesverifier-struct) or [cert_private_key_bytes](#cert_private_key_bytes-property-jadesverifier-struct) property would typically contain auxiliary values, and therefore be longer.

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# cert_key_fingerprint property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_key_fingerprint(&self , CertIndex : 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 [cert_fingerprint](#cert_fingerprint-property-jadesverifier-struct) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_key_usage property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 cert_key_usage(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# cert_key_valid property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_key_valid(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

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

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# cert_ocsp_locations property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 cert_ocsp_locations(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_ocsp_no_check property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_ocsp_no_check(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

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

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# cert_origin property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_origin(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

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

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# cert_policy_i_ds property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

## Syntax

*Rust Syntax*

```text
fn cert_policy_i_ds(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_private_key_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_private_key_bytes(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# cert_private_key_exists property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_private_key_exists(&self , CertIndex : 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 [cert_private_key_bytes](#cert_private_key_bytes-property-jadesverifier-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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# cert_private_key_extractable property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Indicates whether the private key is extractable (exportable).

## Syntax

*Rust Syntax*

```text
fn cert_private_key_extractable(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Indicates whether the private key is extractable (exportable).

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# cert_public_key_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Contains the certificate's public key in DER format.

## Syntax

*Rust Syntax*

```text
fn cert_public_key_bytes(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# cert_qualified property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Indicates whether the certificate is qualified.

## Syntax

*Rust Syntax*

```text
fn cert_qualified(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# cert_qualified_statements property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns a simplified qualified status of the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_qualified_statements(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

```text
0   // NonQualified1   // QualifiedHardware2   // QualifiedSoftware
```

## Default Value

0

## Remarks

Returns a simplified qualified status of the certificate.

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# cert_qualifiers property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

A list of qualifiers.

## Syntax

*Rust Syntax*

```text
fn cert_qualifiers(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_self_signed property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_self_signed(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

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

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# cert_serial_number property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the certificate's serial number.

## Syntax

*Rust Syntax*

```text
fn cert_serial_number(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# cert_sig_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_sig_algorithm(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_source property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 cert_source(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# cert_subject property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 cert_subject(&self , CertIndex : 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 [cert_subject_rdn](#cert_subject_rdn-property-jadesverifier-struct).

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_subject_alternative_name property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_subject_alternative_name(&self , CertIndex : 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 [cert_subject_rdn](#cert_subject_rdn-property-jadesverifier-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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_subject_key_id property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_subject_key_id(&self , CertIndex : 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 [cert_subject_key_id](#cert_subject_key_id-property-jadesverifier-struct) and [cert_ca_key_id](#cert_ca_key_id-property-jadesverifier-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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# cert_subject_rdn property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_subject_rdn(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_valid property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 cert_valid(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# cert_valid_from property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# cert_valid_to property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# check_trusted_lists property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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

# compact_form property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies if the JWS compact serialization to be used.

## Syntax

*Rust Syntax*

```text
fn compact_form(&self ) -> Result<bool, SecureBlackboxError> fn set_compact_form(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

When this property is set to "true" value, the JAdES component will use the JWS compact serialization format when saving a signature.

The JWS compact serialization format is a compact, Url safe representation of a JWS (JSON Web Signature) or JWE (JSON Web Encryption) object, used for transmitting security tokens.

The JWS compact serialization format supports only one signature without unprotected header (only JWS or JAdES BaselineB signature).

## Data Type

bool

# content_type property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies payload content type.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Use this property to read the content type of the payload.

This property is read-only.

## Data Type

String

# crl_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The number of records in the CRL arrays.

## Syntax

*Rust Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [crl_bytes](#crl_bytes-property-jadesverifier-struct)
- [crlca_key_id](#crlca_key_id-property-jadesverifier-struct)
- [crl_entry_count](#crl_entry_count-property-jadesverifier-struct)
- [crl_handle](#crl_handle-property-jadesverifier-struct)
- [crl_issuer](#crl_issuer-property-jadesverifier-struct)
- [crl_issuer_rdn](#crl_issuer_rdn-property-jadesverifier-struct)
- [crl_location](#crl_location-property-jadesverifier-struct)
- [crl_next_update](#crl_next_update-property-jadesverifier-struct)
- [crl_sig_algorithm](#crl_sig_algorithm-property-jadesverifier-struct)
- [crl_source](#crl_source-property-jadesverifier-struct)
- [crltbs](#crltbs-property-jadesverifier-struct)
- [crl_this_update](#crl_this_update-property-jadesverifier-struct)

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

This property is read-only.

## Data Type

i32

# crl_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the raw CRL data in DER format.

## Syntax

*Rust Syntax*

```text
fn crl_bytes(&self , CRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Returns the raw CRL data in DER format.

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# crlca_key_id property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn crlca_key_id(&self , CRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

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

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# crl_entry_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the number of certificate status entries in the CRL.

## Syntax

*Rust Syntax*

```text
fn crl_entry_count(&self , CRLIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

Returns the number of certificate status entries in the CRL.

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# crl_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn crl_handle(&self , CRLIndex : 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 *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i64

# crl_issuer property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# crl_issuer_rdn property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# crl_location property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The URL that the CRL was downloaded from.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The URL that the CRL was downloaded from.

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# crl_next_update property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# crl_sig_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

"0"

## Remarks

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

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# crl_source property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 crl_source(&self , CRLIndex : 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 *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# crltbs property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn crltbs(&self , CRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

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

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# crl_this_update property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crl_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# data_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to pass a payload or an object data to struct in the byte array form.

## Syntax

*Rust Syntax*

```text
fn data_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> fn set_data_bytes(&self, value : Vec<u8>) ->  Option<SecureBlackboxError>
fn set_data_bytes_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError>
```

## Remarks

Assign a byte array containing a JWS payload or an object data to be processed to this property.

## Data Type

Vec

# data_file property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

A path to a file containing a payload or an object data.

## Syntax

*Rust Syntax*

```text
fn data_file(&self ) -> Result<String, SecureBlackboxError> fn set_data_file(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_data_file_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Use this property to provide a JWS payload or an object data to be processed.

## Data Type

String

# data_string property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to pass a payload or an object data to struct in the string form.

## Syntax

*Rust Syntax*

```text
fn data_string(&self ) -> Result<String, SecureBlackboxError> fn set_data_string(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_data_string_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Assign a string containing a JWS payload or an object data to be processed to this property.

## Data Type

String

# detached property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies whether a detached signature should be produced or verified.

## Syntax

*Rust Syntax*

```text
fn detached(&self ) -> Result<bool, SecureBlackboxError> fn set_detached(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

Use this property to specify whether a detached signature should be produced or verified.

When this property is set to "true" value, the JWS payload will be detached from the signature and may either be a single detached object or the result of concatenating multiple detached data objects. In other words, the JWS payload and the signature are stored in separate objects.

If this property is set to "true" value, the user must provide the detached content via the [data_file](#data_file-property-jadesverifier-struct) or data_stream or [data_bytes](#data_bytes-property-jadesverifier-struct) or [data_string](#data_string-property-jadesverifier-struct) properties.

When Detached is set to "false" value, the JWS payload is included with the signature as a single object.

## Data Type

bool

# extract_payload property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies whether a payload should be extracted.

## Syntax

*Rust Syntax*

```text
fn extract_payload(&self ) -> Result<bool, SecureBlackboxError> fn set_extract_payload(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

Use this property to specify whether a payload should be extracted when signature loaded. This applies only to non-detached signatures with a payload.

When this property is set to "true" value, the JWS payload will be extracted from the signature.

The user must provide the [output_file](#output_file-property-jadesverifier-struct) or output_stream properties with a filename or stream where to save the payload, if none is provided then payload is returned via [output_bytes](#output_bytes-property-jadesverifier-struct) or [output_string](#output_string-property-jadesverifier-struct) properties.

## Data Type

bool

# fips_mode property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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

# flattened_signature property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies if the flattened signature to be used.

## Syntax

*Rust Syntax*

```text
fn flattened_signature(&self ) -> Result<bool, SecureBlackboxError> fn set_flattened_signature(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

true

## Remarks

This property determines whether to use the flattened JWS JSON serialization format. This format is optimized for the single digital signature case and flattens the general JWS JSON serialization syntax by removing the "signatures" member and instead placing the "protected", "header", and "signature" members at the top-level JSON object (at the same level as the "payload" member).

When the FlattenedSignature property is set to "true" value, the signature will be represented using the flattened JWS JSON serialization format, but it is only applicable when there is a single signature involved.

When the property is set to "false" value, the signature will be represented using the general JWS JSON serialization format.

## Data Type

bool

# ignore_chain_validation_errors property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Makes the struct tolerant to chain validation errors.

## Syntax

*Rust Syntax*

```text
fn ignore_chain_validation_errors(&self ) -> Result<bool, SecureBlackboxError> fn set_ignore_chain_validation_errors(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

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

## Data Type

bool

# input_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to pass the input to struct in byte array form.

## Syntax

*Rust Syntax*

```text
fn input_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> fn set_input_bytes(&self, value : Vec<u8>) ->  Option<SecureBlackboxError>
fn set_input_bytes_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError>
```

## Remarks

Assign a byte array containing the data to be processed to this property.

## Data Type

Vec

# input_file property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The file to be signed.

## Syntax

*Rust Syntax*

```text
fn input_file(&self ) -> Result<String, SecureBlackboxError> fn set_input_file(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_input_file_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Provide the path to the JSON to be signed.

## Data Type

String

# input_string property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to pass the input to struct in the string form.

## Syntax

*Rust Syntax*

```text
fn input_string(&self ) -> Result<String, SecureBlackboxError> fn set_input_string(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_input_string_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Assign a string containing the data to be processed to this property.

## Data Type

String

# known_cert_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct)
- [known_cert_handle](#known_cert_handle-property-jadesverifier-struct)

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

## Data Type

i32

# known_cert_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# known_cert_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

## Data Type

i64

# known_crl_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct)
- [known_crl_handle](#known_crl_handle-property-jadesverifier-struct)

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

## Data Type

i32

# known_crl_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# known_crl_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

## Data Type

i64

# known_ocsp_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct)
- [known_ocsp_handle](#known_ocsp_handle-property-jadesverifier-struct)

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

## Data Type

i32

# known_ocsp_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# known_ocsp_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

## Data Type

i64

# ocsp_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The number of records in the OCSP arrays.

## Syntax

*Rust Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [ocsp_bytes](#ocsp_bytes-property-jadesverifier-struct)
- [ocsp_entry_count](#ocsp_entry_count-property-jadesverifier-struct)
- [ocsp_handle](#ocsp_handle-property-jadesverifier-struct)
- [ocsp_issuer](#ocsp_issuer-property-jadesverifier-struct)
- [ocsp_issuer_rdn](#ocsp_issuer_rdn-property-jadesverifier-struct)
- [ocsp_location](#ocsp_location-property-jadesverifier-struct)
- [ocsp_produced_at](#ocsp_produced_at-property-jadesverifier-struct)
- [ocsp_sig_algorithm](#ocsp_sig_algorithm-property-jadesverifier-struct)
- [ocsp_source](#ocsp_source-property-jadesverifier-struct)

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

This property is read-only.

## Data Type

i32

# ocsp_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

A buffer containing the raw OCSP response data.

## Syntax

*Rust Syntax*

```text
fn ocsp_bytes(&self , OCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

A buffer containing the raw OCSP response data.

The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocsp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# ocsp_entry_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The number of SingleResponse elements contained in this OCSP response.

## Syntax

*Rust Syntax*

```text
fn ocsp_entry_count(&self , OCSPIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

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

The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocsp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# ocsp_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ocsp_handle(&self , OCSPIndex : 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 *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocsp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i64

# ocsp_issuer property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocsp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# ocsp_issuer_rdn property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocsp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# ocsp_location property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The location of the OCSP responder.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The location of the OCSP responder.

The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocsp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# ocsp_produced_at property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocsp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# ocsp_sig_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

"0"

## Remarks

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

The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocsp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# ocsp_source property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ocsp_source(&self , OCSPIndex : 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 *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocsp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# offline_mode property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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

# output_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to read the output the struct object has produced.

## Syntax

*Rust Syntax*

```text
fn output_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the [output_file](#output_file-property-jadesverifier-struct) and output_stream properties had not been assigned.

This property is read-only.

## Data Type

Vec

# output_file property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Defines where to save the signature.

## Syntax

*Rust Syntax*

```text
fn output_file(&self ) -> Result<String, SecureBlackboxError> fn set_output_file(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_output_file_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the path where the JWS/JAdES signature should be saved.

## Data Type

String

# output_string property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to read the output the struct object has produced.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if [output_file](#output_file-property-jadesverifier-struct) and output_stream properties had not been assigned.

This property is read-only.

## Data Type

String

# profile property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn profile(&self ) -> Result<String, SecureBlackboxError> fn set_profile(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_profile_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# proxy_address property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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

# revocation_check property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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

# signature_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The number of records in the Signature arrays.

## Syntax

*Rust Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [signature_bytes](#signature_bytes-property-jadesverifier-struct)
- [signature_chain_validation_details](#signature_chain_validation_details-property-jadesverifier-struct)
- [signature_chain_validation_result](#signature_chain_validation_result-property-jadesverifier-struct)
- [signature_claimed_signing_time](#signature_claimed_signing_time-property-jadesverifier-struct)
- [signature_compatibility_errors](#signature_compatibility_errors-property-jadesverifier-struct)
- [signature_contains_long_term_info](#signature_contains_long_term_info-property-jadesverifier-struct)
- [signature_content_type](#signature_content_type-property-jadesverifier-struct)
- [signature_countersigned](#signature_countersigned-property-jadesverifier-struct)
- [signature_entity_label](#signature_entity_label-property-jadesverifier-struct)
- [signature_handle](#signature_handle-property-jadesverifier-struct)
- [signature_hash_algorithm](#signature_hash_algorithm-property-jadesverifier-struct)
- [signature_issuer_rdn](#signature_issuer_rdn-property-jadesverifier-struct)
- [signature_jades_version](#signature_jades_version-property-jadesverifier-struct)
- [signature_last_archival_time](#signature_last_archival_time-property-jadesverifier-struct)
- [signature_level](#signature_level-property-jadesverifier-struct)
- [signature_object_type](#signature_object_type-property-jadesverifier-struct)
- [signature_parent_entity](#signature_parent_entity-property-jadesverifier-struct)
- [signature_policy_hash](#signature_policy_hash-property-jadesverifier-struct)
- [signature_policy_hash_algorithm](#signature_policy_hash_algorithm-property-jadesverifier-struct)
- [signature_policy_id](#signature_policy_id-property-jadesverifier-struct)
- [signature_policy_uri](#signature_policy_uri-property-jadesverifier-struct)
- [signature_serial_number](#signature_serial_number-property-jadesverifier-struct)
- [signature_signed_data](#signature_signed_data-property-jadesverifier-struct)
- [signature_signed_data_type](#signature_signed_data_type-property-jadesverifier-struct)
- [signature_subject_key_id](#signature_subject_key_id-property-jadesverifier-struct)
- [signature_subject_rdn](#signature_subject_rdn-property-jadesverifier-struct)
- [signature_timestamped](#signature_timestamped-property-jadesverifier-struct)
- [signature_validated_signing_time](#signature_validated_signing_time-property-jadesverifier-struct)
- [signature_validation_log](#signature_validation_log-property-jadesverifier-struct)
- [signature_validation_result](#signature_validation_result-property-jadesverifier-struct)

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

This property is read-only.

## Data Type

i32

# signature_chain_validation_details property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The details of a certificate chain validation outcome.

## Syntax

*Rust Syntax*

```text
fn signature_chain_validation_details(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# signature_chain_validation_result property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The outcome of a certificate chain validation routine.

## Syntax

*Rust Syntax*

```text
fn signature_chain_validation_result(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

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

## Default Value

0

## Remarks

The outcome of a certificate chain validation routine.

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.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# signature_claimed_signing_time property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The signing time from the signer's computer.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The signing time from the signer's computer.

Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_compatibility_errors property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns compatibility errors encountered during validation.

## Syntax

*Rust Syntax*

```text
fn signature_compatibility_errors(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

Returns compatibility errors encountered during validation.

Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# signature_contains_long_term_info property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

## Syntax

*Rust Syntax*

```text
fn signature_contains_long_term_info(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# signature_content_type property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies payload content type.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Specifies payload content type.

Use this property to indicate the content type of the JWS Payload.

This property provides a way for the application to disambiguate among different kinds of objects that might be present in the payload, but it is typically not used when the kind of object is already known. The value of this property is a string that conforms to the Internet Media Type (MIME) format, such as "text/plain" or "application/json".

It is optional to use this property and it is recommended to omit the "application/" prefix of the media type value when it is not needed. The recipient of the signed message should treat the value as if "application/" were prepended to it, unless it already contains a '/'.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_countersigned property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Indicates if the signature is countersigned.

## Syntax

*Rust Syntax*

```text
fn signature_countersigned(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Indicates if the signature is countersigned.

Use this property to find out whether the JWS/JAdES signature contains any countersignatures over the main signature(s).

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# signature_entity_label property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to get the signature entity label.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Use this property to get the signature entity label.

This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signature_handle(&self , SignatureIndex : 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 *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i64

# signature_hash_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies the hash algorithm to be used.

## Syntax

*Rust Syntax*

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

## Default Value

"SHA256"

## Remarks

Specifies the hash algorithm to be used.

Supported values:

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_issuer_rdn property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The Relative Distinguished Name of the signing certificate's issuer.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_jades_version property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies JAdES version.

## Syntax

*Rust Syntax*

```text
fn signature_jades_version(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

```text
0   // Unknown1   // 111
```

## Default Value

1

## Remarks

Specifies JAdES version.

This property specifies the version of the JAdES specification the signature should comply with.

The supported values are:

|  |  |  |
| --- | --- | --- |
| javUnknown | 0 | Unknown |
| jav111 | 1 | JAdES v1.1.1 |

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# signature_last_archival_time property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Indicates the most recent archival time of an archived signature

This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is in UTC.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_level property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies the signature kind and level.

## Syntax

*Rust Syntax*

```text
fn signature_level(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

```text
0   // Unknown1   // Generic2   // BaselineB3   // BaselineT4   // BaselineLT5   // BaselineLTA
```

## Default Value

2

## Remarks

Specifies the signature kind and level.

JAdES standard defines a number of different 'levels' of signatures which can be used for different purposes.

Use the *Generic* value to produce JWS signature.

The supported levels are:

|  |  |  |
| --- | --- | --- |
| jaslUnknown | 0 | Unknown signature level |
| jaslGeneric | 1 | Generic signature: JSON Web Signature (JWS) |
| jaslBaselineB | 2 | Baseline B (B-B, basic) |
| jaslBaselineT | 3 | Baseline T (B-T, timestamped) |
| jaslBaselineLT | 4 | Baseline LT (B-LT, long-term) |
| jaslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) |

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# signature_object_type property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies signature object content type.

## Syntax

*Rust Syntax*

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

## Default Value

"jose+json"

## Remarks

Specifies signature object content type.

Use this property to specify the content type of the signature object.

It is used by the application to differentiate between different types of objects that might be present in an application data structure containing a JWS or JAdES.

The default value is "jose+json" which indicates that it is a JWS or JAdES using the JWS JSON Serialization, and "jose" which indicates that the object is a JWS or JAdES using the JWS Compact Serialization. Other type values can also be used by the application.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_parent_entity property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to get the parent signature label.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Use this property to get the parent signature label.

This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_policy_hash property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The signature policy hash value.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The signature policy hash value.

Use this property to get the signature policy hash from EPES signatures

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_policy_hash_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The algorithm that was used to calculate the signature policy hash

Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from [signature_policy_hash](#signature_policy_hash-property-jadesverifier-struct).

|  |  |  |
| --- | --- | --- |
| 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 *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_policy_id property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The policy ID that was included or to be included into the signature.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The policy ID that was included or to be included into the signature.

Use this property to retrieve the signature policy identifier from EPES signatures.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_policy_uri property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The signature policy URI that was included in the signature.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy from EPES signatures.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_serial_number property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The serial number of the signing certificate.

## Syntax

*Rust Syntax*

```text
fn signature_serial_number(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

The serial number of the signing certificate.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# signature_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the binary representation of the JSON/JAdES signature.

## Syntax

*Rust Syntax*

```text
fn signature_bytes(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Returns the binary representation of the JSON/JAdES signature.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# signature_validation_result property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The outcome of the cryptographic signature validation.

## Syntax

*Rust Syntax*

```text
fn signature_validation_result(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

```text
0   // Valid1   // Unknown2   // Corrupted3   // SignerNotFound4   // Failure5   // ReferenceCorrupted
```

## Default Value

0

## Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# signature_signed_data property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The sigD header parameter in JSON format that was included or to be included into the signature.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The sigD header parameter in JSON format that was included or to be included into the signature.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_signed_data_type property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Specifies the type of signed data.

## Syntax

*Rust Syntax*

```text
fn signature_signed_data_type(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

```text
0   // Payload1   // HttpHeaders2   // ObjectIdByURI3   // ObjectIdByURIHash4   // Custom
```

## Default Value

0

## Remarks

Specifies the type of signed data.

Supported values:

|  |  |  |
| --- | --- | --- |
| jasdtPayload | 0 | JWS Payload |
| jasdtHttpHeaders | 1 | HttpHeaders mechanism |
| jasdtObjectIdByURI | 2 | ObjectIdByURI mechanism |
| jasdtObjectIdByURIHash | 3 | ObjectIdByURIHash mechanism |
| jasdtCustom | 4 | Custom mechanism |

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# signature_subject_key_id property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Contains the subject key identifier of the signing certificate.

## Syntax

*Rust Syntax*

```text
fn signature_subject_key_id(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Contains the subject key identifier of the signing certificate.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# signature_subject_rdn property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Contains information about the person owning the signing certificate.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_timestamped property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to establish whether the signature contains an embedded timestamp.

## Syntax

*Rust Syntax*

```text
fn signature_timestamped(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Use this property to establish whether the signature contains an embedded timestamp.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# signature_validated_signing_time property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Contains the certified signing time.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Contains the certified signing time.

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

[signature_claimed_signing_time](#signature_claimed_signing_time-property-jadesverifier-struct) returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# signature_validation_log property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Contains the complete log of the certificate validation routine.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Contains the complete log of the certificate validation routine.

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.

The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signature_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# socket_dns_mode property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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

# timestamp_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The number of records in the Timestamp arrays.

## Syntax

*Rust Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [timestamp_accuracy](#timestamp_accuracy-property-jadesverifier-struct)
- [timestamp_bytes](#timestamp_bytes-property-jadesverifier-struct)
- [timestamp_certificate_index](#timestamp_certificate_index-property-jadesverifier-struct)
- [timestamp_chain_validation_details](#timestamp_chain_validation_details-property-jadesverifier-struct)
- [timestamp_chain_validation_result](#timestamp_chain_validation_result-property-jadesverifier-struct)
- [timestamp_contains_long_term_info](#timestamp_contains_long_term_info-property-jadesverifier-struct)
- [timestamp_entity_label](#timestamp_entity_label-property-jadesverifier-struct)
- [timestamp_hash_algorithm](#timestamp_hash_algorithm-property-jadesverifier-struct)
- [timestamp_parent_entity](#timestamp_parent_entity-property-jadesverifier-struct)
- [timestamp_serial_number](#timestamp_serial_number-property-jadesverifier-struct)
- [timestamp_time](#timestamp_time-property-jadesverifier-struct)
- [timestamp_tsa_name](#timestamp_tsa_name-property-jadesverifier-struct)
- [timestamp_type](#timestamp_type-property-jadesverifier-struct)
- [timestamp_validation_log](#timestamp_validation_log-property-jadesverifier-struct)
- [timestamp_validation_result](#timestamp_validation_result-property-jadesverifier-struct)

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

This property is read-only.

## Data Type

i32

# timestamp_accuracy property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn timestamp_accuracy(&self , TimestampIndex : i32) -> Result<i64, SecureBlackboxError>
```

## Default Value

0

## Remarks

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

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i64

# timestamp_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the raw timestamp data in DER format.

## Syntax

*Rust Syntax*

```text
fn timestamp_bytes(&self , TimestampIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Returns the raw timestamp data in DER format.

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# timestamp_certificate_index property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
fn timestamp_certificate_index(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Default Value

-1

## Remarks

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

Use this property to look up the TSA certificate in the Certificates collection.

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# timestamp_chain_validation_details property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The details of a certificate chain validation outcome.

## Syntax

*Rust Syntax*

```text
fn timestamp_chain_validation_details(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# timestamp_chain_validation_result property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The outcome of a certificate chain validation routine.

## Syntax

*Rust Syntax*

```text
fn timestamp_chain_validation_result(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

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

## Default Value

0

## Remarks

The outcome of a certificate chain validation routine.

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.

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# timestamp_contains_long_term_info property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

## Syntax

*Rust Syntax*

```text
fn timestamp_contains_long_term_info(&self , TimestampIndex : i32) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# timestamp_entity_label property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Use this property to get the timestamp entity label.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Use this property to get the timestamp entity label.

This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# timestamp_hash_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the timestamp's hash algorithm.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Returns the timestamp's hash algorithm.

|  |  |  |
| --- | --- | --- |
| 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 *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# timestamp_parent_entity property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

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

This property references the EntityLabel of the object that the timestamp covers, typically a signature.

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# timestamp_serial_number property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the timestamp's serial number.

## Syntax

*Rust Syntax*

```text
fn timestamp_serial_number(&self , TimestampIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Returns the timestamp's serial number.

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# timestamp_time property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The time point incorporated into the timestamp.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The time point incorporated into the timestamp.

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# timestamp_type property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Returns the type of the timestamp.

## Syntax

*Rust Syntax*

```text
fn timestamp_type(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

Returns the type of the timestamp.

Available options:

|  |  |  |
| --- | --- | --- |
| tstUnknown | 0 |  |
| tstLegacy | 1 | Supported by: Authenticode components |
| tstTrusted | 2 | Supported by: Authenticode components |
| tstGeneric | 3 | Supported by: CAdES components |
| tstESC | 4 | Supported by: CAdES components |
| tstContent | 5 | Supported by: CAdES components |
| tstCertsAndCRLs | 6 | Supported by: CAdES components |
| tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components |
| tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components |
| tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components |
| tstIndividualDataObjects | 10 | Individual data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components |
| tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components |

Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# timestamp_tsa_name property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

This value uniquely identifies the Timestamp Authority (TSA).

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

This value uniquely identifies the Timestamp Authority (TSA).

This property provides information about the entity that manages the TSA.

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# timestamp_validation_log property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Contains the TSA certificate chain validation log.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# timestamp_validation_result property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Contains the timestamp validation outcome.

## Syntax

*Rust Syntax*

```text
fn timestamp_validation_result(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

```text
0   // Valid1   // Unknown2   // Corrupted3   // SignerNotFound4   // Failure5   // ReferenceCorrupted
```

## Default Value

0

## Remarks

Contains the timestamp validation outcome.

Use this property to check the result of the most recent timestamp validation.

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

The *TimestampIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TimestampCount](#timestamp_count-property-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# tls_client_cert_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct)
- [tls_client_cert_handle](#tls_client_cert_handle-property-jadesverifier-struct)

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

## Data Type

i32

# tls_client_cert_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# tls_client_cert_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

## Data Type

i64

# tls_server_cert_count property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct)
- [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property-jadesverifier-struct)
- [tls_server_cert_handle](#tls_server_cert_handle-property-jadesverifier-struct)
- [tls_server_cert_issuer](#tls_server_cert_issuer-property-jadesverifier-struct)
- [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property-jadesverifier-struct)
- [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property-jadesverifier-struct)
- [tls_server_cert_key_bits](#tls_server_cert_key_bits-property-jadesverifier-struct)
- [tls_server_cert_key_usage](#tls_server_cert_key_usage-property-jadesverifier-struct)
- [tls_server_cert_self_signed](#tls_server_cert_self_signed-property-jadesverifier-struct)
- [tls_server_cert_serial_number](#tls_server_cert_serial_number-property-jadesverifier-struct)
- [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property-jadesverifier-struct)
- [tls_server_cert_subject](#tls_server_cert_subject-property-jadesverifier-struct)
- [tls_server_cert_subject_rdn](#tls_server_cert_subject_rdn-property-jadesverifier-struct)
- [tls_server_cert_valid_from](#tls_server_cert_valid_from-property-jadesverifier-struct)
- [tls_server_cert_valid_to](#tls_server_cert_valid_to-property-jadesverifier-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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# tls_server_cert_fingerprint property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

i64

# tls_server_cert_issuer property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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](#JAdESVerifier_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-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_issuer_rdn property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_key_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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](#JAdESVerifier_p_TLSKeyBits), [tls_curve](#JAdESVerifier_p_TLSCurve), and [tls_public_key_bytes](#JAdESVerifier_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-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_key_bits property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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](#JAdESVerifier_p_TLSPublicKeyBytes) or [tls_private_key_bytes](#JAdESVerifier_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-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# tls_server_cert_key_usage property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

i32

# tls_server_cert_self_signed property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

bool

# tls_server_cert_serial_number property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# tls_server_cert_sig_algorithm property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_subject property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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](#JAdESVerifier_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-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_subject_rdn property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_valid_from property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# tls_server_cert_valid_to property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

String

# tls_auto_validate_certificates property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct)
- [trusted_cert_handle](#trusted_cert_handle-property-jadesverifier-struct)

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

## Data Type

i32

# trusted_cert_bytes property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

This property is read-only.

## Data Type

Vec

# trusted_cert_handle property ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) property.

## Data Type

i64

# validation_moment property ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

The time point at which signature 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 signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).

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

## Data Type

String

# close method ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Closes an opened JWS/JAdES signature.

## Syntax

*Rust Syntax*

```text
fn close(&self, save_changes : bool) -> Result<(), SecureBlackboxError>
```

## Remarks

Use this method to close a previously opened JWS/JAdES signature. Set *SaveChanges* to true to apply any changes made.

# config method ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-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-jadesverifier-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# do_action method ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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. |

# open method ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Opens a JSON for verifying or removing signatures.

## Syntax

*Rust Syntax*

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

## Remarks

Use this method to open a JSON for verifying or removing signatures. When finished, call [close](#close-method-jadesverifier-struct) to complete or discard the operation.

# reset method ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Resets the struct settings.

## Syntax

*Rust Syntax*

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

## Remarks

reset is a generic method available in every struct.

# revalidate method ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Revalidates a signature in accordance with current settings.

## Syntax

*Rust Syntax*

```text
fn revalidate(&self, sig_label : &str) -> Result<(), SecureBlackboxError>
```

## Remarks

Use this method to re-validate a signature in the opened JWS/JAdES signature.

# select_info method ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Select signature information for a specific entity.

## Syntax

*Rust Syntax*

```text
fn select_info(&self, entity_label : &str, info_type : i32, clear_selection : bool) -> Result<(), SecureBlackboxError>
```

## Remarks

Use this method to select (or filter) signature-related information for a specific signature element.

Provide the unique label of the entity that you are interested in via the *EntityLabel* parameter. Use one of the following filters, or their combination, to specify what information you are interested in:

|  |  |  |
| --- | --- | --- |
| sitEntity | 1 | Select the current entity |
| sitParentEntity | 2 | Select the parent entity of the current entity |
| sitTimestamps | 4 | Select all timestamps covering the current entity |
| sitSignatures | 8 | Select all signatures covering the current entity |
| sitSigningChain | 16 | Select the signing chain of the current entity |
| sitEmbeddedCertificates | 256 | Select all certificates embedded in the current entity |
| sitEmbeddedCRLs | 512 | Select all CRLs embedded in the current entity |
| sitEmbeddedOCSPs | 1024 | Select all OCSP responses embedded in the current entity |
| sitEmbeddedRevInfo | 1792 | Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs) |
| sitUsedCertificates | 4096 | Select all the certificates used to validate this entity's chain |
| sitUsedCRLs | 8192 | Select all the CRLs used to validate this entity's chain |
| sitUsedOCSPs | 16384 | Select all the OCSP responses used to validate this entity's chain |
| sitUsedRevInfo | 28672 | Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses) |
| sitAttributes | 65536 | Select this entity's CMS attributes |
| sitReferences | 131072 | Select this entity's XML references |
| sitSignedParts | 262144 | Select this entity's signed parts |

Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to select_info and keeping *ClearSelection* set to false.

This method is useful if you would like to read/display detailed information about a particular signature or timestamp.

# unsign method ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Deletes a signature from the JWS/JAdES signature.

## Syntax

*Rust Syntax*

```text
fn unsign(&self, sig_label : &str) -> Result<(), SecureBlackboxError>
```

## Remarks

Use this method to delete an existing signature from the JWS/JAdES signature. Use *SigLabel* parameter to specify the signature to be removed.

# verify method ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Verifies the JWS/JAdES signature.

## Syntax

*Rust Syntax*

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

## Remarks

Use this method to verify the JWS/JAdES signature.

# on_chain_element_download event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
// JAdESVerifierChainElementDownloadEventArgs carries the JAdESVerifier ChainElementDownload event's parameters.
pub struct JAdESVerifierChainElementDownloadEventArgs {
  fn kind(&self) -> i32
  fn cert_rdn(&self) -> &String
  fn ca_cert_rdn(&self) -> &String
  fn location(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// JAdESVerifierChainElementDownloadEvent defines the signature of the JAdESVerifier ChainElementDownload event's handler function.
pub trait JAdESVerifierChainElementDownloadEvent {
  fn on_chain_element_download(&self, sender : JAdESVerifier, e : &mut JAdESVerifierChainElementDownloadEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_chain_element_download(&self) -> &'a dyn JAdESVerifierChainElementDownloadEvent;
  pub fn set_on_chain_element_download(&mut self, value : &'a dyn JAdESVerifierChainElementDownloadEvent);
  ...
}
```

## Remarks

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

|  |  |  |
| --- | --- | --- |
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |

|  |  |  |
| --- | --- | --- |
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |

# on_chain_element_needed event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
// JAdESVerifierChainElementNeededEventArgs carries the JAdESVerifier ChainElementNeeded event's parameters.
pub struct JAdESVerifierChainElementNeededEventArgs {
  fn kind(&self) -> i32
  fn cert_rdn(&self) -> &String
  fn ca_cert_rdn(&self) -> &String
}

// JAdESVerifierChainElementNeededEvent defines the signature of the JAdESVerifier ChainElementNeeded event's handler function.
pub trait JAdESVerifierChainElementNeededEvent {
  fn on_chain_element_needed(&self, sender : JAdESVerifier, e : &mut JAdESVerifierChainElementNeededEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_chain_element_needed(&self) -> &'a dyn JAdESVerifierChainElementNeededEvent;
  pub fn set_on_chain_element_needed(&mut self, value : &'a dyn JAdESVerifierChainElementNeededEvent);
  ...
}
```

## Remarks

Subscribe to this event to be notified about missing validation elements. Use the known_crls, known_certificates, and known_ocsps properties in the event handler to provide the missing piece.

|  |  |  |
| --- | --- | --- |
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |

# on_chain_element_store event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierChainElementStoreEventArgs carries the JAdESVerifier ChainElementStore event's parameters.
pub struct JAdESVerifierChainElementStoreEventArgs {
  fn kind(&self) -> i32
  fn body(&self) -> &[u8]
  fn uri(&self) -> &String
  fn set_uri(&self, value : &str)
  fn set_uri_ref(&self, value : &String)
}

// JAdESVerifierChainElementStoreEvent defines the signature of the JAdESVerifier ChainElementStore event's handler function.
pub trait JAdESVerifierChainElementStoreEvent {
  fn on_chain_element_store(&self, sender : JAdESVerifier, e : &mut JAdESVerifierChainElementStoreEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_chain_element_store(&self) -> &'a dyn JAdESVerifierChainElementStoreEvent;
  pub fn set_on_chain_element_store(&mut self, value : &'a dyn JAdESVerifierChainElementStoreEvent);
  ...
}
```

## Remarks

This event could occur if you are verifying XAdES-C form or higher. The *Body* parameter contains the element in binary form that should be stored along with a signature. Use the *URI* parameter to provide an URI of the stored element.

|  |  |  |
| --- | --- | --- |
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |

# on_chain_validated event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Reports the completion of a certificate chain validation.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierChainValidatedEventArgs carries the JAdESVerifier ChainValidated event's parameters.
pub struct JAdESVerifierChainValidatedEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn subject_rdn(&self) -> &String
  fn validation_result(&self) -> i32
  fn validation_details(&self) -> i32
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// JAdESVerifierChainValidatedEvent defines the signature of the JAdESVerifier ChainValidated event's handler function.
pub trait JAdESVerifierChainValidatedEvent {
  fn on_chain_validated(&self, sender : JAdESVerifier, e : &mut JAdESVerifierChainValidatedEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_chain_validated(&self) -> &'a dyn JAdESVerifierChainValidatedEvent;
  pub fn set_on_chain_validated(&mut self, value : &'a dyn JAdESVerifierChainValidatedEvent);
  ...
}
```

## Remarks

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

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

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

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

|  |  |  |
| --- | --- | --- |
| 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_chain_validation_progress event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
// JAdESVerifierChainValidationProgressEventArgs carries the JAdESVerifier ChainValidationProgress event's parameters.
pub struct JAdESVerifierChainValidationProgressEventArgs {
  fn event_kind(&self) -> &String
  fn cert_rdn(&self) -> &String
  fn ca_cert_rdn(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// JAdESVerifierChainValidationProgressEvent defines the signature of the JAdESVerifier ChainValidationProgress event's handler function.
pub trait JAdESVerifierChainValidationProgressEvent {
  fn on_chain_validation_progress(&self, sender : JAdESVerifier, e : &mut JAdESVerifierChainValidationProgressEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_chain_validation_progress(&self) -> &'a dyn JAdESVerifierChainValidationProgressEvent;
  pub fn set_on_chain_validation_progress(&mut self, value : &'a dyn JAdESVerifierChainValidationProgressEvent);
  ...
}
```

## Remarks

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

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

|  |  |  |
| --- | --- | --- |
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |

# on_error event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Information about errors during signing.

## Syntax

*Rust Syntax*

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

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

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

## Remarks

This event is fired in case of exceptional conditions during the JSON processing.

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

# on_http_header_field_needed event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

This event is fired when HTTP header field value is required.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierHTTPHeaderFieldNeededEventArgs carries the JAdESVerifier HTTPHeaderFieldNeeded event's parameters.
pub struct JAdESVerifierHTTPHeaderFieldNeededEventArgs {
  fn field_name(&self) -> &String
  fn field_values(&self) -> &String
  fn set_field_values(&self, value : &str)
  fn set_field_values_ref(&self, value : &String)
}

// JAdESVerifierHTTPHeaderFieldNeededEvent defines the signature of the JAdESVerifier HTTPHeaderFieldNeeded event's handler function.
pub trait JAdESVerifierHTTPHeaderFieldNeededEvent {
  fn on_http_header_field_needed(&self, sender : JAdESVerifier, e : &mut JAdESVerifierHTTPHeaderFieldNeededEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_http_header_field_needed(&self) -> &'a dyn JAdESVerifierHTTPHeaderFieldNeededEvent;
  pub fn set_on_http_header_field_needed(&mut self, value : &'a dyn JAdESVerifierHTTPHeaderFieldNeededEvent);
  ...
}
```

## Remarks

This event is triggered when the type of signed data is HttpHeaders mechanism (jasdtHttpHeaders). It indicates that a HTTP header field value is needed.

For "(request target)" field name value return request method and target URI separated by space character. For example: "GET https://nsoftware.com/sbb/"

# on_loaded event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

This event is fired when the JSON has been loaded into memory.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierLoadedEventArgs carries the JAdESVerifier Loaded event's parameters.
pub struct JAdESVerifierLoadedEventArgs {
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// JAdESVerifierLoadedEvent defines the signature of the JAdESVerifier Loaded event's handler function.
pub trait JAdESVerifierLoadedEvent {
  fn on_loaded(&self, sender : JAdESVerifier, e : &mut JAdESVerifierLoadedEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_loaded(&self) -> &'a dyn JAdESVerifierLoadedEvent;
  pub fn set_on_loaded(&mut self, value : &'a dyn JAdESVerifierLoadedEvent);
  ...
}
```

## Remarks

The handler for this event is a good place to check JWS/JAdES signature properties, which may be useful when preparing the signature.

Set *Cancel* to true to terminate JSON processing on this stage.

# on_notification event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

```text
// JAdESVerifierNotificationEventArgs carries the JAdESVerifier Notification event's parameters.
pub struct JAdESVerifierNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

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

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

## 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:

|  |  |
| --- | --- |
| Loaded | Reports the completion of signature processing by the component. Use the event handler to access signature-related information. The EventParam value passed with this EventID is empty. |
| PayloadExtracted | Reports the completion of payload extraction by the component if [extract_payload](#extract_payload-property-jadesverifier-struct) property is enabled. Use the event handler to access payload. The EventParam value passed with this EventID is empty. |
| SignaturesLoaded | Notifies the application that the component has finished loading signatures. |
| BeforeTimestamp | This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings. |
| TimestampError | This event is only fired if the struct failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info. |
| TimestampRequest | A timestamp is requested from the custom timestamping authority. This event is only fired if timestamp_server was set to a virtual:// URI. The EventParam parameter contains the TSP request (or the plain hash, depending on the value provided to timestamp_server), in base16, that needs to be sent to the TSA. Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property. |

# on_object_needed event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

This event is fired when object is required.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierObjectNeededEventArgs carries the JAdESVerifier ObjectNeeded event's parameters.
pub struct JAdESVerifierObjectNeededEventArgs {
  fn uri(&self) -> &String
  fn content_type(&self) -> &String
  fn base64(&self) -> bool
  fn set_base64(&self, value : bool)
}

// JAdESVerifierObjectNeededEvent defines the signature of the JAdESVerifier ObjectNeeded event's handler function.
pub trait JAdESVerifierObjectNeededEvent {
  fn on_object_needed(&self, sender : JAdESVerifier, e : &mut JAdESVerifierObjectNeededEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_object_needed(&self) -> &'a dyn JAdESVerifierObjectNeededEvent;
  pub fn set_on_object_needed(&mut self, value : &'a dyn JAdESVerifierObjectNeededEvent);
  ...
}
```

## Remarks

This event is triggered when the type of signed data is ObjectIdByURI mechanism (jasdtObjectIdByURI). It is fired to request the data to be signed/verified.

The event handler must pass object data to the component via [data_file](#data_file-property-jadesverifier-struct) or data_stream or [data_bytes](#data_bytes-property-jadesverifier-struct) or [data_string](#data_string-property-jadesverifier-struct) property.

# on_object_validate event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

This event is fired when object should be verified by user.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierObjectValidateEventArgs carries the JAdESVerifier ObjectValidate event's parameters.
pub struct JAdESVerifierObjectValidateEventArgs {
  fn uri(&self) -> &String
  fn content_type(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn hash(&self) -> &[u8]
  fn base64(&self) -> bool
  fn valid(&self) -> bool
  fn set_valid(&self, value : bool)
}

// JAdESVerifierObjectValidateEvent defines the signature of the JAdESVerifier ObjectValidate event's handler function.
pub trait JAdESVerifierObjectValidateEvent {
  fn on_object_validate(&self, sender : JAdESVerifier, e : &mut JAdESVerifierObjectValidateEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_object_validate(&self) -> &'a dyn JAdESVerifierObjectValidateEvent;
  pub fn set_on_object_validate(&mut self, value : &'a dyn JAdESVerifierObjectValidateEvent);
  ...
}
```

## Remarks

This event is triggered when the type of signed data is ObjectIdByURIHash mechanism (jasdtObjectIdByURIHash). It is fired to validate the detached object.

The event handler must pass the object validity to the component via *Valid* parameter.

# on_signature_found event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Signifies the start of signature validation.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierSignatureFoundEventArgs carries the JAdESVerifier SignatureFound event's parameters.
pub struct JAdESVerifierSignatureFoundEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn cert_found(&self) -> bool
  fn validate_signature(&self) -> bool
  fn set_validate_signature(&self, value : bool)
  fn validate_chain(&self) -> bool
  fn set_validate_chain(&self, value : bool)
}

// JAdESVerifierSignatureFoundEvent defines the signature of the JAdESVerifier SignatureFound event's handler function.
pub trait JAdESVerifierSignatureFoundEvent {
  fn on_signature_found(&self, sender : JAdESVerifier, e : &mut JAdESVerifierSignatureFoundEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_signature_found(&self) -> &'a dyn JAdESVerifierSignatureFoundEvent;
  pub fn set_on_signature_found(&mut self, value : &'a dyn JAdESVerifierSignatureFoundEvent);
  ...
}
```

## Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its *IssuerRDN*, *SerialNumber*, and *SubjectKeyID* parameters. It fires for every signature located in the verified document or message.

The *CertFound* parameter is set to True if the struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the  and  properties respectively.

Use the *ValidateSignature* and *ValidateChain* parameters to tell the verifier which stages to include in the validation.

# on_signature_validated event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Marks the completion of the signature validation routine.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierSignatureValidatedEventArgs carries the JAdESVerifier SignatureValidated event's parameters.
pub struct JAdESVerifierSignatureValidatedEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn validation_result(&self) -> i32
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// JAdESVerifierSignatureValidatedEvent defines the signature of the JAdESVerifier SignatureValidated event's handler function.
pub trait JAdESVerifierSignatureValidatedEvent {
  fn on_signature_validated(&self, sender : JAdESVerifier, e : &mut JAdESVerifierSignatureValidatedEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_signature_validated(&self) -> &'a dyn JAdESVerifierSignatureValidatedEvent;
  pub fn set_on_signature_validated(&mut self, value : &'a dyn JAdESVerifierSignatureValidatedEvent);
  ...
}
```

## Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the *IssuerRDN*, *SerialNumber*, and/or *SubjectKeyID* parameters to identify the signing certificate.

*ValidationResult* is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

# on_timestamp_found event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Signifies the start of a timestamp validation routine.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierTimestampFoundEventArgs carries the JAdESVerifier TimestampFound event's parameters.
pub struct JAdESVerifierTimestampFoundEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn cert_found(&self) -> bool
  fn validate_timestamp(&self) -> bool
  fn set_validate_timestamp(&self, value : bool)
  fn validate_chain(&self) -> bool
  fn set_validate_chain(&self, value : bool)
}

// JAdESVerifierTimestampFoundEvent defines the signature of the JAdESVerifier TimestampFound event's handler function.
pub trait JAdESVerifierTimestampFoundEvent {
  fn on_timestamp_found(&self, sender : JAdESVerifier, e : &mut JAdESVerifierTimestampFoundEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_timestamp_found(&self) -> &'a dyn JAdESVerifierTimestampFoundEvent;
  pub fn set_on_timestamp_found(&mut self, value : &'a dyn JAdESVerifierTimestampFoundEvent);
  ...
}
```

## Remarks

This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its *IssuerRDN*, *SerialNumber*, and *SubjectKeyID* parameters.

The *CertFound* parameter is set to True if the struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.

Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the  and  properties respectively.

Use the *ValidateSignature* and *ValidateChain* parameters to tell the verifier which stages to include in the validation.

# on_timestamp_validated event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Reports the completion of the timestamp validation routine.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierTimestampValidatedEventArgs carries the JAdESVerifier TimestampValidated event's parameters.
pub struct JAdESVerifierTimestampValidatedEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn time(&self) -> &String
  fn validation_result(&self) -> i32
  fn chain_validation_result(&self) -> i32
  fn chain_validation_details(&self) -> i32
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// JAdESVerifierTimestampValidatedEvent defines the signature of the JAdESVerifier TimestampValidated event's handler function.
pub trait JAdESVerifierTimestampValidatedEvent {
  fn on_timestamp_validated(&self, sender : JAdESVerifier, e : &mut JAdESVerifierTimestampValidatedEventArgs);
}

impl <'a> JAdESVerifier<'a> {
  pub fn on_timestamp_validated(&self) -> &'a dyn JAdESVerifierTimestampValidatedEvent;
  pub fn set_on_timestamp_validated(&mut self, value : &'a dyn JAdESVerifierTimestampValidatedEvent);
  ...
}
```

## Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

*ValidationResult* is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

# on_tls_cert_needed event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Fires when a remote TLS party requests a client certificate.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierTLSCertNeededEventArgs carries the JAdESVerifier TLSCertNeeded event's parameters.
pub struct JAdESVerifierTLSCertNeededEventArgs {
  fn host(&self) -> &String
  fn ca_names(&self) -> &String
}

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

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

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

# on_tls_cert_validate event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

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

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

## 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Fires when a TLS handshake with Host successfully completes.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierTLSEstablishedEventArgs carries the JAdESVerifier TLSEstablished event's parameters.
pub struct JAdESVerifierTLSEstablishedEventArgs {
  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)
}

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

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

## 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

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

## Syntax

*Rust Syntax*

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

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

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

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

# on_tls_shutdown event ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

Reports the graceful closure of a TLS connection.

## Syntax

*Rust Syntax*

```text
// JAdESVerifierTLSShutdownEventArgs carries the JAdESVerifier TLSShutdown event's parameters.
pub struct JAdESVerifierTLSShutdownEventArgs {
  fn host(&self) -> &String
}

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

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

## 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) 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-jadesverifier-struct) method.

### JAdESVerifier Config Settings

**AsyncDocumentID**: Specifies the document ID for SignAsyncEnd() call.Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

**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 1 day (86400 seconds). A value of 0 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 50 percent. Values are interpreted in the 0..100 range. A value of 0 disables the CRL ratio check. 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 10 minutes (600 seconds). A value of 0 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 1 hour (3600 seconds). A value of 0 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 50 percent. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. A value of 0 disables the OCSP response ratio check. 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 10 minutes (600 seconds). A value of 0 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.

**CertThumbprint**: Specifies the certificate thumbprint.The certificate thumbprint that was included into the signature.

**CertURL**: Specifies the certificate URL.The certificate URL that was included or to be included into the signature.

The certificate URL is the "x5u" (X.509 URL) Header Parameter that refers to a resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or JAdES.

**ChainCurrentCACert**: Returns the current CA certificate.This property returns the CA certificate that is used on the current step.

**ChainCurrentCert**: Returns the certificate that is currently being validated.Use this property to obtain the body of the certificate that is currently being validated.

**ChainCurrentCRL**: Returns the current CRL.Returns the CRL object that is currently being processed.

**ChainCurrentCRLSize**: Returns the size of the current CRL.This property returns the size of the CRL object that is currently being processed.

**ChainCurrentOCSP**: Returns the current OCSP response.Returns the OCSP object that is currently being processed.

**ChainCurrentOCSPSigner**: Returns the signer of the current OCSP object.Returns the signer/CA that has issued the OCSP response that is currently being processed.

**ChainInterimDetails**: Returns the current interim validation details.This property returns the interim chain validation details.

**ChainInterimResult**: Returns the current interim validation result.Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes.

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

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

**DataBase64**: Specifies whether data is Base64-URL-encoded.This property controls the "b64" header parameter and it determines the representation of the JWS payload or object data. Its value must be the same for all signatures if there are multiple of them in the JSON.

If the value is set to "true", the JWS payload will be represented as a Base64-URL-encoded string.

If the value is "false", the JWS payload will be represented without any encoding.

The default value of this property is "true".

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

The default value is **dcrlpPreferComplete** (1).

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.

**ForceCompleteChainValidation**: Whether to check the CA certificates when the signing certificate is invalid.Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid.

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

**GracePeriod**: Specifies a grace period to apply during revocation information checks.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.

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

**IgnoreChainValidationErrors**: Whether to ignore any certificate chain validation issues.Enable this property to ignore any chain validation errors when creating a signature. This may be useful if the signature is created in an environment which uses different trust settings to the validation environment.

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

**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. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows emulating the verifying environment without actually changing its security settings.

**JAdESOptions**: Specifies the JAdES options.Contains a comma-separated list of values that specifies JAdES options.

Supported values are:

|  |  |  |
| --- | --- | --- |
| WriteBase64Param |  | The parameter controls the inclusion of the "b64" header parameter in the signature. When this flag is set, the "b64" header parameter will always be included in the header. Otherwise, the "b64" header parameter will only be included in the header when it is required. |
| PreferEtsiUClearInstance |  | The parameter determines whether the EtsiU components should be written as clear JSON instances or as Base64-encoded strings. When this flag is set, EtsiU components will be written as clear JSON instances, if possible. Otherwise, the EtsiU components will be Base64url-encoded strings. |

**KeyId**: Specifies Key ID.The Key ID that was included or to be included into the signature.

Key ID is a hint indicating which key was used to secure the JWS or JAdES.

**PolicyDescription**: signature policy description.This property specifies the Description of the signature policy.

**PolicyExplicitText**: The explicit text of the user notice.Use this property to specify the explicit text of the user notice to be displayed when the signature is verified.

**PolicyUNNumbers**: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.

**PolicyUNOrganization**: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES.

**ProductionPlace**: Identifies the place of the signature production.The signature production place in JSON format that was included or to be included into the signature.

Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'

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

**ProtectedHeader**: Specifies the protected header.The protected header that was included or to be included into the signature.

**PSSUsed**: Whether to use RSASSA-PSS algorithm.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. This is an alias for *UsePSS*.

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

Supported values are case-insensitive:

|  |  |
| --- | --- |
| Default | Applies the AdES default freshness settings: crl:86400;50;600,ocsp:3600;50;600. This means: CRL maximum age 1 day, CRL age ratio 50%, CRL overlap 10 minutes; OCSP response maximum age 1 hour, OCSP response age ratio 50%, OCSP response overlap 10 minutes. This value is the default. |
| Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. |
| 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.

**SchemeParams**: The algorithm scheme parameters to employ.Use this property to specify the parameters of the algorithm scheme if needed.

This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: *Scheme=PSS;SaltSize=32;TrailerField=1*.

**SignerAttrs**: Identifies the signer attributes.The signer attributes in JSON format that was included or to be included into the signature.

**SignerCommitments**: Identifies the signer commitments.The signer commitments in JSON format that was included or to be included into the signature.

**SigPolicyDescription**: signature policy description.This property specifies the Description of the signature policy (an alias for PolicyDescription).

**SigPolicyExplicitText**: The explicit text of the user notice.Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText);

**SigPolicyHash**: The EPES policy hash.Use this configuration setting to provide the EPES policy hash.

**SigPolicyHashAlgorithm**: The hash algorithm that was used to generate the EPES policy hash.Use this setting to provide the hash algorithm that was used to generate the policy hash.

**SigPolicyID**: The EPES policy ID.The EPES signature policy identifier, in dotted OID format (1.2.3.4.5).

**SigPolicyNoticeNumbers**: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers).

**SigPolicyNoticeOrganization**: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization).

**SigPolicyURI**: The EPES policy URI.Assign the EPES policy URI to this setting.

**TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply.

**ThumbprintHashAlgorithm**: Specifies the thumbprint hash algorithm.The certificate thumbprint hash algorithm that was included or to be included into the signature.

**TimestampResponse**: A base16-encoded timestamp response received from a TSA.When using *virtual://* timestamp endpoints, assign this property in your [on_notification](#on_notification-event-jadesverifier-struct) event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16).

**TLSChainValidationDetails**: Contains the advanced details of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to access the TLS certificate validation details.

**TLSChainValidationResult**: Contains the result of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to obtain the TLS certificate validation result.

**TLSClientAuthRequested**: Indicates whether the TLS server requests client authentication.Check this property in the TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via the TLSClientChain property. Note that the struct may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted.

**TLSValidationLog**: Contains the log of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to retrieve the validation log of the TLS server.

**TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated

**TspAttemptCount**: Specifies the number of timestamping request attempts.Use this property to specify a number of timestamping request attempts.

In case of a timestamping failure, provide new TSA and HTTP settings inside the [on_notification](#on_notification-event-jadesverifier-struct) event handler ('BeforeTimestamp' and 'TimestampError' event IDs).

**TspHashAlgorithm**: Sets a specific hash algorithm for use with the timestamping service.In default configuration struct uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp.

Note: Unlike other structs, [PDFSigner](PDFSigner.md#PDFSigner) struct uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp.

**TspReqPolicy**: Sets a request policy ID to include in the timestamping request.Use this property to provide a specific request policy OID to include in the timestamping request. Use the standard human-readable OID notation (1.2.3.4.5).

**UnprotectedHeader**: Specifies the unprotected header.The unprotected header that was included or to be included into the signature.

**UseDefaultTrustedLists**: Enables or disables 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) LOTL (list of trusted lists).

**UseDefaultTSLs**: Enables or disables 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) LOTL (list of trusted lists).

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

**UsePSS**: Whether to use RSASSA-PSS algorithm.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations.

**UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in 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.

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

**UseValidatorSettingsForTLSValidation**: Whether to employ the primary chain validator setup for auxiliary TLS chain validations.Use this property to specify whether you would like to use the primary (AdES) chain validator component to validate TLS chains for any connections involved (OCSP, CRL).

### 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 ([JAdESVerifier](#struct-secureblackboxjadesverifier) Struct)

### JAdESVerifier 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)) |
| 53477377 | The input file does not exist ([SB_ERROR_JADES_INPUTFILE_NOT_EXISTS](constants.md#const_SBERRORJADESINPUTFILENOTEXISTS)) |