aboutsummaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3')
-rw-r--r--secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.317
1 files changed, 10 insertions, 7 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3 b/secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3
index 99630a34c7dc..8c953f532f28 100644
--- a/secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3
+++ b/secure/lib/libcrypto/man/man3/EVP_PKEY_encapsulate.3
@@ -1,5 +1,5 @@
.\" -*- mode: troff; coding: utf-8 -*-
-.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
+.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -52,10 +52,13 @@
. \}
.\}
.rr rF
+.\"
+.\" Required to disable full justification in groff 1.23.0.
+.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "EVP_PKEY_ENCAPSULATE 3ossl"
-.TH EVP_PKEY_ENCAPSULATE 3ossl 2025-09-30 3.5.4 OpenSSL
+.TH EVP_PKEY_ENCAPSULATE 3ossl 2026-04-07 3.5.6 OpenSSL
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -97,7 +100,7 @@ size of the provided buffer.
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
+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
@@ -107,9 +110,9 @@ maximum size of the generated key buffer is written to \fI*genkeylen\fR unless
.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).
+\&\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),
+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.
@@ -121,7 +124,7 @@ 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"
@@ -186,7 +189,7 @@ The functions \fBEVP_PKEY_encapsulate_init()\fR and \fBEVP_PKEY_encapsulate()\fR
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.
+Support for \fBML\-KEM\fR was added in OpenSSL 3.5.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2020\-2025 The OpenSSL Project Authors. All Rights Reserved.