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

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetContext(char* &lpContext, int &lenContext);
int SetContext(const char* lpContext, int lenContext);

Unicode (Windows)
INT GetContext(LPSTR &lpContext, INT &lenContext);
INT SetContext(LPCSTR lpContext, INT lenContext);

int ipworksencrypt_mldsa_getcontext(void* lpObj, char** lpContext, int* lenContext);
int ipworksencrypt_mldsa_setcontext(void* lpObj, const char* lpContext, int lenContext);

QByteArray getContext();
int setContext(QByteArray qbaContext);

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

The hash algorithm used when PreHash is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHashAlgorithm();
int SetHashAlgorithm(int iHashAlgorithm);

Unicode (Windows)
INT GetHashAlgorithm();
INT SetHashAlgorithm(INT iHashAlgorithm);

MHA_SHA256(0), 
MHA_SHA384(1), 
MHA_SHA512(2)

int ipworksencrypt_mldsa_gethashalgorithm(void* lpObj);
int ipworksencrypt_mldsa_sethashalgorithm(void* lpObj, int iHashAlgorithm);

int getHashAlgorithm();
int setHashAlgorithm(int iHashAlgorithm);

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

The file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* ipworksencrypt_mldsa_getinputfile(void* lpObj);
int ipworksencrypt_mldsa_setinputfile(void* lpObj, const char* lpszInputFile);

QString getInputFile();
int setInputFile(QString qsInputFile);

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.

Data Type

String

InputMessage Property (MLDSA Class)

The message to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputMessage(char* &lpInputMessage, int &lenInputMessage);
int SetInputMessage(const char* lpInputMessage, int lenInputMessage);

Unicode (Windows)
INT GetInputMessage(LPSTR &lpInputMessage, INT &lenInputMessage);
INT SetInputMessage(LPCSTR lpInputMessage, INT lenInputMessage);

int ipworksencrypt_mldsa_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_mldsa_setinputmessage(void* lpObj, const char* lpInputMessage, int lenInputMessage);

QByteArray getInputMessage();
int setInputMessage(QByteArray qbaInputMessage);

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.

Data Type

Binary String

Key Property (MLDSA Class)

The ML-DSA key.

Syntax

• C++
• C
• Qt

IPWorksEncryptMLDSAKey* GetKey();
int SetKey(IPWorksEncryptMLDSAKey* val);

int ipworksencrypt_mldsa_getkeyprivatekey(void* lpObj, char** lpKeyPrivateKey, int* lenKeyPrivateKey);
int ipworksencrypt_mldsa_setkeyprivatekey(void* lpObj, const char* lpKeyPrivateKey, int lenKeyPrivateKey);

int ipworksencrypt_mldsa_getkeypublickey(void* lpObj, char** lpKeyPublicKey, int* lenKeyPublicKey);
int ipworksencrypt_mldsa_setkeypublickey(void* lpObj, const char* lpKeyPublicKey, int lenKeyPublicKey);

QByteArray getKeyPrivateKey();
int setKeyPrivateKey(QByteArray qbaKeyPrivateKey);

QByteArray getKeyPublicKey();
int setKeyPublicKey(QByteArray qbaKeyPublicKey);

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.

Data Type

IPWorksEncryptMLDSAKey

PreHash Property (MLDSA Class)

Whether to use HashML-DSA when signing and verifying.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPreHash();
int SetPreHash(int bPreHash);

Unicode (Windows)
BOOL GetPreHash();
INT SetPreHash(BOOL bPreHash);

int ipworksencrypt_mldsa_getprehash(void* lpObj);
int ipworksencrypt_mldsa_setprehash(void* lpObj, int bPreHash);

bool getPreHash();
int setPreHash(bool bPreHash);

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

The signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignature(char* &lpSignature, int &lenSignature);
int SetSignature(const char* lpSignature, int lenSignature);

Unicode (Windows)
INT GetSignature(LPSTR &lpSignature, INT &lenSignature);
INT SetSignature(LPCSTR lpSignature, INT lenSignature);

