Blame doc/man1/dsaparam.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
openssl-dsaparam,
Packit c4476c
dsaparam - DSA parameter manipulation and generation
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
B<openssl dsaparam>
Packit c4476c
[B<-help>]
Packit c4476c
[B<-inform DER|PEM>]
Packit c4476c
[B<-outform DER|PEM>]
Packit c4476c
[B<-in filename>]
Packit c4476c
[B<-out filename>]
Packit c4476c
[B<-noout>]
Packit c4476c
[B<-text>]
Packit c4476c
[B<-C>]
Packit c4476c
[B<-rand file...>]
Packit c4476c
[B<-writerand file>]
Packit c4476c
[B<-genkey>]
Packit c4476c
[B<-engine id>]
Packit c4476c
[B<numbits>]
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
This command is used to manipulate or generate DSA parameter files.
Packit c4476c
Packit c4476c
=head1 OPTIONS
Packit c4476c
Packit c4476c
=over 4
Packit c4476c
Packit c4476c
=item B<-help>
Packit c4476c
Packit c4476c
Print out a usage message.
Packit c4476c
Packit c4476c
=item B<-inform DER|PEM>
Packit c4476c
Packit c4476c
This specifies the input format. The B<DER> option uses an ASN1 DER encoded
Packit c4476c
form compatible with RFC2459 (PKIX) DSS-Parms that is a SEQUENCE consisting
Packit c4476c
of p, q and g respectively. The PEM form is the default format: it consists
Packit c4476c
of the B<DER> format base64 encoded with additional header and footer lines.
Packit c4476c
Packit c4476c
=item B<-outform DER|PEM>
Packit c4476c
Packit c4476c
This specifies the output format, the options have the same meaning and default
Packit c4476c
as the B<-inform> option.
Packit c4476c
Packit c4476c
=item B<-in filename>
Packit c4476c
Packit c4476c
This specifies the input filename to read parameters from or standard input if
Packit c4476c
this option is not specified. If the B<numbits> parameter is included then
Packit c4476c
this option will be ignored.
Packit c4476c
Packit c4476c
=item B<-out filename>
Packit c4476c
Packit c4476c
This specifies the output filename parameters to. Standard output is used
Packit c4476c
if this option is not present. The output filename should B<not> be the same
Packit c4476c
as the input filename.
Packit c4476c
Packit c4476c
=item B<-noout>
Packit c4476c
Packit c4476c
This option inhibits the output of the encoded version of the parameters.
Packit c4476c
Packit c4476c
=item B<-text>
Packit c4476c
Packit c4476c
This option prints out the DSA parameters in human readable form.
Packit c4476c
Packit c4476c
=item B<-C>
Packit c4476c
Packit c4476c
This option converts the parameters into C code. The parameters can then
Packit c4476c
be loaded by calling the get_dsaXXX() function.
Packit c4476c
Packit c4476c
=item B<-genkey>
Packit c4476c
Packit c4476c
This option will generate a DSA either using the specified or generated
Packit c4476c
parameters.
Packit c4476c
Packit c4476c
=item B<-rand file...>
Packit c4476c
Packit c4476c
A file or files containing random data used to seed the random number
Packit c4476c
generator.
Packit c4476c
Multiple files can be specified separated by an OS-dependent character.
Packit c4476c
The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
Packit c4476c
all others.
Packit c4476c
Packit c4476c
=item [B<-writerand file>]
Packit c4476c
Packit c4476c
Writes random data to the specified I<file> upon exit.
Packit c4476c
This can be used with a subsequent B<-rand> flag.
Packit c4476c
Packit c4476c
=item B<numbits>
Packit c4476c
Packit c4476c
This option specifies that a parameter set should be generated of size
Packit c4476c
B<numbits>. It must be the last option. If this option is included then
Packit c4476c
the input file (if any) is ignored.
Packit c4476c
Packit c4476c
=item B<-engine id>
Packit c4476c
Packit c4476c
Specifying an engine (by its unique B<id> string) will cause B<dsaparam>
Packit c4476c
to attempt to obtain a functional reference to the specified engine,
Packit c4476c
thus initialising it if needed. The engine will then be set as the default
Packit c4476c
for all available algorithms.
Packit c4476c
Packit c4476c
=back
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
PEM format DSA parameters use the header and footer lines:
Packit c4476c
Packit c4476c
 -----BEGIN DSA PARAMETERS-----
Packit c4476c
 -----END DSA PARAMETERS-----
Packit c4476c
Packit c4476c
DSA parameter generation is a slow process and as a result the same set of
Packit c4476c
DSA parameters is often used to generate several distinct keys.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<gendsa(1)>, L<dsa(1)>, L<genrsa(1)>,
Packit c4476c
L<rsa(1)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut