CryptoKeyStorage Class
Properties Methods Events Configuration Settings Errors
The CryptoKeyStorage class offers key storage functionality for a variety of key store types.
Class Name
SecureBlackboxLite_CryptoKeyStorage
Procedural Interface
secureblackboxlite_cryptokeystorage_open(); secureblackboxlite_cryptokeystorage_close($res); secureblackboxlite_cryptokeystorage_register_callback($res, $id, $function); secureblackboxlite_cryptokeystorage_get_last_error($res); secureblackboxlite_cryptokeystorage_get_last_error_code($res); secureblackboxlite_cryptokeystorage_set($res, $id, $index, $value); secureblackboxlite_cryptokeystorage_get($res, $id, $index); secureblackboxlite_cryptokeystorage_do_addpinned($res); secureblackboxlite_cryptokeystorage_do_clear($res); secureblackboxlite_cryptokeystorage_do_close($res, $save); secureblackboxlite_cryptokeystorage_do_config($res, $configurationstring); secureblackboxlite_cryptokeystorage_do_createnew($res, $storagelocation, $storageid); secureblackboxlite_cryptokeystorage_do_importbytes($res, $value, $format, $keyalgorithm, $scheme, $schemeparams, $keytype); secureblackboxlite_cryptokeystorage_do_importfromfile($res, $filename, $format, $keyalgorithm, $scheme, $schemeparams, $keytype); secureblackboxlite_cryptokeystorage_do_open($res, $storageid); secureblackboxlite_cryptokeystorage_do_refresh($res); secureblackboxlite_cryptokeystorage_do_remove($res, $index); secureblackboxlite_cryptokeystorage_do_select($res, $filter, $privatekeyneeded, $maxcount);
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. |