CryptoKeyStorage Class

Properties Methods Events Configuration Settings Errors

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

Syntax

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.


KeyCount	The number of records in the Key arrays.
KeyAlgorithm	The algorithm of the cryptographic key.
KeyBits	The length of the key in bits.
KeyExportable	Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
KeyHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
KeyID	Provides access to a storage-specific key identifier.
KeyIV	The initialization vector (IV) of a symmetric key.
KeyKey	The byte array representation of the key.
KeyNonce	A nonce value associated with a key.
KeyPrivate	Returns True if the object hosts a private key, and False otherwise.
KeyPublic	Returns True if the object hosts a public key, and False otherwise.
KeySubject	Returns the key subject.
KeySymmetric	Returns True if the object contains a symmetric key, and False otherwise.
KeyValid	Returns True if this key is valid.
Opened	Indicates whether the storage is in the open state.
PinnedKeyHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedKeyCount	The number of records in the SelectedKey arrays.
SelectedKeyAlgorithm	The algorithm of the cryptographic key.
SelectedKeyBits	The length of the key in bits.
SelectedKeyExportable	Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
SelectedKeyHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedKeyID	Provides access to a storage-specific key identifier.
SelectedKeyIV	The initialization vector (IV) of a symmetric key.
SelectedKeyKey	The byte array representation of the key.
SelectedKeyNonce	A nonce value associated with a key.
SelectedKeyPrivate	Returns True if the object hosts a private key, and False otherwise.
SelectedKeyPublic	Returns True if the object hosts a public key, and False otherwise.
SelectedKeySubject	Returns the key subject.
SelectedKeySymmetric	Returns True if the object contains a symmetric key, and False otherwise.
SelectedKeyValid	Returns True if this key is valid.
StorageID	A unique identifier of this storage.
StorageLocation	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.


AddPinned	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.
CreateNew	Creates a new storage.
ImportBytes	Adds a key to the storage.
ImportFromFile	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.


Error	Fires when an errors happens during a key storage operation.
Notification	This event notifies the application about an underlying control flow event.
PasswordNeeded	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.