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