xref: /freebsd/secure/lib/libcrypto/man/man7/EVP_SIGNATURE-ED25519.7 (revision a18b956b73cee784e5c422d20fd0e4dabebd7eee)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

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
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
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_SIGNATURE-ED25519 7"
EVP_SIGNATURE-ED25519 7 "2023-05-30" "3.0.9" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
EVP_SIGNATURE-ED25519, EVP_SIGNATURE-ED448, Ed25519, Ed448 \- EVP_PKEY Ed25519 and Ed448 support
"DESCRIPTION"
Header "DESCRIPTION" The Ed25519 and Ed448 \s-1EVP_PKEY\s0 implementation supports key generation, one-shot digest sign and digest verify using PureEdDSA and Ed25519 or Ed448 (see \s-1RFC8032\s0). It has associated private and public key formats compatible with \s-1RFC 8410.\s0
"\s-1ED25519\s0 and \s-1ED448\s0 Signature Parameters"
Subsection "ED25519 and ED448 Signature Parameters" No additional parameters can be set during one-shot signing or verification. In particular, because PureEdDSA is used, a digest must \s-1NOT\s0 be specified when signing or verifying. See \s-1EVP_PKEY-X25519\s0\|(7) for information related to X25519 and X448 keys.

The following signature parameters can be retrieved using \fBEVP_PKEY_CTX_get_params(). Item "algorithm-id (OSSL_SIGNATURE_PARAM_ALGORITHM_ID) <octet string>" The parameters are described in provider-signature\|(7).

"NOTES"
Header "NOTES" The PureEdDSA algorithm does not support the streaming mechanism of other signature algorithms using, for example, EVP_DigestUpdate(). The message to sign or verify must be passed using the one-shot \fBEVP_DigestSign() and EVP_DigestVerify() functions.

When calling EVP_DigestSignInit() or EVP_DigestVerifyInit(), the digest type parameter \s-1MUST\s0 be set to \s-1NULL.\s0

Applications wishing to sign certificates (or other structures such as CRLs or certificate requests) using Ed25519 or Ed448 can either use X509_sign() or X509_sign_ctx() in the usual way.

Ed25519 or Ed448 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.

Ed25519 or Ed448 public keys can be set directly using \fBEVP_PKEY_new_raw_public_key\|(3) or loaded from a SubjectPublicKeyInfo structure in a \s-1PEM\s0 file using PEM_read_bio_PUBKEY\|(3) (or similar function).

Ed25519 and Ed448 can be tested with the openssl-speed\|(1) application since version 1.1.1. Valid algorithm names are ed25519, ed448 and eddsa. If eddsa is specified, then both Ed25519 and Ed448 are benchmarked.

"EXAMPLES"
Header "EXAMPLES" To sign a message using a \s-1ED25519\s0 or \s-1ED448\s0 key:

.Vb 5 void do_sign(EVP_PKEY *ed_key, unsigned char *msg, size_t msg_len) { size_t sig_len; unsigned char *sig = NULL; EVP_MD_CTX *md_ctx = EVP_MD_CTX_new(); \& EVP_DigestSignInit(md_ctx, NULL, NULL, NULL, ed_key); /* Calculate the requires size for the signature by passing a NULL buffer */ EVP_DigestSign(md_ctx, NULL, &sig_len, msg, msg_len); sig = OPENSSL_zalloc(sig_len); \& EVP_DigestSign(md_ctx, sig, &sig_len, msg, msg_len); ... OPENSSL_free(sig); EVP_MD_CTX_free(md_ctx); } .Ve

"SEE ALSO"
Header "SEE ALSO" \s-1EVP_PKEY-X25519\s0\|(7) \fBprovider-signature\|(7), \fBEVP_DigestSignInit\|(3), \fBEVP_DigestVerifyInit\|(3),
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2017-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>.