Additional name for all commands
[openssl.git] / doc / man1 / ecparam.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-ecparam,
6 ecparam - EC parameter manipulation and generation
7
8 =head1 SYNOPSIS
9
10 B<openssl ecparam>
11 [B<-help>]
12 [B<-inform DER|PEM>]
13 [B<-outform DER|PEM>]
14 [B<-in filename>]
15 [B<-out filename>]
16 [B<-noout>]
17 [B<-text>]
18 [B<-C>]
19 [B<-check>]
20 [B<-name arg>]
21 [B<-list_curves>]
22 [B<-conv_form arg>]
23 [B<-param_enc arg>]
24 [B<-no_seed>]
25 [B<-rand file...>]
26 [B<-writerand file>]
27 [B<-genkey>]
28 [B<-engine id>]
29
30 =head1 DESCRIPTION
31
32 This command is used to manipulate or generate EC parameter files.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-help>
39
40 Print out a usage message.
41
42 =item B<-inform DER|PEM>
43
44 This specifies the input format. The B<DER> option uses an ASN.1 DER encoded
45 form compatible with RFC 3279 EcpkParameters. The PEM form is the default
46 format: it consists of the B<DER> format base64 encoded with additional
47 header and footer lines.
48
49 =item B<-outform DER|PEM>
50
51 This specifies the output format, the options have the same meaning and default
52 as the B<-inform> option.
53
54 =item B<-in filename>
55
56 This specifies the input filename to read parameters from or standard input if
57 this option is not specified.
58
59 =item B<-out filename>
60
61 This specifies the output filename parameters to. Standard output is used
62 if this option is not present. The output filename should B<not> be the same
63 as the input filename.
64
65 =item B<-noout>
66
67 This option inhibits the output of the encoded version of the parameters.
68
69 =item B<-text>
70
71 This option prints out the EC parameters in human readable form.
72
73 =item B<-C>
74
75 This option converts the EC parameters into C code. The parameters can then
76 be loaded by calling the get_ec_group_XXX() function.
77
78 =item B<-check>
79
80 Validate the elliptic curve parameters.
81
82 =item B<-name arg>
83
84 Use the EC parameters with the specified 'short' name. Use B<-list_curves>
85 to get a list of all currently implemented EC parameters.
86
87 =item B<-list_curves>
88
89 If this options is specified B<ecparam> will print out a list of all
90 currently implemented EC parameters names and exit.
91
92 =item B<-conv_form>
93
94 This specifies how the points on the elliptic curve are converted
95 into octet strings. Possible values are: B<compressed> (the default
96 value), B<uncompressed> and B<hybrid>. For more information regarding
97 the point conversion forms please read the X9.62 standard.
98 B<Note> Due to patent issues the B<compressed> option is disabled
99 by default for binary curves and can be enabled by defining
100 the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
101
102 =item B<-param_enc arg>
103
104 This specifies how the elliptic curve parameters are encoded.
105 Possible value are: B<named_curve>, i.e. the ec parameters are
106 specified by an OID, or B<explicit> where the ec parameters are
107 explicitly given (see RFC 3279 for the definition of the
108 EC parameters structures). The default value is B<named_curve>.
109 B<Note> the B<implicitlyCA> alternative, as specified in RFC 3279,
110 is currently not implemented in OpenSSL.
111
112 =item B<-no_seed>
113
114 This option inhibits that the 'seed' for the parameter generation
115 is included in the ECParameters structure (see RFC 3279).
116
117 =item B<-genkey>
118
119 This option will generate an EC private key using the specified parameters.
120
121 =item B<-rand file...>
122
123 A file or files containing random data used to seed the random number
124 generator.
125 Multiple files can be specified separated by an OS-dependent character.
126 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
127 all others.
128
129 =item [B<-writerand file>]
130
131 Writes random data to the specified I<file> upon exit.
132 This can be used with a subsequent B<-rand> flag.
133
134 =item B<-engine id>
135
136 Specifying an engine (by its unique B<id> string) will cause B<ecparam>
137 to attempt to obtain a functional reference to the specified engine,
138 thus initialising it if needed. The engine will then be set as the default
139 for all available algorithms.
140
141 =back
142
143 =head1 NOTES
144
145 PEM format EC parameters use the header and footer lines:
146
147  -----BEGIN EC PARAMETERS-----
148  -----END EC PARAMETERS-----
149
150 OpenSSL is currently not able to generate new groups and therefore
151 B<ecparam> can only create EC parameters from known (named) curves.
152
153 =head1 EXAMPLES
154
155 To create EC parameters with the group 'prime192v1':
156
157   openssl ecparam -out ec_param.pem -name prime192v1
158
159 To create EC parameters with explicit parameters:
160
161   openssl ecparam -out ec_param.pem -name prime192v1 -param_enc explicit
162
163 To validate given EC parameters:
164
165   openssl ecparam -in ec_param.pem -check
166
167 To create EC parameters and a private key:
168
169   openssl ecparam -out ec_key.pem -name prime192v1 -genkey
170
171 To change the point encoding to 'compressed':
172
173   openssl ecparam -in ec_in.pem -out ec_out.pem -conv_form compressed
174
175 To print out the EC parameters to standard output:
176
177   openssl ecparam -in ec_param.pem -noout -text
178
179 =head1 SEE ALSO
180
181 L<ec(1)>, L<dsaparam(1)>
182
183 =head1 COPYRIGHT
184
185 Copyright 2003-2017 The OpenSSL Project Authors. All Rights Reserved.
186
187 Licensed under the OpenSSL license (the "License").  You may not use
188 this file except in compliance with the License.  You can obtain a copy
189 in the file LICENSE in the source distribution or at
190 L<https://www.openssl.org/source/license.html>.
191
192 =cut