CryptoKeyStorage Class

Properties   Methods   Events   Config Settings   Errors  

The CryptoKeyStorage class provides access to key stores of various types.

Syntax

secureblackbox.CryptoKeyStorage

Remarks

CryptoKeyStorage allows you to load and access cryptographic keys stored on different media, such as memory buffers, files, operating system, and hardware security modules.

To access keys stored on certain type of media, start with the Open method. Provide the location of your certificates via a uniform URI-like specifier. Once the storage has been opened, you can access the certificates contained in it via the Keys property. KeyStorage.Open("pkcs11://user:12345@localhost/C:/Windows/system32/asepkcs.dll?slot=0");

Iterate over the keys by using the Keys property, or use filtering facilities provided by the Select method. You can add keys to the storage with the ImportBytes, ImportFromFile, and ImportPinned methods. In the latter case please assign the key object to be imported to the PinnedKey property.

Use CreateNew method to create a new storage. Note that not all storage kinds can be created. KeyStorage.CreateNew("file", StorageFile);

When you have finished working with the certificate storage, close it with the Close method.

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.

FIPSMode Property (CryptoKeyStorage Class)

Reserved.

Syntax

public boolean isFIPSMode();
public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

Keys Property (CryptoKeyStorage Class)

An accessor to the collection of keys contained in the storage.

Syntax

public CryptoKeyList getKeys();

Remarks

Use this property to access, browse, or iterate over keys contained in the storage.

This property is read-only and not available at design time.

Please refer to the CryptoKey type for a complete list of fields.

Opened Property (CryptoKeyStorage Class)

Indicates whether the storage is in the open state.

Syntax

public boolean isOpened();

Default Value

False

Remarks

Use this property to check if the storage has been 'opened.' Different kinds of key storages imply different meanings for 'being opened', but generally a storage is open if it is available for operations.

Use Open method to open a storage.

This property is read-only and not available at design time.

PinnedKey Property (CryptoKeyStorage Class)

A pinned key.

Syntax

public CryptoKey getPinnedKey();
public void setPinnedKey(CryptoKey pinnedKey);

Remarks

Use this property to pin a key before adding it to the storage with AddPinned method.

This property is not available at design time.

Please refer to the CryptoKey type for a complete list of fields.

SelectedKeys Property (CryptoKeyStorage Class)

A collection of selected keys.

Syntax

public CryptoKeyList getSelectedKeys();

Remarks

This property contains a list of keys returned by Select method.

This property is read-only and not available at design time.

Please refer to the CryptoKey type for a complete list of fields.

StorageID Property (CryptoKeyStorage Class)

A unique identifier of this storage.

Syntax

public String getStorageID();

Default Value

""

Remarks

Use this property to get a unique ID of this storage. The format of ID may differ for different kinds of key storages, and may range from a file path for a file storage, to a URI-like ID for a PKCS#11 storage, to an empty value for an in-memory storage.

This property is read-only.

StorageLocation Property (CryptoKeyStorage Class)

Specifies the location of the currently opened storage.

Syntax

public String getStorageLocation();

Default Value

""

Remarks

Use this property to get the location of the active storage. The location indicates the nature of the storage and can be assigned with one of the below values (more values may be added in future):

This property is read-only.

AddPinned Method (CryptoKeyStorage Class)

Adds the pinned key to the storage.

Syntax

public void addPinned();

Remarks

This method adds a key attached to the PinnedKey property to the storage. This method is a handy way of adding keys generated/returned by other components.

Clear Method (CryptoKeyStorage Class)

Removes all existing keys from the storage.

Syntax

public void clear();

Remarks

Use this method to empty the storage.

Close Method (CryptoKeyStorage Class)

Closes the logical storage.

Syntax

public void close(boolean save);

Remarks

Use this method to close logical storages connected to PKCS#11-compliant hardware security modules, or storages of similar persistent kinds. Closing a persistent storage with this method is important, as unused but unclosed storages consume extra resources and may result in eventual key locks.

