Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / usr.bin / openssl / man / dsa.1
CommitLineData
e3261593 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
8b0cefbb 5.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
6.if t .sp .5v
7.if n .sp
8..
8b0cefbb 9.de Vb \" Begin verbatim text
984263bc
MD
10.ft CW
11.nf
12.ne \\$1
13..
8b0cefbb 14.de Ve \" End verbatim text
984263bc 15.ft R
984263bc
MD
16.fi
17..
8b0cefbb
JR
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
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-
8b0cefbb 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 26.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
35'br\}
36.el\{\
8b0cefbb
JR
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
984263bc 41'br\}
8b0cefbb 42.\"
e257b235
PA
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
8b0cefbb 47.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
8b0cefbb
JR
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
e257b235 51.ie \nF \{\
8b0cefbb
JR
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 54..
8b0cefbb
JR
55. nr % 0
56. rr F
984263bc 57.\}
e257b235
PA
58.el \{\
59. de IX
60..
61.\}
aac4ff6f 62.\"
8b0cefbb
JR
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
984263bc 66.if n \{\
8b0cefbb
JR
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
984263bc
MD
72.\}
73.if t \{\
8b0cefbb
JR
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
984263bc 79.\}
8b0cefbb 80. \" simple accents for nroff and troff
984263bc 81.if n \{\
8b0cefbb
JR
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
984263bc
MD
88.\}
89.if t \{\
8b0cefbb
JR
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'
984263bc 96.\}
8b0cefbb 97. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 107. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 110. \" for low resolution devices (crt and lpr)
984263bc
MD
111.if \n(.H>23 .if \n(.V>19 \
112\{\
8b0cefbb
JR
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
984263bc
MD
122.\}
123.rm #[ #] #H #V #F C
8b0cefbb
JR
124.\" ========================================================================
125.\"
126.IX Title "DSA 1"
e3261593 127.TH DSA 1 "2012-01-04" "1.0.0f" "OpenSSL"
e257b235
PA
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
984263bc 132.SH "NAME"
e3cdf75b 133dsa \- DSA key processing
984263bc 134.SH "SYNOPSIS"
8b0cefbb
JR
135.IX Header "SYNOPSIS"
136\&\fBopenssl\fR \fBdsa\fR
984263bc
MD
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\-des\fR]
144[\fB\-des3\fR]
145[\fB\-idea\fR]
146[\fB\-text\fR]
147[\fB\-noout\fR]
148[\fB\-modulus\fR]
149[\fB\-pubin\fR]
150[\fB\-pubout\fR]
151[\fB\-engine id\fR]
152.SH "DESCRIPTION"
8b0cefbb
JR
153.IX Header "DESCRIPTION"
154The \fBdsa\fR command processes \s-1DSA\s0 keys. They can be converted between various
984263bc
MD
155forms and their components printed out. \fBNote\fR This command uses the
156traditional SSLeay compatible format for private key encryption: newer
157applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
158.SH "COMMAND OPTIONS"
8b0cefbb
JR
159.IX Header "COMMAND OPTIONS"
160.IP "\fB\-inform DER|PEM\fR" 4
161.IX Item "-inform DER|PEM"
984263bc
MD
162This specifies the input format. The \fB\s-1DER\s0\fR option with a private key uses
163an \s-1ASN1\s0 \s-1DER\s0 encoded form of an \s-1ASN\s0.1 \s-1SEQUENCE\s0 consisting of the values of
164version (currently zero), p, q, g, the public and private key components
165respectively as \s-1ASN\s0.1 INTEGERs. When used with a public key it uses a
166SubjectPublicKeyInfo structure: it is an error if the key is not \s-1DSA\s0.
167.Sp
168The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
169encoded with additional header and footer lines. In the case of a private key
8b0cefbb
JR
170PKCS#8 format is also accepted.
171.IP "\fB\-outform DER|PEM\fR" 4
172.IX Item "-outform DER|PEM"
984263bc 173This specifies the output format, the options have the same meaning as the
8b0cefbb
JR
174\&\fB\-inform\fR option.
175.IP "\fB\-in filename\fR" 4
176.IX Item "-in filename"
984263bc
MD
177This specifies the input filename to read a key from or standard input if this
178option is not specified. If the key is encrypted a pass phrase will be
179prompted for.
8b0cefbb
JR
180.IP "\fB\-passin arg\fR" 4
181.IX Item "-passin arg"
984263bc 182the input file password source. For more information about the format of \fBarg\fR
8b0cefbb
JR
183see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
184.IP "\fB\-out filename\fR" 4
185.IX Item "-out filename"
984263bc
MD
186This specifies the output filename to write a key to or standard output by
187is not specified. If any encryption options are set then a pass phrase will be
188prompted for. The output filename should \fBnot\fR be the same as the input
189filename.
8b0cefbb
JR
190.IP "\fB\-passout arg\fR" 4
191.IX Item "-passout arg"
984263bc 192the output file password source. For more information about the format of \fBarg\fR
8b0cefbb
JR
193see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
194.IP "\fB\-des|\-des3|\-idea\fR" 4
195.IX Item "-des|-des3|-idea"
984263bc 196These options encrypt the private key with the \s-1DES\s0, triple \s-1DES\s0, or the
8b0cefbb 197\&\s-1IDEA\s0 ciphers respectively before outputting it. A pass phrase is prompted for.
984263bc
MD
198If none of these options is specified the key is written in plain text. This
199means that using the \fBdsa\fR utility to read in an encrypted key with no
200encryption option can be used to remove the pass phrase from a key, or by
201setting the encryption options it can be use to add or change the pass phrase.
202These options can only be used with \s-1PEM\s0 format output files.
8b0cefbb
JR
203.IP "\fB\-text\fR" 4
204.IX Item "-text"
984263bc 205prints out the public, private key components and parameters.
8b0cefbb
JR
206.IP "\fB\-noout\fR" 4
207.IX Item "-noout"
984263bc 208this option prevents output of the encoded version of the key.
8b0cefbb
JR
209.IP "\fB\-modulus\fR" 4
210.IX Item "-modulus"
984263bc 211this option prints out the value of the public key component of the key.
8b0cefbb
JR
212.IP "\fB\-pubin\fR" 4
213.IX Item "-pubin"
984263bc
MD
214by default a private key is read from the input file: with this option a
215public key is read instead.
8b0cefbb
JR
216.IP "\fB\-pubout\fR" 4
217.IX Item "-pubout"
984263bc
MD
218by default a private key is output. With this option a public
219key will be output instead. This option is automatically set if the input is
220a public key.
8b0cefbb
JR
221.IP "\fB\-engine id\fR" 4
222.IX Item "-engine id"
01185282 223specifying an engine (by its unique \fBid\fR string) will cause \fBdsa\fR
984263bc
MD
224to attempt to obtain a functional reference to the specified engine,
225thus initialising it if needed. The engine will then be set as the default
226for all available algorithms.
227.SH "NOTES"
8b0cefbb
JR
228.IX Header "NOTES"
229The \s-1PEM\s0 private key format uses the header and footer lines:
984263bc
MD
230.PP
231.Vb 2
e257b235
PA
232\& \-\-\-\-\-BEGIN DSA PRIVATE KEY\-\-\-\-\-
233\& \-\-\-\-\-END DSA PRIVATE KEY\-\-\-\-\-
984263bc 234.Ve
8b0cefbb
JR
235.PP
236The \s-1PEM\s0 public key format uses the header and footer lines:
984263bc
MD
237.PP
238.Vb 2
e257b235
PA
239\& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-
240\& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\-
984263bc
MD
241.Ve
242.SH "EXAMPLES"
8b0cefbb
JR
243.IX Header "EXAMPLES"
244To remove the pass phrase on a \s-1DSA\s0 private key:
984263bc
MD
245.PP
246.Vb 1
e257b235 247\& openssl dsa \-in key.pem \-out keyout.pem
984263bc 248.Ve
8b0cefbb
JR
249.PP
250To encrypt a private key using triple \s-1DES:\s0
984263bc
MD
251.PP
252.Vb 1
e257b235 253\& openssl dsa \-in key.pem \-des3 \-out keyout.pem
984263bc 254.Ve
8b0cefbb 255.PP
e257b235 256To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
984263bc
MD
257.PP
258.Vb 1
e257b235 259\& openssl dsa \-in key.pem \-outform DER \-out keyout.der
984263bc 260.Ve
8b0cefbb 261.PP
984263bc
MD
262To print out the components of a private key to standard output:
263.PP
264.Vb 1
e257b235 265\& openssl dsa \-in key.pem \-text \-noout
984263bc 266.Ve
8b0cefbb 267.PP
984263bc
MD
268To just output the public part of a private key:
269.PP
270.Vb 1
e257b235 271\& openssl dsa \-in key.pem \-pubout \-out pubkey.pem
984263bc
MD
272.Ve
273.SH "SEE ALSO"
e3cdf75b 274.IX Header "SEE ALSO"
8b0cefbb
JR
275\&\fIdsaparam\fR\|(1), \fIgendsa\fR\|(1), \fIrsa\fR\|(1),
276\&\fIgenrsa\fR\|(1)