Change the 'man' directory to 'apps'. Yes I wish cvs
could rename too :-(
This commit is contained in:
154
doc/apps/dsa.pod
Normal file
154
doc/apps/dsa.pod
Normal file
@@ -0,0 +1,154 @@
|
||||
=pod
|
||||
|
||||
=head1 NAME
|
||||
|
||||
dsa - DSA key processing
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
B<openssl> B<dsa>
|
||||
[B<-inform PEM|DER>]
|
||||
[B<-outform PEM|DER>]
|
||||
[B<-in filename>]
|
||||
[B<-passin password>]
|
||||
[B<-envpassin var>]
|
||||
[B<-out filename>]
|
||||
[B<-passout password>]
|
||||
[B<-envpassout var>]
|
||||
[B<-des>]
|
||||
[B<-des3>]
|
||||
[B<-idea>]
|
||||
[B<-text>]
|
||||
[B<-noout>]
|
||||
[B<-modulus>]
|
||||
[B<-pubin>]
|
||||
[B<-pubout>]
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<dsa> command processes DSA keys. They can be converted between various
|
||||
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>
|
||||
|
||||
=head1 COMMAND OPTIONS
|
||||
|
||||
=over 4
|
||||
|
||||
=item B<-inform DER|PEM>
|
||||
|
||||
This specifies the input format. The B<DER> option with a private key uses
|
||||
an ASN1 DER encoded form of an ASN.1 SEQUENCE consisting of the values of
|
||||
version (currently zero), p, q, g, the public and private key components
|
||||
respectively as ASN.1 INTEGERs. When used with a public key it uses a
|
||||
SubjectPublicKeyInfo structure: it is an error if the key is not DSA.
|
||||
|
||||
The B<PEM> form is the default format: it consists of the B<DER> format base64
|
||||
encoded with additional header and footer lines. In the case of a private key
|
||||
PKCS#8 format is also accepted.
|
||||
|
||||
=item B<-outform DER|PEM>
|
||||
|
||||
This specifies the output format, the options have the same meaning as the
|
||||
B<-inform> option.
|
||||
|
||||
=item B<-in filename>
|
||||
|
||||
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.
|
||||
|
||||
=item B<-passin password>
|
||||
|
||||
the input file password. Since certain utilities like "ps" make the command line
|
||||
visible this option should be used with caution.
|
||||
|
||||
=item B<-envpassin var>
|
||||
|
||||
read the input file password from the environment variable B<var>.
|
||||
|
||||
=item B<-out filename>
|
||||
|
||||
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.
|
||||
|
||||
=item B<-passout password>
|
||||
|
||||
the output file password. Since certain utilities like "ps" make the command line
|
||||
visible this option should be used with caution.
|
||||
|
||||
=item B<-envpassout var>
|
||||
|
||||
read the output file password from the environment variable B<var>.
|
||||
|
||||
=item B<-des|-des3|-idea>
|
||||
|
||||
These options encrypt the private key with the DES, triple DES, or the
|
||||
IDEA ciphers respectively before outputting it. A pass phrase is prompted for.
|
||||
If none of these options is specified the key is written in plain text. This
|
||||
means that using the B<rsa> utility to read in an encrypted key with no
|
||||
encryption option can be used to remove the pass phrase from a key, or by
|
||||
setting the encryption options it can be use to add or change the pass phrase.
|
||||
These options can only be used with PEM format output files.
|
||||
|
||||
=item B<-text>
|
||||
|
||||
prints out the public, private key components and parameters.
|
||||
|
||||
=item B<-noout>
|
||||
|
||||
this option prevents output of the encoded version of the key.
|
||||
|
||||
=item B<-modulus>
|
||||
|
||||
this option prints out the value of the public key component of the key.
|
||||
|
||||
=item B<-pubin>
|
||||
|
||||
by default a private key is input file with this option a public key is input
|
||||
instead.
|
||||
|
||||
=item B<-pubout>
|
||||
|
||||
by default a private key is output. With this option a public
|
||||
key will be output instead. This option is automatically set if the input is
|
||||
a public key.
|
||||
|
||||
=back
|
||||
|
||||
=head1 NOTES
|
||||
|
||||
The PEM private key format uses the header and footer lines:
|
||||
|
||||
-----BEGIN DSA PRIVATE KEY-----
|
||||
-----END DSA PRIVATE KEY-----
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
To remove the pass phrase on a DSA private key:
|
||||
|
||||
C<openssl dsa -in key.pem -out keyout.pem>
|
||||
|
||||
To encrypt a private key using triple DES:
|
||||
|
||||
C<openssl dsa -in key.pem -des3 -out keyout.pem>
|
||||
|
||||
To convert a private key from PEM to DER format:
|
||||
|
||||
C<openssl dsa -in key.pem -outform DER -out keyout.der>
|
||||
|
||||
To print out the components of a private key to standard output:
|
||||
|
||||
C<openssl dsa -in key.pem -text -noout>
|
||||
|
||||
To just output the public part of a private key:
|
||||
|
||||
C<openssl dsa -in key.pem -pubout -out pubkey.pem>
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
dsaparam(1), gendsa(1), rsa(1), genrsa(1)
|
||||
|
||||
=cut
|
Reference in New Issue
Block a user