CryptoKeyStorage Class
Properties Methods Events Configuration Settings Errors
The CryptoKeyStorage class offers key storage functionality for a variety of key store types.
Syntax
SecureBlackboxCryptoKeyStorage
SecureBlackboxCryptoKeyStorageSwift
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:(int)keyIndex | The algorithm of the cryptographic key. |
- keyBits:(int)keyIndex | The length of the key in bits. |
- keyExportable:(int)keyIndex | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
- keyHandle:(int)keyIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
- keyID:(int)keyIndex | Provides access to a storage-specific key identifier. |
- keyIV:(int)keyIndex | The initialization vector (IV) of a symmetric key. |
- keyKey:(int)keyIndex | The byte array representation of the key. |
- keyNonce:(int)keyIndex | A nonce value associated with a key. |
- keyPrivate:(int)keyIndex | Returns True if the object hosts a private key, and False otherwise. |
- keyPublic:(int)keyIndex | Returns True if the object hosts a public key, and False otherwise. |
- keySubject:(int)keyIndex | Returns the key subject. |
- keySymmetric:(int)keyIndex | Returns True if the object contains a symmetric key, and False otherwise. |
- keyValid:(int)keyIndex | 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:(int)selectedKeyIndex | The algorithm of the cryptographic key. |
- selectedKeyBits:(int)selectedKeyIndex | The length of the key in bits. |
- selectedKeyExportable:(int)selectedKeyIndex | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
- selectedKeyHandle:(int)selectedKeyIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
- selectedKeyID:(int)selectedKeyIndex | Provides access to a storage-specific key identifier. |
- selectedKeyIV:(int)selectedKeyIndex | The initialization vector (IV) of a symmetric key. |
- selectedKeyKey:(int)selectedKeyIndex | The byte array representation of the key. |
- selectedKeyNonce:(int)selectedKeyIndex | A nonce value associated with a key. |
- selectedKeyPrivate:(int)selectedKeyIndex | Returns True if the object hosts a private key, and False otherwise. |
- selectedKeyPublic:(int)selectedKeyIndex | Returns True if the object hosts a public key, and False otherwise. |
- selectedKeySubject:(int)selectedKeyIndex | Returns the key subject. |
- selectedKeySymmetric:(int)selectedKeyIndex | Returns True if the object contains a symmetric key, and False otherwise. |
- selectedKeyValid:(int)selectedKeyIndex | 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.
- onError | Fires when an errors happens during a key storage operation. |
- onNotification | This event notifies the application about an underlying control flow event. |
- onPasswordNeeded | 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. |