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