secure/usr.bin/openssl/man/ec.1

   1 .\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
   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 "EC 1"
 136 .TH EC 1 "2019-02-26" "1.0.2r" "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 openssl\-ec,
 143 ec \- EC key processing
 144 .SH "SYNOPSIS"
 145 .IX Header "SYNOPSIS"
 146 \&\fBopenssl\fR \fBec\fR
 147 [\fB\-inform PEM|DER\fR]
 148 [\fB\-outform PEM|DER\fR]
 149 [\fB\-in filename\fR]
 150 [\fB\-passin arg\fR]
 151 [\fB\-out filename\fR]
 152 [\fB\-passout arg\fR]
 153 [\fB\-des\fR]
 154 [\fB\-des3\fR]
 155 [\fB\-idea\fR]
 156 [\fB\-text\fR]
 157 [\fB\-noout\fR]
 158 [\fB\-param_out\fR]
 159 [\fB\-pubin\fR]
 160 [\fB\-pubout\fR]
 161 [\fB\-conv_form arg\fR]
 162 [\fB\-param_enc arg\fR]
 163 [\fB\-engine id\fR]
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 The \fBec\fR command processes \s-1EC\s0 keys. They can be converted between various
 167 forms and their components printed out. \fBNote\fR OpenSSL uses the
 168 private key format specified in '\s-1SEC 1:\s0 Elliptic Curve Cryptography'
 169 (http://www.secg.org/). To convert a OpenSSL \s-1EC\s0 private key into the
 170 PKCS#8 private key format use the \fBpkcs8\fR command.
 171 .SH "COMMAND OPTIONS"
 172 .IX Header "COMMAND OPTIONS"
 173 .IP "\fB\-inform DER|PEM\fR" 4
 174 .IX Item "-inform DER|PEM"
 175 This specifies the input format. The \fB\s-1DER\s0\fR option with a private key uses
 176 an \s-1ASN.1 DER\s0 encoded \s-1SEC1\s0 private key. When used with a public key it
 177 uses the SubjectPublicKeyInfo structure as specified in \s-1RFC 3280.\s0
 178 The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
 179 encoded with additional header and footer lines. In the case of a private key
 180 PKCS#8 format is also accepted.
 181 .IP "\fB\-outform DER|PEM\fR" 4
 182 .IX Item "-outform DER|PEM"
 183 This specifies the output format, the options have the same meaning as the
 184 \&\fB\-inform\fR option.
 185 .IP "\fB\-in filename\fR" 4
 186 .IX Item "-in filename"
 187 This specifies the input filename to read a key from or standard input if this
 188 option is not specified. If the key is encrypted a pass phrase will be
 189 prompted for.
 190 .IP "\fB\-passin arg\fR" 4
 191 .IX Item "-passin arg"
 192 the input file password source. For more information about the format of \fBarg\fR
 193 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
 194 .IP "\fB\-out filename\fR" 4
 195 .IX Item "-out filename"
 196 This specifies the output filename to write a key to or standard output by
 197 is not specified. If any encryption options are set then a pass phrase will be
 198 prompted for. The output filename should \fBnot\fR be the same as the input
 199 filename.
 200 .IP "\fB\-passout arg\fR" 4
 201 .IX Item "-passout arg"
 202 the output file password source. For more information about the format of \fBarg\fR
 203 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
 204 .IP "\fB\-des|\-des3|\-idea\fR" 4
 205 .IX Item "-des|-des3|-idea"
 206 These options encrypt the private key with the \s-1DES,\s0 triple \s-1DES, IDEA\s0 or
 207 any other cipher supported by OpenSSL before outputting it. A pass phrase is
 208 prompted for.
 209 If none of these options is specified the key is written in plain text. This
 210 means that using the \fBec\fR utility to read in an encrypted key with no
 211 encryption option can be used to remove the pass phrase from a key, or by
 212 setting the encryption options it can be use to add or change the pass phrase.
 213 These options can only be used with \s-1PEM\s0 format output files.
 214 .IP "\fB\-text\fR" 4
 215 .IX Item "-text"
 216 prints out the public, private key components and parameters.
 217 .IP "\fB\-noout\fR" 4
 218 .IX Item "-noout"
 219 this option prevents output of the encoded version of the key.
 220 .IP "\fB\-modulus\fR" 4
 221 .IX Item "-modulus"
 222 this option prints out the value of the public key component of the key.
 223 .IP "\fB\-pubin\fR" 4
 224 .IX Item "-pubin"
 225 by default a private key is read from the input file: with this option a
 226 public key is read instead.
 227 .IP "\fB\-pubout\fR" 4
 228 .IX Item "-pubout"
 229 by default a private key is output. With this option a public
 230 key will be output instead. This option is automatically set if the input is
 231 a public key.
 232 .IP "\fB\-conv_form\fR" 4
 233 .IX Item "-conv_form"
 234 This specifies how the points on the elliptic curve are converted
 235 into octet strings. Possible values are: \fBcompressed\fR (the default
 236 value), \fBuncompressed\fR and \fBhybrid\fR. For more information regarding
 237 the point conversion forms please read the X9.62 standard.
 238 \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
 239 by default for binary curves and can be enabled by defining
 240 the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
 241 .IP "\fB\-param_enc arg\fR" 4
 242 .IX Item "-param_enc arg"
 243 This specifies how the elliptic curve parameters are encoded.
 244 Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
 245 specified by a \s-1OID,\s0 or \fBexplicit\fR where the ec parameters are
 246 explicitly given (see \s-1RFC 3279\s0 for the definition of the
 247 \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
 248 \&\fBNote\fR the \fBimplicitlyCA\fR alternative ,as specified in \s-1RFC 3279,\s0
 249 is currently not implemented in OpenSSL.
 250 .IP "\fB\-engine id\fR" 4
 251 .IX Item "-engine id"
 252 specifying an engine (by its unique \fBid\fR string) will cause \fBec\fR
 253 to attempt to obtain a functional reference to the specified engine,
 254 thus initialising it if needed. The engine will then be set as the default
 255 for all available algorithms.
 256 .SH "NOTES"
 257 .IX Header "NOTES"
 258 The \s-1PEM\s0 private key format uses the header and footer lines:
 259 .PP
 260 .Vb 2
 261 \& \-\-\-\-\-BEGIN EC PRIVATE KEY\-\-\-\-\-
 262 \& \-\-\-\-\-END EC PRIVATE KEY\-\-\-\-\-
 263 .Ve
 264 .PP
 265 The \s-1PEM\s0 public key format uses the header and footer lines:
 266 .PP
 267 .Vb 2
 268 \& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-
 269 \& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\-
 270 .Ve
 271 .SH "EXAMPLES"
 272 .IX Header "EXAMPLES"
 273 To encrypt a private key using triple \s-1DES:\s0
 274 .PP
 275 .Vb 1
 276 \& openssl ec \-in key.pem \-des3 \-out keyout.pem
 277 .Ve
 278 .PP
 279 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
 280 .PP
 281 .Vb 1
 282 \& openssl ec \-in key.pem \-outform DER \-out keyout.der
 283 .Ve
 284 .PP
 285 To print out the components of a private key to standard output:
 286 .PP
 287 .Vb 1
 288 \& openssl ec \-in key.pem \-text \-noout
 289 .Ve
 290 .PP
 291 To just output the public part of a private key:
 292 .PP
 293 .Vb 1
 294 \& openssl ec \-in key.pem \-pubout \-out pubkey.pem
 295 .Ve
 296 .PP
 297 To change the parameters encoding to \fBexplicit\fR:
 298 .PP
 299 .Vb 1
 300 \& openssl ec \-in key.pem \-param_enc explicit \-out keyout.pem
 301 .Ve
 302 .PP
 303 To change the point conversion form to \fBcompressed\fR:
 304 .PP
 305 .Vb 1
 306 \& openssl ec \-in key.pem \-conv_form compressed \-out keyout.pem
 307 .Ve
 308 .SH "SEE ALSO"
 309 .IX Header "SEE ALSO"
 310 \&\fBecparam\fR\|(1), \fBdsa\fR\|(1), \fBrsa\fR\|(1)
 311 .SH "HISTORY"
 312 .IX Header "HISTORY"
 313 The ec command was first introduced in OpenSSL 0.9.8.
 314 .SH "AUTHOR"
 315 .IX Header "AUTHOR"
 316 Nils Larsch for the OpenSSL project (http://www.openssl.org).