ML-DSA (Edwards-Curve Digital Signature Algorithm) More...

#include "core/crypto.h"
#include "ecc/ec.h"

Data Structures
struct	MldsaPublicKey
	ML-DSA public key. More...

struct	MldsaPrivateKey
	ML-DSA private key. More...

Macros
#define	MLDSA44_SECURITY_LEVEL 2

#define	MLDSA44_SEED_LEN 32

#define	MLDSA44_PRIVATE_KEY_LEN 2560

#define	MLDSA44_PUBLIC_KEY_LEN 1312

#define	MLDSA44_SIGNATURE_LEN 2420

#define	MLDSA65_SECURITY_LEVEL 3

#define	MLDSA65_SEED_LEN 32

#define	MLDSA65_PRIVATE_KEY_LEN 4032

#define	MLDSA65_PUBLIC_KEY_LEN 1952

#define	MLDSA65_SIGNATURE_LEN 3309

#define	MLDSA87_SECURITY_LEVEL 5

#define	MLDSA87_SEED_LEN 32

#define	MLDSA87_PRIVATE_KEY_LEN 4896

#define	MLDSA87_PUBLIC_KEY_LEN 2592

#define	MLDSA87_SIGNATURE_LEN 4627

Functions
void	mldsaInitPublicKey (MldsaPublicKey *key)
	Initialize an ML-DSA public key. More...

void	mldsaFreePublicKey (MldsaPublicKey *key)
	Release an ML-DSA public key. More...

void	mldsaInitPrivateKey (MldsaPrivateKey *key)
	Initialize an ML-DSA private key. More...

void	mldsaFreePrivateKey (MldsaPrivateKey *key)
	Release an ML-DSA private key. More...

error_t	mldsaImportPublicKey (MldsaPublicKey key, uint_t level, const uint8_t input, size_t length)
	Import an ML-DSA public key. More...

error_t	mldsaExportPublicKey (const MldsaPublicKey key, uint8_t output, size_t *written)
	Export an ML-DSA public key. More...

error_t	mldsaImportPrivateKey (MldsaPrivateKey key, uint_t level, const uint8_t input, size_t length)
	Import an ML-DSA private key. More...

error_t	mldsaExportPrivateKey (const MldsaPrivateKey key, uint8_t output, size_t *written)
	Export an ML-DSA private key. More...

error_t	mldsaImportSeed (MldsaPrivateKey key, uint_t level, const uint8_t input, size_t length)
	Import an ML-DSA seed. More...

error_t	mldsaExportSeed (const MldsaPrivateKey key, uint8_t output, size_t *written)
	Export an ML-DSA seed. More...

error_t	mldsa44GenerateSignature (const uint8_t secretKey, const void message, size_t messageLen, const void context, uint8_t contextLen, uint8_t signature)
	ML-DSA-44 signature generation. More...

error_t	mldsa65GenerateSignature (const uint8_t secretKey, const void message, size_t messageLen, const void context, uint8_t contextLen, uint8_t signature)
	ML-DSA-65 signature generation. More...

error_t	mldsa87GenerateSignature (const uint8_t secretKey, const void message, size_t messageLen, const void context, uint8_t contextLen, uint8_t signature)
	ML-DSA-87 signature generation. More...

error_t	mldsa44VerifySignature (const uint8_t publicKey, const void message, size_t messageLen, const void context, uint8_t contextLen, const uint8_t signature)
	ML-DSA-44 signature verification. More...

error_t	mldsa65VerifySignature (const uint8_t publicKey, const void message, size_t messageLen, const void context, uint8_t contextLen, const uint8_t signature)
	ML-DSA-65 signature verification. More...

error_t	mldsa87VerifySignature (const uint8_t publicKey, const void message, size_t messageLen, const void context, uint8_t contextLen, const uint8_t signature)
	ML-DSA-87 signature verification. More...

Variables
const uint8_t	MLDSA44_OID [9]

const uint8_t	MLDSA65_OID [9]

const uint8_t	MLDSA87_OID [9]

Detailed Description

ML-DSA (Edwards-Curve Digital Signature Algorithm)

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneCRYPTO Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.6.4

Definition in file mldsa.h.

