Struct secureblackbox::PDFVerifier
Properties Methods Events Config Settings Errors
The PDFVerifier struct verifies signatures over PDF documents.
Syntax
secureblackbox::PDFVerifier
Remarks
Use PDFVerifier to validate electronic signatures over PDF documents. Generic and PAdES signatures are supported.
PDFVerifier verifier = new PDFVerifier();
// Set the signed PDF document that you want to verify
verifier.setInputFile("signed.pdf");
verifier.verify();
// Verification information
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 svtUnknown:
System.out.println("Signature validity is unknown.");
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;
}
}
PDFVerifier validates each signature from two perspectives: the integrity and validity of the signature itself (i.e. its correspondence to the document 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 around, 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 PDF file to the input_file property (alternatively, you can provide it in a memory buffer via the input_bytes property), and call the verify method. For every signature located in the document, PDFVerifier will fire the on_signature_found event. This event lets you specify whether you want PDFVerifier 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 in accordance with the specifics of your application and its usage scenarios. For example, if your trust environment relies on certificate pinning, validating the chain by PDFVerifier internally may cause unnecessary burden on the system, in which case it may be reasonable to disable it in the event handler.
Once on_signature_found returns, PDFVerifier proceeds to the signature validation routine in accordance with the provided settings. Upon completion of the validation, the on_signature_validated event is fired, and the validation results are separately provided via the and fields of the associated signature object. Other information about the signature can be accessed via the signatures property.
The PDF format uses incremental updates to introduce changes to the document. This implies that a signature may cover not the whole document, but rather a certain revision of it. Strictly speaking, every signature in a PDF document, apart from perhaps the last one, covers just some part of the document. In most cases that part matches the revision of the document that existed before all the subsequent signatures had been added.
Because of these specifics of the PDF format, it is crucially important to understand which part of the document is covered by a specific signature. Use the field to establish the scope of a signature. The revision of the document covered by that specific signature ranges from byte 0 to CoverageEndsAt. Alternatively, you can use the get_signed_version method to extract the signed revision to a file.
Useful settings and properties
The following properties of PDFVerifier may be handy when working with this struct:
- offline_mode lets you validate the document without contacting online revocation sources. Paired with switched-off system trust settings, it can be used to establish the long-term validity of the document and the completeness of the validation material included in it.
- revocation_check lets you adjust the revocation checking preferences.
- returns the signing time as recorded in the embedded signature timestamp. This is in contrast to , which returns the signing time as specified by the signer.
- 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.
- If the document is encrypted (in addition to being signed), the on_encrypted event will fire, asking you for the decryption certificate or password.
By default, PDFVerifier 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 PDFVerifier struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of PDFVerifier 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 | The cumulative validity of all signatures. |
| attached_file_count | The number of records in the AttachedFiles arrays. |
| attached_files_content_subtype | Contains the content subtype of the attachment. |
| attached_files_content_type | Contains the content type of the attachment. |
| attached_files_creation_date | The creation date. |
| attached_files_data | The content of the attachment. |
| attached_files_description | Textual description of the attachment. |
| attached_files_file_name | Specifies the name of the attachment file. |
| attached_files_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| attached_files_id | Contains the attachment's unique identifier. |
| attached_files_modification_date | Specifies the date and time of the file's last modification. |
| attached_files_read_date | Specifies the file's last read date. |
| attached_files_size | The attachment's size in bytes. |
| auto_validate_signatures | Specifies whether PDFVerifier should validate any present signatures when the document is opened. |
| blocked_cert_count | The number of records in the BlockedCert arrays. |
| blocked_cert_bytes | Returns the raw certificate data in DER format. |
| blocked_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| cert_count | The number of records in the Cert arrays. |
| cert_bytes | Returns the raw certificate data in DER format. |
| cert_ca | Indicates whether the certificate has a CA capability. |
| cert_ca_key_id | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| cert_type | Returns the type of the entity contained in the Certificate object. |
| cert_crl_distribution_points | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| cert_curve | Specifies the elliptic curve associated with the certificate's public key. |
| cert_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| cert_friendly_name | Contains an associated alias (friendly name) of the certificate. |
| cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| cert_hash_algorithm | 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 | The common name of the certificate issuer (CA), typically a company name. |
| cert_issuer_rdn | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| cert_key_algorithm | Specifies the public key algorithm of this certificate. |
| cert_key_bits | Returns the length of the public key in bits. |
| cert_key_fingerprint | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| cert_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| cert_key_valid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| cert_ocsp_locations | 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 | Accessor to the value of the certificate's ocsp-no-check extension. |
| cert_origin | Returns the location that the certificate was taken or loaded from. |
| cert_policy_i_ds | Contains identifiers (OIDs) of the applicable certificate policies. |
| cert_private_key_bytes | Returns the certificate's private key in DER-encoded format. |
| cert_private_key_exists | Indicates whether the certificate has a usable private key associated with it. |
| cert_private_key_extractable | Indicates whether the private key is extractable (exportable). |
| cert_public_key_bytes | Contains the certificate's public key in DER format. |
| cert_qualified | Indicates whether the certificate is qualified. |
| cert_qualified_statements | Returns a simplified qualified status of the certificate. |
| cert_qualifiers | A list of qualifiers. |
| cert_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| cert_serial_number | Returns the certificate's serial number. |
| cert_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| cert_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| cert_subject | 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 | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| cert_subject_key_id | Contains a unique identifier of the certificate's cryptographic key. |
| cert_subject_rdn | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| cert_valid | 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 | The time point at which the certificate becomes valid, in UTC. |
| cert_valid_to | The time point at which the certificate expires, in UTC. |
| check_trusted_lists | Specifies whether the struct should attempt to validate chain trust via a known Trusted List. |
| crl_count | The number of records in the CRL arrays. |
| crl_bytes | Returns the raw CRL data in DER format. |
| crlca_key_id | A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
| crl_entry_count | Returns the number of certificate status entries in the CRL. |
| crl_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| crl_issuer | The common name of the CRL issuer (CA), typically a company name. |
| crl_issuer_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
| crl_location | The URL that the CRL was downloaded from. |
| crl_next_update | The planned time and date of the next version of this CRL to be published. |
| crl_sig_algorithm | The public key algorithm that was used by the CA to sign this CRL. |
| crl_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| crltbs | The to-be-signed part of the CRL (the CRL without the signature part). |
| crl_this_update | The date and time at which this version of the CRL was published. |
| decryption_certificate_bytes | Returns the raw certificate data in DER format. |
| decryption_certificate_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| document_info_encryption_algorithm | The symmetric algorithm used to encrypt the document. |
| document_info_encryption_type | The document encryption type. |
| document_info_metadata_encrypted | Indicates if the document metadata is encrypted. |
| document_info_permissions | Contains the document permissions associated with the encryption. |
| fips_mode | Reserved. |
| ignore_chain_validation_errors | Makes the struct tolerant to chain validation errors. |
| input_bytes | Use this property to pass the input to struct in byte array form. |
| input_file | A path to the signed PDF file. |
| known_cert_count | The number of records in the KnownCert arrays. |
| known_cert_bytes | Returns the raw certificate data in DER format. |
| known_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| known_crl_count | The number of records in the KnownCRL arrays. |
| known_crl_bytes | Returns the raw CRL data in DER format. |
| known_crl_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| known_ocsp_count | The number of records in the KnownOCSP arrays. |
| known_ocsp_bytes | A buffer containing the raw OCSP response data. |
| known_ocsp_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| ocsp_count | The number of records in the OCSP arrays. |
| ocsp_bytes | A buffer containing the raw OCSP response data. |
| ocsp_entry_count | The number of SingleResponse elements contained in this OCSP response. |
| ocsp_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| ocsp_issuer | Indicates the issuer of this response (a CA or its authorized representative). |
| ocsp_issuer_rdn | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
| ocsp_location | The location of the OCSP responder. |
| ocsp_produced_at | Specifies the time when the response was produced, in UTC. |
| ocsp_sig_algorithm | The public key algorithm that was used by the CA to sign this OCSP response. |
| ocsp_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| offline_mode | Switches the struct to offline mode. |
| output_bytes | Use this property to read the output the struct object has produced. |
| output_file | The file to save the signed or updated document to. |
| page_count | The number of records in the Page arrays. |
| page_crop_llx | Specifies the lower-left X coordinate of the page crop area. |
| page_crop_lly | Specifies the lower-left Y coordinate of the page crop area. |
| page_crop_urx | Specifies the upper-right X coordinate of the page crop area. |
| page_crop_ury | Specifies the upper-right Y coordinate of the page crop area. |
| page_height | Specifies the height of the page. |
| page_media_llx | Specifies the lower-left X coordinate of the page media area. |
| page_media_lly | Specifies the lower-left Y coordinate of the page media area. |
| page_media_urx | Specifies the upper-right X coordinate of the page media area. |
| page_media_ury | Specifies the upper-right Y coordinate of the page media area. |
| page_rotate | Specifies the rotation angle of the page in degrees. |
| page_width | Specifies the width of the page. |
| password | The decryption password. |
| profile | Specifies a pre-defined profile to apply when creating the signature. |
| proxy_address | The IP address of the proxy server. |
| proxy_authentication | The authentication type used by the proxy server. |
| proxy_password | The password to authenticate to the proxy server. |
| proxy_port | The port on the proxy server to connect to. |
| proxy_type | The type of the proxy server. |
| proxy_request_headers | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| proxy_response_body | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| proxy_response_headers | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| proxy_use_ipv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
| proxy_username | Specifies the username credential for proxy authentication. |
| revocation_check | Specifies the kind(s) of revocation check to perform for all chain certificates. |
| signature_count | The number of records in the Signature arrays. |
| signature_allowed_changes | The changes to the document allowed by the signature. |
| signature_author_name | A human-readable signer name. |
| signature_certification | Specifies whether this is a Certification (MDP) signature. |
| signature_chain_validation_details | The details of a certificate chain validation outcome. |
| signature_chain_validation_result | The outcome of a certificate chain validation routine. |
| signature_claimed_signing_time | Returns or sets the signature's creation time. |
| signature_compatibility_errors | Returns compatibility errors encountered during validation. |
| signature_contact_info | Contains the signer's contact information. |
| signature_contains_long_term_info | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| signature_coverage_ends_at | Indicates the byte offset in the PDF file where signature coverage ends. |
| signature_custom_data | Uninterpreted custom data to save with the PDF signature. |
| signature_empty_field | Indicates whether the signature is created as an empty property (a signature placeholder). |
| signature_entity_label | Use this property to get the signature entity label. |
| signature_filter_name | Specifies the PDF security handler filter name to use when creating a new signature. |
| signature_full_signature_name | Specifies the full name of the signature property. |
| signature_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| signature_hash_algorithm | Specifies the hash algorithm to be used for signing. |
| signature_height | Specifies the height of the signature widget. |
| signature_issuer_rdn | The Relative Distinguished Name of the signing certificate's issuer. |
| signature_level | Specifies the PAdES signature level. |
| signature_location | Specifies the host name or the physical location of the signing entity. |
| signature_offset_x | Specifies the signature widget offset from the left-hand page border. |
| signature_offset_y | Specifies the signature widget offset from the bottom page border. |
| signature_page | Indicates the index of the page on which the signature is placed. |
| signature_policy_hash | The signature policy hash value for EPES signatures. |
| signature_policy_hash_algorithm | The algorithm that was used to calculate the signature policy hash. |
| signature_policy_id | The policy ID to be included in the signature. |
| signature_policy_uri | The signature policy URI that was included in the signature. |
| signature_reason | Specifies the reason for signing. |
| signature_serial_number | The serial number of the signing certificate that created the signature. |
| signature_bytes | Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures. |
| signature_name | Specifies the unique signature identifier to use. |
| signature_type | The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown. |
| signature_validation_result | The outcome of the cryptographic signature validation. |
| signature_subject_key_id | Contains the subject key identifier of the signing certificate. |
| signature_subject_rdn | Contains the RDN of the owner of the signing certificate. |
| signature_timestamped | Use this property to establish whether the signature contains an embedded timestamp. |
| signature_validated_signing_time | Contains the certified signing time. |
| signature_validation_log | Contains the signing certificate's chain validation log. |
| signature_width | Specifies the width of the signature widget. |
| socket_dns_mode | Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system. |
| socket_dns_port | Specifies the port number to be used for sending queries to the DNS server. |
| socket_dns_query_timeout | The timeout (in milliseconds) for each DNS query. |
| socket_dns_servers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| socket_dns_total_timeout | The timeout (in milliseconds) for the whole resolution process. |
| socket_incoming_speed_limit | The maximum number of bytes to read from the socket, per second. |
| socket_local_address | The local network interface to bind the socket to. |
| socket_local_port | The local port number to bind the socket to. |
| socket_outgoing_speed_limit | The maximum number of bytes to write to the socket, per second. |
| socket_timeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| socket_use_ipv6 | Enables or disables IP protocol version 6. |
| timestamp_count | The number of records in the Timestamp arrays. |
| timestamp_accuracy | This property indicates the accuracy of the included time mark, in microseconds. |
| timestamp_bytes | Returns the raw timestamp data in DER format. |
| timestamp_certificate_index | Returns the index of the TSA certificate in the Certificates collection. |
| timestamp_chain_validation_details | The details of a certificate chain validation outcome. |
| timestamp_chain_validation_result | The outcome of a certificate chain validation routine. |
| timestamp_contains_long_term_info | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| timestamp_entity_label | Use this property to get the timestamp entity label. |
| timestamp_hash_algorithm | Returns the timestamp's hash algorithm. |
| timestamp_parent_entity | Use this property to get the label of the timestamp's parent entity. |
| timestamp_serial_number | Returns the timestamp's serial number. |
| timestamp_time | The time point incorporated into the timestamp. |
| timestamp_type | Returns the type of the timestamp. |
| timestamp_tsa_name | This value uniquely identifies the Timestamp Authority (TSA). |
| timestamp_validation_log | Contains the TSA certificate chain validation log. |
| timestamp_validation_result | Contains the timestamp validation outcome. |
| tls_client_cert_count | The number of records in the TLSClientCert arrays. |
| tls_client_cert_bytes | Returns the raw certificate data in DER format. |
| tls_client_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| tls_server_cert_count | The number of records in the TLSServerCert arrays. |
| tls_server_cert_bytes | Returns the raw certificate data in DER format. |
| tls_server_cert_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| tls_server_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| tls_server_cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
| tls_server_cert_issuer_rdn | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| tls_server_cert_key_algorithm | Specifies the public key algorithm of this certificate. |
| tls_server_cert_key_bits | Returns the length of the public key in bits. |
| tls_server_cert_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| tls_server_cert_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| tls_server_cert_serial_number | Returns the certificate's serial number. |
| tls_server_cert_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| tls_server_cert_subject | 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 | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| tls_server_cert_valid_from | The time point at which the certificate becomes valid, in UTC. |
| tls_server_cert_valid_to | The time point at which the certificate expires, in UTC. |
| tls_auto_validate_certificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| tls_base_configuration | Selects the base configuration for the TLS settings. |
| tls_ciphersuites | A list of ciphersuites separated with commas or semicolons. |
| tls_client_auth | Enables or disables certificate-based client authentication. |
| tls_extensions | Provides access to TLS extensions. |
| tls_force_resume_if_destination_changes | Whether to force TLS session resumption when the destination address changes. |
| tls_groups | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| tls_pre_shared_identity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| tls_pre_shared_key | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| tls_pre_shared_key_ciphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| tls_renegotiation_attack_prevention_mode | Selects the renegotiation attack prevention mechanism. |
| tls_revocation_check | Specifies the kind(s) of revocation check to perform. |
| tls_ssl_options | 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 | Specifies the TLS mode to use. |
| tls_use_extended_master_secret | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| tls_use_session_resumption | Enables or disables the TLS session resumption capability. |
| tls_versions | The SSL/TLS versions to enable by default. |
| trusted_cert_count | The number of records in the TrustedCert arrays. |
| trusted_cert_bytes | Returns the raw certificate data in DER format. |
| trusted_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| validation_moment | 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 | Closes an opened document. |
| config | Sets or retrieves a configuration setting. |
| do_action | Performs an additional action. |
| get_attached_bytes | Saves a PDF attachment to a byte array. |
| get_attached_file | Saves a PDF attachment to a file. |
| get_signed_version | Returns the part of the document that is covered by the signature. |
| open | Opens a document for verifying or removing signatures. |
| reset | Resets the struct settings. |
| revalidate | Revalidates a signature in accordance with current settings. |
| select_info | Select signature information for a specific entity. |
| unsign | Deletes a signature from the document. |
| verify | Verifies a signed PDF document. |
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 | Fires when there is a need to download a chain element from an online source. |
| on_chain_element_needed | Fires when an element required to validate the chain was not located. |
| on_chain_validated | Reports the completion of a certificate chain validation. |
| on_chain_validation_progress | This event is fired multiple times during chain validation to report various stages of the validation procedure. |
| on_document_loaded | This event is fired when the document has been loaded into memory. |
| on_encrypted | Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document. |
| on_error | Information about errors during signing/validation. |
| on_notification | This event notifies the application about an underlying control flow event. |
| on_signature_found | Signifies the start of signature validation. |
| on_signature_validated | Marks the completion of the signature validation routine. |
| on_timestamp_found | Signifies the start of a timestamp validation routine. |
| on_timestamp_validated | Reports the completion of the timestamp validation routine. |
| on_tls_cert_needed | Fires when a remote TLS party requests a client certificate. |
| on_tls_cert_validate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| on_tls_established | Fires when a TLS handshake with Host successfully completes. |
| on_tls_handshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
| on_tls_shutdown | 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.
| AlternateName | TBD. |
| AsyncDocumentID | Specifies the document ID for SignAsyncEnd() call. |
| BuildApplicationName | Specifies the application name used to create the signature. |
| BuildApplicationVersion | Specifies the application version used to create the signature. |
| BuildProperties | Specifies the build properties of the signature. |
| CachedCRLMaxAge | Specifies the maximum age of a cached CRL. |
| CachedCRLMaxAgeRatio | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. |
| CachedCRLOverlapTime | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. |
| CachedOCSPResponseMaxAge | Specifies the maximum age of a cached OCSP response. |
| CachedOCSPResponseMaxAgeRatio | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. |
| CachedOCSPResponseOverlapTime | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. |
| ChainCurrentCACert | Returns the current CA certificate. |
| ChainCurrentCert | Returns the certificate that is currently being validated. |
| ChainCurrentCRL | Returns the current CRL. |
| ChainCurrentCRLSize | Returns the size of the current CRL. |
| ChainCurrentOCSP | Returns the current OCSP response. |
| ChainCurrentOCSPSigner | Returns the signer of the current OCSP object. |
| ChainInterimDetails | Returns the current interim validation details. |
| ChainInterimResult | Returns the current interim validation result. |
| CheckValidityPeriodForTrusted | Whether to check validity period for trusted certificates. |
| ConfigPreferLegacyLevels | Indicates whether legacy signature levels should be preferred. |
| CustomSignedAttributes | TBD. |
| CustomTrustedLists | Specifies the custom TrustedLists. |
| CustomTSLs | Specifies the custom TrustedLists. |
| CustomUnsignedAttributes | TBD. |
| DeltaCRLPreference | Specifies whether complete or delta CRLs are preferred. |
| DislikeOpenEndedOCSPs | Tells the struct to discourage OCSP responses without an explicit NextUpdate parameter. |
| DocumentVersion | The document version from the PDF document header. |
| DTSAccuracy | Indicates the accuracy of the document timestamp. |
| DTSSerialNumber | Indicates the serial number of the document timestamp. |
| DTSTime | Indicates the time of the document timestamp. |
| DTSTSAName | Indicates the TSA name of the document timestamp. |
| EmptySignatureFieldAddRevInfo[Index] | Specifies if revocation checking should be performed. |
| EmptySignatureFieldAlternateName[Index] | Contains an alternate field name. |
| EmptySignatureFieldCount | The number of empty signature form fields. |
| EmptySignatureFieldFlags[Index] | The field flags of the signature form field. |
| EmptySignatureFieldHeight[Index] | The Height of the empty signature form field. |
| EmptySignatureFieldInvisible[Index] | The visibility status of the field. |
| EmptySignatureFieldLegalAttestations[Index] | Specifies the legal attestations that are associated with the signature. |
| EmptySignatureFieldMappingName[Index] | The mapping name to be used when exporting form field data from the document. |
| EmptySignatureFieldName[Index] | Textual field name. |
| EmptySignatureFieldOffsetX[Index] | The field's offset from the left page border. |
| EmptySignatureFieldOffsetY[Index] | The field's offset from the bottom page border. |
| EmptySignatureFieldPage[Index] | The index of the form field's page in the document. |
| EmptySignatureFieldRequiredAllowedChanges[Index] | Specifies the changes allowed by the signature. |
| EmptySignatureFieldRequiredConstraints[Index] | Specifies the required Seed Value Dictionary (SVD) constraints. |
| EmptySignatureFieldRequiredDigestAlgorithms[Index] | Specifies the required digest algorithms. |
| EmptySignatureFieldRequiredFilter[Index] | Specifies the required filter. |
| EmptySignatureFieldRequiredLockAction[Index] | Indicates which set of fields shall be locked. |
| EmptySignatureFieldRequiredLockFields[Index] | Indicates the fields that shall be locked on signing. |
| EmptySignatureFieldRequiredReasons[Index] | Specifies the required reasons. |
| EmptySignatureFieldRequiredSubfilters[Index] | Specifies the required subfilters. |
| EmptySignatureFieldTimestampRequired[Index] | Specifies if the signature should be timestamped. |
| EmptySignatureFieldTSPURL[Index] | URL for a TSP server. |
| EmptySignatureFieldWidth[Index] | The Width of the empty signature form field. |
| EnableOldSignatures | Enables support for prehistoric adbe.x509.sha1 signatures. |
| EncryptionHandlerName | Specifies the custom security handler PDF-name. |
| EvaluateSystemTrust | Enables or disables usage of the platform's built-in trust validation facilities. |
| EvaluateSystemTrustForSelfSignedCertificates | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. |
| EvaluateSystemTrustForSSL | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. |
| ForceCompleteChainValidation | Whether to check the CA certificates when the signing certificate is invalid. |
| ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| GracePeriod | Specifies a grace period to apply during revocation information checks. |
| HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
| IgnoreChainLoops | Whether chain loops should be ignored. |
| IgnoreChainValidationErrors | Whether to ignore any certificate chain validation issues. |
| IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| IgnoreTimestampChainValidityForLevelDetection | Specify whether timestamp chain validity should be ignored during signature level detection. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| IsLTVEnabled | Indicates LTV-enabled signature. |
| MappingName | TBD. |
| MDPHashAlgorithm | Specifies the MDP hash algorithm. |
| PageInfoCount | The number of pages. |
| PageInfoCropBoxEmpty[Index] | Check if the page's crop box is empty or not. |
| PageInfoCropLLX[Index] | Defines the X coordinate of the lower left corner of the crop box. |
| PageInfoCropLLY[Index] | Defines the Y coordinate of the lower left corner of the crop box. |
| PageInfoCropURX[Index] | Defines the X coordinate of the upper right corner of the crop box. |
| PageInfoCropURY[Index] | Defines the Y coordinate of the upper right corner of the crop box. |
| PageInfoHeight[Index] | The Height of the page. |
| PageInfoMediaLLX[Index] | Defines the X coordinate of the lower left corner of the media box. |
| PageInfoMediaLLY[Index] | Defines the Y coordinate of the lower left corner of the media box. |
| PageInfoMediaURX[Index] | Defines the X coordinate of the upper right corner of the media box. |
| PageInfoMediaURY[Index] | Defines the Y coordinate of the upper right corner of the media box. |
| PageInfoRotate[Index] | The Rotate value of the page. |
| PageInfoUserUnit[Index] | Defines the size of default user space units. |
| PageInfoWidth[Index] | The Width of the page. |
| PolicyDescription | signature policy description. |
| PolicyExplicitText | The explicit text of the user notice. |
| PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
| ProductionPlace | Identifies the place of the signature production. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| PSSUsed | Whether to use RSASSA-PSS algorithm. |
| RC4KeyBits | Specifies the number of key bits used for the RC4 algorithm. |
| ReassembleMode | Specifies the document reassemble mode. |
| RevocationCacheAgePolicy | Specifies a preset policy for cached CRL and OCSP response freshness settings. |
| SchemeParams | The algorithm scheme parameters to employ. |
| SigPolicyDescription | signature policy description. |
| SigPolicyExplicitText | The explicit text of the user notice. |
| SigPolicyHash | The EPES policy hash. |
| SigPolicyHashAlgorithm | The hash algorithm that was used to generate the EPES policy hash. |
| SigPolicyID | The EPES policy ID. |
| SigPolicyNoticeNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
| SigPolicyURI | The EPES policy URI. |
| TempPath | Path for storing temporary files. |
| TimestampResponse | A base16-encoded timestamp response received from a TSA. |
| TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
| TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
| TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
| TLSValidationLog | Contains the log of the TLS server certificate validation. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| TspAttemptCount | Specifies the number of timestamping request attempts. |
| TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
| TspReqPolicy | Sets a request policy ID to include in the timestamping request. |
| UseDefaultTrustedLists | Enables or disables the use of the default TrustedLists. |
| UseDefaultTSLs | Enables or disables the use of the default TrustedLists. |
| UseEnvStorages | Enables or disables use of the environment storages. |
| UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| UsePSS | Whether to use RSASSA-PSS algorithm. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
| UseValidatorSettingsForTLSValidation | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. |
| WidgetHeight | Specifies the height of the signature widget. |
| WidgetOffsetX | Specifies the signature widget offset from the left-hand page border. |
| WidgetOffsetY | Specifies the signature widget offset from the bottom page border. |
| WidgetWidth | Specifies the width of the signature widget. |
| XMPMetadataContent | The XMP metadata content. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the struct. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| EnableSSHMLKEM | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server structs. |
| EnableTLSMLKEM | Enables support for ML-KEM and hybrid groups in TLS client and server structs. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client structs created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client structs should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
all_signatures_valid property (PDFVerifier Struct)
The cumulative validity of all signatures.
Syntax
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
attached_file_count property (PDFVerifier Struct)
The number of records in the AttachedFiles arrays.
Syntax
fn attached_file_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- attached_files_content_subtype
- attached_files_content_type
- attached_files_creation_date
- attached_files_data
- attached_files_description
- attached_files_file_name
- attached_files_handle
- attached_files_id
- attached_files_modification_date
- attached_files_read_date
- attached_files_size
This property is read-only.
Data Type
i32
attached_files_content_subtype property (PDFVerifier Struct)
Contains the content subtype of the attachment.
Syntax
fn attached_files_content_subtype(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the content subtype of the attachment.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
String
attached_files_content_type property (PDFVerifier Struct)
Contains the content type of the attachment.
Syntax
fn attached_files_content_type(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the content type of the attachment.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
String
attached_files_creation_date property (PDFVerifier Struct)
The creation date.
Syntax
fn attached_files_creation_date(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The creation date.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
String
attached_files_data property (PDFVerifier Struct)
The content of the attachment.
Syntax
fn attached_files_data(&self , AttachedFileIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
The content of the attachment.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
Vec
attached_files_description property (PDFVerifier Struct)
Textual description of the attachment.
Syntax
fn attached_files_description(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Textual description of the attachment.
This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
String
attached_files_file_name property (PDFVerifier Struct)
Specifies the name of the attachment file.
Syntax
fn attached_files_file_name(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the name of the attachment file.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
String
attached_files_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn attached_files_handle(&self , AttachedFileIndex : i32) -> Result<i64, SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
i64
attached_files_id property (PDFVerifier Struct)
Contains the attachment's unique identifier.
Syntax
fn attached_files_id(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the attachment's unique identifier.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
String
attached_files_modification_date property (PDFVerifier Struct)
Specifies the date and time of the file's last modification.
Syntax
fn attached_files_modification_date(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the date and time of the file's last modification.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
String
attached_files_read_date property (PDFVerifier Struct)
Specifies the file's last read date.
Syntax
fn attached_files_read_date(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the file's last read date.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
String
attached_files_size property (PDFVerifier Struct)
The attachment's size in bytes.
Syntax
fn attached_files_size(&self , AttachedFileIndex : i32) -> Result<i64, SecureBlackboxError>
Default Value
0
Remarks
The attachment's size in bytes.
The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.
This property is read-only.
Data Type
i64
auto_validate_signatures property (PDFVerifier Struct)
Specifies whether PDFVerifier should validate any present signatures when the document is opened.
Syntax
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 method.
Data Type
bool
blocked_cert_count property (PDFVerifier Struct)
The number of records in the BlockedCert arrays.
Syntax
fn blocked_cert_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_blocked_cert_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at blocked_cert_count - 1.Data Type
i32
blocked_cert_bytes property (PDFVerifier Struct)
Returns the raw certificate data in DER format.
Syntax
fn blocked_cert_bytes(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is read-only.
Data Type
Vec
blocked_cert_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn blocked_cert_handle(&self , BlockedCertIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_blocked_cert_handle(&self, BlockedCertIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
Data Type
i64
cert_count property (PDFVerifier Struct)
The number of records in the Cert arrays.
Syntax
fn cert_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- cert_bytes
- cert_ca
- cert_ca_key_id
- cert_crl_distribution_points
- cert_curve
- cert_fingerprint
- cert_friendly_name
- cert_handle
- cert_hash_algorithm
- cert_issuer
- cert_issuer_rdn
- cert_key_algorithm
- cert_key_bits
- cert_key_fingerprint
- cert_key_usage
- cert_key_valid
- cert_ocsp_locations
- cert_ocsp_no_check
- cert_origin
- cert_policy_i_ds
- cert_private_key_bytes
- cert_private_key_exists
- cert_private_key_extractable
- cert_public_key_bytes
- cert_qualified
- cert_qualified_statements
- cert_qualifiers
- cert_self_signed
- cert_serial_number
- cert_sig_algorithm
- cert_source
- cert_subject
- cert_subject_alternative_name
- cert_subject_key_id
- cert_subject_rdn
- cert_type
- cert_valid
- cert_valid_from
- cert_valid_to
This property is read-only.
Data Type
i32
cert_bytes property (PDFVerifier Struct)
Returns the raw certificate data in DER format.
Syntax
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 property.
This property is read-only.
Data Type
Vec
cert_ca property (PDFVerifier Struct)
Indicates whether the certificate has a CA capability.
Syntax
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 property.
This property is read-only.
Data Type
bool
cert_ca_key_id property (PDFVerifier Struct)
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Syntax
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 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 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 property.
This property is read-only.
Data Type
Vec
cert_type property (PDFVerifier Struct)
Returns the type of the entity contained in the Certificate object.
Syntax
fn cert_type(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // X509Certificate
2 // X509CertificateRequest
Default Value
0
Remarks
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager struct to load or create new certificate and certificate requests objects.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i32
cert_crl_distribution_points property (PDFVerifier Struct)
Contains a list of locations of CRL distribution points used to check this certificate's validity.
Syntax
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 property.
This property is read-only.
Data Type
String
cert_curve property (PDFVerifier Struct)
Specifies the elliptic curve associated with the certificate's public key.
Syntax
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 property.
This property is read-only.
Data Type
String
cert_fingerprint property (PDFVerifier Struct)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
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 property.
This property is read-only.
Data Type
String
cert_friendly_name property (PDFVerifier Struct)
Contains an associated alias (friendly name) of the certificate.
Syntax
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 property.
This property is read-only.
Data Type
String
cert_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
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.
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 property.
This property is read-only.
Data Type
i64
cert_hash_algorithm property (PDFVerifier Struct)
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
Syntax
fn 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 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 property.
This property is read-only.
Data Type
String
cert_issuer property (PDFVerifier Struct)
The common name of the certificate issuer (CA), typically a company name.
Syntax
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.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_issuer_rdn property (PDFVerifier Struct)
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
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 property.
This property is read-only.
Data Type
String
cert_key_algorithm property (PDFVerifier Struct)
Specifies the public key algorithm of this certificate.
Syntax
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_curve, and cert_public_key_bytes 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 property.
This property is read-only.
Data Type
String
cert_key_bits property (PDFVerifier Struct)
Returns the length of the public key in bits.
Syntax
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 or cert_private_key_bytes 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 property.
This property is read-only.
Data Type
i32
cert_key_fingerprint property (PDFVerifier Struct)
Returns a SHA1 fingerprint of the public key contained in the certificate.
Syntax
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 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 property.
This property is read-only.
Data Type
String
cert_key_usage property (PDFVerifier Struct)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
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 property.
This property is read-only.
Data Type
i32
cert_key_valid property (PDFVerifier Struct)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
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 property.
This property is read-only.
Data Type
bool
cert_ocsp_locations property (PDFVerifier Struct)
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Syntax
fn 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 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 property.
This property is read-only.
Data Type
String
cert_ocsp_no_check property (PDFVerifier Struct)
Accessor to the value of the certificate's ocsp-no-check extension.
Syntax
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 property.
This property is read-only.
Data Type
bool
cert_origin property (PDFVerifier Struct)
Returns the location that the certificate was taken or loaded from.
Syntax
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 property.
This property is read-only.
Data Type
i32
cert_policy_i_ds property (PDFVerifier Struct)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
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 property.
This property is read-only.
Data Type
String
cert_private_key_bytes property (PDFVerifier Struct)
Returns the certificate's private key in DER-encoded format.
Syntax
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 property.
This property is read-only.
Data Type
Vec
cert_private_key_exists property (PDFVerifier Struct)
Indicates whether the certificate has a usable private key associated with it.
Syntax
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, 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 property.
This property is read-only.
Data Type
bool
cert_private_key_extractable property (PDFVerifier Struct)
Indicates whether the private key is extractable (exportable).
Syntax
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 property.
This property is read-only.
Data Type
bool
cert_public_key_bytes property (PDFVerifier Struct)
Contains the certificate's public key in DER format.
Syntax
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 property.
This property is read-only.
Data Type
Vec
cert_qualified property (PDFVerifier Struct)
Indicates whether the certificate is qualified.
Syntax
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 property.
This property is read-only.
Data Type
bool
cert_qualified_statements property (PDFVerifier Struct)
Returns a simplified qualified status of the certificate.
Syntax
fn cert_qualified_statements(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // NonQualified
1 // QualifiedHardware
2 // QualifiedSoftware
Default Value
0
Remarks
Returns a simplified qualified status of the certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i32
cert_qualifiers property (PDFVerifier Struct)
A list of qualifiers.
Syntax
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 property.
This property is read-only.
Data Type
String
cert_self_signed property (PDFVerifier Struct)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
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 property.
This property is read-only.
Data Type
bool
cert_serial_number property (PDFVerifier Struct)
Returns the certificate's serial number.
Syntax
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 property.
This property is read-only.
Data Type
Vec
cert_sig_algorithm property (PDFVerifier Struct)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
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 property.
This property is read-only.
Data Type
String
cert_source property (PDFVerifier Struct)
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
fn cert_source(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // Signature
2 // Document
3 // User
4 // Local
5 // Online
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i32
cert_subject property (PDFVerifier Struct)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
fn 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.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_subject_alternative_name property (PDFVerifier Struct)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
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 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 property.
This property is read-only.
Data Type
String
cert_subject_key_id property (PDFVerifier Struct)
Contains a unique identifier of the certificate's cryptographic key.
Syntax
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 and cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
Vec
cert_subject_rdn property (PDFVerifier Struct)
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
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 property.
This property is read-only.
Data Type
String
cert_valid property (PDFVerifier Struct)
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
Syntax
fn 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 property.
This property is read-only.
Data Type
bool
cert_valid_from property (PDFVerifier Struct)
The time point at which the certificate becomes valid, in UTC.
Syntax
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 property.
This property is read-only.
Data Type
String
cert_valid_to property (PDFVerifier Struct)
The time point at which the certificate expires, in UTC.
Syntax
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 property.
This property is read-only.
Data Type
String
check_trusted_lists property (PDFVerifier Struct)
Specifies whether the struct should attempt to validate chain trust via a known Trusted List.
Syntax
fn check_trusted_lists(&self ) -> Result<bool, SecureBlackboxError>
fn set_check_trusted_lists(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).
Data Type
bool
crl_count property (PDFVerifier Struct)
The number of records in the CRL arrays.
Syntax
fn crl_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- crl_bytes
- crlca_key_id
- crl_entry_count
- crl_handle
- crl_issuer
- crl_issuer_rdn
- crl_location
- crl_next_update
- crl_sig_algorithm
- crl_source
- crltbs
- crl_this_update
This property is read-only.
Data Type
i32
crl_bytes property (PDFVerifier Struct)
Returns the raw CRL data in DER format.
Syntax
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 property.
This property is read-only.
Data Type
Vec
crlca_key_id property (PDFVerifier Struct)
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
Syntax
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 property.
This property is read-only.
Data Type
Vec
crl_entry_count property (PDFVerifier Struct)
Returns the number of certificate status entries in the CRL.
Syntax
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 property.
This property is read-only.
Data Type
i32
crl_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
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.
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 property.
This property is read-only.
Data Type
i64
crl_issuer property (PDFVerifier Struct)
The common name of the CRL issuer (CA), typically a company name.
Syntax
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 property.
This property is read-only.
Data Type
String
crl_issuer_rdn property (PDFVerifier Struct)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Syntax
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 property.
This property is read-only.
Data Type
String
crl_location property (PDFVerifier Struct)
The URL that the CRL was downloaded from.
Syntax
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 property.
This property is read-only.
Data Type
String
crl_next_update property (PDFVerifier Struct)
The planned time and date of the next version of this CRL to be published.
Syntax
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 property.
This property is read-only.
Data Type
String
crl_sig_algorithm property (PDFVerifier Struct)
The public key algorithm that was used by the CA to sign this CRL.
Syntax
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 property.
This property is read-only.
Data Type
String
crl_source property (PDFVerifier Struct)
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
fn crl_source(&self , CRLIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // Signature
2 // Document
3 // User
4 // Local
5 // Online
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
i32
crltbs property (PDFVerifier Struct)
The to-be-signed part of the CRL (the CRL without the signature part).
Syntax
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 property.
This property is read-only.
Data Type
Vec
crl_this_update property (PDFVerifier Struct)
The date and time at which this version of the CRL was published.
Syntax
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 property.
This property is read-only.
Data Type
String
decryption_certificate_bytes property (PDFVerifier Struct)
Returns the raw certificate data in DER format.
Syntax
fn decryption_certificate_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
Vec
decryption_certificate_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn decryption_certificate_handle(&self ) -> Result<i64, SecureBlackboxError>
fn set_decryption_certificate_handle(&self, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
i64
document_info_encryption_algorithm property (PDFVerifier Struct)
The symmetric algorithm used to encrypt the document.
Syntax
fn document_info_encryption_algorithm(&self ) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The symmetric algorithm used to encrypt the document.
This property contains the encryption algorithm that was used to encrypt the PDF document.
Supported values:
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |
This property is read-only.
Data Type
String
document_info_encryption_type property (PDFVerifier Struct)
The document encryption type.
Syntax
fn document_info_encryption_type(&self ) -> Result<i32, SecureBlackboxError>
Possible Values
0 // None
1 // Password
2 // Certificate
Default Value
1
Remarks
The document encryption type.
This property indicates the kind of encryption that was used to encrypt the PDF document.
Supported values:
| petPassword | 1 | The document is encrypted with a password. |
| petCertificate | 2 | The document is encrypted with a certificate (or many certificates). |
This property is read-only.
Data Type
i32
document_info_metadata_encrypted property (PDFVerifier Struct)
Indicates if the document metadata is encrypted.
Syntax
fn document_info_metadata_encrypted(&self ) -> Result<bool, SecureBlackboxError>
Default Value
true
Remarks
Indicates if the document metadata is encrypted.
Use this property to check if the document metadata is encrypted.
Metadata contains additional information about the document such as its name and author.
This property is read-only.
Data Type
bool
document_info_permissions property (PDFVerifier Struct)
Contains the document permissions associated with the encryption.
Syntax
fn document_info_permissions(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Contains the document permissions associated with the encryption.
Use this property to check the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents. Contains a bit mask of the following flags:
| pepAnnotations | 0x0001 | Annotating is allowed |
| pepAssemble | 0x0002 | Assembling a new document on the basis of the processed one is allowed |
| pepExtract | 0x0004 | Extraction/copying of the pictures and text from the document is allowed |
| pepExtractAcc | 0x0008 | Content extraction is allowed for accessibility purposes only |
| pepFillInForms | 0x0010 | Filling forms in is allowed |
| pepHighQualityPrint | 0x0020 | High quality printing is allowed |
| pepLowQualityPrint | 0x0040 | Low quality printing is allowed |
| pepModify | 0x0080 | Modifications are allowed |
This property is read-only.
Data Type
i32
fips_mode property (PDFVerifier Struct)
Reserved.
Syntax
fn fips_mode(&self ) -> Result<bool, SecureBlackboxError>
fn set_fips_mode(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
This property is reserved for future use.
Data Type
bool
ignore_chain_validation_errors property (PDFVerifier Struct)
Makes the struct tolerant to chain validation errors.
Syntax
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 (PDFVerifier Struct)
Use this property to pass the input to struct in byte array form.
Syntax
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 (PDFVerifier Struct)
A path to the signed PDF file.
Syntax
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
Assign the path to the PDF file to be verified to this property.
Data Type
String
known_cert_count property (PDFVerifier Struct)
The number of records in the KnownCert arrays.
Syntax
fn known_cert_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_known_cert_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at known_cert_count - 1.Data Type
i32
known_cert_bytes property (PDFVerifier Struct)
Returns the raw certificate data in DER format.
Syntax
fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is read-only.
Data Type
Vec
known_cert_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn known_cert_handle(&self , KnownCertIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_known_cert_handle(&self, KnownCertIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
Data Type
i64
known_crl_count property (PDFVerifier Struct)
The number of records in the KnownCRL arrays.
Syntax
fn known_crl_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_known_crl_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at known_crl_count - 1.Data Type
i32
known_crl_bytes property (PDFVerifier Struct)
Returns the raw CRL data in DER format.
Syntax
fn known_crl_bytes(&self , KnownCRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw CRL data in DER format.
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is read-only.
Data Type
Vec
known_crl_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn known_crl_handle(&self , KnownCRLIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_known_crl_handle(&self, KnownCRLIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
Data Type
i64
known_ocsp_count property (PDFVerifier Struct)
The number of records in the KnownOCSP arrays.
Syntax
fn known_ocsp_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_known_ocsp_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at known_ocsp_count - 1.Data Type
i32
known_ocsp_bytes property (PDFVerifier Struct)
A buffer containing the raw OCSP response data.
Syntax
fn known_ocsp_bytes(&self , KnownOCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
A buffer containing the raw OCSP response data.
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is read-only.
Data Type
Vec
known_ocsp_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn known_ocsp_handle(&self , KnownOCSPIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_known_ocsp_handle(&self, KnownOCSPIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
Data Type
i64
ocsp_count property (PDFVerifier Struct)
The number of records in the OCSP arrays.
Syntax
fn ocsp_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- ocsp_bytes
- ocsp_entry_count
- ocsp_handle
- ocsp_issuer
- ocsp_issuer_rdn
- ocsp_location
- ocsp_produced_at
- ocsp_sig_algorithm
- ocsp_source
This property is read-only.
Data Type
i32
ocsp_bytes property (PDFVerifier Struct)
A buffer containing the raw OCSP response data.
Syntax
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 property.
This property is read-only.
Data Type
Vec
ocsp_entry_count property (PDFVerifier Struct)
The number of SingleResponse elements contained in this OCSP response.
Syntax
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 property.
This property is read-only.
Data Type
i32
ocsp_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
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.
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 property.
This property is read-only.
Data Type
i64
ocsp_issuer property (PDFVerifier Struct)
Indicates the issuer of this response (a CA or its authorized representative).
Syntax
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 property.
This property is read-only.
Data Type
String
ocsp_issuer_rdn property (PDFVerifier Struct)
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Syntax
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 property.
This property is read-only.
Data Type
String
ocsp_location property (PDFVerifier Struct)
The location of the OCSP responder.
Syntax
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 property.
This property is read-only.
Data Type
String
ocsp_produced_at property (PDFVerifier Struct)
Specifies the time when the response was produced, in UTC.
Syntax
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 property.
This property is read-only.
Data Type
String
ocsp_sig_algorithm property (PDFVerifier Struct)
The public key algorithm that was used by the CA to sign this OCSP response.
Syntax
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 property.
This property is read-only.
Data Type
String
ocsp_source property (PDFVerifier Struct)
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
fn ocsp_source(&self , OCSPIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // Signature
2 // Document
3 // User
4 // Local
5 // Online
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
i32
offline_mode property (PDFVerifier Struct)
Switches the struct to offline mode.
Syntax
fn offline_mode(&self ) -> Result<bool, SecureBlackboxError>
fn set_offline_mode(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
When working in offline mode, the struct restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via known_certificates, known_crls, and other related properties.
Data Type
bool
output_bytes property (PDFVerifier Struct)
Use this property to read the output the struct object has produced.
Syntax
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 and output_stream properties had not been assigned.
This property is read-only.
Data Type
Vec
output_file property (PDFVerifier Struct)
The file to save the signed or updated document to.
Syntax
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
Use this property to provide a path where the resulting PDF document should be saved to.
Data Type
String
page_count property (PDFVerifier Struct)
The number of records in the Page arrays.
Syntax
fn page_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- page_crop_llx
- page_crop_lly
- page_crop_urx
- page_crop_ury
- page_height
- page_media_llx
- page_media_lly
- page_media_urx
- page_media_ury
- page_rotate
- page_width
This property is read-only.
Data Type
i32
page_crop_llx property (PDFVerifier Struct)
Specifies the lower-left X coordinate of the page crop area.
Syntax
fn page_crop_llx(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the lower-left X coordinate of the page crop area.
Specifies the lower-left X coordinate of the page crop area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_crop_lly property (PDFVerifier Struct)
Specifies the lower-left Y coordinate of the page crop area.
Syntax
fn page_crop_lly(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the lower-left Y coordinate of the page crop area.
Specifies the lower-left Y coordinate of the page crop area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_crop_urx property (PDFVerifier Struct)
Specifies the upper-right X coordinate of the page crop area.
Syntax
fn page_crop_urx(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the upper-right X coordinate of the page crop area.
Specifies the upper-right X coordinate of the page crop area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_crop_ury property (PDFVerifier Struct)
Specifies the upper-right Y coordinate of the page crop area.
Syntax
fn page_crop_ury(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the upper-right Y coordinate of the page crop area.
Specifies the upper-right Y coordinate of the page crop area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_height property (PDFVerifier Struct)
Specifies the height of the page.
Syntax
fn page_height(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the height of the page.
Returns the height of the page.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_media_llx property (PDFVerifier Struct)
Specifies the lower-left X coordinate of the page media area.
Syntax
fn page_media_llx(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the lower-left X coordinate of the page media area.
Specifies the lower-left X coordinate of the page media area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_media_lly property (PDFVerifier Struct)
Specifies the lower-left Y coordinate of the page media area.
Syntax
fn page_media_lly(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the lower-left Y coordinate of the page media area.
Specifies the lower-left Y coordinate of the page media area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_media_urx property (PDFVerifier Struct)
Specifies the upper-right X coordinate of the page media area.
Syntax
fn page_media_urx(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the upper-right X coordinate of the page media area.
Specifies the upper-right X coordinate of the page media area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_media_ury property (PDFVerifier Struct)
Specifies the upper-right Y coordinate of the page media area.
Syntax
fn page_media_ury(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the upper-right Y coordinate of the page media area.
Specifies the upper-right Y coordinate of the page media area rectangle.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_rotate property (PDFVerifier Struct)
Specifies the rotation angle of the page in degrees.
Syntax
fn page_rotate(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the rotation angle of the page in degrees. Values of 0, 90, 180, and 270 are allowed.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
page_width property (PDFVerifier Struct)
Specifies the width of the page.
Syntax
fn page_width(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the width of the page.
Returns the width of the page.
The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.
This property is read-only.
Data Type
i32
password property (PDFVerifier Struct)
The decryption password.
Syntax
fn password(&self ) -> Result<String, SecureBlackboxError>
fn set_password(&self, value : &str) -> Option<SecureBlackboxError> fn set_password_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to provide the decryption password.
Data Type
String
profile property (PDFVerifier Struct)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
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 (PDFVerifier Struct)
The IP address of the proxy server.
Syntax
fn proxy_address(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_address(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_address_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The IP address of the proxy server.
Data Type
String
proxy_authentication property (PDFVerifier Struct)
The authentication type used by the proxy server.
Syntax
fn proxy_authentication(&self ) -> Result<i32, SecureBlackboxError>
fn set_proxy_authentication(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // NoAuthentication
1 // Basic
2 // Digest
3 // NTLM
Default Value
0
Remarks
The authentication type used by the proxy server.
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |
Data Type
i32
proxy_password property (PDFVerifier Struct)
The password to authenticate to the proxy server.
Syntax
fn proxy_password(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_password(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_password_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The password to authenticate to the proxy server.
Data Type
String
proxy_port property (PDFVerifier Struct)
The port on the proxy server to connect to.
Syntax
fn proxy_port(&self ) -> Result<i32, SecureBlackboxError>
fn set_proxy_port(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
i32
proxy_type property (PDFVerifier Struct)
The type of the proxy server.
Syntax
fn proxy_type(&self ) -> Result<i32, SecureBlackboxError>
fn set_proxy_type(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // None
1 // Socks4
2 // Socks5
3 // WebTunnel
4 // HTTP
Default Value
0
Remarks
The type of the proxy server.
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |
Data Type
i32
proxy_request_headers property (PDFVerifier Struct)
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
fn proxy_request_headers(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_request_headers(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_request_headers_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
Data Type
String
proxy_response_body property (PDFVerifier Struct)
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
fn proxy_response_body(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_response_body(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_response_body_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Data Type
String
proxy_response_headers property (PDFVerifier Struct)
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
fn proxy_response_headers(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_response_headers(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_response_headers_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Data Type
String
proxy_use_ipv6 property (PDFVerifier Struct)
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
fn proxy_use_ipv6(&self ) -> Result<bool, SecureBlackboxError>
fn set_proxy_use_ipv6(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
Data Type
bool
proxy_username property (PDFVerifier Struct)
Specifies the username credential for proxy authentication.
Syntax
fn proxy_username(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_username(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_username_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
revocation_check property (PDFVerifier Struct)
Specifies the kind(s) of revocation check to perform for all chain certificates.
Syntax
fn revocation_check(&self ) -> Result<i32, SecureBlackboxError>
fn set_revocation_check(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // None
1 // Auto
2 // AllCRL
3 // AllOCSP
4 // AllCRLAndOCSP
5 // AnyCRL
6 // AnyOCSP
7 // AnyCRLOrOCSP
8 // AnyOCSPOrCRL
Default Value
1
Remarks
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.
| 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 (PDFVerifier Struct)
The number of records in the Signature arrays.
Syntax
fn signature_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- signature_allowed_changes
- signature_author_name
- signature_bytes
- signature_certification
- signature_chain_validation_details
- signature_chain_validation_result
- signature_claimed_signing_time
- signature_compatibility_errors
- signature_contact_info
- signature_contains_long_term_info
- signature_coverage_ends_at
- signature_custom_data
- signature_empty_field
- signature_entity_label
- signature_filter_name
- signature_full_signature_name
- signature_handle
- signature_hash_algorithm
- signature_height
- signature_issuer_rdn
- signature_level
- signature_location
- signature_name
- signature_offset_x
- signature_offset_y
- signature_page
- signature_policy_hash
- signature_policy_hash_algorithm
- signature_policy_id
- signature_policy_uri
- signature_reason
- signature_serial_number
- signature_subject_key_id
- signature_subject_rdn
- signature_timestamped
- signature_type
- signature_validated_signing_time
- signature_validation_log
- signature_validation_result
- signature_width
This property is read-only.
Data Type
i32
signature_allowed_changes property (PDFVerifier Struct)
The changes to the document allowed by the signature.
Syntax
fn signature_allowed_changes(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // None
1 // FillInForms
2 // Comment
3 // All
Default Value
0
Remarks
The changes to the document allowed by the signature.
This property is only applicable to MDP/certification signatures and has no effect for any other kinds of signatures (regular or document timestamps).
| psacNone | 0 | No changes are allowed by the signature |
| psacFillInForms | 1 | Only form fill-in is allowed |
| psacComment | 2 | Commenting is allowed |
| psacAll | 3 | Form fill-in and commenting are allowed |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_author_name property (PDFVerifier Struct)
A human-readable signer name.
Syntax
fn signature_author_name(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
A human-readable signer name. This is a PDF document property.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_certification property (PDFVerifier Struct)
Specifies whether this is a Certification (MDP) signature.
Syntax
fn signature_certification(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Specifies whether this is a Certification (MDP) signature.
Certification signatures certify the current revision of the document and define which changes, if any, may be made afterwards without invalidating that certification. Use signature_allowed_changes to specify the permitted changes.
A PDF document normally contains at most one certification signature, and it is the first signature in the document. This setting does not apply to document timestamps.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
signature_chain_validation_details property (PDFVerifier Struct)
The details of a certificate chain validation outcome.
Syntax
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 property.
This property is read-only.
Data Type
i32
signature_chain_validation_result property (PDFVerifier Struct)
The outcome of a certificate chain validation routine.
Syntax
fn signature_chain_validation_result(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // ValidButUntrusted
2 // Invalid
3 // 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 property.
This property is read-only.
Data Type
i32
signature_claimed_signing_time property (PDFVerifier Struct)
Returns or sets the signature's creation time.
Syntax
fn signature_claimed_signing_time(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Returns or sets the signature's creation time.
Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike signature_validated_signing_time, does not originate from a trusted TSA and may be forged or wrong. If this value is not set when a new signature is created, the component uses the current UTC time.
The time is provided in UTC.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_compatibility_errors property (PDFVerifier Struct)
Returns compatibility errors encountered during validation.
Syntax
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 property.
This property is read-only.
Data Type
i32
signature_contact_info property (PDFVerifier Struct)
Contains the signer's contact information.
Syntax
fn signature_contact_info(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the signer's contact information. This is a PDF document property.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_contains_long_term_info property (PDFVerifier Struct)
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
Syntax
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 property.
This property is read-only.
Data Type
bool
signature_coverage_ends_at property (PDFVerifier Struct)
Indicates the byte offset in the PDF file where signature coverage ends.
Syntax
fn signature_coverage_ends_at(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Indicates the byte offset in the PDF file where signature coverage ends.
PDF generators often use incremental updates to make changes in the documents. This may result in the signature only covering a part of the document (one of the past revisions), but not the subsequent changes.
Use this property to identify the offset where the signature coverage ends. One option is to compare it to the length of the whole document. Alternatively, use the get_signed_version method of the PDFVerifier struct to extract the exact revision that was signed.
A value of -1 indicates that the component could not determine the coverage offset.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_custom_data property (PDFVerifier Struct)
Uninterpreted custom data to save with the PDF signature.
Syntax
fn signature_custom_data(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Uninterpreted custom data to save with the PDF signature. The component stores and returns this value as-is and does not validate its contents.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
Vec
signature_empty_field property (PDFVerifier Struct)
Indicates whether the signature is created as an empty property (a signature placeholder).
Syntax
fn signature_empty_field(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Indicates whether the signature is created as an empty field (a signature placeholder).
An empty field reserves a place for a future signature but does not contain a cryptographic signature value.
NOTE: This property is only applicable for creating new empty signature fields. To read info about empty signature fields, use EmptySignatureFieldCount and other EmptySignatureFields* configuration settings.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
signature_entity_label property (PDFVerifier Struct)
Use this property to get the signature entity label.
Syntax
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 property.
This property is read-only.
Data Type
String
signature_filter_name property (PDFVerifier Struct)
Specifies the PDF security handler filter name to use when creating a new signature.
Syntax
fn signature_filter_name(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the PDF security handler filter name to use when creating a new signature.
This value determines how PDF viewers, such as Adobe Acrobat Reader, interpret and validate the digital signature. Commonly recognized values include:
- "Adobe.PPKLite" - the default value; instructs Adobe to use its built-in certificate infrastructure.
- "Adobe.PPKMS" - instructs Adobe to use the system-wide Windows certificate store for signature validation.
Custom values (e.g. "VeriSign.PPKVS" used by the VeriSign plug-in) are also supported. However, non-standard filter names may not be recognized by all PDF viewers or validators, which could lead to compatibility or validation issues.
For maximum compatibility across different PDF environments, it is recommended to use the default value "Adobe.PPKLite" unless integration with a specific custom handler is required.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_full_signature_name property (PDFVerifier Struct)
Specifies the full name of the signature property.
Syntax
fn signature_full_signature_name(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the full name of the signature field.
This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
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.
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 property.
This property is read-only.
Data Type
i64
signature_hash_algorithm property (PDFVerifier Struct)
Specifies the hash algorithm to be used for signing.
Syntax
fn signature_hash_algorithm(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used for signing.
| 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 property.
This property is read-only.
Data Type
String
signature_height property (PDFVerifier Struct)
Specifies the height of the signature widget.
Syntax
fn signature_height(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the height of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels. This integer field uses whole points. To specify fractional values, use the WidgetHeight configuration setting.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_issuer_rdn property (PDFVerifier Struct)
The Relative Distinguished Name of the signing certificate's issuer.
Syntax
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 certificate authority or entity 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 property.
This property is read-only.
Data Type
String
signature_level property (PDFVerifier Struct)
Specifies the PAdES signature level.
Syntax
fn signature_level(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // Generic
2 // BaselineB
3 // BaselineT
4 // BaselineLT
5 // BaselineLTA
6 // BES
7 // EPES
8 // LTV
Default Value
2
Remarks
Specifies the PAdES signature level.
PAdES standard defines a number of different 'levels' of signatures which can be used for different purposes.
Note that when validating a signature, the LTV modifier may be affected by the validation settings. These include OfflineMode (set it to true to obtain the clean LTV capability) and certificate caching (switch it off to stop earlier validations from affecting the current validation).
The supported levels are:
| paslUnknown | 0 | Unknown signature level |
| paslGeneric | 1 | Generic signature: Legacy Adobe signature (adbe.pkcs7.detached), corresponds to pstLegacy signature type |
| paslBaselineB | 2 | Baseline B (B-B, basic) |
| paslBaselineT | 3 | Baseline T (B-T, timestamped) |
| paslBaselineLT | 4 | Baseline LT (B-LT, long-term) |
| paslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) |
| paslBES | 6 | BES (Basic Electronic Signature) |
| paslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
| paslLTV | 8 | LTV (Electronic Signature with with revocation info) |
When creating a signature, some levels require additional settings:
- paslBaselineT requires a timestamp server.
- paslBaselineLT, paslBaselineLTA, and paslLTV require deep validation and a timestamp server.
- paslEPES requires signature_policy_id, signature_policy_hash_algorithm, and signature_policy_hash.
When evaluating the level of a PAdES signature, SecureBlackbox uses the following criteria and conditions:
- If the signing chain is found to be invalid or incomplete, the level will be reported as Baseline-B, BES, or EPES, depending on the attributes included in the signature (such as policy details).
- If the signing chain is found to be valid, the signature includes a timestamp, and the timestamp chain is valid (or the IgnoreTimestampChainValidityForLevelDetection config property is set to true), the level will be reported as Baseline-T.
- If the Baseline-T conditions above are met, and all the validation material is included in the DSS, the level will be reported as Baseline-LT.
- If the Baseline-LT conditions above are met, and the signature is protected by a later document timestamp, the level will be reported as Baseline-LTA.
- If the signing chain is found to be valid, the signature includes a timestamp, and the timestamp chain is valid (or the IgnoreTimestampChainValidityForLevelDetection config property is set to true), and all the validation material is included in the DSS or signature, and the signature does not meet the Baseline-LT and Baseline-LTA criteria, the level will be reported as LTV. In other words, the LTV level is a relaxed version of Baseline-LT, that allows the validation material to be included in the signature itself and not DSS.
Note: The LTV-enabled property reported by Adobe Reader can be misleading, as it does not represent a valid PAdES level. Instead, it is a rather indicative claim that advises that the signature does include some form of an external timestamp (a signature timestamp or a document timestamp) and some piece of validation material, and the signing chain ends up with a local trust anchor. As such, it can be a much weaker property than the Baseline-LT, Baseline-LTA, and LTV levels reported by SecureBlackbox.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_location property (PDFVerifier Struct)
Specifies the host name or the physical location of the signing entity.
Syntax
fn signature_location(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the host name or the physical location of the signing entity. This is a PDF property.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_offset_x property (PDFVerifier Struct)
Specifies the signature widget offset from the left-hand page border.
Syntax
fn signature_offset_x(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the signature widget offset from the left-hand page border.
The value is expressed in document-specific points. When a new visible signature is created, a negative value is converted to the page width plus that value. This integer field uses whole points; to specify fractional values, use the WidgetOffsetX configuration setting.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_offset_y property (PDFVerifier Struct)
Specifies the signature widget offset from the bottom page border.
Syntax
fn signature_offset_y(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the signature widget offset from the bottom page border.
The value is expressed in document-specific points. When a new visible signature is created, a negative value is converted to the page height plus that value. This integer field uses whole points; to specify fractional values, use the WidgetOffsetY configuration setting.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_page property (PDFVerifier Struct)
Indicates the index of the page on which the signature is placed.
Syntax
fn signature_page(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
-1
Remarks
Indicates the index of the page on which the signature is placed. The value "-1" indicates an invisible signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_policy_hash property (PDFVerifier Struct)
The signature policy hash value for EPES signatures.
Syntax
fn signature_policy_hash(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The signature policy hash value for EPES signatures.
This property contains the hash of the external signature policy document. It must be set, together with signature_policy_id and signature_policy_hash_algorithm, when creating a paslEPES signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_policy_hash_algorithm property (PDFVerifier Struct)
The algorithm that was used to calculate the signature policy hash.
Syntax
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.
This property must be set, together with signature_policy_id and signature_policy_hash, when creating a paslEPES signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_policy_id property (PDFVerifier Struct)
The policy ID to be included in the signature.
Syntax
fn signature_policy_id(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The policy ID to be included in the signature.
This property identifies the signature policy for EPES signatures. It must be set, together with signature_policy_hash_algorithm and signature_policy_hash, when creating a paslEPES signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_policy_uri property (PDFVerifier Struct)
The signature policy URI that was included in the signature.
Syntax
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 for EPES signatures. The URI is optional metadata; the policy ID, policy hash algorithm, and policy hash identify the policy value itself.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_reason property (PDFVerifier Struct)
Specifies the reason for signing.
Syntax
fn signature_reason(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the reason for signing. This is a PDF document property.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_serial_number property (PDFVerifier Struct)
The serial number of the signing certificate that created the signature.
Syntax
fn signature_serial_number(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
The serial number of the signing certificate that created the signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
Vec
signature_bytes property (PDFVerifier Struct)
Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures.
Syntax
fn signature_bytes(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
Vec
signature_name property (PDFVerifier Struct)
Specifies the unique signature identifier to use.
Syntax
fn signature_name(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the unique signature identifier to use.
This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_type property (PDFVerifier Struct)
The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.
Syntax
fn signature_type(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // Legacy
2 // PAdES
3 // DocumentTimestamp
Default Value
2
Remarks
The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.
The default value for new signatures is pstPAdES. PAdES signatures use signature_level to select the PAdES profile. Document timestamp signatures require a timestamp server and do not contain signer certificate information.
The supported values are:
| pstUnknown | 0 | Unknown signature type |
| pstLegacy | 1 | Legacy Adobe signature (adbe.pkcs7.detached or adbe.pkcs7.sha1) |
| pstPAdES | 2 | PAdES signature (ETSI.CAdES.detached), use Level field for detailed info |
| pstDocumentTimestamp | 3 | Document timestamp (ETSI.RFC3161) |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_validation_result property (PDFVerifier Struct)
The outcome of the cryptographic signature validation.
Syntax
fn signature_validation_result(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // 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 property.
This property is read-only.
Data Type
i32
signature_subject_key_id property (PDFVerifier Struct)
Contains the subject key identifier of the signing certificate.
Syntax
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 property.
This property is read-only.
Data Type
Vec
signature_subject_rdn property (PDFVerifier Struct)
Contains the RDN of the owner of the signing certificate.
Syntax
fn signature_subject_rdn(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the RDN of the owner of the signing certificate.
RDN is a set of OID=Value pairs declared in the certificate that provide the subject owner's details.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_timestamped property (PDFVerifier Struct)
Use this property to establish whether the signature contains an embedded timestamp.
Syntax
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 property.
This property is read-only.
Data Type
bool
signature_validated_signing_time property (PDFVerifier Struct)
Contains the certified signing time.
Syntax
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 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 property.
This property is read-only.
Data Type
String
signature_validation_log property (PDFVerifier Struct)
Contains the signing certificate's chain validation log.
Syntax
fn signature_validation_log(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_width property (PDFVerifier Struct)
Specifies the width of the signature widget.
Syntax
fn signature_width(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Specifies the width of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels. This integer field uses whole points. To specify fractional values, use the WidgetWidth configuration setting.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
socket_dns_mode property (PDFVerifier Struct)
Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system.
Syntax
fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_dns_mode(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Auto
1 // Platform
2 // Own
3 // OwnSecure
Default Value
0
Remarks
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |
Data Type
i32
socket_dns_port property (PDFVerifier Struct)
Specifies the port number to be used for sending queries to the DNS server.
Syntax
fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_dns_port(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
Data Type
i32
socket_dns_query_timeout property (PDFVerifier Struct)
The timeout (in milliseconds) for each DNS query.
Syntax
fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_dns_query_timeout(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
Data Type
i32
socket_dns_servers property (PDFVerifier Struct)
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError>
fn set_socket_dns_servers(&self, value : &str) -> Option<SecureBlackboxError> fn set_socket_dns_servers_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Data Type
String
socket_dns_total_timeout property (PDFVerifier Struct)
The timeout (in milliseconds) for the whole resolution process.
Syntax
fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_dns_total_timeout(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
Data Type
i32
socket_incoming_speed_limit property (PDFVerifier Struct)
The maximum number of bytes to read from the socket, per second.
Syntax
fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_incoming_speed_limit(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
i32
socket_local_address property (PDFVerifier Struct)
The local network interface to bind the socket to.
Syntax
fn socket_local_address(&self ) -> Result<String, SecureBlackboxError>
fn set_socket_local_address(&self, value : &str) -> Option<SecureBlackboxError> fn set_socket_local_address_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
socket_local_port property (PDFVerifier Struct)
The local port number to bind the socket to.
Syntax
fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_local_port(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
i32
socket_outgoing_speed_limit property (PDFVerifier Struct)
The maximum number of bytes to write to the socket, per second.
Syntax
fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_outgoing_speed_limit(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
i32
socket_timeout property (PDFVerifier Struct)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_timeout(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
i32
socket_use_ipv6 property (PDFVerifier Struct)
Enables or disables IP protocol version 6.
Syntax
fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError>
fn set_socket_use_ipv6(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
bool
timestamp_count property (PDFVerifier Struct)
The number of records in the Timestamp arrays.
Syntax
fn timestamp_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- timestamp_accuracy
- timestamp_bytes
- timestamp_certificate_index
- timestamp_chain_validation_details
- timestamp_chain_validation_result
- timestamp_contains_long_term_info
- timestamp_entity_label
- timestamp_hash_algorithm
- timestamp_parent_entity
- timestamp_serial_number
- timestamp_time
- timestamp_tsa_name
- timestamp_type
- timestamp_validation_log
- timestamp_validation_result
This property is read-only.
Data Type
i32
timestamp_accuracy property (PDFVerifier Struct)
This property indicates the accuracy of the included time mark, in microseconds.
Syntax
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 property.
This property is read-only.
Data Type
i64
timestamp_bytes property (PDFVerifier Struct)
Returns the raw timestamp data in DER format.
Syntax
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 property.
This property is read-only.
Data Type
Vec
timestamp_certificate_index property (PDFVerifier Struct)
Returns the index of the TSA certificate in the Certificates collection.
Syntax
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 property.
This property is read-only.
Data Type
i32
timestamp_chain_validation_details property (PDFVerifier Struct)
The details of a certificate chain validation outcome.
Syntax
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 property.
This property is read-only.
Data Type
i32
timestamp_chain_validation_result property (PDFVerifier Struct)
The outcome of a certificate chain validation routine.
Syntax
fn timestamp_chain_validation_result(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // ValidButUntrusted
2 // Invalid
3 // 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 property.
This property is read-only.
Data Type
i32
timestamp_contains_long_term_info property (PDFVerifier Struct)
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
Syntax
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 property.
This property is read-only.
Data Type
bool
timestamp_entity_label property (PDFVerifier Struct)
Use this property to get the timestamp entity label.
Syntax
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 property.
This property is read-only.
Data Type
String
timestamp_hash_algorithm property (PDFVerifier Struct)
Returns the timestamp's hash algorithm.
Syntax
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 property.
This property is read-only.
Data Type
String
timestamp_parent_entity property (PDFVerifier Struct)
Use this property to get the label of the timestamp's parent entity.
Syntax
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 property.
This property is read-only.
Data Type
String
timestamp_serial_number property (PDFVerifier Struct)
Returns the timestamp's serial number.
Syntax
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 property.
This property is read-only.
Data Type
Vec
timestamp_time property (PDFVerifier Struct)
The time point incorporated into the timestamp.
Syntax
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 property.
This property is read-only.
Data Type
String
timestamp_type property (PDFVerifier Struct)
Returns the type of the timestamp.
Syntax
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 property.
This property is read-only.
Data Type
i32
timestamp_tsa_name property (PDFVerifier Struct)
This value uniquely identifies the Timestamp Authority (TSA).
Syntax
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 property.
This property is read-only.
Data Type
String
timestamp_validation_log property (PDFVerifier Struct)
Contains the TSA certificate chain validation log.
Syntax
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 property.
This property is read-only.
Data Type
String
timestamp_validation_result property (PDFVerifier Struct)
Contains the timestamp validation outcome.
Syntax
fn timestamp_validation_result(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // 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 property.
This property is read-only.
Data Type
i32
tls_client_cert_count property (PDFVerifier Struct)
The number of records in the TLSClientCert arrays.
Syntax
fn tls_client_cert_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_client_cert_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at tls_client_cert_count - 1.Data Type
i32
tls_client_cert_bytes property (PDFVerifier Struct)
Returns the raw certificate data in DER format.
Syntax
fn tls_client_cert_bytes(&self , TLSClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
This property is read-only.
Data Type
Vec
tls_client_cert_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn tls_client_cert_handle(&self , TLSClientCertIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_tls_client_cert_handle(&self, TLSClientCertIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
Data Type
i64
tls_server_cert_count property (PDFVerifier Struct)
The number of records in the TLSServerCert arrays.
Syntax
fn tls_server_cert_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- tls_server_cert_bytes
- tls_server_cert_fingerprint
- tls_server_cert_handle
- tls_server_cert_issuer
- tls_server_cert_issuer_rdn
- tls_server_cert_key_algorithm
- tls_server_cert_key_bits
- tls_server_cert_key_usage
- tls_server_cert_self_signed
- tls_server_cert_serial_number
- tls_server_cert_sig_algorithm
- tls_server_cert_subject
- tls_server_cert_subject_rdn
- tls_server_cert_valid_from
- tls_server_cert_valid_to
This property is read-only.
Data Type
i32
tls_server_cert_bytes property (PDFVerifier Struct)
Returns the raw certificate data in DER format.
Syntax
fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
Vec
tls_server_cert_fingerprint property (PDFVerifier Struct)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
fn tls_server_cert_fingerprint(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result<i64, SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
i64
tls_server_cert_issuer property (PDFVerifier Struct)
The common name of the certificate issuer (CA), typically a company name.
Syntax
fn tls_server_cert_issuer(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via tls_issuer_rdn.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_issuer_rdn property (PDFVerifier Struct)
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
fn tls_server_cert_issuer_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_key_algorithm property (PDFVerifier Struct)
Specifies the public key algorithm of this certificate.
Syntax
fn tls_server_cert_key_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| 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, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_key_bits property (PDFVerifier Struct)
Returns the length of the public key in bits.
Syntax
fn tls_server_cert_key_bits(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the tls_public_key_bytes or tls_private_key_bytes property would typically contain auxiliary values, and therefore be longer.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
i32
tls_server_cert_key_usage property (PDFVerifier Struct)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
fn tls_server_cert_key_usage(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| 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 property.
This property is read-only.
Data Type
i32
tls_server_cert_self_signed property (PDFVerifier Struct)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
fn tls_server_cert_self_signed(&self , TLSServerCertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
bool
tls_server_cert_serial_number property (PDFVerifier Struct)
Returns the certificate's serial number.
Syntax
fn tls_server_cert_serial_number(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
Vec
tls_server_cert_sig_algorithm property (PDFVerifier Struct)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
fn tls_server_cert_sig_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_subject property (PDFVerifier Struct)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
fn tls_server_cert_subject(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via tls_subject_rdn.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_subject_rdn property (PDFVerifier Struct)
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
fn tls_server_cert_subject_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_valid_from property (PDFVerifier Struct)
The time point at which the certificate becomes valid, in UTC.
Syntax
fn tls_server_cert_valid_from(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_valid_to property (PDFVerifier Struct)
The time point at which the certificate expires, in UTC.
Syntax
fn tls_server_cert_valid_to(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_auto_validate_certificates property (PDFVerifier Struct)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError>
fn set_tls_auto_validate_certificates(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
bool
tls_base_configuration property (PDFVerifier Struct)
Selects the base configuration for the TLS settings.
Syntax
fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_base_configuration(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Default
1 // Compatible
2 // ComprehensiveInsecure
3 // HighlySecure
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
| stpcDefault | 0 | |
| stpcCompatible | 1 | |
| stpcComprehensiveInsecure | 2 | |
| stpcHighlySecure | 3 |
Data Type
i32
tls_ciphersuites property (PDFVerifier Struct)
A list of ciphersuites separated with commas or semicolons.
Syntax
fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_ciphersuites(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_ciphersuites_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by tls_base_configuration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
String
tls_client_auth property (PDFVerifier Struct)
Enables or disables certificate-based client authentication.
Syntax
fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_client_auth(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // NoAuth
1 // RequestCert
2 // RequireCert
Default Value
0
Remarks
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
| ccatNoAuth | 0 | |
| ccatRequestCert | 1 | |
| ccatRequireCert | 2 |
Data Type
i32
tls_extensions property (PDFVerifier Struct)
Provides access to TLS extensions.
Syntax
fn tls_extensions(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_extensions(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_extensions_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
tls_force_resume_if_destination_changes property (PDFVerifier Struct)
Whether to force TLS session resumption when the destination address changes.
Syntax
fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError>
fn set_tls_force_resume_if_destination_changes(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
bool
tls_groups property (PDFVerifier Struct)
Specifies a list of key exchange groups to attempt during the TLS key exchange.
Syntax
fn tls_groups(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_groups(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_groups_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Specifies a list of key exchange groups to attempt during the TLS key exchange.
Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:
// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled
client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048";
// Only enable the hybrid X25519/ML-KEM768 group
client.TLSSettings.Groups = "-all;+x25519mlkem768";
The list of groups supported by the component is provided below. All the names are case-insensitive:
Elliptic curve-based groups:
- SECT163K1
- SECT163R1
- SECT163R2
- SECT193R1
- SECT193R2
- SECT233K1
- SECT233R1
- SECT239K1
- SECT283K1
- SECT283R1
- SECT409K1
- SECT409R1
- SECT571K1
- SECT571R1
- SECP160K1
- SECP160R1
- SECP160R2
- SECP192K1
- SECP192R1
- SECP224K1
- SECP224R1
- SECP256K1
- SECP256R1
- SECP384R1
- SECP521R1
- BRAINPOOLP256R1
- BRAINPOOLP384R1
- BRAINPOOLP512R1
- X25519
- X448
Finite field-based groups:
- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192
Post-Quantum and Hybrid groups:
- MLKEM512
- MLKEM768
- MLKEM1024
- SECP256R1MLKEM768
- X25519MLKEM768
- SECP384R1MLKEM1024
Note: this property was called ECCurves in SecureBlackbox 2024 and older.
Data Type
String
tls_pre_shared_identity property (PDFVerifier Struct)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_pre_shared_identity(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_pre_shared_identity_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Data Type
String
tls_pre_shared_key property (PDFVerifier Struct)
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_pre_shared_key(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_pre_shared_key_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Data Type
String
tls_pre_shared_key_ciphersuite property (PDFVerifier Struct)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
tls_renegotiation_attack_prevention_mode property (PDFVerifier Struct)
Selects the renegotiation attack prevention mechanism.
Syntax
fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Compatible
1 // Strict
2 // Auto
Default Value
2
Remarks
Selects the renegotiation attack prevention mechanism.
The following options are available:
| 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 (PDFVerifier Struct)
Specifies the kind(s) of revocation check to perform.
Syntax
fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_revocation_check(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // None
1 // Auto
2 // AllCRL
3 // AllOCSP
4 // AllCRLAndOCSP
5 // AnyCRL
6 // AnyOCSP
7 // AnyCRLOrOCSP
8 // AnyOCSPOrCRL
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
| 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 (PDFVerifier Struct)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_ssl_options(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
| 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 (PDFVerifier Struct)
Specifies the TLS mode to use.
Syntax
fn tls_mode(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_mode(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Default
1 // NoTLS
2 // ExplicitTLS
3 // ImplicitTLS
4 // MixedTLS
Default Value
0
Remarks
Specifies the TLS mode to use.
| 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 (PDFVerifier Struct)
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError>
fn set_tls_use_extended_master_secret(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
true
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Data Type
bool
tls_use_session_resumption property (PDFVerifier Struct)
Enables or disables the TLS session resumption capability.
Syntax
fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError>
fn set_tls_use_session_resumption(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Enables or disables the TLS session resumption capability.
Data Type
bool
tls_versions property (PDFVerifier Struct)
The SSL/TLS versions to enable by default.
Syntax
fn tls_versions(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_versions(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
48
Remarks
The SSL/TLS versions to enable by default.
| 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 (PDFVerifier Struct)
The number of records in the TrustedCert arrays.
Syntax
fn trusted_cert_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_trusted_cert_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at trusted_cert_count - 1.Data Type
i32
trusted_cert_bytes property (PDFVerifier Struct)
Returns the raw certificate data in DER format.
Syntax
fn trusted_cert_bytes(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is read-only.
Data Type
Vec
trusted_cert_handle property (PDFVerifier Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn trusted_cert_handle(&self , TrustedCertIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_trusted_cert_handle(&self, TrustedCertIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
Data Type
i64
validation_moment property (PDFVerifier Struct)
The time point at which signature validity is to be established.
Syntax
fn validation_moment(&self ) -> Result<String, SecureBlackboxError>
fn set_validation_moment(&self, value : &str) -> Option<SecureBlackboxError> fn set_validation_moment_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to specify the moment in time at which 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 (PDFVerifier Struct)
Closes an opened document.
Syntax
fn close(&self, save_changes : bool) -> Result<(), SecureBlackboxError>
Remarks
Use this method to close a previously opened document. The SaveChanges parameter is only taken into account if the document was opened in edit mode.
config method (PDFVerifier Struct)
Sets or retrieves a configuration setting.
Syntax
fn config(&self, configuration_string : &str) -> Result<String, SecureBlackboxError>
Remarks
config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
do_action method (PDFVerifier Struct)
Performs an additional action.
Syntax
fn do_action(&self, action_id : &str, action_params : &str) -> Result<String, SecureBlackboxError>
Remarks
do_action is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Common ActionIDs:
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
get_attached_bytes method (PDFVerifier Struct)
Saves a PDF attachment to a byte array.
Syntax
fn get_attached_bytes(&self, index : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Use this method to retrieve the contents of an attached file as a byte array.
get_attached_file method (PDFVerifier Struct)
Saves a PDF attachment to a file.
Syntax
fn get_attached_file(&self, index : i32, path : &str) -> Result<(), SecureBlackboxError>
Remarks
Use this method to retrieve the contents of an attached file and save it to a file.
get_signed_version method (PDFVerifier Struct)
Returns the part of the document that is covered by the signature.
Syntax
fn get_signed_version(&self, sig_label : &str) -> Result<(), SecureBlackboxError>
Remarks
Use this method to retrieve the revision of the document that is covered by the SigLabel signature.
PDF documents often use the incremental updates approach, with any changes being appended to the document without altering the existing revision. This may lead to situations where a signature only covers a part of the document (one of the past revisions), but not the subsequent changes. This method provides means to extract the revision that is actually certified by the signature.
It is recommended that you use this method when validating signatures to make sure the signature covers what you expect it to cover.
An alternative to this method is to check the field of the signature object and match it to the document length.
open method (PDFVerifier Struct)
Opens a document for verifying or removing signatures.
Syntax
fn open(&self, edit_mode : bool) -> Result<(), SecureBlackboxError>
Remarks
Use this method to open a document for verifying or removing signatures, or for extracting signed content. When finished, call close to complete the operation and release any allocated resources.
Set EditMode to true to open the document in edit mode (only useful if you intend to remove signatures).
reset method (PDFVerifier Struct)
Resets the struct settings.
Syntax
fn reset(&self) -> Result<(), SecureBlackboxError>
Remarks
reset is a generic method available in every struct.
revalidate method (PDFVerifier Struct)
Revalidates a signature in accordance with current settings.
Syntax
fn revalidate(&self, sig_label : &str) -> Result<(), SecureBlackboxError>
Remarks
Use this method to revalidate a signature in the opened PDF document.
select_info method (PDFVerifier Struct)
Select signature information for a specific entity.
Syntax
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 (PDFVerifier Struct)
Deletes a signature from the document.
Syntax
fn unsign(&self, sig_label : &str, unsign_kind : i32) -> Result<(), SecureBlackboxError>
Remarks
Use this method to delete an existing signature from the document. Use the SigLabel parameter to specify the signature to be removed.
Unsigning is different from get_signed_version. The latter returns the revision of the document including the mentioned signature (thus removing anything added after that signature was created). unsign removes the signature completely by carving it out of the document.
For multi-signature documents, the unsign method removes the signature by marking its objects as removed in a new incremental update. A deleted signature might be present in the signature panel in Adobe as the deleted signature. If, for example, in the multi-signature document the last signature should be removed without any trace of the last signature, then get_signed_version method should be used.
The following unsign kinds are currently supported:
| uskDefault (0) | The default option. |
| uskFull (1) | Remove the signature fully. This is also the default option. |
| uskKeepField (2) | Only remove the signature, but keep the form field it is in. |
| uskKeepAppearance (3) | Remove the signature, but keep the form field and its widget. |
Note: SigLabel set to "" removes all signatures in the document.
verify method (PDFVerifier Struct)
Verifies a signed PDF document.
Syntax
fn verify(&self) -> Result<(), SecureBlackboxError>
Remarks
Use this method to validate all signatures in a PDF document.
This method walks through a signed document and reports every signature via the on_signature_found event. Subscribe to the event to be notified about the signatures and adjust validation settings on the fly.
Upon completion of this method, the signature details will be published in the signatures property.
This method only validates the signatures, but does not check their coverage. It is a good idea to use mechanisms such as get_signed_version or to ensure that the signature covers the expected document revision.
on_chain_element_download event (PDFVerifier Struct)
Fires when there is a need to download a chain element from an online source.
Syntax
// PDFVerifierChainElementDownloadEventArgs carries the PDFVerifier ChainElementDownload event's parameters.
pub struct PDFVerifierChainElementDownloadEventArgs {
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)
}
// PDFVerifierChainElementDownloadEvent defines the signature of the PDFVerifier ChainElementDownload event's handler function.
pub trait PDFVerifierChainElementDownloadEvent {
fn on_chain_element_download(&self, sender : PDFVerifier, e : &mut PDFVerifierChainElementDownloadEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_chain_element_download(&self) -> &'a dyn PDFVerifierChainElementDownloadEvent;
pub fn set_on_chain_element_download(&mut self, value : &'a dyn PDFVerifierChainElementDownloadEvent);
...
}
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 (PDFVerifier Struct)
Fires when an element required to validate the chain was not located.
Syntax
// PDFVerifierChainElementNeededEventArgs carries the PDFVerifier ChainElementNeeded event's parameters.
pub struct PDFVerifierChainElementNeededEventArgs {
fn kind(&self) -> i32
fn cert_rdn(&self) -> &String
fn ca_cert_rdn(&self) -> &String
}
// PDFVerifierChainElementNeededEvent defines the signature of the PDFVerifier ChainElementNeeded event's handler function.
pub trait PDFVerifierChainElementNeededEvent {
fn on_chain_element_needed(&self, sender : PDFVerifier, e : &mut PDFVerifierChainElementNeededEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_chain_element_needed(&self) -> &'a dyn PDFVerifierChainElementNeededEvent;
pub fn set_on_chain_element_needed(&mut self, value : &'a dyn PDFVerifierChainElementNeededEvent);
...
}
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_validated event (PDFVerifier Struct)
Reports the completion of a certificate chain validation.
Syntax
// PDFVerifierChainValidatedEventArgs carries the PDFVerifier ChainValidated event's parameters.
pub struct PDFVerifierChainValidatedEventArgs {
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)
}
// PDFVerifierChainValidatedEvent defines the signature of the PDFVerifier ChainValidated event's handler function.
pub trait PDFVerifierChainValidatedEvent {
fn on_chain_validated(&self, sender : PDFVerifier, e : &mut PDFVerifierChainValidatedEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_chain_validated(&self) -> &'a dyn PDFVerifierChainValidatedEvent;
pub fn set_on_chain_validated(&mut self, value : &'a dyn PDFVerifierChainValidatedEvent);
...
}
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) |
| 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 (PDFVerifier Struct)
This event is fired multiple times during chain validation to report various stages of the validation procedure.
Syntax
// PDFVerifierChainValidationProgressEventArgs carries the PDFVerifier ChainValidationProgress event's parameters.
pub struct PDFVerifierChainValidationProgressEventArgs {
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)
}
// PDFVerifierChainValidationProgressEvent defines the signature of the PDFVerifier ChainValidationProgress event's handler function.
pub trait PDFVerifierChainValidationProgressEvent {
fn on_chain_validation_progress(&self, sender : PDFVerifier, e : &mut PDFVerifierChainValidationProgressEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_chain_validation_progress(&self) -> &'a dyn PDFVerifierChainValidationProgressEvent;
pub fn set_on_chain_validation_progress(&mut self, value : &'a dyn PDFVerifierChainValidationProgressEvent);
...
}
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_document_loaded event (PDFVerifier Struct)
This event is fired when the document has been loaded into memory.
Syntax
// PDFVerifierDocumentLoadedEventArgs carries the PDFVerifier DocumentLoaded event's parameters.
pub struct PDFVerifierDocumentLoadedEventArgs {
fn cancel(&self) -> bool
fn set_cancel(&self, value : bool)
}
// PDFVerifierDocumentLoadedEvent defines the signature of the PDFVerifier DocumentLoaded event's handler function.
pub trait PDFVerifierDocumentLoadedEvent {
fn on_document_loaded(&self, sender : PDFVerifier, e : &mut PDFVerifierDocumentLoadedEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_document_loaded(&self) -> &'a dyn PDFVerifierDocumentLoadedEvent;
pub fn set_on_document_loaded(&mut self, value : &'a dyn PDFVerifierDocumentLoadedEvent);
...
}
Remarks
The handler for this event is a good place to check the document structure, which may be useful when preparing the signature. For example, you can use the pages information to find the optimal position for the signature widget.
Set Cancel to true to terminate document processing on this stage.
on_encrypted event (PDFVerifier Struct)
Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document.
Syntax
// PDFVerifierEncryptedEventArgs carries the PDFVerifier Encrypted event's parameters.
pub struct PDFVerifierEncryptedEventArgs {
fn cert_used(&self) -> bool
fn issuer_rdn(&self) -> &String
fn serial_number(&self) -> &[u8]
fn subject_key_id(&self) -> &[u8]
fn need_credential(&self) -> bool
fn skip_this(&self) -> bool
fn set_skip_this(&self, value : bool)
}
// PDFVerifierEncryptedEvent defines the signature of the PDFVerifier Encrypted event's handler function.
pub trait PDFVerifierEncryptedEvent {
fn on_encrypted(&self, sender : PDFVerifier, e : &mut PDFVerifierEncryptedEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_encrypted(&self) -> &'a dyn PDFVerifierEncryptedEvent;
pub fn set_on_encrypted(&mut self, value : &'a dyn PDFVerifierEncryptedEvent);
...
}
Remarks
The struct fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.
This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the decryption_certificate or password property (depending on the encryption method used), or sets SkipThis to true.
The CertUsed parameter specifies the encryption method used. If set to true, it indicates that the document uses asymmetric (certificate-based) encryption. In that case, the IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own on_encrypted event loop.
CertUsed set to false indicates that the document uses password encryption. In this case, provide the password via the password property.
The NeedCredential parameter specifies whether the correct credential is already available to the struct or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the password property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.
on_error event (PDFVerifier Struct)
Information about errors during signing/validation.
Syntax
// PDFVerifierErrorEventArgs carries the PDFVerifier Error event's parameters.
pub struct PDFVerifierErrorEventArgs {
fn error_code(&self) -> i32
fn description(&self) -> &String
}
// PDFVerifierErrorEvent defines the signature of the PDFVerifier Error event's handler function.
pub trait PDFVerifierErrorEvent {
fn on_error(&self, sender : PDFVerifier, e : &mut PDFVerifierErrorEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_error(&self) -> &'a dyn PDFVerifierErrorEvent;
pub fn set_on_error(&mut self, value : &'a dyn PDFVerifierErrorEvent);
...
}
Remarks
The event is fired in case of exceptional conditions during PDF processing.
ErrorCode contains an error code and Description contains a textual description of the error.
on_notification event (PDFVerifier Struct)
This event notifies the application about an underlying control flow event.
Syntax
// PDFVerifierNotificationEventArgs carries the PDFVerifier Notification event's parameters.
pub struct PDFVerifierNotificationEventArgs {
fn event_id(&self) -> &String
fn event_param(&self) -> &String
}
// PDFVerifierNotificationEvent defines the signature of the PDFVerifier Notification event's handler function.
pub trait PDFVerifierNotificationEvent {
fn on_notification(&self, sender : PDFVerifier, e : &mut PDFVerifierNotificationEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_notification(&self) -> &'a dyn PDFVerifierNotificationEvent;
pub fn set_on_notification(&mut self, value : &'a dyn PDFVerifierNotificationEvent);
...
}
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:
| DocumentLoaded | Notifies the application that the document has been loaded. This is a backward-compatibility-only notification. Use OnDocumentLoaded event instead. |
| 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_signature_found event (PDFVerifier Struct)
Signifies the start of signature validation.
Syntax
// PDFVerifierSignatureFoundEventArgs carries the PDFVerifier SignatureFound event's parameters.
pub struct PDFVerifierSignatureFoundEventArgs {
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)
}
// PDFVerifierSignatureFoundEvent defines the signature of the PDFVerifier SignatureFound event's handler function.
pub trait PDFVerifierSignatureFoundEvent {
fn on_signature_found(&self, sender : PDFVerifier, e : &mut PDFVerifierSignatureFoundEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_signature_found(&self) -> &'a dyn PDFVerifierSignatureFoundEvent;
pub fn set_on_signature_found(&mut self, value : &'a dyn PDFVerifierSignatureFoundEvent);
...
}
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 (PDFVerifier Struct)
Marks the completion of the signature validation routine.
Syntax
// PDFVerifierSignatureValidatedEventArgs carries the PDFVerifier SignatureValidated event's parameters.
pub struct PDFVerifierSignatureValidatedEventArgs {
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)
}
// PDFVerifierSignatureValidatedEvent defines the signature of the PDFVerifier SignatureValidated event's handler function.
pub trait PDFVerifierSignatureValidatedEvent {
fn on_signature_validated(&self, sender : PDFVerifier, e : &mut PDFVerifierSignatureValidatedEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_signature_validated(&self) -> &'a dyn PDFVerifierSignatureValidatedEvent;
pub fn set_on_signature_validated(&mut self, value : &'a dyn PDFVerifierSignatureValidatedEvent);
...
}
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 (PDFVerifier Struct)
Signifies the start of a timestamp validation routine.
Syntax
// PDFVerifierTimestampFoundEventArgs carries the PDFVerifier TimestampFound event's parameters.
pub struct PDFVerifierTimestampFoundEventArgs {
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)
}
// PDFVerifierTimestampFoundEvent defines the signature of the PDFVerifier TimestampFound event's handler function.
pub trait PDFVerifierTimestampFoundEvent {
fn on_timestamp_found(&self, sender : PDFVerifier, e : &mut PDFVerifierTimestampFoundEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_timestamp_found(&self) -> &'a dyn PDFVerifierTimestampFoundEvent;
pub fn set_on_timestamp_found(&mut self, value : &'a dyn PDFVerifierTimestampFoundEvent);
...
}
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 (PDFVerifier Struct)
Reports the completion of the timestamp validation routine.
Syntax
// PDFVerifierTimestampValidatedEventArgs carries the PDFVerifier TimestampValidated event's parameters.
pub struct PDFVerifierTimestampValidatedEventArgs {
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)
}
// PDFVerifierTimestampValidatedEvent defines the signature of the PDFVerifier TimestampValidated event's handler function.
pub trait PDFVerifierTimestampValidatedEvent {
fn on_timestamp_validated(&self, sender : PDFVerifier, e : &mut PDFVerifierTimestampValidatedEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_timestamp_validated(&self) -> &'a dyn PDFVerifierTimestampValidatedEvent;
pub fn set_on_timestamp_validated(&mut self, value : &'a dyn PDFVerifierTimestampValidatedEvent);
...
}
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 (PDFVerifier Struct)
Fires when a remote TLS party requests a client certificate.
Syntax
// PDFVerifierTLSCertNeededEventArgs carries the PDFVerifier TLSCertNeeded event's parameters.
pub struct PDFVerifierTLSCertNeededEventArgs {
fn host(&self) -> &String
fn ca_names(&self) -> &String
}
// PDFVerifierTLSCertNeededEvent defines the signature of the PDFVerifier TLSCertNeeded event's handler function.
pub trait PDFVerifierTLSCertNeededEvent {
fn on_tls_cert_needed(&self, sender : PDFVerifier, e : &mut PDFVerifierTLSCertNeededEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_tls_cert_needed(&self) -> &'a dyn PDFVerifierTLSCertNeededEvent;
pub fn set_on_tls_cert_needed(&mut self, value : &'a dyn PDFVerifierTLSCertNeededEvent);
...
}
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the tls_client_chain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the on_tls_handshake event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.
on_tls_cert_validate event (PDFVerifier Struct)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
// PDFVerifierTLSCertValidateEventArgs carries the PDFVerifier TLSCertValidate event's parameters.
pub struct PDFVerifierTLSCertValidateEventArgs {
fn server_host(&self) -> &String
fn server_ip(&self) -> &String
fn accept(&self) -> bool
fn set_accept(&self, value : bool)
}
// PDFVerifierTLSCertValidateEvent defines the signature of the PDFVerifier TLSCertValidate event's handler function.
pub trait PDFVerifierTLSCertValidateEvent {
fn on_tls_cert_validate(&self, sender : PDFVerifier, e : &mut PDFVerifierTLSCertValidateEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_tls_cert_validate(&self) -> &'a dyn PDFVerifierTLSCertValidateEvent;
pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn PDFVerifierTLSCertValidateEvent);
...
}
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 (PDFVerifier Struct)
Fires when a TLS handshake with Host successfully completes.
Syntax
// PDFVerifierTLSEstablishedEventArgs carries the PDFVerifier TLSEstablished event's parameters.
pub struct PDFVerifierTLSEstablishedEventArgs {
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)
}
// PDFVerifierTLSEstablishedEvent defines the signature of the PDFVerifier TLSEstablished event's handler function.
pub trait PDFVerifierTLSEstablishedEvent {
fn on_tls_established(&self, sender : PDFVerifier, e : &mut PDFVerifierTLSEstablishedEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_tls_established(&self) -> &'a dyn PDFVerifierTLSEstablishedEvent;
pub fn set_on_tls_established(&mut self, value : &'a dyn PDFVerifierTLSEstablishedEvent);
...
}
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 (PDFVerifier Struct)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
// PDFVerifierTLSHandshakeEventArgs carries the PDFVerifier TLSHandshake event's parameters.
pub struct PDFVerifierTLSHandshakeEventArgs {
fn host(&self) -> &String
fn abort(&self) -> bool
fn set_abort(&self, value : bool)
}
// PDFVerifierTLSHandshakeEvent defines the signature of the PDFVerifier TLSHandshake event's handler function.
pub trait PDFVerifierTLSHandshakeEvent {
fn on_tls_handshake(&self, sender : PDFVerifier, e : &mut PDFVerifierTLSHandshakeEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_tls_handshake(&self) -> &'a dyn PDFVerifierTLSHandshakeEvent;
pub fn set_on_tls_handshake(&mut self, value : &'a dyn PDFVerifierTLSHandshakeEvent);
...
}
Remarks
The struct uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the on_tls_established event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.
on_tls_shutdown event (PDFVerifier Struct)
Reports the graceful closure of a TLS connection.
Syntax
// PDFVerifierTLSShutdownEventArgs carries the PDFVerifier TLSShutdown event's parameters.
pub struct PDFVerifierTLSShutdownEventArgs {
fn host(&self) -> &String
}
// PDFVerifierTLSShutdownEvent defines the signature of the PDFVerifier TLSShutdown event's handler function.
pub trait PDFVerifierTLSShutdownEvent {
fn on_tls_shutdown(&self, sender : PDFVerifier, e : &mut PDFVerifierTLSShutdownEventArgs);
}
impl <'a> PDFVerifier<'a> {
pub fn on_tls_shutdown(&self) -> &'a dyn PDFVerifierTLSShutdownEvent;
pub fn set_on_tls_shutdown(&mut self, value : &'a dyn PDFVerifierTLSShutdownEvent);
...
}
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 (PDFVerifier Struct)
The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.PDFVerifier Config Settings
For advanced settings of the build properties, use the BuildProperties configuration setting.
For advanced settings of the build properties, use the BuildProperties configuration setting.
Sample value:
{
"App":{
"Name":"TestApp",
"REx":"8.0.0"
}
}
The above value sets the application name and version used to create the signature. The same result could be achieved using the BuildApplicationName and BuildApplicationVersion configuration settings.
Sample value 2:
{
"App":{
"Name":"TestApp",
"REx":"8.0.0",
"R":524288,
"Date":"2023-01-01 00:01",
"OS":[
"Win"
],
"TrustedMode":true
},
"Filter":{
"Name":"TestFilter",
"R":131101,
"Date":"2023-01-01 00:02",
"PreRelease":true
},
"PubSec":{
"R":13102,
"Date":"2023-01-01 00:03",
"PreRelease":true,
"NonEFontNoWarn":true
}
}
The default value is 1 day (86400 seconds). A value of 0 disables the absolute CRL age check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
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 for configuring this setting together with the related cached revocation freshness settings.
The default value is 10 minutes (600 seconds). A value of 0 disables the CRL overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
This setting is evaluated independently from CachedCRLMaxAge and CachedCRLMaxAgeRatio. If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.
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 for configuring this setting together with the related cached revocation freshness settings.
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 to limit their age. A value of 0 disables the OCSP response ratio check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
The default value is 10 minutes (600 seconds). A value of 0 disables the OCSP response overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
This setting is evaluated independently from CachedOCSPResponseMaxAge and CachedOCSPResponseMaxAgeRatio. If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.
TBD
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.
The value is set for document timestamp signatures and is 0 if the timestamp does not include accuracy information.
This is a signature property that can be accessed as "Signatures[index].DTSAccuracy", or as "DTSAccuracy" for the current signature (the signature being validated or the last signature).
The value is set for document timestamp signatures.
This is a signature property that can be accessed as "Signatures[index].DTSSerialNumber", or as "DTSSerialNumber" for the current signature (the signature being validated or the last signature).
The value is set for document timestamp signatures.
This is a signature property that can be accessed as "Signatures[index].DTSTime", or as "DTSTime" for the current signature (the signature being validated or the last signature).
The value is set for document timestamp signatures when the timestamp includes a TSA name.
This is a signature property that can be accessed as "Signatures[index].DTSTSAName", or as "DTSTSAName" for the current signature (the signature being validated or the last signature).
NOTE: The information about empty signature fields is available when the PDF document is open. Read this setting either between open and close methods, or in on_document_loaded event handler.
If 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.
TBD
This is a signature property that can be accessed as "Signatures[index].IsLTVEnabled", or as "IsLTVEnabled" for the current signature (the signature being validated or the last signature).
The following values are supported:
| "auto" | Default value. The struct automatically select the hash algorithm based on the PDF document version. For version 1.6 and higher it uses "none" value, for the other versions it uses MD5 hash algorithm. | |
| "MD5" | The struct uses MD5 hash algorithm. | |
| "SHA1" | The struct uses SHA1 hash algorithm. | |
| "SHA256" | The struct uses SHA256 hash algorithm. | |
| "SHA384" | The struct uses SHA384 hash algorithm. | |
| "SHA512" | The struct uses SHA512 hash algorithm. | |
| "RIPEMD160" | The struct uses RIPEMD160 hash algorithm. | |
| "SHA3_256" | The struct uses SHA3-256 hash algorithm. | |
| "SHA3_384" | The struct uses SHA3-384 hash algorithm. | |
| "SHA3_512" | The struct uses SHA3-512 hash algorithm. | |
| "SHAKE_256" | The struct uses SHAKE-256 hash algorithm. | |
| "none" | The struct will not calculate a digest and will not include DigestLocation, DigestMethod, and DigestValue keys of the Signature References dictionary. |
Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'
The following values are supported:
| "auto" | Default value. The struct automatically reassembles PDF documents in case they contain errors that may invalidate new signatures. | |
| "disabled" | The struct never reassembles PDF documents. This value is not recommended. | |
| "enabled" | The struct always reassembles PDF documents. | |
| "hybrid" | The struct reassembles PDF documents in the same cases as in "auto" mode and additionally reassembles hybrid PDF documents - documents that contain cross-reference tables and cross-reference streams. |
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, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and 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, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and 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.
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.
- 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
In case of a timestamping failure, provide new TSA and HTTP settings inside the on_notification event handler ('BeforeTimestamp' and 'TimestampError' event IDs).
Note: Unlike other structs, 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.
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
This property extends the new_sig_height property to allow the height of the signature widget to be specified in fractional points.
This property extends the new_sig_offset_x property to allow the offset of the signature widget to be specified in fractional points.
This property extends the new_sig_offset_y property to allow the offset of the signature widget to be specified in fractional points.
This property extends the new_sig_width property to allow the width of the signature widget to be specified in fractional points.
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
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. |
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
| 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) |
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):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
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:
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:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
Trappable Errors (PDFVerifier Struct)
PDFVerifier Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 26214401 | The input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS) |
| 26214402 | Cannot encrypt already encrypted file (SB_ERROR_PDF_ENCRYPTED) |
| 26214403 | The file is not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED) |
| 26214405 | Invalid password (SB_ERROR_PDF_INVALID_PASSWORD) |
| 26214406 | Failed to decrypt the file (SB_ERROR_PDF_DECRYPTION_FAILED) |
| 26214407 | The document is signed (SB_ERROR_PDF_SIGNED) |
| 26214408 | The document is not signed (SB_ERROR_PDF_NOT_SIGNED) |
| 26214409 | Cannot update this type of signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE) |
| 26214410 | Unsupported feature or operation (SB_ERROR_PDF_NOT_SUPPORTED) |
| 26214411 | No timestamp server specified (SB_ERROR_PDF_NO_TIMESTAMP_SERVER) |
| 26214412 | The component is not in edit mode (SB_ERROR_PDF_READONLY) |