The EVP_PKEY_CTX_ctrl(3) manual page requires additions for RSA-PSS

but it is growing to excessive size, so split out RSA_pkey_ctx_ctrl(3).

1 files changed, 7 insertions, 264 deletions

diff --git a/src/lib/libcrypto/man/EVP_PKEY_CTX_ctrl.3 b/src/lib/libcrypto/man/EVP_PKEY_CTX_ctrl.3
index b9332a7ec1..2bb6a3fd3b 100644
--- a/src/lib/libcrypto/man/EVP_PKEY_CTX_ctrl.3
+++ b/src/lib/libcrypto/man/EVP_PKEY_CTX_ctrl.3
@@ -1,6 +1,7 @@
-.\" $OpenBSD: EVP_PKEY_CTX_ctrl.3,v 1.20 2019/10/31 14:29:41 schwarze Exp $
+.\" $OpenBSD: EVP_PKEY_CTX_ctrl.3,v 1.21 2019/11/01 12:02:58 schwarze Exp $
 .\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
 .\" selective merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100
+.\" Parts were split out into RSA_pkey_ctx_ctrl(3).
 .\"
 .\" This file was written by Dr. Stephen Henson <steve@openssl.org>
 .\" and Antoine Salon <asalon@vmware.com>.
@@ -51,7 +52,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: October 31 2019 $
+.Dd $Mdocdate: November 1 2019 $
 .Dt EVP_PKEY_CTX_CTRL 3
 .Os
 .Sh NAME
@@ -59,19 +60,6 @@
 .Nm EVP_PKEY_CTX_ctrl_str ,
 .Nm EVP_PKEY_CTX_set_signature_md ,
 .Nm EVP_PKEY_CTX_get_signature_md ,
-.Nm RSA_pkey_ctx_ctrl ,
-.Nm EVP_PKEY_CTX_set_rsa_padding ,
-.Nm EVP_PKEY_CTX_get_rsa_padding ,
-.Nm EVP_PKEY_CTX_set_rsa_pss_saltlen ,
-.Nm EVP_PKEY_CTX_get_rsa_pss_saltlen ,
-.Nm EVP_PKEY_CTX_set_rsa_keygen_bits ,
-.Nm EVP_PKEY_CTX_set_rsa_keygen_pubexp ,
-.Nm EVP_PKEY_CTX_set_rsa_mgf1_md ,
-.Nm EVP_PKEY_CTX_get_rsa_mgf1_md ,
-.Nm EVP_PKEY_CTX_set_rsa_oaep_md ,
-.Nm EVP_PKEY_CTX_get_rsa_oaep_md ,
-.Nm EVP_PKEY_CTX_set0_rsa_oaep_label ,
-.Nm EVP_PKEY_CTX_get0_rsa_oaep_label ,
 .Nm EVP_PKEY_CTX_set_dsa_paramgen_bits ,
 .Nm EVP_PKEY_CTX_set_dh_paramgen_prime_len ,
 .Nm EVP_PKEY_CTX_set_dh_paramgen_generator ,
@@ -118,76 +106,6 @@
 .Fa "EVP_PKEY_CTX *ctx"
 .Fa "const EVP_MD **pmd"
 .Fc
-.In openssl/rsa.h
-.Ft int
-.Fo RSA_pkey_ctx_ctrl
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "int optype"
-.Fa "int cmd"
-.Fa "int p1"
-.Fa "void *p2"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_set_rsa_padding
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "int pad"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_get_rsa_padding
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "int *ppad"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_set_rsa_pss_saltlen
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "int len"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_get_rsa_pss_saltlen
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "int *plen"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_set_rsa_keygen_bits
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "int mbits"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_set_rsa_keygen_pubexp
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "BIGNUM *pubexp"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_set_rsa_mgf1_md
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "const EVP_MD *md"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_get_rsa_mgf1_md
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "const EVP_MD **pmd"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_set_rsa_oaep_md
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "const EVP_MD *md"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_get_rsa_oaep_md
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "const EVP_MD **pmd"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_set0_rsa_oaep_label
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "unsigned char *label"
-.Fa "int len"
-.Fc
-.Ft int
-.Fo EVP_PKEY_CTX_get0_rsa_oaep_label
-.Fa "EVP_PKEY_CTX *ctx"
-.Fa "unsigned char **plabel"
-.Fc
 .In openssl/dsa.h
 .Ft int
 .Fo EVP_PKEY_CTX_set_dsa_paramgen_bits
