795c52d5c55f13ccd1d1ace85011c39fc36a3616
[openssl.git] / doc / man1 / dsaparam.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-dsaparam,
6 dsaparam - DSA parameter manipulation and generation
7
8 =head1 SYNOPSIS
9
10 B<openssl dsaparam>
11 [B<-help>]
12 [B<-inform DER|PEM>]
13 [B<-outform DER|PEM>]
14 [B<-in filename>]
15 [B<-out filename>]
16 [B<-noout>]
17 [B<-text>]
18 [B<-C>]
19 [B<-rand file...>]
20 [B<-writerand file>]
21 [B<-genkey>]
22 [B<-engine id>]
23 [B<-verbose>]
24 [B<numbits>]
25
26 =head1 DESCRIPTION
27
28 This command is used to manipulate or generate DSA parameter files.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-help>
35
36 Print out a usage message.
37
38 =item B<-inform DER|PEM>
39
40 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
41 form compatible with RFC2459 (PKIX) DSS-Parms that is a SEQUENCE consisting
42 of p, q and g respectively. The PEM form is the default format: it consists
43 of the B<DER> format base64 encoded with additional header and footer lines.
44
45 =item B<-outform DER|PEM>
46
47 This specifies the output format, the options have the same meaning and default
48 as the B<-inform> option.
49
50 =item B<-in filename>
51
52 This specifies the input filename to read parameters from or standard input if
53 this option is not specified. If the B<numbits> parameter is included then
54 this option will be ignored.
55
56 =item B<-out filename>
57
58 This specifies the output filename parameters to. Standard output is used
59 if this option is not present. The output filename should B<not> be the same
60 as the input filename.
61
62 =item B<-noout>
63
64 This option inhibits the output of the encoded version of the parameters.
65
66 =item B<-text>
67
68 This option prints out the DSA parameters in human readable form.
69
70 =item B<-C>
71
72 This option converts the parameters into C code. The parameters can then
73 be loaded by calling the get_dsaXXX() function.
74
75 =item B<-genkey>
76
77 This option will generate a DSA either using the specified or generated
78 parameters.
79
80 =item B<-rand file...>
81
82 A file or files containing random data used to seed the random number
83 generator.
84 Multiple files can be specified separated by an OS-dependent character.
85 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
86 all others.
87
88 =item [B<-writerand file>]
89
90 Writes random data to the specified I<file> upon exit.
91 This can be used with a subsequent B<-rand> flag.
92
93 =item B<-engine id>
94
95 Specifying an engine (by its unique B<id> string) will cause B<dsaparam>
96 to attempt to obtain a functional reference to the specified engine,
97 thus initialising it if needed. The engine will then be set as the default
98 for all available algorithms.
99
100 =item B<-verbose>
101
102 Print extra details about the operations being performed.
103
104 =item B<numbits>
105
106 This option specifies that a parameter set should be generated of size
107 B<numbits>. It must be the last option. If this option is included then
108 the input file (if any) is ignored.
109
110 =back
111
112 =head1 NOTES
113
114 PEM format DSA parameters use the header and footer lines:
115
116  -----BEGIN DSA PARAMETERS-----
117  -----END DSA PARAMETERS-----
118
119 DSA parameter generation is a slow process and as a result the same set of
120 DSA parameters is often used to generate several distinct keys.
121
122 =head1 SEE ALSO
123
124 L<gendsa(1)>, L<dsa(1)>, L<genrsa(1)>,
125 L<rsa(1)>
126
127 =head1 COPYRIGHT
128
129 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
130
131 Licensed under the Apache License 2.0 (the "License").  You may not use
132 this file except in compliance with the License.  You can obtain a copy
133 in the file LICENSE in the source distribution or at
134 L<https://www.openssl.org/source/license.html>.
135
136 =cut