CertificateValidator Class

Properties Methods Events Config Settings Errors

The CertificateValidator class provides fine-grained validation of X.509 certificates.

Syntax

class secureblackbox.CertificateValidator

Remarks

This is a powerful and configurable class which can be used to validate all kinds of certificates and their chains.

The purpose of CertificateValidator is to validate certificate chains according to the X.509 specification. It supports a variety of technologies, including CRL and OCSP services, and can provide a comprehensive output on the certificate cryptographic validity, chain integrity, and trust levels. CertificateValidator is used internally in many other SecureBlackbox components, such as PDFSigner, HTTPClient, and OfficeVerifier.

To validate a certificate, please tune up the component as following:

Assign the certificate to be validated to the certificate property.
Set revocation_check in accordance with your revocation check preferences.
Enable use_system_certificates property to trust certificates that are trusted by the operating system. Copy any certificates that are not available in the standard system locations to known_certificates and trusted_certificates collections (see Note 1 below).
Optionally, adjust tls_settings and socket_settings.
Adjust validation_moment if you would like to check the certificate validity at a different moment in time. Leave it unchanged to validate the certificate at the current time moment.
Call validate or validate_for_ssl method to initiate chain validation.

Depending on the complexity of the chain and the configuration of the component, the validation routine may take certain amount of time. The validator reports chain validation progress using a selection of events, such as on_before_certificate_processing, on_after_certificate_processing, and on_crl_downloaded events. It may also ask you for missing objects using on_crl_needed or on_ca_certificate_needed events. In each such event handler you can access the currently validated certificate via the current_certificate property, and the interim validity figures via the interim_validation_result and interim_validation_details property.

The return of the validate (or similar) method indicates the completion of the validation procedure. The outcome of the chain validation is represented with the two parameters:

chain_validation_result reports the general validation outcome: valid, valid-but-untrusted, invalid, and unknown. As a rule, only the valid result can be taken as a good reason to consider the chain valid.
chain_validation_details provides insights into the factors that caused the validation to fail.

Apart from these two parameters, you can check the low-level validation details by consulting the validation_log property. The validation log is often a great source for tracking and reacting to various validation issues.

Note 1: On Windows, CertificateValidator can use CA and ROOT system stores to look for any missing CA certificates and trust anchors. No similar functionality is currently available for other platforms, so in most cases you must provide your own list of trusted and CA certificates via trusted_certificates and known_certificates collections to have your chains validate fully in Linux and macOS projects.

Note 2: The offline_mode property is a handy way to check the completeness of your revocation/validation information. When the offline mode is on, CertificateValidator won't go online for any missing certificates, CRLs, and OCSP responses. Paired with a switched-off use_system_certificates property, it allows to make sure that any content provided via known_certificates, known_crls, and known_ocsps represents the complete set of validation information required to validate the chain.

Property List

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


blocked_cert_count	The number of records in the BlockedCert arrays.
blocked_cert_bytes	Returns the raw certificate data in DER format.
blocked_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
cache_validation_results	Enables or disables validation result caching.
cert_bytes	Returns the raw certificate data in DER format.
cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
chain_validation_details	The details of a certificate chain validation outcome.
chain_validation_result	The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
check_trusted_lists	Specifies whether the class should attempt to validate chain trust via a known Trusted List.
current_ca_cert_bytes	Returns the raw certificate data in DER format.
current_ca_cert_ca	Indicates whether the certificate has a CA capability.
current_ca_cert_ca_key_id	A unique identifier (fingerprint) of the CA certificate's cryptographic key.
current_ca_cert_cert_type	Returns the type of the entity contained in the Certificate object.
current_ca_cert_crl_distribution_points	Contains a list of locations of CRL distribution points used to check this certificate's validity.
current_ca_cert_curve	Specifies the elliptic curve associated with the certificate's public key.
current_ca_cert_fingerprint	Contains the fingerprint (a hash imprint) of this certificate.
current_ca_cert_friendly_name	Contains an associated alias (friendly name) of the certificate.
current_ca_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
current_ca_cert_hash_algorithm	Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
current_ca_cert_issuer	The common name of the certificate issuer (CA), typically a company name.
current_ca_cert_issuer_rdn	A list of Property=Value pairs that uniquely identify the certificate issuer.
current_ca_cert_key_algorithm	Specifies the public key algorithm of this certificate.
current_ca_cert_key_bits	Returns the length of the public key in bits.
current_ca_cert_key_fingerprint	Returns a SHA1 fingerprint of the public key contained in the certificate.
current_ca_cert_key_usage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
current_ca_cert_key_valid	Returns True if the certificate's key is cryptographically valid, and False otherwise.
current_ca_cert_ocsp_locations	Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
current_ca_cert_ocsp_no_check	Accessor to the value of the certificate's ocsp-no-check extension.
current_ca_cert_origin	Returns the location that the certificate was taken or loaded from.
current_ca_cert_policy_i_ds	Contains identifiers (OIDs) of the applicable certificate policies.
current_ca_cert_private_key_bytes	Returns the certificate's private key in DER-encoded format.
current_ca_cert_private_key_exists	Indicates whether the certificate has a usable private key associated with it.
current_ca_cert_private_key_extractable	Indicates whether the private key is extractable (exportable).
current_ca_cert_public_key_bytes	Contains the certificate's public key in DER format.
current_ca_cert_qualified	Indicates whether the certificate is qualified.
current_ca_cert_qualified_statements	Returns a simplified qualified status of the certificate.
current_ca_cert_qualifiers	A list of qualifiers.
current_ca_cert_self_signed	Indicates whether the certificate is self-signed (root) or signed by an external CA.
current_ca_cert_serial_number	Returns the certificate's serial number.
current_ca_cert_sig_algorithm	Indicates the algorithm that was used by the CA to sign this certificate.
current_ca_cert_source	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
current_ca_cert_subject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
current_ca_cert_subject_alternative_name	Returns or sets the value of the Subject Alternative Name extension of the certificate.
current_ca_cert_subject_key_id	Contains a unique identifier of the certificate's cryptographic key.
current_ca_cert_subject_rdn	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
current_ca_cert_valid	Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
current_ca_cert_valid_from	The time point at which the certificate becomes valid, in UTC.
current_ca_cert_valid_to	The time point at which the certificate expires, in UTC.
current_cert_bytes	Returns the raw certificate data in DER format.
current_cert_ca	Indicates whether the certificate has a CA capability.
current_cert_ca_key_id	A unique identifier (fingerprint) of the CA certificate's cryptographic key.
current_cert_cert_type	Returns the type of the entity contained in the Certificate object.
current_cert_crl_distribution_points	Contains a list of locations of CRL distribution points used to check this certificate's validity.
current_cert_curve	Specifies the elliptic curve associated with the certificate's public key.
current_cert_fingerprint	Contains the fingerprint (a hash imprint) of this certificate.
current_cert_friendly_name	Contains an associated alias (friendly name) of the certificate.
current_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
current_cert_hash_algorithm	Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
current_cert_issuer	The common name of the certificate issuer (CA), typically a company name.
current_cert_issuer_rdn	A list of Property=Value pairs that uniquely identify the certificate issuer.
current_cert_key_algorithm	Specifies the public key algorithm of this certificate.
current_cert_key_bits	Returns the length of the public key in bits.
current_cert_key_fingerprint	Returns a SHA1 fingerprint of the public key contained in the certificate.
current_cert_key_usage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
current_cert_key_valid	Returns True if the certificate's key is cryptographically valid, and False otherwise.
current_cert_ocsp_locations	Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
current_cert_ocsp_no_check	Accessor to the value of the certificate's ocsp-no-check extension.
current_cert_origin	Returns the location that the certificate was taken or loaded from.
current_cert_policy_i_ds	Contains identifiers (OIDs) of the applicable certificate policies.
current_cert_private_key_bytes	Returns the certificate's private key in DER-encoded format.
current_cert_private_key_exists	Indicates whether the certificate has a usable private key associated with it.
current_cert_private_key_extractable	Indicates whether the private key is extractable (exportable).
current_cert_public_key_bytes	Contains the certificate's public key in DER format.
current_cert_qualified	Indicates whether the certificate is qualified.
current_cert_qualified_statements	Returns a simplified qualified status of the certificate.
current_cert_qualifiers	A list of qualifiers.
current_cert_self_signed	Indicates whether the certificate is self-signed (root) or signed by an external CA.
current_cert_serial_number	Returns the certificate's serial number.
current_cert_sig_algorithm	Indicates the algorithm that was used by the CA to sign this certificate.
current_cert_source	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
current_cert_subject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
current_cert_subject_alternative_name	Returns or sets the value of the Subject Alternative Name extension of the certificate.
current_cert_subject_key_id	Contains a unique identifier of the certificate's cryptographic key.
current_cert_subject_rdn	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
current_cert_valid	Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
current_cert_valid_from	The time point at which the certificate becomes valid, in UTC.
current_cert_valid_to	The time point at which the certificate expires, in UTC.
fips_mode	Reserved.
grace_period	Specifies a grace period to apply during certificate validation.
interim_validation_details	Contains the validation details of the moment.
interim_validation_result	Contains the validation status of the moment.
known_cert_count	The number of records in the KnownCert arrays.
known_cert_bytes	Returns the raw certificate data in DER format.
known_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
known_crl_count	The number of records in the KnownCRL arrays.
known_crl_bytes	Returns the raw CRL data in DER format.
known_crl_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
known_ocsp_count	The number of records in the KnownOCSP arrays.
known_ocsp_bytes	A buffer containing the raw OCSP response data.
known_ocsp_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
max_validation_time	Specifies the maximum time the validation process may take.
offline_mode	Switches the class to offline mode.
proxy_address	The IP address of the proxy server.
proxy_authentication	The authentication type used by the proxy server.
proxy_password	The password to authenticate to the proxy server.
proxy_port	The port on the proxy server to connect to.
proxy_proxy_type	The type of the proxy server.
proxy_request_headers	Contains HTTP request headers for WebTunnel and HTTP proxy.
proxy_response_body	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_response_headers	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_use_ipv6	Specifies whether IPv6 should be used when connecting through the proxy.
proxy_username	Specifies the username credential for proxy authentication.
qualified_info_address	Contains the address of the TSL provider.
qualified_info_custom_trusted_lists	The list of custom TrustedLists to use.
qualified_info_download_log	Contains the TLS download log.
qualified_info_information_uri	Contains the URI of the provider information.
qualified_info_languages	The preferred language(s) for TSL data.
qualified_info_next_update	Returns the next update date and time of the TSL.
qualified_info_provider	Contains the name of the TSL provider.
qualified_info_qualified	Indicates whether the certificate is qualified.
qualified_info_qualifiers	A list of qualifiers.
qualified_info_service_name	Contains the name of the TSL service.
qualified_info_service_type_id	Contains the TSL service type identifier.
qualified_info_source	The source of qualified information.
qualified_info_status	Indicates a qualified electronic signature.
qualified_info_trade_name	Contains the trade name of the TSL provider.
qualified_info_trusted	Indicates whether the certificate is trusted.
qualified_info_use_default_trusted_lists	Use this setting to enable or disable the use of the default TrustedLists.
qualified_info_validation_log	Contains the TLS validation log.
qualified_info_xml	Contains the XML of the TSL.
revocation_check	Specifies the kind(s) of revocation check to perform for all chain certificates.
socket_dns_mode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
socket_dns_port	Specifies the port number to be used for sending queries to the DNS server.
socket_dns_query_timeout	The timeout (in milliseconds) for each DNS query.
socket_dns_servers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
socket_dns_total_timeout	The timeout (in milliseconds) for the whole resolution process.
socket_incoming_speed_limit	The maximum number of bytes to read from the socket, per second.
socket_local_address	The local network interface to bind the socket to.
socket_local_port	The local port number to bind the socket to.
socket_outgoing_speed_limit	The maximum number of bytes to write to the socket, per second.
socket_timeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
socket_use_ipv6	Enables or disables IP protocol version 6.
tls_client_cert_count	The number of records in the TLSClientCert arrays.
tls_client_cert_bytes	Returns the raw certificate data in DER format.
tls_client_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
tls_server_cert_count	The number of records in the TLSServerCert arrays.
tls_server_cert_bytes	Returns the raw certificate data in DER format.
tls_server_cert_fingerprint	Contains the fingerprint (a hash imprint) of this certificate.
tls_server_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
tls_server_cert_issuer	The common name of the certificate issuer (CA), typically a company name.
tls_server_cert_issuer_rdn	A list of Property=Value pairs that uniquely identify the certificate issuer.
tls_server_cert_key_algorithm	Specifies the public key algorithm of this certificate.
tls_server_cert_key_bits	Returns the length of the public key in bits.
tls_server_cert_key_usage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
tls_server_cert_self_signed	Indicates whether the certificate is self-signed (root) or signed by an external CA.
tls_server_cert_serial_number	Returns the certificate's serial number.
tls_server_cert_sig_algorithm	Indicates the algorithm that was used by the CA to sign this certificate.
tls_server_cert_subject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
tls_server_cert_subject_rdn	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
tls_server_cert_valid_from	The time point at which the certificate becomes valid, in UTC.
tls_server_cert_valid_to	The time point at which the certificate expires, in UTC.
tls_auto_validate_certificates	Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
tls_base_configuration	Selects the base configuration for the TLS settings.
tls_ciphersuites	A list of ciphersuites separated with commas or semicolons.
tls_client_auth	Enables or disables certificate-based client authentication.
tls_ec_curves	Defines the elliptic curves to enable.
tls_extensions	Provides access to TLS extensions.
tls_force_resume_if_destination_changes	Whether to force TLS session resumption when the destination address changes.
tls_pre_shared_identity	Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
tls_pre_shared_key	Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
tls_pre_shared_key_ciphersuite	Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
tls_renegotiation_attack_prevention_mode	Selects the renegotiation attack prevention mechanism.
tls_revocation_check	Specifies the kind(s) of revocation check to perform.
tls_ssl_options	Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
tls_tls_mode	Specifies the TLS mode to use.
tls_use_extended_master_secret	Enables the Extended Master Secret Extension, as defined in RFC 7627.
tls_use_session_resumption	Enables or disables the TLS session resumption capability.
tls_versions	The SSL/TLS versions to enable by default.
trusted_cert_count	The number of records in the TrustedCert arrays.
trusted_cert_bytes	Returns the raw certificate data in DER format.
trusted_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
used_cert_count	The number of records in the UsedCert arrays.
used_cert_bytes	Returns the raw certificate data in DER format.
used_cert_ca	Indicates whether the certificate has a CA capability.
used_cert_ca_key_id	A unique identifier (fingerprint) of the CA certificate's cryptographic key.
used_cert_cert_type	Returns the type of the entity contained in the Certificate object.
used_cert_crl_distribution_points	Contains a list of locations of CRL distribution points used to check this certificate's validity.
used_cert_curve	Specifies the elliptic curve associated with the certificate's public key.
used_cert_fingerprint	Contains the fingerprint (a hash imprint) of this certificate.
used_cert_friendly_name	Contains an associated alias (friendly name) of the certificate.
used_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
used_cert_hash_algorithm	Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
used_cert_issuer	The common name of the certificate issuer (CA), typically a company name.
used_cert_issuer_rdn	A list of Property=Value pairs that uniquely identify the certificate issuer.
used_cert_key_algorithm	Specifies the public key algorithm of this certificate.
used_cert_key_bits	Returns the length of the public key in bits.
used_cert_key_fingerprint	Returns a SHA1 fingerprint of the public key contained in the certificate.
used_cert_key_usage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
used_cert_key_valid	Returns True if the certificate's key is cryptographically valid, and False otherwise.
used_cert_ocsp_locations	Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
used_cert_ocsp_no_check	Accessor to the value of the certificate's ocsp-no-check extension.
used_cert_origin	Returns the location that the certificate was taken or loaded from.
used_cert_policy_i_ds	Contains identifiers (OIDs) of the applicable certificate policies.
used_cert_private_key_bytes	Returns the certificate's private key in DER-encoded format.
used_cert_private_key_exists	Indicates whether the certificate has a usable private key associated with it.
used_cert_private_key_extractable	Indicates whether the private key is extractable (exportable).
used_cert_public_key_bytes	Contains the certificate's public key in DER format.
used_cert_qualified	Indicates whether the certificate is qualified.
used_cert_qualified_statements	Returns a simplified qualified status of the certificate.
used_cert_qualifiers	A list of qualifiers.
used_cert_self_signed	Indicates whether the certificate is self-signed (root) or signed by an external CA.
used_cert_serial_number	Returns the certificate's serial number.
used_cert_sig_algorithm	Indicates the algorithm that was used by the CA to sign this certificate.
used_cert_source	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
used_cert_subject	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	Returns or sets the value of the Subject Alternative Name extension of the certificate.
used_cert_subject_key_id	Contains a unique identifier of the certificate's cryptographic key.
used_cert_subject_rdn	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
used_cert_valid	Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
used_cert_valid_from	The time point at which the certificate becomes valid, in UTC.
used_cert_valid_to	The time point at which the certificate expires, in UTC.
used_crl_count	The number of records in the UsedCRL arrays.
used_crl_bytes	Returns the raw CRL data in DER format.
used_crl_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
used_crl_issuer	The common name of the CRL issuer (CA), typically a company name.
used_crl_issuer_rdn	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
used_crl_location	The URL that the CRL was downloaded from.
used_crl_next_update	The planned time and date of the next version of this CRL to be published.
used_crl_source	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
used_crl_this_update	The date and time at which this version of the CRL was published.
used_ocsp_count	The number of records in the UsedOCSP arrays.
used_ocsp_bytes	A buffer containing the raw OCSP response data.
used_ocsp_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
used_ocsp_issuer	Indicates the issuer of this response (a CA or its authorized representative).
used_ocsp_issuer_rdn	Indicates the RDN of the issuer of this response (a CA or its authorized representative).
used_ocsp_location	The location of the OCSP responder.
used_ocsp_produced_at	Specifies the time when the response was produced, in UTC.
used_ocsp_source	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
use_system_certificates	Enables or disables the use of the system certificates.
validation_log	Contains the complete log of the certificate validation routine.
validation_moment	The time point at which chain 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	Sets or retrieves a configuration setting.
do_action	Performs an additional action.
get_qualified_status	Obtains the qualified information for Certificate .
get_trusted_list_property	Returns a specific TrustedList property.
refresh_cache	Refreshes the certificate cache.
reset	Resets the class settings.
reset_cache	Clears all data contained in the validation cache.
terminate	Terminates the validation process.
validate	Validates the certificate chain.
validate_for_smime	Validates an e-mail signing certificate.
validate_for_ssl	Validates a server-side SSL/TLS certificate.

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_after_certificate_processing	Marks the end of a single certificate processing step.
on_after_certificate_validation	Marks the end of a single certificate validation step.
on_before_ca_certificate_download	Fires when a CA certificate is about to be downloaded.
on_before_certificate_processing	Reports the start of certificate processing.
on_before_certificate_validation	Reports the start of certificate validation.
on_before_crl_download	Fires when a CRL is about to be downloaded.
on_before_ocsp_download	Fires when a certificate's OCSP status is about to be requested.
on_ca_certificate_downloaded	Marks the success of a certificate download.
on_ca_certificate_needed	Requests a missing certificate from the user.
on_crl_downloaded	Marks the success of a CRL download.
on_crl_needed	Requests a missing CRL from the user.
on_error	Information about errors during certificate validation.
on_notification	This event notifies the application about an underlying control flow event.
on_ocsp_downloaded	Marks the success of an OCSP request.
on_tls_cert_needed	Fires when a remote TLS party requests a client certificate.
on_tls_cert_validate	This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
on_tls_established	Fires when a TLS handshake with Host successfully completes.
on_tls_handshake	Fires when a new TLS handshake is initiated, before the handshake commences.
on_tls_shutdown	Reports the graceful closure of a TLS connection.

