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

KeyCount Property (CryptoKeyStorage Class)

The number of records in the Key arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyCount();

Unicode (Windows)
INT GetKeyCount();

int secureblackbox_cryptokeystorage_getkeycount(void* lpObj);

int GetKeyCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyAlgorithm
• KeyBits
• KeyCurve
• KeyExportable
• KeyHandle
• KeyID
• KeyIV
• KeyKey
• KeyNonce
• KeyPrivate
• KeyPublic
• KeySubject
• KeySymmetric
• KeyValid

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

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

Data Type

Integer

KeyAlgorithm Property (CryptoKeyStorage Class)

The algorithm of the cryptographic key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyAlgorithm(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyAlgorithm(INT iKeyIndex);

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

QString GetKeyAlgorithm(int iKeyIndex);

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.

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 and not available at design time.

Data Type

String

KeyBits Property (CryptoKeyStorage Class)

The length of the key in bits.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyBits(int iKeyIndex);

Unicode (Windows)
INT GetKeyBits(INT iKeyIndex);

int secureblackbox_cryptokeystorage_getkeybits(void* lpObj, int keyindex);

int GetKeyBits(int iKeyIndex);

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 and not available at design time.

Data Type

Integer

KeyCurve Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyCurve(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyCurve(INT iKeyIndex);

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

QString GetKeyCurve(int iKeyIndex);

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 and not available at design time.

Data Type

String

KeyExportable Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyExportable(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyExportable(INT iKeyIndex);

int secureblackbox_cryptokeystorage_getkeyexportable(void* lpObj, int keyindex);

bool GetKeyExportable(int iKeyIndex);

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 and not available at design time.

Data Type

Boolean

KeyHandle Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyHandle(int iKeyIndex);

Unicode (Windows)
LONG64 GetKeyHandle(INT iKeyIndex);

int64 secureblackbox_cryptokeystorage_getkeyhandle(void* lpObj, int keyindex);

qint64 GetKeyHandle(int iKeyIndex);

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 and not available at design time.

Data Type

Long64

KeyID Property (CryptoKeyStorage Class)

Provides access to a storage-specific key identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyID(int iKeyIndex, char* &lpKeyID, int &lenKeyID);

Unicode (Windows)
INT GetKeyID(INT iKeyIndex, LPSTR &lpKeyID, INT &lenKeyID);

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

QByteArray GetKeyID(int iKeyIndex);

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 and not available at design time.

Data Type

Byte Array

KeyIV Property (CryptoKeyStorage Class)

The initialization vector (IV) of a symmetric key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyIV(int iKeyIndex, char* &lpKeyIV, int &lenKeyIV);

Unicode (Windows)
INT GetKeyIV(INT iKeyIndex, LPSTR &lpKeyIV, INT &lenKeyIV);

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

QByteArray GetKeyIV(int iKeyIndex);

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 and not available at design time.

Data Type

Byte Array

KeyKey Property (CryptoKeyStorage Class)

The byte array representation of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyKey(int iKeyIndex, char* &lpKeyKey, int &lenKeyKey);

Unicode (Windows)
INT GetKeyKey(INT iKeyIndex, LPSTR &lpKeyKey, INT &lenKeyKey);

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

QByteArray GetKeyKey(int iKeyIndex);

Remarks

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

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 and not available at design time.

Data Type

Byte Array

KeyNonce Property (CryptoKeyStorage Class)

A nonce value associated with a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyNonce(int iKeyIndex, char* &lpKeyNonce, int &lenKeyNonce);

Unicode (Windows)
INT GetKeyNonce(INT iKeyIndex, LPSTR &lpKeyNonce, INT &lenKeyNonce);

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

QByteArray GetKeyNonce(int iKeyIndex);

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 and not available at design time.

Data Type

Byte Array

KeyPrivate Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyPrivate(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyPrivate(INT iKeyIndex);

int secureblackbox_cryptokeystorage_getkeyprivate(void* lpObj, int keyindex);

bool GetKeyPrivate(int iKeyIndex);

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 and not available at design time.

Data Type

Boolean

KeyPublic Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyPublic(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyPublic(INT iKeyIndex);

int secureblackbox_cryptokeystorage_getkeypublic(void* lpObj, int keyindex);

bool GetKeyPublic(int iKeyIndex);

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 and not available at design time.

Data Type

Boolean

KeySubject Property (CryptoKeyStorage Class)

Returns the key subject.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeySubject(int iKeyIndex, char* &lpKeySubject, int &lenKeySubject);

Unicode (Windows)
INT GetKeySubject(INT iKeyIndex, LPSTR &lpKeySubject, INT &lenKeySubject);

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

QByteArray GetKeySubject(int iKeyIndex);

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 and not available at design time.

Data Type

Byte Array

KeySymmetric Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeySymmetric(int iKeyIndex);

Unicode (Windows)
BOOL GetKeySymmetric(INT iKeyIndex);

int secureblackbox_cryptokeystorage_getkeysymmetric(void* lpObj, int keyindex);

bool GetKeySymmetric(int iKeyIndex);

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 and not available at design time.

Data Type

Boolean

KeyValid Property (CryptoKeyStorage Class)

Returns True if this key is valid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyValid(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyValid(INT iKeyIndex);

int secureblackbox_cryptokeystorage_getkeyvalid(void* lpObj, int keyindex);

bool GetKeyValid(int iKeyIndex);

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 and not available at design time.

Data Type

Boolean

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

PinnedKeyHandle Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPinnedKeyHandle();
int SetPinnedKeyHandle(int64 lPinnedKeyHandle);

Unicode (Windows)
LONG64 GetPinnedKeyHandle();
INT SetPinnedKeyHandle(LONG64 lPinnedKeyHandle);

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

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

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());

This property is not available at design time.

Data Type

Long64

SelectedKeyCount Property (CryptoKeyStorage Class)

The number of records in the SelectedKey arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyCount();

Unicode (Windows)
INT GetSelectedKeyCount();

int secureblackbox_cryptokeystorage_getselectedkeycount(void* lpObj);

int GetSelectedKeyCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SelectedKeyAlgorithm
• SelectedKeyBits
• SelectedKeyCurve
• SelectedKeyExportable
• SelectedKeyHandle
• SelectedKeyID
• SelectedKeyIV
• SelectedKeyKey
• SelectedKeyNonce
• SelectedKeyPrivate
• SelectedKeyPublic
• SelectedKeySubject
• SelectedKeySymmetric
• SelectedKeyValid

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

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

Data Type

Integer

SelectedKeyAlgorithm Property (CryptoKeyStorage Class)

The algorithm of the cryptographic key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSelectedKeyAlgorithm(int iSelectedKeyIndex);

Unicode (Windows)
LPWSTR GetSelectedKeyAlgorithm(INT iSelectedKeyIndex);

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

QString GetSelectedKeyAlgorithm(int iSelectedKeyIndex);

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.

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 and not available at design time.

Data Type

String

SelectedKeyBits Property (CryptoKeyStorage Class)

The length of the key in bits.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyBits(int iSelectedKeyIndex);

Unicode (Windows)
INT GetSelectedKeyBits(INT iSelectedKeyIndex);

int secureblackbox_cryptokeystorage_getselectedkeybits(void* lpObj, int selectedkeyindex);

int GetSelectedKeyBits(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Integer

SelectedKeyCurve Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSelectedKeyCurve(int iSelectedKeyIndex);

Unicode (Windows)
LPWSTR GetSelectedKeyCurve(INT iSelectedKeyIndex);

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

QString GetSelectedKeyCurve(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

String

SelectedKeyExportable Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyExportable(int iSelectedKeyIndex);

Unicode (Windows)
BOOL GetSelectedKeyExportable(INT iSelectedKeyIndex);

int secureblackbox_cryptokeystorage_getselectedkeyexportable(void* lpObj, int selectedkeyindex);

bool GetSelectedKeyExportable(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Boolean

SelectedKeyHandle Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSelectedKeyHandle(int iSelectedKeyIndex);

Unicode (Windows)
LONG64 GetSelectedKeyHandle(INT iSelectedKeyIndex);

int64 secureblackbox_cryptokeystorage_getselectedkeyhandle(void* lpObj, int selectedkeyindex);

qint64 GetSelectedKeyHandle(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Long64

SelectedKeyID Property (CryptoKeyStorage Class)

Provides access to a storage-specific key identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyID(int iSelectedKeyIndex, char* &lpSelectedKeyID, int &lenSelectedKeyID);

Unicode (Windows)
INT GetSelectedKeyID(INT iSelectedKeyIndex, LPSTR &lpSelectedKeyID, INT &lenSelectedKeyID);

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

QByteArray GetSelectedKeyID(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Byte Array

SelectedKeyIV Property (CryptoKeyStorage Class)

The initialization vector (IV) of a symmetric key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyIV(int iSelectedKeyIndex, char* &lpSelectedKeyIV, int &lenSelectedKeyIV);

Unicode (Windows)
INT GetSelectedKeyIV(INT iSelectedKeyIndex, LPSTR &lpSelectedKeyIV, INT &lenSelectedKeyIV);

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

QByteArray GetSelectedKeyIV(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Byte Array

SelectedKeyKey Property (CryptoKeyStorage Class)

The byte array representation of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyKey(int iSelectedKeyIndex, char* &lpSelectedKeyKey, int &lenSelectedKeyKey);

Unicode (Windows)
INT GetSelectedKeyKey(INT iSelectedKeyIndex, LPSTR &lpSelectedKeyKey, INT &lenSelectedKeyKey);

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

QByteArray GetSelectedKeyKey(int iSelectedKeyIndex);

Remarks

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

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 and not available at design time.

Data Type

Byte Array

SelectedKeyNonce Property (CryptoKeyStorage Class)

A nonce value associated with a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyNonce(int iSelectedKeyIndex, char* &lpSelectedKeyNonce, int &lenSelectedKeyNonce);

Unicode (Windows)
INT GetSelectedKeyNonce(INT iSelectedKeyIndex, LPSTR &lpSelectedKeyNonce, INT &lenSelectedKeyNonce);

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

QByteArray GetSelectedKeyNonce(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Byte Array

SelectedKeyPrivate Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyPrivate(int iSelectedKeyIndex);

Unicode (Windows)
BOOL GetSelectedKeyPrivate(INT iSelectedKeyIndex);

int secureblackbox_cryptokeystorage_getselectedkeyprivate(void* lpObj, int selectedkeyindex);

bool GetSelectedKeyPrivate(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Boolean

SelectedKeyPublic Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyPublic(int iSelectedKeyIndex);

Unicode (Windows)
BOOL GetSelectedKeyPublic(INT iSelectedKeyIndex);

int secureblackbox_cryptokeystorage_getselectedkeypublic(void* lpObj, int selectedkeyindex);

bool GetSelectedKeyPublic(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Boolean

SelectedKeySubject Property (CryptoKeyStorage Class)

Returns the key subject.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeySubject(int iSelectedKeyIndex, char* &lpSelectedKeySubject, int &lenSelectedKeySubject);

Unicode (Windows)
INT GetSelectedKeySubject(INT iSelectedKeyIndex, LPSTR &lpSelectedKeySubject, INT &lenSelectedKeySubject);

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

QByteArray GetSelectedKeySubject(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Byte Array

SelectedKeySymmetric Property (CryptoKeyStorage Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeySymmetric(int iSelectedKeyIndex);

Unicode (Windows)
BOOL GetSelectedKeySymmetric(INT iSelectedKeyIndex);

int secureblackbox_cryptokeystorage_getselectedkeysymmetric(void* lpObj, int selectedkeyindex);

bool GetSelectedKeySymmetric(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Boolean

SelectedKeyValid Property (CryptoKeyStorage Class)

Returns True if this key is valid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSelectedKeyValid(int iSelectedKeyIndex);

Unicode (Windows)
BOOL GetSelectedKeyValid(INT iSelectedKeyIndex);

int secureblackbox_cryptokeystorage_getselectedkeyvalid(void* lpObj, int selectedkeyindex);

bool GetSelectedKeyValid(int iSelectedKeyIndex);

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 and not available at design time.

Data Type

Boolean

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

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)

Adds 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);

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

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

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

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)

Adds 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);

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

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

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

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)

Adds 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);

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

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

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

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

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

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