c8391b481f7b913ad0527218768b0c92666af799
[openssl.git] / doc / man1 / openssl-ecparam.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-ecparam - EC parameter manipulation and generation
7
8 =head1 SYNOPSIS
9
10 B<openssl ecparam>
11 [B<-help>]
12 [B<-inform> B<DER>|B<PEM>]
13 [B<-outform> B<DER>|B<PEM>]
14 [B<-in> I<filename>]
15 [B<-out> I<filename>]
16 [B<-noout>]
17 [B<-text>]
18 [B<-C>]
19 [B<-check>]
20 [B<-check_named>]
21 [B<-name> I<arg>]
22 [B<-list_curves>]
23 [B<-conv_form> I<arg>]
24 [B<-param_enc> I<arg>]
25 [B<-no_seed>]
26 [B<-genkey>]
27 {- $OpenSSL::safe::opt_engine_synopsis -}
28 {- $OpenSSL::safe::opt_r_synopsis -}
29
30 =for openssl ifdef engine
31
32 =head1 DESCRIPTION
33
34 This command has been deprecated.
35 The L<openssl-genpkey(1)> and L<openssl-pkeyparam(1)> commands
36 should be used instead.
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 {- $OpenSSL::safe::opt_engine_item -}
130
131 {- $OpenSSL::safe::opt_r_item -}
132
133 =back
134
135 =head1 EXAMPLES
136
137 To create EC parameters with the group 'prime192v1':
138
139   openssl ecparam -out ec_param.pem -name prime192v1
140
141 To create EC parameters with explicit parameters:
142
143   openssl ecparam -out ec_param.pem -name prime192v1 -param_enc explicit
144
145 To validate given EC parameters:
146
147   openssl ecparam -in ec_param.pem -check
148
149 To create EC parameters and a private key:
150
151   openssl ecparam -out ec_key.pem -name prime192v1 -genkey
152
153 To change the point encoding to 'compressed':
154
155   openssl ecparam -in ec_in.pem -out ec_out.pem -conv_form compressed
156
157 To print out the EC parameters to standard output:
158
159   openssl ecparam -in ec_param.pem -noout -text
160
161 =head1 SEE ALSO
162
163 L<openssl(1)>,
164 L<openssl-pkeyparam(1)>,
165 L<openssl-genpkey(1)>,
166 L<openssl-ec(1)>,
167 L<openssl-dsaparam(1)>
168
169 =head1 HISTORY
170
171 This command was deprecated in OpenSSL 3.0.
172
173 =head1 COPYRIGHT
174
175 Copyright 2003-2020 The OpenSSL Project Authors. All Rights Reserved.
176
177 Licensed under the Apache License 2.0 (the "License").  You may not use
178 this file except in compliance with the License.  You can obtain a copy
179 in the file LICENSE in the source distribution or at
180 L<https://www.openssl.org/source/license.html>.
181
182 =cut