MLDSA Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworksencrypt.mldsa()

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

Method List

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

Event List

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

Config Settings

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

MLDSA.Context Property

The ML-DSA context string.

Syntax

getContext(): Uint8Array;
setContext(context: Uint8Array): void;

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.

MLDSA.HashAlgorithm Property

The hash algorithm used when PreHash is enabled.

Syntax

getHashAlgorithm(): MLDSAHashAlgorithms;
setHashAlgorithm(hashAlgorithm: MLDSAHashAlgorithms): void;

enum MLDSAHashAlgorithms {
  mhaSHA256,
  mhaSHA384,
  mhaSHA512
}

Default Value

0

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

MLDSA.InputFile Property

The file to process.

Syntax

getInputFile(): string;
setInputFile(inputFile: string): void;

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 class 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:

• InputFile
• InputMessage

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

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

MLDSA.InputMessage Property

The message to process.

Syntax

getInputMessage(): Uint8Array;
setInputMessage(inputMessage: Uint8Array): void;

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class 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:

• InputFile
• InputMessage

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

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

MLDSA.Key Property

The ML-DSA key.

Syntax

getKey(): MLDSAKey;
setKey(key: MLDSAKey): void;

Default Value

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.

MLDSA.PreHash Property

Whether to use HashML-DSA when signing and verifying.

Syntax

isPreHash(): boolean;
setPreHash(preHash: boolean): void;

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.

MLDSA.Signature Property

The signature.

Syntax

getSignature(): Uint8Array;
setSignature(signature: Uint8Array): void;

Default Value

""

Remarks

This property holds the ML-DSA signature.

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

MLDSA.UseHex Property

Whether the signature is hex encoded.

Syntax

isUseHex(): boolean;
setUseHex(useHex: boolean): void;

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.

MLDSA.config Method

Sets or retrieves a configuration setting.

Syntax

async mldsa.config(configurationString : string): Promise<string>

Remarks

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

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

MLDSA.createKey Method

Creates a new key.

Syntax

async mldsa.createKey(): Promise<void>

Remarks

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

MLDSA.reset Method

Resets the class.

Syntax

async mldsa.reset(): Promise<void>

Remarks

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

MLDSA.setInputStream Method

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

Syntax

async mldsa.setInputStream(inputStream : ReadableStream): Promise<void>

Remarks

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

Input and Output Properties

The class 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:

• InputFile
• InputMessage

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

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

MLDSA.sign Method

Creates a signature.

Syntax

async mldsa.sign(): Promise<void>

Remarks

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

MLDSA.verify Method

Verifies a signature.

Syntax

async mldsa.verify(): Promise<boolean>

Remarks

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

MLDSA.Error Event

Fired when information is available about errors during data delivery.

Syntax

mldsa.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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.

MLDSA.Progress Event

Fired as progress is made.

Syntax

mldsa.on('Progress', listener: (e: {readonly bytesProcessed: number, readonly percentProcessed: number}) => void )

Remarks

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

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

public MLDSAKey();

public MLDSAKey(byte[] publicKey);

public MLDSAKey(byte[] publicKey, byte[] privateKey);

ReadableStream Type

Syntax

interface ReadableStream {
  read(buffer: Uint8Array, offset: number, length: number): Promise<number>;
  readSync(buffer: Uint8Array, offset: number, length: number): number;
  available(): number;
  close(): void;
  mark():void;
  reset():void;
  markSupported():boolean;
}

Remarks

The MLDSA class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the MLDSA class.

When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

read(buffer: Uint8Array, offset: number, length: number): Promise <number> { }

readSync(buffer: Uint8Array, offset: number, length: number): number { }

available(): number { }

close(): void { }

mark(): void { }

reset(): void { }

markSupported(): boolean { }

WriteableStream Type

Syntax

interface WriteableStream {
  write(data: Uint8Array, offset: number, length: number): Promise<void>;
  writeSync(data: Uint8Array, offset: number, length: number): void;
  close(): void;
}

Remarks

The MLDSA class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the MLDSA class.

When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

write(data: Uint8Array, offset: number, length: number): Promise <void> { }

writeSync(data: Uint8Array, offset: number, length: number): void { }

close(): void { }

Config Settings (class ipworksencrypt.mldsa)

MLDSA Config Settings

Base Config Settings

Trappable Errors (class ipworksencrypt.mldsa)

MLDSA Errors