Add info about the header and footer lines used in PEM formats
[openssl.git] / doc / man / dsaparam.pod
1 =pod
2 =head1 NAME
3
4 dsaparam - DSA parameter manipulation and generation
5
6 =head1 SYNOPSIS
7
8 B<openssl dsaparam>
9 [B<-inform DER|PEM>]
10 [B<-outform DER|PEM>]
11 [B<-in filename>]
12 [B<-out filename>]
13 [B<-noout>]
14 [B<-text>]
15 [B<-C>]
16 [B<-rand file:file>]
17 [B<-genkey>]
18 [B<numbits>]
19
20 =head1 DESCRIPTION
21
22 This command is used to manipulate or generate DSA parameter files.
23
24 =head1 OPTIONS
25
26 =over 4
27
28 =item B<-inform DER|PEM>
29
30 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
31 form compatible with RFC2459 (PKIX) DSS-Parms that is a SEQUENCE consisting
32 of p, q and g respectively. The PEM form is the default format: it consists
33 of the B<DER> format base64 encoded with additional header and footer lines.
34
35 =item B<-outform DER|PEM>
36
37 This specifies the output format, the options have the same meaning as the 
38 B<-inform> option.
39
40 =item B<-in filename>
41
42 This specifies the input filename to read parameters from or standard input if
43 this option is not specified. If the B<numbits> parameter is included then
44 this option will be ignored.
45
46 =item B<-out filename>
47
48 This specifies the output filename parameters to. Standard output is used
49 if this option is not present. The output filename should B<not> be the same
50 as the input filename.
51
52 =item B<-noout>
53
54 this option inhibits the output of the encoded version of the parameters.
55
56 =item B<-text>
57
58 this option prints out the DSA parameters in human readable form.
59
60 =item B<-C>
61
62 this option converts the parameters into C code. The parameters can then
63 be loaded by calling the B<get_dsaXXX()> function.
64
65 =item B<-genkey>
66
67 this option will generate a DSA either using the specified or generated
68 parameters.
69
70 =item B<-rand file:file>
71
72 a file or files containing random data used to seed the random number
73 generator. Multiple files can be specified separated by B<:>.
74
75 =item B<numbits>
76
77 this option specifies that a parameter set should be generated of size
78 B<numbits>. It must be the last option. If this option is included then
79 the input file (if any) is ignored.
80
81 =back
82
83 =head1 NOTES
84
85 PEM format DSA parameters use the header and footer lines:
86
87  -----BEGIN DSA PARAMETERS-----
88  -----END DSA PARAMETERS-----
89
90 DSA parameter generation is a slow process and as a result the same set of
91 DSA parameters is often used to generate several distinct keys.
92
93 =head1 SEE ALSO
94
95 gendsa(1), dsa(1), genrsa(1), rsa(1)
96
97 =cut