Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | rsautl - RSA utility |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | B<openssl> B<rsautl> |
A J Mohan Rao | 169394d | 2016-02-05 11:58:45 -0500 | [diff] [blame] | 10 | [B<-help>] |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 11 | [B<-in file>] |
| 12 | [B<-out file>] |
| 13 | [B<-inkey file>] |
Viktor Dukhovni | 0c20802 | 2016-02-02 00:37:41 -0500 | [diff] [blame] | 14 | [B<-keyform PEM|DER|ENGINE>] |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 15 | [B<-pubin>] |
| 16 | [B<-certin>] |
| 17 | [B<-sign>] |
| 18 | [B<-verify>] |
| 19 | [B<-encrypt>] |
| 20 | [B<-decrypt>] |
| 21 | [B<-pkcs>] |
| 22 | [B<-ssl>] |
| 23 | [B<-raw>] |
| 24 | [B<-hexdump>] |
| 25 | [B<-asn1parse>] |
| 26 | |
| 27 | =head1 DESCRIPTION |
| 28 | |
| 29 | The B<rsautl> command can be used to sign, verify, encrypt and decrypt |
| 30 | data using the RSA algorithm. |
| 31 | |
Rich Salz | 3dfda1a | 2016-12-12 11:14:40 -0500 | [diff] [blame] | 32 | =head1 OPTIONS |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 33 | |
| 34 | =over 4 |
| 35 | |
A J Mohan Rao | 169394d | 2016-02-05 11:58:45 -0500 | [diff] [blame] | 36 | =item B<-help> |
| 37 | |
| 38 | Print out a usage message. |
| 39 | |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 40 | =item B<-in filename> |
| 41 | |
| 42 | This specifies the input filename to read data from or standard input |
| 43 | if this option is not specified. |
| 44 | |
| 45 | =item B<-out filename> |
| 46 | |
| 47 | specifies the output filename to write to or standard output by |
| 48 | default. |
| 49 | |
| 50 | =item B<-inkey file> |
| 51 | |
| 52 | the input key file, by default it should be an RSA private key. |
| 53 | |
Viktor Dukhovni | 0c20802 | 2016-02-02 00:37:41 -0500 | [diff] [blame] | 54 | =item B<-keyform PEM|DER|ENGINE> |
| 55 | |
| 56 | the key format PEM, DER or ENGINE. |
| 57 | |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 58 | =item B<-pubin> |
| 59 | |
A J Mohan Rao | 169394d | 2016-02-05 11:58:45 -0500 | [diff] [blame] | 60 | the input file is an RSA public key. |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 61 | |
| 62 | =item B<-certin> |
| 63 | |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 64 | the input is a certificate containing an RSA public key. |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 65 | |
| 66 | =item B<-sign> |
| 67 | |
| 68 | sign the input data and output the signed result. This requires |
Soheil Rashidi | 9f07c40 | 2015-10-29 02:01:06 +0330 | [diff] [blame] | 69 | an RSA private key. |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 70 | |
| 71 | =item B<-verify> |
| 72 | |
| 73 | verify the input data and output the recovered data. |
| 74 | |
| 75 | =item B<-encrypt> |
| 76 | |
| 77 | encrypt the input data using an RSA public key. |
| 78 | |
| 79 | =item B<-decrypt> |
| 80 | |
| 81 | decrypt the input data using an RSA private key. |
| 82 | |
Bodo Möller | 2b40660 | 2000-09-06 11:49:43 +0000 | [diff] [blame] | 83 | =item B<-pkcs, -oaep, -ssl, -raw> |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 84 | |
Bodo Möller | 2b40660 | 2000-09-06 11:49:43 +0000 | [diff] [blame] | 85 | the padding to use: PKCS#1 v1.5 (the default), PKCS#1 OAEP, |
| 86 | special padding used in SSL v2 backwards compatible handshakes, |
| 87 | or no padding, respectively. |
| 88 | For signatures, only B<-pkcs> and B<-raw> can be used. |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 89 | |
| 90 | =item B<-hexdump> |
| 91 | |
| 92 | hex dump the output data. |
| 93 | |
| 94 | =item B<-asn1parse> |
| 95 | |
| 96 | asn1parse the output data, this is useful when combined with the |
| 97 | B<-verify> option. |
| 98 | |
| 99 | =back |
| 100 | |
| 101 | =head1 NOTES |
| 102 | |
| 103 | B<rsautl> because it uses the RSA algorithm directly can only be |
| 104 | used to sign or verify small pieces of data. |
| 105 | |
| 106 | =head1 EXAMPLES |
| 107 | |
Bodo Möller | 2b40660 | 2000-09-06 11:49:43 +0000 | [diff] [blame] | 108 | Sign some data using a private key: |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 109 | |
| 110 | openssl rsautl -sign -in file -inkey key.pem -out sig |
| 111 | |
| 112 | Recover the signed data |
| 113 | |
Lutz Jänicke | 0ea6594 | 2001-04-25 15:24:47 +0000 | [diff] [blame] | 114 | openssl rsautl -verify -in sig -inkey key.pem |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 115 | |
| 116 | Examine the raw signed data: |
| 117 | |
Lutz Jänicke | 0ea6594 | 2001-04-25 15:24:47 +0000 | [diff] [blame] | 118 | openssl rsautl -verify -in file -inkey key.pem -raw -hexdump |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 119 | |
| 120 | 0000 - 00 01 ff ff ff ff ff ff-ff ff ff ff ff ff ff ff ................ |
| 121 | 0010 - ff ff ff ff ff ff ff ff-ff ff ff ff ff ff ff ff ................ |
| 122 | 0020 - ff ff ff ff ff ff ff ff-ff ff ff ff ff ff ff ff ................ |
| 123 | 0030 - ff ff ff ff ff ff ff ff-ff ff ff ff ff ff ff ff ................ |
| 124 | 0040 - ff ff ff ff ff ff ff ff-ff ff ff ff ff ff ff ff ................ |
| 125 | 0050 - ff ff ff ff ff ff ff ff-ff ff ff ff ff ff ff ff ................ |
| 126 | 0060 - ff ff ff ff ff ff ff ff-ff ff ff ff ff ff ff ff ................ |
| 127 | 0070 - ff ff ff ff 00 68 65 6c-6c 6f 20 77 6f 72 6c 64 .....hello world |
| 128 | |
| 129 | The PKCS#1 block formatting is evident from this. If this was done using |
| 130 | encrypt and decrypt the block would have been of type 2 (the second byte) |
| 131 | and random padding data visible instead of the 0xff bytes. |
| 132 | |
| 133 | It is possible to analyse the signature of certificates using this |
| 134 | utility in conjunction with B<asn1parse>. Consider the self signed |
| 135 | example in certs/pca-cert.pem . Running B<asn1parse> as follows yields: |
| 136 | |
| 137 | openssl asn1parse -in pca-cert.pem |
| 138 | |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 139 | 0:d=0 hl=4 l= 742 cons: SEQUENCE |
| 140 | 4:d=1 hl=4 l= 591 cons: SEQUENCE |
| 141 | 8:d=2 hl=2 l= 3 cons: cont [ 0 ] |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 142 | 10:d=3 hl=2 l= 1 prim: INTEGER :02 |
| 143 | 13:d=2 hl=2 l= 1 prim: INTEGER :00 |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 144 | 16:d=2 hl=2 l= 13 cons: SEQUENCE |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 145 | 18:d=3 hl=2 l= 9 prim: OBJECT :md5WithRSAEncryption |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 146 | 29:d=3 hl=2 l= 0 prim: NULL |
| 147 | 31:d=2 hl=2 l= 92 cons: SEQUENCE |
| 148 | 33:d=3 hl=2 l= 11 cons: SET |
| 149 | 35:d=4 hl=2 l= 9 cons: SEQUENCE |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 150 | 37:d=5 hl=2 l= 3 prim: OBJECT :countryName |
| 151 | 42:d=5 hl=2 l= 2 prim: PRINTABLESTRING :AU |
| 152 | .... |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 153 | 599:d=1 hl=2 l= 13 cons: SEQUENCE |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 154 | 601:d=2 hl=2 l= 9 prim: OBJECT :md5WithRSAEncryption |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 155 | 612:d=2 hl=2 l= 0 prim: NULL |
| 156 | 614:d=1 hl=3 l= 129 prim: BIT STRING |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 157 | |
| 158 | |
| 159 | The final BIT STRING contains the actual signature. It can be extracted with: |
| 160 | |
| 161 | openssl asn1parse -in pca-cert.pem -out sig -noout -strparse 614 |
| 162 | |
| 163 | The certificate public key can be extracted with: |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 164 | |
Dr. Stephen Henson | a529a80 | 2007-09-17 17:54:31 +0000 | [diff] [blame] | 165 | openssl x509 -in test/testx509.pem -pubkey -noout >pubkey.pem |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 166 | |
| 167 | The signature can be analysed with: |
| 168 | |
| 169 | openssl rsautl -in sig -verify -asn1parse -inkey pubkey.pem -pubin |
| 170 | |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 171 | 0:d=0 hl=2 l= 32 cons: SEQUENCE |
| 172 | 2:d=1 hl=2 l= 12 cons: SEQUENCE |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 173 | 4:d=2 hl=2 l= 8 prim: OBJECT :md5 |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 174 | 14:d=2 hl=2 l= 0 prim: NULL |
| 175 | 16:d=1 hl=2 l= 16 prim: OCTET STRING |
Dr. Stephen Henson | bbb7200 | 2000-09-05 22:30:38 +0000 | [diff] [blame] | 176 | 0000 - f3 46 9e aa 1a 4a 73 c9-37 ea 93 00 48 25 08 b5 .F...Js.7...H%.. |
| 177 | |
| 178 | This is the parsed version of an ASN1 DigestInfo structure. It can be seen that |
| 179 | the digest used was md5. The actual part of the certificate that was signed can |
| 180 | be extracted with: |
| 181 | |
| 182 | openssl asn1parse -in pca-cert.pem -out tbs -noout -strparse 4 |
| 183 | |
| 184 | and its digest computed with: |
| 185 | |
| 186 | openssl md5 -c tbs |
| 187 | MD5(tbs)= f3:46:9e:aa:1a:4a:73:c9:37:ea:93:00:48:25:08:b5 |
| 188 | |
| 189 | which it can be seen agrees with the recovered value above. |
| 190 | |
| 191 | =head1 SEE ALSO |
| 192 | |
Rich Salz | 9b86974 | 2015-08-17 15:21:33 -0400 | [diff] [blame] | 193 | L<dgst(1)>, L<rsa(1)>, L<genrsa(1)> |
Rich Salz | 99ec4fd | 2016-05-18 10:16:40 -0400 | [diff] [blame] | 194 | |
Rich Salz | e2f9261 | 2016-05-18 11:44:05 -0400 | [diff] [blame] | 195 | =head1 COPYRIGHT |
| 196 | |
| 197 | Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. |
| 198 | |
| 199 | Licensed under the OpenSSL license (the "License"). You may not use |
| 200 | this file except in compliance with the License. You can obtain a copy |
| 201 | in the file LICENSE in the source distribution or at |
| 202 | L<https://www.openssl.org/source/license.html>. |
| 203 | |
| 204 | =cut |