CryptoKeyManager Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

secureblackbox.Cryptokeymanager

Remarks

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 class with short descriptions. Click on the links for further details.

Method List

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

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.

Config Settings

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

Certificate Property (CryptoKeyManager Class)

A container for the certificate object.

Syntax

public Certificate getCertificate();


public void setCertificate(Certificate certificate);

Remarks

Use this property to set or access the properties of the certificate object on which an import or export action is to be performed.

This property is not available at design time.

DerivationAlgorithm Property (CryptoKeyManager Class)

Specifies the algorithm to use for key derivation.

Syntax

public String getDerivationAlgorithm();


public void setDerivationAlgorithm(String derivationAlgorithm);

Default Value

"PKCS5"

Remarks

Use this property to specify the key derivation algorithm to use.

Class supports the following algorithms: PKCS5, BCrypt, SCrypt, Argon2, Argon2i, Argon2d.

DeriveIterations Property (CryptoKeyManager Class)

Specifies the number of iterations to use as part of key derivation routine.

Syntax

public int getDeriveIterations();


public void setDeriveIterations(int deriveIterations);

Default Value

2048

Remarks

Use this property to adjust the number of hash algorithm iterations to employ as part of key derivation function.

FIPSMode Property (CryptoKeyManager Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

HMACAlgorithm Property (CryptoKeyManager Class)

Specifies the HMAC algorithm to use with the key derivation algorithm.

Syntax

public String getHMACAlgorithm();


public void setHMACAlgorithm(String HMACAlgorithm);

Default Value

"SHA1"

Remarks

Use this property to specify the HMAC algorithm to use with the chosen key derivation algorithm.

Class supports the following algorithms: SHA1, SHA224, SHA256, SHA384, SHA512, MD5, RIPEMD, HMAC.

Key Property (CryptoKeyManager Class)

The key object that the manager is currently working with.

Syntax

public CryptoKey getKey();


public void setKey(CryptoKey key);

Remarks

Use this property to pass a key to the manager (for example, for serialization), or to obtain a key from the manager (e.g., after generating or importing it).

This property is not available at design time.

Config Method (Cryptokeymanager Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DeriveKey Method (Cryptokeymanager Class)

Generates a strong cryptographic key from a password.

Syntax

public void deriveKey(int keyBits, String password, String salt);

Remarks

Use this method to generate a cryptographically strong key of a needed length from a password.

This method uses a general-purpose PBKDF2 function with PRF1 and 2048 iterations.

DoAction Method (Cryptokeymanager Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insencitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

ExportBytes Method (Cryptokeymanager Class)

Exports the key to a byte array.

Syntax

public byte[] exportBytes(int format, int keyType);

Remarks

Use this method to save the Key (both the public and secret parts) to a byte array.

ExportToCert Method (Cryptokeymanager Class)

Exports the key to a certificate.

Syntax

public void exportToCert();

Remarks

Use this method to save the Key (both the public and secret parts) to the certificate specified in Certificate.

ExportToFile Method (Cryptokeymanager Class)

Exports the key to a file.

Syntax

public void exportToFile(String filename, int format, int keyType);

Remarks

Use this method to save the Key (both the public and secret parts) to the file passed via the Filename parameter.

ExportToStream Method (Cryptokeymanager Class)

Exports the key to a stream.

Syntax

public void exportToStream(java.io.OutputStream stream, int format, int keyType);

Remarks

Use this method to save the Key (both the public and secret parts) to a stream pointed by the Stream parameter.

Generate Method (Cryptokeymanager Class)

Generates a new crypto key.

Syntax

public void generate(String keyAlgorithm, String scheme, String schemeParams, int keyBits);

Remarks

Call this method to generate a new key or keypair with the desired KeyAlgorithm and KeyBits of length.

The generated key will be populated in the Key property.

GetKeyParam Method (Cryptokeymanager Class)

Returns an algorithm-specific key parameter.

Syntax

public byte[] getKeyParam(String name);

Remarks

Use this method to retrieve an algorithm-specific key parameter.

GetKeyParamStr Method (Cryptokeymanager Class)

Returns an algorithm-specific key parameter to a string.

Syntax

public String getKeyParamStr(String name);

Remarks

Use this method to get an algorithm-specific key parameter to a string.

ImportBytes Method (Cryptokeymanager Class)

Loads a key from a byte array.

Syntax

public void importBytes(byte[] value, int format, String keyAlgorithm, String scheme, String schemeParams, int keyType);

Remarks

Use this method to load a key, either public or secret, from a byte array.

ImportFromCert Method (Cryptokeymanager Class)

Loads a key from a certificate.

Syntax

public void importFromCert();

Remarks

Use this method to load a key, either public or secret, from a certificate.

ImportFromFile Method (Cryptokeymanager Class)

Loads a key from a file.

Syntax

public void importFromFile(String filename, int format, String keyAlgorithm, String scheme, String schemeParams, int keyType);

Remarks

Use this method to load a key, either public or secret, from a file.

ImportFromStream Method (Cryptokeymanager Class)

Loads a key from a stream.

Syntax

public void importFromStream(java.io.InputStream stream, int format, String keyAlgorithm, String scheme, String schemeParams, int keyType);

Remarks

Use this method to load a key, either public or secret, from a stream.

SetKeyParam Method (Cryptokeymanager Class)

Sets an algorithm-specific key parameter.

Syntax

public void setKeyParam(String name, byte[] value);

Remarks

Use this method to set an algorithm-specific key parameter.

SetKeyParamStr Method (Cryptokeymanager Class)

Sets an algorithm-specific key parameter.

Syntax

public void setKeyParamStr(String name, String valueStr);

Remarks

Use this method to set an algorithm-specific key parameter provided in a string.

Error Event (Cryptokeymanager Class)

Informs about an error during an operation.

Syntax

public class DefaultCryptokeymanagerEventListener implements CryptokeymanagerEventListener {
  ...
  public void error(CryptokeymanagerErrorEvent e) {}
  ...
}

public class CryptokeymanagerErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The event is fired when an error happens in the middle of the class's work.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (Cryptokeymanager Class)

This event notifies the application about an underlying control flow event.

Syntax

public class DefaultCryptokeymanagerEventListener implements CryptokeymanagerEventListener {
  ...
  public void notification(CryptokeymanagerNotificationEvent e) {}
  ...
}

public class CryptokeymanagerNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PasswordNeeded Event (Cryptokeymanager Class)

This event is fired when a decryption password is needed.

Syntax

public class DefaultCryptokeymanagerEventListener implements CryptokeymanagerEventListener {
  ...
  public void passwordNeeded(CryptokeymanagerPasswordNeededEvent e) {}
  ...
}

public class CryptokeymanagerPasswordNeededEvent {
  public String neededFor;
  public String password;
  public boolean cancel;
}

Remarks

The class fires this event when a password is needed to decrypt a certificate or a private key.

In the handler of this event, assign the password to the Password parameter, or set Cancel to true to abort the operation.

The NeededFor parameter identifies the certificate for which the password is requested.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

public Certificate( bytes,  startIndex,  count,  password);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( bytes,  startIndex,  count);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

public Certificate( path,  password);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certPath,  keyPath,  password);

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

public Certificate( path);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

public Certificate( stream);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public Certificate( stream,  password);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certStream,  keyStream,  password);

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

public Certificate();

Creates a new object with default field values.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

public CryptoKey();

Config Settings (Cryptokeymanager Class)

CryptoKeyManager Config Settings

Base Config Settings

Trappable Errors (Cryptokeymanager Class)

CryptoKeyManager Errors