Following the license change, modify the boilerplates in doc/man1/
[openssl.git] / doc / man1 / gendsa.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-gendsa,
6 gendsa - generate a DSA private key from a set of parameters
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<gendsa>
11 [B<-help>]
12 [B<-out filename>]
13 [B<-aes128>]
14 [B<-aes192>]
15 [B<-aes256>]
16 [B<-aria128>]
17 [B<-aria192>]
18 [B<-aria256>]
19 [B<-camellia128>]
20 [B<-camellia192>]
21 [B<-camellia256>]
22 [B<-des>]
23 [B<-des3>]
24 [B<-idea>]
25 [B<-rand file...>]
26 [B<-writerand file>]
27 [B<-engine id>]
28 [B<paramfile>]
29
30 =head1 DESCRIPTION
31
32 The B<gendsa> command generates a DSA private key from a DSA parameter file
33 (which will be typically generated by the B<openssl dsaparam> command).
34
35 =head1 OPTIONS
36
37 =over 4
38
39 =item B<-help>
40
41 Print out a usage message.
42
43 =item B<-out filename>
44
45 Output the key to the specified file. If this argument is not specified then
46 standard output is used.
47
48 =item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>
49
50 These options encrypt the private key with specified
51 cipher before outputting it. A pass phrase is prompted for.
52 If none of these options is specified no encryption is used.
53
54 =item B<-rand file...>
55
56 A file or files containing random data used to seed the random number
57 generator.
58 Multiple files can be specified separated by an OS-dependent character.
59 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
60 all others.
61
62 =item [B<-writerand file>]
63
64 Writes random data to the specified I<file> upon exit.
65 This can be used with a subsequent B<-rand> flag.
66
67 =item B<-engine id>
68
69 Specifying an engine (by its unique B<id> string) will cause B<gendsa>
70 to attempt to obtain a functional reference to the specified engine,
71 thus initialising it if needed. The engine will then be set as the default
72 for all available algorithms.
73
74 =item B<paramfile>
75
76 This option specifies the DSA parameter file to use. The parameters in this
77 file determine the size of the private key. DSA parameters can be generated
78 and examined using the B<openssl dsaparam> command.
79
80 =back
81
82 =head1 NOTES
83
84 DSA key generation is little more than random number generation so it is
85 much quicker that RSA key generation for example.
86
87 =head1 SEE ALSO
88
89 L<dsaparam(1)>, L<dsa(1)>, L<genrsa(1)>,
90 L<rsa(1)>
91
92 =head1 COPYRIGHT
93
94 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
95
96 Licensed under the Apache License 2.0 (the "License").  You may not use
97 this file except in compliance with the License.  You can obtain a copy
98 in the file LICENSE in the source distribution or at
99 L<https://www.openssl.org/source/license.html>.
100
101 =cut