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