Gets Lutz Jaenicke's name right this time :-)
[openssl.git] / doc / apps / gendh.pod
1 =pod
2
3 =head1 NAME
4
5 gendh - DH parameter generation
6
7 =head1 SYNOPSIS
8
9 B<openssl gendh>
10 [B<-out filename>]
11 [B<-2>]
12 [B<-5>]
13 [B<-rand file(s)>]
14 [numbits]
15
16 =head1 DESCRIPTION
17
18 This command is used to generate DH parameter files.
19
20 =head1 OPTIONS
21
22 =over 4
23
24 =item B<-out filename>
25
26 This specifies the output filename parameters to. Standard output is used
27 if this option is not present. The output format is a base64 encoded form of
28 a PKCS#5 DHParameter structure. 
29
30 =item B<-2>, B<-5>
31
32 The generator to use, either 2 or 5. 2 is the default.
33
34 =item B<-rand file(s)>
35
36 a file or files containing random data used to seed the random number
37 generator. Multiple files can be specified separated by a OS-dependent
38 character.  For MS-Windows, the separator is B<;>.  For OpenVMS, it's
39 B<,>.  For all others, it's B<:>.
40
41 =item B<numbits>
42
43 this option specifies that a parameter set should be generated of size
44 B<numbits>. It must be the last option. If not present then a value of 512
45 is used.
46
47 =back
48
49 =head1 NOTES
50
51 PEM format DH parameters use the header and footer lines:
52
53  -----BEGIN DH PARAMETERS-----
54  -----END DH PARAMETERS-----
55
56 DH parameter generation is a slow process and as a result the same set of
57 DH parameters is often reused.
58
59 OpenSSL currently uses PKCS#3 DH not the more recent X9.42 DH.
60
61 This program creates DH parameters only, not DH keys.
62
63 =head1 BUGS
64
65 The program is badly named. The programs B<gendsa> and B<genrsa> generate
66 actual keys and not parameters.
67
68 There should be a way to generate and manipulate DH keys.
69
70 =head1 SEE ALSO
71
72 dsaparam(1)
73
74 =cut