diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_PKEY_CTX_ctrl.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/EVP_PKEY_CTX_ctrl.3 | 430 |
1 files changed, 187 insertions, 243 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_PKEY_CTX_ctrl.3 b/secure/lib/libcrypto/man/man3/EVP_PKEY_CTX_ctrl.3 index 2d4cc4986a6e..e8bd5a41f279 100644 --- a/secure/lib/libcrypto/man/man3/EVP_PKEY_CTX_ctrl.3 +++ b/secure/lib/libcrypto/man/man3/EVP_PKEY_CTX_ctrl.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,75 +52,15 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_CTRL 3ossl" -.TH EVP_PKEY_CTX_CTRL 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH EVP_PKEY_CTX_CTRL 3ossl 2025-07-01 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME EVP_PKEY_CTX_ctrl, EVP_PKEY_CTX_ctrl_str, EVP_PKEY_CTX_ctrl_uint64, @@ -206,7 +130,7 @@ EVP_PKEY_CTX_get0_ecdh_kdf_ukm, EVP_PKEY_CTX_set1_id, EVP_PKEY_CTX_get1_id, EVP_PKEY_CTX_get1_id_len, EVP_PKEY_CTX_set_kem_op \&\- algorithm specific control operations -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/evp.h> @@ -313,7 +237,7 @@ EVP_PKEY_CTX_set_kem_op .Ve .PP The following functions have been deprecated since OpenSSL 3.0, and can be -hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, +hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value, see \fBopenssl_user_macros\fR\|(7): .PP .Vb 1 @@ -329,7 +253,7 @@ see \fBopenssl_user_macros\fR\|(7): \& \& int EVP_PKEY_CTX_get0_ecdh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char **ukm); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBEVP_PKEY_CTX_ctrl()\fR sends a control operation to the context \fIctx\fR. The key type used must match \fIkeytype\fR if it is not \-1. The parameter \fIoptype\fR is a @@ -337,8 +261,8 @@ mask indicating which operations the control can be applied to. The control command is indicated in \fIcmd\fR and any additional arguments in \&\fIp1\fR and \fIp2\fR. .PP -For \fIcmd\fR = \fB\s-1EVP_PKEY_CTRL_SET_MAC_KEY\s0\fR, \fIp1\fR is the length of the \s-1MAC\s0 key, -and \fIp2\fR is the \s-1MAC\s0 key. This is used by Poly1305, SipHash, \s-1HMAC\s0 and \s-1CMAC.\s0 +For \fIcmd\fR = \fBEVP_PKEY_CTRL_SET_MAC_KEY\fR, \fIp1\fR is the length of the MAC key, +and \fIp2\fR is the MAC key. This is used by Poly1305, SipHash, HMAC and CMAC. .PP Applications will not normally call \fBEVP_PKEY_CTX_ctrl()\fR directly but will instead call one of the algorithm specific functions below. @@ -357,10 +281,10 @@ command line pages for the option \fI\-pkeyopt\fR which is supported by the \&\fIctx\fR. The message digest is specified by its name \fImd\fR. .PP \&\fBEVP_PKEY_CTX_set_signature_md()\fR sets the message digest type used -in a signature. It can be used in the \s-1RSA, DSA\s0 and \s-1ECDSA\s0 algorithms. +in a signature. It can be used in the RSA, DSA and ECDSA algorithms. .PP \&\fBEVP_PKEY_CTX_get_signature_md()\fRgets the message digest type used -in a signature. It can be used in the \s-1RSA, DSA\s0 and \s-1ECDSA\s0 algorithms. +in a signature. It can be used in the RSA, DSA and ECDSA algorithms. .PP Key generation typically involves setting up parameters to be used and generating the private and public key data. Some algorithm implementations @@ -374,62 +298,68 @@ functions instead. the \fBEVP_PKEY_new_raw_private_key\fR\|(3) function. .PP \&\fBEVP_PKEY_CTX_set_group_name()\fR sets the group name to \fIname\fR for parameter and -key generation. For example for \s-1EC\s0 keys this will set the curve name and for -\&\s-1DH\s0 keys it will set the name of the finite field group. +key generation. For example for EC keys this will set the curve name and for +DH keys it will set the name of the finite field group. .PP \&\fBEVP_PKEY_CTX_get_group_name()\fR finds the group name that's currently set with \fIctx\fR, and writes it to the location that \fIname\fR points at, as long as its size \fInamelen\fR is large enough to store that name, including a -terminating \s-1NUL\s0 byte. -.SS "\s-1RSA\s0 parameters" +terminating NUL byte. +.SS "RSA parameters" .IX Subsection "RSA parameters" -\&\fBEVP_PKEY_CTX_set_rsa_padding()\fR sets the \s-1RSA\s0 padding mode for \fIctx\fR. -The \fIpad\fR parameter can take the value \fB\s-1RSA_PKCS1_PADDING\s0\fR for PKCS#1 -padding, \fB\s-1RSA_NO_PADDING\s0\fR for -no padding, \fB\s-1RSA_PKCS1_OAEP_PADDING\s0\fR for \s-1OAEP\s0 padding (encrypt and -decrypt only), \fB\s-1RSA_X931_PADDING\s0\fR for X9.31 padding (signature operations -only), \fB\s-1RSA_PKCS1_PSS_PADDING\s0\fR (sign and verify only) and -\&\fB\s-1RSA_PKCS1_WITH_TLS_PADDING\s0\fR for \s-1TLS RSA\s0 ClientKeyExchange message padding +\&\fBEVP_PKEY_CTX_set_rsa_padding()\fR sets the RSA padding mode for \fIctx\fR. +The \fIpad\fR parameter can take the value \fBRSA_PKCS1_PADDING\fR for PKCS#1 +padding, \fBRSA_NO_PADDING\fR for +no padding, \fBRSA_PKCS1_OAEP_PADDING\fR for OAEP padding (encrypt and +decrypt only), \fBRSA_X931_PADDING\fR for X9.31 padding (signature operations +only), \fBRSA_PKCS1_PSS_PADDING\fR (sign and verify only) and +\&\fBRSA_PKCS1_WITH_TLS_PADDING\fR for TLS RSA ClientKeyExchange message padding (decryption only). .PP -Two \s-1RSA\s0 padding modes behave differently if \fBEVP_PKEY_CTX_set_signature_md()\fR +Two RSA padding modes behave differently if \fBEVP_PKEY_CTX_set_signature_md()\fR is used. If this function is called for PKCS#1 padding the plaintext buffer is an actual digest value and is encapsulated in a 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 \s-1RSA\s0 and PKCS#1 padding then the +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 \s-1RSA\s0 the algorithm identifier byte is added or checked and removed +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 -\&\fBEVP_PKEY_CTX_get_rsa_padding()\fR gets the \s-1RSA\s0 padding mode for \fIctx\fR. +\&\fBEVP_PKEY_CTX_get_rsa_padding()\fR gets the RSA padding mode for \fIctx\fR. .PP -\&\fBEVP_PKEY_CTX_set_rsa_pss_saltlen()\fR sets the \s-1RSA PSS\s0 salt length to \fIsaltlen\fR. -As its name implies it is only supported for \s-1PSS\s0 padding. If this function is -not called then the maximum salt length is used when signing and auto detection -when verifying. Three special values are supported: -.IP "\fB\s-1RSA_PSS_SALTLEN_DIGEST\s0\fR" 4 +\&\fBEVP_PKEY_CTX_set_rsa_pss_saltlen()\fR sets the RSA PSS salt length to \fIsaltlen\fR. +As its name implies it is only supported for PSS padding. If this function is +not called then the salt length is maximized up to the digest length when +signing and auto detection when verifying. Four special values are supported: +.IP \fBRSA_PSS_SALTLEN_DIGEST\fR 4 .IX Item "RSA_PSS_SALTLEN_DIGEST" sets the salt length to the digest length. -.IP "\fB\s-1RSA_PSS_SALTLEN_MAX\s0\fR" 4 +.IP \fBRSA_PSS_SALTLEN_MAX\fR 4 .IX Item "RSA_PSS_SALTLEN_MAX" sets the salt length to the maximum permissible value. -.IP "\fB\s-1RSA_PSS_SALTLEN_AUTO\s0\fR" 4 +.IP \fBRSA_PSS_SALTLEN_AUTO\fR 4 .IX Item "RSA_PSS_SALTLEN_AUTO" causes the salt length to be automatically determined based on the -\&\fB\s-1PSS\s0\fR block structure when verifying. When signing, it has the same -meaning as \fB\s-1RSA_PSS_SALTLEN_MAX\s0\fR. -.PP -\&\fBEVP_PKEY_CTX_get_rsa_pss_saltlen()\fR gets the \s-1RSA PSS\s0 salt length for \fIctx\fR. -The padding mode must already have been set to \fB\s-1RSA_PKCS1_PSS_PADDING\s0\fR. -.PP -\&\fBEVP_PKEY_CTX_set_rsa_keygen_bits()\fR sets the \s-1RSA\s0 key length for -\&\s-1RSA\s0 key generation to \fIbits\fR. If not specified 2048 bits is used. -.PP -\&\fBEVP_PKEY_CTX_set1_rsa_keygen_pubexp()\fR sets the public exponent value for \s-1RSA\s0 key +\&\fBPSS\fR block structure when verifying. When signing, it has the same +meaning as \fBRSA_PSS_SALTLEN_MAX\fR. +.IP \fBRSA_PSS_SALTLEN_AUTO_DIGEST_MAX\fR 4 +.IX Item "RSA_PSS_SALTLEN_AUTO_DIGEST_MAX" +causes the salt length to be automatically determined based on the \fBPSS\fR block +structure when verifying, like \fBRSA_PSS_SALTLEN_AUTO\fR. When signing, the salt +length is maximized up to a maximum of the digest length to comply with FIPS +186\-4 section 5.5. +.PP +\&\fBEVP_PKEY_CTX_get_rsa_pss_saltlen()\fR gets the RSA PSS salt length for \fIctx\fR. +The padding mode must already have been set to \fBRSA_PKCS1_PSS_PADDING\fR. +.PP +\&\fBEVP_PKEY_CTX_set_rsa_keygen_bits()\fR sets the RSA key length for +RSA key generation to \fIbits\fR. If not specified 2048 bits is used. +.PP +\&\fBEVP_PKEY_CTX_set1_rsa_keygen_pubexp()\fR sets the public exponent value for RSA key generation to the value stored in \fIpubexp\fR. Currently it should be an odd integer. In accordance with the OpenSSL naming convention, the \fIpubexp\fR pointer -must be freed independently of the \s-1EVP_PKEY_CTX\s0 (ie, it is internally copied). +must be freed independently of the EVP_PKEY_CTX (ie, it is internally copied). If not specified 65537 is used. .PP \&\fBEVP_PKEY_CTX_set_rsa_keygen_pubexp()\fR does the same as @@ -437,36 +367,36 @@ If not specified 65537 is used. therefore \fIpubexp\fR should not be modified or freed after the call. .PP \&\fBEVP_PKEY_CTX_set_rsa_keygen_primes()\fR sets the number of primes for -\&\s-1RSA\s0 key generation to \fIprimes\fR. If not specified 2 is used. +RSA key generation to \fIprimes\fR. If not specified 2 is used. .PP -\&\fBEVP_PKEY_CTX_set_rsa_mgf1_md_name()\fR sets the \s-1MGF1\s0 digest for \s-1RSA\s0 -padding schemes to the digest named \fImdname\fR. If the \s-1RSA\s0 algorithm +\&\fBEVP_PKEY_CTX_set_rsa_mgf1_md_name()\fR sets the MGF1 digest for RSA +padding schemes to the digest named \fImdname\fR. If the RSA algorithm implementation for the selected provider supports it then the digest will be fetched using the properties \fImdprops\fR. If not explicitly set the signing -digest is used. The padding mode must have been set to \fB\s-1RSA_PKCS1_OAEP_PADDING\s0\fR -or \fB\s-1RSA_PKCS1_PSS_PADDING\s0\fR. +digest is used. The padding mode must have been set to \fBRSA_PKCS1_OAEP_PADDING\fR +or \fBRSA_PKCS1_PSS_PADDING\fR. .PP \&\fBEVP_PKEY_CTX_set_rsa_mgf1_md()\fR does the same as \&\fBEVP_PKEY_CTX_set_rsa_mgf1_md_name()\fR except that the name of the digest is inferred from the supplied \fImd\fR and it is not possible to specify any properties. .PP -\&\fBEVP_PKEY_CTX_get_rsa_mgf1_md_name()\fR gets the name of the \s-1MGF1\s0 +\&\fBEVP_PKEY_CTX_get_rsa_mgf1_md_name()\fR gets the name of the MGF1 digest algorithm for \fIctx\fR. If not explicitly set the signing digest is used. -The padding mode must have been set to \fB\s-1RSA_PKCS1_OAEP_PADDING\s0\fR or -\&\fB\s-1RSA_PKCS1_PSS_PADDING\s0\fR. +The padding mode must have been set to \fBRSA_PKCS1_OAEP_PADDING\fR or +\&\fBRSA_PKCS1_PSS_PADDING\fR. .PP \&\fBEVP_PKEY_CTX_get_rsa_mgf1_md()\fR does the same as \&\fBEVP_PKEY_CTX_get_rsa_mgf1_md_name()\fR except that it returns a pointer to an -\&\s-1EVP_MD\s0 object instead. Note that only known, built-in \s-1EVP_MD\s0 objects will be -returned. The \s-1EVP_MD\s0 object may be \s-1NULL\s0 if the digest is not one of these (such +EVP_MD object instead. Note that only known, built-in EVP_MD objects will be +returned. The EVP_MD object may be NULL if the digest is not one of these (such as a digest only implemented in a third party provider). .PP \&\fBEVP_PKEY_CTX_set_rsa_oaep_md_name()\fR sets the message digest type -used in \s-1RSA OAEP\s0 to the digest named \fImdname\fR. If the \s-1RSA\s0 algorithm +used in RSA OAEP to the digest named \fImdname\fR. If the RSA algorithm implementation for the selected provider supports it then the digest will be fetched using the properties \fImdprops\fR. The padding mode must have been set to -\&\fB\s-1RSA_PKCS1_OAEP_PADDING\s0\fR. +\&\fBRSA_PKCS1_OAEP_PADDING\fR. .PP \&\fBEVP_PKEY_CTX_set_rsa_oaep_md()\fR does the same as \&\fBEVP_PKEY_CTX_set_rsa_oaep_md_name()\fR except that the name of the digest is @@ -474,65 +404,75 @@ inferred from the supplied \fImd\fR and it is not possible to specify any properties. .PP \&\fBEVP_PKEY_CTX_get_rsa_oaep_md_name()\fR gets the message digest -algorithm name used in \s-1RSA OAEP\s0 and stores it in the buffer \fIname\fR which is of +algorithm name used in RSA OAEP and stores it in the buffer \fIname\fR which is of size \fInamelen\fR. The padding mode must have been set to -\&\fB\s-1RSA_PKCS1_OAEP_PADDING\s0\fR. The buffer should be sufficiently large for any +\&\fBRSA_PKCS1_OAEP_PADDING\fR. The buffer should be sufficiently large for any expected digest algorithm names or the function will fail. .PP \&\fBEVP_PKEY_CTX_get_rsa_oaep_md()\fR does the same as \&\fBEVP_PKEY_CTX_get_rsa_oaep_md_name()\fR except that it returns a pointer to an -\&\s-1EVP_MD\s0 object instead. Note that only known, built-in \s-1EVP_MD\s0 objects will be -returned. The \s-1EVP_MD\s0 object may be \s-1NULL\s0 if the digest is not one of these (such +EVP_MD object instead. Note that only known, built-in EVP_MD objects will be +returned. The EVP_MD object may be NULL if the digest is not one of these (such as a digest only implemented in a third party provider). .PP -\&\fBEVP_PKEY_CTX_set0_rsa_oaep_label()\fR sets the \s-1RSA OAEP\s0 label to binary data -\&\fIlabel\fR and its length in bytes to \fIlen\fR. If \fIlabel\fR is \s-1NULL\s0 or \fIlen\fR is 0, +\&\fBEVP_PKEY_CTX_set0_rsa_oaep_label()\fR sets the RSA OAEP label to binary data +\&\fIlabel\fR and its length in bytes to \fIlen\fR. If \fIlabel\fR is NULL or \fIlen\fR 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 \fIlabel\fR. -The padding mode must have been set to \fB\s-1RSA_PKCS1_OAEP_PADDING\s0\fR. +The padding mode must have been set to \fBRSA_PKCS1_OAEP_PADDING\fR. .PP -\&\fBEVP_PKEY_CTX_get0_rsa_oaep_label()\fR gets the \s-1RSA OAEP\s0 label to +\&\fBEVP_PKEY_CTX_get0_rsa_oaep_label()\fR gets the RSA OAEP label to \&\fIlabel\fR. The return value is the label length. The padding mode -must have been set to \fB\s-1RSA_PKCS1_OAEP_PADDING\s0\fR. The resulting pointer is owned +must have been set to \fBRSA_PKCS1_OAEP_PADDING\fR. The resulting pointer is owned by the library and should not be freed by the caller. .PP -\&\fB\s-1RSA_PKCS1_WITH_TLS_PADDING\s0\fR is used when decrypting an \s-1RSA\s0 encrypted \s-1TLS\s0 -pre-master secret in a \s-1TLS\s0 ClientKeyExchange message. It is the same as -\&\s-1RSA_PKCS1_PADDING\s0 except that it additionally verifies that the result is the +\&\fBRSA_PKCS1_WITH_TLS_PADDING\fR is used when decrypting an RSA encrypted TLS +pre-master secret in a TLS ClientKeyExchange message. It is the same as +RSA_PKCS1_PADDING except that it additionally verifies that the result is the correct length and the first two bytes are the protocol version initially requested by the client. If the encrypted content is publicly invalid then the decryption will fail. However, if the padding checks fail then decryption will -still appear to succeed but a random \s-1TLS\s0 premaster secret will be returned +still appear to succeed but a random TLS premaster secret will be returned instead. This padding mode accepts two parameters which can be set using the \&\fBEVP_PKEY_CTX_set_params\fR\|(3) function. These are -\&\s-1OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION\s0 and -\&\s-1OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION,\s0 both of which are expected to be +OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION and +OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION, both of which are expected to be unsigned integers. Normally only the first of these will be set and represents -the \s-1TLS\s0 protocol version that was first requested by the client (e.g. 0x0303 for +the TLS protocol version that was first requested by the client (e.g. 0x0303 for TLSv1.2, 0x0302 for TLSv1.1 etc). Historically some buggy clients would use the negotiated protocol version instead of the protocol version first requested. If this behaviour should be tolerated then -\&\s-1OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION\s0 should be set to the actual +OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION should be set to the actual negotiated protocol version. Otherwise it should be left unset. -.SS "\s-1DSA\s0 parameters" +.PP +Similarly to the \fBRSA_PKCS1_WITH_TLS_PADDING\fR above, since OpenSSL version +3.2.0, the use of \fBRSA_PKCS1_PADDING\fR will return a randomly generated message +instead of padding errors in case padding checks fail. Applications that +want to remain secure while using earlier versions of OpenSSL, or a provider +that doesn't implement the implicit rejection mechanism, still need to +handle both the error code from the RSA decryption operation and the +returned message in a side channel secure manner. +This protection against Bleichenbacher attacks can be disabled by setting +\&\fBOSSL_ASYM_CIPHER_PARAM_IMPLICIT_REJECTION\fR (an unsigned integer) to 0. +.SS "DSA parameters" .IX Subsection "DSA parameters" -\&\fBEVP_PKEY_CTX_set_dsa_paramgen_bits()\fR sets the number of bits used for \s-1DSA\s0 +\&\fBEVP_PKEY_CTX_set_dsa_paramgen_bits()\fR sets the number of bits used for DSA parameter generation to \fBnbits\fR. If not specified, 2048 is used. .PP \&\fBEVP_PKEY_CTX_set_dsa_paramgen_q_bits()\fR sets the number of bits in the subprime -parameter \fIq\fR for \s-1DSA\s0 parameter generation to \fIqbits\fR. If not specified, 224 +parameter \fIq\fR for DSA parameter generation to \fIqbits\fR. If not specified, 224 is used. If a digest function is specified below, this parameter is ignored and instead, the number of bits in \fIq\fR matches the size of the digest. .PP -\&\fBEVP_PKEY_CTX_set_dsa_paramgen_md()\fR sets the digest function used for \s-1DSA\s0 -parameter generation to \fImd\fR. If not specified, one of \s-1SHA\-1, SHA\-224,\s0 or -\&\s-1SHA\-256\s0 is selected to match the bit length of \fIq\fR above. +\&\fBEVP_PKEY_CTX_set_dsa_paramgen_md()\fR sets the digest function used for DSA +parameter generation to \fImd\fR. If not specified, one of SHA\-1, SHA\-224, or +SHA\-256 is selected to match the bit length of \fIq\fR above. .PP -\&\fBEVP_PKEY_CTX_set_dsa_paramgen_md_props()\fR sets the digest function used for \s-1DSA\s0 +\&\fBEVP_PKEY_CTX_set_dsa_paramgen_md_props()\fR sets the digest function used for DSA parameter generation using \fImd_name\fR and \fImd_properties\fR to retrieve the digest from a provider. -If not specified, \fImd_name\fR will be set to one of \s-1SHA\-1, SHA\-224,\s0 or -\&\s-1SHA\-256\s0 depending on the bit length of \fIq\fR above. \fImd_properties\fR is a +If not specified, \fImd_name\fR will be set to one of SHA\-1, SHA\-224, or +SHA\-256 depending on the bit length of \fIq\fR above. \fImd_properties\fR is a property query string that has a default value of '' if not specified. .PP \&\fBEVP_PKEY_CTX_set_dsa_paramgen_gindex()\fR sets the \fIgindex\fR used by the generator @@ -546,44 +486,44 @@ testing purposes only and can fail if the seed does not produce primes for both p & q on its first iteration. This value must be saved if key validation of p, q, and verifiable g are required, since it is not part of a persisted key. .PP -\&\fBEVP_PKEY_CTX_set_dsa_paramgen_type()\fR sets the generation type to use \s-1FIPS186\-4\s0 -generation if \fIname\fR is \*(L"fips186_4\*(R", or \s-1FIPS186\-2\s0 generation if \fIname\fR is -\&\*(L"fips186_2\*(R". The default value for the default provider is \*(L"fips186_2\*(R". The -default value for the \s-1FIPS\s0 provider is \*(L"fips186_4\*(R". -.SS "\s-1DH\s0 parameters" +\&\fBEVP_PKEY_CTX_set_dsa_paramgen_type()\fR sets the generation type to use FIPS186\-4 +generation if \fIname\fR is "fips186_4", or FIPS186\-2 generation if \fIname\fR is +"fips186_2". The default value for the default provider is "fips186_2". The +default value for the FIPS provider is "fips186_4". +.SS "DH parameters" .IX Subsection "DH parameters" -\&\fBEVP_PKEY_CTX_set_dh_paramgen_prime_len()\fR sets the length of the \s-1DH\s0 prime -parameter \fIp\fR for \s-1DH\s0 parameter generation. If this function is not called then +\&\fBEVP_PKEY_CTX_set_dh_paramgen_prime_len()\fR sets the length of the DH prime +parameter \fIp\fR for DH parameter generation. If this function is not called then 2048 is used. Only accepts lengths greater than or equal to 256. .PP -\&\fBEVP_PKEY_CTX_set_dh_paramgen_subprime_len()\fR sets the length of the \s-1DH\s0 -optional subprime parameter \fIq\fR for \s-1DH\s0 parameter generation. The default is -256 if the prime is at least 2048 bits long or 160 otherwise. The \s-1DH\s0 paramgen -type must have been set to \*(L"fips186_4\*(R". +\&\fBEVP_PKEY_CTX_set_dh_paramgen_subprime_len()\fR sets the length of the DH +optional subprime parameter \fIq\fR for DH parameter generation. The default is +256 if the prime is at least 2048 bits long or 160 otherwise. The DH paramgen +type must have been set to "fips186_4". .PP -\&\fBEVP_PKEY_CTX_set_dh_paramgen_generator()\fR sets \s-1DH\s0 generator to \fIgen\fR for \s-1DH\s0 +\&\fBEVP_PKEY_CTX_set_dh_paramgen_generator()\fR sets DH generator to \fIgen\fR for DH parameter generation. If not specified 2 is used. .PP -\&\fBEVP_PKEY_CTX_set_dh_paramgen_type()\fR sets the key type for \s-1DH\s0 parameter +\&\fBEVP_PKEY_CTX_set_dh_paramgen_type()\fR sets the key type for DH parameter generation. The supported parameters are: -.IP "\fB\s-1DH_PARAMGEN_TYPE_GROUP\s0\fR" 4 +.IP \fBDH_PARAMGEN_TYPE_GROUP\fR 4 .IX Item "DH_PARAMGEN_TYPE_GROUP" Use a named group. If only the safe prime parameter \fIp\fR is set this can be used to select a ffdhe safe prime group of the correct size. -.IP "\fB\s-1DH_PARAMGEN_TYPE_FIPS_186_4\s0\fR" 4 +.IP \fBDH_PARAMGEN_TYPE_FIPS_186_4\fR 4 .IX Item "DH_PARAMGEN_TYPE_FIPS_186_4" -\&\s-1FIPS186\-4 FFC\s0 parameter generator. -.IP "\fB\s-1DH_PARAMGEN_TYPE_FIPS_186_2\s0\fR" 4 +FIPS186\-4 FFC parameter generator. +.IP \fBDH_PARAMGEN_TYPE_FIPS_186_2\fR 4 .IX Item "DH_PARAMGEN_TYPE_FIPS_186_2" -\&\s-1FIPS186\-2 FFC\s0 parameter generator (X9.42 \s-1DH\s0). -.IP "\fB\s-1DH_PARAMGEN_TYPE_GENERATOR\s0\fR" 4 +FIPS186\-2 FFC parameter generator (X9.42 DH). +.IP \fBDH_PARAMGEN_TYPE_GENERATOR\fR 4 .IX Item "DH_PARAMGEN_TYPE_GENERATOR" Uses a safe prime generator g (PKCS#3 format). .PP -The default in the default provider is \fB\s-1DH_PARAMGEN_TYPE_GENERATOR\s0\fR for the -\&\*(L"\s-1DH\*(R"\s0 keytype, and \fB\s-1DH_PARAMGEN_TYPE_FIPS_186_2\s0\fR for the \*(L"\s-1DHX\*(R"\s0 keytype. In the -\&\s-1FIPS\s0 provider the default value is \fB\s-1DH_PARAMGEN_TYPE_GROUP\s0\fR for the \*(L"\s-1DH\*(R"\s0 -keytype and <\fB\s-1DH_PARAMGEN_TYPE_FIPS_186_4\s0\fR for the \*(L"\s-1DHX\*(R"\s0 keytype. +The default in the default provider is \fBDH_PARAMGEN_TYPE_GENERATOR\fR for the +"DH" keytype, and \fBDH_PARAMGEN_TYPE_FIPS_186_2\fR for the "DHX" keytype. In the +FIPS provider the default value is \fBDH_PARAMGEN_TYPE_GROUP\fR for the "DH" +keytype and <\fBDH_PARAMGEN_TYPE_FIPS_186_4\fR for the "DHX" keytype. .PP \&\fBEVP_PKEY_CTX_set_dh_paramgen_gindex()\fR sets the \fIgindex\fR used by the generator G. The default value is \-1 which uses unverifiable g, otherwise a positive value @@ -596,13 +536,13 @@ testing purposes only and can fail if the seed does not produce primes for both p & q on its first iteration. This value must be saved if key validation of p, q, and verifiable g are required, since it is not part of a persisted key. .PP -\&\fBEVP_PKEY_CTX_set_dh_pad()\fR sets the \s-1DH\s0 padding mode. -If \fIpad\fR is 1 the shared secret is padded with zeros up to the size of the \s-1DH\s0 +\&\fBEVP_PKEY_CTX_set_dh_pad()\fR sets the DH padding mode. +If \fIpad\fR is 1 the shared secret is padded with zeros up to the size of the DH prime \fIp\fR. If \fIpad\fR is zero (the default) then no padding is performed. .PP -\&\fBEVP_PKEY_CTX_set_dh_nid()\fR sets the \s-1DH\s0 parameters to values corresponding to -\&\fInid\fR as defined in \s-1RFC7919\s0 or \s-1RFC3526.\s0 The \fInid\fR parameter must be +\&\fBEVP_PKEY_CTX_set_dh_nid()\fR sets the DH parameters to values corresponding to +\&\fInid\fR as defined in RFC7919 or RFC3526. The \fInid\fR parameter must be \&\fBNID_ffdhe2048\fR, \fBNID_ffdhe3072\fR, \fBNID_ffdhe4096\fR, \fBNID_ffdhe6144\fR, \&\fBNID_ffdhe8192\fR, \fBNID_modp_1536\fR, \fBNID_modp_2048\fR, \fBNID_modp_3072\fR, \&\fBNID_modp_4096\fR, \fBNID_modp_6144\fR, \fBNID_modp_8192\fR or \fBNID_undef\fR to clear @@ -610,55 +550,55 @@ the stored value. This function can be called during parameter or key generation The nid parameter and the rfc5114 parameter are mutually exclusive. .PP \&\fBEVP_PKEY_CTX_set_dh_rfc5114()\fR and \fBEVP_PKEY_CTX_set_dhx_rfc5114()\fR both set the -\&\s-1DH\s0 parameters to the values defined in \s-1RFC5114.\s0 The \fIrfc5114\fR parameter must -be 1, 2 or 3 corresponding to \s-1RFC5114\s0 sections 2.1, 2.2 and 2.3. or 0 to clear +DH parameters to the values defined in RFC5114. The \fIrfc5114\fR parameter must +be 1, 2 or 3 corresponding to RFC5114 sections 2.1, 2.2 and 2.3. or 0 to clear the stored value. This macro can be called during parameter generation. The -\&\fIctx\fR must have a key type of \fB\s-1EVP_PKEY_DHX\s0\fR. +\&\fIctx\fR must have a key type of \fBEVP_PKEY_DHX\fR. The rfc5114 parameter and the nid parameter are mutually exclusive. -.SS "\s-1DH\s0 key derivation function parameters" +.SS "DH key derivation function parameters" .IX Subsection "DH key derivation function parameters" Note that all of the following functions require that the \fIctx\fR parameter has -a private key type of \fB\s-1EVP_PKEY_DHX\s0\fR. When using key derivation, the output of -\&\fBEVP_PKEY_derive()\fR is the output of the \s-1KDF\s0 instead of the \s-1DH\s0 shared secret. -The \s-1KDF\s0 output is typically used as a Key Encryption Key (\s-1KEK\s0) that in turn -encrypts a Content Encryption Key (\s-1CEK\s0). +a private key type of \fBEVP_PKEY_DHX\fR. When using key derivation, the output of +\&\fBEVP_PKEY_derive()\fR is the output of the KDF instead of the DH shared secret. +The KDF output is typically used as a Key Encryption Key (KEK) that in turn +encrypts a Content Encryption Key (CEK). .PP \&\fBEVP_PKEY_CTX_set_dh_kdf_type()\fR sets the key derivation function type to \fIkdf\fR -for \s-1DH\s0 key derivation. Possible values are \fB\s-1EVP_PKEY_DH_KDF_NONE\s0\fR and -\&\fB\s-1EVP_PKEY_DH_KDF_X9_42\s0\fR which uses the key derivation specified in \s-1RFC2631\s0 +for DH key derivation. Possible values are \fBEVP_PKEY_DH_KDF_NONE\fR and +\&\fBEVP_PKEY_DH_KDF_X9_42\fR which uses the key derivation specified in RFC2631 (based on the keying algorithm described in X9.42). When using key derivation, the \fIkdf_oid\fR, \fIkdf_md\fR and \fIkdf_outlen\fR parameters must also be specified. .PP \&\fBEVP_PKEY_CTX_get_dh_kdf_type()\fR gets the key derivation function type for \fIctx\fR -used for \s-1DH\s0 key derivation. Possible values are \fB\s-1EVP_PKEY_DH_KDF_NONE\s0\fR and -\&\fB\s-1EVP_PKEY_DH_KDF_X9_42\s0\fR. +used for DH key derivation. Possible values are \fBEVP_PKEY_DH_KDF_NONE\fR and +\&\fBEVP_PKEY_DH_KDF_X9_42\fR. .PP \&\fBEVP_PKEY_CTX_set0_dh_kdf_oid()\fR sets the key derivation function object -identifier to \fIoid\fR for \s-1DH\s0 key derivation. This \s-1OID\s0 should identify the +identifier to \fIoid\fR for DH key derivation. This OID should identify the algorithm to be used with the Content Encryption Key. The library takes ownership of the object identifier so the caller should not free the original memory pointed to by \fIoid\fR. .PP \&\fBEVP_PKEY_CTX_get0_dh_kdf_oid()\fR gets the key derivation function oid for \fIctx\fR -used for \s-1DH\s0 key derivation. The resulting pointer is owned by the library and +used for DH key derivation. The resulting pointer is owned by the library and should not be freed by the caller. .PP \&\fBEVP_PKEY_CTX_set_dh_kdf_md()\fR sets the key derivation function message digest to -\&\fImd\fR for \s-1DH\s0 key derivation. Note that \s-1RFC2631\s0 specifies that this digest should -be \s-1SHA1\s0 but OpenSSL tolerates other digests. +\&\fImd\fR for DH key derivation. Note that RFC2631 specifies that this digest should +be SHA1 but OpenSSL tolerates other digests. .PP \&\fBEVP_PKEY_CTX_get_dh_kdf_md()\fR gets the key derivation function message digest for -\&\fIctx\fR used for \s-1DH\s0 key derivation. +\&\fIctx\fR used for DH key derivation. .PP \&\fBEVP_PKEY_CTX_set_dh_kdf_outlen()\fR sets the key derivation function output length -to \fIlen\fR for \s-1DH\s0 key derivation. +to \fIlen\fR for DH key derivation. .PP \&\fBEVP_PKEY_CTX_get_dh_kdf_outlen()\fR gets the key derivation function output length -for \fIctx\fR used for \s-1DH\s0 key derivation. +for \fIctx\fR used for DH key derivation. .PP \&\fBEVP_PKEY_CTX_set0_dh_kdf_ukm()\fR sets the user key material to \fIukm\fR and its -length to \fIlen\fR for \s-1DH\s0 key derivation. This parameter is optional and -corresponds to the partyAInfo field in \s-1RFC2631\s0 terms. The specification +length to \fIlen\fR for DH key derivation. This parameter is optional and +corresponds to the partyAInfo field in RFC2631 terms. The specification requires that it is 512 bits long but this is not enforced by OpenSSL. The library takes ownership of the user key material so the caller should not free the original memory pointed to by \fIukm\fR. @@ -666,67 +606,67 @@ free the original memory pointed to by \fIukm\fR. \&\fBEVP_PKEY_CTX_get0_dh_kdf_ukm()\fR gets the user key material for \fIctx\fR. The return value is the user key material length. The resulting pointer is owned by the library and should not be freed by the caller. -.SS "\s-1EC\s0 parameters" +.SS "EC parameters" .IX Subsection "EC parameters" Use \fBEVP_PKEY_CTX_set_group_name()\fR (described above) to set the curve name to \&\fIname\fR for parameter and key generation. .PP \&\fBEVP_PKEY_CTX_set_ec_paramgen_curve_nid()\fR does the same as -\&\fBEVP_PKEY_CTX_set_group_name()\fR, but is specific to \s-1EC\s0 and uses a \fInid\fR rather +\&\fBEVP_PKEY_CTX_set_group_name()\fR, but is specific to EC and uses a \fInid\fR rather than a name string. .PP -For \s-1EC\s0 parameter generation, one of \fBEVP_PKEY_CTX_set_group_name()\fR +For EC parameter generation, one of \fBEVP_PKEY_CTX_set_group_name()\fR or \fBEVP_PKEY_CTX_set_ec_paramgen_curve_nid()\fR must be called or an error occurs because there is no default curve. These function can also be called to set the curve explicitly when -generating an \s-1EC\s0 key. +generating an EC key. .PP \&\fBEVP_PKEY_CTX_get_group_name()\fR (described above) can be used to obtain the curve name that's currently set with \fIctx\fR. .PP -\&\fBEVP_PKEY_CTX_set_ec_param_enc()\fR sets the \s-1EC\s0 parameter encoding to \fIparam_enc\fR -when generating \s-1EC\s0 parameters or an \s-1EC\s0 key. The encoding can be -\&\fB\s-1OPENSSL_EC_EXPLICIT_CURVE\s0\fR for explicit parameters (the default in versions -of OpenSSL before 1.1.0) or \fB\s-1OPENSSL_EC_NAMED_CURVE\s0\fR to use named curve form. +\&\fBEVP_PKEY_CTX_set_ec_param_enc()\fR sets the EC parameter encoding to \fIparam_enc\fR +when generating EC parameters or an EC key. The encoding can be +\&\fBOPENSSL_EC_EXPLICIT_CURVE\fR for explicit parameters (the default in versions +of OpenSSL before 1.1.0) or \fBOPENSSL_EC_NAMED_CURVE\fR to use named curve form. For maximum compatibility the named curve form should be used. Note: the -\&\fB\s-1OPENSSL_EC_NAMED_CURVE\s0\fR value was added in OpenSSL 1.1.0; previous +\&\fBOPENSSL_EC_NAMED_CURVE\fR value was added in OpenSSL 1.1.0; previous versions should use 0 instead. -.SS "\s-1ECDH\s0 parameters" +.SS "ECDH parameters" .IX Subsection "ECDH parameters" \&\fBEVP_PKEY_CTX_set_ecdh_cofactor_mode()\fR sets the cofactor mode to \fIcofactor_mode\fR -for \s-1ECDH\s0 key derivation. Possible values are 1 to enable cofactor +for ECDH key derivation. Possible values are 1 to enable cofactor key derivation, 0 to disable it and \-1 to clear the stored cofactor mode and fallback to the private key cofactor mode. .PP \&\fBEVP_PKEY_CTX_get_ecdh_cofactor_mode()\fR returns the cofactor mode for \fIctx\fR used -for \s-1ECDH\s0 key derivation. Possible values are 1 when cofactor key derivation is +for ECDH key derivation. Possible values are 1 when cofactor key derivation is enabled and 0 otherwise. -.SS "\s-1ECDH\s0 key derivation function parameters" +.SS "ECDH key derivation function parameters" .IX Subsection "ECDH key derivation function parameters" \&\fBEVP_PKEY_CTX_set_ecdh_kdf_type()\fR sets the key derivation function type to -\&\fIkdf\fR for \s-1ECDH\s0 key derivation. Possible values are \fB\s-1EVP_PKEY_ECDH_KDF_NONE\s0\fR -and \fB\s-1EVP_PKEY_ECDH_KDF_X9_63\s0\fR which uses the key derivation specified in X9.63. +\&\fIkdf\fR for ECDH key derivation. Possible values are \fBEVP_PKEY_ECDH_KDF_NONE\fR +and \fBEVP_PKEY_ECDH_KDF_X9_63\fR which uses the key derivation specified in X9.63. When using key derivation, the \fIkdf_md\fR and \fIkdf_outlen\fR parameters must also be specified. .PP \&\fBEVP_PKEY_CTX_get_ecdh_kdf_type()\fR returns the key derivation function type for -\&\fIctx\fR used for \s-1ECDH\s0 key derivation. Possible values are -\&\fB\s-1EVP_PKEY_ECDH_KDF_NONE\s0\fR and \fB\s-1EVP_PKEY_ECDH_KDF_X9_63\s0\fR. +\&\fIctx\fR used for ECDH key derivation. Possible values are +\&\fBEVP_PKEY_ECDH_KDF_NONE\fR and \fBEVP_PKEY_ECDH_KDF_X9_63\fR. .PP \&\fBEVP_PKEY_CTX_set_ecdh_kdf_md()\fR sets the key derivation function message digest -to \fImd\fR for \s-1ECDH\s0 key derivation. Note that X9.63 specifies that this digest -should be \s-1SHA1\s0 but OpenSSL tolerates other digests. +to \fImd\fR for ECDH key derivation. Note that X9.63 specifies that this digest +should be SHA1 but OpenSSL tolerates other digests. .PP \&\fBEVP_PKEY_CTX_get_ecdh_kdf_md()\fR gets the key derivation function message digest -for \fIctx\fR used for \s-1ECDH\s0 key derivation. +for \fIctx\fR used for ECDH key derivation. .PP \&\fBEVP_PKEY_CTX_set_ecdh_kdf_outlen()\fR sets the key derivation function output -length to \fIlen\fR for \s-1ECDH\s0 key derivation. +length to \fIlen\fR for ECDH key derivation. .PP \&\fBEVP_PKEY_CTX_get_ecdh_kdf_outlen()\fR gets the key derivation function output -length for \fIctx\fR used for \s-1ECDH\s0 key derivation. +length for \fIctx\fR used for ECDH key derivation. .PP -\&\fBEVP_PKEY_CTX_set0_ecdh_kdf_ukm()\fR sets the user key material to \fIukm\fR for \s-1ECDH\s0 +\&\fBEVP_PKEY_CTX_set0_ecdh_kdf_ukm()\fR sets the user key material to \fIukm\fR for ECDH key derivation. This parameter is optional and corresponds to the shared info in X9.63 terms. The library takes ownership of the user key material so the caller should not free the original memory pointed to by \fIukm\fR. @@ -738,20 +678,24 @@ by the library and should not be freed by the caller. .IX Subsection "Other parameters" \&\fBEVP_PKEY_CTX_set1_id()\fR, \fBEVP_PKEY_CTX_get1_id()\fR and \fBEVP_PKEY_CTX_get1_id_len()\fR are used to manipulate the special identifier field for specific signature -algorithms such as \s-1SM2.\s0 The \fBEVP_PKEY_CTX_set1_id()\fR sets an \s-1ID\s0 pointed by \fIid\fR with +algorithms such as SM2. The \fBEVP_PKEY_CTX_set1_id()\fR sets an ID pointed by \fIid\fR with the length \fIid_len\fR to the library. The library takes a copy of the id so that the caller can safely free the original memory pointed to by \fIid\fR. -\&\fBEVP_PKEY_CTX_get1_id_len()\fR returns the length of the \s-1ID\s0 set via a previous call +\&\fBEVP_PKEY_CTX_get1_id_len()\fR returns the length of the ID set via a previous call to \fBEVP_PKEY_CTX_set1_id()\fR. The length is usually used to allocate adequate memory for further calls to \fBEVP_PKEY_CTX_get1_id()\fR. \fBEVP_PKEY_CTX_get1_id()\fR -returns the previously set \s-1ID\s0 value to caller in \fIid\fR. The caller should +returns the previously set ID value to caller in \fIid\fR. The caller should allocate adequate memory space for the \fIid\fR before calling \fBEVP_PKEY_CTX_get1_id()\fR. .PP -\&\fBEVP_PKEY_CTX_set_kem_op()\fR sets the \s-1KEM\s0 operation to run. This can be set after -\&\fBEVP_PKEY_encapsulate_init()\fR or \fBEVP_PKEY_decapsulate_init()\fR to select the -kem operation. \s-1RSA\s0 is the only key type that supports encapsulation currently, -and as there is no default operation for the \s-1RSA\s0 type, this function must be -called before \fBEVP_PKEY_encapsulate()\fR or \fBEVP_PKEY_decapsulate()\fR. +\&\fBEVP_PKEY_CTX_set_kem_op()\fR sets the KEM operation to run. This can be set after +\&\fBEVP_PKEY_encapsulate_init()\fR or \fBEVP_PKEY_decapsulate_init()\fR to select the kem +operation. For the key types that support encapsulation and don't have the +default operation, e.g. RSA, this function must be called before +\&\fBEVP_PKEY_encapsulate()\fR or \fBEVP_PKEY_decapsulate()\fR. +.PP +The supported parameters for the built-in algorithms are documented in +\&\fBEVP_KEM\-RSA\fR\|(7), \fBEVP_KEM\-EC\fR\|(7), \fBEVP_KEM\-X25519\fR\|(7), +\&\fBEVP_KEM\-X448\fR\|(7), and \fBEVP_KEM\-ML\-KEM\fR\|(7). .SH "RETURN VALUES" .IX Header "RETURN VALUES" All other functions described on this page return a positive value for success @@ -770,7 +714,7 @@ indicates the operation is not supported by the public key algorithm. \&\fBEVP_PKEY_keygen\fR\|(3) \&\fBEVP_PKEY_encapsulate\fR\|(3) \&\fBEVP_PKEY_decapsulate\fR\|(3) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" \&\fBEVP_PKEY_CTX_get_rsa_oaep_md_name()\fR, \fBEVP_PKEY_CTX_get_rsa_mgf1_md_name()\fR, \&\fBEVP_PKEY_CTX_set_rsa_mgf1_md_name()\fR, \fBEVP_PKEY_CTX_set_rsa_oaep_md_name()\fR, @@ -788,11 +732,11 @@ From OpenSSL 3.0 they are all functions. .PP \&\fBEVP_PKEY_CTX_set_rsa_keygen_pubexp()\fR, \fBEVP_PKEY_CTX_get0_dh_kdf_ukm()\fR, and \fBEVP_PKEY_CTX_get0_ecdh_kdf_ukm()\fR were deprecated in OpenSSL 3.0. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2006\-2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2006\-2025 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |