]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc: docment key-check param for kbkdf
authorPauli <ppzgs1@gmail.com>
Mon, 5 Aug 2024 05:52:07 +0000 (15:52 +1000)
committerPauli <ppzgs1@gmail.com>
Wed, 7 Aug 2024 22:42:59 +0000 (08:42 +1000)
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/25095)

doc/man7/EVP_KDF-KB.pod

index 1b9342f69116eabf3e7db1f4d6fbc8921625dbf0..e69817594133c2f5423b74c9aacf9e6abfa282f0 100644 (file)
@@ -65,6 +65,23 @@ Set the fixed value 'r', indicating the length of the counter in bits.
 Supported values are B<8>, B<16>, B<24>, and B<32>.
 The default value of B<32> will be used if unspecified.
 
+=item "fips-indicator" (B<OSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR>) <integer>
+
+A getter that returns 1 if the operation is FIPS approved, or 0 otherwise.
+This may be used after calling EVP_KDF_derive. It returns 0 if any "***-check"
+related parameter is set to 0 and the check fails.
+This option is used by the OpenSSL FIPS provider.
+
+=item "key-check" (B<OSSL_KDF_PARAM_FIPS_KEY_CHECK>) <integer>
+
+The default value of 1 causes an error during EVP_KDF_CTX_set_params() if the
+length of used key-derivation key (B<OSSL_KDF_PARAM_KEY>) is shorter than 112
+bits.
+Setting this to zero 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
 
 Depending on whether mac is CMAC or HMAC, either digest or cipher is required