Skip to content

Commit 6af5c38

Browse files
willieyzwillieyz
committed
Rename all parameter sets: from MLKEM-{512/768/1024} to ML-KEM-{512/768/1024}
- This typo was pre-existing before this PR #1153, we sort this out with a separate commit Signed-off-by: willieyz <[email protected]>
1 parent d83e884 commit 6af5c38

File tree

18 files changed

+48
-48
lines changed

18 files changed

+48
-48
lines changed

‎.github/workflows/cbmc.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
id-token: 'write'
1717
uses: ./.github/workflows/ci_ec2_reusable.yml
1818
with:
19-
name: CBMC (MLKEM-512)
19+
name: CBMC (ML-KEM-512)
2020
ec2_instance_type: c7g.4xlarge
2121
ec2_ami: ubuntu-latest (custom AMI)
2222
ec2_ami_id: ami-08ddb0acd99dc3d33 # aarch64, ubuntu-latest, 64g
@@ -38,7 +38,7 @@ jobs:
3838
id-token: 'write'
3939
uses: ./.github/workflows/ci_ec2_reusable.yml
4040
with:
41-
name: CBMC (MLKEM-768)
41+
name: CBMC (ML-KEM-768)
4242
ec2_instance_type: c7g.4xlarge
4343
ec2_ami: ubuntu-latest (custom AMI)
4444
ec2_ami_id: ami-08ddb0acd99dc3d33 # aarch64, ubuntu-latest, 64g
@@ -60,7 +60,7 @@ jobs:
6060
id-token: 'write'
6161
uses: ./.github/workflows/ci_ec2_reusable.yml
6262
with:
63-
name: CBMC (MLKEM-1024)
63+
name: CBMC (ML-KEM-1024)
6464
ec2_instance_type: c7g.4xlarge
6565
ec2_ami: ubuntu-latest (custom AMI)
6666
ec2_ami_id: ami-08ddb0acd99dc3d33 # aarch64, ubuntu-latest, 64g

