xref: /openssl/doc/man1/openssl-dsaparam.pod.in (revision da1c088f)
1=pod
2{- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4=head1 NAME
5
6openssl-dsaparam - DSA parameter manipulation and generation
7
8=head1 SYNOPSIS
9
10B<openssl dsaparam>
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<-genkey>]
19[B<-verbose>]
20[B<-quiet>]
21{- $OpenSSL::safe::opt_r_synopsis -}
22{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
23[I<numbits>]
24[I<numqbits>]
25
26=head1 DESCRIPTION
27
28This command is used to manipulate or generate DSA parameter files.
29
30DSA parameter generation can be a slow process and as a result the same set of
31DSA parameters is often used to generate several distinct keys.
32
33=head1 OPTIONS
34
35=over 4
36
37=item B<-help>
38
39Print out a usage message.
40
41=item B<-inform> B<DER>|B<PEM>
42
43The DSA parameters input format; unspecified by default.
44See L<openssl-format-options(1)> for details.
45
46=item B<-outform> B<DER>|B<PEM>
47
48The DSA parameters output format; the default is B<PEM>.
49See L<openssl-format-options(1)> for details.
50
51Parameters are a sequence of B<ASN.1 INTEGER>s: B<p>, B<q>, and B<g>.
52This is compatible with RFC 2459 B<DSS-Parms> structure.
53
54=item B<-in> I<filename>
55
56This specifies the input filename to read parameters from or standard input if
57this option is not specified. If the I<numbits> parameter is included then
58this option will be ignored.
59
60=item B<-out> I<filename>
61
62This specifies the output filename parameters to. Standard output is used
63if this option is not present. The output filename should B<not> be the same
64as the input filename.
65
66=item B<-noout>
67
68This option inhibits the output of the encoded version of the parameters.
69
70=item B<-text>
71
72This option prints out the DSA parameters in human readable form.
73
74=item B<-genkey>
75
76This option will generate a DSA either using the specified or generated
77parameters.
78
79
80=item B<-verbose>
81
82Print extra details about the operations being performed.
83
84=item B<-quiet>
85
86Print fewer details about the operations being performed, which may
87be handy during batch scripts and pipelines.
88
89{- $OpenSSL::safe::opt_r_item -}
90
91{- $OpenSSL::safe::opt_engine_item -}
92
93=item I<numbits>
94
95This optional argument specifies that a parameter set should be generated of
96size I<numbits>. If this argument is included then the input file (if any) is
97ignored.
98
99=item I<numqbits>
100
101This optional argument specifies that a parameter set should be generated with
102a subprime parameter q of size I<numqbits>. It must be the last argument. If
103this argument is included then the input file (if any) is ignored.
104
105{- $OpenSSL::safe::opt_provider_item -}
106
107=back
108
109=head1 SEE ALSO
110
111L<openssl(1)>,
112L<openssl-pkeyparam(1)>,
113L<openssl-gendsa(1)>,
114L<openssl-dsa(1)>,
115L<openssl-genrsa(1)>,
116L<openssl-rsa(1)>
117
118=head1 HISTORY
119
120The B<-engine> option was deprecated in OpenSSL 3.0.
121
122The B<-C> option was removed in OpenSSL 3.0.
123
124=head1 COPYRIGHT
125
126Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.
127
128Licensed under the Apache License 2.0 (the "License").  You may not use
129this file except in compliance with the License.  You can obtain a copy
130in the file LICENSE in the source distribution or at
131L<https://www.openssl.org/source/license.html>.
132
133=cut
134