xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/X25519.7 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: X25519.7,v 1.8 2024/09/08 13:08:36 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

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'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "X25519 7"
X25519 7 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
X25519, X448 \- EVP_PKEY X25519 and X448 support
DESCRIPTION
Header "DESCRIPTION" The X25519 and X448 EVP_PKEY implementation supports key generation and key derivation using X25519 and X448. It has associated private and public key formats compatible with RFC 8410.

No additional parameters can be set during key generation.

The peer public key must be set using EVP_PKEY_derive_set_peer() when performing key derivation.

NOTES
Header "NOTES" A context for the X25519 algorithm can be obtained by calling:

.Vb 1 EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_X25519, NULL); .Ve

For the X448 algorithm a context can be obtained by calling:

.Vb 1 EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_X448, NULL); .Ve

X25519 or X448 private keys can be set directly using \fBEVP_PKEY_new_raw_private_key\|(3) or loaded from a PKCS#8 private key file using PEM_read_bio_PrivateKey\|(3) (or similar function). Completely new keys can also be generated (see the example below). Setting a private key also sets the associated public key.

X25519 or X448 public keys can be set directly using \fBEVP_PKEY_new_raw_public_key\|(3) or loaded from a SubjectPublicKeyInfo structure in a PEM file using PEM_read_bio_PUBKEY\|(3) (or similar function).

EXAMPLES
Header "EXAMPLES" This example generates an X25519 private key and writes it to standard output in PEM format:

.Vb 9 #include <openssl/evp.h> #include <openssl/pem.h> ... EVP_PKEY *pkey = NULL; EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_X25519, NULL); EVP_PKEY_keygen_init(pctx); EVP_PKEY_keygen(pctx, &pkey); EVP_PKEY_CTX_free(pctx); PEM_write_PrivateKey(stdout, pkey, NULL, NULL, 0, NULL, NULL); .Ve

The key derivation example in EVP_PKEY_derive\|(3) can be used with \fBX25519 and X448.

"SEE ALSO"
Header "SEE ALSO" \fBEVP_PKEY_CTX_new\|(3), \fBEVP_PKEY_keygen\|(3), \fBEVP_PKEY_derive\|(3), \fBEVP_PKEY_derive_set_peer\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.

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>.