# MessageTimestampVerifier Class

The MessageTimestampVerifier class verifies timestamped messages.

## Syntax

```text
class secureblackbox.MessageTimestampVerifier
```

## Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS. MessageTimestampVerifier can process timestamps in one of the following formats:

- PKCS#7 TimestampedData (RFC5544),
- PKCS#7 TimestampToken (CMS), and
- PKCS#7 TSPReply (RFC3161).

 To process a timestamped message, provide it via [input_file](#input_file-property) (or [input_bytes](#input_bytes-property)) property. For detached timestamps, provide the relevant data via [data_file](#data_file-property) (or [data_bytes](#data_bytes-property)) property. Then call [verify](#verify-method) or [verify_detached](#verify_detached-method), depending on the form of the timestamp file.

```text
MessageTimestampVerifier timestampVerifier = new MessageTimestampVerifier();

// Select the file which contains the message that is timestamped
timestampVerifier.setInputFile("timestampedMessage.bin");

// Select the file where the output will be written
timestampVerifier.setOutputFile("verifiedTimestamp.txt");

timestampVerifier.verify(); // verify

System.out.println("Validation result: " + timestampVerifier.getSignatureValidationResult() + "\n" +
        "Signing time: " + timestampVerifier.getValidatedSigningTime() + "\n" +
        "TSA certificate: " + timestampVerifier.getSigningCertificate().getSubjectRDN());

// Output:
//   Validation result: 0 // 0 == svtValid
//   Signing time: 2024-05-16 14:54:33
//   TSA certificate: /C=US/O=Big Little Timestamping Service/CN=Big Little Timestamper
```

## Property List

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

|  |  |
| --- | --- |
| [cert_count](#cert_count-property) | The number of records in the Cert arrays. |
| [cert_bytes](#cert_bytes-property) | Returns the raw certificate data in DER format. |
| [cert_ca](#cert_ca-property) | Indicates whether the certificate has a CA capability. |
| [cert_ca_key_id](#cert_ca_key_id-property) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| [cert_type](#cert_type-property) | Returns the type of the entity contained in the Certificate object. |
| [cert_crl_distribution_points](#cert_crl_distribution_points-property) | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| [cert_curve](#cert_curve-property) | Specifies the elliptic curve associated with the certificate's public key. |
| [cert_fingerprint](#cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. |
| [cert_friendly_name](#cert_friendly_name-property) | Contains an associated alias (friendly name) of the certificate. |
| [cert_handle](#cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [cert_hash_algorithm](#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). |
| [cert_issuer](#cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. |
| [cert_issuer_rdn](#cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [cert_key_algorithm](#cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. |
| [cert_key_bits](#cert_key_bits-property) | Returns the length of the public key in bits. |
| [cert_key_fingerprint](#cert_key_fingerprint-property) | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| [cert_key_usage](#cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| [cert_key_valid](#cert_key_valid-property) | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| [cert_ocsp_locations](#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. |
| [cert_ocsp_no_check](#cert_ocsp_no_check-property) | Accessor to the value of the certificate's ocsp-no-check extension. |
| [cert_origin](#cert_origin-property) | Returns the location that the certificate was taken or loaded from. |
| [cert_policy_i_ds](#cert_policy_i_ds-property) | Contains identifiers (OIDs) of the applicable certificate policies. |
| [cert_private_key_bytes](#cert_private_key_bytes-property) | Returns the certificate's private key in DER-encoded format. |
| [cert_private_key_exists](#cert_private_key_exists-property) | Indicates whether the certificate has a usable private key associated with it. |
| [cert_private_key_extractable](#cert_private_key_extractable-property) | Indicates whether the private key is extractable (exportable). |
| [cert_public_key_bytes](#cert_public_key_bytes-property) | Contains the certificate's public key in DER format. |
| [cert_qualified](#cert_qualified-property) | Indicates whether the certificate is qualified. |
| [cert_qualified_statements](#cert_qualified_statements-property) | Returns a simplified qualified status of the certificate. |
| [cert_qualifiers](#cert_qualifiers-property) | A list of qualifiers. |
| [cert_self_signed](#cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [cert_serial_number](#cert_serial_number-property) | Returns the certificate's serial number. |
| [cert_sig_algorithm](#cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [cert_source](#cert_source-property) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| [cert_subject](#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. |
| [cert_subject_alternative_name](#cert_subject_alternative_name-property) | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| [cert_subject_key_id](#cert_subject_key_id-property) | Contains a unique identifier of the certificate's cryptographic key. |
| [cert_subject_rdn](#cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [cert_valid](#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. |
| [cert_valid_from](#cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. |
| [cert_valid_to](#cert_valid_to-property) | The time point at which the certificate expires, in UTC. |
| [data_bytes](#data_bytes-property) | Use this property to pass the timestamped data to class in the byte array form. |
| [data_file](#data_file-property) | The name of the file containing the originally timestamped data. |
| [data_file_name](#data_file_name-property) | Returns the data filename as recorded in the timestamp. |
| [data_uri](#data_uri-property) | Returns the data URI as recorded in the timestamp. |
| [fips_mode](#fips_mode-property) | Reserved. |
| [input_bytes](#input_bytes-property) | Use this property to pass the input to class in byte array form. |
| [input_file](#input_file-property) | Path to the file containing the timestamped message. |
| [output_bytes](#output_bytes-property) | Use this property to read the output the class object has produced. |
| [output_file](#output_file-property) | Path to the file to save the extracted data to. |
| [signature_validation_result](#signature_validation_result-property) | The signature validation result. |
| [signing_cert_bytes](#signing_cert_bytes-property) | Returns the raw certificate data in DER format. |
| [signing_cert_ca](#signing_cert_ca-property) | Indicates whether the certificate has a CA capability. |
| [signing_cert_ca_key_id](#signing_cert_ca_key_id-property) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| [signing_cert_cert_type](#signing_cert_cert_type-property) | Returns the type of the entity contained in the Certificate object. |
| [signing_cert_crl_distribution_points](#signing_cert_crl_distribution_points-property) | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| [signing_cert_curve](#signing_cert_curve-property) | Specifies the elliptic curve associated with the certificate's public key. |
| [signing_cert_fingerprint](#signing_cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. |
| [signing_cert_friendly_name](#signing_cert_friendly_name-property) | Contains an associated alias (friendly name) of the certificate. |
| [signing_cert_handle](#signing_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [signing_cert_hash_algorithm](#signing_cert_hash_algorithm-property) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). |
| [signing_cert_issuer](#signing_cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. |
| [signing_cert_issuer_rdn](#signing_cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [signing_cert_key_algorithm](#signing_cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. |
| [signing_cert_key_bits](#signing_cert_key_bits-property) | Returns the length of the public key in bits. |
| [signing_cert_key_fingerprint](#signing_cert_key_fingerprint-property) | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| [signing_cert_key_usage](#signing_cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| [signing_cert_key_valid](#signing_cert_key_valid-property) | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| [signing_cert_ocsp_locations](#signing_cert_ocsp_locations-property) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. |
| [signing_cert_ocsp_no_check](#signing_cert_ocsp_no_check-property) | Accessor to the value of the certificate's ocsp-no-check extension. |
| [signing_cert_origin](#signing_cert_origin-property) | Returns the location that the certificate was taken or loaded from. |
| [signing_cert_policy_i_ds](#signing_cert_policy_i_ds-property) | Contains identifiers (OIDs) of the applicable certificate policies. |
| [signing_cert_private_key_bytes](#signing_cert_private_key_bytes-property) | Returns the certificate's private key in DER-encoded format. |
| [signing_cert_private_key_exists](#signing_cert_private_key_exists-property) | Indicates whether the certificate has a usable private key associated with it. |
| [signing_cert_private_key_extractable](#signing_cert_private_key_extractable-property) | Indicates whether the private key is extractable (exportable). |
| [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property) | Contains the certificate's public key in DER format. |
| [signing_cert_qualified](#signing_cert_qualified-property) | Indicates whether the certificate is qualified. |
| [signing_cert_qualified_statements](#signing_cert_qualified_statements-property) | Returns a simplified qualified status of the certificate. |
| [signing_cert_qualifiers](#signing_cert_qualifiers-property) | A list of qualifiers. |
| [signing_cert_self_signed](#signing_cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [signing_cert_serial_number](#signing_cert_serial_number-property) | Returns the certificate's serial number. |
| [signing_cert_sig_algorithm](#signing_cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [signing_cert_source](#signing_cert_source-property) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| [signing_cert_subject](#signing_cert_subject-property) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| [signing_cert_subject_alternative_name](#signing_cert_subject_alternative_name-property) | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| [signing_cert_subject_key_id](#signing_cert_subject_key_id-property) | Contains a unique identifier of the certificate's cryptographic key. |
| [signing_cert_subject_rdn](#signing_cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [signing_cert_valid](#signing_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. |
| [signing_cert_valid_from](#signing_cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. |
| [signing_cert_valid_to](#signing_cert_valid_to-property) | The time point at which the certificate expires, in UTC. |
| [timestamp_format](#timestamp_format-property) | Returns the format of the processed timestamp. |
| [validated_signing_time](#validated_signing_time-property) | Contains the certified signing time. |

## Method List

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

|  |  |
| --- | --- |
| [config](#config-method) | Sets or retrieves a configuration setting. |
| [do_action](#do_action-method) | Performs an additional action. |
| [reset](#reset-method) | Resets the class settings. |
| [verify](#verify-method) | Verifies a timestamped message. |
| [verify_detached](#verify_detached-method) | Verifies a detached timestamped message. |

## 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_error](#on_error-event) | Information about errors during PKCS#7 message encryption. |
| [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. |

## Config Settings

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

|  |  |
| --- | --- |
| [Accuracy](#Accuracy) | TBD. |
| [CMS](#CMS) | TBD. |
| [MediaType](#MediaType) | Media type. |
| [MessageImprint](#MessageImprint) | TBD. |
| [MessageImprintAlgorithm](#MessageImprintAlgorithm) | TBD. |
| [SerialNumber](#SerialNumber) | TBD. |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [Time](#Time) | TBD. |
| [TimestampType](#TimestampType) | TBD. |
| [TSAName](#TSAName) | TBD. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# cert_count property

The number of records in the Cert arrays.

## Syntax

```text
def get_cert_count() -> int: ...
cert_count = property(get_cert_count, None)
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [cert_bytes](#cert_bytes-property)
- [cert_ca](#cert_ca-property)
- [cert_ca_key_id](#cert_ca_key_id-property)
- [cert_crl_distribution_points](#cert_crl_distribution_points-property)
- [cert_curve](#cert_curve-property)
- [cert_fingerprint](#cert_fingerprint-property)
- [cert_friendly_name](#cert_friendly_name-property)
- [cert_handle](#cert_handle-property)
- [cert_hash_algorithm](#cert_hash_algorithm-property)
- [cert_issuer](#cert_issuer-property)
- [cert_issuer_rdn](#cert_issuer_rdn-property)
- [cert_key_algorithm](#cert_key_algorithm-property)
- [cert_key_bits](#cert_key_bits-property)
- [cert_key_fingerprint](#cert_key_fingerprint-property)
- [cert_key_usage](#cert_key_usage-property)
- [cert_key_valid](#cert_key_valid-property)
- [cert_ocsp_locations](#cert_ocsp_locations-property)
- [cert_ocsp_no_check](#cert_ocsp_no_check-property)
- [cert_origin](#cert_origin-property)
- [cert_policy_i_ds](#cert_policy_i_ds-property)
- [cert_private_key_bytes](#cert_private_key_bytes-property)
- [cert_private_key_exists](#cert_private_key_exists-property)
- [cert_private_key_extractable](#cert_private_key_extractable-property)
- [cert_public_key_bytes](#cert_public_key_bytes-property)
- [cert_qualified](#cert_qualified-property)
- [cert_qualified_statements](#cert_qualified_statements-property)
- [cert_qualifiers](#cert_qualifiers-property)
- [cert_self_signed](#cert_self_signed-property)
- [cert_serial_number](#cert_serial_number-property)
- [cert_sig_algorithm](#cert_sig_algorithm-property)
- [cert_source](#cert_source-property)
- [cert_subject](#cert_subject-property)
- [cert_subject_alternative_name](#cert_subject_alternative_name-property)
- [cert_subject_key_id](#cert_subject_key_id-property)
- [cert_subject_rdn](#cert_subject_rdn-property)
- [cert_type](#cert_type-property)
- [cert_valid](#cert_valid-property)
- [cert_valid_from](#cert_valid_from-property)
- [cert_valid_to](#cert_valid_to-property)

The array indices start at *0* and end at *cert_count - 1*.

This property is read-only.

# cert_bytes property

Returns the raw certificate data in DER format.

## Syntax

```text
def get_cert_bytes(cert_index: int) -> bytes: ...
```

## Remarks

Returns the raw certificate data in DER format.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_ca property

Indicates whether the certificate has a CA capability.

## Syntax

```text
def get_cert_ca(cert_index: int) -> bool: ...
```

## Default Value

FALSE

## Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_ca_key_id property

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

## Syntax

```text
def get_cert_ca_key_id(cert_index: int) -> bytes: ...
```

## Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_type property

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

## Syntax

```text
def get_cert_type(cert_index: int) -> int: ...
```

## Possible Values

```text
0   # Unknown1   # X509Certificate2   # X509CertificateRequest
```

## Default Value

0

## Remarks

Returns the type of the entity contained in the [Certificate](#Type_Certificate) object.

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

Use the [CertificateManager](#CertificateManager) class to load or create new certificate and certificate requests objects.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_crl_distribution_points property

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

## Syntax

```text
def get_cert_crl_distribution_points(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_curve property

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

## Syntax

```text
def get_cert_curve(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

|  |  |  |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 |  |
| SB_EC_SECP112R2 | SECP112R2 |  |
| SB_EC_SECP128R1 | SECP128R1 |  |
| SB_EC_SECP128R2 | SECP128R2 |  |
| SB_EC_SECP160K1 | SECP160K1 |  |
| SB_EC_SECP160R1 | SECP160R1 |  |
| SB_EC_SECP160R2 | SECP160R2 |  |
| SB_EC_SECP192K1 | SECP192K1 |  |
| SB_EC_SECP192R1 | SECP192R1 |  |
| SB_EC_SECP224K1 | SECP224K1 |  |
| SB_EC_SECP224R1 | SECP224R1 |  |
| SB_EC_SECP256K1 | SECP256K1 |  |
| SB_EC_SECP256R1 | SECP256R1 |  |
| SB_EC_SECP384R1 | SECP384R1 |  |
| SB_EC_SECP521R1 | SECP521R1 |  |
| SB_EC_SECT113R1 | SECT113R1 |  |
| SB_EC_SECT113R2 | SECT113R2 |  |
| SB_EC_SECT131R1 | SECT131R1 |  |
| SB_EC_SECT131R2 | SECT131R2 |  |
| SB_EC_SECT163K1 | SECT163K1 |  |
| SB_EC_SECT163R1 | SECT163R1 |  |
| SB_EC_SECT163R2 | SECT163R2 |  |
| SB_EC_SECT193R1 | SECT193R1 |  |
| SB_EC_SECT193R2 | SECT193R2 |  |
| SB_EC_SECT233K1 | SECT233K1 |  |
| SB_EC_SECT233R1 | SECT233R1 |  |
| SB_EC_SECT239K1 | SECT239K1 |  |
| SB_EC_SECT283K1 | SECT283K1 |  |
| SB_EC_SECT283R1 | SECT283R1 |  |
| SB_EC_SECT409K1 | SECT409K1 |  |
| SB_EC_SECT409R1 | SECT409R1 |  |
| SB_EC_SECT571K1 | SECT571K1 |  |
| SB_EC_SECT571R1 | SECT571R1 |  |
| SB_EC_PRIME192V1 | PRIME192V1 |  |
| SB_EC_PRIME192V2 | PRIME192V2 |  |
| SB_EC_PRIME192V3 | PRIME192V3 |  |
| SB_EC_PRIME239V1 | PRIME239V1 |  |
| SB_EC_PRIME239V2 | PRIME239V2 |  |
| SB_EC_PRIME239V3 | PRIME239V3 |  |
| SB_EC_PRIME256V1 | PRIME256V1 |  |
| SB_EC_C2PNB163V1 | C2PNB163V1 |  |
| SB_EC_C2PNB163V2 | C2PNB163V2 |  |
| SB_EC_C2PNB163V3 | C2PNB163V3 |  |
| SB_EC_C2PNB176W1 | C2PNB176W1 |  |
| SB_EC_C2TNB191V1 | C2TNB191V1 |  |
| SB_EC_C2TNB191V2 | C2TNB191V2 |  |
| SB_EC_C2TNB191V3 | C2TNB191V3 |  |
| SB_EC_C2ONB191V4 | C2ONB191V4 |  |
| SB_EC_C2ONB191V5 | C2ONB191V5 |  |
| SB_EC_C2PNB208W1 | C2PNB208W1 |  |
| SB_EC_C2TNB239V1 | C2TNB239V1 |  |
| SB_EC_C2TNB239V2 | C2TNB239V2 |  |
| SB_EC_C2TNB239V3 | C2TNB239V3 |  |
| SB_EC_C2ONB239V4 | C2ONB239V4 |  |
| SB_EC_C2ONB239V5 | C2ONB239V5 |  |
| SB_EC_C2PNB272W1 | C2PNB272W1 |  |
| SB_EC_C2PNB304W1 | C2PNB304W1 |  |
| SB_EC_C2TNB359V1 | C2TNB359V1 |  |
| SB_EC_C2PNB368W1 | C2PNB368W1 |  |
| SB_EC_C2TNB431R1 | C2TNB431R1 |  |
| SB_EC_NISTP192 | NISTP192 |  |
| SB_EC_NISTP224 | NISTP224 |  |
| SB_EC_NISTP256 | NISTP256 |  |
| SB_EC_NISTP384 | NISTP384 |  |
| SB_EC_NISTP521 | NISTP521 |  |
| SB_EC_NISTB163 | NISTB163 |  |
| SB_EC_NISTB233 | NISTB233 |  |
| SB_EC_NISTB283 | NISTB283 |  |
| SB_EC_NISTB409 | NISTB409 |  |
| SB_EC_NISTB571 | NISTB571 |  |
| SB_EC_NISTK163 | NISTK163 |  |
| SB_EC_NISTK233 | NISTK233 |  |
| SB_EC_NISTK283 | NISTK283 |  |
| SB_EC_NISTK409 | NISTK409 |  |
| SB_EC_NISTK571 | NISTK571 |  |
| SB_EC_GOSTCPTEST | GOSTCPTEST |  |
| SB_EC_GOSTCPA | GOSTCPA |  |
| SB_EC_GOSTCPB | GOSTCPB |  |
| SB_EC_GOSTCPC | GOSTCPC |  |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA |  |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB |  |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 |  |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 |  |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 |  |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 |  |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 |  |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 |  |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 |  |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 |  |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 |  |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 |  |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 |  |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 |  |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 |  |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 |  |
| SB_EC_CURVE25519 | CURVE25519 |  |
| SB_EC_CURVE448 | CURVE448 |  |

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_fingerprint property

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

## Syntax

```text
def get_cert_fingerprint(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

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

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_friendly_name property

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

## Syntax

```text
def get_cert_friendly_name(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_handle property

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

## Syntax

```text
def get_cert_handle(cert_index: int) -> int: ...
```

## Default Value

0

## Remarks

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

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

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_hash_algorithm property

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

## Syntax

```text
def get_cert_hash_algorithm(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [cert_sig_algorithm](#cert_sig_algorithm-property) to find out the hash algorithm that is part of the certificate signature.

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_issuer property

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

## Syntax

```text
def get_cert_issuer(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [cert_issuer_rdn](#cert_issuer_rdn-property).

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_issuer_rdn property

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

## Syntax

```text
def get_cert_issuer_rdn(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

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

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_key_algorithm property

Specifies the public key algorithm of this certificate.

## Syntax

```text
def get_cert_key_algorithm(cert_index: int) -> str: ...
```

## Default Value

"0"

## Remarks

Specifies the public key algorithm of this certificate.

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

Use the [cert_key_bits](#cert_key_bits-property), [cert_curve](#cert_curve-property), and [cert_public_key_bytes](#cert_public_key_bytes-property) properties to get more details about the key the certificate contains.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_key_bits property

Returns the length of the public key in bits.

## Syntax

```text
def get_cert_key_bits(cert_index: int) -> int: ...
```

## Default Value

0

## Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [cert_public_key_bytes](#cert_public_key_bytes-property) or [cert_private_key_bytes](#cert_private_key_bytes-property) property would typically contain auxiliary values, and therefore be longer.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_key_fingerprint property

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

## Syntax

```text
def get_cert_key_fingerprint(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the [cert_fingerprint](#cert_fingerprint-property) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_key_usage property

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

## Syntax

```text
def get_cert_key_usage(cert_index: int) -> int: ...
```

## Default Value

0

## Remarks

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

This value is a bit mask of the following values:

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

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_key_valid property

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

## Syntax

```text
def get_cert_key_valid(cert_index: int) -> bool: ...
```

## Default Value

FALSE

## Remarks

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_ocsp_locations property

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

## Syntax

```text
def get_cert_ocsp_locations(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

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

Set this property before calling the certificate manager's [generate](#CertificateManager_m_Generate) method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_ocsp_no_check property

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

## Syntax

```text
def get_cert_ocsp_no_check(cert_index: int) -> bool: ...
```

## Default Value

FALSE

## Remarks

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_origin property

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

## Syntax

```text
def get_cert_origin(cert_index: int) -> int: ...
```

## Default Value

0

## Remarks

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_policy_i_ds property

Contains identifiers (OIDs) of the applicable certificate policies.

## Syntax

```text
def get_cert_policy_i_ds(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_private_key_bytes property

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

## Syntax

```text
def get_cert_private_key_bytes(cert_index: int) -> bytes: ...
```

## Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_private_key_exists property

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

## Syntax

```text
def get_cert_private_key_exists(cert_index: int) -> bool: ...
```

## Default Value

FALSE

## Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from [cert_private_key_bytes](#cert_private_key_bytes-property), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_private_key_extractable property

Indicates whether the private key is extractable (exportable).

## Syntax

```text
def get_cert_private_key_extractable(cert_index: int) -> bool: ...
```

## Default Value

FALSE

## Remarks

Indicates whether the private key is extractable (exportable).

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_public_key_bytes property

Contains the certificate's public key in DER format.

## Syntax

```text
def get_cert_public_key_bytes(cert_index: int) -> bytes: ...
```

## Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_qualified property

Indicates whether the certificate is qualified.

## Syntax

```text
def get_cert_qualified(cert_index: int) -> bool: ...
```

## Default Value

FALSE

## Remarks

Indicates whether the certificate is qualified.

This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_qualified_statements property

Returns a simplified qualified status of the certificate.

## Syntax

```text
def get_cert_qualified_statements(cert_index: int) -> int: ...
```

## Possible Values

```text
0   # NonQualified1   # QualifiedHardware2   # QualifiedSoftware
```

## Default Value

0

## Remarks

Returns a simplified qualified status of the certificate.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_qualifiers property

A list of qualifiers.

## Syntax

```text
def get_cert_qualifiers(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

A list of qualifiers.

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_self_signed property

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

## Syntax

```text
def get_cert_self_signed(cert_index: int) -> bool: ...
```

## Default Value

FALSE

## Remarks

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_serial_number property

Returns the certificate's serial number.

## Syntax

```text
def get_cert_serial_number(cert_index: int) -> bytes: ...
```

## Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_sig_algorithm property

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

## Syntax

```text
def get_cert_sig_algorithm(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

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

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_source property

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

## Syntax

```text
def get_cert_source(cert_index: int) -> int: ...
```

## Possible Values

```text
0   # Unknown1   # Signature2   # Document3   # User4   # Local5   # Online
```

## Default Value

0

## Remarks

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_subject property

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

## Syntax

```text
def get_cert_subject(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [cert_subject_rdn](#cert_subject_rdn-property).

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_subject_alternative_name property

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

## Syntax

```text
def get_cert_subject_alternative_name(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

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

Subject alternative names are used to provide additional names that are impractical to store in the main [cert_subject_rdn](#cert_subject_rdn-property) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_subject_key_id property

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

## Syntax

```text
def get_cert_subject_key_id(cert_index: int) -> bytes: ...
```

## Remarks

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

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The [cert_subject_key_id](#cert_subject_key_id-property) and [cert_ca_key_id](#cert_ca_key_id-property) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_subject_rdn property

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

## Syntax

```text
def get_cert_subject_rdn(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

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

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_valid property

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

## Syntax

```text
def get_cert_valid(cert_index: int) -> bool: ...
```

## Default Value

FALSE

## Remarks

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_valid_from property

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

## Syntax

```text
def get_cert_valid_from(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# cert_valid_to property

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

## Syntax

```text
def get_cert_valid_to(cert_index: int) -> str: ...
```

## Default Value

""

## Remarks

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

The *cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [cert_count](#cert_count-property) property.

This property is read-only.

# data_bytes property

Use this property to pass the timestamped data to class in the byte array form.

## Syntax

```text
def get_data_bytes() -> bytes: ...
def set_data_bytes(value: bytes) -> None: ...
data_bytes = property(get_data_bytes, set_data_bytes)
```

## Remarks

Assign a byte array containing the original timestamped data to this property.

# data_file property

The name of the file containing the originally timestamped data.

## Syntax

```text
def get_data_file() -> str: ...
def set_data_file(value: str) -> None: ...
data_file = property(get_data_file, set_data_file)
```

## Default Value

""

## Remarks

Use this property to provide the original data when validating detached timestamps with [verify_detached](#verify_detached-method).

# data_file_name property

Returns the data filename as recorded in the timestamp.

## Syntax

```text
def get_data_file_name() -> str: ...
data_file_name = property(get_data_file_name, None)
```

## Default Value

""

## Remarks

This read-only property returns the file name of the timestamped data as recorded in the timestamp by its creator. It only carries an informational purpose.

This property is read-only.

# data_uri property

Returns the data URI as recorded in the timestamp.

## Syntax

```text
def get_data_uri() -> str: ...
data_uri = property(get_data_uri, None)
```

## Default Value

""

## Remarks

This read-only property returns the URI of the timestamped data as recorded in the timestamp by its creator. It only carries an informational purpose.

This property is read-only.

# fips_mode property

Reserved.

## Syntax

```text
def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...
fips_mode = property(get_fips_mode, set_fips_mode)
```

## Default Value

FALSE

## Remarks

This property is reserved for future use.

# input_bytes property

Use this property to pass the input to class in byte array form.

## Syntax

```text
def get_input_bytes() -> bytes: ...
def set_input_bytes(value: bytes) -> None: ...
input_bytes = property(get_input_bytes, set_input_bytes)
```

## Remarks

Assign a byte array containing the data to be processed to this property.

# input_file property

Path to the file containing the timestamped message.

## Syntax

```text
def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...
input_file = property(get_input_file, set_input_file)
```

## Default Value

""

## Remarks

Use this property to provide a file containing the timestamped data, either enveloping or detached.

# output_bytes property

Use this property to read the output the class object has produced.

## Syntax

```text
def get_output_bytes() -> bytes: ...
output_bytes = property(get_output_bytes, None)
```

## Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the [output_file](#output_file-property) and output_stream properties had not been assigned.

This property is read-only.

# output_file property

Path to the file to save the extracted data to.

## Syntax

```text
def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...
output_file = property(get_output_file, set_output_file)
```

## Default Value

""

## Remarks

Use this property when validating enveloping timestamps to specify the output file where the extracted message should be saved.

# signature_validation_result property

The signature validation result.

## Syntax

```text
def get_signature_validation_result() -> int: ...
signature_validation_result = property(get_signature_validation_result, None)
```

## Possible Values

```text
0   # Valid1   # Unknown2   # Corrupted3   # SignerNotFound4   # Failure5   # ReferenceCorrupted
```

## Default Value

0

## Remarks

Use this property to check the result of the most recent signature validation.

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

This property is read-only.

# signing_cert_bytes property

Returns the raw certificate data in DER format.

## Syntax

```text
def get_signing_cert_bytes() -> bytes: ...
signing_cert_bytes = property(get_signing_cert_bytes, None)
```

## Remarks

Returns the raw certificate data in DER format.

This property is read-only.

# signing_cert_ca property

Indicates whether the certificate has a CA capability.

## Syntax

```text
def get_signing_cert_ca() -> bool: ...
signing_cert_ca = property(get_signing_cert_ca, None)
```

## Default Value

FALSE

## Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

This property is read-only.

# signing_cert_ca_key_id property

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

## Syntax

```text
def get_signing_cert_ca_key_id() -> bytes: ...
signing_cert_ca_key_id = property(get_signing_cert_ca_key_id, None)
```

## Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

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

This property is read-only.

# signing_cert_cert_type property

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

## Syntax

```text
def get_signing_cert_cert_type() -> int: ...
signing_cert_cert_type = property(get_signing_cert_cert_type, None)
```

## Possible Values

```text
0   # Unknown1   # X509Certificate2   # X509CertificateRequest
```

## Default Value

0

## Remarks

Returns the type of the entity contained in the [Certificate](#Type_Certificate) object.

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

Use the [CertificateManager](#CertificateManager) class to load or create new certificate and certificate requests objects.

This property is read-only.

# signing_cert_crl_distribution_points property

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

## Syntax

```text
def get_signing_cert_crl_distribution_points() -> str: ...
signing_cert_crl_distribution_points = property(get_signing_cert_crl_distribution_points, None)
```

## Default Value

""

## Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

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

This property is read-only.

# signing_cert_curve property

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

## Syntax

```text
def get_signing_cert_curve() -> str: ...
signing_cert_curve = property(get_signing_cert_curve, None)
```

## Default Value

""

## Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

|  |  |  |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 |  |
| SB_EC_SECP112R2 | SECP112R2 |  |
| SB_EC_SECP128R1 | SECP128R1 |  |
| SB_EC_SECP128R2 | SECP128R2 |  |
| SB_EC_SECP160K1 | SECP160K1 |  |
| SB_EC_SECP160R1 | SECP160R1 |  |
| SB_EC_SECP160R2 | SECP160R2 |  |
| SB_EC_SECP192K1 | SECP192K1 |  |
| SB_EC_SECP192R1 | SECP192R1 |  |
| SB_EC_SECP224K1 | SECP224K1 |  |
| SB_EC_SECP224R1 | SECP224R1 |  |
| SB_EC_SECP256K1 | SECP256K1 |  |
| SB_EC_SECP256R1 | SECP256R1 |  |
| SB_EC_SECP384R1 | SECP384R1 |  |
| SB_EC_SECP521R1 | SECP521R1 |  |
| SB_EC_SECT113R1 | SECT113R1 |  |
| SB_EC_SECT113R2 | SECT113R2 |  |
| SB_EC_SECT131R1 | SECT131R1 |  |
| SB_EC_SECT131R2 | SECT131R2 |  |
| SB_EC_SECT163K1 | SECT163K1 |  |
| SB_EC_SECT163R1 | SECT163R1 |  |
| SB_EC_SECT163R2 | SECT163R2 |  |
| SB_EC_SECT193R1 | SECT193R1 |  |
| SB_EC_SECT193R2 | SECT193R2 |  |
| SB_EC_SECT233K1 | SECT233K1 |  |
| SB_EC_SECT233R1 | SECT233R1 |  |
| SB_EC_SECT239K1 | SECT239K1 |  |
| SB_EC_SECT283K1 | SECT283K1 |  |
| SB_EC_SECT283R1 | SECT283R1 |  |
| SB_EC_SECT409K1 | SECT409K1 |  |
| SB_EC_SECT409R1 | SECT409R1 |  |
| SB_EC_SECT571K1 | SECT571K1 |  |
| SB_EC_SECT571R1 | SECT571R1 |  |
| SB_EC_PRIME192V1 | PRIME192V1 |  |
| SB_EC_PRIME192V2 | PRIME192V2 |  |
| SB_EC_PRIME192V3 | PRIME192V3 |  |
| SB_EC_PRIME239V1 | PRIME239V1 |  |
| SB_EC_PRIME239V2 | PRIME239V2 |  |
| SB_EC_PRIME239V3 | PRIME239V3 |  |
| SB_EC_PRIME256V1 | PRIME256V1 |  |
| SB_EC_C2PNB163V1 | C2PNB163V1 |  |
| SB_EC_C2PNB163V2 | C2PNB163V2 |  |
| SB_EC_C2PNB163V3 | C2PNB163V3 |  |
| SB_EC_C2PNB176W1 | C2PNB176W1 |  |
| SB_EC_C2TNB191V1 | C2TNB191V1 |  |
| SB_EC_C2TNB191V2 | C2TNB191V2 |  |
| SB_EC_C2TNB191V3 | C2TNB191V3 |  |
| SB_EC_C2ONB191V4 | C2ONB191V4 |  |
| SB_EC_C2ONB191V5 | C2ONB191V5 |  |
| SB_EC_C2PNB208W1 | C2PNB208W1 |  |
| SB_EC_C2TNB239V1 | C2TNB239V1 |  |
| SB_EC_C2TNB239V2 | C2TNB239V2 |  |
| SB_EC_C2TNB239V3 | C2TNB239V3 |  |
| SB_EC_C2ONB239V4 | C2ONB239V4 |  |
| SB_EC_C2ONB239V5 | C2ONB239V5 |  |
| SB_EC_C2PNB272W1 | C2PNB272W1 |  |
| SB_EC_C2PNB304W1 | C2PNB304W1 |  |
| SB_EC_C2TNB359V1 | C2TNB359V1 |  |
| SB_EC_C2PNB368W1 | C2PNB368W1 |  |
| SB_EC_C2TNB431R1 | C2TNB431R1 |  |
| SB_EC_NISTP192 | NISTP192 |  |
| SB_EC_NISTP224 | NISTP224 |  |
| SB_EC_NISTP256 | NISTP256 |  |
| SB_EC_NISTP384 | NISTP384 |  |
| SB_EC_NISTP521 | NISTP521 |  |
| SB_EC_NISTB163 | NISTB163 |  |
| SB_EC_NISTB233 | NISTB233 |  |
| SB_EC_NISTB283 | NISTB283 |  |
| SB_EC_NISTB409 | NISTB409 |  |
| SB_EC_NISTB571 | NISTB571 |  |
| SB_EC_NISTK163 | NISTK163 |  |
| SB_EC_NISTK233 | NISTK233 |  |
| SB_EC_NISTK283 | NISTK283 |  |
| SB_EC_NISTK409 | NISTK409 |  |
| SB_EC_NISTK571 | NISTK571 |  |
| SB_EC_GOSTCPTEST | GOSTCPTEST |  |
| SB_EC_GOSTCPA | GOSTCPA |  |
| SB_EC_GOSTCPB | GOSTCPB |  |
| SB_EC_GOSTCPC | GOSTCPC |  |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA |  |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB |  |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 |  |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 |  |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 |  |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 |  |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 |  |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 |  |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 |  |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 |  |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 |  |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 |  |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 |  |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 |  |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 |  |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 |  |
| SB_EC_CURVE25519 | CURVE25519 |  |
| SB_EC_CURVE448 | CURVE448 |  |

This property is read-only.

# signing_cert_fingerprint property

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

## Syntax

```text
def get_signing_cert_fingerprint() -> str: ...
signing_cert_fingerprint = property(get_signing_cert_fingerprint, None)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

# signing_cert_friendly_name property

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

## Syntax

```text
def get_signing_cert_friendly_name() -> str: ...
signing_cert_friendly_name = property(get_signing_cert_friendly_name, None)
```

## Default Value

""

## Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

This property is read-only.

# signing_cert_handle property

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

## Syntax

```text
def get_signing_cert_handle() -> int: ...
signing_cert_handle = property(get_signing_cert_handle, None)
```

## Default Value

0

## Remarks

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

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

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

This property is read-only.

# signing_cert_hash_algorithm property

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

## Syntax

```text
def get_signing_cert_hash_algorithm() -> str: ...
signing_cert_hash_algorithm = property(get_signing_cert_hash_algorithm, None)
```

## Default Value

""

## Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [signing_cert_sig_algorithm](#signing_cert_sig_algorithm-property) to find out the hash algorithm that is part of the certificate signature.

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

This property is read-only.

# signing_cert_issuer property

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

## Syntax

```text
def get_signing_cert_issuer() -> str: ...
signing_cert_issuer = property(get_signing_cert_issuer, None)
```

## Default Value

""

## Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [signing_cert_issuer_rdn](#signing_cert_issuer_rdn-property).

This property is read-only.

# signing_cert_issuer_rdn property

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

## Syntax

```text
def get_signing_cert_issuer_rdn() -> str: ...
signing_cert_issuer_rdn = property(get_signing_cert_issuer_rdn, None)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

# signing_cert_key_algorithm property

Specifies the public key algorithm of this certificate.

## Syntax

```text
def get_signing_cert_key_algorithm() -> str: ...
signing_cert_key_algorithm = property(get_signing_cert_key_algorithm, None)
```

## Default Value

"0"

## Remarks

Specifies the public key algorithm of this certificate.

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

Use the [signing_cert_key_bits](#signing_cert_key_bits-property), [signing_cert_curve](#signing_cert_curve-property), and [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property) properties to get more details about the key the certificate contains.

This property is read-only.

# signing_cert_key_bits property

Returns the length of the public key in bits.

## Syntax

```text
def get_signing_cert_key_bits() -> int: ...
signing_cert_key_bits = property(get_signing_cert_key_bits, None)
```

## Default Value

0

## Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property) or [signing_cert_private_key_bytes](#signing_cert_private_key_bytes-property) property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

# signing_cert_key_fingerprint property

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

## Syntax

```text
def get_signing_cert_key_fingerprint() -> str: ...
signing_cert_key_fingerprint = property(get_signing_cert_key_fingerprint, None)
```

## Default Value

""

## Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the [signing_cert_fingerprint](#signing_cert_fingerprint-property) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

# signing_cert_key_usage property

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

## Syntax

```text
def get_signing_cert_key_usage() -> int: ...
signing_cert_key_usage = property(get_signing_cert_key_usage, None)
```

## Default Value

0

## Remarks

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

This value is a bit mask of the following values:

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

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

This property is read-only.

# signing_cert_key_valid property

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

## Syntax

```text
def get_signing_cert_key_valid() -> bool: ...
signing_cert_key_valid = property(get_signing_cert_key_valid, None)
```

## Default Value

FALSE

## Remarks

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

This property is read-only.

# signing_cert_ocsp_locations property

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

## Syntax

```text
def get_signing_cert_ocsp_locations() -> str: ...
signing_cert_ocsp_locations = property(get_signing_cert_ocsp_locations, None)
```

## Default Value

""

## Remarks

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

Set this property before calling the certificate manager's [generate](#CertificateManager_m_Generate) method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is read-only.

# signing_cert_ocsp_no_check property

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

## Syntax

```text
def get_signing_cert_ocsp_no_check() -> bool: ...
signing_cert_ocsp_no_check = property(get_signing_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.

# signing_cert_origin property

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

## Syntax

```text
def get_signing_cert_origin() -> int: ...
signing_cert_origin = property(get_signing_cert_origin, None)
```

## Default Value

0

## Remarks

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

This property is read-only.

# signing_cert_policy_i_ds property

Contains identifiers (OIDs) of the applicable certificate policies.

## Syntax

```text
def get_signing_cert_policy_i_ds() -> str: ...
signing_cert_policy_i_ds = property(get_signing_cert_policy_i_ds, None)
```

## Default Value

""

## Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

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

This property is read-only.

# signing_cert_private_key_bytes property

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

## Syntax

```text
def get_signing_cert_private_key_bytes() -> bytes: ...
signing_cert_private_key_bytes = property(get_signing_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.

# signing_cert_private_key_exists property

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

## Syntax

```text
def get_signing_cert_private_key_exists() -> bool: ...
signing_cert_private_key_exists = property(get_signing_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 [signing_cert_private_key_bytes](#signing_cert_private_key_bytes-property), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

This property is read-only.

# signing_cert_private_key_extractable property

Indicates whether the private key is extractable (exportable).

## Syntax

```text
def get_signing_cert_private_key_extractable() -> bool: ...
signing_cert_private_key_extractable = property(get_signing_cert_private_key_extractable, None)
```

## Default Value

FALSE

## Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

# signing_cert_public_key_bytes property

Contains the certificate's public key in DER format.

## Syntax

```text
def get_signing_cert_public_key_bytes() -> bytes: ...
signing_cert_public_key_bytes = property(get_signing_cert_public_key_bytes, None)
```

## Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

This property is read-only.

# signing_cert_qualified property

Indicates whether the certificate is qualified.

## Syntax

```text
def get_signing_cert_qualified() -> bool: ...
signing_cert_qualified = property(get_signing_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.

# signing_cert_qualified_statements property

Returns a simplified qualified status of the certificate.

## Syntax

```text
def get_signing_cert_qualified_statements() -> int: ...
signing_cert_qualified_statements = property(get_signing_cert_qualified_statements, None)
```

## Possible Values

```text
0   # NonQualified1   # QualifiedHardware2   # QualifiedSoftware
```

## Default Value

0

## Remarks

Returns a simplified qualified status of the certificate.

This property is read-only.

# signing_cert_qualifiers property

A list of qualifiers.

## Syntax

```text
def get_signing_cert_qualifiers() -> str: ...
signing_cert_qualifiers = property(get_signing_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.

# signing_cert_self_signed property

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

## Syntax

```text
def get_signing_cert_self_signed() -> bool: ...
signing_cert_self_signed = property(get_signing_cert_self_signed, None)
```

## Default Value

FALSE

## Remarks

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

This property is read-only.

# signing_cert_serial_number property

Returns the certificate's serial number.

## Syntax

```text
def get_signing_cert_serial_number() -> bytes: ...
signing_cert_serial_number = property(get_signing_cert_serial_number, None)
```

## Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

This property is read-only.

# signing_cert_sig_algorithm property

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

## Syntax

```text
def get_signing_cert_sig_algorithm() -> str: ...
signing_cert_sig_algorithm = property(get_signing_cert_sig_algorithm, None)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

# signing_cert_source property

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

## Syntax

```text
def get_signing_cert_source() -> int: ...
signing_cert_source = property(get_signing_cert_source, None)
```

## Possible Values

```text
0   # Unknown1   # Signature2   # Document3   # User4   # Local5   # Online
```

## Default Value

0

## Remarks

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

This property is read-only.

# signing_cert_subject property

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

## Syntax

```text
def get_signing_cert_subject() -> str: ...
signing_cert_subject = property(get_signing_cert_subject, None)
```

## Default Value

""

## Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [signing_cert_subject_rdn](#signing_cert_subject_rdn-property).

This property is read-only.

# signing_cert_subject_alternative_name property

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

## Syntax

```text
def get_signing_cert_subject_alternative_name() -> str: ...
signing_cert_subject_alternative_name = property(get_signing_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 [signing_cert_subject_rdn](#signing_cert_subject_rdn-property) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

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

This property is read-only.

# signing_cert_subject_key_id property

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

## Syntax

```text
def get_signing_cert_subject_key_id() -> bytes: ...
signing_cert_subject_key_id = property(get_signing_cert_subject_key_id, None)
```

## Remarks

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

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The [signing_cert_subject_key_id](#signing_cert_subject_key_id-property) and [signing_cert_ca_key_id](#signing_cert_ca_key_id-property) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is read-only.

# signing_cert_subject_rdn property

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

## Syntax

```text
def get_signing_cert_subject_rdn() -> str: ...
signing_cert_subject_rdn = property(get_signing_cert_subject_rdn, None)
```

## Default Value

""

## Remarks

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

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

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

This property is read-only.

# signing_cert_valid property

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

## Syntax

```text
def get_signing_cert_valid() -> bool: ...
signing_cert_valid = property(get_signing_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.

# signing_cert_valid_from property

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

## Syntax

```text
def get_signing_cert_valid_from() -> str: ...
signing_cert_valid_from = property(get_signing_cert_valid_from, None)
```

## Default Value

""

## Remarks

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

This property is read-only.

# signing_cert_valid_to property

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

## Syntax

```text
def get_signing_cert_valid_to() -> str: ...
signing_cert_valid_to = property(get_signing_cert_valid_to, None)
```

## Default Value

""

## Remarks

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

This property is read-only.

# timestamp_format property

Returns the format of the processed timestamp.

## Syntax

```text
def get_timestamp_format() -> int: ...
timestamp_format = property(get_timestamp_format, None)
```

## Possible Values

```text
0   # Unknown1   # RFC55442   # CMS3   # TSPReply
```

## Default Value

0

## Remarks

Use this property to check the format of the processed timestamp blob.

|  |  |  |
| --- | --- | --- |
| mtfUnknown | 0 | Unknown or unspecified format |
| mtfRFC5544 | 1 | RFC5544-compliant format, based on PKCS#7 TimeStampedData object |
| mtfCMS | 2 | A generic RFC3161 timestamp response object (TimeStampToken) |
| mtfTSPReply | 3 | Same as mtfCMS, but including the auxiliary TSA response wrapper (TimeStampResp) |

This property is read-only.

# validated_signing_time property

Contains the certified signing time.

## Syntax

```text
def get_validated_signing_time() -> str: ...
validated_signing_time = property(get_validated_signing_time, None)
```

## Default Value

""

## Remarks

Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.

This property is read-only.

# config method

Sets or retrieves a configuration setting.

## Syntax

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

## Remarks

config is a generic method available in every class. It is used to set and retrieve [configuration settings](#messagetimestampverifier-config-settings) for the class.

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

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

To read (query) the value of a [configuration setting](#messagetimestampverifier-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string.

# do_action method

Performs an additional action.

## Syntax

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

## Remarks

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

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

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

Common ActionIDs:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

# reset method

Resets the class settings.

## Syntax

```text
def reset() -> None: ...
```

## Remarks

reset is a generic method available in every class.

# verify method

Verifies a timestamped message.

## Syntax

```text
def verify() -> None: ...
```

## Remarks

Use this method to verify the enveloping timestamped message provided via [input_file](#input_file-property) (or input_stream). The original message will be extracted and saved to [output_file](#output_file-property) (output_stream).

Use [verify_detached](#verify_detached-method) to verify detached timestamps.

# verify_detached method

Verifies a detached timestamped message.

## Syntax

```text
def verify_detached() -> None: ...
```

## Remarks

Use this method to verify the detached timestamped message provided via [input_file](#input_file-property) (or input_stream). Please provide the original data via [data_file](#data_file-property) or data_stream property. You do not need to provide [output_file](#output_file-property) and output_stream, as no data is extracted during this call.

Use [verify](#verify-method) to verify enveloping timestamps.

# on_error event

Information about errors during PKCS#7 message encryption.

## Syntax

```text
class MessageTimestampVerifierErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

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

## Remarks

The event is fired in case of exceptional conditions during message processing.

*ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Messages](#messagetimestampverifier-errors) section.

# on_notification event

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

## Syntax

```text
class MessageTimestampVerifierNotificationEventParams(object):
  @property
  def event_id() -> str: ...

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

# In class MessageTimestampVerifier:
@property
def on_notification() -> Callable[[MessageTimestampVerifierNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[MessageTimestampVerifierNotificationEventParams], 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:

|  |  |
| --- | --- |
| Progress | Fires periodically to report the progress of the current operation. The EventParam parameter contains a slash-separated pair of values (Current/Total). |

# MessageTimestampVerifier Config Settings

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

### MessageTimestampVerifier Config Settings

**Accuracy**: TBD.TBD

**CMS**: TBD.TBD

**MediaType**: Media type.The media type.

**MessageImprint**: TBD.TBD

**MessageImprintAlgorithm**: TBD.TBD

**SerialNumber**: TBD.TBD

**TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply.

**Time**: TBD.TBD

**TimestampType**: TBD.TBD

**TSAName**: TBD.TBD

### Base Config Settings

**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.

**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

**CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

**DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

**EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

**GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global".

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

**HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

|  |  |  |
| --- | --- | --- |
| time |  | Current time |
| level |  | Level |
| package |  | Package name |
| module |  | Module name |
| class |  | Class name |
| method |  | Method name |
| threadid |  | Thread Id |
| contenttype |  | Content type |
| content |  | Content |
| all |  | All details |

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-package |  | Exclude a package specified in the value |
| exclude-module |  | Exclude a module specified in the value |
| exclude-class |  | Exclude a class specified in the value |
| exclude-method |  | Exclude a method specified in the value |
| include-package |  | Include a package specified in the value |
| include-module |  | Include a module specified in the value |
| include-class |  | Include a class specified in the value |
| include-method |  | Include a method specified in the value |

**LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | None (by default) |
| fatal |  | Severe errors that cause premature termination. |
| error |  | Other runtime errors or unexpected conditions. |
| warning |  | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". |
| info |  | Interesting runtime events (startup/shutdown). |
| debug |  | Detailed information on flow of through the system. |
| trace |  | More detailed information. |

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

**LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No rotation |
| deleteolder |  | Delete older entries from the cache upon reaching LogMaxEventCount |
| keepolder |  | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |

**MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

**MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

**OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example:

```text
PKICachePath=C:\Temp\cache
```

 In this example, the cached PKI data is stored in the C:\Temp\cache directory.

**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

**StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

**TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

**UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

**UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax:

```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```

**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

# MessageTimestampVerifier Errors

### MessageTimestampVerifier Errors

|  |  |
| --- | --- |
| 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) |
| 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) |
| 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) |
| 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) |
| 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) |
| 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) |
| 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) |
| 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) |
| 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |