Debian Codegraph @

upstream/debian-unstable/man1/openssl-dsaparam.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-DSAPARAM 1SSL"
58 .TH OPENSSL-DSAPARAM 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\-dsaparam \- DSA parameter manipulation and generation
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl dsaparam\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\-genkey\fR]
76 [\fB\-verbose\fR]
77 [\fB\-quiet\fR]
78 [\fB\-rand\fR \fIfiles\fR]
79 [\fB\-writerand\fR \fIfile\fR]
80 [\fB\-engine\fR \fIid\fR]
81 [\fB\-provider\fR \fIname\fR]
82 [\fB\-provider\-path\fR \fIpath\fR]
83 [\fB\-provparam\fR \fI[name:]key=value\fR]
84 [\fB\-propquery\fR \fIpropq\fR]
85 [\fInumbits\fR]
86 [\fInumqbits\fR]
87 .SH DESCRIPTION
88 .IX Header "DESCRIPTION"
89 This command is used to manipulate or generate DSA parameter files.
90 .PP
91 DSA parameter generation can be a slow process and as a result the same set of
92 DSA parameters is often used to generate several distinct keys.
93 .SH OPTIONS
94 .IX Header "OPTIONS"
95 .IP \fB\-help\fR 4
96 .IX Item "-help"
97 Print out a usage message.
98 .IP "\fB\-inform\fR \fBDER\fR|\fBPEM\fR" 4
99 .IX Item "-inform DER|PEM"
100 The DSA parameters input format; unspecified by default.
101 See \fBopenssl\-format\-options\fR\|(1) for details.
102 .IP "\fB\-outform\fR \fBDER\fR|\fBPEM\fR" 4
103 .IX Item "-outform DER|PEM"
104 The DSA parameters output format; the default is \fBPEM\fR.
105 See \fBopenssl\-format\-options\fR\|(1) for details.
106 .Sp
107 Parameters are a sequence of \fBASN.1 INTEGER\fRs: \fBp\fR, \fBq\fR, and \fBg\fR.
108 This is compatible with RFC 3370 \fBDSS-Parms\fR structure.
109 .IP "\fB\-in\fR \fIfilename\fR" 4
110 .IX Item "-in filename"
111 This specifies the input file to read parameters from or standard input if
112 this option is not specified. If the \fInumbits\fR parameter is included then
113 this option will be ignored.
114 .IP "\fB\-out\fR \fIfilename\fR" 4
115 .IX Item "-out filename"
116 This specifies the output file to write parameters to. Standard output is used
117 if this option is not present.
118 The output filename can be the same as the input filename,
119 which leads to replacing the file contents.
120 Note that file I/O is not atomic. The output file is truncated and then written.
121 .IP \fB\-noout\fR 4
122 .IX Item "-noout"
123 This option inhibits the output of the encoded version of the parameters.
124 .IP \fB\-text\fR 4
125 .IX Item "-text"
126 This option prints out the DSA parameters in human readable form.
127 .IP \fB\-genkey\fR 4
128 .IX Item "-genkey"
129 This option will generate a DSA either using the specified or generated
130 parameters.
131 .IP \fB\-verbose\fR 4
132 .IX Item "-verbose"
133 Print extra details about the operations being performed.
134 .IP \fB\-quiet\fR 4
135 .IX Item "-quiet"
136 Print fewer details about the operations being performed, which may
137 be handy during batch scripts and pipelines.
138 .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4
139 .IX Item "-rand files, -writerand file"
140 See "Random State Options" in \fBopenssl\fR\|(1) for details.
141 .IP "\fB\-engine\fR \fIid\fR" 4
142 .IX Item "-engine id"
143 See "Engine Options" in \fBopenssl\fR\|(1).
144 This option is deprecated.
145 .IP \fInumbits\fR 4
146 .IX Item "numbits"
147 This optional argument specifies that a parameter set should be generated of
148 size \fInumbits\fR. If this argument is included then the input file (if any) is
149 ignored.
150 .IP \fInumqbits\fR 4
151 .IX Item "numqbits"
152 This optional argument specifies that a parameter set should be generated with
153 a subprime parameter q of size \fInumqbits\fR. It must be the last argument. If
154 this argument is included then the input file (if any) is ignored.
155 .IP "\fB\-provider\fR \fIname\fR" 4
156 .IX Item "-provider name"
157 .PD 0
158 .IP "\fB\-provider\-path\fR \fIpath\fR" 4
159 .IX Item "-provider-path path"
160 .IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
161 .IX Item "-provparam [name:]key=value"
162 .IP "\fB\-propquery\fR \fIpropq\fR" 4
163 .IX Item "-propquery propq"
164 .PD
165 See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
166 .SH "SEE ALSO"
167 .IX Header "SEE ALSO"
168 \&\fBopenssl\fR\|(1),
169 \&\fBopenssl\-pkeyparam\fR\|(1),
170 \&\fBopenssl\-gendsa\fR\|(1),
171 \&\fBopenssl\-dsa\fR\|(1),
172 \&\fBopenssl\-genrsa\fR\|(1),
173 \&\fBopenssl\-rsa\fR\|(1)
174 .SH HISTORY
175 .IX Header "HISTORY"
176 The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
177 .PP
178 The \fB\-C\fR option was removed in OpenSSL 3.0.
179 .SH COPYRIGHT
180 .IX Header "COPYRIGHT"
181 Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved.
182 .PP
183 Licensed under the Apache License 2.0 (the "License"). You may not use
184 this file except in compliance with the License. You can obtain a copy
185 in the file LICENSE in the source distribution or at
186 <https://www.openssl.org/source/license.html>.