CryptoKeyStorage Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TsbxCryptoKeyStorage

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

Method List

---

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

Event List

---

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

Config Settings

---

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

FIPSMode Property (CryptoKeyStorage Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeyCount Property (CryptoKeyStorage Component)

The number of records in the Key arrays.

Syntax

__property int KeyCount = { read=FKeyCount };

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

The algorithm of the cryptographic key.

Syntax

__property String KeyAlgorithm[int KeyIndex] = { read=FKeyAlgorithm };

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

The length of the key in bits.

Syntax

__property int KeyBits[int KeyIndex] = { read=FKeyBits };

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

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

Syntax

__property String KeyCurve[int KeyIndex] = { read=FKeyCurve };

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

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

Syntax

__property bool KeyExportable[int KeyIndex] = { read=FKeyExportable };

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

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

Syntax

__property __int64 KeyHandle[int KeyIndex] = { read=FKeyHandle };

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

Provides access to a storage-specific key identifier.

Syntax

__property DynamicArray KeyID[int KeyIndex] = { read=FKeyID };

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

The initialization vector (IV) of a symmetric key.

Syntax

__property DynamicArray KeyIV[int KeyIndex] = { read=FKeyIV };

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

The byte array representation of the key.

Syntax

__property DynamicArray KeyKey[int KeyIndex] = { read=FKeyKey };

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

A nonce value associated with a key.

Syntax

__property DynamicArray KeyNonce[int KeyIndex] = { read=FKeyNonce };

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

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

Syntax

__property bool KeyPrivate[int KeyIndex] = { read=FKeyPrivate };

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

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

Syntax

__property bool KeyPublic[int KeyIndex] = { read=FKeyPublic };

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

Returns the key subject.

Syntax

__property DynamicArray KeySubject[int KeyIndex] = { read=FKeySubject };

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

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

Syntax

__property bool KeySymmetric[int KeyIndex] = { read=FKeySymmetric };

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

Returns True if this key is valid.

Syntax

__property bool KeyValid[int KeyIndex] = { read=FKeyValid };

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

Indicates whether the storage is in the open state.

Syntax

__property bool Opened = { read=FOpened };

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

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

Syntax

__property __int64 PinnedKeyHandle = { read=FPinnedKeyHandle, write=FSetPinnedKeyHandle };

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

The number of records in the SelectedKey arrays.

Syntax

__property int SelectedKeyCount = { read=FSelectedKeyCount };

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

The algorithm of the cryptographic key.

Syntax

__property String SelectedKeyAlgorithm[int SelectedKeyIndex] = { read=FSelectedKeyAlgorithm };

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

The length of the key in bits.

Syntax

__property int SelectedKeyBits[int SelectedKeyIndex] = { read=FSelectedKeyBits };

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

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

Syntax

__property String SelectedKeyCurve[int SelectedKeyIndex] = { read=FSelectedKeyCurve };

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

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

Syntax

__property bool SelectedKeyExportable[int SelectedKeyIndex] = { read=FSelectedKeyExportable };

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

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

Syntax

__property __int64 SelectedKeyHandle[int SelectedKeyIndex] = { read=FSelectedKeyHandle };

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

Provides access to a storage-specific key identifier.

Syntax

__property DynamicArray SelectedKeyID[int SelectedKeyIndex] = { read=FSelectedKeyID };

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

The initialization vector (IV) of a symmetric key.

Syntax

__property DynamicArray SelectedKeyIV[int SelectedKeyIndex] = { read=FSelectedKeyIV };

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

The byte array representation of the key.

Syntax

__property DynamicArray SelectedKeyKey[int SelectedKeyIndex] = { read=FSelectedKeyKey };

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

A nonce value associated with a key.

Syntax

__property DynamicArray SelectedKeyNonce[int SelectedKeyIndex] = { read=FSelectedKeyNonce };

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

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

Syntax

__property bool SelectedKeyPrivate[int SelectedKeyIndex] = { read=FSelectedKeyPrivate };

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

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

Syntax

__property bool SelectedKeyPublic[int SelectedKeyIndex] = { read=FSelectedKeyPublic };

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

Returns the key subject.

Syntax

__property DynamicArray SelectedKeySubject[int SelectedKeyIndex] = { read=FSelectedKeySubject };

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

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

Syntax

__property bool SelectedKeySymmetric[int SelectedKeyIndex] = { read=FSelectedKeySymmetric };

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

Returns True if this key is valid.

Syntax

__property bool SelectedKeyValid[int SelectedKeyIndex] = { read=FSelectedKeyValid };

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

A unique identifier of this storage.

Syntax

__property String StorageID = { read=FStorageID };

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

Specifies the location of the currently opened storage.

Syntax

__property String StorageLocation = { read=FStorageLocation };

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

Adds the pinned key to the storage.

Syntax

void __fastcall AddPinned();

Remarks

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

Clear Method (CryptoKeyStorage Component)

Removes all existing keys from the storage.

Syntax

void __fastcall Clear();

Remarks

Use this method to empty the storage.

Close Method (CryptoKeyStorage Component)

Closes the logical storage.

Syntax

void __fastcall Close(bool Save);

Remarks

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

Config Method (CryptoKeyStorage Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

CreateNew Method (CryptoKeyStorage Component)

Creates a new storage.

Syntax

void __fastcall CreateNew(String StorageLocation, String StorageID);

Remarks

Use this method to create new key storage.

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

DoAction Method (CryptoKeyStorage Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. 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;....

GetStorageProperty Method (CryptoKeyStorage Component)

Returns the value of a custom key storage property.

Syntax

String __fastcall GetStorageProperty(String PropName);

Remarks

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

Currently no custom properties are available for this component.

ImportBytes Method (CryptoKeyStorage Component)

Adds a key to the storage.

Syntax

void __fastcall ImportBytes(DynamicArray<Byte> Value, int Format, String KeyAlgorithm, String Scheme, String SchemeParams, int KeyType);

Remarks

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

ImportFromFile Method (CryptoKeyStorage Component)

Adds a key to the storage.

Syntax

void __fastcall ImportFromFile(String Filename, int Format, String KeyAlgorithm, String Scheme, String SchemeParams, int KeyType);

Remarks

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

ListStores Method (CryptoKeyStorage Component)

Returns a list of individual stores available within the storage.

Syntax

String __fastcall ListStores();

Remarks

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

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

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

Login Method (CryptoKeyStorage Component)

Signs in to a session or elevates the session rights.

Syntax

void __fastcall Login(int SessionType, String Pin, bool ReadOnly);

Remarks

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

Logout Method (CryptoKeyStorage Component)

Signs out of an opened session.

Syntax

void __fastcall Logout(bool CloseSesion);

Remarks

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

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

Open Method (CryptoKeyStorage Component)

Opens existing storage or creates one in memory.

Syntax

void __fastcall Open(String StorageID);

Remarks

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

Memory

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

File

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

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

Windows System

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

user is one of these values:

• currentuser
• localmachine
• currentservice

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

params are chosen from this list:

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

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

PKCS#11 Device

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

user is the username used to access the device.

pin is the pin code used to access the device.

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

params are chosen from this list:

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

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

KMIP Server

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

password is the password use to authenticate to the server.

remotehost is the FQDN to the server.

remoteport is the server port to connect to.

params are chosen from this list:

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

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

Refresh Method (CryptoKeyStorage Component)

Refreshes all storage keychains.

Syntax

void __fastcall Refresh();

Remarks

Call this method to refresh the storage.

Remove Method (CryptoKeyStorage Component)

Removes a key from the storage.

Syntax

void __fastcall Remove(int Index);

Remarks

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

Select Method (CryptoKeyStorage Component)

Allows the selection of keys from the store.

Syntax

void __fastcall Select(String Filter, bool PrivateKeyNeeded, int MaxCount);

Remarks

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

SetStorageProperty Method (CryptoKeyStorage Component)

Sets the value of a custom key storage property.

Syntax

void __fastcall SetStorageProperty(String PropName, String PropValue);

Remarks

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

Currently no custom properties are available for this component.

Error Event (CryptoKeyStorage Component)

Fires when an errors happens during a key storage operation.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxCryptoKeyStorageErrorEventParams;
typedef void __fastcall (__closure *TsbxCryptoKeyStorageErrorEvent)(System::TObject* Sender, TsbxCryptoKeyStorageErrorEventParams *e);
__property TsbxCryptoKeyStorageErrorEvent OnError = { read=FOnError, write=FOnError };

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

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxCryptoKeyStorageNotificationEventParams;
typedef void __fastcall (__closure *TsbxCryptoKeyStorageNotificationEvent)(System::TObject* Sender, TsbxCryptoKeyStorageNotificationEventParams *e);
__property TsbxCryptoKeyStorageNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component 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 the 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 Component)

This event is fired when a decryption password is needed.

Syntax

typedef struct {
  String NeededFor;
  String Password;
  bool Cancel;
} TsbxCryptoKeyStoragePasswordNeededEventParams;
typedef void __fastcall (__closure *TsbxCryptoKeyStoragePasswordNeededEvent)(System::TObject* Sender, TsbxCryptoKeyStoragePasswordNeededEventParams *e);
__property TsbxCryptoKeyStoragePasswordNeededEvent OnPasswordNeeded = { read=FOnPasswordNeeded, write=FOnPasswordNeeded };

Remarks

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

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

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

Config Settings (CryptoKeyStorage Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

CryptoKeyStorage Config Settings

Base Config Settings

Trappable Errors (CryptoKeyStorage Component)

CryptoKeyStorage Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)