Debian Codegraph @

upstream/debian-unstable/man1/openssl-ecparam.1ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL-ECPARAM 1SSL"
58 .TH OPENSSL-ECPARAM 1SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 openssl\-ecparam \- EC parameter manipulation and generation
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl ecparam\fR
68 [\fB\-help\fR]
69 [\fB\-inform\fR \fBDER\fR|\fBPEM\fR]
70 [\fB\-outform\fR \fBDER\fR|\fBPEM\fR]
71 [\fB\-in\fR \fIfilename\fR]
72 [\fB\-out\fR \fIfilename\fR]
73 [\fB\-noout\fR]
74 [\fB\-text\fR]
75 [\fB\-check\fR]
76 [\fB\-check_named\fR]
77 [\fB\-name\fR \fIarg\fR]
78 [\fB\-list_curves\fR]
79 [\fB\-conv_form\fR \fIarg\fR]
80 [\fB\-param_enc\fR \fIarg\fR]
81 [\fB\-no_seed\fR]
82 [\fB\-genkey\fR]
83 [\fB\-engine\fR \fIid\fR]
84 [\fB\-rand\fR \fIfiles\fR]
85 [\fB\-writerand\fR \fIfile\fR]
86 [\fB\-provider\fR \fIname\fR]
87 [\fB\-provider\-path\fR \fIpath\fR]
88 [\fB\-provparam\fR \fI[name:]key=value\fR]
89 [\fB\-propquery\fR \fIpropq\fR]
90 .SH DESCRIPTION
91 .IX Header "DESCRIPTION"
92 This command is used to manipulate or generate EC parameter files.
93 .PP
94 OpenSSL is currently not able to generate new groups and therefore
95 this command can only create EC parameters from known (named) curves.
96 .SH OPTIONS
97 .IX Header "OPTIONS"
98 .IP \fB\-help\fR 4
99 .IX Item "-help"
100 Print out a usage message.
101 .IP "\fB\-inform\fR \fBDER\fR|\fBPEM\fR" 4
102 .IX Item "-inform DER|PEM"
103 The EC parameters input format; unspecified by default.
104 See \fBopenssl\-format\-options\fR\|(1) for details.
105 .IP "\fB\-outform\fR \fBDER\fR|\fBPEM\fR" 4
106 .IX Item "-outform DER|PEM"
107 The EC parameters output format; the default is \fBPEM\fR.
108 See \fBopenssl\-format\-options\fR\|(1) for details.
109 .Sp
110 Parameters are encoded as \fBEcpkParameters\fR as specified in IETF RFC 3279.
111 .IP "\fB\-in\fR \fIfilename\fR" 4
112 .IX Item "-in filename"
113 This specifies the input file to read parameters from or standard input if
114 this option is not specified.
115 .IP "\fB\-out\fR \fIfilename\fR" 4
116 .IX Item "-out filename"
117 This specifies the output filename parameters to. Standard output is used
118 if this option is not present.
119 The output filename can be the same as the input filename,
120 which leads to replacing the file contents.
121 Note that file I/O is not atomic. The output file is truncated and then written.
122 .IP \fB\-noout\fR 4
123 .IX Item "-noout"
124 This option inhibits the output of the encoded version of the parameters.
125 .IP \fB\-text\fR 4
126 .IX Item "-text"
127 This option prints out the EC parameters in human readable form.
128 .IP \fB\-check\fR 4
129 .IX Item "-check"
130 Validate the elliptic curve parameters.
131 .IP \fB\-check_named\fR 4
132 .IX Item "-check_named"
133 Validate the elliptic name curve parameters by checking if the curve parameters
134 match any built-in curves.
135 .IP "\fB\-name\fR \fIarg\fR" 4
136 .IX Item "-name arg"
137 Use the EC parameters with the specified 'short' name. Use \fB\-list_curves\fR
138 to get a list of all currently implemented EC parameters.
139 .IP \fB\-list_curves\fR 4
140 .IX Item "-list_curves"
141 Print out a list of all currently implemented EC parameters names and exit.
142 .IP "\fB\-conv_form\fR \fIarg\fR" 4
143 .IX Item "-conv_form arg"
144 This specifies how the points on the elliptic curve are converted
145 into octet strings. Possible values are: \fBcompressed\fR, \fBuncompressed\fR (the
146 default value) and \fBhybrid\fR. For more information regarding
147 the point conversion forms please read the X9.62 standard.
148 \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
149 by default for binary curves and can be enabled by defining
150 the preprocessor macro \fBOPENSSL_EC_BIN_PT_COMP\fR at compile time.
151 .IP "\fB\-param_enc\fR \fIarg\fR" 4
152 .IX Item "-param_enc arg"
153 This specifies how the elliptic curve parameters are encoded.
154 Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
155 specified by an OID, or \fBexplicit\fR where the ec parameters are
156 explicitly given (see RFC 3279 for the definition of the
157 EC parameters structures). The default value is \fBnamed_curve\fR.
158 \&\fBNote\fR the \fBimplicitlyCA\fR alternative, as specified in RFC 3279,
159 is currently not implemented in OpenSSL.
160 .IP \fB\-no_seed\fR 4
161 .IX Item "-no_seed"
162 This option inhibits that the 'seed' for the parameter generation
163 is included in the ECParameters structure (see RFC 3279).
164 .IP \fB\-genkey\fR 4
165 .IX Item "-genkey"
166 This option will generate an EC private key using the specified parameters.
167 .IP "\fB\-engine\fR \fIid\fR" 4
168 .IX Item "-engine id"
169 See "Engine Options" in \fBopenssl\fR\|(1).
170 This option is deprecated.
171 .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4
172 .IX Item "-rand files, -writerand file"
173 See "Random State Options" in \fBopenssl\fR\|(1) for details.
174 .IP "\fB\-provider\fR \fIname\fR" 4
175 .IX Item "-provider name"
176 .PD 0
177 .IP "\fB\-provider\-path\fR \fIpath\fR" 4
178 .IX Item "-provider-path path"
179 .IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
180 .IX Item "-provparam [name:]key=value"
181 .IP "\fB\-propquery\fR \fIpropq\fR" 4
182 .IX Item "-propquery propq"
183 .PD
184 See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
185 .PP
186 The \fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1) commands are capable
187 of performing all the operations this command can, as well as supporting
188 other public key types.
189 .SH EXAMPLES
190 .IX Header "EXAMPLES"
191 The documentation for the \fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1)
192 commands contains examples equivalent to the ones listed here.
193 .PP
194 To create EC parameters with the group 'prime192v1':
195 .PP
196 .Vb 1
197 \& openssl ecparam \-out ec_param.pem \-name prime192v1
198 .Ve
199 .PP
200 To create EC parameters with explicit parameters:
201 .PP
202 .Vb 1
203 \& openssl ecparam \-out ec_param.pem \-name prime192v1 \-param_enc explicit
204 .Ve
205 .PP
206 To validate given EC parameters:
207 .PP
208 .Vb 1
209 \& openssl ecparam \-in ec_param.pem \-check
210 .Ve
211 .PP
212 To create EC parameters and a private key:
213 .PP
214 .Vb 1
215 \& openssl ecparam \-out ec_key.pem \-name prime192v1 \-genkey
216 .Ve
217 .PP
218 To change the point encoding to 'compressed':
219 .PP
220 .Vb 1
221 \& openssl ecparam \-in ec_in.pem \-out ec_out.pem \-conv_form compressed
222 .Ve
223 .PP
224 To print out the EC parameters to standard output:
225 .PP
226 .Vb 1
227 \& openssl ecparam \-in ec_param.pem \-noout \-text
228 .Ve
229 .SH "SEE ALSO"
230 .IX Header "SEE ALSO"
231 \&\fBopenssl\fR\|(1),
232 \&\fBopenssl\-pkeyparam\fR\|(1),
233 \&\fBopenssl\-genpkey\fR\|(1),
234 \&\fBopenssl\-ec\fR\|(1),
235 \&\fBopenssl\-dsaparam\fR\|(1)
236 .SH HISTORY
237 .IX Header "HISTORY"
238 The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
239 .PP
240 The \fB\-C\fR option was removed in OpenSSL 3.0.
241 .SH COPYRIGHT
242 .IX Header "COPYRIGHT"
243 Copyright 2003\-2021 The OpenSSL Project Authors. All Rights Reserved.
244 .PP
245 Licensed under the Apache License 2.0 (the "License"). You may not use
246 this file except in compliance with the License. You can obtain a copy
247 in the file LICENSE in the source distribution or at
248 <https://www.openssl.org/source/license.html>.