CryptoKeyManager Component

Properties   Methods   Events   Config Settings   Errors  

The CryptoKeyManager component provides a simple way to load, generate and manage generic crypto keys.

Syntax

TsbxCryptoKeyManager

Remarks

CryptoKeyManager allows you to load, save, generate, import, and export low-level crypto keys. One example of such keys are raw RSA keys stored in PKCS1 format or AES256 keys. CryptoKeyManager supports asymmetric, symmetric, and HMAC keys.

CryptoKeyManager is a typical companion for low-level cryptography classes, such as PublicKeyCrypto, SymmetricCrypto, and HashFunction. It can also be used to provide external key material to certificate objects, and to derive cryptographic keys from passwords.

Use ImportBytes or ImportFromFile method to load the key material from a buffer or file. Use ImportFromCert (and remember to assign the certificate object to the Certificate property before calling it) to import a key from an X.509 certificate. Once loaded, the key will be available in the Key property.

To generate a new key or keypair use Generate method. You can export the generated key using ExportBytes or ExportToFile method. You can attach the generated or loaded key to an external certificate object using the ExportToCert method.

Note: CryptoKeyManager can only work with one cryptographic key at a time. Use CryptoKeyStorage to access media containing more than one key.

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.

Certificate Property (CryptoKeyManager Component)

A container for the certificate object.

Syntax

property Certificate: TsbxCertificate read get_Certificate write set_Certificate;

Remarks

Use this property to set or access the properties of the certificate object on which an import or export action is to be performed.

This property is not available at design time.

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

DerivationAlgorithm Property (CryptoKeyManager Component)

Specifies the algorithm to use for key derivation.

Syntax

property DerivationAlgorithm: String read get_DerivationAlgorithm write set_DerivationAlgorithm;

Default Value

'PKCS5'

Remarks

Use this property to specify the key derivation algorithm to use.

Component supports the following algorithms: PKCS5, BCrypt, SCrypt, Argon2d, Argon2i, Argon2id.

DeriveIterations Property (CryptoKeyManager Component)

Specifies the number of iterations to use as part of key derivation routine.

Syntax

property DeriveIterations: Integer read get_DeriveIterations write set_DeriveIterations;

Default Value

2048

Remarks

Use this property to adjust the number of hash algorithm iterations to employ as part of key derivation function.

FIPSMode Property (CryptoKeyManager Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

HMACAlgorithm Property (CryptoKeyManager Component)

Specifies the HMAC algorithm to use with the key derivation algorithm.

Syntax

property HMACAlgorithm: String read get_HMACAlgorithm write set_HMACAlgorithm;

Default Value

'SHA1'

Remarks

Use this property to specify the HMAC algorithm to use with the chosen key derivation algorithm.

Component supports the following algorithms: SHA1, SHA224, SHA256, SHA384, SHA512, MD5, RIPEMD, HMAC.

Key Property (CryptoKeyManager Component)

The key object that the manager is currently working with.

Syntax

property Key: TsbxCryptoKey read get_Key write set_Key;

Remarks

Use this property to pass a key to the manager (for example, for serialization), or to obtain a key from the manager (e.g., after generating or importing it).

This property is not available at design time.

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

Config Method (CryptoKeyManager Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

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.

DeriveKey Method (CryptoKeyManager Component)

Generates a strong cryptographic key from a password.

Syntax

procedure DeriveKey(KeyBits: Integer; Password: String; Salt: String);

Remarks

Use this method to generate a cryptographically strong key of a needed length from a password.

This method uses a general-purpose PBKDF2 function with PRF1 and 2048 iterations.

DoAction Method (CryptoKeyManager Component)

Performs an additional action.

Syntax

function DoAction(ActionID: String; ActionParams: String): String;

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

ExportBytes Method (CryptoKeyManager Component)

Exports the key to a byte array.

Syntax

function ExportBytes(Format: Integer; KeyType: Integer): TBytes;

Remarks

Use this method to save the Key (both the public and secret parts) to a byte array.

ExportToCert Method (CryptoKeyManager Component)

Exports the key to a certificate.

Syntax

procedure ExportToCert();

Remarks

Use this method to save the Key (both the public and secret parts) to the certificate specified in Certificate.

ExportToFile Method (CryptoKeyManager Component)

Exports the key to a file.

Syntax

procedure ExportToFile(Filename: String; Format: Integer; KeyType: Integer);

Remarks

Use this method to save the Key (both the public and secret parts) to the file passed via the Filename parameter.

ExportToStream Method (CryptoKeyManager Component)

Exports the key to a stream.

Syntax

procedure ExportToStream(Stream: TStream; Format: Integer; KeyType: Integer);

Remarks

Use this method to save the Key (both the public and secret parts) to a stream pointed by the Stream parameter.

Generate Method (CryptoKeyManager Component)

Generates a new crypto key.

Syntax

procedure Generate(KeyAlgorithm: String; Scheme: String; SchemeParams: String; KeyBits: Integer);

Remarks

Call this method to generate a new key or keypair with the desired KeyAlgorithm and KeyBits of length.

The generated key will be populated in the Key property.

The below snippet illustrates the use of the Generate method to create an RSA keypair: CryptoKeyManager keyMgr = new CryptoKeyManager(); keyMgr.Generate("RSA", "", "", 2048); keyMgr.ExportToFile("public.pem", Constants.kffPEM, Constants.ktPublic); keyMgr.ExportToFile("private.pem", Constants.kffPEM, Constants.ktSecret);

GetKeyParam Method (CryptoKeyManager Component)

Returns an algorithm-specific key parameter.

Syntax

function GetKeyParam(Name: String): TBytes;

Remarks

Use this method to retrieve an algorithm-specific key parameter.

GetKeyParamStr Method (CryptoKeyManager Component)

Returns an algorithm-specific key parameter to a string.

Syntax

function GetKeyParamStr(Name: String): String;

Remarks

Use this method to get an algorithm-specific key parameter to a string.

ImportBytes Method (CryptoKeyManager Component)

Loads a key from a byte array.

Syntax

procedure ImportBytes(Value: TBytes; Format: Integer; KeyAlgorithm: String; Scheme: String; SchemeParams: String; KeyType: Integer);

Remarks

Use this method to load a key, either public or secret, from a byte array.

Example using Custom Property arrays: Mgr.ImportBytes(ThirtyTwoKeyBytes, kffDER, "AES256", "", "", ktSecret)

ImportFromCert Method (CryptoKeyManager Component)

Loads a key from a certificate.

Syntax

procedure ImportFromCert();

Remarks

Use this method to load a key, either public or secret, from a certificate.

ImportFromFile Method (CryptoKeyManager Component)

Loads a key from a file.

Syntax

procedure ImportFromFile(Filename: String; Format: Integer; KeyAlgorithm: String; Scheme: String; SchemeParams: String; KeyType: Integer);

Remarks

Use this method to load a key, either public or secret, from a file.

ImportFromStream Method (CryptoKeyManager Component)

Loads a key from a stream.

Syntax

procedure ImportFromStream(Stream: TStream; Format: Integer; KeyAlgorithm: String; Scheme: String; SchemeParams: String; KeyType: Integer);

Remarks

Use this method to load a key, either public or secret, from a stream.

SetKeyParam Method (CryptoKeyManager Component)

Sets an algorithm-specific key parameter.

Syntax

procedure SetKeyParam(Name: String; Value: TBytes);

Remarks

Use this method to set an algorithm-specific key parameter.

SetKeyParamStr Method (CryptoKeyManager Component)

Sets an algorithm-specific key parameter.

Syntax

procedure SetKeyParamStr(Name: String; ValueStr: String);

Remarks

Use this method to set an algorithm-specific key parameter provided in a string.

Error Event (CryptoKeyManager Component)

Informs about an error during an operation.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The event is fired when an error happens in the middle of the component's work.

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

Notification Event (CryptoKeyManager Component)

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

Syntax

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent 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 (CryptoKeyManager Component)

This event is fired when a decryption password is needed.

Syntax

type TPasswordNeededEvent = procedure (
  Sender: TObject;
  const NeededFor: String;
  var Password: String;
  var Cancel: Boolean
) of Object;

property OnPasswordNeeded: TPasswordNeededEvent 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 certificate for which the password is requested.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

>

constructor Create();

Creates a new object with default field values.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

>

constructor Create();

Creates an empty crypto key object.

Config Settings (CryptoKeyManager 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.

CryptoKeyManager Config Settings

Base Config Settings

Trappable Errors (CryptoKeyManager Component)

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