1999-11-10 10:52:17 +08:00
|
|
|
=pod
|
|
|
|
|
2019-10-13 05:45:56 +08:00
|
|
|
=begin comment
|
|
|
|
{- join("\n", @autowarntext) -}
|
|
|
|
|
|
|
|
=end comment
|
|
|
|
|
1999-11-10 10:52:17 +08:00
|
|
|
=head1 NAME
|
|
|
|
|
2019-08-22 07:04:41 +08:00
|
|
|
openssl-dsa - DSA key processing
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
|
|
|
B<openssl> B<dsa>
|
2016-02-06 00:58:45 +08:00
|
|
|
[B<-help>]
|
2019-09-26 03:20:11 +08:00
|
|
|
[B<-inform> B<DER>|B<PEM>]
|
|
|
|
[B<-outform> B<DER>|B<PEM>]
|
|
|
|
[B<-in> I<filename>]
|
|
|
|
[B<-passin> I<arg>]
|
|
|
|
[B<-out> I<filename>]
|
|
|
|
[B<-passout> I<arg>]
|
2014-07-03 10:42:40 +08:00
|
|
|
[B<-aes128>]
|
|
|
|
[B<-aes192>]
|
|
|
|
[B<-aes256>]
|
2017-02-01 08:10:13 +08:00
|
|
|
[B<-aria128>]
|
|
|
|
[B<-aria192>]
|
|
|
|
[B<-aria256>]
|
2014-07-03 10:42:40 +08:00
|
|
|
[B<-camellia128>]
|
|
|
|
[B<-camellia192>]
|
|
|
|
[B<-camellia256>]
|
1999-11-10 10:52:17 +08:00
|
|
|
[B<-des>]
|
|
|
|
[B<-des3>]
|
|
|
|
[B<-idea>]
|
|
|
|
[B<-text>]
|
|
|
|
[B<-noout>]
|
|
|
|
[B<-modulus>]
|
|
|
|
[B<-pubin>]
|
|
|
|
[B<-pubout>]
|
2019-10-13 05:45:56 +08:00
|
|
|
{- $OpenSSL::safe::opt_engine_synopsis -}
|
1999-11-10 10:52:17 +08:00
|
|
|
|
2019-10-11 23:52:12 +08:00
|
|
|
=for openssl ifdef pvk-string pvk-weak pvk-none engine
|
2019-09-23 07:49:25 +08:00
|
|
|
|
1999-11-10 10:52:17 +08:00
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
Command docs: fix up command references
Almost all OpenSSL commands are in reality 'openssl cmd', so make sure
they are refered to like that and not just as the sub-command.
Self-references are avoided as much as is possible, and replaced with
"this command". In some cases, we even avoid that with a slight
rewrite of the sentence or paragrah they were in. However, in the few
cases where a self-reference is still admissible, they are done in
bold, i.e. openssl-speed.pod references itself like this:
B<openssl speed>
References to other commands are done as manual links, i.e. CA.pl.pod
references 'openssl req' like this: L<openssl-req(1)>
Some commands are examples rather than references; we enclose those in
C<>.
While we are it, we abolish "utility", replacing it with "command", or
remove it entirely in some cases.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10065)
2019-10-02 01:43:36 +08:00
|
|
|
This command processes DSA keys. They can be converted between various
|
1999-11-10 10:52:17 +08:00
|
|
|
forms and their components printed out. B<Note> This command uses the
|
|
|
|
traditional SSLeay compatible format for private key encryption: newer
|
|
|
|
applications should use the more secure PKCS#8 format using the B<pkcs8>
|
|
|
|
|
2016-12-13 00:14:40 +08:00
|
|
|
=head1 OPTIONS
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
2016-02-06 00:58:45 +08:00
|
|
|
=item B<-help>
|
|
|
|
|
|
|
|
Print out a usage message.
|
|
|
|
|
2019-10-10 09:48:33 +08:00
|
|
|
=item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
|
1999-11-10 10:52:17 +08:00
|
|
|
|
2019-10-10 09:48:33 +08:00
|
|
|
The input and formats; the default is B<PEM>.
|
|
|
|
See L<openssl(1)/Format Options> for details.
|
1999-11-10 10:52:17 +08:00
|
|
|
|
2019-10-10 09:48:33 +08:00
|
|
|
Private keys are a sequence of B<ASN.1 INTEGERS>: the version (zero), B<p>,
|
|
|
|
B<q>, B<g>, and the public and and private key components. Public keys
|
|
|
|
are a B<SubjectPublicKeyInfo> structure with the B<DSA> type.
|
1999-11-10 10:52:17 +08:00
|
|
|
|
2019-10-10 09:48:33 +08:00
|
|
|
The B<PEM> format also accepts PKCS#8 data.
|
1999-11-10 10:52:17 +08:00
|
|
|
|
2019-09-26 03:20:11 +08:00
|
|
|
=item B<-in> I<filename>
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
This specifies the input filename to read a key from or standard input if this
|
|
|
|
option is not specified. If the key is encrypted a pass phrase will be
|
|
|
|
prompted for.
|
|
|
|
|
2019-09-26 03:20:11 +08:00
|
|
|
=item B<-out> I<filename>
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
This specifies the output filename to write a key to or standard output by
|
|
|
|
is not specified. If any encryption options are set then a pass phrase will be
|
|
|
|
prompted for. The output filename should B<not> be the same as the input
|
|
|
|
filename.
|
|
|
|
|
2019-10-09 01:10:04 +08:00
|
|
|
=item B<-passin> I<arg>, B<-passout> I<arg>
|
1999-11-12 02:41:31 +08:00
|
|
|
|
2019-10-09 01:10:04 +08:00
|
|
|
The password source for the input and output file.
|
|
|
|
For more information about the format of B<arg>
|
|
|
|
see L<openssl(1)/Pass Phrase Options>.
|
1999-11-12 02:41:31 +08:00
|
|
|
|
2018-07-04 00:45:14 +08:00
|
|
|
=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>
|
1999-11-10 10:52:17 +08:00
|
|
|
|
2014-07-03 10:42:40 +08:00
|
|
|
These options encrypt the private key with the specified
|
|
|
|
cipher before outputting it. A pass phrase is prompted for.
|
1999-11-10 10:52:17 +08:00
|
|
|
If none of these options is specified the key is written in plain text. This
|
Command docs: fix up command references
Almost all OpenSSL commands are in reality 'openssl cmd', so make sure
they are refered to like that and not just as the sub-command.
Self-references are avoided as much as is possible, and replaced with
"this command". In some cases, we even avoid that with a slight
rewrite of the sentence or paragrah they were in. However, in the few
cases where a self-reference is still admissible, they are done in
bold, i.e. openssl-speed.pod references itself like this:
B<openssl speed>
References to other commands are done as manual links, i.e. CA.pl.pod
references 'openssl req' like this: L<openssl-req(1)>
Some commands are examples rather than references; we enclose those in
C<>.
While we are it, we abolish "utility", replacing it with "command", or
remove it entirely in some cases.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10065)
2019-10-02 01:43:36 +08:00
|
|
|
means that this command can be used to remove the pass phrase from a key
|
|
|
|
by not giving any encryption option is given, or to add or change the pass
|
|
|
|
phrase by setting them.
|
1999-11-10 10:52:17 +08:00
|
|
|
These options can only be used with PEM format output files.
|
|
|
|
|
|
|
|
=item B<-text>
|
|
|
|
|
2017-03-30 05:38:30 +08:00
|
|
|
Prints out the public, private key components and parameters.
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
=item B<-noout>
|
|
|
|
|
2017-03-30 05:38:30 +08:00
|
|
|
This option prevents output of the encoded version of the key.
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
=item B<-modulus>
|
|
|
|
|
2017-03-30 05:38:30 +08:00
|
|
|
This option prints out the value of the public key component of the key.
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
=item B<-pubin>
|
|
|
|
|
2017-03-30 05:38:30 +08:00
|
|
|
By default, a private key is read from the input file. With this option a
|
2000-02-08 21:37:08 +08:00
|
|
|
public key is read instead.
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
=item B<-pubout>
|
|
|
|
|
2017-03-30 05:38:30 +08:00
|
|
|
By default, a private key is output. With this option a public
|
1999-11-10 10:52:17 +08:00
|
|
|
key will be output instead. This option is automatically set if the input is
|
|
|
|
a public key.
|
|
|
|
|
2019-10-13 05:45:56 +08:00
|
|
|
{- $OpenSSL::safe::opt_engine_item -}
|
2003-01-31 06:02:27 +08:00
|
|
|
|
1999-11-10 10:52:17 +08:00
|
|
|
=back
|
|
|
|
|
|
|
|
=head1 EXAMPLES
|
|
|
|
|
|
|
|
To remove the pass phrase on a DSA private key:
|
|
|
|
|
2000-01-24 10:24:37 +08:00
|
|
|
openssl dsa -in key.pem -out keyout.pem
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
To encrypt a private key using triple DES:
|
|
|
|
|
2000-01-24 10:24:37 +08:00
|
|
|
openssl dsa -in key.pem -des3 -out keyout.pem
|
1999-11-10 10:52:17 +08:00
|
|
|
|
2016-05-20 20:11:46 +08:00
|
|
|
To convert a private key from PEM to DER format:
|
1999-11-10 10:52:17 +08:00
|
|
|
|
2000-01-24 10:24:37 +08:00
|
|
|
openssl dsa -in key.pem -outform DER -out keyout.der
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
To print out the components of a private key to standard output:
|
|
|
|
|
2000-01-24 10:24:37 +08:00
|
|
|
openssl dsa -in key.pem -text -noout
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
To just output the public part of a private key:
|
|
|
|
|
2000-01-24 10:24:37 +08:00
|
|
|
openssl dsa -in key.pem -pubout -out pubkey.pem
|
1999-11-10 10:52:17 +08:00
|
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
|
2019-08-22 07:04:41 +08:00
|
|
|
L<openssl(1)>,
|
|
|
|
L<openssl-dsaparam(1)>,
|
|
|
|
L<openssl-gendsa(1)>,
|
|
|
|
L<openssl-rsa(1)>,
|
|
|
|
L<openssl-genrsa(1)>
|
1999-11-10 10:52:17 +08:00
|
|
|
|
2016-05-18 23:44:05 +08:00
|
|
|
=head1 COPYRIGHT
|
|
|
|
|
2019-08-22 07:04:41 +08:00
|
|
|
Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
|
2016-05-18 23:44:05 +08:00
|
|
|
|
2018-12-06 21:04:11 +08:00
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
2016-05-18 23:44:05 +08:00
|
|
|
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
|