# PDFSign Class The PDFSign class signs PDF documents. ## Syntax ```text class securepdf.PDFSign ``` ## Remarks The PDFSign class can sign PDF documents in accordance with a selection of PDF and PAdES signature standards, including basic Adobe signatures (ISO 32000) and PAdES signatures (ETSI EN 319 142-1). ### Preparing the Signature To configure PDFSign to produce the desired signature, first provide the input document as a file ([input_file](#input_file-property)), byte array ([input_data](#input_data-property)), or stream (set_input_stream) and assign your signing certificate to the signing_cert property. Then indicate where to save the output document by setting [output_file](#output_file-property) or calling set_output_stream. Optionally, specify the *Signature** properties and the [timestamp_server](#timestamp_server-property) property, and adjust any chain validation parameters as necessary (please see the [Chain Validation Setup](#chain-validation-setup) section for more details). Finally, call [sign](#sign-method). PDFSign also provides means to customize the appearance of the signature widget to be shown on the document page. You can create your own signatures (e.g., in the form of your company's logo) by adjusting the widget properties available in the [set_widget_property](#set_widget_property-method) method. Alternatively, you can choose not to associate any widget with your signature by setting the *Invisible* widget property to *True*. Please see [this article](https://www.nsoftware.com/kb/articles/securepdf-widgets) for more details about customizing the signature widget. ### The Signing Process Depending on the configuration, the signing process may be as straightforward as calculating the document hash and signing it with the private key, or it may involve the advanced chain validation routine. During the latter process, the class may contact external revocation (i.e., CRL and OCSP endpoints) and trust sources to establish the validity of the signing certificate. If an external TSA server was provided by the [timestamp_server](#timestamp_server-property) property, the class also contacts it to timestamp the new signature. During signing, PDFSign may fire events to notify your code about certain conditions. For example, if the input document is encrypted but no decryption parameters were found in the [password](#password-property) or decryption_cert properties, the class fires either the [on_password](#on_password-event) or [on_recipient_info](#on_recipient_info-event) event to tell your code that it needs decryption information to be able to continue with the signing. Additionally, the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event fires if one of the HTTP endpoints involved during the operation (which may be a TSA, CRL, OCSP, or Trusted List service) operates over TLS and needs its certificate to be validated. **Remote Signing** PDFSign can also be configured to sign with external keys. In such scenarios, the class handles every aspect of the signing routine except the actual signing operation - including the document hash calculation, preparation of signature objects, and CRL/OCSP retrieval. Instead of calculating the signature by itself, the class requests it from your code and later incorporates it into the document. To enable this mode, set the [remote_signature_method](#remote_signature_method-property) property to either *rsmPKCS1* or *rsmPKCS7* and call [sign](#sign-method). The class outputs a "pre-signed" document, which encapsulates any signature and widget settings, and populates the [remote_signature_digest](#remote_signature_digest-property) property with the raw data to be signed. Which remote signing method to use depends on the specifics of your remote signing engine. With PKCS#1, the public copy of the signing certificate is needed on the first step because it is included in the PKCS#7 structure prepared by the class. With PKCS#7 on the other hand, only the document hash is calculated, which does not require the certificate. Once your remote signing engine signs the hashed data with the private key, pass the resulting signed data back to the class via the [remote_signature_data](#remote_signature_data-property) property to embed it into the document. The following code shows the full PKCS#1 remote signing process: ```csharp // Step 1: Pre-sign pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "presigned.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPublicKeyFile, "cert.cer", "", "*"); // Configure signature and/or widget properties as desired pdfsign.RemoteSignatureMethod = PDFSignRemoteSignatureMethods.rsmPKCS1; pdfsign.Sign(); string toBeSigned = pdfsign.RemoteSignatureDigest; // Step 2: Pass to remote signing engine byte[] signedData = SignData(toBeSigned); // Step 3: Finalize pdfsign.Reset(); pdfsign.InputFile = "presigned.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.RemoteSignatureData = HexEncode(signedData); pdfsign.Sign(); ``` In the PKCS#7 method, the class can additionally act as the remote signer. To implement this side of the scheme, provide a binary hash of the PDF as input and set [remote_signature_method](#remote_signature_method-property) to *rsmDigest*. After [sign](#sign-method) completes, the output will contain a signed binary PKCS#7 structure over the hash that can then be embedded into the pre-signed document. The following code shows the full PKCS#7 remote signing process using PDFSign on both sides: ```csharp // Step 1: Pre-sign pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "presigned.pdf"; // Configure signature and/or widget properties as desired pdfsign.RemoteSignatureMethod = PDFSignRemoteSignatureMethods.rsmPKCS7; pdfsign.Sign(); string toBeSigned = pdfsign.RemoteSignatureDigest; // Step 2: Sign the hash pdfsign.Reset(); pdfsign.InputData = HexDecode(toBeSigned); pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.RemoteSignatureMethod = PDFSignRemoteSignatureMethods.rsmDigest; pdfsign.Sign(); byte[] signedData = pdfsign.OutputData; // Step 3: Finalize pdfsign.Reset(); pdfsign.InputFile = "presigned.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.RemoteSignatureData = HexEncode(signedData); pdfsign.Sign(); ``` ### Basic Adobe Signatures A basic (also known as legacy) Adobe signature is an original Adobe Acrobat document signature. This is an outdated form of PDF signature; although PAdES is loosely built on it, this signature type does not support extended features and is not compliant with PAdES. Unless the recipient of your signed documents expects you to specifically use this kind of signature, it is unlikely that you will ever need it. ### PAdES Signatures and Profiles In PAdES, a given signature's profile describes the level of "completeness" of the validation material (i.e., certificates, CRLs, and OCSP responses) included in the signature. For example, signatures compliant with the PAdES B-B or PAdES B-T profiles do not require any validation material at all, whereas signatures compliant with the PAdES B-LTA profile must contain complete validation material. **PAdES B-B** The PAdES B-B profile is the baseline profile that uses the PAdES-BES signature level by default, meaning the signature contains only the signing time and signer information. Use the following code to create a B-B signature: ```csharp pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineB; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); ``` **PAdES-EPES** To instead create a PAdES-EPES signature that includes the signature-policy-identifier attribute, set the [PolicyHash](#PolicyHash), [PolicyHashAlgorithm](#PolicyHashAlgorithm), and [PolicyId](#PolicyId) configuration settings before calling [sign](#sign-method). This profile, in both the BES and EPES settings, creates a basic signature that remains valid as long as the signing certificate has not expired or been revoked. Signatures at this level need not contain any validation material. **PAdES B-T** The PAdES B-T profile extends the basic BES or EPES signature by adding a signature timestamp. This timestamp certifies that the signature was created at a specific moment in time. Similar to the B-B profile, signatures at this level need not contain any validation material. Use the following code to create a B-T signature: ```csharp pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineT; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); ``` **PAdES B-LTA** The PAdES B-LTA profile is used to achieve signatures that are equipped with long-term archival (LTA) or long-term validation (LTV) capabilities. It incorporates into the signature all the material required to validate the signature, including signing certificates, timestamping certificates, and revocation information. It also adds a document timestamp, which certifies the integrity of both the document and the complete validation material at a specific moment in time. This guarantees that no relevant certificates were expired or revoked at the signature creation time, and enables the signature to be verified offline. Creating a B-LTA signature with PDFSign is a two-step process. First [sign](#sign-method) the document and add a signature timestamp, setting [signature_profile](#signature_profile-property) appropriately. Then [update](#update-method) the signature to take care of the rest (collect and embed the validation material, and add a document timestamp): ```csharp pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineT; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); // Update the signature to LTV - this retrieves the necessary revocation // elements, embeds them into the document, and adds a document timestamp pdfsign.Reset(); pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "updated.pdf"; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.Update(); ``` Validation material "completeness" can be subjective and depends on several factors, including the following: - The working environment. For example, your organization may explicitly trust its own self-signed TSA certificate. Signatures timestamped with this certificate will be considered B-LTA by your organization, but for any external bodies, those signatures would be rendered as B-LT or even B-B, as they do not know or trust the custom TSA certificate. - The time that has passed since the last document timestamp. If an archived (B-LTA) document is not re-timestamped before its last timestamp expires, it will drop back to a lower signature level. ### 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](#sign-method) and [update](#update-method) in PDFSign as well as [verify](PDFVerify.md#PDFVerify_m_Verify) in PDFVerify, as all three methods execute the chain validation procedure (if it is enabled). **Validation Policy** The [validation_policy](#validation_policy-property) property dictates how thoroughly the chain is validated. It includes options to control which checks the class 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) 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) property, which allows you to specify the locations in which the class 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) property) are all supported. **Offline Mode** The [offline_mode](#offline_mode-property) property provides the ability to sign or verify the document without contacting online sources. If this property is enabled, the class 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. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [attachment_count](#attachment_count-property) | The number of records in the Attachment arrays. | | [attachment_content_type](#attachment_content_type-property) | The content type of the attachment. | | [attachment_creation_date](#attachment_creation_date-property) | The creation date of the attachment. | | [attachment_data](#attachment_data-property) | The raw data of the attachment. | | [attachment_description](#attachment_description-property) | A textual description of the attachment. | | [attachment_file_name](#attachment_file_name-property) | The path and filename of the attachment. | | [attachment_modification_date](#attachment_modification_date-property) | The date and time of the file's last modification. | | [attachment_name](#attachment_name-property) | The name of the attachment. | | [attachment_size](#attachment_size-property) | The attachment's size in bytes. | | [blocked_cert_count](#blocked_cert_count-property) | The number of records in the BlockedCert arrays. | | [blocked_cert_effective_date](#blocked_cert_effective_date-property) | The date on which this certificate becomes valid. | | [blocked_cert_encoded](#blocked_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [blocked_cert_expiration_date](#blocked_cert_expiration_date-property) | The date on which the certificate expires. | | [blocked_cert_extended_key_usage](#blocked_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [blocked_cert_fingerprint](#blocked_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [blocked_cert_fingerprint_sha1](#blocked_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [blocked_cert_fingerprint_sha256](#blocked_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [blocked_cert_issuer](#blocked_cert_issuer-property) | The issuer of the certificate. | | [blocked_cert_private_key](#blocked_cert_private_key-property) | The private key of the certificate (if available). | | [blocked_cert_private_key_available](#blocked_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [blocked_cert_private_key_container](#blocked_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [blocked_cert_public_key](#blocked_cert_public_key-property) | The public key of the certificate. | | [blocked_cert_public_key_algorithm](#blocked_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [blocked_cert_public_key_length](#blocked_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [blocked_cert_serial_number](#blocked_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [blocked_cert_signature_algorithm](#blocked_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [blocked_cert_store](#blocked_cert_store-property) | The name of the certificate store for the client certificate. | | [blocked_cert_store_password](#blocked_cert_store_password-property) | 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) | The type of certificate store for this certificate. | | [blocked_cert_subject](#blocked_cert_subject-property) | The subject of the certificate used for client authentication. | | [blocked_cert_subject_alt_names](#blocked_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [blocked_cert_thumbprint_md5](#blocked_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [blocked_cert_thumbprint_sha1](#blocked_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [blocked_cert_thumbprint_sha256](#blocked_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [blocked_cert_usage](#blocked_cert_usage-property) | The text description of UsageFlags . | | [blocked_cert_usage_flags](#blocked_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [blocked_cert_version](#blocked_cert_version-property) | The certificate's version number. | | [decryption_cert_effective_date](#decryption_cert_effective_date-property) | The date on which this certificate becomes valid. | | [decryption_cert_encoded](#decryption_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [decryption_cert_expiration_date](#decryption_cert_expiration_date-property) | The date on which the certificate expires. | | [decryption_cert_extended_key_usage](#decryption_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [decryption_cert_fingerprint](#decryption_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [decryption_cert_fingerprint_sha1](#decryption_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [decryption_cert_fingerprint_sha256](#decryption_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [decryption_cert_issuer](#decryption_cert_issuer-property) | The issuer of the certificate. | | [decryption_cert_private_key](#decryption_cert_private_key-property) | The private key of the certificate (if available). | | [decryption_cert_private_key_available](#decryption_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [decryption_cert_private_key_container](#decryption_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [decryption_cert_public_key](#decryption_cert_public_key-property) | The public key of the certificate. | | [decryption_cert_public_key_algorithm](#decryption_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [decryption_cert_public_key_length](#decryption_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [decryption_cert_serial_number](#decryption_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [decryption_cert_signature_algorithm](#decryption_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [decryption_cert_store](#decryption_cert_store-property) | The name of the certificate store for the client certificate. | | [decryption_cert_store_password](#decryption_cert_store_password-property) | 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) | The type of certificate store for this certificate. | | [decryption_cert_subject](#decryption_cert_subject-property) | The subject of the certificate used for client authentication. | | [decryption_cert_subject_alt_names](#decryption_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [decryption_cert_thumbprint_md5](#decryption_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [decryption_cert_thumbprint_sha1](#decryption_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [decryption_cert_thumbprint_sha256](#decryption_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [decryption_cert_usage](#decryption_cert_usage-property) | The text description of UsageFlags . | | [decryption_cert_usage_flags](#decryption_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [decryption_cert_version](#decryption_cert_version-property) | The certificate's version number. | | [document_cert_count](#document_cert_count-property) | The number of records in the DocumentCert arrays. | | [document_cert_effective_date](#document_cert_effective_date-property) | The date on which this certificate becomes valid. | | [document_cert_encoded](#document_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [document_cert_expiration_date](#document_cert_expiration_date-property) | The date on which the certificate expires. | | [document_cert_extended_key_usage](#document_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [document_cert_fingerprint](#document_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [document_cert_fingerprint_sha1](#document_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [document_cert_fingerprint_sha256](#document_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [document_cert_issuer](#document_cert_issuer-property) | The issuer of the certificate. | | [document_cert_private_key](#document_cert_private_key-property) | The private key of the certificate (if available). | | [document_cert_private_key_available](#document_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [document_cert_private_key_container](#document_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [document_cert_public_key](#document_cert_public_key-property) | The public key of the certificate. | | [document_cert_public_key_algorithm](#document_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [document_cert_public_key_length](#document_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [document_cert_serial_number](#document_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [document_cert_signature_algorithm](#document_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [document_cert_store](#document_cert_store-property) | The name of the certificate store for the client certificate. | | [document_cert_store_password](#document_cert_store_password-property) | 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) | The type of certificate store for this certificate. | | [document_cert_subject](#document_cert_subject-property) | The subject of the certificate used for client authentication. | | [document_cert_subject_alt_names](#document_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [document_cert_thumbprint_md5](#document_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [document_cert_thumbprint_sha1](#document_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [document_cert_thumbprint_sha256](#document_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [document_cert_usage](#document_cert_usage-property) | The text description of UsageFlags . | | [document_cert_usage_flags](#document_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [document_cert_version](#document_cert_version-property) | The certificate's version number. | | [firewall_auto_detect](#firewall_auto_detect-property) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_host](#firewall_host-property) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_type](#firewall_type-property) | The type of firewall to connect through. | | [firewall_user](#firewall_user-property) | A username if authentication is to be used when connecting through a firewall. | | [input_data](#input_data-property) | A byte array containing the PDF document to process. | | [input_file](#input_file-property) | The PDF file to process. | | [known_cert_count](#known_cert_count-property) | The number of records in the KnownCert arrays. | | [known_cert_effective_date](#known_cert_effective_date-property) | The date on which this certificate becomes valid. | | [known_cert_encoded](#known_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [known_cert_expiration_date](#known_cert_expiration_date-property) | The date on which the certificate expires. | | [known_cert_extended_key_usage](#known_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [known_cert_fingerprint](#known_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [known_cert_fingerprint_sha1](#known_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [known_cert_fingerprint_sha256](#known_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [known_cert_issuer](#known_cert_issuer-property) | The issuer of the certificate. | | [known_cert_private_key](#known_cert_private_key-property) | The private key of the certificate (if available). | | [known_cert_private_key_available](#known_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [known_cert_private_key_container](#known_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [known_cert_public_key](#known_cert_public_key-property) | The public key of the certificate. | | [known_cert_public_key_algorithm](#known_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [known_cert_public_key_length](#known_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [known_cert_serial_number](#known_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [known_cert_signature_algorithm](#known_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [known_cert_store](#known_cert_store-property) | The name of the certificate store for the client certificate. | | [known_cert_store_password](#known_cert_store_password-property) | 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) | The type of certificate store for this certificate. | | [known_cert_subject](#known_cert_subject-property) | The subject of the certificate used for client authentication. | | [known_cert_subject_alt_names](#known_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [known_cert_thumbprint_md5](#known_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [known_cert_thumbprint_sha1](#known_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [known_cert_thumbprint_sha256](#known_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [known_cert_usage](#known_cert_usage-property) | The text description of UsageFlags . | | [known_cert_usage_flags](#known_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [known_cert_version](#known_cert_version-property) | The certificate's version number. | | [offline_mode](#offline_mode-property) | Whether the class is operating in offline mode. | | [output_data](#output_data-property) | A byte array containing the PDF document after processing. | | [output_file](#output_file-property) | The path to a local file where the output is written. | | [overwrite](#overwrite-property) | Whether the class should overwrite files. | | [password](#password-property) | The password to decrypt the document with. | | [pdf_signature_count](#pdf_signature_count-property) | The number of records in the PDFSignature arrays. | | [pdf_signature_author_name](#pdf_signature_author_name-property) | The human-readable name of the signer. | | [pdf_signature_chain_validation_details](#pdf_signature_chain_validation_details-property) | The details of the certificate chain validation outcome. | | [pdf_signature_chain_validation_result](#pdf_signature_chain_validation_result-property) | The outcome of the certificate chain validation routine. | | [pdf_signature_claimed_signing_time](#pdf_signature_claimed_signing_time-property) | The signature's creation time in UTC. | | [pdf_signature_coverage_ends_at](#pdf_signature_coverage_ends_at-property) | The byte offset in the PDF file where the signature coverage ends. | | [pdf_signature_hash_algorithm](#pdf_signature_hash_algorithm-property) | The hash algorithm that was used for signing. | | [pdf_signature_profile](#pdf_signature_profile-property) | The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI. | | [pdf_signature_reason](#pdf_signature_reason-property) | The reason for signing. | | [pdf_signature_signer_cert_index](#pdf_signature_signer_cert_index-property) | The index of the signer certificate in the DocumentCerts collection. | | [pdf_signature_timestamp_cert_index](#pdf_signature_timestamp_cert_index-property) | The index of the timestamping certificate in the DocumentCerts collection (if applicable). | | [pdf_signature_timestamped](#pdf_signature_timestamped-property) | Whether the signature contains an embedded timestamp. | | [pdf_signature_type](#pdf_signature_type-property) | The type of the signature that was created. | | [pdf_signature_validated_signing_time](#pdf_signature_validated_signing_time-property) | The certified signing time in UTC. | | [pdf_signature_validation_result](#pdf_signature_validation_result-property) | The outcome of the cryptographic signature validation. | | [pdf_signature_widget_height](#pdf_signature_widget_height-property) | The height of the signature widget in points. | | [pdf_signature_widget_offset_x](#pdf_signature_widget_offset_x-property) | The signature widget offset from the left-hand page border in points. | | [pdf_signature_widget_offset_y](#pdf_signature_widget_offset_y-property) | The signature widget offset from the bottom page border in points. | | [pdf_signature_widget_pages](#pdf_signature_widget_pages-property) | The pages that the signature and its widget are placed on. | | [pdf_signature_widget_width](#pdf_signature_widget_width-property) | The width of the signature widget in points. | | [proxy_auth_scheme](#proxy_auth_scheme-property) | The type of authorization to perform when connecting to the proxy. | | [proxy_auto_detect](#proxy_auto_detect-property) | Whether to automatically detect and use proxy system settings, if available. | | [proxy_password](#proxy_password-property) | A password if authentication is to be used for the proxy. | | [proxy_port](#proxy_port-property) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). | | [proxy_server](#proxy_server-property) | 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) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. | | [proxy_user](#proxy_user-property) | A username if authentication is to be used for the proxy. | | [remote_signature_data](#remote_signature_data-property) | The signature data obtained from a remote signer. | | [remote_signature_digest](#remote_signature_digest-property) | The digest to be signed remotely. | | [remote_signature_method](#remote_signature_method-property) | The remote signing method. | | [revocation_check](#revocation_check-property) | The kind(s) of revocation check to perform for all chain certificates. | | [signature_author_name](#signature_author_name-property) | The human-readable name of the signer. | | [signature_claimed_signing_time](#signature_claimed_signing_time-property) | The signature's creation time. | | [signature_field](#signature_field-property) | The index of the empty signature field to sign. | | [signature_hash_algorithm](#signature_hash_algorithm-property) | The hash algorithm to be used for signing. | | [signature_profile](#signature_profile-property) | The PAdES profile to apply when creating the signature. | | [signature_reason](#signature_reason-property) | The reason for signing. | | [signature_type](#signature_type-property) | The type of signature to create. | | [signature_widget_height](#signature_widget_height-property) | The height of the signature widget. | | [signature_widget_offset_x](#signature_widget_offset_x-property) | The signature widget offset from the left-hand page border. | | [signature_widget_offset_y](#signature_widget_offset_y-property) | The signature widget offset from the bottom page border. | | [signature_widget_pages](#signature_widget_pages-property) | The pages to place the signature and its widget on. | | [signature_widget_width](#signature_widget_width-property) | The width of the signature widget. | | [signing_cert_effective_date](#signing_cert_effective_date-property) | The date on which this certificate becomes valid. | | [signing_cert_encoded](#signing_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [signing_cert_expiration_date](#signing_cert_expiration_date-property) | The date on which the certificate expires. | | [signing_cert_extended_key_usage](#signing_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [signing_cert_fingerprint](#signing_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [signing_cert_fingerprint_sha1](#signing_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [signing_cert_fingerprint_sha256](#signing_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [signing_cert_issuer](#signing_cert_issuer-property) | The issuer of the certificate. | | [signing_cert_private_key](#signing_cert_private_key-property) | The private key of the certificate (if available). | | [signing_cert_private_key_available](#signing_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [signing_cert_private_key_container](#signing_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [signing_cert_public_key](#signing_cert_public_key-property) | The public key of the certificate. | | [signing_cert_public_key_algorithm](#signing_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [signing_cert_public_key_length](#signing_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [signing_cert_serial_number](#signing_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [signing_cert_signature_algorithm](#signing_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [signing_cert_store](#signing_cert_store-property) | The name of the certificate store for the client certificate. | | [signing_cert_store_password](#signing_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [signing_cert_store_type](#signing_cert_store_type-property) | The type of certificate store for this certificate. | | [signing_cert_subject](#signing_cert_subject-property) | The subject of the certificate used for client authentication. | | [signing_cert_subject_alt_names](#signing_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [signing_cert_thumbprint_md5](#signing_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [signing_cert_thumbprint_sha1](#signing_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [signing_cert_thumbprint_sha256](#signing_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [signing_cert_usage](#signing_cert_usage-property) | The text description of UsageFlags . | | [signing_cert_usage_flags](#signing_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [signing_cert_version](#signing_cert_version-property) | The certificate's version number. | | [timestamp_server](#timestamp_server-property) | The address of the timestamping server. | | [trusted_cert_count](#trusted_cert_count-property) | The number of records in the TrustedCert arrays. | | [trusted_cert_effective_date](#trusted_cert_effective_date-property) | The date on which this certificate becomes valid. | | [trusted_cert_encoded](#trusted_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [trusted_cert_expiration_date](#trusted_cert_expiration_date-property) | The date on which the certificate expires. | | [trusted_cert_extended_key_usage](#trusted_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [trusted_cert_fingerprint](#trusted_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [trusted_cert_fingerprint_sha1](#trusted_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [trusted_cert_fingerprint_sha256](#trusted_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [trusted_cert_issuer](#trusted_cert_issuer-property) | The issuer of the certificate. | | [trusted_cert_private_key](#trusted_cert_private_key-property) | The private key of the certificate (if available). | | [trusted_cert_private_key_available](#trusted_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [trusted_cert_private_key_container](#trusted_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [trusted_cert_public_key](#trusted_cert_public_key-property) | The public key of the certificate. | | [trusted_cert_public_key_algorithm](#trusted_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [trusted_cert_public_key_length](#trusted_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [trusted_cert_serial_number](#trusted_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [trusted_cert_signature_algorithm](#trusted_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [trusted_cert_store](#trusted_cert_store-property) | The name of the certificate store for the client certificate. | | [trusted_cert_store_password](#trusted_cert_store_password-property) | 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) | The type of certificate store for this certificate. | | [trusted_cert_subject](#trusted_cert_subject-property) | The subject of the certificate used for client authentication. | | [trusted_cert_subject_alt_names](#trusted_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [trusted_cert_thumbprint_md5](#trusted_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [trusted_cert_thumbprint_sha1](#trusted_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [trusted_cert_thumbprint_sha256](#trusted_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [trusted_cert_usage](#trusted_cert_usage-property) | The text description of UsageFlags . | | [trusted_cert_usage_flags](#trusted_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [trusted_cert_version](#trusted_cert_version-property) | The certificate's version number. | | [trusted_lists](#trusted_lists-property) | A list of known Trusted Lists for chain validation. | | [trust_sources](#trust_sources-property) | The trust sources to use during chain validation. | | [validation_flags](#validation_flags-property) | Additional chain validation settings. | | [validation_policy](#validation_policy-property) | The level at which to perform chain validation. | | [validation_time](#validation_time-property) | The time point at which the signature should be validated. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [add_attachment](#add_attachment-method) | Adds an attachment to the document. | | [add_timestamp](#add_timestamp-method) | Adds a document timestamp to the document. | | [close](#close-method) | Closes the opened document. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [encrypted](#encrypted-method) | Checks whether the document is encrypted. | | [get_page_property](#get_page_property-method) | Returns the value of a page property. | | [get_widget_property](#get_widget_property-method) | Returns the value of a signature widget property. | | [interrupt](#interrupt-method) | Interrupts the current action. | | [open](#open-method) | Opens the document for processing. | | [remove_attachment](#remove_attachment-method) | Removes an attachment from the document. | | [reset](#reset-method) | Resets the class. | | [save_attachment](#save_attachment-method) | Saves a PDF attachment to a file. | | [set_widget_property](#set_widget_property-method) | Sets the value of a signature widget property. | | [sign](#sign-method) | Signs the data. | | [signed](#signed-method) | Checks whether the document is signed. | | [update](#update-method) | Updates the most recent signature. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_chain_cert](#on_chain_cert-event) | Fired when the class encounters a chain certificate. | | [on_document_info](#on_document_info-event) | Fired when the document has been loaded into memory. | | [on_error](#on_error-event) | Fired when information is available about errors during data delivery. | | [on_log](#on_log-event) | Fired once for each log message. | | [on_password](#on_password-event) | Fired when the class detects that the document is encrypted with a password. | | [on_recipient_info](#on_recipient_info-event) | Fired for each recipient certificate of the encrypted document. | | [on_signature_info](#on_signature_info-event) | Fired when the class finds a signature in the document. | | [on_signature_processed](#on_signature_processed-event) | Fired after a signature has been processed. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event) | Fired when secure connection progress messages are available. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AFRelationship\[Key\]](#AFRelationship[Key]) | The value of the AFRelationship key for the attachment. | | [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. | | [CompressDSS](#CompressDSS) | Whether to compress content in the DSS dictionary. | | [ContactInfo\[Index\]](#ContactInfo[Index]) | The signer's contact information. | | [CustomProfile](#CustomProfile) | A pre-defined custom profile to apply when creating the signature. | | [CustomSignedAttributes](#CustomSignedAttributes) | The custom signed attributes to be added to the inner CMS. | | [EnforcePDFA](#EnforcePDFA) | Whether to enforce PDF/A compliance. | | [ExtraSpace](#ExtraSpace) | The number of extra zero bytes to allocate in the document behind the signature. | | [FallbackFont](#FallbackFont) | The fallback font. | | [FilterName\[Index\]](#FilterName[Index]) | The signature filter name. | | [FontPaths](#FontPaths) | The font search paths. | | [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. | | [IncludeRevocationInfo](#IncludeRevocationInfo) | Whether to include revocation information in the document. | | [IncludeSigningChain](#IncludeSigningChain) | Whether to include the full signing chain in the signature. | | [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. | | [PolicyHash](#PolicyHash) | The signature policy hash value. | | [PolicyHashAlgorithm](#PolicyHashAlgorithm) | The algorithm that was used to calculate the signature policy hash. | | [PolicyId](#PolicyId) | The policy Id to be included in the signature. | | [PreferEmbeddedRevocationInfo](#PreferEmbeddedRevocationInfo) | Whether to prioritize revocation information that is embedded into the document. | | [RemoteSignatureData](#RemoteSignatureData) | The hex-encoded signature data obtained from a remote signing engine. | | [RemoteSignatureDigest](#RemoteSignatureDigest) | The hex-encoded digest to be signed remotely. | | [RemoteSignatureMethod](#RemoteSignatureMethod) | The remote signing method. | | [RevisionOffsets](#RevisionOffsets) | The offsets of the document revisions. | | [SaveChanges](#SaveChanges) | Whether to save changes made to the document. | | [SignatureData\[Index\]](#SignatureData[Index]) | The hex-encoded representation of the underlying PKCS#7/CMS signature container. | | [SystemFontNames](#SystemFontNames) | The system font names. | | [TempPath](#TempPath) | The location where temporary files are stored. | | [TimestampHashAlgorithm](#TimestampHashAlgorithm) | A specific hash algorithm for use with the timestamping service. | | [TSATLSClientCertStore](#TSATLSClientCertStore) | The TLS client certificate store to search. | | [TSATLSClientCertStorePassword](#TSATLSClientCertStorePassword) | The password needed to open the TLS client certificate store. | | [TSATLSClientCertStoreType](#TSATLSClientCertStoreType) | The type of the TLS client certificate store. | | [TSATLSClientCertSubject](#TSATLSClientCertSubject) | The subject of the TLS client certificate. | | [UpdateIndex](#UpdateIndex) | The index of the signature to update. | | [UsePSS](#UsePSS) | Whether to use RSA-PSS during signing and verification. | | [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. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # attachment_count property The number of records in the Attachment arrays. ## Syntax ```text def get_attachment_count() -> int: ... def set_attachment_count(value: int) -> None: ... attachment_count = property(get_attachment_count, set_attachment_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [attachment_content_type](#attachment_content_type-property) - [attachment_creation_date](#attachment_creation_date-property) - [attachment_data](#attachment_data-property) - [attachment_description](#attachment_description-property) - [attachment_file_name](#attachment_file_name-property) - [attachment_modification_date](#attachment_modification_date-property) - [attachment_name](#attachment_name-property) - [attachment_size](#attachment_size-property) The array indices start at *0* and end at *attachment_count - 1*. # attachment_content_type property The content type of the attachment. ## Syntax ```text def get_attachment_content_type(attachment_index: int) -> str: ... def set_attachment_content_type(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The content type of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachment_count](#attachment_count-property) property. # attachment_creation_date property The creation date of the attachment. ## Syntax ```text def get_attachment_creation_date(attachment_index: int) -> str: ... def set_attachment_creation_date(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The creation date of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachment_count](#attachment_count-property) property. # attachment_data property The raw data of the attachment. ## Syntax ```text def get_attachment_data(attachment_index: int) -> bytes: ... def set_attachment_data(attachment_index: int, value: bytes) -> None: ... ``` ## Default Value "" ## Remarks The raw data of the attachment. If [attachment_output_stream](#PDFSign_p_AttachmentOutputStream) is not set to a valid stream, the class writes to this property when an empty string is passed to save_attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachment_count](#attachment_count-property) property. # attachment_description property A textual description of the attachment. ## Syntax ```text def get_attachment_description(attachment_index: int) -> str: ... def set_attachment_description(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks A textual description of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachment_count](#attachment_count-property) property. # attachment_file_name property The path and filename of the attachment. ## Syntax ```text def get_attachment_file_name(attachment_index: int) -> str: ... def set_attachment_file_name(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The path and filename of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachment_count](#attachment_count-property) property. # attachment_modification_date property The date and time of the file's last modification. ## Syntax ```text def get_attachment_modification_date(attachment_index: int) -> str: ... def set_attachment_modification_date(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The date and time of the file's last modification. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachment_count](#attachment_count-property) property. # attachment_name property The name of the attachment. ## Syntax ```text def get_attachment_name(attachment_index: int) -> str: ... def set_attachment_name(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The name of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachment_count](#attachment_count-property) property. # attachment_size property The attachment's size in bytes. ## Syntax ```text def get_attachment_size(attachment_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The attachment's size in bytes. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachment_count](#attachment_count-property) property. This property is read-only. # blocked_cert_count property The number of records in the BlockedCert arrays. ## Syntax ```text def get_blocked_cert_count() -> int: ... def set_blocked_cert_count(value: int) -> None: ... blocked_cert_count = property(get_blocked_cert_count, set_blocked_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [blocked_cert_effective_date](#blocked_cert_effective_date-property) - [blocked_cert_encoded](#blocked_cert_encoded-property) - [blocked_cert_expiration_date](#blocked_cert_expiration_date-property) - [blocked_cert_extended_key_usage](#blocked_cert_extended_key_usage-property) - [blocked_cert_fingerprint](#blocked_cert_fingerprint-property) - [blocked_cert_fingerprint_sha1](#blocked_cert_fingerprint_sha1-property) - [blocked_cert_fingerprint_sha256](#blocked_cert_fingerprint_sha256-property) - [blocked_cert_issuer](#blocked_cert_issuer-property) - [blocked_cert_private_key](#blocked_cert_private_key-property) - [blocked_cert_private_key_available](#blocked_cert_private_key_available-property) - [blocked_cert_private_key_container](#blocked_cert_private_key_container-property) - [blocked_cert_public_key](#blocked_cert_public_key-property) - [blocked_cert_public_key_algorithm](#blocked_cert_public_key_algorithm-property) - [blocked_cert_public_key_length](#blocked_cert_public_key_length-property) - [blocked_cert_serial_number](#blocked_cert_serial_number-property) - [blocked_cert_signature_algorithm](#blocked_cert_signature_algorithm-property) - [blocked_cert_store](#blocked_cert_store-property) - [blocked_cert_store_password](#blocked_cert_store_password-property) - [blocked_cert_store_type](#blocked_cert_store_type-property) - [blocked_cert_subject](#blocked_cert_subject-property) - [blocked_cert_subject_alt_names](#blocked_cert_subject_alt_names-property) - [blocked_cert_thumbprint_md5](#blocked_cert_thumbprint_md5-property) - [blocked_cert_thumbprint_sha1](#blocked_cert_thumbprint_sha1-property) - [blocked_cert_thumbprint_sha256](#blocked_cert_thumbprint_sha256-property) - [blocked_cert_usage](#blocked_cert_usage-property) - [blocked_cert_usage_flags](#blocked_cert_usage_flags-property) - [blocked_cert_version](#blocked_cert_version-property) The array indices start at *0* and end at *blocked_cert_count - 1*. # blocked_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_blocked_cert_effective_date(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_blocked_cert_encoded(blocked_cert_index: int) -> bytes: ... def set_blocked_cert_encoded(blocked_cert_index: int, value: bytes) -> None: ... ``` ## 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) and [blocked_cert_subject](#blocked_cert_subject-property) properties also may be used to specify a certificate. When [blocked_cert_encoded](#blocked_cert_encoded-property) is set, a search is initiated in the current [blocked_cert_store](#blocked_cert_store-property) for the private key of the certificate. If the key is found, [blocked_cert_subject](#blocked_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [blocked_cert_subject](#blocked_cert_subject-property) is set to an empty string. The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. # blocked_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_blocked_cert_expiration_date(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_blocked_cert_extended_key_usage(blocked_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_blocked_cert_fingerprint(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_blocked_cert_fingerprint_sha1(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_blocked_cert_fingerprint_sha256(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_blocked_cert_issuer(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_blocked_cert_private_key(blocked_cert_index: int) -> str: ... ``` ## 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) may be available but not exportable. In this case, [blocked_cert_private_key](#blocked_cert_private_key-property) returns an empty string. The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_blocked_cert_private_key_available(blocked_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether a [blocked_cert_private_key](#blocked_cert_private_key-property) is available for the selected certificate. If [blocked_cert_private_key_available](#blocked_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_blocked_cert_private_key_container(blocked_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the [blocked_cert_private_key](#blocked_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_public_key property The public key of the certificate. ## Syntax ```text def get_blocked_cert_public_key(blocked_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_blocked_cert_public_key_algorithm(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_blocked_cert_public_key_length(blocked_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_blocked_cert_serial_number(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_blocked_cert_signature_algorithm(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_blocked_cert_store(blocked_cert_index: int) -> bytes: ... def set_blocked_cert_store(blocked_cert_index: int, value: bytes) -> None: ... ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [blocked_cert_store_type](#blocked_cert_store_type-property) property denotes the type of the certificate store specified by [blocked_cert_store](#blocked_cert_store-property). If the store is password-protected, specify the password in [blocked_cert_store_password](#blocked_cert_store_password-property). [blocked_cert_store](#blocked_cert_store-property) is used in conjunction with the [blocked_cert_subject](#blocked_cert_subject-property) property to specify client certificates. If [blocked_cert_store](#blocked_cert_store-property) has a value, and [blocked_cert_subject](#blocked_cert_subject-property) or [blocked_cert_encoded](#blocked_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [blocked_cert_subject](#blocked_cert_subject-property) 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. # blocked_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_blocked_cert_store_password(blocked_cert_index: int) -> str: ... def set_blocked_cert_store_password(blocked_cert_index: int, value: str) -> None: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. # blocked_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_blocked_cert_store_type(blocked_cert_index: int) -> int: ... def set_blocked_cert_store_type(blocked_cert_index: int, value: int) -> None: ... ``` ## 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 class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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), the full path of the PKCS#11 DLL as the [blocked_cert_store](#blocked_cert_store-property), and the PIN as the [blocked_cert_store_password](#blocked_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class 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) and set [blocked_cert_store_password](#blocked_cert_store_password-property) 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. # blocked_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_blocked_cert_subject(blocked_cert_index: int) -> str: ... def set_blocked_cert_subject(blocked_cert_index: int, value: str) -> None: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. # blocked_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_blocked_cert_subject_alt_names(blocked_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_blocked_cert_thumbprint_md5(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_blocked_cert_thumbprint_sha1(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_blocked_cert_thumbprint_sha256(blocked_cert_index: int) -> str: ... ``` ## 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_blocked_cert_usage(blocked_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The text description of [blocked_cert_usage_flags](#blocked_cert_usage_flags-property). 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 *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_blocked_cert_usage_flags(blocked_cert_index: int) -> int: ... ``` ## 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) 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) property for a text representation of [blocked_cert_usage_flags](#blocked_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_version property The certificate's version number. ## Syntax ```text def get_blocked_cert_version(blocked_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # decryption_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_decryption_cert_effective_date() -> str: ... decryption_cert_effective_date = property(get_decryption_cert_effective_date, None) ``` ## 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. # decryption_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_decryption_cert_encoded() -> bytes: ... def set_decryption_cert_encoded(value: bytes) -> None: ... decryption_cert_encoded = property(get_decryption_cert_encoded, set_decryption_cert_encoded) ``` ## 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) and [decryption_cert_subject](#decryption_cert_subject-property) properties also may be used to specify a certificate. When [decryption_cert_encoded](#decryption_cert_encoded-property) is set, a search is initiated in the current [decryption_cert_store](#decryption_cert_store-property) for the private key of the certificate. If the key is found, [decryption_cert_subject](#decryption_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [decryption_cert_subject](#decryption_cert_subject-property) is set to an empty string. # decryption_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_decryption_cert_expiration_date() -> str: ... decryption_cert_expiration_date = property(get_decryption_cert_expiration_date, None) ``` ## 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. # decryption_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_decryption_cert_extended_key_usage() -> str: ... decryption_cert_extended_key_usage = property(get_decryption_cert_extended_key_usage, None) ``` ## 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. # decryption_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_decryption_cert_fingerprint() -> str: ... decryption_cert_fingerprint = property(get_decryption_cert_fingerprint, None) ``` ## 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. # decryption_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_decryption_cert_fingerprint_sha1() -> str: ... decryption_cert_fingerprint_sha1 = property(get_decryption_cert_fingerprint_sha1, None) ``` ## 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. # decryption_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_decryption_cert_fingerprint_sha256() -> str: ... decryption_cert_fingerprint_sha256 = property(get_decryption_cert_fingerprint_sha256, None) ``` ## 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. # decryption_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_decryption_cert_issuer() -> str: ... decryption_cert_issuer = property(get_decryption_cert_issuer, None) ``` ## 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. # decryption_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_decryption_cert_private_key() -> str: ... decryption_cert_private_key = property(get_decryption_cert_private_key, None) ``` ## 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) may be available but not exportable. In this case, [decryption_cert_private_key](#decryption_cert_private_key-property) returns an empty string. This property is read-only. # decryption_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_decryption_cert_private_key_available() -> bool: ... decryption_cert_private_key_available = property(get_decryption_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [decryption_cert_private_key](#decryption_cert_private_key-property) is available for the selected certificate. If [decryption_cert_private_key_available](#decryption_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # decryption_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_decryption_cert_private_key_container() -> str: ... decryption_cert_private_key_container = property(get_decryption_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [decryption_cert_private_key](#decryption_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # decryption_cert_public_key property The public key of the certificate. ## Syntax ```text def get_decryption_cert_public_key() -> str: ... decryption_cert_public_key = property(get_decryption_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # decryption_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_decryption_cert_public_key_algorithm() -> str: ... decryption_cert_public_key_algorithm = property(get_decryption_cert_public_key_algorithm, None) ``` ## 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. # decryption_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_decryption_cert_public_key_length() -> int: ... decryption_cert_public_key_length = property(get_decryption_cert_public_key_length, None) ``` ## 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. # decryption_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_decryption_cert_serial_number() -> str: ... decryption_cert_serial_number = property(get_decryption_cert_serial_number, None) ``` ## 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. # decryption_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_decryption_cert_signature_algorithm() -> str: ... decryption_cert_signature_algorithm = property(get_decryption_cert_signature_algorithm, None) ``` ## 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. # decryption_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_decryption_cert_store() -> bytes: ... def set_decryption_cert_store(value: bytes) -> None: ... decryption_cert_store = property(get_decryption_cert_store, set_decryption_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [decryption_cert_store_type](#decryption_cert_store_type-property) property denotes the type of the certificate store specified by [decryption_cert_store](#decryption_cert_store-property). If the store is password-protected, specify the password in [decryption_cert_store_password](#decryption_cert_store_password-property). [decryption_cert_store](#decryption_cert_store-property) is used in conjunction with the [decryption_cert_subject](#decryption_cert_subject-property) property to specify client certificates. If [decryption_cert_store](#decryption_cert_store-property) has a value, and [decryption_cert_subject](#decryption_cert_subject-property) or [decryption_cert_encoded](#decryption_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [decryption_cert_subject](#decryption_cert_subject-property) 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). # decryption_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_decryption_cert_store_password() -> str: ... def set_decryption_cert_store_password(value: str) -> None: ... decryption_cert_store_password = property(get_decryption_cert_store_password, set_decryption_cert_store_password) ``` ## 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. # decryption_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_decryption_cert_store_type() -> int: ... def set_decryption_cert_store_type(value: int) -> None: ... decryption_cert_store_type = property(get_decryption_cert_store_type, set_decryption_cert_store_type) ``` ## 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 class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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), the full path of the PKCS#11 DLL as the [decryption_cert_store](#decryption_cert_store-property), and the PIN as the [decryption_cert_store_password](#decryption_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class 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) and set [decryption_cert_store_password](#decryption_cert_store_password-property) 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. | # decryption_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_decryption_cert_subject() -> str: ... def set_decryption_cert_subject(value: str) -> None: ... decryption_cert_subject = property(get_decryption_cert_subject, set_decryption_cert_subject) ``` ## 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. # decryption_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_decryption_cert_subject_alt_names() -> str: ... decryption_cert_subject_alt_names = property(get_decryption_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # decryption_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_decryption_cert_thumbprint_md5() -> str: ... decryption_cert_thumbprint_md5 = property(get_decryption_cert_thumbprint_md5, None) ``` ## 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. # decryption_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_decryption_cert_thumbprint_sha1() -> str: ... decryption_cert_thumbprint_sha1 = property(get_decryption_cert_thumbprint_sha1, None) ``` ## 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. # decryption_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_decryption_cert_thumbprint_sha256() -> str: ... decryption_cert_thumbprint_sha256 = property(get_decryption_cert_thumbprint_sha256, None) ``` ## 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. # decryption_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_decryption_cert_usage() -> str: ... decryption_cert_usage = property(get_decryption_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [decryption_cert_usage_flags](#decryption_cert_usage_flags-property). 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. # decryption_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_decryption_cert_usage_flags() -> int: ... decryption_cert_usage_flags = property(get_decryption_cert_usage_flags, None) ``` ## 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) 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) property for a text representation of [decryption_cert_usage_flags](#decryption_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # decryption_cert_version property The certificate's version number. ## Syntax ```text def get_decryption_cert_version() -> str: ... decryption_cert_version = property(get_decryption_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # document_cert_count property The number of records in the DocumentCert arrays. ## Syntax ```text def get_document_cert_count() -> int: ... document_cert_count = property(get_document_cert_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [document_cert_effective_date](#document_cert_effective_date-property) - [document_cert_encoded](#document_cert_encoded-property) - [document_cert_expiration_date](#document_cert_expiration_date-property) - [document_cert_extended_key_usage](#document_cert_extended_key_usage-property) - [document_cert_fingerprint](#document_cert_fingerprint-property) - [document_cert_fingerprint_sha1](#document_cert_fingerprint_sha1-property) - [document_cert_fingerprint_sha256](#document_cert_fingerprint_sha256-property) - [document_cert_issuer](#document_cert_issuer-property) - [document_cert_private_key](#document_cert_private_key-property) - [document_cert_private_key_available](#document_cert_private_key_available-property) - [document_cert_private_key_container](#document_cert_private_key_container-property) - [document_cert_public_key](#document_cert_public_key-property) - [document_cert_public_key_algorithm](#document_cert_public_key_algorithm-property) - [document_cert_public_key_length](#document_cert_public_key_length-property) - [document_cert_serial_number](#document_cert_serial_number-property) - [document_cert_signature_algorithm](#document_cert_signature_algorithm-property) - [document_cert_store](#document_cert_store-property) - [document_cert_store_password](#document_cert_store_password-property) - [document_cert_store_type](#document_cert_store_type-property) - [document_cert_subject](#document_cert_subject-property) - [document_cert_subject_alt_names](#document_cert_subject_alt_names-property) - [document_cert_thumbprint_md5](#document_cert_thumbprint_md5-property) - [document_cert_thumbprint_sha1](#document_cert_thumbprint_sha1-property) - [document_cert_thumbprint_sha256](#document_cert_thumbprint_sha256-property) - [document_cert_usage](#document_cert_usage-property) - [document_cert_usage_flags](#document_cert_usage_flags-property) - [document_cert_version](#document_cert_version-property) The array indices start at *0* and end at *document_cert_count - 1*. This property is read-only. # document_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_document_cert_effective_date(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_document_cert_encoded(document_cert_index: int) -> bytes: ... ``` ## 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) and [document_cert_subject](#document_cert_subject-property) properties also may be used to specify a certificate. When [document_cert_encoded](#document_cert_encoded-property) is set, a search is initiated in the current [document_cert_store](#document_cert_store-property) for the private key of the certificate. If the key is found, [document_cert_subject](#document_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [document_cert_subject](#document_cert_subject-property) is set to an empty string. The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_document_cert_expiration_date(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_document_cert_extended_key_usage(document_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_document_cert_fingerprint(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_document_cert_fingerprint_sha1(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_document_cert_fingerprint_sha256(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_document_cert_issuer(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_document_cert_private_key(document_cert_index: int) -> str: ... ``` ## 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) may be available but not exportable. In this case, [document_cert_private_key](#document_cert_private_key-property) returns an empty string. The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_document_cert_private_key_available(document_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether a [document_cert_private_key](#document_cert_private_key-property) is available for the selected certificate. If [document_cert_private_key_available](#document_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_document_cert_private_key_container(document_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the [document_cert_private_key](#document_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_public_key property The public key of the certificate. ## Syntax ```text def get_document_cert_public_key(document_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_document_cert_public_key_algorithm(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_document_cert_public_key_length(document_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_document_cert_serial_number(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_document_cert_signature_algorithm(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_document_cert_store(document_cert_index: int) -> bytes: ... ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [document_cert_store_type](#document_cert_store_type-property) property denotes the type of the certificate store specified by [document_cert_store](#document_cert_store-property). If the store is password-protected, specify the password in [document_cert_store_password](#document_cert_store_password-property). [document_cert_store](#document_cert_store-property) is used in conjunction with the [document_cert_subject](#document_cert_subject-property) property to specify client certificates. If [document_cert_store](#document_cert_store-property) has a value, and [document_cert_subject](#document_cert_subject-property) or [document_cert_encoded](#document_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [document_cert_subject](#document_cert_subject-property) 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_document_cert_store_password(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_document_cert_store_type(document_cert_index: int) -> int: ... ``` ## 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 class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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), the full path of the PKCS#11 DLL as the [document_cert_store](#document_cert_store-property), and the PIN as the [document_cert_store_password](#document_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class 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) and set [document_cert_store_password](#document_cert_store_password-property) 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_document_cert_subject(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_document_cert_subject_alt_names(document_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_document_cert_thumbprint_md5(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_document_cert_thumbprint_sha1(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_document_cert_thumbprint_sha256(document_cert_index: int) -> str: ... ``` ## 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_document_cert_usage(document_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The text description of [document_cert_usage_flags](#document_cert_usage_flags-property). 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 *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_document_cert_usage_flags(document_cert_index: int) -> int: ... ``` ## 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) 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) property for a text representation of [document_cert_usage_flags](#document_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # document_cert_version property The certificate's version number. ## Syntax ```text def get_document_cert_version(document_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *document_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [document_cert_count](#document_cert_count-property) property. This property is read-only. # firewall_auto_detect property Whether to automatically detect and use firewall system settings, if available. ## Syntax ```text def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ... firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use firewall system settings, if available. # firewall_host property The name or IP address of the firewall (optional). ## Syntax ```text def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ... firewall_host = property(get_firewall_host, set_firewall_host) ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property) 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 class fails with an error. # firewall_password property A password if authentication is to be used when connecting through the firewall. ## Syntax ```text def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ... firewall_password = property(get_firewall_password, set_firewall_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property) is specified, the [firewall_user](#firewall_user-property) and [firewall_password](#firewall_password-property) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. # firewall_port property The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax ```text def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ... firewall_port = property(get_firewall_port, set_firewall_port) ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property). See the description of the [firewall_host](#firewall_host-property) property for details. NOTE: This property is set automatically when [firewall_type](#PDFSign_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_type](#PDFSign_p_FirewallFirewallType) property for details. # firewall_type property The type of firewall to connect through. ## Syntax ```text def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ... firewall_type = property(get_firewall_type, set_firewall_type) ``` ## 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) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property) is set to 1080. | # firewall_user property A username if authentication is to be used when connecting through a firewall. ## Syntax ```text def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ... firewall_user = property(get_firewall_user, set_firewall_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property) is specified, this property and the [firewall_password](#firewall_password-property) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error. # input_data property A byte array containing the PDF document to process. ## Syntax ```text def get_input_data() -> bytes: ... def set_input_data(value: bytes) -> None: ... input_data = property(get_input_data, set_input_data) ``` ## Remarks This property is used to assign a byte array containing the PDF document to be processed. # input_file property The PDF file to process. ## Syntax ```text def get_input_file() -> str: ... def set_input_file(value: str) -> None: ... input_file = property(get_input_file, set_input_file) ``` ## Default Value "" ## Remarks This property is used to provide a path to the PDF document to be processed. # known_cert_count property The number of records in the KnownCert arrays. ## Syntax ```text def get_known_cert_count() -> int: ... def set_known_cert_count(value: int) -> None: ... known_cert_count = property(get_known_cert_count, set_known_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_cert_effective_date](#known_cert_effective_date-property) - [known_cert_encoded](#known_cert_encoded-property) - [known_cert_expiration_date](#known_cert_expiration_date-property) - [known_cert_extended_key_usage](#known_cert_extended_key_usage-property) - [known_cert_fingerprint](#known_cert_fingerprint-property) - [known_cert_fingerprint_sha1](#known_cert_fingerprint_sha1-property) - [known_cert_fingerprint_sha256](#known_cert_fingerprint_sha256-property) - [known_cert_issuer](#known_cert_issuer-property) - [known_cert_private_key](#known_cert_private_key-property) - [known_cert_private_key_available](#known_cert_private_key_available-property) - [known_cert_private_key_container](#known_cert_private_key_container-property) - [known_cert_public_key](#known_cert_public_key-property) - [known_cert_public_key_algorithm](#known_cert_public_key_algorithm-property) - [known_cert_public_key_length](#known_cert_public_key_length-property) - [known_cert_serial_number](#known_cert_serial_number-property) - [known_cert_signature_algorithm](#known_cert_signature_algorithm-property) - [known_cert_store](#known_cert_store-property) - [known_cert_store_password](#known_cert_store_password-property) - [known_cert_store_type](#known_cert_store_type-property) - [known_cert_subject](#known_cert_subject-property) - [known_cert_subject_alt_names](#known_cert_subject_alt_names-property) - [known_cert_thumbprint_md5](#known_cert_thumbprint_md5-property) - [known_cert_thumbprint_sha1](#known_cert_thumbprint_sha1-property) - [known_cert_thumbprint_sha256](#known_cert_thumbprint_sha256-property) - [known_cert_usage](#known_cert_usage-property) - [known_cert_usage_flags](#known_cert_usage_flags-property) - [known_cert_version](#known_cert_version-property) The array indices start at *0* and end at *known_cert_count - 1*. # known_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_known_cert_effective_date(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_known_cert_encoded(known_cert_index: int) -> bytes: ... def set_known_cert_encoded(known_cert_index: int, value: bytes) -> None: ... ``` ## 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) and [known_cert_subject](#known_cert_subject-property) properties also may be used to specify a certificate. When [known_cert_encoded](#known_cert_encoded-property) is set, a search is initiated in the current [known_cert_store](#known_cert_store-property) for the private key of the certificate. If the key is found, [known_cert_subject](#known_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [known_cert_subject](#known_cert_subject-property) is set to an empty string. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. # known_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_known_cert_expiration_date(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_known_cert_extended_key_usage(known_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_known_cert_fingerprint(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_known_cert_fingerprint_sha1(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_known_cert_fingerprint_sha256(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_known_cert_issuer(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_known_cert_private_key(known_cert_index: int) -> str: ... ``` ## 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) may be available but not exportable. In this case, [known_cert_private_key](#known_cert_private_key-property) returns an empty string. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_known_cert_private_key_available(known_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether a [known_cert_private_key](#known_cert_private_key-property) is available for the selected certificate. If [known_cert_private_key_available](#known_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_known_cert_private_key_container(known_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the [known_cert_private_key](#known_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_public_key property The public key of the certificate. ## Syntax ```text def get_known_cert_public_key(known_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_known_cert_public_key_algorithm(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_known_cert_public_key_length(known_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_known_cert_serial_number(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_known_cert_signature_algorithm(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_known_cert_store(known_cert_index: int) -> bytes: ... def set_known_cert_store(known_cert_index: int, value: bytes) -> None: ... ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [known_cert_store_type](#known_cert_store_type-property) property denotes the type of the certificate store specified by [known_cert_store](#known_cert_store-property). If the store is password-protected, specify the password in [known_cert_store_password](#known_cert_store_password-property). [known_cert_store](#known_cert_store-property) is used in conjunction with the [known_cert_subject](#known_cert_subject-property) property to specify client certificates. If [known_cert_store](#known_cert_store-property) has a value, and [known_cert_subject](#known_cert_subject-property) or [known_cert_encoded](#known_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [known_cert_subject](#known_cert_subject-property) 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. # known_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_known_cert_store_password(known_cert_index: int) -> str: ... def set_known_cert_store_password(known_cert_index: int, value: str) -> None: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. # known_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_known_cert_store_type(known_cert_index: int) -> int: ... def set_known_cert_store_type(known_cert_index: int, value: int) -> None: ... ``` ## 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 class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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), the full path of the PKCS#11 DLL as the [known_cert_store](#known_cert_store-property), and the PIN as the [known_cert_store_password](#known_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class 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) and set [known_cert_store_password](#known_cert_store_password-property) 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. # known_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_known_cert_subject(known_cert_index: int) -> str: ... def set_known_cert_subject(known_cert_index: int, value: str) -> None: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. # known_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_known_cert_subject_alt_names(known_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_known_cert_thumbprint_md5(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_known_cert_thumbprint_sha1(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_known_cert_thumbprint_sha256(known_cert_index: int) -> str: ... ``` ## 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_known_cert_usage(known_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The text description of [known_cert_usage_flags](#known_cert_usage_flags-property). 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 *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_known_cert_usage_flags(known_cert_index: int) -> int: ... ``` ## 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) 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) property for a text representation of [known_cert_usage_flags](#known_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_version property The certificate's version number. ## Syntax ```text def get_known_cert_version(known_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # offline_mode property Whether the class is operating in offline mode. ## Syntax ```text def get_offline_mode() -> bool: ... def set_offline_mode(value: bool) -> None: ... offline_mode = property(get_offline_mode, set_offline_mode) ``` ## Default Value FALSE ## Remarks This property indicates whether the class should operate in offline mode. In offline mode, the class 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. # output_data property A byte array containing the PDF document after processing. ## Syntax ```text def get_output_data() -> bytes: ... output_data = property(get_output_data, None) ``` ## 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) and set_output_stream respectively. This property is read-only. # output_file property The path to a local file where the output is written. ## Syntax ```text def get_output_file() -> str: ... def set_output_file(value: str) -> None: ... output_file = property(get_output_file, set_output_file) ``` ## Default Value "" ## Remarks This property is used to provide a path where the resulting PDF document is saved after the operation has completed. # overwrite property Whether the class should overwrite files. ## Syntax ```text def get_overwrite() -> bool: ... def set_overwrite(value: bool) -> None: ... overwrite = property(get_overwrite, set_overwrite) ``` ## Default Value FALSE ## Remarks This property indicates whether the class overwrites [output_file](#output_file-property). If set to *False*, an error is thrown whenever [output_file](#output_file-property) exists before an operation. # password property The password to decrypt the document with. ## Syntax ```text def get_password() -> str: ... def set_password(value: str) -> None: ... password = property(get_password, set_password) ``` ## 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. # pdf_signature_count property The number of records in the PDFSignature arrays. ## Syntax ```text def get_pdf_signature_count() -> int: ... pdf_signature_count = property(get_pdf_signature_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [pdf_signature_author_name](#pdf_signature_author_name-property) - [pdf_signature_chain_validation_details](#pdf_signature_chain_validation_details-property) - [pdf_signature_chain_validation_result](#pdf_signature_chain_validation_result-property) - [pdf_signature_claimed_signing_time](#pdf_signature_claimed_signing_time-property) - [pdf_signature_coverage_ends_at](#pdf_signature_coverage_ends_at-property) - [pdf_signature_hash_algorithm](#pdf_signature_hash_algorithm-property) - [pdf_signature_profile](#pdf_signature_profile-property) - [pdf_signature_reason](#pdf_signature_reason-property) - [pdf_signature_signer_cert_index](#pdf_signature_signer_cert_index-property) - [pdf_signature_timestamp_cert_index](#pdf_signature_timestamp_cert_index-property) - [pdf_signature_timestamped](#pdf_signature_timestamped-property) - [pdf_signature_type](#pdf_signature_type-property) - [pdf_signature_validated_signing_time](#pdf_signature_validated_signing_time-property) - [pdf_signature_validation_result](#pdf_signature_validation_result-property) - [pdf_signature_widget_height](#pdf_signature_widget_height-property) - [pdf_signature_widget_offset_x](#pdf_signature_widget_offset_x-property) - [pdf_signature_widget_offset_y](#pdf_signature_widget_offset_y-property) - [pdf_signature_widget_pages](#pdf_signature_widget_pages-property) - [pdf_signature_widget_width](#pdf_signature_widget_width-property) The array indices start at *0* and end at *pdf_signature_count - 1*. This property is read-only. # pdf_signature_author_name property The human-readable name of the signer. ## Syntax ```text def get_pdf_signature_author_name(pdf_signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks The human-readable name of the signer. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_chain_validation_details property The details of the certificate chain validation outcome. ## Syntax ```text def get_pdf_signature_chain_validation_details(pdf_signature_index: int) -> int: ... ``` ## 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). 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](#on_log-event) event to access the detailed validation log. This property is also available as a parameter of the [on_signature_processed](#on_signature_processed-event) event. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_chain_validation_result property The outcome of the certificate chain validation routine. ## Syntax ```text def get_pdf_signature_chain_validation_result(pdf_signature_index: int) -> int: ... ``` ## 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](#on_log-event) event to access the detailed validation log. This property is also available as a parameter of the [on_signature_processed](#on_signature_processed-event) event. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_claimed_signing_time property The signature's creation time in UTC. ## Syntax ```text def get_pdf_signature_claimed_signing_time(pdf_signature_index: int) -> str: ... ``` ## 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), does not originate from a trusted TSA and may be forged or wrong. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_coverage_ends_at property The byte offset in the PDF file where the signature coverage ends. ## Syntax ```text def get_pdf_signature_coverage_ends_at(pdf_signature_index: int) -> int: ... ``` ## 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](#PDFVerify_m_GetSignedVersion) to extract the exact revision that was signed. A value of *0* indicates that the class could not determine the coverage offset. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_hash_algorithm property The hash algorithm that was used for signing. ## Syntax ```text def get_pdf_signature_hash_algorithm(pdf_signature_index: int) -> str: ... ``` ## Default Value "SHA256" ## Remarks The hash algorithm that was used for signing. Possible values are: - SHA1 - SHA224 - SHA256 - SHA384 - SHA512 - MD5 The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_profile property The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI. ## Syntax ```text def get_pdf_signature_profile(pdf_signature_index: int) -> int: ... ``` ## 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](#PDFVerify_p_OfflineMode) (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 *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_reason property The reason for signing. ## Syntax ```text def get_pdf_signature_reason(pdf_signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks The reason for signing. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_signer_cert_index property The index of the signer certificate in the DocumentCerts collection. ## Syntax ```text def get_pdf_signature_signer_cert_index(pdf_signature_index: int) -> int: ... ``` ## Default Value -1 ## Remarks The index of the signer certificate in the [document_certs](#PDFSign_p_DocumentCerts) collection. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_timestamp_cert_index property The index of the timestamping certificate in the DocumentCerts collection (if applicable). ## Syntax ```text def get_pdf_signature_timestamp_cert_index(pdf_signature_index: int) -> int: ... ``` ## Default Value -1 ## Remarks The index of the timestamping certificate in the [document_certs](#PDFSign_p_DocumentCerts) collection (if applicable). The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_timestamped property Whether the signature contains an embedded timestamp. ## Syntax ```text def get_pdf_signature_timestamped(pdf_signature_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether the signature contains an embedded timestamp. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_type property The type of the signature that was created. ## Syntax ```text def get_pdf_signature_type(pdf_signature_index: int) -> int: ... ``` ## 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 *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_validated_signing_time property The certified signing time in UTC. ## Syntax ```text def get_pdf_signature_validated_signing_time(pdf_signature_index: int) -> str: ... ``` ## 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), is the trusted signing time. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_validation_result property The outcome of the cryptographic signature validation. ## Syntax ```text def get_pdf_signature_validation_result(pdf_signature_index: int) -> int: ... ``` ## 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](#on_signature_processed-event) event. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_widget_height property The height of the signature widget in points. ## Syntax ```text def get_pdf_signature_widget_height(pdf_signature_index: int) -> str: ... ``` ## Default Value "70" ## Remarks The height of the signature widget in points. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_widget_offset_x property The signature widget offset from the left-hand page border in points. ## Syntax ```text def get_pdf_signature_widget_offset_x(pdf_signature_index: int) -> str: ... ``` ## Default Value "0" ## Remarks The signature widget offset from the left-hand page border in points. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_widget_offset_y property The signature widget offset from the bottom page border in points. ## Syntax ```text def get_pdf_signature_widget_offset_y(pdf_signature_index: int) -> str: ... ``` ## Default Value "0" ## Remarks The signature widget offset from the bottom page border in points. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_widget_pages property The pages that the signature and its widget are placed on. ## Syntax ```text def get_pdf_signature_widget_pages(pdf_signature_index: int) -> str: ... ``` ## Default Value "" ## Remarks The pages that the signature and its widget are placed on. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # pdf_signature_widget_width property The width of the signature widget in points. ## Syntax ```text def get_pdf_signature_widget_width(pdf_signature_index: int) -> str: ... ``` ## Default Value "70" ## Remarks The width of the signature widget in points. The *pdf_signature_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pdf_signature_count](#pdf_signature_count-property) property. This property is read-only. # proxy_auth_scheme property The type of authorization to perform when connecting to the proxy. ## Syntax ```text def get_proxy_auth_scheme() -> int: ... def set_proxy_auth_scheme(value: int) -> None: ... proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme) ``` ## 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) and [proxy_password](#proxy_password-property) properties are set. [proxy_auth_scheme](#proxy_auth_scheme-property) should be set to authNone (3) when no authentication is expected. By default, [proxy_auth_scheme](#proxy_auth_scheme-property) is authBasic (0), and if the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are set, the class will attempt basic authentication. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authDigest (1), digest authentication will be attempted instead. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If [proxy_auth_scheme](#proxy_auth_scheme-property) 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) and [proxy_password](#proxy_password-property). # proxy_auto_detect property Whether to automatically detect and use proxy system settings, if available. ## Syntax ```text def get_proxy_auto_detect() -> bool: ... def set_proxy_auto_detect(value: bool) -> None: ... proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use proxy system settings, if available. The default value is *False*. # proxy_password property A password if authentication is to be used for the proxy. ## Syntax ```text def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ... proxy_password = property(get_proxy_password, set_proxy_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) 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) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation. # proxy_port property The Transmission Control Protocol (TCP) port for the proxy Server (default 80). ## Syntax ```text def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ... proxy_port = property(get_proxy_port, set_proxy_port) ``` ## Default Value 80 ## Remarks The Transmission Control Protocol (TCP) port for the proxy [proxy_server](#proxy_server-property) (default 80). See the description of the [proxy_server](#proxy_server-property) property for details. # proxy_server property If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. ## Syntax ```text def get_proxy_server() -> str: ... def set_proxy_server(value: str) -> None: ... proxy_server = property(get_proxy_server, set_proxy_server) ``` ## Default Value "" ## Remarks If a proxy [proxy_server](#proxy_server-property) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [proxy_server](#proxy_server-property) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [proxy_server](#proxy_server-property) property is set to the corresponding address. If the search is not successful, an error is returned. # proxy_ssl property When to use a Secure Sockets Layer (SSL) for the connection to the proxy. ## Syntax ```text def get_proxy_ssl() -> int: ... def set_proxy_ssl(value: int) -> None: ... proxy_ssl = property(get_proxy_ssl, set_proxy_ssl) ``` ## 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 class will use the psTunnel option. If the URL is an http URL, the class 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. | # proxy_user property A username if authentication is to be used for the proxy. ## Syntax ```text def get_proxy_user() -> str: ... def set_proxy_user(value: str) -> None: ... proxy_user = property(get_proxy_user, set_proxy_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) 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) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation. # remote_signature_data property The signature data obtained from a remote signer. ## Syntax ```text def get_remote_signature_data() -> str: ... def set_remote_signature_data(value: str) -> None: ... remote_signature_data = property(get_remote_signature_data, set_remote_signature_data) ``` ## Default Value "" ## Remarks This property is used to specify the hex-encoded signature data obtained from a remote signer. Use it to pass the [remote_signature_digest](#remote_signature_digest-property) back to the class (after it has been processed appropriately and signed) to complete the signature. # remote_signature_digest property The digest to be signed remotely. ## Syntax ```text def get_remote_signature_digest() -> str: ... remote_signature_digest = property(get_remote_signature_digest, None) ``` ## Default Value "" ## Remarks This property is used to read the hex-encoded digest that should be passed to a remote signer to be signed. Note that in the PKCS#1 method, this value is the raw data of the PKCS#7 signed-attributes field, whereas in the PKCS#7 method, it is the document hash. This property is read-only. # remote_signature_method property The remote signing method. ## Syntax ```text def get_remote_signature_method() -> int: ... def set_remote_signature_method(value: int) -> None: ... remote_signature_method = property(get_remote_signature_method, set_remote_signature_method) ``` ## Possible Values ```text 0 # None1 # PKCS12 # PKCS73 # Digest4 # Blob ``` ## Default Value 0 ## Remarks This property is used to specify whether and how the new signature is intended to be created remotely. If set to *rsmPKCS1*, *rsmPKCS7*, or *rsmBlob* before [sign](#sign-method) is called, the class does not perform the low-level signing operation itself but instead delegates it to an external or remote signer. Possible values are: | | | | --- | --- | | 0 (rsmNone - default) | Do not create the signature remotely. | | 1 (rsmPKCS1) | Create the signature remotely using the PKCS#1 signing method. The class builds the PKCS#7 structure itself and populates [remote_signature_digest](#remote_signature_digest-property) with the raw data of the signed-attributes field. Note that signing_cert must be set in order to use this option. | | 2 (rsmPKCS7) | Create the signature remotely using the PKCS#7 signing method. The class populates [remote_signature_digest](#remote_signature_digest-property) with the document hash, and the remote signer is expected to build the PKCS#7 structure. Use this option if the signing certificate is not available. | | 3 (rsmDigest) | Sign the digest generated earlier using the PKCS#7 method and produce the corresponding PKCS#7 structure. The input is expected to contain an unencoded binary message digest, and the output is a binary PKCS#7 object. Unlike the other options, this is a one-pass method. Note that no PDF data is involved in either input or output. | | 4 (rsmBlob) | Create the signature remotely given the digest generated earlier using the PKCS#7 method. The input is expected to contain an unencoded binary message digest, and the class builds the PKCS#7 structure and outputs the raw data of the signed-attributes field. This data is expected to be signed with the respective private key and passed back to the class to complete the PKCS#7 structure. Note that signing_cert must be set in order to use this option, and no PDF data is involved in either input or output. | # revocation_check property The kind(s) of revocation check to perform for all chain certificates. ## Syntax ```text def get_revocation_check() -> int: ... def set_revocation_check(value: int) -> None: ... revocation_check = property(get_revocation_check, set_revocation_check) ``` ## Possible Values ```text 0 # AllCRL1 # AllOCSP2 # AllCRLAndOCSP3 # AnyCRL4 # AnyOCSP5 # AnyCRLOrOCSP6 # AnyOCSPOrCRL ``` ## Default Value 6 ## Remarks This property is used to specify the revocation sources and preferences the class 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. # signature_author_name property The human-readable name of the signer. ## Syntax ```text def get_signature_author_name() -> str: ... def set_signature_author_name(value: str) -> None: ... signature_author_name = property(get_signature_author_name, set_signature_author_name) ``` ## Default Value "" ## Remarks This property is used to specify the human-readable name of the signer. NOTE: This property only applies when creating a new signature. # signature_claimed_signing_time property The signature's creation time. ## Syntax ```text def get_signature_claimed_signing_time() -> str: ... def set_signature_claimed_signing_time(value: str) -> None: ... signature_claimed_signing_time = property(get_signature_claimed_signing_time, set_signature_claimed_signing_time) ``` ## Default Value "" ## Remarks This property is used to specify the signature creation time from the signer's computer. The time should be provided in UTC in *yyyyMMddHHmmssZ* format. If this property is empty when a new signature is created, the class uses the current UTC time. NOTE: This property only applies when creating a new signature. # signature_field property The index of the empty signature field to sign. ## Syntax ```text def get_signature_field() -> int: ... def set_signature_field(value: int) -> None: ... signature_field = property(get_signature_field, set_signature_field) ``` ## Default Value -1 ## Remarks This property is used to specify the empty signature field that should be signed. If the default value of *-1* is assigned to this property, a new signature field is created. **Example:** ```csharp pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "emptyfield.pdf"; pdfsign.SignatureType = PDFSignSignatureTypes.stEmptyField; pdfsign.Sign(); // Later pdfsign.Reset(); pdfsign.InputFile = "emptyfield.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureField = 0; // Configure signature properties as desired pdfsign.Sign(); ``` # signature_hash_algorithm property The hash algorithm to be used for signing. ## Syntax ```text def get_signature_hash_algorithm() -> str: ... def set_signature_hash_algorithm(value: str) -> None: ... signature_hash_algorithm = property(get_signature_hash_algorithm, set_signature_hash_algorithm) ``` ## Default Value "SHA256" ## Remarks This property is used to specify the hash algorithm to be used for signing. Possible values are: - SHA1 - SHA224 - SHA256 - SHA384 - SHA512 - MD5 NOTE: This property only applies when creating a new signature. # signature_profile property The PAdES profile to apply when creating the signature. ## Syntax ```text def get_signature_profile() -> int: ... def set_signature_profile(value: int) -> None: ... signature_profile = property(get_signature_profile, set_signature_profile) ``` ## Possible Values ```text 0 # None1 # BaselineB2 # BaselineT3 # BaselineLT4 # BaselineLTA ``` ## Default Value 0 ## Remarks This property is used to specify a pre-defined PAdES profile to apply 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. Specifying a profile pre-configures the class to make it produce the signature that matches the configuration corresponding to that profile. 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 | To apply a custom profile that is not defined by ETSI, set [CustomProfile](#CustomProfile). NOTE: This property only applies when creating a new signature. # signature_reason property The reason for signing. ## Syntax ```text def get_signature_reason() -> str: ... def set_signature_reason(value: str) -> None: ... signature_reason = property(get_signature_reason, set_signature_reason) ``` ## Default Value "" ## Remarks This property is used to specify the reason for signing. NOTE: This property only applies when creating a new signature. # signature_type property The type of signature to create. ## Syntax ```text def get_signature_type() -> int: ... def set_signature_type(value: int) -> None: ... signature_type = property(get_signature_type, set_signature_type) ``` ## Possible Values ```text 0 # Legacy1 # Advanced2 # DTS3 # EmptyField ``` ## Default Value 0 ## Remarks This property is used to specify the type of the signature. For PAdES signatures, use [signature_profile](#signature_profile-property) to specify the PAdES profile. 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) | NOTE: This property only applies when creating a new signature. # signature_widget_height property The height of the signature widget. ## Syntax ```text def get_signature_widget_height() -> str: ... def set_signature_widget_height(value: str) -> None: ... signature_widget_height = property(get_signature_widget_height, set_signature_widget_height) ``` ## Default Value "70" ## Remarks This property is used to specify the height of the signature widget in points. Both integer and decimal values are supported. NOTE: This property only applies when creating a new signature. # signature_widget_offset_x property The signature widget offset from the left-hand page border. ## Syntax ```text def get_signature_widget_offset_x() -> str: ... def set_signature_widget_offset_x(value: str) -> None: ... signature_widget_offset_x = property(get_signature_widget_offset_x, set_signature_widget_offset_x) ``` ## Default Value "0" ## Remarks This property is used to specify the signature widget offset from the left-hand page border in points. Both integer and decimal values are supported. NOTE: This property only applies when creating a new signature. # signature_widget_offset_y property The signature widget offset from the bottom page border. ## Syntax ```text def get_signature_widget_offset_y() -> str: ... def set_signature_widget_offset_y(value: str) -> None: ... signature_widget_offset_y = property(get_signature_widget_offset_y, set_signature_widget_offset_y) ``` ## Default Value "0" ## Remarks This property is used to specify the signature widget offset from the bottom page border in points. Both integer and decimal values are supported. NOTE: This property only applies when creating a new signature. # signature_widget_pages property The pages to place the signature and its widget on. ## Syntax ```text def get_signature_widget_pages() -> str: ... def set_signature_widget_pages(value: str) -> None: ... signature_widget_pages = property(get_signature_widget_pages, set_signature_widget_pages) ``` ## Default Value "" ## Remarks This property is used to specify the pages on which the signature and its widget are placed. A variety of syntaxes are supported: - A single page index (zero-based): *3* - A comma-separated list of page indices (zero-based): *1,2,5,7* - The asterisk character (***) indicates that the widget should be placed on all pages in the document. - The *first* and *last* placeholders specify that the signature should be placed on the respective page, independently of its number. NOTE: If no valid pages are specified, the class places the widget on the first page by default. NOTE: This property only applies when creating a new signature. # signature_widget_width property The width of the signature widget. ## Syntax ```text def get_signature_widget_width() -> str: ... def set_signature_widget_width(value: str) -> None: ... signature_widget_width = property(get_signature_widget_width, set_signature_widget_width) ``` ## Default Value "70" ## Remarks This property is used to specify the width of the signature widget in points. Both integer and decimal values are supported. NOTE: This property only applies when creating a new signature. # signing_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_signing_cert_effective_date() -> str: ... signing_cert_effective_date = property(get_signing_cert_effective_date, None) ``` ## 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. # signing_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_signing_cert_encoded() -> bytes: ... def set_signing_cert_encoded(value: bytes) -> None: ... signing_cert_encoded = property(get_signing_cert_encoded, set_signing_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [signing_cert_store](#signing_cert_store-property) and [signing_cert_subject](#signing_cert_subject-property) properties also may be used to specify a certificate. When [signing_cert_encoded](#signing_cert_encoded-property) is set, a search is initiated in the current [signing_cert_store](#signing_cert_store-property) for the private key of the certificate. If the key is found, [signing_cert_subject](#signing_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [signing_cert_subject](#signing_cert_subject-property) is set to an empty string. # signing_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_signing_cert_expiration_date() -> str: ... signing_cert_expiration_date = property(get_signing_cert_expiration_date, None) ``` ## 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. # signing_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_signing_cert_extended_key_usage() -> str: ... signing_cert_extended_key_usage = property(get_signing_cert_extended_key_usage, None) ``` ## 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. # signing_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_signing_cert_fingerprint() -> str: ... signing_cert_fingerprint = property(get_signing_cert_fingerprint, None) ``` ## 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. # signing_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_signing_cert_fingerprint_sha1() -> str: ... signing_cert_fingerprint_sha1 = property(get_signing_cert_fingerprint_sha1, None) ``` ## 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. # signing_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_signing_cert_fingerprint_sha256() -> str: ... signing_cert_fingerprint_sha256 = property(get_signing_cert_fingerprint_sha256, None) ``` ## 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. # signing_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_signing_cert_issuer() -> str: ... signing_cert_issuer = property(get_signing_cert_issuer, None) ``` ## 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. # signing_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_signing_cert_private_key() -> str: ... signing_cert_private_key = property(get_signing_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [signing_cert_private_key](#signing_cert_private_key-property) may be available but not exportable. In this case, [signing_cert_private_key](#signing_cert_private_key-property) returns an empty string. This property is read-only. # signing_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_signing_cert_private_key_available() -> bool: ... signing_cert_private_key_available = property(get_signing_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [signing_cert_private_key](#signing_cert_private_key-property) is available for the selected certificate. If [signing_cert_private_key_available](#signing_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # signing_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_signing_cert_private_key_container() -> str: ... signing_cert_private_key_container = property(get_signing_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [signing_cert_private_key](#signing_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # signing_cert_public_key property The public key of the certificate. ## Syntax ```text def get_signing_cert_public_key() -> str: ... signing_cert_public_key = property(get_signing_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # signing_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_signing_cert_public_key_algorithm() -> str: ... signing_cert_public_key_algorithm = property(get_signing_cert_public_key_algorithm, None) ``` ## 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. # signing_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_signing_cert_public_key_length() -> int: ... signing_cert_public_key_length = property(get_signing_cert_public_key_length, None) ``` ## 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. # signing_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_signing_cert_serial_number() -> str: ... signing_cert_serial_number = property(get_signing_cert_serial_number, None) ``` ## 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. # signing_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_signing_cert_signature_algorithm() -> str: ... signing_cert_signature_algorithm = property(get_signing_cert_signature_algorithm, None) ``` ## 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. # signing_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_signing_cert_store() -> bytes: ... def set_signing_cert_store(value: bytes) -> None: ... signing_cert_store = property(get_signing_cert_store, set_signing_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [signing_cert_store_type](#signing_cert_store_type-property) property denotes the type of the certificate store specified by [signing_cert_store](#signing_cert_store-property). If the store is password-protected, specify the password in [signing_cert_store_password](#signing_cert_store_password-property). [signing_cert_store](#signing_cert_store-property) is used in conjunction with the [signing_cert_subject](#signing_cert_subject-property) property to specify client certificates. If [signing_cert_store](#signing_cert_store-property) has a value, and [signing_cert_subject](#signing_cert_subject-property) or [signing_cert_encoded](#signing_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [signing_cert_subject](#signing_cert_subject-property) 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). # signing_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_signing_cert_store_password() -> str: ... def set_signing_cert_store_password(value: str) -> None: ... signing_cert_store_password = property(get_signing_cert_store_password, set_signing_cert_store_password) ``` ## 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. # signing_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_signing_cert_store_type() -> int: ... def set_signing_cert_store_type(value: int) -> None: ... signing_cert_store_type = property(get_signing_cert_store_type, set_signing_cert_store_type) ``` ## 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 class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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 [signing_cert_store_type](#signing_cert_store_type-property), the full path of the PKCS#11 DLL as the [signing_cert_store](#signing_cert_store-property), and the PIN as the [signing_cert_store_password](#signing_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class 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 [signing_cert_store](#signing_cert_store-property) and set [signing_cert_store_password](#signing_cert_store_password-property) 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. | # signing_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_signing_cert_subject() -> str: ... def set_signing_cert_subject(value: str) -> None: ... signing_cert_subject = property(get_signing_cert_subject, set_signing_cert_subject) ``` ## 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. # signing_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_signing_cert_subject_alt_names() -> str: ... signing_cert_subject_alt_names = property(get_signing_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # signing_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_signing_cert_thumbprint_md5() -> str: ... signing_cert_thumbprint_md5 = property(get_signing_cert_thumbprint_md5, None) ``` ## 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. # signing_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_signing_cert_thumbprint_sha1() -> str: ... signing_cert_thumbprint_sha1 = property(get_signing_cert_thumbprint_sha1, None) ``` ## 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. # signing_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_signing_cert_thumbprint_sha256() -> str: ... signing_cert_thumbprint_sha256 = property(get_signing_cert_thumbprint_sha256, None) ``` ## 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. # signing_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_signing_cert_usage() -> str: ... signing_cert_usage = property(get_signing_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [signing_cert_usage_flags](#signing_cert_usage_flags-property). 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. # signing_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_signing_cert_usage_flags() -> int: ... signing_cert_usage_flags = property(get_signing_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [signing_cert_usage_flags](#signing_cert_usage_flags-property) 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 [signing_cert_usage](#signing_cert_usage-property) property for a text representation of [signing_cert_usage_flags](#signing_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # signing_cert_version property The certificate's version number. ## Syntax ```text def get_signing_cert_version() -> str: ... signing_cert_version = property(get_signing_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # timestamp_server property The address of the timestamping server. ## Syntax ```text def get_timestamp_server() -> str: ... def set_timestamp_server(value: str) -> None: ... timestamp_server = property(get_timestamp_server, set_timestamp_server) ``` ## Default Value "" ## Remarks This property is used to specify the address of the TSA (Timestamping Authority) server to use for timestamping the signature (normal signing) or the document (LTV update). If the timestamping service enforces credential-based user authentication (basic or digest), the credentials can be provided in the same URL. For example: ```csharp pdfsign.TimestampServer = "http://user:password@timestamp.server.com/TsaService"; ``` If the TSA requires TLS client authentication, provide the client certificate via [TSATLSClientCertStoreType](#TSATLSClientCertStoreType), [TSATLSClientCertStore](#TSATLSClientCertStore), [TSATLSClientCertStorePassword](#TSATLSClientCertStorePassword), and [TSATLSClientCertSubject](#TSATLSClientCertSubject). # trusted_cert_count property The number of records in the TrustedCert arrays. ## Syntax ```text def get_trusted_cert_count() -> int: ... def set_trusted_cert_count(value: int) -> None: ... trusted_cert_count = property(get_trusted_cert_count, set_trusted_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [trusted_cert_effective_date](#trusted_cert_effective_date-property) - [trusted_cert_encoded](#trusted_cert_encoded-property) - [trusted_cert_expiration_date](#trusted_cert_expiration_date-property) - [trusted_cert_extended_key_usage](#trusted_cert_extended_key_usage-property) - [trusted_cert_fingerprint](#trusted_cert_fingerprint-property) - [trusted_cert_fingerprint_sha1](#trusted_cert_fingerprint_sha1-property) - [trusted_cert_fingerprint_sha256](#trusted_cert_fingerprint_sha256-property) - [trusted_cert_issuer](#trusted_cert_issuer-property) - [trusted_cert_private_key](#trusted_cert_private_key-property) - [trusted_cert_private_key_available](#trusted_cert_private_key_available-property) - [trusted_cert_private_key_container](#trusted_cert_private_key_container-property) - [trusted_cert_public_key](#trusted_cert_public_key-property) - [trusted_cert_public_key_algorithm](#trusted_cert_public_key_algorithm-property) - [trusted_cert_public_key_length](#trusted_cert_public_key_length-property) - [trusted_cert_serial_number](#trusted_cert_serial_number-property) - [trusted_cert_signature_algorithm](#trusted_cert_signature_algorithm-property) - [trusted_cert_store](#trusted_cert_store-property) - [trusted_cert_store_password](#trusted_cert_store_password-property) - [trusted_cert_store_type](#trusted_cert_store_type-property) - [trusted_cert_subject](#trusted_cert_subject-property) - [trusted_cert_subject_alt_names](#trusted_cert_subject_alt_names-property) - [trusted_cert_thumbprint_md5](#trusted_cert_thumbprint_md5-property) - [trusted_cert_thumbprint_sha1](#trusted_cert_thumbprint_sha1-property) - [trusted_cert_thumbprint_sha256](#trusted_cert_thumbprint_sha256-property) - [trusted_cert_usage](#trusted_cert_usage-property) - [trusted_cert_usage_flags](#trusted_cert_usage_flags-property) - [trusted_cert_version](#trusted_cert_version-property) The array indices start at *0* and end at *trusted_cert_count - 1*. # trusted_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_trusted_cert_effective_date(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_trusted_cert_encoded(trusted_cert_index: int) -> bytes: ... def set_trusted_cert_encoded(trusted_cert_index: int, value: bytes) -> None: ... ``` ## 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) and [trusted_cert_subject](#trusted_cert_subject-property) properties also may be used to specify a certificate. When [trusted_cert_encoded](#trusted_cert_encoded-property) is set, a search is initiated in the current [trusted_cert_store](#trusted_cert_store-property) for the private key of the certificate. If the key is found, [trusted_cert_subject](#trusted_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [trusted_cert_subject](#trusted_cert_subject-property) is set to an empty string. The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. # trusted_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_trusted_cert_expiration_date(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_trusted_cert_extended_key_usage(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_trusted_cert_fingerprint(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_trusted_cert_fingerprint_sha1(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_trusted_cert_fingerprint_sha256(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_trusted_cert_issuer(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_trusted_cert_private_key(trusted_cert_index: int) -> str: ... ``` ## 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) may be available but not exportable. In this case, [trusted_cert_private_key](#trusted_cert_private_key-property) returns an empty string. The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_trusted_cert_private_key_available(trusted_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether a [trusted_cert_private_key](#trusted_cert_private_key-property) is available for the selected certificate. If [trusted_cert_private_key_available](#trusted_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_trusted_cert_private_key_container(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the [trusted_cert_private_key](#trusted_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_public_key property The public key of the certificate. ## Syntax ```text def get_trusted_cert_public_key(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_trusted_cert_public_key_algorithm(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_trusted_cert_public_key_length(trusted_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_trusted_cert_serial_number(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_trusted_cert_signature_algorithm(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_trusted_cert_store(trusted_cert_index: int) -> bytes: ... def set_trusted_cert_store(trusted_cert_index: int, value: bytes) -> None: ... ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [trusted_cert_store_type](#trusted_cert_store_type-property) property denotes the type of the certificate store specified by [trusted_cert_store](#trusted_cert_store-property). If the store is password-protected, specify the password in [trusted_cert_store_password](#trusted_cert_store_password-property). [trusted_cert_store](#trusted_cert_store-property) is used in conjunction with the [trusted_cert_subject](#trusted_cert_subject-property) property to specify client certificates. If [trusted_cert_store](#trusted_cert_store-property) has a value, and [trusted_cert_subject](#trusted_cert_subject-property) or [trusted_cert_encoded](#trusted_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [trusted_cert_subject](#trusted_cert_subject-property) 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. # trusted_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_trusted_cert_store_password(trusted_cert_index: int) -> str: ... def set_trusted_cert_store_password(trusted_cert_index: int, value: str) -> None: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. # trusted_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_trusted_cert_store_type(trusted_cert_index: int) -> int: ... def set_trusted_cert_store_type(trusted_cert_index: int, value: int) -> None: ... ``` ## 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 class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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), the full path of the PKCS#11 DLL as the [trusted_cert_store](#trusted_cert_store-property), and the PIN as the [trusted_cert_store_password](#trusted_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class 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) and set [trusted_cert_store_password](#trusted_cert_store_password-property) 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. # trusted_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_trusted_cert_subject(trusted_cert_index: int) -> str: ... def set_trusted_cert_subject(trusted_cert_index: int, value: str) -> None: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. # trusted_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_trusted_cert_subject_alt_names(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_trusted_cert_thumbprint_md5(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_trusted_cert_thumbprint_sha1(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_trusted_cert_thumbprint_sha256(trusted_cert_index: int) -> str: ... ``` ## 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_trusted_cert_usage(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The text description of [trusted_cert_usage_flags](#trusted_cert_usage_flags-property). 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 *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_trusted_cert_usage_flags(trusted_cert_index: int) -> int: ... ``` ## 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) 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) property for a text representation of [trusted_cert_usage_flags](#trusted_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_version property The certificate's version number. ## Syntax ```text def get_trusted_cert_version(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_lists property A list of known Trusted Lists for chain validation. ## Syntax ```text def get_trusted_lists() -> str: ... def set_trusted_lists(value: str) -> None: ... trusted_lists = property(get_trusted_lists, set_trusted_lists) ``` ## Default Value "%EUTL%" ## Remarks This property is used to supply a semicolon-separated list of URLs or paths of known Trusted Lists to the class 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 class 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 class 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 class caches all Trusted Lists it downloads and uses during chain validation. This cache is shared between class instances within the same process. If this property contains a URL that is also present in the cache, the class retrieves the cached data and reuses it in the current validation. If the data is invalid, the class downloads a fresh Trusted List and adds it to the cache. # trust_sources property The trust sources to use during chain validation. ## Syntax ```text def get_trust_sources() -> int: ... def set_trust_sources(value: int) -> None: ... trust_sources = property(get_trust_sources, set_trust_sources) ``` ## Possible Values ```text 0 # Manual1 # Local2 # TrustedLists3 # LocalAndTrustedLists ``` ## Default Value 3 ## Remarks This property is used to specify the sources the class 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 class consults trusted_certs only. | | 1 (tsLocal) | The class consults local system stores (e.g., Windows Trusted Root Certification Authorities) as well as trusted_certs. | | 2 (tsTrustedLists) | The class consults [trusted_lists](#trusted_lists-property) only. | | 3 (tsLocalAndTrustedLists - default) | The class consults local system stores, trusted_certs, and [trusted_lists](#trusted_lists-property). | # validation_flags property Additional chain validation settings. ## Syntax ```text def get_validation_flags() -> int: ... def set_validation_flags(value: int) -> None: ... validation_flags = property(get_validation_flags, set_validation_flags) ``` ## 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. | # validation_policy property The level at which to perform chain validation. ## Syntax ```text def get_validation_policy() -> int: ... def set_validation_policy(value: int) -> None: ... validation_policy = property(get_validation_policy, set_validation_policy) ``` ## Possible Values ```text 0 # None1 # Full2 # FullNoTrust3 # FullNoRevocation4 # BestEffort ``` ## Default Value 1 ## Remarks This property is used to specify the overall validation policy the class 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 class. - 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. # validation_time property The time point at which the signature should be validated. ## Syntax ```text def get_validation_time() -> str: ... def set_validation_time(value: str) -> None: ... validation_time = property(get_validation_time, set_validation_time) ``` ## 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 class 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. # add_attachment method Adds an attachment to the document. ## Syntax ```text def add_attachment(file_name: str, description: str) -> None: ... ``` ## Remarks This method is used to add an attachment (embedded file) to the document and to the attachments properties. *file_name* and *description* specify the filename and description of the attachment respectively. **Example:** ```csharp component.InputFile = "input.pdf"; component.OutputFile = "input_with_attachment.pdf"; component.Open(); component.AddAttachment("foo.txt", "desc"); // Alternatively, create a PDFAttachment object and add it to Attachments manually: PDFAttachment attachment = new PDFAttachment(); attachment.FileName = "foo.txt"; // or attachment.DataB = new byte[] { ... }; // or attachment.InputStream = new FileStream(...); attachment.Description = "desc"; component.Attachments.Add(attachment); // Or using one of the constructors: component.Attachments.Add(new PDFAttachment("foo.txt", "desc")); component.Close(); ``` The full list of attachments is contained in the attachments properties. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # add_timestamp method Adds a document timestamp to the document. ## Syntax ```text def add_timestamp() -> None: ... ``` ## Remarks This method is used to obtain a document timestamp and embed it into the document. A document timestamp is a fully independent signature that is added to the PDF document after the initial signature. Unlike the main signature, the document timestamp is made by a TSA, and its purpose is to preserve the document's long-term validity. Typically, adding a document timestamp is done close to the expiration date of the certificate that produced the last timestamp (which is either embedded in the main signature, or is a previous document timestamp). An LTV document therefore contains a chain of document timestamps updated periodically to keep its long-term status. **Example:** ```csharp pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "signed_with_dts.pdf"; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.AddTimestamp(); ``` NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # close method Closes the opened document. ## Syntax ```text def close() -> None: ... ``` ## Remarks This method is used to close the previously opened document. It should always be preceded by a call to [open](#open-method). **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), [output_data](#output_data-property), or the stream set in set_output_stream when this method is called. To configure this saving behavior, set [SaveChanges](#SaveChanges). # config method Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#pdfsign-config-settings) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#pdfsign-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # encrypted method Checks whether the document is encrypted. ## Syntax ```text def encrypted() -> bool: ... ``` ## 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 Returns the value of a page property. ## Syntax ```text def get_page_property(page_index: int, page_property: str) -> str: ... ``` ## 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) event. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # get_widget_property method Returns the value of a signature widget property. ## Syntax ```text def get_widget_property(signature_index: int, widget_property: str) -> str: ... ``` ## Remarks This method is used to obtain the value of a signature widget property. Together with [set_widget_property](#set_widget_property-method), this method provides an extensible way of managing the widget settings that are not available through the primary properties of the class. The list of settings below may be extended in the future. *signature_index* is the index of the signature of interest in the signatures collection, and *widget_property* specifies the widget property to read. Possible values are: | Widget property | Default value | Description | | --- | --- | --- | | BackgroundHeight | 0 | The size of the stretched background image in the vertical direction. | | BackgroundWidth | 0 | The size of the stretched background image in the horizontal direction. | | CompressWidgetData | False | Whether to compress the signature widget data before saving. | | CustomBackgroundContentStream | "" | A custom background content stream to use when BackgroundStyle is set to Custom. | | CustomTextCount | 0 | The number of custom text blocks on the signature widget. | | CustomTextFontResourceName[Index] | "" | The font resource name used for the custom text block. | | CustomTextFontSizeX[Index] | 0 | The horizontal font size scale used for the custom text. | | CustomTextFontSizeY[Index] | 0 | The vertical font size scale used for the custom text. | | CustomTextX[Index] | 0 | The horizontal offset of the custom text block on the widget. | | CustomTextY[Index] | 0 | The vertical offset of the custom text block on the widget. | | CustomText[Index] | "" | The text shown on a custom signature widget text block. This indexed property provides access to the text placed on a specific signature widget text block. CustomText[0] specifies the text on the first block, CustomText[1] on the second block, and so on. Use CustomTextCount to get the number of custom text blocks. | | Height | 70 | The height of the signature widget in points. This property is the same as [](#f_WidgetHeight). | | Invisible | False | Whether the signature widget is invisible on the page. | | OffsetX | 0 | The signature widget offset from the left-hand page border in points. This property is the same as [](#f_WidgetOffsetX). | | OffsetY | 0 | The signature widget offset from the bottom page border in points. This property is the same as [](#f_WidgetOffsetY). | | Pages | "" | The pages on which the signature is shown. This property is the same as [](#f_WidgetPages). | | Rotation | 0 | The rotation angle of the signature widget in degrees clockwise. Supported values: 0, 90, 180, 270. | | Width | 70 | The width of the signature widget in points. This property is the same as [](#f_WidgetWidth). | **Example:** ```csharp pdfsign.InputFile = "signed.pdf"; pdfsign.Open(); bool invisible = bool.Parse(pdfsign.GetWidgetProperty(0, "Invisible")); pdfsign.Close(); ``` NOTE: Each widget property is only populated after the document has been signed and the signature widget has been generated. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # interrupt method Interrupts the current action. ## Syntax ```text def interrupt() -> None: ... ``` ## Remarks This method interrupts the current action. It can be used, for example, within the [on_chain_cert](#on_chain_cert-event) event to abort the chain validation procedure. If there is no action in progress, this method simply returns, doing nothing. # open method Opens the document for processing. ## Syntax ```text def open() -> None: ... ``` ## Remarks This method is used to open the document specified in [input_file](#input_file-property), [input_data](#input_data-property), or set_input_stream before performing some operation on it, such as signing or updating. When finished, call [close](#close-method) to complete or discard the operation. It is recommended to use this method (alongside [close](#close-method)) 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) or [on_recipient_info](#on_recipient_info-event) 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 class 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. # remove_attachment method Removes an attachment from the document. ## Syntax ```text def remove_attachment(index: int) -> None: ... ``` ## Remarks This method is used to remove an attachment from the document and from the attachments collection. *index* is the index of the attachment in the attachments collection to be removed. **Example:** ```csharp pdfsign.InputFile = "input_with_attachment.pdf"; pdfsign.OutputFile = "attachment_removed.pdf"; pdfsign.Open(); pdfsign.RemoveAttachment(0); // Alternatively, remove an attachment from Attachments manually: PDFAttachment attachment = pdfsign.Attachments[0]; pdfsign.Attachments.Remove(attachment); pdfsign.Close(); ``` NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # reset method Resets the class. ## Syntax ```text def reset() -> None: ... ``` ## Remarks This method is used to reset the class's properties and configuration settings to their default values. # save_attachment method Saves a PDF attachment to a file. ## Syntax ```text def save_attachment(index: int, file_name: str) -> None: ... ``` ## 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. # set_widget_property method Sets the value of a signature widget property. ## Syntax ```text def set_widget_property(widget_property: str, value: str) -> None: ... ``` ## Remarks This method is used to adjust the look of the signature widget when creating a signature. Together with [get_widget_property](#get_widget_property-method), this method provides an extensible way of managing the widget settings that are not available through the primary properties of the class. The list of settings below may be extended in the future. *widget_property* and *value* specify the widget property and value to set respectively. Possible values for the former are: | Widget property | Default value | Description | | --- | --- | --- | | AlgorithmCaption | #auto | The caption of the signature widget field with information about the signature algorithm. | | AlgorithmInfo | #auto | Information about the algorithm to be displayed on the signature widget. Keep this property set to #auto to make the class generate the algorithm text automatically, in the form of Algorithm/Key size, for example RSA/1024 bits. | | AutoReshapeArabicSymbols | True | Whether to automatically reshape Arabic symbols in the signature widget. If disabled, Arabic symbols are written in isolated form. | | AutoReverseRTLText | True | Whether to automatically detect and reverse right-to-left text to ensure proper visual presentation in the signature widget. | | BackgroundData | "" | The data of the signature widget background bitmap. Assign the widget background data (in the form of a filename or hex-encoded JPEG or JPEG 2000 bytes) to this property. | | BackgroundHeight | 0 | The size of the stretched background image in the vertical direction. | | BackgroundImageColorSpace | "" | The background image color space. Supported values: none, RGB, CMYK, Gray. | | BackgroundImageHeight | 0 | The height of the background image in pixels. It is important that this property matches the exact size of the image when a custom background is used. The width and height of the background image have no direct relation to the dimensions of the signature widget on the document page, and are only used to indicate the parameters of the image to the PDF processor. Big images are ultimately squeezed to fit into the widget, and smaller ones stretched. | | BackgroundImageType | JPEG2000 | The type of the image contained in BackgroundData. Supported values: JPEG2000, JPEG, Custom. | | BackgroundImageWidth | 0 | The width of the background image in pixels. It is important that this property matches the exact size of the image when a custom background is used. The width and height of the background image have no direct relation to the dimensions of the signature widget on the document page, and are only used to indicate the parameters of the image to the PDF processor. Big images are ultimately squeezed to fit into the widget, and smaller ones stretched. | | BackgroundMask | "" | The hex-encoded bytes of the background image mask. Masks provide a means for marking transparent areas on the signature widget. Specifically, a transparency mask tells PDF viewing applications which pixels of the signature widget should be kept visible and which should be rendered transparent instead. A mask is effectively a matrix of bits, with each bit corresponding to a pixel on the background bitmap. A bit is set to 1 if the corresponding pixel needs to be made transparent, or to 0 if it needs to be opaque. In most cases, a unique mask tailored to the signature widget image is required. This mask should be created based on the actual image design and desired appearance. | | BackgroundPosition | "" | The position of the widget background image. The value may be the keyword value center, which centers the image, or a pair of coordinates (e.g., 10 5.5) in which the first value defines X and the second defines Y starting from the bottom-left corner. | | BackgroundStyle | Default | The style of the signature widget background. Supported values: Default, None, Custom. | | BackgroundWidth | 0 | The size of the stretched background image in the horizontal direction. | | CompressWidgetData | False | Whether to compress the signature widget data before saving. | | CustomBackgroundContentStream | "" | A custom background content stream to use when BackgroundStyle is set to Custom. | | CustomTextCount | 0 | The number of custom text blocks on the signature widget. | | CustomTextFontResourceName[Index] | "" | The font resource name to use for the custom text block. | | CustomTextFontSizeX[Index] | 0 | The horizontal font size scale to use for the custom text. | | CustomTextFontSizeY[Index] | 0 | The vertical font size scale to use for the custom text. | | CustomTextX[Index] | 0 | The horizontal offset of the custom text block on the widget. | | CustomTextY[Index] | 0 | The vertical offset of the custom text block on the widget. | | CustomText[Index] | "" | The text to show on a custom signature widget text block. This indexed property provides access to the text to be placed on a specific signature widget text block. CustomText[0] specifies the text on the first block, CustomText[1] on the second block, and so on. Use CustomTextCount to set the number of custom text blocks. | | DateFontSize | 0 | The font size of the date and time text on the signature widget. | | DateFormat | "" | The format string used to display the signing date and time in the signature widget. Leave this property empty (default value) to use the default format. To convert UTC time to local time, set this property to L (default format) or use the L: prefix with a custom date time format string. | | FontName | "" | The font name for the signature widget text. Use this property to specify a Type 1 or TrueType font name for the signature widget text. If this property is empty, the widget uses the standard PDF Helvetica font. The PDF format supports 14 standard Type 1 fonts: Times-Roman, Helvetica, Courier, Symbol, Times-Bold, Helvetica-Bold, Courier-Bold, ZapfDingbats, Times-Italic, Helvetica-Oblique, Courier-Oblique, Times-BoldItalic, Helvetica-BoldOblique, Courier-BoldOblique. Standard Type 1 fonts are used as standard PDF fonts and are not embedded by the class. Note that Adobe no longer supports Type 1 fonts as of January 2023. If the target document profile, such as PDF/A, requires fonts used in visible text to be embedded, specify a TrueType font. For TrueType fonts, the class supports full font names (e.g., Times New Roman, Arial Bold Italic), filenames (e.g., times.ttf, arialbi.ttf), or full file paths. If a TrueType font is used, then a font subset is embedded into the PDF document. The list of system TrueType font names that are supported by the class can be obtained from the [SystemFontNames](#SystemFontNames) configuration setting. Use the [FontPaths](#FontPaths) configuration setting to specify font search paths when a TrueType font is specified without a full file path. Alternatively, set this property to the full path to the TrueType font file. | | Header | #auto | The header text to put on the signature widget. Keep this property set to #auto to make the class generate the header automatically. | | Height | 70 | The height of the signature widget in points. This property is the same as [signature_widget_height](#signature_widget_height-property). | | HideDefaultText | False | Whether to generate default headers for the signature widget. | | IgnoreExistingAppearance | False | Whether to discard all existing widget parameters when signing empty signature fields. This property only makes sense for signatures created by signing existing empty signature fields with pre-defined widget descriptions. | | InvertMask | False | Whether to invert the mask set in BackgroundMask by making opaque all the bits declared as transparent, and making transparent all the bits declared as opaque. | | Invisible | False | Whether the signature widget is invisible on the page. | | OffsetX | 0 | The signature widget offset from the left-hand page border in points. This property is the same as [signature_widget_offset_x](#signature_widget_offset_x-property). | | OffsetY | 0 | The signature widget offset from the bottom page border in points. This property is the same as [signature_widget_offset_y](#signature_widget_offset_y-property). | | Pages | "" | The pages on which the signature is shown. This property is the same as [signature_widget_pages](#signature_widget_pages-property). | | PositionAnchor | Default | The anchor to bind the position of the widget to. Supported values: Default, BottomLeft, BottomRight, TopLeft, TopRight, Center. | | RenderOptions | Print | A comma-separated list of rendering options. Supported values: Unknown, NoRotate, NoView, NoZoom, Print, ReadOnly, ToggleNoView. | | Rotation | 0 | The rotation angle of the signature widget in degrees clockwise. Supported values: 0, 90, 180, 270. | | SectionTextFontSize | 0 | The font size of general text on the signature widget. | | SectionTitleFontSize | 0 | The font size of the section title on the signature widget. | | ShowDate | True | Whether to display the signing date and time details on the widget. | | SignerCaption | #auto | The caption for the signer section on the signature widget. Keep this property set to #auto to make the class generate the default signer caption, which is Signer: . | | SignerInfo | #auto | Custom signer information to put on the signature widget. The standard signature widget allows for several short strings separated by carriage return line feed (CRLF). Keep this property set to #auto to make the class generate the signer text automatically. | | TitleFontSize | 0 | The font size of the main title on the signature widget. | | UseArabicLigature | False | Whether to enable Arabic ligatures in the signature widget. If enabled, certain adjacent Arabic characters may be combined and rendered as a single ligature form (if supported by the shaping engine or font), improving the natural appearance of the text. If disabled, characters are rendered without ligature substitution, and only basic contextual shaping is applied (if AutoReshapeArabicSymbols is enabled). | | Width | 70 | The width of the signature widget in points. This property is the same as [signature_widget_width](#signature_widget_width-property). | **Example:** ```csharp pdfsign.SetWidgetProperty("Width", "100"); pdfsign.SetWidgetProperty("Height", "100"); pdfsign.SetWidgetProperty("ShowDate", "false"); pdfsign.SetWidgetProperty("SignerInfo", "Hello\r\nworld!"); pdfsign.SetWidgetProperty("TitleFontSize", "11"); pdfsign.Sign(); ``` # sign method Signs the data. ## Syntax ```text def sign() -> None: ... ``` ## Remarks This method is used to sign the document or its hash. If [remote_signature_method](#remote_signature_method-property) is set to *rsmNone* or *rsmDigest*, the input data is signed directly with signing_cert. Otherwise, if it is set to *rsmPKCS1* or *rsmPKCS7*, the document is "pre-signed" with the configured signature settings and [remote_signature_digest](#remote_signature_digest-property) is populated with the data to be signed remotely. Use the following properties to adjust new signature settings: - [signature_author_name](#signature_author_name-property) - [signature_claimed_signing_time](#signature_claimed_signing_time-property) - [signature_hash_algorithm](#signature_hash_algorithm-property) - [signature_profile](#signature_profile-property) - [signature_reason](#signature_reason-property) - [signature_type](#signature_type-property) - [signature_widget_height](#signature_widget_height-property) - [signature_widget_offset_x](#signature_widget_offset_x-property) - [signature_widget_offset_y](#signature_widget_offset_y-property) - [signature_widget_pages](#signature_widget_pages-property) - [signature_widget_width](#signature_widget_width-property) Use the following properties to adjust chain validation parameters: - blocked_certs - known_certs - [offline_mode](#offline_mode-property) - [revocation_check](#revocation_check-property) - trusted_certs - [trusted_lists](#trusted_lists-property) - [trust_sources](#trust_sources-property) - [validation_flags](#validation_flags-property) - [validation_policy](#validation_policy-property) - [validation_time](#validation_time-property) During signing, the chain validation log is available via the [on_log](#on_log-event) event if applicable. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # signed method Checks whether the document is signed. ## Syntax ```text def signed() -> bool: ... ``` ## 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 pdfsign.InputFile = "input.pdf"; if (!pdfsign.Signed()) { pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); // Configure signature-related properties as desired pdfsign.Sign(); } ``` NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # update method Updates the most recent signature. ## Syntax ```text def update() -> None: ... ``` ## Remarks This method is used to update the most recent signature by embedding newer or missing revocation information into the signed document. Updating a signature starts with its cryptographic validation. Before any new validation material is inserted, the signature's integrity must be validated. If the signature is found to be correct, the class proceeds with chain validation and the retrieval of any missing chain elements. If the signature is cryptographically wrong, the class throws an exception. The update approach is typically used to extend the validity of an LTV signature. For LTA signatures, updating is typically accompanied with a document timestamping operation. Set [timestamp_server](#timestamp_server-property) to have the class obtain and embed a document timestamp automatically. Further validation material and document timestamps may be added to a document over time to maintain its authenticity and integrity. Use the following properties to adjust chain validation parameters: - blocked_certs - known_certs - [offline_mode](#offline_mode-property) - [revocation_check](#revocation_check-property) - trusted_certs - [trusted_lists](#trusted_lists-property) - [trust_sources](#trust_sources-property) - [validation_flags](#validation_flags-property) - [validation_policy](#validation_policy-property) - [validation_time](#validation_time-property) NOTE: To choose a different signature to update, set [UpdateIndex](#UpdateIndex). NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # on_chain_cert event Fired when the class encounters a chain certificate. ## Syntax ```text class PDFSignChainCertEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def validation_time() -> str: ... @property def validation_result() -> int: ... @validation_result.setter def validation_result(value) -> None: ... @property def validation_details() -> int: ... @validation_details.setter def validation_details(value) -> None: ... # In class PDFSign: @property def on_chain_cert() -> Callable[[PDFSignChainCertEventParams], None]: ... @on_chain_cert.setter def on_chain_cert(event_hook: Callable[[PDFSignChainCertEventParams], None]) -> None: ... ``` ## Remarks This event is fired once for each certificate encountered during chain validation to report that it is about to be processed. The class 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 class 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 class 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 Fired when the document has been loaded into memory. ## Syntax ```text class PDFSignDocumentInfoEventParams(object): @property def page_count() -> int: ... @property def signature_count() -> int: ... # In class PDFSign: @property def on_document_info() -> Callable[[PDFSignDocumentInfoEventParams], None]: ... @on_document_info.setter def on_document_info(event_hook: Callable[[PDFSignDocumentInfoEventParams], None]) -> None: ... ``` ## 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) 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) is called, but only after [on_password](#on_password-event) or [on_recipient_info](#on_recipient_info-event) is fired (if applicable) and the document has been decrypted. # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class PDFSignErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class PDFSign: @property def on_error() -> Callable[[PDFSignErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[PDFSignErrorEventParams], None]) -> None: ... ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the class 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](#pdfsign-errors) section. # on_log event Fired once for each log message. ## Syntax ```text class PDFSignLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class PDFSign: @property def on_log() -> Callable[[PDFSignLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[PDFSignLogEventParams], None]) -> None: ... ``` ## Remarks This event is fired once for each log message generated by the class. 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 Fired when the class detects that the document is encrypted with a password. ## Syntax ```text class PDFSignPasswordEventParams(object): @property def available() -> bool: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFSign: @property def on_password() -> Callable[[PDFSignPasswordEventParams], None]: ... @on_password.setter def on_password(event_hook: Callable[[PDFSignPasswordEventParams], None]) -> None: ... ``` ## 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). *available* indicates whether the decryption password is already available to the class 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 class will stop firing this event to request a password. # on_recipient_info event Fired for each recipient certificate of the encrypted document. ## Syntax ```text class PDFSignRecipientInfoEventParams(object): @property def issuer() -> str: ... @property def serial_number() -> str: ... @property def subject_key_identifier() -> str: ... @property def available() -> bool: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFSign: @property def on_recipient_info() -> Callable[[PDFSignRecipientInfoEventParams], None]: ... @on_recipient_info.setter def on_recipient_info(event_hook: Callable[[PDFSignRecipientInfoEventParams], None]) -> None: ... ``` ## 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 class 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 class 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 Fired when the class finds a signature in the document. ## Syntax ```text class PDFSignSignatureInfoEventParams(object): @property def signature_index() -> int: ... @property def validate_signature() -> bool: ... @validate_signature.setter def validate_signature(value) -> None: ... @property def validate_chain() -> bool: ... @validate_chain.setter def validate_chain(value) -> None: ... # In class PDFSign: @property def on_signature_info() -> Callable[[PDFSignSignatureInfoEventParams], None]: ... @on_signature_info.setter def on_signature_info(event_hook: Callable[[PDFSignSignatureInfoEventParams], None]) -> None: ... ``` ## 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](PDFVerify.md#PDFVerify_m_Verify)). 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) - [revocation_check](#revocation_check-property) - trusted_certs - [trusted_lists](#trusted_lists-property) - [trust_sources](#trust_sources-property) - [validation_flags](#validation_flags-property) - [validation_policy](#validation_policy-property) - [validation_time](#validation_time-property) # on_signature_processed event Fired after a signature has been processed. ## Syntax ```text class PDFSignSignatureProcessedEventParams(object): @property def signature_index() -> int: ... @property def signature_validation_result() -> int: ... @property def chain_validation_result() -> int: ... @property def chain_validation_details() -> int: ... # In class PDFSign: @property def on_signature_processed() -> Callable[[PDFSignSignatureProcessedEventParams], None]: ... @on_signature_processed.setter def on_signature_processed(event_hook: Callable[[PDFSignSignatureProcessedEventParams], None]) -> None: ... ``` ## 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) 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 Fired after the server presents its certificate to the client. ## Syntax ```text class PDFSignSSLServerAuthenticationEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class PDFSign: @property def on_ssl_server_authentication() -> Callable[[PDFSignSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[PDFSignSSLServerAuthenticationEventParams], None]) -> None: ... ``` ## Remarks This event is fired during timestamping or chain validation after the server presents its SSL/TLS certificate to the class. 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 Fired when secure connection progress messages are available. ## Syntax ```text class PDFSignSSLStatusEventParams(object): @property def message() -> str: ... # In class PDFSign: @property def on_ssl_status() -> Callable[[PDFSignSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[PDFSignSSLStatusEventParams], None]) -> None: ... ``` ## 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. # PDFSign Config Settings The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [config](#config-method) method. ### PDFSign Config Settings **AFRelationship[Key]**: The value of the AFRelationship key for the attachment.This setting specifies the value of the AFRelationship key for the attachment. This key in the file specification dictionary expresses the relationship between the attachment and the document, and it must be set for each attachment added to PDF/A-3 documents. *Key* is either the index of the attachment in the attachments collection or the of the attachment. **CacheRevocationInfo**: Whether to cache revocation information.This setting specifies whether the class caches revocation information. If set to *True*, the class preserves downloaded CRLs and OCSP responses in memory and reuses them in subsequent chain validations. If set to *False*, the class 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*. **CompressDSS**: Whether to compress content in the DSS dictionary.This setting determines whether content in the DSS dictionary will be compressed. The default value is *True*. **ContactInfo[Index]**: The signer's contact information.This indexed setting specifies the signer's contact information for a signature. *index* is the index of the signature in the signatures collection. When creating a new signature, use *-1* as the *index*. **CustomProfile**: A pre-defined custom profile to apply when creating the signature.This setting specifies a pre-defined custom profile to apply when creating the signature. Possible values are: | | | | --- | --- | | BR.AD_RB_v1_0 | Brazilian signature with Basic Reference (AD-RB) version 1.0 | | BR.AD_RB_v1_1 | Brazilian signature with Basic Reference (AD-RB) version 1.1 | | BR.AD_RT_v1_0 | Brazilian signature with Time Reference (AD-RT) version 1.0 | | BR.AD_RT_v1_1 | Brazilian signature with Time Reference (AD-RT) version 1.1 | | BR.AD_RC_v1_1 | Brazilian signature with Complete References (AD-RC) version 1.1 | | BR.AD_RC_v1_2 | Brazilian signature with Complete References (AD-RC) version 1.2 | | BR.AD_RA_v1_1 | Brazilian signature with References for Archiving (AD-RA) version 1.1 | | BR.AD_RA_v1_2 | Brazilian signature with References for Archiving (AD-RA) version 1.2 | **CustomSignedAttributes**: The custom signed attributes to be added to the inner CMS.This setting specifies a CRLF-separated list of custom signed attributes that are added to the inner CMS when [sign](#sign-method) is called. Each attribute must be specified as a *name=value* pair containing an OID followed by an ASN.1-encoded attribute value. For example: ```csharp pdfsign.Config("CustomSignedAttributes=1.2.3.4.5=04084142434445464748\r\n1.2.3.4.7=02020404"); ``` **EnforcePDFA**: Whether to enforce PDF/A compliance.This setting specifies whether the class 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*. **ExtraSpace**: The number of extra zero bytes to allocate in the document behind the signature.This setting specifies the number of extra zero bytes to allocate in the document behind the signature. The allocated space can be used in the future to place a timestamp. **FallbackFont**: The fallback font.This setting specifies the font that the class uses if it cannot find the intended font on the local system. In PDF/A, fonts must be embedded into the document, so this setting can be useful when text must be added but no font is available. **FilterName[Index]**: The signature filter name.This indexed setting specifies the signature filter name. The default value is *nsoftware.SecurePDF*. *index* is the index of the signature in the signatures collection. When creating a new signature, use *-1* as the *index*. If set to *PBAD_PAdES*, the class creates a PBAD.PAdES-compatible signature. **FontPaths**: The font search paths.This setting specifies a CRLF-separated list of directories where the class searches for additional TrueType font files. It is used when resolving a TrueType font specified in the *FontName* widget property without a full file path. Each entry is interpreted as a directory path used during font lookup. To use a specific TrueType font file, either specify its filename and include the containing directory in this setting, or specify the full file path in the *FontName* widget property. The default value is the system font search paths. These paths are platform-dependent: | | | | --- | --- | | Windows | %windir%\Fonts and %LOCALAPPDATA%\Microsoft\Windows\Fonts | | macOS and iOS | /System/Library/Fonts/, /Library/Fonts/, and ~/Library/Fonts/ | | Linux | Directories listed by dir entries in /etc/fonts/fonts.conf and /usr/local/etc/fonts/fonts.conf | | Android | /system/fonts | On Windows, the .NET and Java editions obtain these locations through the runtime APIs or the *windir*, *SystemRoot*, and *LOCALAPPDATA* environment variables. To use custom directories together with the default system locations, include both to prevent the current search path list from being replaced. For example: ```csharp string fontPaths = pdfsign.Config("FontPaths"); fontPaths += @"\r\nC:\Fonts"; pdfsign.Config("FontPaths=" + fontPaths); ``` **FullSignatureName[Index]**: The full name of the signature field.This indexed setting specifies 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. When creating a new signature, use *-1* as the *index*. **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. **IncludeRevocationInfo**: Whether to include revocation information in the document.This setting specifies whether and where revocation information is included in the document when [sign](#sign-method) or [update](#update-method) is called. Its value should be provided as a bitmask of the following flags: | | | | --- | --- | | 0x001 (rilAutomatic) | Include revocation information in either the DSS dictionary or the adbe-revocationInfoArchival signature attribute depending on the [signature_type](#signature_type-property). | | 0x002 (rilDSS) | Include revocation information in the DSS dictionary. | | 0x004 (rilAdbeAttribute) | Include revocation information in the adbe-revocationInfoArchival signature attribute. | The default value is *0x001*, meaning the class saves revocation information in the DSS dictionary for advanced (PAdES) signatures, and in the adbe-revocationInfoArchival signature attribute for legacy signatures. This complies with the respective standards. **IncludeSigningChain**: Whether to include the full signing chain in the signature.This setting specifies whether and how the full signing certificate chain is included in the signature. Possible values are: | | | | --- | --- | | 0 | Do not include the signing chain in the signature. | | 1 (default) | Attempt to build the signing chain automatically, and if successful, include it in the signature. | | 2 | Include the contents of known_certs in the signature. | **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) 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), 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 class 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 class 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 class 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. | **PolicyHash**: The signature policy hash value.This setting specifies the hash of the external signature policy document. The hash is calculated by the policy author when the policy is created, and it is included in the policy file. This setting must be set, together with [PolicyHashAlgorithm](#PolicyHashAlgorithm) and [PolicyId](#PolicyId), in order to create an EPES signature. **PolicyHashAlgorithm**: The algorithm that was used to calculate the signature policy hash.This setting specifies the algorithm that was used to calculate the signature policy hash. It must be set, together with [PolicyHash](#PolicyHash) and [PolicyId](#PolicyId), in order to create an EPES signature. **PolicyId**: The policy Id to be included in the signature.This setting specifies the signature policy Id to be included in the signature. It must be set, together with [PolicyHash](#PolicyHash) and [PolicyHashAlgorithm](#PolicyHashAlgorithm), in order to create an EPES signature. **PreferEmbeddedRevocationInfo**: Whether to prioritize revocation information that is embedded into the document.This setting specifies whether the class uses revocation information that is embedded into the document when checking revocation status. If set to *True*, the class does not download CRLs or OCSP responses from online sources unnecessarily. If set to *False* or no embedded revocation information is present, the class retrieves it as normal based on the value of [revocation_check](#revocation_check-property). The default value is *True*. **RemoteSignatureData**: The hex-encoded signature data obtained from a remote signing engine.This setting specifies the hex-encoded signature data obtained from a remote signing engine. Use it to pass the [RemoteSignatureDigest](#RemoteSignatureDigest) back to the class (after it has been processed appropriately and signed) to complete the signature. NOTE: This setting is deprecated. Please use the [remote_signature_data](#remote_signature_data-property) property instead. **RemoteSignatureDigest**: The hex-encoded digest to be signed remotely.This setting returns the hex-encoded digest that should be passed to a remote signing engine to be signed. Note that in the PKCS#1 method, this value is the raw data of the PKCS#7 signed-attributes field, whereas in the PKCS#7 method, it is the document hash. This setting is read-only. NOTE: This setting is deprecated. Please use the [remote_signature_digest](#remote_signature_digest-property) property instead. **RemoteSignatureMethod**: The remote signing method.This setting specifies whether and how the new signature is intended to be created remotely. If set to *pkcs1* or *pkcs7* before [sign](#sign-method) is called, the class does not perform the low-level signing operation itself but instead delegates it to an external or remote signing engine. Possible values are: | | | | --- | --- | | none (default) | Do not create the signature remotely. | | pkcs1 | Create the signature remotely using the PKCS#1 signing method. The class builds the PKCS#7 structure itself and populates [RemoteSignatureDigest](#RemoteSignatureDigest) with the raw data of the signed-attributes field. Note that signing_cert must be set in order to use this option. | | pkcs7 | Create the signature remotely using the PKCS#7 signing method. The class populates [RemoteSignatureDigest](#RemoteSignatureDigest) with the document hash, and the remote signer is expected to build the PKCS#7 structure. Use this option if the signing certificate is not available. | | pkcs7sign | Sign the digest generated earlier using the PKCS#7 method and produce the corresponding PKCS#7 structure. The input is expected to contain an unencoded binary message digest, and the output is a binary PKCS#7 object. Unlike the other options, this is a one-pass method. Note that no PDF data is involved in either input or output. | NOTE: This setting is deprecated. Please use the [remote_signature_method](#remote_signature_method-property) property instead. **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) is called. Possible values are: | | | | --- | --- | | 0 | Discard all changes. | | 1 | Save the document to [output_file](#output_file-property), [output_data](#output_data-property), 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), [output_data](#output_data-property), or the stream set in set_output_stream, but only if it has been modified. | **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. **SystemFontNames**: The system font names.This setting returns a CRLF-separated list of system TrueType font names that are supported by the class. This setting is read-only. **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. **TimestampHashAlgorithm**: A specific hash algorithm for use with the timestamping service.This setting specifies a different hash algorithm to use for the timestamp. In its default configuration, the class uses the same hash algorithm for the main signature and any associated timestamps. **TSATLSClientCertStore**: The TLS client certificate store to search.This setting specifies the TLS client certificate store to search when the TSA requests TLS client authentication. 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 [TSATLSClientCertStoreType](#TSATLSClientCertStoreType) is set to 2 (*cstPFXFile*), this setting must be set to the name of the file. When the type is set to 3 (*cstPFXBlob*), this setting must be set to the binary contents of a PFX file (i.e., a PKCS#12 certificate store). If the store is password-protected, specify the password in [TSATLSClientCertStorePassword](#TSATLSClientCertStorePassword). **TSATLSClientCertStorePassword**: The password needed to open the TLS client certificate store.This setting specifies the password needed to open the TLS client certificate store when the TSA requests TLS client authentication. **TSATLSClientCertStoreType**: The type of the TLS client certificate store.This setting specifies the type of the TLS client certificate store specified by [TSATLSClientCertStore](#TSATLSClientCertStore). The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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 object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [list_store_certificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](CertMgr.md#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 [](#f_Store) and set [](#f_StorePassword) 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. | **TSATLSClientCertSubject**: The subject of the TLS client certificate.This setting specifies the subject of the TLS client certificate to use when the TSA requests TLS client authentication. It must be set after all other certificate properties are set. When set, a search is performed in the [TSATLSClientCertStore](#TSATLSClientCertStore) to locate a certificate with a matching subject. If a matching certificate is found, the setting 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 setting. If a match is still not found, the setting is set to an empty string, and no certificate is selected. The asterisk character (***) 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. **UpdateIndex**: The index of the signature to update.This setting specifies the index of the signature in the signatures collection to be updated. The default value is *-1*, meaning the class updates the most recent signature. **UsePSS**: Whether to use RSA-PSS during signing and verification.This setting specifies whether RSA-PSS is used when signing and verifying documents. The default value is *False*. ### 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 class 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*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the class 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. # PDFSign Errors ### PDFSign Errors | | | | --- | --- | | 801 | No timestamp server specified. | | 802 | HTTP download failed. The error description contains the detailed message. | | 803 | The document is not signed. | | 810 | Unsupported image type. | | 811 | Unsupported color space type. | | 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. | | 831 | Cannot sign data or update this type of signature. 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. | | 843 | No signing certificate found. | | 845 | Invalid signing certificate chain. The error description contains the detailed message. | | 851 | Unsupported hash algorithm. | | 855 | Invalid signature contents. | | 856 | Invalid signature byte range. | | 857 | Byte range does not cover the entire document. | | 858 | Cannot sign and encrypt document with more than one signature. | | 862 | Cannot timestamp encrypted document. | | 863 | Cannot update encrypted document. | | 865 | Signature is too large to fit in the allocated window. Please consider extending the window by assigning the number of bytes to add to the [ExtraSpace](#ExtraSpace) config before closing the document. | | 866 | Not enough space to update signature. | | 875 | Bad signature type (only PKCS#7/CMS signatures are supported by this handler). | | 876 | Invalid decryption mode. | ### 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) already exists and [overwrite](#overwrite-property) 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 class 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). |