Struct ipworksencrypt::MLDSA

Properties   Methods   Events   Config Settings   Errors  

The MLDSA struct 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.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the MLDSA struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of MLDSA when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

context property (MLDSA Struct)

The ML-DSA context string.

Syntax

fn context(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_context(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_context_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

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.

Data Type

Vec

hash_algorithm property (MLDSA Struct)

The hash algorithm used when PreHash is enabled.

Syntax

fn hash_algorithm(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_hash_algorithm(&self, value : i32) ->  Option<IPWorksEncryptError> 

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

Data Type

i32

input_file property (MLDSA Struct)

The file to process.

Syntax

fn input_file(&self ) -> Result<String, IPWorksEncryptError> 
fn set_input_file(&self, value : &str) ->  Option<IPWorksEncryptError> 
fn set_input_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError> 

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 struct 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.

Data Type

String

input_message property (MLDSA Struct)

The message to process.

Syntax

fn input_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_input_message(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_input_message_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

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

Data Type

Vec

key_private_key property (MLDSA Struct)

The raw ML-DSA private key.

Syntax

fn key_private_key(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_key_private_key(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_key_private_key_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

The raw ML-DSA private key.

Data Type

Vec

key_public_key property (MLDSA Struct)

The raw ML-DSA public key.

Syntax

fn key_public_key(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_key_public_key(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_key_public_key_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

The raw ML-DSA public key.

Data Type

Vec

pre_hash property (MLDSA Struct)

Whether to use HashML-DSA when signing and verifying.

Syntax

fn pre_hash(&self ) -> Result<bool, IPWorksEncryptError> 
fn set_pre_hash(&self, value : bool) ->  Option<IPWorksEncryptError> 

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.

Data Type

bool

signature property (MLDSA Struct)

The signature.

Syntax

fn signature(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_signature(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_signature_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

This property holds the ML-DSA signature.

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

Data Type

Vec

use_hex property (MLDSA Struct)

Whether the signature is hex encoded.

Syntax

fn use_hex(&self ) -> Result<bool, IPWorksEncryptError> 
fn set_use_hex(&self, value : bool) ->  Option<IPWorksEncryptError> 

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.

Data Type

bool

config method (MLDSA Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEncryptError>

Remarks

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

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

Creates a new key.

Syntax

fn create_key(&self) -> Result<(), IPWorksEncryptError>

Remarks

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

reset method (MLDSA Struct)

Resets the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksEncryptError>

Remarks

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

sign method (MLDSA Struct)

Creates a signature.

Syntax

fn sign(&self) -> Result<(), IPWorksEncryptError>

Remarks

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

verify method (MLDSA Struct)

Verifies a signature.

Syntax

fn verify(&self) ->  Result<bool, IPWorksEncryptError>

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 (MLDSA Struct)

Fired when information is available about errors during data delivery.

Syntax

// MLDSAErrorEventArgs carries the MLDSA Error event's parameters.
pub struct MLDSAErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// MLDSAErrorEvent defines the signature of the MLDSA Error event's handler function.
pub trait MLDSAErrorEvent {
  fn on_error(&self, sender : MLDSA, e : &mut MLDSAErrorEventArgs);
}

impl <'a> MLDSA<'a> {
  pub fn on_error(&self) -> &'a dyn MLDSAErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn MLDSAErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct 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 (MLDSA Struct)

Fired as progress is made.

Syntax

// MLDSAProgressEventArgs carries the MLDSA Progress event's parameters.
pub struct MLDSAProgressEventArgs {
  fn bytes_processed(&self) -> i64
  fn percent_processed(&self) -> i32
}

// MLDSAProgressEvent defines the signature of the MLDSA Progress event's handler function.
pub trait MLDSAProgressEvent {
  fn on_progress(&self, sender : MLDSA, e : &mut MLDSAProgressEventArgs);
}

impl <'a> MLDSA<'a> {
  pub fn on_progress(&self) -> &'a dyn MLDSAProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn MLDSAProgressEvent);
  ...
}

Remarks

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

The PercentProcessed parameter indicates the current status of the operation.

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

Config Settings (MLDSA Struct)

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

MLDSA Config Settings

Base Config Settings

Trappable Errors (MLDSA Struct)

MLDSA Errors