Skip to content

Commit 5ba32b1

Browse files
committed
Add ML-DSA documentation to README
1 parent c60eacb commit 5ba32b1

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,16 @@ configure step.
5454
WARNING: ECB (Electronic Code Book) mode AES is generally considered to be
5555
insecure. Please consider using a different mode of AES.
5656

57+
### Optional: PQC ML-DSA Support
58+
59+
To have ML-DSA support in wolfPKCS11, configure wolfSSL with ML-DSA (Dilithium)
60+
support enabled, either by adding `--enable-mldsa` to `./configure` or by
61+
setting `WOLFSSL_DILITHIUM` to `yes` in CMake.
62+
63+
As ML-DSA is a feature of PKCS#11 version 3.2, support for that is required,
64+
too. Hence, to enable all in wolfPKCS11, add `--enable-pkcs11v32 --enable-mldsa`
65+
during the configure step.
66+
5767
### Build options and defines
5868

5969
#### Define WOLFPKCS11_TPM_STORE
@@ -116,7 +126,8 @@ cmake -DCMAKE_INSTALL_PREFIX=/usr/local \
116126
-DWOLFSSL_SHA=yes -DWOLFSSL_SHA224=yes -DWOLFSSL_SHA3=yes \
117127
-DWOLFSSL_SHA384=yes -DWOLFSSL_SHA512=yes \
118128
-DWOLFSSL_SP_MATH_ALL=yes -DWOLFSSL_PUBLIC_MP=yes \
119-
-DWOLFSSL_WC_RSA_DIRECT=yes -DCMAKE_BUILD_TYPE=Release \
129+
-DWOLFSSL_WC_RSA_DIRECT=yes -DWOLFSSL_DILITHIUM=yes \
130+
-DCMAKE_BUILD_TYPE=Release \
120131
..
121132
cmake --build .
122133
sudo cmake --install .
@@ -147,6 +158,8 @@ cmake -DWOLFPKCS11_DEBUG=yes \
147158
-DWOLFPKCS11_AESCTS=yes \
148159
-DWOLFPKCS11_AESCMAC=yes \
149160
-DWOLFPKCS11_PBKDF2=yes \
161+
-DWOLFPKCS11_PKCS11_V3_2=yes \
162+
-DWOLFPKCS11_MLDSA=yes \
150163
..
151164
cmake --build .
152165
ctest
@@ -194,6 +207,7 @@ cmake -DCMAKE_PREFIX_PATH=/path/to/wolfssl/install ..
194207
| `WOLFPKCS11_NSS` | `no` | NSS-specific modifications |
195208
| `WOLFPKCS11_PKCS11_V3_0` | `yes` | PKCS#11 v3.0 support |
196209
| `WOLFPKCS11_PKCS11_V3_2` | `no` | PKCS#11 v3.2 support |
210+
| `WOLFPKCS11_MLDSA` | `no`| ML-DSA support |
197211
| `WOLFPKCS11_EXAMPLES` | `yes` | Build examples |
198212
| `WOLFPKCS11_TESTS` | `yes` | Build and register tests |
199213
| `WOLFPKCS11_COVERAGE` | `no` | Code coverage support |

0 commit comments

Comments
 (0)