ASiCVerifier Class
Properties Methods Events Config Settings Errors
The ASiCVerifier class verifies signature containers.
Syntax
class secureblackbox.ASiCVerifier
Remarks
ASiCVerifier provides the functionality of verifying signatures residing in Associated Signature Containers.
Both ASiC-S and ASiC-E profiles are supported.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| all_signatures_valid | The cumulative validity of all signatures. |
| auto_validate_signatures | Specifies whether ASiCVerifier 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 (a setting in the BasicConstraints extension). |
| cert_ca_key_id | A unique identifier (fingerprint) of the CA certificate's private key. |
| cert_crl_distribution_points | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| cert_curve | Specifies the elliptic curve of the EC 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 | Specifies the hash algorithm to be used in the operations on the certificate (such as key 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 . |
| cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
| cert_issuer_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| cert_key_algorithm | Specifies the public key algorithm of this certificate. |
| cert_key_bits | Returns the length of the public key. |
| cert_key_fingerprint | Returns a 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 (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| cert_policy_i_ds | Contains identifiers (OIDs) of the applicable certificate policies. |
| cert_public_key_bytes | Contains the certificate's public key in DER format. |
| 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_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_key_id | Contains a unique identifier (fingerprint) of the certificate's private key. |
| cert_subject_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| 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. |
| crl_count | The number of records in the CRL arrays. |
| crl_bytes | Returns the raw CRL data in DER format. |
| 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_this_update | The date and time at which this version of the CRL was published. |
| extraction_mode | Specifies which entries should be extracted from the container upon verification. |
| file_count | The number of records in the File arrays. |
| file_action | The action to apply to the file. |
| file_compressed_size | The size of the file after compression. |
| file_data_source | The type of the data source for this entry. |
| file_directory | Tells if the entry is a directory or a regular file. |
| file_encryption_algorithm | Returns the symmetric algorithm that was used to encrypt the file. |
| file_encryption_key_length | Returns the length, in bits, of the encryption key. |
| file_encryption_type | The type of encryption applied to the file. |
| file_file_name | The original name of the compressed file or folder. |
| file_folder | The containing folder of the entry. |
| file_local_path | The local path associated with this entry. |
| file_m_time | The entry's last modification time. |
| file_new_file | Indicates whether the entry corresponds to a file to be added to the archive. |
| file_path | The full internal path of the archived entry. |
| file_signature_count | The number of signatures covering the entry. |
| file_signed | Indicates whether the entry is signed. |
| file_size | The size of the file before compression. |
| 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 | A path to the ASiC container to process. |
| known_cert_count | The number of records in the KnownCert arrays. |
| known_cert_bytes | Returns the raw certificate data in DER format. |
| known_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| known_crl_count | The number of records in the KnownCRL arrays. |
| known_crl_bytes | Returns the raw CRL data in DER format. |
| known_crl_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| known_ocsp_count | The number of records in the KnownOCSP arrays. |
| known_ocsp_bytes | A buffer containing the raw OCSP response data. |
| known_ocsp_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| ocsp_count | The number of records in the OCSP arrays. |
| ocsp_bytes | A buffer containing the raw OCSP response data. |
| ocsp_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. |
| 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 where the processed data will be saved. |
| output_path | A local path to extract the files to. |
| profile | Specifies a pre-defined profile to apply when creating the signature. |
| 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_certificate_index | Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection. |
| 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 signature's creation time. |
| signature_content_type | The signature content type. |
| signature_file_name | The name of the ASiC signature file. |
| signature_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| signature_hash_algorithm | Set or returns the hash algorithm used to generate the signature. |
| signature_issuer_rdn | The Relative Distinguished Name of the signing certificate's issuer. |
| signature_level | Specifies the level according to which the inner AdES signature is to be composed CAdES and XAdES standards define a number of signature levels. |
| signature_policy_hash | The signature policy hash value. |
| signature_policy_hash_algorithm | The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash. |
| signature_policy_id | The policy ID that was included or to be included into the signature. |
| signature_policy_uri | The signature policy URI that was included in the signature. |
| signature_serial_number | The serial number of the timestamp. |
| signature_signature_bytes | Returns the binary representation of the ASiC signature. |
| signature_signature_type | The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown. |
| signature_signature_validation_result | The outcome of the cryptographic signature validation. |
| signature_signed_files | Contains a comma-separated list of files that are covered by the signature. |
| 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. |
| 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_hash_algorithm | Returns the timestamp's hash algorithm. |
| timestamp_serial_number | Returns the timestamp's serial number. |
| timestamp_signature_index | Returns the index of the owner signature, if applicable. |
| 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. |
| 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_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| 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_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. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| close | Closes an opened container. |
| config | Sets or retrieves a configuration setting. |
| do_action | Performs an additional action. |
| extract_file | Extracts a file to one of the output media (bytes, stream, or disk file). |
| extract_files | Extracts files covered by a signature to OutputPath . |
| open | Opens an existing container for signing or updating. |
| revalidate | Revalidates a signature in accordance with current settings. |
| unsign | Deletes a signature from the container. |
| verify | Verifies all signatures in the ASiC container. |
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_element_store | This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature. |
| 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_container_loaded | This event is fired when the container has been loaded into memory. |
| on_error | Information about errors during ASiC signature verification. |
| on_file_extraction_start | Signifies the start of a file extraction process. |
| on_notification | This event notifies the application about an underlying control flow event. |
| on_signature_found | Signifies the start of signature validation. |
| on_signature_validated | Marks the completion of the signature validation routine. |
| on_timestamp_found | Signifies the start of a timestamp validation routine. |
| on_timestamp_validated | Reports the completion of the timestamp validation routine. |
| on_tls_cert_needed | Fires when a remote TLS party requests a client certificate. |
| on_tls_cert_validate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| on_tls_established | Fires when a TLS handshake with Host successfully completes. |
| on_tls_handshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
| on_tls_shutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| DislikeOpenEndedOCSPs | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. |
| ExtractToMemory | Tells the class to extract the current entry to memory. |
| 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. |
| IgnoreChainLoops | Whether chain loops should be ignored. |
| IgnoreChainValidationErrors | Enable this property to ignore any chain validation issues. |
| IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| PolicyExplicitText | The explicit text of the user notice. |
| PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
| ProductionPlace | The production place XAdES attribute. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| TempPath | Path for storing temporary files. |
| 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. |
| UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| UseUTF8Filenames | Specifies whether to use UTF-8 filenames. |
| UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
| 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. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| 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. |
| 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. |
| 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. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
all_signatures_valid Property
The cumulative validity of all signatures.
Syntax
def get_all_signatures_valid() -> bool: ...
all_signatures_valid = property(get_all_signatures_valid, None)
Default Value
FALSE
Remarks
Use this property to check if all the signatures found in the message or document are valid.
This property is read-only.
auto_validate_signatures Property
Specifies whether ASiCVerifier 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
TRUE
Remarks
This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the revalidate method.
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_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_policy_i_ds
- cert_public_key_bytes
- cert_self_signed
- cert_serial_number
- cert_sig_algorithm
- cert_subject
- cert_subject_key_id
- cert_subject_rdn
- 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 (a setting in the BasicConstraints extension).
Syntax
def get_cert_ca(cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints 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_ca_key_id Property
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
def get_cert_ca_key_id(cert_index: int) -> bytes: ...
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
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
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
def get_cert_crl_distribution_points(cert_index: int) -> str: ...
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
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 of the EC public key.
Syntax
def get_cert_curve(cert_index: int) -> str: ...
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| 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) -> bytes: ...
Remarks
Contains the fingerprint (a hash imprint) of this 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_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 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
Specifies the hash algorithm to be used in the operations on the certificate (such as key 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 .
Syntax
def get_cert_hash_algorithm(cert_index: int) -> str: ...
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key 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 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.
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 collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
def get_cert_issuer_rdn(cert_index: int) -> str: ...
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
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 |
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.
Syntax
def get_cert_key_bits(cert_index: int) -> int: ...
Default Value
0
Remarks
Returns the length of the public 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_fingerprint Property
Returns a fingerprint of the public key contained in the certificate.
Syntax
def get_cert_key_fingerprint(cert_index: int) -> bytes: ...
Remarks
Returns a fingerprint 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_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 |
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 (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
def get_cert_ocsp_locations(cert_index: int) -> str: ...
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the 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_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.
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.
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 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.
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.
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 (fingerprint) of the certificate's private key.
Syntax
def get_cert_subject_key_id(cert_index: int) -> bytes: ...
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
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 with a SHA1 hash of the bit string of the subject public 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_subject_rdn Property
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
def get_cert_subject_rdn(cert_index: int) -> str: ...
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
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.
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:
The array indices start at 0 and end at crl_count - 1.This property is read-only.
crl_bytes Property
Returns the raw CRL data in DER format.
Syntax
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.
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_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.
extraction_mode Property
Specifies which entries should be extracted from the container upon verification.
Syntax
def get_extraction_mode() -> int: ... def set_extraction_mode(value: int) -> None: ...
extraction_mode = property(get_extraction_mode, set_extraction_mode)
Default Value
0
Remarks
Use this property to choose entries that should be extracted in the verify method. Choose between extracting all files, signed-only, signed and with verified signature, and none at all (verify-only mode).
| aemNone | 0 |
| aemAll | 1 |
| aemSigned | 2 |
| aemSignedAndValid | 3 |
file_count Property
The number of records in the File arrays.
Syntax
def get_file_count() -> int: ...
file_count = property(get_file_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- file_action
- file_compressed_size
- file_data_source
- file_directory
- file_encryption_algorithm
- file_encryption_key_length
- file_encryption_type
- file_file_name
- file_folder
- file_local_path
- file_m_time
- file_new_file
- file_path
- file_signature_count
- file_signed
- file_size
This property is read-only.
file_action Property
The action to apply to the file.
Syntax
def get_file_action(file_index: int) -> int: ...
Default Value
0
Remarks
The action to apply to the file.
Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:
| atAdd (0) | Add the file to the archive |
| atKeep (1) | Keep the existing file in the archive |
| atUpdate (2) | Update the archived file with a fresher copy |
| atDelete (3) | Delete the file from the archive |
| atExtract (4) | Extract the file (extraction only) |
| atSkip (5) | Skip file extraction (extraction only) |
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_compressed_size Property
The size of the file after compression.
Syntax
def get_file_compressed_size(file_index: int) -> int: ...
Default Value
0
Remarks
The size of the file after compression.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_data_source Property
The type of the data source for this entry.
Syntax
def get_file_data_source(file_index: int) -> int: ...
Default Value
0
Remarks
The type of the data source for this entry.
Use this property to control the data source for this entry.
| fdsFile (0) | The data for this entry should be taken from the file provided via file_local_path. |
| fdsStream (1) | The data is going to be provided on-the-fly via the FileStream property. |
| fdsBuffer (2) | The data is going to be provided on-the-fly via the FileData property. |
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_directory Property
Tells if the entry is a directory or a regular file.
Syntax
def get_file_directory(file_index: int) -> bool: ...
Default Value
FALSE
Remarks
Tells if the entry is a directory or a regular file.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_encryption_algorithm Property
Returns the symmetric algorithm that was used to encrypt the file.
Syntax
def get_file_encryption_algorithm(file_index: int) -> str: ...
Default Value
""
Remarks
Returns the symmetric algorithm that was used to encrypt the file.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_encryption_key_length Property
Returns the length, in bits, of the encryption key.
Syntax
def get_file_encryption_key_length(file_index: int) -> int: ...
Default Value
0
Remarks
Returns the length, in bits, of the encryption key.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_encryption_type Property
The type of encryption applied to the file.
Syntax
def get_file_encryption_type(file_index: int) -> int: ...
Default Value
0
Remarks
The type of encryption applied to the file.
Use this property to find out what kind of encryption was applied to the file.
| aetDefault (0) | Default encryption (not used for already encrypted files) |
| aetNoEncryption (1) | No encryption |
| aetGeneric (2) | Standard ZIP encryption |
| aetWinZip (3) | WinZIP-based encryption |
| aetStrong (4) | Strong encryption |
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_file_name Property
The original name of the compressed file or folder.
Syntax
def get_file_file_name(file_index: int) -> str: ...
Default Value
""
Remarks
The original name of the compressed file or folder.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_folder Property
The containing folder of the entry.
Syntax
def get_file_folder(file_index: int) -> str: ...
Default Value
""
Remarks
The containing folder of the entry.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_local_path Property
The local path associated with this entry.
Syntax
def get_file_local_path(file_index: int) -> str: ...
Default Value
""
Remarks
The local path associated with this entry. It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_m_time Property
The entry's last modification time.
Syntax
def get_file_m_time(file_index: int) -> str: ...
Default Value
""
Remarks
The entry's last modification time.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_new_file Property
Indicates whether the entry corresponds to a file to be added to the archive.
Syntax
def get_file_new_file(file_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the entry corresponds to a file to be added to the archive.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_path Property
The full internal path of the archived entry.
Syntax
def get_file_path(file_index: int) -> str: ...
Default Value
""
Remarks
The full internal path of the archived entry.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_signature_count Property
The number of signatures covering the entry.
Syntax
def get_file_signature_count(file_index: int) -> int: ...
Default Value
0
Remarks
The number of signatures covering the entry.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_signed Property
Indicates whether the entry is signed.
Syntax
def get_file_signed(file_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the entry is signed.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
file_size Property
The size of the file before compression.
Syntax
def get_file_size(file_index: int) -> int: ...
Default Value
0
Remarks
The size of the file before compression.
The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.
This property is read-only.
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
A path to the ASiC container to process.
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 signature container. Use input_stream to provide the container from memory rather than a disk file.
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.
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:
The array indices start at 0 and end at ocsp_count - 1.This property is read-only.
ocsp_bytes Property
A buffer containing the raw OCSP response data.
Syntax
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_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.
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 where the processed data will be saved.
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
Provides a path to the file where the class should save the updated container.
output_path Property
A local path to extract the files to.
Syntax
def get_output_path() -> str: ... def set_output_path(value: str) -> None: ...
output_path = property(get_output_path, set_output_path)
Default Value
""
Remarks
Assign this property with a path where the extracted files (selected according to extraction_mode criteria) are to be saved.
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.
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_certificate_index
- signature_chain_validation_details
- signature_chain_validation_result
- signature_claimed_signing_time
- signature_content_type
- signature_file_name
- signature_handle
- signature_hash_algorithm
- signature_issuer_rdn
- signature_level
- signature_policy_hash
- signature_policy_hash_algorithm
- signature_policy_id
- signature_policy_uri
- signature_serial_number
- signature_signature_bytes
- signature_signature_type
- signature_signature_validation_result
- signature_signed_files
- signature_subject_key_id
- signature_subject_rdn
- signature_timestamped
- signature_validated_signing_time
- signature_validation_log
This property is read-only.
signature_certificate_index Property
Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection.
Syntax
def get_signature_certificate_index(signature_index: int) -> int: ...
Default Value
-1
Remarks
Returns the index of the signing certificate in the Certificates collection
Use this property to look up the signing certificate in the Certificates collection.
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 signature's creation time.
Syntax
def get_signature_claimed_signing_time(signature_index: int) -> str: ...
Default Value
""
Remarks
Returns or sets 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_content_type Property
The signature content type.
Syntax
def get_signature_content_type(signature_index: int) -> str: ...
Default Value
""
Remarks
The signature content type.
Use this property to get or set the content type OID to be included 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_file_name Property
The name of the ASiC signature file.
Syntax
def get_signature_file_name(signature_index: int) -> str: ...
Default Value
""
Remarks
The name of the ASiC signature file.
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
Set or returns the hash algorithm used to generate the signature.
Syntax
def get_signature_hash_algorithm(signature_index: int) -> str: ...
Default Value
""
Remarks
Set or returns the hash algorithm used to generate the signature.
Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use.
| 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_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 level according to which the inner AdES signature is to be composed CAdES and XAdES standards define a number of signature levels.
Syntax
def get_signature_level(signature_index: int) -> int: ...
Default Value
0
Remarks
Specifies the level according to which the inner AdES signature is to be composed
CAdES and XAdES standards define a number of signature levels. The main differences between levels are in the scope of validation information included to the signature. BES signatures only include the most necessary information (the signing chain), whereas XL and A signatures include the complete set.
The supported levels are:
| aslUnknown | 0 | |
| aslBES | 1 | BES form |
| aslEPES | 2 | EPES form |
| aslT | 3 | T form |
| aslC | 4 | C form |
| aslXType1 | 5 | X form (type 1) |
| aslXType2 | 6 | X form (type 2) |
| aslXLType1 | 7 | X-L form (type 1) |
| aslXLType2 | 8 | X-L form (type 2) |
| aslBaselineB | 9 | Baseline B (B-B, basic) |
| aslBaselineT | 10 | Baseline T (B-T, timestamped) |
| aslBaselineLT | 11 | Baseline LT (B-LT, long-term) |
| aslBaselineLTA | 12 | Baseline LTA (B-LTA, long-term with archived timestamp) |
| aslExtendedBES | 13 | Extended BES form |
| aslExtendedEPES | 14 | Extended EPES form |
| aslExtendedT | 15 | Extended T form |
| aslExtendedC | 16 | Extended C form |
| aslExtendedXType1 | 17 | Extended X form (type 1) |
| aslExtendedXType2 | 18 | Extended X form (type 2) |
| aslExtendedXLType1 | 19 | Extended X-L form (type 1) |
| aslExtendedXLType2 | 20 | Extended X-L form (type 1) |
| aslA | 21 | A form |
| aslExtendedA | 22 | Extended A form |
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.
Syntax
def get_signature_policy_hash(signature_index: int) -> str: ...
Default Value
""
Remarks
The signature policy hash value.
Use this property to get the signature policy hash 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_policy_hash_algorithm Property
The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm 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
Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from signature_policy_hash.
| 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_policy_id Property
The policy ID that was included or to be included into the signature.
Syntax
def get_signature_policy_id(signature_index: int) -> str: ...
Default Value
""
Remarks
The policy ID that was included or to be included into the signature.
Use this property to retrieve the signature policy identifier 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_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_serial_number Property
The serial number of the timestamp.
Syntax
def get_signature_serial_number(signature_index: int) -> bytes: ...
Remarks
The serial number of the 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_signature_bytes Property
Returns the binary representation of the ASiC signature.
Syntax
def get_signature_signature_bytes(signature_index: int) -> bytes: ...
Remarks
Returns the binary representation of the ASiC 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_signature_type Property
The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.
Syntax
def get_signature_signature_type(signature_index: int) -> int: ...
Default Value
0
Remarks
The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.
| castUnknown | 0 |
| castCAdES | 1 |
| castXAdES | 2 |
| castTimestamp | 3 |
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 |
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_signed_files Property
Contains a comma-separated list of files that are covered by the signature.
Syntax
def get_signature_signed_files(signature_index: int) -> str: ...
Default Value
""
Remarks
Contains a comma-separated list of files that are covered by 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_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 and providing 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.
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_hash_algorithm
- timestamp_serial_number
- timestamp_signature_index
- 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_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_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_signature_index Property
Returns the index of the owner signature, if applicable.
Syntax
def get_timestamp_signature_index(timestamp_index: int) -> int: ...
Default Value
-1
Remarks
Returns the index of the owner signature, if applicable.
Use this property to establish the index of the associated signature object in the signature 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_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 |
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.
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:
The array indices start at 0 and end at tls_server_cert_count - 1.This property is read-only.
tls_server_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
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_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_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_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
0
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.
close Method
Closes an opened container.
Syntax
def close(save_changes: bool) -> None: ...
Remarks
Use this method to close a previously opened container. 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;....
extract_file Method
Extracts a file to one of the output media (bytes, stream, or disk file).
Syntax
def extract_file(filename: str) -> None: ...
Remarks
Use this method to extract a single archived
extract_files Method
Extracts files covered by a signature to OutputPath .
Syntax
def extract_files(sig_index: int) -> None: ...
Remarks
Use this method to extract all files covered by the signature SigIndex to output_path. Set SigIndex to -1 to extract all the files included in the container.
open Method
Opens an existing container for signing or updating.
Syntax
def open() -> None: ...
Remarks
Use this method to open a container for signing or updating. When finished, call close to complete or discard the operation.
revalidate Method
Revalidates a signature in accordance with current settings.
Syntax
def revalidate(index: int) -> None: ...
Remarks
Use this method to re-validate a signature in the opened ASiC document.
unsign Method
Deletes a signature from the container.
Syntax
def unsign(sig_index: int) -> None: ...
Remarks
Use this method to delete an existing signature from the container. Use SigIndex parameter to specify the signature to be removed.
verify Method
Verifies all signatures in the ASiC container.
Syntax
def verify() -> None: ...
Remarks
Use this method to verify the signature and any associated signed files residing in the ASiC container.
When processing the container, the verifier walks through all the signatures contained in the message, one after another.
For each signature, the on_signature_found event is thrown. The benefits of this are that it:
- Lets you know some basic details about the signature and its creator
- Allows you to tell the component whether or not you want to validate it and/or its signing certificate's chain
- Gives you a chance to provide any missing certificates (CertFound indicates whether you need to do that)
The control's properties remain assigned with the last processed signature's details, and are still available after the Verify() call returns, providing a handy way to work with single-signature containers.
Once the main signature's processing completes, the control proceeds to its subordinate elements (countersignatures and/or timestamps). Each timestamp is reported via on_timestamp_validated event.
Having reported all the countersignatures and timestamps, the control proceeds to the next main signature and any timestamps associated with it - and so on.
on_chain_element_download Event
Fires when there is a need to download a chain element from an online source.
Syntax
class ASiCVerifierChainElementDownloadEventParams(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 ASiCVerifier: @property def on_chain_element_download() -> Callable[[ASiCVerifierChainElementDownloadEventParams], None]: ... @on_chain_element_download.setter def on_chain_element_download(event_hook: Callable[[ASiCVerifierChainElementDownloadEventParams], 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 |
on_chain_element_needed Event
Fires when an element required to validate the chain was not located.
Syntax
class ASiCVerifierChainElementNeededEventParams(object): @property def kind() -> int: ... @property def cert_rdn() -> str: ... @property def ca_cert_rdn() -> str: ... # In class ASiCVerifier: @property def on_chain_element_needed() -> Callable[[ASiCVerifierChainElementNeededEventParams], None]: ... @on_chain_element_needed.setter def on_chain_element_needed(event_hook: Callable[[ASiCVerifierChainElementNeededEventParams], 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.
on_chain_element_store Event
This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
Syntax
class ASiCVerifierChainElementStoreEventParams(object): @property def kind() -> int: ... @property def body() -> bytes: ... @property def uri() -> str: ... @uri.setter def uri(value) -> None: ... # In class ASiCVerifier: @property def on_chain_element_store() -> Callable[[ASiCVerifierChainElementStoreEventParams], None]: ... @on_chain_element_store.setter def on_chain_element_store(event_hook: Callable[[ASiCVerifierChainElementStoreEventParams], None]) -> None: ...
Remarks
This event could occur if you are verifying XAdES-C form or higher. The Body parameter contains the element in binary form that should be stored along with a signature. Use the URI parameter to provide an URI of the stored element.
on_chain_validated Event
Reports the completion of a certificate chain validation.
Syntax
class ASiCVerifierChainValidatedEventParams(object): @property def index() -> int: ... @property def subject_rdn() -> str: ... @property def validation_result() -> int: ... @property def validation_details() -> int: ... # In class ASiCVerifier: @property def on_chain_validated() -> Callable[[ASiCVerifierChainValidatedEventParams], None]: ... @on_chain_validated.setter def on_chain_validated(event_hook: Callable[[ASiCVerifierChainValidatedEventParams], 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 ASiCVerifierChainValidationProgressEventParams(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 ASiCVerifier: @property def on_chain_validation_progress() -> Callable[[ASiCVerifierChainValidationProgressEventParams], None]: ... @on_chain_validation_progress.setter def on_chain_validation_progress(event_hook: Callable[[ASiCVerifierChainValidationProgressEventParams], 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_container_loaded Event
This event is fired when the container has been loaded into memory.
Syntax
class ASiCVerifierContainerLoadedEventParams(object): @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class ASiCVerifier: @property def on_container_loaded() -> Callable[[ASiCVerifierContainerLoadedEventParams], None]: ... @on_container_loaded.setter def on_container_loaded(event_hook: Callable[[ASiCVerifierContainerLoadedEventParams], None]) -> None: ...
Remarks
The handler for this event is a good place to check for any existing signatures and validate them if required.
Set Cancel to true to terminate document processing on this stage.
on_error Event
Information about errors during ASiC signature verification.
Syntax
class ASiCVerifierErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class ASiCVerifier: @property def on_error() -> Callable[[ASiCVerifierErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[ASiCVerifierErrorEventParams], None]) -> None: ...
Remarks
The event is fired in case of exceptional conditions during ASiC signature verification.
ErrorCode contains an error code and Description contains a textual description of the error.
on_file_extraction_start Event
Signifies the start of a file extraction process.
Syntax
class ASiCVerifierFileExtractionStartEventParams(object): @property def file_name() -> str: ... @property def file_size() -> int: ... @property def mod_date() -> str: ... @property def extract() -> bool: ... @extract.setter def extract(value) -> None: ... @property def dest_file() -> str: ... @dest_file.setter def dest_file(value) -> None: ... # In class ASiCVerifier: @property def on_file_extraction_start() -> Callable[[ASiCVerifierFileExtractionStartEventParams], None]: ... @on_file_extraction_start.setter def on_file_extraction_start(event_hook: Callable[[ASiCVerifierFileExtractionStartEventParams], None]) -> None: ...
Remarks
This event fires for every file located in the archive and matching the extraction_mode setting before it is to be extracted.
DestFile indicates the path where the file will be saved to. You can alter the destination path here, by providing an alternative extraction path.
Set DestFile to an empty string and provide a stream object via the output_stream property if you prefer to save the data to a stream instead of file.
If DestFile is set to an empty string and output_stream is unassigned, the file will not be extracted.
Alternatively, you can request the extracted content to be saved into a byte array. To do this, leave DestFile and output_stream empty, and keep the Extract parameter enabled.
Please take care when extracting large files into byte arrays, as those may consume large amounts of memory.
Note: if DestFile already exists, the class will overwrite it. To prevent overwriting of existing files, subscribe to this event, and change DestFile when needed.
on_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class ASiCVerifierNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class ASiCVerifier: @property def on_notification() -> Callable[[ASiCVerifierNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[ASiCVerifierNotificationEventParams], 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.
on_signature_found Event
Signifies the start of signature validation.
Syntax
class ASiCVerifierSignatureFoundEventParams(object): @property def index() -> int: ... @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 ASiCVerifier: @property def on_signature_found() -> Callable[[ASiCVerifierSignatureFoundEventParams], None]: ... @on_signature_found.setter def on_signature_found(event_hook: Callable[[ASiCVerifierSignatureFoundEventParams], 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 ASiCVerifierSignatureValidatedEventParams(object): @property def index() -> int: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def validation_result() -> int: ... # In class ASiCVerifier: @property def on_signature_validated() -> Callable[[ASiCVerifierSignatureValidatedEventParams], None]: ... @on_signature_validated.setter def on_signature_validated(event_hook: Callable[[ASiCVerifierSignatureValidatedEventParams], 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 |
on_timestamp_found Event
Signifies the start of a timestamp validation routine.
Syntax
class ASiCVerifierTimestampFoundEventParams(object): @property def index() -> int: ... @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 ASiCVerifier: @property def on_timestamp_found() -> Callable[[ASiCVerifierTimestampFoundEventParams], None]: ... @on_timestamp_found.setter def on_timestamp_found(event_hook: Callable[[ASiCVerifierTimestampFoundEventParams], None]) -> None: ...
Remarks
This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.
The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.
Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
on_timestamp_validated Event
Reports the completion of the timestamp validation routine.
Syntax
class ASiCVerifierTimestampValidatedEventParams(object): @property def index() -> int: ... @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: ... # In class ASiCVerifier: @property def on_timestamp_validated() -> Callable[[ASiCVerifierTimestampValidatedEventParams], None]: ... @on_timestamp_validated.setter def on_timestamp_validated(event_hook: Callable[[ASiCVerifierTimestampValidatedEventParams], 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 |
on_tls_cert_needed Event
Fires when a remote TLS party requests a client certificate.
Syntax
class ASiCVerifierTLSCertNeededEventParams(object): @property def host() -> str: ... @property def ca_names() -> str: ... # In class ASiCVerifier: @property def on_tls_cert_needed() -> Callable[[ASiCVerifierTLSCertNeededEventParams], None]: ... @on_tls_cert_needed.setter def on_tls_cert_needed(event_hook: Callable[[ASiCVerifierTLSCertNeededEventParams], 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 ASiCVerifierTLSCertValidateEventParams(object): @property def server_host() -> str: ... @property def server_ip() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class ASiCVerifier: @property def on_tls_cert_validate() -> Callable[[ASiCVerifierTLSCertValidateEventParams], None]: ... @on_tls_cert_validate.setter def on_tls_cert_validate(event_hook: Callable[[ASiCVerifierTLSCertValidateEventParams], 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 ASiCVerifierTLSEstablishedEventParams(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 ASiCVerifier: @property def on_tls_established() -> Callable[[ASiCVerifierTLSEstablishedEventParams], None]: ... @on_tls_established.setter def on_tls_established(event_hook: Callable[[ASiCVerifierTLSEstablishedEventParams], 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 ASiCVerifierTLSHandshakeEventParams(object): @property def host() -> str: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class ASiCVerifier: @property def on_tls_handshake() -> Callable[[ASiCVerifierTLSHandshakeEventParams], None]: ... @on_tls_handshake.setter def on_tls_handshake(event_hook: Callable[[ASiCVerifierTLSHandshakeEventParams], 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 ASiCVerifierTLSShutdownEventParams(object): @property def host() -> str: ... # In class ASiCVerifier: @property def on_tls_shutdown() -> Callable[[ASiCVerifierTLSShutdownEventParams], None]: ... @on_tls_shutdown.setter def on_tls_shutdown(event_hook: Callable[[ASiCVerifierTLSShutdownEventParams], 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.
ASiCVerifier 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.ASiCVerifier Config Settings
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.
- 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
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 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.
ASiCVerifier Errors
ASiCVerifier Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
| 16777217 Unsupported level (SB_ERROR_ASIC_UNSUPPORTED_LEVEL) | |
| 16777218 Unsupported signature form (SB_ERROR_ASIC_UNSUPPORTED_SIGNATURE_FORM) | |
| 16777219 Unsupported signature type (SB_ERROR_ASIC_UNSUPPORTED_SIGNATURE_TYPE) | |
| 16777220 Unsupported extraction mode (SB_ERROR_ASIC_UNSUPPORTED_EXTRACTION_MODE) | |
| 16777221 Input file does not exist (SB_ERROR_ASIC_INPUTFILE_NOT_EXISTS) | |
| 16777222 Output file already exists (SB_ERROR_ASIC_OUTPUTFILE_ALREADY_EXISTS) |