Macro Definition Documentation

◆ MLDSA44_PRIVATE_KEY_LEN

#define MLDSA44_PRIVATE_KEY_LEN 2560

Definition at line 43 of file mldsa.h.

◆ MLDSA44_PUBLIC_KEY_LEN

#define MLDSA44_PUBLIC_KEY_LEN 1312

Definition at line 45 of file mldsa.h.

◆ MLDSA44_SECURITY_LEVEL

#define MLDSA44_SECURITY_LEVEL 2

Definition at line 39 of file mldsa.h.

◆ MLDSA44_SEED_LEN

#define MLDSA44_SEED_LEN 32

Definition at line 41 of file mldsa.h.

◆ MLDSA44_SIGNATURE_LEN

#define MLDSA44_SIGNATURE_LEN 2420

Definition at line 47 of file mldsa.h.

◆ MLDSA65_PRIVATE_KEY_LEN

#define MLDSA65_PRIVATE_KEY_LEN 4032

Definition at line 54 of file mldsa.h.

◆ MLDSA65_PUBLIC_KEY_LEN

#define MLDSA65_PUBLIC_KEY_LEN 1952

Definition at line 56 of file mldsa.h.

◆ MLDSA65_SECURITY_LEVEL

#define MLDSA65_SECURITY_LEVEL 3

Definition at line 50 of file mldsa.h.

◆ MLDSA65_SEED_LEN

#define MLDSA65_SEED_LEN 32

Definition at line 52 of file mldsa.h.

◆ MLDSA65_SIGNATURE_LEN

#define MLDSA65_SIGNATURE_LEN 3309

Definition at line 58 of file mldsa.h.

◆ MLDSA87_PRIVATE_KEY_LEN

#define MLDSA87_PRIVATE_KEY_LEN 4896

Definition at line 65 of file mldsa.h.

◆ MLDSA87_PUBLIC_KEY_LEN

#define MLDSA87_PUBLIC_KEY_LEN 2592

Definition at line 67 of file mldsa.h.

◆ MLDSA87_SECURITY_LEVEL

#define MLDSA87_SECURITY_LEVEL 5

Definition at line 61 of file mldsa.h.

◆ MLDSA87_SEED_LEN

#define MLDSA87_SEED_LEN 32

Definition at line 63 of file mldsa.h.

◆ MLDSA87_SIGNATURE_LEN

#define MLDSA87_SIGNATURE_LEN 4627

Definition at line 69 of file mldsa.h.

Function Documentation

◆ mldsa44GenerateSignature()

error_t mldsa44GenerateSignature	(	const uint8_t *	secretKey,
		const void *	message,
		size_t	messageLen,
		const void *	context,
		uint8_t	contextLen,
		uint8_t *	signature
	)

ML-DSA-44 signature generation.

Parameters

[in]	secretKey	Pointer to the secret key (2560 bytes)
[in]	message	Pointer to the message to be signed
[in]	messageLen	Length of the message, in bytes
[in]	context	Context string (a byte string of 255 or fewer bytes)
[in]	contextLen	Length of the context, in bytes
[out]	signature	ML-DSA-44 signature (2420 bytes)

Returns: Error code

Definition at line 542 of file mldsa.c.

◆ mldsa44VerifySignature()

error_t mldsa44VerifySignature	(	const uint8_t *	publicKey,
		const void *	message,
		size_t	messageLen,
		const void *	context,
		uint8_t	contextLen,
		const uint8_t *	signature
	)

ML-DSA-44 signature verification.

Parameters

[in]	publicKey	Pointer to the public key (1312 bytes)
[in]	message	Message whose signature is to be verified
[in]	messageLen	Length of the message, in bytes
[in]	context	Context string (a byte string of 255 or fewer bytes)
[in]	contextLen	Length of the context, in bytes
[in]	signature	ML-DSA-44 signature (2420 bytes)

Returns: Error code

Definition at line 636 of file mldsa.c.

◆ mldsa65GenerateSignature()

error_t mldsa65GenerateSignature	(	const uint8_t *	secretKey,
		const void *	message,
		size_t	messageLen,
		const void *	context,
		uint8_t	contextLen,
		uint8_t *	signature
	)

