CertificateStorage Class

Properties   Methods   Events   Config Settings   Errors  

The CertificateStorage class works with collections of certificates.

Syntax

class secureblackbox.CertificateStorage

Remarks

CertificateStorage can work with certificates residing on a variety of media. Among others, it can access certificates residing in files, Windows and macOS system stores, and PKCS#11 devices. All such kinds of media can be accessed via a simple, unified interface, which makes CertificateStorage a handy certificate access option. Most users of SecureBlackbox use this component to access certificates residing on hardware devices. CertificateStorage is also a good alternative to CertificateManager where the certificate file contains more than one certificate.

To access certificates stored on certain type of media, start with the open method. Provide the location of your certificates via a uniform URI-like specifier. Once the storage has been opened, you can access the certificates contained in it via the certificates property.

Iterate over certificates by using the certificates property, or use filtering facilities such as select and select_chain. You can add certificates to the storage with the import_bytes, import_from_file, and import_pinned methods. In the latter case please assign the certificate object to be imported to the pinned_cert property.

Use create_new method to create a new storage. Note that not all storage kinds can be created.

When you have finished working with the certificate storage, close it with the close method.

Certain types of stores must be kept open for the certificates to continue to be usable. This means that while you can copy a certificate to a different storage, or assign it to a different component, you still must keep the storage it originates from open for as long as you intend to use that certificate in your code. This is because the storage is often a bridge between a certificate and its private key, and by closing the storage early you are destroying this bridge prematurely. See the code example below:

 
 Copy
  // This code, although syntactically correct, will fail because the storage is closed too early:
  storage.Open("pkcs11://user:12345@localhost/C:/Windows/System32/asepkcs.dll");
  pdfSigner.SigningCertificate = storage.Certificates[0];
  storage.Close(false); // the private key of the SigningCertificate gets lost after this call
  pdfSigner.Sign(); // returns an error

  // This code will work as expected
  storage.Open("pkcs11://user:12345@localhost/C:/Windows/System32/asepkcs.dll");
  pdfSigner.SigningCertificate = storage.Certificates[0];
  pdfSigner.Sign();
  storage.Close(false);

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

cert_count Property

The number of records in the Cert arrays.

Syntax

def get_cert_count() -> int: ...

