# PDFVerifier Class The PDFVerifier class verifies signatures over PDF documents. ## Syntax ```text class secureblackbox.PDFVerifier ``` ## Remarks Use PDFVerifier to validate electronic signatures over PDF documents. Generic and PAdES signatures are supported. ```text 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](#input_file-property) property (alternatively, you can provide it in a memory buffer via the [input_bytes](#input_bytes-property) property), and call the [verify](#verify-method) method. For every signature located in the document, PDFVerifier will fire the [on_signature_found](#on_signature_found-event) 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](#on_signature_found-event) returns, PDFVerifier proceeds to the signature validation routine in accordance with the provided settings. Upon completion of the validation, the [on_signature_validated](#on_signature_validated-event) 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](#get_signed_version-method) 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 class: - [offline_mode](#offline_mode-property) 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](#revocation_check-property) 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](#on_encrypted-event) 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. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [all_signatures_valid](#all_signatures_valid-property) | The cumulative validity of all signatures. | | [attached_file_count](#attached_file_count-property) | The number of records in the AttachedFiles arrays. | | [attached_files_content_subtype](#attached_files_content_subtype-property) | Contains the content subtype of the attachment. | | [attached_files_content_type](#attached_files_content_type-property) | Contains the content type of the attachment. | | [attached_files_creation_date](#attached_files_creation_date-property) | The creation date. | | [attached_files_data](#attached_files_data-property) | The content of the attachment. | | [attached_files_description](#attached_files_description-property) | Textual description of the attachment. | | [attached_files_file_name](#attached_files_file_name-property) | Specifies the name of the attachment file. | | [attached_files_handle](#attached_files_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [attached_files_id](#attached_files_id-property) | Contains the attachment's unique identifier. | | [attached_files_modification_date](#attached_files_modification_date-property) | Specifies the date and time of the file's last modification. | | [attached_files_read_date](#attached_files_read_date-property) | Specifies the file's last read date. | | [attached_files_size](#attached_files_size-property) | The attachment's size in bytes. | | [auto_validate_signatures](#auto_validate_signatures-property) | Specifies whether PDFVerifier should validate any present signatures when the document is opened. | | [blocked_cert_count](#blocked_cert_count-property) | The number of records in the BlockedCert arrays. | | [blocked_cert_bytes](#blocked_cert_bytes-property) | Returns the raw certificate data in DER format. | | [blocked_cert_handle](#blocked_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [cert_count](#cert_count-property) | The number of records in the Cert arrays. | | [cert_bytes](#cert_bytes-property) | Returns the raw certificate data in DER format. | | [cert_ca](#cert_ca-property) | Indicates whether the certificate has a CA capability. | | [cert_ca_key_id](#cert_ca_key_id-property) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [cert_type](#cert_type-property) | Returns the type of the entity contained in the Certificate object. | | [cert_crl_distribution_points](#cert_crl_distribution_points-property) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [cert_curve](#cert_curve-property) | Specifies the elliptic curve associated with the certificate's public key. | | [cert_fingerprint](#cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. | | [cert_friendly_name](#cert_friendly_name-property) | Contains an associated alias (friendly name) of the certificate. | | [cert_handle](#cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [cert_hash_algorithm](#cert_hash_algorithm-property) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [cert_issuer](#cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. | | [cert_issuer_rdn](#cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [cert_key_algorithm](#cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. | | [cert_key_bits](#cert_key_bits-property) | Returns the length of the public key in bits. | | [cert_key_fingerprint](#cert_key_fingerprint-property) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [cert_key_usage](#cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [cert_key_valid](#cert_key_valid-property) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [cert_ocsp_locations](#cert_ocsp_locations-property) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [cert_ocsp_no_check](#cert_ocsp_no_check-property) | Accessor to the value of the certificate's ocsp-no-check extension. | | [cert_origin](#cert_origin-property) | Returns the location that the certificate was taken or loaded from. | | [cert_policy_i_ds](#cert_policy_i_ds-property) | Contains identifiers (OIDs) of the applicable certificate policies. | | [cert_private_key_bytes](#cert_private_key_bytes-property) | Returns the certificate's private key in DER-encoded format. | | [cert_private_key_exists](#cert_private_key_exists-property) | Indicates whether the certificate has a usable private key associated with it. | | [cert_private_key_extractable](#cert_private_key_extractable-property) | Indicates whether the private key is extractable (exportable). | | [cert_public_key_bytes](#cert_public_key_bytes-property) | Contains the certificate's public key in DER format. | | [cert_qualified](#cert_qualified-property) | Indicates whether the certificate is qualified. | | [cert_qualified_statements](#cert_qualified_statements-property) | Returns a simplified qualified status of the certificate. | | [cert_qualifiers](#cert_qualifiers-property) | A list of qualifiers. | | [cert_self_signed](#cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [cert_serial_number](#cert_serial_number-property) | Returns the certificate's serial number. | | [cert_sig_algorithm](#cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. | | [cert_source](#cert_source-property) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [cert_subject](#cert_subject-property) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [cert_subject_alternative_name](#cert_subject_alternative_name-property) | Returns or sets the value of the Subject Alternative Name extension of the certificate. | | [cert_subject_key_id](#cert_subject_key_id-property) | Contains a unique identifier of the certificate's cryptographic key. | | [cert_subject_rdn](#cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [cert_valid](#cert_valid-property) | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. | | [cert_valid_from](#cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. | | [cert_valid_to](#cert_valid_to-property) | The time point at which the certificate expires, in UTC. | | [check_trusted_lists](#check_trusted_lists-property) | Specifies whether the class should attempt to validate chain trust via a known Trusted List. | | [crl_count](#crl_count-property) | The number of records in the CRL arrays. | | [crl_bytes](#crl_bytes-property) | Returns the raw CRL data in DER format. | | [crlca_key_id](#crlca_key_id-property) | A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. | | [crl_entry_count](#crl_entry_count-property) | Returns the number of certificate status entries in the CRL. | | [crl_handle](#crl_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [crl_issuer](#crl_issuer-property) | The common name of the CRL issuer (CA), typically a company name. | | [crl_issuer_rdn](#crl_issuer_rdn-property) | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. | | [crl_location](#crl_location-property) | The URL that the CRL was downloaded from. | | [crl_next_update](#crl_next_update-property) | The planned time and date of the next version of this CRL to be published. | | [crl_sig_algorithm](#crl_sig_algorithm-property) | The public key algorithm that was used by the CA to sign this CRL. | | [crl_source](#crl_source-property) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [crltbs](#crltbs-property) | The to-be-signed part of the CRL (the CRL without the signature part). | | [crl_this_update](#crl_this_update-property) | The date and time at which this version of the CRL was published. | | [decryption_certificate_bytes](#decryption_certificate_bytes-property) | Returns the raw certificate data in DER format. | | [decryption_certificate_handle](#decryption_certificate_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [document_info_encryption_algorithm](#document_info_encryption_algorithm-property) | The symmetric algorithm used to encrypt the document. | | [document_info_encryption_type](#document_info_encryption_type-property) | The document encryption type. | | [document_info_metadata_encrypted](#document_info_metadata_encrypted-property) | Indicates if the document metadata is encrypted. | | [document_info_permissions](#document_info_permissions-property) | Contains the document permissions associated with the encryption. | | [fips_mode](#fips_mode-property) | Reserved. | | [ignore_chain_validation_errors](#ignore_chain_validation_errors-property) | Makes the class tolerant to chain validation errors. | | [input_bytes](#input_bytes-property) | Use this property to pass the input to class in byte array form. | | [input_file](#input_file-property) | A path to the signed PDF file. | | [known_cert_count](#known_cert_count-property) | The number of records in the KnownCert arrays. | | [known_cert_bytes](#known_cert_bytes-property) | Returns the raw certificate data in DER format. | | [known_cert_handle](#known_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [known_crl_count](#known_crl_count-property) | The number of records in the KnownCRL arrays. | | [known_crl_bytes](#known_crl_bytes-property) | Returns the raw CRL data in DER format. | | [known_crl_handle](#known_crl_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [known_ocsp_count](#known_ocsp_count-property) | The number of records in the KnownOCSP arrays. | | [known_ocsp_bytes](#known_ocsp_bytes-property) | A buffer containing the raw OCSP response data. | | [known_ocsp_handle](#known_ocsp_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [ocsp_count](#ocsp_count-property) | The number of records in the OCSP arrays. | | [ocsp_bytes](#ocsp_bytes-property) | A buffer containing the raw OCSP response data. | | [ocsp_entry_count](#ocsp_entry_count-property) | The number of SingleResponse elements contained in this OCSP response. | | [ocsp_handle](#ocsp_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [ocsp_issuer](#ocsp_issuer-property) | Indicates the issuer of this response (a CA or its authorized representative). | | [ocsp_issuer_rdn](#ocsp_issuer_rdn-property) | Indicates the RDN of the issuer of this response (a CA or its authorized representative). | | [ocsp_location](#ocsp_location-property) | The location of the OCSP responder. | | [ocsp_produced_at](#ocsp_produced_at-property) | Specifies the time when the response was produced, in UTC. | | [ocsp_sig_algorithm](#ocsp_sig_algorithm-property) | The public key algorithm that was used by the CA to sign this OCSP response. | | [ocsp_source](#ocsp_source-property) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [offline_mode](#offline_mode-property) | Switches the class to offline mode. | | [output_bytes](#output_bytes-property) | Use this property to read the output the class object has produced. | | [output_file](#output_file-property) | The file to save the signed or updated document to. | | [page_count](#page_count-property) | The number of records in the Page arrays. | | [page_crop_llx](#page_crop_llx-property) | Specifies the lower-left X coordinate of the page crop area. | | [page_crop_lly](#page_crop_lly-property) | Specifies the lower-left Y coordinate of the page crop area. | | [page_crop_urx](#page_crop_urx-property) | Specifies the upper-right X coordinate of the page crop area. | | [page_crop_ury](#page_crop_ury-property) | Specifies the upper-right Y coordinate of the page crop area. | | [page_height](#page_height-property) | Specifies the height of the page. | | [page_media_llx](#page_media_llx-property) | Specifies the lower-left X coordinate of the page media area. | | [page_media_lly](#page_media_lly-property) | Specifies the lower-left Y coordinate of the page media area. | | [page_media_urx](#page_media_urx-property) | Specifies the upper-right X coordinate of the page media area. | | [page_media_ury](#page_media_ury-property) | Specifies the upper-right Y coordinate of the page media area. | | [page_rotate](#page_rotate-property) | Specifies the rotation angle of the page in degrees. | | [page_width](#page_width-property) | Specifies the width of the page. | | [password](#password-property) | The decryption password. | | [profile](#profile-property) | Specifies a pre-defined profile to apply when creating the signature. | | [proxy_address](#proxy_address-property) | The IP address of the proxy server. | | [proxy_authentication](#proxy_authentication-property) | The authentication type used by the proxy server. | | [proxy_password](#proxy_password-property) | The password to authenticate to the proxy server. | | [proxy_port](#proxy_port-property) | The port on the proxy server to connect to. | | [proxy_type](#proxy_type-property) | The type of the proxy server. | | [proxy_request_headers](#proxy_request_headers-property) | Contains HTTP request headers for WebTunnel and HTTP proxy. | | [proxy_response_body](#proxy_response_body-property) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. | | [proxy_response_headers](#proxy_response_headers-property) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. | | [proxy_use_ipv6](#proxy_use_ipv6-property) | Specifies whether IPv6 should be used when connecting through the proxy. | | [proxy_username](#proxy_username-property) | Specifies the username credential for proxy authentication. | | [revocation_check](#revocation_check-property) | Specifies the kind(s) of revocation check to perform for all chain certificates. | | [signature_count](#signature_count-property) | The number of records in the Signature arrays. | | [signature_allowed_changes](#signature_allowed_changes-property) | The changes to the document allowed by the signature. | | [signature_author_name](#signature_author_name-property) | A human-readable signer name. | | [signature_certification](#signature_certification-property) | Specifies whether this is a Certification (MDP) signature. | | [signature_chain_validation_details](#signature_chain_validation_details-property) | The details of a certificate chain validation outcome. | | [signature_chain_validation_result](#signature_chain_validation_result-property) | The outcome of a certificate chain validation routine. | | [signature_claimed_signing_time](#signature_claimed_signing_time-property) | Returns or sets the signature's creation time. | | [signature_compatibility_errors](#signature_compatibility_errors-property) | Returns compatibility errors encountered during validation. | | [signature_contact_info](#signature_contact_info-property) | Contains the signer's contact information. | | [signature_contains_long_term_info](#signature_contains_long_term_info-property) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). | | [signature_coverage_ends_at](#signature_coverage_ends_at-property) | Indicates the byte offset in the PDF file where signature coverage ends. | | [signature_custom_data](#signature_custom_data-property) | Uninterpreted custom data to save with the PDF signature. | | [signature_empty_field](#signature_empty_field-property) | Indicates whether the signature is created as an empty property (a signature placeholder). | | [signature_entity_label](#signature_entity_label-property) | Use this property to get the signature entity label. | | [signature_filter_name](#signature_filter_name-property) | Specifies the PDF security handler filter name to use when creating a new signature. | | [signature_full_signature_name](#signature_full_signature_name-property) | Specifies the full name of the signature property. | | [signature_handle](#signature_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signature_hash_algorithm](#signature_hash_algorithm-property) | Specifies the hash algorithm to be used for signing. | | [signature_height](#signature_height-property) | Specifies the height of the signature widget. | | [signature_issuer_rdn](#signature_issuer_rdn-property) | The Relative Distinguished Name of the signing certificate's issuer. | | [signature_level](#signature_level-property) | Specifies the PAdES signature level. | | [signature_location](#signature_location-property) | Specifies the host name or the physical location of the signing entity. | | [signature_offset_x](#signature_offset_x-property) | Specifies the signature widget offset from the left-hand page border. | | [signature_offset_y](#signature_offset_y-property) | Specifies the signature widget offset from the bottom page border. | | [signature_page](#signature_page-property) | Indicates the index of the page on which the signature is placed. | | [signature_policy_hash](#signature_policy_hash-property) | The signature policy hash value for EPES signatures. | | [signature_policy_hash_algorithm](#signature_policy_hash_algorithm-property) | The algorithm that was used to calculate the signature policy hash. | | [signature_policy_id](#signature_policy_id-property) | The policy ID to be included in the signature. | | [signature_policy_uri](#signature_policy_uri-property) | The signature policy URI that was included in the signature. | | [signature_reason](#signature_reason-property) | Specifies the reason for signing. | | [signature_serial_number](#signature_serial_number-property) | The serial number of the signing certificate that created the signature. | | [signature_bytes](#signature_bytes-property) | Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures. | | [signature_name](#signature_name-property) | Specifies the unique signature identifier to use. | | [signature_type](#signature_type-property) | The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown. | | [signature_validation_result](#signature_validation_result-property) | The outcome of the cryptographic signature validation. | | [signature_subject_key_id](#signature_subject_key_id-property) | Contains the subject key identifier of the signing certificate. | | [signature_subject_rdn](#signature_subject_rdn-property) | Contains the RDN of the owner of the signing certificate. | | [signature_timestamped](#signature_timestamped-property) | Use this property to establish whether the signature contains an embedded timestamp. | | [signature_validated_signing_time](#signature_validated_signing_time-property) | Contains the certified signing time. | | [signature_validation_log](#signature_validation_log-property) | Contains the signing certificate's chain validation log. | | [signature_width](#signature_width-property) | Specifies the width of the signature widget. | | [socket_dns_mode](#socket_dns_mode-property) | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. | | [socket_dns_port](#socket_dns_port-property) | Specifies the port number to be used for sending queries to the DNS server. | | [socket_dns_query_timeout](#socket_dns_query_timeout-property) | The timeout (in milliseconds) for each DNS query. | | [socket_dns_servers](#socket_dns_servers-property) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. | | [socket_dns_total_timeout](#socket_dns_total_timeout-property) | The timeout (in milliseconds) for the whole resolution process. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property) | Enables or disables IP protocol version 6. | | [timestamp_count](#timestamp_count-property) | The number of records in the Timestamp arrays. | | [timestamp_accuracy](#timestamp_accuracy-property) | This property indicates the accuracy of the included time mark, in microseconds. | | [timestamp_bytes](#timestamp_bytes-property) | Returns the raw timestamp data in DER format. | | [timestamp_certificate_index](#timestamp_certificate_index-property) | Returns the index of the TSA certificate in the Certificates collection. | | [timestamp_chain_validation_details](#timestamp_chain_validation_details-property) | The details of a certificate chain validation outcome. | | [timestamp_chain_validation_result](#timestamp_chain_validation_result-property) | The outcome of a certificate chain validation routine. | | [timestamp_contains_long_term_info](#timestamp_contains_long_term_info-property) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). | | [timestamp_entity_label](#timestamp_entity_label-property) | Use this property to get the timestamp entity label. | | [timestamp_hash_algorithm](#timestamp_hash_algorithm-property) | Returns the timestamp's hash algorithm. | | [timestamp_parent_entity](#timestamp_parent_entity-property) | Use this property to get the label of the timestamp's parent entity. | | [timestamp_serial_number](#timestamp_serial_number-property) | Returns the timestamp's serial number. | | [timestamp_time](#timestamp_time-property) | The time point incorporated into the timestamp. | | [timestamp_type](#timestamp_type-property) | Returns the type of the timestamp. | | [timestamp_tsa_name](#timestamp_tsa_name-property) | This value uniquely identifies the Timestamp Authority (TSA). | | [timestamp_validation_log](#timestamp_validation_log-property) | Contains the TSA certificate chain validation log. | | [timestamp_validation_result](#timestamp_validation_result-property) | Contains the timestamp validation outcome. | | [tls_auto_validate_certificates](#tls_auto_validate_certificates-property) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [tls_base_configuration](#tls_base_configuration-property) | Selects the base configuration for the TLS settings. | | [tls_ciphersuites](#tls_ciphersuites-property) | A list of ciphersuites separated with commas or semicolons. | | [tls_client_auth](#tls_client_auth-property) | Enables or disables certificate-based client authentication. | | [tls_extensions](#tls_extensions-property) | Provides access to TLS extensions. | | [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property) | Whether to force TLS session resumption when the destination address changes. | | [tls_groups](#tls_groups-property) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [tls_pre_shared_identity](#tls_pre_shared_identity-property) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [tls_pre_shared_key](#tls_pre_shared_key-property) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [tls_pre_shared_key_ciphersuite](#tls_pre_shared_key_ciphersuite-property) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property) | Selects the renegotiation attack prevention mechanism. | | [tls_revocation_check](#tls_revocation_check-property) | Specifies the kind(s) of revocation check to perform. | | [tls_ssl_options](#tls_ssl_options-property) | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. | | [tls_mode](#tls_mode-property) | Specifies the TLS mode to use. | | [tls_use_extended_master_secret](#tls_use_extended_master_secret-property) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [tls_use_session_resumption](#tls_use_session_resumption-property) | Enables or disables the TLS session resumption capability. | | [tls_versions](#tls_versions-property) | The SSL/TLS versions to enable by default. | | [tls_client_cert_count](#tls_client_cert_count-property) | The number of records in the TLSClientCert arrays. | | [tls_client_cert_bytes](#tls_client_cert_bytes-property) | Returns the raw certificate data in DER format. | | [tls_client_cert_handle](#tls_client_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [tls_server_cert_count](#tls_server_cert_count-property) | The number of records in the TLSServerCert arrays. | | [tls_server_cert_bytes](#tls_server_cert_bytes-property) | Returns the raw certificate data in DER format. | | [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. | | [tls_server_cert_handle](#tls_server_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [tls_server_cert_issuer](#tls_server_cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. | | [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. | | [tls_server_cert_key_bits](#tls_server_cert_key_bits-property) | Returns the length of the public key in bits. | | [tls_server_cert_key_usage](#tls_server_cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [tls_server_cert_self_signed](#tls_server_cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [tls_server_cert_serial_number](#tls_server_cert_serial_number-property) | Returns the certificate's serial number. | | [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. | | [tls_server_cert_subject](#tls_server_cert_subject-property) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [tls_server_cert_subject_rdn](#tls_server_cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [tls_server_cert_valid_from](#tls_server_cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. | | [tls_server_cert_valid_to](#tls_server_cert_valid_to-property) | The time point at which the certificate expires, in UTC. | | [trusted_cert_count](#trusted_cert_count-property) | The number of records in the TrustedCert arrays. | | [trusted_cert_bytes](#trusted_cert_bytes-property) | Returns the raw certificate data in DER format. | | [trusted_cert_handle](#trusted_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [validation_moment](#validation_moment-property) | The time point at which signature validity is to be established. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [close](#close-method) | Closes an opened document. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method) | Performs an additional action. | | [get_attached_bytes](#get_attached_bytes-method) | Saves a PDF attachment to a byte array. | | [get_attached_file](#get_attached_file-method) | Saves a PDF attachment to a file. | | [get_signed_version](#get_signed_version-method) | Returns the part of the document that is covered by the signature. | | [open](#open-method) | Opens a document for verifying or removing signatures. | | [reset](#reset-method) | Resets the class settings. | | [revalidate](#revalidate-method) | Revalidates a signature in accordance with current settings. | | [select_info](#select_info-method) | Select signature information for a specific entity. | | [unsign](#unsign-method) | Deletes a signature from the document. | | [verify](#verify-method) | Verifies a signed PDF document. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_chain_element_download](#on_chain_element_download-event) | Fires when there is a need to download a chain element from an online source. | | [on_chain_element_needed](#on_chain_element_needed-event) | Fires when an element required to validate the chain was not located. | | [on_chain_validated](#on_chain_validated-event) | Reports the completion of a certificate chain validation. | | [on_chain_validation_progress](#on_chain_validation_progress-event) | This event is fired multiple times during chain validation to report various stages of the validation procedure. | | [on_document_loaded](#on_document_loaded-event) | This event is fired when the document has been loaded into memory. | | [on_encrypted](#on_encrypted-event) | Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document. | | [on_error](#on_error-event) | Information about errors during signing/validation. | | [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. | | [on_signature_found](#on_signature_found-event) | Signifies the start of signature validation. | | [on_signature_validated](#on_signature_validated-event) | Marks the completion of the signature validation routine. | | [on_timestamp_found](#on_timestamp_found-event) | Signifies the start of a timestamp validation routine. | | [on_timestamp_validated](#on_timestamp_validated-event) | Reports the completion of the timestamp validation routine. | | [on_tls_cert_needed](#on_tls_cert_needed-event) | Fires when a remote TLS party requests a client certificate. | | [on_tls_cert_validate](#on_tls_cert_validate-event) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. | | [on_tls_established](#on_tls_established-event) | Fires when a TLS handshake with Host successfully completes. | | [on_tls_handshake](#on_tls_handshake-event) | Fires when a new TLS handshake is initiated, before the handshake commences. | | [on_tls_shutdown](#on_tls_shutdown-event) | Reports the graceful closure of a TLS connection. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AlternateName](#AlternateName) | TBD. | | [AsyncDocumentID](#AsyncDocumentID) | Specifies the document ID for SignAsyncEnd() call. | | [BuildApplicationName](#BuildApplicationName) | Specifies the application name used to create the signature. | | [BuildApplicationVersion](#BuildApplicationVersion) | Specifies the application version used to create the signature. | | [BuildProperties](#BuildProperties) | Specifies the build properties of the signature. | | [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. | | [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. | | [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. | | [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. | | [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. | | [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. | | [ChainCurrentCACert](#ChainCurrentCACert) | Returns the current CA certificate. | | [ChainCurrentCert](#ChainCurrentCert) | Returns the certificate that is currently being validated. | | [ChainCurrentCRL](#ChainCurrentCRL) | Returns the current CRL. | | [ChainCurrentCRLSize](#ChainCurrentCRLSize) | Returns the size of the current CRL. | | [ChainCurrentOCSP](#ChainCurrentOCSP) | Returns the current OCSP response. | | [ChainCurrentOCSPSigner](#ChainCurrentOCSPSigner) | Returns the signer of the current OCSP object. | | [ChainInterimDetails](#ChainInterimDetails) | Returns the current interim validation details. | | [ChainInterimResult](#ChainInterimResult) | Returns the current interim validation result. | | [CheckValidityPeriodForTrusted](#CheckValidityPeriodForTrusted) | Whether to check validity period for trusted certificates. | | [ConfigPreferLegacyLevels](#ConfigPreferLegacyLevels) | Indicates whether legacy signature levels should be preferred. | | [CustomSignedAttributes](#CustomSignedAttributes) | TBD. | | [CustomTrustedLists](#CustomTrustedLists) | Specifies the custom TrustedLists. | | [CustomTSLs](#CustomTSLs) | Specifies the custom TrustedLists. | | [CustomUnsignedAttributes](#CustomUnsignedAttributes) | TBD. | | [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. | | [DislikeOpenEndedOCSPs](#DislikeOpenEndedOCSPs) | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. | | [DocumentVersion](#DocumentVersion) | The document version from the PDF document header. | | [DTSAccuracy](#DTSAccuracy) | Indicates the accuracy of the document timestamp. | | [DTSSerialNumber](#DTSSerialNumber) | Indicates the serial number of the document timestamp. | | [DTSTime](#DTSTime) | Indicates the time of the document timestamp. | | [DTSTSAName](#DTSTSAName) | Indicates the TSA name of the document timestamp. | | [EmptySignatureFieldAddRevInfo\[Index\]](#EmptySignatureFieldAddRevInfo[Index]) | Specifies if revocation checking should be performed. | | [EmptySignatureFieldAlternateName\[Index\]](#EmptySignatureFieldAlternateName[Index]) | Contains an alternate field name. | | [EmptySignatureFieldCount](#EmptySignatureFieldCount) | The number of empty signature form fields. | | [EmptySignatureFieldFlags\[Index\]](#EmptySignatureFieldFlags[Index]) | The field flags of the signature form field. | | [EmptySignatureFieldHeight\[Index\]](#EmptySignatureFieldHeight[Index]) | The Height of the empty signature form field. | | [EmptySignatureFieldInvisible\[Index\]](#EmptySignatureFieldInvisible[Index]) | The visibility status of the field. | | [EmptySignatureFieldLegalAttestations\[Index\]](#EmptySignatureFieldLegalAttestations[Index]) | Specifies the legal attestations that are associated with the signature. | | [EmptySignatureFieldMappingName\[Index\]](#EmptySignatureFieldMappingName[Index]) | The mapping name to be used when exporting form field data from the document. | | [EmptySignatureFieldName\[Index\]](#EmptySignatureFieldName[Index]) | Textual field name. | | [EmptySignatureFieldOffsetX\[Index\]](#EmptySignatureFieldOffsetX[Index]) | The field's offset from the left page border. | | [EmptySignatureFieldOffsetY\[Index\]](#EmptySignatureFieldOffsetY[Index]) | The field's offset from the bottom page border. | | [EmptySignatureFieldPage\[Index\]](#EmptySignatureFieldPage[Index]) | The index of the form field's page in the document. | | [EmptySignatureFieldRequiredAllowedChanges\[Index\]](#EmptySignatureFieldRequiredAllowedChanges[Index]) | Specifies the changes allowed by the signature. | | [EmptySignatureFieldRequiredConstraints\[Index\]](#EmptySignatureFieldRequiredConstraints[Index]) | Specifies the required Seed Value Dictionary (SVD) constraints. | | [EmptySignatureFieldRequiredDigestAlgorithms\[Index\]](#EmptySignatureFieldRequiredDigestAlgorithms[Index]) | Specifies the required digest algorithms. | | [EmptySignatureFieldRequiredFilter\[Index\]](#EmptySignatureFieldRequiredFilter[Index]) | Specifies the required filter. | | [EmptySignatureFieldRequiredLockAction\[Index\]](#EmptySignatureFieldRequiredLockAction[Index]) | Indicates which set of fields shall be locked. | | [EmptySignatureFieldRequiredLockFields\[Index\]](#EmptySignatureFieldRequiredLockFields[Index]) | Indicates the fields that shall be locked on signing. | | [EmptySignatureFieldRequiredReasons\[Index\]](#EmptySignatureFieldRequiredReasons[Index]) | Specifies the required reasons. | | [EmptySignatureFieldRequiredSubfilters\[Index\]](#EmptySignatureFieldRequiredSubfilters[Index]) | Specifies the required subfilters. | | [EmptySignatureFieldTimestampRequired\[Index\]](#EmptySignatureFieldTimestampRequired[Index]) | Specifies if the signature should be timestamped. | | [EmptySignatureFieldTSPURL\[Index\]](#EmptySignatureFieldTSPURL[Index]) | URL for a TSP server. | | [EmptySignatureFieldWidth\[Index\]](#EmptySignatureFieldWidth[Index]) | The Width of the empty signature form field. | | [EnableOldSignatures](#EnableOldSignatures) | Enables support for prehistoric adbe.x509.sha1 signatures. | | [EncryptionHandlerName](#EncryptionHandlerName) | Specifies the custom security handler PDF-name. | | [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. | | [EvaluateSystemTrustForSelfSignedCertificates](#EvaluateSystemTrustForSelfSignedCertificates) | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. | | [EvaluateSystemTrustForSSL](#EvaluateSystemTrustForSSL) | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. | | [ForceCompleteChainValidation](#ForceCompleteChainValidation) | Whether to check the CA certificates when the signing certificate is invalid. | | [ForceCompleteChainValidationForTrusted](#ForceCompleteChainValidationForTrusted) | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. | | [GracePeriod](#GracePeriod) | Specifies a grace period to apply during revocation information checks. | | [HardenedKeyGeneration](#HardenedKeyGeneration) | Specifies if hardened Key generation should be used. | | [IgnoreChainLoops](#IgnoreChainLoops) | Whether chain loops should be ignored. | | [IgnoreChainValidationErrors](#IgnoreChainValidationErrors) | Whether to ignore any certificate chain validation issues. | | [IgnoreOCSPNoCheckExtension](#IgnoreOCSPNoCheckExtension) | Whether the OCSP NoCheck extension should be ignored. | | [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. | | [IgnoreTimestampChainValidityForLevelDetection](#IgnoreTimestampChainValidityForLevelDetection) | Specify whether timestamp chain validity should be ignored during signature level detection. | | [ImplicitlyTrustSelfSignedCertificates](#ImplicitlyTrustSelfSignedCertificates) | Whether to trust self-signed certificates. | | [IsLTVEnabled](#IsLTVEnabled) | Indicates LTV-enabled signature. | | [MappingName](#MappingName) | TBD. | | [MDPHashAlgorithm](#MDPHashAlgorithm) | Specifies the MDP hash algorithm. | | [PageInfoCount](#PageInfoCount) | The number of pages. | | [PageInfoCropBoxEmpty\[Index\]](#PageInfoCropBoxEmpty[Index]) | Check if the page's crop box is empty or not. | | [PageInfoCropLLX\[Index\]](#PageInfoCropLLX[Index]) | Defines the X coordinate of the lower left corner of the crop box. | | [PageInfoCropLLY\[Index\]](#PageInfoCropLLY[Index]) | Defines the Y coordinate of the lower left corner of the crop box. | | [PageInfoCropURX\[Index\]](#PageInfoCropURX[Index]) | Defines the X coordinate of the upper right corner of the crop box. | | [PageInfoCropURY\[Index\]](#PageInfoCropURY[Index]) | Defines the Y coordinate of the upper right corner of the crop box. | | [PageInfoHeight\[Index\]](#PageInfoHeight[Index]) | The Height of the page. | | [PageInfoMediaLLX\[Index\]](#PageInfoMediaLLX[Index]) | Defines the X coordinate of the lower left corner of the media box. | | [PageInfoMediaLLY\[Index\]](#PageInfoMediaLLY[Index]) | Defines the Y coordinate of the lower left corner of the media box. | | [PageInfoMediaURX\[Index\]](#PageInfoMediaURX[Index]) | Defines the X coordinate of the upper right corner of the media box. | | [PageInfoMediaURY\[Index\]](#PageInfoMediaURY[Index]) | Defines the Y coordinate of the upper right corner of the media box. | | [PageInfoRotate\[Index\]](#PageInfoRotate[Index]) | The Rotate value of the page. | | [PageInfoUserUnit\[Index\]](#PageInfoUserUnit[Index]) | Defines the size of default user space units. | | [PageInfoWidth\[Index\]](#PageInfoWidth[Index]) | The Width of the page. | | [PolicyDescription](#PolicyDescription) | signature policy description. | | [PolicyExplicitText](#PolicyExplicitText) | The explicit text of the user notice. | | [PolicyUNNumbers](#PolicyUNNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. | | [PolicyUNOrganization](#PolicyUNOrganization) | The organization part of the NoticeReference qualifier. | | [ProductionPlace](#ProductionPlace) | Identifies the place of the signature production. | | [PromoteLongOCSPResponses](#PromoteLongOCSPResponses) | Whether long OCSP responses are requested. | | [PSSUsed](#PSSUsed) | Whether to use RSASSA-PSS algorithm. | | [RC4KeyBits](#RC4KeyBits) | Specifies the number of key bits used for the RC4 algorithm. | | [ReassembleMode](#ReassembleMode) | Specifies the document reassemble mode. | | [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. | | [SchemeParams](#SchemeParams) | The algorithm scheme parameters to employ. | | [SigPolicyDescription](#SigPolicyDescription) | signature policy description. | | [SigPolicyExplicitText](#SigPolicyExplicitText) | The explicit text of the user notice. | | [SigPolicyHash](#SigPolicyHash) | The EPES policy hash. | | [SigPolicyHashAlgorithm](#SigPolicyHashAlgorithm) | The hash algorithm that was used to generate the EPES policy hash. | | [SigPolicyID](#SigPolicyID) | The EPES policy ID. | | [SigPolicyNoticeNumbers](#SigPolicyNoticeNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. | | [SigPolicyNoticeOrganization](#SigPolicyNoticeOrganization) | The organization part of the NoticeReference qualifier. | | [SigPolicyURI](#SigPolicyURI) | The EPES policy URI. | | [TempPath](#TempPath) | Path for storing temporary files. | | [TimestampResponse](#TimestampResponse) | A base16-encoded timestamp response received from a TSA. | | [TLSChainValidationDetails](#TLSChainValidationDetails) | Contains the advanced details of the TLS server certificate validation. | | [TLSChainValidationResult](#TLSChainValidationResult) | Contains the result of the TLS server certificate validation. | | [TLSClientAuthRequested](#TLSClientAuthRequested) | Indicates whether the TLS server requests client authentication. | | [TLSValidationLog](#TLSValidationLog) | Contains the log of the TLS server certificate validation. | | [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. | | [TspAttemptCount](#TspAttemptCount) | Specifies the number of timestamping request attempts. | | [TspHashAlgorithm](#TspHashAlgorithm) | Sets a specific hash algorithm for use with the timestamping service. | | [TspReqPolicy](#TspReqPolicy) | Sets a request policy ID to include in the timestamping request. | | [UseDefaultTrustedLists](#UseDefaultTrustedLists) | Enables or disables the use of the default TrustedLists. | | [UseDefaultTSLs](#UseDefaultTSLs) | Enables or disables the use of the default TrustedLists. | | [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. | | [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. | | [UsePSS](#UsePSS) | Whether to use RSASSA-PSS algorithm. | | [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. | | [UseValidationCache](#UseValidationCache) | Enables or disable the use of the product-wide certificate chain validation cache. | | [UseValidatorSettingsForTLSValidation](#UseValidatorSettingsForTLSValidation) | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. | | [WidgetHeight](#WidgetHeight) | Specifies the height of the signature widget. | | [WidgetOffsetX](#WidgetOffsetX) | Specifies the signature widget offset from the left-hand page border. | | [WidgetOffsetY](#WidgetOffsetY) | Specifies the signature widget offset from the bottom page border. | | [WidgetWidth](#WidgetWidth) | Specifies the width of the signature widget. | | [XMPMetadataContent](#XMPMetadataContent) | The XMP metadata content. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # all_signatures_valid property The cumulative validity of all signatures. ## Syntax ```text def get_all_signatures_valid() -> bool: ... all_signatures_valid = property(get_all_signatures_valid, None) ``` ## 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. # attached_file_count property The number of records in the AttachedFiles arrays. ## Syntax ```text def get_attached_file_count() -> int: ... attached_file_count = property(get_attached_file_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [attached_files_content_subtype](#attached_files_content_subtype-property) - [attached_files_content_type](#attached_files_content_type-property) - [attached_files_creation_date](#attached_files_creation_date-property) - [attached_files_data](#attached_files_data-property) - [attached_files_description](#attached_files_description-property) - [attached_files_file_name](#attached_files_file_name-property) - [attached_files_handle](#attached_files_handle-property) - [attached_files_id](#attached_files_id-property) - [attached_files_modification_date](#attached_files_modification_date-property) - [attached_files_read_date](#attached_files_read_date-property) - [attached_files_size](#attached_files_size-property) The array indices start at *0* and end at *attached_file_count - 1*. This property is read-only. # attached_files_content_subtype property Contains the content subtype of the attachment. ## Syntax ```text def get_attached_files_content_subtype(attached_file_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the content subtype of the attachment. The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_content_type property Contains the content type of the attachment. ## Syntax ```text def get_attached_files_content_type(attached_file_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the content type of the attachment. The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_creation_date property The creation date. ## Syntax ```text def get_attached_files_creation_date(attached_file_index: int) -> str: ... ``` ## Default Value "" ## Remarks The creation date. The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_data property The content of the attachment. ## Syntax ```text def get_attached_files_data(attached_file_index: int) -> bytes: ... ``` ## Remarks The content of the attachment. The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_description property Textual description of the attachment. ## Syntax ```text def get_attached_files_description(attached_file_index: int) -> str: ... ``` ## 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 *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_file_name property Specifies the name of the attachment file. ## Syntax ```text def get_attached_files_file_name(attached_file_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the name of the attachment file. The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_attached_files_handle(attached_file_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_id property Contains the attachment's unique identifier. ## Syntax ```text def get_attached_files_id(attached_file_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the attachment's unique identifier. The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_modification_date property Specifies the date and time of the file's last modification. ## Syntax ```text def get_attached_files_modification_date(attached_file_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the date and time of the file's last modification. The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_read_date property Specifies the file's last read date. ## Syntax ```text def get_attached_files_read_date(attached_file_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the file's last read date. The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # attached_files_size property The attachment's size in bytes. ## Syntax ```text def get_attached_files_size(attached_file_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The attachment's size in bytes. The *attached_file_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attached_file_count](#attached_file_count-property) property. This property is read-only. # auto_validate_signatures property Specifies whether PDFVerifier should validate any present signatures when the document is opened. ## Syntax ```text def get_auto_validate_signatures() -> bool: ... def set_auto_validate_signatures(value: bool) -> None: ... auto_validate_signatures = property(get_auto_validate_signatures, set_auto_validate_signatures) ``` ## Default Value TRUE ## Remarks This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the [revalidate](#revalidate-method) method. # blocked_cert_count property The number of records in the BlockedCert arrays. ## Syntax ```text def get_blocked_cert_count() -> int: ... def set_blocked_cert_count(value: int) -> None: ... blocked_cert_count = property(get_blocked_cert_count, set_blocked_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [blocked_cert_bytes](#blocked_cert_bytes-property) - [blocked_cert_handle](#blocked_cert_handle-property) The array indices start at *0* and end at *blocked_cert_count - 1*. # blocked_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_blocked_cert_bytes(blocked_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_blocked_cert_handle(blocked_cert_index: int) -> int: ... def set_blocked_cert_handle(blocked_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. # cert_count property The number of records in the Cert arrays. ## Syntax ```text def get_cert_count() -> int: ... cert_count = property(get_cert_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [cert_bytes](#cert_bytes-property) - [cert_ca](#cert_ca-property) - [cert_ca_key_id](#cert_ca_key_id-property) - [cert_crl_distribution_points](#cert_crl_distribution_points-property) - [cert_curve](#cert_curve-property) - [cert_fingerprint](#cert_fingerprint-property) - [cert_friendly_name](#cert_friendly_name-property) - [cert_handle](#cert_handle-property) - [cert_hash_algorithm](#cert_hash_algorithm-property) - [cert_issuer](#cert_issuer-property) - [cert_issuer_rdn](#cert_issuer_rdn-property) - [cert_key_algorithm](#cert_key_algorithm-property) - [cert_key_bits](#cert_key_bits-property) - [cert_key_fingerprint](#cert_key_fingerprint-property) - [cert_key_usage](#cert_key_usage-property) - [cert_key_valid](#cert_key_valid-property) - [cert_ocsp_locations](#cert_ocsp_locations-property) - [cert_ocsp_no_check](#cert_ocsp_no_check-property) - [cert_origin](#cert_origin-property) - [cert_policy_i_ds](#cert_policy_i_ds-property) - [cert_private_key_bytes](#cert_private_key_bytes-property) - [cert_private_key_exists](#cert_private_key_exists-property) - [cert_private_key_extractable](#cert_private_key_extractable-property) - [cert_public_key_bytes](#cert_public_key_bytes-property) - [cert_qualified](#cert_qualified-property) - [cert_qualified_statements](#cert_qualified_statements-property) - [cert_qualifiers](#cert_qualifiers-property) - [cert_self_signed](#cert_self_signed-property) - [cert_serial_number](#cert_serial_number-property) - [cert_sig_algorithm](#cert_sig_algorithm-property) - [cert_source](#cert_source-property) - [cert_subject](#cert_subject-property) - [cert_subject_alternative_name](#cert_subject_alternative_name-property) - [cert_subject_key_id](#cert_subject_key_id-property) - [cert_subject_rdn](#cert_subject_rdn-property) - [cert_type](#cert_type-property) - [cert_valid](#cert_valid-property) - [cert_valid_from](#cert_valid_from-property) - [cert_valid_to](#cert_valid_to-property) The array indices start at *0* and end at *cert_count - 1*. This property is read-only. # cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_cert_bytes(cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_ca property Indicates whether the certificate has a CA capability. ## Syntax ```text def get_cert_ca(cert_index: int) -> bool: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_ca_key_id property A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax ```text def get_cert_ca_key_id(cert_index: int) -> bytes: ... ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [cert_subject_key_id](#cert_subject_key_id-property) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_type property Returns the type of the entity contained in the Certificate object. ## Syntax ```text def get_cert_type(cert_index: int) -> int: ... ``` ## Possible Values ```text 0 # Unknown1 # X509Certificate2 # X509CertificateRequest ``` ## Default Value 0 ## Remarks Returns the type of the entity contained in the [Certificate](#Type_Certificate) object. A [Certificate](#Type_Certificate) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](#CertificateManager) class to load or create new certificate and certificate requests objects. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_crl_distribution_points property Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Syntax ```text def get_cert_crl_distribution_points(cert_index: int) -> str: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_curve property Specifies the elliptic curve associated with the certificate's public key. ## Syntax ```text def get_cert_curve(cert_index: int) -> str: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_fingerprint property Contains the fingerprint (a hash imprint) of this certificate. ## Syntax ```text def get_cert_fingerprint(cert_index: int) -> str: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_friendly_name property Contains an associated alias (friendly name) of the certificate. ## Syntax ```text def get_cert_friendly_name(cert_index: int) -> str: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_cert_handle(cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_hash_algorithm property Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Syntax ```text def get_cert_hash_algorithm(cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [cert_sig_algorithm](#cert_sig_algorithm-property) 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_issuer property The common name of the certificate issuer (CA), typically a company name. ## Syntax ```text def get_cert_issuer(cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [cert_issuer_rdn](#cert_issuer_rdn-property). The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_issuer_rdn property A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax ```text def get_cert_issuer_rdn(cert_index: int) -> str: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_key_algorithm property Specifies the public key algorithm of this certificate. ## Syntax ```text def get_cert_key_algorithm(cert_index: int) -> str: ... ``` ## Default Value "0" ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [cert_key_bits](#cert_key_bits-property), [cert_curve](#cert_curve-property), and [cert_public_key_bytes](#cert_public_key_bytes-property) properties to get more details about the key the certificate contains. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_key_bits property Returns the length of the public key in bits. ## Syntax ```text def get_cert_key_bits(cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [cert_public_key_bytes](#cert_public_key_bytes-property) or [cert_private_key_bytes](#cert_private_key_bytes-property) property would typically contain auxiliary values, and therefore be longer. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_key_fingerprint property Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax ```text def get_cert_key_fingerprint(cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the [cert_fingerprint](#cert_fingerprint-property) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_key_usage property Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax ```text def get_cert_key_usage(cert_index: int) -> int: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_key_valid property Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Syntax ```text def get_cert_key_valid(cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_ocsp_locations property Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Syntax ```text def get_cert_ocsp_locations(cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this property before calling the certificate manager's [generate](#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_ocsp_no_check property Accessor to the value of the certificate's ocsp-no-check extension. ## Syntax ```text def get_cert_ocsp_no_check(cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Accessor to the value of the certificate's ocsp-no-check extension. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_origin property Returns the location that the certificate was taken or loaded from. ## Syntax ```text def get_cert_origin(cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Returns the location that the certificate was taken or loaded from. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_policy_i_ds property Contains identifiers (OIDs) of the applicable certificate policies. ## Syntax ```text def get_cert_policy_i_ds(cert_index: int) -> str: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_private_key_bytes property Returns the certificate's private key in DER-encoded format. ## Syntax ```text def get_cert_private_key_bytes(cert_index: int) -> bytes: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_private_key_exists property Indicates whether the certificate has a usable private key associated with it. ## Syntax ```text def get_cert_private_key_exists(cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption. This property is independent from [cert_private_key_bytes](#cert_private_key_bytes-property), 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_private_key_extractable property Indicates whether the private key is extractable (exportable). ## Syntax ```text def get_cert_private_key_extractable(cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the private key is extractable (exportable). The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_public_key_bytes property Contains the certificate's public key in DER format. ## Syntax ```text def get_cert_public_key_bytes(cert_index: int) -> bytes: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_qualified property Indicates whether the certificate is qualified. ## Syntax ```text def get_cert_qualified(cert_index: int) -> bool: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_qualified_statements property Returns a simplified qualified status of the certificate. ## Syntax ```text def get_cert_qualified_statements(cert_index: int) -> int: ... ``` ## Possible Values ```text 0 # NonQualified1 # QualifiedHardware2 # QualifiedSoftware ``` ## Default Value 0 ## Remarks Returns a simplified qualified status of the certificate. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_qualifiers property A list of qualifiers. ## Syntax ```text def get_cert_qualifiers(cert_index: int) -> str: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_self_signed property Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax ```text def get_cert_self_signed(cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_serial_number property Returns the certificate's serial number. ## Syntax ```text def get_cert_serial_number(cert_index: int) -> bytes: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_sig_algorithm property Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax ```text def get_cert_sig_algorithm(cert_index: int) -> str: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_source property Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax ```text def get_cert_source(cert_index: int) -> int: ... ``` ## Possible Values ```text 0 # Unknown1 # Signature2 # Document3 # User4 # Local5 # Online ``` ## Default Value 0 ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_subject property The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax ```text def get_cert_subject(cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [cert_subject_rdn](#cert_subject_rdn-property). The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_subject_alternative_name property Returns or sets the value of the Subject Alternative Name extension of the certificate. ## Syntax ```text def get_cert_subject_alternative_name(cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Returns or sets the value of the Subject Alternative Name extension of the certificate. Subject alternative names are used to provide additional names that are impractical to store in the main [cert_subject_rdn](#cert_subject_rdn-property) 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_subject_key_id property Contains a unique identifier of the certificate's cryptographic key. ## Syntax ```text def get_cert_subject_key_id(cert_index: int) -> bytes: ... ``` ## Remarks Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [cert_subject_key_id](#cert_subject_key_id-property) and [cert_ca_key_id](#cert_ca_key_id-property) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_subject_rdn property A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax ```text def get_cert_subject_rdn(cert_index: int) -> str: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_valid property 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 ```text def get_cert_valid(cert_index: int) -> bool: ... ``` ## 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 *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_valid_from property The time point at which the certificate becomes valid, in UTC. ## Syntax ```text def get_cert_valid_from(cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # cert_valid_to property The time point at which the certificate expires, in UTC. ## Syntax ```text def get_cert_valid_to(cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property. This property is read-only. # check_trusted_lists property Specifies whether the class should attempt to validate chain trust via a known Trusted List. ## Syntax ```text def get_check_trusted_lists() -> bool: ... def set_check_trusted_lists(value: bool) -> None: ... check_trusted_lists = property(get_check_trusted_lists, set_check_trusted_lists) ``` ## 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). # crl_count property The number of records in the CRL arrays. ## Syntax ```text def get_crl_count() -> int: ... crl_count = property(get_crl_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [crl_bytes](#crl_bytes-property) - [crlca_key_id](#crlca_key_id-property) - [crl_entry_count](#crl_entry_count-property) - [crl_handle](#crl_handle-property) - [crl_issuer](#crl_issuer-property) - [crl_issuer_rdn](#crl_issuer_rdn-property) - [crl_location](#crl_location-property) - [crl_next_update](#crl_next_update-property) - [crl_sig_algorithm](#crl_sig_algorithm-property) - [crl_source](#crl_source-property) - [crltbs](#crltbs-property) - [crl_this_update](#crl_this_update-property) The array indices start at *0* and end at *crl_count - 1*. This property is read-only. # crl_bytes property Returns the raw CRL data in DER format. ## Syntax ```text def get_crl_bytes(crl_index: int) -> bytes: ... ``` ## Remarks Returns the raw CRL data in DER format. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crlca_key_id property A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. ## Syntax ```text def get_crlca_key_id(crl_index: int) -> bytes: ... ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crl_entry_count property Returns the number of certificate status entries in the CRL. ## Syntax ```text def get_crl_entry_count(crl_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Returns the number of certificate status entries in the CRL. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crl_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_crl_handle(crl_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crl_issuer property The common name of the CRL issuer (CA), typically a company name. ## Syntax ```text def get_crl_issuer(crl_index: int) -> str: ... ``` ## Default Value "" ## Remarks The common name of the CRL issuer (CA), typically a company name. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crl_issuer_rdn property A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. ## Syntax ```text def get_crl_issuer_rdn(crl_index: int) -> str: ... ``` ## Default Value "" ## Remarks A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crl_location property The URL that the CRL was downloaded from. ## Syntax ```text def get_crl_location(crl_index: int) -> str: ... ``` ## Default Value "" ## Remarks The URL that the CRL was downloaded from. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crl_next_update property The planned time and date of the next version of this CRL to be published. ## Syntax ```text def get_crl_next_update(crl_index: int) -> str: ... ``` ## Default Value "" ## Remarks The planned time and date of the next version of this CRL to be published. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crl_sig_algorithm property The public key algorithm that was used by the CA to sign this CRL. ## Syntax ```text def get_crl_sig_algorithm(crl_index: int) -> str: ... ``` ## Default Value "0" ## Remarks The public key algorithm that was used by the CA to sign this CRL. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crl_source property Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax ```text def get_crl_source(crl_index: int) -> int: ... ``` ## Possible Values ```text 0 # Unknown1 # Signature2 # Document3 # User4 # Local5 # Online ``` ## Default Value 0 ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crltbs property The to-be-signed part of the CRL (the CRL without the signature part). ## Syntax ```text def get_crltbs(crl_index: int) -> bytes: ... ``` ## Remarks The to-be-signed part of the CRL (the CRL without the signature part). The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # crl_this_update property The date and time at which this version of the CRL was published. ## Syntax ```text def get_crl_this_update(crl_index: int) -> str: ... ``` ## Default Value "" ## Remarks The date and time at which this version of the CRL was published. The *crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [crl_count](#crl_count-property) property. This property is read-only. # decryption_certificate_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_decryption_certificate_bytes() -> bytes: ... decryption_certificate_bytes = property(get_decryption_certificate_bytes, None) ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. # decryption_certificate_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_decryption_certificate_handle() -> int: ... def set_decryption_certificate_handle(value: int) -> None: ... decryption_certificate_handle = property(get_decryption_certificate_handle, set_decryption_certificate_handle) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # document_info_encryption_algorithm property The symmetric algorithm used to encrypt the document. ## Syntax ```text def get_document_info_encryption_algorithm() -> str: ... document_info_encryption_algorithm = property(get_document_info_encryption_algorithm, None) ``` ## 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. # document_info_encryption_type property The document encryption type. ## Syntax ```text def get_document_info_encryption_type() -> int: ... document_info_encryption_type = property(get_document_info_encryption_type, None) ``` ## Possible Values ```text 0 # None1 # Password2 # 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. # document_info_metadata_encrypted property Indicates if the document metadata is encrypted. ## Syntax ```text def get_document_info_metadata_encrypted() -> bool: ... document_info_metadata_encrypted = property(get_document_info_metadata_encrypted, None) ``` ## 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. # document_info_permissions property Contains the document permissions associated with the encryption. ## Syntax ```text def get_document_info_permissions() -> int: ... document_info_permissions = property(get_document_info_permissions, None) ``` ## 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. # fips_mode property Reserved. ## Syntax ```text def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ... fips_mode = property(get_fips_mode, set_fips_mode) ``` ## Default Value FALSE ## Remarks This property is reserved for future use. # ignore_chain_validation_errors property Makes the class tolerant to chain validation errors. ## Syntax ```text def get_ignore_chain_validation_errors() -> bool: ... def set_ignore_chain_validation_errors(value: bool) -> None: ... ignore_chain_validation_errors = property(get_ignore_chain_validation_errors, set_ignore_chain_validation_errors) ``` ## 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. # input_bytes property Use this property to pass the input to class in byte array form. ## Syntax ```text def get_input_bytes() -> bytes: ... def set_input_bytes(value: bytes) -> None: ... input_bytes = property(get_input_bytes, set_input_bytes) ``` ## Remarks Assign a byte array containing the data to be processed to this property. # input_file property A path to the signed PDF file. ## Syntax ```text def get_input_file() -> str: ... def set_input_file(value: str) -> None: ... input_file = property(get_input_file, set_input_file) ``` ## Default Value "" ## Remarks Assign the path to the PDF file to be verified to this property. # known_cert_count property The number of records in the KnownCert arrays. ## Syntax ```text def get_known_cert_count() -> int: ... def set_known_cert_count(value: int) -> None: ... known_cert_count = property(get_known_cert_count, set_known_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_cert_bytes](#known_cert_bytes-property) - [known_cert_handle](#known_cert_handle-property) The array indices start at *0* and end at *known_cert_count - 1*. # known_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_known_cert_bytes(known_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_known_cert_handle(known_cert_index: int) -> int: ... def set_known_cert_handle(known_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. # known_crl_count property The number of records in the KnownCRL arrays. ## Syntax ```text def get_known_crl_count() -> int: ... def set_known_crl_count(value: int) -> None: ... known_crl_count = property(get_known_crl_count, set_known_crl_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_crl_bytes](#known_crl_bytes-property) - [known_crl_handle](#known_crl_handle-property) The array indices start at *0* and end at *known_crl_count - 1*. # known_crl_bytes property Returns the raw CRL data in DER format. ## Syntax ```text def get_known_crl_bytes(known_crl_index: int) -> bytes: ... ``` ## Remarks Returns the raw CRL data in DER format. The *known_crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_crl_count](#known_crl_count-property) property. This property is read-only. # known_crl_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_known_crl_handle(known_crl_index: int) -> int: ... def set_known_crl_handle(known_crl_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *known_crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_crl_count](#known_crl_count-property) property. # known_ocsp_count property The number of records in the KnownOCSP arrays. ## Syntax ```text def get_known_ocsp_count() -> int: ... def set_known_ocsp_count(value: int) -> None: ... known_ocsp_count = property(get_known_ocsp_count, set_known_ocsp_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_ocsp_bytes](#known_ocsp_bytes-property) - [known_ocsp_handle](#known_ocsp_handle-property) The array indices start at *0* and end at *known_ocsp_count - 1*. # known_ocsp_bytes property A buffer containing the raw OCSP response data. ## Syntax ```text def get_known_ocsp_bytes(known_ocsp_index: int) -> bytes: ... ``` ## Remarks A buffer containing the raw OCSP response data. The *known_ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_ocsp_count](#known_ocsp_count-property) property. This property is read-only. # known_ocsp_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_known_ocsp_handle(known_ocsp_index: int) -> int: ... def set_known_ocsp_handle(known_ocsp_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *known_ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_ocsp_count](#known_ocsp_count-property) property. # ocsp_count property The number of records in the OCSP arrays. ## Syntax ```text def get_ocsp_count() -> int: ... ocsp_count = property(get_ocsp_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [ocsp_bytes](#ocsp_bytes-property) - [ocsp_entry_count](#ocsp_entry_count-property) - [ocsp_handle](#ocsp_handle-property) - [ocsp_issuer](#ocsp_issuer-property) - [ocsp_issuer_rdn](#ocsp_issuer_rdn-property) - [ocsp_location](#ocsp_location-property) - [ocsp_produced_at](#ocsp_produced_at-property) - [ocsp_sig_algorithm](#ocsp_sig_algorithm-property) - [ocsp_source](#ocsp_source-property) The array indices start at *0* and end at *ocsp_count - 1*. This property is read-only. # ocsp_bytes property A buffer containing the raw OCSP response data. ## Syntax ```text def get_ocsp_bytes(ocsp_index: int) -> bytes: ... ``` ## Remarks A buffer containing the raw OCSP response data. The *ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [ocsp_count](#ocsp_count-property) property. This property is read-only. # ocsp_entry_count property The number of SingleResponse elements contained in this OCSP response. ## Syntax ```text def get_ocsp_entry_count(ocsp_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. The *ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [ocsp_count](#ocsp_count-property) property. This property is read-only. # ocsp_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_ocsp_handle(ocsp_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [ocsp_count](#ocsp_count-property) property. This property is read-only. # ocsp_issuer property Indicates the issuer of this response (a CA or its authorized representative). ## Syntax ```text def get_ocsp_issuer(ocsp_index: int) -> str: ... ``` ## Default Value "" ## Remarks Indicates the issuer of this response (a CA or its authorized representative). The *ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [ocsp_count](#ocsp_count-property) property. This property is read-only. # ocsp_issuer_rdn property Indicates the RDN of the issuer of this response (a CA or its authorized representative). ## Syntax ```text def get_ocsp_issuer_rdn(ocsp_index: int) -> str: ... ``` ## Default Value "" ## Remarks Indicates the RDN of the issuer of this response (a CA or its authorized representative). The *ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [ocsp_count](#ocsp_count-property) property. This property is read-only. # ocsp_location property The location of the OCSP responder. ## Syntax ```text def get_ocsp_location(ocsp_index: int) -> str: ... ``` ## Default Value "" ## Remarks The location of the OCSP responder. The *ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [ocsp_count](#ocsp_count-property) property. This property is read-only. # ocsp_produced_at property Specifies the time when the response was produced, in UTC. ## Syntax ```text def get_ocsp_produced_at(ocsp_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the time when the response was produced, in UTC. The *ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [ocsp_count](#ocsp_count-property) property. This property is read-only. # ocsp_sig_algorithm property The public key algorithm that was used by the CA to sign this OCSP response. ## Syntax ```text def get_ocsp_sig_algorithm(ocsp_index: int) -> str: ... ``` ## Default Value "0" ## Remarks The public key algorithm that was used by the CA to sign this OCSP response. The *ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [ocsp_count](#ocsp_count-property) property. This property is read-only. # ocsp_source property Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax ```text def get_ocsp_source(ocsp_index: int) -> int: ... ``` ## Possible Values ```text 0 # Unknown1 # Signature2 # Document3 # User4 # Local5 # Online ``` ## Default Value 0 ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. The *ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [ocsp_count](#ocsp_count-property) property. This property is read-only. # offline_mode property Switches the class to offline mode. ## Syntax ```text def get_offline_mode() -> bool: ... def set_offline_mode(value: bool) -> None: ... offline_mode = property(get_offline_mode, set_offline_mode) ``` ## Default Value FALSE ## Remarks When working in offline mode, the class 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. # output_bytes property Use this property to read the output the class object has produced. ## Syntax ```text def get_output_bytes() -> bytes: ... output_bytes = property(get_output_bytes, None) ``` ## Remarks Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the [output_file](#output_file-property) and output_stream properties had not been assigned. This property is read-only. # output_file property The file to save the signed or updated document to. ## Syntax ```text def get_output_file() -> str: ... def set_output_file(value: str) -> None: ... output_file = property(get_output_file, set_output_file) ``` ## Default Value "" ## Remarks Use this property to provide a path where the resulting PDF document should be saved to. # page_count property The number of records in the Page arrays. ## Syntax ```text def get_page_count() -> int: ... page_count = property(get_page_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [page_crop_llx](#page_crop_llx-property) - [page_crop_lly](#page_crop_lly-property) - [page_crop_urx](#page_crop_urx-property) - [page_crop_ury](#page_crop_ury-property) - [page_height](#page_height-property) - [page_media_llx](#page_media_llx-property) - [page_media_lly](#page_media_lly-property) - [page_media_urx](#page_media_urx-property) - [page_media_ury](#page_media_ury-property) - [page_rotate](#page_rotate-property) - [page_width](#page_width-property) The array indices start at *0* and end at *page_count - 1*. This property is read-only. # page_crop_llx property Specifies the lower-left X coordinate of the page crop area. ## Syntax ```text def get_page_crop_llx(page_index: int) -> int: ... ``` ## 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 *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_crop_lly property Specifies the lower-left Y coordinate of the page crop area. ## Syntax ```text def get_page_crop_lly(page_index: int) -> int: ... ``` ## 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 *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_crop_urx property Specifies the upper-right X coordinate of the page crop area. ## Syntax ```text def get_page_crop_urx(page_index: int) -> int: ... ``` ## 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 *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_crop_ury property Specifies the upper-right Y coordinate of the page crop area. ## Syntax ```text def get_page_crop_ury(page_index: int) -> int: ... ``` ## 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 *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_height property Specifies the height of the page. ## Syntax ```text def get_page_height(page_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Specifies the height of the page. Returns the height of the page. The *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_media_llx property Specifies the lower-left X coordinate of the page media area. ## Syntax ```text def get_page_media_llx(page_index: int) -> int: ... ``` ## 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 *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_media_lly property Specifies the lower-left Y coordinate of the page media area. ## Syntax ```text def get_page_media_lly(page_index: int) -> int: ... ``` ## 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 *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_media_urx property Specifies the upper-right X coordinate of the page media area. ## Syntax ```text def get_page_media_urx(page_index: int) -> int: ... ``` ## 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 *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_media_ury property Specifies the upper-right Y coordinate of the page media area. ## Syntax ```text def get_page_media_ury(page_index: int) -> int: ... ``` ## 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 *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_rotate property Specifies the rotation angle of the page in degrees. ## Syntax ```text def get_page_rotate(page_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Specifies the rotation angle of the page in degrees. Values of 0, 90, 180, and 270 are allowed. The *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # page_width property Specifies the width of the page. ## Syntax ```text def get_page_width(page_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Specifies the width of the page. Returns the width of the page. The *page_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [page_count](#page_count-property) property. This property is read-only. # password property The decryption password. ## Syntax ```text def get_password() -> str: ... def set_password(value: str) -> None: ... password = property(get_password, set_password) ``` ## Default Value "" ## Remarks Use this property to provide the decryption password. # profile property Specifies a pre-defined profile to apply when creating the signature. ## Syntax ```text def get_profile() -> str: ... def set_profile(value: str) -> None: ... profile = property(get_profile, set_profile) ``` ## 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. # proxy_address property The IP address of the proxy server. ## Syntax ```text def get_proxy_address() -> str: ... def set_proxy_address(value: str) -> None: ... proxy_address = property(get_proxy_address, set_proxy_address) ``` ## Default Value "" ## Remarks The IP address of the proxy server. # proxy_authentication property The authentication type used by the proxy server. ## Syntax ```text def get_proxy_authentication() -> int: ... def set_proxy_authentication(value: int) -> None: ... proxy_authentication = property(get_proxy_authentication, set_proxy_authentication) ``` ## Possible Values ```text 0 # NoAuthentication1 # Basic2 # Digest3 # NTLM ``` ## Default Value 0 ## Remarks The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | # proxy_password property The password to authenticate to the proxy server. ## Syntax ```text def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ... proxy_password = property(get_proxy_password, set_proxy_password) ``` ## Default Value "" ## Remarks The password to authenticate to the proxy server. # proxy_port property The port on the proxy server to connect to. ## Syntax ```text def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ... proxy_port = property(get_proxy_port, set_proxy_port) ``` ## Default Value 0 ## Remarks The port on the proxy server to connect to. # proxy_type property The type of the proxy server. ## Syntax ```text def get_proxy_type() -> int: ... def set_proxy_type(value: int) -> None: ... proxy_type = property(get_proxy_type, set_proxy_type) ``` ## Possible Values ```text 0 # None1 # Socks42 # Socks53 # WebTunnel4 # HTTP ``` ## Default Value 0 ## Remarks The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | # proxy_request_headers property Contains HTTP request headers for WebTunnel and HTTP proxy. ## Syntax ```text def get_proxy_request_headers() -> str: ... def set_proxy_request_headers(value: str) -> None: ... proxy_request_headers = property(get_proxy_request_headers, set_proxy_request_headers) ``` ## Default Value "" ## Remarks Contains HTTP request headers for WebTunnel and HTTP proxy. # proxy_response_body property Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Syntax ```text def get_proxy_response_body() -> str: ... def set_proxy_response_body(value: str) -> None: ... proxy_response_body = property(get_proxy_response_body, set_proxy_response_body) ``` ## Default Value "" ## Remarks Contains the HTTP or HTTPS (WebTunnel) proxy response body. # proxy_response_headers property Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Syntax ```text def get_proxy_response_headers() -> str: ... def set_proxy_response_headers(value: str) -> None: ... proxy_response_headers = property(get_proxy_response_headers, set_proxy_response_headers) ``` ## Default Value "" ## Remarks Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. # proxy_use_ipv6 property Specifies whether IPv6 should be used when connecting through the proxy. ## Syntax ```text def get_proxy_use_ipv6() -> bool: ... def set_proxy_use_ipv6(value: bool) -> None: ... proxy_use_ipv6 = property(get_proxy_use_ipv6, set_proxy_use_ipv6) ``` ## Default Value FALSE ## Remarks Specifies whether IPv6 should be used when connecting through the proxy. # proxy_username property Specifies the username credential for proxy authentication. ## Syntax ```text def get_proxy_username() -> str: ... def set_proxy_username(value: str) -> None: ... proxy_username = property(get_proxy_username, set_proxy_username) ``` ## Default Value "" ## Remarks Specifies the username credential for proxy authentication. # revocation_check property Specifies the kind(s) of revocation check to perform for all chain certificates. ## Syntax ```text def get_revocation_check() -> int: ... def set_revocation_check(value: int) -> None: ... revocation_check = property(get_revocation_check, set_revocation_check) ``` ## Possible Values ```text 0 # None1 # Auto2 # AllCRL3 # AllOCSP4 # AllCRLAndOCSP5 # AnyCRL6 # AnyOCSP7 # AnyCRLOrOCSP8 # AnyOCSPOrCRL ``` ## Default Value 1 ## Remarks Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. # signature_count property The number of records in the Signature arrays. ## Syntax ```text def get_signature_count() -> int: ... signature_count = property(get_signature_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [signature_allowed_changes](#signature_allowed_changes-property) - [signature_author_name](#signature_author_name-property) - [signature_bytes](#signature_bytes-property) - [signature_certification](#signature_certification-property) - [signature_chain_validation_details](#signature_chain_validation_details-property) - [signature_chain_validation_result](#signature_chain_validation_result-property) - [signature_claimed_signing_time](#signature_claimed_signing_time-property) - [signature_compatibility_errors](#signature_compatibility_errors-property) - [signature_contact_info](#signature_contact_info-property) - [signature_contains_long_term_info](#signature_contains_long_term_info-property) - [signature_coverage_ends_at](#signature_coverage_ends_at-property) - [signature_custom_data](#signature_custom_data-property) - [signature_empty_field](#signature_empty_field-property) - [signature_entity_label](#signature_entity_label-property) - [signature_filter_name](#signature_filter_name-property) - [signature_full_signature_name](#signature_full_signature_name-property) - [signature_handle](#signature_handle-property) - [signature_hash_algorithm](#signature_hash_algorithm-property) - [signature_height](#signature_height-property) - [signature_issuer_rdn](#signature_issuer_rdn-property) - [signature_level](#signature_level-property) - [signature_location](#signature_location-property) - [signature_name](#signature_name-property) - [signature_offset_x](#signature_offset_x-property) - [signature_offset_y](#signature_offset_y-property) - [signature_page](#signature_page-property) - [signature_policy_hash](#signature_policy_hash-property) - [signature_policy_hash_algorithm](#signature_policy_hash_algorithm-property) - [signature_policy_id](#signature_policy_id-property) - [signature_policy_uri](#signature_policy_uri-property) - [signature_reason](#signature_reason-property) - [signature_serial_number](#signature_serial_number-property) - [signature_subject_key_id](#signature_subject_key_id-property) - [signature_subject_rdn](#signature_subject_rdn-property) - [signature_timestamped](#signature_timestamped-property) - [signature_type](#signature_type-property) - [signature_validated_signing_time](#signature_validated_signing_time-property) - [signature_validation_log](#signature_validation_log-property) - [signature_validation_result](#signature_validation_result-property) - [signature_width](#signature_width-property) The array indices start at *0* and end at *signature_count - 1*. This property is read-only. # signature_allowed_changes property The changes to the document allowed by the signature. ## Syntax ```text def get_signature_allowed_changes(signature_index: int) -> int: ... ``` ## Possible Values ```text 0 # None1 # FillInForms2 # Comment3 # 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_author_name property A human-readable signer name. ## Syntax ```text def get_signature_author_name(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks A human-readable signer name. This is a PDF document property. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_certification property Specifies whether this is a Certification (MDP) signature. ## Syntax ```text def get_signature_certification(signature_index: int) -> bool: ... ``` ## 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](#signature_allowed_changes-property) 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_chain_validation_details property The details of a certificate chain validation outcome. ## Syntax ```text def get_signature_chain_validation_details(signature_index: int) -> int: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_chain_validation_result property The outcome of a certificate chain validation routine. ## Syntax ```text def get_signature_chain_validation_result(signature_index: int) -> int: ... ``` ## Possible Values ```text 0 # Valid1 # ValidButUntrusted2 # Invalid3 # CantBeEstablished ``` ## Default Value 0 ## Remarks The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_claimed_signing_time property Returns or sets the signature's creation time. ## Syntax ```text def get_signature_claimed_signing_time(signature_index: int) -> str: ... ``` ## 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](#signature_validated_signing_time-property), 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_compatibility_errors property Returns compatibility errors encountered during validation. ## Syntax ```text def get_signature_compatibility_errors(signature_index: int) -> int: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_contact_info property Contains the signer's contact information. ## Syntax ```text def get_signature_contact_info(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the signer's contact information. This is a PDF document property. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_contains_long_term_info property Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). ## Syntax ```text def get_signature_contains_long_term_info(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_coverage_ends_at property Indicates the byte offset in the PDF file where signature coverage ends. ## Syntax ```text def get_signature_coverage_ends_at(signature_index: int) -> int: ... ``` ## 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](#get_signed_version-method) method of the PDFVerifier class to extract the exact revision that was signed. A value of **-1** indicates that the component could not determine the coverage offset. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_custom_data property Uninterpreted custom data to save with the PDF signature. ## Syntax ```text def get_signature_custom_data(signature_index: int) -> bytes: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_empty_field property Indicates whether the signature is created as an empty property (a signature placeholder). ## Syntax ```text def get_signature_empty_field(signature_index: int) -> bool: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_entity_label property Use this property to get the signature entity label. ## Syntax ```text def get_signature_entity_label(signature_index: int) -> str: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_filter_name property Specifies the PDF security handler filter name to use when creating a new signature. ## Syntax ```text def get_signature_filter_name(signature_index: int) -> str: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_full_signature_name property Specifies the full name of the signature property. ## Syntax ```text def get_signature_full_signature_name(signature_index: int) -> str: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_signature_handle(signature_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_hash_algorithm property Specifies the hash algorithm to be used for signing. ## Syntax ```text def get_signature_hash_algorithm(signature_index: int) -> str: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_height property Specifies the height of the signature widget. ## Syntax ```text def get_signature_height(signature_index: int) -> int: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_issuer_rdn property The Relative Distinguished Name of the signing certificate's issuer. ## Syntax ```text def get_signature_issuer_rdn(signature_index: int) -> str: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_level property Specifies the PAdES signature level. ## Syntax ```text def get_signature_level(signature_index: int) -> int: ... ``` ## Possible Values ```text 0 # Unknown1 # Generic2 # BaselineB3 # BaselineT4 # BaselineLT5 # BaselineLTA6 # BES7 # EPES8 # 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_id-property), [signature_policy_hash_algorithm](#signature_policy_hash_algorithm-property), and [signature_policy_hash](#signature_policy_hash-property). 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_location property Specifies the host name or the physical location of the signing entity. ## Syntax ```text def get_signature_location(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the host name or the physical location of the signing entity. This is a PDF property. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_offset_x property Specifies the signature widget offset from the left-hand page border. ## Syntax ```text def get_signature_offset_x(signature_index: int) -> int: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_offset_y property Specifies the signature widget offset from the bottom page border. ## Syntax ```text def get_signature_offset_y(signature_index: int) -> int: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_page property Indicates the index of the page on which the signature is placed. ## Syntax ```text def get_signature_page(signature_index: int) -> int: ... ``` ## Default Value -1 ## Remarks Indicates the index of the page on which the signature is placed. The value "-1" indicates an invisible signature. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_policy_hash property The signature policy hash value for EPES signatures. ## Syntax ```text def get_signature_policy_hash(signature_index: int) -> str: ... ``` ## 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](#signature_policy_id-property) and [signature_policy_hash_algorithm](#signature_policy_hash_algorithm-property), when creating a **paslEPES** signature. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_policy_hash_algorithm property The algorithm that was used to calculate the signature policy hash. ## Syntax ```text def get_signature_policy_hash_algorithm(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks The algorithm that was used to calculate the signature policy hash. This property must be set, together with [signature_policy_id](#signature_policy_id-property) and [signature_policy_hash](#signature_policy_hash-property), when creating a **paslEPES** signature. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_policy_id property The policy ID to be included in the signature. ## Syntax ```text def get_signature_policy_id(signature_index: int) -> str: ... ``` ## 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](#signature_policy_hash_algorithm-property) and [signature_policy_hash](#signature_policy_hash-property), when creating a **paslEPES** signature. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_policy_uri property The signature policy URI that was included in the signature. ## Syntax ```text def get_signature_policy_uri(signature_index: int) -> str: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_reason property Specifies the reason for signing. ## Syntax ```text def get_signature_reason(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the reason for signing. This is a PDF document property. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_serial_number property The serial number of the signing certificate that created the signature. ## Syntax ```text def get_signature_serial_number(signature_index: int) -> bytes: ... ``` ## Remarks The serial number of the signing certificate that created the signature. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_bytes property Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures. ## Syntax ```text def get_signature_bytes(signature_index: int) -> bytes: ... ``` ## Remarks Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_name property Specifies the unique signature identifier to use. ## Syntax ```text def get_signature_name(signature_index: int) -> str: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_type property The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown. ## Syntax ```text def get_signature_type(signature_index: int) -> int: ... ``` ## Possible Values ```text 0 # Unknown1 # Legacy2 # PAdES3 # 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](#signature_level-property) 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_validation_result property The outcome of the cryptographic signature validation. ## Syntax ```text def get_signature_validation_result(signature_index: int) -> int: ... ``` ## Possible Values ```text 0 # Valid1 # Unknown2 # Corrupted3 # SignerNotFound4 # Failure5 # ReferenceCorrupted ``` ## Default Value 0 ## Remarks The outcome of the cryptographic signature validation. The following signature validity values are supported: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_subject_key_id property Contains the subject key identifier of the signing certificate. ## Syntax ```text def get_signature_subject_key_id(signature_index: int) -> bytes: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_subject_rdn property Contains the RDN of the owner of the signing certificate. ## Syntax ```text def get_signature_subject_rdn(signature_index: int) -> str: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_timestamped property Use this property to establish whether the signature contains an embedded timestamp. ## Syntax ```text def get_signature_timestamped(signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Use this property to establish whether the signature contains an embedded timestamp. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_validated_signing_time property Contains the certified signing time. ## Syntax ```text def get_signature_validated_signing_time(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the certified signing time. Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature. [signature_claimed_signing_time](#signature_claimed_signing_time-property) returns a non-trusted signing time from the signer's computer. Both times are in UTC. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_validation_log property Contains the signing certificate's chain validation log. ## Syntax ```text def get_signature_validation_log(signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures. The *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # signature_width property Specifies the width of the signature widget. ## Syntax ```text def get_signature_width(signature_index: int) -> int: ... ``` ## 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 *signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signature_count](#signature_count-property) property. This property is read-only. # socket_dns_mode property Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. ## Syntax ```text def get_socket_dns_mode() -> int: ... def set_socket_dns_mode(value: int) -> None: ... socket_dns_mode = property(get_socket_dns_mode, set_socket_dns_mode) ``` ## Possible Values ```text 0 # Auto1 # Platform2 # Own3 # OwnSecure ``` ## Default Value 0 ## Remarks Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | | | --- | --- | | dmAuto | 0 | | dmPlatform | 1 | | dmOwn | 2 | | dmOwnSecure | 3 | # socket_dns_port property Specifies the port number to be used for sending queries to the DNS server. ## Syntax ```text def get_socket_dns_port() -> int: ... def set_socket_dns_port(value: int) -> None: ... socket_dns_port = property(get_socket_dns_port, set_socket_dns_port) ``` ## Default Value 0 ## Remarks Specifies the port number to be used for sending queries to the DNS server. # socket_dns_query_timeout property The timeout (in milliseconds) for each DNS query. ## Syntax ```text def get_socket_dns_query_timeout() -> int: ... def set_socket_dns_query_timeout(value: int) -> None: ... socket_dns_query_timeout = property(get_socket_dns_query_timeout, set_socket_dns_query_timeout) ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. # socket_dns_servers property The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Syntax ```text def get_socket_dns_servers() -> str: ... def set_socket_dns_servers(value: str) -> None: ... socket_dns_servers = property(get_socket_dns_servers, set_socket_dns_servers) ``` ## Default Value "" ## Remarks The addresses of DNS servers to use for address resolution, separated by commas or semicolons. # socket_dns_total_timeout property The timeout (in milliseconds) for the whole resolution process. ## Syntax ```text def get_socket_dns_total_timeout() -> int: ... def set_socket_dns_total_timeout(value: int) -> None: ... socket_dns_total_timeout = property(get_socket_dns_total_timeout, set_socket_dns_total_timeout) ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. # socket_incoming_speed_limit property The maximum number of bytes to read from the socket, per second. ## Syntax ```text def get_socket_incoming_speed_limit() -> int: ... def set_socket_incoming_speed_limit(value: int) -> None: ... socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit) ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. # socket_local_address property The local network interface to bind the socket to. ## Syntax ```text def get_socket_local_address() -> str: ... def set_socket_local_address(value: str) -> None: ... socket_local_address = property(get_socket_local_address, set_socket_local_address) ``` ## Default Value "" ## Remarks The local network interface to bind the socket to. # socket_local_port property The local port number to bind the socket to. ## Syntax ```text def get_socket_local_port() -> int: ... def set_socket_local_port(value: int) -> None: ... socket_local_port = property(get_socket_local_port, set_socket_local_port) ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. # socket_outgoing_speed_limit property The maximum number of bytes to write to the socket, per second. ## Syntax ```text def get_socket_outgoing_speed_limit() -> int: ... def set_socket_outgoing_speed_limit(value: int) -> None: ... socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit) ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. # socket_timeout property The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax ```text def get_socket_timeout() -> int: ... def set_socket_timeout(value: int) -> None: ... socket_timeout = property(get_socket_timeout, set_socket_timeout) ``` ## 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). # socket_use_ipv6 property Enables or disables IP protocol version 6. ## Syntax ```text def get_socket_use_ipv6() -> bool: ... def set_socket_use_ipv6(value: bool) -> None: ... socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6) ``` ## Default Value FALSE ## Remarks Enables or disables IP protocol version 6. # timestamp_count property The number of records in the Timestamp arrays. ## Syntax ```text def get_timestamp_count() -> int: ... timestamp_count = property(get_timestamp_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [timestamp_accuracy](#timestamp_accuracy-property) - [timestamp_bytes](#timestamp_bytes-property) - [timestamp_certificate_index](#timestamp_certificate_index-property) - [timestamp_chain_validation_details](#timestamp_chain_validation_details-property) - [timestamp_chain_validation_result](#timestamp_chain_validation_result-property) - [timestamp_contains_long_term_info](#timestamp_contains_long_term_info-property) - [timestamp_entity_label](#timestamp_entity_label-property) - [timestamp_hash_algorithm](#timestamp_hash_algorithm-property) - [timestamp_parent_entity](#timestamp_parent_entity-property) - [timestamp_serial_number](#timestamp_serial_number-property) - [timestamp_time](#timestamp_time-property) - [timestamp_tsa_name](#timestamp_tsa_name-property) - [timestamp_type](#timestamp_type-property) - [timestamp_validation_log](#timestamp_validation_log-property) - [timestamp_validation_result](#timestamp_validation_result-property) The array indices start at *0* and end at *timestamp_count - 1*. This property is read-only. # timestamp_accuracy property This property indicates the accuracy of the included time mark, in microseconds. ## Syntax ```text def get_timestamp_accuracy(timestamp_index: int) -> int: ... ``` ## Default Value 0 ## Remarks This field indicates the accuracy of the included time mark, in microseconds. The *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_bytes property Returns the raw timestamp data in DER format. ## Syntax ```text def get_timestamp_bytes(timestamp_index: int) -> bytes: ... ``` ## Remarks Returns the raw timestamp data in DER format. The *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_certificate_index property Returns the index of the TSA certificate in the Certificates collection. ## Syntax ```text def get_timestamp_certificate_index(timestamp_index: int) -> int: ... ``` ## 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 *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_chain_validation_details property The details of a certificate chain validation outcome. ## Syntax ```text def get_timestamp_chain_validation_details(timestamp_index: int) -> int: ... ``` ## 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 *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_chain_validation_result property The outcome of a certificate chain validation routine. ## Syntax ```text def get_timestamp_chain_validation_result(timestamp_index: int) -> int: ... ``` ## Possible Values ```text 0 # Valid1 # ValidButUntrusted2 # Invalid3 # CantBeEstablished ``` ## Default Value 0 ## Remarks The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. The *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_contains_long_term_info property Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). ## Syntax ```text def get_timestamp_contains_long_term_info(timestamp_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). The *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_entity_label property Use this property to get the timestamp entity label. ## Syntax ```text def get_timestamp_entity_label(timestamp_index: int) -> str: ... ``` ## 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 *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_hash_algorithm property Returns the timestamp's hash algorithm. ## Syntax ```text def get_timestamp_hash_algorithm(timestamp_index: int) -> str: ... ``` ## 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 *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_parent_entity property Use this property to get the label of the timestamp's parent entity. ## Syntax ```text def get_timestamp_parent_entity(timestamp_index: int) -> str: ... ``` ## 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 *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_serial_number property Returns the timestamp's serial number. ## Syntax ```text def get_timestamp_serial_number(timestamp_index: int) -> bytes: ... ``` ## Remarks Returns the timestamp's serial number. The *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_time property The time point incorporated into the timestamp. ## Syntax ```text def get_timestamp_time(timestamp_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point incorporated into the timestamp. The *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_type property Returns the type of the timestamp. ## Syntax ```text def get_timestamp_type(timestamp_index: int) -> int: ... ``` ## 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 *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_tsa_name property This value uniquely identifies the Timestamp Authority (TSA). ## Syntax ```text def get_timestamp_tsa_name(timestamp_index: int) -> str: ... ``` ## Default Value "" ## Remarks This value uniquely identifies the Timestamp Authority (TSA). This property provides information about the entity that manages the TSA. The *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_validation_log property Contains the TSA certificate chain validation log. ## Syntax ```text def get_timestamp_validation_log(timestamp_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails. The *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # timestamp_validation_result property Contains the timestamp validation outcome. ## Syntax ```text def get_timestamp_validation_result(timestamp_index: int) -> int: ... ``` ## Possible Values ```text 0 # Valid1 # Unknown2 # Corrupted3 # SignerNotFound4 # Failure5 # ReferenceCorrupted ``` ## Default Value 0 ## Remarks Contains the timestamp validation outcome. Use this property to check the result of the most recent timestamp validation. | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | The *timestamp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [timestamp_count](#timestamp_count-property) property. This property is read-only. # tls_auto_validate_certificates property Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax ```text def get_tls_auto_validate_certificates() -> bool: ... def set_tls_auto_validate_certificates(value: bool) -> None: ... tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates) ``` ## Default Value TRUE ## Remarks Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. # tls_base_configuration property Selects the base configuration for the TLS settings. ## Syntax ```text def get_tls_base_configuration() -> int: ... def set_tls_base_configuration(value: int) -> None: ... tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration) ``` ## Possible Values ```text 0 # Default1 # Compatible2 # ComprehensiveInsecure3 # HighlySecure ``` ## Default Value 0 ## Remarks Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | # tls_ciphersuites property A list of ciphersuites separated with commas or semicolons. ## Syntax ```text def get_tls_ciphersuites() -> str: ... def set_tls_ciphersuites(value: str) -> None: ... tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites) ``` ## Default Value "" ## Remarks A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [tls_base_configuration](#tls_base_configuration-property). 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 # tls_client_auth property Enables or disables certificate-based client authentication. ## Syntax ```text def get_tls_client_auth() -> int: ... def set_tls_client_auth(value: int) -> None: ... tls_client_auth = property(get_tls_client_auth, set_tls_client_auth) ``` ## Possible Values ```text 0 # NoAuth1 # RequestCert2 # RequireCert ``` ## Default Value 0 ## Remarks Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | # tls_extensions property Provides access to TLS extensions. ## Syntax ```text def get_tls_extensions() -> str: ... def set_tls_extensions(value: str) -> None: ... tls_extensions = property(get_tls_extensions, set_tls_extensions) ``` ## Default Value "" ## Remarks Provides access to TLS extensions. # tls_force_resume_if_destination_changes property Whether to force TLS session resumption when the destination address changes. ## Syntax ```text def get_tls_force_resume_if_destination_changes() -> bool: ... def set_tls_force_resume_if_destination_changes(value: bool) -> None: ... tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes) ``` ## Default Value FALSE ## Remarks Whether to force TLS session resumption when the destination address changes. # tls_groups property Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax ```text def get_tls_groups() -> str: ... def set_tls_groups(value: str) -> None: ... tls_groups = property(get_tls_groups, set_tls_groups) ``` ## Default Value "" ## Remarks Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. # tls_pre_shared_identity property Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax ```text def get_tls_pre_shared_identity() -> str: ... def set_tls_pre_shared_identity(value: str) -> None: ... tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity) ``` ## Default Value "" ## Remarks Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. # tls_pre_shared_key property Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Syntax ```text def get_tls_pre_shared_key() -> str: ... def set_tls_pre_shared_key(value: str) -> None: ... tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key) ``` ## Default Value "" ## Remarks Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. # tls_pre_shared_key_ciphersuite property Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Syntax ```text def get_tls_pre_shared_key_ciphersuite() -> str: ... def set_tls_pre_shared_key_ciphersuite(value: str) -> None: ... tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite) ``` ## Default Value "" ## Remarks Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. # tls_renegotiation_attack_prevention_mode property Selects the renegotiation attack prevention mechanism. ## Syntax ```text def get_tls_renegotiation_attack_prevention_mode() -> int: ... def set_tls_renegotiation_attack_prevention_mode(value: int) -> None: ... tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode) ``` ## Possible Values ```text 0 # Compatible1 # Strict2 # Auto ``` ## Default Value 2 ## Remarks Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | # tls_revocation_check property Specifies the kind(s) of revocation check to perform. ## Syntax ```text def get_tls_revocation_check() -> int: ... def set_tls_revocation_check(value: int) -> None: ... tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check) ``` ## Possible Values ```text 0 # None1 # Auto2 # AllCRL3 # AllOCSP4 # AllCRLAndOCSP5 # AnyCRL6 # AnyOCSP7 # AnyCRLOrOCSP8 # AnyOCSPOrCRL ``` ## Default Value 1 ## Remarks Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. # tls_ssl_options property 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 ```text def get_tls_ssl_options() -> int: ... def set_tls_ssl_options(value: int) -> None: ... tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options) ``` ## 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 | # tls_mode property Specifies the TLS mode to use. ## Syntax ```text def get_tls_mode() -> int: ... def set_tls_mode(value: int) -> None: ... tls_mode = property(get_tls_mode, set_tls_mode) ``` ## Possible Values ```text 0 # Default1 # NoTLS2 # ExplicitTLS3 # ImplicitTLS4 # MixedTLS ``` ## Default Value 0 ## Remarks Specifies the TLS mode to use. | | | | | --- | --- | --- | | smDefault | 0 | | | smNoTLS | 1 | Do not use TLS | | smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. | | smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. | | smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. | # tls_use_extended_master_secret property Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax ```text def get_tls_use_extended_master_secret() -> bool: ... def set_tls_use_extended_master_secret(value: bool) -> None: ... tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret) ``` ## Default Value TRUE ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. # tls_use_session_resumption property Enables or disables the TLS session resumption capability. ## Syntax ```text def get_tls_use_session_resumption() -> bool: ... def set_tls_use_session_resumption(value: bool) -> None: ... tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption) ``` ## Default Value FALSE ## Remarks Enables or disables the TLS session resumption capability. # tls_versions property The SSL/TLS versions to enable by default. ## Syntax ```text def get_tls_versions() -> int: ... def set_tls_versions(value: int) -> None: ... tls_versions = property(get_tls_versions, set_tls_versions) ``` ## 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 | # tls_client_cert_count property The number of records in the TLSClientCert arrays. ## Syntax ```text def get_tls_client_cert_count() -> int: ... def set_tls_client_cert_count(value: int) -> None: ... tls_client_cert_count = property(get_tls_client_cert_count, set_tls_client_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [tls_client_cert_bytes](#tls_client_cert_bytes-property) - [tls_client_cert_handle](#tls_client_cert_handle-property) The array indices start at *0* and end at *tls_client_cert_count - 1*. # tls_client_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_tls_client_cert_bytes(tls_client_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *tls_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_client_cert_count](#tls_client_cert_count-property) property. This property is read-only. # tls_client_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_tls_client_cert_handle(tls_client_cert_index: int) -> int: ... def set_tls_client_cert_handle(tls_client_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *tls_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_client_cert_count](#tls_client_cert_count-property) property. # tls_server_cert_count property The number of records in the TLSServerCert arrays. ## Syntax ```text def get_tls_server_cert_count() -> int: ... tls_server_cert_count = property(get_tls_server_cert_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [tls_server_cert_bytes](#tls_server_cert_bytes-property) - [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property) - [tls_server_cert_handle](#tls_server_cert_handle-property) - [tls_server_cert_issuer](#tls_server_cert_issuer-property) - [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property) - [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property) - [tls_server_cert_key_bits](#tls_server_cert_key_bits-property) - [tls_server_cert_key_usage](#tls_server_cert_key_usage-property) - [tls_server_cert_self_signed](#tls_server_cert_self_signed-property) - [tls_server_cert_serial_number](#tls_server_cert_serial_number-property) - [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property) - [tls_server_cert_subject](#tls_server_cert_subject-property) - [tls_server_cert_subject_rdn](#tls_server_cert_subject_rdn-property) - [tls_server_cert_valid_from](#tls_server_cert_valid_from-property) - [tls_server_cert_valid_to](#tls_server_cert_valid_to-property) The array indices start at *0* and end at *tls_server_cert_count - 1*. This property is read-only. # tls_server_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_tls_server_cert_bytes(tls_server_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_fingerprint property Contains the fingerprint (a hash imprint) of this certificate. ## Syntax ```text def get_tls_server_cert_fingerprint(tls_server_cert_index: int) -> str: ... ``` ## 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 *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_tls_server_cert_handle(tls_server_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_issuer property The common name of the certificate issuer (CA), typically a company name. ## Syntax ```text def get_tls_server_cert_issuer(tls_server_cert_index: int) -> str: ... ``` ## 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](#PDFVerifier_p_TLSIssuerRDN). The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_issuer_rdn property A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax ```text def get_tls_server_cert_issuer_rdn(tls_server_cert_index: int) -> str: ... ``` ## 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 *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_key_algorithm property Specifies the public key algorithm of this certificate. ## Syntax ```text def get_tls_server_cert_key_algorithm(tls_server_cert_index: int) -> str: ... ``` ## 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](#PDFVerifier_p_TLSKeyBits), [tls_curve](#PDFVerifier_p_TLSCurve), and [tls_public_key_bytes](#PDFVerifier_p_TLSPublicKeyBytes) properties to get more details about the key the certificate contains. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_key_bits property Returns the length of the public key in bits. ## Syntax ```text def get_tls_server_cert_key_bits(tls_server_cert_index: int) -> int: ... ``` ## 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](#PDFVerifier_p_TLSPublicKeyBytes) or [tls_private_key_bytes](#PDFVerifier_p_TLSPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_key_usage property Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax ```text def get_tls_server_cert_key_usage(tls_server_cert_index: int) -> int: ... ``` ## 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 *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_self_signed property Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax ```text def get_tls_server_cert_self_signed(tls_server_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_serial_number property Returns the certificate's serial number. ## Syntax ```text def get_tls_server_cert_serial_number(tls_server_cert_index: int) -> bytes: ... ``` ## 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 *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_sig_algorithm property Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax ```text def get_tls_server_cert_sig_algorithm(tls_server_cert_index: int) -> str: ... ``` ## 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 *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_subject property The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax ```text def get_tls_server_cert_subject(tls_server_cert_index: int) -> str: ... ``` ## 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](#PDFVerifier_p_TLSSubjectRDN). The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_subject_rdn property A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax ```text def get_tls_server_cert_subject_rdn(tls_server_cert_index: int) -> str: ... ``` ## 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 *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_valid_from property The time point at which the certificate becomes valid, in UTC. ## Syntax ```text def get_tls_server_cert_valid_from(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_valid_to property The time point at which the certificate expires, in UTC. ## Syntax ```text def get_tls_server_cert_valid_to(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # trusted_cert_count property The number of records in the TrustedCert arrays. ## Syntax ```text def get_trusted_cert_count() -> int: ... def set_trusted_cert_count(value: int) -> None: ... trusted_cert_count = property(get_trusted_cert_count, set_trusted_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [trusted_cert_bytes](#trusted_cert_bytes-property) - [trusted_cert_handle](#trusted_cert_handle-property) The array indices start at *0* and end at *trusted_cert_count - 1*. # trusted_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_trusted_cert_bytes(trusted_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_trusted_cert_handle(trusted_cert_index: int) -> int: ... def set_trusted_cert_handle(trusted_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. # validation_moment property The time point at which signature validity is to be established. ## Syntax ```text def get_validation_moment() -> str: ... def set_validation_moment(value: str) -> None: ... validation_moment = property(get_validation_moment, set_validation_moment) ``` ## 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. # close method Closes an opened document. ## Syntax ```text def close(save_changes: bool) -> None: ... ``` ## 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 Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#pdfverifier-config-settings) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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](#pdfverifier-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method Performs an additional action. ## Syntax ```text def do_action(action_id: str, action_params: str) -> str: ... ``` ## Remarks do_action is a generic method available in every class. 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 Saves a PDF attachment to a byte array. ## Syntax ```text def get_attached_bytes(index: int) -> bytes: ... ``` ## Remarks Use this method to retrieve the contents of an attached file as a byte array. # get_attached_file method Saves a PDF attachment to a file. ## Syntax ```text def get_attached_file(index: int, path: str) -> None: ... ``` ## Remarks Use this method to retrieve the contents of an attached file and save it to a file. # get_signed_version method Returns the part of the document that is covered by the signature. ## Syntax ```text def get_signed_version(sig_label: str) -> None: ... ``` ## 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 Opens a document for verifying or removing signatures. ## Syntax ```text def open(edit_mode: bool) -> None: ... ``` ## Remarks Use this method to open a document for verifying or removing signatures, or for extracting signed content. When finished, call [close](#close-method) 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 Resets the class settings. ## Syntax ```text def reset() -> None: ... ``` ## Remarks reset is a generic method available in every class. # revalidate method Revalidates a signature in accordance with current settings. ## Syntax ```text def revalidate(sig_label: str) -> None: ... ``` ## Remarks Use this method to revalidate a signature in the opened PDF document. # select_info method Select signature information for a specific entity. ## Syntax ```text def select_info(entity_label: str, info_type: int, clear_selection: bool) -> None: ... ``` ## 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 Deletes a signature from the document. ## Syntax ```text def unsign(sig_label: str, unsign_kind: int) -> None: ... ``` ## 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](#get_signed_version-method). 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](#get_signed_version-method) 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 Verifies a signed PDF document. ## Syntax ```text def verify() -> None: ... ``` ## 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](#on_signature_found-event) 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](#get_signed_version-method) or to ensure that the signature covers the expected document revision. # on_chain_element_download event Fires when there is a need to download a chain element from an online source. ## Syntax ```text class PDFVerifierChainElementDownloadEventParams(object): @property def kind() -> int: ... @property def cert_rdn() -> str: ... @property def ca_cert_rdn() -> str: ... @property def location() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class PDFVerifier: @property def on_chain_element_download() -> Callable[[PDFVerifierChainElementDownloadEventParams], None]: ... @on_chain_element_download.setter def on_chain_element_download(event_hook: Callable[[PDFVerifierChainElementDownloadEventParams], None]) -> None: ... ``` ## 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 Fires when an element required to validate the chain was not located. ## Syntax ```text class PDFVerifierChainElementNeededEventParams(object): @property def kind() -> int: ... @property def cert_rdn() -> str: ... @property def ca_cert_rdn() -> str: ... # In class PDFVerifier: @property def on_chain_element_needed() -> Callable[[PDFVerifierChainElementNeededEventParams], None]: ... @on_chain_element_needed.setter def on_chain_element_needed(event_hook: Callable[[PDFVerifierChainElementNeededEventParams], None]) -> None: ... ``` ## 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 Reports the completion of a certificate chain validation. ## Syntax ```text class PDFVerifierChainValidatedEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def subject_rdn() -> str: ... @property def validation_result() -> int: ... @property def validation_details() -> int: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFVerifier: @property def on_chain_validated() -> Callable[[PDFVerifierChainValidatedEventParams], None]: ... @on_chain_validated.setter def on_chain_validated(event_hook: Callable[[PDFVerifierChainValidatedEventParams], None]) -> None: ... ``` ## Remarks This event is fired when a certificate chain validation routine completes. *SubjectRDN* identifies the owner of the validated certificate. *ValidationResult* set to 0 (zero) indicates successful chain validation. | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Any other value reports a failure, and *ValidationDetails* provides more details on its reasons. | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | # on_chain_validation_progress event This event is fired multiple times during chain validation to report various stages of the validation procedure. ## Syntax ```text class PDFVerifierChainValidationProgressEventParams(object): @property def event_kind() -> str: ... @property def cert_rdn() -> str: ... @property def ca_cert_rdn() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class PDFVerifier: @property def on_chain_validation_progress() -> Callable[[PDFVerifierChainValidationProgressEventParams], None]: ... @on_chain_validation_progress.setter def on_chain_validation_progress(event_hook: Callable[[PDFVerifierChainValidationProgressEventParams], None]) -> None: ... ``` ## 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 This event is fired when the document has been loaded into memory. ## Syntax ```text class PDFVerifierDocumentLoadedEventParams(object): @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFVerifier: @property def on_document_loaded() -> Callable[[PDFVerifierDocumentLoadedEventParams], None]: ... @on_document_loaded.setter def on_document_loaded(event_hook: Callable[[PDFVerifierDocumentLoadedEventParams], None]) -> None: ... ``` ## 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 Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document. ## Syntax ```text class PDFVerifierEncryptedEventParams(object): @property def cert_used() -> bool: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def need_credential() -> bool: ... @property def skip_this() -> bool: ... @skip_this.setter def skip_this(value) -> None: ... # In class PDFVerifier: @property def on_encrypted() -> Callable[[PDFVerifierEncryptedEventParams], None]: ... @on_encrypted.setter def on_encrypted(event_hook: Callable[[PDFVerifierEncryptedEventParams], None]) -> None: ... ``` ## Remarks The class 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](#password-property) 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](#password-property) property. The *NeedCredential* parameter specifies whether the correct credential is already available to the class 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](#password-property) 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 Information about errors during signing/validation. ## Syntax ```text class PDFVerifierErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class PDFVerifier: @property def on_error() -> Callable[[PDFVerifierErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[PDFVerifierErrorEventParams], None]) -> None: ... ``` ## 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 This event notifies the application about an underlying control flow event. ## Syntax ```text class PDFVerifierNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class PDFVerifier: @property def on_notification() -> Callable[[PDFVerifierNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[PDFVerifierNotificationEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted. This class 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 class 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 Signifies the start of signature validation. ## Syntax ```text class PDFVerifierSignatureFoundEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def cert_found() -> bool: ... @property def validate_signature() -> bool: ... @validate_signature.setter def validate_signature(value) -> None: ... @property def validate_chain() -> bool: ... @validate_chain.setter def validate_chain(value) -> None: ... # In class PDFVerifier: @property def on_signature_found() -> Callable[[PDFVerifierSignatureFoundEventParams], None]: ... @on_signature_found.setter def on_signature_found(event_hook: Callable[[PDFVerifierSignatureFoundEventParams], None]) -> None: ... ``` ## 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 class 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 Marks the completion of the signature validation routine. ## Syntax ```text class PDFVerifierSignatureValidatedEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def validation_result() -> int: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFVerifier: @property def on_signature_validated() -> Callable[[PDFVerifierSignatureValidatedEventParams], None]: ... @on_signature_validated.setter def on_signature_validated(event_hook: Callable[[PDFVerifierSignatureValidatedEventParams], None]) -> None: ... ``` ## 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 Signifies the start of a timestamp validation routine. ## Syntax ```text class PDFVerifierTimestampFoundEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def cert_found() -> bool: ... @property def validate_timestamp() -> bool: ... @validate_timestamp.setter def validate_timestamp(value) -> None: ... @property def validate_chain() -> bool: ... @validate_chain.setter def validate_chain(value) -> None: ... # In class PDFVerifier: @property def on_timestamp_found() -> Callable[[PDFVerifierTimestampFoundEventParams], None]: ... @on_timestamp_found.setter def on_timestamp_found(event_hook: Callable[[PDFVerifierTimestampFoundEventParams], None]) -> None: ... ``` ## 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 class 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 Reports the completion of the timestamp validation routine. ## Syntax ```text class PDFVerifierTimestampValidatedEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def time() -> str: ... @property def validation_result() -> int: ... @property def chain_validation_result() -> int: ... @property def chain_validation_details() -> int: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFVerifier: @property def on_timestamp_validated() -> Callable[[PDFVerifierTimestampValidatedEventParams], None]: ... @on_timestamp_validated.setter def on_timestamp_validated(event_hook: Callable[[PDFVerifierTimestampValidatedEventParams], None]) -> None: ... ``` ## 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 Fires when a remote TLS party requests a client certificate. ## Syntax ```text class PDFVerifierTLSCertNeededEventParams(object): @property def host() -> str: ... @property def ca_names() -> str: ... # In class PDFVerifier: @property def on_tls_cert_needed() -> Callable[[PDFVerifierTLSCertNeededEventParams], None]: ... @on_tls_cert_needed.setter def on_tls_cert_needed(event_hook: Callable[[PDFVerifierTLSCertNeededEventParams], None]) -> None: ... ``` ## Remarks This event fires to notify the implementation that a remote TLS server has requested a client certificate. The *Host* parameter identifies the host that makes a request, and the *CANames* parameter (optional, according to the TLS spec) advises on the accepted issuing CAs. Use the tls_client_chain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire. This event is preceded by the [on_tls_handshake](#on_tls_handshake-event) event for the given host and, if the certificate was accepted, succeeded by the [on_tls_established](#on_tls_established-event) event. # on_tls_cert_validate event This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. ## Syntax ```text class PDFVerifierTLSCertValidateEventParams(object): @property def server_host() -> str: ... @property def server_ip() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class PDFVerifier: @property def on_tls_cert_validate() -> Callable[[PDFVerifierTLSCertValidateEventParams], None]: ... @on_tls_cert_validate.setter def on_tls_cert_validate(event_hook: Callable[[PDFVerifierTLSCertValidateEventParams], None]) -> None: ... ``` ## Remarks This event is fired during a TLS handshake. Use the tls_server_chain property to access the certificate chain. In general, classes 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 class, and can be adjusted if needed. # on_tls_established event Fires when a TLS handshake with Host successfully completes. ## Syntax ```text class PDFVerifierTLSEstablishedEventParams(object): @property def host() -> str: ... @property def version() -> str: ... @property def ciphersuite() -> str: ... @property def connection_id() -> bytes: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class PDFVerifier: @property def on_tls_established() -> Callable[[PDFVerifierTLSEstablishedEventParams], None]: ... @on_tls_established.setter def on_tls_established(event_hook: Callable[[PDFVerifierTLSEstablishedEventParams], None]) -> None: ... ``` ## Remarks The class 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 Fires when a new TLS handshake is initiated, before the handshake commences. ## Syntax ```text class PDFVerifierTLSHandshakeEventParams(object): @property def host() -> str: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class PDFVerifier: @property def on_tls_handshake() -> Callable[[PDFVerifierTLSHandshakeEventParams], None]: ... @on_tls_handshake.setter def on_tls_handshake(event_hook: Callable[[PDFVerifierTLSHandshakeEventParams], None]) -> None: ... ``` ## Remarks The class uses this event to notify the application about the start of a new TLS handshake to *Host*. If the handshake is successful, this event will be followed by the [on_tls_established](#on_tls_established-event) event. If the server chooses to request a client certificate, the [on_tls_cert_needed](#on_tls_cert_needed-event) event will also be fired. # on_tls_shutdown event Reports the graceful closure of a TLS connection. ## Syntax ```text class PDFVerifierTLSShutdownEventParams(object): @property def host() -> str: ... # In class PDFVerifier: @property def on_tls_shutdown() -> Callable[[PDFVerifierTLSShutdownEventParams], None]: ... @on_tls_shutdown.setter def on_tls_shutdown(event_hook: Callable[[PDFVerifierTLSShutdownEventParams], None]) -> None: ... ``` ## Remarks This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported. # PDFVerifier Config Settings The class 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 class, access to these *internal properties* is provided through the [config](#config-method) method. ### PDFVerifier Config Settings **AlternateName**: TBD.TBD **AsyncDocumentID**: Specifies the document ID for SignAsyncEnd() call.Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. **BuildApplicationName**: Specifies the application name used to create the signature.Use this property to set the application name used to create the signature. For advanced settings of the build properties, use the [BuildProperties](#BuildProperties) configuration setting. **BuildApplicationVersion**: Specifies the application version used to create the signature.Use this property to set the application version used to create the signature. For advanced settings of the build properties, use the [BuildProperties](#BuildProperties) configuration setting. **BuildProperties**: Specifies the build properties of the signature.Use this property to set the build properties of the signature in JSON format. Names of JSON fields correspond to the entry names in Adobe's Digital Signature Build Dictionary Specification. Sample value: ```text { "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](#BuildApplicationName) and [BuildApplicationVersion](#BuildApplicationVersion) configuration settings. Sample value 2: ```text { "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 } } ``` **CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched. The default value is 1 day (86400 seconds). A value of 0 disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched. The default value is 50 percent. Values are interpreted in the 0..100 range. A value of 0 disables the CRL ratio check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched. The default value is 10 minutes (600 seconds). A value of 0 disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them. **CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched. The default value is 1 hour (3600 seconds). A value of 0 disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched. The default value is 50 percent. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. A value of 0 disables the OCSP response ratio check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched. The default value is 10 minutes (600 seconds). A value of 0 disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them. **ChainCurrentCACert**: Returns the current CA certificate.This property returns the CA certificate that is used on the current step. **ChainCurrentCert**: Returns the certificate that is currently being validated.Use this property to obtain the body of the certificate that is currently being validated. **ChainCurrentCRL**: Returns the current CRL.Returns the CRL object that is currently being processed. **ChainCurrentCRLSize**: Returns the size of the current CRL.This property returns the size of the CRL object that is currently being processed. **ChainCurrentOCSP**: Returns the current OCSP response.Returns the OCSP object that is currently being processed. **ChainCurrentOCSPSigner**: Returns the signer of the current OCSP object.Returns the signer/CA that has issued the OCSP response that is currently being processed. **ChainInterimDetails**: Returns the current interim validation details.This property returns the interim chain validation details. **ChainInterimResult**: Returns the current interim validation result.Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes. **CheckValidityPeriodForTrusted**: Whether to check validity period for trusted certificates.Whether to check validity period for trusted certificates. **ConfigPreferLegacyLevels**: Indicates whether legacy signature levels should be preferred.Set this property to True to instruct the validation engine to prioritize legacy PAdES signature levels (BES, EPES, LTV) over Baseline levels (B-B, B-T, B-LT, B-LTA) when a signature can be determined as multiple levels. TBD **CustomSignedAttributes**: TBD.TBD **CustomTrustedLists**: Specifies the custom TrustedLists.Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated. **CustomTSLs**: Specifies the custom TrustedLists.Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated. **CustomUnsignedAttributes**: TBD.TBD **DeltaCRLPreference**: Specifies whether complete or delta CRLs are preferred.Use this setting to specify which CRL type should be preferred during revocation checks performed by the AdES component. The default value is **dcrlpPreferComplete** (1). Supported values: - **dcrlpPreferDelta** (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed. - **dcrlpPreferComplete** (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved. **DislikeOpenEndedOCSPs**: Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the class is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022). **DocumentVersion**: The document version from the PDF document header.This property contains the PDF document version provided in the document header. The version is returned in the form "Major.Minor": for example, PDF-1.7 will be returned as "1.7", and PDF-2.0 as "2.0". **DTSAccuracy**: Indicates the accuracy of the document timestamp.Use this property to get the accuracy of the document timestamp in microseconds. 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). **DTSSerialNumber**: Indicates the serial number of the document timestamp.Use this property to get the serial number of the document timestamp. 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). **DTSTime**: Indicates the time of the document timestamp.Use this property to get the time included in the document timestamp. 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). **DTSTSAName**: Indicates the TSA name of the document timestamp.Use this property to get the name of the timestamping authority that issued the document timestamp. 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). **EmptySignatureFieldAddRevInfo[Index]**: Specifies if revocation checking should be performed.This property contains True if the viewing application should check the signing certificate revocation info and include the revocation information within the signature value. **EmptySignatureFieldAlternateName[Index]**: Contains an alternate field name.This property contains an alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface. **EmptySignatureFieldCount**: The number of empty signature form fields.Returns the number of empty signature form fields available. NOTE: The information about empty signature fields is available when the PDF document is open. Read this setting either between [open](#open-method) and [close](#close-method) methods, or in [on_document_loaded](#on_document_loaded-event) event handler. **EmptySignatureFieldFlags[Index]**: The field flags of the signature form field.This property contains the empty signature form field flags ("Ff" entry in the signature field dictionary). **EmptySignatureFieldHeight[Index]**: The Height of the empty signature form field.This property contains the height of the empty signature form field. **EmptySignatureFieldInvisible[Index]**: The visibility status of the field.This property contains True if the empty signature form field is visible. **EmptySignatureFieldLegalAttestations[Index]**: Specifies the legal attestations that are associated with the signature.This property contains 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.This property contains the name to be used when exporting form field data from the document. **EmptySignatureFieldName[Index]**: Textual field name.This property contains the empty signature field name. **EmptySignatureFieldOffsetX[Index]**: The field's offset from the left page border.This property contains the horizontal offset of the empty signature form field. **EmptySignatureFieldOffsetY[Index]**: The field's offset from the bottom page border.This property contains the vertical offset of the empty signature form field. **EmptySignatureFieldPage[Index]**: The index of the form field's page in the document.This property contains the index of the empty signature form field's page in the document. **EmptySignatureFieldRequiredAllowedChanges[Index]**: Specifies the changes allowed by the signature.This property contains the changes that are allowed to the document when the signature field is signed. **EmptySignatureFieldRequiredConstraints[Index]**: Specifies the required Seed Value Dictionary (SVD) constraints.This property contains the required SVD constraints. If a certain bit in RequiredConstraints is switched on, the corresponding data item is constrained. **EmptySignatureFieldRequiredDigestAlgorithms[Index]**: Specifies the required digest algorithms.This property contains the list of the digest algorithms used for signature generation. **EmptySignatureFieldRequiredFilter[Index]**: Specifies the required filter.This property contains the required filter (name of the preferred signature handler) to use for signature generation. **EmptySignatureFieldRequiredLockAction[Index]**: Indicates which set of fields shall be locked.This property contains a set of form fields that shall be locked when the current signature field is signed. **EmptySignatureFieldRequiredLockFields[Index]**: Indicates the fields that shall be locked on signing.This property contains the list of form field names that shall be locked when the current signature field is signed. Whether this list shall be included or excluded is defined by the EmptySignatureFieldRequiredLockAction[Index] property. **EmptySignatureFieldRequiredReasons[Index]**: Specifies the required reasons.This property contains the required reasons used for signature generation. **EmptySignatureFieldRequiredSubfilters[Index]**: Specifies the required subfilters.This property contains the list of subfilters required by the signature. A subfilter represents the encoding to use when signing the PDF form. **EmptySignatureFieldTimestampRequired[Index]**: Specifies if the signature should be timestamped.This property contains True if the signature should be timestamped. **EmptySignatureFieldTSPURL[Index]**: URL for a TSP server.This property contains the TSP server URL. **EmptySignatureFieldWidth[Index]**: The Width of the empty signature form field.This property contains the width of the empty signature form field. **EnableOldSignatures**: Enables support for prehistoric adbe.x509.sha1 signatures.Set this property to true to enable support for adbe.x509.sha1 signatures (based on raw PKCS#1 signing). Signatures of this kind are very old, insecure, and extremely rarely used. It is reasonable to only enable this setting if you are know what you are doing. **EncryptionHandlerName**: Specifies the custom security handler PDF-name.Specifies the custom security handler PDF-name for the encryption handler. **EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is disabled by default, because enabling it may prevent the AdES components from collecting full revocation information required for long-term validation (LTV) signatures. **EvaluateSystemTrustForSelfSignedCertificates**: Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) for self-signed certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default. **EvaluateSystemTrustForSSL**: Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) specifically for SSL/TLS certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default. **ForceCompleteChainValidation**: Whether to check the CA certificates when the signing certificate is invalid.Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid. **ForceCompleteChainValidationForTrusted**: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments. **GracePeriod**: Specifies a grace period to apply during revocation information checks.Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated. **HardenedKeyGeneration**: Specifies if hardened Key generation should be used.Specifies if hardened Key generation should be used when the AES-256 encryption algorithm and password encryption are used. **IgnoreChainLoops**: Whether chain loops should be ignored.Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves. **IgnoreChainValidationErrors**: Whether to ignore any certificate chain validation issues.Enable this property to ignore any chain validation errors when creating a signature. This may be useful if the signature is created in an environment which uses different trust settings to the validation environment. **IgnoreOCSPNoCheckExtension**: Whether the OCSP NoCheck extension should be ignored.Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues. **IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store. If [IgnoreSystemTrust](#IgnoreSystemTrust) is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the trusted_certificates property) are considered trusted. **IgnoreTimestampChainValidityForLevelDetection**: Specify whether timestamp chain validity should be ignored during signature level detection.Set this property to True to instruct the validation engine to disregard the validity of the timestamp signer certificate chain when determining the signature level. TBD **ImplicitlyTrustSelfSignedCertificates**: Whether to trust self-signed certificates. Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows emulating the verifying environment without actually changing its security settings. **IsLTVEnabled**: Indicates LTV-enabled signature.Use this property to check if the signature is *LTV-enabled*. This property is similar to *LTV-enabled* property reported by Adobe Reader. 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). **MappingName**: TBD.TBD **MDPHashAlgorithm**: Specifies the MDP hash algorithm.Use this property to control the hash algorithm's signature references (DocMDP, FieldMDP transforms). The following values are supported: | | | | | --- | --- | --- | | | "auto" | Default value. The class 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 class uses MD5 hash algorithm. | | | "SHA1" | The class uses SHA1 hash algorithm. | | | "SHA256" | The class uses SHA256 hash algorithm. | | | "SHA384" | The class uses SHA384 hash algorithm. | | | "SHA512" | The class uses SHA512 hash algorithm. | | | "RIPEMD160" | The class uses RIPEMD160 hash algorithm. | | | "SHA3_256" | The class uses SHA3-256 hash algorithm. | | | "SHA3_384" | The class uses SHA3-384 hash algorithm. | | | "SHA3_512" | The class uses SHA3-512 hash algorithm. | | | "SHAKE_256" | The class uses SHAKE-256 hash algorithm. | | | "none" | The class will not calculate a digest and will not include DigestLocation, DigestMethod, and DigestValue keys of the Signature References dictionary. | **PageInfoCount**: The number of pages.Returns the number of pages available. **PageInfoCropBoxEmpty[Index]**: Check if the page's crop box is empty or not.This property contains True if the crop box is empty, and False otherwise. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. **PageInfoCropLLX[Index]**: Defines the X coordinate of the lower left corner of the crop box.This property contains the X coordinate of the lower left corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. **PageInfoCropLLY[Index]**: Defines the Y coordinate of the lower left corner of the crop box.This property contains the Y coordinate of the lower left corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. **PageInfoCropURX[Index]**: Defines the X coordinate of the upper right corner of the crop box.This property contains the X coordinate of the upper right corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. **PageInfoCropURY[Index]**: Defines the Y coordinate of the upper right corner of the crop box.This property contains the Y coordinate of the upper right corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. **PageInfoHeight[Index]**: The Height of the page.This property contains the page height value. **PageInfoMediaLLX[Index]**: Defines the X coordinate of the lower left corner of the media box.This property contains the X coordinate of the lower left corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed. **PageInfoMediaLLY[Index]**: Defines the Y coordinate of the lower left corner of the media box.This property contains the Y coordinate of the lower left corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed. **PageInfoMediaURX[Index]**: Defines the X coordinate of the upper right corner of the media box.This property contains the X coordinate of the upper right corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed. **PageInfoMediaURY[Index]**: Defines the Y coordinate of the upper right corner of the media box.This property contains the Y coordinate of the upper right corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed. **PageInfoRotate[Index]**: The Rotate value of the page.This property contains the page rotation angle. **PageInfoUserUnit[Index]**: Defines the size of default user space units.This property contains a positive number that shall give the size of default user space units, in multiples of 1/72 inch. The default value is 1.0 (user space unit is 1/72 inch). **PageInfoWidth[Index]**: The Width of the page.This property contains the page width value. **PolicyDescription**: signature policy description.This property specifies the Description of the signature policy. **PolicyExplicitText**: The explicit text of the user notice.Use this property to specify the explicit text of the user notice to be displayed when the signature is verified. **PolicyUNNumbers**: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES. **PolicyUNOrganization**: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES. **ProductionPlace**: Identifies the place of the signature production.The signature production place in JSON format that was included or to be included into the signature. Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}' **PromoteLongOCSPResponses**: Whether long OCSP responses are requested. Set this property to True to force the class to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted. **PSSUsed**: Whether to use RSASSA-PSS algorithm.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. This is an alias for *UsePSS*. **RC4KeyBits**: Specifies the number of key bits used for the RC4 algorithm.Specifies the number of key bits used for the RC4 encryption algorithm. **ReassembleMode**: Specifies the document reassemble mode.Use this property to control if the PDF document should be reassembled before signing/saving it. This property doesn't have any effect on PDF documents that have already been signed. The following values are supported: | | | | | --- | --- | --- | | | "auto" | Default value. The class automatically reassembles PDF documents in case they contain errors that may invalidate new signatures. | | | "disabled" | The class never reassembles PDF documents. This value is not recommended. | | | "enabled" | The class always reassembles PDF documents. | | | "hybrid" | The class 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. | **RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Default. Supported values are case-insensitive: | | | | --- | --- | | Default | Applies the AdES default freshness settings: crl:86400;50;600,ocsp:3600;50;600. This means: CRL maximum age 1 day, CRL age ratio 50%, CRL overlap 10 minutes; OCSP response maximum age 1 hour, OCSP response age ratio 50%, OCSP response overlap 10 minutes. This value is the default. | | Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. | | Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. | | Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. | | N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. | | crl:;;,ocsp:;; | Sets the CRL and OCSP response freshness values explicitly. | Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values. **SchemeParams**: The algorithm scheme parameters to employ.Use this property to specify the parameters of the algorithm scheme if needed. This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: *Scheme=PSS;SaltSize=32;TrailerField=1*. **SigPolicyDescription**: signature policy description.This property specifies the Description of the signature policy (an alias for PolicyDescription). **SigPolicyExplicitText**: The explicit text of the user notice.Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText); **SigPolicyHash**: The EPES policy hash.Use this configuration setting to provide the EPES policy hash. **SigPolicyHashAlgorithm**: The hash algorithm that was used to generate the EPES policy hash.Use this setting to provide the hash algorithm that was used to generate the policy hash. **SigPolicyID**: The EPES policy ID.The EPES signature policy identifier, in dotted OID format (1.2.3.4.5). **SigPolicyNoticeNumbers**: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers). **SigPolicyNoticeOrganization**: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization). **SigPolicyURI**: The EPES policy URI.Assign the EPES policy URI to this setting. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. **TimestampResponse**: A base16-encoded timestamp response received from a TSA.When using *virtual://* timestamp endpoints, assign this property in your [on_notification](#on_notification-event) event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16). **TLSChainValidationDetails**: Contains the advanced details of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to access the TLS certificate validation details. **TLSChainValidationResult**: Contains the result of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to obtain the TLS certificate validation result. **TLSClientAuthRequested**: Indicates whether the TLS server requests client authentication.Check this property in the TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via the TLSClientChain property. Note that the class may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted. **TLSValidationLog**: Contains the log of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to retrieve the validation log of the TLS server. **TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are: - CA, revocation source, TLS key usage requirements are not mandated - Violation of OCSP issuer requirements are ignored - The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates) - Basic constraints and name constraints of CA certificates are ignored - Some weaker algorithms are tolerated **TspAttemptCount**: Specifies the number of timestamping request attempts.Use this property to specify a number of timestamping request attempts. In case of a timestamping failure, provide new TSA and HTTP settings inside the [on_notification](#on_notification-event) event handler ('BeforeTimestamp' and 'TimestampError' event IDs). **TspHashAlgorithm**: Sets a specific hash algorithm for use with the timestamping service.In default configuration class uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp. Note: Unlike other classes, [PDFSigner](PDFSigner.md#PDFSigner) class uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp. **TspReqPolicy**: Sets a request policy ID to include in the timestamping request.Use this property to provide a specific request policy OID to include in the timestamping request. Use the standard human-readable OID notation (1.2.3.4.5). **UseDefaultTrustedLists**: Enables or disables the use of the default TrustedLists.Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists). The following default TSLs are used: EU (European Union) LOTL (list of trusted lists). **UseDefaultTSLs**: Enables or disables the use of the default TrustedLists.Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists). The following default TSLs are used: EU (European Union) LOTL (list of trusted lists). **UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages. **UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. **UsePSS**: Whether to use RSASSA-PSS algorithm.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. **UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. **UseValidationCache**: Enables or disable the use of the product-wide certificate chain validation cache.Use this property to enable or disable the use of the global chain validation cache. If enabled, the class will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the class, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start. **UseValidatorSettingsForTLSValidation**: Whether to employ the primary chain validator setup for auxiliary TLS chain validations.Use this property to specify whether you would like to use the primary (AdES) chain validator component to validate TLS chains for any connections involved (OCSP, CRL). **WidgetHeight**: Specifies the height of the signature widget.Use this property to set the height of the signature widget in points. Integer and float values are supported. This property extends the [new_sig_height](#PDFVerifier_p_NewSigHeight) property to allow the height of the signature widget to be specified in fractional points. **WidgetOffsetX**: Specifies the signature widget offset from the left-hand page border.Use this property to set the signature widget offset from the left-hand page border. Integer and float values are supported. This property extends the [new_sig_offset_x](#PDFVerifier_p_NewSigOffsetX) property to allow the offset of the signature widget to be specified in fractional points. **WidgetOffsetY**: Specifies the signature widget offset from the bottom page border.Use this property to set the signature widget offset from the bottom page border. Integer and float values are supported. This property extends the [new_sig_offset_y](#PDFVerifier_p_NewSigOffsetY) property to allow the offset of the signature widget to be specified in fractional points. **WidgetWidth**: Specifies the width of the signature widget.Use this property to set the width of the signature widget in points. Integer and float values are supported. This property extends the [new_sig_width](#PDFVerifier_p_NewSigWidth) property to allow the width of the signature widget to be specified in fractional points. **XMPMetadataContent**: The XMP metadata content.Use this config property to read or set the XMP metadata content. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # PDFVerifier Errors ### PDFVerifier Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 26214401 | The input file does not exist ([SB_ERROR_PDF_INPUTFILE_NOT_EXISTS](constants.md#const_SBERRORPDFINPUTFILENOTEXISTS)) | | 26214402 | Cannot encrypt already encrypted file ([SB_ERROR_PDF_ENCRYPTED](constants.md#const_SBERRORPDFENCRYPTED)) | | 26214403 | The file is not encrypted ([SB_ERROR_PDF_NOT_ENCRYPTED](constants.md#const_SBERRORPDFNOTENCRYPTED)) | | 26214405 | Invalid password ([SB_ERROR_PDF_INVALID_PASSWORD](constants.md#const_SBERRORPDFINVALIDPASSWORD)) | | 26214406 | Failed to decrypt the file ([SB_ERROR_PDF_DECRYPTION_FAILED](constants.md#const_SBERRORPDFDECRYPTIONFAILED)) | | 26214407 | The document is signed ([SB_ERROR_PDF_SIGNED](constants.md#const_SBERRORPDFSIGNED)) | | 26214408 | The document is not signed ([SB_ERROR_PDF_NOT_SIGNED](constants.md#const_SBERRORPDFNOTSIGNED)) | | 26214409 | Cannot update this type of signature ([SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE](constants.md#const_SBERRORPDFINAPPROPRIATESIGNATURE)) | | 26214410 | Unsupported feature or operation ([SB_ERROR_PDF_NOT_SUPPORTED](constants.md#const_SBERRORPDFNOTSUPPORTED)) | | 26214411 | No timestamp server specified ([SB_ERROR_PDF_NO_TIMESTAMP_SERVER](constants.md#const_SBERRORPDFNOTIMESTAMPSERVER)) | | 26214412 | The component is not in edit mode ([SB_ERROR_PDF_READONLY](constants.md#const_SBERRORPDFREADONLY)) |