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

=pod
{- OpenSSL::safe::output_do_not_edit_headers(); -}

=head1 NAME

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

=head1 SYNOPSIS

B<openssl> B<gendsa>
[B<-help>]
[B<-out> I<filename>]
[B<-passout> I<arg>]
[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<-verbose>]
{- $OpenSSL::safe::opt_r_synopsis -}
{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
[I<paramfile>]

=head1 DESCRIPTION

This command generates a DSA private key from a DSA parameter file
(which will be typically generated by the L<openssl-dsaparam(1)> command).

=head1 OPTIONS

=over 4

=item B<-help>

Print out a usage message.

=item B<-out> I<filename>

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

=item B<-passout> I<arg>

The passphrase used for the output file.
See L<openssl-passphrase-options(1)>.

=item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-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<-verbose>

Print extra details about the operations being performed.

{- $OpenSSL::safe::opt_r_item -}

{- $OpenSSL::safe::opt_engine_item -}

=item I<paramfile>

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 L<openssl-dsaparam(1)> command.

{- $OpenSSL::safe::opt_provider_item -}

=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<openssl(1)>,
L<openssl-genpkey(1)>,
L<openssl-dsaparam(1)>,
L<openssl-dsa(1)>,
L<openssl-genrsa(1)>,
L<openssl-rsa(1)>

=head1 HISTORY

The B<-engine> option was deprecated in OpenSSL 3.0.

=head1 COPYRIGHT

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

Licensed under the Apache License 2.0 (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	1	=pod
625c781d	2	{- OpenSSL::safe::output_do_not_edit_headers(); -}
9fcb9702	3
aba3e65f DSH	4	=head1 NAME
aba3e65f DSH	5
b6b66573	6	openssl-gendsa - generate a DSA private key from a set of parameters
aba3e65f DSH	7
	8	=head1 SYNOPSIS
	9
	10	B<openssl> B<gendsa>
169394d4	11	[B<-help>]
e8769719	12	[B<-out> I<filename>]
65718c51	13	[B<-passout> I<arg>]
fc1d88f0 RS	14	[B<-aes128>]
	15	[B<-aes192>]
	16	[B<-aes256>]
d42d0a4d P	17	[B<-aria128>]
	18	[B<-aria192>]
	19	[B<-aria256>]
fc1d88f0 RS	20	[B<-camellia128>]
	21	[B<-camellia192>]
	22	[B<-camellia256>]
aba3e65f DSH	23	[B<-des>]
	24	[B<-des3>]
	25	[B<-idea>]
b6a07f67	26	[B<-verbose>]
9fcb9702	27	{- $OpenSSL::safe::opt_r_synopsis -}
d55e4487	28	{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
2f0ea936	29	[I<paramfile>]
aba3e65f DSH	30
	31	=head1 DESCRIPTION
	32
35a810bb RL	33	This command generates a DSA private key from a DSA parameter file
35a810bb RL	34	(which will be typically generated by the L<openssl-dsaparam(1)> command).
aba3e65f DSH	35
	36	=head1 OPTIONS
	37
	38	=over 4
	39
169394d4 MR	40	=item B<-help>
	41
	42	Print out a usage message.
	43
e8769719	44	=item B<-out> I<filename>
169394d4 MR	45
	46	Output the key to the specified file. If this argument is not specified then
	47	standard output is used.
	48
65718c51 RS	49	=item B<-passout> I<arg>
	50
	51	The passphrase used for the output file.
46949153	52	See L<openssl-passphrase-options(1)>.
65718c51	53
dfee8626	54	=item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>
aba3e65f	55
fc1d88f0 RS	56	These options encrypt the private key with specified
fc1d88f0 RS	57	cipher before outputting it. A pass phrase is prompted for.
aba3e65f DSH	58	If none of these options is specified no encryption is used.
aba3e65f DSH	59
b6a07f67 PP	60	=item B<-verbose>
	61
	62	Print extra details about the operations being performed.
	63
018aaeb4 RS	64	{- $OpenSSL::safe::opt_r_item -}
	65
	66	{- $OpenSSL::safe::opt_engine_item -}
	67
2f0ea936	68	=item I<paramfile>
aba3e65f	69
2f0ea936 RL	70	The DSA parameter file to use. The parameters in this file determine
2f0ea936 RL	71	the size of the private key. DSA parameters can be generated and
35a810bb	72	examined using the L<openssl-dsaparam(1)> command.
aba3e65f	73
6bd4e3f2 P	74	{- $OpenSSL::safe::opt_provider_item -}
6bd4e3f2 P	75
aba3e65f DSH	76	=back
	77
	78	=head1 NOTES
	79
	80	DSA key generation is little more than random number generation so it is
	81	much quicker that RSA key generation for example.
	82
	83	=head1 SEE ALSO
	84
b6b66573	85	L<openssl(1)>,
1ddf2594	86	L<openssl-genpkey(1)>,
b6b66573 DMSP	87	L<openssl-dsaparam(1)>,
	88	L<openssl-dsa(1)>,
	89	L<openssl-genrsa(1)>,
	90	L<openssl-rsa(1)>
aba3e65f	91
0f221d9c P	92	=head1 HISTORY
	93
	94	The B<-engine> option was deprecated in OpenSSL 3.0.
	95
e2f92610 RS	96	=head1 COPYRIGHT
e2f92610 RS	97
33388b44	98	Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
e2f92610	99
449040b4	100	Licensed under the Apache License 2.0 (the "License"). You may not use
e2f92610 RS	101	this file except in compliance with the License. You can obtain a copy
	102	in the file LICENSE in the source distribution or at
	103	L<https://www.openssl.org/source/license.html>.
	104
	105	=cut