@@ -302,7 +220,8 @@ and
 Applications will not normally call
 .Fn EVP_PKEY_CTX_ctrl
 directly but will instead call one of the algorithm specific macros
-below.
+described below and in
+.Xr RSA_pkey_ctx_ctrl 3 .
 .Pp
 The function
 .Fn EVP_PKEY_CTX_ctrl_str
@@ -331,156 +250,6 @@ and
 .Fn EVP_PKEY_CTX_get_signature_md
 macros set and get the message digest type used in a signature.
 They can be used with the RSA, DSA, and ECDSA algorithms.
-.Ss RSA parameters
-The
-.Fn RSA_pkey_ctx_ctrl
-function is a shallow wrapper around
-.Fn EVP_PKEY_CTX_ctrl
-which only succeeds if
-.Fa ctx
-matches either
-.Dv EVP_PKEY_RSA
-or
-.Dv EVP_PKEY_RSA_PSS .
-.Pp
-The
-.Fn EVP_PKEY_CTX_set_rsa_padding
-macro sets the RSA padding mode for
-.Fa ctx .
-The
-.Fa pad
-parameter can take the value
-.Dv RSA_PKCS1_PADDING
-for PKCS#1 padding,
-.Dv RSA_NO_PADDING
-for no padding,
-.Dv RSA_PKCS1_OAEP_PADDING
-for OAEP padding (encrypt and decrypt only),
-.Dv RSA_X931_PADDING
-for X9.31 padding (signature operations only) and
-.Dv RSA_PKCS1_PSS_PADDING
-(sign and verify only).
-.Pp
-Two RSA padding modes behave differently if
-.Fn EVP_PKEY_CTX_set_signature_md
-is used.
-If this macro is called for PKCS#1 padding, the plaintext buffer is an
-actual digest value and is encapsulated in a
-.Vt DigestInfo
-structure according to PKCS#1 when signing and this structure is
-expected (and stripped off) when verifying.
-If this control is not used with RSA and PKCS#1 padding then the
-supplied data is used directly and not encapsulated.
-In the case of X9.31 padding for RSA the algorithm identifier byte is
-added or checked and removed if this control is called.
-If it is not called then the first byte of the plaintext buffer is
-expected to be the algorithm identifier byte.
-.Pp
-The
-.Fn EVP_PKEY_CTX_get_rsa_padding
-macro retrieves the RSA padding mode for
-.Fa ctx .
-.Pp
-The
-.Fn EVP_PKEY_CTX_set_rsa_pss_saltlen
-macro sets the RSA PSS salt length to
-.Fa len .
-As its name implies, it is only supported for PSS padding.
-Two special values are supported: -1 sets the salt length to the digest
-length.
-When signing -2 sets the salt length to the maximum permissible value.
-When verifying -2 causes the salt length to be automatically determined
-based on the PSS block structure.
-If this macro is not called a salt length value of -2 is used by
-default.
-.Pp
-The
-.Fn EVP_PKEY_CTX_get_rsa_pss_saltlen
-macro retrieves the RSA PSS salt length for
-.Fa ctx .
-The padding mode must have been set to
-.Dv RSA_PKCS1_PSS_PADDING .
-.Pp
-The
-.Fn EVP_PKEY_CTX_set_rsa_keygen_bits
-macro sets the RSA key length for RSA key generation to
-.Fa mbits .
-The smallest supported value is 512 bits.
-If not specified, 1024 bits is used.
-.Pp
-The
-.Fn EVP_PKEY_CTX_set_rsa_keygen_pubexp
-macro sets the public exponent value for RSA key generation to
-.Fa pubexp .
-Currently, it should be an odd integer.
-The
-.Fa pubexp
-pointer is used internally by this function, so it should not be modified
-or freed after the call.
-If this macro is not called, then 65537 is used.
-.Pp
-The
-.Fn EVP_PKEY_CTX_set_rsa_mgf1_md
-macro sets the MGF1 digest for RSA padding schemes to
-.Fa md .
-Unless explicitly specified, the signing digest is used.
-The padding mode must have been set to
-.Dv RSA_PKCS1_OAEP_PADDING
-or
-.Dv RSA_PKCS1_PSS_PADDING .
-.Pp
-The
-.Fn EVP_PKEY_CTX_get_rsa_mgf1_md
-macro retrieves the MGF1 digest for
-.Fa ctx .
-Unless explicitly specified, the signing digest is used.
-The padding mode must have been set to
-.Dv RSA_PKCS1_OAEP_PADDING
-or
-.Dv RSA_PKCS1_PSS_PADDING .
-.Pp
-The
-.Fn EVP_PKEY_CTX_set_rsa_oaep_md
-macro sets the message digest type used in RSA OAEP to
-.Fa md .
-The padding mode must have been set to
-.Dv RSA_PKCS1_OAEP_PADDING .
-.Pp
-The
-.Fn EVP_PKEY_CTX_get_rsa_oaep_md
-macro gets the message digest type used in RSA OAEP to
-.Pf * Fa md .
-The padding mode must have been set to
-.Dv RSA_PKCS1_OAEP_PADDING .
-.Pp
-The
-.Fn EVP_PKEY_CTX_set0_rsa_oaep_label
-macro sets the RSA OAEP label to
-.Fa label
-and its length to
-.Fa len .
-If
-.Fa label
-is
-.Dv NULL
-or
-.Fa len
-is 0, the label is cleared.
-The library takes ownership of the label so the caller should not
-free the original memory pointed to by
-.Fa label .
-The padding mode must have been set to
-.Dv RSA_PKCS1_OAEP_PADDING .
-.Pp
-The
-.Fn EVP_PKEY_CTX_get0_rsa_oaep_label
-macro gets the RSA OAEP label to
-.Pf * Fa plabel .
-The return value is the label length.
-The padding mode must have been set to
-.Dv RSA_PKCS1_OAEP_PADDING .
-The resulting pointer is owned by the library and should not be
-freed by the caller.
 .Ss DSA parameters
 The macro
 .Fn EVP_PKEY_CTX_set_dsa_paramgen_bits
