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

cert_countThe number of records in the Cert arrays.
cert_bytesReturns the raw certificate data in DER format.
cert_caIndicates whether the certificate has a CA capability.
cert_ca_key_idA unique identifier (fingerprint) of the CA certificate's cryptographic key.
cert_cert_typeReturns the type of the entity contained in the Certificate object.
cert_crl_distribution_pointsContains a list of locations of CRL distribution points used to check this certificate's validity.
cert_curveSpecifies the elliptic curve associated with the certificate's public key.
cert_fingerprintContains the fingerprint (a hash imprint) of this certificate.
cert_friendly_nameContains an associated alias (friendly name) of the certificate.
cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
cert_hash_algorithmProvides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
cert_issuerThe common name of the certificate issuer (CA), typically a company name.
cert_issuer_rdnA list of Property=Value pairs that uniquely identify the certificate issuer.
cert_key_algorithmSpecifies the public key algorithm of this certificate.
cert_key_bitsReturns the length of the public key in bits.
cert_key_fingerprintReturns a SHA1 fingerprint of the public key contained in the certificate.
cert_key_usageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
cert_key_validReturns True if the certificate's key is cryptographically valid, and False otherwise.
cert_ocsp_locationsLocations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
cert_ocsp_no_checkAccessor to the value of the certificate's ocsp-no-check extension.
cert_originReturns the location that the certificate was taken or loaded from.
cert_policy_i_dsContains identifiers (OIDs) of the applicable certificate policies.
cert_private_key_bytesReturns the certificate's private key in DER-encoded format.
cert_private_key_existsIndicates whether the certificate has a usable private key associated with it.
cert_private_key_extractableIndicates whether the private key is extractable (exportable).
cert_public_key_bytesContains the certificate's public key in DER format.
cert_qualifiedIndicates whether the certificate is qualified.
cert_qualified_statementsReturns a simplified qualified status of the certificate.
cert_qualifiersA list of qualifiers.
cert_self_signedIndicates whether the certificate is self-signed (root) or signed by an external CA.
cert_serial_numberReturns the certificate's serial number.
cert_sig_algorithmIndicates the algorithm that was used by the CA to sign this certificate.
cert_sourceReturns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
cert_subjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
cert_subject_alternative_nameReturns or sets the value of the Subject Alternative Name extension of the certificate.
cert_subject_key_idContains a unique identifier of the certificate's cryptographic key.
cert_subject_rdnA list of Property=Value pairs that uniquely identify the certificate holder (subject).
cert_validIndicates 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_fromThe time point at which the certificate becomes valid, in UTC.
cert_valid_toThe time point at which the certificate expires, in UTC.
crl_countThe number of records in the CRL arrays.
crl_bytesReturns the raw CRL data in DER format.
crlca_key_idA unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
crl_entry_countReturns the number of certificate status entries in the CRL.
crl_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
crl_issuerThe common name of the CRL issuer (CA), typically a company name.
crl_issuer_rdnA collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
crl_locationThe URL that the CRL was downloaded from.
crl_next_updateThe planned time and date of the next version of this CRL to be published.
crl_sig_algorithmThe public key algorithm that was used by the CA to sign this CRL.
crl_sourceReturns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
crltbsThe to-be-signed part of the CRL (the CRL without the signature part).
crl_this_updateThe date and time at which this version of the CRL was published.
fips_modeReserved.
ocsp_countThe number of records in the OCSP arrays.
ocsp_bytesA buffer containing the raw OCSP response data.
ocsp_entry_countThe number of SingleResponse elements contained in this OCSP response.
ocsp_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ocsp_issuerIndicates the issuer of this response (a CA or its authorized representative).
ocsp_issuer_rdnIndicates the RDN of the issuer of this response (a CA or its authorized representative).
ocsp_locationThe location of the OCSP responder.
ocsp_produced_atSpecifies the time when the response was produced, in UTC.
ocsp_sig_algorithmThe public key algorithm that was used by the CA to sign this OCSP response.
ocsp_sourceReturns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
openedIndicates whether the storage is in the open state.
pinned_cert_bytesReturns the raw certificate data in DER format.
pinned_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
pinned_crl_bytesReturns the raw CRL data in DER format.
pinned_crl_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
pinned_ocsp_bytesA buffer containing the raw OCSP response data.
pinned_ocsp_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
selected_cert_countThe number of records in the SelectedCert arrays.
selected_cert_bytesReturns the raw certificate data in DER format.
selected_cert_caIndicates whether the certificate has a CA capability.
selected_cert_ca_key_idA unique identifier (fingerprint) of the CA certificate's cryptographic key.
selected_cert_cert_typeReturns the type of the entity contained in the Certificate object.
selected_cert_crl_distribution_pointsContains a list of locations of CRL distribution points used to check this certificate's validity.
selected_cert_curveSpecifies the elliptic curve associated with the certificate's public key.
selected_cert_fingerprintContains the fingerprint (a hash imprint) of this certificate.
selected_cert_friendly_nameContains an associated alias (friendly name) of the certificate.
selected_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
selected_cert_hash_algorithmProvides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
selected_cert_issuerThe common name of the certificate issuer (CA), typically a company name.
selected_cert_issuer_rdnA list of Property=Value pairs that uniquely identify the certificate issuer.
selected_cert_key_algorithmSpecifies the public key algorithm of this certificate.
selected_cert_key_bitsReturns the length of the public key in bits.
selected_cert_key_fingerprintReturns a SHA1 fingerprint of the public key contained in the certificate.
selected_cert_key_usageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
selected_cert_key_validReturns True if the certificate's key is cryptographically valid, and False otherwise.
selected_cert_ocsp_locationsLocations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
selected_cert_ocsp_no_checkAccessor to the value of the certificate's ocsp-no-check extension.
selected_cert_originReturns the location that the certificate was taken or loaded from.
selected_cert_policy_i_dsContains identifiers (OIDs) of the applicable certificate policies.
selected_cert_private_key_bytesReturns the certificate's private key in DER-encoded format.
selected_cert_private_key_existsIndicates whether the certificate has a usable private key associated with it.
selected_cert_private_key_extractableIndicates whether the private key is extractable (exportable).
selected_cert_public_key_bytesContains the certificate's public key in DER format.
selected_cert_qualifiedIndicates whether the certificate is qualified.
selected_cert_qualified_statementsReturns a simplified qualified status of the certificate.
selected_cert_qualifiersA list of qualifiers.
selected_cert_self_signedIndicates whether the certificate is self-signed (root) or signed by an external CA.
selected_cert_serial_numberReturns the certificate's serial number.
selected_cert_sig_algorithmIndicates the algorithm that was used by the CA to sign this certificate.
selected_cert_sourceReturns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
selected_cert_subjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
selected_cert_subject_alternative_nameReturns or sets the value of the Subject Alternative Name extension of the certificate.
selected_cert_subject_key_idContains a unique identifier of the certificate's cryptographic key.
selected_cert_subject_rdnA list of Property=Value pairs that uniquely identify the certificate holder (subject).
selected_cert_validIndicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
selected_cert_valid_fromThe time point at which the certificate becomes valid, in UTC.
selected_cert_valid_toThe time point at which the certificate expires, in UTC.
storage_idA unique identifier of this storage.
storage_locationSpecifies the location of the currently opened storage.

