MLDSA Component

Properties   Methods   Events   Config Settings   Errors  

The MLDSA component can be used to create and verify digital signatures using Module-Lattice-Based Digital Signature Algorithm (ML-DSA) cryptography.

Syntax

TipcMLDSA

Remarks

The MLDSA component can be used to create and verify digital signatures using Module-Lattice-Based Digital Signature Algorithm (ML-DSA) cryptography. Includes support for ML-DSA-44, ML-DSA-65, and ML-DSA-87 parameter sets.

Note that by default the component uses ML-DSA-44. 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.

Context Property (MLDSA Component)

The ML-DSA context string.

Syntax

property Context: String read get_Context write set_Context;
property ContextB: TBytes read get_ContextB write set_ContextB;

Default Value

''

Remarks

This property specifies the optional ML-DSA context used when signing and verifying. This property may be empty. The default value is empty.

The same value must be specified when calling Sign and Verify.

The maximum length is 255 bytes.

HashAlgorithm Property (MLDSA Component)

The hash algorithm used when PreHash is enabled.

Syntax

property HashAlgorithm: TipcMLDSAHashAlgorithms read get_HashAlgorithm write set_HashAlgorithm;

TipcMLDSAHashAlgorithms = (
  mhaSHA256,
  mhaSHA384,
  mhaSHA512
);

Default Value

mhaSHA256

Remarks

This property specifies the hash algorithm used to pre-hash input data when PreHash is set to True.

Possible values are:

• 0 (mhaSHA256 - default): SHA-256
• 1 (mhaSHA384): SHA-384
• 2 (mhaSHA512): SHA-512

InputFile Property (MLDSA Component)

The file to process.

Syntax

property InputFile: String read get_InputFile write set_InputFile;

Default Value

''

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

InputMessage Property (MLDSA Component)

The message to process.

Syntax

property InputMessage: String read get_InputMessage write set_InputMessage;
property InputMessageB: TBytes read get_InputMessageB write set_InputMessageB;

Default Value

''

Remarks

This property specifies the message to be processed.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Key Property (MLDSA Component)

The ML-DSA key.

Syntax

property Key: TipcMLDSAKey read get_Key write set_Key;

Remarks

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

The private key is required before calling Sign, and the public key is required before calling Verify.

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

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

PreHash Property (MLDSA Component)

Whether to use HashML-DSA when signing and verifying.

Syntax

property PreHash: Boolean read get_PreHash write set_PreHash;

Default Value

false

Remarks

This property specifies whether the component uses HashML-DSA when signing and verifying.

If set to True, the input is pre-hashed using HashAlgorithm before signing or verifying. This supports a single pass over input data from InputFile or .

If set to False (default), pure ML-DSA is used.

Signature Property (MLDSA Component)

The signature.

Syntax

property Signature: String read get_Signature write set_Signature;
property SignatureB: TBytes read get_SignatureB write set_SignatureB;

Default Value

''

Remarks

This property holds the ML-DSA signature.

It is populated by Sign and must be set before calling Verify.

UseHex Property (MLDSA Component)

Whether the signature is hex encoded.

Syntax

property UseHex: Boolean read get_UseHex write set_UseHex;

Default Value

false

Remarks

This property specifies whether Signature is hex encoded.

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

When Sign is called and this property is set to True, Signature is hex encoded when populated.

When Verify is called and this property is set to True, Signature is treated as hex encoded.

Input data from InputMessage, InputFile, or SetInputStream is always processed as provided.

Config Method (MLDSA 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 (MLDSA Component)

Creates a new key.

Syntax

procedure CreateKey();

Remarks

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

Reset Method (MLDSA Component)

Resets the component.

Syntax

procedure Reset();

Remarks

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

SetInputStream Method (MLDSA Component)

Sets the stream from which the component will read data to encrypt or decrypt.

Syntax

procedure SetInputStream(InputStream: TStream);

Remarks

This method sets the stream from which the component will read data to encrypt or decrypt.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Sign Method (MLDSA Component)

Creates a signature.

Syntax

procedure Sign();

Remarks

This method signs the data specified by InputFile or InputMessage using the private key in Key and populates Signature.

Verify Method (MLDSA Component)

Verifies a signature.

Syntax

function Verify(): Boolean;

Remarks

This method verifies Signature for the data specified by InputFile or InputMessage using the public key in Key. The result is returned.

Error Event (MLDSA 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.

Progress Event (MLDSA Component)

Fired as progress is made.

Syntax

type TProgressEvent = procedure (
  Sender: TObject;
  BytesProcessed: Int64;
  PercentProcessed: Integer
) of Object;

property OnProgress: TProgressEvent read FOnProgress write FOnProgress;

Remarks

This event is fired automatically as data is processed by the component.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

MLDSAKey Type

Contains a raw ML-DSA key.

Remarks

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

• PrivateKey
• PublicKey

Fields

Constructors

>

constructor Create();

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

MLDSA Config Settings

Base Config Settings

Trappable Errors (MLDSA Component)

MLDSA Errors