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.

Context Property (MLDSA Class)

The ML-DSA context string.

Syntax

public byte[] getContext();
public void setContext(byte[] context);

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

The hash algorithm used when PreHash is enabled.

Syntax

public int getHashAlgorithm();
public void setHashAlgorithm(int hashAlgorithm);

Enumerated values:
  public final static int mhaSHA256 = 0;
  public final static int mhaSHA384 = 1;
  public final static int mhaSHA512 = 2;

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

InputFile Property (MLDSA Class)

The file to process.

Syntax

public String getInputFile();
public void setInputFile(String 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 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:

• 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 Class)

The message to process.

Syntax

public byte[] getInputMessage();
public void setInputMessage(byte[] inputMessage);

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:

• 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 Class)

The ML-DSA key.

Syntax

public MLDSAKey getKey();
public void setKey(MLDSAKey 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 Class)

Whether to use HashML-DSA when signing and verifying.

Syntax

public boolean isPreHash();
public void setPreHash(boolean 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 SetInputStream.

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

Signature Property (MLDSA Class)

The signature.

Syntax

public byte[] getSignature();
public void setSignature(byte[] signature);

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

Whether the signature is hex encoded.

Syntax

public boolean isUseHex();
public void setUseHex(boolean 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 Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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.

CreateKey Method (MLDSA Class)

Creates a new key.

Syntax

public void createKey();

Remarks

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

Reset Method (MLDSA Class)

Resets the class.

Syntax

public void reset();

Remarks

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

SetInputStream Method (MLDSA Class)

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

Syntax

public void setInputStream(java.io.InputStream inputStream);

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:

• 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 Class)

Creates a signature.

Syntax

public void sign();

Remarks

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

Verify Method (MLDSA Class)

Verifies a signature.

Syntax

public boolean verify();

Remarks

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

Error Event (MLDSA Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultMLDSAEventListener implements MLDSAEventListener {
  ...
  public void error(MLDSAErrorEvent e) {}
  ...
}

public class MLDSAErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws 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 Class)

Fired as progress is made.

Syntax

public class DefaultMLDSAEventListener implements MLDSAEventListener {
  ...
  public void progress(MLDSAProgressEvent e) {}
  ...
}

public class MLDSAProgressEvent {
  public long bytesProcessed;
  public int percentProcessed;
}

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

Config Settings (MLDSA Class)

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

MLDSA Config Settings

Base Config Settings

Trappable Errors (MLDSA Class)

MLDSA Errors