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