‎examples/monolithic_build_multilevel/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ by `MLK_CONFIG_PARAMETER_SET`) every time.
4141
```
4242
4343
Note the setting `MLK_CONFIG_MULTILEVEL_WITH_SHARED` which forces the inclusion of all level-independent
44-
code in the MLKEM-512 build, and the setting `MLK_CONFIG_MULTILEVEL_NO_SHARED`, which drops all
44+
code in the ML-KEM-512 build, and the setting `MLK_CONFIG_MULTILEVEL_NO_SHARED`, which drops all
4545
level-independent code in the subsequent builds. Finally, `MLK_CONFIG_MONOBUILD_KEEP_SHARED_HEADERS` entails that
4646
`mlkem_native.c` does not `#undefine` the `#define` clauses from level-independent files.
4747
@@ -54,23 +54,23 @@ would lead to name-clashes upon multiple use.
5454
```C
5555
#define MLK_CONFIG_API_NO_SUPERCOP
5656
57-
/* API for MLKEM-512 */
57+
/* API for ML-KEM-512 */
5858
#define MLK_CONFIG_API_PARAMETER_SET 512
5959
#define MLK_CONFIG_API_NAMESPACE_PREFIX mlkem512
6060
#include <mlkem_native.h>
6161
#undef MLK_CONFIG_API_PARAMETER_SET
6262
#undef MLK_CONFIG_API_NAMESPACE_PREFIX
6363
#undef MLK_H
6464
65-
/* API for MLKEM-768 */
65+
/* API for ML-KEM-768 */
6666
#define MLK_CONFIG_API_PARAMETER_SET 768
6767
#define MLK_CONFIG_API_NAMESPACE_PREFIX mlkem768
6868
#include <mlkem_native.h>
6969
#undef MLK_CONFIG_API_PARAMETER_SET
7070
#undef MLK_CONFIG_API_NAMESPACE_PREFIX
7171
#undef MLK_H
7272
73-
/* API for MLKEM-1024 */
73+
/* API for ML-KEM-1024 */
7474
#define MLK_CONFIG_API_PARAMETER_SET 1024
7575
#define MLK_CONFIG_API_NAMESPACE_PREFIX mlkem1024
7676
#include <mlkem_native.h>

‎examples/monolithic_build_multilevel/main.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ static int test_keys_mlkem512(void)
7373
"[WARNING] Skipping KAT test since PCT is enabled and modifies PRNG\n");
7474
#endif
7575

76-
printf("[MLKEM-512] OK\n");
76+
printf("[ML-KEM-512] OK\n");
7777
return 0;
7878
}
7979

@@ -128,7 +128,7 @@ static int test_keys_mlkem768(void)
128128
"[WARNING] Skipping KAT test since PCT is enabled and modifies PRNG\n");
129129
#endif
130130

131-
printf("[MLKEM-768] OK\n");
131+
printf("[ML-KEM-768] OK\n");
132132
return 0;
133133
}
134134

@@ -184,7 +184,7 @@ static int test_keys_mlkem1024(void)
184184
"[WARNING] Skipping KAT test since PCT is enabled and modifies PRNG\n");
185185
#endif
186186

187-
printf("[MLKEM-1024] OK\n");
187+
printf("[ML-KEM-1024] OK\n");
188188
return 0;
189189
}
190190

‎examples/monolithic_build_multilevel/mlkem_native_all.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@
88

99
#define MLK_CONFIG_API_NO_SUPERCOP
1010

11-
/* API for MLKEM-512 */
11+
/* API for ML-KEM-512 */
1212
#define MLK_CONFIG_API_PARAMETER_SET 512
1313
#define MLK_CONFIG_API_NAMESPACE_PREFIX mlkem512
1414
#include <mlkem_native.h>
1515
#undef MLK_CONFIG_API_PARAMETER_SET
1616
#undef MLK_CONFIG_API_NAMESPACE_PREFIX
1717
#undef MLK_H
1818

19-
/* API for MLKEM-768 */
19+
/* API for ML-KEM-768 */
2020
#define MLK_CONFIG_API_PARAMETER_SET 768
2121
#define MLK_CONFIG_API_NAMESPACE_PREFIX mlkem768
2222
#include <mlkem_native.h>
2323
#undef MLK_CONFIG_API_PARAMETER_SET
2424
#undef MLK_CONFIG_API_NAMESPACE_PREFIX
2525
#undef MLK_H
2626

27-
/* API for MLKEM-1024 */
27+
/* API for ML-KEM-1024 */
2828
#define MLK_CONFIG_API_PARAMETER_SET 1024
2929
#define MLK_CONFIG_API_NAMESPACE_PREFIX mlkem1024
3030
#include <mlkem_native.h>

‎examples/monolithic_build_multilevel_native/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ appropriately first, and then includes the monobuild:
4242
```
4343
4444
Note the setting `MLK_CONFIG_MULTILEVEL_WITH_SHARED` which forces the inclusion of all level-independent
45-
code in the MLKEM-512 build, and the setting `MLK_CONFIG_MULTILEVEL_NO_SHARED`, which drops all
45+
code in the ML-KEM-512 build, and the setting `MLK_CONFIG_MULTILEVEL_NO_SHARED`, which drops all
4646
level-independent code in the subsequent builds. Finally, `MLK_CONFIG_MONOBUILD_KEEP_SHARED_HEADERS` entails that
4747
[mlkem_native.c](mlkem/mlkem_native.c) does not `#undefine` the `#define` clauses from level-independent files.
4848

‎examples/monolithic_build_multilevel_native/main.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ static int test_keys_mlkem512(void)
7777
"[WARNING] Skipping KAT test since PCT is enabled and modifies PRNG\n");
7878
#endif
7979

80-
printf("[MLKEM-512] OK\n");
80+
printf("[ML-KEM-512] OK\n");
8181
return 0;
8282
}
8383

@@ -132,7 +132,7 @@ static int test_keys_mlkem768(void)
132132
"[WARNING] Skipping KAT test since PCT is enabled and modifies PRNG\n");
133133
#endif
134134

135-
printf("[MLKEM-768] OK\n");
135+
printf("[ML-KEM-768] OK\n");
136136
return 0;
137137
}
138138

@@ -188,7 +188,7 @@ static int test_keys_mlkem1024(void)
188188
"[WARNING] Skipping KAT test since PCT is enabled and modifies PRNG\n");
189189
#endif
190190

191-
printf("[MLKEM-1024] OK\n");
191+
printf("[ML-KEM-1024] OK\n");
192192
return 0;
193193
}
194194

‎examples/multilevel_build/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
# Multi-level build
44

55
This directory contains a minimal example for how to build mlkem-native with support for all 3 security levels
6-
MLKEM-512, MLKEM-768, and MLKEM-1024, and so that level-independent code is shared. In this example, only the C-backend
6+
ML-KEM-512, ML-KEM-768, and ML-KEM-1024, and so that level-independent code is shared. In this example, only the C-backend
77
of mlkem-native is used.
88

