Skip to content

Namespacing: Add MLD_CONFIG_PARAMETER_SET + MLD_CONFIG_NAMESPACE_PREFIX, modify api, common, config accordingly #452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft

Namespacing: Add MLD_CONFIG_PARAMETER_SET + MLD_CONFIG_NAMESPACE_PREFIX, modify api, common, config accordingly #452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
7f590c0
Namespacing: Switch to mlkem-native style namespace, api, common, and…
jakemas Sep 11, 2025
e599528
Update CMBC proof files
jakemas Sep 11, 2025
8d03d62
update api definitions
jakemas Sep 11, 2025
7b68d43
add api.h to bench_mldsa.c
jakemas Sep 11, 2025
feb4c4f
fix PCT config
jakemas Sep 11, 2025
0d3a40a
remove setting 44 param set
jakemas Sep 11, 2025
eca69a8
break pct config change
jakemas Sep 11, 2025
2f6e248
fix custom zeroize congif
jakemas Sep 11, 2025
8077609
fix cmbc proof for attempt_signature
jakemas Sep 11, 2025
7219178
remove namespacing
jakemas Sep 11, 2025
95f0582
include new apis in stack test
jakemas Sep 11, 2025
7c7f787
linting
jakemas Sep 11, 2025
ba1fff8
fix no asm config
jakemas Sep 11, 2025
c15909e
include common.h to provide namespace macro
jakemas Sep 12, 2025
e776152
alphabetical ordering
jakemas Sep 12, 2025
72087ff
change all mldsa_mode to config_param_set
jakemas Sep 12, 2025
d67d215
provide config param set provided as in mlkem-native
jakemas Sep 12, 2025
f0f86ee
testing failing proof
jakemas Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ $(error Neither 'shasum' nor 'sha256sum' found. Please install one of these tool
endif

include test/mk/config.mk
include test/mk/compiler.mk
include test/mk/components.mk
include test/mk/rules.mk

Expand Down
24 changes: 12 additions & 12 deletions Makefile.Microsoft_nmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,57 +31,57 @@ OPT = 0
# compilation for mldsa44
{mldsa}.c{$(MLDSA44_BUILD_DIR)\mldsa}.obj::
@if NOT EXIST $(MLDSA44_BUILD_DIR)\mldsa mkdir $(MLDSA44_BUILD_DIR)\mldsa
$(CC) $(CFLAGS) /D MLDSA_MODE=2 /c /Fo$(MLDSA44_BUILD_DIR)\mldsa\ $<
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=44 /c /Fo$(MLDSA44_BUILD_DIR)\mldsa\ $<

{mldsa\fips202}.c{$(MLDSA44_BUILD_DIR)\mldsa\fips202}.obj::
@if NOT EXIST $(MLDSA44_BUILD_DIR)\mldsa\fips202 mkdir $(MLDSA44_BUILD_DIR)\mldsa\fips202
$(CC) $(CFLAGS) /D MLDSA_MODE=2 /c /Fo$(MLDSA44_BUILD_DIR)\mldsa\fips202\ $<
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=44 /c /Fo$(MLDSA44_BUILD_DIR)\mldsa\fips202\ $<

{test}.c{$(MLDSA44_BUILD_DIR)\test}.obj::
@if NOT EXIST $(MLDSA44_BUILD_DIR)\test mkdir $(MLDSA44_BUILD_DIR)\test
$(CC) $(CFLAGS) /D MLDSA_MODE=2 /c /Fo$(MLDSA44_BUILD_DIR)\test\ $<
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=44 /c /Fo$(MLDSA44_BUILD_DIR)\test\ $<

# compilation for mldsa65
{mldsa}.c{$(MLDSA65_BUILD_DIR)\mldsa}.obj::
@if NOT EXIST $(MLDSA65_BUILD_DIR)\mldsa mkdir $(MLDSA65_BUILD_DIR)\mldsa
$(CC) $(CFLAGS) /D MLDSA_MODE=3 /c /Fo$(MLDSA65_BUILD_DIR)\mldsa\ $<
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=65 /c /Fo$(MLDSA65_BUILD_DIR)\mldsa\ $<

{mldsa\fips202}.c{$(MLDSA65_BUILD_DIR)\mldsa\fips202}.obj::
@if NOT EXIST $(MLDSA65_BUILD_DIR)\mldsa\fips202 mkdir $(MLDSA65_BUILD_DIR)\mldsa\fips202
$(CC) $(CFLAGS) /D MLDSA_MODE=3 /c /Fo$(MLDSA65_BUILD_DIR)\mldsa\fips202\ $<
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=65 /c /Fo$(MLDSA65_BUILD_DIR)\mldsa\fips202\ $<

{test}.c{$(MLDSA65_BUILD_DIR)\test}.obj::
@if NOT EXIST $(MLDSA65_BUILD_DIR)\test mkdir $(MLDSA65_BUILD_DIR)\test
$(CC) $(CFLAGS) /D MLDSA_MODE=3 /c /Fo$(MLDSA65_BUILD_DIR)\test\ $<
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=65 /c /Fo$(MLDSA65_BUILD_DIR)\test\ $<

# compilation for mldsa87
{mldsa}.c{$(MLDSA87_BUILD_DIR)\mldsa}.obj::
@if NOT EXIST $(MLDSA87_BUILD_DIR)\mldsa mkdir $(MLDSA87_BUILD_DIR)\mldsa
$(CC) $(CFLAGS) /D MLDSA_MODE=5 /c /Fo$(MLDSA87_BUILD_DIR)\mldsa\ $<
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=87 /c /Fo$(MLDSA87_BUILD_DIR)\mldsa\ $<

{mldsa\fips202}.c{$(MLDSA87_BUILD_DIR)\mldsa\fips202}.obj::
@if NOT EXIST $(MLDSA87_BUILD_DIR)\mldsa\fips202 mkdir $(MLDSA87_BUILD_DIR)\mldsa\fips202
$(CC) $(CFLAGS) /D MLDSA_MODE=5 /c /Fo$(MLDSA87_BUILD_DIR)\mldsa\fips202\ $<
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=87 /c /Fo$(MLDSA87_BUILD_DIR)\mldsa\fips202\ $<

{test}.c{$(MLDSA87_BUILD_DIR)\test}.obj::
@if NOT EXIST $(MLDSA87_BUILD_DIR)\test mkdir $(MLDSA87_BUILD_DIR)\test
$(CC) $(CFLAGS) /D MLDSA_MODE=5 /c /Fo$(MLDSA87_BUILD_DIR)\test\ $<
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=87 /c /Fo$(MLDSA87_BUILD_DIR)\test\ $<


# compile functional test for mldsa44
test_mldsa44: $(OBJ_FILES_44) $(MLDSA44_BUILD_DIR)\test\test_mldsa.obj $(BUILD_DIR)\randombytes\notrandombytes.obj
@if NOT EXIST $(MLDSA44_BUILD_DIR)\bin mkdir $(MLDSA44_BUILD_DIR)\bin
$(CC) $(CFLAGS) /D MLDSA_MODE=2 /Fe$(MLDSA44_BUILD_DIR)\bin\test_mldsa44 $** /link
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=44 /Fe$(MLDSA44_BUILD_DIR)\bin\test_mldsa44 $** /link

# compile functional test for mldsa65
test_mldsa65: $(OBJ_FILES_65) $(MLDSA65_BUILD_DIR)\test\test_mldsa.obj $(BUILD_DIR)\randombytes\notrandombytes.obj
@if NOT EXIST $(MLDSA65_BUILD_DIR)\bin mkdir $(MLDSA65_BUILD_DIR)\bin
$(CC) $(CFLAGS) /D MLDSA_MODE=3 /Fe$(MLDSA65_BUILD_DIR)\bin\test_mldsa65 $** /link
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=65 /Fe$(MLDSA65_BUILD_DIR)\bin\test_mldsa65 $** /link

# compile functional test for mldsa87
test_mldsa87: $(OBJ_FILES_87) $(MLDSA87_BUILD_DIR)\test\test_mldsa.obj $(BUILD_DIR)\randombytes\notrandombytes.obj
@if NOT EXIST $(MLDSA87_BUILD_DIR)\bin mkdir $(MLDSA87_BUILD_DIR)\bin
$(CC) $(CFLAGS) /D MLDSA_MODE=5 /Fe$(MLDSA87_BUILD_DIR)\bin\test_mldsa87 $** /link
$(CC) $(CFLAGS) /D MLD_CONFIG_PARAMETER_SET=87 /Fe$(MLDSA87_BUILD_DIR)\bin\test_mldsa87 $** /link

quickcheck: test_mldsa44 test_mldsa65 test_mldsa87
$(MLDSA44_BUILD_DIR)\bin\test_mldsa44.exe
Expand Down
89 changes: 11 additions & 78 deletions mldsa/api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,107 +7,40 @@

#include <stddef.h>
#include <stdint.h>
#include "common.h"

#define MLD_44_PUBLICKEYBYTES 1312
#define MLD_44_SECRETKEYBYTES 2560
#define MLD_44_BYTES 2420

#define MLD_44_ref_PUBLICKEYBYTES MLD_44_PUBLICKEYBYTES
#define MLD_44_ref_SECRETKEYBYTES MLD_44_SECRETKEYBYTES
#define MLD_44_ref_BYTES MLD_44_BYTES

int MLD_44_ref_keypair(uint8_t *pk, uint8_t *sk);

int MLD_44_ref_signature(uint8_t *sig, size_t *siglen, const uint8_t *m,
size_t mlen, const uint8_t *ctx, size_t ctxlen,
const uint8_t *sk);

int MLD_44_ref(uint8_t *sm, size_t *smlen, const uint8_t *m, size_t mlen,
const uint8_t *ctx, size_t ctxlen, const uint8_t *sk);

int MLD_44_ref_verify(const uint8_t *sig, size_t siglen, const uint8_t *m,
size_t mlen, const uint8_t *ctx, size_t ctxlen,
const uint8_t *pk);

int MLD_44_ref_open(uint8_t *m, size_t *mlen, const uint8_t *sm, size_t smlen,
const uint8_t *ctx, size_t ctxlen, const uint8_t *pk);

#define MLD_65_PUBLICKEYBYTES 1952
#define MLD_65_SECRETKEYBYTES 4032
#define MLD_65_BYTES 3309

#define MLD_65_ref_PUBLICKEYBYTES MLD_65_PUBLICKEYBYTES
#define MLD_65_ref_SECRETKEYBYTES MLD_65_SECRETKEYBYTES
#define MLD_65_ref_BYTES MLD_65_BYTES

int MLD_65_ref_keypair(uint8_t *pk, uint8_t *sk);

int MLD_65_ref_signature(uint8_t *sig, size_t *siglen, const uint8_t *m,
size_t mlen, const uint8_t *ctx, size_t ctxlen,
const uint8_t *sk);

int MLD_65_ref(uint8_t *sm, size_t *smlen, const uint8_t *m, size_t mlen,
const uint8_t *ctx, size_t ctxlen, const uint8_t *sk);

int MLD_65_ref_verify(const uint8_t *sig, size_t siglen, const uint8_t *m,
size_t mlen, const uint8_t *ctx, size_t ctxlen,
const uint8_t *pk);

int MLD_65_ref_open(uint8_t *m, size_t *mlen, const uint8_t *sm, size_t smlen,
const uint8_t *ctx, size_t ctxlen, const uint8_t *pk);

#define MLD_87_PUBLICKEYBYTES 2592
#define MLD_87_SECRETKEYBYTES 4896
#define MLD_87_BYTES 4627

#define MLD_87_ref_PUBLICKEYBYTES MLD_87_PUBLICKEYBYTES
#define MLD_87_ref_SECRETKEYBYTES MLD_87_SECRETKEYBYTES
#define MLD_87_ref_BYTES MLD_87_BYTES

int MLD_87_ref_keypair(uint8_t *pk, uint8_t *sk);

int MLD_87_ref_signature(uint8_t *sig, size_t *siglen, const uint8_t *m,
size_t mlen, const uint8_t *ctx, size_t ctxlen,
const uint8_t *sk);

int MLD_87_ref(uint8_t *sm, size_t *smlen, const uint8_t *m, size_t mlen,
const uint8_t *ctx, size_t ctxlen, const uint8_t *sk);

int MLD_87_ref_verify(const uint8_t *sig, size_t siglen, const uint8_t *m,
size_t mlen, const uint8_t *ctx, size_t ctxlen,
const uint8_t *pk);

int MLD_87_ref_open(uint8_t *m, size_t *mlen, const uint8_t *sm, size_t smlen,
const uint8_t *ctx, size_t ctxlen, const uint8_t *pk);

#if MLDSA_MODE == 2
#if MLD_CONFIG_PARAMETER_SET == 44
#define CRYPTO_PUBLICKEYBYTES MLD_44_PUBLICKEYBYTES
#define CRYPTO_SECRETKEYBYTES MLD_44_SECRETKEYBYTES
#define CRYPTO_BYTES MLD_44_BYTES
#define crypto_sign_keypair MLD_44_ref_keypair
#define crypto_sign_signature MLD_44_ref_signature
#define crypto_sign MLD_44_ref
#define crypto_sign_verify MLD_44_ref_verify
#define crypto_sign_open MLD_44_ref_open
#elif MLDSA_MODE == 3
#elif MLD_CONFIG_PARAMETER_SET == 65
#define CRYPTO_PUBLICKEYBYTES MLD_65_PUBLICKEYBYTES
#define CRYPTO_SECRETKEYBYTES MLD_65_SECRETKEYBYTES
#define CRYPTO_BYTES MLD_65_BYTES
#define crypto_sign_keypair MLD_65_ref_keypair
#define crypto_sign_signature MLD_65_ref_signature
#define crypto_sign MLD_65_ref
#define crypto_sign_verify MLD_65_ref_verify
#define crypto_sign_open MLD_65_ref_open
#elif MLDSA_MODE == 5
#elif MLD_CONFIG_PARAMETER_SET == 87
#define CRYPTO_PUBLICKEYBYTES MLD_87_PUBLICKEYBYTES
#define CRYPTO_SECRETKEYBYTES MLD_87_SECRETKEYBYTES
#define CRYPTO_BYTES MLD_87_BYTES
#define crypto_sign_keypair MLD_87_ref_keypair
#define crypto_sign_signature MLD_87_ref_signature
#define crypto_sign MLD_87_ref
#define crypto_sign_verify MLD_87_ref_verify
#define crypto_sign_open MLD_87_ref_open
#endif /* MLDSA_MODE == 5 */
#endif

#define crypto_sign_keypair MLD_NAMESPACE_K(keypair)
#define crypto_sign_signature MLD_NAMESPACE_K(signature)
#define crypto_sign MLD_NAMESPACE_K(sign)
#define crypto_sign_verify MLD_NAMESPACE_K(verify)
#define crypto_sign_open MLD_NAMESPACE_K(open)


#endif /* !MLD_API_H */
79 changes: 73 additions & 6 deletions mldsa/common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,50 @@
#include "params.h"
#include "sys.h"

/* Internal and public API have external linkage by default, but
* this can be overwritten by the user, e.g. for single-CU builds. */
#if !defined(MLD_CONFIG_INTERNAL_API_QUALIFIER)
#define MLD_INTERNAL_API
#else
#define MLD_INTERNAL_API MLD_CONFIG_INTERNAL_API_QUALIFIER
#endif

#if defined(MLD_CONFIG_USE_NATIVE_BACKEND_ARITH) && \
!defined(MLD_CONFIG_ARITH_BACKEND_FILE)
#error Bad configuration: MLD_CONFIG_USE_NATIVE_BACKEND_ARITH is set, but MLD_CONFIG_ARITH_BACKEND_FILE is not.
#if !defined(MLD_CONFIG_EXTERNAL_API_QUALIFIER)
#define MLD_EXTERNAL_API
#else
#define MLD_EXTERNAL_API MLD_CONFIG_EXTERNAL_API_QUALIFIER
#endif

#if defined(MLD_CONFIG_USE_NATIVE_BACKEND_ARITH)
#include MLD_CONFIG_ARITH_BACKEND_FILE
#if defined(MLD_CONFIG_MULTILEVEL_NO_SHARED) || \
defined(MLD_CONFIG_MULTILEVEL_WITH_SHARED)
#define MLD_MULTILEVEL_BUILD
#endif

#define MLD_CONCAT_(x1, x2) x1##x2
#define MLD_CONCAT(x1, x2) MLD_CONCAT_(x1, x2)

#if defined(MLD_MULTILEVEL_BUILD)
#define MLD_ADD_PARAM_SET(s) MLD_CONCAT(s, MLD_CONFIG_PARAMETER_SET)
#else
#define MLD_ADD_PARAM_SET(s) s
#endif

#define MLD_NAMESPACE_PREFIX MLD_CONCAT(MLD_CONFIG_NAMESPACE_PREFIX, _)
#define MLD_NAMESPACE_PREFIX_K \
MLD_CONCAT(MLD_ADD_PARAM_SET(MLD_CONFIG_NAMESPACE_PREFIX), _)

/* Functions are prefixed by MLD_CONFIG_NAMESPACE_PREFIX.
*
* If multiple parameter sets are used, functions depending on the parameter
* set are additionally prefixed with 44/65/87. See config.h.
*
* Example: If MLD_CONFIG_NAMESPACE_PREFIX is PQCP_MLDSA_NATIVE_MLDSA, then
* MLD_NAMESPACE_K(keypair) becomes PQCP_MLDSA_NATIVE_MLDSA44_keypair/
* PQCP_MLDSA_NATIVE_MLDSA65_keypair/PQCP_MLDSA_NATIVE_MLDSA87_keypair.
*/
#define MLD_NAMESPACE(s) MLD_CONCAT(MLD_NAMESPACE_PREFIX, s)
#define MLD_NAMESPACE_K(s) MLD_CONCAT(MLD_NAMESPACE_PREFIX_K, s)

/* On Apple platforms, we need to emit leading underscore
* in front of assembly symbols. We thus introducee a separate
* namespace wrapper for ASM symbols. */
Expand All @@ -53,11 +84,47 @@
* all source files are included, even those that are not needed.
* Those files are appropriately guarded and will be empty when unneeded.
* The following is to avoid compilers complaining about this. */
#define MLD_EMPTY_CU(s) extern int MLD_NAMESPACE(empty_cu_##s);
#define MLD_EMPTY_CU(s) extern int MLD_NAMESPACE_K(empty_cu_##s);

/* MLD_CONFIG_NO_ASM takes precedence over MLD_USE_NATIVE_XXX */
#if defined(MLD_CONFIG_NO_ASM)
#undef MLD_CONFIG_USE_NATIVE_BACKEND_ARITH
#undef MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202
#endif

#if defined(MLD_CONFIG_USE_NATIVE_BACKEND_ARITH) && \
!defined(MLD_CONFIG_ARITH_BACKEND_FILE)
#error Bad configuration: MLD_CONFIG_USE_NATIVE_BACKEND_ARITH is set, but MLD_CONFIG_ARITH_BACKEND_FILE is not.
#endif

#if defined(MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202) && \
!defined(MLD_CONFIG_FIPS202_BACKEND_FILE)
#error Bad configuration: MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202 is set, but MLD_CONFIG_FIPS202_BACKEND_FILE is not.
#endif

#if defined(MLD_CONFIG_USE_NATIVE_BACKEND_ARITH)
#include MLD_CONFIG_ARITH_BACKEND_FILE
/* Include to enforce consistency of API and implementation,
* and conduct sanity checks on the backend.
*
* Keep this _after_ the inclusion of the backend; otherwise,
* the sanity checks won't have an effect. */
#if defined(MLD_CHECK_APIS) && !defined(__ASSEMBLER__)
#include "native/api.h"
#endif
#endif /* MLD_CONFIG_USE_NATIVE_BACKEND_ARITH */

#if defined(MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202)
#include MLD_CONFIG_FIPS202_BACKEND_FILE
/* Include to enforce consistency of API and implementation,
* and conduct sanity checks on the backend.
*
* Keep this _after_ the inclusion of the backend; otherwise,
* the sanity checks won't have an effect. */
#if defined(MLD_CHECK_APIS) && !defined(__ASSEMBLER__)
#include "fips202/native/api.h"
#endif
#endif /* MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202 */

#if !defined(__ASSEMBLER__)
#include <string.h>
Expand Down
Loading
Loading