@@ -652,16 +421,13 @@ supported by the public key algorithm.
 .Xr EVP_PKEY_meth_set_ctrl 3 ,
 .Xr EVP_PKEY_sign 3 ,
 .Xr EVP_PKEY_verify 3 ,
-.Xr EVP_PKEY_verify_recover 3
+.Xr EVP_PKEY_verify_recover 3 ,
+.Xr RSA_pkey_ctx_ctrl 3
 .Sh HISTORY
 The functions
 .Fn EVP_PKEY_CTX_ctrl ,
 .Fn EVP_PKEY_CTX_ctrl_str ,
 .Fn EVP_PKEY_CTX_set_signature_md ,
-.Fn EVP_PKEY_CTX_set_rsa_padding ,
-.Fn EVP_PKEY_CTX_set_rsa_pss_saltlen ,
-.Fn EVP_PKEY_CTX_set_rsa_keygen_bits ,
-.Fn EVP_PKEY_CTX_set_rsa_keygen_pubexp ,
 .Fn EVP_PKEY_CTX_set_dsa_paramgen_bits ,
 .Fn EVP_PKEY_CTX_set_dh_paramgen_prime_len ,
 .Fn EVP_PKEY_CTX_set_dh_paramgen_generator ,
@@ -671,15 +437,6 @@ first appeared in OpenSSL 1.0.0 and have been available since
 .Ox 4.9 .
 .Pp
 The functions
-.Fn EVP_PKEY_CTX_get_rsa_padding ,
-.Fn EVP_PKEY_CTX_get_rsa_pss_saltlen ,
-.Fn EVP_PKEY_CTX_set_rsa_mgf1_md ,
-and
-.Fn EVP_PKEY_CTX_get_rsa_mgf1_md
-first appeared in OpenSSL 1.0.1 and have been available since
-.Ox 5.3 .
-.Pp
-The functions
 .Fn EVP_PKEY_CTX_get_signature_md ,
 .Fn EVP_PKEY_CTX_set_ec_param_enc ,
 .Fn EVP_PKEY_CTX_set_ecdh_cofactor_mode ,
@@ -703,17 +460,3 @@ and
 .Fn EVP_PKEY_CTX_get1_id_len
 first appeared in OpenSSL 1.1.1 and have been available since
 .Ox 6.6 .
-.Pp
-The functions
-.Fn EVP_PKEY_CTX_set_rsa_oaep_md ,
-.Fn EVP_PKEY_CTX_get_rsa_oaep_md ,
-.Fn EVP_PKEY_CTX_set0_rsa_oaep_label ,
-and
-.Fn EVP_PKEY_CTX_get0_rsa_oaep_label
-first appeared in OpenSSL 1.0.2 and have been available since
-.Ox 6.7 .
-.Pp
-The function
-.Fn RSA_pkey_ctx_ctrl
-first appeared in OpenSSL 1.1.1 and has been available since
-.Ox 6.7 .