| blob | 6ff8ace030349491f059bc2f3ed406830b203bd4 |
1 .\" $NetBSD: openssl_dsa.1,v 1.14 2015/06/12 17:01:14 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
10 ..
11 .de Vb \" Begin verbatim text
12 .ft CW
13 .nf
14 .ne \\$1
15 ..
16 .de Ve \" End verbatim text
17 .ft R
18 .fi
19 ..
20 .\" Set up some character translations and predefined strings. \*(-- will
21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
22 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
23 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
24 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
25 .\" nothing in troff, for use with C<>.
26 .tr \(*W-
27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
28 .ie n \{\
29 . ds -- \(*W-
30 . ds PI pi
31 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
32 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
33 . ds L" ""
34 . ds R" ""
35 . ds C` ""
36 . ds C' ""
37 'br\}
38 .el\{\
39 . ds -- \|\(em\|
40 . ds PI \(*p
41 . ds L" ``
42 . ds R" ''
43 . ds C`
44 . ds C'
45 'br\}
46 .\"
47 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .ie \n(.g .ds Aq \(aq
49 .el .ds Aq '
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .\"
56 .\" Avoid warning from groff about undefined register 'F'.
57 .de IX
58 ..
59 .nr rF 0
60 .if \n(.g .if rF .nr rF 1
61 .if (\n(rF:(\n(.g==0)) \{
62 . if \nF \{
63 . de IX
64 . tm Index:\\$1\t\\n%\t"\\$2"
65 ..
66 . if !\nF==2 \{
67 . nr % 0
68 . nr F 2
69 . \}
70 . \}
71 .\}
72 .rr rF
73 .\"
74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
75 .\" Fear. Run. Save yourself. No user-serviceable parts.
76 . \" fudge factors for nroff and troff
77 .if n \{\
78 . ds #H 0
79 . ds #V .8m
80 . ds #F .3m
81 . ds #[ \f1
82 . ds #] \fP
83 .\}
84 .if t \{\
85 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
86 . ds #V .6m
87 . ds #F 0
88 . ds #[ \&
89 . ds #] \&
90 .\}
91 . \" simple accents for nroff and troff
92 .if n \{\
93 . ds ' \&
94 . ds ` \&
95 . ds ^ \&
96 . ds , \&
97 . ds ~ ~
98 . ds /
99 .\}
100 .if t \{\
101 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
102 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
103 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
104 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
105 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
106 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
107 .\}
108 . \" troff and (daisy-wheel) nroff accents
109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
116 .ds ae a\h'-(\w'a'u*4/10)'e
117 .ds Ae A\h'-(\w'A'u*4/10)'E
118 . \" corrections for vroff
119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
121 . \" for low resolution devices (crt and lpr)
122 .if \n(.H>23 .if \n(.V>19 \
123 \{\
124 . ds : e
125 . ds 8 ss
126 . ds o a
127 . ds d- d\h'-1'\(ga
128 . ds D- D\h'-1'\(hy
129 . ds th \o'bp'
130 . ds Th \o'LP'
131 . ds ae ae
132 . ds Ae AE
133 .\}
134 .rm #[ #] #H #V #F C
135 .\" ========================================================================
136 .\"
137 .IX Title "DSA 1"
138 .TH DSA 1 "2014-08-10" "1.0.1n" "OpenSSL"
139 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
140 .\" way too many mistakes in technical documents.
141 .if n .ad l
142 .nh
143 .SH "NAME"
144 dsa \- DSA key processing
145 .SH "LIBRARY"
146 libcrypto, -lcrypto
147 .SH "SYNOPSIS"
148 .IX Header "SYNOPSIS"
149 \&\fBopenssl\fR \fBdsa\fR
150 [\fB\-inform PEM|DER\fR]
151 [\fB\-outform PEM|DER\fR]
152 [\fB\-in filename\fR]
153 [\fB\-passin arg\fR]
154 [\fB\-out filename\fR]
155 [\fB\-passout arg\fR]
156 [\fB\-aes128\fR]
157 [\fB\-aes192\fR]
158 [\fB\-aes256\fR]
159 [\fB\-camellia128\fR]
160 [\fB\-camellia192\fR]
161 [\fB\-camellia256\fR]
162 [\fB\-des\fR]
163 [\fB\-des3\fR]
164 [\fB\-idea\fR]
165 [\fB\-text\fR]
166 [\fB\-noout\fR]
167 [\fB\-modulus\fR]
168 [\fB\-pubin\fR]
169 [\fB\-pubout\fR]
170 [\fB\-engine id\fR]
171 .SH "DESCRIPTION"
172 .IX Header "DESCRIPTION"
173 The \fBdsa\fR command processes \s-1DSA\s0 keys. They can be converted between various
174 forms and their components printed out. \fBNote\fR This command uses the
175 traditional SSLeay compatible format for private key encryption: newer
176 applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
177 .SH "COMMAND OPTIONS"
178 .IX Header "COMMAND OPTIONS"
179 .IP "\fB\-inform DER|PEM\fR" 4
180 .IX Item "-inform DER|PEM"
181 This specifies the input format. The \fB\s-1DER\s0\fR option with a private key uses
182 an \s-1ASN1 DER\s0 encoded form of an \s-1ASN.1 SEQUENCE\s0 consisting of the values of
183 version (currently zero), p, q, g, the public and private key components
184 respectively as \s-1ASN.1\s0 INTEGERs. When used with a public key it uses a
185 SubjectPublicKeyInfo structure: it is an error if the key is not \s-1DSA.\s0
186 .Sp
187 The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
188 encoded with additional header and footer lines. In the case of a private key
189 PKCS#8 format is also accepted.
190 .IP "\fB\-outform DER|PEM\fR" 4
191 .IX Item "-outform DER|PEM"
192 This specifies the output format, the options have the same meaning as the
193 \&\fB\-inform\fR option.
194 .IP "\fB\-in filename\fR" 4
195 .IX Item "-in filename"
196 This specifies the input filename to read a key from or standard input if this
197 option is not specified. If the key is encrypted a pass phrase will be
198 prompted for.
199 .IP "\fB\-passin arg\fR" 4
200 .IX Item "-passin arg"
201 the input file password source. For more information about the format of \fBarg\fR
202 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
203 .IP "\fB\-out filename\fR" 4
204 .IX Item "-out filename"
205 This specifies the output filename to write a key to or standard output by
206 is not specified. If any encryption options are set then a pass phrase will be
207 prompted for. The output filename should \fBnot\fR be the same as the input
208 filename.
209 .IP "\fB\-passout arg\fR" 4
210 .IX Item "-passout arg"
211 the output file password source. For more information about the format of \fBarg\fR
212 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
213 .IP "\fB\-aes128|\-aes192|\-aes256|\-camellia128|\-camellia192|\-camellia256|\-des|\-des3|\-idea\fR" 4
214 .IX Item "-aes128|-aes192|-aes256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea"
215 These options encrypt the private key with the specified
216 cipher before outputting it. A pass phrase is prompted for.
217 If none of these options is specified the key is written in plain text. This
218 means that using the \fBdsa\fR utility to read in an encrypted key with no
219 encryption option can be used to remove the pass phrase from a key, or by
220 setting the encryption options it can be use to add or change the pass phrase.
221 These options can only be used with \s-1PEM\s0 format output files.
222 .IP "\fB\-text\fR" 4
223 .IX Item "-text"
224 prints out the public, private key components and parameters.
225 .IP "\fB\-noout\fR" 4
226 .IX Item "-noout"
227 this option prevents output of the encoded version of the key.
228 .IP "\fB\-modulus\fR" 4
229 .IX Item "-modulus"
230 this option prints out the value of the public key component of the key.
231 .IP "\fB\-pubin\fR" 4
232 .IX Item "-pubin"
233 by default a private key is read from the input file: with this option a
234 public key is read instead.
235 .IP "\fB\-pubout\fR" 4
236 .IX Item "-pubout"
237 by default a private key is output. With this option a public
238 key will be output instead. This option is automatically set if the input is
239 a public key.
240 .IP "\fB\-engine id\fR" 4
241 .IX Item "-engine id"
242 specifying an engine (by its unique \fBid\fR string) will cause \fBdsa\fR
243 to attempt to obtain a functional reference to the specified engine,
244 thus initialising it if needed. The engine will then be set as the default
245 for all available algorithms.
246 .SH "NOTES"
247 .IX Header "NOTES"
248 The \s-1PEM\s0 private key format uses the header and footer lines:
249 .PP
250 .Vb 2
251 \& \-\-\-\-\-BEGIN DSA PRIVATE KEY\-\-\-\-\-
252 \& \-\-\-\-\-END DSA PRIVATE KEY\-\-\-\-\-
253 .Ve
254 .PP
255 The \s-1PEM\s0 public key format uses the header and footer lines:
256 .PP
257 .Vb 2
258 \& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-
259 \& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\-
260 .Ve
261 .SH "EXAMPLES"
262 .IX Header "EXAMPLES"
263 To remove the pass phrase on a \s-1DSA\s0 private key:
264 .PP
265 .Vb 1
266 \& openssl dsa \-in key.pem \-out keyout.pem
267 .Ve
268 .PP
269 To encrypt a private key using triple \s-1DES:\s0
270 .PP
271 .Vb 1
272 \& openssl dsa \-in key.pem \-des3 \-out keyout.pem
273 .Ve
274 .PP
275 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
276 .PP
277 .Vb 1
278 \& openssl dsa \-in key.pem \-outform DER \-out keyout.der
279 .Ve
280 .PP
281 To print out the components of a private key to standard output:
282 .PP
283 .Vb 1
284 \& openssl dsa \-in key.pem \-text \-noout
285 .Ve
286 .PP
287 To just output the public part of a private key:
288 .PP
289 .Vb 1
290 \& openssl dsa \-in key.pem \-pubout \-out pubkey.pem
291 .Ve
292 .SH "SEE ALSO"
293 .IX Header "SEE ALSO"
294 \&\fIopenssl_dsaparam\fR\|(1), \fIopenssl_gendsa\fR\|(1), \fIopenssl_rsa\fR\|(1),
295 \&\fIopenssl_genrsa\fR\|(1)