xref: /onnv-gate/usr/src/common/openssl/doc/apps/dsaparam.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948dsaparam - DSA parameter manipulation and generation
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948B<openssl dsaparam>
10*2175Sjp161948[B<-inform DER|PEM>]
11*2175Sjp161948[B<-outform DER|PEM>]
12*2175Sjp161948[B<-in filename>]
13*2175Sjp161948[B<-out filename>]
14*2175Sjp161948[B<-noout>]
15*2175Sjp161948[B<-text>]
16*2175Sjp161948[B<-C>]
17*2175Sjp161948[B<-rand file(s)>]
18*2175Sjp161948[B<-genkey>]
19*2175Sjp161948[B<-engine id>]
20*2175Sjp161948[B<numbits>]
21*2175Sjp161948
22*2175Sjp161948=head1 DESCRIPTION
23*2175Sjp161948
24*2175Sjp161948This command is used to manipulate or generate DSA parameter files.
25*2175Sjp161948
26*2175Sjp161948=head1 OPTIONS
27*2175Sjp161948
28*2175Sjp161948=over 4
29*2175Sjp161948
30*2175Sjp161948=item B<-inform DER|PEM>
31*2175Sjp161948
32*2175Sjp161948This specifies the input format. The B<DER> option uses an ASN1 DER encoded
33*2175Sjp161948form compatible with RFC2459 (PKIX) DSS-Parms that is a SEQUENCE consisting
34*2175Sjp161948of p, q and g respectively. The PEM form is the default format: it consists
35*2175Sjp161948of the B<DER> format base64 encoded with additional header and footer lines.
36*2175Sjp161948
37*2175Sjp161948=item B<-outform DER|PEM>
38*2175Sjp161948
39*2175Sjp161948This specifies the output format, the options have the same meaning as the
40*2175Sjp161948B<-inform> option.
41*2175Sjp161948
42*2175Sjp161948=item B<-in filename>
43*2175Sjp161948
44*2175Sjp161948This specifies the input filename to read parameters from or standard input if
45*2175Sjp161948this option is not specified. If the B<numbits> parameter is included then
46*2175Sjp161948this option will be ignored.
47*2175Sjp161948
48*2175Sjp161948=item B<-out filename>
49*2175Sjp161948
50*2175Sjp161948This specifies the output filename parameters to. Standard output is used
51*2175Sjp161948if this option is not present. The output filename should B<not> be the same
52*2175Sjp161948as the input filename.
53*2175Sjp161948
54*2175Sjp161948=item B<-noout>
55*2175Sjp161948
56*2175Sjp161948this option inhibits the output of the encoded version of the parameters.
57*2175Sjp161948
58*2175Sjp161948=item B<-text>
59*2175Sjp161948
60*2175Sjp161948this option prints out the DSA parameters in human readable form.
61*2175Sjp161948
62*2175Sjp161948=item B<-C>
63*2175Sjp161948
64*2175Sjp161948this option converts the parameters into C code. The parameters can then
65*2175Sjp161948be loaded by calling the B<get_dsaXXX()> function.
66*2175Sjp161948
67*2175Sjp161948=item B<-genkey>
68*2175Sjp161948
69*2175Sjp161948this option will generate a DSA either using the specified or generated
70*2175Sjp161948parameters.
71*2175Sjp161948
72*2175Sjp161948=item B<-rand file(s)>
73*2175Sjp161948
74*2175Sjp161948a file or files containing random data used to seed the random number
75*2175Sjp161948generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
76*2175Sjp161948Multiple files can be specified separated by a OS-dependent character.
77*2175Sjp161948The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
78*2175Sjp161948all others.
79*2175Sjp161948
80*2175Sjp161948=item B<numbits>
81*2175Sjp161948
82*2175Sjp161948this option specifies that a parameter set should be generated of size
83*2175Sjp161948B<numbits>. It must be the last option. If this option is included then
84*2175Sjp161948the input file (if any) is ignored.
85*2175Sjp161948
86*2175Sjp161948=item B<-engine id>
87*2175Sjp161948
88*2175Sjp161948specifying an engine (by it's unique B<id> string) will cause B<req>
89*2175Sjp161948to attempt to obtain a functional reference to the specified engine,
90*2175Sjp161948thus initialising it if needed. The engine will then be set as the default
91*2175Sjp161948for all available algorithms.
92*2175Sjp161948
93*2175Sjp161948=back
94*2175Sjp161948
95*2175Sjp161948=head1 NOTES
96*2175Sjp161948
97*2175Sjp161948PEM format DSA parameters use the header and footer lines:
98*2175Sjp161948
99*2175Sjp161948 -----BEGIN DSA PARAMETERS-----
100*2175Sjp161948 -----END DSA PARAMETERS-----
101*2175Sjp161948
102*2175Sjp161948DSA parameter generation is a slow process and as a result the same set of
103*2175Sjp161948DSA parameters is often used to generate several distinct keys.
104*2175Sjp161948
105*2175Sjp161948=head1 SEE ALSO
106*2175Sjp161948
107*2175Sjp161948L<gendsa(1)|gendsa(1)>, L<dsa(1)|dsa(1)>, L<genrsa(1)|genrsa(1)>,
108*2175Sjp161948L<rsa(1)|rsa(1)>
109*2175Sjp161948
110*2175Sjp161948=cut
111