OfficeVerifier Class

Properties Methods Events Configuration Settings Errors

The OfficeVerifier class is capable of verifying signatures stored in Office documents.

Syntax

class secureblackbox.OfficeVerifier

Remarks

Use OfficeVerifier to validate electronic signatures made over Office documents.

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.
blocked_cert_count	The number of records in the BlockedCert arrays.
blocked_cert_bytes	Returns 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 raw certificate data in DER format.
cert_ca	Indicates whether the certificate has a CA capability (a setting in 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.
chain_validation_details	The details of a certificate chain validation outcome.
chain_validation_result	The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
claimed_signing_time	Returns a signature's claimed signing time.
crl_count	The number of records in the CRL arrays.
crl_bytes	Returns 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.
document_format	Defines the format of the Office document.
ignore_chain_validation_errors	Makes the class tolerant to chain validation errors.
input_bytes	Use this property to pass the input to class in the byte array form.
input_file	The path to the signed office document.
known_cert_count	The number of records in the KnownCert arrays.
known_cert_bytes	Returns 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 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	Buffer containing raw OCSP response data.
known_ocsp_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
last_archival_time	Indicates the most recent archival time of an archived signature.
ocsp_count	The number of records in the OCSP arrays.
ocsp_bytes	Buffer containing 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	Location of the OCSP responder.
ocsp_produced_at	Specifies the time when the response was produced, in UTC.
offline_mode	Switches the class to the offline mode.
output_bytes	Use this property to read the output the class object has produced.
output_file	Defines where to save the modified signed document.
profile	Specifies a pre-defined profile to apply when creating the signature.
proxy_address	The IP address of the proxy server.
proxy_authentication	The authentication type used by the proxy server.
proxy_password	The password to authenticate to the proxy server.
proxy_port	The port on the proxy server to connect to.
proxy_proxy_type	The type of the proxy server.
proxy_request_headers	Contains HTTP request headers for WebTunnel and HTTP proxy.
proxy_response_body	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_response_headers	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_use_i_pv6	Specifies whether IPv6 should be used when connecting through the proxy.
proxy_use_proxy	Enables or disables proxy-driven connection.
proxy_username	Specifies the username credential for proxy authentication.
qualified	Indicates a qualified electronic signature.
revocation_check	Specifies the kind(s) of revocation check to perform.
sig_chain_validation_details	The details of a certificate chain validation outcome.
sig_chain_validation_result	The outcome of a certificate chain validation routine.
sig_core_properties_signed	Returns True if this signature covers the core properties of the document.
sig_document_signed	Returns True if the signature covers the document itself.
sig_expire_time	Specifies the signature expiration time in UTC.
sig_hash_algorithm	The hash algorithm used for signing.
sig_qualified	Indicates a qualified electronic signature.
sig_signature_info_comments	Contains the comments for the SignatureInfoText.
sig_signature_info_included	Specifies whether the signature info is included.
sig_signature_info_text	Contains the text of the signature info.
sig_signature_origin_signed	Returns True if the signature origin is signed.
sig_signature_time	Specifies the certified signing time.
sig_signature_type	Specifies the type of this signature.
sig_signature_validation_result	The outcome of the cryptographic signature validation.
sig_sign_time	Specifies the time when the signature was generated.
sig_subject_rdn	Contains information about the person owning the signing certificate.
sig_validation_log	Contains the signature validation log.
signature_index	The index of the signature to update or to verify.
signature_count	The number of records in the Signature arrays.
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_core_properties_signed	Returns True if this signature covers the core properties of the document.
signature_document_signed	Returns True if the signature covers the document itself.
signature_expire_time	Specifies the signature expiration time in UTC.
signature_hash_algorithm	The hash algorithm used for signing.
signature_qualified	Indicates a qualified electronic signature.
signature_signature_info_comments	Contains the comments for the SignatureInfoText.
signature_signature_info_included	Specifies whether the signature info is included.
signature_signature_info_text	Contains the text of the signature info.
signature_signature_origin_signed	Returns True if the signature origin is signed.
signature_signature_time	Specifies the certified signing time.
signature_signature_type	Specifies the type of this signature.
signature_signature_validation_result	The outcome of the cryptographic signature validation.
signature_sign_time	Specifies the time when the signature was generated.
signature_subject_rdn	Contains information about the person owning the signing certificate.
signature_validation_log	Contains the signature validation log.
signature_validation_result	The signature validation result.
signed_part_count	The number of records in the SignedPart arrays.
signed_part_content_type	Specifies the content type of this signed part.
signed_part_digest_value	Contains the digest value computed over this signed part.
signed_part_hash_algorithm	The hash algorithm used for signing.
signed_part_is_relationship_part	Specifies whether this signed part is a relationship part.
signed_part_path	The path to this signed part in the document package.
signed_part_signature_validation_result	The outcome of the cryptographic signature validation.
signing_cert_bytes	Returns raw certificate data in DER format.
signing_cert_ca	Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
signing_cert_ca_key_id	A unique identifier (fingerprint) of the CA certificate's private key.
signing_cert_crl_distribution_points	Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
signing_cert_curve	Specifies the elliptic curve of the EC public key.
signing_cert_fingerprint	Contains the fingerprint (a hash imprint) of this certificate.
signing_cert_friendly_name	Contains an associated alias (friendly name) of the certificate.
signing_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
signing_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 .
signing_cert_issuer	The common name of the certificate issuer (CA), typically a company name.
signing_cert_issuer_rdn	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
signing_cert_key_algorithm	Specifies the public key algorithm of this certificate.
signing_cert_key_bits	Returns the length of the public key.
signing_cert_key_fingerprint	Returns a fingerprint of the public key contained in the certificate.
signing_cert_key_usage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
signing_cert_key_valid	Returns True if the certificate's key is cryptographically valid, and False otherwise.
signing_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.
signing_cert_policy_i_ds	Contains identifiers (OIDs) of the applicable certificate policies.
signing_cert_public_key_bytes	Contains the certificate's public key in DER format.
signing_cert_self_signed	Indicates whether the certificate is self-signed (root) or signed by an external CA.
signing_cert_serial_number	Returns the certificate's serial number.
signing_cert_sig_algorithm	Indicates the algorithm that was used by the CA to sign this certificate.
signing_cert_subject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
signing_cert_subject_key_id	Contains a unique identifier (fingerprint) of the certificate's private key.
signing_cert_subject_rdn	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
signing_cert_valid_from	The time point at which the certificate becomes valid, in UTC.
signing_cert_valid_to	The time point at which the certificate expires, in UTC.
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_i_pv6	Enables or disables IP protocol version 6.
timestamp_accuracy	This property indicates the accuracy of the included time mark, in microseconds.
timestamp_bytes	Returns raw timestamp data in DER format.
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 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 .
timestamp_serial_number	Returns the timestamp's serial number.
timestamp_time	The time point incorporated into the timestamp.
timestamp_timestamp_type	Returns the timestamp type.
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 timestamp validation outcome.
timestamped	Indicates whether or not the signature is timestamped.
tls_client_cert_count	The number of records in the TLSClientCert arrays.
tls_client_cert_bytes	Returns 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 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.
tlsec_curves	Defines the elliptic curves to enable.
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 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 renegotiation attack prevention mechanism.
tls_revocation_check	Specifies the kind(s) of revocation check to perform.
tlsssl_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.
tlstls_mode	Specifies the TLS mode to use.
tls_use_extended_master_secret	Enables Extended Master Secret Extension, as defined in RFC 7627.
tls_use_session_resumption	Enables or disables TLS session resumption capability.
tls_versions	Th SSL/TLS versions to enable by default.
trusted_cert_count	The number of records in the TrustedCert arrays.
trusted_cert_bytes	Returns raw certificate data in DER format.
trusted_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
tsa_cert_bytes	Returns raw certificate data in DER format.
tsa_cert_ca	Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
tsa_cert_ca_key_id	A unique identifier (fingerprint) of the CA certificate's private key.
tsa_cert_crl_distribution_points	Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
tsa_cert_curve	Specifies the elliptic curve of the EC public key.
tsa_cert_fingerprint	Contains the fingerprint (a hash imprint) of this certificate.
tsa_cert_friendly_name	Contains an associated alias (friendly name) of the certificate.
tsa_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
tsa_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 .
tsa_cert_issuer	The common name of the certificate issuer (CA), typically a company name.
tsa_cert_issuer_rdn	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
tsa_cert_key_algorithm	Specifies the public key algorithm of this certificate.
tsa_cert_key_bits	Returns the length of the public key.
tsa_cert_key_fingerprint	Returns a fingerprint of the public key contained in the certificate.
tsa_cert_key_usage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
tsa_cert_key_valid	Returns True if the certificate's key is cryptographically valid, and False otherwise.
tsa_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.
tsa_cert_policy_i_ds	Contains identifiers (OIDs) of the applicable certificate policies.
tsa_cert_public_key_bytes	Contains the certificate's public key in DER format.
tsa_cert_self_signed	Indicates whether the certificate is self-signed (root) or signed by an external CA.
tsa_cert_serial_number	Returns the certificate's serial number.
tsa_cert_sig_algorithm	Indicates the algorithm that was used by the CA to sign this certificate.
tsa_cert_subject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
tsa_cert_subject_key_id	Contains a unique identifier (fingerprint) of the certificate's private key.
tsa_cert_subject_rdn	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
tsa_cert_valid_from	The time point at which the certificate becomes valid, in UTC.
tsa_cert_valid_to	The time point at which the certificate expires, in UTC.
validated_signing_time	Contains the certified signing time.
validation_log	Contains the complete log of the certificate validation routine.
validation_moment	Specifies the validation moment.
x_ad_es_enabled	Specifies whether the document contains an advanced signature (XAdES).
x_ad_es_form	Specifies which form of XAdES has been used.
x_ad_es_version	Specifies XAdES version.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


add_timestamp	Use this method to add an timestamp.
add_timestamp_validation_data	Use this method to add timestamp validation data to the signature.
add_validation_data_refs	Use this method to add signature validation references to the signature.
add_validation_data_values	Use this method to add signature validation values to the signature.
config	Sets or retrieves a configuration setting.
verify	Verifies the whole document.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


on_chain_validated	Reports the completion of a certificate chain validation.
on_error	Information about errors during the signature validation.
on_notification	This event notifies the application about an underlying control flow event.
on_retrieve_certificate	This event is fired when a certificate should be retrieved.
on_retrieve_crl	This event is fired when a CRL should be retrieved.
on_retrieve_ocsp_response	This event is fired when a OCSP Response should be retrieved.
on_signature_found	Signifies the start of signature validation.
on_signature_validated	Marks the completion of the signature validation routine.
on_store_certificate	This event is fired when a certificate should be stored along with a signature.
on_store_crl	This event is fired when a CRL should be stored along with a signature.
on_store_ocsp_response	This event is fired when a OCSP Response should be stored along with a signature.
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_validate	This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


ClaimedRoleText	The text of the claimed role.
ClaimedRoleXML	The XML content of the claimed roles.
CommitmentTypeIndicationAllSignedDataObjects[Index]	Specifies the CommitmentTypeIndication's AllSignedDataObjects.
CommitmentTypeIndicationCount	The number of the CommitmentTypeIndication elements.
CommitmentTypeIndicationIdentifier[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.
CommitmentTypeIndicationIdentifierDescription[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.
CommitmentTypeIndicationIdentifierDocumentationReferences[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.
CommitmentTypeIndicationIdentifierQualifier[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.
CommitmentTypeIndicationObjectReference[Index]	Specifies the CommitmentTypeIndication's ObjectReference.
CommitmentTypeIndicationQualifiersXML[Index]	The XML content of the CommitmentTypeIndication's Qualifiers.
CustomTSLs	Specifies the custom TSLs.
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.
IgnoreOCSPNoCheckExtension	Whether OCSP NoCheck extension should be ignored.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
ImplicitlyTrustSelfSignedCertificates	Whether to trust self-signed certificates.
IncludeKnownRevocationInfoToSignature	Whether to include custom revocation info to the signature.
ProductionPlace	Identifies the place of the signature production.
PromoteLongOCSPResponses	Whether long OCSP responses are requested.
QualifiedStatus	Indicates a qualified electronic signature.
RemoveSignature	Whether to remove signature.
SignatureInfoAddress1	Specifies the location at which the signature was created.
SignatureInfoAddress2	Specifies the location at which the signature was created.
SignatureInfoComments	Comments to the signature info text.
SignatureInfoDelegateSuggestedSigner	Specifies the name of a person.
SignatureInfoDelegateSuggestedSigner2	Specifies the title of a person.
SignatureInfoDelegateSuggestedSignerEmail	Specifies the e-mail address of a person.
SignatureInfoImage	Specifies an image for the digital signature.
SignatureInfoIncluded	Whether to include the signature info.
SignatureInfoInvalidLnImage	Specifies the image of an invalid signature.
SignatureInfoSignatureType	Specifies the type of the digital signature.
SignatureInfoText	The text to be displayed as the signature info.
SignatureInfoValidLnImage	Specifies the image of a valid signature.
SignatureLineAdditionalSignatureInfo[Index]	Contains additional signature information.
SignatureLineAllowComments[Index]	Indicates if comments are allowed.
SignatureLineCount	The number of signature lines.
SignatureLineId[Index]	Contains signature unique ID.
SignatureLineImageData[Index]	Contains signature image.
SignatureLineShowSignDate[Index]	Indicates if signing date should be shown.
SignatureLineSignatureIndex[Index]	The index of the signature that signs signature line.
SignatureLineSignatureProviderId[Index]	Contains signature provider ID.
SignatureLineSignatureProviderUrl[Index]	Contains signature provider URL.
SignatureLineSigned[Index]	Indicates if signature line is signed.
SignatureLineSigningInstructions[Index]	Contains signing instructions.
SignatureLineSuggestedSigner2[Index]	Suggested signer line two.
SignatureLineSuggestedSigner[Index]	Suggested signer line one.
SignatureLineSuggestedSignerEmail[Index]	Suggested signer email address.
SigPolicyDescription	signature policy description.
SigPolicyExplicitText	The explicit text of the user notice.
SigPolicyHash	The hash value of the signature policy.
SigPolicyHashAlgorithm	The hash algorithm used to compute the signature policy hash.
SigPolicyID	Identifies the signature policy.
SigPolicyNoticeNumbers	Contains user notice numbers.
SigPolicyNoticeOrganization	The organization part of the NoticeReference qualifier.
SigPolicyURI	Signature policy URI.
TempPath	Location where the temporary files are stored.
TimestampCanonicalizationMethod	Specifies canonicalization method used in timestamp.
TimestampValidationDataDetails	Specifies timestamp validation data details to include to the signature.
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.
TSLDistributionPoints	Contains XML content of distribution points of the TSL used.
TSLDistributionPoints[Idx]	Contains distribution point of the specified index of the TSL used.
TSLHistoricalInformationPeriod	Contains historical information period of the TSL used.
TSLLegalNotices	Contains XML content of legal notices of the TSL used.
TSLLegalNotices[lang]	Contains legal notices for the specified language of the TSL used.
TSLListIssueDateTime	Contains list issue date and time of the TSL used.
TSLNextUpdate	Contains next update date and time of the TSL used.
TSLPolicies	Contains XML content of policies of the TSL used.
TSLPolicies[lang]	Contains policies for the specified language of the TSL used.
TSLSchemeExtensions	Contains XML content of scheme extensions of the TSL used.
TSLSchemeExtensions[Idx]	Contains XML content of scheme extension of the specified index of the TSL used.
TSLSchemeInformationURI	Contains XML content of scheme information URI of the TSL used.
TSLSchemeInformationURI[lang]	Contains scheme information URI for the specified language of the TSL used.
TSLSchemeName	Contains XML content of scheme name of the TSL used.
TSLSchemeName[lang]	Contains scheme name for the specified language of the TSL used.
TSLSchemeOperatorAddress	Contains XML content of scheme operator address of the TSL used.
TSLSchemeOperatorName	Contains XML content of scheme operator name of the TSL used.
TSLSchemeOperatorName[lang]	Contains scheme operator name for the specified language of the TSL used.
TSLSchemeTerritory	Contains scheme territory of the TSL used.
TSLSchemeTypeCommunityRules	Contains XML content of scheme type/community/rules of the TSL used.
TSLSchemeTypeCommunityRules[lang]	Contains scheme type/community/rules for the specified language of the TSL used.
TSLSequenceNumber	Contains sequence number of the TSL used.
TSLsRetrieveLog	Contains the complete log of the TSLs retrieve.
TSLStatusDeterminationApproach	Contains status determination approach of the TSL used.
TSLsValidationLog	Contains the complete log of the TSLs validation.
TSLTSPAdditionalServiceInformation	Contains addtional service information of the TSP service used.
TSLTSPAddress	Contains XML content of the address of the TSP used.
TSLTSPHistoryInstance	Indicates that TSP service history instance used.
TSLTSPHistoryInstanceAdditionalServiceInformation	Contains addtional service information of the TSP service history instance used.
TSLTSPHistoryInstanceQualifiers	Contains list of qualifiers of the TSP service history instance used.
TSLTSPHistoryInstanceServiceInformationExtensions	Contains XML content of information extensions of the TSP service history instance used.
TSLTSPHistoryInstanceServiceInformationExtensions[Idx]	Contains XML content of information extension of the specified index of the TSP service history instance used.
TSLTSPHistoryInstanceServiceName	Contains XML content of name of the TSP service history instance used.
TSLTSPHistoryInstanceServiceName[lang]	Contains name for the specified language of the TSP service history instance used.
TSLTSPHistoryInstanceServiceStatus	Contains status of the TSP service history instance used.
TSLTSPHistoryInstanceServiceStatusStartingTime	Contains status starting time of the TSP service history instance used.
TSLTSPHistoryInstanceServiceTypeIdentifier	Contains type identifier of the TSP service history instance used.
TSLTSPHistoryInstanceXML	Contains XML content of the TSP service history instance used.
TSLTSPInformationExtensions	Contains XML content of information extensions of the TSP used.
TSLTSPInformationExtensions[Idx]	Contains XML content of information extension of the specified index of the TSP used.
TSLTSPInformationURI	Contains XML content of information URI of the TSP used.
TSLTSPInformationURI[lang]	Contains information URI for the specified language of the TSP used.
TSLTSPName	Contains XML content of name of the TSP used.
TSLTSPName[lang]	Contains name for the specified language of the TSP used.
TSLTSPSchemeServiceDefinitionURI	Contains XML content of scheme service definition URI of the TSP service used.
TSLTSPSchemeServiceDefinitionURI[lang]	Contains scheme service definition URI for the specified language of the TSP service used.
TSLTSPServiceDefinitionURI	Contains XML content of definition URI of the TSP service used.
TSLTSPServiceDefinitionURI[lang]	Contains definition URI for the specified language of the TSP service used.
TSLTSPServiceInformationExtensions	Contains XML content of information extensions of the TSP service used.
TSLTSPServiceInformationExtensions[Idx]	Contains XML content of information extension of the specified index of the TSP service used.
TSLTSPServiceName	Contains XML content of name of the TSP service used.
TSLTSPServiceName[lang]	Contains name for the specified language of the TSP service used.
TSLTSPServiceQualifiers	Contains list of qualifiers of the TSP service used.
TSLTSPServiceStatus	Contains status of the TSP service used.
TSLTSPServiceStatusStartingTime	Contains status starting time of the TSP service used.
TSLTSPServiceSupplyPoints	Contains XML content of the supply points of the TSP service used.
TSLTSPServiceTypeIdentifier	Contains type identifier of the TSP service used.
TSLTSPServiceXML	Contains XML content of the TSP service used.
TSLTSPTradeName	Contains XML content of trade name of the TSP used.
TSLTSPTradeName[lang]	Contains trade name for the specified language of the TSP used.
TSLTSPXML	Contains XML content of the TSP used.
TSLType	Contains TSL type of the TSL used.
TSLVersionIdentifier	Contains version identifier of the TSL used.
TSLXML	Contains XML content of the TSL used.
TspHashAlgorithm	Sets a specific hash algorithm for use with the timestamping service.
UseDefaultTSLs	Enables or disables the use of the default TSLs.
UseMicrosoftCTL	Enables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificates	Enables or disables the use of the system certificates.
ValidationDataRefsDetails	Specifies validation data references details to include to the signature.
ValidationDataValuesDetails	Specifies validation data values details to include to the signature.
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 (supported for HTTPClient, RESTClient and SOAPClient only).
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.
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.