Config Settings

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


CacheValidityTime	Time period during which to keep validation cache.
CheckStrongAlgorithmForTrusted	Whether to check a 'strong' hash algorithm for trusted certificates.
CheckValidityPeriodForTrusted	Whether to check validity period for trusted certificates.
CrossCertificationValidationStrategy	Defines how the cross certification validation is performed.
DislikeOpenEndedOCSPs	Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.
ForceCompleteChainValidationForTrusted	Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.
ForceRevocationCheckForRoot	Whether to check revocation info for root certificates.
IgnoreBadOCSPChains	Whether to ignore bad OCSP chains during validation.
IgnoreCABasicConstraints	Whether to ignore the Basic Constraints extension for the CA certificates.
IgnoreCAKeyUsage	Whether to ignore Key Usage extension for CA certificates.
IgnoreCANameConstraints	Whether to ignore the Name Constraints extension for the CA certificates.
IgnoreChainLoops	Whether chain loops should be ignored.
IgnoreCRLIssuerKeyID	Tells the validator to ignore malformed CRL issuer key IDs.
IgnoreOCSPNoCheckExtension	Whether the OCSP NoCheck extension should be ignored.
IgnoreRevocationKeyUsage	Whether to check the CA certs used to sign revocation info.
IgnoreSSLKeyUsage	Whether to check the CA certs used in SSL/TLS.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
ImplicitlyTrustSelfSignedCertificates	Whether to trust self-signed certificates.
LookupCRLByNameIfDPNotPresent	Whether to look for implicit CRL Distribution Points.
PromoteLongOCSPResponses	Whether long OCSP responses are requested.
RevocationMomentGracePeriod	Grace period for revocation information propagation.
SkipSubjectNameIfAltNameExists	Whether to check CommonName if SubjectAltName is present.
UseMicrosoftCTL	Enables or disables the automatic use of the Microsoft online certificate trust list.
UseValidationCache	Enables or disable the use of the product-wide certificate chain validation cache.
ValidateInvalidCertificates	Whether to do all checks on invalid certificates.
WeakAlgorithmHandlingMode	How to handle certificates signed with a 'weak' hash algorithm.
CustomTrustedLists	Specifies the custom TrustedLists.
CustomTSLs	Specifies the custom TrustedLists.
DistributionPoints	Contains XML content of distribution points of the TSL used.
HistoricalInformationPeriod	Contains historical information period of the TSL used.
LegalNotices	Contains XML content of legal notices of the TSL used.
ListIssueDateTime	Contains list issue date and time of the TSL used.
NextUpdate	Contains next update date and time of the TSL used.
Policies	Contains XML content of policies of the TSL used.
QualifiedStatus	Indicates a qualified electronic signature.
SchemeExtensions	Contains XML content of scheme extensions of the TSL used.
SchemeInformationURI	Contains XML content of scheme information URI of the TSL used.
SchemeName	Contains XML content of scheme name of the TSL used.
SchemeOperatorAddress	Contains XML content of scheme operator address of the TSL used.
SchemeOperatorName	Contains XML content of scheme operator name of the TSL used.
SchemeTerritory	Contains scheme territory of the TSL used.
SchemeTypeCommunityRules	Contains XML content of scheme type/community/rules of the TSL used.
SequenceNumber	Contains sequence number of the TSL used.
StatusDeterminationApproach	Contains status determination approach of the TSL used.
TSLContent	Specifies the TrustedList content.
TSLContentHex	Specifies the TrustedList content.
TSLDistributionPoints	Contains XML content of distribution points of the TSL used.
TSLDistributionPoints[Idx]	Contains distribution point of the specified index of the TSL used.
TSLHistoricalInformationPeriod	Contains historical information period of the TSL used.
TSLLegalNotices	Contains XML content of legal notices of the TSL used.
TSLLegalNotices[lang]	Contains legal notices for the specified language of the TSL used.
TSLListIssueDateTime	Contains list issue date and time of the TSL used.
TSLNextUpdate	Contains next update date and time of the TSL used.
TSLPolicies	Contains XML content of policies of the TSL used.
TSLPolicies[lang]	Contains policies for the specified language of the TSL used.
TSLSchemeExtensions	Contains XML content of scheme extensions of the TSL used.
TSLSchemeExtensions[Idx]	Contains XML content of scheme extension of the specified index of the TSL used.
TSLSchemeInformationURI	Contains XML content of scheme information URI of the TSL used.
TSLSchemeInformationURI[lang]	Contains scheme information URI for the specified language of the TSL used.
TSLSchemeName	Contains XML content of scheme name of the TSL used.
TSLSchemeName[lang]	Contains scheme name for the specified language of the TSL used.
TSLSchemeOperatorAddress	Contains XML content of scheme operator address of the TSL used.
TSLSchemeOperatorName	Contains XML content of scheme operator name of the TSL used.
TSLSchemeOperatorName[lang]	Contains scheme operator name for the specified language of the TSL used.
TSLSchemeTerritory	Contains scheme territory of the TSL used.
TSLSchemeTypeCommunityRules	Contains XML content of scheme type/community/rules of the TSL used.
TSLSchemeTypeCommunityRules[lang]	Contains scheme type/community/rules for the specified language of the TSL used.
TSLSequenceNumber	Contains sequence number of the TSL used.
TSLsRetrieveLog	Contains the complete log of the TSLs retrieve.
TSLStatusDeterminationApproach	Contains status determination approach of the TSL used.
TSLsValidationLog	Contains the complete log of the TSLs validation.
TSLTSPAdditionalServiceInformation	Contains addtional service information of the TSP service used.
TSLTSPAddress	Contains XML content of the address of the TSP used.
TSLTSPHistoryInstance	Indicates that TSP service history instance used.
TSLTSPHistoryInstanceAdditionalServiceInformation	Contains addtional service information of the TSP service history instance used.
TSLTSPHistoryInstanceQualifiers	Contains list of qualifiers of the TSP service history instance used.
TSLTSPHistoryInstanceServiceInformationExtensions	Contains XML content of information extensions of the TSP service history instance used.
TSLTSPHistoryInstanceServiceInformationExtensions[Idx]	Contains XML content of information extension of the specified index of the TSP service history instance used.
TSLTSPHistoryInstanceServiceName	Contains XML content of name of the TSP service history instance used.
TSLTSPHistoryInstanceServiceName[lang]	Contains name for the specified language of the TSP service history instance used.
TSLTSPHistoryInstanceServiceStatus	Contains status of the TSP service history instance used.
TSLTSPHistoryInstanceServiceStatusStartingTime	Contains status starting time of the TSP service history instance used.
TSLTSPHistoryInstanceServiceTypeIdentifier	Contains type identifier of the TSP service history instance used.
TSLTSPHistoryInstanceXML	Contains XML content of the TSP service history instance used.
TSLTSPInformationExtensions	Contains XML content of information extensions of the TSP used.
TSLTSPInformationExtensions[Idx]	Contains XML content of information extension of the specified index of the TSP used.
TSLTSPInformationURI	Contains XML content of information URI of the TSP used.
TSLTSPInformationURI[lang]	Contains information URI for the specified language of the TSP used.
TSLTSPName	Contains XML content of name of the TSP used.
TSLTSPName[lang]	Contains name for the specified language of the TSP used.
TSLTSPSchemeServiceDefinitionURI	Contains XML content of scheme service definition URI of the TSP service used.
TSLTSPSchemeServiceDefinitionURI[lang]	Contains scheme service definition URI for the specified language of the TSP service used.
TSLTSPServiceDefinitionURI	Contains XML content of definition URI of the TSP service used.
TSLTSPServiceDefinitionURI[lang]	Contains definition URI for the specified language of the TSP service used.
TSLTSPServiceInformationExtensions	Contains XML content of information extensions of the TSP service used.
TSLTSPServiceInformationExtensions[Idx]	Contains XML content of information extension of the specified index of the TSP service used.
TSLTSPServiceName	Contains XML content of name of the TSP service used.
TSLTSPServiceName[lang]	Contains name for the specified language of the TSP service used.
TSLTSPServiceQualifiers	Contains list of qualifiers of the TSP service used.
TSLTSPServiceStatus	Contains status of the TSP service used.
TSLTSPServiceStatusStartingTime	Contains status starting time of the TSP service used.
TSLTSPServiceSupplyPoints	Contains XML content of the supply points of the TSP service used.
TSLTSPServiceTypeIdentifier	Contains type identifier of the TSP service used.
TSLTSPServiceXML	Contains XML content of the TSP service used.
TSLTSPTradeName	Contains XML content of trade name of the TSP used.
TSLTSPTradeName[lang]	Contains trade name for the specified language of the TSP used.
TSLTSPXML	Contains XML content of the TSP used.
TSLType	Contains TSL type of the TSL used.
TSLVersionIdentifier	Contains version identifier of the TSL used.
TSLXML	Contains XML content of the TSL used.
TSPAdditionalServiceInformation	Contains addtional service information of the TSP service used.
TSPAddress	Contains XML content of the address of the TSP used.
TSPHistoryInstance	Indicates that TSP service history instance used.
TSPHistoryInstanceAdditionalServiceInformation	Contains addtional service information of the TSP service history instance used.
TSPHistoryInstanceQualifiers	Contains list of qualifiers of the TSP service history instance used.
TSPHistoryInstanceServiceInformationExtensions	Contains XML content of information extensions of the TSP service history instance used.
TSPHistoryInstanceServiceName	Contains XML content of name of the TSP service history instance used.
TSPHistoryInstanceServiceStatus	Contains status of the TSP service history instance used.
TSPHistoryInstanceServiceStatusStartingTime	Contains status starting time of the TSP service history instance used.
TSPHistoryInstanceServiceTypeIdentifier	Contains type identifier of the TSP service history instance used.
TSPHistoryInstanceXML	Contains XML content of the TSP service history instance used.
TSPInformationExtensions	Contains XML content of information extensions of the TSP used.
TSPInformationURI	Contains XML content of information URI of the TSP used.
TSPName	Contains XML content of name of the TSP used.
TSPSchemeServiceDefinitionURI	Contains XML content of scheme service definition URI of the TSP service used.
TSPServiceDefinitionURI	Contains XML content of definition URI of the TSP service used.
TSPServiceInformationExtensions	Contains XML content of information extensions of the TSP service used.
TSPServiceName	Contains XML content of name of the TSP service used.
TSPServiceQualifiers	Contains list of qualifiers of the TSP service used.
TSPServiceStatus	Contains status of the TSP service used.
TSPServiceStatusStartingTime	Contains status starting time of the TSP service used.
TSPServiceSupplyPoints	Contains XML content of the supply points of the TSP service used.
TSPServiceTypeIdentifier	Contains type identifier of the TSP service used.
TSPServiceXML	Contains XML content of the TSP service used.
TSPTradeName	Contains XML content of trade name of the TSP used.
TSPXML	Contains XML content of the TSP used.
Type	Contains TSL type of the TSL used.
VersionIdentifier	Contains version identifier of the TSL used.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

blocked_cert_count Property

The number of records in the BlockedCert arrays.

Syntax

def get_blocked_cert_count() -> int: ...
def set_blocked_cert_count(value: int) -> None: ...

blocked_cert_count = property(get_blocked_cert_count, set_blocked_cert_count)

Default Value

Remarks

This property controls the size of the following arrays:

blocked_cert_bytes
blocked_cert_handle

The array indices start at 0 and end at blocked_cert_count - 1.

