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