Documentation updates
[openssl.git] / doc / man1 / gendsa.pod
1 =pod
2
3 =head1 NAME
4
5 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 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 file(s)>]
25 [B<-engine id>]
26 [B<paramfile>]
27
28 =head1 DESCRIPTION
29
30 The B<gendsa> command generates a DSA private key from a DSA parameter file
31 (which will be typically generated by the B<openssl dsaparam> command).
32
33 =head1 OPTIONS
34
35 =over 4
36
37 =item B<-help>
38
39 Print out a usage message.
40
41 =item B<-out filename>
42
43 Output the key to the specified file. If this argument is not specified then
44 standard output is used.
45
46 =item B<-aes128|-aes192|-aes256|-aria128|-aria192|-aria256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea>
47
48 These options encrypt the private key with specified
49 cipher before outputting it. A pass phrase is prompted for.
50 If none of these options is specified no encryption is used.
51
52 =item B<-rand file(s)>
53
54 A file or files containing random data used to seed the random number
55 generator, or an EGD socket (see L<RAND_egd(3)>).
56 Multiple files can be specified separated by an OS-dependent character.
57 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
58 all others.
59
60 =item B<-engine id>
61
62 Specifying an engine (by its unique B<id> string) will cause B<gendsa>
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<paramfile>
68
69 This option specifies the DSA parameter file to use. The parameters in this
70 file determine the size of the private key. DSA parameters can be generated
71 and examined using the B<openssl dsaparam> command.
72
73 =back
74
75 =head1 NOTES
76
77 DSA key generation is little more than random number generation so it is
78 much quicker that RSA key generation for example.
79
80 =head1 SEE ALSO
81
82 L<dsaparam(1)>, L<dsa(1)>, L<genrsa(1)>,
83 L<rsa(1)>
84
85 =head1 COPYRIGHT
86
87 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
88
89 Licensed under the OpenSSL license (the "License").  You may not use
90 this file except in compliance with the License.  You can obtain a copy
91 in the file LICENSE in the source distribution or at
92 L<https://www.openssl.org/source/license.html>.
93
94 =cut