]>
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>] | |
018aaeb4 | 39 | {- $OpenSSL::safe::opt_engine_synopsis -} |
6bd4e3f2 | 40 | {- $OpenSSL::safe::opt_provider_synopsis -} |
aba3e65f | 41 | |
9f3c076b | 42 | =for openssl ifdef pvk-string pvk-weak pvk-none engine |
1738c0ce | 43 | |
aba3e65f DSH |
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 | ||
777182a0 | 59 | =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM> |
aba3e65f | 60 | |
777182a0 RS |
61 | The input and formats; the default is B<PEM>. |
62 | See L<openssl(1)/Format Options> for details. | |
aba3e65f | 63 | |
777182a0 | 64 | Private keys are a sequence of B<ASN.1 INTEGERS>: the version (zero), B<p>, |
8c1cbc72 | 65 | B<q>, B<g>, and the public and private key components. Public keys |
777182a0 | 66 | are a B<SubjectPublicKeyInfo> structure with the B<DSA> type. |
aba3e65f | 67 | |
777182a0 | 68 | The B<PEM> format also accepts PKCS#8 data. |
aba3e65f | 69 | |
e8769719 | 70 | =item B<-in> I<filename> |
aba3e65f DSH |
71 | |
72 | This specifies the input filename to read a key from or standard input if this | |
73 | option is not specified. If the key is encrypted a pass phrase will be | |
74 | prompted for. | |
75 | ||
e8769719 | 76 | =item B<-out> I<filename> |
aba3e65f DSH |
77 | |
78 | This specifies the output filename to write a key to or standard output by | |
79 | is not specified. If any encryption options are set then a pass phrase will be | |
80 | prompted for. The output filename should B<not> be the same as the input | |
81 | filename. | |
82 | ||
3a4e43de | 83 | =item B<-passin> I<arg>, B<-passout> I<arg> |
af29811e | 84 | |
3a4e43de RS |
85 | The password source for the input and output file. |
86 | For more information about the format of B<arg> | |
87 | see L<openssl(1)/Pass Phrase Options>. | |
af29811e | 88 | |
dfee8626 | 89 | =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 | 90 | |
fc1d88f0 RS |
91 | These options encrypt the private key with the specified |
92 | cipher before outputting it. A pass phrase is prompted for. | |
aba3e65f | 93 | If none of these options is specified the key is written in plain text. This |
35a810bb RL |
94 | means that this command can be used to remove the pass phrase from a key |
95 | by not giving any encryption option is given, or to add or change the pass | |
96 | phrase by setting them. | |
aba3e65f DSH |
97 | These options can only be used with PEM format output files. |
98 | ||
99 | =item B<-text> | |
100 | ||
c4de074e | 101 | Prints out the public, private key components and parameters. |
aba3e65f DSH |
102 | |
103 | =item B<-noout> | |
104 | ||
c4de074e | 105 | This option prevents output of the encoded version of the key. |
aba3e65f DSH |
106 | |
107 | =item B<-modulus> | |
108 | ||
c4de074e | 109 | This option prints out the value of the public key component of the key. |
aba3e65f DSH |
110 | |
111 | =item B<-pubin> | |
112 | ||
c4de074e | 113 | By default, a private key is read from the input file. With this option a |
0cd4498b | 114 | public key is read instead. |
aba3e65f DSH |
115 | |
116 | =item B<-pubout> | |
117 | ||
c4de074e | 118 | By default, a private key is output. With this option a public |
aba3e65f DSH |
119 | key will be output instead. This option is automatically set if the input is |
120 | a public key. | |
121 | ||
018aaeb4 | 122 | {- $OpenSSL::safe::opt_engine_item -} |
bfa35550 | 123 | |
6bd4e3f2 P |
124 | {- $OpenSSL::safe::opt_provider_item -} |
125 | ||
aba3e65f DSH |
126 | =back |
127 | ||
128 | =head1 EXAMPLES | |
129 | ||
35eb4588 P |
130 | Examples equivalent to these can be found in the documentation for the |
131 | non-deprecated L<openssl-pkey(1)> command. | |
132 | ||
aba3e65f DSH |
133 | To remove the pass phrase on a DSA private key: |
134 | ||
1675f6eb | 135 | openssl dsa -in key.pem -out keyout.pem |
aba3e65f DSH |
136 | |
137 | To encrypt a private key using triple DES: | |
138 | ||
1675f6eb | 139 | openssl dsa -in key.pem -des3 -out keyout.pem |
aba3e65f | 140 | |
1bc74519 | 141 | To convert a private key from PEM to DER format: |
aba3e65f | 142 | |
1675f6eb | 143 | openssl dsa -in key.pem -outform DER -out keyout.der |
aba3e65f DSH |
144 | |
145 | To print out the components of a private key to standard output: | |
146 | ||
1675f6eb | 147 | openssl dsa -in key.pem -text -noout |
aba3e65f DSH |
148 | |
149 | To just output the public part of a private key: | |
150 | ||
1675f6eb | 151 | openssl dsa -in key.pem -pubout -out pubkey.pem |
aba3e65f DSH |
152 | |
153 | =head1 SEE ALSO | |
154 | ||
b6b66573 | 155 | L<openssl(1)>, |
1ddf2594 | 156 | L<openssl-pkey(1)>, |
b6b66573 DMSP |
157 | L<openssl-dsaparam(1)>, |
158 | L<openssl-gendsa(1)>, | |
159 | L<openssl-rsa(1)>, | |
160 | L<openssl-genrsa(1)> | |
aba3e65f | 161 | |
e2f92610 RS |
162 | =head1 COPYRIGHT |
163 | ||
33388b44 | 164 | Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 165 | |
449040b4 | 166 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
167 | this file except in compliance with the License. You can obtain a copy |
168 | in the file LICENSE in the source distribution or at | |
169 | L<https://www.openssl.org/source/license.html>. | |
170 | ||
171 | =cut |