blocked_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_blocked_cert_bytes(blocked_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The blocked_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the blocked_cert_count property.

This property is read-only.

blocked_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_blocked_cert_handle(blocked_cert_index: int) -> int: ...
def set_blocked_cert_handle(blocked_cert_index: int, value: int) -> None: ...

Default Value

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The blocked_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the blocked_cert_count property.

cache_validation_results Property

Enables or disables validation result caching.

Syntax

def get_cache_validation_results() -> bool: ...
def set_cache_validation_results(value: bool) -> None: ...

cache_validation_results = property(get_cache_validation_results, set_cache_validation_results)

Default Value

FALSE

Remarks

Set this property to True to enable caching of validation results.

cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_cert_bytes() -> bytes: ...

cert_bytes = property(get_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_cert_handle() -> int: ...
def set_cert_handle(value: int) -> None: ...

cert_handle = property(get_cert_handle, set_cert_handle)

Default Value

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.

chain_validation_details Property

The details of a certificate chain validation outcome.

Syntax

def get_chain_validation_details() -> int: ...

chain_validation_details = property(get_chain_validation_details, None)

Default Value

Remarks

Use the value(s) returned by this property to identify 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.

chain_validation_result Property

The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.

Syntax

def get_chain_validation_result() -> int: ...

chain_validation_result = property(get_chain_validation_result, None)

Default Value

Remarks

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.

check_trusted_lists Property

Specifies whether the class should attempt to validate chain trust via a known Trusted List.

Syntax

def get_check_trusted_lists() -> bool: ...
def set_check_trusted_lists(value: bool) -> None: ...

check_trusted_lists = property(get_check_trusted_lists, set_check_trusted_lists)

Default Value

FALSE

Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

current_ca_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_current_ca_cert_bytes() -> bytes: ...

current_ca_cert_bytes = property(get_current_ca_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

current_ca_cert_ca Property

Indicates whether the certificate has a CA capability.

Syntax

def get_current_ca_cert_ca() -> bool: ...

current_ca_cert_ca = property(get_current_ca_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.

current_ca_cert_ca_key_id Property

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

def get_current_ca_cert_ca_key_id() -> bytes: ...

current_ca_cert_ca_key_id = property(get_current_ca_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 generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the current_ca_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

current_ca_cert_cert_type Property

Returns the type of the entity contained in the Certificate object.

Syntax

def get_current_ca_cert_cert_type() -> int: ...

current_ca_cert_cert_type = property(get_current_ca_cert_cert_type, None)

Default Value

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

This property is read-only.

current_ca_cert_crl_distribution_points Property

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

def get_current_ca_cert_crl_distribution_points() -> str: ...

current_ca_cert_crl_distribution_points = property(get_current_ca_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.

current_ca_cert_curve Property

Specifies the elliptic curve associated with the certificate's public key.

Syntax

def get_current_ca_cert_curve() -> str: ...

current_ca_cert_curve = property(get_current_ca_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.

current_ca_cert_fingerprint Property

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

def get_current_ca_cert_fingerprint() -> str: ...

current_ca_cert_fingerprint = property(get_current_ca_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.

current_ca_cert_friendly_name Property

Contains an associated alias (friendly name) of the certificate.

Syntax

def get_current_ca_cert_friendly_name() -> str: ...

current_ca_cert_friendly_name = property(get_current_ca_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.

current_ca_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_current_ca_cert_handle() -> int: ...

current_ca_cert_handle = property(get_current_ca_cert_handle, None)

Default Value

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.

This property is read-only.

current_ca_cert_hash_algorithm Property

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

def get_current_ca_cert_hash_algorithm() -> str: ...

current_ca_cert_hash_algorithm = property(get_current_ca_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 current_ca_cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

This property is read-only.

current_ca_cert_issuer Property

The common name of the certificate issuer (CA), typically a company name.

Syntax

def get_current_ca_cert_issuer() -> str: ...

current_ca_cert_issuer = property(get_current_ca_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 current_ca_cert_issuer_rdn.

This property is read-only.

current_ca_cert_issuer_rdn Property

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

def get_current_ca_cert_issuer_rdn() -> str: ...

current_ca_cert_issuer_rdn = property(get_current_ca_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.

current_ca_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_current_ca_cert_key_algorithm() -> str: ...

current_ca_cert_key_algorithm = property(get_current_ca_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`

Use the current_ca_cert_key_bits, current_ca_cert_curve, and current_ca_cert_public_key_bytes properties to get more details about the key the certificate contains.

This property is read-only.

current_ca_cert_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_current_ca_cert_key_bits() -> int: ...

current_ca_cert_key_bits = property(get_current_ca_cert_key_bits, None)

Default Value

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 current_ca_cert_public_key_bytes or current_ca_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

current_ca_cert_key_fingerprint Property

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

def get_current_ca_cert_key_fingerprint() -> str: ...

current_ca_cert_key_fingerprint = property(get_current_ca_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 current_ca_cert_fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

current_ca_cert_key_usage Property

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

def get_current_ca_cert_key_usage() -> int: ...

current_ca_cert_key_usage = property(get_current_ca_cert_key_usage, None)

Default Value

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.

current_ca_cert_key_valid Property

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

def get_current_ca_cert_key_valid() -> bool: ...

current_ca_cert_key_valid = property(get_current_ca_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.

current_ca_cert_ocsp_locations Property

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

def get_current_ca_cert_ocsp_locations() -> str: ...

current_ca_cert_ocsp_locations = property(get_current_ca_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 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.

current_ca_cert_ocsp_no_check Property

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

def get_current_ca_cert_ocsp_no_check() -> bool: ...

current_ca_cert_ocsp_no_check = property(get_current_ca_cert_ocsp_no_check, None)

Default Value

FALSE

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

This property is read-only.

current_ca_cert_origin Property

Returns the location that the certificate was taken or loaded from.

Syntax

def get_current_ca_cert_origin() -> int: ...

current_ca_cert_origin = property(get_current_ca_cert_origin, None)

Default Value

Remarks

Returns the location that the certificate was taken or loaded from.

This property is read-only.

current_ca_cert_policy_i_ds Property

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

def get_current_ca_cert_policy_i_ds() -> str: ...

current_ca_cert_policy_i_ds = property(get_current_ca_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.

current_ca_cert_private_key_bytes Property

Returns the certificate's private key in DER-encoded format.

Syntax

def get_current_ca_cert_private_key_bytes() -> bytes: ...

current_ca_cert_private_key_bytes = property(get_current_ca_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.

current_ca_cert_private_key_exists Property

Indicates whether the certificate has a usable private key associated with it.

Syntax

def get_current_ca_cert_private_key_exists() -> bool: ...

current_ca_cert_private_key_exists = property(get_current_ca_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 current_ca_cert_private_key_bytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

This property is read-only.

current_ca_cert_private_key_extractable Property

Indicates whether the private key is extractable (exportable).

Syntax

def get_current_ca_cert_private_key_extractable() -> bool: ...

current_ca_cert_private_key_extractable = property(get_current_ca_cert_private_key_extractable, None)

Default Value

FALSE

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

current_ca_cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

def get_current_ca_cert_public_key_bytes() -> bytes: ...

current_ca_cert_public_key_bytes = property(get_current_ca_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.

current_ca_cert_qualified Property

Indicates whether the certificate is qualified.

Syntax

def get_current_ca_cert_qualified() -> bool: ...

current_ca_cert_qualified = property(get_current_ca_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.

current_ca_cert_qualified_statements Property

Returns a simplified qualified status of the certificate.

Syntax

def get_current_ca_cert_qualified_statements() -> int: ...

current_ca_cert_qualified_statements = property(get_current_ca_cert_qualified_statements, None)

Default Value

Remarks

Returns a simplified qualified status of the certificate.

This property is read-only.

current_ca_cert_qualifiers Property

A list of qualifiers.

Syntax

def get_current_ca_cert_qualifiers() -> str: ...

current_ca_cert_qualifiers = property(get_current_ca_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.

current_ca_cert_self_signed Property

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

def get_current_ca_cert_self_signed() -> bool: ...

current_ca_cert_self_signed = property(get_current_ca_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.

current_ca_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_current_ca_cert_serial_number() -> bytes: ...

current_ca_cert_serial_number = property(get_current_ca_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.

current_ca_cert_sig_algorithm Property

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

def get_current_ca_cert_sig_algorithm() -> str: ...

current_ca_cert_sig_algorithm = property(get_current_ca_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.

current_ca_cert_source Property

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

def get_current_ca_cert_source() -> int: ...

current_ca_cert_source = property(get_current_ca_cert_source, None)

Default Value

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.

current_ca_cert_subject Property

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

def get_current_ca_cert_subject() -> str: ...

current_ca_cert_subject = property(get_current_ca_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 current_ca_cert_subject_rdn.

This property is read-only.

current_ca_cert_subject_alternative_name Property

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

def get_current_ca_cert_subject_alternative_name() -> str: ...

current_ca_cert_subject_alternative_name = property(get_current_ca_cert_subject_alternative_name, None)

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 current_ca_cert_subject_rdn field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

This property is read-only.

current_ca_cert_subject_key_id Property

Contains a unique identifier of the certificate's cryptographic key.

Syntax

def get_current_ca_cert_subject_key_id() -> bytes: ...

current_ca_cert_subject_key_id = property(get_current_ca_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 current_ca_cert_subject_key_id and current_ca_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is read-only.

current_ca_cert_subject_rdn Property

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

def get_current_ca_cert_subject_rdn() -> str: ...

current_ca_cert_subject_rdn = property(get_current_ca_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.

current_ca_cert_valid Property

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

def get_current_ca_cert_valid() -> bool: ...

current_ca_cert_valid = property(get_current_ca_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.

current_ca_cert_valid_from Property

The time point at which the certificate becomes valid, in UTC.

Syntax

def get_current_ca_cert_valid_from() -> str: ...

current_ca_cert_valid_from = property(get_current_ca_cert_valid_from, None)

Default Value

Remarks

The time point at which the certificate becomes valid, in UTC.

This property is read-only.

current_ca_cert_valid_to Property

The time point at which the certificate expires, in UTC.

Syntax

def get_current_ca_cert_valid_to() -> str: ...

current_ca_cert_valid_to = property(get_current_ca_cert_valid_to, None)

Default Value

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only.

current_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_current_cert_bytes() -> bytes: ...

current_cert_bytes = property(get_current_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

current_cert_ca Property

Indicates whether the certificate has a CA capability.

Syntax

def get_current_cert_ca() -> bool: ...

current_cert_ca = property(get_current_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.

current_cert_ca_key_id Property

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

def get_current_cert_ca_key_id() -> bytes: ...

current_cert_ca_key_id = property(get_current_cert_ca_key_id, None)

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the current_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

current_cert_cert_type Property

Returns the type of the entity contained in the Certificate object.

Syntax

def get_current_cert_cert_type() -> int: ...

current_cert_cert_type = property(get_current_cert_cert_type, None)

Default Value

Remarks

Returns the type of the entity contained in the Certificate object.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

This property is read-only.

current_cert_crl_distribution_points Property

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

def get_current_cert_crl_distribution_points() -> str: ...

current_cert_crl_distribution_points = property(get_current_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.

current_cert_curve Property

Specifies the elliptic curve associated with the certificate's public key.

Syntax

def get_current_cert_curve() -> str: ...

current_cert_curve = property(get_current_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.

current_cert_fingerprint Property

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

def get_current_cert_fingerprint() -> str: ...

current_cert_fingerprint = property(get_current_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.

current_cert_friendly_name Property

Contains an associated alias (friendly name) of the certificate.

Syntax

def get_current_cert_friendly_name() -> str: ...

current_cert_friendly_name = property(get_current_cert_friendly_name, None)

Default Value

Remarks

This property is read-only.

current_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_current_cert_handle() -> int: ...

current_cert_handle = property(get_current_cert_handle, None)

Default Value

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.

This property is read-only.

current_cert_hash_algorithm Property

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

def get_current_cert_hash_algorithm() -> str: ...

current_cert_hash_algorithm = property(get_current_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 current_cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

This property is read-only.

current_cert_issuer Property

The common name of the certificate issuer (CA), typically a company name.

Syntax

def get_current_cert_issuer() -> str: ...

current_cert_issuer = property(get_current_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 current_cert_issuer_rdn.

This property is read-only.

current_cert_issuer_rdn Property

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

def get_current_cert_issuer_rdn() -> str: ...

current_cert_issuer_rdn = property(get_current_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.

current_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_current_cert_key_algorithm() -> str: ...

current_cert_key_algorithm = property(get_current_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`

Use the current_cert_key_bits, current_cert_curve, and current_cert_public_key_bytes properties to get more details about the key the certificate contains.

This property is read-only.

current_cert_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_current_cert_key_bits() -> int: ...

current_cert_key_bits = property(get_current_cert_key_bits, None)

Default Value

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 current_cert_public_key_bytes or current_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

current_cert_key_fingerprint Property

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

def get_current_cert_key_fingerprint() -> str: ...

current_cert_key_fingerprint = property(get_current_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 current_cert_fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

current_cert_key_usage Property

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

def get_current_cert_key_usage() -> int: ...

current_cert_key_usage = property(get_current_cert_key_usage, None)

Default Value

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.

current_cert_key_valid Property

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

def get_current_cert_key_valid() -> bool: ...

current_cert_key_valid = property(get_current_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.

current_cert_ocsp_locations Property

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

def get_current_cert_ocsp_locations() -> str: ...

current_cert_ocsp_locations = property(get_current_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 method to propagate it to the new certificate.

This property is read-only.

current_cert_ocsp_no_check Property

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

def get_current_cert_ocsp_no_check() -> bool: ...

current_cert_ocsp_no_check = property(get_current_cert_ocsp_no_check, None)

Default Value

FALSE

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

This property is read-only.

current_cert_origin Property

Returns the location that the certificate was taken or loaded from.

Syntax

def get_current_cert_origin() -> int: ...

current_cert_origin = property(get_current_cert_origin, None)

Default Value

Remarks

Returns the location that the certificate was taken or loaded from.

This property is read-only.

current_cert_policy_i_ds Property

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

def get_current_cert_policy_i_ds() -> str: ...

current_cert_policy_i_ds = property(get_current_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.

This property is read-only.

current_cert_private_key_bytes Property

Returns the certificate's private key in DER-encoded format.

Syntax

def get_current_cert_private_key_bytes() -> bytes: ...

current_cert_private_key_bytes = property(get_current_cert_private_key_bytes, None)

Remarks

This property is read-only.

current_cert_private_key_exists Property

Indicates whether the certificate has a usable private key associated with it.

Syntax

def get_current_cert_private_key_exists() -> bool: ...

current_cert_private_key_exists = property(get_current_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 current_cert_private_key_bytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

This property is read-only.

current_cert_private_key_extractable Property

Indicates whether the private key is extractable (exportable).

Syntax

def get_current_cert_private_key_extractable() -> bool: ...

current_cert_private_key_extractable = property(get_current_cert_private_key_extractable, None)

Default Value

FALSE

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

current_cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

def get_current_cert_public_key_bytes() -> bytes: ...

current_cert_public_key_bytes = property(get_current_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.

current_cert_qualified Property

Indicates whether the certificate is qualified.

Syntax

def get_current_cert_qualified() -> bool: ...

current_cert_qualified = property(get_current_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.

current_cert_qualified_statements Property

Returns a simplified qualified status of the certificate.

Syntax

def get_current_cert_qualified_statements() -> int: ...

current_cert_qualified_statements = property(get_current_cert_qualified_statements, None)

Default Value

Remarks

Returns a simplified qualified status of the certificate.

This property is read-only.

current_cert_qualifiers Property

A list of qualifiers.

Syntax

def get_current_cert_qualifiers() -> str: ...

current_cert_qualifiers = property(get_current_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.

current_cert_self_signed Property

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

def get_current_cert_self_signed() -> bool: ...

current_cert_self_signed = property(get_current_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.

current_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_current_cert_serial_number() -> bytes: ...

current_cert_serial_number = property(get_current_cert_serial_number, None)

Remarks

Returns the certificate's serial number.

This property is read-only.

current_cert_sig_algorithm Property

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

def get_current_cert_sig_algorithm() -> str: ...

current_cert_sig_algorithm = property(get_current_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.

current_cert_source Property

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

def get_current_cert_source() -> int: ...

current_cert_source = property(get_current_cert_source, None)

Default Value

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.

current_cert_subject Property

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

def get_current_cert_subject() -> str: ...

current_cert_subject = property(get_current_cert_subject, None)

Default Value

Remarks

This property is read-only.

current_cert_subject_alternative_name Property

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

def get_current_cert_subject_alternative_name() -> str: ...

current_cert_subject_alternative_name = property(get_current_cert_subject_alternative_name, None)

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 current_cert_subject_rdn field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

This property is read-only.

current_cert_subject_key_id Property

Contains a unique identifier of the certificate's cryptographic key.

Syntax

def get_current_cert_subject_key_id() -> bytes: ...

current_cert_subject_key_id = property(get_current_cert_subject_key_id, None)

Remarks

Contains a unique identifier of the certificate's cryptographic key.

The current_cert_subject_key_id and current_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is read-only.

current_cert_subject_rdn Property

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

def get_current_cert_subject_rdn() -> str: ...

current_cert_subject_rdn = property(get_current_cert_subject_rdn, None)

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

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.

current_cert_valid Property

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

def get_current_cert_valid() -> bool: ...

current_cert_valid = property(get_current_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.

current_cert_valid_from Property

The time point at which the certificate becomes valid, in UTC.

Syntax

def get_current_cert_valid_from() -> str: ...

current_cert_valid_from = property(get_current_cert_valid_from, None)

Default Value

Remarks

The time point at which the certificate becomes valid, in UTC.

This property is read-only.

current_cert_valid_to Property

The time point at which the certificate expires, in UTC.

Syntax

def get_current_cert_valid_to() -> str: ...

current_cert_valid_to = property(get_current_cert_valid_to, None)

Default Value

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only.

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

grace_period Property

Specifies a grace period to apply during certificate validation.

Syntax

def get_grace_period() -> int: ...
def set_grace_period(value: int) -> None: ...

grace_period = property(get_grace_period, set_grace_period)

Default Value

Remarks

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.

interim_validation_details Property

Contains the validation details of the moment.

Syntax

def get_interim_validation_details() -> int: ...
def set_interim_validation_details(value: int) -> None: ...

interim_validation_details = property(get_interim_validation_details, set_interim_validation_details)

Default Value

Remarks

Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.

Use this property to check the interim validity details mid-flight.

The value of this property is 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

interim_validation_result Property

Contains the validation status of the moment.

Syntax

def get_interim_validation_result() -> int: ...
def set_interim_validation_result(value: int) -> None: ...

interim_validation_result = property(get_interim_validation_result, set_interim_validation_result)

Default Value

Remarks

Use this property to check the interim validity status mid-flight.


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)

known_cert_count Property

The number of records in the KnownCert arrays.

Syntax

def get_known_cert_count() -> int: ...
def set_known_cert_count(value: int) -> None: ...

known_cert_count = property(get_known_cert_count, set_known_cert_count)

Default Value

Remarks

This property controls the size of the following arrays:

known_cert_bytes
known_cert_handle

The array indices start at 0 and end at known_cert_count - 1.

known_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_known_cert_bytes(known_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The known_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_cert_count property.

This property is read-only.

known_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_known_cert_handle(known_cert_index: int) -> int: ...
def set_known_cert_handle(known_cert_index: int, value: int) -> None: ...

Default Value

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.

The known_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_cert_count property.

known_crl_count Property

The number of records in the KnownCRL arrays.

Syntax

def get_known_crl_count() -> int: ...
def set_known_crl_count(value: int) -> None: ...

known_crl_count = property(get_known_crl_count, set_known_crl_count)

Default Value

Remarks

This property controls the size of the following arrays:

known_crl_bytes
known_crl_handle

The array indices start at 0 and end at known_crl_count - 1.

known_crl_bytes Property

Returns the raw CRL data in DER format.

Syntax

def get_known_crl_bytes(known_crl_index: int) -> bytes: ...

Remarks

Returns the raw CRL data in DER format.

The known_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_crl_count property.

This property is read-only.

known_crl_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_known_crl_handle(known_crl_index: int) -> int: ...
def set_known_crl_handle(known_crl_index: int, value: int) -> None: ...

Default Value

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.

The known_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_crl_count property.

known_ocsp_count Property

The number of records in the KnownOCSP arrays.

Syntax

def get_known_ocsp_count() -> int: ...
def set_known_ocsp_count(value: int) -> None: ...

known_ocsp_count = property(get_known_ocsp_count, set_known_ocsp_count)

Default Value

Remarks

This property controls the size of the following arrays:

known_ocsp_bytes
known_ocsp_handle

The array indices start at 0 and end at known_ocsp_count - 1.

known_ocsp_bytes Property

A buffer containing the raw OCSP response data.

Syntax

def get_known_ocsp_bytes(known_ocsp_index: int) -> bytes: ...

Remarks

A buffer containing the raw OCSP response data.

The known_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_ocsp_count property.

This property is read-only.

known_ocsp_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_known_ocsp_handle(known_ocsp_index: int) -> int: ...
def set_known_ocsp_handle(known_ocsp_index: int, value: int) -> None: ...

Default Value

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.

The known_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_ocsp_count property.

max_validation_time Property

Specifies the maximum time the validation process may take.

Syntax

def get_max_validation_time() -> int: ...
def set_max_validation_time(value: int) -> None: ...

max_validation_time = property(get_max_validation_time, set_max_validation_time)

Default Value

Remarks

Use this property to limit the amount of time available for the validator to carry out the validation. If the validation process exceeds this time, it is terminated and the validation error is returned.

offline_mode Property

Switches the class to offline mode.

Syntax

def get_offline_mode() -> bool: ...
def set_offline_mode(value: bool) -> None: ...

offline_mode = property(get_offline_mode, set_offline_mode)

Default Value

FALSE

Remarks

When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via known_certificates, known_crls, and other related properties.

proxy_address Property

The IP address of the proxy server.

Syntax

def get_proxy_address() -> str: ...
def set_proxy_address(value: str) -> None: ...

proxy_address = property(get_proxy_address, set_proxy_address)

Default Value

Remarks

The IP address of the proxy server.

proxy_authentication Property

The authentication type used by the proxy server.

Syntax

def get_proxy_authentication() -> int: ...
def set_proxy_authentication(value: int) -> None: ...

proxy_authentication = property(get_proxy_authentication, set_proxy_authentication)

Default Value

Remarks

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

proxy_password Property

The password to authenticate to the proxy server.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

Remarks

The password to authenticate to the proxy server.

proxy_port Property

The port on the proxy server to connect to.

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

Remarks

The port on the proxy server to connect to.

proxy_proxy_type Property

The type of the proxy server.

Syntax

def get_proxy_proxy_type() -> int: ...
def set_proxy_proxy_type(value: int) -> None: ...

proxy_proxy_type = property(get_proxy_proxy_type, set_proxy_proxy_type)

Default Value

Remarks

The type of the proxy server.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

proxy_request_headers Property

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

def get_proxy_request_headers() -> str: ...
def set_proxy_request_headers(value: str) -> None: ...

proxy_request_headers = property(get_proxy_request_headers, set_proxy_request_headers)

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

proxy_response_body Property

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

def get_proxy_response_body() -> str: ...
def set_proxy_response_body(value: str) -> None: ...

proxy_response_body = property(get_proxy_response_body, set_proxy_response_body)

Default Value

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

proxy_response_headers Property

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

def get_proxy_response_headers() -> str: ...
def set_proxy_response_headers(value: str) -> None: ...

proxy_response_headers = property(get_proxy_response_headers, set_proxy_response_headers)

Default Value

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

proxy_use_ipv6 Property

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

def get_proxy_use_ipv6() -> bool: ...
def set_proxy_use_ipv6(value: bool) -> None: ...

proxy_use_ipv6 = property(get_proxy_use_ipv6, set_proxy_use_ipv6)

Default Value

FALSE

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

proxy_username Property

Specifies the username credential for proxy authentication.

Syntax

def get_proxy_username() -> str: ...
def set_proxy_username(value: str) -> None: ...

proxy_username = property(get_proxy_username, set_proxy_username)

Default Value

Remarks

Specifies the username credential for proxy authentication.

qualified_info_address Property

Contains the address of the TSL provider.

Syntax

def get_qualified_info_address() -> str: ...

qualified_info_address = property(get_qualified_info_address, None)

Default Value

Remarks

Contains the address of the TSL provider.

Use this property to check the address of the TSL provider.

This property is read-only.

qualified_info_custom_trusted_lists Property

The list of custom TrustedLists to use.

Syntax

def get_qualified_info_custom_trusted_lists() -> str: ...
def set_qualified_info_custom_trusted_lists(value: str) -> None: ...

qualified_info_custom_trusted_lists = property(get_qualified_info_custom_trusted_lists, set_qualified_info_custom_trusted_lists)

Default Value

Remarks

The list of custom TrustedLists to use.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

qualified_info_download_log Property

Contains the TLS download log.

Syntax

def get_qualified_info_download_log() -> str: ...

qualified_info_download_log = property(get_qualified_info_download_log, None)

Default Value

Remarks

Contains the TLS download log.

This log may be useful in investigating TSL retrieval failures.

This property is read-only.

qualified_info_information_uri Property

Contains the URI of the provider information.

Syntax

def get_qualified_info_information_uri() -> str: ...

qualified_info_information_uri = property(get_qualified_info_information_uri, None)

Default Value

Remarks

Contains the URI of the provider information.

Use this property to get the URI of the TSL provider information.

This property is read-only.

qualified_info_languages Property

The preferred language(s) for TSL data.

Syntax

def get_qualified_info_languages() -> str: ...
def set_qualified_info_languages(value: str) -> None: ...

qualified_info_languages = property(get_qualified_info_languages, set_qualified_info_languages)

Default Value

Remarks

The preferred language(s) for TSL data.

Use this property to pass a list of languages, in order of preference, which will be considered when returning TSL properties. Many trust providers return qualified information in several languages. By tuning up this property you can choose a selection of preferred languages (such as "it,en") in which you would like to read the qualified details.

qualified_info_next_update Property

Returns the next update date and time of the TSL.

Syntax

def get_qualified_info_next_update() -> str: ...

qualified_info_next_update = property(get_qualified_info_next_update, None)

Default Value

Remarks

Returns the next update date and time of the TSL.

Use this property to check the next update value for the TSL.

This property is read-only.

qualified_info_provider Property

Contains the name of the TSL provider.

Syntax

def get_qualified_info_provider() -> str: ...

qualified_info_provider = property(get_qualified_info_provider, None)

Default Value

Remarks

Contains the name of the TSL provider.

Use this property to check the name of the TSL provider.

This property is read-only.

qualified_info_qualified Property

Indicates whether the certificate is qualified.

Syntax

def get_qualified_info_qualified() -> bool: ...

qualified_info_qualified = property(get_qualified_info_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 TSL to be qualified.

This property is read-only.

qualified_info_qualifiers Property

A list of qualifiers.

Syntax

def get_qualified_info_qualifiers() -> str: ...

qualified_info_qualifiers = property(get_qualified_info_qualifiers, None)

Default Value

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifiers for the certificate, for example QCP-n-qscd,QCWithSSCD.

This property is read-only.

qualified_info_service_name Property

Contains the name of the TSL service.

Syntax

def get_qualified_info_service_name() -> str: ...

qualified_info_service_name = property(get_qualified_info_service_name, None)

Default Value

Remarks

Contains the name of the TSL service.

Use this property to check the name of the TSL service.

This property is read-only.

qualified_info_service_type_id Property

Contains the TSL service type identifier.

Syntax

def get_qualified_info_service_type_id() -> str: ...

qualified_info_service_type_id = property(get_qualified_info_service_type_id, None)

Default Value

Remarks

Contains the TSL service type identifier.

Use this property to check the service type identifier of the TSL.

This property is read-only.

qualified_info_source Property

The source of qualified information.

Syntax

def get_qualified_info_source() -> int: ...

qualified_info_source = property(get_qualified_info_source, None)

Default Value

Remarks

The source of qualified information.

Available options:


qisUnknown	`0`	The source is unknown
qisCertificate	`1`	The information was taken from the certificate
qisTSL	`2`	The information was taken from an online TSL
qisBoth	`3`	The information was taken from both the certificate and an online TSL

Use the Source property to establish the origin of the qualified information.

This property is read-only.

qualified_info_status Property

Indicates a qualified electronic signature.

Syntax

def get_qualified_info_status() -> int: ...

qualified_info_status = property(get_qualified_info_status, None)

Default Value

Remarks

Indicates a qualified electronic signature.

Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate.

Adjust UseDefaultTSLs property and/or CustomTSLs property before validating the signature/certificate to properly obtain TSP (Trust Service Provider) service status. Use Qualified* and TSL* config properties to obtain extended information.

The following qualified statuses are supported:


sqsUnknown	`0`	Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI.
sqsNone	`1`	None
sqsGranted	`2`	Granted
sqsWithdrawn	`3`	Withdrawn
sqsSetByNationalLaw	`4`	Set by national law
sqsDeprecatedByNationalLaw	`5`	Deprecated by national law
sqsRecognizedAtNationalLevel	`6`	Recognized at national level
sqsDeprecatedAtNationalLevel	`7`	Deprecated at national level
sqsUnderSupervision	`8`	Under supervision
sqsSupervisionInCessation	`9`	Supervision in cessation
sqsSupervisionCeased	`10`	Supervision ceased
sqsSupervisionRevoked	`11`	Supervision revoked
sqsAccredited	`12`	Accredited
sqsAccreditationCeased	`13`	Accreditation ceased
sqsAccreditationRevoked	`14`	Accreditation revoked
sqsInAccordance	`15`	Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes).
sqsExpired	`16`	Deprecated. The subject service is no longer overseen by the scheme, e.g. due to nonrenewal or withdrawal by the TSP, or cessation of the service or the scheme's operations.
sqsSuspended	`17`	Deprecated. The subject service's status is temporarily uncertain whilst checks are made by the scheme operator (typically e.g. while a revocation request is being investigated or if action is required to resolve a deficiency in the service fulfilling the scheme's criteria.
sqsRevoked	`18`	Deprecated. The subject service's approved status has been revoked because it is no longer in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes).
sqsNotInAccordance	`19`	Deprecated. The subject service is not in accordance with the scheme's specific status determination criteria (only for use in negative approval schemes).

This property is read-only.

qualified_info_trade_name Property

Contains the trade name of the TSL provider.

Syntax

def get_qualified_info_trade_name() -> str: ...

qualified_info_trade_name = property(get_qualified_info_trade_name, None)

Default Value

Remarks

Contains the trade name of the TSL provider.

Use this property to check the trade name of the TSL provider.

This property is read-only.

qualified_info_trusted Property

Indicates whether the certificate is trusted.

Syntax

def get_qualified_info_trusted() -> bool: ...

qualified_info_trusted = property(get_qualified_info_trusted, None)

Default Value

FALSE

Remarks

Indicates whether the certificate is trusted.

This property is set to true if the certificate is confirmed by a TSL to be trusted.

This property is read-only.

qualified_info_use_default_trusted_lists Property

Use this setting to enable or disable the use of the default TrustedLists.

Syntax

def get_qualified_info_use_default_trusted_lists() -> bool: ...
def set_qualified_info_use_default_trusted_lists(value: bool) -> None: ...

qualified_info_use_default_trusted_lists = property(get_qualified_info_use_default_trusted_lists, set_qualified_info_use_default_trusted_lists)

Default Value

TRUE

Remarks

Use this setting to enable or disable the use of the default TrustedLists.

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

The following default TSLs are used: EU (European Union) TSL.

qualified_info_validation_log Property

Contains the TLS validation log.

Syntax

def get_qualified_info_validation_log() -> str: ...

qualified_info_validation_log = property(get_qualified_info_validation_log, None)

Default Value

Remarks

Contains the TLS validation log.

This log may be useful in investigating TSL validation failures.

This property is read-only.

qualified_info_xml Property

Contains the XML of the TSL.

Syntax

def get_qualified_info_xml() -> str: ...

qualified_info_xml = property(get_qualified_info_xml, None)

Default Value

Remarks

Contains the XML of the TSL.

Use this property to obtain the original body of the TSL in XML format.

This property is read-only.

revocation_check Property

Specifies the kind(s) of revocation check to perform for all chain certificates.

Syntax

def get_revocation_check() -> int: ...
def set_revocation_check(value: int) -> None: ...

revocation_check = property(get_revocation_check, set_revocation_check)

Default Value

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.

socket_dns_mode Property

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Syntax

def get_socket_dns_mode() -> int: ...
def set_socket_dns_mode(value: int) -> None: ...

socket_dns_mode = property(get_socket_dns_mode, set_socket_dns_mode)

Default Value

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

socket_dns_port Property

Specifies the port number to be used for sending queries to the DNS server.

Syntax

def get_socket_dns_port() -> int: ...
def set_socket_dns_port(value: int) -> None: ...

socket_dns_port = property(get_socket_dns_port, set_socket_dns_port)

Default Value

Remarks

Specifies the port number to be used for sending queries to the DNS server.

socket_dns_query_timeout Property

The timeout (in milliseconds) for each DNS query.

Syntax

def get_socket_dns_query_timeout() -> int: ...
def set_socket_dns_query_timeout(value: int) -> None: ...

socket_dns_query_timeout = property(get_socket_dns_query_timeout, set_socket_dns_query_timeout)

Default Value

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

socket_dns_servers Property

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

def get_socket_dns_servers() -> str: ...
def set_socket_dns_servers(value: str) -> None: ...

socket_dns_servers = property(get_socket_dns_servers, set_socket_dns_servers)

Default Value

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

socket_dns_total_timeout Property

The timeout (in milliseconds) for the whole resolution process.

Syntax

def get_socket_dns_total_timeout() -> int: ...
def set_socket_dns_total_timeout(value: int) -> None: ...

socket_dns_total_timeout = property(get_socket_dns_total_timeout, set_socket_dns_total_timeout)

Default Value

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

socket_incoming_speed_limit Property

The maximum number of bytes to read from the socket, per second.

Syntax

def get_socket_incoming_speed_limit() -> int: ...
def set_socket_incoming_speed_limit(value: int) -> None: ...

socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit)

Default Value

Remarks

The maximum number of bytes to read from the socket, per second.

socket_local_address Property

The local network interface to bind the socket to.

Syntax

def get_socket_local_address() -> str: ...
def set_socket_local_address(value: str) -> None: ...

socket_local_address = property(get_socket_local_address, set_socket_local_address)

Default Value

Remarks

The local network interface to bind the socket to.

socket_local_port Property

The local port number to bind the socket to.

Syntax

def get_socket_local_port() -> int: ...
def set_socket_local_port(value: int) -> None: ...

socket_local_port = property(get_socket_local_port, set_socket_local_port)

Default Value

Remarks

The local port number to bind the socket to.

socket_outgoing_speed_limit Property

The maximum number of bytes to write to the socket, per second.

Syntax

def get_socket_outgoing_speed_limit() -> int: ...
def set_socket_outgoing_speed_limit(value: int) -> None: ...

socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit)

Default Value

Remarks

The maximum number of bytes to write to the socket, per second.

socket_timeout Property

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

def get_socket_timeout() -> int: ...
def set_socket_timeout(value: int) -> None: ...

socket_timeout = property(get_socket_timeout, set_socket_timeout)

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

socket_use_ipv6 Property

Enables or disables IP protocol version 6.

Syntax

def get_socket_use_ipv6() -> bool: ...
def set_socket_use_ipv6(value: bool) -> None: ...

socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6)

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

tls_client_cert_count Property

The number of records in the TLSClientCert arrays.

Syntax

def get_tls_client_cert_count() -> int: ...
def set_tls_client_cert_count(value: int) -> None: ...

tls_client_cert_count = property(get_tls_client_cert_count, set_tls_client_cert_count)

Default Value

Remarks

This property controls the size of the following arrays:

tls_client_cert_bytes
tls_client_cert_handle

The array indices start at 0 and end at tls_client_cert_count - 1.

tls_client_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_tls_client_cert_bytes(tls_client_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The tls_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_client_cert_count property.

This property is read-only.

tls_client_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_tls_client_cert_handle(tls_client_cert_index: int) -> int: ...
def set_tls_client_cert_handle(tls_client_cert_index: int, value: int) -> None: ...

Default Value

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.

The tls_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_client_cert_count property.

tls_server_cert_count Property

The number of records in the TLSServerCert arrays.

Syntax

def get_tls_server_cert_count() -> int: ...

tls_server_cert_count = property(get_tls_server_cert_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

tls_server_cert_bytes
tls_server_cert_fingerprint
tls_server_cert_handle
tls_server_cert_issuer
tls_server_cert_issuer_rdn
tls_server_cert_key_algorithm
tls_server_cert_key_bits
tls_server_cert_key_usage
tls_server_cert_self_signed
tls_server_cert_serial_number
tls_server_cert_sig_algorithm
tls_server_cert_subject
tls_server_cert_subject_rdn
tls_server_cert_valid_from
tls_server_cert_valid_to

The array indices start at 0 and end at tls_server_cert_count - 1.

This property is read-only.

tls_server_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_tls_server_cert_bytes(tls_server_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_fingerprint Property

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

def get_tls_server_cert_fingerprint(tls_server_cert_index: int) -> str: ...

Default Value

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_tls_server_cert_handle(tls_server_cert_index: int) -> int: ...

Default Value

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.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_issuer Property

The common name of the certificate issuer (CA), typically a company name.

Syntax

def get_tls_server_cert_issuer(tls_server_cert_index: int) -> str: ...

Default Value

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via tls_issuer_rdn.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_issuer_rdn Property

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

def get_tls_server_cert_issuer_rdn(tls_server_cert_index: int) -> str: ...

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_tls_server_cert_key_algorithm(tls_server_cert_index: int) -> str: ...

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Use the tls_key_bits, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_tls_server_cert_key_bits(tls_server_cert_index: int) -> int: ...

Default Value

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the tls_public_key_bytes or tls_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_key_usage Property

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

def get_tls_server_cert_key_usage(tls_server_cert_index: int) -> int: ...

Default Value

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_self_signed Property

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

def get_tls_server_cert_self_signed(tls_server_cert_index: int) -> bool: ...

Default Value

FALSE

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_tls_server_cert_serial_number(tls_server_cert_index: int) -> bytes: ...

Remarks

Returns the certificate's serial number.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_sig_algorithm Property

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

def get_tls_server_cert_sig_algorithm(tls_server_cert_index: int) -> str: ...

Default Value

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_subject Property

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

def get_tls_server_cert_subject(tls_server_cert_index: int) -> str: ...

Default Value

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via tls_subject_rdn.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_subject_rdn Property

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

def get_tls_server_cert_subject_rdn(tls_server_cert_index: int) -> str: ...

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_valid_from Property

The time point at which the certificate becomes valid, in UTC.

Syntax

def get_tls_server_cert_valid_from(tls_server_cert_index: int) -> str: ...

Default Value

Remarks

The time point at which the certificate becomes valid, in UTC.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_valid_to Property

The time point at which the certificate expires, in UTC.

Syntax

def get_tls_server_cert_valid_to(tls_server_cert_index: int) -> str: ...

Default Value

Remarks

The time point at which the certificate expires, in UTC.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_auto_validate_certificates Property

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

def get_tls_auto_validate_certificates() -> bool: ...
def set_tls_auto_validate_certificates(value: bool) -> None: ...

tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates)

Default Value

TRUE

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

tls_base_configuration Property

Selects the base configuration for the TLS settings.

Syntax

def get_tls_base_configuration() -> int: ...
def set_tls_base_configuration(value: int) -> None: ...

tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration)

Default Value

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.


stpcDefault	`0`
stpcCompatible	`1`
stpcComprehensiveInsecure	`2`
stpcHighlySecure	`3`

tls_ciphersuites Property

A list of ciphersuites separated with commas or semicolons.

Syntax

def get_tls_ciphersuites() -> str: ...
def set_tls_ciphersuites(value: str) -> None: ...

tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites)

Default Value

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by tls_base_configuration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

NULL_NULL_NULL
RSA_NULL_MD5
RSA_NULL_SHA
RSA_RC4_MD5
RSA_RC4_SHA
RSA_RC2_MD5
RSA_IDEA_MD5
RSA_IDEA_SHA
RSA_DES_MD5
RSA_DES_SHA
RSA_3DES_MD5
RSA_3DES_SHA
RSA_AES128_SHA
RSA_AES256_SHA
DH_DSS_DES_SHA
DH_DSS_3DES_SHA
DH_DSS_AES128_SHA
DH_DSS_AES256_SHA
DH_RSA_DES_SHA
DH_RSA_3DES_SHA
DH_RSA_AES128_SHA
DH_RSA_AES256_SHA
DHE_DSS_DES_SHA
DHE_DSS_3DES_SHA
DHE_DSS_AES128_SHA
DHE_DSS_AES256_SHA
DHE_RSA_DES_SHA
DHE_RSA_3DES_SHA
DHE_RSA_AES128_SHA
DHE_RSA_AES256_SHA
DH_ANON_RC4_MD5
DH_ANON_DES_SHA
DH_ANON_3DES_SHA
DH_ANON_AES128_SHA
DH_ANON_AES256_SHA
RSA_RC2_MD5_EXPORT
RSA_RC4_MD5_EXPORT
RSA_DES_SHA_EXPORT
DH_DSS_DES_SHA_EXPORT
DH_RSA_DES_SHA_EXPORT
DHE_DSS_DES_SHA_EXPORT
DHE_RSA_DES_SHA_EXPORT
DH_ANON_RC4_MD5_EXPORT
DH_ANON_DES_SHA_EXPORT
RSA_CAMELLIA128_SHA
DH_DSS_CAMELLIA128_SHA
DH_RSA_CAMELLIA128_SHA
DHE_DSS_CAMELLIA128_SHA
DHE_RSA_CAMELLIA128_SHA
DH_ANON_CAMELLIA128_SHA
RSA_CAMELLIA256_SHA
DH_DSS_CAMELLIA256_SHA
DH_RSA_CAMELLIA256_SHA
DHE_DSS_CAMELLIA256_SHA
DHE_RSA_CAMELLIA256_SHA
DH_ANON_CAMELLIA256_SHA
PSK_RC4_SHA
PSK_3DES_SHA
PSK_AES128_SHA
PSK_AES256_SHA
DHE_PSK_RC4_SHA
DHE_PSK_3DES_SHA
DHE_PSK_AES128_SHA
DHE_PSK_AES256_SHA
RSA_PSK_RC4_SHA
RSA_PSK_3DES_SHA
RSA_PSK_AES128_SHA
RSA_PSK_AES256_SHA
RSA_SEED_SHA
DH_DSS_SEED_SHA
DH_RSA_SEED_SHA
DHE_DSS_SEED_SHA
DHE_RSA_SEED_SHA
DH_ANON_SEED_SHA
SRP_SHA_3DES_SHA
SRP_SHA_RSA_3DES_SHA
SRP_SHA_DSS_3DES_SHA
SRP_SHA_AES128_SHA
SRP_SHA_RSA_AES128_SHA
SRP_SHA_DSS_AES128_SHA
SRP_SHA_AES256_SHA
SRP_SHA_RSA_AES256_SHA
SRP_SHA_DSS_AES256_SHA
ECDH_ECDSA_NULL_SHA
ECDH_ECDSA_RC4_SHA
ECDH_ECDSA_3DES_SHA
ECDH_ECDSA_AES128_SHA
ECDH_ECDSA_AES256_SHA
ECDHE_ECDSA_NULL_SHA
ECDHE_ECDSA_RC4_SHA
ECDHE_ECDSA_3DES_SHA
ECDHE_ECDSA_AES128_SHA
ECDHE_ECDSA_AES256_SHA
ECDH_RSA_NULL_SHA
ECDH_RSA_RC4_SHA
ECDH_RSA_3DES_SHA
ECDH_RSA_AES128_SHA
ECDH_RSA_AES256_SHA
ECDHE_RSA_NULL_SHA
ECDHE_RSA_RC4_SHA
ECDHE_RSA_3DES_SHA
ECDHE_RSA_AES128_SHA
ECDHE_RSA_AES256_SHA
ECDH_ANON_NULL_SHA
ECDH_ANON_RC4_SHA
ECDH_ANON_3DES_SHA
ECDH_ANON_AES128_SHA
ECDH_ANON_AES256_SHA
RSA_NULL_SHA256
RSA_AES128_SHA256
RSA_AES256_SHA256
DH_DSS_AES128_SHA256
DH_RSA_AES128_SHA256
DHE_DSS_AES128_SHA256
DHE_RSA_AES128_SHA256
DH_DSS_AES256_SHA256
DH_RSA_AES256_SHA256
DHE_DSS_AES256_SHA256
DHE_RSA_AES256_SHA256
DH_ANON_AES128_SHA256
DH_ANON_AES256_SHA256
RSA_AES128_GCM_SHA256
RSA_AES256_GCM_SHA384
DHE_RSA_AES128_GCM_SHA256
DHE_RSA_AES256_GCM_SHA384
DH_RSA_AES128_GCM_SHA256
DH_RSA_AES256_GCM_SHA384
DHE_DSS_AES128_GCM_SHA256
DHE_DSS_AES256_GCM_SHA384
DH_DSS_AES128_GCM_SHA256
DH_DSS_AES256_GCM_SHA384
DH_ANON_AES128_GCM_SHA256
DH_ANON_AES256_GCM_SHA384
ECDHE_ECDSA_AES128_SHA256
ECDHE_ECDSA_AES256_SHA384
ECDH_ECDSA_AES128_SHA256
ECDH_ECDSA_AES256_SHA384
ECDHE_RSA_AES128_SHA256
ECDHE_RSA_AES256_SHA384
ECDH_RSA_AES128_SHA256
ECDH_RSA_AES256_SHA384
ECDHE_ECDSA_AES128_GCM_SHA256
ECDHE_ECDSA_AES256_GCM_SHA384
ECDH_ECDSA_AES128_GCM_SHA256
ECDH_ECDSA_AES256_GCM_SHA384
ECDHE_RSA_AES128_GCM_SHA256
ECDHE_RSA_AES256_GCM_SHA384
ECDH_RSA_AES128_GCM_SHA256
ECDH_RSA_AES256_GCM_SHA384
PSK_AES128_GCM_SHA256
PSK_AES256_GCM_SHA384
DHE_PSK_AES128_GCM_SHA256
DHE_PSK_AES256_GCM_SHA384
RSA_PSK_AES128_GCM_SHA256
RSA_PSK_AES256_GCM_SHA384
PSK_AES128_SHA256
PSK_AES256_SHA384
PSK_NULL_SHA256
PSK_NULL_SHA384
DHE_PSK_AES128_SHA256
DHE_PSK_AES256_SHA384
DHE_PSK_NULL_SHA256
DHE_PSK_NULL_SHA384
RSA_PSK_AES128_SHA256
RSA_PSK_AES256_SHA384
RSA_PSK_NULL_SHA256
RSA_PSK_NULL_SHA384
RSA_CAMELLIA128_SHA256
DH_DSS_CAMELLIA128_SHA256
DH_RSA_CAMELLIA128_SHA256
DHE_DSS_CAMELLIA128_SHA256
DHE_RSA_CAMELLIA128_SHA256
DH_ANON_CAMELLIA128_SHA256
RSA_CAMELLIA256_SHA256
DH_DSS_CAMELLIA256_SHA256
DH_RSA_CAMELLIA256_SHA256
DHE_DSS_CAMELLIA256_SHA256
DHE_RSA_CAMELLIA256_SHA256
DH_ANON_CAMELLIA256_SHA256
ECDHE_ECDSA_CAMELLIA128_SHA256
ECDHE_ECDSA_CAMELLIA256_SHA384
ECDH_ECDSA_CAMELLIA128_SHA256
ECDH_ECDSA_CAMELLIA256_SHA384
ECDHE_RSA_CAMELLIA128_SHA256
ECDHE_RSA_CAMELLIA256_SHA384
ECDH_RSA_CAMELLIA128_SHA256
ECDH_RSA_CAMELLIA256_SHA384
RSA_CAMELLIA128_GCM_SHA256
RSA_CAMELLIA256_GCM_SHA384
DHE_RSA_CAMELLIA128_GCM_SHA256
DHE_RSA_CAMELLIA256_GCM_SHA384
DH_RSA_CAMELLIA128_GCM_SHA256
DH_RSA_CAMELLIA256_GCM_SHA384
DHE_DSS_CAMELLIA128_GCM_SHA256
DHE_DSS_CAMELLIA256_GCM_SHA384
DH_DSS_CAMELLIA128_GCM_SHA256
DH_DSS_CAMELLIA256_GCM_SHA384
DH_anon_CAMELLIA128_GCM_SHA256
DH_anon_CAMELLIA256_GCM_SHA384
ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
ECDH_ECDSA_CAMELLIA128_GCM_SHA256
ECDH_ECDSA_CAMELLIA256_GCM_SHA384
ECDHE_RSA_CAMELLIA128_GCM_SHA256
ECDHE_RSA_CAMELLIA256_GCM_SHA384
ECDH_RSA_CAMELLIA128_GCM_SHA256
ECDH_RSA_CAMELLIA256_GCM_SHA384
PSK_CAMELLIA128_GCM_SHA256
PSK_CAMELLIA256_GCM_SHA384
DHE_PSK_CAMELLIA128_GCM_SHA256
DHE_PSK_CAMELLIA256_GCM_SHA384
RSA_PSK_CAMELLIA128_GCM_SHA256
RSA_PSK_CAMELLIA256_GCM_SHA384
PSK_CAMELLIA128_SHA256
PSK_CAMELLIA256_SHA384
DHE_PSK_CAMELLIA128_SHA256
DHE_PSK_CAMELLIA256_SHA384
RSA_PSK_CAMELLIA128_SHA256
RSA_PSK_CAMELLIA256_SHA384
ECDHE_PSK_CAMELLIA128_SHA256
ECDHE_PSK_CAMELLIA256_SHA384
ECDHE_PSK_RC4_SHA
ECDHE_PSK_3DES_SHA
ECDHE_PSK_AES128_SHA
ECDHE_PSK_AES256_SHA
ECDHE_PSK_AES128_SHA256
ECDHE_PSK_AES256_SHA384
ECDHE_PSK_NULL_SHA
ECDHE_PSK_NULL_SHA256
ECDHE_PSK_NULL_SHA384
ECDHE_RSA_CHACHA20_POLY1305_SHA256
ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
DHE_RSA_CHACHA20_POLY1305_SHA256
PSK_CHACHA20_POLY1305_SHA256
ECDHE_PSK_CHACHA20_POLY1305_SHA256
DHE_PSK_CHACHA20_POLY1305_SHA256
RSA_PSK_CHACHA20_POLY1305_SHA256
AES128_GCM_SHA256
AES256_GCM_SHA384
CHACHA20_POLY1305_SHA256
AES128_CCM_SHA256
AES128_CCM8_SHA256

tls_client_auth Property

Enables or disables certificate-based client authentication.

Syntax

def get_tls_client_auth() -> int: ...
def set_tls_client_auth(value: int) -> None: ...

tls_client_auth = property(get_tls_client_auth, set_tls_client_auth)

Default Value

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:


ccatNoAuth	`0`
ccatRequestCert	`1`
ccatRequireCert	`2`

tls_ec_curves Property

Defines the elliptic curves to enable.

Syntax

def get_tls_ec_curves() -> str: ...
def set_tls_ec_curves(value: str) -> None: ...

tls_ec_curves = property(get_tls_ec_curves, set_tls_ec_curves)

Default Value

Remarks

Defines the elliptic curves to enable.

tls_extensions Property

Provides access to TLS extensions.

Syntax

def get_tls_extensions() -> str: ...
def set_tls_extensions(value: str) -> None: ...

tls_extensions = property(get_tls_extensions, set_tls_extensions)

Default Value

Remarks

Provides access to TLS extensions.

tls_force_resume_if_destination_changes Property

Whether to force TLS session resumption when the destination address changes.

Syntax

def get_tls_force_resume_if_destination_changes() -> bool: ...
def set_tls_force_resume_if_destination_changes(value: bool) -> None: ...

tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes)

Default Value

FALSE

Remarks

Whether to force TLS session resumption when the destination address changes.

tls_pre_shared_identity Property

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

def get_tls_pre_shared_identity() -> str: ...
def set_tls_pre_shared_identity(value: str) -> None: ...

tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity)

Default Value

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

tls_pre_shared_key Property

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

def get_tls_pre_shared_key() -> str: ...
def set_tls_pre_shared_key(value: str) -> None: ...

tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key)

Default Value

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

tls_pre_shared_key_ciphersuite Property

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

def get_tls_pre_shared_key_ciphersuite() -> str: ...
def set_tls_pre_shared_key_ciphersuite(value: str) -> None: ...

tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite)

Default Value

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

tls_renegotiation_attack_prevention_mode Property

Selects the renegotiation attack prevention mechanism.

Syntax

def get_tls_renegotiation_attack_prevention_mode() -> int: ...
def set_tls_renegotiation_attack_prevention_mode(value: int) -> None: ...

tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode)

Default Value

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:


crapmCompatible	`0`	TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict	`1`	Renegotiation attack prevention is enabled and enforced.
crapmAuto	`2`	Automatically choose whether to enable or disable renegotiation attack prevention.

tls_revocation_check Property

Specifies the kind(s) of revocation check to perform.

Syntax

def get_tls_revocation_check() -> int: ...
def set_tls_revocation_check(value: int) -> None: ...

tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check)

Default Value

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.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

tls_ssl_options Property

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

def get_tls_ssl_options() -> int: ...
def set_tls_ssl_options(value: int) -> None: ...

tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options)

Default Value

Remarks

Various SSL (TLS) protocol options, set of


cssloExpectShutdownMessage	`0x001`	Wait for the close-notify message when shutting down the connection
cssloOpenSSLDTLSWorkaround	`0x002`	(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions
cssloDisableKexLengthAlignment	`0x004`	Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.
cssloForceUseOfClientCertHashAlg	`0x008`	Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add the server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.
cssloIntolerateHigherProtocolVersions	`0x080`	(server option) Do not allow fallback from TLS versions higher than currently enabled
cssloStickToPrefCertHashAlg	`0x100`	Stick to preferred certificate hash algorithms
cssloNoImplicitTLS12Fallback	`0x200`	Disable implicit TLS 1.3 to 1.2 fallbacks
cssloUseHandshakeBatches	`0x400`	Send the handshake message as large batches rather than individually

tls_tls_mode Property

Specifies the TLS mode to use.

Syntax

def get_tls_tls_mode() -> int: ...
def set_tls_tls_mode(value: int) -> None: ...

tls_tls_mode = property(get_tls_tls_mode, set_tls_tls_mode)

Default Value

Remarks

Specifies the TLS mode to use.


smDefault	`0`
smNoTLS	`1`	Do not use TLS
smExplicitTLS	`2`	Connect to the server without any encryption and then request an SSL session.
smImplicitTLS	`3`	Connect to the specified port, and establish the SSL session at once.
smMixedTLS	`4`	Connect to the specified port, and establish the SSL session at once, but allow plain data.

tls_use_extended_master_secret Property

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

def get_tls_use_extended_master_secret() -> bool: ...
def set_tls_use_extended_master_secret(value: bool) -> None: ...

tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret)

Default Value

FALSE

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

tls_use_session_resumption Property

Enables or disables the TLS session resumption capability.

Syntax

def get_tls_use_session_resumption() -> bool: ...
def set_tls_use_session_resumption(value: bool) -> None: ...

tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption)

Default Value

FALSE

Remarks

Enables or disables the TLS session resumption capability.

tls_versions Property

The SSL/TLS versions to enable by default.

Syntax

def get_tls_versions() -> int: ...
def set_tls_versions(value: int) -> None: ...

tls_versions = property(get_tls_versions, set_tls_versions)

Default Value

Remarks

The SSL/TLS versions to enable by default.


csbSSL2	`0x01`	SSL 2
csbSSL3	`0x02`	SSL 3
csbTLS1	`0x04`	TLS 1.0
csbTLS11	`0x08`	TLS 1.1
csbTLS12	`0x10`	TLS 1.2
csbTLS13	`0x20`	TLS 1.3

trusted_cert_count Property

The number of records in the TrustedCert arrays.

Syntax

def get_trusted_cert_count() -> int: ...
def set_trusted_cert_count(value: int) -> None: ...

trusted_cert_count = property(get_trusted_cert_count, set_trusted_cert_count)

Default Value

Remarks

This property controls the size of the following arrays:

trusted_cert_bytes
trusted_cert_handle

The array indices start at 0 and end at trusted_cert_count - 1.

trusted_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_trusted_cert_bytes(trusted_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

This property is read-only.

trusted_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_trusted_cert_handle(trusted_cert_index: int) -> int: ...
def set_trusted_cert_handle(trusted_cert_index: int, value: int) -> None: ...

Default Value

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.

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

used_cert_count Property

The number of records in the UsedCert arrays.

Syntax

def get_used_cert_count() -> int: ...

used_cert_count = property(get_used_cert_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

used_cert_bytes
used_cert_ca
used_cert_ca_key_id
used_cert_cert_type
used_cert_crl_distribution_points
used_cert_curve
used_cert_fingerprint
used_cert_friendly_name
used_cert_handle
used_cert_hash_algorithm
used_cert_issuer
used_cert_issuer_rdn
used_cert_key_algorithm
used_cert_key_bits
used_cert_key_fingerprint
used_cert_key_usage
used_cert_key_valid
used_cert_ocsp_locations
used_cert_ocsp_no_check
used_cert_origin
used_cert_policy_i_ds
used_cert_private_key_bytes
used_cert_private_key_exists
used_cert_private_key_extractable
used_cert_public_key_bytes
used_cert_qualified
used_cert_qualified_statements
used_cert_qualifiers
used_cert_self_signed
used_cert_serial_number
used_cert_sig_algorithm
used_cert_source
used_cert_subject
used_cert_subject_alternative_name
used_cert_subject_key_id
used_cert_subject_rdn
used_cert_valid
used_cert_valid_from
used_cert_valid_to

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

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 property.

This property is read-only.

used_cert_ca Property

Indicates whether the certificate has a CA capability.

Syntax

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 property.

This property is read-only.

used_cert_ca_key_id Property

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

def get_used_cert_ca_key_id(used_cert_index: int) -> bytes: ...

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the used_cert_subject_key_id 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 property.

This property is read-only.

used_cert_cert_type Property

Returns the type of the entity contained in the Certificate object.

Syntax

def get_used_cert_cert_type(used_cert_index: int) -> int: ...

Default Value

Remarks

Returns the type of the entity contained in the Certificate object.

Use the 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 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

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 property.

This property is read-only.

used_cert_curve Property

Specifies the elliptic curve associated with the certificate's public key.

Syntax

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 property.

This property is read-only.

used_cert_fingerprint Property

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

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 property.

This property is read-only.

used_cert_friendly_name Property

Contains an associated alias (friendly name) of the certificate.

Syntax

def get_used_cert_friendly_name(used_cert_index: int) -> str: ...

Default Value

Remarks

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 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

def get_used_cert_handle(used_cert_index: int) -> int: ...

Default Value

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.

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 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

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 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 property.

This property is read-only.

used_cert_issuer Property

The common name of the certificate issuer (CA), typically a company name.

Syntax

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.

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 property.

This property is read-only.

used_cert_issuer_rdn Property

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

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 property.

This property is read-only.

used_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

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`

Use the used_cert_key_bits, used_cert_curve, and used_cert_public_key_bytes 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 property.

This property is read-only.

used_cert_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_used_cert_key_bits(used_cert_index: int) -> int: ...

Default Value

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 or used_cert_private_key_bytes 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 property.

This property is read-only.

used_cert_key_fingerprint Property

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

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 property. The key fingeprint 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 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

def get_used_cert_key_usage(used_cert_index: int) -> int: ...

Default Value

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 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

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 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

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 method to propagate it 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 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

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 property.

This property is read-only.

used_cert_origin Property

Returns the location that the certificate was taken or loaded from.

Syntax

def get_used_cert_origin(used_cert_index: int) -> int: ...

Default Value

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 property.

This property is read-only.

used_cert_policy_i_ds Property

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

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 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 property.

This property is read-only.

used_cert_private_key_bytes Property

Returns the certificate's private key in DER-encoded format.

Syntax

def get_used_cert_private_key_bytes(used_cert_index: int) -> bytes: ...

Remarks

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 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

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, 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 property.

This property is read-only.

used_cert_private_key_extractable Property

Indicates whether the private key is extractable (exportable).

Syntax

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 property.

This property is read-only.

used_cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

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 property.

This property is read-only.

used_cert_qualified Property

Indicates whether the certificate is qualified.

Syntax

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 property.

This property is read-only.

used_cert_qualified_statements Property

Returns a simplified qualified status of the certificate.

Syntax

def get_used_cert_qualified_statements(used_cert_index: int) -> int: ...

Default Value

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 property.

This property is read-only.

used_cert_qualifiers Property

A list of qualifiers.

Syntax

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 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

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 property.

This property is read-only.

used_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_used_cert_serial_number(used_cert_index: int) -> bytes: ...

Remarks

Returns the certificate's serial number.

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 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

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 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

def get_used_cert_source(used_cert_index: int) -> int: ...

Default Value

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 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

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.

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 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

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 field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

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 property.

This property is read-only.

used_cert_subject_key_id Property

Contains a unique identifier of the certificate's cryptographic key.

Syntax

def get_used_cert_subject_key_id(used_cert_index: int) -> bytes: ...

Remarks

Contains a unique identifier of the certificate's cryptographic key.

The used_cert_subject_key_id and used_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The 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 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

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).

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 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

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 property.

This property is read-only.

used_cert_valid_from Property

The time point at which the certificate becomes valid, in UTC.

Syntax

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 property.

This property is read-only.

used_cert_valid_to Property

The time point at which the certificate expires, in UTC.

Syntax

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 property.

This property is read-only.

used_crl_count Property

The number of records in the UsedCRL arrays.

Syntax

def get_used_crl_count() -> int: ...

used_crl_count = property(get_used_crl_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

used_crl_bytes
used_crl_handle
used_crl_issuer
used_crl_issuer_rdn
used_crl_location
used_crl_next_update
used_crl_source
used_crl_this_update

The array indices start at 0 and end at used_crl_count - 1.

This property is read-only.

used_crl_bytes Property

Returns the raw CRL data in DER format.

Syntax

def get_used_crl_bytes(used_crl_index: int) -> bytes: ...

Remarks

Returns the raw CRL data in DER format.

The used_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_crl_count property.

This property is read-only.

used_crl_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_used_crl_handle(used_crl_index: int) -> int: ...

Default Value

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.

The used_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_crl_count property.

This property is read-only.

used_crl_issuer Property

The common name of the CRL issuer (CA), typically a company name.

Syntax

def get_used_crl_issuer(used_crl_index: int) -> str: ...

Default Value

Remarks

The common name of the CRL issuer (CA), typically a company name.

The used_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_crl_count property.

This property is read-only.

used_crl_issuer_rdn Property

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.

Syntax

def get_used_crl_issuer_rdn(used_crl_index: int) -> str: ...

Default Value

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.

The used_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_crl_count property.

This property is read-only.

used_crl_location Property

The URL that the CRL was downloaded from.

Syntax

def get_used_crl_location(used_crl_index: int) -> str: ...

Default Value

Remarks

The URL that the CRL was downloaded from.

The used_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_crl_count property.

This property is read-only.

used_crl_next_update Property

The planned time and date of the next version of this CRL to be published.

Syntax

def get_used_crl_next_update(used_crl_index: int) -> str: ...

Default Value

Remarks

The planned time and date of the next version of this CRL to be published.

The used_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_crl_count property.

This property is read-only.

used_crl_source Property

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

def get_used_crl_source(used_crl_index: int) -> int: ...

Default Value

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The used_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_crl_count property.

This property is read-only.

used_crl_this_update Property

The date and time at which this version of the CRL was published.

Syntax

def get_used_crl_this_update(used_crl_index: int) -> str: ...

Default Value

Remarks

The date and time at which this version of the CRL was published.

The used_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_crl_count property.

This property is read-only.

used_ocsp_count Property

The number of records in the UsedOCSP arrays.

Syntax

def get_used_ocsp_count() -> int: ...

used_ocsp_count = property(get_used_ocsp_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

used_ocsp_bytes
used_ocsp_handle
used_ocsp_issuer
used_ocsp_issuer_rdn
used_ocsp_location
used_ocsp_produced_at
used_ocsp_source

The array indices start at 0 and end at used_ocsp_count - 1.

This property is read-only.

used_ocsp_bytes Property

A buffer containing the raw OCSP response data.

Syntax

def get_used_ocsp_bytes(used_ocsp_index: int) -> bytes: ...

Remarks

A buffer containing the raw OCSP response data.

The used_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_ocsp_count property.

This property is read-only.

used_ocsp_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_used_ocsp_handle(used_ocsp_index: int) -> int: ...

Default Value

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.

The used_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_ocsp_count property.

This property is read-only.

used_ocsp_issuer Property

Indicates the issuer of this response (a CA or its authorized representative).

Syntax

def get_used_ocsp_issuer(used_ocsp_index: int) -> str: ...

Default Value

Remarks

Indicates the issuer of this response (a CA or its authorized representative).

The used_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_ocsp_count property.

This property is read-only.

used_ocsp_issuer_rdn Property

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

Syntax

def get_used_ocsp_issuer_rdn(used_ocsp_index: int) -> str: ...

Default Value

Remarks

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

The used_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_ocsp_count property.

This property is read-only.

used_ocsp_location Property

The location of the OCSP responder.

Syntax

def get_used_ocsp_location(used_ocsp_index: int) -> str: ...

Default Value

Remarks

The location of the OCSP responder.

The used_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_ocsp_count property.

This property is read-only.

used_ocsp_produced_at Property

Specifies the time when the response was produced, in UTC.

Syntax

def get_used_ocsp_produced_at(used_ocsp_index: int) -> str: ...

Default Value

Remarks

Specifies the time when the response was produced, in UTC.

The used_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_ocsp_count property.

This property is read-only.

used_ocsp_source Property

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

def get_used_ocsp_source(used_ocsp_index: int) -> int: ...

Default Value

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The used_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the used_ocsp_count property.

This property is read-only.

use_system_certificates Property

Enables or disables the use of the system certificates.

Syntax

def get_use_system_certificates() -> bool: ...
def set_use_system_certificates(value: bool) -> None: ...

use_system_certificates = property(get_use_system_certificates, set_use_system_certificates)

Default Value

FALSE

Remarks

Use this property to tell the validator to use (or not to use) 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.

validation_log Property

Contains the complete log of the certificate validation routine.

Syntax

def get_validation_log() -> str: ...

validation_log = property(get_validation_log, None)

Default Value

Remarks

Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.

This property is read-only.

validation_moment Property

The time point at which chain validity is to be established.

Syntax

def get_validation_moment() -> str: ...
def set_validation_moment(value: str) -> None: ...

validation_moment = property(get_validation_moment, set_validation_moment)

Default Value

Remarks

Use this property to specify the moment in time at which chain validity should be established. The time is in UTC. Leave the setting empty to stick to the current moment.

The validity of the same chain may differ depending on the time point chosen due to temporal changes in subchain validities and revocation statuses.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

get_qualified_status Method

Obtains the qualified information for Certificate .

Syntax

def get_qualified_status() -> None: ...

Remarks

Use this method to obtain a fresh qualified status for the certificate.

get_trusted_list_property Method

Returns a specific TrustedList property.

Syntax

def get_trusted_list_property(prop_name: str, language: str) -> str: ...

Remarks

Use this method to obtain the value of a specific TrustedList property. Use the Language parameter to specify the language identifier (e.g. it) in which you would like to have the property returned (if supported by the TrustedList). Leave the parameter empty to return the value in the default language.

Please find a list of common TrustedList properties below:

VersionIdentifier
SequenceNumber
Type
SchemeName
SchemeOperatorName
SchemeOperatorAddress
SchemeInformationURI
StatusDeterminationApproach
SchemeTypeCommunityRules
SchemeTerritory
Policies
LegalNotices
HistoricalInformationPeriod
ListIssueDateTime
NextUpdate
DistributionPoints
SchemeExtensions
TSPXML
TSPName
TSPTradeName
TSPInformationURI
TSPAddress
TSPInformationExtensions
TSPServiceXML
TSPServiceTypeIdentifier
TSPServiceName
TSPServiceStatus
TSPServiceStatusStartingTime
TSPSchemeServiceDefinitionURI
TSPServiceDefinitionURI
TSPServiceSupplyPoints
TSPServiceInformationExtensions
TSPServiceQualifiers
TSPAdditionalServiceInformation
TSPHistoryInstance
TSPHistoryInstanceXML
TSPHistoryInstanceServiceTypeIdentifier
TSPHistoryInstanceServiceName
TSPHistoryInstanceServiceStatus
TSPHistoryInstanceServiceStatusStartingTime
TSPHistoryInstanceServiceInformationExtensions
TSPHistoryInstanceQualifiers
TSPHistoryInstanceAdditionalServiceInformation

refresh_cache Method

Refreshes the certificate cache.

Syntax

def refresh_cache() -> None: ...

Remarks

Use this method to remove obsolete information from the validation cache (only makes sense if cache_validation_results is on).

reset Method

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

reset_cache Method

Clears all data contained in the validation cache.

Syntax

def reset_cache() -> None: ...

Remarks

Use this method to clear the validation cache (only makes sense if cache_validation_results is on).

terminate Method

Terminates the validation process.

Syntax

def terminate() -> None: ...

Remarks

Call this method if you would like to stop the validation process.

validate Method

Validates the certificate chain.

Syntax

def validate() -> int: ...

Remarks

Use this method to validate the certificate chain that starts with certificate.

The chain validation is a multi-step process which includes validation of each certificate in the chain up to the trusted anchor. The ultimate goal of this process is to establish the integrity of the chain and its trustworthiness.

Depending on the component tuneup, the validation process may differ drastically, even for the same certificate: it may be more or less rigorous, may include or exclude revocation checks, and may be more or less tolerant to minor chain issues.

When this process is completed, the final decision on the validity of the checked certificate is returned from this method, and also saved in chain_validation_result property. Another property, chain_validation_details, provides insight into the reasons that contributed to that decision. Use validation_log to get a detailed step-by-step log of the entire validation process.

validate_for_smime Method

Validates an e-mail signing certificate.

Syntax

def validate_for_smime(email_address: str) -> int: ...

Remarks

Use this method to validate an e-mail security certificate.

This is a variant of validate method that performs some additional e-mail specific checks, imposed by e-mail certificate rules. This method returns the overall chain validation result.

validate_for_ssl Method

Validates a server-side SSL/TLS certificate.

Syntax

def validate_for_ssl(url: str, ip_address: str) -> int: ...

Remarks

Use this method to validate a server-side SSL/TLS certificate.

This is a variant of validate method that performs some additional TLS-specific checks. It is important that you provide a correct URL or IPAddress for the check to return a reasonable and justified result.

This method returns the overall result of the chain validation.

on_after_certificate_processing Event

Marks the end of a single certificate processing step.

Syntax

class CertificateValidatorAfterCertificateProcessingEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def validity() -> int: ...

  @property
  def validation_details() -> int: ...

# In class CertificateValidator:
@property
def on_after_certificate_processing() -> Callable[[CertificateValidatorAfterCertificateProcessingEventParams], None]: ...
@on_after_certificate_processing.setter
def on_after_certificate_processing(event_hook: Callable[[CertificateValidatorAfterCertificateProcessingEventParams], None]) -> None: ...

Remarks

This event is fired when the class has finished processing Cert, and returns its Validity status and ValidationDetails.

'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via on_after_certificate_validation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.

You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via interim_validation_result and interim_validation_details properties.

Validity status:


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)

Validation details:


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_after_certificate_validation Event

Marks the end of a single certificate validation step.

Syntax

class CertificateValidatorAfterCertificateValidationEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def ca_cert() -> str: ...

  @property
  def validity() -> int: ...

  @property
  def validation_details() -> int: ...

# In class CertificateValidator:
@property
def on_after_certificate_validation() -> Callable[[CertificateValidatorAfterCertificateValidationEventParams], None]: ...
@on_after_certificate_validation.setter
def on_after_certificate_validation(event_hook: Callable[[CertificateValidatorAfterCertificateValidationEventParams], None]) -> None: ...

Remarks

This event is fired when the class has finished validation of Cert with CACert, and returns its Validity status and ValidationDetails.

'Validation', in this context, means a single validation of a certificate with its CA certificate. For certificates with multiple CAs, validations are grouped into 'processings.' Each processing, therefore, is a set of validations of the same certificate with all its CAs.

Validity status:


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)

Validation details:


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_before_ca_certificate_download Event

Fires when a CA certificate is about to be downloaded.

Syntax

class CertificateValidatorBeforeCACertificateDownloadEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def location() -> str: ...

# In class CertificateValidator:
@property
def on_before_ca_certificate_download() -> Callable[[CertificateValidatorBeforeCACertificateDownloadEventParams], None]: ...
@on_before_ca_certificate_download.setter
def on_before_ca_certificate_download(event_hook: Callable[[CertificateValidatorBeforeCACertificateDownloadEventParams], None]) -> None: ...

Remarks

This event is fired when a CA certificate that is needed to validate Cert is about to be downloaded from Location.

on_before_certificate_processing Event

Reports the start of certificate processing.

Syntax

class CertificateValidatorBeforeCertificateProcessingEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def validity() -> int: ...

  @property
  def validation_details() -> int: ...

# In class CertificateValidator:
@property
def on_before_certificate_processing() -> Callable[[CertificateValidatorBeforeCertificateProcessingEventParams], None]: ...
@on_before_certificate_processing.setter
def on_before_certificate_processing(event_hook: Callable[[CertificateValidatorBeforeCertificateProcessingEventParams], None]) -> None: ...

Remarks

This event is fired when the class is about to start the processing of Cert.

The firing of on_after_certificate_processing marks the end of the certificate processing.

Validity and ValidationDetails specify the current validation status.

Validity status:


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)

Validation details:


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_before_certificate_validation Event

Reports the start of certificate validation.

Syntax

class CertificateValidatorBeforeCertificateValidationEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def ca_cert() -> str: ...

# In class CertificateValidator:
@property
def on_before_certificate_validation() -> Callable[[CertificateValidatorBeforeCertificateValidationEventParams], None]: ...
@on_before_certificate_validation.setter
def on_before_certificate_validation(event_hook: Callable[[CertificateValidatorBeforeCertificateValidationEventParams], None]) -> None: ...

Remarks

This event is fired when the class is about to start validating Cert with CACert.

A 'validation' is a single step of validating a certificate with its CA certificate. A row of consecutive validations of the same certificate with different CAs are grouped into 'processings.'

The firing of on_after_certificate_validation marks the end of the certificate validation step.

on_before_crl_download Event

Fires when a CRL is about to be downloaded.

Syntax

class CertificateValidatorBeforeCRLDownloadEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def ca_cert() -> str: ...

  @property
  def location() -> str: ...

# In class CertificateValidator:
@property
def on_before_crl_download() -> Callable[[CertificateValidatorBeforeCRLDownloadEventParams], None]: ...
@on_before_crl_download.setter
def on_before_crl_download(event_hook: Callable[[CertificateValidatorBeforeCRLDownloadEventParams], None]) -> None: ...

Remarks

This event is fired when a CRL (Certificate Revocation List) needed to validate Cert is going to be downloaded from Location.

on_before_ocsp_download Event

Fires when a certificate's OCSP status is about to be requested.

Syntax

class CertificateValidatorBeforeOCSPDownloadEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def ca_cert() -> str: ...

  @property
  def location() -> str: ...

# In class CertificateValidator:
@property
def on_before_ocsp_download() -> Callable[[CertificateValidatorBeforeOCSPDownloadEventParams], None]: ...
@on_before_ocsp_download.setter
def on_before_ocsp_download(event_hook: Callable[[CertificateValidatorBeforeOCSPDownloadEventParams], None]) -> None: ...

Remarks

This event is fired when the validator is about to request a fresh revocation status from an OCSP responder.

on_ca_certificate_downloaded Event

Marks the success of a certificate download.

Syntax

class CertificateValidatorCACertificateDownloadedEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def location() -> str: ...

# In class CertificateValidator:
@property
def on_ca_certificate_downloaded() -> Callable[[CertificateValidatorCACertificateDownloadedEventParams], None]: ...
@on_ca_certificate_downloaded.setter
def on_ca_certificate_downloaded(event_hook: Callable[[CertificateValidatorCACertificateDownloadedEventParams], None]) -> None: ...

Remarks

This event is fired when a CA certificate has been successfully downloaded from Location. This event is preceded with on_before_ca_certificate_download event.

on_ca_certificate_needed Event

Requests a missing certificate from the user.

Syntax

class CertificateValidatorCACertificateNeededEventParams(object):
  @property
  def cert() -> str: ...

# In class CertificateValidator:
@property
def on_ca_certificate_needed() -> Callable[[CertificateValidatorCACertificateNeededEventParams], None]: ...
@on_ca_certificate_needed.setter
def on_ca_certificate_needed(event_hook: Callable[[CertificateValidatorCACertificateNeededEventParams], None]) -> None: ...

Remarks

This event is fired when a CA certificate that is needed to validate Cert is not found at any of the available locations. If you have access to the missing certificate, please add it to the known_certificates collection to make it available to the validator.

When this event fires, the current_certificate property is assigned with the certificate being validated. It is the CA that issued that certificate that the validator is looking for.

on_crl_downloaded Event

Marks the success of a CRL download.

Syntax

class CertificateValidatorCRLDownloadedEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def ca_cert() -> str: ...

  @property
  def location() -> str: ...

# In class CertificateValidator:
@property
def on_crl_downloaded() -> Callable[[CertificateValidatorCRLDownloadedEventParams], None]: ...
@on_crl_downloaded.setter
def on_crl_downloaded(event_hook: Callable[[CertificateValidatorCRLDownloadedEventParams], None]) -> None: ...

Remarks

This event is fired when a CRL containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with on_before_crl_download event.

on_crl_needed Event

Requests a missing CRL from the user.

Syntax

class CertificateValidatorCRLNeededEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def ca_cert() -> str: ...

# In class CertificateValidator:
@property
def on_crl_needed() -> Callable[[CertificateValidatorCRLNeededEventParams], None]: ...
@on_crl_needed.setter
def on_crl_needed(event_hook: Callable[[CertificateValidatorCRLNeededEventParams], None]) -> None: ...

Remarks

This event is fired when a CRL that is needed to validate Cert is not found at any of the available locations. If you have access to the missing CRL, please add it to the known_crls collection to make it available to the validator.

When this event fires, the current_certificate and current_ca_certificate properties are assigned with the certificate being validated and its issuer certificate.

on_error Event

Information about errors during certificate validation.

Syntax

class CertificateValidatorErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class CertificateValidator:
@property
def on_error() -> Callable[[CertificateValidatorErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[CertificateValidatorErrorEventParams], None]) -> None: ...

Remarks

The event is fired in case of exceptional conditions during certificate processing or online information retrieval.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the corresponding section.

on_notification Event

This event notifies the application about an underlying control flow event.

Syntax

class CertificateValidatorNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class CertificateValidator:
@property
def on_notification() -> Callable[[CertificateValidatorNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[CertificateValidatorNotificationEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:


DownloadTSL	This event is fired if a Trusted List is requested. The EventParam parameter contains the URL value from where to retrieve the TrustedList. The downloaded Trusted List content should be assigned to the TSLContent or TSLContentHex configuration settings. The class automatically downloads Trusted List if offline_mode is disabled and no Trusted List content is provided. It is important to note that if you are caching the Trusted List content, you should check the NextUpdate field of the Trusted List and update it in a timely manner, otherwise the outdated Trusted List will be discarded.
StoreTSL	This event is fired if the Trusted List should be stored for offline usage. The EventParam parameter contains the URL value from where the Trusted List was retrieved. The TrustedList content could be read using TSLContent or TSLContentHex configuration settings.

on_ocsp_downloaded Event

Marks the success of an OCSP request.

Syntax

class CertificateValidatorOCSPDownloadedEventParams(object):
  @property
  def cert() -> str: ...

  @property
  def ca_cert() -> str: ...

  @property
  def location() -> str: ...

# In class CertificateValidator:
@property
def on_ocsp_downloaded() -> Callable[[CertificateValidatorOCSPDownloadedEventParams], None]: ...
@on_ocsp_downloaded.setter
def on_ocsp_downloaded(event_hook: Callable[[CertificateValidatorOCSPDownloadedEventParams], None]) -> None: ...

Remarks

This event is fired when an OCSP response containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with on_before_ocsp_download event.

on_tls_cert_needed Event

Fires when a remote TLS party requests a client certificate.

Syntax

class CertificateValidatorTLSCertNeededEventParams(object):
  @property
  def host() -> str: ...

  @property
  def ca_names() -> str: ...

# In class CertificateValidator:
@property
def on_tls_cert_needed() -> Callable[[CertificateValidatorTLSCertNeededEventParams], None]: ...
@on_tls_cert_needed.setter
def on_tls_cert_needed(event_hook: Callable[[CertificateValidatorTLSCertNeededEventParams], None]) -> None: ...

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the tls_client_chain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the on_tls_handshake event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.

on_tls_cert_validate Event

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

class CertificateValidatorTLSCertValidateEventParams(object):
  @property
  def server_host() -> str: ...

  @property
  def server_ip() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class CertificateValidator:
@property
def on_tls_cert_validate() -> Callable[[CertificateValidatorTLSCertValidateEventParams], None]: ...
@on_tls_cert_validate.setter
def on_tls_cert_validate(event_hook: Callable[[CertificateValidatorTLSCertValidateEventParams], None]) -> None: ...

Remarks

This event is fired during a TLS handshake. Use the tls_server_chain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

on_tls_established Event

Fires when a TLS handshake with Host successfully completes.

Syntax

class CertificateValidatorTLSEstablishedEventParams(object):
  @property
  def host() -> str: ...

  @property
  def version() -> str: ...

  @property
  def ciphersuite() -> str: ...

  @property
  def connection_id() -> bytes: ...

  @property
  def abort() -> bool: ...
  @abort.setter
  def abort(value) -> None: ...

# In class CertificateValidator:
@property
def on_tls_established() -> Callable[[CertificateValidatorTLSEstablishedEventParams], None]: ...
@on_tls_established.setter
def on_tls_established(event_hook: Callable[[CertificateValidatorTLSEstablishedEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

on_tls_handshake Event

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

class CertificateValidatorTLSHandshakeEventParams(object):
  @property
  def host() -> str: ...

  @property
  def abort() -> bool: ...
  @abort.setter
  def abort(value) -> None: ...

# In class CertificateValidator:
@property
def on_tls_handshake() -> Callable[[CertificateValidatorTLSHandshakeEventParams], None]: ...
@on_tls_handshake.setter
def on_tls_handshake(event_hook: Callable[[CertificateValidatorTLSHandshakeEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the on_tls_established event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.

on_tls_shutdown Event

Reports the graceful closure of a TLS connection.

Syntax

class CertificateValidatorTLSShutdownEventParams(object):
  @property
  def host() -> str: ...

# In class CertificateValidator:
@property
def on_tls_shutdown() -> Callable[[CertificateValidatorTLSShutdownEventParams], None]: ...
@on_tls_shutdown.setter
def on_tls_shutdown(event_hook: Callable[[CertificateValidatorTLSShutdownEventParams], None]) -> None: ...

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

CertificateValidator Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

CertificateValidator Config Settings

CacheValidityTime: Time period during which to keep validation cache.

The validity period of the cached validation results in milliseconds.

CheckStrongAlgorithmForTrusted: Whether to check a 'strong' hash algorithm for trusted certificates.

Whether to check a 'strong' hash algorithm for trusted certificates.

CheckValidityPeriodForTrusted: Whether to check validity period for trusted certificates.

Whether to check validity period for trusted certificates.

CrossCertificationValidationStrategy: Defines how the cross certification validation is performed.

This property tells the class how to perform the cross certification validation. Supported values: csvSmart = 0 csvOptimistic = 1 csvPessimistic = 2 csvNoCrossCertification = 3

In the optimistic strategy, positive validation results are kept, and negative ones are ignored. If there are no good certificates in the chain, the validation proceeds using self-signed certificates. Smart is the same as optimistic.

In the pessimistic strategy, even one negative validation result makes the whole process to fail.

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).

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.

ForceRevocationCheckForRoot: Whether to check revocation info for root certificates.

Specifies if revocation information should be checked for the root certificate.

IgnoreBadOCSPChains: Whether to ignore bad OCSP chains during validation.

Whether to ignore bad OCSP chains during validation.

IgnoreCABasicConstraints: Whether to ignore the Basic Constraints extension for the CA certificates.

Whether to ignore the Basic Constraints extension for the CA certificates.

IgnoreCAKeyUsage: Whether to ignore Key Usage extension for CA certificates.

Whether to ignore Key Usage extension for CA certificates.

IgnoreCANameConstraints: Whether to ignore the Name Constraints extension for the CA certificates.

Whether to ignore the Name Constraints extension for the CA certificates.

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.

IgnoreCRLIssuerKeyID: Tells the validator to ignore malformed CRL issuer key IDs.

Another compatibility/tolerance tweak that tells the validator to ignore the issuer key identifier values recorded in the processed CRLs (occasionally it is recorded there wrongly).

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.

IgnoreRevocationKeyUsage: Whether to check the CA certs used to sign revocation info.

Whether the issuer (CA) certificates should be checked if their key usage extension (when available) allows using them to sign revocation information.

IgnoreSSLKeyUsage: Whether to check the CA certs used in SSL/TLS.

Whether the issuer (CA) certificates should be checked if their key usage extension (when available) allows using these certificates in SSL protocol communications.

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 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.

LookupCRLByNameIfDPNotPresent: Whether to look for implicit CRL Distribution Points.

Whether to look for implicit CRL Distribution Points (DPs) if no DPs are available.

PromoteLongOCSPResponses: Whether long OCSP responses are requested.

Set this property to True to force the class to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

RevocationMomentGracePeriod: Grace period for revocation information propagation.

Use this property to specify the grace period (in seconds). Grace period allows the certificate revocation information to propagate through the revocation process.

SkipSubjectNameIfAltNameExists: Whether to check CommonName if SubjectAltName is present.

RFC 6125 requires that the SubjectAltName (SAN) extension should be checked if it is present. In such case, SubjectName.CommonName (CN) should not be checked. This contradicts to some existing certificates where, for instance, CN contains "a.com" and SAN is "www.a.com".

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.

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.

ValidateInvalidCertificates: Whether to do all checks on invalid certificates.

If ValidateInvalidCertificates is True and certain certificate check determines that the certificate is not valid, further checks are done anyway. This allows to create a full validation report.

When ValidateInvalidCertificates is False and a certificate is found to be not valid, further checks of this certificate are not performed.

WeakAlgorithmHandlingMode: How to handle certificates signed with a 'weak' hash algorithm.

Defines how to handle the certificates signed using a 'weak' hash algorithm.

Supported values: wahmIgnore = 0 wahmWarning = 1 wahmError = 2

TrustedLists Config Settings

CustomTrustedLists: Specifies the custom TrustedLists.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

CustomTSLs: Specifies the custom TrustedLists.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

DistributionPoints: Contains XML content of distribution points of the TSL used.

Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate.

HistoricalInformationPeriod: Contains historical information period of the TSL used.

Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate.

LegalNotices: Contains XML content of legal notices of the TSL used.

Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate.

ListIssueDateTime: Contains list issue date and time of the TSL used.

Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate.

NextUpdate: Contains next update date and time of the TSL used.

Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate.

Policies: Contains XML content of policies of the TSL used.

Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate.

QualifiedStatus: Indicates a qualified electronic signature.

Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate. This property return TSP service status URI.

SchemeExtensions: Contains XML content of scheme extensions of the TSL used.

Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate.

SchemeInformationURI: Contains XML content of scheme information URI of the TSL used.

Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate.

SchemeName: Contains XML content of scheme name of the TSL used.

Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate.

SchemeOperatorAddress: Contains XML content of scheme operator address of the TSL used.

Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate.

SchemeOperatorName: Contains XML content of scheme operator name of the TSL used.

Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate.

SchemeTerritory: Contains scheme territory of the TSL used.

Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate.

SchemeTypeCommunityRules: Contains XML content of scheme type/community/rules of the TSL used.

Use this property to get XML content of multilingual scheme type/community/rules of the TSL used to obtain the qualified status of the certificate.

SequenceNumber: Contains sequence number of the TSL used.

Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate.

StatusDeterminationApproach: Contains status determination approach of the TSL used.

Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate.

TSLContent: Specifies the TrustedList content.

Assign or read this property in your on_notification event handler with the Trusted List content.

TSLContentHex: Specifies the TrustedList content.

Assign or read this property in your on_notification event handler with the Trusted List content in Hex encoding.

TSLDistributionPoints: Contains XML content of distribution points of the TSL used.

Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate.

TSLDistributionPoints[Idx]: Contains distribution point of the specified index of the TSL used.

Use this property to get distribution point of the specified index of the TSL used to obtain the qualified status of the certificate.

TSLHistoricalInformationPeriod: Contains historical information period of the TSL used.

Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate.

TSLLegalNotices: Contains XML content of legal notices of the TSL used.

Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate.

TSLLegalNotices[lang]: Contains legal notices for the specified language of the TSL used.

Use this property to get legal notices for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLListIssueDateTime: Contains list issue date and time of the TSL used.

Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate.

TSLNextUpdate: Contains next update date and time of the TSL used.

Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate.

TSLPolicies: Contains XML content of policies of the TSL used.

Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate.

TSLPolicies[lang]: Contains policies for the specified language of the TSL used.

Use this property to get policies for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeExtensions: Contains XML content of scheme extensions of the TSL used.

Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate.

TSLSchemeExtensions[Idx]: Contains XML content of scheme extension of the specified index of the TSL used.

Use this property to get XML content of scheme extension of the specified index of the TSL used to obtain the qualified status of the certificate.

TSLSchemeInformationURI: Contains XML content of scheme information URI of the TSL used.

Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate.

TSLSchemeInformationURI[lang]: Contains scheme information URI for the specified language of the TSL used.

Use this property to get scheme information URI for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeName: Contains XML content of scheme name of the TSL used.

Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate.

TSLSchemeName[lang]: Contains scheme name for the specified language of the TSL used.

Use this property to get scheme name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorAddress: Contains XML content of scheme operator address of the TSL used.

Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorName: Contains XML content of scheme operator name of the TSL used.

Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorName[lang]: Contains scheme operator name for the specified language of the TSL used.

Use this property to get scheme operator name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTerritory: Contains scheme territory of the TSL used.

Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTypeCommunityRules: Contains XML content of scheme type/community/rules of the TSL used.

Use this property to get XML content of multilingual scheme type/community/rules of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTypeCommunityRules[lang]: Contains scheme type/community/rules for the specified language of the TSL used.

Use this property to get scheme type/community/rules for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSequenceNumber: Contains sequence number of the TSL used.

Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate.

TSLsRetrieveLog: Contains the complete log of the TSLs retrieve.

Use this property to access the TSLs retrieve log produced by the class. The log can be very useful when investigating issues with TSL retrieve.

TSLStatusDeterminationApproach: Contains status determination approach of the TSL used.

Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate.

TSLsValidationLog: Contains the complete log of the TSLs validation.

Use this property to access the TSLs validation log produced by the class. The log can be very useful when investigating issues with TSL validation.

TSLTSPAdditionalServiceInformation: Contains addtional service information of the TSP service used.

Use this property to get the list of addtional service information of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPAddress: Contains XML content of the address of the TSP used.

Use this property to get XML content of the address of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPHistoryInstance: Indicates that TSP service history instance used.

Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance.

TSLTSPHistoryInstanceAdditionalServiceInformation: Contains addtional service information of the TSP service history instance used.

Use this property to get the list of addtional service information of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPHistoryInstanceQualifiers: Contains list of qualifiers of the TSP service history instance used.

Use this property to get the list of qualifiers of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPHistoryInstanceServiceInformationExtensions: Contains XML content of information extensions of the TSP service history instance used.

Use this property to get XML content of information extensions of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceInformationExtensions[Idx]: Contains XML content of information extension of the specified index of the TSP service history instance used.

Use this property to get XML content of information extension of the specified index of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceName: Contains XML content of name of the TSP service history instance used.

Use this property to get XML content of multilingual name of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceName[lang]: Contains name for the specified language of the TSP service history instance used.

Use this property to get the name for the specified language code (e.g. 'en') of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceStatus: Contains status of the TSP service history instance used.

Use this property to get the status of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceStatusStartingTime: Contains status starting time of the TSP service history instance used.

Use this property to get the status starting time of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceTypeIdentifier: Contains type identifier of the TSP service history instance used.

Use this property to get type identifier of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceXML: Contains XML content of the TSP service history instance used.

Use this property to get XML content of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPInformationExtensions: Contains XML content of information extensions of the TSP used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationExtensions[Idx]: Contains XML content of information extension of the specified index of the TSP used.

Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationURI: Contains XML content of information URI of the TSP used.

Use this property to get XML content of multilingual information URI of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationURI[lang]: Contains information URI for the specified language of the TSP used.

Use this property to get the information URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPName: Contains XML content of name of the TSP used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPName[lang]: Contains name for the specified language of the TSP used.

Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPSchemeServiceDefinitionURI: Contains XML content of scheme service definition URI of the TSP service used.

Use this property to get XML content of multilingual scheme service definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPSchemeServiceDefinitionURI[lang]: Contains scheme service definition URI for the specified language of the TSP service used.

Use this property to get the scheme service definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceDefinitionURI: Contains XML content of definition URI of the TSP service used.

Use this property to get XML content of multilingual definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceDefinitionURI[lang]: Contains definition URI for the specified language of the TSP service used.

Use this property to get the definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceInformationExtensions: Contains XML content of information extensions of the TSP service used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceInformationExtensions[Idx]: Contains XML content of information extension of the specified index of the TSP service used.

Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceName: Contains XML content of name of the TSP service used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceName[lang]: Contains name for the specified language of the TSP service used.

Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceQualifiers: Contains list of qualifiers of the TSP service used.

Use this property to get the list of qualifiers of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPServiceStatus: Contains status of the TSP service used.

Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceStatusStartingTime: Contains status starting time of the TSP service used.

Use this property to get the status starting time of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceSupplyPoints: Contains XML content of the supply points of the TSP service used.

Use this property to get XML content of the supply points of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceTypeIdentifier: Contains type identifier of the TSP service used.

Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceXML: Contains XML content of the TSP service used.

Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPTradeName: Contains XML content of trade name of the TSP used.

Use this property to get XML content of multilingual trade name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPTradeName[lang]: Contains trade name for the specified language of the TSP used.

Use this property to get the trade name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPXML: Contains XML content of the TSP used.

Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLType: Contains TSL type of the TSL used.

Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate.

TSLVersionIdentifier: Contains version identifier of the TSL used.

Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate.

TSLXML: Contains XML content of the TSL used.

Use this property to get XML content of the TSL used to obtain the qualified status of the certificate.

TSPAdditionalServiceInformation: Contains addtional service information of the TSP service used.

TSPAddress: Contains XML content of the address of the TSP used.

Use this property to get XML content of the address of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSPHistoryInstance: Indicates that TSP service history instance used.

Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance.

TSPHistoryInstanceAdditionalServiceInformation: Contains addtional service information of the TSP service history instance used.

TSPHistoryInstanceQualifiers: Contains list of qualifiers of the TSP service history instance used.

TSPHistoryInstanceServiceInformationExtensions: Contains XML content of information extensions of the TSP service history instance used.

Use this property to get XML content of information extensions of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPHistoryInstanceServiceName: Contains XML content of name of the TSP service history instance used.

Use this property to get XML content of multilingual name of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPHistoryInstanceServiceStatus: Contains status of the TSP service history instance used.

Use this property to get the status of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPHistoryInstanceServiceStatusStartingTime: Contains status starting time of the TSP service history instance used.

Use this property to get the status starting time of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPHistoryInstanceServiceTypeIdentifier: Contains type identifier of the TSP service history instance used.

Use this property to get type identifier of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPHistoryInstanceXML: Contains XML content of the TSP service history instance used.

Use this property to get XML content of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPInformationExtensions: Contains XML content of information extensions of the TSP used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSPInformationURI: Contains XML content of information URI of the TSP used.

Use this property to get XML content of multilingual information URI of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSPName: Contains XML content of name of the TSP used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSPSchemeServiceDefinitionURI: Contains XML content of scheme service definition URI of the TSP service used.

Use this property to get XML content of multilingual scheme service definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPServiceDefinitionURI: Contains XML content of definition URI of the TSP service used.

Use this property to get XML content of multilingual definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPServiceInformationExtensions: Contains XML content of information extensions of the TSP service used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPServiceName: Contains XML content of name of the TSP service used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPServiceQualifiers: Contains list of qualifiers of the TSP service used.

Use this property to get the list of qualifiers of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSPServiceStatus: Contains status of the TSP service used.

Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPServiceStatusStartingTime: Contains status starting time of the TSP service used.

Use this property to get the status starting time of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPServiceSupplyPoints: Contains XML content of the supply points of the TSP service used.

Use this property to get XML content of the supply points of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPServiceTypeIdentifier: Contains type identifier of the TSP service used.

Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPServiceXML: Contains XML content of the TSP service used.

Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSPTradeName: Contains XML content of trade name of the TSP used.

Use this property to get XML content of multilingual trade name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSPXML: Contains XML content of the TSP used.

Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

Type: Contains TSL type of the TSL used.

Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate.

VersionIdentifier: Contains version identifier of the TSL used.

Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate.

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.

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: auto, enable, or disable.

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.

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 devided 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 chached 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).

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).

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.

CertificateValidator Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)