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