MLDSA Component

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

func (obj *MLDSA) Context() ([]byte, error)
func (obj *MLDSA) SetContext(value []byte) error

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

[]byte

HashAlgorithm Property (MLDSA Component)

The hash algorithm used when PreHash is enabled.

Syntax

func (obj *MLDSA) HashAlgorithm() (int32, error)
func (obj *MLDSA) SetHashAlgorithm(value int32) error

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 PreHash is set to True.

Possible values are:

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

Data Type

int32

InputFile Property (MLDSA Component)

The file to process.

Syntax

func (obj *MLDSA) InputFile() (string, error)
func (obj *MLDSA) SetInputFile(value string) error

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:

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

Data Type

string

InputMessage Property (MLDSA Component)

The message to process.

Syntax

func (obj *MLDSA) InputMessage() ([]byte, error)
func (obj *MLDSA) SetInputMessage(value []byte) error

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:

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

Data Type

[]byte

KeyPrivateKey Property (MLDSA Component)

The raw ML-DSA private key.

Syntax

func (obj *MLDSA) KeyPrivateKey() ([]byte, error)
func (obj *MLDSA) SetKeyPrivateKey(value []byte) error

Default Value

""

Remarks

The raw ML-DSA private key.

Data Type

[]byte

KeyPublicKey Property (MLDSA Component)

The raw ML-DSA public key.

Syntax

func (obj *MLDSA) KeyPublicKey() ([]byte, error)
func (obj *MLDSA) SetKeyPublicKey(value []byte) error

Default Value

""

Remarks

The raw ML-DSA public key.

Data Type

[]byte

PreHash Property (MLDSA Component)

Whether to use HashML-DSA when signing and verifying.

Syntax

func (obj *MLDSA) PreHash() (bool, error)
func (obj *MLDSA) SetPreHash(value bool) error

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.

Data Type

bool

Signature Property (MLDSA Component)

The signature.

Syntax

func (obj *MLDSA) Signature() ([]byte, error)
func (obj *MLDSA) SetSignature(value []byte) error

Default Value

""

Remarks

This property holds the ML-DSA signature.

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

Data Type

[]byte

UseHex Property (MLDSA Component)

Whether the signature is hex encoded.

Syntax

func (obj *MLDSA) UseHex() (bool, error)
func (obj *MLDSA) SetUseHex(value bool) error

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.

Data Type

bool

Config Method (MLDSA Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *MLDSA) Config(ConfigurationString string) (string, error)

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.

CreateKey Method (MLDSA Component)

Creates a new key.

Syntax

func (obj *MLDSA) CreateKey() error

Remarks

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

Reset Method (MLDSA Component)

Resets the class.

Syntax

func (obj *MLDSA) Reset() error

Remarks

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

Sign Method (MLDSA Component)

Creates a signature.

Syntax

func (obj *MLDSA) Sign() error

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

func (obj *MLDSA) Verify() (bool, error)

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

// MLDSAErrorEventArgs carries the MLDSA Error event's parameters.
type MLDSAErrorEventArgs struct {...}

func (args *MLDSAErrorEventArgs) ErrorCode() int32
func (args *MLDSAErrorEventArgs) Description() string
// MLDSAErrorEvent defines the signature of the MLDSA Error event's handler function.
type MLDSAErrorEvent func(sender *MLDSA, args *MLDSAErrorEventArgs)

func (obj *MLDSA) GetOnErrorHandler() MLDSAErrorEvent
func (obj *MLDSA) SetOnErrorHandler(handlerFunc MLDSAErrorEvent)

Remarks

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

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

// MLDSAProgressEventArgs carries the MLDSA Progress event's parameters.
type MLDSAProgressEventArgs struct {...}

func (args *MLDSAProgressEventArgs) BytesProcessed() int64
func (args *MLDSAProgressEventArgs) PercentProcessed() int32
// MLDSAProgressEvent defines the signature of the MLDSA Progress event's handler function.
type MLDSAProgressEvent func(sender *MLDSA, args *MLDSAProgressEventArgs)

func (obj *MLDSA) GetOnProgressHandler() MLDSAProgressEvent
func (obj *MLDSA) SetOnProgressHandler(handlerFunc 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 Component)

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

MLDSA Errors