-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathcustom_native_capability_config_0.h
More file actions
722 lines (678 loc) · 30 KB
/
custom_native_capability_config_0.h
File metadata and controls
722 lines (678 loc) · 30 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
/*
* Copyright (c) The mldsa-native project authors
* SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
*/
/* References
* ==========
*
* - [FIPS140_3_IG]
* Implementation Guidance for FIPS 140-3 and the Cryptographic Module
* Validation Program
* National Institute of Standards and Technology
* https://csrc.nist.gov/projects/cryptographic-module-validation-program/fips-140-3-ig-announcements
*
* - [FIPS204]
* FIPS 204 Module-Lattice-Based Digital Signature Standard
* National Institute of Standards and Technology
* https://csrc.nist.gov/pubs/fips/204/final
*/
/*
* WARNING: This file is auto-generated from scripts/autogen
* in the mldsa-native repository.
* Do not modify it directly.
*/
/*
* Test configuration: Test configuration with custom capability function
* returning 0
*
* This configuration differs from the default mldsa/mldsa_native_config.h in
* the following places:
* - MLD_CONFIG_CUSTOM_CAPABILITY_FUNC
*/
#ifndef MLD_CONFIG_H
#define MLD_CONFIG_H
/******************************************************************************
* Name: MLD_CONFIG_PARAMETER_SET
*
* Description: Specifies the parameter set for ML-DSA
* - MLD_CONFIG_PARAMETER_SET=44 corresponds to ML-DSA-44
* - MLD_CONFIG_PARAMETER_SET=65 corresponds to ML-DSA-65
* - MLD_CONFIG_PARAMETER_SET=87 corresponds to ML-DSA-87
*
* If you want to support multiple parameter sets, build the
* library multiple times and set MLD_CONFIG_MULTILEVEL_BUILD.
* See MLD_CONFIG_MULTILEVEL_BUILD for how to do this while
* minimizing code duplication.
*
* This can also be set using CFLAGS.
*
*****************************************************************************/
#ifndef MLD_CONFIG_PARAMETER_SET
#define MLD_CONFIG_PARAMETER_SET \
44 /* Change this for different security strengths */
#endif
/******************************************************************************
* Name: MLD_CONFIG_FILE
*
* Description: If defined, this is a header that will be included instead
* of the default configuration file mldsa/mldsa_native_config.h.
*
* When you need to build mldsa-native in multiple configurations,
* using varying MLD_CONFIG_FILE can be more convenient
* then configuring everything through CFLAGS.
*
* To use, MLD_CONFIG_FILE _must_ be defined prior
* to the inclusion of any mldsa-native headers. For example,
* it can be set by passing `-DMLD_CONFIG_FILE="..."`
* on the command line.
*
*****************************************************************************/
/* #define MLD_CONFIG_FILE "mldsa_native_config.h" */
/******************************************************************************
* Name: MLD_CONFIG_NAMESPACE_PREFIX
*
* Description: The prefix to use to namespace global symbols from mldsa/.
*
* In a multi-level build, level-dependent symbols will
* additionally be prefixed with the parameter set (44/65/87).
*
* This can also be set using CFLAGS.
*
*****************************************************************************/
#if !defined(MLD_CONFIG_NAMESPACE_PREFIX)
#define MLD_CONFIG_NAMESPACE_PREFIX MLD_DEFAULT_NAMESPACE_PREFIX
#endif
/******************************************************************************
* Name: MLD_CONFIG_MULTILEVEL_BUILD
*
* Description: Set this if the build is part of a multi-level build supporting
* multiple parameter sets.
*
* If you need only a single parameter set, keep this unset.
*
* To build mldsa-native with support for all parameter sets,
* build it three times -- once per parameter set -- and set the
* option MLD_CONFIG_MULTILEVEL_WITH_SHARED for exactly one of
* them, and MLD_CONFIG_MULTILEVEL_NO_SHARED for the others.
* MLD_CONFIG_MULTILEVEL_BUILD should be set for all of them.
*
* See examples/multilevel_build for an example.
*
* This can also be set using CFLAGS.
*
*****************************************************************************/
/* #define MLD_CONFIG_MULTILEVEL_BUILD */
/******************************************************************************
* Name: MLD_CONFIG_EXTERNAL_API_QUALIFIER
*
* Description: If set, this option provides an additional function
* qualifier to be added to declarations of mldsa-native's
* public API.
*
* The primary use case for this option are single-CU builds
* where the public API exposed by mldsa-native is wrapped by
* another API in the consuming application. In this case,
* even mldsa-native's public API can be marked `static`.
*
*****************************************************************************/
/* #define MLD_CONFIG_EXTERNAL_API_QUALIFIER */
/******************************************************************************
* Name: MLD_CONFIG_NO_RANDOMIZED_API
*
* Description: If this option is set, mldsa-native will be built without the
* randomized API functions (crypto_sign_keypair,
* crypto_sign, crypto_sign_signature, and
* crypto_sign_signature_extmu).
* This allows users to build mldsa-native without providing a
* randombytes() implementation if they only need the
* internal deterministic API
* (crypto_sign_keypair_internal, crypto_sign_signature_internal).
*
* NOTE: This option is incompatible with MLD_CONFIG_KEYGEN_PCT
* as the current PCT implementation requires
* crypto_sign_signature().
*
*****************************************************************************/
/* #define MLD_CONFIG_NO_RANDOMIZED_API */
/******************************************************************************
* Name: MLD_CONFIG_NO_SUPERCOP
*
* Description: By default, mldsa_native.h exposes the mldsa-native API in the
* SUPERCOP naming convention (crypto_sign_xxx). If you don't need
* this, set MLD_CONFIG_NO_SUPERCOP.
*
* NOTE: You must set this for a multi-level build as the SUPERCOP
* naming does not disambiguate between the parameter sets.
*
*****************************************************************************/
/* #define MLD_CONFIG_NO_SUPERCOP */
/******************************************************************************
* Name: MLD_CONFIG_CONSTANTS_ONLY
*
* Description: If you only need the size constants (MLDSA_PUBLICKEYBYTES, etc.)
* but no function declarations, set MLD_CONFIG_CONSTANTS_ONLY.
*
* This only affects the public header mldsa_native.h, not
* the implementation.
*
*****************************************************************************/
/* #define MLD_CONFIG_CONSTANTS_ONLY */
/******************************************************************************
*
* Build-only configuration options
*
* The remaining configurations are build-options only.
* They do not affect the API described in mldsa_native.h.
*
*****************************************************************************/
#if defined(MLD_BUILD_INTERNAL)
/******************************************************************************
* Name: MLD_CONFIG_MULTILEVEL_WITH_SHARED
*
* Description: This is for multi-level builds of mldsa-native only. If you
* need only a single parameter set, keep this unset.
*
* If this is set, all MLD_CONFIG_PARAMETER_SET-independent
* code will be included in the build, including code needed only
* for other parameter sets.
*
* Example: TODO: add example
*
* To build mldsa-native with support for all parameter sets,
* build it three times -- once per parameter set -- and set the
* option MLD_CONFIG_MULTILEVEL_WITH_SHARED for exactly one of
* them, and MLD_CONFIG_MULTILEVEL_NO_SHARED for the others.
*
* See examples/multilevel_build_mldsa for an example.
*
* This can also be set using CFLAGS.
*
*****************************************************************************/
/* #define MLD_CONFIG_MULTILEVEL_WITH_SHARED */
/******************************************************************************
* Name: MLD_CONFIG_MULTILEVEL_NO_SHARED
*
* Description: This is for multi-level builds of mldsa-native only. If you
* need only a single parameter set, keep this unset.
*
* If this is set, no MLD_CONFIG_PARAMETER_SET-independent code
* will be included in the build.
*
* To build mldsa-native with support for all parameter sets,
* build it three times -- once per parameter set -- and set the
* option MLD_CONFIG_MULTILEVEL_WITH_SHARED for exactly one of
* them, and MLD_CONFIG_MULTILEVEL_NO_SHARED for the others.
*
* See examples/multilevel_build_mldsa for an example.
*
* This can also be set using CFLAGS.
*
*****************************************************************************/
/* #define MLD_CONFIG_MULTILEVEL_NO_SHARED */
/******************************************************************************
* Name: MLD_CONFIG_MONOBUILD_KEEP_SHARED_HEADERS
*
* Description: This is only relevant for single compilation unit (SCU)
* builds of mldsa-native. In this case, it determines whether
* directives defined in parameter-set-independent headers should
* be #undef'ined or not at the of the SCU file. This is needed
* in multilevel builds.
*
* See examples/multilevel_build_native for an example.
*
* This can also be set using CFLAGS.
*
*****************************************************************************/
/* #define MLD_CONFIG_MONOBUILD_KEEP_SHARED_HEADERS */
/******************************************************************************
* Name: MLD_CONFIG_USE_NATIVE_BACKEND_ARITH
*
* Description: Determines whether an native arithmetic backend should be used.
*
* The arithmetic backend covers performance critical functions
* such as the number-theoretic transform (NTT).
*
* If this option is unset, the C backend will be used.
*
* If this option is set, the arithmetic backend to be use is
* determined by MLD_CONFIG_ARITH_BACKEND_FILE: If the latter is
* unset, the default backend for your the target architecture
* will be used. If set, it must be the name of a backend metadata
* file.
*
* This can also be set using CFLAGS.
*
*****************************************************************************/
#if !defined(MLD_CONFIG_USE_NATIVE_BACKEND_ARITH)
/* #define MLD_CONFIG_USE_NATIVE_BACKEND_ARITH */
#endif
/******************************************************************************
* Name: MLD_CONFIG_ARITH_BACKEND_FILE
*
* Description: The arithmetic backend to use.
*
* If MLD_CONFIG_USE_NATIVE_BACKEND_ARITH is unset, this option
* is ignored.
*
* If MLD_CONFIG_USE_NATIVE_BACKEND_ARITH is set, this option must
* either be undefined or the filename of an arithmetic backend.
* If unset, the default backend will be used.
*
* This can be set using CFLAGS.
*
*****************************************************************************/
#if defined(MLD_CONFIG_USE_NATIVE_BACKEND_ARITH) && \
!defined(MLD_CONFIG_ARITH_BACKEND_FILE)
#define MLD_CONFIG_ARITH_BACKEND_FILE "native/meta.h"
#endif
/******************************************************************************
* Name: MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202
*
* Description: Determines whether an native FIPS202 backend should be used.
*
* The FIPS202 backend covers 1x/2x/4x-fold Keccak-f1600, which is
* the performance bottleneck of SHA3 and SHAKE.
*
* If this option is unset, the C backend will be used.
*
* If this option is set, the FIPS202 backend to be use is
* determined by MLD_CONFIG_FIPS202_BACKEND_FILE: If the latter is
* unset, the default backend for your the target architecture
* will be used. If set, it must be the name of a backend metadata
* file.
*
* This can also be set using CFLAGS.
*
*****************************************************************************/
#if !defined(MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202)
/* #define MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202 */
#endif
/******************************************************************************
* Name: MLD_CONFIG_FIPS202_BACKEND_FILE
*
* Description: The FIPS-202 backend to use.
*
* If MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202 is set, this option
* must either be undefined or the filename of a FIPS202 backend.
* If unset, the default backend will be used.
*
* This can be set using CFLAGS.
*
*****************************************************************************/
#if defined(MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202) && \
!defined(MLD_CONFIG_FIPS202_BACKEND_FILE)
#define MLD_CONFIG_FIPS202_BACKEND_FILE "fips202/native/auto.h"
#endif
/******************************************************************************
* Name: MLD_CONFIG_FIPS202_CUSTOM_HEADER
*
* Description: Custom header to use for FIPS-202
*
* This should only be set if you intend to use a custom
* FIPS-202 implementation, different from the one shipped
* with mldsa-native.
*
* If set, it must be the name of a file serving as the
* replacement for mldsa/src/fips202/fips202.h, and exposing
* the same API (see FIPS202.md).
*
*****************************************************************************/
/* #define MLD_CONFIG_FIPS202_CUSTOM_HEADER "SOME_FILE.h" */
/******************************************************************************
* Name: MLD_CONFIG_FIPS202X4_CUSTOM_HEADER
*
* Description: Custom header to use for FIPS-202-X4
*
* This should only be set if you intend to use a custom
* FIPS-202 implementation, different from the one shipped
* with mldsa-native.
*
* If set, it must be the name of a file serving as the
* replacement for mldsa/src/fips202/fips202x4.h, and exposing
* the same API (see FIPS202.md).
*
*****************************************************************************/
/* #define MLD_CONFIG_FIPS202X4_CUSTOM_HEADER "SOME_FILE.h" */
/******************************************************************************
* Name: MLD_CONFIG_CUSTOM_ZEROIZE
*
* Description: In compliance with @[FIPS204, Section 3.6.3], mldsa-native,
* zeroizes intermediate stack buffers before returning from
* function calls.
*
* Set this option and define `mld_zeroize_native` if you want to
* use a custom method to zeroize intermediate stack buffers.
* The default implementation uses SecureZeroMemory on Windows
* and a memset + compiler barrier otherwise. If neither of those
* is available on the target platform, compilation will fail,
* and you will need to use MLD_CONFIG_CUSTOM_ZEROIZE to provide
* a custom implementation of `mld_zeroize_native()`.
*
* WARNING:
* The explicit stack zeroization conducted by mldsa-native
* reduces the likelihood of data leaking on the stack, but
* does not eliminate it! The C standard makes no guarantee about
* where a compiler allocates structures and whether/where it makes
* copies of them. Also, in addition to entire structures, there
* may also be potentially exploitable leakage of individual values
* on the stack.
*
* If you need bullet-proof zeroization of the stack, you need to
* consider additional measures instead of what this feature
* provides. In this case, you can set mld_zeroize_native to a
* no-op.
*
*****************************************************************************/
/* #define MLD_CONFIG_CUSTOM_ZEROIZE
#if !defined(__ASSEMBLER__)
#include <stdint.h>
#include "src/src.h"
static MLD_INLINE void mld_zeroize_native(void *ptr, size_t len)
{
... your implementation ...
}
#endif
*/
/******************************************************************************
* Name: MLD_CONFIG_CUSTOM_RANDOMBYTES
*
* Description: mldsa-native does not provide a secure randombytes
* implementation. Such an implementation has to provided by the
* consumer.
*
* If this option is not set, mldsa-native expects a function
* int randombytes(uint8_t *out, size_t outlen).
*
* Set this option and define `mld_randombytes` if you want to
* use a custom method to sample randombytes with a different name
* or signature.
*
*****************************************************************************/
/* #define MLD_CONFIG_CUSTOM_RANDOMBYTES
#if !defined(__ASSEMBLER__)
#include <stdint.h>
#include "src/src.h"
static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
{
... your implementation ...
return 0;
}
#endif
*/
/******************************************************************************
* Name: MLD_CONFIG_CUSTOM_CAPABILITY_FUNC
*
* Description: mldsa-native backends may rely on specific hardware features.
* Those backends will only be included in an mldsa-native build
* if support for the respective features is enabled at
* compile-time. However, when building for a heteroneous set
* of CPUs to run the resulting binary/library on, feature
* detection at _runtime_ is needed to decided whether a backend
* can be used or not.
*
* Set this option and define `mld_sys_check_capability` if you
* want to use a custom method to dispatch between implementations.
*
* Return value 1 indicates that a capability is supported.
* Return value 0 indicates that a capability is not supported.
*
* If this option is not set, mldsa-native uses compile-time
* feature detection only to decide which backend to use.
*
* If you compile mldsa-native on a system with different
* capabilities than the system that the resulting binary/library
* will be run on, you must use this option.
*
*****************************************************************************/
#define MLD_CONFIG_CUSTOM_CAPABILITY_FUNC
#if !defined(__ASSEMBLER__)
#include "../mldsa/src/sys.h"
/* System capability enumeration */
static MLD_INLINE int mld_sys_check_capability(mld_sys_cap cap)
{
(void)cap; /* Ignore parameter */
return 0;
}
#endif /* !__ASSEMBLER__ */
/******************************************************************************
* Name: MLD_CONFIG_CUSTOM_ALLOC_FREE [EXPERIMENTAL]
*
* Description: Set this option and define `MLD_CUSTOM_ALLOC` and
* `MLD_CUSTOM_FREE` if you want to use custom allocation for
* large local structures or buffers.
*
* By default, all buffers/structures are allocated on the stack.
* If this option is set, most of them will be allocated via
* MLD_CUSTOM_ALLOC.
*
* Parameters to MLD_CUSTOM_ALLOC:
* - T* v: Target pointer to declare.
* - T: Type of structure to be allocated
* - N: Number of elements to be allocated.
*
* Parameters to MLD_CUSTOM_FREE:
* - T* v: Target pointer to free. May be NULL.
* - T: Type of structure to be freed.
* - N: Number of elements to be freed.
*
* WARNING: This option is experimental!
* Its scope, configuration and function/macro signatures may
* change at any time. We expect a stable API for v2.
*
* NOTE: Even if this option is set, some allocations further down
* the call stack will still be made from the stack. Those will
* likely be added to the scope of this option in the future.
*
* NOTE: MLD_CUSTOM_ALLOC need not guarantee a successful
* allocation nor include error handling. Upon failure, the
* target pointer should simply be set to NULL. The calling
* code will handle this case and invoke MLD_CUSTOM_FREE.
*
*****************************************************************************/
/* #define MLD_CONFIG_CUSTOM_ALLOC_FREE
#if !defined(__ASSEMBLER__)
#include <stdlib.h>
#define MLD_CUSTOM_ALLOC(v, T, N) \
T* (v) = (T *)aligned_alloc(MLD_DEFAULT_ALIGN, \
MLD_ALIGN_UP(sizeof(T) * (N)))
#define MLD_CUSTOM_FREE(v, T, N) free(v)
#endif
*/
/******************************************************************************
* Name: MLD_CONFIG_CUSTOM_MEMCPY
*
* Description: Set this option and define `mld_memcpy` if you want to
* use a custom method to copy memory instead of the standard
* library memcpy function.
*
* The custom implementation must have the same signature and
* behavior as the standard memcpy function:
* void *mld_memcpy(void *dest, const void *src, size_t n)
*
*****************************************************************************/
/* #define MLD_CONFIG_CUSTOM_MEMCPY
#if !defined(__ASSEMBLER__)
#include <stdint.h>
#include "src/src.h"
static MLD_INLINE void *mld_memcpy(void *dest, const void *src, size_t n)
{
... your implementation ...
}
#endif
*/
/******************************************************************************
* Name: MLD_CONFIG_CUSTOM_MEMSET
*
* Description: Set this option and define `mld_memset` if you want to
* use a custom method to set memory instead of the standard
* library memset function.
*
* The custom implementation must have the same signature and
* behavior as the standard memset function:
* void *mld_memset(void *s, int c, size_t n)
*
*****************************************************************************/
/* #define MLD_CONFIG_CUSTOM_MEMSET
#if !defined(__ASSEMBLER__)
#include <stdint.h>
#include "src/src.h"
static MLD_INLINE void *mld_memset(void *s, int c, size_t n)
{
... your implementation ...
}
#endif
*/
/******************************************************************************
* Name: MLD_CONFIG_INTERNAL_API_QUALIFIER
*
* Description: If set, this option provides an additional function
* qualifier to be added to declarations of internal API.
*
* The primary use case for this option are single-CU builds,
* in which case this option can be set to `static`.
*
*****************************************************************************/
/* #define MLD_CONFIG_INTERNAL_API_QUALIFIER */
/******************************************************************************
* Name: MLD_CONFIG_CT_TESTING_ENABLED
*
* Description: If set, mldsa-native annotates data as secret / public using
* valgrind's annotations VALGRIND_MAKE_MEM_UNDEFINED and
* VALGRIND_MAKE_MEM_DEFINED, enabling various checks for secret-
* dependent control flow of variable time execution (depending
* on the exact version of valgrind installed).
*
*****************************************************************************/
/* #define MLD_CONFIG_CT_TESTING_ENABLED */
/******************************************************************************
* Name: MLD_CONFIG_NO_ASM
*
* Description: If this option is set, mldsa-native will be built without
* use of native code or inline assembly.
*
* By default, inline assembly is used to implement value barriers.
* Without inline assembly, mldsa-native will use a global volatile
* 'opt blocker' instead; see ct.h.
*
* Inline assembly is also used to implement a secure zeroization
* function on non-Windows platforms. If this option is set and
* the target platform is not Windows, you MUST set
* MLD_CONFIG_CUSTOM_ZEROIZE and provide a custom zeroization
* function.
*
* If this option is set, MLD_CONFIG_USE_NATIVE_BACKEND_FIPS202 and
* and MLD_CONFIG_USE_NATIVE_BACKEND_ARITH will be ignored, and no
* native backends will be used.
*
*****************************************************************************/
/* #define MLD_CONFIG_NO_ASM */
/******************************************************************************
* Name: MLD_CONFIG_NO_ASM_VALUE_BARRIER
*
* Description: If this option is set, mldsa-native will be built without
* use of native code or inline assembly for value barriers.
*
* By default, inline assembly (if available) is used to implement
* value barriers.
* Without inline assembly, mldsa-native will use a global volatile
* 'opt blocker' instead; see ct.h.
*
*****************************************************************************/
/* #define MLD_CONFIG_NO_ASM_VALUE_BARRIER */
/******************************************************************************
* Name: MLD_CONFIG_KEYGEN_PCT
*
* Description: Compliance with @[FIPS140_3_IG, p.87] requires a
* Pairwise Consistency Test (PCT) to be carried out on a freshly
* generated keypair before it can be exported.
*
* Set this option if such a check should be implemented.
* In this case, crypto_sign_keypair_internal and
* crypto_sign_keypair will return a non-zero error code if the
* PCT failed.
*
* NOTE: This feature will drastically lower the performance of
* key generation.
*
*****************************************************************************/
/* #define MLD_CONFIG_KEYGEN_PCT */
/******************************************************************************
* Name: MLD_CONFIG_KEYGEN_PCT_BREAKAGE_TEST
*
* Description: If this option is set, the user must provide a runtime
* function `static inline int mld_break_pct() { ... }` to
* indicate whether the PCT should be made fail.
*
* This option only has an effect if MLD_CONFIG_KEYGEN_PCT is set.
*
*****************************************************************************/
/* #define MLD_CONFIG_KEYGEN_PCT_BREAKAGE_TEST
#if !defined(__ASSEMBLER__)
#include "src/src.h"
static MLD_INLINE int mld_break_pct(void)
{
... return 0/1 depending on whether PCT should be broken ...
}
#endif
*/
/******************************************************************************
* Name: MLD_CONFIG_SERIAL_FIPS202_ONLY
*
* Description: Set this to use a FIPS202 implementation with global state
* that supports only one active Keccak computation at a time
* (e.g. some hardware accelerators).
*
* If this option is set, ML-DSA will use FIPS202 operations
* serially, ensuring that only one SHAKE context is active
* at any given time.
*
* This allows offloading Keccak computations to a hardware
* accelerator that holds only a single Keccak state locally,
* rather than requiring support for multiple concurrent
* Keccak states.
*
* NOTE: Depending on the target CPU, this may reduce
* performance when using software FIPS202 implementations.
* Only enable this when you have to.
*
*****************************************************************************/
/* #define MLD_CONFIG_SERIAL_FIPS202_ONLY */
/******************************************************************************
* Name: MLD_CONFIG_REDUCE_RAM [EXPERIMENTAL]
*
* Description: Set this to reduce RAM usage.
* This trades memory for performance.
*
* For detailed expected memory savings, see the
* mldsa-native README.
*
* This option is useful for embedded systems with tight RAM
* constraints but relaxed performance requirements.
*
* WARNING: This option is experimental!
* CBMC proofs do not currently cover this configuration option.
* Its scope and configuration may change at any time.
*
*****************************************************************************/
/* #define MLD_CONFIG_REDUCE_RAM */
/************************* Config internals ********************************/
#endif /* MLD_BUILD_INTERNAL */
/* Default namespace
*
* Don't change this. If you need a different namespace, re-define
* MLD_CONFIG_NAMESPACE_PREFIX above instead, and remove the following.
*
* The default MLDSA namespace is
*
* PQCP_MLDSA_NATIVE_MLDSA<LEVEL>_
*
* e.g., PQCP_MLDSA_NATIVE_MLDSA44_
*/
#if MLD_CONFIG_PARAMETER_SET == 44
#define MLD_DEFAULT_NAMESPACE_PREFIX PQCP_MLDSA_NATIVE_MLDSA44
#elif MLD_CONFIG_PARAMETER_SET == 65
#define MLD_DEFAULT_NAMESPACE_PREFIX PQCP_MLDSA_NATIVE_MLDSA65
#elif MLD_CONFIG_PARAMETER_SET == 87
#define MLD_DEFAULT_NAMESPACE_PREFIX PQCP_MLDSA_NATIVE_MLDSA87
#endif
#endif /* !MLD_CONFIG_H */