SecureBlackbox 2020 iOS 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

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.

- keyCountThe number of records in the Key arrays.
- keyAlgorithm:(int)keyIndexThe algorithm of the cryptographic key.
- keyBits:(int)keyIndexThe length of the key in bits.
- keyExportable:(int)keyIndexReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
- keyHandle:(int)keyIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- keyID:(int)keyIndexProvides access to a storage-specific key identifier.
- keyIV:(int)keyIndexThe initialization vector (IV) of a symmetric key.
- keyKey:(int)keyIndexThe byte array representation of the key.
- keyNonce:(int)keyIndexA nonce value associated with a key.
- keyPrivate:(int)keyIndexReturns True if the object hosts a private key, and False otherwise.
- keyPublic:(int)keyIndexReturns True if the object hosts a public key, and False otherwise.
- keySubject:(int)keyIndexReturns the key subject.
- keySymmetric:(int)keyIndexReturns True if the object contains a symmetric key, and False otherwise.
- keyValid:(int)keyIndexReturns True if this key is valid.
- openedIndicates whether the storage is in the open state.
- pinnedKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
- selectedKeyCountThe number of records in the SelectedKey arrays.
- selectedKeyAlgorithm:(int)selectedKeyIndexThe algorithm of the cryptographic key.
- selectedKeyBits:(int)selectedKeyIndexThe length of the key in bits.
- selectedKeyExportable:(int)selectedKeyIndexReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
- selectedKeyHandle:(int)selectedKeyIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- selectedKeyID:(int)selectedKeyIndexProvides access to a storage-specific key identifier.
- selectedKeyIV:(int)selectedKeyIndexThe initialization vector (IV) of a symmetric key.
- selectedKeyKey:(int)selectedKeyIndexThe byte array representation of the key.
- selectedKeyNonce:(int)selectedKeyIndexA nonce value associated with a key.
- selectedKeyPrivate:(int)selectedKeyIndexReturns True if the object hosts a private key, and False otherwise.
- selectedKeyPublic:(int)selectedKeyIndexReturns True if the object hosts a public key, and False otherwise.
- selectedKeySubject:(int)selectedKeyIndexReturns the key subject.
- selectedKeySymmetric:(int)selectedKeyIndexReturns True if the object contains a symmetric key, and False otherwise.
- selectedKeyValid:(int)selectedKeyIndexReturns True if this key is valid.
- storageIDA unique identifier of this storage.
- storageLocationSpecifies 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.

- addPinnedAdds the pinned key to the storage.
- clearRemoves all existing keys from the storage.
- closeCloses the logical storage.
- configSets or retrieves a configuration setting.
- createNewCreates a new storage.
- importBytesAdds a key to the storage.
- importFromFileAdds 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.

- onErrorFires when an errors happens during a key storage operation.
- onNotificationThis event notifies the application about an underlying control flow event.
- onPasswordNeededThis 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 iOS Edition - Version 20.0 [Build 8165]