Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / usr.bin / openssl / man / ec.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
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.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
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 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
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 "2008-09-06" "0.9.8h" "OpenSSL"
133 .SH "NAME"
134 ec \- EC key processing
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBopenssl\fR \fBec\fR
138 [\fB\-inform PEM|DER\fR]
139 [\fB\-outform PEM|DER\fR]
140 [\fB\-in filename\fR]
141 [\fB\-passin arg\fR]
142 [\fB\-out filename\fR]
143 [\fB\-passout arg\fR]
144 [\fB\-des\fR]
145 [\fB\-des3\fR]
146 [\fB\-idea\fR]
147 [\fB\-text\fR]
148 [\fB\-noout\fR]
149 [\fB\-param_out\fR]
150 [\fB\-pubin\fR]
151 [\fB\-pubout\fR]
152 [\fB\-conv_form arg\fR]
153 [\fB\-param_enc arg\fR]
154 [\fB\-engine id\fR]
155 .SH "DESCRIPTION"
156 .IX Header "DESCRIPTION"
157 The \fBec\fR command processes \s-1EC\s0 keys. They can be converted between various
158 forms and their components printed out. \fBNote\fR OpenSSL uses the 
159 private key format specified in '\s-1SEC\s0 1: Elliptic Curve Cryptography'
160 (http://www.secg.org/). To convert a OpenSSL \s-1EC\s0 private key into the
161 PKCS#8 private key format use the \fBpkcs8\fR command.
162 .SH "COMMAND OPTIONS"
163 .IX Header "COMMAND OPTIONS"
164 .IP "\fB\-inform DER|PEM\fR" 4
165 .IX Item "-inform DER|PEM"
166 This specifies the input format. The \fB\s-1DER\s0\fR option with a private key uses
167 an \s-1ASN\s0.1 \s-1DER\s0 encoded \s-1SEC1\s0 private key. When used with a public key it
168 uses the SubjectPublicKeyInfo structur as specified in \s-1RFC\s0 3280.
169 The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
170 encoded with additional header and footer lines. In the case of a private key
171 PKCS#8 format is also accepted.
172 .IP "\fB\-outform DER|PEM\fR" 4
173 .IX Item "-outform DER|PEM"
174 This specifies the output format, the options have the same meaning as the 
175 \&\fB\-inform\fR option.
176 .IP "\fB\-in filename\fR" 4
177 .IX Item "-in filename"
178 This specifies the input filename to read a key from or standard input if this
179 option is not specified. If the key is encrypted a pass phrase will be
180 prompted for.
181 .IP "\fB\-passin arg\fR" 4
182 .IX Item "-passin arg"
183 the input file password source. For more information about the format of \fBarg\fR
184 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
185 .IP "\fB\-out filename\fR" 4
186 .IX Item "-out filename"
187 This specifies the output filename to write a key to or standard output by
188 is not specified. If any encryption options are set then a pass phrase will be
189 prompted for. The output filename should \fBnot\fR be the same as the input
190 filename.
191 .IP "\fB\-passout arg\fR" 4
192 .IX Item "-passout arg"
193 the output file password source. For more information about the format of \fBarg\fR
194 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
195 .IP "\fB\-des|\-des3|\-idea\fR" 4
196 .IX Item "-des|-des3|-idea"
197 These options encrypt the private key with the \s-1DES\s0, triple \s-1DES\s0, \s-1IDEA\s0 or 
198 any other cipher supported by OpenSSL before outputting it. A pass phrase is
199 prompted for.
200 If none of these options is specified the key is written in plain text. This
201 means that using the \fBec\fR utility to read in an encrypted key with no
202 encryption option can be used to remove the pass phrase from a key, or by
203 setting the encryption options it can be use to add or change the pass phrase.
204 These options can only be used with \s-1PEM\s0 format output files.
205 .IP "\fB\-text\fR" 4
206 .IX Item "-text"
207 prints out the public, private key components and parameters.
208 .IP "\fB\-noout\fR" 4
209 .IX Item "-noout"
210 this option prevents output of the encoded version of the key.
211 .IP "\fB\-modulus\fR" 4
212 .IX Item "-modulus"
213 this option prints out the value of the public key component of the key.
214 .IP "\fB\-pubin\fR" 4
215 .IX Item "-pubin"
216 by default a private key is read from the input file: with this option a
217 public key is read instead.
218 .IP "\fB\-pubout\fR" 4
219 .IX Item "-pubout"
220 by default a private key is output. With this option a public
221 key will be output instead. This option is automatically set if the input is
222 a public key.
223 .IP "\fB\-conv_form\fR" 4
224 .IX Item "-conv_form"
225 This specifies how the points on the elliptic curve are converted
226 into octet strings. Possible values are: \fBcompressed\fR (the default
227 value), \fBuncompressed\fR and \fBhybrid\fR. For more information regarding
228 the point conversion forms please read the X9.62 standard.
229 \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
230 by default for binary curves and can be enabled by defining
231 the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
232 .IP "\fB\-param_enc arg\fR" 4
233 .IX Item "-param_enc arg"
234 This specifies how the elliptic curve parameters are encoded.
235 Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
236 specified by a \s-1OID\s0, or \fBexplicit\fR where the ec parameters are
237 explicitly given (see \s-1RFC\s0 3279 for the definition of the 
238 \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
239 \&\fBNote\fR the \fBimplicitlyCA\fR alternative ,as specified in \s-1RFC\s0 3279,
240 is currently not implemented in OpenSSL.
241 .IP "\fB\-engine id\fR" 4
242 .IX Item "-engine id"
243 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
244 to attempt to obtain a functional reference to the specified engine,
245 thus initialising it if needed. The engine will then be set as the default
246 for all available algorithms.
247 .SH "NOTES"
248 .IX Header "NOTES"
249 The \s-1PEM\s0 private key format uses the header and footer lines:
250 .PP
251 .Vb 2
252 \& -----BEGIN EC PRIVATE KEY-----
253 \& -----END EC PRIVATE KEY-----
254 .Ve
255 .PP
256 The \s-1PEM\s0 public key format uses the header and footer lines:
257 .PP
258 .Vb 2
259 \& -----BEGIN PUBLIC KEY-----
260 \& -----END PUBLIC KEY-----
261 .Ve
262 .SH "EXAMPLES"
263 .IX Header "EXAMPLES"
264 To encrypt a private key using triple \s-1DES:\s0
265 .PP
266 .Vb 1
267 \& openssl ec -in key.pem -des3 -out keyout.pem
268 .Ve
269 .PP
270 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format: 
271 .PP
272 .Vb 1
273 \& openssl ec -in key.pem -outform DER -out keyout.der
274 .Ve
275 .PP
276 To print out the components of a private key to standard output:
277 .PP
278 .Vb 1
279 \& openssl ec -in key.pem -text -noout
280 .Ve
281 .PP
282 To just output the public part of a private key:
283 .PP
284 .Vb 1
285 \& openssl ec -in key.pem -pubout -out pubkey.pem
286 .Ve
287 .PP
288 To change the parameters encoding to \fBexplicit\fR:
289 .PP
290 .Vb 1
291 \& openssl ec -in key.pem -param_enc explicit -out keyout.pem
292 .Ve
293 .PP
294 To change the point conversion form to \fBcompressed\fR:
295 .PP
296 .Vb 1
297 \& openssl ec -in key.pem -conv_form compressed -out keyout.pem
298 .Ve
299 .SH "SEE ALSO"
300 .IX Header "SEE ALSO"
301 \&\fIecparam\fR\|(1), \fIdsa\fR\|(1), \fIrsa\fR\|(1)
302 .SH "HISTORY"
303 .IX Header "HISTORY"
304 The ec command was first introduced in OpenSSL 0.9.8.
305 .SH "AUTHOR"
306 .IX Header "AUTHOR"
307 Nils Larsch for the OpenSSL project (http://www.openssl.org).