diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3 | 180 |
1 files changed, 69 insertions, 111 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3 b/secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3 index 8d7aedb791ae..bdd9c97c523f 100644 --- a/secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3 +++ b/secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.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,88 +52,30 @@ . \} .\} .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_ENCAPSULATE 3ossl" -.TH EVP_PKEY_ENCAPSULATE 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH EVP_PKEY_ENCAPSULATE 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" -EVP_PKEY_encapsulate_init, EVP_PKEY_encapsulate +.SH NAME +EVP_PKEY_encapsulate_init, EVP_PKEY_auth_encapsulate_init, EVP_PKEY_encapsulate \&\- Key encapsulation using a KEM algorithm with a public key -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/evp.h> \& \& int EVP_PKEY_encapsulate_init(EVP_PKEY_CTX *ctx, const OSSL_PARAM params[]); +\& int EVP_PKEY_auth_encapsulate_init(EVP_PKEY_CTX *ctx, EVP_PKEY *authpriv, +\& const OSSL_PARAM params[]); \& int EVP_PKEY_encapsulate(EVP_PKEY_CTX *ctx, \& unsigned char *wrappedkey, size_t *wrappedkeylen, \& unsigned char *genkey, size_t *genkeylen); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" The \fBEVP_PKEY_encapsulate_init()\fR function initializes a public key algorithm context \fIctx\fR for an encapsulation operation and then sets the \fIparams\fR @@ -157,32 +83,55 @@ on the context in the same way as calling \fBEVP_PKEY_CTX_set_params\fR\|(3). Note that \fIctx\fR is usually is produced using \fBEVP_PKEY_CTX_new_from_pkey\fR\|(3), specifying the public key to use. .PP +The \fBEVP_PKEY_auth_encapsulate_init()\fR function is similar to +\&\fBEVP_PKEY_encapsulate_init()\fR but also passes an \fIauthpriv\fR authentication private +key that is used during encapsulation. +.PP The \fBEVP_PKEY_encapsulate()\fR function performs a public key encapsulation operation using \fIctx\fR. -The symmetric secret generated in \fIgenkey\fR can be used as key material. -The ciphertext in \fIwrappedkey\fR is its encapsulated form, which can be sent -to another party, who can use \fBEVP_PKEY_decapsulate\fR\|(3) to retrieve it -using their private key. -If \fIwrappedkey\fR is \s-1NULL\s0 then the maximum size of the output buffer -is written to the \fI*wrappedkeylen\fR parameter unless \fIwrappedkeylen\fR is \s-1NULL\s0 -and the maximum size of the generated key buffer is written to \fI*genkeylen\fR -unless \fIgenkeylen\fR is \s-1NULL.\s0 -If \fIwrappedkey\fR is not \s-1NULL\s0 and the call is successful then the -internally generated key is written to \fIgenkey\fR and its size is written to -\&\fI*genkeylen\fR. The encapsulated version of the generated key is written to -\&\fIwrappedkey\fR and its size is written to \fI*wrappedkeylen\fR. -.SH "NOTES" +The shared secret written to \fIgenkey\fR can be used as an input for key +derivation, typically for various symmetric algorithms. +Its size is written to \fIgenkeylen\fR, which must be initialised to the +size of the provided buffer. +.PP +The ciphertext written to \fIwrappedkey\fR is an encapsulated form, which +is expected to be only usable by the holder of the private key corresponding +to the public key associated with \fIctx\fR. +This ciphertext is then communicated to the private-key holder, who can use +\&\fBEVP_PKEY_decapsulate\fR\|(3) to securely recover the same shared secret. +.PP +If \fIwrappedkey\fR is NULL then the maximum size of the output buffer is written +to the \fI*wrappedkeylen\fR parameter unless \fIwrappedkeylen\fR is NULL and the +maximum size of the generated key buffer is written to \fI*genkeylen\fR unless +\&\fIgenkeylen\fR is NULL. +.PP +If \fIwrappedkey\fR is not NULL and the call is successful then the generated +shared secret is written to \fIgenkey\fR and its size is written to +\&\fI*genkeylen\fR (which must be non-NULL). +The encapsulated ciphertext is written to \fIwrappedkey\fR and +its size is written to \fI*wrappedkeylen\fR (must also be non-NULL), +The value pointed to by \fIwrappedlen\fR initially hold the size of the +\&\fIunwrapped\fR buffer so that its size can be validated by the call, ensuring it +is large enough to hold the result written to \fIwrapped\fR. +.PP +Absent detailed prior knowledge of the internals of the specific KEM +algorithm, callers SHOULD NOT assume that the returned shared secret and +ciphertext are necessarily of the maximum possible length. +The lengths returned via \fI*wrappedkeylen\fR and \fI*genkeylen\fR SHOULD +be used to determine the actual lengths of the outputs. +.SH NOTES .IX Header "NOTES" -After the call to \fBEVP_PKEY_encapsulate_init()\fR algorithm-specific parameters +After the call to \fBEVP_PKEY_encapsulate_init()\fR, algorithm-specific parameters for the operation may be set or modified using \fBEVP_PKEY_CTX_set_params\fR\|(3). .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fBEVP_PKEY_encapsulate_init()\fR and \fBEVP_PKEY_encapsulate()\fR return 1 for -success and 0 or a negative value for failure. In particular a return value of \-2 -indicates the operation is not supported by the public key algorithm. -.SH "EXAMPLES" +\&\fBEVP_PKEY_encapsulate_init()\fR, \fBEVP_PKEY_auth_encapsulate_init()\fR and +\&\fBEVP_PKEY_encapsulate()\fR return 1 for success and 0 or a negative value for +failure. In particular a return value of \-2 indicates the operation is not +supported by the public key algorithm. +.SH EXAMPLES .IX Header "EXAMPLES" -Encapsulate an \s-1RSASVE\s0 key (for \s-1RSA\s0 keys). +Encapsulate an RSASVE key (for RSA keys). .PP .Vb 1 \& #include <openssl/evp.h> @@ -196,7 +145,7 @@ Encapsulate an \s-1RSASVE\s0 key (for \s-1RSA\s0 keys). \& unsigned char *out = NULL, *secret = NULL; \& \& ctx = EVP_PKEY_CTX_new_from_pkey(libctx, rsa_pub_key, NULL); -\& if (ctx = NULL) +\& if (ctx == NULL) \& /* Error */ \& if (EVP_PKEY_encapsulate_init(ctx, NULL) <= 0) \& /* Error */ @@ -225,15 +174,24 @@ Encapsulate an \s-1RSASVE\s0 key (for \s-1RSA\s0 keys). .IX Header "SEE ALSO" \&\fBEVP_PKEY_CTX_new_from_pkey\fR\|(3), \&\fBEVP_PKEY_decapsulate\fR\|(3), -\&\s-1\fBEVP_KEM\-RSA\s0\fR\|(7), -.SH "HISTORY" +\&\fBEVP_KEM\-RSA\fR\|(7), +\&\fBEVP_KEM\-X25519\fR\|(7), +\&\fBEVP_KEM\-EC\fR\|(7), +\&\fBEVP_KEM\-ML\-KEM\-512\fR\|(7), +\&\fBEVP_KEM\-ML\-KEM\-768\fR\|(7), +\&\fBEVP_KEM\-ML\-KEM\-1024\fR\|(7) +.SH HISTORY .IX Header "HISTORY" -These functions were added in OpenSSL 3.0. -.SH "COPYRIGHT" +The functions \fBEVP_PKEY_encapsulate_init()\fR and \fBEVP_PKEY_encapsulate()\fR were +added in OpenSSL 3.0. +The function \fBEVP_PKEY_auth_encapsulate_init()\fR was added in OpenSSL 3.2. +.PP +Support for \fBML-KEM\fR was added in OpenSSL 3.5. +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2020\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2020\-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>. |