Add references to the new passwd utility.
[openssl.git] / doc / apps / dhparam.pod
1 =pod
2
3 =head1 NAME
4
5 dhparam - DH parameter manipulation and generation
6
7 =head1 SYNOPSIS
8
9 B<openssl dh>
10 [B<-inform DER|PEM>]
11 [B<-outform DER|PEM>]
12 [B<-in filename>]
13 [B<-out filename>]
14 [B<-noout>]
15 [B<-text>]
16 [B<-C>]
17 [B<-2>]
18 [B<-5>]
19 [B<-rand file(s)>]
20 [numbits]
21
22 =head1 DESCRIPTION
23
24 This command is used to manipulate DH parameter files.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-inform DER|PEM>
31
32 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
33 form compatible with the PKCS#3 DHparameter structure. The PEM form is the
34 default format: it consists of the B<DER> format base64 encoded with
35 additional header and footer lines.
36
37 =item B<-outform DER|PEM>
38
39 This specifies the output format, the options have the same meaning as the 
40 B<-inform> option.
41
42 =item B<-in filename>
43
44 This specifies the input filename to read parameters from or standard input if
45 this option is not specified.
46
47 =item B<-out filename>
48
49 This specifies the output filename parameters to. Standard output is used
50 if this option is not present. The output filename should B<not> be the same
51 as the input filename.
52
53 =item B<-2>, B<-5>
54
55 The generator to use, either 2 or 5. 2 is the default. If present then the
56 input file is ignored and parameters are generated instead.
57
58 =item B<-rand file(s)>
59
60 a file or files containing random data used to seed the random number
61 generator. Multiple files can be specified separated by a OS-dependent
62 character.  For MS-Windows, the separator is B<;>.  For OpenVMS, it's
63 B<,>. For all others, it's B<:>.
64
65 =item B<numbits>
66
67 this option specifies that a parameter set should be generated of size
68 B<numbits>. It must be the last option. If not present then a value of 512
69 is used. If this option is present then the input file is ignored and 
70 parameters are generated instead.
71
72 =item B<-noout>
73
74 this option inhibits the output of the encoded version of the parameters.
75
76 =item B<-text>
77
78 this option prints out the DH parameters in human readable form.
79
80 =item B<-C>
81
82 this option converts the parameters into C code. The parameters can then
83 be loaded by calling the B<get_dhXXX()> function.
84
85 =back
86
87 =head1 WARNINGS
88
89 The program B<dhparam> combines the functionality of the programs B<dh> and
90 B<gendh> in previous versions of OpenSSL and SSLeay. The B<dh> and B<gendh>
91 programs are retained for now but may have different purposes in future 
92 versions of OpenSSL.
93
94 =head1 NOTES
95
96 PEM format DH parameters use the header and footer lines:
97
98  -----BEGIN DH PARAMETERS-----
99  -----END DH PARAMETERS-----
100
101 OpenSSL currently only supports the older PKCS#3 DH, not the newer X9.42
102 DH.
103
104 This program manipulates DH parameters not keys.
105
106 =head1 BUGS
107
108 There should be a way to generate and manipulate DH keys.
109
110 =head1 SEE ALSO
111
112 L<dsaparam(1)|dsaparam(1)>
113
114 =cut