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