diff options
author | Pauli <pauli@openssl.org> | 2023-03-16 14:21:25 +1100 |
---|---|---|
committer | Pauli <pauli@openssl.org> | 2023-03-29 09:29:22 +1100 |
commit | 2fa58ca78266a0c9e01030520fe743cb7eeed72f (patch) | |
tree | 64acc27bc8551b1d6ba32a426f0cd39911e18e15 /doc | |
parent | 2d574892fee144f2307b5fb9c5b19d3cbe9ad99e (diff) |
doc: note the restriction on digests used by DRBGs in FIPS mode.
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/20521)
(cherry picked from commit e14fc22c90ce5a9e6d66d8658fc6bb37f95019da)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man1/openssl-fipsinstall.pod.in | 6 | ||||
-rw-r--r-- | doc/man7/EVP_RAND-HASH-DRBG.pod | 28 | ||||
-rw-r--r-- | doc/man7/EVP_RAND-HMAC-DRBG.pod | 28 |
3 files changed, 60 insertions, 2 deletions
diff --git a/doc/man1/openssl-fipsinstall.pod.in b/doc/man1/openssl-fipsinstall.pod.in index 813b7ecc19..94dd0eee7f 100644 --- a/doc/man1/openssl-fipsinstall.pod.in +++ b/doc/man1/openssl-fipsinstall.pod.in @@ -22,6 +22,7 @@ B<openssl fipsinstall> [B<-no_conditional_errors>] [B<-no_security_checks>] [B<-ems_check>] +[B<-no_drbg_truncated_digests>] [B<-self_test_onload>] [B<-self_test_oninstall>] [B<-corrupt_desc> I<selftest_description>] @@ -175,6 +176,11 @@ Configure the module to enable a run-time Extended Master Secret (EMS) check when using the TLS1_PRF KDF algorithm. This check is disabled by default. See RFC 7627 for information related to EMS. +=item B<-no_drbg_truncated_digests> + +Configure the module to not allow truncated digests to be used with Hash and +HMAC DRBGs. See FIPS 140-3 IG D.R for details. + =item B<-self_test_onload> Do not write the two fields related to the "test status indicator" and diff --git a/doc/man7/EVP_RAND-HASH-DRBG.pod b/doc/man7/EVP_RAND-HASH-DRBG.pod index 62ded203ad..466d62cd7b 100644 --- a/doc/man7/EVP_RAND-HASH-DRBG.pod +++ b/doc/man7/EVP_RAND-HASH-DRBG.pod @@ -54,6 +54,24 @@ These parameters work as described in L<EVP_RAND(3)/PARAMETERS>. =head1 NOTES +When the FIPS provider is installed using the B<-no_drbg_truncated_digests> +option to fipsinstall, only these digests are permitted (as per +L<FIPS 140-3 IG D.R|https://csrc.nist.gov/CSRC/media/Projects/cryptographic-module-validation-program/documents/fips%20140-3/FIPS%20140-3%20IG.pdf>): + +=over 4 + +=item SHA-1 + +=item SHA2-256 + +=item SHA2-512 + +=item SHA3-256 + +=item SHA3-512 + +=back + A context for HASH DRBG can be obtained by calling: EVP_RAND *rand = EVP_RAND_fetch(NULL, "HASH-DRBG", NULL); @@ -86,7 +104,15 @@ NIST SP 800-90A and SP 800-90B =head1 SEE ALSO L<EVP_RAND(3)>, -L<EVP_RAND(3)/PARAMETERS> +L<EVP_RAND(3)/PARAMETERS>, +L<openssl-fipsinstall(1)> + +=head1 HISTORY + +OpenSSL 3.1.1 introduced the B<-no_drbg_truncated_digests> option to +fipsinstall which restricts the permitted digests when using the FIPS +provider in a complaint manner. For details refer to +L<FIPS 140-3 IG D.R|https://csrc.nist.gov/CSRC/media/Projects/cryptographic-module-validation-program/documents/fips%20140-3/FIPS%20140-3%20IG.pdf>. =head1 COPYRIGHT diff --git a/doc/man7/EVP_RAND-HMAC-DRBG.pod b/doc/man7/EVP_RAND-HMAC-DRBG.pod index 54ae61478d..98b533f3ad 100644 --- a/doc/man7/EVP_RAND-HMAC-DRBG.pod +++ b/doc/man7/EVP_RAND-HMAC-DRBG.pod @@ -56,6 +56,23 @@ These parameters work as described in L<EVP_RAND(3)/PARAMETERS>. =head1 NOTES +When using the FIPS provider, only these digests are permitted (as per +L<FIPS 140-3 IG D.R|https://csrc.nist.gov/CSRC/media/Projects/cryptographic-module-validation-program/documents/fips%20140-3/FIPS%20140-3%20IG.pdf>): + +=over 4 + +=item SHA-1 + +=item SHA2-256 + +=item SHA2-512 + +=item SHA3-256 + +=item SHA3-512 + +=back + A context for HMAC DRBG can be obtained by calling: EVP_RAND *rand = EVP_RAND_fetch(NULL, "HMAC-DRBG", NULL); @@ -89,7 +106,16 @@ NIST SP 800-90A and SP 800-90B =head1 SEE ALSO L<EVP_RAND(3)>, -L<EVP_RAND(3)/PARAMETERS> +L<EVP_RAND(3)/PARAMETERS>, +L<openssl-fipsinstall(1)> + + +=head1 HISTORY + +OpenSSL 3.1.1 introduced the B<-no_drbg_truncated_digests> option to +fipsinstall which restricts the permitted digests when using the FIPS +provider in a complaint manner. For details refer to +L<FIPS 140-3 IG D.R|https://csrc.nist.gov/CSRC/media/Projects/cryptographic-module-validation-program/documents/fips%20140-3/FIPS%20140-3%20IG.pdf>). =head1 COPYRIGHT |