secure/lib/libcrypto/man/man7/Ed25519.7

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "ED25519 7"
 136 .TH ED25519 7 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 Ed25519, Ed448 \&\- EVP_PKEY Ed25519 and Ed448 support
 143 .SH "DESCRIPTION"
 144 .IX Header "DESCRIPTION"
 145 The \fBEd25519\fR and \fBEd448\fR \s-1EVP_PKEY\s0 implementation supports key generation,
 146 one-shot digest sign and digest verify using PureEdDSA and \fBEd25519\fR or \fBEd448\fR
 147 (see \s-1RFC8032\s0). It has associated private and public key formats compatible with
 148 \&\s-1RFC 8410.\s0
 149 .PP
 150 No additional parameters can be set during key generation, one-shot signing or
 151 verification. In particular, because PureEdDSA is used, a digest must \fB\s-1NOT\s0\fR be
 152 specified when signing or verifying.
 153 .SH "NOTES"
 154 .IX Header "NOTES"
 155 The PureEdDSA algorithm does not support the streaming mechanism
 156 of other signature algorithms using, for example, \fBEVP_DigestUpdate()\fR.
 157 The message to sign or verify must be passed using the one-shot
 158 \&\fBEVP_DigestSign()\fR and \fBEVP_DigestVerify()\fR functions.
 159 .PP
 160 When calling \fBEVP_DigestSignInit()\fR or \fBEVP_DigestVerifyInit()\fR, the
 161 digest \fBtype\fR parameter \fB\s-1MUST\s0\fR be set to \fB\s-1NULL\s0\fR.
 162 .PP
 163 Applications wishing to sign certificates (or other structures such as
 164 CRLs or certificate requests) using Ed25519 or Ed448 can either use \fBX509_sign()\fR
 165 or \fBX509_sign_ctx()\fR in the usual way.
 166 .PP
 167 A context for the \fBEd25519\fR algorithm can be obtained by calling:
 168 .PP
 169 .Vb 1
 170 \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED25519, NULL);
 171 .Ve
 172 .PP
 173 For the \fBEd448\fR algorithm a context can be obtained by calling:
 174 .PP
 175 .Vb 1
 176 \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED448, NULL);
 177 .Ve
 178 .PP
 179 Ed25519 or Ed448 private keys can be set directly using
 180 \&\fBEVP_PKEY_new_raw_private_key\fR\|(3) or loaded from a PKCS#8 private key file
 181 using \fBPEM_read_bio_PrivateKey\fR\|(3) (or similar function). Completely new keys
 182 can also be generated (see the example below). Setting a private key also sets
 183 the associated public key.
 184 .PP
 185 Ed25519 or Ed448 public keys can be set directly using
 186 \&\fBEVP_PKEY_new_raw_public_key\fR\|(3) or loaded from a SubjectPublicKeyInfo
 187 structure in a \s-1PEM\s0 file using \fBPEM_read_bio_PUBKEY\fR\|(3) (or similar function).
 188 .PP
 189 Ed25519 and Ed448 can be tested within \fBspeed\fR\|(1) application since version 1.1.1.
 190 Valid algorithm names are \fBed25519\fR, \fBed448\fR and \fBeddsa\fR. If \fBeddsa\fR is
 191 specified, then both Ed25519 and Ed448 are benchmarked.
 192 .SH "EXAMPLES"
 193 .IX Header "EXAMPLES"
 194 This example generates an \fB\s-1ED25519\s0\fR private key and writes it to standard
 195 output in \s-1PEM\s0 format:
 196 .PP
 197 .Vb 9
 198 \& #include <openssl/evp.h>
 199 \& #include <openssl/pem.h>
 200 \& ...
 201 \& EVP_PKEY *pkey = NULL;
 202 \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED25519, NULL);
 203 \& EVP_PKEY_keygen_init(pctx);
 204 \& EVP_PKEY_keygen(pctx, &pkey);
 205 \& EVP_PKEY_CTX_free(pctx);
 206 \& PEM_write_PrivateKey(stdout, pkey, NULL, NULL, 0, NULL, NULL);
 207 .Ve
 208 .SH "SEE ALSO"
 209 .IX Header "SEE ALSO"
 210 \&\fBEVP_PKEY_CTX_new\fR\|(3),
 211 \&\fBEVP_PKEY_keygen\fR\|(3),
 212 \&\fBEVP_DigestSignInit\fR\|(3),
 213 \&\fBEVP_DigestVerifyInit\fR\|(3),
 214 .SH "COPYRIGHT"
 215 .IX Header "COPYRIGHT"
 216 Copyright 2017\-2020 The OpenSSL Project Authors. All Rights Reserved.
 217 .PP
 218 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 219 this file except in compliance with the License.  You can obtain a copy
 220 in the file \s-1LICENSE\s0 in the source distribution or at
 221 <https://www.openssl.org/source/license.html>.