xref: /freebsd/secure/lib/libcrypto/man/man7/EVP_PKEY-X25519.7 (revision 257e70f1d5ee61037c8c59b116538d3b6b1427a2)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "EVP_PKEY-X25519 7ossl"
EVP_PKEY-X25519 7ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
EVP_PKEY-X25519, EVP_PKEY-X448, EVP_PKEY-ED25519, EVP_PKEY-ED448, EVP_KEYMGMT-X25519, EVP_KEYMGMT-X448, EVP_KEYMGMT-ED25519, EVP_KEYMGMT-ED448 \- EVP_PKEY X25519, X448, ED25519 and ED448 keytype and algorithm support
"DESCRIPTION"
Header "DESCRIPTION" The X25519, X448, \s-1ED25519\s0 and \s-1ED448\s0 keytypes are implemented in OpenSSL's default and \s-1FIPS\s0 providers. These implementations support the associated key, containing the public key pub and the private key priv.

No additional parameters can be set during key generation.

"Common X25519, X448, \s-1ED25519\s0 and \s-1ED448\s0 parameters"
Subsection "Common X25519, X448, ED25519 and ED448 parameters" In addition to the common parameters that all keytypes should support (see \*(L"Common parameters\*(R" in provider-keymgmt\|(7)), the implementation of these keytypes support the following. Item "group (OSSL_PKEY_PARAM_GROUP_NAME) <UTF8 string>" This is only supported by X25519 and X448. The group name must be \*(L"x25519\*(R" or \*(L"x448\*(R" respectively for those algorithms. This is only present for consistency with other key exchange algorithms and is typically not needed. Item "pub (OSSL_PKEY_PARAM_PUB_KEY) <octet string>" The public key value. Item "priv (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" The private key value. Item "encoded-pub-key (OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY) <octet string>" Used for getting and setting the encoding of a public key for the X25519 and \fBX448 key types. Public keys are expected be encoded in a format as defined by \s-1RFC7748.\s0
"\s-1ED25519\s0 and \s-1ED448\s0 parameters"
Subsection "ED25519 and ED448 parameters" Item "mandatory-digest (OSSL_PKEY_PARAM_MANDATORY_DIGEST) <UTF8 string>" The empty string, signifying that no digest may be specified.
"CONFORMING TO"
Header "CONFORMING TO"
"\s-1RFC 8032\s0" 4
Item "RFC 8032"

0

"\s-1RFC 8410\s0" 4
Item "RFC 8410"

"EXAMPLES"
Header "EXAMPLES" An \s-1EVP_PKEY\s0 context can be obtained by calling:

.Vb 2 EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_name(NULL, "X25519", NULL); \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_name(NULL, "X448", NULL); \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_name(NULL, "ED25519", NULL); \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_name(NULL, "ED448", NULL); .Ve

An X25519 key can be generated like this:

.Vb 1 pkey = EVP_PKEY_Q_keygen(NULL, NULL, "X25519"); .Ve

An X448, \s-1ED25519\s0, or \s-1ED448\s0 key can be generated likewise.

"SEE ALSO"
Header "SEE ALSO" \s-1EVP_KEYMGMT\s0\|(3), \s-1EVP_PKEY\s0\|(3), provider-keymgmt\|(7), \s-1EVP_KEYEXCH-X25519\s0\|(7), \s-1EVP_KEYEXCH-X448\s0\|(7), \s-1EVP_SIGNATURE-ED25519\s0\|(7), \s-1EVP_SIGNATURE-ED448\s0\|(7)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.