From: Pauli <ppzgs1@gmail.com>
Date: Wed, 8 Jan 2025 03:17:47 +0000 (+1100)
Subject: doc: update documentation now that ML-KEM is in the FIPS provider
X-Git-Tag: openssl-3.5.0-alpha1~535
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=96b89c6adb9cff4e214814a5fc6e821f75b9b219;p=thirdparty%2Fopenssl.git

doc: update documentation now that ML-KEM is in the FIPS provider

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Reviewed-by: Hugo Landau <hlandau@devever.net>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/26338)
---

diff --git a/doc/man7/EVP_PKEY-ML-KEM.pod b/doc/man7/EVP_PKEY-ML-KEM.pod
index 30b015ffc4b..13fc39a5741 100644
--- a/doc/man7/EVP_PKEY-ML-KEM.pod
+++ b/doc/man7/EVP_PKEY-ML-KEM.pod
@@ -14,7 +14,7 @@ EVP_PKEY-ML-KEM
 =head1 DESCRIPTION
 
 The B<ML-KEM-512>, B<ML-KEM-768>, and B<ML-KEM-1024> keytypes are implemented
-in OpenSSL's B<default> provider.
+in OpenSSL's default and FIPS providers.
 
 =for comment (TODO(ML-KEM): Add FIPS support).
 
diff --git a/doc/man7/OSSL_PROVIDER-FIPS.pod b/doc/man7/OSSL_PROVIDER-FIPS.pod
index a7d3efb0d19..d85c65017f8 100644
--- a/doc/man7/OSSL_PROVIDER-FIPS.pod
+++ b/doc/man7/OSSL_PROVIDER-FIPS.pod
@@ -140,8 +140,7 @@ This is an unapproved algorithm.
 
 =item X448, see L<EVP_KEYEXCH-X448(7)>
 
-=for comment TODO(ML-KEM) L<EVP_KEM-ML-KEM(7)> once ML-KEM is supported in the
-             FIPS module.
+=item ML-KEM, see L<EVP_KEM-ML-KEM(7)>
 
 =item TLS1-PRF
 
@@ -321,6 +320,10 @@ Known answer test for a key derivation function.
 
 Known answer test for key agreement.
 
+=item "KAT_KEM" (B<OSSL_SELF_TEST_TYPE_KAT_KEM>)
+
+Known answer test for key encapsulation.
+
 =item "DRBG" (B<OSSL_SELF_TEST_TYPE_DRBG>)
 
 Known answer test for a Deterministic Random Bit Generator.
@@ -366,6 +369,8 @@ The FIPS module passes the following descriptions(s) to OSSL_SELF_TEST_onbegin()
 
 =item "ML-DSA" (B<OSSL_SELF_TEST_DESC_PCT_ML_DSA>)
 
+=item "ML-KEM" (B<OSSL_SELF_TEST_DESC_PCT_ML_KEM>)
+
 Key generation tests used with the "Pairwise_Consistency_Test" type.
 
 =item "RSA_Encrypt" (B<OSSL_SELF_TEST_DESC_ASYM_RSA_ENC>)
@@ -428,6 +433,16 @@ Key agreement tests used with the "KAT_KA" type.
 
 =item "KBKDF" (B<OSSL_SELF_TEST_DESC_KDF_KBKDF>)
 
+Key Encapsulation Function tests used with the "KAT_KEM" type.
+
+=item "KEM_Encap" (B<OSSL_SELF_TEST_DESC_ENCAP_KEM>)
+
+=item "KEM_Decap" (B<OSSL_SELF_TEST_DESC_DECAP_KEM>)
+
+=item "KEM_Decap_Reject" (B<OSSL_SELF_TEST_DESC_DECAP_REJ_KEM>)
+
+=item "KEM_Keygen" (B<OSSL_SELF_TEST_DESC_KEYGEN_KEM>)
+
 Key Derivation Function tests used with the "KAT_KDF" type.
 
 =item "CTR" (B<OSSL_SELF_TEST_DESC_DRBG_CTR>)