xref: /openssl/doc/man1/openssl-dsaparam.pod.in (revision 32189981)
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 file 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 file to write parameters to. Standard output is used
63if this option is not present.
64The output filename can be the same as the input filename,
65which leads to replacing the file contents.
66Note that file I/O is not atomic. The output file is truncated and then written.
67
68=item B<-noout>
69
70This option inhibits the output of the encoded version of the parameters.
71
72=item B<-text>
73
74This option prints out the DSA parameters in human readable form.
75
76=item B<-genkey>
77
78This option will generate a DSA either using the specified or generated
79parameters.
80
81
82=item B<-verbose>
83
84Print extra details about the operations being performed.
85
86=item B<-quiet>
87
88Print fewer details about the operations being performed, which may
89be handy during batch scripts and pipelines.
90
91{- $OpenSSL::safe::opt_r_item -}
92
93{- $OpenSSL::safe::opt_engine_item -}
94
95=item I<numbits>
96
97This optional argument specifies that a parameter set should be generated of
98size I<numbits>. If this argument is included then the input file (if any) is
99ignored.
100
101=item I<numqbits>
102
103This optional argument specifies that a parameter set should be generated with
104a subprime parameter q of size I<numqbits>. It must be the last argument. If
105this argument is included then the input file (if any) is ignored.
106
107{- $OpenSSL::safe::opt_provider_item -}
108
109=back
110
111=head1 SEE ALSO
112
113L<openssl(1)>,
114L<openssl-pkeyparam(1)>,
115L<openssl-gendsa(1)>,
116L<openssl-dsa(1)>,
117L<openssl-genrsa(1)>,
118L<openssl-rsa(1)>
119
120=head1 HISTORY
121
122The B<-engine> option was deprecated in OpenSSL 3.0.
123
124The B<-C> option was removed in OpenSSL 3.0.
125
126=head1 COPYRIGHT
127
128Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.
129
130Licensed under the Apache License 2.0 (the "License").  You may not use
131this file except in compliance with the License.  You can obtain a copy
132in the file LICENSE in the source distribution or at
133L<https://www.openssl.org/source/license.html>.
134
135=cut
136