Debian Codegraph @

upstream/debian-unstable/man7/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 "X25519 7SSL"
58 .TH 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 X25519,
65 X448
66 \&\- EVP_PKEY X25519 and X448 support
67 .SH DESCRIPTION
68 .IX Header "DESCRIPTION"
69 The \fBX25519\fR and \fBX448\fR EVP_PKEY implementation supports key generation and
70 key derivation using \fBX25519\fR and \fBX448\fR. It has associated private and public
71 key formats compatible with RFC 8410.
72 .PP
73 No additional parameters can be set during key generation.
74 .PP
75 The peer public key must be set using \fBEVP_PKEY_derive_set_peer()\fR when
76 performing key derivation.
77 .SH NOTES
78 .IX Header "NOTES"
79 A context for the \fBX25519\fR algorithm can be obtained by calling:
80 .PP
81 .Vb 1
82 \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_X25519, NULL);
83 .Ve
84 .PP
85 For the \fBX448\fR algorithm a context can be obtained by calling:
86 .PP
87 .Vb 1
88 \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_X448, NULL);
89 .Ve
90 .PP
91 X25519 or X448 private keys can be set directly using
92 \&\fBEVP_PKEY_new_raw_private_key\fR\|(3) or loaded from a PKCS#8 private key file
93 using \fBPEM_read_bio_PrivateKey\fR\|(3) (or similar function). Completely new keys
94 can also be generated (see the example below). Setting a private key also sets
95 the associated public key.
96 .PP
97 X25519 or X448 public keys can be set directly using
98 \&\fBEVP_PKEY_new_raw_public_key\fR\|(3) or loaded from a SubjectPublicKeyInfo
99 structure in a PEM file using \fBPEM_read_bio_PUBKEY\fR\|(3) (or similar function).
100 .SH EXAMPLES
101 .IX Header "EXAMPLES"
102 This example generates an \fBX25519\fR private key and writes it to standard
103 output in PEM format:
104 .PP
105 .Vb 9
106 \& #include <openssl/evp.h>
107 \& #include <openssl/pem.h>
108 \& ...
109 \& EVP_PKEY *pkey = NULL;
110 \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_X25519, NULL);
111 \& EVP_PKEY_keygen_init(pctx);
112 \& EVP_PKEY_keygen(pctx, &pkey);
113 \& EVP_PKEY_CTX_free(pctx);
114 \& PEM_write_PrivateKey(stdout, pkey, NULL, NULL, 0, NULL, NULL);
115 .Ve
116 .PP
117 The key derivation example in \fBEVP_PKEY_derive\fR\|(3) can be used with
118 \&\fBX25519\fR and \fBX448\fR.
119 .SH "SEE ALSO"
120 .IX Header "SEE ALSO"
121 \&\fBEVP_PKEY_CTX_new\fR\|(3),
122 \&\fBEVP_PKEY_keygen\fR\|(3),
123 \&\fBEVP_PKEY_derive\fR\|(3),
124 \&\fBEVP_PKEY_derive_set_peer\fR\|(3)
125 .SH COPYRIGHT
126 .IX Header "COPYRIGHT"
127 Copyright 2017\-2020 The OpenSSL Project Authors. All Rights Reserved.
128 .PP
129 Licensed under the Apache License 2.0 (the "License"). You may not use
130 this file except in compliance with the License. You can obtain a copy
131 in the file LICENSE in the source distribution or at
132 <https://www.openssl.org/source/license.html>.