]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/man/dh.pod
Manpages for the DH utils and fix for a memory leak in dh program
[thirdparty/openssl.git] / doc / man / dh.pod
CommitLineData
ef7eaa4c
DSH
1=pod
2
3=head1 NAME
4
5dh - DH parameter manipulation and generation
6
7=head1 SYNOPSIS
8
9B<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
18=head1 DESCRIPTION
19
20This command is used to manipulate DH parameter files.
21
22=head1 OPTIONS
23
24=over 4
25
26=item B<-inform DER|PEM>
27
28This specifies the input format. The B<DER> option uses an ASN1 DER encoded
29form compatible with the PKCS#3 DHparameter structure. The PEM form is the
30default format: it consists of the B<DER> format base64 encoded with
31additional header and footer lines.
32
33=item B<-outform DER|PEM>
34
35This specifies the output format, the options have the same meaning as the
36B<-inform> option.
37
38=item B<-in filename>
39
40This specifies the input filename to read parameters from or standard input if
41this option is not specified.
42
43=item B<-out filename>
44
45This specifies the output filename parameters to. Standard output is used
46if this option is not present. The output filename should B<not> be the same
47as the input filename.
48
49=item B<-noout>
50
51this option inhibits the output of the encoded version of the parameters.
52
53=item B<-text>
54
55this option prints out the DH parameters in human readable form.
56
57=item B<-C>
58
59this option converts the parameters into C code. The parameters can then
60be loaded by calling the B<get_dhXXX()> function.
61
62=back
63
64=head1 NOTES
65
66PEM format DH parameters use the header and footer lines:
67
68 -----BEGIN DH PARAMETERS-----
69 -----END DH PARAMETERS-----
70
71OpenSSL currently only supports the older PKCS#3 DH, not the newer X9.42
72DH.
73
74This program manipulates DH parameters not keys.
75
76=head1 BUGS
77
78This program is badly named: the B<rsa> and B<dsa> programs manipulate keys
79and not parameters.
80
81There should be a way to generate and manipulate DH keys.
82
83=head1 SEE ALSO
84
85dsaparam(1)
86
87=cut