Commit | Line | Data |
---|---|---|
e3261593 | 1 | .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19) |
a561f9ff SS |
2 | .\" |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
a561f9ff SS |
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 | |
e257b235 PA |
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- | |
a561f9ff SS |
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 | 'br\} | |
42 | .\" | |
e257b235 PA |
43 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
44 | .ie \n(.g .ds Aq \(aq | |
45 | .el .ds Aq ' | |
46 | .\" | |
a561f9ff | 47 | .\" If the F register is turned on, we'll generate index entries on stderr for |
01185282 | 48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
a561f9ff SS |
49 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
50 | .\" output yourself in some meaningful fashion. | |
e257b235 | 51 | .ie \nF \{\ |
a561f9ff SS |
52 | . de IX |
53 | . tm Index:\\$1\t\\n%\t"\\$2" | |
54 | .. | |
55 | . nr % 0 | |
56 | . rr F | |
57 | .\} | |
e257b235 PA |
58 | .el \{\ |
59 | . de IX | |
60 | .. | |
61 | .\} | |
aac4ff6f | 62 | .\" |
a561f9ff SS |
63 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
64 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
65 | . \" fudge factors for nroff and troff | |
66 | .if n \{\ | |
67 | . ds #H 0 | |
68 | . ds #V .8m | |
69 | . ds #F .3m | |
70 | . ds #[ \f1 | |
71 | . ds #] \fP | |
72 | .\} | |
73 | .if t \{\ | |
74 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
75 | . ds #V .6m | |
76 | . ds #F 0 | |
77 | . ds #[ \& | |
78 | . ds #] \& | |
79 | .\} | |
80 | . \" simple accents for nroff and troff | |
81 | .if n \{\ | |
82 | . ds ' \& | |
83 | . ds ` \& | |
84 | . ds ^ \& | |
85 | . ds , \& | |
86 | . ds ~ ~ | |
87 | . ds / | |
88 | .\} | |
89 | .if t \{\ | |
90 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
91 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
92 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
93 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
94 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
95 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
96 | .\} | |
97 | . \" troff and (daisy-wheel) nroff accents | |
98 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
99 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
100 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
101 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
102 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
103 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
104 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
105 | .ds ae a\h'-(\w'a'u*4/10)'e | |
106 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
107 | . \" corrections for vroff | |
108 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
109 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
110 | . \" for low resolution devices (crt and lpr) | |
111 | .if \n(.H>23 .if \n(.V>19 \ | |
112 | \{\ | |
113 | . ds : e | |
114 | . ds 8 ss | |
115 | . ds o a | |
116 | . ds d- d\h'-1'\(ga | |
117 | . ds D- D\h'-1'\(hy | |
118 | . ds th \o'bp' | |
119 | . ds Th \o'LP' | |
120 | . ds ae ae | |
121 | . ds Ae AE | |
122 | .\} | |
123 | .rm #[ #] #H #V #F C | |
124 | .\" ======================================================================== | |
125 | .\" | |
126 | .IX Title "ECPARAM 1" | |
e3261593 | 127 | .TH ECPARAM 1 "2012-01-04" "1.0.0f" "OpenSSL" |
e257b235 PA |
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
129 | .\" way too many mistakes in technical documents. | |
130 | .if n .ad l | |
131 | .nh | |
a561f9ff SS |
132 | .SH "NAME" |
133 | ecparam \- EC parameter manipulation and generation | |
134 | .SH "SYNOPSIS" | |
135 | .IX Header "SYNOPSIS" | |
136 | \&\fBopenssl ecparam\fR | |
137 | [\fB\-inform DER|PEM\fR] | |
138 | [\fB\-outform DER|PEM\fR] | |
139 | [\fB\-in filename\fR] | |
140 | [\fB\-out filename\fR] | |
141 | [\fB\-noout\fR] | |
142 | [\fB\-text\fR] | |
143 | [\fB\-C\fR] | |
144 | [\fB\-check\fR] | |
145 | [\fB\-name arg\fR] | |
146 | [\fB\-list_curve\fR] | |
147 | [\fB\-conv_form arg\fR] | |
148 | [\fB\-param_enc arg\fR] | |
149 | [\fB\-no_seed\fR] | |
150 | [\fB\-rand file(s)\fR] | |
151 | [\fB\-genkey\fR] | |
152 | [\fB\-engine id\fR] | |
153 | .SH "DESCRIPTION" | |
154 | .IX Header "DESCRIPTION" | |
155 | This command is used to manipulate or generate \s-1EC\s0 parameter files. | |
156 | .SH "OPTIONS" | |
157 | .IX Header "OPTIONS" | |
158 | .IP "\fB\-inform DER|PEM\fR" 4 | |
159 | .IX Item "-inform DER|PEM" | |
160 | This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN\s0.1 \s-1DER\s0 encoded | |
161 | form compatible with \s-1RFC\s0 3279 EcpkParameters. The \s-1PEM\s0 form is the default | |
162 | format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with additional | |
163 | header and footer lines. | |
164 | .IP "\fB\-outform DER|PEM\fR" 4 | |
165 | .IX Item "-outform DER|PEM" | |
166 | This specifies the output format, the options have the same meaning as the | |
167 | \&\fB\-inform\fR option. | |
168 | .IP "\fB\-in filename\fR" 4 | |
169 | .IX Item "-in filename" | |
170 | This specifies the input filename to read parameters from or standard input if | |
171 | this option is not specified. | |
172 | .IP "\fB\-out filename\fR" 4 | |
173 | .IX Item "-out filename" | |
174 | This specifies the output filename parameters to. Standard output is used | |
175 | if this option is not present. The output filename should \fBnot\fR be the same | |
176 | as the input filename. | |
177 | .IP "\fB\-noout\fR" 4 | |
178 | .IX Item "-noout" | |
179 | This option inhibits the output of the encoded version of the parameters. | |
180 | .IP "\fB\-text\fR" 4 | |
181 | .IX Item "-text" | |
182 | This option prints out the \s-1EC\s0 parameters in human readable form. | |
183 | .IP "\fB\-C\fR" 4 | |
184 | .IX Item "-C" | |
185 | This option converts the \s-1EC\s0 parameters into C code. The parameters can then | |
186 | be loaded by calling the \fB\f(BIget_ec_group_XXX()\fB\fR function. | |
187 | .IP "\fB\-check\fR" 4 | |
188 | .IX Item "-check" | |
189 | Validate the elliptic curve parameters. | |
190 | .IP "\fB\-name arg\fR" 4 | |
191 | .IX Item "-name arg" | |
192 | Use the \s-1EC\s0 parameters with the specified 'short' name. Use \fB\-list_curves\fR | |
193 | to get a list of all currently implemented \s-1EC\s0 parameters. | |
194 | .IP "\fB\-list_curves\fR" 4 | |
195 | .IX Item "-list_curves" | |
196 | If this options is specified \fBecparam\fR will print out a list of all | |
197 | currently implemented \s-1EC\s0 parameters names and exit. | |
198 | .IP "\fB\-conv_form\fR" 4 | |
199 | .IX Item "-conv_form" | |
200 | This specifies how the points on the elliptic curve are converted | |
201 | into octet strings. Possible values are: \fBcompressed\fR (the default | |
202 | value), \fBuncompressed\fR and \fBhybrid\fR. For more information regarding | |
203 | the point conversion forms please read the X9.62 standard. | |
204 | \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled | |
205 | by default for binary curves and can be enabled by defining | |
206 | the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time. | |
207 | .IP "\fB\-param_enc arg\fR" 4 | |
208 | .IX Item "-param_enc arg" | |
209 | This specifies how the elliptic curve parameters are encoded. | |
210 | Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are | |
211 | specified by a \s-1OID\s0, or \fBexplicit\fR where the ec parameters are | |
212 | explicitly given (see \s-1RFC\s0 3279 for the definition of the | |
213 | \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR. | |
214 | \&\fBNote\fR the \fBimplicitlyCA\fR alternative ,as specified in \s-1RFC\s0 3279, | |
215 | is currently not implemented in OpenSSL. | |
216 | .IP "\fB\-no_seed\fR" 4 | |
217 | .IX Item "-no_seed" | |
218 | This option inhibits that the 'seed' for the parameter generation | |
219 | is included in the ECParameters structure (see \s-1RFC\s0 3279). | |
220 | .IP "\fB\-genkey\fR" 4 | |
221 | .IX Item "-genkey" | |
222 | This option will generate a \s-1EC\s0 private key using the specified parameters. | |
223 | .IP "\fB\-rand file(s)\fR" 4 | |
224 | .IX Item "-rand file(s)" | |
225 | a file or files containing random data used to seed the random number | |
226 | generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)). | |
227 | Multiple files can be specified separated by a OS-dependent character. | |
e257b235 | 228 | The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for |
a561f9ff SS |
229 | all others. |
230 | .IP "\fB\-engine id\fR" 4 | |
231 | .IX Item "-engine id" | |
01185282 | 232 | specifying an engine (by its unique \fBid\fR string) will cause \fBecparam\fR |
a561f9ff SS |
233 | to attempt to obtain a functional reference to the specified engine, |
234 | thus initialising it if needed. The engine will then be set as the default | |
235 | for all available algorithms. | |
236 | .SH "NOTES" | |
237 | .IX Header "NOTES" | |
238 | \&\s-1PEM\s0 format \s-1EC\s0 parameters use the header and footer lines: | |
239 | .PP | |
240 | .Vb 2 | |
e257b235 PA |
241 | \& \-\-\-\-\-BEGIN EC PARAMETERS\-\-\-\-\- |
242 | \& \-\-\-\-\-END EC PARAMETERS\-\-\-\-\- | |
a561f9ff SS |
243 | .Ve |
244 | .PP | |
245 | OpenSSL is currently not able to generate new groups and therefore | |
e257b235 | 246 | \&\fBecparam\fR can only create \s-1EC\s0 parameters from known (named) curves. |
a561f9ff SS |
247 | .SH "EXAMPLES" |
248 | .IX Header "EXAMPLES" | |
249 | To create \s-1EC\s0 parameters with the group 'prime192v1': | |
250 | .PP | |
251 | .Vb 1 | |
e257b235 | 252 | \& openssl ecparam \-out ec_param.pem \-name prime192v1 |
a561f9ff SS |
253 | .Ve |
254 | .PP | |
255 | To create \s-1EC\s0 parameters with explicit parameters: | |
256 | .PP | |
257 | .Vb 1 | |
e257b235 | 258 | \& openssl ecparam \-out ec_param.pem \-name prime192v1 \-param_enc explicit |
a561f9ff SS |
259 | .Ve |
260 | .PP | |
261 | To validate given \s-1EC\s0 parameters: | |
262 | .PP | |
263 | .Vb 1 | |
e257b235 | 264 | \& openssl ecparam \-in ec_param.pem \-check |
a561f9ff SS |
265 | .Ve |
266 | .PP | |
267 | To create \s-1EC\s0 parameters and a private key: | |
268 | .PP | |
269 | .Vb 1 | |
e257b235 | 270 | \& openssl ecparam \-out ec_key.pem \-name prime192v1 \-genkey |
a561f9ff SS |
271 | .Ve |
272 | .PP | |
273 | To change the point encoding to 'compressed': | |
274 | .PP | |
275 | .Vb 1 | |
e257b235 | 276 | \& openssl ecparam \-in ec_in.pem \-out ec_out.pem \-conv_form compressed |
a561f9ff SS |
277 | .Ve |
278 | .PP | |
279 | To print out the \s-1EC\s0 parameters to standard output: | |
280 | .PP | |
281 | .Vb 1 | |
e257b235 | 282 | \& openssl ecparam \-in ec_param.pem \-noout \-text |
a561f9ff SS |
283 | .Ve |
284 | .SH "SEE ALSO" | |
285 | .IX Header "SEE ALSO" | |
286 | \&\fIec\fR\|(1), \fIdsaparam\fR\|(1) | |
287 | .SH "HISTORY" | |
288 | .IX Header "HISTORY" | |
289 | The ecparam command was first introduced in OpenSSL 0.9.8. | |
290 | .SH "AUTHOR" | |
291 | .IX Header "AUTHOR" | |
292 | Nils Larsch for the OpenSSL project (http://www.openssl.org) |