CryptoKeyStorage Class

Properties   Methods   Events   Config Settings   Errors  

The CryptoKeyStorage class offers key storage functionality for a variety of key store types.

Syntax

CryptoKeyStorage

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.

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_cryptokeystorage_getfipsmode(void* lpObj);
int secureblackbox_cryptokeystorage_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

Keys Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCryptoKey>* GetKeys();

int secureblackbox_cryptokeystorage_getkeycount(void* lpObj);

char* secureblackbox_cryptokeystorage_getkeyalgorithm(void* lpObj, int keyindex);

int secureblackbox_cryptokeystorage_getkeybits(void* lpObj, int keyindex);

char* secureblackbox_cryptokeystorage_getkeycurve(void* lpObj, int keyindex);

int secureblackbox_cryptokeystorage_getkeyexportable(void* lpObj, int keyindex);

char* secureblackbox_cryptokeystorage_getkeyfingerprint(void* lpObj, int keyindex);

int64 secureblackbox_cryptokeystorage_getkeyhandle(void* lpObj, int keyindex);

int secureblackbox_cryptokeystorage_getkeyid(void* lpObj, int keyindex, char** lpKeyID, int* lenKeyID);

int secureblackbox_cryptokeystorage_getkeyiv(void* lpObj, int keyindex, char** lpKeyIV, int* lenKeyIV);

int secureblackbox_cryptokeystorage_getkeykey(void* lpObj, int keyindex, char** lpKeyKey, int* lenKeyKey);

int secureblackbox_cryptokeystorage_getkeynonce(void* lpObj, int keyindex, char** lpKeyNonce, int* lenKeyNonce);

int secureblackbox_cryptokeystorage_getkeyprivate(void* lpObj, int keyindex);

int secureblackbox_cryptokeystorage_getkeypublic(void* lpObj, int keyindex);

int secureblackbox_cryptokeystorage_getkeysubject(void* lpObj, int keyindex, char** lpKeySubject, int* lenKeySubject);

int secureblackbox_cryptokeystorage_getkeysymmetric(void* lpObj, int keyindex);

int secureblackbox_cryptokeystorage_getkeyvalid(void* lpObj, int keyindex);

int GetKeyCount();

QString GetKeyAlgorithm(int iKeyIndex);

int GetKeyBits(int iKeyIndex);

QString GetKeyCurve(int iKeyIndex);

bool GetKeyExportable(int iKeyIndex);

QString GetKeyFingerprint(int iKeyIndex);

qint64 GetKeyHandle(int iKeyIndex);

QByteArray GetKeyID(int iKeyIndex);

QByteArray GetKeyIV(int iKeyIndex);

QByteArray GetKeyKey(int iKeyIndex);

QByteArray GetKeyNonce(int iKeyIndex);

bool GetKeyPrivate(int iKeyIndex);

bool GetKeyPublic(int iKeyIndex);

QByteArray GetKeySubject(int iKeyIndex);

bool GetKeySymmetric(int iKeyIndex);

bool GetKeyValid(int iKeyIndex);

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.

Data Type

SecureBlackboxCryptoKey

Opened Property (CryptoKeyStorage Class)

Indicates whether the storage is in the open state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOpened();

Unicode (Windows)
BOOL GetOpened();

int secureblackbox_cryptokeystorage_getopened(void* lpObj);

bool GetOpened();

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.

Data Type

Boolean

PinnedKey Property (CryptoKeyStorage Class)

A pinned key.

Syntax

• C++
• C
• Qt

SecureBlackboxCryptoKey* GetPinnedKey();
int SetPinnedKey(SecureBlackboxCryptoKey* val);

int64 secureblackbox_cryptokeystorage_getpinnedkeyhandle(void* lpObj);
int secureblackbox_cryptokeystorage_setpinnedkeyhandle(void* lpObj, int64 lPinnedKeyHandle);

qint64 GetPinnedKeyHandle();
int SetPinnedKeyHandle(qint64 lPinnedKeyHandle);

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.

Data Type

SecureBlackboxCryptoKey

SelectedKeys Property (CryptoKeyStorage Class)

A collection of selected keys.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCryptoKey>* GetSelectedKeys();

int secureblackbox_cryptokeystorage_getselectedkeycount(void* lpObj);

char* secureblackbox_cryptokeystorage_getselectedkeyalgorithm(void* lpObj, int selectedkeyindex);

int secureblackbox_cryptokeystorage_getselectedkeybits(void* lpObj, int selectedkeyindex);

