SecureBlackbox 2020 Python Edition

Questions / Feedback?

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_countThe number of records in the Key arrays.
key_algorithmThe algorithm of the cryptographic key.
key_bitsThe length of the key in bits.
key_exportableReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
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_exportableReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
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.
import_bytesAdds a key to the storage.
import_from_fileAdds a key to the storage.
openOpens existing storage or creates one in memory.
refreshRefreshes all storage keychains.
removeRemoves a key from the storage.
selectAllows 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_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.

Configuration Settings


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

TempPathPath for storing temporary files.
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 (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
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.
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.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Python Edition - Version 20.0 [Build 8165]