| 1 | .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sh \" Subsection heading |
| 6 | .br |
| 7 | .if t .Sp |
| 8 | .ne 5 |
| 9 | .PP |
| 10 | \fB\\$1\fR |
| 11 | .PP |
| 12 | .. |
| 13 | .de Sp \" Vertical space (when we can't use .PP) |
| 14 | .if t .sp .5v |
| 15 | .if n .sp |
| 16 | .. |
| 17 | .de Vb \" Begin verbatim text |
| 18 | .ft CW |
| 19 | .nf |
| 20 | .ne \\$1 |
| 21 | .. |
| 22 | .de Ve \" End verbatim text |
| 23 | .ft R |
| 24 | .fi |
| 25 | .. |
| 26 | .\" Set up some character translations and predefined strings. \*(-- will |
| 27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| 29 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| 30 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| 31 | .\" nothing in troff, for use with C<>. |
| 32 | .tr \(*W- |
| 33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 | .ie n \{\ |
| 35 | . ds -- \(*W- |
| 36 | . ds PI pi |
| 37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 | . ds L" "" |
| 40 | . ds R" "" |
| 41 | . ds C` "" |
| 42 | . ds C' "" |
| 43 | 'br\} |
| 44 | .el\{\ |
| 45 | . ds -- \|\(em\| |
| 46 | . ds PI \(*p |
| 47 | . ds L" `` |
| 48 | . ds R" '' |
| 49 | 'br\} |
| 50 | .\" |
| 51 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
| 52 | .ie \n(.g .ds Aq \(aq |
| 53 | .el .ds Aq ' |
| 54 | .\" |
| 55 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 56 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 57 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 58 | .\" output yourself in some meaningful fashion. |
| 59 | .ie \nF \{\ |
| 60 | . de IX |
| 61 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 62 | .. |
| 63 | . nr % 0 |
| 64 | . rr F |
| 65 | .\} |
| 66 | .el \{\ |
| 67 | . de IX |
| 68 | .. |
| 69 | .\} |
| 70 | .\" |
| 71 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 72 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 73 | . \" fudge factors for nroff and troff |
| 74 | .if n \{\ |
| 75 | . ds #H 0 |
| 76 | . ds #V .8m |
| 77 | . ds #F .3m |
| 78 | . ds #[ \f1 |
| 79 | . ds #] \fP |
| 80 | .\} |
| 81 | .if t \{\ |
| 82 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 83 | . ds #V .6m |
| 84 | . ds #F 0 |
| 85 | . ds #[ \& |
| 86 | . ds #] \& |
| 87 | .\} |
| 88 | . \" simple accents for nroff and troff |
| 89 | .if n \{\ |
| 90 | . ds ' \& |
| 91 | . ds ` \& |
| 92 | . ds ^ \& |
| 93 | . ds , \& |
| 94 | . ds ~ ~ |
| 95 | . ds / |
| 96 | .\} |
| 97 | .if t \{\ |
| 98 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 99 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 100 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 101 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 102 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 103 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 104 | .\} |
| 105 | . \" troff and (daisy-wheel) nroff accents |
| 106 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 107 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 108 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 109 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 110 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 111 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 112 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 113 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 114 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 115 | . \" corrections for vroff |
| 116 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 117 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 118 | . \" for low resolution devices (crt and lpr) |
| 119 | .if \n(.H>23 .if \n(.V>19 \ |
| 120 | \{\ |
| 121 | . ds : e |
| 122 | . ds 8 ss |
| 123 | . ds o a |
| 124 | . ds d- d\h'-1'\(ga |
| 125 | . ds D- D\h'-1'\(hy |
| 126 | . ds th \o'bp' |
| 127 | . ds Th \o'LP' |
| 128 | . ds ae ae |
| 129 | . ds Ae AE |
| 130 | .\} |
| 131 | .rm #[ #] #H #V #F C |
| 132 | .\" ======================================================================== |
| 133 | .\" |
| 134 | .IX Title "EC 1" |
| 135 | .TH EC 1 "2009-01-11" "0.9.8j" "OpenSSL" |
| 136 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 137 | .\" way too many mistakes in technical documents. |
| 138 | .if n .ad l |
| 139 | .nh |
| 140 | .SH "NAME" |
| 141 | ec \- EC key processing |
| 142 | .SH "SYNOPSIS" |
| 143 | .IX Header "SYNOPSIS" |
| 144 | \&\fBopenssl\fR \fBec\fR |
| 145 | [\fB\-inform PEM|DER\fR] |
| 146 | [\fB\-outform PEM|DER\fR] |
| 147 | [\fB\-in filename\fR] |
| 148 | [\fB\-passin arg\fR] |
| 149 | [\fB\-out filename\fR] |
| 150 | [\fB\-passout arg\fR] |
| 151 | [\fB\-des\fR] |
| 152 | [\fB\-des3\fR] |
| 153 | [\fB\-idea\fR] |
| 154 | [\fB\-text\fR] |
| 155 | [\fB\-noout\fR] |
| 156 | [\fB\-param_out\fR] |
| 157 | [\fB\-pubin\fR] |
| 158 | [\fB\-pubout\fR] |
| 159 | [\fB\-conv_form arg\fR] |
| 160 | [\fB\-param_enc arg\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\s0 1: Elliptic Curve Cryptography' |
| 167 | (http://www.secg.org/). To convert a OpenSSL \s-1EC\s0 private key into the |
| 168 | PKCS#8 private key format use the \fBpkcs8\fR command. |
| 169 | .SH "COMMAND OPTIONS" |
| 170 | .IX Header "COMMAND OPTIONS" |
| 171 | .IP "\fB\-inform DER|PEM\fR" 4 |
| 172 | .IX Item "-inform DER|PEM" |
| 173 | This specifies the input format. The \fB\s-1DER\s0\fR option with a private key uses |
| 174 | an \s-1ASN\s0.1 \s-1DER\s0 encoded \s-1SEC1\s0 private key. When used with a public key it |
| 175 | uses the SubjectPublicKeyInfo structur as specified in \s-1RFC\s0 3280. |
| 176 | The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64 |
| 177 | encoded with additional header and footer lines. In the case of a private key |
| 178 | PKCS#8 format is also accepted. |
| 179 | .IP "\fB\-outform DER|PEM\fR" 4 |
| 180 | .IX Item "-outform DER|PEM" |
| 181 | This specifies the output format, the options have the same meaning as the |
| 182 | \&\fB\-inform\fR option. |
| 183 | .IP "\fB\-in filename\fR" 4 |
| 184 | .IX Item "-in filename" |
| 185 | This specifies the input filename to read a key from or standard input if this |
| 186 | option is not specified. If the key is encrypted a pass phrase will be |
| 187 | prompted for. |
| 188 | .IP "\fB\-passin arg\fR" 4 |
| 189 | .IX Item "-passin arg" |
| 190 | the input file password source. For more information about the format of \fBarg\fR |
| 191 | see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1). |
| 192 | .IP "\fB\-out filename\fR" 4 |
| 193 | .IX Item "-out filename" |
| 194 | This specifies the output filename to write a key to or standard output by |
| 195 | is not specified. If any encryption options are set then a pass phrase will be |
| 196 | prompted for. The output filename should \fBnot\fR be the same as the input |
| 197 | filename. |
| 198 | .IP "\fB\-passout arg\fR" 4 |
| 199 | .IX Item "-passout arg" |
| 200 | the output file password source. For more information about the format of \fBarg\fR |
| 201 | see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1). |
| 202 | .IP "\fB\-des|\-des3|\-idea\fR" 4 |
| 203 | .IX Item "-des|-des3|-idea" |
| 204 | These options encrypt the private key with the \s-1DES\s0, triple \s-1DES\s0, \s-1IDEA\s0 or |
| 205 | any other cipher supported by OpenSSL before outputting it. A pass phrase is |
| 206 | prompted for. |
| 207 | If none of these options is specified the key is written in plain text. This |
| 208 | means that using the \fBec\fR utility to read in an encrypted key with no |
| 209 | encryption option can be used to remove the pass phrase from a key, or by |
| 210 | setting the encryption options it can be use to add or change the pass phrase. |
| 211 | These options can only be used with \s-1PEM\s0 format output files. |
| 212 | .IP "\fB\-text\fR" 4 |
| 213 | .IX Item "-text" |
| 214 | prints out the public, private key components and parameters. |
| 215 | .IP "\fB\-noout\fR" 4 |
| 216 | .IX Item "-noout" |
| 217 | this option prevents output of the encoded version of the key. |
| 218 | .IP "\fB\-modulus\fR" 4 |
| 219 | .IX Item "-modulus" |
| 220 | this option prints out the value of the public key component of the key. |
| 221 | .IP "\fB\-pubin\fR" 4 |
| 222 | .IX Item "-pubin" |
| 223 | by default a private key is read from the input file: with this option a |
| 224 | public key is read instead. |
| 225 | .IP "\fB\-pubout\fR" 4 |
| 226 | .IX Item "-pubout" |
| 227 | by default a private key is output. With this option a public |
| 228 | key will be output instead. This option is automatically set if the input is |
| 229 | a public key. |
| 230 | .IP "\fB\-conv_form\fR" 4 |
| 231 | .IX Item "-conv_form" |
| 232 | This specifies how the points on the elliptic curve are converted |
| 233 | into octet strings. Possible values are: \fBcompressed\fR (the default |
| 234 | value), \fBuncompressed\fR and \fBhybrid\fR. For more information regarding |
| 235 | the point conversion forms please read the X9.62 standard. |
| 236 | \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled |
| 237 | by default for binary curves and can be enabled by defining |
| 238 | the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time. |
| 239 | .IP "\fB\-param_enc arg\fR" 4 |
| 240 | .IX Item "-param_enc arg" |
| 241 | This specifies how the elliptic curve parameters are encoded. |
| 242 | Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are |
| 243 | specified by a \s-1OID\s0, or \fBexplicit\fR where the ec parameters are |
| 244 | explicitly given (see \s-1RFC\s0 3279 for the definition of the |
| 245 | \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR. |
| 246 | \&\fBNote\fR the \fBimplicitlyCA\fR alternative ,as specified in \s-1RFC\s0 3279, |
| 247 | is currently not implemented in OpenSSL. |
| 248 | .IP "\fB\-engine id\fR" 4 |
| 249 | .IX Item "-engine id" |
| 250 | specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR |
| 251 | to attempt to obtain a functional reference to the specified engine, |
| 252 | thus initialising it if needed. The engine will then be set as the default |
| 253 | for all available algorithms. |
| 254 | .SH "NOTES" |
| 255 | .IX Header "NOTES" |
| 256 | The \s-1PEM\s0 private key format uses the header and footer lines: |
| 257 | .PP |
| 258 | .Vb 2 |
| 259 | \& \-\-\-\-\-BEGIN EC PRIVATE KEY\-\-\-\-\- |
| 260 | \& \-\-\-\-\-END EC PRIVATE KEY\-\-\-\-\- |
| 261 | .Ve |
| 262 | .PP |
| 263 | The \s-1PEM\s0 public key format uses the header and footer lines: |
| 264 | .PP |
| 265 | .Vb 2 |
| 266 | \& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\- |
| 267 | \& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\- |
| 268 | .Ve |
| 269 | .SH "EXAMPLES" |
| 270 | .IX Header "EXAMPLES" |
| 271 | To encrypt a private key using triple \s-1DES:\s0 |
| 272 | .PP |
| 273 | .Vb 1 |
| 274 | \& openssl ec \-in key.pem \-des3 \-out keyout.pem |
| 275 | .Ve |
| 276 | .PP |
| 277 | To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format: |
| 278 | .PP |
| 279 | .Vb 1 |
| 280 | \& openssl ec \-in key.pem \-outform DER \-out keyout.der |
| 281 | .Ve |
| 282 | .PP |
| 283 | To print out the components of a private key to standard output: |
| 284 | .PP |
| 285 | .Vb 1 |
| 286 | \& openssl ec \-in key.pem \-text \-noout |
| 287 | .Ve |
| 288 | .PP |
| 289 | To just output the public part of a private key: |
| 290 | .PP |
| 291 | .Vb 1 |
| 292 | \& openssl ec \-in key.pem \-pubout \-out pubkey.pem |
| 293 | .Ve |
| 294 | .PP |
| 295 | To change the parameters encoding to \fBexplicit\fR: |
| 296 | .PP |
| 297 | .Vb 1 |
| 298 | \& openssl ec \-in key.pem \-param_enc explicit \-out keyout.pem |
| 299 | .Ve |
| 300 | .PP |
| 301 | To change the point conversion form to \fBcompressed\fR: |
| 302 | .PP |
| 303 | .Vb 1 |
| 304 | \& openssl ec \-in key.pem \-conv_form compressed \-out keyout.pem |
| 305 | .Ve |
| 306 | .SH "SEE ALSO" |
| 307 | .IX Header "SEE ALSO" |
| 308 | \&\fIecparam\fR\|(1), \fIdsa\fR\|(1), \fIrsa\fR\|(1) |
| 309 | .SH "HISTORY" |
| 310 | .IX Header "HISTORY" |
| 311 | The ec command was first introduced in OpenSSL 0.9.8. |
| 312 | .SH "AUTHOR" |
| 313 | .IX Header "AUTHOR" |
| 314 | Nils Larsch for the OpenSSL project (http://www.openssl.org). |