PDFSigner Class
Properties Methods Events Config Settings Errors
The PDFSigner class signs PDF documents digitally.
Syntax
class secureblackbox.PDFSigner
Remarks
PDFSigner can sign PDF documents in accordance with a selection of PDF and PAdES signature standards.
PDFSigner signer = new PDFSigner();
// Set the PDF document that you want to sign
signer.setInputFile("MyDocument.pdf");
// Set the path where you want the signed document to be saved
signer.setOutputFile("Signed.pdf");
// The certificate which the document will be signed with
signer.setSigningCertificate(new Certificate("Cert.pfx","password"));
// The signature level
signer.getNewSignature().setLevel(PDFSignature.paslBaselineT);
signer.getNewSignature().setHashAlgorithm("SHA512"); // Hashing algorithm used for signing, default SHA256
signer.setTimestampServer("https://..."); // The address of the timestamping server
signer.sign();
Standards and technologies supported
PDFSigner can create PDF signatures that match the following baseline standards:
- Generic PDF signatures (ISO 32000)
- PAdES: all profiles are supported (BES, EPES, T, LTV, B-B, B-T, and others) (ETSI EN 319 142-1 and others)
- Signature and document timestamps using external TSAs.
- All industry-standard cryptographic algorithms (RSA, ECDSA, SHA256-512, and many others).
Configuring the signature spec
Configuring PDFSigner to produce signatures of the right type is one of the most important questions you need to address. Normally the service or software you will be communicating your PDF documents to will provide you with the list of requirements that your signatures should match.
Typically, those will dictate the following key aspects of the signatures:
- Level (BES, T, or LTV). This can be adjusted with the property (Note: when creating EPES signatures you need to provide the signature and properties).
- Timestamp requirement: provide the address of your online TSA service via the timestamp_server property.
- When creating LTV signatures, tune up validation parameters via the revocation_check, offline_mode, and ignore_chain_validation_errors properties.
- To create a document timestamp, sign your document first, and then sign the result again with set to pslDocumentTimestamp and timestamp_server pointing to the TSA URL.
Signing certificates
PDFSigner can use certificates residing on different media. Besides generic certificates stored in PFX or PEM files (A1), it can operate with non-exportable certificates residing on hardware media (A3) or in the cloud.
Non-exportable certificates can be accessed transparently via a Windows CSP or a PKCS#11 driver, if supplied by the certificate issuer. Proprietary interfaces can be plugged in with the external signing feature (see below).
You can use the CertificateManager and CertificateStorage classes to load the signing certificate. Assign the certificate to the signing_certificate property, and optionally provide the remainder of its chain via the signing_chain property.
Note: If signing with a non-exportable key (such as residing on a hardware device or in the cloud), please make sure you keep the original CertificateStorage object open until the signing is completed. This is because the storage class provides a 'bridge' to the private key. If the storage is closed prematurely, this bridge is destroyed, and the private key can't be used.
You don't need to provide a signing certificate or chain when creating document timestamp signatures, since this type of signature is done with a TSA's certificate.
Widget adjustment
PDFSigner provides means to customize the look of the signature widget to be shown on the document page. Create your very own signatures in the form of your company's logo, a handwritten signature, or a wet seal.
Alternatively, you can choose not to associate any widget with your signature by setting to true.
Please check out this self-describing PDF document for good guidance on widget positioning, background styles, and text formatting.
Signing the document
Now that you have set up all signature, certificate, and widget properties, it is time to sign. You can provide the input document in one of the following forms: as a file (assign the path to the input_file property), as a stream (assign to the input_stream property), or as a byte array (assign to input_bytes). Similarly, the output can be collected in one of the same forms, either by passing the destination path or stream via output_file and output_stream respectively, or by reading the resulting document bytes from the output_bytes property after the signing.
Having set up the input and output, call the class's sign method. This will initiate the signing process. Depending on the settings, the signing may be as straightforward as calculating the document hash and signing it with the private key (e.g. in the PAdES-BES signing variant), or it may involve advanced chain validation routines (PAdES-LTV). During the latter, the class may contact a number of external revocation information sources (CRL and OCSP servers) to establish the validity of the signing certificate.
If a TSA server was provided via the timestamp_server property, the class will contact it too to timestamp the new signature.
During the signing, PDFSigner may fire events to let your code know of certain conditions. If the input document is encrypted but no decryption parameters were found in the password and decryption_certificate properties, the class will fire the on_encrypted event to tell your code that it needs decryption information to be able to continue with the signing. It may fire on_tls_cert_validate if one of the HTTP endpoints involved during the operation (which may be a CRL, OCSP, or TSA service) works over TLS and needs its certificate to be validated.
External signing and DCAuth
PDFSigner, like many other classes offered by the product, supports two methods of signing with external keys. These methods are fully independent of each other: you can choose the one that suits your usage scenario best.
Synchronous method: ExternalSign
This is a simpler method that basically lets you infiltrate into the heart of the signing routine by taking care of the hash signing operation. The class does the rest of the job (hash calculation, preparation of signature objects, CRL/OCSP retrieval).
To initiate this method, call sign_external instead of sign. When the hash is ready, it will be passed back to your code with the on_external_sign event. Your event handler needs to sign the hash with the private key and return the created signature back to the class - which will embed it into the document.
You don't need your signing certificate to contain an associated private key when using this method. The certificate itself (its public copy) may be needed though, as it is often included in the hash calculation.
This method is synchronous, meaning sign_external provides you the results immediately upon its completion.
Asynchronous method: DCAuth
DCAuth is a SecureBlackbox know-how technology. This protocol was designed to allow sharing of private keys across environments, allowing the signer and the private key to reside on different systems. It works in the following way:
- The signing party - such as PDFSigner - initiates the operation using a sign_async_begin call. This produces two outcomes: a pre-signed document (a document with a blank signature placeholder), and a request state (an object containing a hash that needs to be signed). At this point the PDFSigner instance can be released, and the process itself terminated (which may be useful when run as part of a web page).
- The request state is passed to the private key holder party. The private key holder passes the request state to a DCAuth object, which parses the request state, extracts the hash, and signs it. The output of DCAuth processing is another object, a response state, which contains the signature. The private key holder then sends the response state back to the signing party.
- The signing party re-creates the classes and passes the response state, together with the pre-signed version of the document, to the signer's sign_async_end method. sign_async_end extracts the signature from the response state and incorporates it into the pre-signed document.
This method is asynchronous in that sense that from the signing party's viewpoint, it splits the signing operation into the pre-signing and completion stages which can be performed independently from each other and in different execution contexts. This makes this method particularly helpful for use in web pages and other scenarios where the signing key is not available in real time.
Fine-grained chain validation setup
Chain validation is a sophisticated, multi-faceted 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 tune up your chain validation parameters so they fit them best. A summary of such parameters is given below.
- revocation_check lets you choose between and/or prioritize revocation origins. OCSP sources are often preferred to CRL because of their real-time capability and the smaller size of validation tokens they produce.
- offline_mode is a master switch that stops the class from looking for any validation tokens online. If this property is switched on, the class will only use the known_certificates, trusted_certificates, known_crls, and known_ocsps collections to look for the missing validation material.
- ignore_chain_validation_errors makes the class ignore any major validation issues it encounters (such us an untrusted chain or missing CRL). This option is handy for debugging and for creating signatures in the environments where the signing certificate is not trusted.
- known_certificates, known_crls, and known_ocsps let you provide your own validation material. This may be useful when working in offline_mode, where the signer has no access to the validation sources, or where the validation material has already been collected.
- trusted_certificates lets you provide a list of trust anchors, either as a complement to the system's or as an alternative to it.
- blocked_certificates lets you provide a list of blocked/distrusted certificates. Any CA certificate contained in it will be deemed untrusted/invalid.
The following parameters are not directly related to chain validation, but may have an implicit effect on it.
- proxy, socket_settings, and tls_settings let you tune up the connectivity and TLS options in accordance with local preferences.
- tls_client_chain lets you provide the client certificate and its chain for TLS client authentication.
- Subscribe to on_tls_cert_validate to validate any TLS certificates of the services involved in chain validation.
The results of the chain validation procedure, upon its completion, are published in the following properties:
- chain_validation_result contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined.
- chain_validation_details provides the details of the factors that contributed to the chain validation result, such as an outdated certificate, a missing CRL, or a missing CA certificate.
- validation_log contains the detailed chain validation log. The log can often be very helpful in nailing down various validation issues.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| attached_file_count | The number of records in the AttachedFiles arrays. |
| attached_files_content_subtype | Contains the content subtype of the attachment. |
| attached_files_content_type | Contains the content type of the attachment. |
| attached_files_creation_date | The creation date. |
| attached_files_data | The content of the attachment. |
| attached_files_description | Textual description of the attachment. |
| attached_files_file_name | Specifies the name of the attachment file. |
| attached_files_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| attached_files_id | Contains the attachment's unique identifier. |
| attached_files_modification_date | Specifies the date and time of the file's last modification. |
| attached_files_read_date | Specifies the file's last read date. |
| attached_files_size | The attachment's size in bytes. |
| auto_validate_signatures | Specifies whether PDFSigner should validate any present signatures when the document is opened. |
| blocked_cert_count | The number of records in the BlockedCert arrays. |
| blocked_cert_bytes | Returns the raw certificate data in DER format. |
| blocked_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| cert_count | The number of records in the Cert arrays. |
| cert_bytes | Returns the raw certificate data in DER format. |
| cert_ca | Indicates whether the certificate has a CA capability. |
| cert_ca_key_id | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| cert_cert_type | Returns the type of the entity contained in the Certificate object. |
| cert_crl_distribution_points | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| cert_curve | Specifies the elliptic curve associated with the certificate's public key. |
| cert_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| cert_friendly_name | Contains an associated alias (friendly name) of the certificate. |
| cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| cert_hash_algorithm | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). |
| cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
| cert_issuer_rdn | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| cert_key_algorithm | Specifies the public key algorithm of this certificate. |
| cert_key_bits | Returns the length of the public key in bits. |
| cert_key_fingerprint | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| cert_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| cert_key_valid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| cert_ocsp_locations | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. |
| cert_ocsp_no_check | Accessor to the value of the certificate's ocsp-no-check extension. |
| cert_origin | Returns the location that the certificate was taken or loaded from. |
| cert_policy_i_ds | Contains identifiers (OIDs) of the applicable certificate policies. |
| cert_private_key_bytes | Returns the certificate's private key in DER-encoded format. |
| cert_private_key_exists | Indicates whether the certificate has a usable private key associated with it. |
| cert_private_key_extractable | Indicates whether the private key is extractable (exportable). |
| cert_public_key_bytes | Contains the certificate's public key in DER format. |
| cert_qualified | Indicates whether the certificate is qualified. |
| cert_qualified_statements | Returns a simplified qualified status of the certificate. |
| cert_qualifiers | A list of qualifiers. |
| cert_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| cert_serial_number | Returns the certificate's serial number. |
| cert_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| cert_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| cert_subject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| cert_subject_alternative_name | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| cert_subject_key_id | Contains a unique identifier of the certificate's cryptographic key. |
| cert_subject_rdn | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| cert_valid | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. |
| cert_valid_from | The time point at which the certificate becomes valid, in UTC. |
| cert_valid_to | The time point at which the certificate expires, in UTC. |
| check_trusted_lists | Specifies whether the class should attempt to validate chain trust via a known Trusted List. |
| crl_count | The number of records in the CRL arrays. |
| crl_bytes | Returns the raw CRL data in DER format. |
| crlca_key_id | A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
| crl_entry_count | Returns the number of certificate status entries in the CRL. |
| crl_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| crl_issuer | The common name of the CRL issuer (CA), typically a company name. |
| crl_issuer_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
| crl_location | The URL that the CRL was downloaded from. |
| crl_next_update | The planned time and date of the next version of this CRL to be published. |
| crl_sig_algorithm | The public key algorithm that was used by the CA to sign this CRL. |
| crl_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| crltbs | The to-be-signed part of the CRL (the CRL without the signature part). |
| crl_this_update | The date and time at which this version of the CRL was published. |
| decryption_certificate_bytes | Returns the raw certificate data in DER format. |
| decryption_certificate_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| document_info_encryption_algorithm | The symmetric algorithm used to encrypt the document. |
| document_info_encryption_type | The document encryption type. |
| document_info_metadata_encrypted | Indicates if the document metadata is encrypted. |
| document_info_permissions | Contains the document permissions associated with the encryption. |
| empty_field_index | Specifies the index of the empty signature field to sign. |
| external_crypto_async_document_id | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
| external_crypto_custom_params | Custom parameters to be passed to the signing service (uninterpreted). |
| external_crypto_data | Additional data to be included in the async state and mirrored back by the requestor. |
| external_crypto_external_hash_calculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| external_crypto_hash_algorithm | Specifies the request's signature hash algorithm. |
| external_crypto_key_id | The ID of the pre-shared key used for DC request authentication. |
| external_crypto_key_secret | The pre-shared key used for DC request authentication. |
| external_crypto_method | Specifies the asynchronous signing method. |
| external_crypto_mode | Specifies the external cryptography mode. |
| external_crypto_public_key_algorithm | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
| fips_mode | Reserved. |
| ignore_chain_validation_errors | Makes the class tolerant to chain validation errors. |
| input_bytes | Use this property to pass the input to class in byte array form. |
| input_file | The PDF file to be signed or updated. |
| known_cert_count | The number of records in the KnownCert arrays. |
| known_cert_bytes | Returns the raw certificate data in DER format. |
| known_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| known_crl_count | The number of records in the KnownCRL arrays. |
| known_crl_bytes | Returns the raw CRL data in DER format. |
| known_crl_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| known_ocsp_count | The number of records in the KnownOCSP arrays. |
| known_ocsp_bytes | A buffer containing the raw OCSP response data. |
| known_ocsp_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| new_sig_allowed_changes | The changes to the document allowed by the signature. |
| new_sig_author_name | A human-readable signer name. |
| new_sig_certification | Specifies whether this is a Certification (MDP) signature. |
| new_sig_chain_validation_details | The details of a certificate chain validation outcome. |
| new_sig_chain_validation_result | The outcome of a certificate chain validation routine. |
| new_sig_claimed_signing_time | Returns or sets the signature's creation time. |
| new_sig_compatibility_errors | Returns compatibility errors encountered during validation. |
| new_sig_contact_info | Contains the signer's contact information. |
| new_sig_contains_long_term_info | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| new_sig_coverage_ends_at | Indicates the offset in the PDF file where signature coverage ends. |
| new_sig_custom_data | Uninterpreted custom data to save with the signature. |
| new_sig_empty_field | Indicates whether or not the signature created/read is an empty property (a signature placeholder). |
| new_sig_entity_label | Use this property to get the signature entity label. |
| new_sig_filter_name | The signature filter name. |
| new_sig_full_signature_name | Specifies the full name of the signature property. |
| new_sig_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| new_sig_hash_algorithm | Specifies the hash algorithm to be used for signing. |
| new_sig_height | Specifies the height of the signature widget. |
| new_sig_issuer_rdn | The Relative Distinguished Name of the signing certificate's issuer. |
| new_sig_level | Specifies the PAdES signature level. |
| new_sig_location | Specifies the host name or the physical location of the signing entity. |
| new_sig_offset_x | Specifies the signature widget offset from the left-hand page border. |
| new_sig_offset_y | Specifies the signature widget offset from the bottom page border. |
| new_sig_page | Indicates the index of the page on which the signature is placed. |
| new_sig_policy_hash | The signature policy hash value for EPES signatures. |
| new_sig_policy_hash_algorithm | The algorithm that was used to calculate the signature policy hash. |
| new_sig_policy_id | The policy ID to be included into the signature. |
| new_sig_policy_uri | The signature policy URI that was included in the signature. |
| new_sig_reason | Specifies the reason for signing. |
| new_sig_serial_number | The serial number of the signing certificate. |
| new_sig_signature_bytes | Returns the binary representation of the underlying PKCS7 signature blob. |
| new_sig_signature_name | Specifies the unique signature identifier to use. |
| new_sig_signature_type | The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown. |
| new_sig_signature_validation_result | The outcome of the cryptographic signature validation. |
| new_sig_subject_key_id | Contains the subject key identifier of the signing certificate. |
| new_sig_subject_rdn | Contains the RDN of the owner of the signing certificate. |
| new_sig_timestamped | Use this property to establish whether the signature contains an embedded timestamp. |
| new_sig_validated_signing_time | Contains the certified signing time. |
| new_sig_validation_log | Contains the signing certificate's chain validation log. |
| new_sig_width | Specifies the width of the signature widget. |
| ocsp_count | The number of records in the OCSP arrays. |
| ocsp_bytes | A buffer containing the raw OCSP response data. |
| ocsp_entry_count | The number of SingleResponse elements contained in this OCSP response. |
| ocsp_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| ocsp_issuer | Indicates the issuer of this response (a CA or its authorized representative). |
| ocsp_issuer_rdn | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
| ocsp_location | The location of the OCSP responder. |
| ocsp_produced_at | Specifies the time when the response was produced, in UTC. |
| ocsp_sig_algorithm | The public key algorithm that was used by the CA to sign this OCSP response. |
| ocsp_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| offline_mode | Switches the class to offline mode. |
| output_bytes | Use this property to read the output the class object has produced. |
| output_file | The file to save the signed or updated document to. |
| page_count | The number of records in the Page arrays. |
| page_crop_llx | Specifies the lower-left X coordinate of the page crop area. |
| page_crop_lly | Specifies the lower-left Y coordinate of the page crop area. |
| page_crop_urx | Specifies the upper-right X coordinate of the page crop area. |
| page_crop_ury | Specifies the upper-right Y coordinate of the page crop area. |
| page_height | Specifies the height of the page. |
| page_media_llx | Specifies the lower-left X coordinate of the page media area. |
| page_media_lly | Specifies the lower-left Y coordinate of the page media area. |
| page_media_urx | Specifies the upper-right X coordinate of the page media area. |
| page_media_ury | Specifies the upper-right Y coordinate of the page media area. |
| page_rotate | Specifies the rotation angle of the page in degrees. |
| page_width | Specifies the width of the page. |
| password | The decryption password. |
| profile | Specifies a pre-defined profile to apply when creating the signature. |
| proxy_address | The IP address of the proxy server. |
| proxy_authentication | The authentication type used by the proxy server. |
| proxy_password | The password to authenticate to the proxy server. |
| proxy_port | The port on the proxy server to connect to. |
| proxy_proxy_type | The type of the proxy server. |
| proxy_request_headers | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| proxy_response_body | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| proxy_response_headers | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| proxy_use_ipv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
| proxy_username | Specifies the username credential for proxy authentication. |
| revocation_check | Specifies the kind(s) of revocation check to perform for all chain certificates. |
| signature_count | The number of records in the Signature arrays. |
| signature_allowed_changes | The changes to the document allowed by the signature. |
| signature_author_name | A human-readable signer name. |
| signature_certification | Specifies whether this is a Certification (MDP) signature. |
| signature_chain_validation_details | The details of a certificate chain validation outcome. |
| signature_chain_validation_result | The outcome of a certificate chain validation routine. |
| signature_claimed_signing_time | Returns or sets the signature's creation time. |
| signature_compatibility_errors | Returns compatibility errors encountered during validation. |
| signature_contact_info | Contains the signer's contact information. |
| signature_contains_long_term_info | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| signature_coverage_ends_at | Indicates the offset in the PDF file where signature coverage ends. |
| signature_custom_data | Uninterpreted custom data to save with the signature. |
| signature_empty_field | Indicates whether or not the signature created/read is an empty property (a signature placeholder). |
| signature_entity_label | Use this property to get the signature entity label. |
| signature_filter_name | The signature filter name. |
| signature_full_signature_name | Specifies the full name of the signature property. |
| signature_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| signature_hash_algorithm | Specifies the hash algorithm to be used for signing. |
| signature_height | Specifies the height of the signature widget. |
| signature_issuer_rdn | The Relative Distinguished Name of the signing certificate's issuer. |
| signature_level | Specifies the PAdES signature level. |
| signature_location | Specifies the host name or the physical location of the signing entity. |
| signature_offset_x | Specifies the signature widget offset from the left-hand page border. |
| signature_offset_y | Specifies the signature widget offset from the bottom page border. |
| signature_page | Indicates the index of the page on which the signature is placed. |
| signature_policy_hash | The signature policy hash value for EPES signatures. |
| signature_policy_hash_algorithm | The algorithm that was used to calculate the signature policy hash. |
| signature_policy_id | The policy ID to be included into the signature. |
| signature_policy_uri | The signature policy URI that was included in the signature. |
| signature_reason | Specifies the reason for signing. |
| signature_serial_number | The serial number of the signing certificate. |
| signature_signature_bytes | Returns the binary representation of the underlying PKCS7 signature blob. |
| signature_signature_name | Specifies the unique signature identifier to use. |
| signature_signature_type | The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown. |
| signature_signature_validation_result | The outcome of the cryptographic signature validation. |
| signature_subject_key_id | Contains the subject key identifier of the signing certificate. |
| signature_subject_rdn | Contains the RDN of the owner of the signing certificate. |
| signature_timestamped | Use this property to establish whether the signature contains an embedded timestamp. |
| signature_validated_signing_time | Contains the certified signing time. |
| signature_validation_log | Contains the signing certificate's chain validation log. |
| signature_width | Specifies the width of the signature widget. |
| signing_cert_bytes | Returns the raw certificate data in DER format. |
| signing_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| signing_chain_count | The number of records in the SigningChain arrays. |
| signing_chain_bytes | Returns the raw certificate data in DER format. |
| signing_chain_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| socket_dns_mode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
| socket_dns_port | Specifies the port number to be used for sending queries to the DNS server. |
| socket_dns_query_timeout | The timeout (in milliseconds) for each DNS query. |
| socket_dns_servers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| socket_dns_total_timeout | The timeout (in milliseconds) for the whole resolution process. |
| socket_incoming_speed_limit | The maximum number of bytes to read from the socket, per second. |
| socket_local_address | The local network interface to bind the socket to. |
| socket_local_port | The local port number to bind the socket to. |
| socket_outgoing_speed_limit | The maximum number of bytes to write to the socket, per second. |
| socket_timeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| socket_use_ipv6 | Enables or disables IP protocol version 6. |
| timestamp_count | The number of records in the Timestamp arrays. |
| timestamp_accuracy | This property indicates the accuracy of the included time mark, in microseconds. |
| timestamp_bytes | Returns the raw timestamp data in DER format. |
| timestamp_certificate_index | Returns the index of the TSA certificate in the Certificates collection. |
| timestamp_chain_validation_details | The details of a certificate chain validation outcome. |
| timestamp_chain_validation_result | The outcome of a certificate chain validation routine. |
| timestamp_contains_long_term_info | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| timestamp_entity_label | Use this property to get the timestamp entity label. |
| timestamp_hash_algorithm | Returns the timestamp's hash algorithm. |
| timestamp_parent_entity | Use this property to get the label of the timestamp's parent entity. |
| timestamp_serial_number | Returns the timestamp's serial number. |
| timestamp_time | The time point incorporated into the timestamp. |
| timestamp_timestamp_type | Returns the type of the timestamp. |
| timestamp_tsa_name | This value uniquely identifies the Timestamp Authority (TSA). |
| timestamp_validation_log | Contains the TSA certificate chain validation log. |
| timestamp_validation_result | Contains the timestamp validation outcome. |
| timestamp_server | The address of the timestamping server. |
| tls_client_cert_count | The number of records in the TLSClientCert arrays. |
| tls_client_cert_bytes | Returns the raw certificate data in DER format. |
| tls_client_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| tls_server_cert_count | The number of records in the TLSServerCert arrays. |
| tls_server_cert_bytes | Returns the raw certificate data in DER format. |
| tls_server_cert_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| tls_server_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| tls_server_cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
| tls_server_cert_issuer_rdn | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| tls_server_cert_key_algorithm | Specifies the public key algorithm of this certificate. |
| tls_server_cert_key_bits | Returns the length of the public key in bits. |
| tls_server_cert_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| tls_server_cert_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| tls_server_cert_serial_number | Returns the certificate's serial number. |
| tls_server_cert_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| tls_server_cert_subject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| tls_server_cert_subject_rdn | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| tls_server_cert_valid_from | The time point at which the certificate becomes valid, in UTC. |
| tls_server_cert_valid_to | The time point at which the certificate expires, in UTC. |
| tls_auto_validate_certificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| tls_base_configuration | Selects the base configuration for the TLS settings. |
| tls_ciphersuites | A list of ciphersuites separated with commas or semicolons. |
| tls_client_auth | Enables or disables certificate-based client authentication. |
| tls_ec_curves | Defines the elliptic curves to enable. |
| tls_extensions | Provides access to TLS extensions. |
| tls_force_resume_if_destination_changes | Whether to force TLS session resumption when the destination address changes. |
| tls_pre_shared_identity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| tls_pre_shared_key | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| tls_pre_shared_key_ciphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| tls_renegotiation_attack_prevention_mode | Selects the renegotiation attack prevention mechanism. |
| tls_revocation_check | Specifies the kind(s) of revocation check to perform. |
| tls_ssl_options | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
| tls_tls_mode | Specifies the TLS mode to use. |
| tls_use_extended_master_secret | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| tls_use_session_resumption | Enables or disables the TLS session resumption capability. |
| tls_versions | The SSL/TLS versions to enable by default. |
| trusted_cert_count | The number of records in the TrustedCert arrays. |
| trusted_cert_bytes | Returns the raw certificate data in DER format. |
| trusted_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| validation_moment | The time point at which signature validity is to be established. |
| widget_algorithm_caption | The caption of the signature widget property with information about the signature algorithm. |
| widget_algorithm_info | Information about the algorithm to be shown on the signature widget. |
| widget_background_data | Contains/takes the data of the signature widget background bitmap. |
| widget_background_height | Use this property to manually adjust the size of the stretched background picture in the vertical direction. |
| widget_background_image_height | The height of the background image in pixels. |
| widget_background_image_type | The type of the image contained in BackgroundData . |
| widget_background_image_width | The width of the background image in pixels. |
| widget_background_mask | Contains the background image mask. |
| widget_background_position | The position of the widget background. |
| widget_background_style | The style of the signature widget background. |
| widget_background_width | Use this property to manually adjust the horizontal size of the stretched background picture. |
| widget_compress_widget_data | Whether the signature widget data should be compressed before saving. |
| widget_custom_appearance | Contains a custom widget description in raw PDF graphic operators format. |
| widget_custom_background_content_stream | Specifies a custom background content stream for the pwbsCustom BackgroundStyle . |
| widget_custom_visual_status_matrix | Defines the custom visual status matrix. |
| widget_date_format | The format string used to display the signing date and time in the signature widget. |
| widget_font_name | Specifies the font name for the signature text. |
| widget_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| widget_header | Specifies the header text to put on the signature widget. |
| widget_hide_default_text | Switches off the generation of any headers for the signature widget. |
| widget_ignore_existing_appearance | Tells the class to discard any existing widget parameters when signing empty signature properties. |
| widget_invert_mask | Specifies whether BackgroundMask should be inverted. |
| widget_invisible | Controls whether the signature widget is visible on the page. |
| widget_pages_to_place_on | The page numbers on which the signature is shown. |
| widget_position_anchor | The anchor to bind the position of the widget to. |
| widget_render_options | This setting is a container for a selection of rendering options. |
| widget_rotate | Specifies the rotation angle of the signature widget in degrees. |
| widget_show_date | Whether to display the signing date and time details on the widget. |
| widget_show_visual_status | Specifies whether to show the signature's status icon. |
| widget_signer_caption | Specifies the caption for the signer section on the signature widget. |
| widget_signer_info | Provides custom signer information to put on the signature widget. |
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_widget_custom_data | Adds a custom data to the signature widget. |
| add_widget_text | Adds a text block to the signature widget. |
| add_widget_text_ex | Adds a text block to the signature widget. |
| attach_bytes | Adds an attachment to the PDF document. |
| attach_file | Adds an attachment to the PDF document. |
| close | Closes an opened document. |
| config | Sets or retrieves a configuration setting. |
| do_action | Performs an additional action. |
| extract_async_data | Extracts user data from the DC signing service response. |
| get_attached_bytes | Saves a PDF attachment to a byte array. |
| get_attached_file | Saves a PDF attachment to a file. |
| open | Opens a document for signing or updating. |
| reset | Resets the class settings. |
| revalidate | Revalidates a signature in accordance with current settings. |
| select_info | Select signature information for a specific entity. |
| sign | Signs a PDF document. |
| sign_async_begin | Initiates the asynchronous signing operation. |
| sign_async_end | Completes the asynchronous signing operation. |
| sign_external | Signs the document using an external signing facility. |
| update | Updates a 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_element_download | Fires when there is a need to download a chain element from an online source. |
| on_chain_element_needed | Fires when an element required to validate the chain was not located. |
| on_chain_validated | Reports the completion of a certificate chain validation. |
| on_chain_validation_progress | This event is fired multiple times during chain validation to report various stages of the validation procedure. |
| on_document_loaded | This event is fired when the document has been loaded into memory. |
| on_encrypted | Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document. |
| on_error | Information about errors during signing/validation. |
| on_external_decrypt | Handles remote or external decryption. |
| on_external_sign | Handles remote or external signing initiated by the SignExternal method or other source. |
| on_notification | This event notifies the application about an underlying control flow event. |
| on_pre_render_widget | Fires when a signature widget is ready to be written to the document. |
| on_signature_found | Signifies the start of signature validation. |
| on_signature_validated | Marks the completion of the signature validation routine. |
| on_timestamp_found | Signifies the start of a timestamp validation routine. |
| on_timestamp_request | Fires when the class is ready to request a timestamp from an external TSA. |
| on_timestamp_validated | Reports the completion of the timestamp validation routine. |
| on_tls_cert_needed | Fires when a remote TLS party requests a client certificate. |
| on_tls_cert_validate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| on_tls_established | Fires when a TLS handshake with Host successfully completes. |
| on_tls_handshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
| on_tls_shutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| AddOutputIntents | Specifies output intents to be added to the document. |
| AlternateName | TBD. |
| AssemblyOptions | Specifies the assembly options. |
| AsyncDocumentID | Specifies the document ID for SignAsyncEnd() call. |
| AutoCollectRevocationInfo | Whether revocation info should be collected automatically. |
| AutoReshapeArabicSymbols | Specifies whether to auto-reshape Arabic symbols. |
| AutoReverseRTLText | Specifies whether to auto reverse RTL text. |
| AutoRotateSignature | Specifies whether to auto-rotate the signature widget. |
| BackgroundImageBitsPerComponent | Specifies the number of bits per color class. |
| BackgroundImageColorSpace | Specifies the background image color space. |
| BackgroundImageInterpolate | Specifies the background image interpolation flag. |
| BackgroundMaskImageBitsPerComponent | TBD. |
| BackgroundMaskImageColorSpace | TBD. |
| BackgroundMaskImageInterpolate | TBD. |
| BackgroundPosition | TBD. |
| BuildApplicationName | Specifies the application name used to create the signature. |
| BuildApplicationVersion | Specifies the application version used to create the signature. |
| BuildProperties | Specifies the build properties of the signature. |
| CachedCRLOverlapTime | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. |
| CachedOCSPResponseOverlapTime | Specifies the time period before a cached OCSP Response's NextUpdate when it is considered stale and must be refreshed. |
| ChainCurrentCACert | Returns the current CA certificate. |
| ChainCurrentCert | Returns the certificate that is currently being validated. |
| ChainCurrentCRL | Returns the current CRL. |
| ChainCurrentCRLSize | Returns the size of the current CRL. |
| ChainCurrentOCSP | Returns the current OCSP response. |
| ChainCurrentOCSPSigner | Returns the signer of the current OCSP object. |
| ChainInterimDetails | Returns the current interim validation details. |
| ChainInterimResult | Returns the current interim validation result. |
| CheckValidityPeriodForTrusted | Whether to check validity period for trusted certificates. |
| CollectRevInfoForTimestamps | Whether revocation info for timestamps should be collected automatically. |
| Commitments | TBD. |
| ConfigPreferLegacyLevels | Indicates whether legacy signature levels should be preferred. |
| CustomSignedAttributes | TBD. |
| CustomTextCount | 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] | The horizontal font size scale. |
| CustomTextFontSizeY[Index] | The vertical font size scale. |
| CustomTextText[Index] | A text to show on a custom signature widget text block. |
| CustomTextX[Index] | The horizontal offset of the text block. |
| CustomTextY[Index] | The vertical offset of the text block. |
| CustomTrustedLists | Specifies the custom TrustedLists. |
| CustomTSLs | Specifies the custom TrustedLists. |
| CustomUnsignedAttributes | TBD. |
| DateFontSize | The font size of the date/time text on the signature widget. |
| DeepValidation | Whether a complete validation should be performed. |
| DislikeOpenEndedOCSPs | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. |
| DocumentVersion | The document version from the PDF document header. |
| DTSAccuracy | TBD. |
| DTSSerialNumber | TBD. |
| DTSTime | TBD. |
| DTSTSAName | TBD. |
| EmptyFullFieldName | Specifies the full name of the empty signature field to sign. |
| EmptySignatureFieldAddRevInfo[Index] | Specifies if revocation checking should be performed. |
| EmptySignatureFieldAlternateName[Index] | Contains an alternate field name. |
| EmptySignatureFieldCount | The number of empty signature form fields. |
| EmptySignatureFieldFlags[Index] | The field flags of the signature form field. |
| EmptySignatureFieldHeight[Index] | The Height of the empty signature form field. |
| EmptySignatureFieldInvisible[Index] | The visibility status of the field. |
| EmptySignatureFieldLegalAttestations[Index] | Specifies the legal attestations that are associated with the signature. |
| EmptySignatureFieldMappingName[Index] | The mapping name to be used when exporting form field data from the document. |
| EmptySignatureFieldName[Index] | Textual field name. |
| EmptySignatureFieldOffsetX[Index] | The field's offset from the left page border. |
| EmptySignatureFieldOffsetY[Index] | The field's offset from the bottom page border. |
| EmptySignatureFieldPage[Index] | The index of the form field's page in the document. |
| EmptySignatureFieldRequiredAllowedChanges[Index] | Specifies the changes allowed by the signature. |
| EmptySignatureFieldRequiredConstraints[Index] | Specifies the required Seed Value Dictionary (SVD) constraints. |
| EmptySignatureFieldRequiredDigestAlgorithms[Index] | Specifies the required digest algorithms. |
| EmptySignatureFieldRequiredFilter[Index] | Specifies the required filter. |
| EmptySignatureFieldRequiredLockAction[Index] | Indicates which set of fields shall be locked. |
| EmptySignatureFieldRequiredLockFields[Index] | Indicates the fields that shall be locked on signing. |
| EmptySignatureFieldRequiredReasons[Index] | Specifies the required reasons. |
| EmptySignatureFieldRequiredSubfilters[Index] | Specifies the required subfilters. |
| EmptySignatureFieldTimestampRequired[Index] | Specifies if the signature should be timestamped. |
| EmptySignatureFieldTSPURL[Index] | URL for a TSP server. |
| EmptySignatureFieldWidth[Index] | The Width of the empty signature form field. |
| EnableOldSignatures | Enables support for prehistoric adbe.x509.sha1 signatures. |
| EncryptionHandlerName | Specifies the custom security handler PDF-name. |
| ExtensionIdentifierMode | Specifies the extension identifier mode. |
| ExtraSpace | Allows for the allocation of extra zero character space in the document behind the signature. |
| FontPaths | Specifies font search paths. |
| ForceCompleteChainValidation | Whether to check the CA certificates when the signing certificate is invalid. |
| ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| GracePeriod | Specifies a grace period to apply during revocation information checks. |
| HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
| IgnoreChainLoops | Whether chain loops should be ignored. |
| IgnoreChainValidationErrors | Whether to ignore any certificate chain validation issues. |
| IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| IgnoreTimestampChainValidityForLevelDetection | Specify whether timestamp chain validity should be ignored during signature level detection. |
| IgnoreTimestampFailure | Whether to ignore timestamping failures during signing. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| IncludeKnownRevInfoToSignature | Whether to include custom revocation info into the signature. |
| IncludeKnownRevocationInfoToSignature | Whether to include custom revocation info into the signature. |
| IncludeRevocationInfo | Whether to include custom revocation info into the signature. |
| IncludeRevocationInfoToAdbeAttribute | Whether to save revocation info in PDF-compliant form. |
| LastSignatureWidget | Specifies that it is the last signature widget to be added. |
| Locked | TBD. |
| LockedContents | TBD. |
| MappingName | TBD. |
| MDPHashAlgorithm | Specifies the MDP hash algorithm. |
| NewCustomSignedAttributes | TBD. |
| NewCustomUnsignedAttributes | TBD. |
| PAdESOptions | Specifies the PAdES options. |
| PageInfoCount | The number of pages. |
| PageInfoCropBoxEmpty[Index] | Check if the page's crop box is empty or not. |
| PageInfoCropLLX[Index] | Defines the X coordinate of the lower left corner of the crop box. |
| PageInfoCropLLY[Index] | Defines the Y coordinate of the lower left corner of the crop box. |
| PageInfoCropURX[Index] | Defines the X coordinate of the upper right corner of the crop box. |
| PageInfoCropURY[Index] | Defines the Y coordinate of the upper right corner of the crop box. |
| PageInfoHeight[Index] | The Height of the page. |
| PageInfoMediaLLX[Index] | Defines the X coordinate of the lower left corner of the media box. |
| PageInfoMediaLLY[Index] | Defines the Y coordinate of the lower left corner of the media box. |
| PageInfoMediaURX[Index] | Defines the X coordinate of the upper right corner of the media box. |
| PageInfoMediaURY[Index] | Defines the Y coordinate of the upper right corner of the media box. |
| PageInfoRotate[Index] | The Rotate value of the page. |
| PageInfoUserUnit[Index] | Defines the size of default user space units. |
| PageInfoWidth[Index] | The Width of the page. |
| PolicyDescription | signature policy description. |
| PolicyExplicitText | The explicit text of the user notice. |
| PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
| PredefinedSignatureSize | User-defined size of the signature. |
| ProductionPlace | Identifies the place of the signature production. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| PSSUsed | Whether to use RSASSA-PSS algorithm. |
| RC4KeyBits | Specifies the number of key bits used for the RC4 algorithm. |
| ReassembleMode | Specifies the document reassemble mode. |
| SchemeParams | The algorithm scheme parameters to employ. |
| SectionTextFontSize | The font size of general text on the signature widget. |
| SectionTitleFontSize | The font size of the section title on the signature widget. |
| SignatureOptions | Specifies the signature options. |
| SignatureSizeEstimationStrategy | Which mechanism to use to estimate the size of a PAdES signature. |
| SigPolicyDescription | signature policy description. |
| SigPolicyExplicitText | The explicit text of the user notice. |
| SigPolicyHash | The EPES policy hash. |
| SigPolicyHashAlgorithm | The hash algorithm that was used to generate the EPES policy hash. |
| SigPolicyID | The EPES policy ID. |
| SigPolicyNoticeNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
| SigPolicyURI | The EPES policy URI. |
| TempPath | Path for storing temporary files. |
| TextObjEncoding | The encoding to apply to string objects stored with the signature. |
| TimestampResponse | A base16-encoded timestamp response received from a TSA. |
| TitleFontSize | The font size of the main title on the signature widget. |
| TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
| TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
| TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
| TLSValidationLog | Contains the log of the TLS server certificate validation. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| TransparentColor | TBD. |
| TransparentColorDelta | TBD. |
| TransparentColorX | TBD. |
| TransparentColorY | TBD. |
| TspAttemptCount | Specifies the number of timestamping request attempts. |
| TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
| TspReqPolicy | Sets a request policy ID to include in the timestamping request. |
| UpdateKind | Adjusts the scope of modifications that are made to the signature with the Update method. |
| UseDefaultTrustedLists | Enables or disables the use of the default TrustedLists. |
| UseDefaultTSLs | Enables or disables the use of the default TrustedLists. |
| UseLegacyVisualStyle | Specifies whether to use the legacy signature visual style. |
| UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| UsePSS | Whether to use RSASSA-PSS algorithm. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
| UseValidatorSettingsForTLSValidation | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. |
| WidgetHeight | Specifies the height of the signature widget. |
| WidgetOffsetX | Specifies the signature widget offset from the left-hand page border. |
| WidgetOffsetY | Specifies the signature widget offset from the bottom page border. |
| WidgetWidth | Specifies the width of the signature widget. |
| XMPMetadataContent | The XMP metadata content. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
attached_file_count Property
The number of records in the AttachedFiles arrays.
Syntax
def get_attached_file_count() -> int: ...
attached_file_count = property(get_attached_file_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- attached_files_content_subtype
- attached_files_content_type
- attached_files_creation_date
- attached_files_data
- attached_files_description
- attached_files_file_name
- attached_files_handle
- attached_files_id
- attached_files_modification_date
- attached_files_read_date
- attached_files_size
This property is read-only.
attached_files_content_subtype Property
Contains the content subtype of the attachment.
Syntax
def get_attached_files_content_subtype(attached_file_index: int) -> str: ...
Default Value
""
Remarks
Contains the content subtype of the attachment.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_content_type Property
Contains the content type of the attachment.
Syntax
def get_attached_files_content_type(attached_file_index: int) -> str: ...
Default Value
""
Remarks
Contains the content type of the attachment.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_creation_date Property
The creation date.
Syntax
def get_attached_files_creation_date(attached_file_index: int) -> str: ...
Default Value
""
Remarks
The creation date.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_data Property
The content of the attachment.
Syntax
def get_attached_files_data(attached_file_index: int) -> bytes: ...
Remarks
The content of the attachment.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_description Property
Textual description of the attachment.
Syntax
def get_attached_files_description(attached_file_index: int) -> str: ...
Default Value
""
Remarks
Textual description of the attachment.
This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_file_name Property
Specifies the name of the attachment file.
Syntax
def get_attached_files_file_name(attached_file_index: int) -> str: ...
Default Value
""
Remarks
Specifies the name of the attachment file.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_attached_files_handle(attached_file_index: int) -> int: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_id Property
Contains the attachment's unique identifier.
Syntax
def get_attached_files_id(attached_file_index: int) -> str: ...
Default Value
""
Remarks
Contains the attachment's unique identifier.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_modification_date Property
Specifies the date and time of the file's last modification.
Syntax
def get_attached_files_modification_date(attached_file_index: int) -> str: ...
Default Value
""
Remarks
Specifies the date and time of the file's last modification.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_read_date Property
Specifies the file's last read date.
Syntax
def get_attached_files_read_date(attached_file_index: int) -> str: ...
Default Value
""
Remarks
Specifies the file's last read date.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
attached_files_size Property
The attachment's size in bytes.
Syntax
def get_attached_files_size(attached_file_index: int) -> int: ...
Default Value
0
Remarks
The attachment's size in bytes.
The attached_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the attached_file_count property.
This property is read-only.
auto_validate_signatures Property
Specifies whether PDFSigner should validate any present signatures when the document is opened.
Syntax
def get_auto_validate_signatures() -> bool: ... def set_auto_validate_signatures(value: bool) -> None: ...
auto_validate_signatures = property(get_auto_validate_signatures, set_auto_validate_signatures)
Default Value
FALSE
Remarks
This setting is switched off by default to speed up document processing. Even if the document is loaded with this property set to false, you can validate the signatures manually on a later stage using the revalidate method.
blocked_cert_count Property
The number of records in the BlockedCert arrays.
Syntax
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:
The array indices start at 0 and end at blocked_cert_count - 1.blocked_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_blocked_cert_bytes(blocked_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The blocked_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the blocked_cert_count property.
This property is read-only.
blocked_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_blocked_cert_handle(blocked_cert_index: int) -> int: ... def set_blocked_cert_handle(blocked_cert_index: int, value: int) -> None: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The blocked_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the blocked_cert_count property.
cert_count Property
The number of records in the Cert arrays.
Syntax
def get_cert_count() -> int: ...
cert_count = property(get_cert_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- cert_bytes
- cert_ca
- cert_ca_key_id
- cert_cert_type
- cert_crl_distribution_points
- cert_curve
- cert_fingerprint
- cert_friendly_name
- cert_handle
- cert_hash_algorithm
- cert_issuer
- cert_issuer_rdn
- cert_key_algorithm
- cert_key_bits
- cert_key_fingerprint
- cert_key_usage
- cert_key_valid
- cert_ocsp_locations
- cert_ocsp_no_check
- cert_origin
- cert_policy_i_ds
- cert_private_key_bytes
- cert_private_key_exists
- cert_private_key_extractable
- cert_public_key_bytes
- cert_qualified
- cert_qualified_statements
- cert_qualifiers
- cert_self_signed
- cert_serial_number
- cert_sig_algorithm
- cert_source
- cert_subject
- cert_subject_alternative_name
- cert_subject_key_id
- cert_subject_rdn
- cert_valid
- cert_valid_from
- cert_valid_to
This property is read-only.
cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_cert_bytes(cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_ca Property
Indicates whether the certificate has a CA capability.
Syntax
def get_cert_ca(cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_ca_key_id Property
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Syntax
def get_cert_ca_key_id(cert_index: int) -> bytes: ...
Remarks
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_cert_type Property
Returns the type of the entity contained in the Certificate object.
Syntax
def get_cert_cert_type(cert_index: int) -> int: ...
Default Value
0
Remarks
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_crl_distribution_points Property
Contains a list of locations of CRL distribution points used to check this certificate's validity.
Syntax
def get_cert_crl_distribution_points(cert_index: int) -> str: ...
Default Value
""
Remarks
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_curve Property
Specifies the elliptic curve associated with the certificate's public key.
Syntax
def get_cert_curve(cert_index: int) -> str: ...
Default Value
""
Remarks
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_fingerprint Property
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
def get_cert_fingerprint(cert_index: int) -> str: ...
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_friendly_name Property
Contains an associated alias (friendly name) of the certificate.
Syntax
def get_cert_friendly_name(cert_index: int) -> str: ...
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_cert_handle(cert_index: int) -> int: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_hash_algorithm Property
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
Syntax
def get_cert_hash_algorithm(cert_index: int) -> str: ...
Default Value
""
Remarks
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_issuer Property
The common name of the certificate issuer (CA), typically a company name.
Syntax
def get_cert_issuer(cert_index: int) -> str: ...
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via cert_issuer_rdn.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_issuer_rdn Property
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
def get_cert_issuer_rdn(cert_index: int) -> str: ...
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_key_algorithm Property
Specifies the public key algorithm of this certificate.
Syntax
def get_cert_key_algorithm(cert_index: int) -> str: ...
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the cert_key_bits, cert_curve, and cert_public_key_bytes properties to get more details about the key the certificate contains.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_key_bits Property
Returns the length of the public key in bits.
Syntax
def get_cert_key_bits(cert_index: int) -> int: ...
Default Value
0
Remarks
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the cert_public_key_bytes or cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_key_fingerprint Property
Returns a SHA1 fingerprint of the public key contained in the certificate.
Syntax
def get_cert_key_fingerprint(cert_index: int) -> str: ...
Default Value
""
Remarks
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the cert_fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_key_usage Property
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
def get_cert_key_usage(cert_index: int) -> int: ...
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this property before generating the certificate to propagate the key usage flags to the new certificate.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_key_valid Property
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
def get_cert_key_valid(cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_ocsp_locations Property
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Syntax
def get_cert_ocsp_locations(cert_index: int) -> str: ...
Default Value
""
Remarks
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this property before calling the certificate manager's generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_ocsp_no_check Property
Accessor to the value of the certificate's ocsp-no-check extension.
Syntax
def get_cert_ocsp_no_check(cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Accessor to the value of the certificate's ocsp-no-check extension.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_origin Property
Returns the location that the certificate was taken or loaded from.
Syntax
def get_cert_origin(cert_index: int) -> int: ...
Default Value
0
Remarks
Returns the location that the certificate was taken or loaded from.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_policy_i_ds Property
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
def get_cert_policy_i_ds(cert_index: int) -> str: ...
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this property when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_private_key_bytes Property
Returns the certificate's private key in DER-encoded format.
Syntax
def get_cert_private_key_bytes(cert_index: int) -> bytes: ...
Remarks
Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_private_key_exists Property
Indicates whether the certificate has a usable private key associated with it.
Syntax
def get_cert_private_key_exists(cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This property is independent from cert_private_key_bytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_private_key_extractable Property
Indicates whether the private key is extractable (exportable).
Syntax
def get_cert_private_key_extractable(cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the private key is extractable (exportable).
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_public_key_bytes Property
Contains the certificate's public key in DER format.
Syntax
def get_cert_public_key_bytes(cert_index: int) -> bytes: ...
Remarks
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_qualified Property
Indicates whether the certificate is qualified.
Syntax
def get_cert_qualified(cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_qualified_statements Property
Returns a simplified qualified status of the certificate.
Syntax
def get_cert_qualified_statements(cert_index: int) -> int: ...
Default Value
0
Remarks
Returns a simplified qualified status of the certificate.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_qualifiers Property
A list of qualifiers.
Syntax
def get_cert_qualifiers(cert_index: int) -> str: ...
Default Value
""
Remarks
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_self_signed Property
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
def get_cert_self_signed(cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_serial_number Property
Returns the certificate's serial number.
Syntax
def get_cert_serial_number(cert_index: int) -> bytes: ...
Remarks
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_sig_algorithm Property
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
def get_cert_sig_algorithm(cert_index: int) -> str: ...
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_source Property
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
def get_cert_source(cert_index: int) -> int: ...
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_subject Property
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
def get_cert_subject(cert_index: int) -> str: ...
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via cert_subject_rdn.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_subject_alternative_name Property
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
def get_cert_subject_alternative_name(cert_index: int) -> str: ...
Default Value
""
Remarks
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main cert_subject_rdn field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_subject_key_id Property
Contains a unique identifier of the certificate's cryptographic key.
Syntax
def get_cert_subject_key_id(cert_index: int) -> bytes: ...
Remarks
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The cert_subject_key_id and cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_subject_rdn Property
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
def get_cert_subject_rdn(cert_index: int) -> str: ...
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_valid Property
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
Syntax
def get_cert_valid(cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_valid_from Property
The time point at which the certificate becomes valid, in UTC.
Syntax
def get_cert_valid_from(cert_index: int) -> str: ...
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_valid_to Property
The time point at which the certificate expires, in UTC.
Syntax
def get_cert_valid_to(cert_index: int) -> str: ...
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
check_trusted_lists Property
Specifies whether the class should attempt to validate chain trust via a known Trusted List.
Syntax
def get_check_trusted_lists() -> bool: ... def set_check_trusted_lists(value: bool) -> None: ...
check_trusted_lists = property(get_check_trusted_lists, set_check_trusted_lists)
Default Value
FALSE
Remarks
Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).
crl_count Property
The number of records in the CRL arrays.
Syntax
def get_crl_count() -> int: ...
crl_count = property(get_crl_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- crl_bytes
- crlca_key_id
- crl_entry_count
- crl_handle
- crl_issuer
- crl_issuer_rdn
- crl_location
- crl_next_update
- crl_sig_algorithm
- crl_source
- crltbs
- crl_this_update
This property is read-only.
crl_bytes Property
Returns the raw CRL data in DER format.
Syntax
def get_crl_bytes(crl_index: int) -> bytes: ...
Remarks
Returns the raw CRL data in DER format.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crlca_key_id Property
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
Syntax
def get_crlca_key_id(crl_index: int) -> bytes: ...
Remarks
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crl_entry_count Property
Returns the number of certificate status entries in the CRL.
Syntax
def get_crl_entry_count(crl_index: int) -> int: ...
Default Value
0
Remarks
Returns the number of certificate status entries in the CRL.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crl_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_crl_handle(crl_index: int) -> int: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crl_issuer Property
The common name of the CRL issuer (CA), typically a company name.
Syntax
def get_crl_issuer(crl_index: int) -> str: ...
Default Value
""
Remarks
The common name of the CRL issuer (CA), typically a company name.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crl_issuer_rdn Property
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Syntax
def get_crl_issuer_rdn(crl_index: int) -> str: ...
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crl_location Property
The URL that the CRL was downloaded from.
Syntax
def get_crl_location(crl_index: int) -> str: ...
Default Value
""
Remarks
The URL that the CRL was downloaded from.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crl_next_update Property
The planned time and date of the next version of this CRL to be published.
Syntax
def get_crl_next_update(crl_index: int) -> str: ...
Default Value
""
Remarks
The planned time and date of the next version of this CRL to be published.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crl_sig_algorithm Property
The public key algorithm that was used by the CA to sign this CRL.
Syntax
def get_crl_sig_algorithm(crl_index: int) -> str: ...
Default Value
"0"
Remarks
The public key algorithm that was used by the CA to sign this CRL.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crl_source Property
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
def get_crl_source(crl_index: int) -> int: ...
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crltbs Property
The to-be-signed part of the CRL (the CRL without the signature part).
Syntax
def get_crltbs(crl_index: int) -> bytes: ...
Remarks
The to-be-signed part of the CRL (the CRL without the signature part).
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
crl_this_update Property
The date and time at which this version of the CRL was published.
Syntax
def get_crl_this_update(crl_index: int) -> str: ...
Default Value
""
Remarks
The date and time at which this version of the CRL was published.
The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.
This property is read-only.
decryption_certificate_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_decryption_certificate_bytes() -> bytes: ...
decryption_certificate_bytes = property(get_decryption_certificate_bytes, None)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
decryption_certificate_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_decryption_certificate_handle() -> int: ... def set_decryption_certificate_handle(value: int) -> None: ...
decryption_certificate_handle = property(get_decryption_certificate_handle, set_decryption_certificate_handle)
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
document_info_encryption_algorithm Property
The symmetric algorithm used to encrypt the document.
Syntax
def get_document_info_encryption_algorithm() -> str: ...
document_info_encryption_algorithm = property(get_document_info_encryption_algorithm, None)
Default Value
""
Remarks
The symmetric algorithm used to encrypt the document.
This property contains the encryption algorithm that was used to encrypt the PDF document.
Supported values:
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |
This property is read-only.
document_info_encryption_type Property
The document encryption type.
Syntax
def get_document_info_encryption_type() -> int: ...
document_info_encryption_type = property(get_document_info_encryption_type, None)
Default Value
1
Remarks
The document encryption type.
This property indicates the kind of encryption that was used to encrypt the PDF document.
Supported values:
| petPassword | 1 | The document is encrypted with a password. |
| petCertificate | 2 | The document is encrypted with a certificate (or many certificates). |
This property is read-only.
document_info_metadata_encrypted Property
Indicates if the document metadata is encrypted.
Syntax
def get_document_info_metadata_encrypted() -> bool: ...
document_info_metadata_encrypted = property(get_document_info_metadata_encrypted, None)
Default Value
TRUE
Remarks
Indicates if the document metadata is encrypted.
Use this property to check if the document metadata is encrypted.
Metadata contains additional information about the document such as its name and author.
This property is read-only.
document_info_permissions Property
Contains the document permissions associated with the encryption.
Syntax
def get_document_info_permissions() -> int: ...
document_info_permissions = property(get_document_info_permissions, None)
Default Value
0
Remarks
Contains the document permissions associated with the encryption.
Use this property to check the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents. Contains a bit mask of the following flags:
| pepAnnotations | 0x0001 | Annotating is allowed |
| pepAssemble | 0x0002 | Assembling a new document on the basis of the processed one is allowed |
| pepExtract | 0x0004 | Extraction/copying of the pictures and text from the document is allowed |
| pepExtractAcc | 0x0008 | Content extraction is allowed for accessibility purposes only |
| pepFillInForms | 0x0010 | Filling forms in is allowed |
| pepHighQualityPrint | 0x0020 | High quality printing is allowed |
| pepLowQualityPrint | 0x0040 | Low quality printing is allowed |
| pepModify | 0x0080 | Modifications are allowed |
This property is read-only.
empty_field_index Property
Specifies the index of the empty signature field to sign.
Syntax
def get_empty_field_index() -> int: ... def set_empty_field_index(value: int) -> None: ...
empty_field_index = property(get_empty_field_index, set_empty_field_index)
Default Value
-1
Remarks
Use this property to specify the empty form field that should be signed. If the default value of -1 is assigned to this property, a new signature field will be created.
external_crypto_async_document_id Property
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Syntax
def get_external_crypto_async_document_id() -> str: ... def set_external_crypto_async_document_id(value: str) -> None: ...
external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)
Default Value
""
Remarks
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
external_crypto_custom_params Property
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
def get_external_crypto_custom_params() -> str: ... def set_external_crypto_custom_params(value: str) -> None: ...
external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
external_crypto_data Property
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
def get_external_crypto_data() -> str: ... def set_external_crypto_data(value: str) -> None: ...
external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculation Property
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
def get_external_crypto_external_hash_calculation() -> bool: ... def set_external_crypto_external_hash_calculation(value: bool) -> None: ...
external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)
Default Value
FALSE
Remarks
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.
If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
external_crypto_hash_algorithm Property
Specifies the request's signature hash algorithm.
Syntax
def get_external_crypto_hash_algorithm() -> str: ... def set_external_crypto_hash_algorithm(value: str) -> None: ...
external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)
Default Value
"SHA256"
Remarks
Specifies the request's signature hash algorithm.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
external_crypto_key_id Property
The ID of the pre-shared key used for DC request authentication.
Syntax
def get_external_crypto_key_id() -> str: ... def set_external_crypto_key_id(value: str) -> None: ...
external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)
Default Value
""
Remarks
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
external_crypto_key_secret Property
The pre-shared key used for DC request authentication.
Syntax
def get_external_crypto_key_secret() -> str: ... def set_external_crypto_key_secret(value: str) -> None: ...
external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)
Default Value
""
Remarks
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the external_crypto_key_id topic.
external_crypto_method Property
Specifies the asynchronous signing method.
Syntax
def get_external_crypto_method() -> int: ... def set_external_crypto_method(value: int) -> None: ...
external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |
external_crypto_mode Property
Specifies the external cryptography mode.
Syntax
def get_external_crypto_mode() -> int: ... def set_external_crypto_mode(value: int) -> None: ...
external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode)
Default Value
0
Remarks
Specifies the external cryptography mode.
Available options:
| ecmDefault | The default value (0) |
| ecmDisabled | Do not use DC or external signing (1) |
| ecmGeneric | Generic external signing with the OnExternalSign event (2) |
| ecmDCAuth | DCAuth signing (3) |
| ecmDCAuthJSON | DCAuth signing in JSON format (4) |
external_crypto_public_key_algorithm Property
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
def get_external_crypto_public_key_algorithm() -> str: ... def set_external_crypto_public_key_algorithm(value: str) -> None: ...
external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)
Default Value
""
Remarks
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
fips_mode Property
Reserved.
Syntax
def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ...
fips_mode = property(get_fips_mode, set_fips_mode)
Default Value
FALSE
Remarks
This property is reserved for future use.
ignore_chain_validation_errors Property
Makes the class tolerant to chain validation errors.
Syntax
def get_ignore_chain_validation_errors() -> bool: ... def set_ignore_chain_validation_errors(value: bool) -> None: ...
ignore_chain_validation_errors = property(get_ignore_chain_validation_errors, set_ignore_chain_validation_errors)
Default Value
FALSE
Remarks
If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.
input_bytes Property
Use this property to pass the input to class in byte array form.
Syntax
def get_input_bytes() -> bytes: ... def set_input_bytes(value: bytes) -> None: ...
input_bytes = property(get_input_bytes, set_input_bytes)
Remarks
Assign a byte array containing the data to be processed to this property.
input_file Property
The PDF file to be signed or updated.
Syntax
def get_input_file() -> str: ... def set_input_file(value: str) -> None: ...
input_file = property(get_input_file, set_input_file)
Default Value
""
Remarks
Use this property to provide a path to the PDF document to be signed or updated, or to the pre-signed copy expected by sign_async_end.
known_cert_count Property
The number of records in the KnownCert arrays.
Syntax
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:
The array indices start at 0 and end at known_cert_count - 1.known_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_known_cert_bytes(known_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The known_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_cert_count property.
This property is read-only.
known_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_known_cert_handle(known_cert_index: int) -> int: ... def set_known_cert_handle(known_cert_index: int, value: int) -> None: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The known_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_cert_count property.
known_crl_count Property
The number of records in the KnownCRL arrays.
Syntax
def get_known_crl_count() -> int: ... def set_known_crl_count(value: int) -> None: ...
known_crl_count = property(get_known_crl_count, set_known_crl_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at known_crl_count - 1.known_crl_bytes Property
Returns the raw CRL data in DER format.
Syntax
def get_known_crl_bytes(known_crl_index: int) -> bytes: ...
Remarks
Returns the raw CRL data in DER format.
The known_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_crl_count property.
This property is read-only.
known_crl_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_known_crl_handle(known_crl_index: int) -> int: ... def set_known_crl_handle(known_crl_index: int, value: int) -> None: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The known_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_crl_count property.
known_ocsp_count Property
The number of records in the KnownOCSP arrays.
Syntax
def get_known_ocsp_count() -> int: ... def set_known_ocsp_count(value: int) -> None: ...
known_ocsp_count = property(get_known_ocsp_count, set_known_ocsp_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at known_ocsp_count - 1.known_ocsp_bytes Property
A buffer containing the raw OCSP response data.
Syntax
def get_known_ocsp_bytes(known_ocsp_index: int) -> bytes: ...
Remarks
A buffer containing the raw OCSP response data.
The known_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_ocsp_count property.
This property is read-only.
known_ocsp_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_known_ocsp_handle(known_ocsp_index: int) -> int: ... def set_known_ocsp_handle(known_ocsp_index: int, value: int) -> None: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The known_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_ocsp_count property.
new_sig_allowed_changes Property
The changes to the document allowed by the signature.
Syntax
def get_new_sig_allowed_changes() -> int: ... def set_new_sig_allowed_changes(value: int) -> None: ...
new_sig_allowed_changes = property(get_new_sig_allowed_changes, set_new_sig_allowed_changes)
Default Value
0
Remarks
The changes to the document allowed by the signature.
This property is only applicable to MDP/certification signatures and has no effect for any other kinds of signatures (regular or document timestamps).
| psacNone | 0 | No changes are allowed by the signature |
| psacFillInForms | 1 | Only form fill-in is allowed |
| psacComment | 2 | Commenting is allowed |
| psacAll | 3 | Form fill-in and commenting are allowed |
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_author_name Property
A human-readable signer name.
Syntax
def get_new_sig_author_name() -> str: ... def set_new_sig_author_name(value: str) -> None: ...
new_sig_author_name = property(get_new_sig_author_name, set_new_sig_author_name)
Default Value
""
Remarks
A human-readable signer name. This is a PDF document property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_certification Property
Specifies whether this is a Certification (MDP) signature.
Syntax
def get_new_sig_certification() -> bool: ... def set_new_sig_certification(value: bool) -> None: ...
new_sig_certification = property(get_new_sig_certification, set_new_sig_certification)
Default Value
FALSE
Remarks
Specifies whether this is a Certification (MDP) signature.
Certification signatures are a feature used by earlier Acrobat versions. They have little use these days.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_chain_validation_details Property
The details of a certificate chain validation outcome.
Syntax
def get_new_sig_chain_validation_details() -> int: ...
new_sig_chain_validation_details = property(get_new_sig_chain_validation_details, None)
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_chain_validation_result Property
The outcome of a certificate chain validation routine.
Syntax
def get_new_sig_chain_validation_result() -> int: ...
new_sig_chain_validation_result = property(get_new_sig_chain_validation_result, None)
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_claimed_signing_time Property
Returns or sets the signature's creation time.
Syntax
def get_new_sig_claimed_signing_time() -> str: ... def set_new_sig_claimed_signing_time(value: str) -> None: ...
new_sig_claimed_signing_time = property(get_new_sig_claimed_signing_time, set_new_sig_claimed_signing_time)
Default Value
""
Remarks
Returns or sets the signature's creation time.
Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike new_sig_validated_signing_time, does not originate from a trusted TSA and may be forfeited or wrong.
The time is provided in UTC.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_compatibility_errors Property
Returns compatibility errors encountered during validation.
Syntax
def get_new_sig_compatibility_errors() -> int: ...
new_sig_compatibility_errors = property(get_new_sig_compatibility_errors, None)
Default Value
0
Remarks
Returns compatibility errors encountered during validation.
Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_contact_info Property
Contains the signer's contact information.
Syntax
def get_new_sig_contact_info() -> str: ... def set_new_sig_contact_info(value: str) -> None: ...
new_sig_contact_info = property(get_new_sig_contact_info, set_new_sig_contact_info)
Default Value
""
Remarks
Contains the signer's contact information. This is a PDF document property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_contains_long_term_info Property
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
Syntax
def get_new_sig_contains_long_term_info() -> bool: ...
new_sig_contains_long_term_info = property(get_new_sig_contains_long_term_info, None)
Default Value
FALSE
Remarks
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_coverage_ends_at Property
Indicates the offset in the PDF file where signature coverage ends.
Syntax
def get_new_sig_coverage_ends_at() -> int: ...
new_sig_coverage_ends_at = property(get_new_sig_coverage_ends_at, None)
Default Value
0
Remarks
Indicates the offset in the PDF file where signature coverage ends.
PDF generators often use incremental updates to make changes in the documents. This may result in the signature only covering a part of the document (one of the past revisions), but not the subsequent changes.
Use this property to identify the offset where the signature coverage ends. One option is to compare it to the length of the whole document. Alternatively, use the get_signed_version method of the PDFVerifier class to extract the exact revision that was signed.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_custom_data Property
Uninterpreted custom data to save with the signature.
Syntax
def get_new_sig_custom_data() -> bytes: ... def set_new_sig_custom_data(value: bytes) -> None: ...
new_sig_custom_data = property(get_new_sig_custom_data, set_new_sig_custom_data)
Remarks
Uninterpreted custom data to save with the signature.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_empty_field Property
Indicates whether or not the signature created/read is an empty property (a signature placeholder).
Syntax
def get_new_sig_empty_field() -> bool: ... def set_new_sig_empty_field(value: bool) -> None: ...
new_sig_empty_field = property(get_new_sig_empty_field, set_new_sig_empty_field)
Default Value
FALSE
Remarks
Indicates whether or not the signature created/read is an empty field (a signature placeholder).
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_entity_label Property
Use this property to get the signature entity label.
Syntax
def get_new_sig_entity_label() -> str: ...
new_sig_entity_label = property(get_new_sig_entity_label, None)
Default Value
""
Remarks
Use this property to get the signature entity label.
This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_filter_name Property
The signature filter name.
Syntax
def get_new_sig_filter_name() -> str: ... def set_new_sig_filter_name(value: str) -> None: ...
new_sig_filter_name = property(get_new_sig_filter_name, set_new_sig_filter_name)
Default Value
""
Remarks
The signature filter name.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_full_signature_name Property
Specifies the full name of the signature property.
Syntax
def get_new_sig_full_signature_name() -> str: ...
new_sig_full_signature_name = property(get_new_sig_full_signature_name, None)
Default Value
""
Remarks
Specifies the full name of the signature field.
This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_new_sig_handle() -> int: ... def set_new_sig_handle(value: int) -> None: ...
new_sig_handle = property(get_new_sig_handle, set_new_sig_handle)
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_hash_algorithm Property
Specifies the hash algorithm to be used for signing.
Syntax
def get_new_sig_hash_algorithm() -> str: ... def set_new_sig_hash_algorithm(value: str) -> None: ...
new_sig_hash_algorithm = property(get_new_sig_hash_algorithm, set_new_sig_hash_algorithm)
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used for signing.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_height Property
Specifies the height of the signature widget.
Syntax
def get_new_sig_height() -> int: ... def set_new_sig_height(value: int) -> None: ...
new_sig_height = property(get_new_sig_height, set_new_sig_height)
Default Value
0
Remarks
Specifies the height of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_issuer_rdn Property
The Relative Distinguished Name of the signing certificate's issuer.
Syntax
def get_new_sig_issuer_rdn() -> str: ...
new_sig_issuer_rdn = property(get_new_sig_issuer_rdn, None)
Default Value
""
Remarks
The Relative Distinguished Name of the signing certificate's issuer.
A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_level Property
Specifies the PAdES signature level.
Syntax
def get_new_sig_level() -> int: ... def set_new_sig_level(value: int) -> None: ...
new_sig_level = property(get_new_sig_level, set_new_sig_level)
Default Value
2
Remarks
Specifies the PAdES signature level.
PAdES standard defines a number of different 'levels' of signatures which can be used for different purposes.
Note that when validating a signature, the LTV modifier may be affected by the validation settings. These include OfflineMode (set it to true to obtain the clean LTV capability) and certificate caching (switch it off to stop earlier validations from affecting the current validation).
The supported levels are:
| paslUnknown | 0 | Unknown signature level |
| paslGeneric | 1 | Generic signature: Legacy Adobe signature (adbe.pkcs7.detached), corresponds to pstLegacy signature type |
| paslBaselineB | 2 | Baseline B (B-B, basic) |
| paslBaselineT | 3 | Baseline T (B-T, timestamped) |
| paslBaselineLT | 4 | Baseline LT (B-LT, long-term) |
| paslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) |
| paslBES | 6 | BES (Basic Electronic Signature) |
| paslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
| paslLTV | 8 | LTV (Electronic Signature with with revocation info) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_location Property
Specifies the host name or the physical location of the signing entity.
Syntax
def get_new_sig_location() -> str: ... def set_new_sig_location(value: str) -> None: ...
new_sig_location = property(get_new_sig_location, set_new_sig_location)
Default Value
""
Remarks
Specifies the host name or the physical location of the signing entity. This is a PDF property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_offset_x Property
Specifies the signature widget offset from the left-hand page border.
Syntax
def get_new_sig_offset_x() -> int: ... def set_new_sig_offset_x(value: int) -> None: ...
new_sig_offset_x = property(get_new_sig_offset_x, set_new_sig_offset_x)
Default Value
0
Remarks
Specifies the signature widget offset from the left-hand page border.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_offset_y Property
Specifies the signature widget offset from the bottom page border.
Syntax
def get_new_sig_offset_y() -> int: ... def set_new_sig_offset_y(value: int) -> None: ...
new_sig_offset_y = property(get_new_sig_offset_y, set_new_sig_offset_y)
Default Value
0
Remarks
Specifies the signature widget offset from the bottom page border.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_page Property
Indicates the index of the page on which the signature is placed.
Syntax
def get_new_sig_page() -> int: ...
new_sig_page = property(get_new_sig_page, None)
Default Value
-1
Remarks
Indicates the index of the page on which the signature is placed. The value "-1" indicates an invisible signature.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_policy_hash Property
The signature policy hash value for EPES signatures.
Syntax
def get_new_sig_policy_hash() -> str: ... def set_new_sig_policy_hash(value: str) -> None: ...
new_sig_policy_hash = property(get_new_sig_policy_hash, set_new_sig_policy_hash)
Default Value
""
Remarks
The signature policy hash value for EPES signatures.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_policy_hash_algorithm Property
The algorithm that was used to calculate the signature policy hash.
Syntax
def get_new_sig_policy_hash_algorithm() -> str: ... def set_new_sig_policy_hash_algorithm(value: str) -> None: ...
new_sig_policy_hash_algorithm = property(get_new_sig_policy_hash_algorithm, set_new_sig_policy_hash_algorithm)
Default Value
""
Remarks
The algorithm that was used to calculate the signature policy hash.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_policy_id Property
The policy ID to be included into the signature.
Syntax
def get_new_sig_policy_id() -> str: ... def set_new_sig_policy_id(value: str) -> None: ...
new_sig_policy_id = property(get_new_sig_policy_id, set_new_sig_policy_id)
Default Value
""
Remarks
The policy ID to be included into the signature.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_policy_uri Property
The signature policy URI that was included in the signature.
Syntax
def get_new_sig_policy_uri() -> str: ... def set_new_sig_policy_uri(value: str) -> None: ...
new_sig_policy_uri = property(get_new_sig_policy_uri, set_new_sig_policy_uri)
Default Value
""
Remarks
The signature policy URI that was included in the signature.
Use this property to set or retrieve the URI of the signature policy from EPES signatures.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_reason Property
Specifies the reason for signing.
Syntax
def get_new_sig_reason() -> str: ... def set_new_sig_reason(value: str) -> None: ...
new_sig_reason = property(get_new_sig_reason, set_new_sig_reason)
Default Value
""
Remarks
Specifies the reason for signing. This is a PDF document property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_serial_number Property
The serial number of the signing certificate.
Syntax
def get_new_sig_serial_number() -> bytes: ...
new_sig_serial_number = property(get_new_sig_serial_number, None)
Remarks
The serial number of the signing certificate.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_signature_bytes Property
Returns the binary representation of the underlying PKCS7 signature blob.
Syntax
def get_new_sig_signature_bytes() -> bytes: ...
new_sig_signature_bytes = property(get_new_sig_signature_bytes, None)
Remarks
Returns the binary representation of the underlying PKCS7 signature blob.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_signature_name Property
Specifies the unique signature identifier to use.
Syntax
def get_new_sig_signature_name() -> str: ... def set_new_sig_signature_name(value: str) -> None: ...
new_sig_signature_name = property(get_new_sig_signature_name, set_new_sig_signature_name)
Default Value
""
Remarks
Specifies the unique signature identifier to use.
This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_signature_type Property
The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.
Syntax
def get_new_sig_signature_type() -> int: ... def set_new_sig_signature_type(value: int) -> None: ...
new_sig_signature_type = property(get_new_sig_signature_type, set_new_sig_signature_type)
Default Value
2
Remarks
The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.
The supported values are:
| pstUnknown | 0 | Unknown signature type |
| pstLegacy | 1 | Legacy Adobe signature (adbe.pkcs7.detached or adbe.pkcs7.sha1) |
| pstPAdES | 2 | PAdES signature (ETSI.CAdES.detached), use Level field for detailed info |
| pstDocumentTimestamp | 3 | Document timestamp (ETSI.RFC3161) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
new_sig_signature_validation_result Property
The outcome of the cryptographic signature validation.
Syntax
def get_new_sig_signature_validation_result() -> int: ...
new_sig_signature_validation_result = property(get_new_sig_signature_validation_result, None)
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_subject_key_id Property
Contains the subject key identifier of the signing certificate.
Syntax
def get_new_sig_subject_key_id() -> bytes: ...
new_sig_subject_key_id = property(get_new_sig_subject_key_id, None)
Remarks
Contains the subject key identifier of the signing certificate.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_subject_rdn Property
Contains the RDN of the owner of the signing certificate.
Syntax
def get_new_sig_subject_rdn() -> str: ...
new_sig_subject_rdn = property(get_new_sig_subject_rdn, None)
Default Value
""
Remarks
Contains the RDN of the owner of the signing certificate.
RDN is a number of OID=Value pairs declared in the certificate that provide the owner's details.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_timestamped Property
Use this property to establish whether the signature contains an embedded timestamp.
Syntax
def get_new_sig_timestamped() -> bool: ...
new_sig_timestamped = property(get_new_sig_timestamped, None)
Default Value
FALSE
Remarks
Use this property to establish whether the signature contains an embedded timestamp.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_validated_signing_time Property
Contains the certified signing time.
Syntax
def get_new_sig_validated_signing_time() -> str: ...
new_sig_validated_signing_time = property(get_new_sig_validated_signing_time, None)
Default Value
""
Remarks
Contains the certified signing time.
Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.
new_sig_claimed_signing_time returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_validation_log Property
Contains the signing certificate's chain validation log.
Syntax
def get_new_sig_validation_log() -> str: ...
new_sig_validation_log = property(get_new_sig_validation_log, None)
Default Value
""
Remarks
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
This property is read-only.
new_sig_width Property
Specifies the width of the signature widget.
Syntax
def get_new_sig_width() -> int: ... def set_new_sig_width(value: int) -> None: ...
new_sig_width = property(get_new_sig_width, set_new_sig_width)
Default Value
0
Remarks
Specifies the width of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels.
The parameter specifies the index of the item in the array. The size of the array is controlled by the new_sig_count property.
ocsp_count Property
The number of records in the OCSP arrays.
Syntax
def get_ocsp_count() -> int: ...
ocsp_count = property(get_ocsp_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- ocsp_bytes
- ocsp_entry_count
- ocsp_handle
- ocsp_issuer
- ocsp_issuer_rdn
- ocsp_location
- ocsp_produced_at
- ocsp_sig_algorithm
- ocsp_source
This property is read-only.
ocsp_bytes Property
A buffer containing the raw OCSP response data.
Syntax
def get_ocsp_bytes(ocsp_index: int) -> bytes: ...
Remarks
A buffer containing the raw OCSP response data.
The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.
This property is read-only.
ocsp_entry_count Property
The number of SingleResponse elements contained in this OCSP response.
Syntax
def get_ocsp_entry_count(ocsp_index: int) -> int: ...
Default Value
0
Remarks
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.
This property is read-only.
ocsp_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_ocsp_handle(ocsp_index: int) -> int: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.
This property is read-only.
ocsp_issuer Property
Indicates the issuer of this response (a CA or its authorized representative).
Syntax
def get_ocsp_issuer(ocsp_index: int) -> str: ...
Default Value
""
Remarks
Indicates the issuer of this response (a CA or its authorized representative).
The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.
This property is read-only.
ocsp_issuer_rdn Property
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Syntax
def get_ocsp_issuer_rdn(ocsp_index: int) -> str: ...
Default Value
""
Remarks
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.
This property is read-only.
ocsp_location Property
The location of the OCSP responder.
Syntax
def get_ocsp_location(ocsp_index: int) -> str: ...
Default Value
""
Remarks
The location of the OCSP responder.
The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.
This property is read-only.
ocsp_produced_at Property
Specifies the time when the response was produced, in UTC.
Syntax
def get_ocsp_produced_at(ocsp_index: int) -> str: ...
Default Value
""
Remarks
Specifies the time when the response was produced, in UTC.
The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.
This property is read-only.
ocsp_sig_algorithm Property
The public key algorithm that was used by the CA to sign this OCSP response.
Syntax
def get_ocsp_sig_algorithm(ocsp_index: int) -> str: ...
Default Value
"0"
Remarks
The public key algorithm that was used by the CA to sign this OCSP response.
The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.
This property is read-only.
ocsp_source Property
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
def get_ocsp_source(ocsp_index: int) -> int: ...
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.
This property is read-only.
offline_mode Property
Switches the class to offline mode.
Syntax
def get_offline_mode() -> bool: ... def set_offline_mode(value: bool) -> None: ...
offline_mode = property(get_offline_mode, set_offline_mode)
Default Value
FALSE
Remarks
When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via known_certificates, known_crls, and other related properties.
output_bytes Property
Use this property to read the output the class object has produced.
Syntax
def get_output_bytes() -> bytes: ...
output_bytes = property(get_output_bytes, None)
Remarks
Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the output_file and output_stream properties had not been assigned.
This property is read-only.
output_file Property
The file to save the signed or updated document to.
Syntax
def get_output_file() -> str: ... def set_output_file(value: str) -> None: ...
output_file = property(get_output_file, set_output_file)
Default Value
""
Remarks
Use this property to provide a path where the resulting PDF document should be saved to.
page_count Property
The number of records in the Page arrays.
Syntax
def get_page_count() -> int: ...
page_count = property(get_page_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- page_crop_llx
- page_crop_lly
- page_crop_urx
- page_crop_ury
- page_height
- page_media_llx
- page_media_lly
- page_media_urx
- page_media_ury
- page_rotate
- page_width
This property is read-only.
page_crop_llx Property
Specifies the lower-left X coordinate of the page crop area.
Syntax
def get_page_crop_llx(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the lower-left X coordinate of the page crop area.
Specifies the lower-left X coordinate of the page crop area rectangle.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_crop_lly Property
Specifies the lower-left Y coordinate of the page crop area.
Syntax
def get_page_crop_lly(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the lower-left Y coordinate of the page crop area.
Specifies the lower-left Y coordinate of the page crop area rectangle.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_crop_urx Property
Specifies the upper-right X coordinate of the page crop area.
Syntax
def get_page_crop_urx(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the upper-right X coordinate of the page crop area.
Specifies the upper-right X coordinate of the page crop area rectangle.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_crop_ury Property
Specifies the upper-right Y coordinate of the page crop area.
Syntax
def get_page_crop_ury(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the upper-right Y coordinate of the page crop area.
Specifies the upper-right Y coordinate of the page crop area rectangle.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_height Property
Specifies the height of the page.
Syntax
def get_page_height(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the height of the page.
Returns the height of the page.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_media_llx Property
Specifies the lower-left X coordinate of the page media area.
Syntax
def get_page_media_llx(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the lower-left X coordinate of the page media area.
Specifies the lower-left X coordinate of the page media area rectangle.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_media_lly Property
Specifies the lower-left Y coordinate of the page media area.
Syntax
def get_page_media_lly(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the lower-left Y coordinate of the page media area.
Specifies the lower-left Y coordinate of the page media area rectangle.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_media_urx Property
Specifies the upper-right X coordinate of the page media area.
Syntax
def get_page_media_urx(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the upper-right X coordinate of the page media area.
Specifies the upper-right X coordinate of the page media area rectangle.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_media_ury Property
Specifies the upper-right Y coordinate of the page media area.
Syntax
def get_page_media_ury(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the upper-right Y coordinate of the page media area.
Specifies the upper-right Y coordinate of the page media area rectangle.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_rotate Property
Specifies the rotation angle of the page in degrees.
Syntax
def get_page_rotate(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the rotation angle of the page in degrees. Values of 0, 90, 180, and 270 are allowed.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
page_width Property
Specifies the width of the page.
Syntax
def get_page_width(page_index: int) -> int: ...
Default Value
0
Remarks
Specifies the width of the page.
Returns the width of the page.
The page_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_count property.
This property is read-only.
password Property
The decryption password.
Syntax
def get_password() -> str: ... def set_password(value: str) -> None: ...
password = property(get_password, set_password)
Default Value
""
Remarks
Use this property to provide the decryption password.
profile Property
Specifies a pre-defined profile to apply when creating the signature.
Syntax
def get_profile() -> str: ... def set_profile(value: str) -> None: ...
profile = property(get_profile, set_profile)
Default Value
""
Remarks
Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.
Supported profiles:
| "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 |
proxy_address Property
The IP address of the proxy server.
Syntax
def get_proxy_address() -> str: ... def set_proxy_address(value: str) -> None: ...
proxy_address = property(get_proxy_address, set_proxy_address)
Default Value
""
Remarks
The IP address of the proxy server.
proxy_authentication Property
The authentication type used by the proxy server.
Syntax
def get_proxy_authentication() -> int: ... def set_proxy_authentication(value: int) -> None: ...
proxy_authentication = property(get_proxy_authentication, set_proxy_authentication)
Default Value
0
Remarks
The authentication type used by the proxy server.
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |
proxy_password Property
The password to authenticate to the proxy server.
Syntax
def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ...
proxy_password = property(get_proxy_password, set_proxy_password)
Default Value
""
Remarks
The password to authenticate to the proxy server.
proxy_port Property
The port on the proxy server to connect to.
Syntax
def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ...
proxy_port = property(get_proxy_port, set_proxy_port)
Default Value
0
Remarks
The port on the proxy server to connect to.
proxy_proxy_type Property
The type of the proxy server.
Syntax
def get_proxy_proxy_type() -> int: ... def set_proxy_proxy_type(value: int) -> None: ...
proxy_proxy_type = property(get_proxy_proxy_type, set_proxy_proxy_type)
Default Value
0
Remarks
The type of the proxy server.
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |
proxy_request_headers Property
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
def get_proxy_request_headers() -> str: ... def set_proxy_request_headers(value: str) -> None: ...
proxy_request_headers = property(get_proxy_request_headers, set_proxy_request_headers)
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
proxy_response_body Property
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
def get_proxy_response_body() -> str: ... def set_proxy_response_body(value: str) -> None: ...
proxy_response_body = property(get_proxy_response_body, set_proxy_response_body)
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_response_headers Property
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
def get_proxy_response_headers() -> str: ... def set_proxy_response_headers(value: str) -> None: ...
proxy_response_headers = property(get_proxy_response_headers, set_proxy_response_headers)
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_use_ipv6 Property
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
def get_proxy_use_ipv6() -> bool: ... def set_proxy_use_ipv6(value: bool) -> None: ...
proxy_use_ipv6 = property(get_proxy_use_ipv6, set_proxy_use_ipv6)
Default Value
FALSE
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
proxy_username Property
Specifies the username credential for proxy authentication.
Syntax
def get_proxy_username() -> str: ... def set_proxy_username(value: str) -> None: ...
proxy_username = property(get_proxy_username, set_proxy_username)
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
revocation_check Property
Specifies the kind(s) of revocation check to perform for all chain certificates.
Syntax
def get_revocation_check() -> int: ... def set_revocation_check(value: int) -> None: ...
revocation_check = property(get_revocation_check, set_revocation_check)
Default Value
1
Remarks
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
signature_count Property
The number of records in the Signature arrays.
Syntax
def get_signature_count() -> int: ...
signature_count = property(get_signature_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- signature_allowed_changes
- signature_author_name
- signature_certification
- signature_chain_validation_details
- signature_chain_validation_result
- signature_claimed_signing_time
- signature_compatibility_errors
- signature_contact_info
- signature_contains_long_term_info
- signature_coverage_ends_at
- signature_custom_data
- signature_empty_field
- signature_entity_label
- signature_filter_name
- signature_full_signature_name
- signature_handle
- signature_hash_algorithm
- signature_height
- signature_issuer_rdn
- signature_level
- signature_location
- signature_offset_x
- signature_offset_y
- signature_page
- signature_policy_hash
- signature_policy_hash_algorithm
- signature_policy_id
- signature_policy_uri
- signature_reason
- signature_serial_number
- signature_signature_bytes
- signature_signature_name
- signature_signature_type
- signature_signature_validation_result
- signature_subject_key_id
- signature_subject_rdn
- signature_timestamped
- signature_validated_signing_time
- signature_validation_log
- signature_width
This property is read-only.
signature_allowed_changes Property
The changes to the document allowed by the signature.
Syntax
def get_signature_allowed_changes(signature_index: int) -> int: ...
Default Value
0
Remarks
The changes to the document allowed by the signature.
This property is only applicable to MDP/certification signatures and has no effect for any other kinds of signatures (regular or document timestamps).
| psacNone | 0 | No changes are allowed by the signature |
| psacFillInForms | 1 | Only form fill-in is allowed |
| psacComment | 2 | Commenting is allowed |
| psacAll | 3 | Form fill-in and commenting are allowed |
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_author_name Property
A human-readable signer name.
Syntax
def get_signature_author_name(signature_index: int) -> str: ...
Default Value
""
Remarks
A human-readable signer name. This is a PDF document property.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_certification Property
Specifies whether this is a Certification (MDP) signature.
Syntax
def get_signature_certification(signature_index: int) -> bool: ...
Default Value
FALSE
Remarks
Specifies whether this is a Certification (MDP) signature.
Certification signatures are a feature used by earlier Acrobat versions. They have little use these days.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_chain_validation_details Property
The details of a certificate chain validation outcome.
Syntax
def get_signature_chain_validation_details(signature_index: int) -> int: ...
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_chain_validation_result Property
The outcome of a certificate chain validation routine.
Syntax
def get_signature_chain_validation_result(signature_index: int) -> int: ...
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_claimed_signing_time Property
Returns or sets the signature's creation time.
Syntax
def get_signature_claimed_signing_time(signature_index: int) -> str: ...
Default Value
""
Remarks
Returns or sets the signature's creation time.
Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike signature_validated_signing_time, does not originate from a trusted TSA and may be forfeited or wrong.
The time is provided in UTC.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_compatibility_errors Property
Returns compatibility errors encountered during validation.
Syntax
def get_signature_compatibility_errors(signature_index: int) -> int: ...
Default Value
0
Remarks
Returns compatibility errors encountered during validation.
Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_contact_info Property
Contains the signer's contact information.
Syntax
def get_signature_contact_info(signature_index: int) -> str: ...
Default Value
""
Remarks
Contains the signer's contact information. This is a PDF document property.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_contains_long_term_info Property
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
Syntax
def get_signature_contains_long_term_info(signature_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_coverage_ends_at Property
Indicates the offset in the PDF file where signature coverage ends.
Syntax
def get_signature_coverage_ends_at(signature_index: int) -> int: ...
Default Value
0
Remarks
Indicates the offset in the PDF file where signature coverage ends.
PDF generators often use incremental updates to make changes in the documents. This may result in the signature only covering a part of the document (one of the past revisions), but not the subsequent changes.
Use this property to identify the offset where the signature coverage ends. One option is to compare it to the length of the whole document. Alternatively, use the get_signed_version method of the PDFVerifier class to extract the exact revision that was signed.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_custom_data Property
Uninterpreted custom data to save with the signature.
Syntax
def get_signature_custom_data(signature_index: int) -> bytes: ...
Remarks
Uninterpreted custom data to save with the signature.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_empty_field Property
Indicates whether or not the signature created/read is an empty property (a signature placeholder).
Syntax
def get_signature_empty_field(signature_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether or not the signature created/read is an empty field (a signature placeholder).
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_entity_label Property
Use this property to get the signature entity label.
Syntax
def get_signature_entity_label(signature_index: int) -> str: ...
Default Value
""
Remarks
Use this property to get the signature entity label.
This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_filter_name Property
The signature filter name.
Syntax
def get_signature_filter_name(signature_index: int) -> str: ...
Default Value
""
Remarks
The signature filter name.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_full_signature_name Property
Specifies the full name of the signature property.
Syntax
def get_signature_full_signature_name(signature_index: int) -> str: ...
Default Value
""
Remarks
Specifies the full name of the signature field.
This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_signature_handle(signature_index: int) -> int: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_hash_algorithm Property
Specifies the hash algorithm to be used for signing.
Syntax
def get_signature_hash_algorithm(signature_index: int) -> str: ...
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used for signing.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_height Property
Specifies the height of the signature widget.
Syntax
def get_signature_height(signature_index: int) -> int: ...
Default Value
0
Remarks
Specifies the height of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_issuer_rdn Property
The Relative Distinguished Name of the signing certificate's issuer.
Syntax
def get_signature_issuer_rdn(signature_index: int) -> str: ...
Default Value
""
Remarks
The Relative Distinguished Name of the signing certificate's issuer.
A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_level Property
Specifies the PAdES signature level.
Syntax
def get_signature_level(signature_index: int) -> int: ...
Default Value
2
Remarks
Specifies the PAdES signature level.
PAdES standard defines a number of different 'levels' of signatures which can be used for different purposes.
Note that when validating a signature, the LTV modifier may be affected by the validation settings. These include OfflineMode (set it to true to obtain the clean LTV capability) and certificate caching (switch it off to stop earlier validations from affecting the current validation).
The supported levels are:
| paslUnknown | 0 | Unknown signature level |
| paslGeneric | 1 | Generic signature: Legacy Adobe signature (adbe.pkcs7.detached), corresponds to pstLegacy signature type |
| paslBaselineB | 2 | Baseline B (B-B, basic) |
| paslBaselineT | 3 | Baseline T (B-T, timestamped) |
| paslBaselineLT | 4 | Baseline LT (B-LT, long-term) |
| paslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) |
| paslBES | 6 | BES (Basic Electronic Signature) |
| paslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
| paslLTV | 8 | LTV (Electronic Signature with with revocation info) |
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_location Property
Specifies the host name or the physical location of the signing entity.
Syntax
def get_signature_location(signature_index: int) -> str: ...
Default Value
""
Remarks
Specifies the host name or the physical location of the signing entity. This is a PDF property.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_offset_x Property
Specifies the signature widget offset from the left-hand page border.
Syntax
def get_signature_offset_x(signature_index: int) -> int: ...
Default Value
0
Remarks
Specifies the signature widget offset from the left-hand page border.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_offset_y Property
Specifies the signature widget offset from the bottom page border.
Syntax
def get_signature_offset_y(signature_index: int) -> int: ...
Default Value
0
Remarks
Specifies the signature widget offset from the bottom page border.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_page Property
Indicates the index of the page on which the signature is placed.
Syntax
def get_signature_page(signature_index: int) -> int: ...
Default Value
-1
Remarks
Indicates the index of the page on which the signature is placed. The value "-1" indicates an invisible signature.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_policy_hash Property
The signature policy hash value for EPES signatures.
Syntax
def get_signature_policy_hash(signature_index: int) -> str: ...
Default Value
""
Remarks
The signature policy hash value for EPES signatures.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_policy_hash_algorithm Property
The algorithm that was used to calculate the signature policy hash.
Syntax
def get_signature_policy_hash_algorithm(signature_index: int) -> str: ...
Default Value
""
Remarks
The algorithm that was used to calculate the signature policy hash.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_policy_id Property
The policy ID to be included into the signature.
Syntax
def get_signature_policy_id(signature_index: int) -> str: ...
Default Value
""
Remarks
The policy ID to be included into the signature.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_policy_uri Property
The signature policy URI that was included in the signature.
Syntax
def get_signature_policy_uri(signature_index: int) -> str: ...
Default Value
""
Remarks
The signature policy URI that was included in the signature.
Use this property to set or retrieve the URI of the signature policy from EPES signatures.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_reason Property
Specifies the reason for signing.
Syntax
def get_signature_reason(signature_index: int) -> str: ...
Default Value
""
Remarks
Specifies the reason for signing. This is a PDF document property.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_serial_number Property
The serial number of the signing certificate.
Syntax
def get_signature_serial_number(signature_index: int) -> bytes: ...
Remarks
The serial number of the signing certificate.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_signature_bytes Property
Returns the binary representation of the underlying PKCS7 signature blob.
Syntax
def get_signature_signature_bytes(signature_index: int) -> bytes: ...
Remarks
Returns the binary representation of the underlying PKCS7 signature blob.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_signature_name Property
Specifies the unique signature identifier to use.
Syntax
def get_signature_signature_name(signature_index: int) -> str: ...
Default Value
""
Remarks
Specifies the unique signature identifier to use.
This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_signature_type Property
The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.
Syntax
def get_signature_signature_type(signature_index: int) -> int: ...
Default Value
2
Remarks
The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.
The supported values are:
| pstUnknown | 0 | Unknown signature type |
| pstLegacy | 1 | Legacy Adobe signature (adbe.pkcs7.detached or adbe.pkcs7.sha1) |
| pstPAdES | 2 | PAdES signature (ETSI.CAdES.detached), use Level field for detailed info |
| pstDocumentTimestamp | 3 | Document timestamp (ETSI.RFC3161) |
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_signature_validation_result Property
The outcome of the cryptographic signature validation.
Syntax
def get_signature_signature_validation_result(signature_index: int) -> int: ...
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_subject_key_id Property
Contains the subject key identifier of the signing certificate.
Syntax
def get_signature_subject_key_id(signature_index: int) -> bytes: ...
Remarks
Contains the subject key identifier of the signing certificate.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_subject_rdn Property
Contains the RDN of the owner of the signing certificate.
Syntax
def get_signature_subject_rdn(signature_index: int) -> str: ...
Default Value
""
Remarks
Contains the RDN of the owner of the signing certificate.
RDN is a number of OID=Value pairs declared in the certificate that provide the owner's details.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_timestamped Property
Use this property to establish whether the signature contains an embedded timestamp.
Syntax
def get_signature_timestamped(signature_index: int) -> bool: ...
Default Value
FALSE
Remarks
Use this property to establish whether the signature contains an embedded timestamp.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_validated_signing_time Property
Contains the certified signing time.
Syntax
def get_signature_validated_signing_time(signature_index: int) -> str: ...
Default Value
""
Remarks
Contains the certified signing time.
Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.
signature_claimed_signing_time returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_validation_log Property
Contains the signing certificate's chain validation log.
Syntax
def get_signature_validation_log(signature_index: int) -> str: ...
Default Value
""
Remarks
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signature_width Property
Specifies the width of the signature widget.
Syntax
def get_signature_width(signature_index: int) -> int: ...
Default Value
0
Remarks
Specifies the width of the signature widget.
Note that the dimensions of the widget are provided in document-specific points, not pixels.
The signature_index parameter specifies the index of the item in the array. The size of the array is controlled by the signature_count property.
This property is read-only.
signing_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_signing_cert_bytes() -> bytes: ...
signing_cert_bytes = property(get_signing_cert_bytes, None)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
signing_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_signing_cert_handle() -> int: ... def set_signing_cert_handle(value: int) -> None: ...
signing_cert_handle = property(get_signing_cert_handle, set_signing_cert_handle)
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
signing_chain_count Property
The number of records in the SigningChain arrays.
Syntax
def get_signing_chain_count() -> int: ... def set_signing_chain_count(value: int) -> None: ...
signing_chain_count = property(get_signing_chain_count, set_signing_chain_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at signing_chain_count - 1.signing_chain_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_signing_chain_bytes(signing_chain_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The signing_chain_index parameter specifies the index of the item in the array. The size of the array is controlled by the signing_chain_count property.
This property is read-only.
signing_chain_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_signing_chain_handle(signing_chain_index: int) -> int: ... def set_signing_chain_handle(signing_chain_index: int, value: int) -> None: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The signing_chain_index parameter specifies the index of the item in the array. The size of the array is controlled by the signing_chain_count property.
socket_dns_mode Property
Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
Syntax
def get_socket_dns_mode() -> int: ... def set_socket_dns_mode(value: int) -> None: ...
socket_dns_mode = property(get_socket_dns_mode, set_socket_dns_mode)
Default Value
0
Remarks
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |
socket_dns_port Property
Specifies the port number to be used for sending queries to the DNS server.
Syntax
def get_socket_dns_port() -> int: ... def set_socket_dns_port(value: int) -> None: ...
socket_dns_port = property(get_socket_dns_port, set_socket_dns_port)
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
socket_dns_query_timeout Property
The timeout (in milliseconds) for each DNS query.
Syntax
def get_socket_dns_query_timeout() -> int: ... def set_socket_dns_query_timeout(value: int) -> None: ...
socket_dns_query_timeout = property(get_socket_dns_query_timeout, set_socket_dns_query_timeout)
Default Value
0
Remarks
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
socket_dns_servers Property
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
def get_socket_dns_servers() -> str: ... def set_socket_dns_servers(value: str) -> None: ...
socket_dns_servers = property(get_socket_dns_servers, set_socket_dns_servers)
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
socket_dns_total_timeout Property
The timeout (in milliseconds) for the whole resolution process.
Syntax
def get_socket_dns_total_timeout() -> int: ... def set_socket_dns_total_timeout(value: int) -> None: ...
socket_dns_total_timeout = property(get_socket_dns_total_timeout, set_socket_dns_total_timeout)
Default Value
0
Remarks
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
socket_incoming_speed_limit Property
The maximum number of bytes to read from the socket, per second.
Syntax
def get_socket_incoming_speed_limit() -> int: ... def set_socket_incoming_speed_limit(value: int) -> None: ...
socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit)
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
socket_local_address Property
The local network interface to bind the socket to.
Syntax
def get_socket_local_address() -> str: ... def set_socket_local_address(value: str) -> None: ...
socket_local_address = property(get_socket_local_address, set_socket_local_address)
Default Value
""
Remarks
The local network interface to bind the socket to.
socket_local_port Property
The local port number to bind the socket to.
Syntax
def get_socket_local_port() -> int: ... def set_socket_local_port(value: int) -> None: ...
socket_local_port = property(get_socket_local_port, set_socket_local_port)
Default Value
0
Remarks
The local port number to bind the socket to.
socket_outgoing_speed_limit Property
The maximum number of bytes to write to the socket, per second.
Syntax
def get_socket_outgoing_speed_limit() -> int: ... def set_socket_outgoing_speed_limit(value: int) -> None: ...
socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit)
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
socket_timeout Property
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
def get_socket_timeout() -> int: ... def set_socket_timeout(value: int) -> None: ...
socket_timeout = property(get_socket_timeout, set_socket_timeout)
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
socket_use_ipv6 Property
Enables or disables IP protocol version 6.
Syntax
def get_socket_use_ipv6() -> bool: ... def set_socket_use_ipv6(value: bool) -> None: ...
socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6)
Default Value
FALSE
Remarks
Enables or disables IP protocol version 6.
timestamp_count Property
The number of records in the Timestamp arrays.
Syntax
def get_timestamp_count() -> int: ...
timestamp_count = property(get_timestamp_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- timestamp_accuracy
- timestamp_bytes
- timestamp_certificate_index
- timestamp_chain_validation_details
- timestamp_chain_validation_result
- timestamp_contains_long_term_info
- timestamp_entity_label
- timestamp_hash_algorithm
- timestamp_parent_entity
- timestamp_serial_number
- timestamp_time
- timestamp_timestamp_type
- timestamp_tsa_name
- timestamp_validation_log
- timestamp_validation_result
This property is read-only.
timestamp_accuracy Property
This property indicates the accuracy of the included time mark, in microseconds.
Syntax
def get_timestamp_accuracy(timestamp_index: int) -> int: ...
Default Value
0
Remarks
This field indicates the accuracy of the included time mark, in microseconds.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_bytes Property
Returns the raw timestamp data in DER format.
Syntax
def get_timestamp_bytes(timestamp_index: int) -> bytes: ...
Remarks
Returns the raw timestamp data in DER format.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_certificate_index Property
Returns the index of the TSA certificate in the Certificates collection.
Syntax
def get_timestamp_certificate_index(timestamp_index: int) -> int: ...
Default Value
-1
Remarks
Returns the index of the TSA certificate in the Certificates collection.
Use this property to look up the TSA certificate in the Certificates collection.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_chain_validation_details Property
The details of a certificate chain validation outcome.
Syntax
def get_timestamp_chain_validation_details(timestamp_index: int) -> int: ...
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_chain_validation_result Property
The outcome of a certificate chain validation routine.
Syntax
def get_timestamp_chain_validation_result(timestamp_index: int) -> int: ...
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_contains_long_term_info Property
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
Syntax
def get_timestamp_contains_long_term_info(timestamp_index: int) -> bool: ...
Default Value
FALSE
Remarks
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_entity_label Property
Use this property to get the timestamp entity label.
Syntax
def get_timestamp_entity_label(timestamp_index: int) -> str: ...
Default Value
""
Remarks
Use this property to get the timestamp entity label.
This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_hash_algorithm Property
Returns the timestamp's hash algorithm.
Syntax
def get_timestamp_hash_algorithm(timestamp_index: int) -> str: ...
Default Value
""
Remarks
Returns the timestamp's hash algorithm.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_parent_entity Property
Use this property to get the label of the timestamp's parent entity.
Syntax
def get_timestamp_parent_entity(timestamp_index: int) -> str: ...
Default Value
""
Remarks
Use this property to get the label of the timestamp's parent entity.
This property references the EntityLabel of the object that the timestamp covers, typically a signature.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_serial_number Property
Returns the timestamp's serial number.
Syntax
def get_timestamp_serial_number(timestamp_index: int) -> bytes: ...
Remarks
Returns the timestamp's serial number.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_time Property
The time point incorporated into the timestamp.
Syntax
def get_timestamp_time(timestamp_index: int) -> str: ...
Default Value
""
Remarks
The time point incorporated into the timestamp.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_timestamp_type Property
Returns the type of the timestamp.
Syntax
def get_timestamp_timestamp_type(timestamp_index: int) -> int: ...
Default Value
0
Remarks
Returns the type of the timestamp.
Available options:
| tstUnknown | 0 | |
| tstLegacy | 1 | Supported by: Authenticode components |
| tstTrusted | 2 | Supported by: Authenticode components |
| tstGeneric | 3 | Supported by: CAdES components |
| tstESC | 4 | Supported by: CAdES components |
| tstContent | 5 | Supported by: CAdES components |
| tstCertsAndCRLs | 6 | Supported by: CAdES components |
| tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components |
| tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components |
| tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components |
| tstIndividualDataObjects | 10 | Individual data objects timetamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components |
| tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components |
Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_tsa_name Property
This value uniquely identifies the Timestamp Authority (TSA).
Syntax
def get_timestamp_tsa_name(timestamp_index: int) -> str: ...
Default Value
""
Remarks
This value uniquely identifies the Timestamp Authority (TSA).
This property provides information about the entity that manages the TSA.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_validation_log Property
Contains the TSA certificate chain validation log.
Syntax
def get_timestamp_validation_log(timestamp_index: int) -> str: ...
Default Value
""
Remarks
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_validation_result Property
Contains the timestamp validation outcome.
Syntax
def get_timestamp_validation_result(timestamp_index: int) -> int: ...
Default Value
0
Remarks
Contains the timestamp validation outcome.
Use this property to check the result of the most recent timestamp validation.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
The timestamp_index parameter specifies the index of the item in the array. The size of the array is controlled by the timestamp_count property.
This property is read-only.
timestamp_server Property
The address of the timestamping server.
Syntax
def get_timestamp_server() -> str: ... def set_timestamp_server(value: str) -> None: ...
timestamp_server = property(get_timestamp_server, set_timestamp_server)
Default Value
""
Remarks
Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.
SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.
If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:
http://user:password@timestamp.server.com/TsaService
For TSAs using certificate-based TLS authentication, provide the client certificate via the tls_client_chain property.
If this property is left empty, no timestamp will be added to the signature.
Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.
To employ the virtual service, assign an URI of the following format to this property:
virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true
Subscribe to on_notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:
component.Config("TimestampResponse=308208ab...");
Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.
The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.
The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.
The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.
The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.
All the parameters are optional.
tls_client_cert_count Property
The number of records in the TLSClientCert arrays.
Syntax
def get_tls_client_cert_count() -> int: ... def set_tls_client_cert_count(value: int) -> None: ...
tls_client_cert_count = property(get_tls_client_cert_count, set_tls_client_cert_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at tls_client_cert_count - 1.tls_client_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_tls_client_cert_bytes(tls_client_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The tls_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_client_cert_count property.
This property is read-only.
tls_client_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_tls_client_cert_handle(tls_client_cert_index: int) -> int: ... def set_tls_client_cert_handle(tls_client_cert_index: int, value: int) -> None: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The tls_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_client_cert_count property.
tls_server_cert_count Property
The number of records in the TLSServerCert arrays.
Syntax
def get_tls_server_cert_count() -> int: ...
tls_server_cert_count = property(get_tls_server_cert_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- tls_server_cert_bytes
- tls_server_cert_fingerprint
- tls_server_cert_handle
- tls_server_cert_issuer
- tls_server_cert_issuer_rdn
- tls_server_cert_key_algorithm
- tls_server_cert_key_bits
- tls_server_cert_key_usage
- tls_server_cert_self_signed
- tls_server_cert_serial_number
- tls_server_cert_sig_algorithm
- tls_server_cert_subject
- tls_server_cert_subject_rdn
- tls_server_cert_valid_from
- tls_server_cert_valid_to
This property is read-only.
tls_server_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_tls_server_cert_bytes(tls_server_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_fingerprint Property
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
def get_tls_server_cert_fingerprint(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_tls_server_cert_handle(tls_server_cert_index: int) -> int: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_issuer Property
The common name of the certificate issuer (CA), typically a company name.
Syntax
def get_tls_server_cert_issuer(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via tls_issuer_rdn.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_issuer_rdn Property
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
def get_tls_server_cert_issuer_rdn(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_key_algorithm Property
Specifies the public key algorithm of this certificate.
Syntax
def get_tls_server_cert_key_algorithm(tls_server_cert_index: int) -> str: ...
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the tls_key_bits, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_key_bits Property
Returns the length of the public key in bits.
Syntax
def get_tls_server_cert_key_bits(tls_server_cert_index: int) -> int: ...
Default Value
0
Remarks
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the tls_public_key_bytes or tls_private_key_bytes property would typically contain auxiliary values, and therefore be longer.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_key_usage Property
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
def get_tls_server_cert_key_usage(tls_server_cert_index: int) -> int: ...
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this property before generating the certificate to propagate the key usage flags to the new certificate.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_self_signed Property
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
def get_tls_server_cert_self_signed(tls_server_cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_serial_number Property
Returns the certificate's serial number.
Syntax
def get_tls_server_cert_serial_number(tls_server_cert_index: int) -> bytes: ...
Remarks
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_sig_algorithm Property
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
def get_tls_server_cert_sig_algorithm(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_subject Property
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
def get_tls_server_cert_subject(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via tls_subject_rdn.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_subject_rdn Property
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
def get_tls_server_cert_subject_rdn(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_valid_from Property
The time point at which the certificate becomes valid, in UTC.
Syntax
def get_tls_server_cert_valid_from(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_valid_to Property
The time point at which the certificate expires, in UTC.
Syntax
def get_tls_server_cert_valid_to(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_auto_validate_certificates Property
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
def get_tls_auto_validate_certificates() -> bool: ... def set_tls_auto_validate_certificates(value: bool) -> None: ...
tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates)
Default Value
TRUE
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
tls_base_configuration Property
Selects the base configuration for the TLS settings.
Syntax
def get_tls_base_configuration() -> int: ... def set_tls_base_configuration(value: int) -> None: ...
tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration)
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
| stpcDefault | 0 | |
| stpcCompatible | 1 | |
| stpcComprehensiveInsecure | 2 | |
| stpcHighlySecure | 3 |
tls_ciphersuites Property
A list of ciphersuites separated with commas or semicolons.
Syntax
def get_tls_ciphersuites() -> str: ... def set_tls_ciphersuites(value: str) -> None: ...
tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites)
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by tls_base_configuration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
tls_client_auth Property
Enables or disables certificate-based client authentication.
Syntax
def get_tls_client_auth() -> int: ... def set_tls_client_auth(value: int) -> None: ...
tls_client_auth = property(get_tls_client_auth, set_tls_client_auth)
Default Value
0
Remarks
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
| ccatNoAuth | 0 | |
| ccatRequestCert | 1 | |
| ccatRequireCert | 2 |
tls_ec_curves Property
Defines the elliptic curves to enable.
Syntax
def get_tls_ec_curves() -> str: ... def set_tls_ec_curves(value: str) -> None: ...
tls_ec_curves = property(get_tls_ec_curves, set_tls_ec_curves)
Default Value
""
Remarks
Defines the elliptic curves to enable.
tls_extensions Property
Provides access to TLS extensions.
Syntax
def get_tls_extensions() -> str: ... def set_tls_extensions(value: str) -> None: ...
tls_extensions = property(get_tls_extensions, set_tls_extensions)
Default Value
""
Remarks
Provides access to TLS extensions.
tls_force_resume_if_destination_changes Property
Whether to force TLS session resumption when the destination address changes.
Syntax
def get_tls_force_resume_if_destination_changes() -> bool: ... def set_tls_force_resume_if_destination_changes(value: bool) -> None: ...
tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes)
Default Value
FALSE
Remarks
Whether to force TLS session resumption when the destination address changes.
tls_pre_shared_identity Property
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
def get_tls_pre_shared_identity() -> str: ... def set_tls_pre_shared_identity(value: str) -> None: ...
tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity)
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
tls_pre_shared_key Property
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
def get_tls_pre_shared_key() -> str: ... def set_tls_pre_shared_key(value: str) -> None: ...
tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key)
Default Value
""
Remarks
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
tls_pre_shared_key_ciphersuite Property
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
def get_tls_pre_shared_key_ciphersuite() -> str: ... def set_tls_pre_shared_key_ciphersuite(value: str) -> None: ...
tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite)
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
tls_renegotiation_attack_prevention_mode Property
Selects the renegotiation attack prevention mechanism.
Syntax
def get_tls_renegotiation_attack_prevention_mode() -> int: ... def set_tls_renegotiation_attack_prevention_mode(value: int) -> None: ...
tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode)
Default Value
2
Remarks
Selects the renegotiation attack prevention mechanism.
The following options are available:
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
tls_revocation_check Property
Specifies the kind(s) of revocation check to perform.
Syntax
def get_tls_revocation_check() -> int: ... def set_tls_revocation_check(value: int) -> None: ...
tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check)
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
tls_ssl_options Property
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
def get_tls_ssl_options() -> int: ... def set_tls_ssl_options(value: int) -> None: ...
tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options)
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
tls_tls_mode Property
Specifies the TLS mode to use.
Syntax
def get_tls_tls_mode() -> int: ... def set_tls_tls_mode(value: int) -> None: ...
tls_tls_mode = property(get_tls_tls_mode, set_tls_tls_mode)
Default Value
0
Remarks
Specifies the TLS mode to use.
| smDefault | 0 | |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
tls_use_extended_master_secret Property
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
def get_tls_use_extended_master_secret() -> bool: ... def set_tls_use_extended_master_secret(value: bool) -> None: ...
tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret)
Default Value
FALSE
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
tls_use_session_resumption Property
Enables or disables the TLS session resumption capability.
Syntax
def get_tls_use_session_resumption() -> bool: ... def set_tls_use_session_resumption(value: bool) -> None: ...
tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption)
Default Value
FALSE
Remarks
Enables or disables the TLS session resumption capability.
tls_versions Property
The SSL/TLS versions to enable by default.
Syntax
def get_tls_versions() -> int: ... def set_tls_versions(value: int) -> None: ...
tls_versions = property(get_tls_versions, set_tls_versions)
Default Value
16
Remarks
The SSL/TLS versions to enable by default.
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |
trusted_cert_count Property
The number of records in the TrustedCert arrays.
Syntax
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:
The array indices start at 0 and end at trusted_cert_count - 1.trusted_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_trusted_cert_bytes(trusted_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.
This property is read-only.
trusted_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_trusted_cert_handle(trusted_cert_index: int) -> int: ... def set_trusted_cert_handle(trusted_cert_index: int, value: int) -> None: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.
validation_moment Property
The time point at which signature validity is to be established.
Syntax
def get_validation_moment() -> str: ... def set_validation_moment(value: str) -> None: ...
validation_moment = property(get_validation_moment, set_validation_moment)
Default Value
""
Remarks
Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).
The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.
widget_algorithm_caption Property
The caption of the signature widget property with information about the signature algorithm.
Syntax
def get_widget_algorithm_caption() -> str: ... def set_widget_algorithm_caption(value: str) -> None: ...
widget_algorithm_caption = property(get_widget_algorithm_caption, set_widget_algorithm_caption)
Default Value
"#auto"
Remarks
The caption of the signature widget field with information about the signature algorithm.
widget_algorithm_info Property
Information about the algorithm to be shown on the signature widget.
Syntax
def get_widget_algorithm_info() -> str: ... def set_widget_algorithm_info(value: str) -> None: ...
widget_algorithm_info = property(get_widget_algorithm_info, set_widget_algorithm_info)
Default Value
"#auto"
Remarks
Information about the algorithm to be shown on the signature widget.
This property contains information about the algorithm to be displayed in the signature widget. Keep this property set to #auto to make the component generate the algorithm text automatically, in the form of "Algorithm/Key size", e.g. "RSA/1024 bits".
widget_background_data Property
Contains/takes the data of the signature widget background bitmap.
Syntax
def get_widget_background_data() -> bytes: ... def set_widget_background_data(value: bytes) -> None: ...
widget_background_data = property(get_widget_background_data, set_widget_background_data)
Remarks
Contains/takes the data of the signature widget background bitmap.
Assign the widget background data (in the form of JPEG or JPEG2000 bytes) to this property.
widget_background_height Property
Use this property to manually adjust the size of the stretched background picture in the vertical direction.
Syntax
def get_widget_background_height() -> str: ... def set_widget_background_height(value: str) -> None: ...
widget_background_height = property(get_widget_background_height, set_widget_background_height)
Default Value
"0"
Remarks
Use this property to manually adjust the size of the stretched background picture in the vertical direction.
widget_background_image_height Property
The height of the background image in pixels.
Syntax
def get_widget_background_image_height() -> int: ... def set_widget_background_image_height(value: int) -> None: ...
widget_background_image_height = property(get_widget_background_image_height, set_widget_background_image_height)
Default Value
0
Remarks
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 will ultimately be squeezed to fit in the widget, and smaller ones stretched.
widget_background_image_type Property
The type of the image contained in BackgroundData .
Syntax
def get_widget_background_image_type() -> int: ... def set_widget_background_image_type(value: int) -> None: ...
widget_background_image_type = property(get_widget_background_image_type, set_widget_background_image_type)
Default Value
0
Remarks
The type of the image contained in widget_background_data. The JPEG and JPEG2000 formats are currently supported.
| pwitJPEG2000 | 0 | JPEG 2000 format (supports transparency) |
| pwitJPEG | 1 | standard JPEG format (does not support transparency) |
| pwitCustom | 2 | Custom background format |
widget_background_image_width Property
The width of the background image in pixels.
Syntax
def get_widget_background_image_width() -> int: ... def set_widget_background_image_width(value: int) -> None: ...
widget_background_image_width = property(get_widget_background_image_width, set_widget_background_image_width)
Default Value
0
Remarks
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 will ultimately be squeezed to fit in the widget, and smaller ones stretched.
widget_background_mask Property
Contains the background image mask.
Syntax
def get_widget_background_mask() -> bytes: ... def set_widget_background_mask(value: bytes) -> None: ...
widget_background_mask = property(get_widget_background_mask, set_widget_background_mask)
Remarks
Contains the background image mask.
Masks provide a means for marking transparent areas on your signature widgets. Specifically, a transparency mask tells PDF viewing apps which pixels of the signature widget should be kept visible and which should be rendered transparent instead.
In most cases, you will need a unique mask that is tailored for your signature widget image. This is something that you will need to create yourself based on your preferences and the actual image design.
A mask is effectively a matrix of bits, with each bit corresponding to a pixel on your 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.
To create the mask that can be passed to BackgroundMask, please follow the below procedure:
Go through your signature widget bitmap row by row, processing each row of pixels from left to right. For each row,
1. Start with an empty bit string.
2. For every pixel in a row, add a '1' bit if you want it to be transparent, or a '0' bit if you want it to be opaque.
3. Upon reaching the end of the row, append '0' bits to your bit string until the number of bits in it is a multiple of 8. This is because each row of pixels needs to be represented with a whole number of bytes.
4. Convert the bit string to a byte array by grouping every 8 bits into a byte.
Do the same for every row of pixels, and then concatenate the received byte arrays together. Pass the created byte array to BackgroundMask.
A small example. Imagine your image is 19 pixels wide and 3 pixels tall. Imagine you want to make it 'semi-transparent' by using a 'mesh' pattern. The mask will therefore look like this:
10101010 10101010 10100000 // first row
01010101 01010101 01000000 // second row
10101010 10101010 10100000 // third row
Note that the last 5 bits of each row are padding '0' bits and are ignored: you only need them to make each row contain a whole number of bytes. When converted to a byte string, this would look like
0xAA 0xAA 0xA0
0x55 0x55 0x40
0xAA 0xAA 0xA0
, or, if written as a byte array, (0xAA, 0xAA, 0xA0, 0x55, 0x55, 0x40, 0xAA, 0xAA, 0xA0): this is what you need to pass to BackgroundMask.
widget_background_position Property
The position of the widget background.
Syntax
def get_widget_background_position() -> str: ... def set_widget_background_position(value: str) -> None: ...
widget_background_position = property(get_widget_background_position, set_widget_background_position)
Default Value
""
Remarks
The position of the widget background.
Specifies the position of the background image.
The value may be:
The keyword value "center", which centers the image.
A pair of coordinates ("10 5.5"), in which one value defines X and the other defines Y starting from the bottom-left corner.
widget_background_style Property
The style of the signature widget background.
Syntax
def get_widget_background_style() -> int: ... def set_widget_background_style(value: int) -> None: ...
widget_background_style = property(get_widget_background_style, set_widget_background_style)
Default Value
0
Remarks
The style of the signature widget background.
pwbsDefault uses the default image, pwbsNoBackground doesn't use a background image at all, and pwbsCustom expects the application to provide a custom background image.
| pwbsDefault | 0 | The default widget background |
| pwbsNoBackground | 1 | No (empty) background |
| pwbsCustom | 2 | Custom background (picture or vector) |
widget_background_width Property
Use this property to manually adjust the horizontal size of the stretched background picture.
Syntax
def get_widget_background_width() -> str: ... def set_widget_background_width(value: str) -> None: ...
widget_background_width = property(get_widget_background_width, set_widget_background_width)
Default Value
"0"
Remarks
Use this property to manually adjust the horizontal size of the stretched background picture.
widget_compress_widget_data Property
Whether the signature widget data should be compressed before saving.
Syntax
def get_widget_compress_widget_data() -> bool: ... def set_widget_compress_widget_data(value: bool) -> None: ...
widget_compress_widget_data = property(get_widget_compress_widget_data, set_widget_compress_widget_data)
Default Value
FALSE
Remarks
Whether the signature widget data should be compressed before saving.
widget_custom_appearance Property
Contains a custom widget description in raw PDF graphic operators format.
Syntax
def get_widget_custom_appearance() -> bytes: ... def set_widget_custom_appearance(value: bytes) -> None: ...
widget_custom_appearance = property(get_widget_custom_appearance, set_widget_custom_appearance)
Remarks
Contains a custom widget description in raw PDF graphic operators format.
Use this property to provide a PDF stream describing the widget appearance.
widget_custom_background_content_stream Property
Specifies a custom background content stream for the pwbsCustom BackgroundStyle .
Syntax
def get_widget_custom_background_content_stream() -> str: ... def set_widget_custom_background_content_stream(value: str) -> None: ...
widget_custom_background_content_stream = property(get_widget_custom_background_content_stream, set_widget_custom_background_content_stream)
Default Value
""
Remarks
Specifies a custom background content stream for the pwbsCustom widget_background_style.
widget_custom_visual_status_matrix Property
Defines the custom visual status matrix.
Syntax
def get_widget_custom_visual_status_matrix() -> str: ... def set_widget_custom_visual_status_matrix(value: str) -> None: ...
widget_custom_visual_status_matrix = property(get_widget_custom_visual_status_matrix, set_widget_custom_visual_status_matrix)
Default Value
""
Remarks
Defines the custom visual status matrix.
Use of this property makes sense only if a visual status icon is displayed over the signature (widget_show_visual_status). Prior to Acrobat 6, a signature's visual appearance was modified with a status icon, e.g., "valid" or "invalid". The visual status matrix is used to position the icon in the signature widget. If CustomVisualStatusMatrix is empty, the value of '0.25 0 0 0.25 0 0' is used.
widget_date_format Property
The format string used to display the signing date and time in the signature widget.
Syntax
def get_widget_date_format() -> str: ... def set_widget_date_format(value: str) -> None: ...
widget_date_format = property(get_widget_date_format, set_widget_date_format)
Default Value
""
Remarks
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 formatting.
Use the "L" value to convert UTC time to local time using the default formatting, or use the "L:" prefix with a custom date time formatting string.
widget_font_name Property
Specifies the font name for the signature text.
Syntax
def get_widget_font_name() -> str: ... def set_widget_font_name(value: str) -> None: ...
widget_font_name = property(get_widget_font_name, set_widget_font_name)
Default Value
""
Remarks
Specifies the font name for the signature text.
Use this property to specify a Type 1 or TrueType font name for the signature text.
The PDF format supports 14 standard Type 1 fonts, specifically: "Times-Roman", "Helvetica", "Courier", "Symbol", "Times-Bold", "Helvetica-Bold", "Courier-Bold", "ZapfDingbats", "Times-Italic", "Helvetica-Oblique", "Courier-Oblique", "Times-BoldItalic", "Helvetica-BoldOblique", "Courier-BoldOblique".
For TrueType font names, the component supports a full font name (e.g. "Times New Roman", "Arial Bold Italic"), its filename (e.g. "times.ttf", "arialbi.ttf"), or a full file name.
If a TrueType font is used, then a font subset is embedded into the PDF document.
The list of system TrueType font names that the component supports could be obtained using the do_action method with the "GetSystemFontNames" action ID.
Use the FontPaths configuration setting (accessed via config) to specify font search paths in case the TrueType font filename is provided.
widget_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_widget_handle() -> int: ... def set_widget_handle(value: int) -> None: ...
widget_handle = property(get_widget_handle, set_widget_handle)
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
widget_header Property
Specifies the header text to put on the signature widget.
Syntax
def get_widget_header() -> str: ... def set_widget_header(value: str) -> None: ...
widget_header = property(get_widget_header, set_widget_header)
Default Value
"#auto"
Remarks
Specifies the header text to put on the signature widget. Keep this property set to #auto to make the component generate the header automatically.
widget_hide_default_text Property
Switches off the generation of any headers for the signature widget.
Syntax
def get_widget_hide_default_text() -> bool: ... def set_widget_hide_default_text(value: bool) -> None: ...
widget_hide_default_text = property(get_widget_hide_default_text, set_widget_hide_default_text)
Default Value
FALSE
Remarks
Switches off the generation of any headers for the signature widget.
widget_ignore_existing_appearance Property
Tells the class to discard any existing widget parameters when signing empty signature properties.
Syntax
def get_widget_ignore_existing_appearance() -> bool: ... def set_widget_ignore_existing_appearance(value: bool) -> None: ...
widget_ignore_existing_appearance = property(get_widget_ignore_existing_appearance, set_widget_ignore_existing_appearance)
Default Value
FALSE
Remarks
Tells the component to discard any existing widget parameters when signing empty signature fields.
IgnoreExistingAppearance only makes sense for signatures created by signing existing empty signature fields with pre-defined widget descriptions.
widget_invert_mask Property
Specifies whether BackgroundMask should be inverted.
Syntax
def get_widget_invert_mask() -> bool: ... def set_widget_invert_mask(value: bool) -> None: ...
widget_invert_mask = property(get_widget_invert_mask, set_widget_invert_mask)
Default Value
FALSE
Remarks
Specifies whether widget_background_mask should be inverted.
Set this property to flip all the bits in the mask, by making opaque all the bits declared by the mask as transparent, and making transparent all the bits declared as opaque.
widget_invisible Property
Controls whether the signature widget is visible on the page.
Syntax
def get_widget_invisible() -> bool: ... def set_widget_invisible(value: bool) -> None: ...
widget_invisible = property(get_widget_invisible, set_widget_invisible)
Default Value
FALSE
Remarks
Controls whether the signature widget is visible on the page.
widget_pages_to_place_on Property
The page numbers on which the signature is shown.
Syntax
def get_widget_pages_to_place_on() -> str: ... def set_widget_pages_to_place_on(value: str) -> None: ...
widget_pages_to_place_on = property(get_widget_pages_to_place_on, set_widget_pages_to_place_on)
Default Value
""
Remarks
The page numbers on which the signature is shown. This field supports a variety of syntaxes:
- A single page number: 3
- A comma-separated list of page numbers: 1,2,5,7
- The star 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.
widget_position_anchor Property
The anchor to bind the position of the widget to.
Syntax
def get_widget_position_anchor() -> int: ... def set_widget_position_anchor(value: int) -> None: ...
widget_position_anchor = property(get_widget_position_anchor, set_widget_position_anchor)
Default Value
0
Remarks
The anchor to bind the position of the widget to.
Supported values are:
| ppaDefault | 0 | The signature's OffsetX and OffsetY properties specify the position of the bottom left widget corner starting from the page's physical bottom left corner (doesn't take into account page rotation). |
| ppaBottomLeft | 1 | The signature's OffsetX and OffsetY properties specify the position of the bottom left widget corner starting from the page's bottom left corner according to the viewer's perspective (take into account page rotation). |
| ppaBottomRight | 2 | The signature's OffsetX and OffsetY properties specify the position of the bottom right widget corner starting from the page's bottom right corner according to the viewer's perspective (take into account page rotation). |
| ppaTopLeft | 3 | The signature's OffsetX and OffsetY properties specify the position of the top left widget corner starting from the page's top left corner according to the viewer's perspective (take into account page rotation). |
| ppaTopRight | 4 | The signature's OffsetX and OffsetY properties specify the position of the top right widget corner starting from the page's top right corner according to the viewer's perspective (take into account page rotation). |
| ppaCenter | 5 | The signature's OffsetX and OffsetY properties specify the position of the widget center starting from the page's center according to the viewer's perspective. |
widget_render_options Property
This setting is a container for a selection of rendering options.
Syntax
def get_widget_render_options() -> int: ... def set_widget_render_options(value: int) -> None: ...
widget_render_options = property(get_widget_render_options, set_widget_render_options)
Default Value
8
Remarks
This setting is a container for a selection of rendering options. OR or NOT an option to include or exclude it from the bit mask.
| wroUnknown | 0x00000 | Unknown, unsupported, or uninitialized set of options |
| wroNoRotate | 0x00001 | Enabling this option prevents the signature widget from being rotated when the containing document is rotated in a viewing app. |
| wroNoView | 0x00002 | Enabling this option prevents the widget from being displayed when the document is viewed in an app (the widget will still be printed, if configured). |
| wroNoZoom | 0x00004 | Keeps the widget at the same size when the document is zoomed in or out. |
| wroPrint | 0x00008 | Makes the widget printable. |
| wroReadOnly | 0x00010 | Controls the ReadOnly flag of the widget object. |
| wroToggleNoView | 0x00020 | If set, the signature widget will only be displayed when the viewer hovers a mouse pointer over it. |
widget_rotate Property
Specifies the rotation angle of the signature widget in degrees.
Syntax
def get_widget_rotate() -> int: ... def set_widget_rotate(value: int) -> None: ...
widget_rotate = property(get_widget_rotate, set_widget_rotate)
Default Value
0
Remarks
Specifies the rotation angle of the signature widget in degrees. Values of 0, 90, 180, and 270 are allowed.
widget_show_date Property
Whether to display the signing date and time details on the widget.
Syntax
def get_widget_show_date() -> bool: ... def set_widget_show_date(value: bool) -> None: ...
widget_show_date = property(get_widget_show_date, set_widget_show_date)
Default Value
TRUE
Remarks
Whether to display the signing date and time details on the widget.
widget_show_visual_status Property
Specifies whether to show the signature's status icon.
Syntax
def get_widget_show_visual_status() -> bool: ... def set_widget_show_visual_status(value: bool) -> None: ...
widget_show_visual_status = property(get_widget_show_visual_status, set_widget_show_visual_status)
Default Value
FALSE
Remarks
Specifies whether to show the signature's status icon.
It is a good idea to avoid using the visual status icon, as described below:
According to the Digital Signature Appearances Adobe Acrobat SDK (May 2015), "Prior to Acrobat 6.0, signature appearances were manipulated at run-time in order to display the validity of the signature. The validity was shown as a graphic icon and with an additional, optional text message. The manipulated portions of the signature appearance were contained in layers n1, n3 and n4. Beginning with version 6, Acrobat does not maintain support for signature appearances that can be manipulated, though legacy signatures with these appearances may continue to display correctly. Use of layers n1, n3, and n4 is not recommended."
widget_signer_caption Property
Specifies the caption for the signer section on the signature widget.
Syntax
def get_widget_signer_caption() -> str: ... def set_widget_signer_caption(value: str) -> None: ...
widget_signer_caption = property(get_widget_signer_caption, set_widget_signer_caption)
Default Value
"#auto"
Remarks
Specifies the caption for the signer section on the signature widget.
The default value, which is used if the property is set to #auto, is "Signer: ".
widget_signer_info Property
Provides custom signer information to put on the signature widget.
Syntax
def get_widget_signer_info() -> str: ... def set_widget_signer_info(value: str) -> None: ...
widget_signer_info = property(get_widget_signer_info, set_widget_signer_info)
Default Value
"#auto"
Remarks
Provides custom signer information to put on the signature widget.
The standard signature widget allows for several short strings separated by CRLF. Keep this property set to #auto to make the component generate the signer text automatically.
add_widget_custom_data Method
Adds a custom data to the signature widget.
Syntax
def add_widget_custom_data(custom_data: str) -> int: ...
Remarks
Use this method to quickly add a custom data block that contains PDF graphics operators to your signature widget.
The method returns the index of the new custom text in the CustomText collection (accessed via config).
add_widget_text Method
Adds a text block to the signature widget.
Syntax
def add_widget_text(text: str, x: int, y: int, font_size: str) -> int: ...
Remarks
Use this method to quickly add a custom text block to your signature widget.
The method returns the index of the new custom text in the CustomText collection (accessed via config).
add_widget_text_ex Method
Adds a text block to the signature widget.
Syntax
def add_widget_text_ex(text: str, settings: str) -> int: ...
Remarks
Use this method to add a custom text block to your signature widget.
Text represents the text string to add. Settings contains a list of parameters in the form of PARAM1=VALUE1;PARAM2=VALUE2;... or in JSON format.
The following parameters are supported:
| "X" | The text offset from the left-hand signature widget border. | |
| "Y" | The text offset from the bottom signature widget border. | |
| "FontSize" | The font size of the text (single value, or two values separated with a space character that represent horizontal and vertical font sizes). | |
| "FontSizeX" | The horizontal font size of the text. | |
| "FontSizeY" | The vertical font size of the text. | |
| "FontName" | The font name or TrueType filename. It supports the same values as the Widget.FontName property. |
The method returns the index of the new custom text in the CustomText collection (accessed via config).
attach_bytes Method
Adds an attachment to the PDF document.
Syntax
def attach_bytes(data: bytes, obj_name: str, file_name: str, description: str, sub_type: str, c_date: str, m_date: str) -> None: ...
Remarks
Use this method to add an attachment (embedded file) to a PDF document.
attach_file Method
Adds an attachment to the PDF document.
Syntax
def attach_file(path: str, obj_name: str, file_name: str, description: str, sub_type: str, c_date: str, m_date: str) -> None: ...
Remarks
Use this method to add an attachment (embedded file) to a PDF document.
close Method
Closes an opened document.
Syntax
def close(save_changes: bool) -> None: ...
Remarks
Use this method to close a previously opened document. Set SaveChanges to true to apply any changes made.
config Method
Sets or retrieves a configuration setting.
Syntax
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 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, you must call Config("PROPERTY"). The value will be returned as a string.
do_action Method
Performs an additional action.
Syntax
def do_action(action_id: str, action_params: str) -> str: ...
Remarks
do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Common ActionIDs:
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
The PDFSigner class ActionIDs:
| Action | Description | |
| "AddImage" | Adds an image to the foreground layer. | |
| "GetTextWidth" | Calculates the width of the given text for a specific font. | |
| "GetSystemFontNames" | Gets the list of system font names. | |
| "IsAllGlyphsAvailable" | Checks if all glyphs from the given text are available for a specific font. |
Use "AddImage" action to add an image to the foreground layer. The following parameters are supported:
| "ImageData" | The image data in hex or base64 encoding. To use base64 encoding prepend an encoded data with "base64:" prefix. | |
| "ImageWidth" | The width of the image in pixels. | |
| "ImageHeight" | The height of the image in pixels. | |
| "ImageType" | The type of the image contained in ImageData parameter. Supported values: "jpeg", "jpeg2000", "custom". | |
| "ImageBitsPerComponent" | The number of bits per color space component for the image. | |
| "ImageColorSpace" | The image color space. Supported values: "RGB", "CMYK" and "Gray". | |
| "ImageInterpolate" | Specifies whether an image interpolation shall be performed by a conforming reader. | |
| "X" | The image offset from the left-hand signature widget border. | |
| "Y" | The image offset from the bottom signature widget border. | |
| "Width" | The width of the image in points. | |
| "Height" | The height of the image in points. |
Parameters ImageData, ImageWidth, ImageHeight, ImageType, X, Y, Width and Height are required.
Sample code to add a JPEG image of size 100px x 100px and place it in position (10, 10) with an image size (30, 30):
Signer.DoAction("AddImage",
"ImageData=" + Utils.HexEncode(BinaryImageData) +
"; ImageWidth=100; ImageHeight=100; ImageType=jpeg; X=10; Y=10; Width=30; Height=30");
Use "GetTextWidth" action to calculate the width of the given text for a specific font. The following parameters are supported:
| "Text" | Represent the text string for which you want to determine the width. | |
| "FontName" | The font name or TrueType filename. It supports the same values as Widget.FontName property. | |
| "FontSize" | The horizontal font size of the text. If omitted, the width of the text returned in units, and the width for a specific font size could be calculated by the formula: (Width / 1000) * FontSize |
Sample code:
Signer.DoAction("GetTextWidth",
"Text=Lorem Ipsum; FontSize=10; FontName=Arial Bold Italic");
Use "GetSystemFontNames" action to get a CRLF-separated list of system TrueType font names that the component supports.
Use "IsAllGlyphsAvailable" action to check if all glyphs that correspond to the given text are available for a specific font. The following parameters are required:
| "Text" | Represent the text string that you want to check. | |
| "FontName" | The font name or TrueType filename. It supports the same values as Widget.FontName property. |
For standard Type 1 fonts this action always returns a "true" value.
extract_async_data Method
Extracts user data from the DC signing service response.
Syntax
def extract_async_data(async_reply: str) -> str: ...
Remarks
Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.
The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.
get_attached_bytes Method
Saves a PDF attachment to a byte array.
Syntax
def get_attached_bytes(index: int) -> bytes: ...
Remarks
Use this method to retrieve the contents of an attached file as a byte array.
get_attached_file Method
Saves a PDF attachment to a file.
Syntax
def get_attached_file(index: int, path: str) -> None: ...
Remarks
Use this method to retrieve the contents of an attached file and save it to a file.
open Method
Opens a document for signing or updating.
Syntax
def open() -> None: ...
Remarks
Use this method to open a document for signing or updating. When finished, call close to complete or discard the operation.
reset Method
Resets the class settings.
Syntax
def reset() -> None: ...
Remarks
reset is a generic method available in every class.
revalidate Method
Revalidates a signature in accordance with current settings.
Syntax
def revalidate(sig_label: str) -> None: ...
Remarks
Use this method to re-validate a signature in the opened PDF document.
select_info Method
Select signature information for a specific entity.
Syntax
def select_info(entity_label: str, info_type: int, clear_selection: bool) -> None: ...
Remarks
Use this method to select (or filter) signature-related information for a specific signature element.
Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:
| sitEntity | 1 | Select the current entity |
| sitParentEntity | 2 | Select the parent entity of the current entity |
| sitTimestamps | 4 | Select all timestamps covering the current entity |
| sitSignatures | 8 | Select all signatures covering the current entity |
| sitSigningChain | 16 | Select the signing chain of the current entity |
| sitEmbeddedCertificates | 256 | Select all certificates embedded in the current entity |
| sitEmbeddedCRLs | 512 | Select all CRLs embedded in the current entity |
| sitEmbeddedOCSPs | 1024 | Select all OCSP responses embedded in the current entity |
| sitEmbeddedRevInfo | 1792 | Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs) |
| sitUsedCertificates | 4096 | Select all the certificates used to validate this entity's chain |
| sitUsedCRLs | 8192 | Select all the CRLs used to validate this entity's chain |
| sitUsedOCSPs | 16384 | Select all the OCSP responses used to validate this entity's chain |
| sitUsedRevInfo | 28672 | Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses) |
| sitAttributes | 65536 | Select this entity's CMS attributes |
| sitReferences | 131072 | Select this entity's XML references |
| sitSignedParts | 262144 | Select this entity's signed parts |
Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to select_info and keeping ClearSelection set to false.
This method is useful if you would like to read/display detailed information about a particular signature or timestamp.
sign Method
Signs a PDF document.
Syntax
def sign() -> None: ...
Remarks
Call this method to sign the document referenced by the input_file (or input_stream) property. The document will be signed with signing_certificate as configured in new_signature, and saved in output_file (output_stream).
Use trusted_certificates, known_certificates, revocation_check, offline_mode and other properties of the class to adjust chain validation parameters. After the signing, the chain validation log will be available in the property.
sign_async_begin Method
Initiates the asynchronous signing operation.
Syntax
def sign_async_begin() -> str: ...
Remarks
When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in output_file (or output_stream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.
Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to input_file (or input_stream), and call sign_async_end to finalize the signing.
Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the signing_certificate property.
Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to sign_async_end and expect it to recover the correct response from the batch automatically.
AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.
In a typical scenario you get a client-side async state from the sign_async_begin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the sign_async_end method.
There are some conditions that should be met when signing PDF documents asynchronously. The advanced PDF signature levels, specifically BES, EPES, and LTV, require that the 'signingCertificate' attribute is included in the signature. This can only be satisfied if either external_crypto is configured to use the asmdPKCS7 method, or the public copy of the signing certificate is provided on the pre-signing stage.
Please note that you will still be able to sign a document with the asmdPKCS1 method and no public copy of the certificate provided (resulting in the omission of the 'signingCertificate' attribute from the signature); however, most modern PDF processors will reject such signatures as invalid or non-compliant.
sign_async_end Method
Completes the asynchronous signing operation.
Syntax
def sign_async_end(async_reply: str) -> None: ...
Remarks
When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.
Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior sign_async_begin call to input_file (or input_stream). The method will embed the signature into the pre-signed document, and save the complete signed document to output_file (or output_stream).
Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the signing_certificate property.
Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (sign_async_begin) stage.
AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.
In a typical scenario you get a client-side async state from the sign_async_begin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the sign_async_end method.
sign_external Method
Signs the document using an external signing facility.
Syntax
def sign_external() -> None: ...
Remarks
Use this method to create a PDF signature using an external signing facility for the cryptographic computations. SignExternal delegates the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.
When all preparations are done and the hash is computed, the class fires the on_external_sign event which allows the hash value to be passed for signing.
update Method
Updates a signature.
Syntax
def update(sig_label: str) -> None: ...
Remarks
PDF signatures may be updated from time to time by embedding newer/missing revocation information. The update approach is typically used to extend the validity of an LTV signature. Set SigLabel to the label of the signature field to update.
Updating is typically accompanied with a document timestamping operation. Set timestamp_server to have the class obtain and embed a document timestamp for you.
Before calling this method, provide the signed document via the input_file (or input_stream) property. The updated document will be saved to output_file (or output_stream).
on_chain_element_download Event
Fires when there is a need to download a chain element from an online source.
Syntax
class PDFSignerChainElementDownloadEventParams(object): @property def kind() -> int: ... @property def cert_rdn() -> str: ... @property def ca_cert_rdn() -> str: ... @property def location() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class PDFSigner: @property def on_chain_element_download() -> Callable[[PDFSignerChainElementDownloadEventParams], None]: ... @on_chain_element_download.setter def on_chain_element_download(event_hook: Callable[[PDFSignerChainElementDownloadEventParams], None]) -> None: ...
Remarks
Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |
on_chain_element_needed Event
Fires when an element required to validate the chain was not located.
Syntax
class PDFSignerChainElementNeededEventParams(object): @property def kind() -> int: ... @property def cert_rdn() -> str: ... @property def ca_cert_rdn() -> str: ... # In class PDFSigner: @property def on_chain_element_needed() -> Callable[[PDFSignerChainElementNeededEventParams], None]: ... @on_chain_element_needed.setter def on_chain_element_needed(event_hook: Callable[[PDFSignerChainElementNeededEventParams], None]) -> None: ...
Remarks
Subscribe to this event to be notified about missing validation elements. Use the known_crls, known_certificates, and known_ocsps properties in the event handler to provide the missing piece.
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |
on_chain_validated Event
Reports the completion of a certificate chain validation.
Syntax
class PDFSignerChainValidatedEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def subject_rdn() -> str: ... @property def validation_result() -> int: ... @property def validation_details() -> int: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFSigner: @property def on_chain_validated() -> Callable[[PDFSignerChainValidatedEventParams], None]: ... @on_chain_validated.setter def on_chain_validated(event_hook: Callable[[PDFSignerChainValidatedEventParams], None]) -> None: ...
Remarks
This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.
ValidationResult set to 0 (zero) indicates successful chain validation.
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
on_chain_validation_progress Event
This event is fired multiple times during chain validation to report various stages of the validation procedure.
Syntax
class PDFSignerChainValidationProgressEventParams(object): @property def event_kind() -> str: ... @property def cert_rdn() -> str: ... @property def ca_cert_rdn() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class PDFSigner: @property def on_chain_validation_progress() -> Callable[[PDFSignerChainValidationProgressEventParams], None]: ... @on_chain_validation_progress.setter def on_chain_validation_progress(event_hook: Callable[[PDFSignerChainValidationProgressEventParams], None]) -> None: ...
Remarks
Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.
The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |
on_document_loaded Event
This event is fired when the document has been loaded into memory.
Syntax
class PDFSignerDocumentLoadedEventParams(object): @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFSigner: @property def on_document_loaded() -> Callable[[PDFSignerDocumentLoadedEventParams], None]: ... @on_document_loaded.setter def on_document_loaded(event_hook: Callable[[PDFSignerDocumentLoadedEventParams], None]) -> None: ...
Remarks
The handler for this event is a good place to check the document structure, which may be useful when preparing the signature. For example, you can use the pages information to find the optimal position for the signature widget.
Set Cancel to true to terminate document processing on this stage.
on_encrypted Event
Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document.
Syntax
class PDFSignerEncryptedEventParams(object): @property def cert_used() -> bool: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def need_credential() -> bool: ... @property def skip_this() -> bool: ... @skip_this.setter def skip_this(value) -> None: ... # In class PDFSigner: @property def on_encrypted() -> Callable[[PDFSignerEncryptedEventParams], None]: ... @on_encrypted.setter def on_encrypted(event_hook: Callable[[PDFSignerEncryptedEventParams], None]) -> None: ...
Remarks
The class fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.
This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the decryption_certificate or password property (depending on the encryption method used), or sets SkipThis to true.
The CertUsed parameter specifies the encryption method used. If set to true, it indicates that the document uses asymmetric (certificate-based) encryption. In that case, the IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own on_encrypted event loop.
CertUsed set to false indicates that the document uses password encryption. In this case, provide the password via the password property.
The NeedCredential parameter specifies whether the correct credential is already available to the class or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the password property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.
on_error Event
Information about errors during signing/validation.
Syntax
class PDFSignerErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class PDFSigner: @property def on_error() -> Callable[[PDFSignerErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[PDFSignerErrorEventParams], None]) -> None: ...
Remarks
The event is fired in case of exceptional conditions during PDF processing.
ErrorCode contains an error code and Description contains a textual description of the error.
on_external_decrypt Event
Handles remote or external decryption.
Syntax
class PDFSignerExternalDecryptEventParams(object): @property def operation_id() -> str: ... @property def algorithm() -> str: ... @property def pars() -> str: ... @property def encrypted_data() -> str: ... @property def data() -> str: ... @data.setter def data(value) -> None: ... # In class PDFSigner: @property def on_external_decrypt() -> Callable[[PDFSignerExternalDecryptEventParams], None]: ... @on_external_decrypt.setter def on_external_decrypt(event_hook: Callable[[PDFSignerExternalDecryptEventParams], None]) -> None: ...
Remarks
Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.
The class uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.
Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
on_external_sign Event
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
class PDFSignerExternalSignEventParams(object): @property def operation_id() -> str: ... @property def hash_algorithm() -> str: ... @property def pars() -> str: ... @property def data() -> str: ... @property def signed_data() -> str: ... @signed_data.setter def signed_data(value) -> None: ... # In class PDFSigner: @property def on_external_sign() -> Callable[[PDFSignerExternalSignEventParams], None]: ... @on_external_sign.setter def on_external_sign(event_hook: Callable[[PDFSignerExternalSignEventParams], None]) -> None: ...
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
on_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class PDFSignerNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class PDFSigner: @property def on_notification() -> Callable[[PDFSignerNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[PDFSignerNotificationEventParams], None]) -> None: ...
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
This class can fire this event with the following EventID values:
| DocumentLoaded | Reports the completion of PDF document processing by the component. Use the event handler to access document-related information, such as page number and document file details. The EventParam value passed with this EventID is empty. |
| BeforeTimestamp | This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings. |
| TimestampError | This event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info. |
| TimestampRequest | A timestamp is requested from the custom timestamping
authority. This event is only fired if timestamp_server was set to a
virtual:// URI. The EventParam parameter contains the
TSP request (or the plain hash, depending on the value provided to
timestamp_server), in base16, that needs to be sent to the TSA.
Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property. |
| BeforeDocumentTimestamp | This event is fired before adding document timestamp. Use the event handler to modify signature settings. |
| SignatureWidgetPrepare | Another copy of the signature widget needs
to be configured. Use the event handler to configure individual widgets
when creating multi-widget signatures. The on_notification event with this
event ID will be fired repeatedly until the LastSignatureWidget
configuration setting is set to true.
The EventParam value passed with this EventID is empty. |
| SignaturesLoaded | Notifies the application that the component has finished loading signatures. |
on_pre_render_widget Event
Fires when a signature widget is ready to be written to the document.
Syntax
class PDFSignerPreRenderWidgetEventParams(object): @property def add_another() -> bool: ... @add_another.setter def add_another(value) -> None: ... @property def reset_another() -> bool: ... @reset_another.setter def reset_another(value) -> None: ... # In class PDFSigner: @property def on_pre_render_widget() -> Callable[[PDFSignerPreRenderWidgetEventParams], None]: ... @on_pre_render_widget.setter def on_pre_render_widget(event_hook: Callable[[PDFSignerPreRenderWidgetEventParams], None]) -> None: ...
Remarks
The class fires this event when it is ready to insert a new instance of the signature widget to the document. This event is fired repeatedly until the event handler sets the AddAnother parameter to false, allowing your application to create as many copies of the signature widget as required.
You can use this event handler to adjust the look of each widget copy. Set the ResetAnother parameter to true to automatically clean up all the existing widget settings after the current widget is saved. Setting ResetAnother to true will let you start every new widget from scratch. Keeping it set to false would result in every new widget looking the same as the previous one.
on_signature_found Event
Signifies the start of signature validation.
Syntax
class PDFSignerSignatureFoundEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def cert_found() -> bool: ... @property def validate_signature() -> bool: ... @validate_signature.setter def validate_signature(value) -> None: ... @property def validate_chain() -> bool: ... @validate_chain.setter def validate_chain(value) -> None: ... # In class PDFSigner: @property def on_signature_found() -> Callable[[PDFSignerSignatureFoundEventParams], None]: ... @on_signature_found.setter def on_signature_found(event_hook: Callable[[PDFSignerSignatureFoundEventParams], None]) -> None: ...
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.
The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
on_signature_validated Event
Marks the completion of the signature validation routine.
Syntax
class PDFSignerSignatureValidatedEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def validation_result() -> int: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFSigner: @property def on_signature_validated() -> Callable[[PDFSignerSignatureValidatedEventParams], None]: ... @on_signature_validated.setter def on_signature_validated(event_hook: Callable[[PDFSignerSignatureValidatedEventParams], None]) -> None: ...
Remarks
This event is fired upon the completion of the signature validation routine, and reports the respective validation result.
Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
on_timestamp_found Event
Signifies the start of a timestamp validation routine.
Syntax
class PDFSignerTimestampFoundEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def cert_found() -> bool: ... @property def validate_timestamp() -> bool: ... @validate_timestamp.setter def validate_timestamp(value) -> None: ... @property def validate_chain() -> bool: ... @validate_chain.setter def validate_chain(value) -> None: ... # In class PDFSigner: @property def on_timestamp_found() -> Callable[[PDFSignerTimestampFoundEventParams], None]: ... @on_timestamp_found.setter def on_timestamp_found(event_hook: Callable[[PDFSignerTimestampFoundEventParams], None]) -> None: ...
Remarks
This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.
The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.
Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
on_timestamp_request Event
Fires when the class is ready to request a timestamp from an external TSA.
Syntax
class PDFSignerTimestampRequestEventParams(object): @property def tsa() -> str: ... @property def timestamp_request() -> str: ... @property def timestamp_response() -> str: ... @timestamp_response.setter def timestamp_response(value) -> None: ... @property def suppress_default() -> bool: ... @suppress_default.setter def suppress_default(value) -> None: ... # In class PDFSigner: @property def on_timestamp_request() -> Callable[[PDFSignerTimestampRequestEventParams], None]: ... @on_timestamp_request.setter def on_timestamp_request(event_hook: Callable[[PDFSignerTimestampRequestEventParams], None]) -> None: ...
Remarks
Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.
The TSA parameter indicates the timestamping service being used. It matches the value passed to the timestamp_server property. Set the SuppressDefault parameter to false if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.
on_timestamp_validated Event
Reports the completion of the timestamp validation routine.
Syntax
class PDFSignerTimestampValidatedEventParams(object): @property def index() -> int: ... @property def entity_label() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def time() -> str: ... @property def validation_result() -> int: ... @property def chain_validation_result() -> int: ... @property def chain_validation_details() -> int: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFSigner: @property def on_timestamp_validated() -> Callable[[PDFSignerTimestampValidatedEventParams], None]: ... @on_timestamp_validated.setter def on_timestamp_validated(event_hook: Callable[[PDFSignerTimestampValidatedEventParams], None]) -> None: ...
Remarks
This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
on_tls_cert_needed Event
Fires when a remote TLS party requests a client certificate.
Syntax
class PDFSignerTLSCertNeededEventParams(object): @property def host() -> str: ... @property def ca_names() -> str: ... # In class PDFSigner: @property def on_tls_cert_needed() -> Callable[[PDFSignerTLSCertNeededEventParams], None]: ... @on_tls_cert_needed.setter def on_tls_cert_needed(event_hook: Callable[[PDFSignerTLSCertNeededEventParams], None]) -> None: ...
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the tls_client_chain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the on_tls_handshake event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.
on_tls_cert_validate Event
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
class PDFSignerTLSCertValidateEventParams(object): @property def server_host() -> str: ... @property def server_ip() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class PDFSigner: @property def on_tls_cert_validate() -> Callable[[PDFSignerTLSCertValidateEventParams], None]: ... @on_tls_cert_validate.setter def on_tls_cert_validate(event_hook: Callable[[PDFSignerTLSCertValidateEventParams], None]) -> None: ...
Remarks
This event is fired during a TLS handshake. Use the tls_server_chain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.
on_tls_established Event
Fires when a TLS handshake with Host successfully completes.
Syntax
class PDFSignerTLSEstablishedEventParams(object): @property def host() -> str: ... @property def version() -> str: ... @property def ciphersuite() -> str: ... @property def connection_id() -> bytes: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class PDFSigner: @property def on_tls_established() -> Callable[[PDFSignerTLSEstablishedEventParams], None]: ... @on_tls_established.setter def on_tls_established(event_hook: Callable[[PDFSignerTLSEstablishedEventParams], None]) -> None: ...
Remarks
The class uses this event to notify the application about a successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
on_tls_handshake Event
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
class PDFSignerTLSHandshakeEventParams(object): @property def host() -> str: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class PDFSigner: @property def on_tls_handshake() -> Callable[[PDFSignerTLSHandshakeEventParams], None]: ... @on_tls_handshake.setter def on_tls_handshake(event_hook: Callable[[PDFSignerTLSHandshakeEventParams], None]) -> None: ...
Remarks
The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the on_tls_established event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.
on_tls_shutdown Event
Reports the graceful closure of a TLS connection.
Syntax
class PDFSignerTLSShutdownEventParams(object): @property def host() -> str: ... # In class PDFSigner: @property def on_tls_shutdown() -> Callable[[PDFSignerTLSShutdownEventParams], None]: ... @on_tls_shutdown.setter def on_tls_shutdown(event_hook: Callable[[PDFSignerTLSShutdownEventParams], None]) -> None: ...
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
PDFSigner 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 method.PDFSigner Config Settings
Supported values are:
| GTS_PDFA1.sRGB | GTS_PDFA1 corresponding to the PDF/A standard as defined by ISO 19005. sRGB IEC61966-2.1 is a standard color space. | |
| GTS_PDFX.sRGB | GTS_PDFX corresponding to the PDF/X format standard specified in ISO 15930. sRGB IEC61966-2.1 is a standard color space. |
Output intents describe the final destination device you will use to reproduce the color in the PDF, such as the separations printing device. Output intents override working spaces during viewing and printing, but they do not convert the colors in the PDF.
Supported values are:
| AcrobatFriendlyAcroForm | Acrobat reader friendly form | |
| AdjustTimesToUTC | Asserts that all the time properties are set in local time and should be adjusted to UTC when writing to the document |
Note: This property ignored and always disabled for PAdES levels BES/EPES/BaselineB/BaselineT. For PAdES levels LTV/BaselineLT/BaselineLTA this property is also ignored and always enabled if IncludeKnownRevocationInfoToSignature property is disabled.
The default value is 0, which means that BitsPerComponent is set automatically according to the widget's property.
Supported values are:
For advanced settings of the build properties, use the BuildProperties configuration setting.
For advanced settings of the build properties, use the BuildProperties configuration setting.
Sample value:
{
"App":{
"Name":"TestApp",
"REx":"8.0.0"
}
}
The above value sets the application name and version used to create the signature. The same result could be achieved using the BuildApplicationName and BuildApplicationVersion configuration settings.
Sample value 2:
{
"App":{
"Name":"TestApp",
"REx":"8.0.0",
"R":524288,
"Date":"2023-01-01 00:01",
"OS":[
"Win"
],
"TrustedMode":true
},
"Filter":{
"Name":"TestFilter",
"R":131101,
"Date":"2023-01-01 00:02",
"PreRelease":true
},
"PubSec":{
"R":13102,
"Date":"2023-01-01 00:03",
"PreRelease":true,
"NonEFontNoWarn":true
}
}
This property enables collection of revocation info for any new ("fresh") timestamps, that are created during the current operation, such as signing or updating a signature with a document timestamp.
Note that revocation info for existing timestamps is always collected when updating the signature that contains them, regardless of this setting.
TBD
Supported values are:
| none | No extensions | |
| ESIC | ESIC Extension Level 2 | |
| ADBE | Adobe Extension Level 8 | |
| ADBEIfNotPresent | Adobe Extension Level 8 if not present | |
| Both | Both (ESIC and Adobe) extensions |
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the trusted_certificates property) are considered trusted.
TBD
Note: it makes sense to disable AutoCollectRevocationInfo property when using this property. TBD equals to IncludeKnownRevocationInfoToSignature
Note: it makes sense to disable AutoCollectRevocationInfo property when using this property.
Note: it makes sense to disable AutoCollectRevocationInfo property when using this property. TBD equals to IncludeKnownRevocationInfoToSignature
This setting is used by the on_notification event when the EventID parameter is "SignatureWidgetPrepare" to allow support for multi-widget signatures.
The following values are supported:
| "auto" | Default value. The class automatically select the hash algorithm based on the PDF document version. For version 1.6 and higher it uses "none" value, for the other versions it uses MD5 hash algorithm. | |
| "MD5" | The class uses MD5 hash algorithm. | |
| "SHA1" | The class uses SHA1 hash algorithm. | |
| "none" | The class will not calculate a digest and will not include DigestLocation, DigestMethod, and DigestValue keys of the Signature References dictionary. |
Supported values are:
| UseSigningCertificateV2 | When this flag is set, the signing certificate V2 attribute will be used. | |
| IncludeAllRevInfoToDSS | When this flag is set, the full set of revocation information will be included in the DSS dictionary. | |
| CreateVRIDictionaries | When this flag is set, VRI dictionaries will be created. A VRI dictionary references all the validation data that has been used for validating one specific signature. | |
| UseUndefBEREncoding | When this flag is set, ASN.1 tags with undefined sizes are allowed in the signature. | |
| TolerateMissingSigningCertificate | When this flag is set, a missing signing certificate attribute will be tolerated. | |
| CompressDSS | When this flag is set, content in DSS dictionary will be compressed. | |
| CreatePBADCompatibleSignature | When this flag is set, the PBAD.PAdES compatible signature is created. | |
| EnforcePDFACompliance | When this flag is set, the component will enforce PDF/A compliance during signing. In rare cases this may lead to exceptions being thrown if the signing chain is too heavy to fit into the PDF/A restrictions. |
Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'
The following values are supported:
| "auto" | Default value. The class automatically reassembles PDF documents in case they contain errors that may invalidate new signatures. | |
| "disabled" | The class never reassembles PDF documents. This value is not recommended. | |
| "enabled" | The class always reassembles PDF documents. | |
| "hybrid" | The class reassembles PDF documents in the same cases as in "auto" mode and additionally reassembles hybrid PDF documents - documents that contain cross-reference tables and cross-reference streams. |
This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: Scheme=PSS;SaltSize=32;TrailerField=1.
Supported values are:
| SuppressEmptyAuthorName | When this flag is not set, the author name in the signature is set to "Not specified". | |
| AddAnnotationForInvisibleSignature | When this flag is set, the annotation object is added for invisible signatures. |
- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated
In case of a timestamping failure, provide new TSA and HTTP settings inside the on_notification event handler ('BeforeTimestamp' and 'TimestampError' event IDs).
Note: Unlike other classs, PDFSigner class uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp.
With this property set to the default setting (default), Update() refreshes the validation details included in the signature using any available revocation information sources. It also seals the added elements with a Document Timestamp if the TSA is provided through the timestamp_server property.
The only alternative setting is TimestampOnly, which instructs Update() to only timestamp the updated non-timestamped signature with a signature timestamp. No validation information collection is performed and no Document Timestamp is added. The TimestampOnly variant requires the timestamp_server property to be set.
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
This property extends the new_sig_height property to allow the height of the signature widget to be specified in fractional points.
This property extends the new_sig_offset_x property to allow the offset of the signature widget to be specified in fractional points.
This property extends the new_sig_offset_y property to allow the offset of the signature widget to be specified in fractional points.
This property extends the new_sig_width property to allow the width of the signature widget to be specified in fractional points.
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
| time | Current time | |
| level | Level | |
| package | Package name | |
| module | Module name | |
| class | Class name | |
| method | Method name | |
| threadid | Thread Id | |
| contenttype | Content type | |
| content | Content | |
| all | All details |
Supported filter names are:
| exclude-package | Exclude a package specified in the value | |
| exclude-module | Exclude a module specified in the value | |
| exclude-class | Exclude a class specified in the value | |
| exclude-method | Exclude a method specified in the value | |
| include-package | Include a package specified in the value | |
| include-module | Include a module specified in the value | |
| include-class | Include a class specified in the value | |
| include-method | Include a method specified in the value |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
| none | None (by default) | |
| fatal | Severe errors that cause premature termination. | |
| error | Other runtime errors or unexpected conditions. | |
| warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
| info | Interesting runtime events (startup/shutdown). | |
| debug | Detailed information on flow of through the system. | |
| trace | More detailed information. |
The default value of this setting is 100.
| none | No rotation | |
| deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
| keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
PDFSigner Errors
PDFSigner Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 26214401 | The input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS) |
| 26214402 | Cannot encrypt already encrypted file (SB_ERROR_PDF_ENCRYPTED) |
| 26214403 | The file is not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED) |
| 26214405 | Invalid password (SB_ERROR_PDF_INVALID_PASSWORD) |
| 26214406 | Failed to decrypt the file (SB_ERROR_PDF_DECRYPTION_FAILED) |
| 26214407 | The document is signed (SB_ERROR_PDF_SIGNED) |
| 26214408 | The document is not signed (SB_ERROR_PDF_NOT_SIGNED) |
| 26214409 | Cannot update this type of signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE) |
| 26214410 | Unsupported feature or operation (SB_ERROR_PDF_NOT_SUPPORTED) |
| 26214411 | No timestamp server specified (SB_ERROR_PDF_NO_TIMESTAMP_SERVER) |
| 26214412 | The component is not in edit mode (SB_ERROR_PDF_READONLY) |