]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - secure/usr.bin/openssl/man/rsautl.1
MFC: r337791
[FreeBSD/FreeBSD.git] / secure / usr.bin / openssl / man / rsautl.1
1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
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-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
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' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .if !\nF .nr F 0
58 .if \nF>0 \{\
59 .    de IX
60 .    tm Index:\\$1\t\\n%\t"\\$2"
61 ..
62 .    if !\nF==2 \{\
63 .        nr % 0
64 .        nr F 2
65 .    \}
66 .\}
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 "RSAUTL 1"
132 .TH RSAUTL 1 "2018-08-14" "1.0.2p" "OpenSSL"
133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
135 .if n .ad l
136 .nh
137 .SH "NAME"
138 openssl\-rsautl,
139 rsautl \- RSA utility
140 .SH "SYNOPSIS"
141 .IX Header "SYNOPSIS"
142 \&\fBopenssl\fR \fBrsautl\fR
143 [\fB\-in file\fR]
144 [\fB\-out file\fR]
145 [\fB\-inkey file\fR]
146 [\fB\-pubin\fR]
147 [\fB\-certin\fR]
148 [\fB\-sign\fR]
149 [\fB\-verify\fR]
150 [\fB\-encrypt\fR]
151 [\fB\-decrypt\fR]
152 [\fB\-pkcs\fR]
153 [\fB\-ssl\fR]
154 [\fB\-raw\fR]
155 [\fB\-hexdump\fR]
156 [\fB\-asn1parse\fR]
157 .SH "DESCRIPTION"
158 .IX Header "DESCRIPTION"
159 The \fBrsautl\fR command can be used to sign, verify, encrypt and decrypt
160 data using the \s-1RSA\s0 algorithm.
161 .SH "COMMAND OPTIONS"
162 .IX Header "COMMAND OPTIONS"
163 .IP "\fB\-in filename\fR" 4
164 .IX Item "-in filename"
165 This specifies the input filename to read data from or standard input
166 if this option is not specified.
167 .IP "\fB\-out filename\fR" 4
168 .IX Item "-out filename"
169 specifies the output filename to write to or standard output by
170 default.
171 .IP "\fB\-inkey file\fR" 4
172 .IX Item "-inkey file"
173 the input key file, by default it should be an \s-1RSA\s0 private key.
174 .IP "\fB\-pubin\fR" 4
175 .IX Item "-pubin"
176 the input file is an \s-1RSA\s0 public key.
177 .IP "\fB\-certin\fR" 4
178 .IX Item "-certin"
179 the input is a certificate containing an \s-1RSA\s0 public key.
180 .IP "\fB\-sign\fR" 4
181 .IX Item "-sign"
182 sign the input data and output the signed result. This requires
183 and \s-1RSA\s0 private key.
184 .IP "\fB\-verify\fR" 4
185 .IX Item "-verify"
186 verify the input data and output the recovered data.
187 .IP "\fB\-encrypt\fR" 4
188 .IX Item "-encrypt"
189 encrypt the input data using an \s-1RSA\s0 public key.
190 .IP "\fB\-decrypt\fR" 4
191 .IX Item "-decrypt"
192 decrypt the input data using an \s-1RSA\s0 private key.
193 .IP "\fB\-pkcs, \-oaep, \-ssl, \-raw\fR" 4
194 .IX Item "-pkcs, -oaep, -ssl, -raw"
195 the padding to use: PKCS#1 v1.5 (the default), PKCS#1 \s-1OAEP,\s0
196 special padding used in \s-1SSL\s0 v2 backwards compatible handshakes,
197 or no padding, respectively.
198 For signatures, only \fB\-pkcs\fR and \fB\-raw\fR can be used.
199 .IP "\fB\-hexdump\fR" 4
200 .IX Item "-hexdump"
201 hex dump the output data.
202 .IP "\fB\-asn1parse\fR" 4
203 .IX Item "-asn1parse"
204 asn1parse the output data, this is useful when combined with the
205 \&\fB\-verify\fR option.
206 .SH "NOTES"
207 .IX Header "NOTES"
208 \&\fBrsautl\fR because it uses the \s-1RSA\s0 algorithm directly can only be
209 used to sign or verify small pieces of data.
210 .SH "EXAMPLES"
211 .IX Header "EXAMPLES"
212 Sign some data using a private key:
213 .PP
214 .Vb 1
215 \& openssl rsautl \-sign \-in file \-inkey key.pem \-out sig
216 .Ve
217 .PP
218 Recover the signed data
219 .PP
220 .Vb 1
221 \& openssl rsautl \-verify \-in sig \-inkey key.pem
222 .Ve
223 .PP
224 Examine the raw signed data:
225 .PP
226 .Vb 1
227 \& openssl rsautl \-verify \-in sig \-inkey key.pem \-raw \-hexdump
228 \&
229 \& 0000 \- 00 01 ff ff ff ff ff ff\-ff ff ff ff ff ff ff ff   ................
230 \& 0010 \- ff ff ff ff ff ff ff ff\-ff ff ff ff ff ff ff ff   ................
231 \& 0020 \- ff ff ff ff ff ff ff ff\-ff ff ff ff ff ff ff ff   ................
232 \& 0030 \- ff ff ff ff ff ff ff ff\-ff ff ff ff ff ff ff ff   ................
233 \& 0040 \- ff ff ff ff ff ff ff ff\-ff ff ff ff ff ff ff ff   ................
234 \& 0050 \- ff ff ff ff ff ff ff ff\-ff ff ff ff ff ff ff ff   ................
235 \& 0060 \- ff ff ff ff ff ff ff ff\-ff ff ff ff ff ff ff ff   ................
236 \& 0070 \- ff ff ff ff 00 68 65 6c\-6c 6f 20 77 6f 72 6c 64   .....hello world
237 .Ve
238 .PP
239 The PKCS#1 block formatting is evident from this. If this was done using
240 encrypt and decrypt the block would have been of type 2 (the second byte)
241 and random padding data visible instead of the 0xff bytes.
242 .PP
243 It is possible to analyse the signature of certificates using this
244 utility in conjunction with \fBasn1parse\fR. Consider the self signed
245 example in certs/pca\-cert.pem . Running \fBasn1parse\fR as follows yields:
246 .PP
247 .Vb 1
248 \& openssl asn1parse \-in pca\-cert.pem
249 \&
250 \&    0:d=0  hl=4 l= 742 cons: SEQUENCE          
251 \&    4:d=1  hl=4 l= 591 cons:  SEQUENCE          
252 \&    8:d=2  hl=2 l=   3 cons:   cont [ 0 ]        
253 \&   10:d=3  hl=2 l=   1 prim:    INTEGER           :02
254 \&   13:d=2  hl=2 l=   1 prim:   INTEGER           :00
255 \&   16:d=2  hl=2 l=  13 cons:   SEQUENCE          
256 \&   18:d=3  hl=2 l=   9 prim:    OBJECT            :md5WithRSAEncryption
257 \&   29:d=3  hl=2 l=   0 prim:    NULL              
258 \&   31:d=2  hl=2 l=  92 cons:   SEQUENCE          
259 \&   33:d=3  hl=2 l=  11 cons:    SET               
260 \&   35:d=4  hl=2 l=   9 cons:     SEQUENCE          
261 \&   37:d=5  hl=2 l=   3 prim:      OBJECT            :countryName
262 \&   42:d=5  hl=2 l=   2 prim:      PRINTABLESTRING   :AU
263 \&  ....
264 \&  599:d=1  hl=2 l=  13 cons:  SEQUENCE          
265 \&  601:d=2  hl=2 l=   9 prim:   OBJECT            :md5WithRSAEncryption
266 \&  612:d=2  hl=2 l=   0 prim:   NULL              
267 \&  614:d=1  hl=3 l= 129 prim:  BIT STRING
268 .Ve
269 .PP
270 The final \s-1BIT STRING\s0 contains the actual signature. It can be extracted with:
271 .PP
272 .Vb 1
273 \& openssl asn1parse \-in pca\-cert.pem \-out sig \-noout \-strparse 614
274 .Ve
275 .PP
276 The certificate public key can be extracted with:
277 .PP
278 .Vb 1
279 \& openssl x509 \-in test/testx509.pem \-pubkey \-noout >pubkey.pem
280 .Ve
281 .PP
282 The signature can be analysed with:
283 .PP
284 .Vb 1
285 \& openssl rsautl \-in sig \-verify \-asn1parse \-inkey pubkey.pem \-pubin
286 \&
287 \&    0:d=0  hl=2 l=  32 cons: SEQUENCE          
288 \&    2:d=1  hl=2 l=  12 cons:  SEQUENCE          
289 \&    4:d=2  hl=2 l=   8 prim:   OBJECT            :md5
290 \&   14:d=2  hl=2 l=   0 prim:   NULL              
291 \&   16:d=1  hl=2 l=  16 prim:  OCTET STRING      
292 \&      0000 \- f3 46 9e aa 1a 4a 73 c9\-37 ea 93 00 48 25 08 b5   .F...Js.7...H%..
293 .Ve
294 .PP
295 This is the parsed version of an \s-1ASN1\s0 DigestInfo structure. It can be seen that
296 the digest used was md5. The actual part of the certificate that was signed can
297 be extracted with:
298 .PP
299 .Vb 1
300 \& openssl asn1parse \-in pca\-cert.pem \-out tbs \-noout \-strparse 4
301 .Ve
302 .PP
303 and its digest computed with:
304 .PP
305 .Vb 2
306 \& openssl md5 \-c tbs
307 \& MD5(tbs)= f3:46:9e:aa:1a:4a:73:c9:37:ea:93:00:48:25:08:b5
308 .Ve
309 .PP
310 which it can be seen agrees with the recovered value above.
311 .SH "SEE ALSO"
312 .IX Header "SEE ALSO"
313 \&\fIdgst\fR\|(1), \fIrsa\fR\|(1), \fIgenrsa\fR\|(1)