char* secureblackbox_cryptokeystorage_getselectedkeycurve(void* lpObj, int selectedkeyindex);

int secureblackbox_cryptokeystorage_getselectedkeyexportable(void* lpObj, int selectedkeyindex);

char* secureblackbox_cryptokeystorage_getselectedkeyfingerprint(void* lpObj, int selectedkeyindex);

int64 secureblackbox_cryptokeystorage_getselectedkeyhandle(void* lpObj, int selectedkeyindex);

int secureblackbox_cryptokeystorage_getselectedkeyid(void* lpObj, int selectedkeyindex, char** lpSelectedKeyID, int* lenSelectedKeyID);

int secureblackbox_cryptokeystorage_getselectedkeyiv(void* lpObj, int selectedkeyindex, char** lpSelectedKeyIV, int* lenSelectedKeyIV);

int secureblackbox_cryptokeystorage_getselectedkeykey(void* lpObj, int selectedkeyindex, char** lpSelectedKeyKey, int* lenSelectedKeyKey);

int secureblackbox_cryptokeystorage_getselectedkeynonce(void* lpObj, int selectedkeyindex, char** lpSelectedKeyNonce, int* lenSelectedKeyNonce);

int secureblackbox_cryptokeystorage_getselectedkeyprivate(void* lpObj, int selectedkeyindex);

int secureblackbox_cryptokeystorage_getselectedkeypublic(void* lpObj, int selectedkeyindex);

int secureblackbox_cryptokeystorage_getselectedkeysubject(void* lpObj, int selectedkeyindex, char** lpSelectedKeySubject, int* lenSelectedKeySubject);

int secureblackbox_cryptokeystorage_getselectedkeysymmetric(void* lpObj, int selectedkeyindex);

int secureblackbox_cryptokeystorage_getselectedkeyvalid(void* lpObj, int selectedkeyindex);

int GetSelectedKeyCount();

QString GetSelectedKeyAlgorithm(int iSelectedKeyIndex);

int GetSelectedKeyBits(int iSelectedKeyIndex);

QString GetSelectedKeyCurve(int iSelectedKeyIndex);

bool GetSelectedKeyExportable(int iSelectedKeyIndex);

QString GetSelectedKeyFingerprint(int iSelectedKeyIndex);

qint64 GetSelectedKeyHandle(int iSelectedKeyIndex);

QByteArray GetSelectedKeyID(int iSelectedKeyIndex);

QByteArray GetSelectedKeyIV(int iSelectedKeyIndex);

QByteArray GetSelectedKeyKey(int iSelectedKeyIndex);

QByteArray GetSelectedKeyNonce(int iSelectedKeyIndex);

bool GetSelectedKeyPrivate(int iSelectedKeyIndex);

bool GetSelectedKeyPublic(int iSelectedKeyIndex);

QByteArray GetSelectedKeySubject(int iSelectedKeyIndex);

bool GetSelectedKeySymmetric(int iSelectedKeyIndex);

bool GetSelectedKeyValid(int iSelectedKeyIndex);

Remarks

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

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

Data Type

SecureBlackboxCryptoKey

StorageID Property (CryptoKeyStorage Class)

A unique identifier of this storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStorageID();

Unicode (Windows)
LPWSTR GetStorageID();

char* secureblackbox_cryptokeystorage_getstorageid(void* lpObj);

QString 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.

Data Type

String

StorageLocation Property (CryptoKeyStorage Class)

Specifies the location of the currently opened storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStorageLocation();

Unicode (Windows)
LPWSTR GetStorageLocation();

char* secureblackbox_cryptokeystorage_getstoragelocation(void* lpObj);

QString 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.

Data Type

String

AddPinned Method (CryptoKeyStorage Class)

Adds the pinned key to the storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddPinned();

Unicode (Windows)
INT AddPinned();

int secureblackbox_cryptokeystorage_addpinned(void* lpObj);

int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Clear Method (CryptoKeyStorage Class)

Removes all existing keys from the storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Clear();

Unicode (Windows)
INT Clear();

int secureblackbox_cryptokeystorage_clear(void* lpObj);

int Clear();

Remarks

Use this method to empty the storage.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Close Method (CryptoKeyStorage Class)

Closes the logical storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close(int bSave);

Unicode (Windows)
INT Close(BOOL bSave);

int secureblackbox_cryptokeystorage_close(void* lpObj, int bSave);

