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