c15fdc9d0379bb7cb08d6e4e8415e1af2acc2a7c
[openssl.git] / doc / man1 / openssl-gendsa.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-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> I<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<-engine> I<id>]
26 [B<-verbose>]
27 {- $OpenSSL::safe::opt_r_synopsis -}
28 [I<paramfile>]
29
30 =for openssl ifdef engine
31
32 =head1 DESCRIPTION
33
34 This command generates a DSA private key from a DSA parameter file
35 (which will be typically generated by the L<openssl-dsaparam(1)> 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<-engine> I<id>
57
58 Specifying an engine (by its unique I<id> string) will cause this command
59 to attempt to obtain a functional reference to the specified engine,
60 thus initialising it if needed. The engine will then be set as the default
61 for all available algorithms.
62
63 =item B<-verbose>
64
65 Print extra details about the operations being performed.
66
67 =item I<paramfile>
68
69 The DSA parameter file to use. The parameters in this file determine
70 the size of the private key. DSA parameters can be generated and
71 examined using the L<openssl-dsaparam(1)> command.
72
73 {- $OpenSSL::safe::opt_r_item -}
74
75 =back
76
77 =head1 NOTES
78
79 DSA key generation is little more than random number generation so it is
80 much quicker that RSA key generation for example.
81
82 =head1 SEE ALSO
83
84 L<openssl(1)>,
85 L<openssl-dsaparam(1)>,
86 L<openssl-dsa(1)>,
87 L<openssl-genrsa(1)>,
88 L<openssl-rsa(1)>
89
90 =head1 COPYRIGHT
91
92 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
93
94 Licensed under the Apache License 2.0 (the "License").  You may not use
95 this file except in compliance with the License.  You can obtain a copy
96 in the file LICENSE in the source distribution or at
97 L<https://www.openssl.org/source/license.html>.
98
99 =cut