]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Fix documentation of OSSL_ASYM_CIPHER_PARAM_IMPLICIT_REJECTION
authorRichard Levitte <levitte@openssl.org>
Wed, 15 Jan 2025 09:14:41 +0000 (10:14 +0100)
committerTomas Mraz <tomas@openssl.org>
Fri, 17 Jan 2025 17:55:06 +0000 (18:55 +0100)
This drops OSSL_PKEY_PARAM_IMPLICIT_REJECTION - which is a meaningless
name - everywhere apart from still existing (for API stability, in
case someone uses that macro).

Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/26421)

(cherry picked from commit 1df07c761b25e5aca8ecd90b81d05496631285fb)

doc/man3/EVP_PKEY_decrypt.pod
doc/man7/provider-asym_cipher.pod
util/perl/OpenSSL/paramnames.pm

index 31466200952d988ac30f70da2e71f3e35f6809c4..2dfcb93a1e845059b8153c6eca8d50bd9a1de54b 100644 (file)
@@ -61,7 +61,7 @@ used private key. They had to be processed in a side-channel free way.
 Since version 3.2.0, the EVP_PKEY_decrypt() method when used with PKCS#1
 v1.5 padding as implemented in the B<default> provider implements
 the implicit rejection mechanism (see
-B<OSSL_PKEY_PARAM_IMPLICIT_REJECTION> in L<provider-asym_cipher(7)>).
+B<OSSL_ASYM_CIPHER_PARAM_IMPLICIT_REJECTION> in L<provider-asym_cipher(7)>).
 That means it doesn't return an error when it detects an error in padding,
 instead it returns a pseudo-randomly generated message, removing the need
 of side-channel secure code from applications using OpenSSL.
index 0ff33f5b70d55b9eac4ea20c4796b73ea6016f30..7259fc43078b62f700f59fbebb2d6086f9430611 100644 (file)
@@ -234,14 +234,14 @@ The TLS protocol version first requested by the client.
 
 The negotiated TLS protocol version.
 
-=item "implicit-rejection" (B<OSSL_PKEY_PARAM_IMPLICIT_REJECTION>) <unsigned integer>
+=item "implicit-rejection" (B<OSSL_ASYM_CIPHER_PARAM_IMPLICIT_REJECTION>) <unsigned integer>
 
-Gets of sets the use of the implicit rejection mechanism for RSA PKCS#1 v1.5
+Gets or sets the use of the implicit rejection mechanism for RSA PKCS#1 v1.5
 decryption. When set (non zero value), the decryption API will return
 a deterministically random value if the PKCS#1 v1.5 padding check fails.
 This makes exploitation of the Bleichenbacher significantly harder, even
 if the code using the RSA decryption API is not implemented in side-channel
-free manner. Set by default. Requires provider support.
+free manner. Set by default in OpenSSL providers.
 
 =back
 
index e67f0f2beb29bf0ccb04ee3e33aaf54ee349893c..353c613c68cd8c14cbc4de9ded054617bc36963b 100644 (file)
@@ -302,6 +302,9 @@ my %params = (
     'PKEY_PARAM_DIST_ID' =>             "distid",
     'PKEY_PARAM_PUB_KEY' =>             "pub",
     'PKEY_PARAM_PRIV_KEY' =>            "priv",
+    # PKEY_PARAM_IMPLICIT_REJECTION isn't actually used, or meaningful.  We keep
+    # it for API stability, but please use ASYM_CIPHER_PARAM_IMPLICIT_REJECTION
+    # instead.
     'PKEY_PARAM_IMPLICIT_REJECTION' =>  "implicit-rejection",
     'PKEY_PARAM_FIPS_DIGEST_CHECK' =>   "digest-check",
     'PKEY_PARAM_FIPS_KEY_CHECK' =>      "key-check",