Ed25519.html 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. <?xml version="1.0" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <title>Ed25519</title>
  6. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  7. <link rev="made" href="mailto:root@localhost" />
  8. </head>
  9. <body>
  10. <ul id="index">
  11. <li><a href="#NAME">NAME</a></li>
  12. <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
  13. <li><a href="#NOTES">NOTES</a></li>
  14. <li><a href="#EXAMPLES">EXAMPLES</a></li>
  15. <li><a href="#SEE-ALSO">SEE ALSO</a></li>
  16. <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
  17. </ul>
  18. <h1 id="NAME">NAME</h1>
  19. <p>Ed25519, Ed448 - EVP_PKEY Ed25519 and Ed448 support</p>
  20. <h1 id="DESCRIPTION">DESCRIPTION</h1>
  21. <p>The <b>Ed25519</b> and <b>Ed448</b> EVP_PKEY implementation supports key generation, one-shot digest sign and digest verify using PureEdDSA and <b>Ed25519</b> or <b>Ed448</b> (see RFC8032). It has associated private and public key formats compatible with RFC 8410.</p>
  22. <p>No additional parameters can be set during key generation, one-shot signing or verification. In particular, because PureEdDSA is used, a digest must <b>NOT</b> be specified when signing or verifying.</p>
  23. <h1 id="NOTES">NOTES</h1>
  24. <p>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 EVP_DigestSign() and EVP_DigestVerify() functions.</p>
  25. <p>When calling EVP_DigestSignInit() or EVP_DigestVerifyInit(), the digest <b>type</b> parameter <b>MUST</b> be set to <b>NULL</b>.</p>
  26. <p>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.</p>
  27. <p>A context for the <b>Ed25519</b> algorithm can be obtained by calling:</p>
  28. <pre><code> EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED25519, NULL);</code></pre>
  29. <p>For the <b>Ed448</b> algorithm a context can be obtained by calling:</p>
  30. <pre><code> EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED448, NULL);</code></pre>
  31. <p>Ed25519 or Ed448 private keys can be set directly using <a href="../man3/EVP_PKEY_new_raw_private_key.html">EVP_PKEY_new_raw_private_key(3)</a> or loaded from a PKCS#8 private key file using <a href="../man3/PEM_read_bio_PrivateKey.html">PEM_read_bio_PrivateKey(3)</a> (or similar function). Completely new keys can also be generated (see the example below). Setting a private key also sets the associated public key.</p>
  32. <p>Ed25519 or Ed448 public keys can be set directly using <a href="../man3/EVP_PKEY_new_raw_public_key.html">EVP_PKEY_new_raw_public_key(3)</a> or loaded from a SubjectPublicKeyInfo structure in a PEM file using <a href="../man3/PEM_read_bio_PUBKEY.html">PEM_read_bio_PUBKEY(3)</a> (or similar function).</p>
  33. <p>Ed25519 and Ed448 can be tested within <a href="../man1/speed.html">speed(1)</a> application since version 1.1.1. Valid algorithm names are <b>ed25519</b>, <b>ed448</b> and <b>eddsa</b>. If <b>eddsa</b> is specified, then both Ed25519 and Ed448 are benchmarked.</p>
  34. <h1 id="EXAMPLES">EXAMPLES</h1>
  35. <p>This example generates an <b>ED25519</b> private key and writes it to standard output in PEM format:</p>
  36. <pre><code> #include &lt;openssl/evp.h&gt;
  37. #include &lt;openssl/pem.h&gt;
  38. ...
  39. EVP_PKEY *pkey = NULL;
  40. EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED25519, NULL);
  41. EVP_PKEY_keygen_init(pctx);
  42. EVP_PKEY_keygen(pctx, &amp;pkey);
  43. EVP_PKEY_CTX_free(pctx);
  44. PEM_write_PrivateKey(stdout, pkey, NULL, NULL, 0, NULL, NULL);</code></pre>
  45. <h1 id="SEE-ALSO">SEE ALSO</h1>
  46. <p><a href="../man3/EVP_PKEY_CTX_new.html">EVP_PKEY_CTX_new(3)</a>, <a href="../man3/EVP_PKEY_keygen.html">EVP_PKEY_keygen(3)</a>, <a href="../man3/EVP_DigestSignInit.html">EVP_DigestSignInit(3)</a>, <a href="../man3/EVP_DigestVerifyInit.html">EVP_DigestVerifyInit(3)</a>,</p>
  47. <h1 id="COPYRIGHT">COPYRIGHT</h1>
  48. <p>Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.</p>
  49. <p>Licensed under the OpenSSL license (the &quot;License&quot;). 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 <a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
  50. </body>
  51. </html>