# Struct securepdf::PDFVerify The PDFVerify struct verifies PDF signatures. ## Syntax ```text securepdf::PDFVerify ``` ## Remarks The PDFVerify struct verifies electronic signatures over PDF documents. Basic Adobe and PAdES signatures are supported. PDFVerify validates each signature from two perspectives: the integrity and validity of the signature (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 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. ### Preparing the Validation To initiate the validation, first provide the signed PDF document as a file ([input_file](#input_file-property-pdfverify-struct)), byte array ([input_data](#input_data-property-pdfverify-struct)), or stream (set_input_stream). Then adjust any chain validation parameters as necessary (please see the [Chain Validation Setup](#chain-validation-setup) section for more details) and call [verify](#verify-method-pdfverify-struct). For every signature in the document, PDFVerify fires the [on_signature_info](#on_signature_info-event-pdfverify-struct) event, allowing you to specify whether you want the struct to validate the signature, the chain, or both. Once [on_signature_info](#on_signature_info-event-pdfverify-struct) returns, PDFVerify proceeds to the signature validation routine in accordance with the provided settings. ### Validation Results Upon completion of the validation, the [on_signature_processed](#on_signature_processed-event-pdfverify-struct) event is fired, and the validation results are published here as well as in the following properties of the associated PDFSignature object: - contains the outcome of the signature validation: valid, corrupted, the signing certificate was missing, or failed. - contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined. - provides the details of the factors that contributed to the chain validation result, such as an outdated certificate, a missing CRL, or a missing CA certificate. Other information about the signature can be accessed using the signatures property. ### Checking Signature Coverage The PDF format uses incremental updates to introduce changes to the document. This implies that a signature may not cover the whole document, but rather a certain revision of it. Strictly speaking, every signature in a PDF document, apart from potentially 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 were 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 property of the associated PDFSignature object to establish the scope of a signature. The revision of the document covered by that specific signature ranges from byte *0* to . Alternatively, you can use the [get_signed_version](#get_signed_version-method-pdfverify-struct) method to extract the signed revision to a file. ### Chain Validation Setup Chain validation is a sophisticated, multifaceted procedure that involves a lot of variables. Depending on the configuration of your operating environment, the specifics of the PKI framework being used, and the validation policy you need to follow, you may want to adjust your chain validation parameters to best fit your requirements. A summary of these parameters is given below. NOTE: These parameters apply to [sign](PDFSign.md#PDFSign_m_Sign) and [update](PDFSign.md#PDFSign_m_Update) in PDFSign as well as [verify](#verify-method-pdfverify-struct) in PDFVerify, as all three methods execute the chain validation procedure (if it is enabled). **Validation Policy** The [validation_policy](#validation_policy-property-pdfverify-struct) property dictates how thoroughly the chain is validated. It includes options to control which checks the struct performs, allowing you to tailor the validation process to meet your specific security needs. For example, if it is not essential to check each certificate's revocation status, set this property to *vpFullNoRevocation*. **Revocation** The revocation aspect of chain validation is controlled by the [revocation_check](#revocation_check-property-pdfverify-struct) property, which allows you to choose between and prioritize revocation origins. NOTE: OCSP sources are often preferred to CRL endpoints because of their real-time capability and the smaller size of the responses they produce. **Trust** The trust aspect of chain validation is controlled by the [trust_sources](#trust_sources-property-pdfverify-struct) property, which allows you to specify the locations in which the struct searches for trust anchors. Local system stores, your own trusted root certificates (through the trusted_certs property), and Trusted Lists (through the [trusted_lists](#trusted_lists-property-pdfverify-struct) property) are all supported. **Offline Mode** The [offline_mode](#offline_mode-property-pdfverify-struct) property provides the ability to sign or verify the document without contacting online sources. If this property is enabled, the struct only uses known_certs, trusted_certs, data structures within the document, and revocation and Trusted List data that it previously saved to its internal cache when looking for missing validation material. ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecurePDF. Due to this, the PDFVerify struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of PDFVerify when you have finished using the instance. ## Property List *The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [attachment_count](#attachment_count-property-pdfverify-struct) | The number of records in the Attachment arrays. | | [attachment_content_type](#attachment_content_type-property-pdfverify-struct) | The content type of the attachment. | | [attachment_creation_date](#attachment_creation_date-property-pdfverify-struct) | The creation date of the attachment. | | [attachment_data](#attachment_data-property-pdfverify-struct) | The raw data of the attachment. | | [attachment_description](#attachment_description-property-pdfverify-struct) | A textual description of the attachment. | | [attachment_file_name](#attachment_file_name-property-pdfverify-struct) | The path and filename of the attachment. | | [attachment_modification_date](#attachment_modification_date-property-pdfverify-struct) | The date and time of the file's last modification. | | [attachment_name](#attachment_name-property-pdfverify-struct) | The name of the attachment. | | [attachment_size](#attachment_size-property-pdfverify-struct) | The attachment's size in bytes. | | [blocked_cert_count](#blocked_cert_count-property-pdfverify-struct) | The number of records in the BlockedCert arrays. | | [blocked_cert_effective_date](#blocked_cert_effective_date-property-pdfverify-struct) | The date on which this certificate becomes valid. | | [blocked_cert_expiration_date](#blocked_cert_expiration_date-property-pdfverify-struct) | The date on which the certificate expires. | | [blocked_cert_extended_key_usage](#blocked_cert_extended_key_usage-property-pdfverify-struct) | A comma-delimited list of extended key usage identifiers. | | [blocked_cert_fingerprint](#blocked_cert_fingerprint-property-pdfverify-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [blocked_cert_fingerprint_sha1](#blocked_cert_fingerprint_sha1-property-pdfverify-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [blocked_cert_fingerprint_sha256](#blocked_cert_fingerprint_sha256-property-pdfverify-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [blocked_cert_issuer](#blocked_cert_issuer-property-pdfverify-struct) | The issuer of the certificate. | | [blocked_cert_private_key](#blocked_cert_private_key-property-pdfverify-struct) | The private key of the certificate (if available). | | [blocked_cert_private_key_available](#blocked_cert_private_key_available-property-pdfverify-struct) | Whether a PrivateKey is available for the selected certificate. | | [blocked_cert_private_key_container](#blocked_cert_private_key_container-property-pdfverify-struct) | The name of the PrivateKey container for the certificate (if available). | | [blocked_cert_public_key](#blocked_cert_public_key-property-pdfverify-struct) | The public key of the certificate. | | [blocked_cert_public_key_algorithm](#blocked_cert_public_key_algorithm-property-pdfverify-struct) | The textual description of the certificate's public key algorithm. | | [blocked_cert_public_key_length](#blocked_cert_public_key_length-property-pdfverify-struct) | The length of the certificate's public key (in bits). | | [blocked_cert_serial_number](#blocked_cert_serial_number-property-pdfverify-struct) | The serial number of the certificate encoded as a string. | | [blocked_cert_signature_algorithm](#blocked_cert_signature_algorithm-property-pdfverify-struct) | The text description of the certificate's signature algorithm. | | [blocked_cert_store](#blocked_cert_store-property-pdfverify-struct) | The name of the certificate store for the client certificate. | | [blocked_cert_store_password](#blocked_cert_store_password-property-pdfverify-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [blocked_cert_store_type](#blocked_cert_store_type-property-pdfverify-struct) | The type of certificate store for this certificate. | | [blocked_cert_subject_alt_names](#blocked_cert_subject_alt_names-property-pdfverify-struct) | Comma-separated lists of alternative subject names for the certificate. | | [blocked_cert_thumbprint_md5](#blocked_cert_thumbprint_md5-property-pdfverify-struct) | The MD5 hash of the certificate. | | [blocked_cert_thumbprint_sha1](#blocked_cert_thumbprint_sha1-property-pdfverify-struct) | The SHA-1 hash of the certificate. | | [blocked_cert_thumbprint_sha256](#blocked_cert_thumbprint_sha256-property-pdfverify-struct) | The SHA-256 hash of the certificate. | | [blocked_cert_usage](#blocked_cert_usage-property-pdfverify-struct) | The text description of UsageFlags . | | [blocked_cert_usage_flags](#blocked_cert_usage_flags-property-pdfverify-struct) | The flags that show intended use for the certificate. | | [blocked_cert_version](#blocked_cert_version-property-pdfverify-struct) | The certificate's version number. | | [blocked_cert_subject](#blocked_cert_subject-property-pdfverify-struct) | The subject of the certificate used for client authentication. | | [blocked_cert_encoded](#blocked_cert_encoded-property-pdfverify-struct) | The certificate (PEM/Base64 encoded). | | [decryption_cert_effective_date](#decryption_cert_effective_date-property-pdfverify-struct) | The date on which this certificate becomes valid. | | [decryption_cert_expiration_date](#decryption_cert_expiration_date-property-pdfverify-struct) | The date on which the certificate expires. | | [decryption_cert_extended_key_usage](#decryption_cert_extended_key_usage-property-pdfverify-struct) | A comma-delimited list of extended key usage identifiers. | | [decryption_cert_fingerprint](#decryption_cert_fingerprint-property-pdfverify-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [decryption_cert_fingerprint_sha1](#decryption_cert_fingerprint_sha1-property-pdfverify-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [decryption_cert_fingerprint_sha256](#decryption_cert_fingerprint_sha256-property-pdfverify-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [decryption_cert_issuer](#decryption_cert_issuer-property-pdfverify-struct) | The issuer of the certificate. | | [decryption_cert_private_key](#decryption_cert_private_key-property-pdfverify-struct) | The private key of the certificate (if available). | | [decryption_cert_private_key_available](#decryption_cert_private_key_available-property-pdfverify-struct) | Whether a PrivateKey is available for the selected certificate. | | [decryption_cert_private_key_container](#decryption_cert_private_key_container-property-pdfverify-struct) | The name of the PrivateKey container for the certificate (if available). | | [decryption_cert_public_key](#decryption_cert_public_key-property-pdfverify-struct) | The public key of the certificate. | | [decryption_cert_public_key_algorithm](#decryption_cert_public_key_algorithm-property-pdfverify-struct) | The textual description of the certificate's public key algorithm. | | [decryption_cert_public_key_length](#decryption_cert_public_key_length-property-pdfverify-struct) | The length of the certificate's public key (in bits). | | [decryption_cert_serial_number](#decryption_cert_serial_number-property-pdfverify-struct) | The serial number of the certificate encoded as a string. | | [decryption_cert_signature_algorithm](#decryption_cert_signature_algorithm-property-pdfverify-struct) | The text description of the certificate's signature algorithm. | | [decryption_cert_store](#decryption_cert_store-property-pdfverify-struct) | The name of the certificate store for the client certificate. | | [decryption_cert_store_password](#decryption_cert_store_password-property-pdfverify-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [decryption_cert_store_type](#decryption_cert_store_type-property-pdfverify-struct) | The type of certificate store for this certificate. | | [decryption_cert_subject_alt_names](#decryption_cert_subject_alt_names-property-pdfverify-struct) | Comma-separated lists of alternative subject names for the certificate. | | [decryption_cert_thumbprint_md5](#decryption_cert_thumbprint_md5-property-pdfverify-struct) | The MD5 hash of the certificate. | | [decryption_cert_thumbprint_sha1](#decryption_cert_thumbprint_sha1-property-pdfverify-struct) | The SHA-1 hash of the certificate. | | [decryption_cert_thumbprint_sha256](#decryption_cert_thumbprint_sha256-property-pdfverify-struct) | The SHA-256 hash of the certificate. | | [decryption_cert_usage](#decryption_cert_usage-property-pdfverify-struct) | The text description of UsageFlags . | | [decryption_cert_usage_flags](#decryption_cert_usage_flags-property-pdfverify-struct) | The flags that show intended use for the certificate. | | [decryption_cert_version](#decryption_cert_version-property-pdfverify-struct) | The certificate's version number. | | [decryption_cert_subject](#decryption_cert_subject-property-pdfverify-struct) | The subject of the certificate used for client authentication. | | [decryption_cert_encoded](#decryption_cert_encoded-property-pdfverify-struct) | The certificate (PEM/Base64 encoded). | | [document_cert_count](#document_cert_count-property-pdfverify-struct) | The number of records in the DocumentCert arrays. | | [document_cert_effective_date](#document_cert_effective_date-property-pdfverify-struct) | The date on which this certificate becomes valid. | | [document_cert_expiration_date](#document_cert_expiration_date-property-pdfverify-struct) | The date on which the certificate expires. | | [document_cert_extended_key_usage](#document_cert_extended_key_usage-property-pdfverify-struct) | A comma-delimited list of extended key usage identifiers. | | [document_cert_fingerprint](#document_cert_fingerprint-property-pdfverify-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [document_cert_fingerprint_sha1](#document_cert_fingerprint_sha1-property-pdfverify-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [document_cert_fingerprint_sha256](#document_cert_fingerprint_sha256-property-pdfverify-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [document_cert_issuer](#document_cert_issuer-property-pdfverify-struct) | The issuer of the certificate. | | [document_cert_private_key](#document_cert_private_key-property-pdfverify-struct) | The private key of the certificate (if available). | | [document_cert_private_key_available](#document_cert_private_key_available-property-pdfverify-struct) | Whether a PrivateKey is available for the selected certificate. | | [document_cert_private_key_container](#document_cert_private_key_container-property-pdfverify-struct) | The name of the PrivateKey container for the certificate (if available). | | [document_cert_public_key](#document_cert_public_key-property-pdfverify-struct) | The public key of the certificate. | | [document_cert_public_key_algorithm](#document_cert_public_key_algorithm-property-pdfverify-struct) | The textual description of the certificate's public key algorithm. | | [document_cert_public_key_length](#document_cert_public_key_length-property-pdfverify-struct) | The length of the certificate's public key (in bits). | | [document_cert_serial_number](#document_cert_serial_number-property-pdfverify-struct) | The serial number of the certificate encoded as a string. | | [document_cert_signature_algorithm](#document_cert_signature_algorithm-property-pdfverify-struct) | The text description of the certificate's signature algorithm. | | [document_cert_store](#document_cert_store-property-pdfverify-struct) | The name of the certificate store for the client certificate. | | [document_cert_store_password](#document_cert_store_password-property-pdfverify-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [document_cert_store_type](#document_cert_store_type-property-pdfverify-struct) | The type of certificate store for this certificate. | | [document_cert_subject_alt_names](#document_cert_subject_alt_names-property-pdfverify-struct) | Comma-separated lists of alternative subject names for the certificate. | | [document_cert_thumbprint_md5](#document_cert_thumbprint_md5-property-pdfverify-struct) | The MD5 hash of the certificate. | | [document_cert_thumbprint_sha1](#document_cert_thumbprint_sha1-property-pdfverify-struct) | The SHA-1 hash of the certificate. | | [document_cert_thumbprint_sha256](#document_cert_thumbprint_sha256-property-pdfverify-struct) | The SHA-256 hash of the certificate. | | [document_cert_usage](#document_cert_usage-property-pdfverify-struct) | The text description of UsageFlags . | | [document_cert_usage_flags](#document_cert_usage_flags-property-pdfverify-struct) | The flags that show intended use for the certificate. | | [document_cert_version](#document_cert_version-property-pdfverify-struct) | The certificate's version number. | | [document_cert_subject](#document_cert_subject-property-pdfverify-struct) | The subject of the certificate used for client authentication. | | [document_cert_encoded](#document_cert_encoded-property-pdfverify-struct) | The certificate (PEM/Base64 encoded). | | [firewall_auto_detect](#firewall_auto_detect-property-pdfverify-struct) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_type](#firewall_type-property-pdfverify-struct) | The type of firewall to connect through. | | [firewall_host](#firewall_host-property-pdfverify-struct) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property-pdfverify-struct) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property-pdfverify-struct) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_user](#firewall_user-property-pdfverify-struct) | A username if authentication is to be used when connecting through a firewall. | | [input_data](#input_data-property-pdfverify-struct) | A byte array containing the PDF document to process. | | [input_file](#input_file-property-pdfverify-struct) | The PDF file to process. | | [known_cert_count](#known_cert_count-property-pdfverify-struct) | The number of records in the KnownCert arrays. | | [known_cert_effective_date](#known_cert_effective_date-property-pdfverify-struct) | The date on which this certificate becomes valid. | | [known_cert_expiration_date](#known_cert_expiration_date-property-pdfverify-struct) | The date on which the certificate expires. | | [known_cert_extended_key_usage](#known_cert_extended_key_usage-property-pdfverify-struct) | A comma-delimited list of extended key usage identifiers. | | [known_cert_fingerprint](#known_cert_fingerprint-property-pdfverify-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [known_cert_fingerprint_sha1](#known_cert_fingerprint_sha1-property-pdfverify-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [known_cert_fingerprint_sha256](#known_cert_fingerprint_sha256-property-pdfverify-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [known_cert_issuer](#known_cert_issuer-property-pdfverify-struct) | The issuer of the certificate. | | [known_cert_private_key](#known_cert_private_key-property-pdfverify-struct) | The private key of the certificate (if available). | | [known_cert_private_key_available](#known_cert_private_key_available-property-pdfverify-struct) | Whether a PrivateKey is available for the selected certificate. | | [known_cert_private_key_container](#known_cert_private_key_container-property-pdfverify-struct) | The name of the PrivateKey container for the certificate (if available). | | [known_cert_public_key](#known_cert_public_key-property-pdfverify-struct) | The public key of the certificate. | | [known_cert_public_key_algorithm](#known_cert_public_key_algorithm-property-pdfverify-struct) | The textual description of the certificate's public key algorithm. | | [known_cert_public_key_length](#known_cert_public_key_length-property-pdfverify-struct) | The length of the certificate's public key (in bits). | | [known_cert_serial_number](#known_cert_serial_number-property-pdfverify-struct) | The serial number of the certificate encoded as a string. | | [known_cert_signature_algorithm](#known_cert_signature_algorithm-property-pdfverify-struct) | The text description of the certificate's signature algorithm. | | [known_cert_store](#known_cert_store-property-pdfverify-struct) | The name of the certificate store for the client certificate. | | [known_cert_store_password](#known_cert_store_password-property-pdfverify-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [known_cert_store_type](#known_cert_store_type-property-pdfverify-struct) | The type of certificate store for this certificate. | | [known_cert_subject_alt_names](#known_cert_subject_alt_names-property-pdfverify-struct) | Comma-separated lists of alternative subject names for the certificate. | | [known_cert_thumbprint_md5](#known_cert_thumbprint_md5-property-pdfverify-struct) | The MD5 hash of the certificate. | | [known_cert_thumbprint_sha1](#known_cert_thumbprint_sha1-property-pdfverify-struct) | The SHA-1 hash of the certificate. | | [known_cert_thumbprint_sha256](#known_cert_thumbprint_sha256-property-pdfverify-struct) | The SHA-256 hash of the certificate. | | [known_cert_usage](#known_cert_usage-property-pdfverify-struct) | The text description of UsageFlags . | | [known_cert_usage_flags](#known_cert_usage_flags-property-pdfverify-struct) | The flags that show intended use for the certificate. | | [known_cert_version](#known_cert_version-property-pdfverify-struct) | The certificate's version number. | | [known_cert_subject](#known_cert_subject-property-pdfverify-struct) | The subject of the certificate used for client authentication. | | [known_cert_encoded](#known_cert_encoded-property-pdfverify-struct) | The certificate (PEM/Base64 encoded). | | [offline_mode](#offline_mode-property-pdfverify-struct) | Whether the struct is operating in offline mode. | | [output_data](#output_data-property-pdfverify-struct) | A byte array containing the PDF document after processing. | | [output_file](#output_file-property-pdfverify-struct) | The path to a local file where the output is written. | | [overwrite](#overwrite-property-pdfverify-struct) | Whether the struct should overwrite files. | | [password](#password-property-pdfverify-struct) | The password to decrypt the document with. | | [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) | The type of authorization to perform when connecting to the proxy. | | [proxy_auto_detect](#proxy_auto_detect-property-pdfverify-struct) | Whether to automatically detect and use proxy system settings, if available. | | [proxy_password](#proxy_password-property-pdfverify-struct) | A password if authentication is to be used for the proxy. | | [proxy_port](#proxy_port-property-pdfverify-struct) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). | | [proxy_server](#proxy_server-property-pdfverify-struct) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. | | [proxy_ssl](#proxy_ssl-property-pdfverify-struct) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. | | [proxy_user](#proxy_user-property-pdfverify-struct) | A username if authentication is to be used for the proxy. | | [revocation_check](#revocation_check-property-pdfverify-struct) | The kind(s) of revocation check to perform for all chain certificates. | | [pdf_signature_count](#pdf_signature_count-property-pdfverify-struct) | The number of records in the PDFSignature arrays. | | [pdf_signature_author_name](#pdf_signature_author_name-property-pdfverify-struct) | The human-readable name of the signer. | | [pdf_signature_chain_validation_details](#pdf_signature_chain_validation_details-property-pdfverify-struct) | The details of the certificate chain validation outcome. | | [pdf_signature_chain_validation_result](#pdf_signature_chain_validation_result-property-pdfverify-struct) | The outcome of the certificate chain validation routine. | | [pdf_signature_claimed_signing_time](#pdf_signature_claimed_signing_time-property-pdfverify-struct) | The signature's creation time in UTC. | | [pdf_signature_coverage_ends_at](#pdf_signature_coverage_ends_at-property-pdfverify-struct) | The byte offset in the PDF file where the signature coverage ends. | | [pdf_signature_hash_algorithm](#pdf_signature_hash_algorithm-property-pdfverify-struct) | The hash algorithm that was used for signing. | | [pdf_signature_profile](#pdf_signature_profile-property-pdfverify-struct) | The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI. | | [pdf_signature_reason](#pdf_signature_reason-property-pdfverify-struct) | The reason for signing. | | [pdf_signature_type](#pdf_signature_type-property-pdfverify-struct) | The type of the signature that was created. | | [pdf_signature_signer_cert_index](#pdf_signature_signer_cert_index-property-pdfverify-struct) | The index of the signer certificate in the DocumentCerts collection. | | [pdf_signature_timestamp_cert_index](#pdf_signature_timestamp_cert_index-property-pdfverify-struct) | The index of the timestamping certificate in the DocumentCerts collection (if applicable). | | [pdf_signature_timestamped](#pdf_signature_timestamped-property-pdfverify-struct) | Whether the signature contains an embedded timestamp. | | [pdf_signature_validated_signing_time](#pdf_signature_validated_signing_time-property-pdfverify-struct) | The certified signing time in UTC. | | [pdf_signature_validation_result](#pdf_signature_validation_result-property-pdfverify-struct) | The outcome of the cryptographic signature validation. | | [pdf_signature_widget_height](#pdf_signature_widget_height-property-pdfverify-struct) | The height of the signature widget in points. | | [pdf_signature_widget_offset_x](#pdf_signature_widget_offset_x-property-pdfverify-struct) | The signature widget offset from the left-hand page border in points. | | [pdf_signature_widget_offset_y](#pdf_signature_widget_offset_y-property-pdfverify-struct) | The signature widget offset from the bottom page border in points. | | [pdf_signature_widget_pages](#pdf_signature_widget_pages-property-pdfverify-struct) | The pages that the signature and its widget are placed on. | | [pdf_signature_widget_width](#pdf_signature_widget_width-property-pdfverify-struct) | The width of the signature widget in points. | | [trusted_cert_count](#trusted_cert_count-property-pdfverify-struct) | The number of records in the TrustedCert arrays. | | [trusted_cert_effective_date](#trusted_cert_effective_date-property-pdfverify-struct) | The date on which this certificate becomes valid. | | [trusted_cert_expiration_date](#trusted_cert_expiration_date-property-pdfverify-struct) | The date on which the certificate expires. | | [trusted_cert_extended_key_usage](#trusted_cert_extended_key_usage-property-pdfverify-struct) | A comma-delimited list of extended key usage identifiers. | | [trusted_cert_fingerprint](#trusted_cert_fingerprint-property-pdfverify-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [trusted_cert_fingerprint_sha1](#trusted_cert_fingerprint_sha1-property-pdfverify-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [trusted_cert_fingerprint_sha256](#trusted_cert_fingerprint_sha256-property-pdfverify-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [trusted_cert_issuer](#trusted_cert_issuer-property-pdfverify-struct) | The issuer of the certificate. | | [trusted_cert_private_key](#trusted_cert_private_key-property-pdfverify-struct) | The private key of the certificate (if available). | | [trusted_cert_private_key_available](#trusted_cert_private_key_available-property-pdfverify-struct) | Whether a PrivateKey is available for the selected certificate. | | [trusted_cert_private_key_container](#trusted_cert_private_key_container-property-pdfverify-struct) | The name of the PrivateKey container for the certificate (if available). | | [trusted_cert_public_key](#trusted_cert_public_key-property-pdfverify-struct) | The public key of the certificate. | | [trusted_cert_public_key_algorithm](#trusted_cert_public_key_algorithm-property-pdfverify-struct) | The textual description of the certificate's public key algorithm. | | [trusted_cert_public_key_length](#trusted_cert_public_key_length-property-pdfverify-struct) | The length of the certificate's public key (in bits). | | [trusted_cert_serial_number](#trusted_cert_serial_number-property-pdfverify-struct) | The serial number of the certificate encoded as a string. | | [trusted_cert_signature_algorithm](#trusted_cert_signature_algorithm-property-pdfverify-struct) | The text description of the certificate's signature algorithm. | | [trusted_cert_store](#trusted_cert_store-property-pdfverify-struct) | The name of the certificate store for the client certificate. | | [trusted_cert_store_password](#trusted_cert_store_password-property-pdfverify-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [trusted_cert_store_type](#trusted_cert_store_type-property-pdfverify-struct) | The type of certificate store for this certificate. | | [trusted_cert_subject_alt_names](#trusted_cert_subject_alt_names-property-pdfverify-struct) | Comma-separated lists of alternative subject names for the certificate. | | [trusted_cert_thumbprint_md5](#trusted_cert_thumbprint_md5-property-pdfverify-struct) | The MD5 hash of the certificate. | | [trusted_cert_thumbprint_sha1](#trusted_cert_thumbprint_sha1-property-pdfverify-struct) | The SHA-1 hash of the certificate. | | [trusted_cert_thumbprint_sha256](#trusted_cert_thumbprint_sha256-property-pdfverify-struct) | The SHA-256 hash of the certificate. | | [trusted_cert_usage](#trusted_cert_usage-property-pdfverify-struct) | The text description of UsageFlags . | | [trusted_cert_usage_flags](#trusted_cert_usage_flags-property-pdfverify-struct) | The flags that show intended use for the certificate. | | [trusted_cert_version](#trusted_cert_version-property-pdfverify-struct) | The certificate's version number. | | [trusted_cert_subject](#trusted_cert_subject-property-pdfverify-struct) | The subject of the certificate used for client authentication. | | [trusted_cert_encoded](#trusted_cert_encoded-property-pdfverify-struct) | The certificate (PEM/Base64 encoded). | | [trusted_lists](#trusted_lists-property-pdfverify-struct) | A list of known Trusted Lists for chain validation. | | [trust_sources](#trust_sources-property-pdfverify-struct) | The trust sources to use during chain validation. | | [validation_flags](#validation_flags-property-pdfverify-struct) | Additional chain validation settings. | | [validation_policy](#validation_policy-property-pdfverify-struct) | The level at which to perform chain validation. | | [validation_time](#validation_time-property-pdfverify-struct) | The time point at which the signature should be validated. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [close](#close-method-pdfverify-struct) | Closes the opened document. | | [config](#config-method-pdfverify-struct) | Sets or retrieves a configuration setting. | | [encrypted](#encrypted-method-pdfverify-struct) | Checks whether the document is encrypted. | | [get_page_property](#get_page_property-method-pdfverify-struct) | Returns the value of a page property. | | [get_signed_version](#get_signed_version-method-pdfverify-struct) | Returns the part of the signed document that is covered by a signature. | | [interrupt](#interrupt-method-pdfverify-struct) | Interrupts the current action. | | [open](#open-method-pdfverify-struct) | Opens the document for processing. | | [reset](#reset-method-pdfverify-struct) | Resets the struct. | | [save_attachment](#save_attachment-method-pdfverify-struct) | Saves a PDF attachment to a file. | | [signed](#signed-method-pdfverify-struct) | Checks whether the document is signed. | | [unsign](#unsign-method-pdfverify-struct) | Removes a signature from the document. | | [verify](#verify-method-pdfverify-struct) | Verifies the signed document. | ## Event List *The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_chain_cert](#on_chain_cert-event-pdfverify-struct) | Fired when the struct encounters a chain certificate. | | [on_document_info](#on_document_info-event-pdfverify-struct) | Fired when the document has been loaded into memory. | | [on_error](#on_error-event-pdfverify-struct) | Fired when information is available about errors during data delivery. | | [on_log](#on_log-event-pdfverify-struct) | Fired once for each log message. | | [on_password](#on_password-event-pdfverify-struct) | Fired when the struct detects that the document is encrypted with a password. | | [on_recipient_info](#on_recipient_info-event-pdfverify-struct) | Fired for each recipient certificate of the encrypted document. | | [on_signature_info](#on_signature_info-event-pdfverify-struct) | Fired when the struct finds a signature in the document. | | [on_signature_processed](#on_signature_processed-event-pdfverify-struct) | Fired after a signature has been processed. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event-pdfverify-struct) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event-pdfverify-struct) | Fired when secure connection progress messages are available. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CacheRevocationInfo](#CacheRevocationInfo) | Whether to cache revocation information. | | [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Whether to close the input stream after processing. | | [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) | Whether to close the output stream after processing. | | [ContactInfo\[Index\]](#ContactInfo[Index]) | The signer's contact information. | | [EnforcePDFA](#EnforcePDFA) | Whether to enforce PDF/A compliance. | | [FilterName\[Index\]](#FilterName[Index]) | The signature filter name. | | [FullSignatureName\[Index\]](#FullSignatureName[Index]) | The full name of the signature field. | | [HTTPRetryCount](#HTTPRetryCount) | The number of HTTP request retries. | | [HTTPRetryInterval](#HTTPRetryInterval) | A time interval to apply between HTTP request retries. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [OwnerPassword](#OwnerPassword) | The owner password to decrypt the document with. | | [PDFALevel](#PDFALevel) | The PDF/A conformance level to enforce. | | [PDFAPolicy](#PDFAPolicy) | The PDF/A policy to follow. | | [Permissions](#Permissions) | The document permissions associated with the encryption. | | [PreferEmbeddedRevocationInfo](#PreferEmbeddedRevocationInfo) | Whether to prioritize revocation information that is embedded into the document. | | [RevisionOffsets](#RevisionOffsets) | The offsets of the document revisions. | | [SaveChanges](#SaveChanges) | Whether to save changes made to the document. | | [SignatureAllowedChanges\[Index\]](#SignatureAllowedChanges[Index]) | The changes allowed by the signature. | | [SignatureData\[Index\]](#SignatureData[Index]) | The hex-encoded representation of the underlying PKCS#7/CMS signature container. | | [SignatureInvertedLock\[Index\]](#SignatureInvertedLock[Index]) | Whether the locked field list should be treated as containing unlocked fields instead. | | [SignatureLockedFields\[Index\]](#SignatureLockedFields[Index]) | The list of form fields that are locked by the signature. | | [TempPath](#TempPath) | The location where temporary files are stored. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # attachment_count property ([PDFVerify](#struct-securepdfpdfverify) Struct) The number of records in the Attachment arrays. ## Syntax *Rust Syntax* ```text fn attachment_count(&self ) -> Result fn set_attachment_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [attachment_content_type](#attachment_content_type-property-pdfverify-struct) - [attachment_creation_date](#attachment_creation_date-property-pdfverify-struct) - [attachment_data](#attachment_data-property-pdfverify-struct) - [attachment_description](#attachment_description-property-pdfverify-struct) - [attachment_file_name](#attachment_file_name-property-pdfverify-struct) - [attachment_modification_date](#attachment_modification_date-property-pdfverify-struct) - [attachment_name](#attachment_name-property-pdfverify-struct) - [attachment_size](#attachment_size-property-pdfverify-struct) The array indices start at *0* and end at *attachment_count - 1*. ## Data Type i32 # attachment_content_type property ([PDFVerify](#struct-securepdfpdfverify) Struct) The content type of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_content_type(&self , AttachmentIndex : i32) -> Result fn set_attachment_content_type(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_content_type_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The content type of the attachment. The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachment_count-property-pdfverify-struct) property. ## Data Type String # attachment_creation_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The creation date of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_creation_date(&self , AttachmentIndex : i32) -> Result fn set_attachment_creation_date(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_creation_date_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The creation date of the attachment. The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachment_count-property-pdfverify-struct) property. ## Data Type String # attachment_data property ([PDFVerify](#struct-securepdfpdfverify) Struct) The raw data of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_data(&self , AttachmentIndex : i32) -> Result, SecurePDFError> fn set_attachment_data(&self, AttachmentIndex : i32, value : Vec) -> Option fn set_attachment_data_ref(&self, AttachmentIndex : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The raw data of the attachment. If [attachment_output_stream](#PDFVerify_p_AttachmentOutputStream) is not set to a valid stream, the struct writes to this property when an empty string is passed to save_attachment. The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachment_count-property-pdfverify-struct) property. ## Data Type Vec # attachment_description property ([PDFVerify](#struct-securepdfpdfverify) Struct) A textual description of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_description(&self , AttachmentIndex : i32) -> Result fn set_attachment_description(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_description_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks A textual description of the attachment. The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachment_count-property-pdfverify-struct) property. ## Data Type String # attachment_file_name property ([PDFVerify](#struct-securepdfpdfverify) Struct) The path and filename of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_file_name(&self , AttachmentIndex : i32) -> Result fn set_attachment_file_name(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_file_name_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The path and filename of the attachment. The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachment_count-property-pdfverify-struct) property. ## Data Type String # attachment_modification_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date and time of the file's last modification. ## Syntax *Rust Syntax* ```text fn attachment_modification_date(&self , AttachmentIndex : i32) -> Result fn set_attachment_modification_date(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_modification_date_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The date and time of the file's last modification. The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachment_count-property-pdfverify-struct) property. ## Data Type String # attachment_name property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_name(&self , AttachmentIndex : i32) -> Result fn set_attachment_name(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_name_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The name of the attachment. The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachment_count-property-pdfverify-struct) property. ## Data Type String # attachment_size property ([PDFVerify](#struct-securepdfpdfverify) Struct) The attachment's size in bytes. ## Syntax *Rust Syntax* ```text fn attachment_size(&self , AttachmentIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The attachment's size in bytes. The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachment_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i64 # blocked_cert_count property ([PDFVerify](#struct-securepdfpdfverify) Struct) The number of records in the BlockedCert arrays. ## Syntax *Rust Syntax* ```text fn blocked_cert_count(&self ) -> Result fn set_blocked_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [blocked_cert_effective_date](#blocked_cert_effective_date-property-pdfverify-struct) - [blocked_cert_encoded](#blocked_cert_encoded-property-pdfverify-struct) - [blocked_cert_expiration_date](#blocked_cert_expiration_date-property-pdfverify-struct) - [blocked_cert_extended_key_usage](#blocked_cert_extended_key_usage-property-pdfverify-struct) - [blocked_cert_fingerprint](#blocked_cert_fingerprint-property-pdfverify-struct) - [blocked_cert_fingerprint_sha1](#blocked_cert_fingerprint_sha1-property-pdfverify-struct) - [blocked_cert_fingerprint_sha256](#blocked_cert_fingerprint_sha256-property-pdfverify-struct) - [blocked_cert_issuer](#blocked_cert_issuer-property-pdfverify-struct) - [blocked_cert_private_key](#blocked_cert_private_key-property-pdfverify-struct) - [blocked_cert_private_key_available](#blocked_cert_private_key_available-property-pdfverify-struct) - [blocked_cert_private_key_container](#blocked_cert_private_key_container-property-pdfverify-struct) - [blocked_cert_public_key](#blocked_cert_public_key-property-pdfverify-struct) - [blocked_cert_public_key_algorithm](#blocked_cert_public_key_algorithm-property-pdfverify-struct) - [blocked_cert_public_key_length](#blocked_cert_public_key_length-property-pdfverify-struct) - [blocked_cert_serial_number](#blocked_cert_serial_number-property-pdfverify-struct) - [blocked_cert_signature_algorithm](#blocked_cert_signature_algorithm-property-pdfverify-struct) - [blocked_cert_store](#blocked_cert_store-property-pdfverify-struct) - [blocked_cert_store_password](#blocked_cert_store_password-property-pdfverify-struct) - [blocked_cert_store_type](#blocked_cert_store_type-property-pdfverify-struct) - [blocked_cert_subject](#blocked_cert_subject-property-pdfverify-struct) - [blocked_cert_subject_alt_names](#blocked_cert_subject_alt_names-property-pdfverify-struct) - [blocked_cert_thumbprint_md5](#blocked_cert_thumbprint_md5-property-pdfverify-struct) - [blocked_cert_thumbprint_sha1](#blocked_cert_thumbprint_sha1-property-pdfverify-struct) - [blocked_cert_thumbprint_sha256](#blocked_cert_thumbprint_sha256-property-pdfverify-struct) - [blocked_cert_usage](#blocked_cert_usage-property-pdfverify-struct) - [blocked_cert_usage_flags](#blocked_cert_usage_flags-property-pdfverify-struct) - [blocked_cert_version](#blocked_cert_version-property-pdfverify-struct) The array indices start at *0* and end at *blocked_cert_count - 1*. ## Data Type i32 # blocked_cert_effective_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn blocked_cert_effective_date(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_expiration_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn blocked_cert_expiration_date(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_extended_key_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn blocked_cert_extended_key_usage(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_fingerprint property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_fingerprint(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_fingerprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_fingerprint_sha1(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_fingerprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_fingerprint_sha256(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_issuer property ([PDFVerify](#struct-securepdfpdfverify) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_issuer(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_private_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn blocked_cert_private_key(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [blocked_cert_private_key](#blocked_cert_private_key-property-pdfverify-struct) may be available but not exportable. In this case, [blocked_cert_private_key](#blocked_cert_private_key-property-pdfverify-struct) returns an empty string. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_private_key_available property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_private_key_available(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether a [blocked_cert_private_key](#blocked_cert_private_key-property-pdfverify-struct) is available for the selected certificate. If [blocked_cert_private_key_available](#blocked_cert_private_key_available-property-pdfverify-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type bool # blocked_cert_private_key_container property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn blocked_cert_private_key_container(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the [blocked_cert_private_key](#blocked_cert_private_key-property-pdfverify-struct) container for the certificate (if available). This functionality is available only on Windows platforms. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_public_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_public_key(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_public_key_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn blocked_cert_public_key_algorithm(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_public_key_length property ([PDFVerify](#struct-securepdfpdfverify) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn blocked_cert_public_key_length(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # blocked_cert_serial_number property ([PDFVerify](#struct-securepdfpdfverify) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn blocked_cert_serial_number(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_signature_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn blocked_cert_signature_algorithm(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_store property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_store(&self , BlockedCertIndex : i32) -> Result, SecurePDFError> fn set_blocked_cert_store(&self, BlockedCertIndex : i32, value : Vec) -> Option fn set_blocked_cert_store_ref(&self, BlockedCertIndex : i32, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [blocked_cert_store_type](#blocked_cert_store_type-property-pdfverify-struct) property denotes the type of the certificate store specified by [blocked_cert_store](#blocked_cert_store-property-pdfverify-struct). If the store is password-protected, specify the password in [blocked_cert_store_password](#blocked_cert_store_password-property-pdfverify-struct). [blocked_cert_store](#blocked_cert_store-property-pdfverify-struct) is used in conjunction with the [blocked_cert_subject](#blocked_cert_subject-property-pdfverify-struct) property to specify client certificates. If [blocked_cert_store](#blocked_cert_store-property-pdfverify-struct) has a value, and [blocked_cert_subject](#blocked_cert_subject-property-pdfverify-struct) or [blocked_cert_encoded](#blocked_cert_encoded-property-pdfverify-struct) is set, a search for a certificate is initiated. Please see the [blocked_cert_subject](#blocked_cert_subject-property-pdfverify-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. ## Data Type Vec # blocked_cert_store_password property ([PDFVerify](#struct-securepdfpdfverify) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn blocked_cert_store_password(&self , BlockedCertIndex : i32) -> Result fn set_blocked_cert_store_password(&self, BlockedCertIndex : i32, value : &str) -> Option fn set_blocked_cert_store_password_ref(&self, BlockedCertIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. ## Data Type String # blocked_cert_store_type property ([PDFVerify](#struct-securepdfpdfverify) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_store_type(&self , BlockedCertIndex : i32) -> Result fn set_blocked_cert_store_type(&self, BlockedCertIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [blocked_cert_store_type](#blocked_cert_store_type-property-pdfverify-struct), the full path of the PKCS#11 DLL as the [blocked_cert_store](#blocked_cert_store-property-pdfverify-struct), and the PIN as the [blocked_cert_store_password](#blocked_cert_store_password-property-pdfverify-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [blocked_cert_store](#blocked_cert_store-property-pdfverify-struct) and set [blocked_cert_store_password](#blocked_cert_store_password-property-pdfverify-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. ## Data Type i32 # blocked_cert_subject_alt_names property ([PDFVerify](#struct-securepdfpdfverify) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_subject_alt_names(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_thumbprint_md5 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_thumbprint_md5(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_thumbprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_thumbprint_sha1(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_thumbprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_thumbprint_sha256(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn blocked_cert_usage(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of [blocked_cert_usage_flags](#blocked_cert_usage_flags-property-pdfverify-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_usage_flags property ([PDFVerify](#struct-securepdfpdfverify) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn blocked_cert_usage_flags(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [blocked_cert_usage_flags](#blocked_cert_usage_flags-property-pdfverify-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [blocked_cert_usage](#blocked_cert_usage-property-pdfverify-struct) property for a text representation of [blocked_cert_usage_flags](#blocked_cert_usage_flags-property-pdfverify-struct). This functionality currently is not available when the provider is OpenSSL. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # blocked_cert_version property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn blocked_cert_version(&self , BlockedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # blocked_cert_subject property ([PDFVerify](#struct-securepdfpdfverify) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn blocked_cert_subject(&self , BlockedCertIndex : i32) -> Result fn set_blocked_cert_subject(&self, BlockedCertIndex : i32, value : &str) -> Option fn set_blocked_cert_subject_ref(&self, BlockedCertIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. ## Data Type String # blocked_cert_encoded property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn blocked_cert_encoded(&self , BlockedCertIndex : i32) -> Result, SecurePDFError> fn set_blocked_cert_encoded(&self, BlockedCertIndex : i32, value : Vec) -> Option fn set_blocked_cert_encoded_ref(&self, BlockedCertIndex : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [blocked_cert_store](#blocked_cert_store-property-pdfverify-struct) and [blocked_cert_subject](#blocked_cert_subject-property-pdfverify-struct) properties also may be used to specify a certificate. When [blocked_cert_encoded](#blocked_cert_encoded-property-pdfverify-struct) is set, a search is initiated in the current [blocked_cert_store](#blocked_cert_store-property-pdfverify-struct) for the private key of the certificate. If the key is found, [blocked_cert_subject](#blocked_cert_subject-property-pdfverify-struct) is updated to reflect the full subject of the selected certificate; otherwise, [blocked_cert_subject](#blocked_cert_subject-property-pdfverify-struct) is set to an empty string. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blocked_cert_count-property-pdfverify-struct) property. ## Data Type Vec # decryption_cert_effective_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn decryption_cert_effective_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # decryption_cert_expiration_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn decryption_cert_expiration_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # decryption_cert_extended_key_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn decryption_cert_extended_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # decryption_cert_fingerprint property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_fingerprint(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # decryption_cert_fingerprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_fingerprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # decryption_cert_fingerprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_fingerprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # decryption_cert_issuer property ([PDFVerify](#struct-securepdfpdfverify) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_issuer(&self ) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # decryption_cert_private_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn decryption_cert_private_key(&self ) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [decryption_cert_private_key](#decryption_cert_private_key-property-pdfverify-struct) may be available but not exportable. In this case, [decryption_cert_private_key](#decryption_cert_private_key-property-pdfverify-struct) returns an empty string. This property is read-only. ## Data Type String # decryption_cert_private_key_available property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [decryption_cert_private_key](#decryption_cert_private_key-property-pdfverify-struct) is available for the selected certificate. If [decryption_cert_private_key_available](#decryption_cert_private_key_available-property-pdfverify-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # decryption_cert_private_key_container property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn decryption_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [decryption_cert_private_key](#decryption_cert_private_key-property-pdfverify-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # decryption_cert_public_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_public_key(&self ) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # decryption_cert_public_key_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn decryption_cert_public_key_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # decryption_cert_public_key_length property ([PDFVerify](#struct-securepdfpdfverify) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn decryption_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # decryption_cert_serial_number property ([PDFVerify](#struct-securepdfpdfverify) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn decryption_cert_serial_number(&self ) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # decryption_cert_signature_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn decryption_cert_signature_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # decryption_cert_store property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_store(&self ) -> Result, SecurePDFError> fn set_decryption_cert_store(&self, value : Vec) -> Option fn set_decryption_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [decryption_cert_store_type](#decryption_cert_store_type-property-pdfverify-struct) property denotes the type of the certificate store specified by [decryption_cert_store](#decryption_cert_store-property-pdfverify-struct). If the store is password-protected, specify the password in [decryption_cert_store_password](#decryption_cert_store_password-property-pdfverify-struct). [decryption_cert_store](#decryption_cert_store-property-pdfverify-struct) is used in conjunction with the [decryption_cert_subject](#decryption_cert_subject-property-pdfverify-struct) property to specify client certificates. If [decryption_cert_store](#decryption_cert_store-property-pdfverify-struct) has a value, and [decryption_cert_subject](#decryption_cert_subject-property-pdfverify-struct) or [decryption_cert_encoded](#decryption_cert_encoded-property-pdfverify-struct) is set, a search for a certificate is initiated. Please see the [decryption_cert_subject](#decryption_cert_subject-property-pdfverify-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type Vec # decryption_cert_store_password property ([PDFVerify](#struct-securepdfpdfverify) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn decryption_cert_store_password(&self ) -> Result fn set_decryption_cert_store_password(&self, value : &str) -> Option fn set_decryption_cert_store_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # decryption_cert_store_type property ([PDFVerify](#struct-securepdfpdfverify) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_store_type(&self ) -> Result fn set_decryption_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [decryption_cert_store_type](#decryption_cert_store_type-property-pdfverify-struct), the full path of the PKCS#11 DLL as the [decryption_cert_store](#decryption_cert_store-property-pdfverify-struct), and the PIN as the [decryption_cert_store_password](#decryption_cert_store_password-property-pdfverify-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [decryption_cert_store](#decryption_cert_store-property-pdfverify-struct) and set [decryption_cert_store_password](#decryption_cert_store_password-property-pdfverify-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # decryption_cert_subject_alt_names property ([PDFVerify](#struct-securepdfpdfverify) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # decryption_cert_thumbprint_md5 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_thumbprint_md5(&self ) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # decryption_cert_thumbprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_thumbprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # decryption_cert_thumbprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_thumbprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # decryption_cert_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn decryption_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [decryption_cert_usage_flags](#decryption_cert_usage_flags-property-pdfverify-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # decryption_cert_usage_flags property ([PDFVerify](#struct-securepdfpdfverify) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [decryption_cert_usage_flags](#decryption_cert_usage_flags-property-pdfverify-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [decryption_cert_usage](#decryption_cert_usage-property-pdfverify-struct) property for a text representation of [decryption_cert_usage_flags](#decryption_cert_usage_flags-property-pdfverify-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # decryption_cert_version property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn decryption_cert_version(&self ) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # decryption_cert_subject property ([PDFVerify](#struct-securepdfpdfverify) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn decryption_cert_subject(&self ) -> Result fn set_decryption_cert_subject(&self, value : &str) -> Option fn set_decryption_cert_subject_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # decryption_cert_encoded property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn decryption_cert_encoded(&self ) -> Result, SecurePDFError> fn set_decryption_cert_encoded(&self, value : Vec) -> Option fn set_decryption_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [decryption_cert_store](#decryption_cert_store-property-pdfverify-struct) and [decryption_cert_subject](#decryption_cert_subject-property-pdfverify-struct) properties also may be used to specify a certificate. When [decryption_cert_encoded](#decryption_cert_encoded-property-pdfverify-struct) is set, a search is initiated in the current [decryption_cert_store](#decryption_cert_store-property-pdfverify-struct) for the private key of the certificate. If the key is found, [decryption_cert_subject](#decryption_cert_subject-property-pdfverify-struct) is updated to reflect the full subject of the selected certificate; otherwise, [decryption_cert_subject](#decryption_cert_subject-property-pdfverify-struct) is set to an empty string. ## Data Type Vec # document_cert_count property ([PDFVerify](#struct-securepdfpdfverify) Struct) The number of records in the DocumentCert arrays. ## Syntax *Rust Syntax* ```text fn document_cert_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [document_cert_effective_date](#document_cert_effective_date-property-pdfverify-struct) - [document_cert_encoded](#document_cert_encoded-property-pdfverify-struct) - [document_cert_expiration_date](#document_cert_expiration_date-property-pdfverify-struct) - [document_cert_extended_key_usage](#document_cert_extended_key_usage-property-pdfverify-struct) - [document_cert_fingerprint](#document_cert_fingerprint-property-pdfverify-struct) - [document_cert_fingerprint_sha1](#document_cert_fingerprint_sha1-property-pdfverify-struct) - [document_cert_fingerprint_sha256](#document_cert_fingerprint_sha256-property-pdfverify-struct) - [document_cert_issuer](#document_cert_issuer-property-pdfverify-struct) - [document_cert_private_key](#document_cert_private_key-property-pdfverify-struct) - [document_cert_private_key_available](#document_cert_private_key_available-property-pdfverify-struct) - [document_cert_private_key_container](#document_cert_private_key_container-property-pdfverify-struct) - [document_cert_public_key](#document_cert_public_key-property-pdfverify-struct) - [document_cert_public_key_algorithm](#document_cert_public_key_algorithm-property-pdfverify-struct) - [document_cert_public_key_length](#document_cert_public_key_length-property-pdfverify-struct) - [document_cert_serial_number](#document_cert_serial_number-property-pdfverify-struct) - [document_cert_signature_algorithm](#document_cert_signature_algorithm-property-pdfverify-struct) - [document_cert_store](#document_cert_store-property-pdfverify-struct) - [document_cert_store_password](#document_cert_store_password-property-pdfverify-struct) - [document_cert_store_type](#document_cert_store_type-property-pdfverify-struct) - [document_cert_subject](#document_cert_subject-property-pdfverify-struct) - [document_cert_subject_alt_names](#document_cert_subject_alt_names-property-pdfverify-struct) - [document_cert_thumbprint_md5](#document_cert_thumbprint_md5-property-pdfverify-struct) - [document_cert_thumbprint_sha1](#document_cert_thumbprint_sha1-property-pdfverify-struct) - [document_cert_thumbprint_sha256](#document_cert_thumbprint_sha256-property-pdfverify-struct) - [document_cert_usage](#document_cert_usage-property-pdfverify-struct) - [document_cert_usage_flags](#document_cert_usage_flags-property-pdfverify-struct) - [document_cert_version](#document_cert_version-property-pdfverify-struct) The array indices start at *0* and end at *document_cert_count - 1*. This property is read-only. ## Data Type i32 # document_cert_effective_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn document_cert_effective_date(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_expiration_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn document_cert_expiration_date(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_extended_key_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn document_cert_extended_key_usage(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_fingerprint property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_fingerprint(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_fingerprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_fingerprint_sha1(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_fingerprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_fingerprint_sha256(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_issuer property ([PDFVerify](#struct-securepdfpdfverify) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_issuer(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_private_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn document_cert_private_key(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [document_cert_private_key](#document_cert_private_key-property-pdfverify-struct) may be available but not exportable. In this case, [document_cert_private_key](#document_cert_private_key-property-pdfverify-struct) returns an empty string. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_private_key_available property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn document_cert_private_key_available(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether a [document_cert_private_key](#document_cert_private_key-property-pdfverify-struct) is available for the selected certificate. If [document_cert_private_key_available](#document_cert_private_key_available-property-pdfverify-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type bool # document_cert_private_key_container property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn document_cert_private_key_container(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the [document_cert_private_key](#document_cert_private_key-property-pdfverify-struct) container for the certificate (if available). This functionality is available only on Windows platforms. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_public_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_public_key(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_public_key_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn document_cert_public_key_algorithm(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_public_key_length property ([PDFVerify](#struct-securepdfpdfverify) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn document_cert_public_key_length(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # document_cert_serial_number property ([PDFVerify](#struct-securepdfpdfverify) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn document_cert_serial_number(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_signature_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn document_cert_signature_algorithm(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_store property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn document_cert_store(&self , DocumentCertIndex : i32) -> Result, SecurePDFError> ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [document_cert_store_type](#document_cert_store_type-property-pdfverify-struct) property denotes the type of the certificate store specified by [document_cert_store](#document_cert_store-property-pdfverify-struct). If the store is password-protected, specify the password in [document_cert_store_password](#document_cert_store_password-property-pdfverify-struct). [document_cert_store](#document_cert_store-property-pdfverify-struct) is used in conjunction with the [document_cert_subject](#document_cert_subject-property-pdfverify-struct) property to specify client certificates. If [document_cert_store](#document_cert_store-property-pdfverify-struct) has a value, and [document_cert_subject](#document_cert_subject-property-pdfverify-struct) or [document_cert_encoded](#document_cert_encoded-property-pdfverify-struct) is set, a search for a certificate is initiated. Please see the [document_cert_subject](#document_cert_subject-property-pdfverify-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type Vec # document_cert_store_password property ([PDFVerify](#struct-securepdfpdfverify) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn document_cert_store_password(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_store_type property ([PDFVerify](#struct-securepdfpdfverify) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn document_cert_store_type(&self , DocumentCertIndex : i32) -> Result ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [document_cert_store_type](#document_cert_store_type-property-pdfverify-struct), the full path of the PKCS#11 DLL as the [document_cert_store](#document_cert_store-property-pdfverify-struct), and the PIN as the [document_cert_store_password](#document_cert_store_password-property-pdfverify-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [document_cert_store](#document_cert_store-property-pdfverify-struct) and set [document_cert_store_password](#document_cert_store_password-property-pdfverify-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # document_cert_subject_alt_names property ([PDFVerify](#struct-securepdfpdfverify) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_subject_alt_names(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_thumbprint_md5 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_thumbprint_md5(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_thumbprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_thumbprint_sha1(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_thumbprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_thumbprint_sha256(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn document_cert_usage(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of [document_cert_usage_flags](#document_cert_usage_flags-property-pdfverify-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_usage_flags property ([PDFVerify](#struct-securepdfpdfverify) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn document_cert_usage_flags(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [document_cert_usage_flags](#document_cert_usage_flags-property-pdfverify-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [document_cert_usage](#document_cert_usage-property-pdfverify-struct) property for a text representation of [document_cert_usage_flags](#document_cert_usage_flags-property-pdfverify-struct). This functionality currently is not available when the provider is OpenSSL. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # document_cert_version property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn document_cert_version(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_subject property ([PDFVerify](#struct-securepdfpdfverify) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn document_cert_subject(&self , DocumentCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # document_cert_encoded property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn document_cert_encoded(&self , DocumentCertIndex : i32) -> Result, SecurePDFError> ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [document_cert_store](#document_cert_store-property-pdfverify-struct) and [document_cert_subject](#document_cert_subject-property-pdfverify-struct) properties also may be used to specify a certificate. When [document_cert_encoded](#document_cert_encoded-property-pdfverify-struct) is set, a search is initiated in the current [document_cert_store](#document_cert_store-property-pdfverify-struct) for the private key of the certificate. If the key is found, [document_cert_subject](#document_cert_subject-property-pdfverify-struct) is updated to reflect the full subject of the selected certificate; otherwise, [document_cert_subject](#document_cert_subject-property-pdfverify-struct) is set to an empty string. The *DocumentCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#document_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type Vec # firewall_auto_detect property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether to automatically detect and use firewall system settings, if available. ## Syntax *Rust Syntax* ```text fn firewall_auto_detect(&self ) -> Result fn set_firewall_auto_detect(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type bool # firewall_type property ([PDFVerify](#struct-securepdfpdfverify) Struct) The type of firewall to connect through. ## Syntax *Rust Syntax* ```text fn firewall_type(&self ) -> Result fn set_firewall_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // Tunnel2 // SOCKS43 // SOCKS510 // SOCKS4A ``` ## Default Value 0 ## Remarks The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [firewall_port](#firewall_port-property-pdfverify-struct) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property-pdfverify-struct) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property-pdfverify-struct) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property-pdfverify-struct) is set to 1080. | ## Data Type i32 # firewall_host property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name or IP address of the firewall (optional). ## Syntax *Rust Syntax* ```text fn firewall_host(&self ) -> Result fn set_firewall_host(&self, value : &str) -> Option fn set_firewall_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property-pdfverify-struct) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error. ## Data Type String # firewall_password property ([PDFVerify](#struct-securepdfpdfverify) Struct) A password if authentication is to be used when connecting through the firewall. ## Syntax *Rust Syntax* ```text fn firewall_password(&self ) -> Result fn set_firewall_password(&self, value : &str) -> Option fn set_firewall_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property-pdfverify-struct) is specified, the [firewall_user](#firewall_user-property-pdfverify-struct) and [firewall_password](#firewall_password-property-pdfverify-struct) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. ## Data Type String # firewall_port property ([PDFVerify](#struct-securepdfpdfverify) Struct) The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax *Rust Syntax* ```text fn firewall_port(&self ) -> Result fn set_firewall_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property-pdfverify-struct). See the description of the [firewall_host](#firewall_host-property-pdfverify-struct) property for details. NOTE: This property is set automatically when [firewall_firewall_type](#PDFVerify_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_firewall_type](#PDFVerify_p_FirewallFirewallType) property for details. ## Data Type i32 # firewall_user property ([PDFVerify](#struct-securepdfpdfverify) Struct) A username if authentication is to be used when connecting through a firewall. ## Syntax *Rust Syntax* ```text fn firewall_user(&self ) -> Result fn set_firewall_user(&self, value : &str) -> Option fn set_firewall_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property-pdfverify-struct) is specified, this property and the [firewall_password](#firewall_password-property-pdfverify-struct) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error. ## Data Type String # input_data property ([PDFVerify](#struct-securepdfpdfverify) Struct) A byte array containing the PDF document to process. ## Syntax *Rust Syntax* ```text fn input_data(&self ) -> Result, SecurePDFError> fn set_input_data(&self, value : Vec) -> Option fn set_input_data_ref(&self, value : &[u8]) -> Option ``` ## Remarks This property is used to assign a byte array containing the PDF document to be processed. ## Data Type Vec # input_file property ([PDFVerify](#struct-securepdfpdfverify) Struct) The PDF file to process. ## Syntax *Rust Syntax* ```text fn input_file(&self ) -> Result fn set_input_file(&self, value : &str) -> Option fn set_input_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property is used to provide a path to the PDF document to be processed. ## Data Type String # known_cert_count property ([PDFVerify](#struct-securepdfpdfverify) Struct) The number of records in the KnownCert arrays. ## Syntax *Rust Syntax* ```text fn known_cert_count(&self ) -> Result fn set_known_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_cert_effective_date](#known_cert_effective_date-property-pdfverify-struct) - [known_cert_encoded](#known_cert_encoded-property-pdfverify-struct) - [known_cert_expiration_date](#known_cert_expiration_date-property-pdfverify-struct) - [known_cert_extended_key_usage](#known_cert_extended_key_usage-property-pdfverify-struct) - [known_cert_fingerprint](#known_cert_fingerprint-property-pdfverify-struct) - [known_cert_fingerprint_sha1](#known_cert_fingerprint_sha1-property-pdfverify-struct) - [known_cert_fingerprint_sha256](#known_cert_fingerprint_sha256-property-pdfverify-struct) - [known_cert_issuer](#known_cert_issuer-property-pdfverify-struct) - [known_cert_private_key](#known_cert_private_key-property-pdfverify-struct) - [known_cert_private_key_available](#known_cert_private_key_available-property-pdfverify-struct) - [known_cert_private_key_container](#known_cert_private_key_container-property-pdfverify-struct) - [known_cert_public_key](#known_cert_public_key-property-pdfverify-struct) - [known_cert_public_key_algorithm](#known_cert_public_key_algorithm-property-pdfverify-struct) - [known_cert_public_key_length](#known_cert_public_key_length-property-pdfverify-struct) - [known_cert_serial_number](#known_cert_serial_number-property-pdfverify-struct) - [known_cert_signature_algorithm](#known_cert_signature_algorithm-property-pdfverify-struct) - [known_cert_store](#known_cert_store-property-pdfverify-struct) - [known_cert_store_password](#known_cert_store_password-property-pdfverify-struct) - [known_cert_store_type](#known_cert_store_type-property-pdfverify-struct) - [known_cert_subject](#known_cert_subject-property-pdfverify-struct) - [known_cert_subject_alt_names](#known_cert_subject_alt_names-property-pdfverify-struct) - [known_cert_thumbprint_md5](#known_cert_thumbprint_md5-property-pdfverify-struct) - [known_cert_thumbprint_sha1](#known_cert_thumbprint_sha1-property-pdfverify-struct) - [known_cert_thumbprint_sha256](#known_cert_thumbprint_sha256-property-pdfverify-struct) - [known_cert_usage](#known_cert_usage-property-pdfverify-struct) - [known_cert_usage_flags](#known_cert_usage_flags-property-pdfverify-struct) - [known_cert_version](#known_cert_version-property-pdfverify-struct) The array indices start at *0* and end at *known_cert_count - 1*. ## Data Type i32 # known_cert_effective_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn known_cert_effective_date(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_expiration_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn known_cert_expiration_date(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_extended_key_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn known_cert_extended_key_usage(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_fingerprint property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_fingerprint(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_fingerprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_fingerprint_sha1(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_fingerprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_fingerprint_sha256(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_issuer property ([PDFVerify](#struct-securepdfpdfverify) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_issuer(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_private_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn known_cert_private_key(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [known_cert_private_key](#known_cert_private_key-property-pdfverify-struct) may be available but not exportable. In this case, [known_cert_private_key](#known_cert_private_key-property-pdfverify-struct) returns an empty string. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_private_key_available property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn known_cert_private_key_available(&self , KnownCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether a [known_cert_private_key](#known_cert_private_key-property-pdfverify-struct) is available for the selected certificate. If [known_cert_private_key_available](#known_cert_private_key_available-property-pdfverify-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type bool # known_cert_private_key_container property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn known_cert_private_key_container(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the [known_cert_private_key](#known_cert_private_key-property-pdfverify-struct) container for the certificate (if available). This functionality is available only on Windows platforms. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_public_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_public_key(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_public_key_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn known_cert_public_key_algorithm(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_public_key_length property ([PDFVerify](#struct-securepdfpdfverify) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn known_cert_public_key_length(&self , KnownCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # known_cert_serial_number property ([PDFVerify](#struct-securepdfpdfverify) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn known_cert_serial_number(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_signature_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn known_cert_signature_algorithm(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_store property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn known_cert_store(&self , KnownCertIndex : i32) -> Result, SecurePDFError> fn set_known_cert_store(&self, KnownCertIndex : i32, value : Vec) -> Option fn set_known_cert_store_ref(&self, KnownCertIndex : i32, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [known_cert_store_type](#known_cert_store_type-property-pdfverify-struct) property denotes the type of the certificate store specified by [known_cert_store](#known_cert_store-property-pdfverify-struct). If the store is password-protected, specify the password in [known_cert_store_password](#known_cert_store_password-property-pdfverify-struct). [known_cert_store](#known_cert_store-property-pdfverify-struct) is used in conjunction with the [known_cert_subject](#known_cert_subject-property-pdfverify-struct) property to specify client certificates. If [known_cert_store](#known_cert_store-property-pdfverify-struct) has a value, and [known_cert_subject](#known_cert_subject-property-pdfverify-struct) or [known_cert_encoded](#known_cert_encoded-property-pdfverify-struct) is set, a search for a certificate is initiated. Please see the [known_cert_subject](#known_cert_subject-property-pdfverify-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. ## Data Type Vec # known_cert_store_password property ([PDFVerify](#struct-securepdfpdfverify) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn known_cert_store_password(&self , KnownCertIndex : i32) -> Result fn set_known_cert_store_password(&self, KnownCertIndex : i32, value : &str) -> Option fn set_known_cert_store_password_ref(&self, KnownCertIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. ## Data Type String # known_cert_store_type property ([PDFVerify](#struct-securepdfpdfverify) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn known_cert_store_type(&self , KnownCertIndex : i32) -> Result fn set_known_cert_store_type(&self, KnownCertIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [known_cert_store_type](#known_cert_store_type-property-pdfverify-struct), the full path of the PKCS#11 DLL as the [known_cert_store](#known_cert_store-property-pdfverify-struct), and the PIN as the [known_cert_store_password](#known_cert_store_password-property-pdfverify-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [known_cert_store](#known_cert_store-property-pdfverify-struct) and set [known_cert_store_password](#known_cert_store_password-property-pdfverify-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. ## Data Type i32 # known_cert_subject_alt_names property ([PDFVerify](#struct-securepdfpdfverify) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_subject_alt_names(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_thumbprint_md5 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_thumbprint_md5(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_thumbprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_thumbprint_sha1(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_thumbprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_thumbprint_sha256(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn known_cert_usage(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of [known_cert_usage_flags](#known_cert_usage_flags-property-pdfverify-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_usage_flags property ([PDFVerify](#struct-securepdfpdfverify) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn known_cert_usage_flags(&self , KnownCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [known_cert_usage_flags](#known_cert_usage_flags-property-pdfverify-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [known_cert_usage](#known_cert_usage-property-pdfverify-struct) property for a text representation of [known_cert_usage_flags](#known_cert_usage_flags-property-pdfverify-struct). This functionality currently is not available when the provider is OpenSSL. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # known_cert_version property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn known_cert_version(&self , KnownCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # known_cert_subject property ([PDFVerify](#struct-securepdfpdfverify) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn known_cert_subject(&self , KnownCertIndex : i32) -> Result fn set_known_cert_subject(&self, KnownCertIndex : i32, value : &str) -> Option fn set_known_cert_subject_ref(&self, KnownCertIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. ## Data Type String # known_cert_encoded property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn known_cert_encoded(&self , KnownCertIndex : i32) -> Result, SecurePDFError> fn set_known_cert_encoded(&self, KnownCertIndex : i32, value : Vec) -> Option fn set_known_cert_encoded_ref(&self, KnownCertIndex : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [known_cert_store](#known_cert_store-property-pdfverify-struct) and [known_cert_subject](#known_cert_subject-property-pdfverify-struct) properties also may be used to specify a certificate. When [known_cert_encoded](#known_cert_encoded-property-pdfverify-struct) is set, a search is initiated in the current [known_cert_store](#known_cert_store-property-pdfverify-struct) for the private key of the certificate. If the key is found, [known_cert_subject](#known_cert_subject-property-pdfverify-struct) is updated to reflect the full subject of the selected certificate; otherwise, [known_cert_subject](#known_cert_subject-property-pdfverify-struct) is set to an empty string. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#known_cert_count-property-pdfverify-struct) property. ## Data Type Vec # offline_mode property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether the struct is operating in offline mode. ## Syntax *Rust Syntax* ```text fn offline_mode(&self ) -> Result fn set_offline_mode(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property indicates whether the struct should operate in offline mode. In offline mode, the struct restricts itself from accessing online Trusted Lists and revocation information sources such as CRLs or OCSP responders. It may be useful to set this property to *true* if there is a need to verify the completeness of the validation information included within the signature or provided via known_certs. ## Data Type bool # output_data property ([PDFVerify](#struct-securepdfpdfverify) Struct) A byte array containing the PDF document after processing. ## Syntax *Rust Syntax* ```text fn output_data(&self ) -> Result, SecurePDFError> ``` ## Remarks This property is used to read the byte array containing the produced output after the operation has completed. It is only set if an output file and output stream have not been assigned via [output_file](#output_file-property-pdfverify-struct) and set_output_stream respectively. This property is read-only. ## Data Type Vec # output_file property ([PDFVerify](#struct-securepdfpdfverify) Struct) The path to a local file where the output is written. ## Syntax *Rust Syntax* ```text fn output_file(&self ) -> Result fn set_output_file(&self, value : &str) -> Option fn set_output_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property is used to provide a path where the resulting PDF document is saved after the operation has completed. ## Data Type String # overwrite property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether the struct should overwrite files. ## Syntax *Rust Syntax* ```text fn overwrite(&self ) -> Result fn set_overwrite(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property indicates whether the struct overwrites [output_file](#output_file-property-pdfverify-struct). If set to *false*, an error is thrown whenever [output_file](#output_file-property-pdfverify-struct) exists before an operation. ## Data Type bool # password property ([PDFVerify](#struct-securepdfpdfverify) Struct) The password to decrypt the document with. ## Syntax *Rust Syntax* ```text fn password(&self ) -> Result fn set_password(&self, value : &str) -> Option fn set_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property is used to provide the user password for decryption. Though it may be different from [OwnerPassword](#OwnerPassword), most implementations use the same value for both. ## Data Type String # proxy_auth_scheme property ([PDFVerify](#struct-securepdfpdfverify) Struct) The type of authorization to perform when connecting to the proxy. ## Syntax *Rust Syntax* ```text fn proxy_auth_scheme(&self ) -> Result fn set_proxy_auth_scheme(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Basic1 // Digest2 // Proprietary3 // None4 // Ntlm5 // Negotiate ``` ## Default Value 0 ## Remarks The type of authorization to perform when connecting to the proxy. This is used only when the [proxy_user](#proxy_user-property-pdfverify-struct) and [proxy_password](#proxy_password-property-pdfverify-struct) properties are set. [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) should be set to authNone (3) when no authentication is expected. By default, [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is authBasic (0), and if the [proxy_user](#proxy_user-property-pdfverify-struct) and [proxy_password](#proxy_password-property-pdfverify-struct) properties are set, the struct will attempt basic authentication. If [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is set to authDigest (1), digest authentication will be attempted instead. If [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token. If [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [proxy_user](#proxy_user-property-pdfverify-struct) and [proxy_password](#proxy_password-property-pdfverify-struct). ## Data Type i32 # proxy_auto_detect property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether to automatically detect and use proxy system settings, if available. ## Syntax *Rust Syntax* ```text fn proxy_auto_detect(&self ) -> Result fn set_proxy_auto_detect(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Whether to automatically detect and use proxy system settings, if available. The default value is *false*. ## Data Type bool # proxy_password property ([PDFVerify](#struct-securepdfpdfverify) Struct) A password if authentication is to be used for the proxy. ## Syntax *Rust Syntax* ```text fn proxy_password(&self ) -> Result fn set_proxy_password(&self, value : &str) -> Option fn set_proxy_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A password if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is set to Basic Authentication, the [proxy_user](#proxy_user-property-pdfverify-struct) and [proxy_password](#proxy_password-property-pdfverify-struct) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is set to Digest Authentication, the [proxy_user](#proxy_user-property-pdfverify-struct) and [proxy_password](#proxy_password-property-pdfverify-struct) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is set to NTLM Authentication, the [proxy_user](#proxy_user-property-pdfverify-struct) and [proxy_password](#proxy_password-property-pdfverify-struct) properties are used to authenticate through NTLM negotiation. ## Data Type String # proxy_port property ([PDFVerify](#struct-securepdfpdfverify) Struct) The Transmission Control Protocol (TCP) port for the proxy Server (default 80). ## Syntax *Rust Syntax* ```text fn proxy_port(&self ) -> Result fn set_proxy_port(&self, value : i32) -> Option ``` ## Default Value 80 ## Remarks The Transmission Control Protocol (TCP) port for the proxy [proxy_server](#proxy_server-property-pdfverify-struct) (default 80). See the description of the [proxy_server](#proxy_server-property-pdfverify-struct) property for details. ## Data Type i32 # proxy_server property ([PDFVerify](#struct-securepdfpdfverify) Struct) If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. ## Syntax *Rust Syntax* ```text fn proxy_server(&self ) -> Result fn set_proxy_server(&self, value : &str) -> Option fn set_proxy_server_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks If a proxy [proxy_server](#proxy_server-property-pdfverify-struct) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [proxy_server](#proxy_server-property-pdfverify-struct) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [proxy_server](#proxy_server-property-pdfverify-struct) property is set to the corresponding address. If the search is not successful, an error is returned. ## Data Type String # proxy_ssl property ([PDFVerify](#struct-securepdfpdfverify) Struct) When to use a Secure Sockets Layer (SSL) for the connection to the proxy. ## Syntax *Rust Syntax* ```text fn proxy_ssl(&self ) -> Result fn set_proxy_ssl(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Automatic1 // Always2 // Never3 // Tunnel ``` ## Default Value 0 ## Remarks When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the struct will use the psTunnel option. If the URL is an http URL, the struct will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | ## Data Type i32 # proxy_user property ([PDFVerify](#struct-securepdfpdfverify) Struct) A username if authentication is to be used for the proxy. ## Syntax *Rust Syntax* ```text fn proxy_user(&self ) -> Result fn set_proxy_user(&self, value : &str) -> Option fn set_proxy_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A username if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is set to Basic Authentication, the [proxy_user](#proxy_user-property-pdfverify-struct) and [proxy_password](#proxy_password-property-pdfverify-struct) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is set to Digest Authentication, the [proxy_user](#proxy_user-property-pdfverify-struct) and [proxy_password](#proxy_password-property-pdfverify-struct) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property-pdfverify-struct) is set to NTLM Authentication, the [proxy_user](#proxy_user-property-pdfverify-struct) and [proxy_password](#proxy_password-property-pdfverify-struct) properties are used to authenticate through NTLM negotiation. ## Data Type String # revocation_check property ([PDFVerify](#struct-securepdfpdfverify) Struct) The kind(s) of revocation check to perform for all chain certificates. ## Syntax *Rust Syntax* ```text fn revocation_check(&self ) -> Result fn set_revocation_check(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // AllCRL1 // AllOCSP2 // AllCRLAndOCSP3 // AnyCRL4 // AnyOCSP5 // AnyCRLOrOCSP6 // AnyOCSPOrCRL ``` ## Default Value 6 ## Remarks This property is used to specify the revocation sources and preferences the struct uses during chain validation. Revocation checking is necessary to ensure the integrity of the chain and to obtain up-to-date certificate validity and trust information. Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate has not been revoked by the Certificate Authority (CA) at the time of use. Depending on the circumstances and security policy requirements, either one or both of the revocation information source types may be used. Possible values are: | | | | --- | --- | | 0 (rcAllCRL) | All provided CRL endpoints are checked, and all checks must succeed. | | 1 (rcAllOCSP) | All provided OCSP endpoints are checked, and all checks must succeed. | | 2 (rcAllCRLAndOCSP) | All provided CRL and OCSP endpoints are checked, and all checks must succeed. | | 3 (rcAnyCRL) | All provided CRL endpoints are checked, and at least one check must succeed. | | 4 (rcAnyOCSP) | All provided OCSP endpoints are checked, and at least one check must succeed. | | 5 (rcAnyCRLOrOCSP) | All provided CRL and OCSP endpoints are checked, and at least one check must succeed. CRL endpoints are checked first. | | 6 (rcAnyOCSPOrCRL - default) | All provided CRL and OCSP endpoints are checked, and at least one check must succeed. OCSP endpoints are checked first. | This property controls the way revocation checks are performed for every certificate in the chain. Typically, certificates come with two types of revocation information sources: CRLs (Certificate Revocation Lists) and OCSP responses. 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 a delay between the time at which a certificate was revoked and the time at which the subsequent CRL mentioning that revocation is published. The benefits of CRLs are 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 property allows the validation course to be adjusted by including or excluding certain types of revocation sources from the validation process. The *rcAnyOCSPOrCRL* 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 *rcAll** 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 is considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. ## Data Type i32 # pdf_signature_count property ([PDFVerify](#struct-securepdfpdfverify) Struct) The number of records in the PDFSignature arrays. ## Syntax *Rust Syntax* ```text fn pdf_signature_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [pdf_signature_author_name](#pdf_signature_author_name-property-pdfverify-struct) - [pdf_signature_chain_validation_details](#pdf_signature_chain_validation_details-property-pdfverify-struct) - [pdf_signature_chain_validation_result](#pdf_signature_chain_validation_result-property-pdfverify-struct) - [pdf_signature_claimed_signing_time](#pdf_signature_claimed_signing_time-property-pdfverify-struct) - [pdf_signature_coverage_ends_at](#pdf_signature_coverage_ends_at-property-pdfverify-struct) - [pdf_signature_hash_algorithm](#pdf_signature_hash_algorithm-property-pdfverify-struct) - [pdf_signature_profile](#pdf_signature_profile-property-pdfverify-struct) - [pdf_signature_reason](#pdf_signature_reason-property-pdfverify-struct) - [pdf_signature_signer_cert_index](#pdf_signature_signer_cert_index-property-pdfverify-struct) - [pdf_signature_timestamp_cert_index](#pdf_signature_timestamp_cert_index-property-pdfverify-struct) - [pdf_signature_timestamped](#pdf_signature_timestamped-property-pdfverify-struct) - [pdf_signature_type](#pdf_signature_type-property-pdfverify-struct) - [pdf_signature_validated_signing_time](#pdf_signature_validated_signing_time-property-pdfverify-struct) - [pdf_signature_validation_result](#pdf_signature_validation_result-property-pdfverify-struct) - [pdf_signature_widget_height](#pdf_signature_widget_height-property-pdfverify-struct) - [pdf_signature_widget_offset_x](#pdf_signature_widget_offset_x-property-pdfverify-struct) - [pdf_signature_widget_offset_y](#pdf_signature_widget_offset_y-property-pdfverify-struct) - [pdf_signature_widget_pages](#pdf_signature_widget_pages-property-pdfverify-struct) - [pdf_signature_widget_width](#pdf_signature_widget_width-property-pdfverify-struct) The array indices start at *0* and end at *pdf_signature_count - 1*. This property is read-only. ## Data Type i32 # pdf_signature_author_name property ([PDFVerify](#struct-securepdfpdfverify) Struct) The human-readable name of the signer. ## Syntax *Rust Syntax* ```text fn pdf_signature_author_name(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "" ## Remarks The human-readable name of the signer. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # pdf_signature_chain_validation_details property ([PDFVerify](#struct-securepdfpdfverify) Struct) The details of the certificate chain validation outcome. ## Syntax *Rust Syntax* ```text fn pdf_signature_chain_validation_details(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The details of the certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result in [pdf_signature_chain_validation_result](#pdf_signature_chain_validation_result-property-pdfverify-struct). The value of this property is a bitmask of the following flags: | | | | --- | --- | | 0x001 (cvdRevoked) | One or more certificates are revoked. | | 0x002 (cvdExpiredOrNotYetValid) | One or more certificates are expired or not yet valid. | | 0x004 (cvdUnknownCA) | A CA certificate for one or more certificates has not been found, is not trusted, or has a wrong public key (chain incomplete). | | 0x008 (cvdPolicyViolated) | One of the CA certificates is not authorized to act as a CA, a mandatory key usage is not enabled in one of the chain certificates, or a weak algorithm is used in one of the certificates or revocation elements. | | 0x010 (cvdRevocationCheckFailed) | One or more CRLs or OCSP responses could not be verified. | | 0x020 (cvdBlocked) | One or more certificates are blocked. | | 0x040 (cvdFailure) | General validation failure. | Subscribe to the [on_log](#PDFSign_e_Log) event to access the detailed validation log. This property is also available as a parameter of the [on_signature_processed](#PDFSign_e_SignatureProcessed) event. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # pdf_signature_chain_validation_result property ([PDFVerify](#struct-securepdfpdfverify) Struct) The outcome of the certificate chain validation routine. ## Syntax *Rust Syntax* ```text fn pdf_signature_chain_validation_result(&self , PDFSignatureIndex : i32) -> Result ``` ## Possible Values ```text 0 // Unknown1 // Valid2 // ValidButUntrusted3 // Invalid4 // CantBeEstablished ``` ## Default Value 0 ## Remarks The outcome of the certificate chain validation routine. Possible values are: | | | | --- | --- | | 0 (cvrUnknown - default) | Chain validity is unknown. | | 1 (cvrValid) | The chain is valid. | | 2 (cvrValidButUntrusted) | The chain is valid, but the root certificate is not trusted. | | 3 (cvrInvalid) | The chain is not valid (some of the certificates are revoked, expired, or contain an invalid signature). | | 4 (cvrCantBeEstablished) | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses). | Subscribe to the [on_log](#PDFSign_e_Log) event to access the detailed validation log. This property is also available as a parameter of the [on_signature_processed](#PDFSign_e_SignatureProcessed) event. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # pdf_signature_claimed_signing_time property ([PDFVerify](#struct-securepdfpdfverify) Struct) The signature's creation time in UTC. ## Syntax *Rust Syntax* ```text fn pdf_signature_claimed_signing_time(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "" ## Remarks The signature's creation time in UTC. Use this property to get the signature creation time from the signer's computer. Note that the claimed time, unlike [pdf_signature_validated_signing_time](#pdf_signature_validated_signing_time-property-pdfverify-struct), does not originate from a trusted TSA and may be forged or wrong. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # pdf_signature_coverage_ends_at property ([PDFVerify](#struct-securepdfpdfverify) Struct) The byte offset in the PDF file where the signature coverage ends. ## Syntax *Rust Syntax* ```text fn pdf_signature_coverage_ends_at(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The byte offset in the PDF file where the signature coverage ends. PDF generators often use incremental updates to make changes in 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 to ensure that the signature covers the entire document. Alternatively, use [get_signed_version](#get_signed_version-method-pdfverify-struct) to extract the exact revision that was signed. A value of *0* indicates that the struct could not determine the coverage offset. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # pdf_signature_hash_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hash algorithm that was used for signing. ## Syntax *Rust Syntax* ```text fn pdf_signature_hash_algorithm(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "SHA256" ## Remarks The hash algorithm that was used for signing. Possible values are: - SHA1 - SHA224 - SHA256 - SHA384 - SHA512 - MD5 The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # pdf_signature_profile property ([PDFVerify](#struct-securepdfpdfverify) Struct) The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI. ## Syntax *Rust Syntax* ```text fn pdf_signature_profile(&self , PDFSignatureIndex : i32) -> Result ``` ## Possible Values ```text 0 // None1 // BaselineB2 // BaselineT3 // BaselineLT4 // BaselineLTA ``` ## Default Value 0 ## Remarks The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI. Advanced signatures come in many variants, and they are often defined by parties that need to process them or by local standards. Profiles are sets of pre-defined configurations that correspond to particular signature variants. Possible values are: | | | | --- | --- | | 0 (pfNone - default) | No profile | | 1 (pfBaselineB) | PAdES B-B profile | | 2 (pfBaselineT) | PAdES B-T profile | | 3 (pfBaselineLT) | PAdES B-LT profile | | 4 (pfBaselineLTA) | PAdES B-LTA profile | Note that when verifying a signature, the LTV modifier may be affected by the validation settings. These include [offline_mode](#offline_mode-property-pdfverify-struct) (set it to *true* to obtain the clean LTV capability) and [CacheRevocationInfo](#CacheRevocationInfo) (set it to *false* to prevent earlier validations from affecting the current validation). The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # pdf_signature_reason property ([PDFVerify](#struct-securepdfpdfverify) Struct) The reason for signing. ## Syntax *Rust Syntax* ```text fn pdf_signature_reason(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "" ## Remarks The reason for signing. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # pdf_signature_type property ([PDFVerify](#struct-securepdfpdfverify) Struct) The type of the signature that was created. ## Syntax *Rust Syntax* ```text fn pdf_signature_type(&self , PDFSignatureIndex : i32) -> Result ``` ## Possible Values ```text 0 // Legacy1 // Advanced2 // DTS3 // EmptyField ``` ## Default Value 0 ## Remarks The type of the signature that was created. Possible values are: | | | | --- | --- | | 0 (stLegacy - default) | Legacy Adobe signature (adbe.pkcs7.detached) | | 1 (stAdvanced) | PAdES-compliant signature (ETSI.CAdES.detached) | | 2 (stDTS) | Document timestamp (ETSI.RFC3161) | | 3 (stEmptyField) | Empty signature field (signature placeholder) | The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # pdf_signature_signer_cert_index property ([PDFVerify](#struct-securepdfpdfverify) Struct) The index of the signer certificate in the DocumentCerts collection. ## Syntax *Rust Syntax* ```text fn pdf_signature_signer_cert_index(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value -1 ## Remarks The index of the signer certificate in the [document_certs](#PDFSign_p_DocumentCerts) collection. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # pdf_signature_timestamp_cert_index property ([PDFVerify](#struct-securepdfpdfverify) Struct) The index of the timestamping certificate in the DocumentCerts collection (if applicable). ## Syntax *Rust Syntax* ```text fn pdf_signature_timestamp_cert_index(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value -1 ## Remarks The index of the timestamping certificate in the [document_certs](#PDFSign_p_DocumentCerts) collection (if applicable). The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # pdf_signature_timestamped property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether the signature contains an embedded timestamp. ## Syntax *Rust Syntax* ```text fn pdf_signature_timestamped(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether the signature contains an embedded timestamp. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type bool # pdf_signature_validated_signing_time property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certified signing time in UTC. ## Syntax *Rust Syntax* ```text fn pdf_signature_validated_signing_time(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "" ## Remarks The certified signing time in UTC. 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 is a valid timestamp included in the signature. Note that the validated time, unlike [pdf_signature_claimed_signing_time](#pdf_signature_claimed_signing_time-property-pdfverify-struct), is the trusted signing time. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # pdf_signature_validation_result property ([PDFVerify](#struct-securepdfpdfverify) Struct) The outcome of the cryptographic signature validation. ## Syntax *Rust Syntax* ```text fn pdf_signature_validation_result(&self , PDFSignatureIndex : i32) -> Result ``` ## Possible Values ```text 0 // Unknown1 // Valid2 // Corrupted3 // SignerNotFound4 // Failure ``` ## Default Value 0 ## Remarks The outcome of the cryptographic signature validation. Possible values are: | | | | --- | --- | | 0 (svrUnknown - default) | Signature validity is unknown. | | 1 (svrValid) | The signature is valid. | | 2 (svrCorrupted) | The signature is corrupted. | | 3 (svrSignerNotFound) | Failed to acquire the signing certificate. The signature cannot be validated. | | 4 (svrFailure) | General failure. | This property is also available as the *[signature_validation_result](#)* parameter of the [on_signature_processed](#PDFSign_e_SignatureProcessed) event. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # pdf_signature_widget_height property ([PDFVerify](#struct-securepdfpdfverify) Struct) The height of the signature widget in points. ## Syntax *Rust Syntax* ```text fn pdf_signature_widget_height(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "70" ## Remarks The height of the signature widget in points. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # pdf_signature_widget_offset_x property ([PDFVerify](#struct-securepdfpdfverify) Struct) The signature widget offset from the left-hand page border in points. ## Syntax *Rust Syntax* ```text fn pdf_signature_widget_offset_x(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "0" ## Remarks The signature widget offset from the left-hand page border in points. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # pdf_signature_widget_offset_y property ([PDFVerify](#struct-securepdfpdfverify) Struct) The signature widget offset from the bottom page border in points. ## Syntax *Rust Syntax* ```text fn pdf_signature_widget_offset_y(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "0" ## Remarks The signature widget offset from the bottom page border in points. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # pdf_signature_widget_pages property ([PDFVerify](#struct-securepdfpdfverify) Struct) The pages that the signature and its widget are placed on. ## Syntax *Rust Syntax* ```text fn pdf_signature_widget_pages(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "" ## Remarks The pages that the signature and its widget are placed on. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # pdf_signature_widget_width property ([PDFVerify](#struct-securepdfpdfverify) Struct) The width of the signature widget in points. ## Syntax *Rust Syntax* ```text fn pdf_signature_widget_width(&self , PDFSignatureIndex : i32) -> Result ``` ## Default Value "70" ## Remarks The width of the signature widget in points. The *PDFSignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdf_signature_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_count property ([PDFVerify](#struct-securepdfpdfverify) Struct) The number of records in the TrustedCert arrays. ## Syntax *Rust Syntax* ```text fn trusted_cert_count(&self ) -> Result fn set_trusted_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [trusted_cert_effective_date](#trusted_cert_effective_date-property-pdfverify-struct) - [trusted_cert_encoded](#trusted_cert_encoded-property-pdfverify-struct) - [trusted_cert_expiration_date](#trusted_cert_expiration_date-property-pdfverify-struct) - [trusted_cert_extended_key_usage](#trusted_cert_extended_key_usage-property-pdfverify-struct) - [trusted_cert_fingerprint](#trusted_cert_fingerprint-property-pdfverify-struct) - [trusted_cert_fingerprint_sha1](#trusted_cert_fingerprint_sha1-property-pdfverify-struct) - [trusted_cert_fingerprint_sha256](#trusted_cert_fingerprint_sha256-property-pdfverify-struct) - [trusted_cert_issuer](#trusted_cert_issuer-property-pdfverify-struct) - [trusted_cert_private_key](#trusted_cert_private_key-property-pdfverify-struct) - [trusted_cert_private_key_available](#trusted_cert_private_key_available-property-pdfverify-struct) - [trusted_cert_private_key_container](#trusted_cert_private_key_container-property-pdfverify-struct) - [trusted_cert_public_key](#trusted_cert_public_key-property-pdfverify-struct) - [trusted_cert_public_key_algorithm](#trusted_cert_public_key_algorithm-property-pdfverify-struct) - [trusted_cert_public_key_length](#trusted_cert_public_key_length-property-pdfverify-struct) - [trusted_cert_serial_number](#trusted_cert_serial_number-property-pdfverify-struct) - [trusted_cert_signature_algorithm](#trusted_cert_signature_algorithm-property-pdfverify-struct) - [trusted_cert_store](#trusted_cert_store-property-pdfverify-struct) - [trusted_cert_store_password](#trusted_cert_store_password-property-pdfverify-struct) - [trusted_cert_store_type](#trusted_cert_store_type-property-pdfverify-struct) - [trusted_cert_subject](#trusted_cert_subject-property-pdfverify-struct) - [trusted_cert_subject_alt_names](#trusted_cert_subject_alt_names-property-pdfverify-struct) - [trusted_cert_thumbprint_md5](#trusted_cert_thumbprint_md5-property-pdfverify-struct) - [trusted_cert_thumbprint_sha1](#trusted_cert_thumbprint_sha1-property-pdfverify-struct) - [trusted_cert_thumbprint_sha256](#trusted_cert_thumbprint_sha256-property-pdfverify-struct) - [trusted_cert_usage](#trusted_cert_usage-property-pdfverify-struct) - [trusted_cert_usage_flags](#trusted_cert_usage_flags-property-pdfverify-struct) - [trusted_cert_version](#trusted_cert_version-property-pdfverify-struct) The array indices start at *0* and end at *trusted_cert_count - 1*. ## Data Type i32 # trusted_cert_effective_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn trusted_cert_effective_date(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_expiration_date property ([PDFVerify](#struct-securepdfpdfverify) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn trusted_cert_expiration_date(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_extended_key_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn trusted_cert_extended_key_usage(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_fingerprint property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_fingerprint(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_fingerprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_fingerprint_sha1(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_fingerprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_fingerprint_sha256(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_issuer property ([PDFVerify](#struct-securepdfpdfverify) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_issuer(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_private_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn trusted_cert_private_key(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [trusted_cert_private_key](#trusted_cert_private_key-property-pdfverify-struct) may be available but not exportable. In this case, [trusted_cert_private_key](#trusted_cert_private_key-property-pdfverify-struct) returns an empty string. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_private_key_available property ([PDFVerify](#struct-securepdfpdfverify) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_private_key_available(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether a [trusted_cert_private_key](#trusted_cert_private_key-property-pdfverify-struct) is available for the selected certificate. If [trusted_cert_private_key_available](#trusted_cert_private_key_available-property-pdfverify-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type bool # trusted_cert_private_key_container property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn trusted_cert_private_key_container(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the [trusted_cert_private_key](#trusted_cert_private_key-property-pdfverify-struct) container for the certificate (if available). This functionality is available only on Windows platforms. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_public_key property ([PDFVerify](#struct-securepdfpdfverify) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_public_key(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_public_key_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn trusted_cert_public_key_algorithm(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_public_key_length property ([PDFVerify](#struct-securepdfpdfverify) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn trusted_cert_public_key_length(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # trusted_cert_serial_number property ([PDFVerify](#struct-securepdfpdfverify) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn trusted_cert_serial_number(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_signature_algorithm property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn trusted_cert_signature_algorithm(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_store property ([PDFVerify](#struct-securepdfpdfverify) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_store(&self , TrustedCertIndex : i32) -> Result, SecurePDFError> fn set_trusted_cert_store(&self, TrustedCertIndex : i32, value : Vec) -> Option fn set_trusted_cert_store_ref(&self, TrustedCertIndex : i32, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [trusted_cert_store_type](#trusted_cert_store_type-property-pdfverify-struct) property denotes the type of the certificate store specified by [trusted_cert_store](#trusted_cert_store-property-pdfverify-struct). If the store is password-protected, specify the password in [trusted_cert_store_password](#trusted_cert_store_password-property-pdfverify-struct). [trusted_cert_store](#trusted_cert_store-property-pdfverify-struct) is used in conjunction with the [trusted_cert_subject](#trusted_cert_subject-property-pdfverify-struct) property to specify client certificates. If [trusted_cert_store](#trusted_cert_store-property-pdfverify-struct) has a value, and [trusted_cert_subject](#trusted_cert_subject-property-pdfverify-struct) or [trusted_cert_encoded](#trusted_cert_encoded-property-pdfverify-struct) is set, a search for a certificate is initiated. Please see the [trusted_cert_subject](#trusted_cert_subject-property-pdfverify-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. ## Data Type Vec # trusted_cert_store_password property ([PDFVerify](#struct-securepdfpdfverify) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn trusted_cert_store_password(&self , TrustedCertIndex : i32) -> Result fn set_trusted_cert_store_password(&self, TrustedCertIndex : i32, value : &str) -> Option fn set_trusted_cert_store_password_ref(&self, TrustedCertIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. ## Data Type String # trusted_cert_store_type property ([PDFVerify](#struct-securepdfpdfverify) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_store_type(&self , TrustedCertIndex : i32) -> Result fn set_trusted_cert_store_type(&self, TrustedCertIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [trusted_cert_store_type](#trusted_cert_store_type-property-pdfverify-struct), the full path of the PKCS#11 DLL as the [trusted_cert_store](#trusted_cert_store-property-pdfverify-struct), and the PIN as the [trusted_cert_store_password](#trusted_cert_store_password-property-pdfverify-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [trusted_cert_store](#trusted_cert_store-property-pdfverify-struct) and set [trusted_cert_store_password](#trusted_cert_store_password-property-pdfverify-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. ## Data Type i32 # trusted_cert_subject_alt_names property ([PDFVerify](#struct-securepdfpdfverify) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_subject_alt_names(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_thumbprint_md5 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_thumbprint_md5(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_thumbprint_sha1 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_thumbprint_sha1(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_thumbprint_sha256 property ([PDFVerify](#struct-securepdfpdfverify) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_thumbprint_sha256(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_usage property ([PDFVerify](#struct-securepdfpdfverify) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn trusted_cert_usage(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of [trusted_cert_usage_flags](#trusted_cert_usage_flags-property-pdfverify-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_usage_flags property ([PDFVerify](#struct-securepdfpdfverify) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn trusted_cert_usage_flags(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [trusted_cert_usage_flags](#trusted_cert_usage_flags-property-pdfverify-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [trusted_cert_usage](#trusted_cert_usage-property-pdfverify-struct) property for a text representation of [trusted_cert_usage_flags](#trusted_cert_usage_flags-property-pdfverify-struct). This functionality currently is not available when the provider is OpenSSL. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type i32 # trusted_cert_version property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn trusted_cert_version(&self , TrustedCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. This property is read-only. ## Data Type String # trusted_cert_subject property ([PDFVerify](#struct-securepdfpdfverify) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn trusted_cert_subject(&self , TrustedCertIndex : i32) -> Result fn set_trusted_cert_subject(&self, TrustedCertIndex : i32, value : &str) -> Option fn set_trusted_cert_subject_ref(&self, TrustedCertIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. ## Data Type String # trusted_cert_encoded property ([PDFVerify](#struct-securepdfpdfverify) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn trusted_cert_encoded(&self , TrustedCertIndex : i32) -> Result, SecurePDFError> fn set_trusted_cert_encoded(&self, TrustedCertIndex : i32, value : Vec) -> Option fn set_trusted_cert_encoded_ref(&self, TrustedCertIndex : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [trusted_cert_store](#trusted_cert_store-property-pdfverify-struct) and [trusted_cert_subject](#trusted_cert_subject-property-pdfverify-struct) properties also may be used to specify a certificate. When [trusted_cert_encoded](#trusted_cert_encoded-property-pdfverify-struct) is set, a search is initiated in the current [trusted_cert_store](#trusted_cert_store-property-pdfverify-struct) for the private key of the certificate. If the key is found, [trusted_cert_subject](#trusted_cert_subject-property-pdfverify-struct) is updated to reflect the full subject of the selected certificate; otherwise, [trusted_cert_subject](#trusted_cert_subject-property-pdfverify-struct) is set to an empty string. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trusted_cert_count-property-pdfverify-struct) property. ## Data Type Vec # trusted_lists property ([PDFVerify](#struct-securepdfpdfverify) Struct) A list of known Trusted Lists for chain validation. ## Syntax *Rust Syntax* ```text fn trusted_lists(&self ) -> Result fn set_trusted_lists(&self, value : &str) -> Option fn set_trusted_lists_ref(&self, value : &String) -> Option ``` ## Default Value "%EUTL%" ## Remarks This property is used to supply a semicolon-separated list of URLs or paths of known Trusted Lists to the struct for chain validation. A Trusted List is an XML document that contains a government-issued list of CAs that have passed regulated compliance checks. When validating the chain, the struct consults the Trusted List to establish certificate trust, ensuring that the CA is legitimate and entitled to issue certificates of the kind being checked. The default value is the special *%EUTL%* macro, which, if applicable, instructs the struct to check the root certificate against up-to-date versions of the primary EU Trusted Lists from the [EU LOTL](https://ec.europa.eu/tools/lotl/eu-lotl.xml). Custom values can be appended: ```csharp component.TrustedLists = "%EUTL%;http://my.company/tsl;c:\tsls\mytsl.xml"; ``` NOTE: The struct caches all Trusted Lists it downloads and uses during chain validation. This cache is shared between struct instances within the same process. If this property contains a URL that is also present in the cache, the struct retrieves the cached data and reuses it in the current validation. If the data is invalid, the struct downloads a fresh Trusted List and adds it to the cache. ## Data Type String # trust_sources property ([PDFVerify](#struct-securepdfpdfverify) Struct) The trust sources to use during chain validation. ## Syntax *Rust Syntax* ```text fn trust_sources(&self ) -> Result fn set_trust_sources(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Manual1 // Local2 // TrustedLists3 // LocalAndTrustedLists ``` ## Default Value 3 ## Remarks This property is used to specify the sources the struct uses to establish certificate trust during chain validation. Establishing trust for a particular certificate, when either signing or verifying, involves building a chain up to a valid trust anchor. This trust anchor is a root certificate that typically resides on the local system. If the certificate does not eventually chain up to a valid trust anchor, the chain is considered untrusted and therefore invalid. Possible values are: | | | | --- | --- | | 0 (tsManual) | The struct consults trusted_certs only. | | 1 (tsLocal) | The struct consults local system stores (e.g., Windows Trusted Root Certification Authorities) as well as trusted_certs. | | 2 (tsTrustedLists) | The struct consults [trusted_lists](#trusted_lists-property-pdfverify-struct) only. | | 3 (tsLocalAndTrustedLists - default) | The struct consults local system stores, trusted_certs, and [trusted_lists](#trusted_lists-property-pdfverify-struct). | ## Data Type i32 # validation_flags property ([PDFVerify](#struct-securepdfpdfverify) Struct) Additional chain validation settings. ## Syntax *Rust Syntax* ```text fn validation_flags(&self ) -> Result fn set_validation_flags(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property is used to specify additional settings that affect the overall flow of the chain validation. Its value should be provided as a bitmask of the following flags: | | | | --- | --- | | 0x001 (cvfForceCompleteChainValidationForTrusted) | Perform full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce the completeness of the collected revocation information. It often makes sense to omit this flag when validating signatures to reduce validation time and avoid issues with poorly configured environments. | | 0x002 (cvfIgnoreChainLoops) | Currently unsupported. | | 0x004 (cvfIgnoreOCSPNoCheckExtension) | Currently unsupported. | | 0x008 (cvfTolerateMinorChainIssues) | Currently unsupported. | ## Data Type i32 # validation_policy property ([PDFVerify](#struct-securepdfpdfverify) Struct) The level at which to perform chain validation. ## Syntax *Rust Syntax* ```text fn validation_policy(&self ) -> Result fn set_validation_policy(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // Full2 // FullNoTrust3 // FullNoRevocation4 // BestEffort ``` ## Default Value 1 ## Remarks This property is used to specify the overall validation policy the struct follows. Possible values are: | | | | --- | --- | | 0 (vpNone) | No chain validation is attempted at all. | | 1 (vpFull - default) | Revocation and trust checks must succeed for all chains. | | 2 (vpFullNoTrust) | Revocation checks must succeed, but trust checks will not occur. | | 3 (vpFullNoRevocation) | Trust checks must succeed, but revocation checks will not occur. | | 4 (vpBestEffort) | Currently unsupported. | ### Validation Policy Heuristics The choice of validation policy depends on the scenario for which the chain is validated. **Creating a new signature:** - For a basic signature with or without a timestamp, chain validation is not required, so it is recommended to use *vpNone*. This policy may also be used in test environments or on offline systems. - For an LTV signature, use *vpFull* or *vpFullNoTrust* depending on whether trust checks are necessary in the current environment. If the signature is being created in an environment that does not match the prospective validation environment, consider *vpFullNoTrust* to validate the chain properly and fully without expecting good trust. **Updating or extending an existing signature:** - When updating a basic signature to LTV, similarly use *vpFull* or *vpFullNoTrust* as above. - When extending an LTV signature, similarly use *vpFull* or *vpFullNoTrust* as above. **Validating an existing signature:** - For basic signature validation, use *vpFullNoRevocation* if trust checks, but not revocation checks, are necessary in the current environment. This policy may also be used on offline systems if the trust anchor is already available to the struct. - For archival validation, use *vpFull* to validate the chain properly and fully. This policy expects the trust anchor and all the revocation material to be available. ## Data Type i32 # validation_time property ([PDFVerify](#struct-securepdfpdfverify) Struct) The time point at which the signature should be validated. ## Syntax *Rust Syntax* ```text fn validation_time(&self ) -> Result fn set_validation_time(&self, value : &str) -> Option fn set_validation_time_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property is used to specify the moment in time at which the signature validity should be established. The time should be provided in UTC in *yyyyMMddHHmmssZ* format. Leave this property empty to stick to the default time point. The struct then prioritizes: - The signature creation time if the signature contains a signature timestamp (), or - The local time included in the signature by the signer (). NOTE: The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times. ## Data Type String # close method ([PDFVerify](#struct-securepdfpdfverify) Struct) Closes the opened document. ## Syntax *Rust Syntax* ```text fn close(&self) -> Result<(), SecurePDFError> ``` ## Remarks This method is used to close the previously opened document. It should always be preceded by a call to [open](#open-method-pdfverify-struct). **Example:** ```csharp component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); ``` If any changes are made to the document, they are saved automatically to [output_file](#output_file-property-pdfverify-struct), [output_data](#output_data-property-pdfverify-struct), or the stream set in set_output_stream when this method is called. To configure this saving behavior, set [SaveChanges](#SaveChanges). # config method ([PDFVerify](#struct-securepdfpdfverify) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-pdfverify-struct) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-pdfverify-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # encrypted method ([PDFVerify](#struct-securepdfpdfverify) Struct) Checks whether the document is encrypted. ## Syntax *Rust Syntax* ```text fn encrypted(&self) -> Result ``` ## Remarks This method is used to determine whether the document is encrypted. It returns *false* if the document is pseudo-encrypted with an empty password. **Example:** ```csharp component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); ``` NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # get_page_property method ([PDFVerify](#struct-securepdfpdfverify) Struct) Returns the value of a page property. ## Syntax *Rust Syntax* ```text fn get_page_property(&self, page_index : i32, page_property : &str) -> Result ``` ## Remarks This method is used to obtain general information about the pages of the document, such as their dimensions and content positioning details. *page_index* specifies the page to read information about (with a valid range from *0* to *page_count - 1*), and *page_property* specifies the page property to read. Possible values are: | Page property | Default value | Description | | --- | --- | --- | | CropLowerLeftX | 0 | The lower-left X coordinate of the page crop area in points. | | CropLowerLeftY | 0 | The lower-left Y coordinate of the page crop area in points. | | CropUpperRightX | 0 | The upper-right X coordinate of the page crop area in points. | | CropUpperRightY | 0 | The upper-right Y coordinate of the page crop area in points. | | Height | 0 | The height of the page in points. | | MediaLowerLeftX | 0 | The lower-left X coordinate of the page media area in points. | | MediaLowerLeftY | 0 | The lower-left Y coordinate of the page media area in points. | | MediaUpperRightX | 0 | The upper-right X coordinate of the page media area in points. | | MediaUpperRightY | 0 | The upper-right Y coordinate of the page media area in points. | | Rotation | 0 | The rotation angle of the page in degrees clockwise. Supported values: 0, 90, 180, 270. | | Width | 0 | The width of the page in points. | **Example:** ```csharp int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 0; i < pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); ``` The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: ```csharp int x = int.Parse(pdfsign.GetPageProperty(0, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); ``` NOTE: Each page property is only populated once the document has been loaded, which is reported by the [on_document_info](#on_document_info-event-pdfverify-struct) event. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # get_signed_version method ([PDFVerify](#struct-securepdfpdfverify) Struct) Returns the part of the signed document that is covered by a signature. ## Syntax *Rust Syntax* ```text fn get_signed_version(&self, signature_index : i32) -> Result<(), SecurePDFError> ``` ## Remarks This method is used to obtain the revision of the document that is covered by a signature. *signature_index* is the index of the signature of interest in the signatures collection. **Example:** ```csharp pdfverify.InputFile = "signed.pdf"; pdfverify.OutputFile = "revision0.pdf"; pdfverify.GetSignedVersion(0); ``` PDF documents often use an incremental update approach, with any changes being appended to the document without altering the existing revision. This may lead to situations where a signature only covers part of the document (one of the past revisions), but not subsequent changes. This method provides a means to extract the revision that is actually certified by the signature. It is recommended to use this method when validating signatures to make sure the signature covers the byte range it is expected to cover. An alternative to this method is to check the property of the signature object and match it to the document length. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # interrupt method ([PDFVerify](#struct-securepdfpdfverify) Struct) Interrupts the current action. ## Syntax *Rust Syntax* ```text fn interrupt(&self) -> Result<(), SecurePDFError> ``` ## Remarks This method interrupts the current action. It can be used, for example, within the [on_chain_cert](#on_chain_cert-event-pdfverify-struct) event to abort the chain validation procedure. If there is no action in progress, this method simply returns, doing nothing. # open method ([PDFVerify](#struct-securepdfpdfverify) Struct) Opens the document for processing. ## Syntax *Rust Syntax* ```text fn open(&self) -> Result<(), SecurePDFError> ``` ## Remarks This method is used to open the document specified in [input_file](#input_file-property-pdfverify-struct), [input_data](#input_data-property-pdfverify-struct), or set_input_stream before performing some operation on it, such as verifying or removing signatures. When finished, call [close](#close-method-pdfverify-struct) to complete or discard the operation. It is recommended to use this method (alongside [close](#close-method-pdfverify-struct)) when performing multiple operations on the document at once. NOTE: This method populates the attachments, document_certs, and signatures collections with any corresponding objects found in the document. ### Automatic Decryption Functionality If this method is called on an encrypted document, the [on_password](#on_password-event-pdfverify-struct) or [on_recipient_info](#on_recipient_info-event-pdfverify-struct) event fires (depending on the encryption type) as a notification that the document must be decrypted before processing can continue. Once the correct decryption material is supplied, the struct then attempts to decrypt the document automatically within this method. When this occurs, the decrypted content is kept in memory so that the document's encrypted status is preserved when it is saved later. Use [decrypt](PDFDecrypt.md#PDFDecrypt_m_Decrypt) to save a decrypted copy of the document instead. # reset method ([PDFVerify](#struct-securepdfpdfverify) Struct) Resets the struct. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), SecurePDFError> ``` ## Remarks This method is used to reset the struct's properties and configuration settings to their default values. # save_attachment method ([PDFVerify](#struct-securepdfpdfverify) Struct) Saves a PDF attachment to a file. ## Syntax *Rust Syntax* ```text fn save_attachment(&self, index : i32, file_name : &str) -> Result<(), SecurePDFError> ``` ## Remarks This method is used to retrieve the contents of an attachment from the document and save it to a file. It does not modify the contents of the attachments collection. *index* is the index of the attachment in the attachments collection to be saved. *file_name* specifies the filename that the attachment will be saved to. **Example:** ```csharp component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); ``` **Example (saving to a stream):** ```csharp component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream property if it's set ``` NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # signed method ([PDFVerify](#struct-securepdfpdfverify) Struct) Checks whether the document is signed. ## Syntax *Rust Syntax* ```text fn signed(&self) -> Result ``` ## Remarks This method is used to determine whether the document is signed. It returns *false* if the document contains only empty signature fields. **Example:** ```csharp pdfverify.InputFile = "input.pdf"; if (pdfverify.Signed()) { // Configure validation-related properties as desired pdfverify.Verify(); } ``` NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # unsign method ([PDFVerify](#struct-securepdfpdfverify) Struct) Removes a signature from the document. ## Syntax *Rust Syntax* ```text fn unsign(&self, signature_index : i32, unsign_kind : i32) -> Result<(), SecurePDFError> ``` ## Remarks This method is used to remove an existing signature from the document. *signature_index* is the index of the signature in the signatures collection to be removed. *unsign_kind* specifies the kind of unsign to perform. Possible values are: | | | | --- | --- | | 0 (uskFull) | Remove the signature fully. | | 1 (uskKeepField) | Remove the signature, but keep the form field it is in. | | 2 (uskKeepAppearance) | Remove the signature, but keep the form field and its widget. | **Example:** ```csharp pdfverify.InputFile = "signed.pdf"; pdfverify.OutputFile = "unsigned.pdf"; pdfverify.Open(); int idx = pdfverify.Signatures.Count - 1; pdfverify.Unsign(idx, 0); // uskFull pdfverify.Close(); ``` Note that unsigning is different from [get_signed_version](#get_signed_version-method-pdfverify-struct). The latter returns the revision of the document **including** the mentioned signature (thus removing anything after that signature was created). unsign removes the signature completely by carving it out of the document. NOTE: *signature_index* set to *-1* removes all signatures in the document. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # verify method ([PDFVerify](#struct-securepdfpdfverify) Struct) Verifies the signed document. ## Syntax *Rust Syntax* ```text fn verify(&self) -> Result<(), SecurePDFError> ``` ## Remarks This method is used to validate all signatures in the document. This method walks through the signed document and reports every signature via the [on_signature_info](#on_signature_info-event-pdfverify-struct) 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. **Example:** ```csharp pdfverify.InputFile = "signed.pdf"; pdfverify.Verify(); PDFSignature signature = pdfverify.Signatures[0]; if (signature.ValidationResult == SignatureValidationResults.svrValid) Console.WriteLine("Signature is good"); if (signature.ChainValidationResult == ChainValidationResults.cvrValid) Console.WriteLine("Chain is good"); ``` This method only validates the signatures and does not check their coverage. It is a good idea to use mechanisms such as [get_signed_version](#get_signed_version-method-pdfverify-struct) or to ensure that the signature covers the expected document revision. To control individual signature validation, subscribe to the [on_signature_info](#on_signature_info-event-pdfverify-struct) event and set the *validate_signature* and *validate_chain* parameters accordingly. The results are reported via the [on_signature_processed](#on_signature_processed-event-pdfverify-struct) event. Use the following properties to adjust chain validation parameters: - blocked_certs - known_certs - [offline_mode](#offline_mode-property-pdfverify-struct) - [revocation_check](#revocation_check-property-pdfverify-struct) - trusted_certs - [trusted_lists](#trusted_lists-property-pdfverify-struct) - [trust_sources](#trust_sources-property-pdfverify-struct) - [validation_flags](#validation_flags-property-pdfverify-struct) - [validation_policy](#validation_policy-property-pdfverify-struct) - [validation_time](#validation_time-property-pdfverify-struct) NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # on_chain_cert event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired when the struct encounters a chain certificate. ## Syntax *Rust Syntax* ```text // PDFVerifyChainCertEventArgs carries the PDFVerify ChainCert event's parameters. pub struct PDFVerifyChainCertEventArgs { fn cert_encoded(&self) -> &[u8] fn cert_subject(&self) -> &String fn cert_issuer(&self) -> &String fn validation_time(&self) -> &String fn validation_result(&self) -> i32 fn set_validation_result(&self, value : i32) fn validation_details(&self) -> i32 fn set_validation_details(&self, value : i32) } // PDFVerifyChainCertEvent defines the signature of the PDFVerify ChainCert event's handler function. pub trait PDFVerifyChainCertEvent { fn on_chain_cert(&self, sender : PDFVerify, e : &mut PDFVerifyChainCertEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_chain_cert(&self) -> &'a dyn PDFVerifyChainCertEvent; pub fn set_on_chain_cert(&mut self, value : &'a dyn PDFVerifyChainCertEvent); ... } ``` ## Remarks This event is fired once for each certificate encountered during chain validation to report that it is about to be processed. The struct tries to retrieve all required chain certificates automatically. *cert_encoded* specifies the PEM (Base64-encoded) public certificate. *cert_subject* and *cert_issuer* specify the distinguished names of the certificate owner and issuer respectively. *validation_time* specifies the time point (in UTC) at which the certificate validity was established. *validation_result* reports the outcome of the individual certificate validation and can be one of the following values: | | | | --- | --- | | 0 (cvrUnknown - default) | Certificate validity is unknown. | | 1 (cvrValid) | The certificate is valid. | | 2 (cvrValidButUntrusted) | The certificate is valid but not trusted. | | 3 (cvrInvalid) | The certificate is not valid (it is revoked, expired, or contains an invalid signature). | | 4 (cvrCantBeEstablished) | The validity of the certificate cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses). | In the case of a failure, *validation_details* provides more details on its reasons. Its value is a bitmask of the following flags: | | | | --- | --- | | 0x001 (cvdRevoked) | The certificate is revoked. | | 0x002 (cvdExpiredOrNotYetValid) | The certificate is expired or not yet valid. | | 0x004 (cvdUnknownCA) | A CA certificate for the certificate has not been found, is not trusted, or has a wrong public key (chain incomplete). | | 0x008 (cvdPolicyViolated) | One of the CA certificates is not authorized to act as a CA, a mandatory key usage is not enabled, or a weak algorithm is used in the certificate. | | 0x010 (cvdRevocationCheckFailed) | One or more CRLs or OCSP responses could not be verified. | | 0x020 (cvdBlocked) | The certificate is blocked. | | 0x040 (cvdFailure) | General validation failure. | ### Overridable Chain Validation While the struct follows the validation rules defined by the X.509 standard to the best of its ability, minor technical issues may arise when validating the chain. The *validation_result* and *validation_details* parameters can be overridden to relax such requirements on a per-certificate basis. For example, set *validation_result* to *cvrValid* and *validation_details* to *0* in order to: - Ignore CA or TLS key usage requirements - Ignore the AuthorityKeyId extension in certificate-issuing CAs (helps with incorrectly renewed certificates) - Ignore the Basic Constraints or Name Constraints extensions of CA certificates - Tolerate some weaker algorithms - Implicitly trust self-signed certificates - Skip validity period checks for trusted certificates (helps with older devices that have expired root certificates) - Ignore chain loops (helps with buggy CAs that include subchains that sign themselves) Based on the adjusted validity of the certificate that is currently being processed, the struct continues or aborts the chain validation procedure accordingly as if it had arrived at the chosen validation result itself. NOTE: The user code is ultimately responsible for certificate validity decisions made via these two parameters. If their values are modified within this event, the resulting chain validation procedure may deviate from the standard. # on_document_info event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired when the document has been loaded into memory. ## Syntax *Rust Syntax* ```text // PDFVerifyDocumentInfoEventArgs carries the PDFVerify DocumentInfo event's parameters. pub struct PDFVerifyDocumentInfoEventArgs { fn page_count(&self) -> i32 fn signature_count(&self) -> i32 } // PDFVerifyDocumentInfoEvent defines the signature of the PDFVerify DocumentInfo event's handler function. pub trait PDFVerifyDocumentInfoEvent { fn on_document_info(&self, sender : PDFVerify, e : &mut PDFVerifyDocumentInfoEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_document_info(&self) -> &'a dyn PDFVerifyDocumentInfoEvent; pub fn set_on_document_info(&mut self, value : &'a dyn PDFVerifyDocumentInfoEvent); ... } ``` ## Remarks This event is fired once per document processing routine to report that the document has been processed and loaded into memory. The handler for this event is a good place to check the document structure and access document-related information such as page number and document file details. These may be useful when preparing the signature. For example, [get_page_property](#get_page_property-method-pdfverify-struct) can be used to find the optimal position for the signature widget. *page_count* reports the number of pages in the document. *signature_count* reports the number of signatures in the document. This event is fired when [open](#open-method-pdfverify-struct) is called, but only after [on_password](#on_password-event-pdfverify-struct) or [on_recipient_info](#on_recipient_info-event-pdfverify-struct) is fired (if applicable) and the document has been decrypted. # on_error event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired when information is available about errors during data delivery. ## Syntax *Rust Syntax* ```text // PDFVerifyErrorEventArgs carries the PDFVerify Error event's parameters. pub struct PDFVerifyErrorEventArgs { fn error_code(&self) -> i32 fn description(&self) -> &String } // PDFVerifyErrorEvent defines the signature of the PDFVerify Error event's handler function. pub trait PDFVerifyErrorEvent { fn on_error(&self, sender : PDFVerify, e : &mut PDFVerifyErrorEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_error(&self) -> &'a dyn PDFVerifyErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn PDFVerifyErrorEvent); ... } ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error. The *error_code* parameter contains an error code, and the *description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-pdfverify-struct) section. # on_log event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired once for each log message. ## Syntax *Rust Syntax* ```text // PDFVerifyLogEventArgs carries the PDFVerify Log event's parameters. pub struct PDFVerifyLogEventArgs { fn log_level(&self) -> i32 fn message(&self) -> &String fn log_type(&self) -> &String } // PDFVerifyLogEvent defines the signature of the PDFVerify Log event's handler function. pub trait PDFVerifyLogEvent { fn on_log(&self, sender : PDFVerify, e : &mut PDFVerifyLogEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_log(&self) -> &'a dyn PDFVerifyLogEvent; pub fn set_on_log(&mut self, value : &'a dyn PDFVerifyLogEvent); ... } ``` ## Remarks This event is fired once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) configuration setting. *log_level* indicates the detail level of the message. Possible values are: | | | | --- | --- | | 0 (None) | No messages are logged. | | 1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. | | 2 (Verbose) | Detailed data such as HTTP requests are logged. | | 3 (Debug) | Debug data including the full chain validation procedure are logged. | *message* is the log message. *log_type* identifies the type of log entry. Possible values are: - CertValidator - Font - HTTP - PDFInvalidSignature - PDFRevocationInfo - Timestamp - TSL # on_password event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired when the struct detects that the document is encrypted with a password. ## Syntax *Rust Syntax* ```text // PDFVerifyPasswordEventArgs carries the PDFVerify Password event's parameters. pub struct PDFVerifyPasswordEventArgs { fn available(&self) -> bool fn cancel(&self) -> bool fn set_cancel(&self, value : bool) } // PDFVerifyPasswordEvent defines the signature of the PDFVerify Password event's handler function. pub trait PDFVerifyPasswordEvent { fn on_password(&self, sender : PDFVerify, e : &mut PDFVerifyPasswordEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_password(&self) -> &'a dyn PDFVerifyPasswordEvent; pub fn set_on_password(&mut self, value : &'a dyn PDFVerifyPasswordEvent); ... } ``` ## Remarks This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to [password](#password-property-pdfverify-struct). *available* indicates whether the decryption password is already available to the struct or still needs to be set. If this parameter is *false*, the correct password must be provided for the decryption attempt to succeed. *cancel* determines whether the struct will stop firing this event to request a password. # on_recipient_info event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired for each recipient certificate of the encrypted document. ## Syntax *Rust Syntax* ```text // PDFVerifyRecipientInfoEventArgs carries the PDFVerify RecipientInfo event's parameters. pub struct PDFVerifyRecipientInfoEventArgs { fn issuer(&self) -> &String fn serial_number(&self) -> &String fn subject_key_identifier(&self) -> &String fn available(&self) -> bool fn cancel(&self) -> bool fn set_cancel(&self, value : bool) } // PDFVerifyRecipientInfoEvent defines the signature of the PDFVerify RecipientInfo event's handler function. pub trait PDFVerifyRecipientInfoEvent { fn on_recipient_info(&self, sender : PDFVerify, e : &mut PDFVerifyRecipientInfoEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_recipient_info(&self) -> &'a dyn PDFVerifyRecipientInfoEvent; pub fn set_on_recipient_info(&mut self, value : &'a dyn PDFVerifyRecipientInfoEvent); ... } ``` ## Remarks This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to decryption_cert. *issuer* specifies the subject of the issuer certificate. *serial_number* specifies the serial number of the encryption certificate. *subject_key_identifier* specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string. *available* indicates whether the decryption certificate is already available to the struct or still needs to be set. If this parameter is *false*, the correct certificate must be provided for the decryption attempt to succeed. *cancel* determines whether the struct will stop firing this event to request a certificate. NOTE: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate causes its own invocation of this event. # on_signature_info event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired when the struct finds a signature in the document. ## Syntax *Rust Syntax* ```text // PDFVerifySignatureInfoEventArgs carries the PDFVerify SignatureInfo event's parameters. pub struct PDFVerifySignatureInfoEventArgs { fn signature_index(&self) -> i32 fn validate_signature(&self) -> bool fn set_validate_signature(&self, value : bool) fn validate_chain(&self) -> bool fn set_validate_chain(&self, value : bool) } // PDFVerifySignatureInfoEvent defines the signature of the PDFVerify SignatureInfo event's handler function. pub trait PDFVerifySignatureInfoEvent { fn on_signature_info(&self, sender : PDFVerify, e : &mut PDFVerifySignatureInfoEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_signature_info(&self) -> &'a dyn PDFVerifySignatureInfoEvent; pub fn set_on_signature_info(&mut self, value : &'a dyn PDFVerifySignatureInfoEvent); ... } ``` ## Remarks This event is fired once for each signature found in the document to report that it is about to be validated. *signature_index* is the index of the signature in the signatures collection. Signature validation consists of two independent stages: cryptographic signature validation and chain validation. *validate_signature* and *validate_chain* determine whether each stage should be included in the validation. They can be overridden to modify the validation policy on a per-signature basis, allowing signatures to be verified individually instead of all at once (via [verify](#verify-method-pdfverify-struct)). To skip validation entirely, set both parameters to *false*. Use the following properties to adjust chain validation parameters: - blocked_certs - known_certs - [offline_mode](#offline_mode-property-pdfverify-struct) - [revocation_check](#revocation_check-property-pdfverify-struct) - trusted_certs - [trusted_lists](#trusted_lists-property-pdfverify-struct) - [trust_sources](#trust_sources-property-pdfverify-struct) - [validation_flags](#validation_flags-property-pdfverify-struct) - [validation_policy](#validation_policy-property-pdfverify-struct) - [validation_time](#validation_time-property-pdfverify-struct) # on_signature_processed event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired after a signature has been processed. ## Syntax *Rust Syntax* ```text // PDFVerifySignatureProcessedEventArgs carries the PDFVerify SignatureProcessed event's parameters. pub struct PDFVerifySignatureProcessedEventArgs { fn signature_index(&self) -> i32 fn signature_validation_result(&self) -> i32 fn chain_validation_result(&self) -> i32 fn chain_validation_details(&self) -> i32 } // PDFVerifySignatureProcessedEvent defines the signature of the PDFVerify SignatureProcessed event's handler function. pub trait PDFVerifySignatureProcessedEvent { fn on_signature_processed(&self, sender : PDFVerify, e : &mut PDFVerifySignatureProcessedEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_signature_processed(&self) -> &'a dyn PDFVerifySignatureProcessedEvent; pub fn set_on_signature_processed(&mut self, value : &'a dyn PDFVerifySignatureProcessedEvent); ... } ``` ## Remarks This event is fired once for each signature found in the document to report that it has completed validation. It is fired after [on_signature_info](#on_signature_info-event-pdfverify-struct) if that event's *validate_signature* parameter is set to *true*. *signature_index* is the index of the signature in the signatures collection. Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each in *signature_validation_result* and *chain_validation_result*. The former reports the validity of the signature and can be one of the following values: | | | | --- | --- | | 0 (svrUnknown - default) | Signature validity is unknown. | | 1 (svrValid) | The signature is valid. | | 2 (svrCorrupted) | The signature is corrupted. | | 3 (svrSignerNotFound) | Failed to acquire the signing certificate. The signature cannot be validated. | | 4 (svrFailure) | General failure. | The latter reports the validity of the chain and can be one of the following values: | | | | --- | --- | | 0 (cvrUnknown - default) | Chain validity is unknown. | | 1 (cvrValid) | The chain is valid. | | 2 (cvrValidButUntrusted) | The chain is valid, but the root certificate is not trusted. | | 3 (cvrInvalid) | The chain is not valid (some of the certificates are revoked, expired, or contain an invalid signature). | | 4 (cvrCantBeEstablished) | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses). | In the case of a failure, *chain_validation_details* provides more details on its reasons. Its value is a bitmask of the following flags: | | | | --- | --- | | 0x001 (cvdRevoked) | One or more certificates are revoked. | | 0x002 (cvdExpiredOrNotYetValid) | One or more certificates are expired or not yet valid. | | 0x004 (cvdUnknownCA) | A CA certificate for one or more certificates has not been found, is not trusted, or has a wrong public key (chain incomplete). | | 0x008 (cvdPolicyViolated) | One of the CA certificates is not authorized to act as a CA, a mandatory key usage is not enabled in one of the chain certificates, or a weak algorithm is used in one of the certificates or revocation elements. | | 0x010 (cvdRevocationCheckFailed) | One or more CRLs or OCSP responses could not be verified. | | 0x020 (cvdBlocked) | One or more certificates are blocked. | | 0x040 (cvdFailure) | General validation failure. | NOTE: *signature_validation_result*, *chain_validation_result*, and *chain_validation_details* are also available as properties in the PDFSignature type. # on_ssl_server_authentication event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired after the server presents its certificate to the client. ## Syntax *Rust Syntax* ```text // PDFVerifySSLServerAuthenticationEventArgs carries the PDFVerify SSLServerAuthentication event's parameters. pub struct PDFVerifySSLServerAuthenticationEventArgs { fn cert_encoded(&self) -> &[u8] fn cert_subject(&self) -> &String fn cert_issuer(&self) -> &String fn status(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) } // PDFVerifySSLServerAuthenticationEvent defines the signature of the PDFVerify SSLServerAuthentication event's handler function. pub trait PDFVerifySSLServerAuthenticationEvent { fn on_ssl_server_authentication(&self, sender : PDFVerify, e : &mut PDFVerifySSLServerAuthenticationEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_ssl_server_authentication(&self) -> &'a dyn PDFVerifySSLServerAuthenticationEvent; pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn PDFVerifySSLServerAuthenticationEvent); ... } ``` ## Remarks This event is fired during timestamping or chain validation after the server presents its SSL/TLS certificate to the struct. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS. During this event, the client can decide whether to continue with the connection process. *accept* is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue. When *accept* is *false*, *status* shows why the verification failed (otherwise, *status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting *accept* to *true*. # on_ssl_status event ([PDFVerify](#struct-securepdfpdfverify) Struct) Fired when secure connection progress messages are available. ## Syntax *Rust Syntax* ```text // PDFVerifySSLStatusEventArgs carries the PDFVerify SSLStatus event's parameters. pub struct PDFVerifySSLStatusEventArgs { fn message(&self) -> &String } // PDFVerifySSLStatusEvent defines the signature of the PDFVerify SSLStatus event's handler function. pub trait PDFVerifySSLStatusEvent { fn on_ssl_status(&self, sender : PDFVerify, e : &mut PDFVerifySSLStatusEventArgs); } impl <'a> PDFVerify<'a> { pub fn on_ssl_status(&self) -> &'a dyn PDFVerifySSLStatusEvent; pub fn set_on_ssl_status(&mut self, value : &'a dyn PDFVerifySSLStatusEvent); ... } ``` ## Remarks This event is fired during timestamping or chain validation for informational and logging purposes only. This event tracks the progress of the SSL/TLS connection. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS. # Config Settings ([PDFVerify](#struct-securepdfpdfverify) Struct) The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [config](#config-method-pdfverify-struct) method. ### PDFVerify Config Settings **CacheRevocationInfo**: Whether to cache revocation information.This setting specifies whether the struct caches revocation information. If set to *true*, the struct preserves downloaded CRLs and OCSP responses in memory and reuses them in subsequent chain validations. If set to *false*, the struct always collects revocation information from scratch (when applicable). The default value is *true*. **CloseInputStreamAfterProcessing**: Whether to close the input stream after processing.This setting determines whether the input stream specified in set_input_stream will be closed after processing is complete. The default value is *true*. **CloseOutputStreamAfterProcessing**: Whether to close the output stream after processing.This setting determines whether the output stream specified in set_output_stream will be closed after processing is complete. The default value is *true*. **ContactInfo[Index]**: The signer's contact information.This indexed setting returns the signer's contact information for a signature. *index* is the index of the signature in the signatures collection. This setting is read-only. **EnforcePDFA**: Whether to enforce PDF/A compliance.This setting specifies whether the struct enforces PDF/A compliance when operating on the document. If set to *true*, [PDFALevel](#PDFALevel) and [PDFAPolicy](#PDFAPolicy) are used to establish the level of PDF/A compliance to apply. The default value is *false*. **FilterName[Index]**: The signature filter name.This indexed setting returns the signature filter name. *index* is the index of the signature in the signatures collection. This setting is read-only. **FullSignatureName[Index]**: The full name of the signature field.This indexed setting returns the full name of the signature field. It is an internal identifier of a signature (such as *Signature1*) and is not meant to be human-readable. *index* is the index of the signature in the signatures collection. This setting is read-only. **HTTPRetryCount**: The number of HTTP request retries.This setting specifies the number of times to retry an HTTP request. It can be useful in the case of timestamping or CRL/OCSP retrieval failures. **HTTPRetryInterval**: A time interval to apply between HTTP request retries.This setting specifies the time interval (in seconds) to apply between successive HTTP request retries. It can be useful in the case of timestamping or CRL/OCSP retrieval failures. **LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [on_log](#on_log-event-pdfverify-struct) event. Possible values are: | | | | --- | --- | | 0 (None) | No messages are logged. | | 1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. | | 2 (Verbose) | Detailed data such as HTTP requests are logged. | | 3 (Debug) | Debug data including the full chain validation procedure are logged. | **OwnerPassword**: The owner password to decrypt the document with.This setting is used to provide the document owner password for decryption. Though it may be different from [password](#password-property-pdfverify-struct), most implementations use the same value for both. **PDFALevel**: The PDF/A conformance level to enforce.This setting specifies the desired PDF/A conformance level that the struct attempts to enforce when [EnforcePDFA](#EnforcePDFA) is set to *true*. Possible values are: | | | | --- | --- | | 1 | PDF/A-1 | | 2 | PDF/A-2 | | 3 (default) | PDF/A-3 | **PDFAPolicy**: The PDF/A policy to follow.This setting specifies the PDF/A policy the struct follows when [EnforcePDFA](#EnforcePDFA) is set to *true*. Possible values are: | | | | --- | --- | | Default | Maps to Preserve. | | Preserve | Keep existing document features and only write PDF/A-compliant pieces. If the struct needs to write a non-compliant piece, it throws an exception. | | Enforce | Preserve PDF/A-compliant pieces and attempt to fix violations in the original document. | **Permissions**: The document permissions associated with the encryption.This setting returns the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents, but note that it is a policy-like requirement rather than an enforcement. This setting is read-only. Its value is a bitmask of the following flags: | | | | --- | --- | | 0x001 (pepAnnotations) | Annotating is allowed. | | 0x002 (pepAssemble) | Assembling a new document on the basis of the processed one is allowed. | | 0x004 (pepExtract) | Extraction/copying of the pictures and text from the document is allowed. | | 0x008 (pepExtractAcc) | Content extraction is allowed for accessibility purposes only. | | 0x010 (pepFillInForms) | Filling in forms is allowed. | | 0x020 (pepHighQualityPrint) | High quality printing is allowed. | | 0x040 (pepLowQualityPrint) | Low quality printing is allowed. | | 0x080 (pepModify) | Modifications are allowed. | **PreferEmbeddedRevocationInfo**: Whether to prioritize revocation information that is embedded into the document.This setting specifies whether the struct uses revocation information that is embedded into the document when checking revocation status. If set to *true*, the struct does not download CRLs or OCSP responses from online sources unnecessarily. If set to *false* or no embedded revocation information is present, the struct retrieves it as normal based on the value of [revocation_check](#revocation_check-property-pdfverify-struct). The default value is *true*. **RevisionOffsets**: The offsets of the document revisions.This setting returns a comma-separated list of the byte offsets of all the revisions in the document. It may be used to obtain the number of revisions or extract a particular revision. This setting is read-only. **SaveChanges**: Whether to save changes made to the document.This setting specifies whether and how changes made to the PDF document are saved when [close](#close-method-pdfverify-struct) is called. Possible values are: | | | | --- | --- | | 0 | Discard all changes. | | 1 | Save the document to [output_file](#output_file-property-pdfverify-struct), [output_data](#output_data-property-pdfverify-struct), or the stream set in set_output_stream, even if it has not been modified. | | 2 (default) | Save the document to [output_file](#output_file-property-pdfverify-struct), [output_data](#output_data-property-pdfverify-struct), or the stream set in set_output_stream, but only if it has been modified. | **SignatureAllowedChanges[Index]**: The changes allowed by the signature.This indexed setting returns the scope of further changes to the document allowed by the signature. *index* is the index of the signature in the signatures collection. This setting is read-only. Its value is a bitmask of the following flags: | | | | --- | --- | | 0x001 (PDF_SIGNATURE_ALLOWED_CHANGE_FILL_IN_FORMS) | The signature allows filling in forms. | | 0x002 (PDF_SIGNATURE_ALLOWED_CHANGE_COMMENT) | The signature allows adding comments. | A value of *0* indicates that no changes are allowed. **SignatureData[Index]**: The hex-encoded representation of the underlying PKCS#7/CMS signature container.This indexed setting returns the hex-encoded representation of the underlying PKCS#7/CMS signature container, or the timestamp token for document timestamps. *index* is the index of the signature in the signatures collection. This setting is read-only. **SignatureInvertedLock[Index]**: Whether the locked field list should be treated as containing unlocked fields instead.This indexed setting indicates whether the list returned by [SignatureLockedFields\[Index\]](#SignatureLockedFields[Index]) should be treated in the opposite way, as a list of the only **unlocked** form fields. All other fields that are not present in the list are locked. This setting can only return *true* if an explicit list of field names is returned. *index* is the index of the signature in the signatures collection. This setting is read-only. **SignatureLockedFields[Index]**: The list of form fields that are locked by the signature.This indexed setting returns a list of form fields that are locked for modification by the signature. *index* is the index of the signature in the signatures collection. This setting is read-only. Depending on the method chosen by the author of the document, this setting may return one of the following values: - A comma-separated list of field names (see also [SignatureInvertedLock\[Index\]](#SignatureInvertedLock[Index])). - An asterisk character (***), to indicate that all the form fields are locked. - An empty string, to indicate that no locking information is provided in the document. **TempPath**: The location where temporary files are stored.This setting specifies an absolute path to the location on disk where temporary files are stored. It can be useful to reduce memory usage. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([PDFVerify](#struct-securepdfpdfverify) Struct) ### PDFVerify Errors | | | | --- | --- | | 802 | HTTP download failed. The error description contains the detailed message. | | 803 | The document is not signed. | | 816 | Invalid signature. The error description contains the detailed message. | | 827 | Invalid timestamp data. The error description contains the detailed message. | | 829 | Bad signing certificate attribute. | | 830 | Chain validation failed. The error description contains the detailed message. | | 833 | Trusted List processing error. The error description contains the detailed message. | | 834 | Cannot parse Trusted List data. | | 837 | Invalid revocation information. | | 839 | Failed to process Trusted List. The error description contains the detailed message. | | 844 | No signer certificate found. | | 845 | Invalid signing certificate chain. The error description contains the detailed message. | | 851 | Unsupported hash algorithm. | | 853 | Invalid digest. | | 854 | Invalid signature reference. | | 855 | Invalid signature contents. | | 856 | Invalid signature byte range. | | 857 | Byte range does not cover the entire document. | ### PDF Errors | | | | --- | --- | | 804 | PDF decompression failed. | | 805 | Cannot add entry to cross-reference table. | | 806 | Unsupported field size. | | 807 | Unsupported Encoding filter. | | 808 | Unsupported predictor algorithm. | | 809 | Unsupported document version. | | 812 | Cannot read PDF file stream. | | 813 | Cannot write to PDF file stream. | | 814 | [output_file](#output_file-property-pdfverify-struct) already exists and [overwrite](#overwrite-property-pdfverify-struct) is false. | | 815 | Invalid parameter. | | 817 | Bad cross-reference entry. | | 818 | Invalid object or generation number. | | 819 | Invalid object stream. | | 820 | Invalid stream dictionary. | | 821 | Invalid AcroForm entry. | | 822 | Invalid Root entry. | | 823 | Invalid annotation. | | 824 | The input document is empty. | | 826 | OpenType font error. The error description contains the detailed message. | | 828 | Invalid CMS data. The error description contains the detailed message. | | 835 | Cannot change decryption mode for opened document. | | 836 | Unsupported Date string. | | 838 | Cryptographic error. The error description contains the detailed message. | | 840 | decryption_cert error. The error description contains the detailed message. | | 841 | Encryption failed. The error description contains the detailed message. | | 842 | No proper certificate for encryption found. | | 846 | Unsupported revision. | | 847 | Unsupported security handler SubFilter. | | 848 | Failed to verify permissions. | | 849 | Invalid password. | | 850 | Invalid password information. | | 852 | Unsupported encryption algorithm. | | 859 | Cannot encrypt encrypted document. | | 864 | Cannot modify document after signature update. | | 868 | Cannot encrypt or decrypt object. | | 869 | Invalid security handler information. | | 870 | Invalid encrypted data. | | 871 | Invalid block cipher padding. | | 872 | Failed to reload signature. | | 873 | Object is not encrypted. | | 874 | Unexpected cipher information. | | 877 | Invalid document. Bad document catalog. | | 878 | Invalid document Id. | | 880 | Invalid document. Invalid requirements dictionary. | | 881 | Invalid linearization dictionary. | | 882 | Invalid signature information. | | 883 | Unsupported document format. | | 890 | Unsupported feature. | | 891 | Internal error. The error description contains the detailed message. | | 892 | Unsupported color. | | 893 | This operation is not supported for this PDF/A level. | | 894 | Interactive features ([](#f_Action)) are not supported by PDF/A. Set [EnforcePDFA](#EnforcePDFA) to false or clear the [](#f_Action) property of the field. | | 895 | Font file not found. | ### Parsing Errors | | | | --- | --- | | 1001 | Bad object. | | 1002 | Bad document trailer. | | 1003 | Illegal stream dictionary. | | 1004 | Illegal string. | | 1005 | Indirect object expected. | | 1007 | Invalid reference. | | 1008 | Invalid reference table. | | 1009 | Invalid stream data. | | 1010 | Unexpected character. | | 1011 | Unexpected EOF. | | 1012 | Unexpected indirect object in cross-reference table. | | 1013 | RDF object not found. | | 1014 | Invalid RDF object. | | 1015 | Cannot create element with unknown prefix. | | 1021 | Invalid type in Root object list. | The class may also return one of the following error codes, which are inherited from other classes. ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in url. | | 153 | Specified url_scheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open attached_file. | The class may also return one of the following error codes, which are inherited from other classes. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the remote_port at this time. A connection is in progress. | | 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. | | 102 | The remote_host address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the local_port at this time. A connection is in progress. | | 107 | You cannot change the local_host at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | remote_port cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the struct is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |