MLKEM Component

Properties   Methods   Events   Config Settings   Errors  

The MLKEM component can be used to establish a shared secret key through Module-Lattice-Based Key-Encapsulation Mechanism (ML-KEM) cryptography.

Syntax

TipcMLKEM

Remarks

The MLKEM component can be used to establish a shared secret key through Module-Lattice-Based Key-Encapsulation Mechanism (ML-KEM) cryptography. Includes support for ML-KEM-512, ML-KEM-768, and ML-KEM-1024 parameter sets.

Note that by default the component uses ML-KEM-512. You may specify the parameter set by setting ParamSet.

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.

CipherText Property (MLKEM Component)

The cipher text.

Syntax

property CipherText: String read get_CipherText write set_CipherText;
property CipherTextB: TBytes read get_CipherTextB write set_CipherTextB;

Default Value

''

Remarks

This property holds the ML-KEM ciphertext.

It is populated by Encapsulate and must be set before calling Decapsulate.

Key Property (MLKEM Component)

The ML-KEM key.

Syntax

property Key: TipcMLKEMKey read get_Key write set_Key;

Remarks

This property specifies the ML-KEM public or private key.

The public key is required before calling Encapsulate, and the private key is required before calling Decapsulate.

ML-KEM keys are made up of raw private key and public key fields.

PublicKey holds the public key.

PrivateKey holds the private key.

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

SharedSecret Property (MLKEM Component)

The computed shared secret.

Syntax

property SharedSecret: String read get_SharedSecret;
property SharedSecretB: TBytes read get_SharedSecretB;

Default Value

''

Remarks

This property holds the shared secret computed by Encapsulate or Decapsulate.

This property is read-only.

UseHex Property (MLKEM Component)

Whether binary values are hex encoded.

Syntax

property UseHex: Boolean read get_UseHex write set_UseHex;

Default Value

false

Remarks

This property specifies whether CipherText and SharedSecret are hex encoded when Encapsulate is called.

If set to False (default), values are provided as-is with no encoding.

When Decapsulate is called and this property is set to True, CipherText is treated as hex encoded and SharedSecret is hex encoded when populated.

Config Method (MLKEM 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.

CreateKey Method (MLKEM Component)

Creates a new key.

Syntax

procedure CreateKey();

Remarks

CreateKey creates a new ML-KEM public and private key pair.

When this method is called, Key is populated with the generated raw public and private key values. The parameter set is controlled by the ParamSet configuration setting.

Decapsulate Method (MLKEM Component)

Decapsulates a shared secret.

Syntax

procedure Decapsulate();

Remarks

This method uses the private key in Key and the ciphertext in CipherText to recover the shared secret.

The shared secret is available from SharedSecret.

Encapsulate Method (MLKEM Component)

Encapsulates a shared secret.

Syntax

procedure Encapsulate();

Remarks

This method uses the public key in Key to generate a shared secret and ciphertext.

The generated shared secret is available from SharedSecret, and the ciphertext is available from CipherText.

Reset Method (MLKEM Component)

Resets the component.

Syntax

procedure Reset();

Remarks

When called, the component will reset all of its properties to their default values.

Error Event (MLKEM Component)

Fired when information is available about errors during data delivery.

Syntax

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

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

MLKEMKey Type

Contains a raw ML-KEM key.

Remarks

This type contains the raw public and private key values used by the MLKEM component.

• PrivateKey
• PublicKey

Fields

Constructors

>

constructor Create();

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

MLKEM Config Settings

Base Config Settings

Trappable Errors (MLKEM Component)

MLKEM Errors