MLKEM Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

MLKEM

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

Method List

---

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

Event List

---

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

Config Settings

---

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

CipherText Property (MLKEM Control)

The cipher text.

Syntax

mlkemcontrol.CipherText[=string]

Default Value

""

Remarks

This property holds the ML-KEM ciphertext.

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CipherTextB.

Data Type

Binary String

KeyPrivateKey Property (MLKEM Control)

The raw ML-KEM private key.

Syntax

mlkemcontrol.KeyPrivateKey[=string]

Default Value

""

Remarks

The raw ML-KEM private key.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyPrivateKeyB.

Data Type

Binary String

KeyPublicKey Property (MLKEM Control)

The raw ML-KEM public key.

Syntax

mlkemcontrol.KeyPublicKey[=string]

Default Value

""

Remarks

The raw ML-KEM public key.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyPublicKeyB.

Data Type

Binary String

SharedSecret Property (MLKEM Control)

The computed shared secret.

Syntax

mlkemcontrol.SharedSecret

Default Value

""

Remarks

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SharedSecretB.

This property is read-only.

Data Type

Binary String

UseHex Property (MLKEM Control)

Whether binary values are hex encoded.

Syntax

mlkemcontrol.UseHex[=boolean]

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.

Data Type

Boolean

Config Method (MLKEM Control)

Sets or retrieves a configuration setting.

Syntax

mlkemcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 Control)

Creates a new key.

Syntax

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

Decapsulates a shared secret.

Syntax

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

Encapsulates a shared secret.

Syntax

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

Resets the control.

Syntax

mlkemcontrol.Reset 

Remarks

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

Error Event (MLKEM Control)

Fired when information is available about errors during data delivery.

Syntax

Sub mlkemcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

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.

Config Settings (MLKEM Control)

The control 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 control, access to these internal properties is provided through the Config method.

MLKEM Config Settings

Base Config Settings

Trappable Errors (MLKEM Control)

MLKEM Errors