9-
The library is built 3 times in different build directories `build/mlkem{512,768,1024}`. For the MLKEM-512 build, we set
9+
The library is built 3 times in different build directories `build/mlkem{512,768,1024}`. For the ML-KEM-512 build, we set
1010
`MLK_CONFIG_MULTILEVEL_WITH_SHARED` to force the inclusion of all level-independent code in the
11-
MLKEM512-build. For MLKEM-768 and MLKEM-1024, we set `MLK_CONFIG_MULTILEVEL_NO_SHARED` to not include any
11+
MLKEM512-build. For ML-KEM-768 and ML-KEM-1024, we set `MLK_CONFIG_MULTILEVEL_NO_SHARED` to not include any
1212
level-independent code. Finally, we use the common namespace prefix `mlkem` as `MLK_CONFIG_NAMESPACE_PREFIX` for all three
1313
builds; the suffix 512/768/1024 will be added to level-dependent functions automatically.
1414

‎examples/multilevel_build/main.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ static int test_keys_mlkem512(void)
7373
"[WARNING] Skipping KAT test since PCT is enabled and modifies PRNG\n");
7474
#endif
7575

76-
printf("[MLKEM-512] OK\n");
76+
printf("[ML-KEM-512] OK\n");
7777
return 0;
7878
}
7979

@@ -128,7 +128,7 @@ static int test_keys_mlkem768(void)
128128
"[WARNING] Skipping KAT test since PCT is enabled and modifies PRNG\n");
129129
#endif
130130

131-
printf("[MLKEM-768] OK\n");
131+
printf("[ML-KEM-768] OK\n");
132132
return 0;
133133
}
134134

@@ -183,7 +183,7 @@ static int test_keys_mlkem1024(void)
183183
"[WARNING] Skipping KAT test since PCT is enabled and modifies PRNG\n");
184184
#endif
185185

186-
printf("[MLKEM-1024] OK\n");
186+
printf("[ML-KEM-1024] OK\n");
187187
return 0;
188188
}
189189

‎examples/multilevel_build/mlkem_native_all.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@
66
#if !defined(MLK_ALL_H)
77
#define MLK_ALL_H
88

9-
/* API for MLKEM-512 */
9+
/* API for ML-KEM-512 */
1010
#define MLK_CONFIG_API_PARAMETER_SET 512
1111
#define MLK_CONFIG_API_NAMESPACE_PREFIX mlkem512
1212
#include "mlkem_native/mlkem/mlkem_native.h"
1313
#undef MLK_CONFIG_API_PARAMETER_SET
1414
#undef MLK_CONFIG_API_NAMESPACE_PREFIX
1515
#undef MLK_H
1616

17-
/* API for MLKEM-768 */
17+
/* API for ML-KEM-768 */
1818
#define MLK_CONFIG_API_PARAMETER_SET 768
1919
#define MLK_CONFIG_API_NAMESPACE_PREFIX mlkem768
2020
#include "mlkem_native/mlkem/mlkem_native.h"
2121
#undef MLK_CONFIG_API_PARAMETER_SET
2222
#undef MLK_CONFIG_API_NAMESPACE_PREFIX
2323
#undef MLK_H
2424

25-
/* API for MLKEM-1024 */
25+
/* API for ML-KEM-1024 */
2626
#define MLK_CONFIG_API_PARAMETER_SET 1024
2727
#define MLK_CONFIG_API_NAMESPACE_PREFIX mlkem1024
2828
#include "mlkem_native/mlkem/mlkem_native.h"

‎examples/multilevel_build_native/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
# Multi-level build
44

55
This directory contains a minimal example for how to build mlkem-native with support for all 3 security levels
6-
MLKEM-512, MLKEM-768, and MLKEM-1024. All level-independent code is shared, and native backends are in use.
6+
ML-KEM-512, ML-KEM-768, and ML-KEM-1024. All level-independent code is shared, and native backends are in use.
77

8-
The library is built 3 times in different build directories `build/mlkem{512,768,1024}`. For the MLKEM-512 build, we set
8+
The library is built 3 times in different build directories `build/mlkem{512,768,1024}`. For the ML-KEM-512 build, we set
99
`MLK_CONFIG_MULTILEVEL_WITH_SHARED` to force the inclusion of all level-independent code in the
10-
MLKEM512-build. For MLKEM-768 and MLKEM-1024, we set `MLK_CONFIG_MULTILEVEL_NO_SHARED` to not include any
10+
MLKEM512-build. For ML-KEM-768 and ML-KEM-1024, we set `MLK_CONFIG_MULTILEVEL_NO_SHARED` to not include any
1111
level-independent code. Finally, we use the common namespace prefix `mlkem` as `MLK_CONFIG_NAMESPACE_PREFIX` for all three
1212
builds; the suffix 512/768/1024 will be added to level-dependent functions automatically.
1313

0 commit comments

Comments
 (0)