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