CryptoKeyStorage Class

Properties Methods Events Configuration 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.


key_count	The number of records in the Key arrays.
key_algorithm	The algorithm of the cryptographic key.
key_bits	The length of the key in bits.
key_exportable	Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
key_id	Provides access to a storage-specific key identifier.
key_iv	The initialization vector (IV) of a symmetric key.
key_key	The byte array representation of the key.
key_nonce	A nonce value associated with a key.
key_private	Returns True if the object hosts a private key, and False otherwise.
key_public	Returns True if the object hosts a public key, and False otherwise.
key_subject	Returns the key subject.
key_symmetric	Returns True if the object contains a symmetric key, and False otherwise.
key_valid	Returns True if this key is valid.
opened	Indicates whether the storage is in the open state.
pinned_key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
selected_key_count	The number of records in the SelectedKey arrays.
selected_key_algorithm	The algorithm of the cryptographic key.
selected_key_bits	The length of the key in bits.
selected_key_exportable	Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
selected_key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
selected_key_id	Provides access to a storage-specific key identifier.
selected_key_iv	The initialization vector (IV) of a symmetric key.
selected_key_key	The byte array representation of the key.
selected_key_nonce	A nonce value associated with a key.
selected_key_private	Returns True if the object hosts a private key, and False otherwise.
selected_key_public	Returns True if the object hosts a public key, and False otherwise.
selected_key_subject	Returns the key subject.
selected_key_symmetric	Returns True if the object contains a symmetric key, and False otherwise.
selected_key_valid	Returns True if this key is valid.
storage_id	A unique identifier of this storage.
storage_location	Specifies 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_pinned	Adds the pinned key to the storage.
clear	Removes all existing keys from the storage.
close	Closes the logical storage.
config	Sets or retrieves a configuration setting.
create_new	Creates a new storage.
import_bytes	Adds a key to the storage.
import_from_file	Adds a key to the storage.
open	Opens existing storage or creates one in memory.
refresh	Refreshes all storage keychains.
remove	Removes a key from the storage.
select	Allows the selection of keys from the store.

Event List

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


on_error	Fires when an errors happens during a key storage operation.
on_notification	This event notifies the application about an underlying control flow event.
on_password_needed	This event is fired when a decryption password is needed.

Configuration Settings

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


TempPath	Path for storing temporary files.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.