xref: /openssl/doc/man1/openssl-dsa.pod.in (revision da1c088f)
1=pod
2
3=begin comment
4{- join("\n", @autowarntext) -}
5
6=end comment
7
8=head1 NAME
9
10openssl-dsa - DSA key processing
11
12=head1 SYNOPSIS
13
14B<openssl> B<dsa>
15[B<-help>]
16[B<-inform> B<DER>|B<PEM>]
17[B<-outform> B<DER>|B<PEM>]
18[B<-in> I<filename>]
19[B<-passin> I<arg>]
20[B<-out> I<filename>]
21[B<-passout> I<arg>]
22[B<-aes128>]
23[B<-aes192>]
24[B<-aes256>]
25[B<-aria128>]
26[B<-aria192>]
27[B<-aria256>]
28[B<-camellia128>]
29[B<-camellia192>]
30[B<-camellia256>]
31[B<-des>]
32[B<-des3>]
33[B<-idea>]
34[B<-text>]
35[B<-noout>]
36[B<-modulus>]
37[B<-pubin>]
38[B<-pubout>]
39[B<-pvk-strong>]
40[B<-pvk-weak>]
41[B<-pvk-none>]
42{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
43
44=head1 DESCRIPTION
45
46This command processes DSA keys. They can be converted between various
47forms and their components printed out. B<Note> This command uses the
48traditional SSLeay compatible format for private key encryption: newer
49applications should use the more secure PKCS#8 format using the B<pkcs8>
50
51=head1 OPTIONS
52
53=over 4
54
55=item B<-help>
56
57Print out a usage message.
58
59=item B<-inform> B<DER>|B<PEM>
60
61The key input format; unspecified by default.
62See L<openssl-format-options(1)> for details.
63
64=item B<-outform> B<DER>|B<PEM>
65
66The key output format; the default is B<PEM>.
67See L<openssl-format-options(1)> for details.
68
69Private keys are a sequence of B<ASN.1 INTEGERS>: the version (zero), B<p>,
70B<q>, B<g>, and the public and private key components.  Public keys
71are a B<SubjectPublicKeyInfo> structure with the B<DSA> type.
72
73The B<PEM> format also accepts PKCS#8 data.
74
75=item B<-in> I<filename>
76
77This specifies the input filename to read a key from or standard input if this
78option is not specified. If the key is encrypted a pass phrase will be
79prompted for.
80
81=item B<-out> I<filename>
82
83This specifies the output filename to write a key to or standard output by
84is not specified. If any encryption options are set then a pass phrase will be
85prompted for. The output filename should B<not> be the same as the input
86filename.
87
88=item B<-passin> I<arg>, B<-passout> I<arg>
89
90The password source for the input and output file.
91For more information about the format of B<arg>
92see L<openssl-passphrase-options(1)>.
93
94=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>
95
96These options encrypt the private key with the specified
97cipher before outputting it. A pass phrase is prompted for.
98If none of these options is specified the key is written in plain text. This
99means that this command can be used to remove the pass phrase from a key
100by not giving any encryption option is given, or to add or change the pass
101phrase by setting them.
102These options can only be used with PEM format output files.
103
104=item B<-text>
105
106Prints out the public, private key components and parameters.
107
108=item B<-noout>
109
110This option prevents output of the encoded version of the key.
111
112=item B<-modulus>
113
114This option prints out the value of the public key component of the key.
115
116=item B<-pubin>
117
118By default, a private key is read from the input.
119With this option a public key is read instead.
120If the input contains no public key but a private key, its public part is used.
121
122=item B<-pubout>
123
124By default, a private key is output. With this option a public
125key will be output instead. This option is automatically set if the input is
126a public key.
127
128=item B<-pvk-strong>
129
130Enable 'Strong' PVK encoding level (default).
131
132=item B<-pvk-weak>
133
134Enable 'Weak' PVK encoding level.
135
136=item B<-pvk-none>
137
138Don't enforce PVK encoding.
139
140{- $OpenSSL::safe::opt_engine_item -}
141
142{- $OpenSSL::safe::opt_provider_item -}
143
144=back
145
146The L<openssl-pkey(1)> command is capable of performing all the operations
147this command can, as well as supporting other public key types.
148
149=head1 EXAMPLES
150
151The documentation for the L<openssl-pkey(1)> command contains examples
152equivalent to the ones listed here.
153
154To remove the pass phrase on a DSA private key:
155
156 openssl dsa -in key.pem -out keyout.pem
157
158To encrypt a private key using triple DES:
159
160 openssl dsa -in key.pem -des3 -out keyout.pem
161
162To convert a private key from PEM to DER format:
163
164 openssl dsa -in key.pem -outform DER -out keyout.der
165
166To print out the components of a private key to standard output:
167
168 openssl dsa -in key.pem -text -noout
169
170To just output the public part of a private key:
171
172 openssl dsa -in key.pem -pubout -out pubkey.pem
173
174=head1 SEE ALSO
175
176L<openssl(1)>,
177L<openssl-pkey(1)>,
178L<openssl-dsaparam(1)>,
179L<openssl-gendsa(1)>,
180L<openssl-rsa(1)>,
181L<openssl-genrsa(1)>
182
183=head1 HISTORY
184
185The B<-engine> option was deprecated in OpenSSL 3.0.
186
187=head1 COPYRIGHT
188
189Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.
190
191Licensed under the Apache License 2.0 (the "License").  You may not use
192this file except in compliance with the License.  You can obtain a copy
193in the file LICENSE in the source distribution or at
194L<https://www.openssl.org/source/license.html>.
195
196=cut
197