| blob | 9d7b1e840300f9905732b16bb072de009b76ab41 |
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
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' ""
43 'br\}
44 .el\{\
45 . ds -- \|\(em\|
46 . ds PI \(*p
47 . ds L" ``
48 . ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), 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 .if \nF \{\
56 . de IX
57 . tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 . nr % 0
60 . rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
71 .if n \{\
72 . ds #H 0
73 . ds #V .8m
74 . ds #F .3m
75 . ds #[ \f1
76 . ds #] \fP
77 .\}
78 .if t \{\
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . ds #V .6m
81 . ds #F 0
82 . ds #[ \&
83 . ds #] \&
84 .\}
85 . \" simple accents for nroff and troff
86 .if n \{\
87 . ds ' \&
88 . ds ` \&
89 . ds ^ \&
90 . ds , \&
91 . ds ~ ~
92 . ds /
93 .\}
94 .if t \{\
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 . ds : e
119 . ds 8 ss
120 . ds o a
121 . ds d- d\h'-1'\(ga
122 . ds D- D\h'-1'\(hy
123 . ds th \o'bp'
124 . ds Th \o'LP'
125 . ds ae ae
126 . ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "RSA 1"
132 .TH RSA 1 "2014-10-15" "1.0.1k" "OpenSSL"
133 .SH "NAME"
134 rsa \- RSA key processing tool
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBopenssl\fR \fBrsa\fR
138 [\fB\-inform PEM|NET|DER\fR]
139 [\fB\-outform PEM|NET|DER\fR]
140 [\fB\-in filename\fR]
141 [\fB\-passin arg\fR]
142 [\fB\-out filename\fR]
143 [\fB\-passout arg\fR]
144 [\fB\-sgckey\fR]
145 [\fB\-aes128\fR]
146 [\fB\-aes192\fR]
147 [\fB\-aes256\fR]
148 [\fB\-camellia128\fR]
149 [\fB\-camellia192\fR]
150 [\fB\-camellia256\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\-check\fR]
158 [\fB\-pubin\fR]
159 [\fB\-pubout\fR]
160 [\fB\-RSAPublicKey_in\fR]
161 [\fB\-RSAPublicKey_out\fR]
162 [\fB\-engine id\fR]
163 .SH "DESCRIPTION"
164 .IX Header "DESCRIPTION"
165 The \fBrsa\fR command processes \s-1RSA\s0 keys. They can be converted between various
166 forms and their components printed out. \fBNote\fR this command uses the
167 traditional SSLeay compatible format for private key encryption: newer
168 applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
169 utility.
170 .SH "COMMAND OPTIONS"
171 .IX Header "COMMAND OPTIONS"
172 .IP "\fB\-inform DER|NET|PEM\fR" 4
173 .IX Item "-inform DER|NET|PEM"
174 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
175 form compatible with the PKCS#1 RSAPrivateKey or SubjectPublicKeyInfo format.
176 The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
177 encoded with additional header and footer lines. On input PKCS#8 format private
178 keys are also accepted. The \fB\s-1NET\s0\fR form is a format is described in the \fB\s-1NOTES\s0\fR
179 section.
180 .IP "\fB\-outform DER|NET|PEM\fR" 4
181 .IX Item "-outform DER|NET|PEM"
182 This specifies the output format, the options have the same meaning as the
183 \&\fB\-inform\fR option.
184 .IP "\fB\-in filename\fR" 4
185 .IX Item "-in filename"
186 This specifies the input filename to read a key from or standard input if this
187 option is not specified. If the key is encrypted a pass phrase will be
188 prompted for.
189 .IP "\fB\-passin arg\fR" 4
190 .IX Item "-passin arg"
191 the input file password source. For more information about the format of \fBarg\fR
192 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
193 .IP "\fB\-out filename\fR" 4
194 .IX Item "-out filename"
195 This specifies the output filename to write a key to or standard output if this
196 option is not specified. If any encryption options are set then a pass phrase
197 will be prompted for. The output filename should \fBnot\fR be the same as the input
198 filename.
199 .IP "\fB\-passout password\fR" 4
200 .IX Item "-passout password"
201 the output file password source. For more information about the format of \fBarg\fR
202 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
203 .IP "\fB\-sgckey\fR" 4
204 .IX Item "-sgckey"
205 use the modified \s-1NET\s0 algorithm used with some versions of Microsoft \s-1IIS\s0 and \s-1SGC\s0
206 keys.
207 .IP "\fB\-aes128|\-aes192|\-aes256|\-camellia128|\-camellia192|\-camellia256|\-des|\-des3|\-idea\fR" 4
208 .IX Item "-aes128|-aes192|-aes256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea"
209 These options encrypt the private key with the specified
210 cipher before outputting it. A pass phrase is prompted for.
211 If none of these options is specified the key is written in plain text. This
212 means that using the \fBrsa\fR utility to read in an encrypted key with no
213 encryption option can be used to remove the pass phrase from a key, or by
214 setting the encryption options it can be use to add or change the pass phrase.
215 These options can only be used with \s-1PEM\s0 format output files.
216 .IP "\fB\-text\fR" 4
217 .IX Item "-text"
218 prints out the various public or private key components in
219 plain text in addition to the encoded version.
220 .IP "\fB\-noout\fR" 4
221 .IX Item "-noout"
222 this option prevents output of the encoded version of the key.
223 .IP "\fB\-modulus\fR" 4
224 .IX Item "-modulus"
225 this option prints out the value of the modulus of the key.
226 .IP "\fB\-check\fR" 4
227 .IX Item "-check"
228 this option checks the consistency of an \s-1RSA\s0 private key.
229 .IP "\fB\-pubin\fR" 4
230 .IX Item "-pubin"
231 by default a private key is read from the input file: with this
232 option a public key is read instead.
233 .IP "\fB\-pubout\fR" 4
234 .IX Item "-pubout"
235 by default a private key is output: with this option a public
236 key will be output instead. This option is automatically set if
237 the input is a public key.
238 .IP "\fB\-RSAPublicKey_in\fR, \fB\-RSAPublicKey_out\fR" 4
239 .IX Item "-RSAPublicKey_in, -RSAPublicKey_out"
240 like \fB\-pubin\fR and \fB\-pubout\fR except \fBRSAPublicKey\fR format is used instead.
241 .IP "\fB\-engine id\fR" 4
242 .IX Item "-engine id"
243 specifying an engine (by its unique \fBid\fR string) will cause \fBrsa\fR
244 to attempt to obtain a functional reference to the specified engine,
245 thus initialising it if needed. The engine will then be set as the default
246 for all available algorithms.
247 .SH "NOTES"
248 .IX Header "NOTES"
249 The \s-1PEM\s0 private key format uses the header and footer lines:
250 .PP
251 .Vb 2
252 \& -----BEGIN RSA PRIVATE KEY-----
253 \& -----END RSA PRIVATE KEY-----
254 .Ve
255 .PP
256 The \s-1PEM\s0 public key format uses the header and footer lines:
257 .PP
258 .Vb 2
259 \& -----BEGIN PUBLIC KEY-----
260 \& -----END PUBLIC KEY-----
261 .Ve
262 .PP
263 The \s-1PEM\s0 \fBRSAPublicKey\fR format uses the header and footer lines:
264 .PP
265 .Vb 2
266 \& -----BEGIN RSA PUBLIC KEY-----
267 \& -----END RSA PUBLIC KEY-----
268 .Ve
269 .PP
270 The \fB\s-1NET\s0\fR form is a format compatible with older Netscape servers
271 and Microsoft \s-1IIS\s0 .key files, this uses unsalted \s-1RC4\s0 for its encryption.
272 It is not very secure and so should only be used when necessary.
273 .PP
274 Some newer version of \s-1IIS\s0 have additional data in the exported .key
275 files. To use these with the utility, view the file with a binary editor
276 and look for the string \*(L"private\-key\*(R", then trace back to the byte
277 sequence 0x30, 0x82 (this is an \s-1ASN1\s0 \s-1SEQUENCE\s0). Copy all the data
278 from this point onwards to another file and use that as the input
279 to the \fBrsa\fR utility with the \fB\-inform \s-1NET\s0\fR option. If you get
280 an error after entering the password try the \fB\-sgckey\fR option.
281 .SH "EXAMPLES"
282 .IX Header "EXAMPLES"
283 To remove the pass phrase on an \s-1RSA\s0 private key:
284 .PP
285 .Vb 1
286 \& openssl rsa -in key.pem -out keyout.pem
287 .Ve
288 .PP
289 To encrypt a private key using triple \s-1DES:\s0
290 .PP
291 .Vb 1
292 \& openssl rsa -in key.pem -des3 -out keyout.pem
293 .Ve
294 .PP
295 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
296 .PP
297 .Vb 1
298 \& openssl rsa -in key.pem -outform DER -out keyout.der
299 .Ve
300 .PP
301 To print out the components of a private key to standard output:
302 .PP
303 .Vb 1
304 \& openssl rsa -in key.pem -text -noout
305 .Ve
306 .PP
307 To just output the public part of a private key:
308 .PP
309 .Vb 1
310 \& openssl rsa -in key.pem -pubout -out pubkey.pem
311 .Ve
312 .PP
313 Output the public part of a private key in \fBRSAPublicKey\fR format:
314 .PP
315 .Vb 1
316 \& openssl rsa -in key.pem -RSAPublicKey_out -out pubkey.pem
317 .Ve
318 .SH "BUGS"
319 .IX Header "BUGS"
320 The command line password arguments don't currently work with
321 \&\fB\s-1NET\s0\fR format.
322 .PP
323 There should be an option that automatically handles .key files,
324 without having to manually edit them.
325 .SH "SEE ALSO"
326 .IX Header "SEE ALSO"
327 \&\fIpkcs8\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
328 \&\fIgendsa\fR\|(1)