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

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