ML-DSA-65 signature generation.

Parameters

[in]	secretKey	Pointer to the secret key (4032 bytes)
[in]	message	Pointer to the message to be signed
[in]	messageLen	Length of the message, in bytes
[in]	context	Context string (a byte string of 255 or fewer bytes)
[in]	contextLen	Length of the context, in bytes
[out]	signature	ML-DSA-65 signature (3309 bytes)

Returns: Error code

Definition at line 574 of file mldsa.c.

◆ mldsa65VerifySignature()

error_t mldsa65VerifySignature	(	const uint8_t *	publicKey,
		const void *	message,
		size_t	messageLen,
		const void *	context,
		uint8_t	contextLen,
		const uint8_t *	signature
	)

ML-DSA-65 signature verification.

Parameters

[in]	publicKey	Pointer to the public key (1952 bytes)
[in]	message	Message whose signature is to be verified
[in]	messageLen	Length of the message, in bytes
[in]	context	Context string (a byte string of 255 or fewer bytes)
[in]	contextLen	Length of the context, in bytes
[in]	signature	ML-DSA-65 signature (3309 bytes)

Returns: Error code

Definition at line 667 of file mldsa.c.

◆ mldsa87GenerateSignature()

error_t mldsa87GenerateSignature	(	const uint8_t *	secretKey,
		const void *	message,
		size_t	messageLen,
		const void *	context,
		uint8_t	contextLen,
		uint8_t *	signature
	)

ML-DSA-87 signature generation.

Parameters

[in]	secretKey	Pointer to the secret key (4896 bytes)
[in]	message	Pointer to the message to be signed
[in]	messageLen	Length of the message, in bytes
[out]	signature	ML-DSA-87 signature (4627 bytes)

Returns: Error code

Definition at line 604 of file mldsa.c.

◆ mldsa87VerifySignature()

error_t mldsa87VerifySignature	(	const uint8_t *	publicKey,
		const void *	message,
		size_t	messageLen,
		const void *	context,
		uint8_t	contextLen,
		const uint8_t *	signature
	)

ML-DSA-87 signature verification.

Parameters

[in]	publicKey	Pointer to the public key (2592 bytes)
[in]	message	Message whose signature is to be verified
[in]	messageLen	Length of the message, in bytes
[in]	context	Context string (a byte string of 255 or fewer bytes)
[in]	contextLen	Length of the context, in bytes
[in]	signature	ML-DSA-87 signature (4627 bytes)

Returns: Error code

Definition at line 698 of file mldsa.c.

◆ mldsaExportPrivateKey()

error_t mldsaExportPrivateKey	(	const MldsaPrivateKey *	key,
		uint8_t *	output,
		size_t *	written
	)

Export an ML-DSA private key.

Parameters

[in]	key	ML-DSA private key
[out]	output	Pointer to the octet string (optional parameter)
[out]	written	Length of the octet string, in bytes

Returns: Error code

Definition at line 357 of file mldsa.c.

◆ mldsaExportPublicKey()

error_t mldsaExportPublicKey	(	const MldsaPublicKey *	key,
		uint8_t *	output,
		size_t *	written
	)

Export an ML-DSA public key.

Parameters

[in]	key	ML-DSA public key
[out]	output	Pointer to the octet string (optional parameter)
[out]	written	Length of the resulting octet string, in bytes

Returns: Error code

Definition at line 225 of file mldsa.c.

◆ mldsaExportSeed()

error_t mldsaExportSeed	(	const MldsaPrivateKey *	key,
		uint8_t *	output,
		size_t *	written
	)

Export an ML-DSA seed.

Parameters

[in]	key	ML-DSA private key
[out]	output	Pointer to the octet string (optional parameter)
[out]	written	Length of the octet string, in bytes

Returns: Error code

Definition at line 489 of file mldsa.c.

◆ mldsaFreePrivateKey()

void mldsaFreePrivateKey ( MldsaPrivateKey * key )

Release an ML-DSA private key.

Parameters

[in] key Pointer to the ML-DSA public key to free

Definition at line 114 of file mldsa.c.

◆ mldsaFreePublicKey()

