summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorslontis <shane.lontis@oracle.com>2024-08-08 08:56:22 +0200
committerTomas Mraz <tomas@openssl.org>2024-08-15 19:48:15 +0200
commit05681e0e3e47e0abc5ec3a4c12ddb0afcd66db37 (patch)
tree6f1de65f08990e455285c11101d634b9ee371157 /doc
parentapps/cms.c, apps/smime.c: Fix -crlfeol help messages (diff)
downloadopenssl-05681e0e3e47e0abc5ec3a4c12ddb0afcd66db37.tar.xz
openssl-05681e0e3e47e0abc5ec3a4c12ddb0afcd66db37.zip
Add FIPS Indicator for ECDH cofactor.
FIPS KAS requires use of ECC CDH. The EC 'B' and 'K' curves have a cofactor that is not 1, and this MUST be multiplied by the private key when deriving the shared secret. Reviewed-by: Paul Dale <ppzgs1@gmail.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/25139)
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/openssl-fipsinstall.pod.in7
-rw-r--r--doc/man7/EVP_KEYEXCH-ECDH.pod9
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/man1/openssl-fipsinstall.pod.in b/doc/man1/openssl-fipsinstall.pod.in
index eae0314471..4a0b046986 100644
--- a/doc/man1/openssl-fipsinstall.pod.in
+++ b/doc/man1/openssl-fipsinstall.pod.in
@@ -46,6 +46,7 @@ B<openssl fipsinstall>
[B<-sshkdf_key_check>]
[B<-sskdf_key_check>]
[B<-x963kdf_key_check>]
+[B<-ecdh_cofactor_check>]
[B<-self_test_onload>]
[B<-self_test_oninstall>]
[B<-corrupt_desc> I<selftest_description>]
@@ -339,6 +340,12 @@ See NIST SP 800-131Ar2 for details.
Configure the module to not perform run-time lower bound check for PBKDF2.
See NIST SP 800-132 for details.
+=item B<-ecdh_cofactor_check>
+
+Configure the module to enable a run-time check that ECDH uses the EC curves
+cofactor value when deriving a key. This only affects the 'B' and 'K' curves.
+See SP 800-56A r3 Section 5.7.1.2 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_KEYEXCH-ECDH.pod b/doc/man7/EVP_KEYEXCH-ECDH.pod
index 1d27f55298..9b592c0f99 100644
--- a/doc/man7/EVP_KEYEXCH-ECDH.pod
+++ b/doc/man7/EVP_KEYEXCH-ECDH.pod
@@ -49,6 +49,15 @@ per-key basis.
See L<provider-keyexch(7)/Common Key Exchange parameters>.
+=item "ecdh-cofactor-check" (B<OSSL_EXCHANGE_PARAM_FIPS_ECDH_COFACTOR_CHECK>) <integer>
+
+If required this parameter should before OSSL_FUNC_keyexch_derive().
+The default value of 1 causes an error during the OSSL_FUNC_keyexch_derive if
+the EC curve has a cofactor that is not 1, and the cofactor is not used.
+Setting this to 0 will ignore the error and set the approved "fips-indicator" to
+0. This option is used by the OpenSSL FIPS provider, and breaks FIPS compliance
+if set to 0.
+
=back
=head1 EXAMPLES