Method List


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

clearRemoves all certificates from the storage.
closeCloses the certificate storage.
configSets or retrieves a configuration setting.
create_newCreates a new storage.
do_actionPerforms an additional action.
export_bytesExports the certificates in the chosen format.
export_to_fileExports the certificates to a file.
get_storage_propertyReturns the value of a custom certificate storage property.
import_bytesImports a certificate.
import_from_fileLoads a certificate from a file.
import_pinnedAdds the pinned certificate to the storage.
list_storesReturns a list of individual stores available within the storage.
loginSigns in to a session or elevates the session rights.
logoutSigns out of an opened session.
openOpens existing storage or creates one in memory.
refreshRefreshes all storage keychains.
removeRemoves a certificate from the storage.
remove_crlRemoves a CRL from the storage.
remove_ocspRemoves an OCSP response from the storage.
resetResets the class settings.
selectAllows the selection of certificates from the system store.
select_chainSelects a chain of certificates given its index.
set_storage_propertySets the value of a custom certificate storage property.

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_errorInformation about errors during certificate loading or saving.
on_notificationThis event notifies the application about an underlying control flow event.
on_password_neededThis event is fired when a decryption password is needed.

Config Settings


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

AuthAttemptsThe number of auth/login attempts to try.
CertValidationTimes[i].
CertValidities[i].
CertValidityReasons[i].
ContainerNameSpecifies the key container name for the imported certificate.
FriendlyNameGets or sets the certificate friendly name.
KeyExportableSpecifies the Exportable setting for the imported key.
KeyProtectedSpecifies the Protected setting for the imported key.
PfxAlgorithmSets the PFX encryption algorithm.
PKCS11ActiveSlotThe index of the slot that the class is working with.
PKCS11LabelReturns the HSM label.
PKCS11LoginGets or sets the current PKCS#11 login type.
PKCS11NewPINChanges the current user's PIN.
PKCS11NewUserPINRegisters a new user PIN.
PKCS11PINSets the operation PIN.
PKCS11SlotControls the number of a PKCS#11 slot to be opened.
PKCS11SlotCountThe number of slots exposed in the storage.
PKCS11SlotDescription[i]A human-readable description of the slot.
PKCS11SlotLoggedIn[i]Whether slot i has an active session associated with it.
PKCS11SlotLoginRequired[i]Specifies whether the token expects the user to sign in.
PKCS11SlotPinNeeded[i]Whether slot i requires you to provide a PIN to log in or sign.
PKCS11SlotReadOnly[i]Whether slot i only supports read-only access.
PKCS11SlotTokenFlags[i]The capabilities flags of the inserted token.
PKCS11SlotTokenLabel[i]The label assigned to the token.
PKCS11SlotTokenModel[i]The token model.
PKCS11SlotTokenPresent[i]Indicates whether there is a token in the slot.
PKCS11SlotTokenSerial[i]The serial number of the token.
PKCS11SlotTokenVendorID[i]The manufacturer ID of the inserted token.
PKCS11SlotVendorID[i]Returns the manufacturer ID of the slot.
PKCS11TextEncodingModeThe encoding mode to apply to non-ASCII text strings.
StoreNameSpecifies the name of the system store to import the certificate to.
TempPathPath for storing temporary files.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

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:

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

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.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

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

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_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 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.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

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

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

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:

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

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:

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

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

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

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.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

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

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

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.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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

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

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

