summaryrefslogtreecommitdiff
path: root/static/freebsd/man7/EVP_KEM-X25519.7
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
commitac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (patch)
tree9367490586c84cba28652e443e3166d66c33b0d9 /static/freebsd/man7/EVP_KEM-X25519.7
parent253e67c8b3a72b3a4757fdbc5845297628db0a4a (diff)
docs: Added All FreeBSD Manuals
Diffstat (limited to 'static/freebsd/man7/EVP_KEM-X25519.7')
-rw-r--r--static/freebsd/man7/EVP_KEM-X25519.7130
1 files changed, 130 insertions, 0 deletions
diff --git a/static/freebsd/man7/EVP_KEM-X25519.7 b/static/freebsd/man7/EVP_KEM-X25519.7
new file mode 100644
index 00000000..7a0ba8a0
--- /dev/null
+++ b/static/freebsd/man7/EVP_KEM-X25519.7
@@ -0,0 +1,130 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Required to disable full justification in groff 1.23.0.
+.if n .ds AD l
+.\" ========================================================================
+.\"
+.IX Title "EVP_KEM-X25519 7ossl"
+.TH EVP_KEM-X25519 7ossl 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
+.nh
+.SH NAME
+EVP_KEM\-X25519, EVP_KEM\-X448
+\&\- EVP_KEM X25519 and EVP_KEM X448 keytype and algorithm support
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+The \fBX25519\fR and <X448> keytype and its parameters are described in
+\&\fBEVP_PKEY\-X25519\fR\|(7).
+See \fBEVP_PKEY_encapsulate\fR\|(3) and \fBEVP_PKEY_decapsulate\fR\|(3) for more info.
+.SS "X25519 and X448 KEM parameters"
+.IX Subsection "X25519 and X448 KEM parameters"
+.IP """operation"" (\fBOSSL_KEM_PARAM_OPERATION\fR)<UTF8 string>" 4
+.IX Item """operation"" (OSSL_KEM_PARAM_OPERATION)<UTF8 string>"
+The OpenSSL X25519 and X448 Key Encapsulation Mechanisms only support the
+following default operation (operating mode):
+.RS 4
+.IP """DHKEM"" (\fBOSSL_KEM_PARAM_OPERATION_DHKEM\fR)" 4
+.IX Item """DHKEM"" (OSSL_KEM_PARAM_OPERATION_DHKEM)"
+The encapsulate function generates an ephemeral keypair. It produces keymaterial
+by doing an X25519 or X448 key exchange using the ephemeral private key and a
+supplied recipient public key. A HKDF operation using the keymaterial and a kem
+context then produces a shared secret. The shared secret and the ephemeral
+public key are returned.
+The decapsulate function uses the recipient private key and the
+ephemeral public key to produce the same keymaterial, which can then be used to
+produce the same shared secret.
+See <https://www.rfc\-editor.org/rfc/rfc9180.html#name\-dh\-based\-kem\-dhkem>
+.RE
+.RS 4
+.Sp
+This can be set using either \fBEVP_PKEY_CTX_set_kem_op()\fR or
+\&\fBEVP_PKEY_CTX_set_params()\fR.
+.RE
+.IP """ikme"" (\fBOSSL_KEM_PARAM_IKME\fR) <octet string>" 4
+.IX Item """ikme"" (OSSL_KEM_PARAM_IKME) <octet string>"
+Used to specify the key material used for generation of the ephemeral key.
+This value should not be reused for other purposes.
+It should have a length of at least 32 for X25519, and 56 for X448.
+If this value is not set, then a random ikm is used.
+.SH "CONFORMING TO"
+.IX Header "CONFORMING TO"
+.IP RFC9180 4
+.IX Item "RFC9180"
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBEVP_PKEY_CTX_set_kem_op\fR\|(3),
+\&\fBEVP_PKEY_encapsulate\fR\|(3),
+\&\fBEVP_PKEY_decapsulate\fR\|(3)
+\&\fBEVP_KEYMGMT\fR\|(3),
+\&\fBEVP_PKEY\fR\|(3),
+\&\fBprovider\-keymgmt\fR\|(7)
+.SH HISTORY
+.IX Header "HISTORY"
+This functionality was added in OpenSSL 3.2.
+.PP
+The \f(CW\*(C`operation\*(C'\fR (operating mode) was a required parameter prior to OpenSSL 3.5.
+As of OpenSSL 3.5, \f(CW\*(C`DHKEM\*(C'\fR is the default operating mode, and no explicit value
+need be specified.
+.SH COPYRIGHT
+.IX Header "COPYRIGHT"
+Copyright 2022\-2025 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+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 LICENSE in the source distribution or at
+<https://www.openssl.org/source/license.html>.