Debian Codegraph @

upstream/debian-unstable/man7/EVP_KEM-X25519.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_KEM-X25519 7SSL"
58 .TH EVP_KEM-X25519 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_KEM\-X25519, EVP_KEM\-X448
65 \&\- EVP_KEM X25519 and EVP_KEM X448 keytype and algorithm support
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 The \fBX25519\fR and <X448> keytype and its parameters are described in
69 \&\fBEVP_PKEY\-X25519\fR\|(7).
70 See \fBEVP_PKEY_encapsulate\fR\|(3) and \fBEVP_PKEY_decapsulate\fR\|(3) for more info.
71 .SS "X25519 and X448 KEM parameters"
72 .IX Subsection "X25519 and X448 KEM parameters"
73 .IP """operation"" (\fBOSSL_KEM_PARAM_OPERATION\fR)<UTF8 string>" 4
74 .IX Item """operation"" (OSSL_KEM_PARAM_OPERATION)<UTF8 string>"
75 The OpenSSL X25519 and X448 Key Encapsulation Mechanisms only support the
76 following default operation (operating mode):
77 .RS 4
78 .IP """DHKEM"" (\fBOSSL_KEM_PARAM_OPERATION_DHKEM\fR)" 4
79 .IX Item """DHKEM"" (OSSL_KEM_PARAM_OPERATION_DHKEM)"
80 The encapsulate function generates an ephemeral keypair. It produces keymaterial
81 by doing an X25519 or X448 key exchange using the ephemeral private key and a
82 supplied recipient public key. A HKDF operation using the keymaterial and a kem
83 context then produces a shared secret. The shared secret and the ephemeral
84 public key are returned.
85 The decapsulate function uses the recipient private key and the
86 ephemeral public key to produce the same keymaterial, which can then be used to
87 produce the same shared secret.
88 See <https://www.rfc\-editor.org/rfc/rfc9180.html#name\-dh\-based\-kem\-dhkem>
89 .RE
90 .RS 4
91 .Sp
92 This can be set using either \fBEVP_PKEY_CTX_set_kem_op()\fR or
93 \&\fBEVP_PKEY_CTX_set_params()\fR.
94 .RE
95 .IP """ikme"" (\fBOSSL_KEM_PARAM_IKME\fR) <octet string>" 4
96 .IX Item """ikme"" (OSSL_KEM_PARAM_IKME) <octet string>"
97 Used to specify the key material used for generation of the ephemeral key.
98 This value should not be reused for other purposes.
99 It should have a length of at least 32 for X25519, and 56 for X448.
100 If this value is not set, then a random ikm is used.
101 .SH "CONFORMING TO"
102 .IX Header "CONFORMING TO"
103 .IP RFC9180 4
104 .IX Item "RFC9180"
105 .SH "SEE ALSO"
106 .IX Header "SEE ALSO"
107 \&\fBEVP_PKEY_CTX_set_kem_op\fR\|(3),
108 \&\fBEVP_PKEY_encapsulate\fR\|(3),
109 \&\fBEVP_PKEY_decapsulate\fR\|(3)
110 \&\fBEVP_KEYMGMT\fR\|(3),
111 \&\fBEVP_PKEY\fR\|(3),
112 \&\fBprovider\-keymgmt\fR\|(7)
113 .SH HISTORY
114 .IX Header "HISTORY"
115 This functionality was added in OpenSSL 3.2.
116 .PP
117 The \f(CW\*(C`operation\*(C'\fR (operating mode) was a required parameter prior to OpenSSL 3.5.
118 As of OpenSSL 3.5, \f(CW\*(C`DHKEM\*(C'\fR is the default operating mode, and no explicit value
119 need be specified.
120 .SH COPYRIGHT
121 .IX Header "COPYRIGHT"
122 Copyright 2022\-2025 The OpenSSL Project Authors. All Rights Reserved.
123 .PP
124 Licensed under the Apache License 2.0 (the "License"). You may not use
125 this file except in compliance with the License. You can obtain a copy
126 in the file LICENSE in the source distribution or at
127 <https://www.openssl.org/source/license.html>.