cslUnspecifiedunspecified
cslMemorymemoryin-memory storage

cslFilefilefile storage

cslSystemsystemOS-specific certificate storage (e.g. CryptoAPI)

cslPKCS11pkcs11PKCS#11 compatible device

cslKMIPkmip
cslAppleappleApple certificates storage (macOS and iOS only)

cslJavajavajava key storage

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.

cslUnspecifiedunspecified
cslMemorymemoryin-memory storage

cslFilefilefile storage

cslSystemsystemOS-specific certificate storage (e.g. CryptoAPI)

cslPKCS11pkcs11PKCS#11 compatible device

cslKMIPkmip
cslAppleappleApple certificates storage (macOS and iOS only)

cslJavajavajava key storage

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

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.

cfmUnknown0Unknown certificate format

cfmDER1DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported

cfmPEM2PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys.

cfmPFX3PFX/PKCS#12 file format. Applicable to certificates. Encryption supported.

cfmSPC4SPC file format. Applicable to certificates. Encryption not supported.

cfmPVK5PVK file format. Applicable to private keys. Encryption not supported.

cfmPKCS86PKCS#8 file format. Applicable to private keys. Encryption supported.

cfmNET7NET file format. Applicable to private keys. Encryption not supported.

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.

cfmUnknown0Unknown certificate format

cfmDER1DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported

cfmPEM2PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys.

cfmPFX3PFX/PKCS#12 file format. Applicable to certificates. Encryption supported.

cfmSPC4SPC file format. Applicable to certificates. Encryption not supported.

cfmPVK5PVK file format. Applicable to private keys. Encryption not supported.

cfmPKCS86PKCS#8 file format. Applicable to private keys. Encryption supported.

cfmNET7NET file format. Applicable to private keys. Encryption not supported.

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:

PKCS11SlotCountReturns the number of slots available in an opened PKCS#11 storage.
PKCS11ActiveSlotReturns the index of the PKCS#11 slot that is currently being accessed.
PKCS11PINThe PIN for the storage and/or operation, previously set with set_storage_property call.
PKCS11TextEncodingModeThe string encoding mode to apply to the PIN when passing it to C_Login() method. This can be changed by passing the relevant setting to set_storage_property.
PKCS11SlotThe slot number to open, set previously with set_storage_property.
PKCS11LoginThe user account to sign in with, set previously with set_storage_property
PKCS11SlotLoggedIn[i]Returns true if there is an active session associated with slot number i.
PKCS11SlotPinNeeded[i]Returns true if you need to provide a PIN to sign in to the session for slot i.
PKCS11SlotReadOnly[i]Returns the availability of the slot for write operations.
PKCS11SlotVendorID[i]Returns the manufacturer name associated with the slot.
PKCS11SlotDescription[i]A human-readable description of the slot.
PKCS11SlotTokenPresent[i]Indicates whether there is a token in the slot.
PKCS11SlotTokenVendorID[i]The manufacturer ID of the inserted token.
PKCS11SlotTokenLabel[i]The label assigned to the token.
PKCS11SlotTokenModel[i]The token model.
PKCS11SlotTokenSerial[i]The serial number of the token.
PKCS11SlotTokenFlags[i]The value of the PKCS#11 token flags parameter.

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