void mldsaFreePublicKey ( MldsaPublicKey * key )

Release an ML-DSA public key.

Parameters

[in] key Pointer to the ML-DSA public key to free

Definition at line 75 of file mldsa.c.

◆ mldsaImportPrivateKey()

error_t mldsaImportPrivateKey	(	MldsaPrivateKey *	key,
		uint_t	level,
		const uint8_t *	input,
		size_t	length
	)

Import an ML-DSA private key.

Parameters

[out]	key	ML-DSA private key
[in]	level	Security level
[in]	input	Pointer to the octet string
[in]	length	Length of the octet string, in bytes

Returns: Error code

Definition at line 276 of file mldsa.c.

◆ mldsaImportPublicKey()

error_t mldsaImportPublicKey	(	MldsaPublicKey *	key,
		uint_t	level,
		const uint8_t *	input,
		size_t	length
	)

Import an ML-DSA public key.

Parameters

[out]	key	ML-DSA public key
[in]	level	Security level
[in]	input	Pointer to the octet string
[in]	length	Length of the octet string, in bytes

Returns: Error code

Definition at line 144 of file mldsa.c.

◆ mldsaImportSeed()

error_t mldsaImportSeed	(	MldsaPrivateKey *	key,
		uint_t	level,
		const uint8_t *	input,
		size_t	length
	)

Import an ML-DSA seed.

Parameters

[out]	key	ML-DSA private key
[in]	level	Security level
[in]	input	Pointer to the octet string
[in]	length	Length of the octet string, in bytes

Returns: Error code

Definition at line 408 of file mldsa.c.

◆ mldsaInitPrivateKey()

void mldsaInitPrivateKey ( MldsaPrivateKey * key )

Initialize an ML-DSA private key.

Parameters

[in] key Pointer to the ML-DSA private key to initialize

Definition at line 94 of file mldsa.c.

◆ mldsaInitPublicKey()

void mldsaInitPublicKey ( MldsaPublicKey * key )

Initialize an ML-DSA public key.

Parameters

[in] key Pointer to the ML-DSA public key to initialize

Definition at line 59 of file mldsa.c.

Variable Documentation

◆ MLDSA44_OID

const uint8_t MLDSA44_OID[9]

extern

Definition at line 47 of file mldsa.c.

◆ MLDSA65_OID

const uint8_t MLDSA65_OID[9]

extern

Definition at line 49 of file mldsa.c.

◆ MLDSA87_OID

const uint8_t MLDSA87_OID[9]

extern

Definition at line 51 of file mldsa.c.

Data Structures

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ MLDSA44_PRIVATE_KEY_LEN

◆ MLDSA44_PUBLIC_KEY_LEN

◆ MLDSA44_SECURITY_LEVEL

◆ MLDSA44_SEED_LEN

◆ MLDSA44_SIGNATURE_LEN

◆ MLDSA65_PRIVATE_KEY_LEN

◆ MLDSA65_PUBLIC_KEY_LEN

◆ MLDSA65_SECURITY_LEVEL

◆ MLDSA65_SEED_LEN

◆ MLDSA65_SIGNATURE_LEN

◆ MLDSA87_PRIVATE_KEY_LEN

◆ MLDSA87_PUBLIC_KEY_LEN

◆ MLDSA87_SECURITY_LEVEL

◆ MLDSA87_SEED_LEN

◆ MLDSA87_SIGNATURE_LEN

Function Documentation

◆ mldsa44GenerateSignature()

◆ mldsa44VerifySignature()

◆ mldsa65GenerateSignature()

◆ mldsa65VerifySignature()

◆ mldsa87GenerateSignature()

◆ mldsa87VerifySignature()

◆ mldsaExportPrivateKey()

◆ mldsaExportPublicKey()

◆ mldsaExportSeed()

◆ mldsaFreePrivateKey()

◆ mldsaFreePublicKey()

◆ mldsaImportPrivateKey()

◆ mldsaImportPublicKey()

◆ mldsaImportSeed()

◆ mldsaInitPrivateKey()

◆ mldsaInitPublicKey()

Variable Documentation

◆ MLDSA44_OID

◆ MLDSA65_OID

◆ MLDSA87_OID