cert_count = property(get_cert_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• cert_bytes
• cert_ca
• cert_ca_key_id
• cert_cert_type
• cert_crl_distribution_points
• cert_curve
• cert_fingerprint
• cert_friendly_name
• cert_handle
• cert_hash_algorithm
• cert_issuer
• cert_issuer_rdn
• cert_key_algorithm
• cert_key_bits
• cert_key_fingerprint
• cert_key_usage
• cert_key_valid
• cert_ocsp_locations
• cert_ocsp_no_check
• cert_origin
• cert_policy_i_ds
• cert_private_key_bytes
• cert_private_key_exists
• cert_private_key_extractable
• cert_public_key_bytes
• cert_qualified
• cert_qualified_statements
• cert_qualifiers
• cert_self_signed
• cert_serial_number
• cert_sig_algorithm
• cert_source
• cert_subject
• cert_subject_alternative_name
• cert_subject_key_id
• cert_subject_rdn
• cert_valid
• cert_valid_from
• cert_valid_to

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

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

Remarks

Returns the raw certificate data in DER format.

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_ca Property

Indicates whether the certificate has a CA capability.

Syntax

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

This property is read-only.

cert_ca_key_id Property

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

Syntax

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

This property is read-only.

cert_cert_type Property

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

Syntax

def get_cert_cert_type(cert_index: int) -> int: ...

Possible Values

0   # Unknown
1   # X509Certificate
2   # X509CertificateRequest

Default Value

0

Remarks

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

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

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

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_crl_distribution_points Property

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

Syntax

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

This property is read-only.

cert_curve Property

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

Syntax

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.

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_fingerprint Property

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

Syntax

def get_cert_fingerprint(cert_index: int) -> 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 property.

This property is read-only.

cert_friendly_name Property

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

Syntax

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

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate. The 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 property.

This property is read-only.

cert_handle Property

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

Syntax

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

Default Value

0

Remarks

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

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

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_hash_algorithm Property

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

Syntax

def get_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 to find out the hash algorithm that is part of the certificate signature.

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_issuer Property

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

Syntax

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

Default Value

""

Remarks

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

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_issuer_rdn Property

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

Syntax

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

This property is read-only.

cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

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

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the cert_key_bits, cert_curve, and cert_public_key_bytes 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 property.

This property is read-only.

cert_key_bits Property

Returns the length of the public key in bits.

Syntax

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

This property is read-only.

cert_key_fingerprint Property

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

Syntax

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

This property is read-only.

cert_key_usage Property

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

Syntax

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

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

This property is read-only.

cert_key_valid Property

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

Syntax

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

Default Value

FALSE

Remarks

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

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_ocsp_locations Property

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

Syntax

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

This property is read-only.

cert_ocsp_no_check Property

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

Syntax

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

This property is read-only.

cert_origin Property

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

Syntax

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

This property is read-only.

cert_policy_i_ds Property

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

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

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

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

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

This property is read-only.

cert_private_key_bytes Property

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

Syntax

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

This property is read-only.

cert_private_key_exists Property

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

Syntax

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

This property is read-only.

cert_private_key_extractable Property

Indicates whether the private key is extractable (exportable).

Syntax

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

This property is read-only.

cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

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

Remarks

Contains the certificate's public key in DER format.

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

This property is read-only.

cert_qualified Property

Indicates whether the certificate is qualified.

Syntax

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

This property is read-only.

cert_qualified_statements Property

Returns a simplified qualified status of the certificate.

Syntax

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

Possible Values

0   # NonQualified
1   # QualifiedHardware
2   # 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 property.

This property is read-only.

cert_qualifiers Property

A list of qualifiers.

Syntax

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

This property is read-only.

cert_self_signed Property

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

Syntax

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

Default Value

FALSE

Remarks

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

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_serial_number Property

Returns the certificate's serial number.

Syntax

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

Remarks

Returns the certificate's serial number.

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

This property is read-only.

cert_sig_algorithm Property

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

Syntax

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

Default Value

""

Remarks

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

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

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

Possible Values

0   # Unknown
1   # Signature
2   # Document
3   # User
4   # Local
5   # 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 property.

This property is read-only.

cert_subject Property

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

Syntax

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

Default Value

""

Remarks

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

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_subject_alternative_name Property

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

Syntax

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

This property is read-only.

cert_subject_key_id Property

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

Syntax

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

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_subject_rdn Property

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

Syntax

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

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

This property is read-only.

cert_valid_from Property

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

Syntax

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

Default Value

""

Remarks

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

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

cert_valid_to Property

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

Syntax

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

Default Value

""

Remarks

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

The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.

This property is read-only.

crl_count Property

The number of records in the CRL arrays.

Syntax

def get_crl_count() -> int: ...

crl_count = property(get_crl_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• crl_bytes
• crlca_key_id
• crl_entry_count
• crl_handle
• crl_issuer
• crl_issuer_rdn
• crl_location
• crl_next_update
• crl_sig_algorithm
• crl_source
• crltbs
• crl_this_update

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

This property is read-only.

crl_bytes Property

Returns the raw CRL data in DER format.

Syntax

def get_crl_bytes(crl_index: int) -> bytes: ...

Remarks

Returns the raw CRL data in DER format.

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crlca_key_id Property

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

Syntax

def get_crlca_key_id(crl_index: int) -> bytes: ...

Remarks

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crl_entry_count Property

Returns the number of certificate status entries in the CRL.

Syntax

def get_crl_entry_count(crl_index: int) -> int: ...

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crl_handle Property

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

Syntax

def get_crl_handle(crl_index: int) -> int: ...

Default Value

0

Remarks

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

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

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crl_issuer Property

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

Syntax

def get_crl_issuer(crl_index: int) -> str: ...

Default Value

""

Remarks

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

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crl_issuer_rdn Property

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

Syntax

def get_crl_issuer_rdn(crl_index: int) -> str: ...

Default Value

""

Remarks

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

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crl_location Property

The URL that the CRL was downloaded from.

Syntax

def get_crl_location(crl_index: int) -> str: ...

Default Value

""

Remarks

The URL that the CRL was downloaded from.

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crl_next_update Property

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

Syntax

def get_crl_next_update(crl_index: int) -> str: ...

Default Value

""

Remarks

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

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crl_sig_algorithm Property

The public key algorithm that was used by the CA to sign this CRL.

Syntax

def get_crl_sig_algorithm(crl_index: int) -> str: ...

Default Value

"0"

Remarks

The public key algorithm that was used by the CA to sign this CRL.

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crl_source Property

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

Syntax

def get_crl_source(crl_index: int) -> int: ...

Possible Values

0   # Unknown
1   # Signature
2   # Document
3   # User
4   # Local
5   # 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 crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crltbs Property

The to-be-signed part of the CRL (the CRL without the signature part).

Syntax

def get_crltbs(crl_index: int) -> bytes: ...

Remarks

The to-be-signed part of the CRL (the CRL without the signature part).

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

crl_this_update Property

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

Syntax

def get_crl_this_update(crl_index: int) -> str: ...

Default Value

""

Remarks

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

The crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the crl_count property.

This property is read-only.

fips_mode Property

Reserved.

Syntax

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

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

ocsp_count Property

The number of records in the OCSP arrays.

Syntax

def get_ocsp_count() -> int: ...

ocsp_count = property(get_ocsp_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• ocsp_bytes
• ocsp_entry_count
• ocsp_handle
• ocsp_issuer
• ocsp_issuer_rdn
• ocsp_location
• ocsp_produced_at
• ocsp_sig_algorithm
• ocsp_source

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

This property is read-only.

ocsp_bytes Property

A buffer containing the raw OCSP response data.

Syntax

def get_ocsp_bytes(ocsp_index: int) -> bytes: ...

Remarks

A buffer containing the raw OCSP response data.

The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.

This property is read-only.

ocsp_entry_count Property

The number of SingleResponse elements contained in this OCSP response.

Syntax

def get_ocsp_entry_count(ocsp_index: int) -> int: ...

Default Value

0

Remarks

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.

This property is read-only.

ocsp_handle Property

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

Syntax

def get_ocsp_handle(ocsp_index: int) -> int: ...

Default Value

0

Remarks

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

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

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.

This property is read-only.

ocsp_issuer Property

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

Syntax

def get_ocsp_issuer(ocsp_index: int) -> str: ...

Default Value

""

Remarks

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

The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.

This property is read-only.

ocsp_issuer_rdn Property

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

Syntax

def get_ocsp_issuer_rdn(ocsp_index: int) -> str: ...

Default Value

""

Remarks

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

The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.

This property is read-only.

ocsp_location Property

The location of the OCSP responder.

Syntax

def get_ocsp_location(ocsp_index: int) -> str: ...

Default Value

""

Remarks

The location of the OCSP responder.

The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.

This property is read-only.

ocsp_produced_at Property

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

Syntax

def get_ocsp_produced_at(ocsp_index: int) -> str: ...

Default Value

""

Remarks

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

The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.

This property is read-only.

ocsp_sig_algorithm Property

The public key algorithm that was used by the CA to sign this OCSP response.

Syntax

def get_ocsp_sig_algorithm(ocsp_index: int) -> str: ...

Default Value

"0"

Remarks

The public key algorithm that was used by the CA to sign this OCSP response.

The ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.

This property is read-only.

ocsp_source Property

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

Syntax

def get_ocsp_source(ocsp_index: int) -> int: ...

Possible Values

0   # Unknown
1   # Signature
2   # Document
3   # User
4   # Local
5   # 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 ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the ocsp_count property.

This property is read-only.

opened Property

Indicates whether the storage is in the open state.

Syntax

def get_opened() -> bool: ...

opened = property(get_opened, None)

Default Value

FALSE

Remarks

Use this property to check if the storage has been 'opened.' Different kinds of certificate storages imply different meanings for 'being opened', but generally a storage is open if it is available for operations.

Use open method to open a storage.

This property is read-only.

pinned_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_pinned_cert_bytes() -> bytes: ...

pinned_cert_bytes = property(get_pinned_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

pinned_cert_handle Property

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

Syntax

def get_pinned_cert_handle() -> int: ...
def set_pinned_cert_handle(value: int) -> None: ...

pinned_cert_handle = property(get_pinned_cert_handle, set_pinned_cert_handle)

Default Value

0

Remarks

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

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

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

pinned_crl_bytes Property

Returns the raw CRL data in DER format.

Syntax

def get_pinned_crl_bytes() -> bytes: ...

pinned_crl_bytes = property(get_pinned_crl_bytes, None)

Remarks

Returns the raw CRL data in DER format.

This property is read-only.

pinned_crl_handle Property

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

Syntax

def get_pinned_crl_handle() -> int: ...
def set_pinned_crl_handle(value: int) -> None: ...

pinned_crl_handle = property(get_pinned_crl_handle, set_pinned_crl_handle)

Default Value

0

Remarks

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

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

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

pinned_ocsp_bytes Property

A buffer containing the raw OCSP response data.

Syntax

def get_pinned_ocsp_bytes() -> bytes: ...

pinned_ocsp_bytes = property(get_pinned_ocsp_bytes, None)

Remarks

A buffer containing the raw OCSP response data.

This property is read-only.

pinned_ocsp_handle Property

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

Syntax

def get_pinned_ocsp_handle() -> int: ...
def set_pinned_ocsp_handle(value: int) -> None: ...

pinned_ocsp_handle = property(get_pinned_ocsp_handle, set_pinned_ocsp_handle)

Default Value

0

Remarks

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

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

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

selected_cert_count Property

The number of records in the SelectedCert arrays.

Syntax

def get_selected_cert_count() -> int: ...

selected_cert_count = property(get_selected_cert_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• selected_cert_bytes
• selected_cert_ca
• selected_cert_ca_key_id
• selected_cert_cert_type
• selected_cert_crl_distribution_points
• selected_cert_curve
• selected_cert_fingerprint
• selected_cert_friendly_name
• selected_cert_handle
• selected_cert_hash_algorithm
• selected_cert_issuer
• selected_cert_issuer_rdn
• selected_cert_key_algorithm
• selected_cert_key_bits
• selected_cert_key_fingerprint
• selected_cert_key_usage
• selected_cert_key_valid
• selected_cert_ocsp_locations
• selected_cert_ocsp_no_check
• selected_cert_origin
• selected_cert_policy_i_ds
• selected_cert_private_key_bytes
• selected_cert_private_key_exists
• selected_cert_private_key_extractable
• selected_cert_public_key_bytes
• selected_cert_qualified
• selected_cert_qualified_statements
• selected_cert_qualifiers
• selected_cert_self_signed
• selected_cert_serial_number
• selected_cert_sig_algorithm
• selected_cert_source
• selected_cert_subject
• selected_cert_subject_alternative_name
• selected_cert_subject_key_id
• selected_cert_subject_rdn
• selected_cert_valid
• selected_cert_valid_from
• selected_cert_valid_to

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

This property is read-only.

selected_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_selected_cert_bytes(selected_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_ca Property

Indicates whether the certificate has a CA capability.

Syntax

def get_selected_cert_ca(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_ca_key_id Property

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

Syntax

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_cert_type Property

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

Syntax

def get_selected_cert_cert_type(selected_cert_index: int) -> int: ...

Possible Values

0   # Unknown
1   # X509Certificate
2   # X509CertificateRequest

Default Value

0

Remarks

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

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

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_crl_distribution_points Property

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

Syntax

def get_selected_cert_crl_distribution_points(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_curve Property

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

Syntax

def get_selected_cert_curve(selected_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.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_fingerprint Property

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

Syntax

def get_selected_cert_fingerprint(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_friendly_name Property

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

Syntax

def get_selected_cert_friendly_name(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_handle Property

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

Syntax

def get_selected_cert_handle(selected_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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_hash_algorithm Property

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

Syntax

def get_selected_cert_hash_algorithm(selected_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 selected_cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_issuer Property

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

Syntax

def get_selected_cert_issuer(selected_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 selected_cert_issuer_rdn.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_issuer_rdn Property

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

Syntax

def get_selected_cert_issuer_rdn(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_selected_cert_key_algorithm(selected_cert_index: int) -> str: ...

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the selected_cert_key_bits, selected_cert_curve, and selected_cert_public_key_bytes properties to get more details about the key the certificate contains.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_selected_cert_key_bits(selected_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 selected_cert_public_key_bytes or selected_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_key_fingerprint Property

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

Syntax

def get_selected_cert_key_fingerprint(selected_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 selected_cert_fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_key_usage Property

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

Syntax

def get_selected_cert_key_usage(selected_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:

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_key_valid Property

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

Syntax

def get_selected_cert_key_valid(selected_cert_index: int) -> bool: ...

Default Value

FALSE

Remarks

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_ocsp_locations Property

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

Syntax

def get_selected_cert_ocsp_locations(selected_cert_index: int) -> str: ...

Default Value

""

Remarks

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

Set this property before calling the certificate manager's generate method to propagate it to the new certificate.

The 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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_ocsp_no_check Property

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

Syntax

def get_selected_cert_ocsp_no_check(selected_cert_index: int) -> bool: ...

Default Value

FALSE

Remarks

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_origin Property

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

Syntax

def get_selected_cert_origin(selected_cert_index: int) -> int: ...

Default Value

0

Remarks

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_policy_i_ds Property

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

def get_selected_cert_policy_i_ds(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_private_key_bytes Property

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

Syntax

def get_selected_cert_private_key_bytes(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_private_key_exists Property

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

Syntax

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_private_key_extractable Property

Indicates whether the private key is extractable (exportable).

Syntax

def get_selected_cert_private_key_extractable(selected_cert_index: int) -> bool: ...

Default Value

FALSE

Remarks

Indicates whether the private key is extractable (exportable).

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

def get_selected_cert_public_key_bytes(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_qualified Property

Indicates whether the certificate is qualified.

Syntax

def get_selected_cert_qualified(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_qualified_statements Property

Returns a simplified qualified status of the certificate.

Syntax

def get_selected_cert_qualified_statements(selected_cert_index: int) -> int: ...

Possible Values

0   # NonQualified
1   # QualifiedHardware
2   # QualifiedSoftware

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_qualifiers Property

A list of qualifiers.

Syntax

def get_selected_cert_qualifiers(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_self_signed Property

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

Syntax

def get_selected_cert_self_signed(selected_cert_index: int) -> bool: ...

Default Value

FALSE

Remarks

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_selected_cert_serial_number(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_sig_algorithm Property

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

Syntax

def get_selected_cert_sig_algorithm(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_source Property

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

Syntax

def get_selected_cert_source(selected_cert_index: int) -> int: ...

Possible Values

0   # Unknown
1   # Signature
2   # Document
3   # User
4   # Local
5   # 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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_subject Property

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

Syntax

def get_selected_cert_subject(selected_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 selected_cert_subject_rdn.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_subject_alternative_name Property

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

Syntax

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

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_subject_key_id Property

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

Syntax

def get_selected_cert_subject_key_id(selected_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 selected_cert_subject_key_id and selected_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_subject_rdn Property

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

Syntax

def get_selected_cert_subject_rdn(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_valid Property

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

Syntax

def get_selected_cert_valid(selected_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 selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_valid_from Property

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

Syntax

def get_selected_cert_valid_from(selected_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

selected_cert_valid_to Property

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

Syntax

def get_selected_cert_valid_to(selected_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The selected_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_cert_count property.

This property is read-only.

storage_id Property

A unique identifier of this storage.

Syntax

def get_storage_id() -> str: ...

storage_id = property(get_storage_id, None)

Default Value

""

Remarks

Use this property to get a unique ID of this storage. The format of ID may differ for different kinds of certificate storages, and may range from a file path for a file storage, to a URI-like ID for a PKCS#11 storage, to an empty value for an in-memory storage.

This property is read-only.

storage_location Property

Specifies the location of the currently opened storage.

Syntax

def get_storage_location() -> str: ...

storage_location = property(get_storage_location, None)

Default Value

""

Remarks

Use this property to get the location of the active storage. The location indicates the nature of the storage and can be assigned with one of the below values (more values may be added in future):

This property is read-only.

clear Method

Removes all certificates from the storage.

Syntax

def clear() -> None: ...

Remarks

Use this method to empty the storage.

close Method

Closes the certificate storage.

Syntax

def close(save: bool) -> None: ...

Remarks

Use this method to close the storage component and clean up any resources associated with it.

This method releases all memory objects and handles associated with the certificates contained in the storage. Any certificate objects originating from the storage become invalid as soon as the storage is closed, and should not be used.

Save parameter only applies to certain types of stores, such as file stores. Set it to True to commit any changes to the underlying media. Note that PKCS#11 and Win32 storage types are of transactional nature and commit any changes immediately, so the value of the Save parameter does not make any difference with them.

config Method

Sets or retrieves a configuration setting.

Syntax

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

Remarks

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

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

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

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

create_new Method

Creates a new storage.

Syntax

def create_new(storage_location: str, storage_id: str) -> None: ...

Remarks

Use this method to create new certificate storage.

StorageLocation specifies where the new storage should be created, and StorageID contains a unique storage identifier.

do_action Method

Performs an additional action.

Syntax

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

Remarks

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

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

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

Common ActionIDs:

export_bytes Method

Exports the certificates in the chosen format.

Syntax

def export_bytes(what: int, format: int, password: str) -> bytes: ...

Remarks

Use this method to save the certificates in one of the formats defined below.

Pass the encryption password via the Password parameter if needed.

Note that not all formats support encryption, and some (like PEM) only support partial encryption (key only). Keep this in mind when considering which format to choose for storing your certificates.

export_to_file Method

Exports the certificates to a file.

Syntax

def export_to_file(what: int, file_name: str, format: int, password: str) -> None: ...

Remarks

Use this method to save the certificates to a file in one of the formats given below. Pass the encryption password via the Password parameter.

Note that not all formats support encryption, and some (like PEM) only support partial encryption (key only). Keep this in mind when considering which format to choose for storing your certificates.

get_storage_property Method

Returns the value of a custom certificate storage property.

Syntax

def get_storage_property(name: str) -> str: ...

Remarks

This method, together with set_storage_property, provides an extensible way of managing the certificate storage's settings that are not available through the primary properties of the component. The list of settings may be extended in future, in response to emergence of new storage variants and recognition of non-obvious storage usage scenarios.

The following certificate storage properties can be read using this method:

import_bytes Method

Imports a certificate.

Syntax

def import_bytes(cert_bytes: bytes, password: str, clear: bool) -> None: ...

Remarks

Use this method to load a certificate or certificates from a byte array. Provide the password via the Password parameter. The Password parameter is optional. If it is omitted and it is later discovered that the certificate is password-encrypted, the on_password_needed event will be fired to request it.

This method supports certificates in DER, PEM, PFX, and SPC formats. Multi-certificate blobs certificate files are supported.

Use the Clear parameter to tell the component whether it should empty the storage before importing the new certificates.

Hint: use this method with Clear set to false to mimic the behavior of the previous version's Add() method.

import_from_file Method

Loads a certificate from a file.

Syntax

def import_from_file(path: str, password: str, clear: bool) -> None: ...

Remarks

This method can load certificates saved in a file in one of the following formats: DER, PEM, PFX, SPC.

Use the Path parameter to provide a path to the certificate file, and Password to specify the password.

The Password parameter is optional. If it is omitted and it is later discovered that the certificate is password-encrypted, the on_password_needed event will be fired to request it.

This method supports certificates in DER, PEM, PFX, and SPC formats. Multi-certificate blobs certificate files are supported.

Use the Clear parameter to tell the component whether it should empty the storage before importing the new certificates.

Hint: use this method with Clear set to false to mimic the behavior of the previous version's AddFromFile() method.

import_pinned Method

Adds the pinned certificate to the storage.

Syntax

def import_pinned(clear: bool) -> None: ...

Remarks

This method adds a certificate attached to the pinned_cert property into the storage. This method is a handy way of adding certificates generated/returned by other components.

Use the Clear parameter to tell the component whether it should empty the storage before importing the new certificate.

Hint: use this method with Clear set to false to mimic the behavior of the previous version's AddPinned() method.

list_stores Method

Returns a list of individual stores available within the storage.

Syntax

def list_stores() -> str: ...

Remarks

Use this method to query a list of individual stores available in the opened storage.

The contents of the list depends on the type of the store used and the parameters it is opened with. For system (CryptoAPI) stores the method returns a list of available system stores for the chosen access type, as returned by Windows (e.g. MY, ADDRESSBOOK, CA). For PKCS#11 stores the method returns a list of slot descriptions for all slots published by the driver.

The store names are separated from each other with a CRLF sequence.

login Method

Signs in to a session or elevates the session rights.

Syntax

def login(session_type: int, pin: str, read_only: bool) -> None: ...

Remarks

Use this method to sign in to a session with a required access type. Note that in some cases you may call this method more than one time for a specific session to elevate your access rights, for example:

 
 Copy
// open an unauthenticated session
storage.Login(stUnauthenticated, "", false);

// elevate the access rights for the session
storage.Login(stUser, "password", false);

Sessions are currently supported for PKCS#11 storage types only.

logout Method

Signs out of an opened session.

Syntax

def logout(close_sesion: bool) -> None: ...

Remarks

Use this method to sign out of a session. Pass true to CloseSession to shut the session down altogether.

This method is currently support for PKCS#11 storage type only.

open Method

Opens existing storage or creates one in memory.

Syntax

def open(storage_id: str) -> None: ...

Remarks

Use this method to open the storage with the given StorageID. Certificate storages can come from several different locations, detailed below.

Memory

A storage can be created in memory by passing an empty string ("").

File

A storage can be opened from a file using one of two syntaxes:

• C:\Certs\certs.pem
• file://C:/Certs/certs.pem

Windows System

A storage can be opened from the Windows System using this syntax: system://{user}@{host}/?{params}

user is one of these values:

• currentuser
• localmachine
• currentservice

host is either "localhost", an IP address, or FQDN.

params are chosen from this list:

• store (required), is the name of the Windows store to access (e.g. "MY")
• readonly, whether to access the store with only read permissions. Use 0 for false, and 1 for true.

Example: system://currentuser@localhost/?store=MY&readonly=1

PKCS#11 Device

A storage can be opened from a PKCS#11 device using this syntax: pkcs11://{user}:{pin}@/{driverpath}?{params}

user is the username used to access the device; typically it's either "user" or "admin".

pin is the pin code used to access the device.

driverpath is the path to the driver used to access the device.

params are chosen from this list:

• slot, the token slot to access on the device. If not provided, one will be chosen automatically. If set to -1, no session will be opened.
• readonly, whether to access the device with only read permissions. Use 0 for false, and 1 for true.
• login, whether to sign in to the device with a PIN. Use 0 or no to avoid signing in, or 1 or yes to enforce it. When not specified, the yes mode is used.

Example: pkcs11://user:1234@/c:/windows/system32/asepkcs.dll?slot=0&readonly=1

macOS

A keychain can be opened on macOS using this syntax: macos://:{password}@/{keychain}?{params}

This is the right way to perform cryptographic operations using private keys, including non-exportable private keys. By now, only certificates with RSA keys are supported, other certificates are not listed and are not used.

keychain is the path to a keychain file. If no keychain specified, the default keychain is opened.

password is the keychain access password. If no password is provided, it will be asked by macOS UI if necessary. To access a keychain in readonly mode, no password is needed usually.

params are chosen from this list:

• readonly, whether to access the keychain with only read permissions. Use 0 for false, and 1 for true.

Example: macos://:f00Keys@/Users/test/Documents/test.keychain?readonly=0

iOS

A keychain can be opened on iOS using this syntax: ios:///?{params}

iOS doesn't support keychains located in files. By now, only certificates with RSA keys are supported, other certificates are not listed and are not used.

params are chosen from this list:

• readonly, whether to access the keychain with only read permissions. Use 0 for false, and 1 for true.

Example: ios:///?readonly=1

KMIP Server

A storage can be opened from a KMIP server using this syntax: mailto:{password}@{remotehost}:{remoteport}/?{params}

password is the password use to authenticate to the server.

remotehost is the FQDN to the server.

remoteport is the server port to connect to.

params are chosen from this list:

• encoder, the message encoding used to communicate with the server. Possible values are:
  • 1 (XML)
  • 2 (JSON)
  • 3 (TTLV)

Example: mailto:password@kmip.website.com:5696/?encoder=1

Apple

A storage can be opened on macOS using this syntax: apple:///{path}/?{params}

This is a legacy way to work with keychains on macOS and iOS.

path is the path for storage file.

params are chosen from this list:

• keychainindex, key chain index. If not provided, one will be set to 0.
• readonly, whether to access the storage with only read permissions. Use 0 for false, and 1 for true.

Example: apple:///Users/test/Documents/test.storage?readonly=1 A storage can be opened on iOS using this syntax: apple:///?{params}

params are chosen from this list:

• readonly, whether to access the storage with only read permissions. Use 0 for false, and 1 for true.

Example: apple:///?readonly=1

In Xamarin projects for iOS keychain support should be enabled manually. To do this: 1. Double click on Entitlements.plist file, go to "Entitlements" tab and turn "Enable Keychain" option on. 2. Go to project options, select "iOS Bundle Signing", choose correct configuration and platform and set "Custom Entitlements" to "Entitlements.plist" value.

Azure Key Vault

A storage can be opened from the Azure Key Vault service using this syntax: vault://{clientid}:{clientsecret}@{vaultname}.{vaulthost}/

clientid is the client id obtained from Azure Portal when registering an app.

clientsecret is the client secret obtained from Azure Portal when registering an app.

vaultname is the name of the vault to connect to.

vaulthost is the Cloud environment where the vault is located; supported environments are:

Example: vault://xxxx:yyyy@myvault.vault.azure.net/

refresh Method

Refreshes all storage keychains.

Syntax

def refresh() -> None: ...

Remarks

Call this method to refresh the storage.

remove Method

Removes a certificate from the storage.

Syntax

def remove(index: int) -> None: ...

Remarks

Use this method to remove the certificate from the storage given its index.

remove_crl Method

Removes a CRL from the storage.

Syntax

def remove_crl(index: int) -> None: ...

Remarks

Use this method to remove a CRL from the storage given its index.

remove_ocsp Method

Removes an OCSP response from the storage.

Syntax

def remove_ocsp(index: int) -> None: ...

Remarks

Use this method to remove an OCSP response from the storage given its index.

reset Method

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

select Method

Allows the selection of certificates from the system store.

Syntax

def select(filter: str, private_key_needed: bool, max_count: int) -> None: ...

Remarks

This function allows the user to select certificates from the system store by Filter and save them to selected_certificates. PrivateKeyNeeded specifies whether the method only should consider certificates having associated private keys. MaxCount limits the number of certificates selected.

The supported filters are listed below. Split the name and value of a specific filter with colon (:). Use | separator to pass more than one filter. During the search, the filters are joined using OR logic.

• subjectkeyid: the subject key identifier, in hexadecimal format.
• cakeyid: the key identifier of the issuing certificate, in hexadecimal format.
• serialnumber: the serial number of the certificate, in hexadecimal format.
• keyusage: certificate key usage flags. Use bitwise OR to specify several key usage flags using the values shown below.
• fingerprint: certificate fingerprint in hexadecimal format. MD5, SHA1, SHA256, and SHA512 fingerprints are supported.
• email: the e-mail parameter of the certificate subject.
• subject: the subject of the certificate, either as an RDN, or as its common name parameter.
• issuer: the issuer of the certificate, either as an RDN or a common name.
• ui (Windows system stores only): whether to use UI dialog to select a certificate. Supported values: true, false, 1, 0. All other filters are ignored if this filter is specified.
• * (asterisk): selects all certificates. This filter should always be used as a single character, not as a name:value pair.

Examples of filters

ui:1 - use Windows certificate selection dialog to let the user select a certificate visually.

* - select all certificates.

email:user@server.com - select all certificates with subject RDNs containing this e-mail address.

fingerprint:0a1b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d - select all certificates with this SHA1 fingerprint.

subject:/C=US/O=Big Company Inc/CN=Signing Certificate - select all certificates with the specified subject RDN.

keyusage:3|email:user@server.com - select all certificates with key usages of Digital Signature or Non-Repudiation, or those having this e-mail address in their subject.

Key usage flags

select_chain Method

Selects a chain of certificates given its index.

Syntax

def select_chain(index: int) -> None: ...

Remarks

Use this method to select a certificate chain given its index.

set_storage_property Method

Sets the value of a custom certificate storage property.

Syntax

def set_storage_property(name: str, value: str) -> None: ...

Remarks

This method, together with get_storage_property, provides an extensible way of managing the certificate storage's settings that are not available through the primary properties of the component. The list of settings may be extended in future, in response to emergence of new storage variants and recognition of non-obvious storage usage scenarios.

The following certificate storage properties can be read using this method:

on_error Event

Information about errors during certificate loading or saving.

Syntax

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

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

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

Remarks

Reports exceptional conditions during certificate loading or exporting.

ErrorCode contains an error code and Description contains a textual description of the error.

on_notification Event

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

Syntax

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

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

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

on_password_needed Event

This event is fired when a decryption password is needed.

Syntax

class CertificateStoragePasswordNeededEventParams(object):
  @property
  def needed_for() -> str: ...

  @property
  def password() -> str: ...
  @password.setter
  def password(value) -> None: ...

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

# In class CertificateStorage:
@property
def on_password_needed() -> Callable[[CertificateStoragePasswordNeededEventParams], None]: ...
@on_password_needed.setter
def on_password_needed(event_hook: Callable[[CertificateStoragePasswordNeededEventParams], None]) -> None: ...

Remarks

The class fires this event when a password is needed to decrypt a certificate or a private key.

In the handler of this event, assign the password to the Password parameter, or set Cancel to true to abort the operation.

The NeededFor parameter identifies the certificate for which the password is requested.

CertificateStorage Config Settings

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

CertificateStorage Config Settings

Base Config Settings

CertificateStorage Errors

CertificateStorage Errors