Config Method (CryptoKeyStorage 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.

CreateNew Method (CryptoKeyStorage Class)

Creates a new storage.

Syntax

public void createNew(String storageLocation, String storageID);

Remarks

Use this method to create new key storage.

StorageLocation specifies where the new storage should be created, and StorageID contains a unique storage identifier.

DoAction Method (CryptoKeyStorage 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 insensitive) 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;....

Common ActionIDs:

GetStorageProperty Method (CryptoKeyStorage Class)

Returns the value of a custom key storage property.

Syntax

public String getStorageProperty(String propName);

Remarks

This method, together with SetStorageProperty, provides an extensible way of managing the certificate storage's settings that are not available through the primary properties of the component. The list of settings may be extended in future, in response to emergence of new storage variants and recognition of non-obvious storage usage scenarios.

Currently no custom properties are available for this component.

ImportBytes Method (CryptoKeyStorage Class)

Imports a key to the storage.

Syntax

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

Remarks

Use this method to add a key from a byte array.

ImportFromFile Method (CryptoKeyStorage Class)

Imports a key to the storage.

Syntax

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

Remarks

Use this method to add a key stored in a file.

ImportFromStream Method (CryptoKeyStorage Class)

Imports a key to the storage.

Syntax

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

Remarks

Use this method to add a key contained in a stream.

ListStores Method (CryptoKeyStorage Class)

Returns a list of individual stores available within the storage.

Syntax

public String listStores();

Remarks

Use this method to query a list of individual stores available in the opened storage.

The contents of the list depends on the type of the store used and the parameters it is opened with. For PKCS#11 stores the method returns a list of slot descriptions for all slots published by the driver.

The store identifiers are separated from each other with a CRLF sequence.

Login Method (CryptoKeyStorage Class)

Signs in to a session or elevates the session rights.

Syntax

public void login(int sessionType, String pin, boolean readOnly);

Remarks

Use this method to sign in to a session with a required access type. Note that in some cases you may call this method more than one time for a specific session to elevate your access rights, for example: // open an unauthenticated session storage.Login(stUnauthenticated, "", false); // elevate the access rights for the session storage.Login(stUser, "password", false); Sessions are currently supported for PKCS#11 storage types only.

Logout Method (CryptoKeyStorage Class)

Signs out of an opened session.

Syntax

public void logout(boolean closeSesion);

Remarks

Use this method to sign out of a session. Pass true to CloseSession to shut the session down altogether.

This method is currently support for PKCS#11 storage type only.

Open Method (CryptoKeyStorage Class)

Opens existing storage or creates one in memory.

Syntax

public void open(String storageID);

Remarks

Use this method to open the storage with the given StorageID. Key storages can come from several different locations, detailed below.

Memory

A storage can be created in memory by passing an empty string ("").

File

A storage can be opened from a file using one of two syntaxes:

• C:\Certs\keys.pem
• file://C:/Certs/keys.pem

Windows System

A storage can be opened from the Windows System using this syntax: system://{user}@{host}/?{params}

user is one of these values:

• currentuser
• localmachine
• currentservice

host is either "localhost", an IP address, or FQDN.

params are chosen from this list:

• store (required), is the name of the Windows store to access (e.g. "MY")
• readonly, whether to access the store with only read permissions. Use 0 for false, and 1 for true.

Example: system://currentuser@localhost/?store=MY&readonly=1

PKCS#11 Device

A storage can be opened from a PKCS#11 device using this syntax: pkcs11://{user}:{pin}@/{driverpath}?{params}

user is the username used to access the device.

pin is the pin code used to access the device.

driverpath is the path to the driver used to access the device.

params are chosen from this list:

• slot, the token slot to access on the device. If not provided, one will be chosen automatically.
• readonly, whether to access the device with only read permissions. Use 0 for false, and 1 for true.

Example: pkcs11://john.doe:1234@/c:/windows/system32/asepkcs.dll?slot=0&readonly=1

KMIP Server

A storage can be opened from a KMIP server using this syntax: mailto:{password}@{remotehost}:{remoteport}/?{params}

password is the password use to authenticate to the server.

remotehost is the FQDN to the server.

remoteport is the server port to connect to.

params are chosen from this list:

• encoder, the message encoding used to communicate with the server. Possible values are:
  • 1 (XML)
  • 2 (JSON)
  • 3 (TTLV)

Example: mailto:password@kmip.website.com:5696/?encoder=1

Refresh Method (CryptoKeyStorage Class)

Refreshes all storage keychains.

Syntax

public void refresh();

Remarks

Call this method to refresh the storage.

Remove Method (CryptoKeyStorage Class)

Removes a key from the storage.

Syntax

public void remove(int index);

Remarks

Use this method to remove a key from the storage by its index.

Reset Method (CryptoKeyStorage Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

Select Method (CryptoKeyStorage Class)

Allows the selection of keys from the store.

Syntax

public void select(String filter, boolean privateKeyNeeded, int maxCount);

Remarks

This function allows the user to select keys from the storage by applying a Filter. PrivateKeyNeeded specifies whether only private keys should be selected. MaxCount limits the number of certificates selected.

SetStorageProperty Method (CryptoKeyStorage Class)

Sets the value of a custom key storage property.

Syntax

public void setStorageProperty(String propName, String propValue);

Remarks

This method, together with GetStorageProperty, provides an extensible way of managing the certificate storage's settings that are not available through the primary properties of the component. The list of settings may be extended in future, in response to emergence of new storage variants and recognition of non-obvious storage usage scenarios.

Currently no custom properties are available for this component.

Error Event (CryptoKeyStorage Class)

Fires when an errors happens during a key storage operation.

Syntax

public class DefaultCryptoKeyStorageEventListener implements CryptoKeyStorageEventListener {
  ...
  public void error(CryptoKeyStorageErrorEvent e) {}
  ...
}

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

Remarks

This event reports an exceptional situation during a key storage operation.

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

Notification Event (CryptoKeyStorage Class)

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

Syntax

public class DefaultCryptoKeyStorageEventListener implements CryptoKeyStorageEventListener {
  ...
  public void notification(CryptoKeyStorageNotificationEvent e) {}
  ...
}

public class CryptoKeyStorageNotificationEvent {
  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 class. 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 the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

PasswordNeeded Event (CryptoKeyStorage Class)

This event is fired when a decryption password is needed.

Syntax

public class DefaultCryptoKeyStorageEventListener implements CryptoKeyStorageEventListener {
  ...
  public void passwordNeeded(CryptoKeyStoragePasswordNeededEvent e) {}
  ...
}

public class CryptoKeyStoragePasswordNeededEvent {
  public String neededFor;
  public String password; //read-write
  public boolean cancel; //read-write
}

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 key or certificate for which the password is requested.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

public CryptoKey();

Config Settings (CryptoKeyStorage Class)

The class accepts one or more of the following configuration settings. Configuration 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.

CryptoKeyStorage Config Settings

Base Config Settings

Trappable Errors (CryptoKeyStorage Class)

CryptoKeyStorage Errors