stUnauthenticated0
stUser1
stAdministrator2

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:

Cloud environmentvaulthost
Azure Cloudvault.azure.net
Azure China Cloudvault.azure.cn
Azure US Governmentvault.usgovcloudapi.net
Azure German Cloudvault.microsoftazure.de
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

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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:

PKCS11PINUse this property to provide your PIN on the fly for an operation requiring the private key (e.g. signing). This may be useful if the PIN was not provided on the Open stage.
PKCS11NewUserPINSetting this property will register a new PIN to the HSM user account. This property is the way to administratively reset the user's PIN, and can only be set from under the 'admin' session.
PKCS11NewPINSetting this property will change the current users's PIN to the provided value. Most HSMs require the user to be signed in to perform this operation. This is the way to change your own PIN, either for admin or regular user accounts.
PKCS11TextEncodingModeThe string encoding mode to apply to the PIN when passing it to C_Login() method. This can be changed by passing the relevant setting to set_storage_property.
PKCS11SlotSpecifies the slot number to open, from 0 to (PKCS11SlotCount - 1). Use the 'auto' value to let the component pick the slot automatically, or -1 to stop the component from opening any slots.
PKCS11LoginProvides a PKCS#11 user ID to sign in with. The following options are available: 'user' (normal user), 'so' (security officer), or 'no' (do not sign in).

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:

PKCS11BeforeLoadDriverFires before the driver DLL is loaded.
PKCS11BeforeLoginFires before the C_Login() function is called.
PKCS11BeforeOpenSessionFires before C_OpenSession() is called.
PKCS11DriverLoadedReports that the driver has been successfully loaded.
PKCS11LoggedInNotifies about successful sign-in.
PKCS11LoginErrorNotifies about a sign-in issue.
PKCS11SessionOpenedNotifies the application that the session has been opened.

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

AuthAttempts:   The number of auth/login attempts to try.

Specifies the number of tries to authenticate to the storage (the default is 3). The control will fire PasswordNeeded event after each unsuccessful attempt. Applicable to: PKCS11.

CertValidationTimes[i]:   .

Returns the validation moments for every certificate in the store.

CertValidities[i]:   .

Returns the validity markers of the certificate objects.

CertValidityReasons[i]:   .

Returns the validation details for each of the certificate objects in the store.

ContainerName:   Specifies the key container name for the imported certificate.

This setting allows to provide a key container name for the certificate that is to be imported. This is often used when associating CA-provided certificate with a previously generated private key.

FriendlyName:   Gets or sets the certificate friendly name.

Use this read-only indexed property to obtain the friendly name of a specific certificate in the storage.

KeyExportable:   Specifies the Exportable setting for the imported key.

KeyExportable and KeyProtected configs allow the application to specify the desired private key protection parameters for certificates imported into a Windows system store.

KeyProtected:   Specifies the Protected setting for the imported key.

KeyExportable and KeyProtected configs allow the application to specify the desired private key protection parameters for certificates imported into a Windows system store. Protected keys invoke a warning UI dialog when accessed.

PfxAlgorithm:   Sets the PFX encryption algorithm.

Use this property to adjust the encryption algorithm(s) that will be used when saving the certificate to PFX format. This setting accepts a string containing either one PBE algorithm name (in which case it will be used to encrypt both the certificate and its private key), or two semicolon-separated PBE algorithm names (in which case the first will be used to encrypt the private key, and the second to encrypt the certificate).

The following values are supported for either algorithm:

  • PBES2-PBKDF2-SHA256-AES256
  • PBES2-PBKDF2-SHA1-AES256
  • PBE-SHA1-RC4-128
  • PBE-SHA1-RC4-40
  • PBE-SHA1-3DES
  • PBE-SHA1-RC2-128
  • PBE-SHA1-RC2-40
