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