[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<-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 -}
[I<paramfile>]

=for openssl ifdef engine

=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<-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.

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

=head1 COPYRIGHT

Copyright 2000-2019 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>]
fc1d88f0 RS	13	[B<-aes128>]
	14	[B<-aes192>]
	15	[B<-aes256>]
d42d0a4d P	16	[B<-aria128>]
	17	[B<-aria192>]
	18	[B<-aria256>]
fc1d88f0 RS	19	[B<-camellia128>]
	20	[B<-camellia192>]
	21	[B<-camellia256>]
aba3e65f DSH	22	[B<-des>]
	23	[B<-des3>]
	24	[B<-idea>]
b6a07f67	25	[B<-verbose>]
9fcb9702	26	{- $OpenSSL::safe::opt_r_synopsis -}
018aaeb4	27	{- $OpenSSL::safe::opt_engine_synopsis -}
2f0ea936	28	[I<paramfile>]
aba3e65f	29
9f3c076b	30	=for openssl ifdef engine
1738c0ce	31
aba3e65f DSH	32	=head1 DESCRIPTION
aba3e65f DSH	33
35a810bb RL	34	This command generates a DSA private key from a DSA parameter file
35a810bb RL	35	(which will be typically generated by the L<openssl-dsaparam(1)> command).
aba3e65f DSH	36
	37	=head1 OPTIONS
	38
	39	=over 4
	40
169394d4 MR	41	=item B<-help>
	42
	43	Print out a usage message.
	44
e8769719	45	=item B<-out> I<filename>
169394d4 MR	46
	47	Output the key to the specified file. If this argument is not specified then
	48	standard output is used.
	49
dfee8626	50	=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	51
fc1d88f0 RS	52	These options encrypt the private key with specified
fc1d88f0 RS	53	cipher before outputting it. A pass phrase is prompted for.
aba3e65f DSH	54	If none of these options is specified no encryption is used.
aba3e65f DSH	55
b6a07f67 PP	56	=item B<-verbose>
	57
	58	Print extra details about the operations being performed.
	59
018aaeb4 RS	60	{- $OpenSSL::safe::opt_r_item -}
	61
	62	{- $OpenSSL::safe::opt_engine_item -}
	63
2f0ea936	64	=item I<paramfile>
aba3e65f	65
2f0ea936 RL	66	The DSA parameter file to use. The parameters in this file determine
2f0ea936 RL	67	the size of the private key. DSA parameters can be generated and
35a810bb	68	examined using the L<openssl-dsaparam(1)> command.
aba3e65f DSH	69
	70	=back
	71
	72	=head1 NOTES
	73
	74	DSA key generation is little more than random number generation so it is
	75	much quicker that RSA key generation for example.
	76
	77	=head1 SEE ALSO
	78
b6b66573 DMSP	79	L<openssl(1)>,
	80	L<openssl-dsaparam(1)>,
	81	L<openssl-dsa(1)>,
	82	L<openssl-genrsa(1)>,
	83	L<openssl-rsa(1)>
aba3e65f	84
e2f92610 RS	85	=head1 COPYRIGHT
e2f92610 RS	86
b6b66573	87	Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
e2f92610	88
449040b4	89	Licensed under the Apache License 2.0 (the "License"). You may not use
e2f92610 RS	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