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

class 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

The ML-DSA context string.

Syntax

def get_context() -> bytes: ...
def set_context(value: bytes) -> None: ...

context = property(get_context, set_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.

hash_algorithm property

The hash algorithm used when PreHash is enabled.

Syntax

def get_hash_algorithm() -> int: ...
def set_hash_algorithm(value: int) -> None: ...

hash_algorithm = property(get_hash_algorithm, set_hash_algorithm)

Possible Values

0   # SHA256
1   # SHA384
2   # SHA512

Default Value

0

Remarks

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

Possible values are:

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

input_file property

The file to process.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

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:

• input_file
• input_message

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

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

input_message property

The message to process.

Syntax

def get_input_message() -> bytes: ...
def set_input_message(value: bytes) -> None: ...

input_message = property(get_input_message, set_input_message)

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:

• input_file
• input_message

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

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

key_private_key property

The raw ML-DSA private key.

Syntax

def get_key_private_key() -> bytes: ...
def set_key_private_key(value: bytes) -> None: ...

key_private_key = property(get_key_private_key, set_key_private_key)

Default Value

""

Remarks

The raw ML-DSA private key.

key_public_key property

The raw ML-DSA public key.

Syntax

def get_key_public_key() -> bytes: ...
def set_key_public_key(value: bytes) -> None: ...

key_public_key = property(get_key_public_key, set_key_public_key)

Default Value

""

Remarks

The raw ML-DSA public key.

pre_hash property

Whether to use HashML-DSA when signing and verifying.

Syntax

def get_pre_hash() -> bool: ...
def set_pre_hash(value: bool) -> None: ...

pre_hash = property(get_pre_hash, set_pre_hash)

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 hash_algorithm before signing or verifying. This supports a single pass over input data from input_file or .

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

signature property

The signature.

Syntax

def get_signature() -> bytes: ...
def set_signature(value: bytes) -> None: ...

signature = property(get_signature, set_signature)

Default Value

""

Remarks

This property holds the ML-DSA signature.

It is populated by sign and must be set before calling verify.

use_hex property

Whether the signature is hex encoded.

Syntax

def get_use_hex() -> bool: ...
def set_use_hex(value: bool) -> None: ...

use_hex = property(get_use_hex, set_use_hex)

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 input_message, input_file, or set_input_stream is always processed as provided.

config method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

create_key method

Creates a new key.

Syntax

def create_key() -> None: ...

Remarks

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

reset method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

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

sign method

Creates a signature.

Syntax

def sign() -> None: ...

Remarks

This method signs the data specified by input_file or input_message using the private key in key and populates signature.

verify method

Verifies a signature.

Syntax

def verify() -> bool: ...

Remarks

This method verifies signature for the data specified by input_file or input_message using the public key in key. The result is returned.

on_error event

Fired when information is available about errors during data delivery.

Syntax

class MLDSAErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class MLDSA:
@property
def on_error() -> Callable[[MLDSAErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[MLDSAErrorEventParams], None]) -> None: ...

Remarks

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

The error_code 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.

on_progress event

Fired as progress is made.

Syntax

class MLDSAProgressEventParams(object):
  @property
  def bytes_processed() -> int: ...

  @property
  def percent_processed() -> int: ...

# In class MLDSA:
@property
def on_progress() -> Callable[[MLDSAProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[MLDSAProgressEventParams], None]) -> None: ...

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.

MLDSA Config Settings

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

MLDSA Errors

MLDSA Errors