CryptoKeyStorage Class

Properties   Methods   Events   Config Settings   Errors  

The CryptoKeyStorage class offers key storage functionality for a variety of key store types.

Syntax

class secureblackbox.CryptoKeyStorage

Remarks

CryptoKeyStorage provides access to many types of key stores, such as files or PKCS#11.

Property List


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

fips_modeReserved.
key_countThe number of records in the Key arrays.
key_algorithmThe algorithm of the cryptographic key.
key_bitsThe length of the key in bits.
key_curveThis property specifies the name of the curve the EC key is built on.
key_exportableReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
key_fingerprintContains the fingerprint (a hash imprint) of this key.
key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
key_idProvides access to a storage-specific key identifier.
key_ivThe initialization vector (IV) of a symmetric key.
key_keyThe byte array representation of the key.
key_nonceA nonce value associated with a key.
key_privateReturns True if the object hosts a private key, and False otherwise.
key_publicReturns True if the object hosts a public key, and False otherwise.
key_subjectReturns the key subject.
key_symmetricReturns True if the object contains a symmetric key, and False otherwise.
key_validReturns True if this key is valid.
openedIndicates whether the storage is in the open state.
pinned_key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
selected_key_countThe number of records in the SelectedKey arrays.
selected_key_algorithmThe algorithm of the cryptographic key.
selected_key_bitsThe length of the key in bits.
selected_key_curveThis property specifies the name of the curve the EC key is built on.
selected_key_exportableReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
selected_key_fingerprintContains the fingerprint (a hash imprint) of this key.
selected_key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
selected_key_idProvides access to a storage-specific key identifier.
selected_key_ivThe initialization vector (IV) of a symmetric key.
selected_key_keyThe byte array representation of the key.
selected_key_nonceA nonce value associated with a key.
selected_key_privateReturns True if the object hosts a private key, and False otherwise.
selected_key_publicReturns True if the object hosts a public key, and False otherwise.
selected_key_subjectReturns the key subject.
selected_key_symmetricReturns True if the object contains a symmetric key, and False otherwise.
selected_key_validReturns True if this key is valid.
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.

add_pinnedAdds the pinned key to the storage.
clearRemoves all existing keys from the storage.
closeCloses the logical storage.
configSets or retrieves a configuration setting.
create_newCreates a new storage.
do_actionPerforms an additional action.
get_storage_propertyReturns the value of a custom key storage property.
import_bytesImports a key to the storage.
import_from_fileImports a key 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 key from the storage.
resetResets the class settings.
selectAllows the selection of keys from the store.
set_storage_propertySets the value of a custom key 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_errorFires when an errors happens during a key storage operation.
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.
PKCS11ActiveSlotThe index of the slot that the class is working with.
PKCS11AutoDetectStructAlignmentTBD.
PKCS11AutoGenerateKeyIDsTBD.
PKCS11CreatePublicKeyObjectsTBD.
PKCS11DelayedPublicKeyImportTBD.
PKCS11ForceUseForIndirectHashingOperationsTBD.
PKCS11IgnoreReportedSupportedAlgorithmsTBD.
PKCS11NewPINChanges the current user's PIN.
PKCS11NewUserPINRegisters a new user PIN.
PKCS11NormalizeSourceLengthTBD.
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.
PKCS11SmartKeyImportTBD.
PKCS11StoreKeysTBD.
PKCS11TextEncodingModeThe encoding mode to apply to non-ASCII text strings.
PKCS11ThreadSafeTBD.
PKCS11UseForHashingOperationsTBD.
PKCS11UseForNonPrivateOperationsTBD.
PKCS11UseForPublicKeyOperationsTBD.
PKCS11UseForSymmetricKeyOperationsTBD.
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.

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.

key_count Property

The number of records in the Key arrays.

Syntax

def get_key_count() -> int: ...

