Update core_names.h fields and document most fields.
[openssl.git] / doc / man7 / EVP_SIGNATURE-ED25519.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_SIGNATURE-ED25519,
6 EVP_SIGNATURE-ED448,
7 Ed25519,
8 Ed448
9 - EVP_PKEY Ed25519 and Ed448 support
10
11 =head1 DESCRIPTION
12
13 The B<Ed25519> and B<Ed448> EVP_PKEY implementation supports key generation,
14 one-shot digest sign and digest verify using PureEdDSA and B<Ed25519> or B<Ed448>
15 (see RFC8032). It has associated private and public key formats compatible with
16 RFC 8410.
17
18 No additional parameters can be set during one-shot signing or verification.
19 In particular, because PureEdDSA is used, a digest must B<NOT> be specified when
20 signing or verifying.
21 See L<EVP_PKEY-X25519(7)> for information related to B<X25519> and B<X448> keys.
22
23 =head1 NOTES
24
25 The PureEdDSA algorithm does not support the streaming mechanism
26 of other signature algorithms using, for example, EVP_DigestUpdate().
27 The message to sign or verify must be passed using the one-shot
28 EVP_DigestSign() and EVP_DigestVerify() functions.
29
30 When calling EVP_DigestSignInit() or EVP_DigestVerifyInit(), the
31 digest I<type> parameter B<MUST> be set to NULL.
32
33 Applications wishing to sign certificates (or other structures such as
34 CRLs or certificate requests) using Ed25519 or Ed448 can either use X509_sign()
35 or X509_sign_ctx() in the usual way.
36
37 Ed25519 or Ed448 private keys can be set directly using
38 L<EVP_PKEY_new_raw_private_key(3)> or loaded from a PKCS#8 private key file
39 using L<PEM_read_bio_PrivateKey(3)> (or similar function). Completely new keys
40 can also be generated (see the example below). Setting a private key also sets
41 the associated public key.
42
43 Ed25519 or Ed448 public keys can be set directly using
44 L<EVP_PKEY_new_raw_public_key(3)> or loaded from a SubjectPublicKeyInfo
45 structure in a PEM file using L<PEM_read_bio_PUBKEY(3)> (or similar function).
46
47 Ed25519 and Ed448 can be tested with the L<openssl-speed(1)> application
48 since version 1.1.1.
49 Valid algorithm names are B<ed25519>, B<ed448> and B<eddsa>. If B<eddsa> is
50 specified, then both Ed25519 and Ed448 are benchmarked.
51
52 =head1 EXAMPLES
53
54 To sign a message using a ED25519 or ED448 key:
55
56     void do_sign(EVP_PKEY *ed_key, unsigned char *msg, size_t msg_len)
57     {
58         size_t sig_len;
59         unsigned char *sig = NULL;
60         EVP_MD_CTX *md_ctx = EVP_MD_CTX_new();
61
62         EVP_DigestSignInit(md_ctx, NULL, NULL, NULL, ed_key);
63         /* Calculate the requires size for the signature by passing a NULL buffer */
64         EVP_DigestSign(md_ctx, NULL, &sig_len, msg, msg_len);
65         sig = OPENSSL_zalloc(sig_len);
66
67         EVP_DigestSign(md_ctx, sig, &sig_len, msg, msg_len);
68         ...
69         OPENSSL_free(sig);
70         EVP_MD_CTX_free(md_ctx);
71     }
72
73 =head1 SEE ALSO
74
75 L<EVP_PKEY-X25519(7)>
76 L<provider-signature(7)>,
77 L<EVP_DigestSignInit(3)>,
78 L<EVP_DigestVerifyInit(3)>,
79
80 =head1 COPYRIGHT
81
82 Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.
83
84 Licensed under the Apache License 2.0 (the "License").  You may not use
85 this file except in compliance with the License.  You can obtain a copy
86 in the file LICENSE in the source distribution or at
87 L<https://www.openssl.org/source/license.html>.
88
89 =cut