| 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-EC 7SSL" |
| 58 |
.TH EVP_KEM-EC 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\-EC |
| 65 |
\&\- EVP_KEM EC keytype and algorithm support |
| 66 |
.SH DESCRIPTION |
| 67 |
.IX Header "DESCRIPTION" |
| 68 |
The \fBEC\fR keytype and its parameters are described in \fBEVP_PKEY\-EC\fR\|(7). |
| 69 |
See \fBEVP_PKEY_encapsulate\fR\|(3) and \fBEVP_PKEY_decapsulate\fR\|(3) for more info. |
| 70 |
.SS "EC KEM parameters" |
| 71 |
.IX Subsection "EC KEM parameters" |
| 72 |
.IP """operation"" (\fBOSSL_KEM_PARAM_OPERATION\fR)<UTF8 string>" 4 |
| 73 |
.IX Item """operation"" (OSSL_KEM_PARAM_OPERATION)<UTF8 string>" |
| 74 |
The OpenSSL EC Key Encapsulation Mechanisms only supports the |
| 75 |
following default operation (operating mode): |
| 76 |
.RS 4 |
| 77 |
.IP """DHKEM"" (\fBOSSL_KEM_PARAM_OPERATION_DHKEM\fR)" 4 |
| 78 |
.IX Item """DHKEM"" (OSSL_KEM_PARAM_OPERATION_DHKEM)" |
| 79 |
The encapsulate function generates an ephemeral keypair. It produces keymaterial |
| 80 |
by doing an ECDH key exchange using the ephemeral private key and a supplied |
| 81 |
recipient public key. A HKDF operation using the keymaterial and a kem context |
| 82 |
then produces a shared secret. The shared secret and the ephemeral public key |
| 83 |
are returned. |
| 84 |
The decapsulate function uses the recipient private key and the |
| 85 |
ephemeral public key to produce the same keymaterial, which can then be used to |
| 86 |
produce the same shared secret. |
| 87 |
See <https://www.rfc\-editor.org/rfc/rfc9180.html#name\-dh\-based\-kem\-dhkem> |
| 88 |
.RE |
| 89 |
.RS 4 |
| 90 |
.Sp |
| 91 |
This can be set using either \fBEVP_PKEY_CTX_set_kem_op()\fR or |
| 92 |
\&\fBEVP_PKEY_CTX_set_params()\fR. |
| 93 |
.RE |
| 94 |
.IP """ikme"" (\fBOSSL_KEM_PARAM_IKME\fR) <octet string>" 4 |
| 95 |
.IX Item """ikme"" (OSSL_KEM_PARAM_IKME) <octet string>" |
| 96 |
Used to specify the key material used for generation of the ephemeral key. |
| 97 |
This value should not be reused for other purposes. |
| 98 |
It can only be used for the curves "P\-256", "P\-384" and "P\-521" and should |
| 99 |
have a length of at least the size of the encoded private key |
| 100 |
(i.e. 32, 48 and 66 for the listed curves). |
| 101 |
If this value is not set, then a random ikm is used. |
| 102 |
.SH "CONFORMING TO" |
| 103 |
.IX Header "CONFORMING TO" |
| 104 |
.IP RFC9180 4 |
| 105 |
.IX Item "RFC9180" |
| 106 |
.SH "SEE ALSO" |
| 107 |
.IX Header "SEE ALSO" |
| 108 |
\&\fBEVP_PKEY_CTX_set_kem_op\fR\|(3), |
| 109 |
\&\fBEVP_PKEY_encapsulate\fR\|(3), |
| 110 |
\&\fBEVP_PKEY_decapsulate\fR\|(3) |
| 111 |
\&\fBEVP_KEYMGMT\fR\|(3), |
| 112 |
\&\fBEVP_PKEY\fR\|(3), |
| 113 |
\&\fBprovider\-keymgmt\fR\|(7) |
| 114 |
.SH HISTORY |
| 115 |
.IX Header "HISTORY" |
| 116 |
This functionality was added in OpenSSL 3.2. |
| 117 |
.PP |
| 118 |
The \f(CW\*(C`operation\*(C'\fR (operating mode) was a required parameter prior to OpenSSL 3.5. |
| 119 |
As of OpenSSL 3.5, \f(CW\*(C`DHKEM\*(C'\fR is the default operating mode, and no explicit value |
| 120 |
need be specified. |
| 121 |
.SH COPYRIGHT |
| 122 |
.IX Header "COPYRIGHT" |
| 123 |
Copyright 2022\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 124 |
.PP |
| 125 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 126 |
this file except in compliance with the License. You can obtain a copy |
| 127 |
in the file LICENSE in the source distribution or at |
| 128 |
<https://www.openssl.org/source/license.html>. |