key_count = property(get_key_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only.

key_algorithm Property

The algorithm of the cryptographic key.

Syntax

def get_key_algorithm(key_index: int) -> str: ...

Default Value

""

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_DESDES
SB_SYMMETRIC_ALGORITHM_3DES3DES
SB_SYMMETRIC_ALGORITHM_RC2RC2
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES192AES192
SB_SYMMETRIC_ALGORITHM_AES256AES256
SB_SYMMETRIC_ALGORITHM_IDENTITYIdentity
SB_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_SYMMETRIC_ALGORITHM_CAST128CAST128
SB_SYMMETRIC_ALGORITHM_IDEAIDEA
SB_SYMMETRIC_ALGORITHM_TWOFISHTwofish
SB_SYMMETRIC_ALGORITHM_TWOFISH128Twofish128
SB_SYMMETRIC_ALGORITHM_TWOFISH192Twofish192
SB_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256
SB_SYMMETRIC_ALGORITHM_CAMELLIACamellia
SB_SYMMETRIC_ALGORITHM_CAMELLIA128Camellia128
SB_SYMMETRIC_ALGORITHM_CAMELLIA192Camellia192
SB_SYMMETRIC_ALGORITHM_CAMELLIA256Camellia256
SB_SYMMETRIC_ALGORITHM_SERPENTSerpent
SB_SYMMETRIC_ALGORITHM_SERPENT128Serpent128
SB_SYMMETRIC_ALGORITHM_SERPENT192Serpent192
SB_SYMMETRIC_ALGORITHM_SERPENT256Serpent256
SB_SYMMETRIC_ALGORITHM_SEEDSEED
SB_SYMMETRIC_ALGORITHM_RABBITRabbit
SB_SYMMETRIC_ALGORITHM_SYMMETRICGeneric
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989GOST-28147-1989
SB_SYMMETRIC_ALGORITHM_CHACHA20ChaCha20
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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_bits Property

The length of the key in bits.

Syntax

def get_key_bits(key_index: int) -> int: ...

Default Value

0

Remarks

The length of the key in bits.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_curve Property

This property specifies the name of the curve the EC key is built on.

Syntax

def get_key_curve(key_index: int) -> str: ...

Default Value

""

Remarks

This property specifies the name of the curve the EC key is built on.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_exportable Property

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

def get_key_exportable(key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_fingerprint Property

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

Syntax

def get_key_fingerprint(key_index: int) -> str: ...

Default Value

""

Remarks

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

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_handle Property

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

Syntax

def get_key_handle(key_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 key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_id Property

Provides access to a storage-specific key identifier.

Syntax

def get_key_id(key_index: int) -> bytes: ...

Remarks

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_iv Property

The initialization vector (IV) of a symmetric key.

Syntax

def get_key_iv(key_index: int) -> bytes: ...

Remarks

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_key Property

The byte array representation of the key.

Syntax

def get_key_key(key_index: int) -> bytes: ...

Remarks

The byte array representation of the key. This may not be available for non-key_exportable keys.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_nonce Property

A nonce value associated with a key.

Syntax

def get_key_nonce(key_index: int) -> bytes: ...

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_private Property

Returns True if the object hosts a private key, and False otherwise.

Syntax

def get_key_private(key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if the object hosts a private key, and False otherwise.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_public Property

Returns True if the object hosts a public key, and False otherwise.

Syntax

def get_key_public(key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if the object hosts a public key, and False otherwise.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_subject Property

Returns the key subject.

Syntax

def get_key_subject(key_index: int) -> bytes: ...

Remarks

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_symmetric Property

Returns True if the object contains a symmetric key, and False otherwise.

Syntax

def get_key_symmetric(key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if the object contains a symmetric key, and False otherwise.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_count property.

This property is read-only.

key_valid Property

Returns True if this key is valid.

Syntax

def get_key_valid(key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

The key_index parameter specifies the index of the item in the array. The size of the array is controlled by the key_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 key 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_key_handle Property

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

Syntax

def get_pinned_key_handle() -> int: ...
def set_pinned_key_handle(value: int) -> None: ...

pinned_key_handle = property(get_pinned_key_handle, set_pinned_key_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_key_count Property

The number of records in the SelectedKey arrays.

Syntax

def get_selected_key_count() -> int: ...

selected_key_count = property(get_selected_key_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_key_count - 1.

This property is read-only.

selected_key_algorithm Property

The algorithm of the cryptographic key.

Syntax

def get_selected_key_algorithm(selected_key_index: int) -> str: ...

Default Value

""

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_DESDES
SB_SYMMETRIC_ALGORITHM_3DES3DES
SB_SYMMETRIC_ALGORITHM_RC2RC2
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES192AES192
SB_SYMMETRIC_ALGORITHM_AES256AES256
SB_SYMMETRIC_ALGORITHM_IDENTITYIdentity
SB_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_SYMMETRIC_ALGORITHM_CAST128CAST128
SB_SYMMETRIC_ALGORITHM_IDEAIDEA
SB_SYMMETRIC_ALGORITHM_TWOFISHTwofish
SB_SYMMETRIC_ALGORITHM_TWOFISH128Twofish128
SB_SYMMETRIC_ALGORITHM_TWOFISH192Twofish192
SB_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256
SB_SYMMETRIC_ALGORITHM_CAMELLIACamellia
SB_SYMMETRIC_ALGORITHM_CAMELLIA128Camellia128
SB_SYMMETRIC_ALGORITHM_CAMELLIA192Camellia192
SB_SYMMETRIC_ALGORITHM_CAMELLIA256Camellia256
SB_SYMMETRIC_ALGORITHM_SERPENTSerpent
SB_SYMMETRIC_ALGORITHM_SERPENT128Serpent128
SB_SYMMETRIC_ALGORITHM_SERPENT192Serpent192
SB_SYMMETRIC_ALGORITHM_SERPENT256Serpent256
SB_SYMMETRIC_ALGORITHM_SEEDSEED
SB_SYMMETRIC_ALGORITHM_RABBITRabbit
SB_SYMMETRIC_ALGORITHM_SYMMETRICGeneric
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989GOST-28147-1989
SB_SYMMETRIC_ALGORITHM_CHACHA20ChaCha20
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_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_bits Property

The length of the key in bits.

Syntax

def get_selected_key_bits(selected_key_index: int) -> int: ...

Default Value

0

Remarks

The length of the key in bits.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_curve Property

This property specifies the name of the curve the EC key is built on.

Syntax

def get_selected_key_curve(selected_key_index: int) -> str: ...

Default Value

""

Remarks

This property specifies the name of the curve the EC key is built on.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_exportable Property

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

def get_selected_key_exportable(selected_key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_fingerprint Property

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

Syntax

def get_selected_key_fingerprint(selected_key_index: int) -> str: ...

Default Value

""

Remarks

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

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_handle Property

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

Syntax

def get_selected_key_handle(selected_key_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_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_id Property

Provides access to a storage-specific key identifier.

Syntax

def get_selected_key_id(selected_key_index: int) -> bytes: ...

Remarks

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_iv Property

The initialization vector (IV) of a symmetric key.

Syntax

def get_selected_key_iv(selected_key_index: int) -> bytes: ...

Remarks

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_key Property

The byte array representation of the key.

Syntax

def get_selected_key_key(selected_key_index: int) -> bytes: ...

Remarks

The byte array representation of the key. This may not be available for non-selected_key_exportable keys.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_nonce Property

A nonce value associated with a key.

Syntax

def get_selected_key_nonce(selected_key_index: int) -> bytes: ...

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_private Property

Returns True if the object hosts a private key, and False otherwise.

Syntax

def get_selected_key_private(selected_key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if the object hosts a private key, and False otherwise.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_public Property

Returns True if the object hosts a public key, and False otherwise.

Syntax

def get_selected_key_public(selected_key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if the object hosts a public key, and False otherwise.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_subject Property

Returns the key subject.

Syntax

def get_selected_key_subject(selected_key_index: int) -> bytes: ...

Remarks

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_symmetric Property

Returns True if the object contains a symmetric key, and False otherwise.

Syntax

def get_selected_key_symmetric(selected_key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if the object contains a symmetric key, and False otherwise.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_count property.

This property is read-only.

selected_key_valid Property

Returns True if this key is valid.

Syntax

def get_selected_key_valid(selected_key_index: int) -> bool: ...

Default Value

FALSE

Remarks

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

The selected_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_key_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 key 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.

add_pinned Method

Adds the pinned key to the storage.

Syntax

def add_pinned() -> None: ...

Remarks

This method adds a key attached to the pinned_key property to the storage. This method is a handy way of adding keys generated/returned by other components.

clear Method

Removes all existing keys from the storage.

Syntax

def clear() -> None: ...

Remarks

Use this method to empty the storage.

close Method

Closes the logical storage.

Syntax

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

Remarks

Use this method to close logical storages connected to PKCS#11-compliant hardware security modules, or storages of similar persistent kinds. Closing a persistent storage with this method is important, as unused but unclosed storages consume extra resources and may result in eventual key locks.

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

get_storage_property Method

Returns the value of a custom key storage property.

Syntax

def get_storage_property(prop_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.

Currently no custom properties are available for this component.

import_bytes Method

Imports a key to the storage.

Syntax

def import_bytes(value: bytes, format: int, key_algorithm: str, scheme: str, scheme_params: str, key_type: int, password: str) -> None: ...

Remarks

Use this method to add a key from a byte array.

kffUnknown0The key format was not recognized as one of the known formats.

kffAuto1The default format in current circumstances. This depends on the key being loaded or saved.

kffDER2DER (binary) format

kffPEM3PEM format (base64-encoded with headers)

kffJSON4JSON key format

ktAuto0The default key type in current circumstances. This depends on the operation, the file content, and the storage type.

ktPublic1The operation should be performed on a public key.

ktSecret2The operation should be performed on a private or secret key

import_from_file Method

Imports a key to the storage.

Syntax

def import_from_file(file_name: str, format: int, key_algorithm: str, scheme: str, scheme_params: str, key_type: int, password: str) -> None: ...

Remarks

Use this method to add a key stored in a file.

kffUnknown0The key format was not recognized as one of the known formats.

kffAuto1The default format in current circumstances. This depends on the key being loaded or saved.

kffDER2DER (binary) format

kffPEM3PEM format (base64-encoded with headers)

kffJSON4JSON key format

ktAuto0The default key type in current circumstances. This depends on the operation, the file content, and the storage type.

ktPublic1The operation should be performed on a public key.

ktSecret2The operation should be performed on a private or secret key

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 PKCS#11 stores the method returns a list of slot descriptions for all slots published by the driver.

The store identifiers 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. Key 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\keys.pem
  • file://C:/Certs/keys.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.

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.
  • readonly, whether to access the device with only read permissions. Use 0 for false, and 1 for true.
Example: pkcs11://john.doe:1234@/c:/windows/system32/asepkcs.dll?slot=0&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

refresh Method

Refreshes all storage keychains.

Syntax

def refresh() -> None: ...

Remarks

Call this method to refresh the storage.

remove Method

Removes a key from the storage.

Syntax

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

Remarks

Use this method to remove a key from the storage by 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 keys from the store.

Syntax

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

Remarks

This function allows the user to select keys from the storage by applying a Filter. PrivateKeyNeeded specifies whether only private keys should be selected. MaxCount limits the number of certificates selected.

set_storage_property Method

Sets the value of a custom key storage property.

Syntax

def set_storage_property(prop_name: str, prop_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.

Currently no custom properties are available for this component.

on_error Event

Fires when an errors happens during a key storage operation.

Syntax

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

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

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

Remarks

This event reports an exceptional situation during a key storage operation.

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 CryptoKeyStorageNotificationEventParams(object):
  @property
  def event_id() -> str: ...

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

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

Remarks

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

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

on_password_needed Event

This event is fired when a decryption password is needed.

Syntax

class CryptoKeyStoragePasswordNeededEventParams(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 CryptoKeyStorage:
@property
def on_password_needed() -> Callable[[CryptoKeyStoragePasswordNeededEventParams], None]: ...
@on_password_needed.setter
def on_password_needed(event_hook: Callable[[CryptoKeyStoragePasswordNeededEventParams], 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 key or certificate for which the password is requested.

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

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

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.

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.

PKCS11SmartKeyImport:   TBD.

TBD

PKCS11StoreKeys:   TBD.

TBD

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

TBD

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.

CryptoKeyStorage Errors

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