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.

Class Name

IPWorksEncrypt_MLDSA

Procedural Interface

 ipworksencrypt_mldsa_open();
 ipworksencrypt_mldsa_close($res);
 ipworksencrypt_mldsa_register_callback($res, $id, $function);
 ipworksencrypt_mldsa_get_last_error($res);
 ipworksencrypt_mldsa_get_last_error_code($res);
 ipworksencrypt_mldsa_set($res, $id, $index, $value);
 ipworksencrypt_mldsa_get($res, $id, $index);
 ipworksencrypt_mldsa_do_config($res, $configurationstring);
 ipworksencrypt_mldsa_do_createkey($res);
 ipworksencrypt_mldsa_do_reset($res);
 ipworksencrypt_mldsa_do_sign($res);
 ipworksencrypt_mldsa_do_verify($res);

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

The ML-DSA context string.

Object Oriented Interface

public function getContext();
public function setContext($value);

Procedural Interface

ipworksencrypt_mldsa_get($res, 1 );
ipworksencrypt_mldsa_set($res, 1, $value );

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

Binary String

HashAlgorithm Property (IPWorksEncrypt_MLDSA Class)

The hash algorithm used when PreHash is enabled.

Object Oriented Interface

public function getHashAlgorithm();
public function setHashAlgorithm($value);

Procedural Interface

ipworksencrypt_mldsa_get($res, 2 );
ipworksencrypt_mldsa_set($res, 2, $value );

Possible Values

MLDSA_HASHALGORITHM_SHA256(0), 
MLDSA_HASHALGORITHM_SHA384(1), 
MLDSA_HASHALGORITHM_SHA512(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

Data Type

Integer

InputFile Property (IPWorksEncrypt_MLDSA Class)

The file to process.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

ipworksencrypt_mldsa_get($res, 3 );
ipworksencrypt_mldsa_set($res, 3, $value );

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.

Data Type

String

InputMessage Property (IPWorksEncrypt_MLDSA Class)

The message to process.

Object Oriented Interface

public function getInputMessage();
public function setInputMessage($value);

Procedural Interface

ipworksencrypt_mldsa_get($res, 4 );
ipworksencrypt_mldsa_set($res, 4, $value );

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.

Data Type

Binary String

KeyPrivateKey Property (IPWorksEncrypt_MLDSA Class)

The raw ML-DSA private key.

Object Oriented Interface

public function getKeyPrivateKey();
public function setKeyPrivateKey($value);

Procedural Interface

ipworksencrypt_mldsa_get($res, 5 );
ipworksencrypt_mldsa_set($res, 5, $value );

Default Value

''

Remarks

The raw ML-DSA private key.

Data Type

Binary String

KeyPublicKey Property (IPWorksEncrypt_MLDSA Class)

The raw ML-DSA public key.

Object Oriented Interface

public function getKeyPublicKey();
public function setKeyPublicKey($value);

Procedural Interface

ipworksencrypt_mldsa_get($res, 6 );
ipworksencrypt_mldsa_set($res, 6, $value );

Default Value

''

Remarks

The raw ML-DSA public key.

Data Type

Binary String

PreHash Property (IPWorksEncrypt_MLDSA Class)

Whether to use HashML-DSA when signing and verifying.

Object Oriented Interface

public function getPreHash();
public function setPreHash($value);

Procedural Interface

ipworksencrypt_mldsa_get($res, 7 );
ipworksencrypt_mldsa_set($res, 7, $value );

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

Boolean

Signature Property (IPWorksEncrypt_MLDSA Class)

The signature.

Object Oriented Interface

public function getSignature();
public function setSignature($value);

Procedural Interface

ipworksencrypt_mldsa_get($res, 8 );
ipworksencrypt_mldsa_set($res, 8, $value );

Default Value

''

Remarks

This property holds the ML-DSA signature.

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

Data Type

Binary String

UseHex Property (IPWorksEncrypt_MLDSA Class)

Whether the signature is hex encoded.

Object Oriented Interface

public function getUseHex();
public function setUseHex($value);

Procedural Interface

ipworksencrypt_mldsa_get($res, 9 );
ipworksencrypt_mldsa_set($res, 9, $value );

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

Boolean

Config Method (IPWorksEncrypt_MLDSA Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksencrypt_mldsa_do_config($res, $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 (IPWorksEncrypt_MLDSA Class)

Creates a new key.

Object Oriented Interface

public function doCreateKey();

Procedural Interface

ipworksencrypt_mldsa_do_createkey($res);

Remarks

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

Reset Method (IPWorksEncrypt_MLDSA Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksencrypt_mldsa_do_reset($res);

Remarks

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

Sign Method (IPWorksEncrypt_MLDSA Class)

Creates a signature.

Object Oriented Interface

public function doSign();

Procedural Interface

ipworksencrypt_mldsa_do_sign($res);

Remarks

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

Verify Method (IPWorksEncrypt_MLDSA Class)

Verifies a signature.

Object Oriented Interface

public function doVerify();

Procedural Interface

ipworksencrypt_mldsa_do_verify($res);

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

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksencrypt_mldsa_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

Fired as progress is made.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworksencrypt_mldsa_register_callback($res, 2, array($this, 'fireProgress'));

Parameter List

 'bytesprocessed'
 '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.

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