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

   1 .\" Automatically generated by Pod::Man 4.09 (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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "EC 1"
 132 .TH EC 1 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 openssl\-ec, ec \- EC key processing
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBopenssl\fR \fBec\fR
 142 [\fB\-help\fR]
 143 [\fB\-inform PEM|DER\fR]
 144 [\fB\-outform PEM|DER\fR]
 145 [\fB\-in filename\fR]
 146 [\fB\-passin arg\fR]
 147 [\fB\-out filename\fR]
 148 [\fB\-passout arg\fR]
 149 [\fB\-des\fR]
 150 [\fB\-des3\fR]
 151 [\fB\-idea\fR]
 152 [\fB\-text\fR]
 153 [\fB\-noout\fR]
 154 [\fB\-param_out\fR]
 155 [\fB\-pubin\fR]
 156 [\fB\-pubout\fR]
 157 [\fB\-conv_form arg\fR]
 158 [\fB\-param_enc arg\fR]
 159 [\fB\-no_public\fR]
 160 [\fB\-check\fR]
 161 [\fB\-engine id\fR]
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 The \fBec\fR command processes \s-1EC\s0 keys. They can be converted between various
 165 forms and their components printed out. \fBNote\fR OpenSSL uses the
 166 private key format specified in '\s-1SEC 1:\s0 Elliptic Curve Cryptography'
 167 (http://www.secg.org/). To convert an OpenSSL \s-1EC\s0 private key into the
 168 PKCS#8 private key format use the \fBpkcs8\fR command.
 169 .SH "OPTIONS"
 170 .IX Header "OPTIONS"
 171 .IP "\fB\-help\fR" 4
 172 .IX Item "-help"
 173 Print out a usage message.
 174 .IP "\fB\-inform DER|PEM\fR" 4
 175 .IX Item "-inform DER|PEM"
 176 This specifies the input format. The \fB\s-1DER\s0\fR option with a private key uses
 177 an \s-1ASN.1 DER\s0 encoded \s-1SEC1\s0 private key. When used with a public key it
 178 uses the SubjectPublicKeyInfo structure as specified in \s-1RFC 3280.\s0
 179 The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
 180 encoded with additional header and footer lines. In the case of a private key
 181 PKCS#8 format is also accepted.
 182 .IP "\fB\-outform DER|PEM\fR" 4
 183 .IX Item "-outform DER|PEM"
 184 This specifies the output format, the options have the same meaning and default
 185 as the \fB\-inform\fR option.
 186 .IP "\fB\-in filename\fR" 4
 187 .IX Item "-in filename"
 188 This specifies the input filename to read a key from or standard input if this
 189 option is not specified. If the key is encrypted a pass phrase will be
 190 prompted for.
 191 .IP "\fB\-passin arg\fR" 4
 192 .IX Item "-passin arg"
 193 The input file password source. For more information about the format of \fBarg\fR
 194 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 195 .IP "\fB\-out filename\fR" 4
 196 .IX Item "-out filename"
 197 This specifies the output filename to write a key to or standard output by
 198 is not specified. If any encryption options are set then a pass phrase will be
 199 prompted for. The output filename should \fBnot\fR be the same as the input
 200 filename.
 201 .IP "\fB\-passout arg\fR" 4
 202 .IX Item "-passout arg"
 203 The output file password source. For more information about the format of \fBarg\fR
 204 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 205 .IP "\fB\-des|\-des3|\-idea\fR" 4
 206 .IX Item "-des|-des3|-idea"
 207 These options encrypt the private key with the \s-1DES,\s0 triple \s-1DES, IDEA\s0 or
 208 any other cipher supported by OpenSSL before outputting it. A pass phrase is
 209 prompted for.
 210 If none of these options is specified the key is written in plain text. This
 211 means that using the \fBec\fR utility to read in an encrypted key with no
 212 encryption option can be used to remove the pass phrase from a key, or by
 213 setting the encryption options it can be use to add or change the pass phrase.
 214 These options can only be used with \s-1PEM\s0 format output files.
 215 .IP "\fB\-text\fR" 4
 216 .IX Item "-text"
 217 Prints out the public, private key components and parameters.
 218 .IP "\fB\-noout\fR" 4
 219 .IX Item "-noout"
 220 This option prevents output of the encoded version of the key.
 221 .IP "\fB\-modulus\fR" 4
 222 .IX Item "-modulus"
 223 This option prints out the value of the public key component of the key.
 224 .IP "\fB\-pubin\fR" 4
 225 .IX Item "-pubin"
 226 By default, a private key is read from the input file. With this option a
 227 public key is read instead.
 228 .IP "\fB\-pubout\fR" 4
 229 .IX Item "-pubout"
 230 By default a private key is output. With this option a public
 231 key will be output instead. This option is automatically set if the input is
 232 a public key.
 233 .IP "\fB\-conv_form\fR" 4
 234 .IX Item "-conv_form"
 235 This specifies how the points on the elliptic curve are converted
 236 into octet strings. Possible values are: \fBcompressed\fR (the default
 237 value), \fBuncompressed\fR and \fBhybrid\fR. For more information regarding
 238 the point conversion forms please read the X9.62 standard.
 239 \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
 240 by default for binary curves and can be enabled by defining
 241 the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
 242 .IP "\fB\-param_enc arg\fR" 4
 243 .IX Item "-param_enc arg"
 244 This specifies how the elliptic curve parameters are encoded.
 245 Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
 246 specified by an \s-1OID,\s0 or \fBexplicit\fR where the ec parameters are
 247 explicitly given (see \s-1RFC 3279\s0 for the definition of the
 248 \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
 249 \&\fBNote\fR the \fBimplicitlyCA\fR alternative, as specified in \s-1RFC 3279,\s0
 250 is currently not implemented in OpenSSL.
 251 .IP "\fB\-no_public\fR" 4
 252 .IX Item "-no_public"
 253 This option omits the public key components from the private key output.
 254 .IP "\fB\-check\fR" 4
 255 .IX Item "-check"
 256 This option checks the consistency of an \s-1EC\s0 private or public key.
 257 .IP "\fB\-engine id\fR" 4
 258 .IX Item "-engine id"
 259 Specifying an engine (by its unique \fBid\fR string) will cause \fBec\fR
 260 to attempt to obtain a functional reference to the specified engine,
 261 thus initialising it if needed. The engine will then be set as the default
 262 for all available algorithms.
 263 .SH "NOTES"
 264 .IX Header "NOTES"
 265 The \s-1PEM\s0 private key format uses the header and footer lines:
 266 .PP
 267 .Vb 2
 268 \& \-\-\-\-\-BEGIN EC PRIVATE KEY\-\-\-\-\-
 269 \& \-\-\-\-\-END EC PRIVATE KEY\-\-\-\-\-
 270 .Ve
 271 .PP
 272 The \s-1PEM\s0 public key format uses the header and footer lines:
 273 .PP
 274 .Vb 2
 275 \& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-
 276 \& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\-
 277 .Ve
 278 .SH "EXAMPLES"
 279 .IX Header "EXAMPLES"
 280 To encrypt a private key using triple \s-1DES:\s0
 281 .PP
 282 .Vb 1
 283 \& openssl ec \-in key.pem \-des3 \-out keyout.pem
 284 .Ve
 285 .PP
 286 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
 287 .PP
 288 .Vb 1
 289 \& openssl ec \-in key.pem \-outform DER \-out keyout.der
 290 .Ve
 291 .PP
 292 To print out the components of a private key to standard output:
 293 .PP
 294 .Vb 1
 295 \& openssl ec \-in key.pem \-text \-noout
 296 .Ve
 297 .PP
 298 To just output the public part of a private key:
 299 .PP
 300 .Vb 1
 301 \& openssl ec \-in key.pem \-pubout \-out pubkey.pem
 302 .Ve
 303 .PP
 304 To change the parameters encoding to \fBexplicit\fR:
 305 .PP
 306 .Vb 1
 307 \& openssl ec \-in key.pem \-param_enc explicit \-out keyout.pem
 308 .Ve
 309 .PP
 310 To change the point conversion form to \fBcompressed\fR:
 311 .PP
 312 .Vb 1
 313 \& openssl ec \-in key.pem \-conv_form compressed \-out keyout.pem
 314 .Ve
 315 .SH "SEE ALSO"
 316 .IX Header "SEE ALSO"
 317 \&\fIecparam\fR\|(1), \fIdsa\fR\|(1), \fIrsa\fR\|(1)
 318 .SH "COPYRIGHT"
 319 .IX Header "COPYRIGHT"
 320 Copyright 2003\-2017 The OpenSSL Project Authors. All Rights Reserved.
 321 .PP
 322 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 323 this file except in compliance with the License.  You can obtain a copy
 324 in the file \s-1LICENSE\s0 in the source distribution or at
 325 <https://www.openssl.org/source/license.html>.