SecureBlackbox 2020 macOS Edition

Questions / Feedback?

CryptoKeyManager Module

Properties   Methods   Events   Configuration Settings   Errors  

The CryptoKeyManager component provides a simple way to load, generate and manage generic crypto keys.




CryptoKeyManager allows you to load, save, generate, import, and export low-level crypto keys. One example of such keys are raw RSA keys stored in PKCS1 format or AES256 keys. CryptoKeyManager supports asymmetric, symmetric, and HMAC keys.

CryptoKeyManager is a typical companion for low-level cryptography classes, such as PublicKeyCrypto, SymmetricCrypto, and HashFunction. It can also be used to provide external key material to certificate objects, and to derive cryptographic keys from passwords.

Use ImportBytes or ImportFromFile method to load the key material from a buffer or file. Use ImportFromCert (and remember to assign the certificate object to the Certificate property before calling it) to import a key from an X.509 certificate. Once loaded, the key will be available in the Key property.

To generate a new key or keypair use Generate method. You can export the generated key using ExportBytes or ExportToFile method. You can attach the generated or loaded key to an external certificate object using the ExportToCert method.

Note: CryptoKeyManager can only work with one cryptographic key at a time. Use CryptoKeyStorage to access media containing more than one key.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

CertificateA container for the certificate object.
KeyThe key object that the manager is currently working with.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
DeriveKeyGenerates a strong cryptographic key from a password.
ExportBytesExports the key to a byte array.
ExportToCertExports the key to a certificate.
ExportToFileExports the key to a file.
GenerateGenerates a new crypto key.
GetKeyParamReturns an algorithm-specific key parameter.
GetKeyParamStrReturns an algorithm-specific key parameter to a string.
ImportBytesLoads a key from a byte array.
ImportFromCertLoads a key from a certificate.
ImportFromFileLoads a key from a file.
SetKeyParamSets an algorithm-specific key parameter.
SetKeyParamStrSets an algorithm-specific key parameter.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

ErrorInforms about an error during an operation.
NotificationThis event notifies the application about an underlying control flow event.
PasswordNeededThis event is fired when a decryption password is needed.

Configuration Settings

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

Argon2MemoryCostSets the memory cost parameter of Argon2 key derivation algorithm.
Argon2ParallelismSets the parallelism parameter of Argon2 key derivation algorithm.
CurveThe name of the curve of the newly added elliptic cryptography (EC) key.
DerivationAlgorithmThe algorithm to use for key derivation.
DeriveIterationsThe number of iterations to use as part of key derivation routine.
HMACAlgorithmSpecifies the HMAC algorithm to use with the key derivation algorithm.
TempPathPath for storing temporary files.
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 component (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 components 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 macOS Edition - Version 20.0 [Build 8165]