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