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