int Close(bool bSave);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (CryptoKeyStorage Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_cryptokeystorage_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateNew Method (CryptoKeyStorage Class)

Creates a new storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateNew(const char* lpszStorageLocation, const char* lpszStorageID);

Unicode (Windows)
INT CreateNew(LPCWSTR lpszStorageLocation, LPCWSTR lpszStorageID);

int secureblackbox_cryptokeystorage_createnew(void* lpObj, const char* lpszStorageLocation, const char* lpszStorageID);

int CreateNew(const QString& qsStorageLocation, const QString& qsStorageID);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoAction Method (CryptoKeyStorage Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_cryptokeystorage_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

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;....

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetStorageProperty Method (CryptoKeyStorage Class)

Returns the value of a custom key storage property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStorageProperty(const char* lpszPropName);

Unicode (Windows)
LPWSTR GetStorageProperty(LPCWSTR lpszPropName);

char* secureblackbox_cryptokeystorage_getstorageproperty(void* lpObj, const char* lpszPropName);

QString GetStorageProperty(const QString& qsPropName);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ImportBytes Method (CryptoKeyStorage Class)

Imports a key to the storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportBytes(const char* lpValue, int lenValue, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType, const char* lpszPassword);

Unicode (Windows)
INT ImportBytes(LPCSTR lpValue, INT lenValue, INT iFormat, LPCWSTR lpszKeyAlgorithm, LPCWSTR lpszScheme, LPCWSTR lpszSchemeParams, INT iKeyType, LPCWSTR lpszPassword);

int secureblackbox_cryptokeystorage_importbytes(void* lpObj, const char* lpValue, int lenValue, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType, const char* lpszPassword);

int ImportBytes(QByteArray qbaValue, int iFormat, const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyType, const QString& qsPassword);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportFromFile Method (CryptoKeyStorage Class)

Imports a key to the storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportFromFile(const char* lpszFileName, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType, const char* lpszPassword);

Unicode (Windows)
INT ImportFromFile(LPCWSTR lpszFileName, INT iFormat, LPCWSTR lpszKeyAlgorithm, LPCWSTR lpszScheme, LPCWSTR lpszSchemeParams, INT iKeyType, LPCWSTR lpszPassword);

int secureblackbox_cryptokeystorage_importfromfile(void* lpObj, const char* lpszFileName, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType, const char* lpszPassword);

int ImportFromFile(const QString& qsFileName, int iFormat, const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyType, const QString& qsPassword);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportFromStream Method (CryptoKeyStorage Class)

Imports a key to the storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportFromStream(SecureBlackboxStream* sStream, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType, const char* lpszPassword);

Unicode (Windows)
INT ImportFromStream(SecureBlackboxStream* sStream, INT iFormat, LPCWSTR lpszKeyAlgorithm, LPCWSTR lpszScheme, LPCWSTR lpszSchemeParams, INT iKeyType, LPCWSTR lpszPassword);

int secureblackbox_cryptokeystorage_importfromstream(void* lpObj, SecureBlackboxStream* sStream, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType, const char* lpszPassword);

int ImportFromStream(SecureBlackboxStream* sStream, int iFormat, const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyType, const QString& qsPassword);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListStores Method (CryptoKeyStorage Class)

Returns a list of individual stores available within the storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ListStores();

Unicode (Windows)
LPWSTR ListStores();

char* secureblackbox_cryptokeystorage_liststores(void* lpObj);

QString 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Login Method (CryptoKeyStorage Class)

Signs in to a session or elevates the session rights.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Login(int iSessionType, const char* lpszPin, int bReadOnly);

Unicode (Windows)
INT Login(INT iSessionType, LPCWSTR lpszPin, BOOL bReadOnly);

int secureblackbox_cryptokeystorage_login(void* lpObj, int iSessionType, const char* lpszPin, int bReadOnly);

int Login(int iSessionType, const QString& qsPin, bool bReadOnly);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Logout Method (CryptoKeyStorage Class)

Signs out of an opened session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Logout(int bCloseSesion);

Unicode (Windows)
INT Logout(BOOL bCloseSesion);

int secureblackbox_cryptokeystorage_logout(void* lpObj, int bCloseSesion);

int Logout(bool bCloseSesion);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Open Method (CryptoKeyStorage Class)

Opens existing storage or creates one in memory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Open(const char* lpszStorageID);

Unicode (Windows)
INT Open(LPCWSTR lpszStorageID);

int secureblackbox_cryptokeystorage_open(void* lpObj, const char* lpszStorageID);

int Open(const QString& qsStorageID);

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

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.

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.

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)

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Refresh Method (CryptoKeyStorage Class)

Refreshes all storage keychains.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Refresh();

Unicode (Windows)
INT Refresh();

int secureblackbox_cryptokeystorage_refresh(void* lpObj);

int Refresh();

Remarks

Call this method to refresh the storage.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Remove Method (CryptoKeyStorage Class)

Removes a key from the storage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Remove(int iIndex);

Unicode (Windows)
INT Remove(INT iIndex);

int secureblackbox_cryptokeystorage_remove(void* lpObj, int iIndex);

int Remove(int iIndex);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (CryptoKeyStorage Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_cryptokeystorage_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Select Method (CryptoKeyStorage Class)

Allows the selection of keys from the store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Select(const char* lpszFilter, int bPrivateKeyNeeded, int iMaxCount);

Unicode (Windows)
INT Select(LPCWSTR lpszFilter, BOOL bPrivateKeyNeeded, INT iMaxCount);

int secureblackbox_cryptokeystorage_select(void* lpObj, const char* lpszFilter, int bPrivateKeyNeeded, int iMaxCount);

int Select(const QString& qsFilter, bool bPrivateKeyNeeded, int iMaxCount);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetStorageProperty Method (CryptoKeyStorage Class)

Sets the value of a custom key storage property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetStorageProperty(const char* lpszPropName, const char* lpszPropValue);

Unicode (Windows)
INT SetStorageProperty(LPCWSTR lpszPropName, LPCWSTR lpszPropValue);

int secureblackbox_cryptokeystorage_setstorageproperty(void* lpObj, const char* lpszPropName, const char* lpszPropValue);

int SetStorageProperty(const QString& qsPropName, const QString& qsPropValue);

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 Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (CryptoKeyStorage Class)

Fires when an errors happens during a key storage operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(CryptoKeyStorageErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} CryptoKeyStorageErrorEventParams;


Unicode (Windows)
virtual INT FireError(CryptoKeyStorageErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} CryptoKeyStorageErrorEventParams;

#define EID_CRYPTOKEYSTORAGE_ERROR 1

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class CryptoKeyStorageErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(CryptoKeyStorageErrorEventParams *e);

// Or, subclass CryptoKeyStorage and override this emitter function.
virtual int FireError(CryptoKeyStorageErrorEventParams *e) {...}

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(CryptoKeyStorageNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} CryptoKeyStorageNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(CryptoKeyStorageNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} CryptoKeyStorageNotificationEventParams;

#define EID_CRYPTOKEYSTORAGE_NOTIFICATION 2

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class CryptoKeyStorageNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(CryptoKeyStorageNotificationEventParams *e);

// Or, subclass CryptoKeyStorage and override this emitter function.
virtual int FireNotification(CryptoKeyStorageNotificationEventParams *e) {...}

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePasswordNeeded(CryptoKeyStoragePasswordNeededEventParams *e);

typedef struct {
  const char *NeededFor;
  char *Password;
  int Cancel;
  int reserved;
} CryptoKeyStoragePasswordNeededEventParams;


Unicode (Windows)
virtual INT FirePasswordNeeded(CryptoKeyStoragePasswordNeededEventParams *e);

typedef struct {
  LPCWSTR NeededFor;
  LPWSTR Password;
  BOOL Cancel;
  INT reserved;
} CryptoKeyStoragePasswordNeededEventParams;

#define EID_CRYPTOKEYSTORAGE_PASSWORDNEEDED 3

virtual INT SECUREBLACKBOX_CALL FirePasswordNeeded(LPSTR &lpszNeededFor, LPSTR &lpszPassword, BOOL &bCancel);

class CryptoKeyStoragePasswordNeededEventParams {
public:
  const QString &NeededFor();

  const QString &Password();
  void SetPassword(const QString &qsPassword);

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PasswordNeeded(CryptoKeyStoragePasswordNeededEventParams *e);

// Or, subclass CryptoKeyStorage and override this emitter function.
virtual int FirePasswordNeeded(CryptoKeyStoragePasswordNeededEventParams *e) {...}

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.

Syntax

SecureBlackboxCryptoKey (declared in secureblackbox.h)

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

CryptoKey()

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the CryptoKeyStorage class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The CryptoKeyStorage class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the CryptoKeyStorage class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (CryptoKeyStorage Class)

CryptoKeyStorage Config Settings

Base Config Settings

Trappable Errors (CryptoKeyStorage Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CryptoKeyStorage Errors