[thirdparty/openssl.git] / doc / man1 / gendsa.pod

=pod

=head1 NAME

gendsa - generate a DSA private key from a set of parameters

=head1 SYNOPSIS

B<openssl> B<gendsa>
[B<-help>]
[B<-out filename>]
[B<-aes128>]
[B<-aes192>]
[B<-aes256>]
[B<-aria128>]
[B<-aria192>]
[B<-aria256>]
[B<-camellia128>]
[B<-camellia192>]
[B<-camellia256>]
[B<-des>]
[B<-des3>]
[B<-idea>]
[B<-rand file(s)>]
[B<-engine id>]
[B<paramfile>]

=head1 DESCRIPTION

The B<gendsa> command generates a DSA private key from a DSA parameter file
(which will be typically generated by the B<openssl dsaparam> command).

=head1 OPTIONS

=over 4

=item B<-help>

Print out a usage message.

=item B<-out filename>

Output the key to the specified file. If this argument is not specified then
standard output is used.

=item B<-aes128|-aes192|-aes256|-aria128|-aria192|-aria256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea>

These options encrypt the private key with specified
cipher before outputting it. A pass phrase is prompted for.
If none of these options is specified no encryption is used.

=item B<-rand file(s)>

A file or files containing random data used to seed the random number
generator, or an EGD socket (see L<RAND_egd(3)>).
Multiple files can be specified separated by an OS-dependent character.
The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
all others.

=item B<-engine id>

Specifying an engine (by its unique B<id> string) will cause B<gendsa>
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
for all available algorithms.

=item B<paramfile>

This option specifies the DSA parameter file to use. The parameters in this
file determine the size of the private key. DSA parameters can be generated
and examined using the B<openssl dsaparam> command.

=back

=head1 NOTES

DSA key generation is little more than random number generation so it is
much quicker that RSA key generation for example.

=head1 SEE ALSO

L<dsaparam(1)>, L<dsa(1)>, L<genrsa(1)>,
L<rsa(1)>

=head1 COPYRIGHT

Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
aba3e65f DSH	1	=pod
	2
	3	=head1 NAME
	4
	5	gendsa - generate a DSA private key from a set of parameters
	6
	7	=head1 SYNOPSIS
	8
	9	B<openssl> B<gendsa>
169394d4	10	[B<-help>]
aba3e65f	11	[B<-out filename>]
fc1d88f0 RS	12	[B<-aes128>]
	13	[B<-aes192>]
	14	[B<-aes256>]
d42d0a4d P	15	[B<-aria128>]
	16	[B<-aria192>]
	17	[B<-aria256>]
fc1d88f0 RS	18	[B<-camellia128>]
	19	[B<-camellia192>]
	20	[B<-camellia256>]
aba3e65f DSH	21	[B<-des>]
	22	[B<-des3>]
	23	[B<-idea>]
9597902a	24	[B<-rand file(s)>]
bfa35550	25	[B<-engine id>]
aba3e65f DSH	26	[B<paramfile>]
	27
	28	=head1 DESCRIPTION
	29
	30	The B<gendsa> command generates a DSA private key from a DSA parameter file
	31	(which will be typically generated by the B<openssl dsaparam> command).
	32
	33	=head1 OPTIONS
	34
	35	=over 4
	36
169394d4 MR	37	=item B<-help>
	38
	39	Print out a usage message.
	40
	41	=item B<-out filename>
	42
	43	Output the key to the specified file. If this argument is not specified then
	44	standard output is used.
	45
d42d0a4d	46	=item B<-aes128\|-aes192\|-aes256\|-aria128\|-aria192\|-aria256\|-camellia128\|-camellia192\|-camellia256\|-des\|-des3\|-idea>
aba3e65f	47
fc1d88f0 RS	48	These options encrypt the private key with specified
fc1d88f0 RS	49	cipher before outputting it. A pass phrase is prompted for.
aba3e65f DSH	50	If none of these options is specified no encryption is used.
aba3e65f DSH	51
9597902a	52	=item B<-rand file(s)>
aba3e65f	53
c4de074e	54	A file or files containing random data used to seed the random number
9b86974e	55	generator, or an EGD socket (see L<RAND_egd(3)>).
35ed393e	56	Multiple files can be specified separated by an OS-dependent character.
b87ef946	57	The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
a4cfd178	58	all others.
aba3e65f	59
bfa35550 RL	60	=item B<-engine id>
bfa35550 RL	61
c4de074e	62	Specifying an engine (by its unique B<id> string) will cause B<gendsa>
bfa35550 RL	63	to attempt to obtain a functional reference to the specified engine,
	64	thus initialising it if needed. The engine will then be set as the default
	65	for all available algorithms.
	66
aba3e65f DSH	67	=item B<paramfile>
	68
	69	This option specifies the DSA parameter file to use. The parameters in this
	70	file determine the size of the private key. DSA parameters can be generated
	71	and examined using the B<openssl dsaparam> command.
	72
	73	=back
	74
	75	=head1 NOTES
	76
	77	DSA key generation is little more than random number generation so it is
	78	much quicker that RSA key generation for example.
	79
	80	=head1 SEE ALSO
	81
9b86974e RS	82	L<dsaparam(1)>, L<dsa(1)>, L<genrsa(1)>,
9b86974e RS	83	L<rsa(1)>
aba3e65f	84
e2f92610 RS	85	=head1 COPYRIGHT
e2f92610 RS	86
d42d0a4d	87	Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
e2f92610 RS	88
	89	Licensed under the OpenSSL license (the "License"). You may not use
	90	this file except in compliance with the License. You can obtain a copy
	91	in the file LICENSE in the source distribution or at
	92	L<https://www.openssl.org/source/license.html>.
	93
	94	=cut