Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / usr.bin / openssl / man / rsa.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 "RSA 1"
e3261593 127.TH RSA 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 133rsa \- RSA key processing tool
984263bc 134.SH "SYNOPSIS"
8b0cefbb
JR
135.IX Header "SYNOPSIS"
136\&\fBopenssl\fR \fBrsa\fR
984263bc
MD
137[\fB\-inform PEM|NET|DER\fR]
138[\fB\-outform PEM|NET|DER\fR]
139[\fB\-in filename\fR]
140[\fB\-passin arg\fR]
141[\fB\-out filename\fR]
142[\fB\-passout arg\fR]
143[\fB\-sgckey\fR]
144[\fB\-des\fR]
145[\fB\-des3\fR]
146[\fB\-idea\fR]
147[\fB\-text\fR]
148[\fB\-noout\fR]
149[\fB\-modulus\fR]
150[\fB\-check\fR]
151[\fB\-pubin\fR]
152[\fB\-pubout\fR]
153[\fB\-engine id\fR]
154.SH "DESCRIPTION"
8b0cefbb
JR
155.IX Header "DESCRIPTION"
156The \fBrsa\fR command processes \s-1RSA\s0 keys. They can be converted between various
984263bc
MD
157forms and their components printed out. \fBNote\fR this command uses the
158traditional SSLeay compatible format for private key encryption: newer
159applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
160utility.
161.SH "COMMAND OPTIONS"
8b0cefbb
JR
162.IX Header "COMMAND OPTIONS"
163.IP "\fB\-inform DER|NET|PEM\fR" 4
164.IX Item "-inform DER|NET|PEM"
984263bc 165This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
8b0cefbb 166form compatible with the PKCS#1 RSAPrivateKey or SubjectPublicKeyInfo format.
984263bc 167The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
8b0cefbb 168encoded with additional header and footer lines. On input PKCS#8 format private
984263bc
MD
169keys are also accepted. The \fB\s-1NET\s0\fR form is a format is described in the \fB\s-1NOTES\s0\fR
170section.
8b0cefbb
JR
171.IP "\fB\-outform DER|NET|PEM\fR" 4
172.IX Item "-outform DER|NET|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 if this
187option is not specified. If any encryption options are set then a pass phrase
188will be prompted for. The output filename should \fBnot\fR be the same as the input
189filename.
8b0cefbb
JR
190.IP "\fB\-passout password\fR" 4
191.IX Item "-passout password"
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\-sgckey\fR" 4
195.IX Item "-sgckey"
984263bc
MD
196use the modified \s-1NET\s0 algorithm used with some versions of Microsoft \s-1IIS\s0 and \s-1SGC\s0
197keys.
8b0cefbb
JR
198.IP "\fB\-des|\-des3|\-idea\fR" 4
199.IX Item "-des|-des3|-idea"
984263bc 200These options encrypt the private key with the \s-1DES\s0, triple \s-1DES\s0, or the
8b0cefbb 201\&\s-1IDEA\s0 ciphers respectively before outputting it. A pass phrase is prompted for.
984263bc
MD
202If none of these options is specified the key is written in plain text. This
203means that using the \fBrsa\fR utility to read in an encrypted key with no
204encryption option can be used to remove the pass phrase from a key, or by
205setting the encryption options it can be use to add or change the pass phrase.
206These options can only be used with \s-1PEM\s0 format output files.
8b0cefbb
JR
207.IP "\fB\-text\fR" 4
208.IX Item "-text"
984263bc 209prints out the various public or private key components in
e257b235 210plain text in addition to the encoded version.
8b0cefbb
JR
211.IP "\fB\-noout\fR" 4
212.IX Item "-noout"
984263bc 213this option prevents output of the encoded version of the key.
8b0cefbb
JR
214.IP "\fB\-modulus\fR" 4
215.IX Item "-modulus"
984263bc 216this option prints out the value of the modulus of the key.
8b0cefbb
JR
217.IP "\fB\-check\fR" 4
218.IX Item "-check"
984263bc 219this option checks the consistency of an \s-1RSA\s0 private 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
223option a public 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
228the input is a public key.
8b0cefbb
JR
229.IP "\fB\-engine id\fR" 4
230.IX Item "-engine id"
01185282 231specifying an engine (by its unique \fBid\fR string) will cause \fBrsa\fR
984263bc
MD
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 RSA PRIVATE KEY\-\-\-\-\-
241\& \-\-\-\-\-END RSA 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 249.Ve
8b0cefbb
JR
250.PP
251The \fB\s-1NET\s0\fR form is a format compatible with older Netscape servers
252and Microsoft \s-1IIS\s0 .key files, this uses unsalted \s-1RC4\s0 for its encryption.
984263bc
MD
253It is not very secure and so should only be used when necessary.
254.PP
8b0cefbb 255Some newer version of \s-1IIS\s0 have additional data in the exported .key
984263bc 256files. To use these with the utility, view the file with a binary editor
e257b235 257and look for the string \*(L"private-key\*(R", then trace back to the byte
8b0cefbb 258sequence 0x30, 0x82 (this is an \s-1ASN1\s0 \s-1SEQUENCE\s0). Copy all the data
984263bc 259from this point onwards to another file and use that as the input
8b0cefbb 260to the \fBrsa\fR utility with the \fB\-inform \s-1NET\s0\fR option. If you get
984263bc
MD
261an error after entering the password try the \fB\-sgckey\fR option.
262.SH "EXAMPLES"
8b0cefbb
JR
263.IX Header "EXAMPLES"
264To remove the pass phrase on an \s-1RSA\s0 private key:
984263bc
MD
265.PP
266.Vb 1
e257b235 267\& openssl rsa \-in key.pem \-out keyout.pem
984263bc 268.Ve
8b0cefbb
JR
269.PP
270To encrypt a private key using triple \s-1DES:\s0
984263bc
MD
271.PP
272.Vb 1
e257b235 273\& openssl rsa \-in key.pem \-des3 \-out keyout.pem
984263bc 274.Ve
8b0cefbb 275.PP
e257b235 276To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
984263bc
MD
277.PP
278.Vb 1
e257b235 279\& openssl rsa \-in key.pem \-outform DER \-out keyout.der
984263bc 280.Ve
8b0cefbb 281.PP
984263bc
MD
282To print out the components of a private key to standard output:
283.PP
284.Vb 1
e257b235 285\& openssl rsa \-in key.pem \-text \-noout
984263bc 286.Ve
8b0cefbb 287.PP
984263bc
MD
288To just output the public part of a private key:
289.PP
290.Vb 1
e257b235 291\& openssl rsa \-in key.pem \-pubout \-out pubkey.pem
984263bc
MD
292.Ve
293.SH "BUGS"
8b0cefbb 294.IX Header "BUGS"
984263bc 295The command line password arguments don't currently work with
8b0cefbb 296\&\fB\s-1NET\s0\fR format.
984263bc
MD
297.PP
298There should be an option that automatically handles .key files,
299without having to manually edit them.
300.SH "SEE ALSO"
e3cdf75b 301.IX Header "SEE ALSO"
8b0cefbb 302\&\fIpkcs8\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
e257b235 303\&\fIgendsa\fR\|(1)