int ipworksencrypt_mldsa_getsignature(void* lpObj, char** lpSignature, int* lenSignature);
int ipworksencrypt_mldsa_setsignature(void* lpObj, const char* lpSignature, int lenSignature);

QByteArray getSignature();
int setSignature(QByteArray qbaSignature);

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

Whether the signature is hex encoded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseHex();
int SetUseHex(int bUseHex);

Unicode (Windows)
BOOL GetUseHex();
INT SetUseHex(BOOL bUseHex);

int ipworksencrypt_mldsa_getusehex(void* lpObj);
int ipworksencrypt_mldsa_setusehex(void* lpObj, int bUseHex);

bool getUseHex();
int setUseHex(bool bUseHex);

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksencrypt_mldsa_config(void* lpObj, const char* lpszConfigurationString);

QString config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateKey Method (MLDSA Class)

Creates a new key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateKey();

Unicode (Windows)
INT CreateKey();

int ipworksencrypt_mldsa_createkey(void* lpObj);

int createKey();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (MLDSA Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksencrypt_mldsa_reset(void* lpObj);

int reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetInputStream Method (MLDSA Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(IPWorksEncryptStream* sInputStream);

Unicode (Windows)
INT SetInputStream(IPWorksEncryptStream* sInputStream);

int ipworksencrypt_mldsa_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);

int setInputStream(IPWorksEncryptStream* sInputStream);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Sign Method (MLDSA Class)

Creates a signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int ipworksencrypt_mldsa_sign(void* lpObj);

int sign();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Verify Method (MLDSA Class)

Verifies a signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool Verify();

Unicode (Windows)
bool Verify();

bool ipworksencrypt_mldsa_verify(void* lpObj);

bool verify();

Remarks

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

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Error Event (MLDSA Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(MLDSAErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} MLDSAErrorEventParams;


Unicode (Windows)
virtual INT FireError(MLDSAErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} MLDSAErrorEventParams;

#define EID_MLDSA_ERROR 1

virtual INT IPWORKSENCRYPT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class MLDSAErrorEventParams {
public:
  int errorCode();

  const QString &description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass MLDSA and override this emitter function.
virtual int fireError(MLDSAErrorEventParams *e) {...}
// Or, connect one or more slots to this signal.
void error(MLDSAErrorEventParams *e);

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

Fired as progress is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(MLDSAProgressEventParams *e);

typedef struct {
  int64 BytesProcessed;
  int PercentProcessed;
  int reserved;
} MLDSAProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(MLDSAProgressEventParams *e);

typedef struct {
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT reserved;
} MLDSAProgressEventParams;

#define EID_MLDSA_PROGRESS 2

virtual INT IPWORKSENCRYPT_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed);

class MLDSAProgressEventParams {
public:
  qint64 bytesProcessed();

  int percentProcessed();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass MLDSA and override this emitter function.
virtual int fireProgress(MLDSAProgressEventParams *e) {...}
// Or, connect one or more slots to this signal.
void progress(MLDSAProgressEventParams *e);

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.

Syntax

IPWorksEncryptMLDSAKey (declared in ipworksencrypt.h)

Remarks

This type contains the raw public and private key values used by the MLDSA component.

• PrivateKey
• PublicKey

Fields

Constructors

MLDSAKey()

MLDSAKey(const char* lpPublicKey, int lenPublicKey)

MLDSAKey(const char* lpPublicKey, int lenPublicKey, const char* lpPrivateKey, int lenPrivateKey)

IPWorksEncryptStream Type

Syntax

IPWorksEncryptStream (declared in ipworksencrypt.h)

Remarks

The MLDSA class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksEncryptStream interface and pass the MLDSA class an instance of that concrete class.

When implementing the IPWorksEncryptStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (MLDSA Class)

MLDSA Config Settings

Base Config Settings

Trappable Errors (MLDSA Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

MLDSA Errors