# MailReader Class The MailReader class implements parsing and decryption of e-mail messages. ## Syntax ```text class secureblackbox.MailReader ``` ## Remarks MailReader parses and decrypts e-mail messages, as well as verifies electronic signatures. Loading a e-mail message and accessing its properties: ```text MailReader reader = new MailReader(); reader.LoadFromFile("path\\message.eml"); Console.WriteLine($"From: {reader.Message.From}"); Console.WriteLine($"To : {reader.Message.SendTo}"); Console.WriteLine($"Subject: {reader.Message.Subject}"); Console.WriteLine($"Attachments: {reader.Message.AttachmentCount}"); Console.WriteLine("Plain text:"); Console.WriteLine(reader.Message.PlainText); ``` Checking a signed message and validating its signature: ```text MailReader reader = new MailReader(); reader.LoadFromFile("path\\message.eml"); if (reader.SecurityInfo.Signed) { if (reader.SecurityInfo.SignatureValidationResult == SignatureValidities.svtValid) Console.WriteLine($"Signed by {reader.SigningCertificate.Subject} and the signature is valid"); else Console.WriteLine("Signature is NOT valid"); } ``` Processing an encrypted e-mail message: ```text MailReader reader = new MailReader(); reader.OnDecryptionInfoNeeded += (s, e) => { // here you should provide a certificate for decryption; // use the provided IssuerRDN and SerialNumber/SubjectKeyID // values to find an appropriate certificate, then // assign the certificate to DecryptionCertificate property; // the certificate should include its private key }; reader.LoadFromFile("path\\message.eml"); ``` ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [attach_count](#attach_count-property) | The number of records in the Attach arrays. | | [attach_content_subtype](#attach_content_subtype-property) | Contains the content subtype of the attachment. | | [attach_content_type](#attach_content_type-property) | Contains the content type of the attachment. | | [attach_creation_date](#attach_creation_date-property) | The creation date. | | [attach_data](#attach_data-property) | The content of the attachment. | | [attach_description](#attach_description-property) | Textual description of the attachment. | | [attach_file_name](#attach_file_name-property) | Specifies the name of the attachment file. | | [attach_handle](#attach_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [attach_id](#attach_id-property) | Contains the attachment's unique identifier. | | [attach_modification_date](#attach_modification_date-property) | Specifies the date and time of the file's last modification. | | [attach_read_date](#attach_read_date-property) | Specifies the file's last read date. | | [attach_size](#attach_size-property) | The attachment's size in bytes. | | [bcc](#bcc-property) | The number of records in the BccAddr arrays. | | [bcc](#bcc-property-1) | Contains the e-mail address in the form of john@doe. | | [bcc](#bcc-property-2) | Contains the friendly name of the user of this address, such as John Doe. | | [bcc](#bcc-property-3) | The name of the group this address belongs to. | | [blocked_cert_count](#blocked_cert_count-property) | The number of records in the BlockedCert arrays. | | [blocked_cert_bytes](#blocked_cert_bytes-property) | Returns the raw certificate data in DER format. | | [blocked_cert_handle](#blocked_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [cc_addr_count](#cc_addr_count-property) | The number of records in the CcAddr arrays. | | [cc_addr_address](#cc_addr_address-property) | Contains the e-mail address in the form of john@doe. | | [cc_addr_display_name](#cc_addr_display_name-property) | Contains the friendly name of the user of this address, such as John Doe. | | [cc_addr_group_name](#cc_addr_group_name-property) | The name of the group this address belongs to. | | [decryption_cert_bytes](#decryption_cert_bytes-property) | Returns the raw certificate data in DER format. | | [decryption_cert_ca](#decryption_cert_ca-property) | Indicates whether the certificate has a CA capability. | | [decryption_cert_ca_key_id](#decryption_cert_ca_key_id-property) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [decryption_cert_cert_type](#decryption_cert_cert_type-property) | Returns the type of the entity contained in the Certificate object. | | [decryption_cert_crl_distribution_points](#decryption_cert_crl_distribution_points-property) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [decryption_cert_curve](#decryption_cert_curve-property) | Specifies the elliptic curve associated with the certificate's public key. | | [decryption_cert_fingerprint](#decryption_cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. | | [decryption_cert_friendly_name](#decryption_cert_friendly_name-property) | Contains an associated alias (friendly name) of the certificate. | | [decryption_cert_handle](#decryption_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [decryption_cert_hash_algorithm](#decryption_cert_hash_algorithm-property) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [decryption_cert_issuer](#decryption_cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. | | [decryption_cert_issuer_rdn](#decryption_cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [decryption_cert_key_algorithm](#decryption_cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. | | [decryption_cert_key_bits](#decryption_cert_key_bits-property) | Returns the length of the public key in bits. | | [decryption_cert_key_fingerprint](#decryption_cert_key_fingerprint-property) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [decryption_cert_key_usage](#decryption_cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [decryption_cert_key_valid](#decryption_cert_key_valid-property) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [decryption_cert_ocsp_locations](#decryption_cert_ocsp_locations-property) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [decryption_cert_ocsp_no_check](#decryption_cert_ocsp_no_check-property) | Accessor to the value of the certificate's ocsp-no-check extension. | | [decryption_cert_origin](#decryption_cert_origin-property) | Returns the location that the certificate was taken or loaded from. | | [decryption_cert_policy_i_ds](#decryption_cert_policy_i_ds-property) | Contains identifiers (OIDs) of the applicable certificate policies. | | [decryption_cert_private_key_bytes](#decryption_cert_private_key_bytes-property) | Returns the certificate's private key in DER-encoded format. | | [decryption_cert_private_key_exists](#decryption_cert_private_key_exists-property) | Indicates whether the certificate has a usable private key associated with it. | | [decryption_cert_private_key_extractable](#decryption_cert_private_key_extractable-property) | Indicates whether the private key is extractable (exportable). | | [decryption_cert_public_key_bytes](#decryption_cert_public_key_bytes-property) | Contains the certificate's public key in DER format. | | [decryption_cert_qualified](#decryption_cert_qualified-property) | Indicates whether the certificate is qualified. | | [decryption_cert_qualified_statements](#decryption_cert_qualified_statements-property) | Returns a simplified qualified status of the certificate. | | [decryption_cert_qualifiers](#decryption_cert_qualifiers-property) | A list of qualifiers. | | [decryption_cert_self_signed](#decryption_cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [decryption_cert_serial_number](#decryption_cert_serial_number-property) | Returns the certificate's serial number. | | [decryption_cert_sig_algorithm](#decryption_cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. | | [decryption_cert_source](#decryption_cert_source-property) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [decryption_cert_subject](#decryption_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. | | [decryption_cert_subject_alternative_name](#decryption_cert_subject_alternative_name-property) | Returns or sets the value of the Subject Alternative Name extension of the certificate. | | [decryption_cert_subject_key_id](#decryption_cert_subject_key_id-property) | Contains a unique identifier of the certificate's cryptographic key. | | [decryption_cert_subject_rdn](#decryption_cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [decryption_cert_valid](#decryption_cert_valid-property) | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. | | [decryption_cert_valid_from](#decryption_cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. | | [decryption_cert_valid_to](#decryption_cert_valid_to-property) | The time point at which the certificate expires, in UTC. | | [external_crypto_async_document_id](#external_crypto_async_document_id-property) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [external_crypto_custom_params](#external_crypto_custom_params-property) | Custom parameters to be passed to the signing service (uninterpreted). | | [external_crypto_data](#external_crypto_data-property) | Additional data to be included in the async state and mirrored back by the requestor. | | [external_crypto_external_hash_calculation](#external_crypto_external_hash_calculation-property) | Specifies whether the message hash is to be calculated at the external endpoint. | | [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property) | Specifies the request's signature hash algorithm. | | [external_crypto_key_id](#external_crypto_key_id-property) | The ID of the pre-shared key used for DC request authentication. | | [external_crypto_key_secret](#external_crypto_key_secret-property) | The pre-shared key used for DC request authentication. | | [external_crypto_method](#external_crypto_method-property) | Specifies the asynchronous signing method. | | [external_crypto_mode](#external_crypto_mode-property) | Specifies the external cryptography mode. | | [external_crypto_public_key_algorithm](#external_crypto_public_key_algorithm-property) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [fips_mode](#fips_mode-property) | Reserved. | | [author](#author-property) | The number of records in the FromAddr arrays. | | [author](#author-property-1) | Contains the e-mail address in the form of john@doe. | | [author](#author-property-2) | Contains the friendly name of the user of this address, such as John Doe. | | [author](#author-property-3) | The name of the group this address belongs to. | | [header_field_count](#header_field_count-property) | The number of records in the HeaderField arrays. | | [header_field_category](#header_field_category-property) | Specifies the string category of the contained value. | | [header_field_format](#header_field_format-property) | Specifies the format (encoding) of the value contained in the Value property. | | [header_field_name](#header_field_name-property) | The name element in a (name, value) pair. | | [header_field_value](#header_field_value-property) | The value element in a (name, value) pair. | | [ignore_chain_validation_errors](#ignore_chain_validation_errors-property) | Makes the class tolerant to chain validation errors. | | [known_cert_count](#known_cert_count-property) | The number of records in the KnownCert arrays. | | [known_cert_bytes](#known_cert_bytes-property) | Returns the raw certificate data in DER format. | | [known_cert_handle](#known_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [known_crl_count](#known_crl_count-property) | The number of records in the KnownCRL arrays. | | [known_crl_bytes](#known_crl_bytes-property) | Returns the raw CRL data in DER format. | | [known_crl_handle](#known_crl_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [known_ocsp_count](#known_ocsp_count-property) | The number of records in the KnownOCSP arrays. | | [known_ocsp_bytes](#known_ocsp_bytes-property) | A buffer containing the raw OCSP response data. | | [known_ocsp_handle](#known_ocsp_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [msg_attachment_count](#msg_attachment_count-property) | Returns the number of attachments in this message. | | [msg_bcc](#msg_bcc-property) | The contents of the BCC header property. | | [msg_cc](#msg_cc-property) | The value of the CC header property. | | [msg_comments](#msg_comments-property) | Contains additional information about the message body. | | [msg_date](#msg_date-property) | The date and time when the message entered the mail delivery system. | | [msg_delivery_receipt](#msg_delivery_receipt-property) | Enables delivery notification. | | [msg_from](#msg_from-property) | Contains the value of the From header property. | | [msg_handle](#msg_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [msg_html_text](#msg_html_text-property) | The HTML version of the message. | | [msg_id](#msg_id-property) | The contents of the Message-ID header property. | | [msg_in_reply_to](#msg_in_reply_to-property) | The value of the In-Reply-To header property. | | [msg_keywords](#msg_keywords-property) | The value of the Keywords header property. | | [msg_mailer](#msg_mailer-property) | The name of the software that was used to send the message. | | [msg_plain_text](#msg_plain_text-property) | The plain text version of the message. | | [msg_priority](#msg_priority-property) | Specifies the message priority. | | [msg_read_receipt](#msg_read_receipt-property) | Enables a read notification. | | [msg_references](#msg_references-property) | The value of the References header property. | | [msg_reply_to](#msg_reply_to-property) | The value of the Reply-To header property. | | [msg_return_path](#msg_return_path-property) | The value of the Return-Path header property. | | [msg_sender](#msg_sender-property) | The value of the Sender header property. | | [msg_send_to](#msg_send_to-property) | The value of the To header property. | | [msg_subject](#msg_subject-property) | Contains the subject property of this message. | | [offline_mode](#offline_mode-property) | Switches the class to offline mode. | | [profile](#profile-property) | Specifies a pre-defined profile to apply when creating the signature. | | [proxy_address](#proxy_address-property) | The IP address of the proxy server. | | [proxy_authentication](#proxy_authentication-property) | The authentication type used by the proxy server. | | [proxy_password](#proxy_password-property) | The password to authenticate to the proxy server. | | [proxy_port](#proxy_port-property) | The port on the proxy server to connect to. | | [proxy_type](#proxy_type-property) | The type of the proxy server. | | [proxy_request_headers](#proxy_request_headers-property) | Contains HTTP request headers for WebTunnel and HTTP proxy. | | [proxy_response_body](#proxy_response_body-property) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. | | [proxy_response_headers](#proxy_response_headers-property) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. | | [proxy_use_ipv6](#proxy_use_ipv6-property) | Specifies whether IPv6 should be used when connecting through the proxy. | | [proxy_username](#proxy_username-property) | Specifies the username credential for proxy authentication. | | [reply_to_addr_count](#reply_to_addr_count-property) | The number of records in the ReplyToAddr arrays. | | [reply_to_addr_address](#reply_to_addr_address-property) | Contains the e-mail address in the form of john@doe. | | [reply_to_addr_display_name](#reply_to_addr_display_name-property) | Contains the friendly name of the user of this address, such as John Doe. | | [reply_to_addr_group_name](#reply_to_addr_group_name-property) | The name of the group this address belongs to. | | [revocation_check](#revocation_check-property) | Specifies the kind(s) of revocation check to perform for all chain certificates. | | [sec_info_chain_validation_details](#sec_info_chain_validation_details-property) | The details of a certificate chain validation outcome. | | [sec_info_chain_validation_result](#sec_info_chain_validation_result-property) | The outcome of a certificate chain validation routine. | | [sec_info_claimed_signing_time](#sec_info_claimed_signing_time-property) | Returns the signature's claimed signing time. | | [sec_info_encrypted](#sec_info_encrypted-property) | Indicates whether the message is encrypted. | | [sec_info_encryption_algorithm](#sec_info_encryption_algorithm-property) | Indicates the algorithm that was used to encrypt the message. | | [sec_info_hash_algorithm](#sec_info_hash_algorithm-property) | Specifies the hash algorithm that was used to calculate the signature. | | [sec_info_signature_validation_result](#sec_info_signature_validation_result-property) | The outcome of the cryptographic signature validation. | | [sec_info_signed](#sec_info_signed-property) | Indicates whether the message is signed. | | [sec_info_validation_log](#sec_info_validation_log-property) | Contains the signing certificate's chain validation log. | | [sender_addr_address](#sender_addr_address-property) | Contains the e-mail address in the form of john@doe. | | [sender_addr_display_name](#sender_addr_display_name-property) | Contains the friendly name of the user of this address, such as John Doe. | | [sender_addr_group_name](#sender_addr_group_name-property) | The name of the group this address belongs to. | | [send_to_addr_count](#send_to_addr_count-property) | The number of records in the SendToAddr arrays. | | [send_to_addr_address](#send_to_addr_address-property) | Contains the e-mail address in the form of john@doe. | | [send_to_addr_display_name](#send_to_addr_display_name-property) | Contains the friendly name of the user of this address, such as John Doe. | | [send_to_addr_group_name](#send_to_addr_group_name-property) | The name of the group this address belongs to. | | [signing_cert_bytes](#signing_cert_bytes-property) | Returns the raw certificate data in DER format. | | [signing_cert_ca](#signing_cert_ca-property) | Indicates whether the certificate has a CA capability. | | [signing_cert_ca_key_id](#signing_cert_ca_key_id-property) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [signing_cert_crl_distribution_points](#signing_cert_crl_distribution_points-property) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [signing_cert_curve](#signing_cert_curve-property) | Specifies the elliptic curve associated with the certificate's public key. | | [signing_cert_fingerprint](#signing_cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. | | [signing_cert_friendly_name](#signing_cert_friendly_name-property) | Contains an associated alias (friendly name) of the certificate. | | [signing_cert_handle](#signing_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signing_cert_hash_algorithm](#signing_cert_hash_algorithm-property) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [signing_cert_issuer](#signing_cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. | | [signing_cert_issuer_rdn](#signing_cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [signing_cert_key_algorithm](#signing_cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. | | [signing_cert_key_bits](#signing_cert_key_bits-property) | Returns the length of the public key in bits. | | [signing_cert_key_fingerprint](#signing_cert_key_fingerprint-property) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [signing_cert_key_usage](#signing_cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [signing_cert_key_valid](#signing_cert_key_valid-property) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [signing_cert_ocsp_locations](#signing_cert_ocsp_locations-property) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [signing_cert_policy_i_ds](#signing_cert_policy_i_ds-property) | Contains identifiers (OIDs) of the applicable certificate policies. | | [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property) | Contains the certificate's public key in DER format. | | [signing_cert_self_signed](#signing_cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [signing_cert_serial_number](#signing_cert_serial_number-property) | Returns the certificate's serial number. | | [signing_cert_sig_algorithm](#signing_cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. | | [signing_cert_subject](#signing_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. | | [signing_cert_subject_key_id](#signing_cert_subject_key_id-property) | Contains a unique identifier of the certificate's cryptographic key. | | [signing_cert_subject_rdn](#signing_cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [signing_cert_valid_from](#signing_cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. | | [signing_cert_valid_to](#signing_cert_valid_to-property) | The time point at which the certificate expires, in UTC. | | [socket_dns_mode](#socket_dns_mode-property) | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. | | [socket_dns_port](#socket_dns_port-property) | Specifies the port number to be used for sending queries to the DNS server. | | [socket_dns_query_timeout](#socket_dns_query_timeout-property) | The timeout (in milliseconds) for each DNS query. | | [socket_dns_servers](#socket_dns_servers-property) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. | | [socket_dns_total_timeout](#socket_dns_total_timeout-property) | The timeout (in milliseconds) for the whole resolution process. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property) | Enables or disables IP protocol version 6. | | [tls_auto_validate_certificates](#tls_auto_validate_certificates-property) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [tls_base_configuration](#tls_base_configuration-property) | Selects the base configuration for the TLS settings. | | [tls_ciphersuites](#tls_ciphersuites-property) | A list of ciphersuites separated with commas or semicolons. | | [tls_client_auth](#tls_client_auth-property) | Enables or disables certificate-based client authentication. | | [tls_extensions](#tls_extensions-property) | Provides access to TLS extensions. | | [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property) | Whether to force TLS session resumption when the destination address changes. | | [tls_groups](#tls_groups-property) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [tls_pre_shared_identity](#tls_pre_shared_identity-property) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [tls_pre_shared_key](#tls_pre_shared_key-property) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [tls_pre_shared_key_ciphersuite](#tls_pre_shared_key_ciphersuite-property) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property) | Selects the renegotiation attack prevention mechanism. | | [tls_revocation_check](#tls_revocation_check-property) | Specifies the kind(s) of revocation check to perform. | | [tls_ssl_options](#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. | | [tls_mode](#tls_mode-property) | Specifies the TLS mode to use. | | [tls_use_extended_master_secret](#tls_use_extended_master_secret-property) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [tls_use_session_resumption](#tls_use_session_resumption-property) | Enables or disables the TLS session resumption capability. | | [tls_versions](#tls_versions-property) | The SSL/TLS versions to enable by default. | | [trusted_cert_count](#trusted_cert_count-property) | The number of records in the TrustedCert arrays. | | [trusted_cert_bytes](#trusted_cert_bytes-property) | Returns the raw certificate data in DER format. | | [trusted_cert_handle](#trusted_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [used_cert_count](#used_cert_count-property) | The number of records in the UsedCert arrays. | | [used_cert_bytes](#used_cert_bytes-property) | Returns the raw certificate data in DER format. | | [used_cert_ca](#used_cert_ca-property) | Indicates whether the certificate has a CA capability. | | [used_cert_ca_key_id](#used_cert_ca_key_id-property) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [used_cert_cert_type](#used_cert_cert_type-property) | Returns the type of the entity contained in the Certificate object. | | [used_cert_crl_distribution_points](#used_cert_crl_distribution_points-property) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [used_cert_curve](#used_cert_curve-property) | Specifies the elliptic curve associated with the certificate's public key. | | [used_cert_fingerprint](#used_cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. | | [used_cert_friendly_name](#used_cert_friendly_name-property) | Contains an associated alias (friendly name) of the certificate. | | [used_cert_handle](#used_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [used_cert_hash_algorithm](#used_cert_hash_algorithm-property) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [used_cert_issuer](#used_cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. | | [used_cert_issuer_rdn](#used_cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [used_cert_key_algorithm](#used_cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. | | [used_cert_key_bits](#used_cert_key_bits-property) | Returns the length of the public key in bits. | | [used_cert_key_fingerprint](#used_cert_key_fingerprint-property) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [used_cert_key_usage](#used_cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [used_cert_key_valid](#used_cert_key_valid-property) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [used_cert_ocsp_locations](#used_cert_ocsp_locations-property) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [used_cert_ocsp_no_check](#used_cert_ocsp_no_check-property) | Accessor to the value of the certificate's ocsp-no-check extension. | | [used_cert_origin](#used_cert_origin-property) | Returns the location that the certificate was taken or loaded from. | | [used_cert_policy_i_ds](#used_cert_policy_i_ds-property) | Contains identifiers (OIDs) of the applicable certificate policies. | | [used_cert_private_key_bytes](#used_cert_private_key_bytes-property) | Returns the certificate's private key in DER-encoded format. | | [used_cert_private_key_exists](#used_cert_private_key_exists-property) | Indicates whether the certificate has a usable private key associated with it. | | [used_cert_private_key_extractable](#used_cert_private_key_extractable-property) | Indicates whether the private key is extractable (exportable). | | [used_cert_public_key_bytes](#used_cert_public_key_bytes-property) | Contains the certificate's public key in DER format. | | [used_cert_qualified](#used_cert_qualified-property) | Indicates whether the certificate is qualified. | | [used_cert_qualified_statements](#used_cert_qualified_statements-property) | Returns a simplified qualified status of the certificate. | | [used_cert_qualifiers](#used_cert_qualifiers-property) | A list of qualifiers. | | [used_cert_self_signed](#used_cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [used_cert_serial_number](#used_cert_serial_number-property) | Returns the certificate's serial number. | | [used_cert_sig_algorithm](#used_cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. | | [used_cert_source](#used_cert_source-property) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [used_cert_subject](#used_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. | | [used_cert_subject_alternative_name](#used_cert_subject_alternative_name-property) | Returns or sets the value of the Subject Alternative Name extension of the certificate. | | [used_cert_subject_key_id](#used_cert_subject_key_id-property) | Contains a unique identifier of the certificate's cryptographic key. | | [used_cert_subject_rdn](#used_cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [used_cert_valid](#used_cert_valid-property) | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. | | [used_cert_valid_from](#used_cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. | | [used_cert_valid_to](#used_cert_valid_to-property) | The time point at which the certificate expires, in UTC. | | [validation_moment](#validation_moment-property) | 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.* | | | | --- | --- | | [config](#config-method) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method) | Performs an additional action. | | [find_attachment](#find_attachment-method) | Looks up a Message's attachment by its ID. | | [load_from_bytes](#load_from_bytes-method) | Loads an e-mail message from a byte array. | | [load_from_file](#load_from_file-method) | Loads an e-mail message from a file. | | [reset](#reset-method) | Resets the class settings. | ## 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](#on_chain_validated-event) | Reports the completion of a certificate chain validation. | | [on_decryption_info_needed](#on_decryption_info_needed-event) | Asks the application to provide a decryption certificate. | | [on_error](#on_error-event) | Reports information about errors during e-mail message loading, parsing or saving. | | [on_external_decrypt](#on_external_decrypt-event) | Handles remote or external decryption. | | [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. | | [on_signature_found](#on_signature_found-event) | Signifies the start of signature validation. | | [on_signature_validated](#on_signature_validated-event) | Marks the completion of the signature validation routine. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ChainCurrentCACert](#ChainCurrentCACert) | Returns the current CA certificate. | | [ChainCurrentCert](#ChainCurrentCert) | Returns the certificate that is currently being validated. | | [ChainCurrentCRL](#ChainCurrentCRL) | Returns the current CRL. | | [ChainCurrentCRLSize](#ChainCurrentCRLSize) | Returns the size of the current CRL. | | [ChainCurrentOCSP](#ChainCurrentOCSP) | Returns the current OCSP response. | | [ChainCurrentOCSPSigner](#ChainCurrentOCSPSigner) | Returns the signer of the current OCSP object. | | [ChainInterimDetails](#ChainInterimDetails) | Returns the current interim validation details. | | [ChainInterimResult](#ChainInterimResult) | Returns the current interim validation result. | | [CheckValidityPeriodForTrusted](#CheckValidityPeriodForTrusted) | Whether to check validity period for trusted certificates. | | [DislikeOpenEndedOCSPs](#DislikeOpenEndedOCSPs) | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. | | [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. | | [EvaluateSystemTrustForSelfSignedCertificates](#EvaluateSystemTrustForSelfSignedCertificates) | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. | | [EvaluateSystemTrustForSSL](#EvaluateSystemTrustForSSL) | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. | | [ForceCompleteChainValidation](#ForceCompleteChainValidation) | Whether to check the CA certificates when the signing certificate is invalid. | | [ForceCompleteChainValidationForTrusted](#ForceCompleteChainValidationForTrusted) | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. | | [GracePeriod](#GracePeriod) | Specifies a grace period to apply during revocation information checks. | | [HeaderCharset](#HeaderCharset) | Charset of the header. If not empty, the one specified in the message header will be ignored. | | [IgnoreChainLoops](#IgnoreChainLoops) | Whether chain loops should be ignored. | | [IgnoreOCSPNoCheckExtension](#IgnoreOCSPNoCheckExtension) | Whether the OCSP NoCheck extension should be ignored. | | [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. | | [ImplicitlyTrustSelfSignedCertificates](#ImplicitlyTrustSelfSignedCertificates) | Whether to trust self-signed certificates. | | [MaxHeaderSize](#MaxHeaderSize) | Specifies the maximum mail message header size in bytes. | | [PromoteLongOCSPResponses](#PromoteLongOCSPResponses) | Whether long OCSP responses are requested. | | [TempPath](#TempPath) | Path for storing temporary files. | | [TextCharset](#TextCharset) | Charset of text parts, if any. If not empty, the one specified in the message text parts will be ignored. | | [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. | | [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. | | [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. | | [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. | | [UseValidationCache](#UseValidationCache) | Enables or disable the use of the product-wide certificate chain validation cache. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # attach_count property The number of records in the Attach arrays. ## Syntax ```text def get_attach_count() -> int: ... attach_count = property(get_attach_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [attach_content_subtype](#attach_content_subtype-property) - [attach_content_type](#attach_content_type-property) - [attach_creation_date](#attach_creation_date-property) - [attach_data](#attach_data-property) - [attach_description](#attach_description-property) - [attach_file_name](#attach_file_name-property) - [attach_handle](#attach_handle-property) - [attach_id](#attach_id-property) - [attach_modification_date](#attach_modification_date-property) - [attach_read_date](#attach_read_date-property) - [attach_size](#attach_size-property) The array indices start at *0* and end at *attach_count - 1*. This property is read-only. # attach_content_subtype property Contains the content subtype of the attachment. ## Syntax ```text def get_attach_content_subtype(attach_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the content subtype of the attachment. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_content_type property Contains the content type of the attachment. ## Syntax ```text def get_attach_content_type(attach_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the content type of the attachment. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_creation_date property The creation date. ## Syntax ```text def get_attach_creation_date(attach_index: int) -> str: ... ``` ## Default Value "" ## Remarks The creation date. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_data property The content of the attachment. ## Syntax ```text def get_attach_data(attach_index: int) -> bytes: ... ``` ## Remarks The content of the attachment. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_description property Textual description of the attachment. ## Syntax ```text def get_attach_description(attach_index: int) -> str: ... ``` ## Default Value "" ## Remarks Textual description of the attachment. This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_file_name property Specifies the name of the attachment file. ## Syntax ```text def get_attach_file_name(attach_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the name of the attachment file. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_attach_handle(attach_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_id property Contains the attachment's unique identifier. ## Syntax ```text def get_attach_id(attach_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the attachment's unique identifier. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_modification_date property Specifies the date and time of the file's last modification. ## Syntax ```text def get_attach_modification_date(attach_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the date and time of the file's last modification. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_read_date property Specifies the file's last read date. ## Syntax ```text def get_attach_read_date(attach_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the file's last read date. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # attach_size property The attachment's size in bytes. ## Syntax ```text def get_attach_size(attach_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The attachment's size in bytes. The *attach_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attach_count](#attach_count-property) property. This property is read-only. # bcc property The number of records in the BccAddr arrays. ## Syntax ```text def get_bcc() -> int: ... bcc = property(get_bcc, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [bcc_addr_address](#bcc-property-1) - [bcc_addr_display_name](#bcc-property-2) - [bcc_addr_group_name](#bcc-property-3) The array indices start at *0* and end at *bcc_addr_count - 1*. This property is read-only. # bcc property Contains the e-mail address in the form of john@doe. ## Syntax ```text def get_bcc(bcc_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the e-mail address in the form of john@doe.com. The *bcc_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [bcc_addr_count](#bcc-property) property. This property is read-only. # bcc property Contains the friendly name of the user of this address, such as John Doe. ## Syntax ```text def get_bcc(bcc_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the friendly name of the user of this address, such as John Doe. The *bcc_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [bcc_addr_count](#bcc-property) property. This property is read-only. # bcc property The name of the group this address belongs to. ## Syntax ```text def get_bcc(bcc_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the group this address belongs to. The *bcc_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [bcc_addr_count](#bcc-property) property. This property is read-only. # blocked_cert_count property The number of records in the BlockedCert arrays. ## Syntax ```text def get_blocked_cert_count() -> int: ... def set_blocked_cert_count(value: int) -> None: ... blocked_cert_count = property(get_blocked_cert_count, set_blocked_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [blocked_cert_bytes](#blocked_cert_bytes-property) - [blocked_cert_handle](#blocked_cert_handle-property) 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 ```text 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](#blocked_cert_count-property) 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 ```text 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. ```text 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](#blocked_cert_count-property) property. # cc_addr_count property The number of records in the CcAddr arrays. ## Syntax ```text def get_cc_addr_count() -> int: ... cc_addr_count = property(get_cc_addr_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [cc_addr_address](#cc_addr_address-property) - [cc_addr_display_name](#cc_addr_display_name-property) - [cc_addr_group_name](#cc_addr_group_name-property) The array indices start at *0* and end at *cc_addr_count - 1*. This property is read-only. # cc_addr_address property Contains the e-mail address in the form of john@doe. ## Syntax ```text def get_cc_addr_address(cc_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the e-mail address in the form of john@doe.com. The *cc_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cc_addr_count](#cc_addr_count-property) property. This property is read-only. # cc_addr_display_name property Contains the friendly name of the user of this address, such as John Doe. ## Syntax ```text def get_cc_addr_display_name(cc_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the friendly name of the user of this address, such as John Doe. The *cc_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cc_addr_count](#cc_addr_count-property) property. This property is read-only. # cc_addr_group_name property The name of the group this address belongs to. ## Syntax ```text def get_cc_addr_group_name(cc_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the group this address belongs to. The *cc_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cc_addr_count](#cc_addr_count-property) property. This property is read-only. # decryption_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_decryption_cert_bytes() -> bytes: ... decryption_cert_bytes = property(get_decryption_cert_bytes, None) ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. # decryption_cert_ca property Indicates whether the certificate has a CA capability. ## Syntax ```text def get_decryption_cert_ca() -> bool: ... def set_decryption_cert_ca(value: bool) -> None: ... decryption_cert_ca = property(get_decryption_cert_ca, set_decryption_cert_ca) ``` ## Default Value FALSE ## Remarks Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled. Set this property when generating a new certificate to have its Basic Constraints extension generated automatically. # decryption_cert_ca_key_id property A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax ```text def get_decryption_cert_ca_key_id() -> bytes: ... decryption_cert_ca_key_id = property(get_decryption_cert_ca_key_id, None) ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [decryption_cert_subject_key_id](#decryption_cert_subject_key_id-property) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. This property is read-only. # decryption_cert_cert_type property Returns the type of the entity contained in the Certificate object. ## Syntax ```text def get_decryption_cert_cert_type() -> int: ... decryption_cert_cert_type = property(get_decryption_cert_cert_type, None) ``` ## Possible Values ```text 0 # Unknown1 # X509Certificate2 # X509CertificateRequest ``` ## Default Value 0 ## Remarks Returns the type of the entity contained in the [Certificate](#Type_Certificate) object. A [Certificate](#Type_Certificate) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](#CertificateManager) class to load or create new certificate and certificate requests objects. This property is read-only. # decryption_cert_crl_distribution_points property Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Syntax ```text def get_decryption_cert_crl_distribution_points() -> str: ... def set_decryption_cert_crl_distribution_points(value: str) -> None: ... decryption_cert_crl_distribution_points = property(get_decryption_cert_crl_distribution_points, set_decryption_cert_crl_distribution_points) ``` ## Default Value "" ## Remarks Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension. Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate. The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. # decryption_cert_curve property Specifies the elliptic curve associated with the certificate's public key. ## Syntax ```text def get_decryption_cert_curve() -> str: ... def set_decryption_cert_curve(value: str) -> None: ... decryption_cert_curve = property(get_decryption_cert_curve, set_decryption_cert_curve) ``` ## Default Value "" ## Remarks Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | # decryption_cert_fingerprint property Contains the fingerprint (a hash imprint) of this certificate. ## Syntax ```text def get_decryption_cert_fingerprint() -> str: ... decryption_cert_fingerprint = property(get_decryption_cert_fingerprint, None) ``` ## Default Value "" ## Remarks Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. This property is read-only. # decryption_cert_friendly_name property Contains an associated alias (friendly name) of the certificate. ## Syntax ```text def get_decryption_cert_friendly_name() -> str: ... decryption_cert_friendly_name = property(get_decryption_cert_friendly_name, None) ``` ## Default Value "" ## Remarks Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names. This property is read-only. # decryption_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_decryption_cert_handle() -> int: ... def set_decryption_cert_handle(value: int) -> None: ... decryption_cert_handle = property(get_decryption_cert_handle, set_decryption_cert_handle) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # decryption_cert_hash_algorithm property Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Syntax ```text def get_decryption_cert_hash_algorithm() -> str: ... def set_decryption_cert_hash_algorithm(value: str) -> None: ... decryption_cert_hash_algorithm = property(get_decryption_cert_hash_algorithm, set_decryption_cert_hash_algorithm) ``` ## Default Value "" ## Remarks Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [decryption_cert_sig_algorithm](#decryption_cert_sig_algorithm-property) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | # decryption_cert_issuer property The common name of the certificate issuer (CA), typically a company name. ## Syntax ```text def get_decryption_cert_issuer() -> str: ... decryption_cert_issuer = property(get_decryption_cert_issuer, None) ``` ## Default Value "" ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [decryption_cert_issuer_rdn](#decryption_cert_issuer_rdn-property). This property is read-only. # decryption_cert_issuer_rdn property A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax ```text def get_decryption_cert_issuer_rdn() -> str: ... def set_decryption_cert_issuer_rdn(value: str) -> None: ... decryption_cert_issuer_rdn = property(get_decryption_cert_issuer_rdn, set_decryption_cert_issuer_rdn) ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* # decryption_cert_key_algorithm property Specifies the public key algorithm of this certificate. ## Syntax ```text def get_decryption_cert_key_algorithm() -> str: ... def set_decryption_cert_key_algorithm(value: str) -> None: ... decryption_cert_key_algorithm = property(get_decryption_cert_key_algorithm, set_decryption_cert_key_algorithm) ``` ## 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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [decryption_cert_key_bits](#decryption_cert_key_bits-property), [decryption_cert_curve](#decryption_cert_curve-property), and [decryption_cert_public_key_bytes](#decryption_cert_public_key_bytes-property) properties to get more details about the key the certificate contains. # decryption_cert_key_bits property Returns the length of the public key in bits. ## Syntax ```text def get_decryption_cert_key_bits() -> int: ... decryption_cert_key_bits = property(get_decryption_cert_key_bits, None) ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [decryption_cert_public_key_bytes](#decryption_cert_public_key_bytes-property) or [decryption_cert_private_key_bytes](#decryption_cert_private_key_bytes-property) property would typically contain auxiliary values, and therefore be longer. This property is read-only. # decryption_cert_key_fingerprint property Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax ```text def get_decryption_cert_key_fingerprint() -> str: ... decryption_cert_key_fingerprint = property(get_decryption_cert_key_fingerprint, None) ``` ## Default Value "" ## Remarks Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the [decryption_cert_fingerprint](#decryption_cert_fingerprint-property) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. This property is read-only. # decryption_cert_key_usage property Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax ```text def get_decryption_cert_key_usage() -> int: ... def set_decryption_cert_key_usage(value: int) -> None: ... decryption_cert_key_usage = property(get_decryption_cert_key_usage, set_decryption_cert_key_usage) ``` ## Default Value 0 ## Remarks Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. # decryption_cert_key_valid property Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Syntax ```text def get_decryption_cert_key_valid() -> bool: ... decryption_cert_key_valid = property(get_decryption_cert_key_valid, None) ``` ## Default Value FALSE ## Remarks Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. This property is read-only. # decryption_cert_ocsp_locations property Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Syntax ```text def get_decryption_cert_ocsp_locations() -> str: ... def set_decryption_cert_ocsp_locations(value: str) -> None: ... decryption_cert_ocsp_locations = property(get_decryption_cert_ocsp_locations, set_decryption_cert_ocsp_locations) ``` ## Default Value "" ## Remarks Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this property before calling the certificate manager's [generate](#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. # decryption_cert_ocsp_no_check property Accessor to the value of the certificate's ocsp-no-check extension. ## Syntax ```text def get_decryption_cert_ocsp_no_check() -> bool: ... def set_decryption_cert_ocsp_no_check(value: bool) -> None: ... decryption_cert_ocsp_no_check = property(get_decryption_cert_ocsp_no_check, set_decryption_cert_ocsp_no_check) ``` ## Default Value FALSE ## Remarks Accessor to the value of the certificate's ocsp-no-check extension. # decryption_cert_origin property Returns the location that the certificate was taken or loaded from. ## Syntax ```text def get_decryption_cert_origin() -> int: ... decryption_cert_origin = property(get_decryption_cert_origin, None) ``` ## Default Value 0 ## Remarks Returns the location that the certificate was taken or loaded from. This property is read-only. # decryption_cert_policy_i_ds property Contains identifiers (OIDs) of the applicable certificate policies. ## Syntax ```text def get_decryption_cert_policy_i_ds() -> str: ... def set_decryption_cert_policy_i_ds(value: str) -> None: ... decryption_cert_policy_i_ds = property(get_decryption_cert_policy_i_ds, set_decryption_cert_policy_i_ds) ``` ## Default Value "" ## Remarks Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. Set this property when generating a certificate to propagate the policies information to the new certificate. The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator. # decryption_cert_private_key_bytes property Returns the certificate's private key in DER-encoded format. ## Syntax ```text def get_decryption_cert_private_key_bytes() -> bytes: ... decryption_cert_private_key_bytes = property(get_decryption_cert_private_key_bytes, None) ``` ## Remarks Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. This property is read-only. # decryption_cert_private_key_exists property Indicates whether the certificate has a usable private key associated with it. ## Syntax ```text def get_decryption_cert_private_key_exists() -> bool: ... decryption_cert_private_key_exists = property(get_decryption_cert_private_key_exists, None) ``` ## Default Value FALSE ## Remarks Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption. This property is independent from [decryption_cert_private_key_bytes](#decryption_cert_private_key_bytes-property), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. This property is read-only. # decryption_cert_private_key_extractable property Indicates whether the private key is extractable (exportable). ## Syntax ```text def get_decryption_cert_private_key_extractable() -> bool: ... decryption_cert_private_key_extractable = property(get_decryption_cert_private_key_extractable, None) ``` ## Default Value FALSE ## Remarks Indicates whether the private key is extractable (exportable). This property is read-only. # decryption_cert_public_key_bytes property Contains the certificate's public key in DER format. ## Syntax ```text def get_decryption_cert_public_key_bytes() -> bytes: ... decryption_cert_public_key_bytes = property(get_decryption_cert_public_key_bytes, None) ``` ## Remarks Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. This property is read-only. # decryption_cert_qualified property Indicates whether the certificate is qualified. ## Syntax ```text def get_decryption_cert_qualified() -> bool: ... decryption_cert_qualified = property(get_decryption_cert_qualified, None) ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. This property is read-only. # decryption_cert_qualified_statements property Returns a simplified qualified status of the certificate. ## Syntax ```text def get_decryption_cert_qualified_statements() -> int: ... def set_decryption_cert_qualified_statements(value: int) -> None: ... decryption_cert_qualified_statements = property(get_decryption_cert_qualified_statements, set_decryption_cert_qualified_statements) ``` ## Possible Values ```text 0 # NonQualified1 # QualifiedHardware2 # QualifiedSoftware ``` ## Default Value 0 ## Remarks Returns a simplified qualified status of the certificate. # decryption_cert_qualifiers property A list of qualifiers. ## Syntax ```text def get_decryption_cert_qualifiers() -> str: ... decryption_cert_qualifiers = property(get_decryption_cert_qualifiers, None) ``` ## Default Value "" ## Remarks A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. This property is read-only. # decryption_cert_self_signed property Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax ```text def get_decryption_cert_self_signed() -> bool: ... decryption_cert_self_signed = property(get_decryption_cert_self_signed, None) ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. This property is read-only. # decryption_cert_serial_number property Returns the certificate's serial number. ## Syntax ```text def get_decryption_cert_serial_number() -> bytes: ... def set_decryption_cert_serial_number(value: bytes) -> None: ... decryption_cert_serial_number = property(get_decryption_cert_serial_number, set_decryption_cert_serial_number) ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. # decryption_cert_sig_algorithm property Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax ```text def get_decryption_cert_sig_algorithm() -> str: ... decryption_cert_sig_algorithm = property(get_decryption_cert_sig_algorithm, None) ``` ## Default Value "" ## Remarks Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. This property is read-only. # decryption_cert_source property Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax ```text def get_decryption_cert_source() -> int: ... decryption_cert_source = property(get_decryption_cert_source, None) ``` ## Possible Values ```text 0 # Unknown1 # Signature2 # Document3 # User4 # Local5 # Online ``` ## Default Value 0 ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. This property is read-only. # decryption_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 ```text def get_decryption_cert_subject() -> str: ... decryption_cert_subject = property(get_decryption_cert_subject, None) ``` ## Default Value "" ## Remarks The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [decryption_cert_subject_rdn](#decryption_cert_subject_rdn-property). This property is read-only. # decryption_cert_subject_alternative_name property Returns or sets the value of the Subject Alternative Name extension of the certificate. ## Syntax ```text def get_decryption_cert_subject_alternative_name() -> str: ... def set_decryption_cert_subject_alternative_name(value: str) -> None: ... decryption_cert_subject_alternative_name = property(get_decryption_cert_subject_alternative_name, set_decryption_cert_subject_alternative_name) ``` ## Default Value "" ## Remarks Returns or sets the value of the Subject Alternative Name extension of the certificate. Subject alternative names are used to provide additional names that are impractical to store in the main [decryption_cert_subject_rdn](#decryption_cert_subject_rdn-property) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator. # decryption_cert_subject_key_id property Contains a unique identifier of the certificate's cryptographic key. ## Syntax ```text def get_decryption_cert_subject_key_id() -> bytes: ... def set_decryption_cert_subject_key_id(value: bytes) -> None: ... decryption_cert_subject_key_id = property(get_decryption_cert_subject_key_id, set_decryption_cert_subject_key_id) ``` ## Remarks Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [decryption_cert_subject_key_id](#decryption_cert_subject_key_id-property) and [decryption_cert_ca_key_id](#decryption_cert_ca_key_id-property) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. # decryption_cert_subject_rdn property A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax ```text def get_decryption_cert_subject_rdn() -> str: ... def set_decryption_cert_subject_rdn(value: str) -> None: ... decryption_cert_subject_rdn = property(get_decryption_cert_subject_rdn, set_decryption_cert_subject_rdn) ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. # decryption_cert_valid property Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. ## Syntax ```text def get_decryption_cert_valid() -> bool: ... decryption_cert_valid = property(get_decryption_cert_valid, None) ``` ## Default Value FALSE ## Remarks Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. This property is read-only. # decryption_cert_valid_from property The time point at which the certificate becomes valid, in UTC. ## Syntax ```text def get_decryption_cert_valid_from() -> str: ... def set_decryption_cert_valid_from(value: str) -> None: ... decryption_cert_valid_from = property(get_decryption_cert_valid_from, set_decryption_cert_valid_from) ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. # decryption_cert_valid_to property The time point at which the certificate expires, in UTC. ## Syntax ```text def get_decryption_cert_valid_to() -> str: ... def set_decryption_cert_valid_to(value: str) -> None: ... decryption_cert_valid_to = property(get_decryption_cert_valid_to, set_decryption_cert_valid_to) ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. # external_crypto_async_document_id property Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax ```text def get_external_crypto_async_document_id() -> str: ... def set_external_crypto_async_document_id(value: str) -> None: ... external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id) ``` ## Default Value "" ## Remarks Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. # external_crypto_custom_params property Custom parameters to be passed to the signing service (uninterpreted). ## Syntax ```text def get_external_crypto_custom_params() -> str: ... def set_external_crypto_custom_params(value: str) -> None: ... external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params) ``` ## Default Value "" ## Remarks Custom parameters to be passed to the signing service (uninterpreted). # external_crypto_data property Additional data to be included in the async state and mirrored back by the requestor. ## Syntax ```text def get_external_crypto_data() -> str: ... def set_external_crypto_data(value: str) -> None: ... external_crypto_data = property(get_external_crypto_data, set_external_crypto_data) ``` ## Default Value "" ## Remarks Additional data to be included in the async state and mirrored back by the requestor. # external_crypto_external_hash_calculation property Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax ```text def get_external_crypto_external_hash_calculation() -> bool: ... def set_external_crypto_external_hash_calculation(value: bool) -> None: ... external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation) ``` ## Default Value FALSE ## Remarks Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. # external_crypto_hash_algorithm property Specifies the request's signature hash algorithm. ## Syntax ```text def get_external_crypto_hash_algorithm() -> str: ... def set_external_crypto_hash_algorithm(value: str) -> None: ... external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm) ``` ## Default Value "SHA256" ## Remarks Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | # external_crypto_key_id property The ID of the pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_id() -> str: ... def set_external_crypto_key_id(value: str) -> None: ... external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id) ``` ## Default Value "" ## Remarks The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [external_crypto_key_secret](#external_crypto_key_secret-property) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` # external_crypto_key_secret property The pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_secret() -> str: ... def set_external_crypto_key_secret(value: str) -> None: ... external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret) ``` ## Default Value "" ## Remarks The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [external_crypto_key_id](#external_crypto_key_id-property) topic. # external_crypto_method property Specifies the asynchronous signing method. ## Syntax ```text def get_external_crypto_method() -> int: ... def set_external_crypto_method(value: int) -> None: ... external_crypto_method = property(get_external_crypto_method, set_external_crypto_method) ``` ## Possible Values ```text 0 # PKCS11 # PKCS7 ``` ## Default Value 0 ## Remarks Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | # external_crypto_mode property Specifies the external cryptography mode. ## Syntax ```text def get_external_crypto_mode() -> int: ... def set_external_crypto_mode(value: int) -> None: ... external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode) ``` ## Possible Values ```text 0 # Default1 # Disabled2 # Generic3 # DCAuth4 # DCAuthJSON ``` ## Default Value 0 ## Remarks Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | # external_crypto_public_key_algorithm property Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax ```text def get_external_crypto_public_key_algorithm() -> str: ... def set_external_crypto_public_key_algorithm(value: str) -> None: ... external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm) ``` ## Default Value "" ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | # fips_mode property Reserved. ## Syntax ```text 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. # author property The number of records in the FromAddr arrays. ## Syntax ```text def get_author() -> int: ... author = property(get_author, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [from_addr_address](#author-property-1) - [from_addr_display_name](#author-property-2) - [from_addr_group_name](#author-property-3) The array indices start at *0* and end at *from_addr_count - 1*. This property is read-only. # author property Contains the e-mail address in the form of john@doe. ## Syntax ```text def get_author(from_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the e-mail address in the form of john@doe.com. The *from_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [from_addr_count](#author-property) property. This property is read-only. # author property Contains the friendly name of the user of this address, such as John Doe. ## Syntax ```text def get_author(from_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the friendly name of the user of this address, such as John Doe. The *from_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [from_addr_count](#author-property) property. This property is read-only. # author property The name of the group this address belongs to. ## Syntax ```text def get_author(from_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the group this address belongs to. The *from_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [from_addr_count](#author-property) property. This property is read-only. # header_field_count property The number of records in the HeaderField arrays. ## Syntax ```text def get_header_field_count() -> int: ... header_field_count = property(get_header_field_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [header_field_category](#header_field_category-property) - [header_field_format](#header_field_format-property) - [header_field_name](#header_field_name-property) - [header_field_value](#header_field_value-property) The array indices start at *0* and end at *header_field_count - 1*. This property is read-only. # header_field_category property Specifies the string category of the contained value. ## Syntax ```text def get_header_field_category(header_field_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the string category of the contained value. This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used. For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used. The *header_field_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [header_field_count](#header_field_count-property) property. This property is read-only. # header_field_format property Specifies the format (encoding) of the value contained in the Value property. ## Syntax ```text def get_header_field_format(header_field_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Specifies the format (encoding) of the value contained in the [header_field_value](#header_field_value-property) property. Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: ```text utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071"; ``` The following formats are currently supported: | | | | | --- | --- | --- | | svfText | 0 | The property contains text | | svfBinary | 1 | The property contains binary data. The Value property contains a hex encoding of it. | The *header_field_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [header_field_count](#header_field_count-property) property. This property is read-only. # header_field_name property The name element in a (name, value) pair. ## Syntax ```text def get_header_field_name(header_field_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name element in a (name, value) pair. The *header_field_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [header_field_count](#header_field_count-property) property. This property is read-only. # header_field_value property The value element in a (name, value) pair. ## Syntax ```text def get_header_field_value(header_field_index: int) -> str: ... ``` ## Default Value "" ## Remarks The value element in a (name, value) pair. The *header_field_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [header_field_count](#header_field_count-property) property. This property is read-only. # ignore_chain_validation_errors property Makes the class tolerant to chain validation errors. ## Syntax ```text 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. # known_cert_count property The number of records in the KnownCert arrays. ## Syntax ```text def get_known_cert_count() -> int: ... def set_known_cert_count(value: int) -> None: ... known_cert_count = property(get_known_cert_count, set_known_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_cert_bytes](#known_cert_bytes-property) - [known_cert_handle](#known_cert_handle-property) 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 ```text 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](#known_cert_count-property) 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 ```text 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. ```text 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](#known_cert_count-property) property. # known_crl_count property The number of records in the KnownCRL arrays. ## Syntax ```text 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: - [known_crl_bytes](#known_crl_bytes-property) - [known_crl_handle](#known_crl_handle-property) 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 ```text 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](#known_crl_count-property) 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 ```text 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. ```text 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](#known_crl_count-property) property. # known_ocsp_count property The number of records in the KnownOCSP arrays. ## Syntax ```text 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: - [known_ocsp_bytes](#known_ocsp_bytes-property) - [known_ocsp_handle](#known_ocsp_handle-property) 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 ```text 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](#known_ocsp_count-property) 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 ```text 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. ```text 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](#known_ocsp_count-property) property. # msg_attachment_count property Returns the number of attachments in this message. ## Syntax ```text def get_msg_attachment_count() -> int: ... msg_attachment_count = property(get_msg_attachment_count, None) ``` ## Default Value 0 ## Remarks Returns the number of attachments in this message. This property is read-only. # msg_bcc property The contents of the BCC header property. ## Syntax ```text def get_msg_bcc() -> str: ... def set_msg_bcc(value: str) -> None: ... msg_bcc = property(get_msg_bcc, set_msg_bcc) ``` ## Default Value "" ## Remarks The contents of the BCC header field. The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message. Mail servers remove the BCC header when processing the message and use its value for dispatching the message only. # msg_cc property The value of the CC header property. ## Syntax ```text def get_msg_cc() -> str: ... def set_msg_cc(value: str) -> None: ... msg_cc = property(get_msg_cc, set_msg_cc) ``` ## Default Value "" ## Remarks The value of the CC header field. The CC field contains the addresses of secondary recipients of the message. # msg_comments property Contains additional information about the message body. ## Syntax ```text def get_msg_comments() -> str: ... def set_msg_comments(value: str) -> None: ... msg_comments = property(get_msg_comments, set_msg_comments) ``` ## Default Value "" ## Remarks Contains additional information about the message body. # msg_date property The date and time when the message entered the mail delivery system. ## Syntax ```text def get_msg_date() -> str: ... def set_msg_date(value: str) -> None: ... msg_date = property(get_msg_date, set_msg_date) ``` ## Default Value "" ## Remarks The date and time when the message entered the mail delivery system. This field contains the date and time at which the creator of the message posted the message to the mail delivery system. The date is returned and accepted in UTC time zone. # msg_delivery_receipt property Enables delivery notification. ## Syntax ```text def get_msg_delivery_receipt() -> bool: ... def set_msg_delivery_receipt(value: bool) -> None: ... msg_delivery_receipt = property(get_msg_delivery_receipt, set_msg_delivery_receipt) ``` ## Default Value FALSE ## Remarks Enables delivery notification. # msg_from property Contains the value of the From header property. ## Syntax ```text def get_msg_from() -> str: ... def set_msg_from(value: str) -> None: ... msg_from = property(get_msg_from, set_msg_from) ``` ## Default Value "" ## Remarks Contains the value of the From header field. This field contains the address(es) of the message author(s). If the actual sender is not the author of the message, use [msg_sender](#msg_sender-property) to specify the sender separately. # msg_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_msg_handle() -> int: ... def set_msg_handle(value: int) -> None: ... msg_handle = property(get_msg_handle, set_msg_handle) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # msg_html_text property The HTML version of the message. ## Syntax ```text def get_msg_html_text() -> str: ... def set_msg_html_text(value: str) -> None: ... msg_html_text = property(get_msg_html_text, set_msg_html_text) ``` ## Default Value "" ## Remarks The HTML version of the message. # msg_id property The contents of the Message-ID header property. ## Syntax ```text def get_msg_id() -> str: ... def set_msg_id(value: str) -> None: ... msg_id = property(get_msg_id, set_msg_id) ``` ## Default Value "" ## Remarks The contents of the Message-ID header field. This field contains a unique identifier that refers to a particular version of this message. # msg_in_reply_to property The value of the In-Reply-To header property. ## Syntax ```text def get_msg_in_reply_to() -> str: ... def set_msg_in_reply_to(value: str) -> None: ... msg_in_reply_to = property(get_msg_in_reply_to, set_msg_in_reply_to) ``` ## Default Value "" ## Remarks The value of the In-Reply-To header field. A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply. # msg_keywords property The value of the Keywords header property. ## Syntax ```text def get_msg_keywords() -> str: ... def set_msg_keywords(value: str) -> None: ... msg_keywords = property(get_msg_keywords, set_msg_keywords) ``` ## Default Value "" ## Remarks The value of the Keywords header field. This field can be used to add some important words and phrases that might be useful for the recipient. # msg_mailer property The name of the software that was used to send the message. ## Syntax ```text def get_msg_mailer() -> str: ... msg_mailer = property(get_msg_mailer, None) ``` ## Default Value "" ## Remarks The name of the software that was used to send the message. This property is read-only. # msg_plain_text property The plain text version of the message. ## Syntax ```text def get_msg_plain_text() -> str: ... def set_msg_plain_text(value: str) -> None: ... msg_plain_text = property(get_msg_plain_text, set_msg_plain_text) ``` ## Default Value "" ## Remarks The plain text version of the message. # msg_priority property Specifies the message priority. ## Syntax ```text def get_msg_priority() -> int: ... def set_msg_priority(value: int) -> None: ... msg_priority = property(get_msg_priority, set_msg_priority) ``` ## Possible Values ```text 0 # Lowest1 # Low2 # Normal3 # High4 # Highest ``` ## Default Value 2 ## Remarks Specifies the message priority. Available options: | | | | --- | --- | | mpLowest | 0 | | mpLow | 1 | | mpNormal | 2 | | mpHigh | 3 | | mpHighest | 4 | # msg_read_receipt property Enables a read notification. ## Syntax ```text def get_msg_read_receipt() -> bool: ... def set_msg_read_receipt(value: bool) -> None: ... msg_read_receipt = property(get_msg_read_receipt, set_msg_read_receipt) ``` ## Default Value FALSE ## Remarks Enables a read notification. # msg_references property The value of the References header property. ## Syntax ```text def get_msg_references() -> str: ... def set_msg_references(value: str) -> None: ... msg_references = property(get_msg_references, set_msg_references) ``` ## Default Value "" ## Remarks The value of the References header field. A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message. # msg_reply_to property The value of the Reply-To header property. ## Syntax ```text def get_msg_reply_to() -> str: ... def set_msg_reply_to(value: str) -> None: ... msg_reply_to = property(get_msg_reply_to, set_msg_reply_to) ``` ## Default Value "" ## Remarks The value of the Reply-To header field. This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the [msg_from](#msg_from-property) field. # msg_return_path property The value of the Return-Path header property. ## Syntax ```text def get_msg_return_path() -> str: ... def set_msg_return_path(value: str) -> None: ... msg_return_path = property(get_msg_return_path, set_msg_return_path) ``` ## Default Value "" ## Remarks The value of the Return-Path header field. This field contains the address to which this message shall be returned in case of unsuccessful delivery. # msg_sender property The value of the Sender header property. ## Syntax ```text def get_msg_sender() -> str: ... def set_msg_sender(value: str) -> None: ... msg_sender = property(get_msg_sender, set_msg_sender) ``` ## Default Value "" ## Remarks The value of the Sender header field. This field specifies the mailbox of the agent responsible for the actual transmission of this message. If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are identical, the "Sender:" field is deemed excessive and should not be used. # msg_send_to property The value of the To header property. ## Syntax ```text def get_msg_send_to() -> str: ... def set_msg_send_to(value: str) -> None: ... msg_send_to = property(get_msg_send_to, set_msg_send_to) ``` ## Default Value "" ## Remarks The value of the To header field. This field specifies the address(es) of the primary recipient(s) of the message. # msg_subject property Contains the subject property of this message. ## Syntax ```text def get_msg_subject() -> str: ... def set_msg_subject(value: str) -> None: ... msg_subject = property(get_msg_subject, set_msg_subject) ``` ## Default Value "" ## Remarks Contains the subject field of this message. # offline_mode property Switches the class to offline mode. ## Syntax ```text def get_offline_mode() -> bool: ... def set_offline_mode(value: bool) -> None: ... offline_mode = property(get_offline_mode, set_offline_mode) ``` ## Default Value FALSE ## Remarks 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. # profile property Specifies a pre-defined profile to apply when creating the signature. ## Syntax ```text 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. # proxy_address property The IP address of the proxy server. ## Syntax ```text def get_proxy_address() -> str: ... def set_proxy_address(value: str) -> None: ... proxy_address = property(get_proxy_address, set_proxy_address) ``` ## Default Value "" ## Remarks The IP address of the proxy server. # proxy_authentication property The authentication type used by the proxy server. ## Syntax ```text def get_proxy_authentication() -> int: ... def set_proxy_authentication(value: int) -> None: ... proxy_authentication = property(get_proxy_authentication, set_proxy_authentication) ``` ## Possible Values ```text 0 # NoAuthentication1 # Basic2 # Digest3 # NTLM ``` ## Default Value 0 ## Remarks The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | # proxy_password property The password to authenticate to the proxy server. ## Syntax ```text def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ... proxy_password = property(get_proxy_password, set_proxy_password) ``` ## Default Value "" ## Remarks The password to authenticate to the proxy server. # proxy_port property The port on the proxy server to connect to. ## Syntax ```text def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ... proxy_port = property(get_proxy_port, set_proxy_port) ``` ## Default Value 0 ## Remarks The port on the proxy server to connect to. # proxy_type property The type of the proxy server. ## Syntax ```text def get_proxy_type() -> int: ... def set_proxy_type(value: int) -> None: ... proxy_type = property(get_proxy_type, set_proxy_type) ``` ## Possible Values ```text 0 # None1 # Socks42 # Socks53 # WebTunnel4 # HTTP ``` ## Default Value 0 ## Remarks The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | # proxy_request_headers property Contains HTTP request headers for WebTunnel and HTTP proxy. ## Syntax ```text def get_proxy_request_headers() -> str: ... def set_proxy_request_headers(value: str) -> None: ... proxy_request_headers = property(get_proxy_request_headers, set_proxy_request_headers) ``` ## Default Value "" ## Remarks Contains HTTP request headers for WebTunnel and HTTP proxy. # proxy_response_body property Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Syntax ```text def get_proxy_response_body() -> str: ... def set_proxy_response_body(value: str) -> None: ... proxy_response_body = property(get_proxy_response_body, set_proxy_response_body) ``` ## Default Value "" ## Remarks Contains the HTTP or HTTPS (WebTunnel) proxy response body. # proxy_response_headers property Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Syntax ```text def get_proxy_response_headers() -> str: ... def set_proxy_response_headers(value: str) -> None: ... proxy_response_headers = property(get_proxy_response_headers, set_proxy_response_headers) ``` ## Default Value "" ## Remarks Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. # proxy_use_ipv6 property Specifies whether IPv6 should be used when connecting through the proxy. ## Syntax ```text def get_proxy_use_ipv6() -> bool: ... def set_proxy_use_ipv6(value: bool) -> None: ... proxy_use_ipv6 = property(get_proxy_use_ipv6, set_proxy_use_ipv6) ``` ## Default Value FALSE ## Remarks Specifies whether IPv6 should be used when connecting through the proxy. # proxy_username property Specifies the username credential for proxy authentication. ## Syntax ```text def get_proxy_username() -> str: ... def set_proxy_username(value: str) -> None: ... proxy_username = property(get_proxy_username, set_proxy_username) ``` ## Default Value "" ## Remarks Specifies the username credential for proxy authentication. # reply_to_addr_count property The number of records in the ReplyToAddr arrays. ## Syntax ```text def get_reply_to_addr_count() -> int: ... reply_to_addr_count = property(get_reply_to_addr_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [reply_to_addr_address](#reply_to_addr_address-property) - [reply_to_addr_display_name](#reply_to_addr_display_name-property) - [reply_to_addr_group_name](#reply_to_addr_group_name-property) The array indices start at *0* and end at *reply_to_addr_count - 1*. This property is read-only. # reply_to_addr_address property Contains the e-mail address in the form of john@doe. ## Syntax ```text def get_reply_to_addr_address(reply_to_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the e-mail address in the form of john@doe.com. The *reply_to_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [reply_to_addr_count](#reply_to_addr_count-property) property. This property is read-only. # reply_to_addr_display_name property Contains the friendly name of the user of this address, such as John Doe. ## Syntax ```text def get_reply_to_addr_display_name(reply_to_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the friendly name of the user of this address, such as John Doe. The *reply_to_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [reply_to_addr_count](#reply_to_addr_count-property) property. This property is read-only. # reply_to_addr_group_name property The name of the group this address belongs to. ## Syntax ```text def get_reply_to_addr_group_name(reply_to_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the group this address belongs to. The *reply_to_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [reply_to_addr_count](#reply_to_addr_count-property) property. This property is read-only. # revocation_check property Specifies the kind(s) of revocation check to perform for all chain certificates. ## Syntax ```text def get_revocation_check() -> int: ... def set_revocation_check(value: int) -> None: ... revocation_check = property(get_revocation_check, set_revocation_check) ``` ## Possible Values ```text 0 # None1 # Auto2 # AllCRL3 # AllOCSP4 # AllCRLAndOCSP5 # AnyCRL6 # AnyOCSP7 # AnyCRLOrOCSP8 # AnyOCSPOrCRL ``` ## 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. # sec_info_chain_validation_details property The details of a certificate chain validation outcome. ## Syntax ```text def get_sec_info_chain_validation_details() -> int: ... sec_info_chain_validation_details = property(get_sec_info_chain_validation_details, None) ``` ## Default Value 0 ## Remarks The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | This property is read-only. # sec_info_chain_validation_result property The outcome of a certificate chain validation routine. ## Syntax ```text def get_sec_info_chain_validation_result() -> int: ... sec_info_chain_validation_result = property(get_sec_info_chain_validation_result, None) ``` ## Possible Values ```text 0 # Valid1 # ValidButUntrusted2 # Invalid3 # CantBeEstablished ``` ## 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. This property is read-only. # sec_info_claimed_signing_time property Returns the signature's claimed signing time. ## Syntax ```text def get_sec_info_claimed_signing_time() -> str: ... sec_info_claimed_signing_time = property(get_sec_info_claimed_signing_time, None) ``` ## Default Value "" ## Remarks Returns the signature's claimed signing time. Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by a trusted timestamp and may be forfeited or wrong. The time is provided in UTC. This property is read-only. # sec_info_encrypted property Indicates whether the message is encrypted. ## Syntax ```text def get_sec_info_encrypted() -> bool: ... sec_info_encrypted = property(get_sec_info_encrypted, None) ``` ## Default Value FALSE ## Remarks Indicates whether the message is encrypted. This property is read-only. # sec_info_encryption_algorithm property Indicates the algorithm that was used to encrypt the message. ## Syntax ```text def get_sec_info_encryption_algorithm() -> str: ... sec_info_encryption_algorithm = property(get_sec_info_encryption_algorithm, None) ``` ## Default Value "" ## Remarks Indicates the algorithm that was used to encrypt the message. This property is read-only. # sec_info_hash_algorithm property Specifies the hash algorithm that was used to calculate the signature. ## Syntax ```text def get_sec_info_hash_algorithm() -> str: ... sec_info_hash_algorithm = property(get_sec_info_hash_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the hash algorithm that was used to calculate the signature. This property is read-only. # sec_info_signature_validation_result property The outcome of the cryptographic signature validation. ## Syntax ```text def get_sec_info_signature_validation_result() -> int: ... sec_info_signature_validation_result = property(get_sec_info_signature_validation_result, None) ``` ## Possible Values ```text 0 # Valid1 # Unknown2 # Corrupted3 # SignerNotFound4 # Failure5 # ReferenceCorrupted ``` ## Default Value 0 ## Remarks The outcome of the cryptographic signature validation. The following signature validity values are supported: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only. # sec_info_signed property Indicates whether the message is signed. ## Syntax ```text def get_sec_info_signed() -> bool: ... sec_info_signed = property(get_sec_info_signed, None) ``` ## Default Value FALSE ## Remarks Indicates whether the message is signed. This property is read-only. # sec_info_validation_log property Contains the signing certificate's chain validation log. ## Syntax ```text def get_sec_info_validation_log() -> str: ... sec_info_validation_log = property(get_sec_info_validation_log, None) ``` ## Default Value "" ## Remarks Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures. This property is read-only. # sender_addr_address property Contains the e-mail address in the form of john@doe. ## Syntax ```text def get_sender_addr_address() -> str: ... sender_addr_address = property(get_sender_addr_address, None) ``` ## Default Value "" ## Remarks Contains the e-mail address in the form of john@doe.com. This property is read-only. # sender_addr_display_name property Contains the friendly name of the user of this address, such as John Doe. ## Syntax ```text def get_sender_addr_display_name() -> str: ... sender_addr_display_name = property(get_sender_addr_display_name, None) ``` ## Default Value "" ## Remarks Contains the friendly name of the user of this address, such as John Doe. This property is read-only. # sender_addr_group_name property The name of the group this address belongs to. ## Syntax ```text def get_sender_addr_group_name() -> str: ... sender_addr_group_name = property(get_sender_addr_group_name, None) ``` ## Default Value "" ## Remarks The name of the group this address belongs to. This property is read-only. # send_to_addr_count property The number of records in the SendToAddr arrays. ## Syntax ```text def get_send_to_addr_count() -> int: ... send_to_addr_count = property(get_send_to_addr_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [send_to_addr_address](#send_to_addr_address-property) - [send_to_addr_display_name](#send_to_addr_display_name-property) - [send_to_addr_group_name](#send_to_addr_group_name-property) The array indices start at *0* and end at *send_to_addr_count - 1*. This property is read-only. # send_to_addr_address property Contains the e-mail address in the form of john@doe. ## Syntax ```text def get_send_to_addr_address(send_to_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the e-mail address in the form of john@doe.com. The *send_to_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [send_to_addr_count](#send_to_addr_count-property) property. This property is read-only. # send_to_addr_display_name property Contains the friendly name of the user of this address, such as John Doe. ## Syntax ```text def get_send_to_addr_display_name(send_to_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the friendly name of the user of this address, such as John Doe. The *send_to_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [send_to_addr_count](#send_to_addr_count-property) property. This property is read-only. # send_to_addr_group_name property The name of the group this address belongs to. ## Syntax ```text def get_send_to_addr_group_name(send_to_addr_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the group this address belongs to. The *send_to_addr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [send_to_addr_count](#send_to_addr_count-property) property. This property is read-only. # signing_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_signing_cert_bytes() -> bytes: ... signing_cert_bytes = property(get_signing_cert_bytes, None) ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. # signing_cert_ca property Indicates whether the certificate has a CA capability. ## Syntax ```text def get_signing_cert_ca() -> bool: ... signing_cert_ca = property(get_signing_cert_ca, None) ``` ## Default Value FALSE ## Remarks Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled. Set this property when generating a new certificate to have its Basic Constraints extension generated automatically. This property is read-only. # signing_cert_ca_key_id property A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax ```text def get_signing_cert_ca_key_id() -> bytes: ... signing_cert_ca_key_id = property(get_signing_cert_ca_key_id, None) ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [signing_cert_subject_key_id](#signing_cert_subject_key_id-property) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. This property is read-only. # signing_cert_crl_distribution_points property Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Syntax ```text def get_signing_cert_crl_distribution_points() -> str: ... signing_cert_crl_distribution_points = property(get_signing_cert_crl_distribution_points, None) ``` ## Default Value "" ## Remarks Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension. Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate. The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. This property is read-only. # signing_cert_curve property Specifies the elliptic curve associated with the certificate's public key. ## Syntax ```text def get_signing_cert_curve() -> str: ... signing_cert_curve = property(get_signing_cert_curve, None) ``` ## Default Value "" ## Remarks Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | This property is read-only. # signing_cert_fingerprint property Contains the fingerprint (a hash imprint) of this certificate. ## Syntax ```text def get_signing_cert_fingerprint() -> str: ... signing_cert_fingerprint = property(get_signing_cert_fingerprint, None) ``` ## Default Value "" ## Remarks Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. This property is read-only. # signing_cert_friendly_name property Contains an associated alias (friendly name) of the certificate. ## Syntax ```text def get_signing_cert_friendly_name() -> str: ... signing_cert_friendly_name = property(get_signing_cert_friendly_name, None) ``` ## Default Value "" ## Remarks Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names. This property is read-only. # signing_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_signing_cert_handle() -> int: ... signing_cert_handle = property(get_signing_cert_handle, 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is read-only. # signing_cert_hash_algorithm property Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Syntax ```text def get_signing_cert_hash_algorithm() -> str: ... signing_cert_hash_algorithm = property(get_signing_cert_hash_algorithm, None) ``` ## Default Value "" ## Remarks Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [signing_cert_sig_algorithm](#signing_cert_sig_algorithm-property) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | This property is read-only. # signing_cert_issuer property The common name of the certificate issuer (CA), typically a company name. ## Syntax ```text def get_signing_cert_issuer() -> str: ... signing_cert_issuer = property(get_signing_cert_issuer, None) ``` ## Default Value "" ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [signing_cert_issuer_rdn](#signing_cert_issuer_rdn-property). This property is read-only. # signing_cert_issuer_rdn property A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax ```text def get_signing_cert_issuer_rdn() -> str: ... signing_cert_issuer_rdn = property(get_signing_cert_issuer_rdn, None) ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* This property is read-only. # signing_cert_key_algorithm property Specifies the public key algorithm of this certificate. ## Syntax ```text def get_signing_cert_key_algorithm() -> str: ... signing_cert_key_algorithm = property(get_signing_cert_key_algorithm, None) ``` ## 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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [signing_cert_key_bits](#signing_cert_key_bits-property), [signing_cert_curve](#signing_cert_curve-property), and [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property) properties to get more details about the key the certificate contains. This property is read-only. # signing_cert_key_bits property Returns the length of the public key in bits. ## Syntax ```text def get_signing_cert_key_bits() -> int: ... signing_cert_key_bits = property(get_signing_cert_key_bits, None) ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property) or [signing_cert_private_key_bytes](#MailReader_p_SigningCertPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. This property is read-only. # signing_cert_key_fingerprint property Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax ```text def get_signing_cert_key_fingerprint() -> str: ... signing_cert_key_fingerprint = property(get_signing_cert_key_fingerprint, None) ``` ## Default Value "" ## Remarks Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the [signing_cert_fingerprint](#signing_cert_fingerprint-property) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. This property is read-only. # signing_cert_key_usage property Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax ```text def get_signing_cert_key_usage() -> int: ... signing_cert_key_usage = property(get_signing_cert_key_usage, None) ``` ## Default Value 0 ## Remarks Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. This property is read-only. # signing_cert_key_valid property Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Syntax ```text def get_signing_cert_key_valid() -> bool: ... signing_cert_key_valid = property(get_signing_cert_key_valid, None) ``` ## Default Value FALSE ## Remarks Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. This property is read-only. # signing_cert_ocsp_locations property Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Syntax ```text def get_signing_cert_ocsp_locations() -> str: ... signing_cert_ocsp_locations = property(get_signing_cert_ocsp_locations, None) ``` ## Default Value "" ## Remarks Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this property before calling the certificate manager's [generate](#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. This property is read-only. # signing_cert_policy_i_ds property Contains identifiers (OIDs) of the applicable certificate policies. ## Syntax ```text def get_signing_cert_policy_i_ds() -> str: ... signing_cert_policy_i_ds = property(get_signing_cert_policy_i_ds, None) ``` ## Default Value "" ## Remarks Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. Set this property when generating a certificate to propagate the policies information to the new certificate. The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator. This property is read-only. # signing_cert_public_key_bytes property Contains the certificate's public key in DER format. ## Syntax ```text def get_signing_cert_public_key_bytes() -> bytes: ... signing_cert_public_key_bytes = property(get_signing_cert_public_key_bytes, None) ``` ## Remarks Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. This property is read-only. # signing_cert_self_signed property Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax ```text def get_signing_cert_self_signed() -> bool: ... signing_cert_self_signed = property(get_signing_cert_self_signed, None) ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. This property is read-only. # signing_cert_serial_number property Returns the certificate's serial number. ## Syntax ```text def get_signing_cert_serial_number() -> bytes: ... signing_cert_serial_number = property(get_signing_cert_serial_number, None) ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. This property is read-only. # signing_cert_sig_algorithm property Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax ```text def get_signing_cert_sig_algorithm() -> str: ... signing_cert_sig_algorithm = property(get_signing_cert_sig_algorithm, None) ``` ## Default Value "" ## Remarks Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. This property is read-only. # signing_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 ```text def get_signing_cert_subject() -> str: ... signing_cert_subject = property(get_signing_cert_subject, None) ``` ## Default Value "" ## Remarks The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [signing_cert_subject_rdn](#signing_cert_subject_rdn-property). This property is read-only. # signing_cert_subject_key_id property Contains a unique identifier of the certificate's cryptographic key. ## Syntax ```text def get_signing_cert_subject_key_id() -> bytes: ... signing_cert_subject_key_id = property(get_signing_cert_subject_key_id, None) ``` ## Remarks Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [signing_cert_subject_key_id](#signing_cert_subject_key_id-property) and [signing_cert_ca_key_id](#signing_cert_ca_key_id-property) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. This property is read-only. # signing_cert_subject_rdn property A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax ```text def get_signing_cert_subject_rdn() -> str: ... signing_cert_subject_rdn = property(get_signing_cert_subject_rdn, None) ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. This property is read-only. # signing_cert_valid_from property The time point at which the certificate becomes valid, in UTC. ## Syntax ```text def get_signing_cert_valid_from() -> str: ... signing_cert_valid_from = property(get_signing_cert_valid_from, None) ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. This property is read-only. # signing_cert_valid_to property The time point at which the certificate expires, in UTC. ## Syntax ```text def get_signing_cert_valid_to() -> str: ... signing_cert_valid_to = property(get_signing_cert_valid_to, None) ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. 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 ```text 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) ``` ## Possible Values ```text 0 # Auto1 # Platform2 # Own3 # OwnSecure ``` ## 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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. # tls_auto_validate_certificates property Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax ```text 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 ```text 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) ``` ## Possible Values ```text 0 # Default1 # Compatible2 # ComprehensiveInsecure3 # HighlySecure ``` ## 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 ```text 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](#tls_base_configuration-property). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below: - NULL_NULL_NULL - RSA_NULL_MD5 - RSA_NULL_SHA - RSA_RC4_MD5 - RSA_RC4_SHA - RSA_RC2_MD5 - RSA_IDEA_MD5 - RSA_IDEA_SHA - RSA_DES_MD5 - RSA_DES_SHA - RSA_3DES_MD5 - RSA_3DES_SHA - RSA_AES128_SHA - RSA_AES256_SHA - DH_DSS_DES_SHA - DH_DSS_3DES_SHA - DH_DSS_AES128_SHA - DH_DSS_AES256_SHA - DH_RSA_DES_SHA - DH_RSA_3DES_SHA - DH_RSA_AES128_SHA - DH_RSA_AES256_SHA - DHE_DSS_DES_SHA - DHE_DSS_3DES_SHA - DHE_DSS_AES128_SHA - DHE_DSS_AES256_SHA - DHE_RSA_DES_SHA - DHE_RSA_3DES_SHA - DHE_RSA_AES128_SHA - DHE_RSA_AES256_SHA - DH_ANON_RC4_MD5 - DH_ANON_DES_SHA - DH_ANON_3DES_SHA - DH_ANON_AES128_SHA - DH_ANON_AES256_SHA - RSA_RC2_MD5_EXPORT - RSA_RC4_MD5_EXPORT - RSA_DES_SHA_EXPORT - DH_DSS_DES_SHA_EXPORT - DH_RSA_DES_SHA_EXPORT - DHE_DSS_DES_SHA_EXPORT - DHE_RSA_DES_SHA_EXPORT - DH_ANON_RC4_MD5_EXPORT - DH_ANON_DES_SHA_EXPORT - RSA_CAMELLIA128_SHA - DH_DSS_CAMELLIA128_SHA - DH_RSA_CAMELLIA128_SHA - DHE_DSS_CAMELLIA128_SHA - DHE_RSA_CAMELLIA128_SHA - DH_ANON_CAMELLIA128_SHA - RSA_CAMELLIA256_SHA - DH_DSS_CAMELLIA256_SHA - DH_RSA_CAMELLIA256_SHA - DHE_DSS_CAMELLIA256_SHA - DHE_RSA_CAMELLIA256_SHA - DH_ANON_CAMELLIA256_SHA - PSK_RC4_SHA - PSK_3DES_SHA - PSK_AES128_SHA - PSK_AES256_SHA - DHE_PSK_RC4_SHA - DHE_PSK_3DES_SHA - DHE_PSK_AES128_SHA - DHE_PSK_AES256_SHA - RSA_PSK_RC4_SHA - RSA_PSK_3DES_SHA - RSA_PSK_AES128_SHA - RSA_PSK_AES256_SHA - RSA_SEED_SHA - DH_DSS_SEED_SHA - DH_RSA_SEED_SHA - DHE_DSS_SEED_SHA - DHE_RSA_SEED_SHA - DH_ANON_SEED_SHA - SRP_SHA_3DES_SHA - SRP_SHA_RSA_3DES_SHA - SRP_SHA_DSS_3DES_SHA - SRP_SHA_AES128_SHA - SRP_SHA_RSA_AES128_SHA - SRP_SHA_DSS_AES128_SHA - SRP_SHA_AES256_SHA - SRP_SHA_RSA_AES256_SHA - SRP_SHA_DSS_AES256_SHA - ECDH_ECDSA_NULL_SHA - ECDH_ECDSA_RC4_SHA - ECDH_ECDSA_3DES_SHA - ECDH_ECDSA_AES128_SHA - ECDH_ECDSA_AES256_SHA - ECDHE_ECDSA_NULL_SHA - ECDHE_ECDSA_RC4_SHA - ECDHE_ECDSA_3DES_SHA - ECDHE_ECDSA_AES128_SHA - ECDHE_ECDSA_AES256_SHA - ECDH_RSA_NULL_SHA - ECDH_RSA_RC4_SHA - ECDH_RSA_3DES_SHA - ECDH_RSA_AES128_SHA - ECDH_RSA_AES256_SHA - ECDHE_RSA_NULL_SHA - ECDHE_RSA_RC4_SHA - ECDHE_RSA_3DES_SHA - ECDHE_RSA_AES128_SHA - ECDHE_RSA_AES256_SHA - ECDH_ANON_NULL_SHA - ECDH_ANON_RC4_SHA - ECDH_ANON_3DES_SHA - ECDH_ANON_AES128_SHA - ECDH_ANON_AES256_SHA - RSA_NULL_SHA256 - RSA_AES128_SHA256 - RSA_AES256_SHA256 - DH_DSS_AES128_SHA256 - DH_RSA_AES128_SHA256 - DHE_DSS_AES128_SHA256 - DHE_RSA_AES128_SHA256 - DH_DSS_AES256_SHA256 - DH_RSA_AES256_SHA256 - DHE_DSS_AES256_SHA256 - DHE_RSA_AES256_SHA256 - DH_ANON_AES128_SHA256 - DH_ANON_AES256_SHA256 - RSA_AES128_GCM_SHA256 - RSA_AES256_GCM_SHA384 - DHE_RSA_AES128_GCM_SHA256 - DHE_RSA_AES256_GCM_SHA384 - DH_RSA_AES128_GCM_SHA256 - DH_RSA_AES256_GCM_SHA384 - DHE_DSS_AES128_GCM_SHA256 - DHE_DSS_AES256_GCM_SHA384 - DH_DSS_AES128_GCM_SHA256 - DH_DSS_AES256_GCM_SHA384 - DH_ANON_AES128_GCM_SHA256 - DH_ANON_AES256_GCM_SHA384 - ECDHE_ECDSA_AES128_SHA256 - ECDHE_ECDSA_AES256_SHA384 - ECDH_ECDSA_AES128_SHA256 - ECDH_ECDSA_AES256_SHA384 - ECDHE_RSA_AES128_SHA256 - ECDHE_RSA_AES256_SHA384 - ECDH_RSA_AES128_SHA256 - ECDH_RSA_AES256_SHA384 - ECDHE_ECDSA_AES128_GCM_SHA256 - ECDHE_ECDSA_AES256_GCM_SHA384 - ECDH_ECDSA_AES128_GCM_SHA256 - ECDH_ECDSA_AES256_GCM_SHA384 - ECDHE_RSA_AES128_GCM_SHA256 - ECDHE_RSA_AES256_GCM_SHA384 - ECDH_RSA_AES128_GCM_SHA256 - ECDH_RSA_AES256_GCM_SHA384 - PSK_AES128_GCM_SHA256 - PSK_AES256_GCM_SHA384 - DHE_PSK_AES128_GCM_SHA256 - DHE_PSK_AES256_GCM_SHA384 - RSA_PSK_AES128_GCM_SHA256 - RSA_PSK_AES256_GCM_SHA384 - PSK_AES128_SHA256 - PSK_AES256_SHA384 - PSK_NULL_SHA256 - PSK_NULL_SHA384 - DHE_PSK_AES128_SHA256 - DHE_PSK_AES256_SHA384 - DHE_PSK_NULL_SHA256 - DHE_PSK_NULL_SHA384 - RSA_PSK_AES128_SHA256 - RSA_PSK_AES256_SHA384 - RSA_PSK_NULL_SHA256 - RSA_PSK_NULL_SHA384 - RSA_CAMELLIA128_SHA256 - DH_DSS_CAMELLIA128_SHA256 - DH_RSA_CAMELLIA128_SHA256 - DHE_DSS_CAMELLIA128_SHA256 - DHE_RSA_CAMELLIA128_SHA256 - DH_ANON_CAMELLIA128_SHA256 - RSA_CAMELLIA256_SHA256 - DH_DSS_CAMELLIA256_SHA256 - DH_RSA_CAMELLIA256_SHA256 - DHE_DSS_CAMELLIA256_SHA256 - DHE_RSA_CAMELLIA256_SHA256 - DH_ANON_CAMELLIA256_SHA256 - ECDHE_ECDSA_CAMELLIA128_SHA256 - ECDHE_ECDSA_CAMELLIA256_SHA384 - ECDH_ECDSA_CAMELLIA128_SHA256 - ECDH_ECDSA_CAMELLIA256_SHA384 - ECDHE_RSA_CAMELLIA128_SHA256 - ECDHE_RSA_CAMELLIA256_SHA384 - ECDH_RSA_CAMELLIA128_SHA256 - ECDH_RSA_CAMELLIA256_SHA384 - RSA_CAMELLIA128_GCM_SHA256 - RSA_CAMELLIA256_GCM_SHA384 - DHE_RSA_CAMELLIA128_GCM_SHA256 - DHE_RSA_CAMELLIA256_GCM_SHA384 - DH_RSA_CAMELLIA128_GCM_SHA256 - DH_RSA_CAMELLIA256_GCM_SHA384 - DHE_DSS_CAMELLIA128_GCM_SHA256 - DHE_DSS_CAMELLIA256_GCM_SHA384 - DH_DSS_CAMELLIA128_GCM_SHA256 - DH_DSS_CAMELLIA256_GCM_SHA384 - DH_anon_CAMELLIA128_GCM_SHA256 - DH_anon_CAMELLIA256_GCM_SHA384 - ECDHE_ECDSA_CAMELLIA128_GCM_SHA256 - ECDHE_ECDSA_CAMELLIA256_GCM_SHA384 - ECDH_ECDSA_CAMELLIA128_GCM_SHA256 - ECDH_ECDSA_CAMELLIA256_GCM_SHA384 - ECDHE_RSA_CAMELLIA128_GCM_SHA256 - ECDHE_RSA_CAMELLIA256_GCM_SHA384 - ECDH_RSA_CAMELLIA128_GCM_SHA256 - ECDH_RSA_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_GCM_SHA256 - PSK_CAMELLIA256_GCM_SHA384 - DHE_PSK_CAMELLIA128_GCM_SHA256 - DHE_PSK_CAMELLIA256_GCM_SHA384 - RSA_PSK_CAMELLIA128_GCM_SHA256 - RSA_PSK_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_SHA256 - PSK_CAMELLIA256_SHA384 - DHE_PSK_CAMELLIA128_SHA256 - DHE_PSK_CAMELLIA256_SHA384 - RSA_PSK_CAMELLIA128_SHA256 - RSA_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_CAMELLIA128_SHA256 - ECDHE_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_RC4_SHA - ECDHE_PSK_3DES_SHA - ECDHE_PSK_AES128_SHA - ECDHE_PSK_AES256_SHA - ECDHE_PSK_AES128_SHA256 - ECDHE_PSK_AES256_SHA384 - ECDHE_PSK_NULL_SHA - ECDHE_PSK_NULL_SHA256 - ECDHE_PSK_NULL_SHA384 - ECDHE_RSA_CHACHA20_POLY1305_SHA256 - ECDHE_ECDSA_CHACHA20_POLY1305_SHA256 - DHE_RSA_CHACHA20_POLY1305_SHA256 - PSK_CHACHA20_POLY1305_SHA256 - ECDHE_PSK_CHACHA20_POLY1305_SHA256 - DHE_PSK_CHACHA20_POLY1305_SHA256 - RSA_PSK_CHACHA20_POLY1305_SHA256 - AES128_GCM_SHA256 - AES256_GCM_SHA384 - CHACHA20_POLY1305_SHA256 - AES128_CCM_SHA256 - AES128_CCM8_SHA256 # tls_client_auth property Enables or disables certificate-based client authentication. ## Syntax ```text def get_tls_client_auth() -> int: ... def set_tls_client_auth(value: int) -> None: ... tls_client_auth = property(get_tls_client_auth, set_tls_client_auth) ``` ## Possible Values ```text 0 # NoAuth1 # RequestCert2 # RequireCert ``` ## Default Value 0 ## Remarks Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | # tls_extensions property Provides access to TLS extensions. ## Syntax ```text 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 ```text 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_groups property Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax ```text def get_tls_groups() -> str: ... def set_tls_groups(value: str) -> None: ... tls_groups = property(get_tls_groups, set_tls_groups) ``` ## Default Value "" ## Remarks Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. # tls_pre_shared_identity property Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax ```text 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 ```text 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 ```text 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 ```text 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) ``` ## Possible Values ```text 0 # Compatible1 # Strict2 # Auto ``` ## Default Value 2 ## Remarks Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | # tls_revocation_check property Specifies the kind(s) of revocation check to perform. ## Syntax ```text 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) ``` ## Possible Values ```text 0 # None1 # Auto2 # AllCRL3 # AllOCSP4 # AllCRLAndOCSP5 # AnyCRL6 # AnyOCSP7 # AnyCRLOrOCSP8 # AnyOCSPOrCRL ``` ## 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 ```text 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_mode property Specifies the TLS mode to use. ## Syntax ```text def get_tls_mode() -> int: ... def set_tls_mode(value: int) -> None: ... tls_mode = property(get_tls_mode, set_tls_mode) ``` ## Possible Values ```text 0 # Default1 # NoTLS2 # ExplicitTLS3 # ImplicitTLS4 # MixedTLS ``` ## 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 ```text 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 TRUE ## 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 ```text 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 ```text def get_tls_versions() -> int: ... def set_tls_versions(value: int) -> None: ... tls_versions = property(get_tls_versions, set_tls_versions) ``` ## Default Value 48 ## 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 ```text def get_trusted_cert_count() -> int: ... def set_trusted_cert_count(value: int) -> None: ... trusted_cert_count = property(get_trusted_cert_count, set_trusted_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [trusted_cert_bytes](#trusted_cert_bytes-property) - [trusted_cert_handle](#trusted_cert_handle-property) 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 ```text 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](#trusted_cert_count-property) 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 ```text 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. ```text 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](#trusted_cert_count-property) property. # used_cert_count property The number of records in the UsedCert arrays. ## Syntax ```text def get_used_cert_count() -> int: ... used_cert_count = property(get_used_cert_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [used_cert_bytes](#used_cert_bytes-property) - [used_cert_ca](#used_cert_ca-property) - [used_cert_ca_key_id](#used_cert_ca_key_id-property) - [used_cert_cert_type](#used_cert_cert_type-property) - [used_cert_crl_distribution_points](#used_cert_crl_distribution_points-property) - [used_cert_curve](#used_cert_curve-property) - [used_cert_fingerprint](#used_cert_fingerprint-property) - [used_cert_friendly_name](#used_cert_friendly_name-property) - [used_cert_handle](#used_cert_handle-property) - [used_cert_hash_algorithm](#used_cert_hash_algorithm-property) - [used_cert_issuer](#used_cert_issuer-property) - [used_cert_issuer_rdn](#used_cert_issuer_rdn-property) - [used_cert_key_algorithm](#used_cert_key_algorithm-property) - [used_cert_key_bits](#used_cert_key_bits-property) - [used_cert_key_fingerprint](#used_cert_key_fingerprint-property) - [used_cert_key_usage](#used_cert_key_usage-property) - [used_cert_key_valid](#used_cert_key_valid-property) - [used_cert_ocsp_locations](#used_cert_ocsp_locations-property) - [used_cert_ocsp_no_check](#used_cert_ocsp_no_check-property) - [used_cert_origin](#used_cert_origin-property) - [used_cert_policy_i_ds](#used_cert_policy_i_ds-property) - [used_cert_private_key_bytes](#used_cert_private_key_bytes-property) - [used_cert_private_key_exists](#used_cert_private_key_exists-property) - [used_cert_private_key_extractable](#used_cert_private_key_extractable-property) - [used_cert_public_key_bytes](#used_cert_public_key_bytes-property) - [used_cert_qualified](#used_cert_qualified-property) - [used_cert_qualified_statements](#used_cert_qualified_statements-property) - [used_cert_qualifiers](#used_cert_qualifiers-property) - [used_cert_self_signed](#used_cert_self_signed-property) - [used_cert_serial_number](#used_cert_serial_number-property) - [used_cert_sig_algorithm](#used_cert_sig_algorithm-property) - [used_cert_source](#used_cert_source-property) - [used_cert_subject](#used_cert_subject-property) - [used_cert_subject_alternative_name](#used_cert_subject_alternative_name-property) - [used_cert_subject_key_id](#used_cert_subject_key_id-property) - [used_cert_subject_rdn](#used_cert_subject_rdn-property) - [used_cert_valid](#used_cert_valid-property) - [used_cert_valid_from](#used_cert_valid_from-property) - [used_cert_valid_to](#used_cert_valid_to-property) The array indices start at *0* and end at *used_cert_count - 1*. This property is read-only. # used_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_used_cert_bytes(used_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_ca property Indicates whether the certificate has a CA capability. ## Syntax ```text def get_used_cert_ca(used_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled. Set this property when generating a new certificate to have its Basic Constraints extension generated automatically. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_ca_key_id property A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax ```text def get_used_cert_ca_key_id(used_cert_index: int) -> bytes: ... ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [used_cert_subject_key_id](#used_cert_subject_key_id-property) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_cert_type property Returns the type of the entity contained in the Certificate object. ## Syntax ```text def get_used_cert_cert_type(used_cert_index: int) -> int: ... ``` ## Possible Values ```text 0 # Unknown1 # X509Certificate2 # X509CertificateRequest ``` ## Default Value 0 ## Remarks Returns the type of the entity contained in the [Certificate](#Type_Certificate) object. A [Certificate](#Type_Certificate) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](#CertificateManager) class to load or create new certificate and certificate requests objects. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_crl_distribution_points property Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Syntax ```text def get_used_cert_crl_distribution_points(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension. Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate. The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_curve property Specifies the elliptic curve associated with the certificate's public key. ## Syntax ```text def get_used_cert_curve(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_fingerprint property Contains the fingerprint (a hash imprint) of this certificate. ## Syntax ```text def get_used_cert_fingerprint(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_friendly_name property Contains an associated alias (friendly name) of the certificate. ## Syntax ```text def get_used_cert_friendly_name(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_used_cert_handle(used_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_hash_algorithm property Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Syntax ```text def get_used_cert_hash_algorithm(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [used_cert_sig_algorithm](#used_cert_sig_algorithm-property) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_issuer property The common name of the certificate issuer (CA), typically a company name. ## Syntax ```text def get_used_cert_issuer(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [used_cert_issuer_rdn](#used_cert_issuer_rdn-property). The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_issuer_rdn property A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax ```text def get_used_cert_issuer_rdn(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_key_algorithm property Specifies the public key algorithm of this certificate. ## Syntax ```text def get_used_cert_key_algorithm(used_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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [used_cert_key_bits](#used_cert_key_bits-property), [used_cert_curve](#used_cert_curve-property), and [used_cert_public_key_bytes](#used_cert_public_key_bytes-property) properties to get more details about the key the certificate contains. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_key_bits property Returns the length of the public key in bits. ## Syntax ```text def get_used_cert_key_bits(used_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [used_cert_public_key_bytes](#used_cert_public_key_bytes-property) or [used_cert_private_key_bytes](#used_cert_private_key_bytes-property) property would typically contain auxiliary values, and therefore be longer. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_key_fingerprint property Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax ```text def get_used_cert_key_fingerprint(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the [used_cert_fingerprint](#used_cert_fingerprint-property) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_key_usage property Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax ```text def get_used_cert_key_usage(used_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_key_valid property Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Syntax ```text def get_used_cert_key_valid(used_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_ocsp_locations property Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Syntax ```text def get_used_cert_ocsp_locations(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this property before calling the certificate manager's [generate](#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_ocsp_no_check property Accessor to the value of the certificate's ocsp-no-check extension. ## Syntax ```text def get_used_cert_ocsp_no_check(used_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Accessor to the value of the certificate's ocsp-no-check extension. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_origin property Returns the location that the certificate was taken or loaded from. ## Syntax ```text def get_used_cert_origin(used_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Returns the location that the certificate was taken or loaded from. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_policy_i_ds property Contains identifiers (OIDs) of the applicable certificate policies. ## Syntax ```text def get_used_cert_policy_i_ds(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. Set this property when generating a certificate to propagate the policies information to the new certificate. The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_private_key_bytes property Returns the certificate's private key in DER-encoded format. ## Syntax ```text def get_used_cert_private_key_bytes(used_cert_index: int) -> bytes: ... ``` ## Remarks Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_private_key_exists property Indicates whether the certificate has a usable private key associated with it. ## Syntax ```text def get_used_cert_private_key_exists(used_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption. This property is independent from [used_cert_private_key_bytes](#used_cert_private_key_bytes-property), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_private_key_extractable property Indicates whether the private key is extractable (exportable). ## Syntax ```text def get_used_cert_private_key_extractable(used_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the private key is extractable (exportable). The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_public_key_bytes property Contains the certificate's public key in DER format. ## Syntax ```text def get_used_cert_public_key_bytes(used_cert_index: int) -> bytes: ... ``` ## Remarks Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_qualified property Indicates whether the certificate is qualified. ## Syntax ```text def get_used_cert_qualified(used_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_qualified_statements property Returns a simplified qualified status of the certificate. ## Syntax ```text def get_used_cert_qualified_statements(used_cert_index: int) -> int: ... ``` ## Possible Values ```text 0 # NonQualified1 # QualifiedHardware2 # QualifiedSoftware ``` ## Default Value 0 ## Remarks Returns a simplified qualified status of the certificate. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_qualifiers property A list of qualifiers. ## Syntax ```text def get_used_cert_qualifiers(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_self_signed property Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax ```text def get_used_cert_self_signed(used_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_serial_number property Returns the certificate's serial number. ## Syntax ```text def get_used_cert_serial_number(used_cert_index: int) -> bytes: ... ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_sig_algorithm property Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax ```text def get_used_cert_sig_algorithm(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_source property Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax ```text def get_used_cert_source(used_cert_index: int) -> int: ... ``` ## Possible Values ```text 0 # Unknown1 # Signature2 # Document3 # User4 # Local5 # Online ``` ## Default Value 0 ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_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 ```text def get_used_cert_subject(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [used_cert_subject_rdn](#used_cert_subject_rdn-property). The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_subject_alternative_name property Returns or sets the value of the Subject Alternative Name extension of the certificate. ## Syntax ```text def get_used_cert_subject_alternative_name(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Returns or sets the value of the Subject Alternative Name extension of the certificate. Subject alternative names are used to provide additional names that are impractical to store in the main [used_cert_subject_rdn](#used_cert_subject_rdn-property) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_subject_key_id property Contains a unique identifier of the certificate's cryptographic key. ## Syntax ```text def get_used_cert_subject_key_id(used_cert_index: int) -> bytes: ... ``` ## Remarks Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [used_cert_subject_key_id](#used_cert_subject_key_id-property) and [used_cert_ca_key_id](#used_cert_ca_key_id-property) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_subject_rdn property A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax ```text def get_used_cert_subject_rdn(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_valid property Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. ## Syntax ```text def get_used_cert_valid(used_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_valid_from property The time point at which the certificate becomes valid, in UTC. ## Syntax ```text def get_used_cert_valid_from(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # used_cert_valid_to property The time point at which the certificate expires, in UTC. ## Syntax ```text def get_used_cert_valid_to(used_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. The *used_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [used_cert_count](#used_cert_count-property) property. This property is read-only. # validation_moment property The time point at which signature validity is to be established. ## Syntax ```text 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. # config method Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#mailreader-config-settings) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#mailreader-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method Performs an additional action. ## Syntax ```text def do_action(action_id: str, action_params: str) -> str: ... ``` ## Remarks do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # find_attachment method Looks up a Message's attachment by its ID. ## Syntax ```text def find_attachment(id: str) -> int: ... ``` ## Remarks Use this method to find the attachment by its *ID*. # load_from_bytes method Loads an e-mail message from a byte array. ## Syntax ```text def load_from_bytes(message_bytes: bytes) -> None: ... ``` ## Remarks Use this method to load a message from a byte array and process it. Once the message has been loaded, use message to access its properties. # load_from_file method Loads an e-mail message from a file. ## Syntax ```text def load_from_file(file_name: str) -> None: ... ``` ## Remarks Use this method to load a message from a file and process it. Once the message has been loaded, use message to access its properties. # reset method Resets the class settings. ## Syntax ```text def reset() -> None: ... ``` ## Remarks reset is a generic method available in every class. # on_chain_validated event Reports the completion of a certificate chain validation. ## Syntax ```text class MailReaderChainValidatedEventParams(object): @property def subject_rdn() -> str: ... @property def validation_result() -> int: ... @property def validation_details() -> int: ... # In class MailReader: @property def on_chain_validated() -> Callable[[MailReaderChainValidatedEventParams], None]: ... @on_chain_validated.setter def on_chain_validated(event_hook: Callable[[MailReaderChainValidatedEventParams], 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) | Any other value reports a failure, and *ValidationDetails* provides more details on its reasons. | | | | | --- | --- | --- | | 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_decryption_info_needed event Asks the application to provide a decryption certificate. ## Syntax ```text class MailReaderDecryptionInfoNeededEventParams(object): @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... # In class MailReader: @property def on_decryption_info_needed() -> Callable[[MailReaderDecryptionInfoNeededEventParams], None]: ... @on_decryption_info_needed.setter def on_decryption_info_needed(event_hook: Callable[[MailReaderDecryptionInfoNeededEventParams], None]) -> None: ... ``` ## Remarks This event is fired when the component needs a decryption certificate. Use the provided values to look up the certificate, and assign it to decryption_certificate property. Note that the decryption certificate must have an associated private key. # on_error event Reports information about errors during e-mail message loading, parsing or saving. ## Syntax ```text class MailReaderErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class MailReader: @property def on_error() -> Callable[[MailReaderErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[MailReaderErrorEventParams], None]) -> None: ... ``` ## Remarks The event is fired in case of exceptional conditions during message processing. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # on_external_decrypt event Handles remote or external decryption. ## Syntax ```text class MailReaderExternalDecryptEventParams(object): @property def operation_id() -> str: ... @property def algorithm() -> str: ... @property def pars() -> str: ... @property def encrypted_data() -> str: ... @property def data() -> str: ... @data.setter def data(value) -> None: ... # In class MailReader: @property def on_external_decrypt() -> Callable[[MailReaderExternalDecryptEventParams], None]: ... @on_external_decrypt.setter def on_external_decrypt(event_hook: Callable[[MailReaderExternalDecryptEventParams], None]) -> None: ... ``` ## Remarks Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the *EncryptedData* parameter, and is expected to decrypt it and place the decrypted value into the *Data* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *Algorithm* specifies the encryption algorithm being used, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *EncryptedData*, *Data*, and *Pars* parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption. Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 # on_notification event This event notifies the application about an underlying control flow event. ## Syntax ```text class MailReaderNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class MailReader: @property def on_notification() -> Callable[[MailReaderNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[MailReaderNotificationEventParams], 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 ```text class MailReaderSignatureFoundEventParams(object): @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 MailReader: @property def on_signature_found() -> Callable[[MailReaderSignatureFoundEventParams], None]: ... @on_signature_found.setter def on_signature_found(event_hook: Callable[[MailReaderSignatureFoundEventParams], 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 ```text class MailReaderSignatureValidatedEventParams(object): @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def validation_result() -> int: ... # In class MailReader: @property def on_signature_validated() -> Callable[[MailReaderSignatureValidatedEventParams], None]: ... @on_signature_validated.setter def on_signature_validated(event_hook: Callable[[MailReaderSignatureValidatedEventParams], None]) -> None: ... ``` ## Remarks This event is fired upon the completion of the signature validation routine, and reports the respective validation result. Use the *IssuerRDN*, *SerialNumber*, and/or *SubjectKeyID* parameters to identify the signing certificate. *ValidationResult* is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure. | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | # MailReader Config Settings The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [config](#config-method) method. ### MailReader Config Settings **ChainCurrentCACert**: Returns the current CA certificate.This property returns the CA certificate that is used on the current step. **ChainCurrentCert**: Returns the certificate that is currently being validated.Use this property to obtain the body of the certificate that is currently being validated. **ChainCurrentCRL**: Returns the current CRL.Returns the CRL object that is currently being processed. **ChainCurrentCRLSize**: Returns the size of the current CRL.This property returns the size of the CRL object that is currently being processed. **ChainCurrentOCSP**: Returns the current OCSP response.Returns the OCSP object that is currently being processed. **ChainCurrentOCSPSigner**: Returns the signer of the current OCSP object.Returns the signer/CA that has issued the OCSP response that is currently being processed. **ChainInterimDetails**: Returns the current interim validation details.This property returns the interim chain validation details. **ChainInterimResult**: Returns the current interim validation result.Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes. **CheckValidityPeriodForTrusted**: Whether to check validity period for trusted certificates.Whether to check validity period for trusted certificates. **DislikeOpenEndedOCSPs**: Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the class is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022). **EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is disabled by default, because enabling it may prevent the AdES components from collecting full revocation information required for long-term validation (LTV) signatures. **EvaluateSystemTrustForSelfSignedCertificates**: Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) for self-signed certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default. **EvaluateSystemTrustForSSL**: Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) specifically for SSL/TLS certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default. **ForceCompleteChainValidation**: Whether to check the CA certificates when the signing certificate is invalid.Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid. **ForceCompleteChainValidationForTrusted**: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments. **GracePeriod**: Specifies a grace period to apply during revocation information checks.Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated. **HeaderCharset**: Charset of the header. If not empty, the one specified in the message header will be ignored. **IgnoreChainLoops**: Whether chain loops should be ignored.Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves. **IgnoreOCSPNoCheckExtension**: Whether the OCSP NoCheck extension should be ignored.Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues. **IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store. If [IgnoreSystemTrust](#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. **ImplicitlyTrustSelfSignedCertificates**: Whether to trust self-signed certificates. Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows emulating the verifying environment without actually changing its security settings. **MaxHeaderSize**: Specifies the maximum mail message header size in bytes.Use this property to adjust the maximum size of a mail message header. If no header end (CRLFCRLF) found, the header is considered blank. Default size is 32768 (i.e. 32KB). **PromoteLongOCSPResponses**: Whether long OCSP responses are requested. Set this property to True to force the class to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. **TextCharset**: Charset of text parts, if any. If not empty, the one specified in the message text parts will be ignored. **TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are: - 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 **UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages. **UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. **UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. **UseValidationCache**: Enables or disable the use of the product-wide certificate chain validation cache.Use this property to enable or disable the use of the global chain validation cache. If enabled, the class will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the class, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. 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 | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. 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 | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. 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. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | 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) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # MailReader Errors ### MailReader Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 22020097 | Failed to assemble the mail message ([SB_ERROR_MAIL_ASSEMBLY_FAILED](constants.md#const_SBERRORMAILASSEMBLYFAILED)) | | 22020098 | Failed to assemble the mail message ([SB_ERROR_MAIL_PARSING_FAILED](constants.md#const_SBERRORMAILPARSINGFAILED)) | | 22020099 | No decryption certificate found ([SB_ERROR_MAIL_NO_DECRYPTION_CERTIFICATE](constants.md#const_SBERRORMAILNODECRYPTIONCERTIFICATE)) |