Apart from the above, a special legacy alias is supported that maps to PBE-SHA1-3DES when used for the private key part, or to PBE-SHA1-RC2-40 when used for the certificate part.

PKCS11ActiveSlot:   The index of the slot that the component is working with.

Returns the index of the PKCS#11 slot that is currently being accessed.

PKCS11Label:   Returns the HSM label.

Returns the label of the currently opened PKCS#11 device.

PKCS11Login:   Gets or sets the current PKCS#11 login type.

The primary purpose of this setting is to allow provision/change of the login type on a later stage (when the storage has already been opened).

The two common PKCS#11 login types are user and admin.

PKCS11NewPIN:   Changes the current user's PIN.

Setting this property will change the current users's PIN to the provided value. Most HSMs require the user to be signed in to perform this operation. This is the way to change your own PIN, either for admin or regular user accounts.

PKCS11NewUserPIN:   Registers a new user PIN.

Setting this property will register a new PIN to the HSM user account. This property is the way to administratively reset the user's PIN, and can only be set from under the 'admin' session.

PKCS11PIN:   Sets the operation PIN.

Use this property to provide your PIN on the fly for an operation requiring the private key (e.g. signing). This may be useful if the PIN was not provided on the Open stage.

PKCS11Slot:   Controls the number of a PKCS#11 slot to be opened.

Use this property to set the number of slot to be opened late into the process (after the storage has been opened). Use the auto placeholder to tell the component to select the slot automatically.

PKCS11SlotCount:   The number of slots exposed in the storage.

Returns the number of slots available in an opened PKCS#11 storage.

PKCS11SlotDescription[i]:   A human-readable description of the slot.

Returns a human-readable description of slot i.

PKCS11SlotLoggedIn[i]:   Whether slot i has an active session associated with it.

Returns true if there is an active session associated with slot number i.

PKCS11SlotLoginRequired[i]:   Specifies whether the token expects the user to sign in.

Specifies whether the token in the slot #i expects the user to sign in to perform further operations with the token.

PKCS11SlotPinNeeded[i]:   Whether slot i requires you to provide a PIN to log in or sign.

Returns true if you need to provide a PIN to sign in to the session for slot i.

PKCS11SlotReadOnly[i]:   Whether slot i only supports read-only access.

Returns the availability of the slot for write operations.

PKCS11SlotTokenFlags[i]:   The capabilities flags of the inserted token.

Returns the capabilities flags for the token inserted into slot number i.

PKCS11SlotTokenLabel[i]:   The label assigned to the token.

Returns the label assigned to the token.

PKCS11SlotTokenModel[i]:   The token model.

Returns the model of the token as provided by the driver.

PKCS11SlotTokenPresent[i]:   Indicates whether there is a token in the slot.

Returns true if slot number i has a token inserted.

PKCS11SlotTokenSerial[i]:   The serial number of the token.

Returns the serial number of the token.

PKCS11SlotTokenVendorID[i]:   The manufacturer ID of the inserted token.

Returns vendor ID string for slot number i.

PKCS11SlotVendorID[i]:   Returns the manufacturer ID of the slot.

Returns the manufacturer name associated with the slot.

PKCS11TextEncodingMode:   The encoding mode to apply to non-ASCII text strings.

Specifies the method to approach strings (e.g. PINs) containing international characters when accessing PKCS#11 devices. The following options are available:

  • standard: use UTF8, as instructed by the PKCS#11 specification.
  • ansi: use Ansi (local) code page to convert text to the byte arrays that are passed over to the driver.
  • smart: if the standard approach fails, try the ansi approach automatically
StoreName:   Specifies the name of the system store to import the certificate to.

Use this property to adjust the name of the certificate store where the certificate should be imported to.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

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:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

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

DNSLocalSuffix:   The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

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

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

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

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

HardwareCryptoUsePolicy:   The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

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

HttpVersion:   The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert:   Whether to tolerate the expired Windows Update signing certificate.

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

ListDelimiter:   The delimiter character for multi-element lists.

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

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

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

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

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

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

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

OldClientSideRSAFallback:   Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

ProductVersion:   Returns the version of the SecureBlackbox library.

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

ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

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

StaticIPAddresses:   Gets or sets all the static DNS rules.

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

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

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

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation:   Enables legacy AdES validation mode.

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

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

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

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

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

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

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

CertificateStorage Errors

CertificateStorage Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)