1 /* rfc2268.c  - The cipher described in rfc2268; aka Ron's Cipher 2.
2  * Copyright (C) 2003 Nikos Mavroyanopoulos
3  * Copyright (C) 2004 Free Software Foundation, Inc.
4  *
5  * This file is part of Libgcrypt
6  *
7  * Libgcrypt is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser general Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * Libgcrypt is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21 
22 /* This implementation was written by Nikos Mavroyanopoulos for GNUTLS
23  * as a Libgcrypt module (gnutls/lib/x509/rc2.c) and later adapted for
24  * direct use by Libgcrypt by Werner Koch.  This implementation is
25  * only useful for pkcs#12 decryption.
26  *
27  * The implementation here is based on Peter Gutmann's RRC.2 paper.
28  */
29 
30 
31 #include <config.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include "g10lib.h"
36 #include "types.h"
37 #include "cipher.h"
38 #include "cipher-internal.h"
39 
40 #define RFC2268_BLOCKSIZE 8
41 
42 typedef struct
43 {
44   u16 S[64];
45 } RFC2268_context;
46 
47 static const unsigned char rfc2268_sbox[] = {
48   217, 120, 249, 196,  25, 221, 181, 237,
49    40, 233, 253, 121,  74, 160, 216, 157,
50   198, 126,  55, 131,  43, 118,  83, 142,
51    98,  76, 100, 136,  68, 139, 251, 162,
52    23, 154,  89, 245, 135, 179,  79,  19,
53    97,  69, 109, 141,   9, 129, 125,  50,
54   189, 143,  64, 235, 134, 183, 123,  11,
55   240, 149,  33,  34,  92, 107,  78, 130,
56    84, 214, 101, 147, 206,  96, 178,  28,
57   115,  86, 192,  20, 167, 140, 241, 220,
58    18, 117, 202,  31,  59, 190, 228, 209,
59    66,  61, 212,  48, 163,  60, 182,  38,
60   111, 191,  14, 218,  70, 105,   7,  87,
61    39, 242,  29, 155, 188, 148,  67,   3,
62   248,  17, 199, 246, 144, 239,  62, 231,
63     6, 195, 213,  47, 200, 102,  30, 215,
64     8, 232, 234, 222, 128,  82, 238, 247,
65   132, 170, 114, 172,  53,  77, 106,  42,
66   150,  26, 210, 113,  90,  21,  73, 116,
67    75, 159, 208,  94,   4,  24, 164, 236,
68   194, 224,  65, 110,  15,  81, 203, 204,
69    36, 145, 175,  80, 161, 244, 112,  57,
70   153, 124,  58, 133,  35, 184, 180, 122,
71   252,   2,  54,  91,  37,  85, 151,  49,
72    45,  93, 250, 152, 227, 138, 146, 174,
73     5, 223,  41,  16, 103, 108, 186, 201,
74   211,   0, 230, 207, 225, 158, 168,  44,
75    99,  22,   1,  63,  88, 226, 137, 169,
76    13,  56,  52,  27, 171,  51, 255, 176,
77   187,  72,  12,  95, 185, 177, 205,  46,
78   197, 243, 219,  71, 229, 165, 156, 119,
79    10, 166,  32, 104, 254, 127, 193, 173
80 };
81 
82 #define rotl16(x,n)   (((x) << ((u16)(n))) | ((x) >> (16 - (u16)(n))))
83 #define rotr16(x,n)   (((x) >> ((u16)(n))) | ((x) << (16 - (u16)(n))))
84 
85 static const char *selftest (void);
86 
87 
88 static void
do_encrypt(void * context,unsigned char * outbuf,const unsigned char * inbuf)89 do_encrypt (void *context, unsigned char *outbuf, const unsigned char *inbuf)
90 {
91   RFC2268_context *ctx = context;
92   register int i, j;
93   u16 word0 = 0, word1 = 0, word2 = 0, word3 = 0;
94 
95   word0 = (word0 << 8) | inbuf[1];
96   word0 = (word0 << 8) | inbuf[0];
97   word1 = (word1 << 8) | inbuf[3];
98   word1 = (word1 << 8) | inbuf[2];
99   word2 = (word2 << 8) | inbuf[5];
100   word2 = (word2 << 8) | inbuf[4];
101   word3 = (word3 << 8) | inbuf[7];
102   word3 = (word3 << 8) | inbuf[6];
103 
104   for (i = 0; i < 16; i++)
105     {
106       j = i * 4;
107       /* For some reason I cannot combine those steps. */
108       word0 += (word1 & ~word3) + (word2 & word3) + ctx->S[j];
109       word0 = rotl16(word0, 1);
110 
111       word1 += (word2 & ~word0) + (word3 & word0) + ctx->S[j + 1];
112       word1 = rotl16(word1, 2);
113 
114       word2 += (word3 & ~word1) + (word0 & word1) + ctx->S[j + 2];
115       word2 = rotl16(word2, 3);
116 
117       word3 += (word0 & ~word2) + (word1 & word2) + ctx->S[j + 3];
118       word3 = rotl16(word3, 5);
119 
120       if (i == 4 || i == 10)
121         {
122           word0 += ctx->S[word3 & 63];
123           word1 += ctx->S[word0 & 63];
124           word2 += ctx->S[word1 & 63];
125           word3 += ctx->S[word2 & 63];
126         }
127 
128     }
129 
130   outbuf[0] = word0 & 255;
131   outbuf[1] = word0 >> 8;
132   outbuf[2] = word1 & 255;
133   outbuf[3] = word1 >> 8;
134   outbuf[4] = word2 & 255;
135   outbuf[5] = word2 >> 8;
136   outbuf[6] = word3 & 255;
137   outbuf[7] = word3 >> 8;
138 }
139 
140 static unsigned int
encrypt_block(void * context,unsigned char * outbuf,const unsigned char * inbuf)141 encrypt_block (void *context, unsigned char *outbuf, const unsigned char *inbuf)
142 {
143   do_encrypt (context, outbuf, inbuf);
144   return /*burn_stack*/ (4 * sizeof(void *) + sizeof(void *) + sizeof(u32) * 4);
145 }
146 
147 static void
do_decrypt(void * context,unsigned char * outbuf,const unsigned char * inbuf)148 do_decrypt (void *context, unsigned char *outbuf, const unsigned char *inbuf)
149 {
150   RFC2268_context *ctx = context;
151   register int i, j;
152   u16 word0 = 0, word1 = 0, word2 = 0, word3 = 0;
153 
154   word0 = (word0 << 8) | inbuf[1];
155   word0 = (word0 << 8) | inbuf[0];
156   word1 = (word1 << 8) | inbuf[3];
157   word1 = (word1 << 8) | inbuf[2];
158   word2 = (word2 << 8) | inbuf[5];
159   word2 = (word2 << 8) | inbuf[4];
160   word3 = (word3 << 8) | inbuf[7];
161   word3 = (word3 << 8) | inbuf[6];
162 
163   for (i = 15; i >= 0; i--)
164     {
165       j = i * 4;
166 
167       word3 = rotr16(word3, 5);
168       word3 -= (word0 & ~word2) + (word1 & word2) + ctx->S[j + 3];
169 
170       word2 = rotr16(word2, 3);
171       word2 -= (word3 & ~word1) + (word0 & word1) + ctx->S[j + 2];
172 
173       word1 = rotr16(word1, 2);
174       word1 -= (word2 & ~word0) + (word3 & word0) + ctx->S[j + 1];
175 
176       word0 = rotr16(word0, 1);
177       word0 -= (word1 & ~word3) + (word2 & word3) + ctx->S[j];
178 
179       if (i == 5 || i == 11)
180         {
181           word3 = word3 - ctx->S[word2 & 63];
182           word2 = word2 - ctx->S[word1 & 63];
183           word1 = word1 - ctx->S[word0 & 63];
184           word0 = word0 - ctx->S[word3 & 63];
185         }
186 
187     }
188 
189   outbuf[0] = word0 & 255;
190   outbuf[1] = word0 >> 8;
191   outbuf[2] = word1 & 255;
192   outbuf[3] = word1 >> 8;
193   outbuf[4] = word2 & 255;
194   outbuf[5] = word2 >> 8;
195   outbuf[6] = word3 & 255;
196   outbuf[7] = word3 >> 8;
197 }
198 
199 static unsigned int
decrypt_block(void * context,unsigned char * outbuf,const unsigned char * inbuf)200 decrypt_block (void *context, unsigned char *outbuf, const unsigned char *inbuf)
201 {
202   do_decrypt (context, outbuf, inbuf);
203   return /*burn_stack*/ (4 * sizeof(void *) + sizeof(void *) + sizeof(u32) * 4);
204 }
205 
206 
207 static gpg_err_code_t
setkey_core(void * context,const unsigned char * key,unsigned int keylen,int with_phase2)208 setkey_core (void *context, const unsigned char *key, unsigned int keylen, int with_phase2)
209 {
210   static int initialized;
211   static const char *selftest_failed;
212   RFC2268_context *ctx = context;
213   unsigned int i;
214   unsigned char *S, x;
215   int len;
216   int bits = keylen * 8;
217 
218   if (!initialized)
219     {
220       initialized = 1;
221       selftest_failed = selftest ();
222       if (selftest_failed)
223         log_error ("RFC2268 selftest failed (%s).\n", selftest_failed);
224     }
225   if (selftest_failed)
226     return GPG_ERR_SELFTEST_FAILED;
227 
228   if (keylen < 40 / 8)	/* We want at least 40 bits. */
229     return GPG_ERR_INV_KEYLEN;
230 
231   S = (unsigned char *) ctx->S;
232 
233   for (i = 0; i < keylen; i++)
234     S[i] = key[i];
235 
236   for (i = keylen; i < 128; i++)
237     S[i] = rfc2268_sbox[(S[i - keylen] + S[i - 1]) & 255];
238 
239   S[0] = rfc2268_sbox[S[0]];
240 
241   /* Phase 2 - reduce effective key size to "bits". This was not
242    * discussed in Gutmann's paper. I've copied that from the public
243    * domain code posted in sci.crypt. */
244   if (with_phase2)
245     {
246       len = (bits + 7) >> 3;
247       i = 128 - len;
248       x = rfc2268_sbox[S[i] & (255 >> (7 & -bits))];
249       S[i] = x;
250 
251       while (i--)
252         {
253           x = rfc2268_sbox[x ^ S[i + len]];
254           S[i] = x;
255         }
256     }
257 
258   /* Make the expanded key, endian independent. */
259   for (i = 0; i < 64; i++)
260     ctx->S[i] = ( (u16) S[i * 2] | (((u16) S[i * 2 + 1]) << 8));
261 
262   return 0;
263 }
264 
265 static gpg_err_code_t
do_setkey(void * context,const unsigned char * key,unsigned int keylen,cipher_bulk_ops_t * bulk_ops)266 do_setkey (void *context, const unsigned char *key, unsigned int keylen,
267            cipher_bulk_ops_t *bulk_ops)
268 {
269   (void)bulk_ops;
270   return setkey_core (context, key, keylen, 1);
271 }
272 
273 static const char *
selftest(void)274 selftest (void)
275 {
276   RFC2268_context ctx;
277   unsigned char scratch[16];
278 
279   /* Test vectors from Peter Gutmann's paper. */
280   static unsigned char key_1[] =
281     { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
282       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
283     };
284   static unsigned char plaintext_1[] =
285     { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
286   static const unsigned char ciphertext_1[] =
287     { 0x1C, 0x19, 0x8A, 0x83, 0x8D, 0xF0, 0x28, 0xB7 };
288 
289   static unsigned char key_2[] =
290     { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
291       0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F
292     };
293   static unsigned char plaintext_2[] =
294     { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
295   static unsigned char ciphertext_2[] =
296     { 0x50, 0xDC, 0x01, 0x62, 0xBD, 0x75, 0x7F, 0x31 };
297 
298   /* This one was checked against libmcrypt's RFC2268. */
299   static unsigned char key_3[] =
300     { 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
301       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
302     };
303   static unsigned char plaintext_3[] =
304     { 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
305   static unsigned char ciphertext_3[] =
306     { 0x8f, 0xd1, 0x03, 0x89, 0x33, 0x6b, 0xf9, 0x5e };
307 
308 
309   /* First test. */
310   setkey_core (&ctx, key_1, sizeof(key_1), 0);
311   do_encrypt (&ctx, scratch, plaintext_1);
312 
313   if (memcmp (scratch, ciphertext_1, sizeof(ciphertext_1)))
314     return "RFC2268 encryption test 1 failed.";
315 
316   setkey_core (&ctx, key_1, sizeof(key_1), 0);
317   do_decrypt (&ctx, scratch, scratch);
318   if (memcmp (scratch, plaintext_1, sizeof(plaintext_1)))
319     return "RFC2268 decryption test 1 failed.";
320 
321   /* Second test. */
322   setkey_core (&ctx, key_2, sizeof(key_2), 0);
323   do_encrypt (&ctx, scratch, plaintext_2);
324   if (memcmp (scratch, ciphertext_2, sizeof(ciphertext_2)))
325     return "RFC2268 encryption test 2 failed.";
326 
327   setkey_core (&ctx, key_2, sizeof(key_2), 0);
328   do_decrypt (&ctx, scratch, scratch);
329   if (memcmp (scratch, plaintext_2, sizeof(plaintext_2)))
330     return "RFC2268 decryption test 2 failed.";
331 
332   /* Third test. */
333   setkey_core(&ctx, key_3, sizeof(key_3), 0);
334   do_encrypt(&ctx, scratch, plaintext_3);
335 
336   if (memcmp(scratch, ciphertext_3, sizeof(ciphertext_3)))
337     return "RFC2268 encryption test 3 failed.";
338 
339   setkey_core (&ctx, key_3, sizeof(key_3), 0);
340   do_decrypt (&ctx, scratch, scratch);
341   if (memcmp(scratch, plaintext_3, sizeof(plaintext_3)))
342     return "RFC2268 decryption test 3 failed.";
343 
344   return NULL;
345 }
346 
347 
348 
349 static gcry_cipher_oid_spec_t oids_rfc2268_40[] =
350   {
351     /*{ "1.2.840.113549.3.2", GCRY_CIPHER_MODE_CBC },*/
352     /* pbeWithSHAAnd40BitRC2_CBC */
353     { "1.2.840.113549.1.12.1.6", GCRY_CIPHER_MODE_CBC },
354     { NULL }
355   };
356 
357 static gcry_cipher_oid_spec_t oids_rfc2268_128[] =
358   {
359     /* pbeWithSHAAnd128BitRC2_CBC */
360     { "1.2.840.113549.1.12.1.5", GCRY_CIPHER_MODE_CBC },
361     { NULL }
362   };
363 
364 gcry_cipher_spec_t _gcry_cipher_spec_rfc2268_40 =
365   {
366     GCRY_CIPHER_RFC2268_40, {0, 0},
367     "RFC2268_40", NULL, oids_rfc2268_40,
368     RFC2268_BLOCKSIZE, 40, sizeof(RFC2268_context),
369     do_setkey, encrypt_block, decrypt_block
370   };
371 
372 gcry_cipher_spec_t _gcry_cipher_spec_rfc2268_128 =
373   {
374     GCRY_CIPHER_RFC2268_128, {0, 0},
375     "RFC2268_128", NULL, oids_rfc2268_128,
376     RFC2268_BLOCKSIZE, 128, sizeof(RFC2268_context),
377     do_setkey, encrypt_block, decrypt_block
378   };
379