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