Struct secureblackbox::CryptoKeyStorage

Properties   Methods   Events   Config Settings   Errors  

The CryptoKeyStorage struct 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 import_bytes, import_from_file, and import_pinned methods. In the latter case please assign the key object to be imported to the pinned_key property.

Use create_new 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.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the CryptoKeyStorage struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of CryptoKeyStorage when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

fips_mode property (CryptoKeyStorage Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

key_count property (CryptoKeyStorage Struct)

The number of records in the Key arrays.

Syntax

fn key_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• key_algorithm
• key_bits
• key_curve
• key_exportable
• key_fingerprint
• key_handle
• key_id
• key_iv
• key_nonce
• key_private
• key_public
• key_subject
• key_symmetric
• key_valid
• key_value

The array indices start at 0 and end at key_count - 1.

This property is read-only.

Data Type

i32

key_algorithm property (CryptoKeyStorage Struct)

The algorithm of the cryptographic key.

Syntax

fn key_algorithm(&self , KeyIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH, EdDSA, ML-DSA, ML-KEM.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_bits property (CryptoKeyStorage Struct)

The length of the key in bits.

Syntax

fn key_bits(&self , KeyIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the key in bits.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

i32

key_curve property (CryptoKeyStorage Struct)

This property specifies the name of the curve the EC key is built on.

Syntax

fn key_curve(&self , KeyIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

This property specifies the name of the curve the EC key is built on.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_exportable property (CryptoKeyStorage Struct)

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

fn key_exportable(&self , KeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

key_fingerprint property (CryptoKeyStorage Struct)

Contains the fingerprint (a hash imprint) of this key.

Syntax

fn key_fingerprint(&self , KeyIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_handle property (CryptoKeyStorage Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn key_handle(&self , KeyIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

i64

key_id property (CryptoKeyStorage Struct)

Provides access to a storage-specific key identifier.

Syntax

fn key_id(&self , KeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

Vec

key_iv property (CryptoKeyStorage Struct)

The initialization vector (IV) of a symmetric key.

Syntax

fn key_iv(&self , KeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

Vec

key_nonce property (CryptoKeyStorage Struct)

A nonce value associated with a key.

Syntax

fn key_nonce(&self , KeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

Vec

key_private property (CryptoKeyStorage Struct)

Returns True if the object hosts a private key, and False otherwise.

Syntax

fn key_private(&self , KeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if the object hosts a private key, and False otherwise.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

key_public property (CryptoKeyStorage Struct)

Returns True if the object hosts a public key, and False otherwise.

Syntax

fn key_public(&self , KeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if the object hosts a public key, and False otherwise.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

key_subject property (CryptoKeyStorage Struct)

Returns the key subject.

Syntax

fn key_subject(&self , KeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

Vec

key_symmetric property (CryptoKeyStorage Struct)

Returns True if the object contains a symmetric key, and False otherwise.

Syntax

fn key_symmetric(&self , KeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if the object contains a symmetric key, and False otherwise.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

key_valid property (CryptoKeyStorage Struct)

Returns True if this key is valid.

Syntax

fn key_valid(&self , KeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

key_value property (CryptoKeyStorage Struct)

The byte array representation of the key value.

Syntax

fn key_value(&self , KeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The byte array representation of the key value. This may not be available for non-key_exportable keys.

This property used to be called Key in SecureBlackbox versions 2024 and older.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

Vec

opened property (CryptoKeyStorage Struct)

Indicates whether the storage is in the open state.

Syntax

fn opened(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

pinned_key_handle property (CryptoKeyStorage Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn pinned_key_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_pinned_key_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

selected_key_count property (CryptoKeyStorage Struct)

The number of records in the SelectedKey arrays.

Syntax

fn selected_key_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• selected_key_algorithm
• selected_key_bits
• selected_key_curve
• selected_key_exportable
• selected_key_fingerprint
• selected_key_handle
• selected_key_id
• selected_key_iv
• selected_key_nonce
• selected_key_private
• selected_key_public
• selected_key_subject
• selected_key_symmetric
• selected_key_valid
• selected_key_value

The array indices start at 0 and end at selected_key_count - 1.

This property is read-only.

Data Type

i32

selected_key_algorithm property (CryptoKeyStorage Struct)

The algorithm of the cryptographic key.

Syntax

fn selected_key_algorithm(&self , SelectedKeyIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH, EdDSA, ML-DSA, ML-KEM.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

String

selected_key_bits property (CryptoKeyStorage Struct)

The length of the key in bits.

Syntax

fn selected_key_bits(&self , SelectedKeyIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the key in bits.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

i32

selected_key_curve property (CryptoKeyStorage Struct)

This property specifies the name of the curve the EC key is built on.

Syntax

fn selected_key_curve(&self , SelectedKeyIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

This property specifies the name of the curve the EC key is built on.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

String

selected_key_exportable property (CryptoKeyStorage Struct)

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

fn selected_key_exportable(&self , SelectedKeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

bool

selected_key_fingerprint property (CryptoKeyStorage Struct)

Contains the fingerprint (a hash imprint) of this key.

Syntax

fn selected_key_fingerprint(&self , SelectedKeyIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this key.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

String

selected_key_handle property (CryptoKeyStorage Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn selected_key_handle(&self , SelectedKeyIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

i64

selected_key_id property (CryptoKeyStorage Struct)

Provides access to a storage-specific key identifier.

Syntax

fn selected_key_id(&self , SelectedKeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

Vec

selected_key_iv property (CryptoKeyStorage Struct)

The initialization vector (IV) of a symmetric key.

Syntax

fn selected_key_iv(&self , SelectedKeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

Vec

selected_key_nonce property (CryptoKeyStorage Struct)

A nonce value associated with a key.

Syntax

fn selected_key_nonce(&self , SelectedKeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

Vec

selected_key_private property (CryptoKeyStorage Struct)

Returns True if the object hosts a private key, and False otherwise.

Syntax

fn selected_key_private(&self , SelectedKeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if the object hosts a private key, and False otherwise.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

bool

selected_key_public property (CryptoKeyStorage Struct)

Returns True if the object hosts a public key, and False otherwise.

Syntax

fn selected_key_public(&self , SelectedKeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if the object hosts a public key, and False otherwise.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

bool

selected_key_subject property (CryptoKeyStorage Struct)

Returns the key subject.

Syntax

fn selected_key_subject(&self , SelectedKeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

Vec

selected_key_symmetric property (CryptoKeyStorage Struct)

Returns True if the object contains a symmetric key, and False otherwise.

Syntax

fn selected_key_symmetric(&self , SelectedKeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if the object contains a symmetric key, and False otherwise.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

bool

selected_key_valid property (CryptoKeyStorage Struct)

Returns True if this key is valid.

Syntax

fn selected_key_valid(&self , SelectedKeyIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

bool

selected_key_value property (CryptoKeyStorage Struct)

The byte array representation of the key value.

Syntax

fn selected_key_value(&self , SelectedKeyIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The byte array representation of the key value. This may not be available for non-selected_key_exportable keys.

This property used to be called Key in SecureBlackbox versions 2024 and older.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

This property is read-only.

Data Type

Vec

storage_id property (CryptoKeyStorage Struct)

A unique identifier of this storage.

Syntax

fn storage_id(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

storage_location property (CryptoKeyStorage Struct)

Specifies the location of the currently opened storage.

Syntax

fn storage_location(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

add_pinned method (CryptoKeyStorage Struct)

Adds the pinned key to the storage.

Syntax

fn add_pinned(&self) -> Result<(), SecureBlackboxError>

Remarks

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

clear method (CryptoKeyStorage Struct)

Removes all existing keys from the storage.

Syntax

fn clear(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to empty the storage.

close method (CryptoKeyStorage Struct)

Closes the logical storage.

Syntax

fn close(&self, save : bool) -> Result<(), SecureBlackboxError>

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 Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

create_new method (CryptoKeyStorage Struct)

Creates a new storage.

Syntax

fn create_new(&self, storage_location : &str, storage_id : &str) -> Result<(), SecureBlackboxError>

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.

do_action method (CryptoKeyStorage Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. 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:

get_storage_property method (CryptoKeyStorage Struct)

Returns the value of a custom key storage property.

Syntax

fn get_storage_property(&self, prop_name : &str) ->  Result<String, SecureBlackboxError>

Remarks

This method, together with set_storage_property, 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.

import_bytes method (CryptoKeyStorage Struct)

Imports a key to the storage.

Syntax

fn import_bytes(&self, value : &[u8], format : i32, key_algorithm : &str, scheme : &str, scheme_params : &str, key_type : i32, password : &str) -> Result<(), SecureBlackboxError>

Remarks

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

import_from_file method (CryptoKeyStorage Struct)

Imports a key to the storage.

Syntax

fn import_from_file(&self, file_name : &str, format : i32, key_algorithm : &str, scheme : &str, scheme_params : &str, key_type : i32, password : &str) -> Result<(), SecureBlackboxError>

Remarks

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

list_stores method (CryptoKeyStorage Struct)

Returns a list of individual stores available within the storage.

Syntax

fn list_stores(&self) ->  Result<String, SecureBlackboxError>

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 Struct)

Signs in to a session or elevates the session rights.

Syntax

fn login(&self, session_type : i32, pin : &str, read_only : bool) -> Result<(), SecureBlackboxError>

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 Struct)

Signs out of an opened session.

Syntax

fn logout(&self, close_sesion : bool) -> Result<(), SecureBlackboxError>

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 Struct)

Opens existing storage or creates one in memory.

Syntax

fn open(&self, storage_id : &str) -> Result<(), SecureBlackboxError>

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.
• login, whether to sign in to the device with a PIN. Use 0 or no to avoid signing in, or 1 or yes to enforce it. When not specified, the yes mode is used.

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 Struct)

Refreshes all storage keychains.

Syntax

fn refresh(&self) -> Result<(), SecureBlackboxError>

Remarks

Call this method to refresh the storage.

remove method (CryptoKeyStorage Struct)

Removes a key from the storage.

Syntax

fn remove(&self, index : i32) -> Result<(), SecureBlackboxError>

Remarks

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

reset method (CryptoKeyStorage Struct)

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

select method (CryptoKeyStorage Struct)

Allows the selection of keys from the store.

Syntax

fn select(&self, filter : &str, private_key_needed : bool, max_count : i32) -> Result<(), SecureBlackboxError>

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.

set_storage_property method (CryptoKeyStorage Struct)

Sets the value of a custom key storage property.

Syntax

fn set_storage_property(&self, prop_name : &str, prop_value : &str) -> Result<(), SecureBlackboxError>

Remarks

This method, together with get_storage_property, 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.

on_error event (CryptoKeyStorage Struct)

Fires when an errors happens during a key storage operation.

Syntax

// CryptoKeyStorageErrorEventArgs carries the CryptoKeyStorage Error event's parameters.
pub struct CryptoKeyStorageErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// CryptoKeyStorageErrorEvent defines the signature of the CryptoKeyStorage Error event's handler function.
pub trait CryptoKeyStorageErrorEvent {
  fn on_error(&self, sender : CryptoKeyStorage, e : &mut CryptoKeyStorageErrorEventArgs);
}

impl <'a> CryptoKeyStorage<'a> {
  pub fn on_error(&self) -> &'a dyn CryptoKeyStorageErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn CryptoKeyStorageErrorEvent);
  ...
}

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.

on_notification event (CryptoKeyStorage Struct)

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

Syntax

// CryptoKeyStorageNotificationEventArgs carries the CryptoKeyStorage Notification event's parameters.
pub struct CryptoKeyStorageNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// CryptoKeyStorageNotificationEvent defines the signature of the CryptoKeyStorage Notification event's handler function.
pub trait CryptoKeyStorageNotificationEvent {
  fn on_notification(&self, sender : CryptoKeyStorage, e : &mut CryptoKeyStorageNotificationEventArgs);
}

impl <'a> CryptoKeyStorage<'a> {
  pub fn on_notification(&self) -> &'a dyn CryptoKeyStorageNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn CryptoKeyStorageNotificationEvent);
  ...
}

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.

on_password_needed event (CryptoKeyStorage Struct)

This event is fired when a decryption password is needed.

Syntax

// CryptoKeyStoragePasswordNeededEventArgs carries the CryptoKeyStorage PasswordNeeded event's parameters.
pub struct CryptoKeyStoragePasswordNeededEventArgs {
  fn needed_for(&self) -> &String
  fn password(&self) -> &String
  fn set_password(&self, value : &str)
  fn set_password_ref(&self, value : &String)
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// CryptoKeyStoragePasswordNeededEvent defines the signature of the CryptoKeyStorage PasswordNeeded event's handler function.
pub trait CryptoKeyStoragePasswordNeededEvent {
  fn on_password_needed(&self, sender : CryptoKeyStorage, e : &mut CryptoKeyStoragePasswordNeededEventArgs);
}

impl <'a> CryptoKeyStorage<'a> {
  pub fn on_password_needed(&self) -> &'a dyn CryptoKeyStoragePasswordNeededEvent;
  pub fn set_on_password_needed(&mut self, value : &'a dyn CryptoKeyStoragePasswordNeededEvent);
  ...
}

Remarks

The struct 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.

Config Settings (CryptoKeyStorage Struct)

The struct 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 struct, access to these internal properties is provided through the config method.

CryptoKeyStorage Config Settings

Base Config Settings

Trappable Errors (CryptoKeyStorage Struct)

CryptoKeyStorage Errors