* w32reg.c (read_w32_registry_string): Fallback to HLM.
[gnupg.git] / cipher / cipher.c
1 /* cipher.c  -  cipher dispatcher
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <assert.h>
27 #include "util.h"
28 #include "errors.h"
29 #include "cipher.h"
30 #include "algorithms.h"
31
32 /* We have support for a DUMMY encryption cipher which comes handy to
33    debug MDCs and similar things.  Because this is a bit dangerous it
34    is not enabled. */
35 /*#define ALLOW_DUMMY 1 */
36
37 #define MAX_BLOCKSIZE 16
38 #define TABLE_SIZE 14
39
40 struct cipher_table_s {
41     const char *name;
42     int algo;
43     size_t blocksize;
44     size_t keylen;
45     size_t contextsize; /* allocate this amount of context */
46     int  (*setkey)( void *c, byte *key, unsigned keylen );
47     void (*encrypt)( void *c, byte *outbuf, byte *inbuf );
48     void (*decrypt)( void *c, byte *outbuf, byte *inbuf );
49 };
50
51 static struct cipher_table_s cipher_table[TABLE_SIZE];
52 static int disabled_algos[TABLE_SIZE];
53
54
55 struct cipher_handle_s {
56     int  algo;
57     int  mode;
58     size_t blocksize;
59     byte iv[MAX_BLOCKSIZE];     /* (this should be ulong aligned) */
60     byte lastiv[MAX_BLOCKSIZE];
61     int  unused;  /* in IV */
62     int  (*setkey)( void *c, byte *key, unsigned keylen );
63     void (*encrypt)( void *c, byte *outbuf, byte *inbuf );
64     void (*decrypt)( void *c, byte *outbuf, byte *inbuf );
65     PROPERLY_ALIGNED_TYPE context;
66 };
67
68
69 #ifdef ALLOW_DUMMY
70 static int
71 dummy_setkey( void *c, byte *key, unsigned keylen ) { return 0; }
72 static void
73 dummy_encrypt_block( void *c, byte *outbuf, byte *inbuf ) { BUG(); }
74 static void
75 dummy_decrypt_block( void *c, byte *outbuf, byte *inbuf ) { BUG(); }
76 #ifdef __GNUC__
77 # warning DUMMY cipher module is enabled
78 #endif
79 #endif
80
81
82 /****************
83  * Put the static entries into the table.
84  */
85 static void
86 setup_cipher_table(void)
87 {
88
89     int i;
90
91     i = 0;
92     cipher_table[i].algo = CIPHER_ALGO_RIJNDAEL;
93     cipher_table[i].name = rijndael_get_info( cipher_table[i].algo,
94                                          &cipher_table[i].keylen,
95                                          &cipher_table[i].blocksize,
96                                          &cipher_table[i].contextsize,
97                                          &cipher_table[i].setkey,
98                                          &cipher_table[i].encrypt,
99                                          &cipher_table[i].decrypt     );
100     if( !cipher_table[i].name )
101         BUG();
102     i++;
103     cipher_table[i].algo = CIPHER_ALGO_RIJNDAEL192;
104     cipher_table[i].name = rijndael_get_info( cipher_table[i].algo,
105                                          &cipher_table[i].keylen,
106                                          &cipher_table[i].blocksize,
107                                          &cipher_table[i].contextsize,
108                                          &cipher_table[i].setkey,
109                                          &cipher_table[i].encrypt,
110                                          &cipher_table[i].decrypt     );
111     if( !cipher_table[i].name )
112         BUG();
113     i++;
114     cipher_table[i].algo = CIPHER_ALGO_RIJNDAEL256;
115     cipher_table[i].name = rijndael_get_info( cipher_table[i].algo,
116                                          &cipher_table[i].keylen,
117                                          &cipher_table[i].blocksize,
118                                          &cipher_table[i].contextsize,
119                                          &cipher_table[i].setkey,
120                                          &cipher_table[i].encrypt,
121                                          &cipher_table[i].decrypt     );
122     if( !cipher_table[i].name )
123         BUG();
124     i++;
125     cipher_table[i].algo = CIPHER_ALGO_TWOFISH;
126     cipher_table[i].name = twofish_get_info( cipher_table[i].algo,
127                                          &cipher_table[i].keylen,
128                                          &cipher_table[i].blocksize,
129                                          &cipher_table[i].contextsize,
130                                          &cipher_table[i].setkey,
131                                          &cipher_table[i].encrypt,
132                                          &cipher_table[i].decrypt     );
133     if( !cipher_table[i].name )
134         BUG();
135     i++;
136     cipher_table[i].algo = CIPHER_ALGO_BLOWFISH;
137     cipher_table[i].name = blowfish_get_info( cipher_table[i].algo,
138                                          &cipher_table[i].keylen,
139                                          &cipher_table[i].blocksize,
140                                          &cipher_table[i].contextsize,
141                                          &cipher_table[i].setkey,
142                                          &cipher_table[i].encrypt,
143                                          &cipher_table[i].decrypt     );
144     if( !cipher_table[i].name )
145         BUG();
146     i++;
147     cipher_table[i].algo = CIPHER_ALGO_CAST5;
148     cipher_table[i].name = cast5_get_info( cipher_table[i].algo,
149                                          &cipher_table[i].keylen,
150                                          &cipher_table[i].blocksize,
151                                          &cipher_table[i].contextsize,
152                                          &cipher_table[i].setkey,
153                                          &cipher_table[i].encrypt,
154                                          &cipher_table[i].decrypt     );
155     if( !cipher_table[i].name )
156         BUG();
157     i++;
158     cipher_table[i].algo = CIPHER_ALGO_3DES;
159     cipher_table[i].name = des_get_info( cipher_table[i].algo,
160                                          &cipher_table[i].keylen,
161                                          &cipher_table[i].blocksize,
162                                          &cipher_table[i].contextsize,
163                                          &cipher_table[i].setkey,
164                                          &cipher_table[i].encrypt,
165                                          &cipher_table[i].decrypt     );
166     if( !cipher_table[i].name )
167         BUG();
168     i++;
169     cipher_table[i].algo = CIPHER_ALGO_IDEA;
170     cipher_table[i].name = idea_get_info( cipher_table[i].algo,
171                                          &cipher_table[i].keylen,
172                                          &cipher_table[i].blocksize,
173                                          &cipher_table[i].contextsize,
174                                          &cipher_table[i].setkey,
175                                          &cipher_table[i].encrypt,
176                                          &cipher_table[i].decrypt     );
177     if (cipher_table[i].name)
178       i++;  /* Note that IDEA is usually not available. */
179
180 #ifdef ALLOW_DUMMY
181     cipher_table[i].algo = CIPHER_ALGO_DUMMY;
182     cipher_table[i].name = "DUMMY";
183     cipher_table[i].blocksize = 8;
184     cipher_table[i].keylen = 128;
185     cipher_table[i].contextsize = 0;
186     cipher_table[i].setkey = dummy_setkey;
187     cipher_table[i].encrypt = dummy_encrypt_block;
188     cipher_table[i].decrypt = dummy_decrypt_block;
189     i++;
190 #endif
191
192     for( ; i < TABLE_SIZE; i++ )
193         cipher_table[i].name = NULL;
194 }
195
196
197 /****************
198  * Try to load all modules and return true if new modules are available
199  */
200 static int
201 load_cipher_modules(void)
202 {
203   static int initialized = 0;
204
205   if (!initialized ) 
206     {
207       setup_cipher_table(); /* load static modules on the first call */
208       initialized = 1;
209       return 1;
210     }
211   return 0;
212 }
213
214
215
216
217
218
219
220 /****************
221  * Map a string to the cipher algo
222  */
223 int
224 string_to_cipher_algo( const char *string )
225 {
226   int i;
227   const char *s;
228
229   /* kludge to alias RIJNDAEL to AES */
230   if ( *string == 'R' || *string == 'r')
231     {
232       if (!ascii_strcasecmp (string, "RIJNDAEL"))
233         string = "AES";
234       else if (!ascii_strcasecmp (string, "RIJNDAEL192"))
235         string = "AES192";
236       else if (!ascii_strcasecmp (string, "RIJNDAEL256"))
237         string = "AES256";
238     }
239
240   do
241     {
242       for(i=0; (s=cipher_table[i].name); i++ ) 
243         {
244           if( !ascii_strcasecmp( s, string ) )
245             return cipher_table[i].algo;
246         }
247     } while( load_cipher_modules() );
248   return 0;
249 }
250
251 /****************
252  * Map a cipher algo to a string
253  */
254 const char *
255 cipher_algo_to_string( int algo )
256 {
257     int i;
258
259     do {
260         for(i=0; cipher_table[i].name; i++ )
261             if( cipher_table[i].algo == algo )
262                 return cipher_table[i].name;
263     } while( load_cipher_modules() );
264     return NULL;
265 }
266
267
268 void
269 disable_cipher_algo( int algo )
270 {
271     int i;
272
273     for(i=0; i < DIM(disabled_algos); i++ ) {
274         if( !disabled_algos[i] || disabled_algos[i] == algo ) {
275             disabled_algos[i] = algo;
276             return;
277         }
278     }
279     /* fixme: we should use a linked list */
280     log_fatal("can't disable cipher algo %d: table full\n", algo );
281 }
282
283 /****************
284  * Return 0 if the cipher algo is available
285  */
286 int
287 check_cipher_algo( int algo )
288 {
289     int i;
290
291     do {
292        for(i=0; cipher_table[i].name; i++ )
293            if( cipher_table[i].algo == algo ) {
294                 for(i=0; i < DIM(disabled_algos); i++ ) {
295                    if( disabled_algos[i] == algo )
296                        return G10ERR_CIPHER_ALGO;
297                 }
298                 return 0; /* okay */
299            }
300     } while( load_cipher_modules() );
301     return G10ERR_CIPHER_ALGO;
302 }
303
304
305 unsigned
306 cipher_get_keylen( int algo )
307 {
308     int i;
309     unsigned len = 0;
310
311     do {
312         for(i=0; cipher_table[i].name; i++ ) {
313             if( cipher_table[i].algo == algo ) {
314                 len = cipher_table[i].keylen;
315                 if( !len )
316                     log_bug("cipher %d w/o key length\n", algo );
317                 return len;
318             }
319         }
320     } while( load_cipher_modules() );
321     log_bug("cipher %d not found\n", algo );
322     return 0;
323 }
324
325 unsigned
326 cipher_get_blocksize( int algo )
327 {
328     int i;
329     unsigned len = 0;
330
331     do {
332         for(i=0; cipher_table[i].name; i++ ) {
333             if( cipher_table[i].algo == algo ) {
334                 len = cipher_table[i].blocksize;
335                 if( !len )
336                     log_bug("cipher %d w/o blocksize\n", algo );
337                 return len;
338             }
339         }
340     } while( load_cipher_modules() );
341     log_bug("cipher %d not found\n", algo );
342     return 0;
343 }
344
345
346 /****************
347  * Open a cipher handle for use with algorithm ALGO, in mode MODE
348  * and put it into secure memory if SECURE is true.
349  */
350 CIPHER_HANDLE
351 cipher_open( int algo, int mode, int secure )
352 {
353     CIPHER_HANDLE hd;
354     int i;
355
356     fast_random_poll();
357     do {
358         for(i=0; cipher_table[i].name; i++ )
359             if( cipher_table[i].algo == algo )
360                 break;
361     } while( !cipher_table[i].name && load_cipher_modules() );
362     if( !cipher_table[i].name ) {
363         log_fatal("cipher_open: algorithm %d not available\n", algo );
364         return NULL;
365     }
366
367     /* ? perform selftest here and mark this with a flag in cipher_table ? */
368
369     hd = secure ? m_alloc_secure_clear( sizeof *hd
370                                         + cipher_table[i].contextsize
371                                         - sizeof(PROPERLY_ALIGNED_TYPE) )
372                 : m_alloc_clear( sizeof *hd + cipher_table[i].contextsize
373                                            - sizeof(PROPERLY_ALIGNED_TYPE)  );
374     hd->algo = algo;
375     hd->blocksize = cipher_table[i].blocksize;
376     hd->setkey  = cipher_table[i].setkey;
377     hd->encrypt = cipher_table[i].encrypt;
378     hd->decrypt = cipher_table[i].decrypt;
379
380     if( mode == CIPHER_MODE_AUTO_CFB ) {
381         if( algo >= 100 )
382             hd->mode = CIPHER_MODE_CFB;
383         else
384             hd->mode = CIPHER_MODE_PHILS_CFB;
385     }
386     else
387         hd->mode = mode;
388
389 #ifdef ALLOW_DUMMY
390     if( algo == CIPHER_ALGO_DUMMY )
391         hd->mode = CIPHER_MODE_DUMMY;
392 #endif
393
394     return hd;
395 }
396
397
398 void
399 cipher_close( CIPHER_HANDLE c )
400 {
401     m_free(c);
402 }
403
404
405 int
406 cipher_setkey( CIPHER_HANDLE c, byte *key, unsigned keylen )
407 {
408     return (*c->setkey)( &c->context.c, key, keylen );
409 }
410
411
412
413 void
414 cipher_setiv( CIPHER_HANDLE c, const byte *iv, unsigned ivlen )
415 {
416     memset( c->iv, 0, c->blocksize );
417     if( iv ) {
418         if( ivlen != c->blocksize )
419             log_info("WARNING: cipher_setiv: ivlen=%u blklen=%u\n",
420                                              ivlen, (unsigned)c->blocksize );
421         if( ivlen > c->blocksize )
422             ivlen = c->blocksize;
423         memcpy( c->iv, iv, ivlen );
424     }
425     c->unused = 0;
426 }
427
428
429
430 static void
431 do_ecb_encrypt( CIPHER_HANDLE c, byte *outbuf, byte *inbuf, unsigned nblocks )
432 {
433     unsigned n;
434
435     for(n=0; n < nblocks; n++ ) {
436         (*c->encrypt)( &c->context.c, outbuf, inbuf );
437         inbuf  += c->blocksize;
438         outbuf += c->blocksize;
439     }
440 }
441
442 static void
443 do_ecb_decrypt( CIPHER_HANDLE c, byte *outbuf, byte *inbuf, unsigned nblocks )
444 {
445     unsigned n;
446
447     for(n=0; n < nblocks; n++ ) {
448         (*c->decrypt)( &c->context.c, outbuf, inbuf );
449         inbuf  += c->blocksize;
450         outbuf += c->blocksize;
451     }
452 }
453
454 static void
455 do_cbc_encrypt( CIPHER_HANDLE c, byte *outbuf, byte *inbuf, unsigned nblocks )
456 {
457     unsigned int n;
458     byte *ivp;
459     int i;
460     size_t blocksize = c->blocksize;
461
462     for(n=0; n < nblocks; n++ ) {
463         /* fixme: the xor should works on words and not on
464          * bytes.  Maybe it is a good idea to enhance the cipher backend
465          * API to allow for CBC handling in the backend */
466         for(ivp=c->iv,i=0; i < blocksize; i++ )
467             outbuf[i] = inbuf[i] ^ *ivp++;
468         (*c->encrypt)( &c->context.c, outbuf, outbuf );
469         memcpy(c->iv, outbuf, blocksize );
470         inbuf  += c->blocksize;
471         outbuf += c->blocksize;
472     }
473 }
474
475 static void
476 do_cbc_decrypt( CIPHER_HANDLE c, byte *outbuf, byte *inbuf, unsigned nblocks )
477 {
478     unsigned int n;
479     byte *ivp;
480     int i;
481     size_t blocksize = c->blocksize;
482
483     for(n=0; n < nblocks; n++ ) {
484         /* because outbuf and inbuf might be the same, we have
485          * to save the original ciphertext block.  We use lastiv
486          * for this here because it is not used otherwise */
487         memcpy(c->lastiv, inbuf, blocksize );
488         (*c->decrypt)( &c->context.c, outbuf, inbuf );
489         for(ivp=c->iv,i=0; i < blocksize; i++ )
490             outbuf[i] ^= *ivp++;
491         memcpy(c->iv, c->lastiv, blocksize );
492         inbuf  += c->blocksize;
493         outbuf += c->blocksize;
494     }
495 }
496
497
498 static void
499 do_cfb_encrypt( CIPHER_HANDLE c, byte *outbuf, byte *inbuf, unsigned nbytes )
500 {
501     byte *ivp;
502     size_t blocksize = c->blocksize;
503
504     if( nbytes <= c->unused ) {
505         /* short enough to be encoded by the remaining XOR mask */
506         /* XOR the input with the IV and store input into IV */
507         for(ivp=c->iv+c->blocksize - c->unused; nbytes; nbytes--, c->unused-- )
508             *outbuf++ = (*ivp++ ^= *inbuf++);
509         return;
510     }
511
512     if( c->unused ) {
513         /* XOR the input with the IV and store input into IV */
514         nbytes -= c->unused;
515         for(ivp=c->iv+blocksize - c->unused; c->unused; c->unused-- )
516             *outbuf++ = (*ivp++ ^= *inbuf++);
517     }
518
519     /* now we can process complete blocks */
520     while( nbytes >= blocksize ) {
521         int i;
522         /* encrypt the IV (and save the current one) */
523         memcpy( c->lastiv, c->iv, blocksize );
524         (*c->encrypt)( &c->context.c, c->iv, c->iv );
525         /* XOR the input with the IV and store input into IV */
526         for(ivp=c->iv,i=0; i < blocksize; i++ )
527             *outbuf++ = (*ivp++ ^= *inbuf++);
528         nbytes -= blocksize;
529     }
530     if( nbytes ) { /* process the remaining bytes */
531         /* encrypt the IV (and save the current one) */
532         memcpy( c->lastiv, c->iv, blocksize );
533         (*c->encrypt)( &c->context.c, c->iv, c->iv );
534         c->unused = blocksize;
535         /* and apply the xor */
536         c->unused -= nbytes;
537         for(ivp=c->iv; nbytes; nbytes-- )
538             *outbuf++ = (*ivp++ ^= *inbuf++);
539     }
540 }
541
542 static void
543 do_cfb_decrypt( CIPHER_HANDLE c, byte *outbuf, byte *inbuf, unsigned nbytes )
544 {
545     byte *ivp;
546     ulong temp;
547     size_t blocksize = c->blocksize;
548
549     if( nbytes <= c->unused ) {
550         /* short enough to be encoded by the remaining XOR mask */
551         /* XOR the input with the IV and store input into IV */
552         for(ivp=c->iv+blocksize - c->unused; nbytes; nbytes--,c->unused--){
553             temp = *inbuf++;
554             *outbuf++ = *ivp ^ temp;
555             *ivp++ = temp;
556         }
557         return;
558     }
559
560     if( c->unused ) {
561         /* XOR the input with the IV and store input into IV */
562         nbytes -= c->unused;
563         for(ivp=c->iv+blocksize - c->unused; c->unused; c->unused-- ) {
564             temp = *inbuf++;
565             *outbuf++ = *ivp ^ temp;
566             *ivp++ = temp;
567         }
568     }
569
570     /* now we can process complete blocks */
571     while( nbytes >= blocksize ) {
572         int i;
573         /* encrypt the IV (and save the current one) */
574         memcpy( c->lastiv, c->iv, blocksize );
575         (*c->encrypt)( &c->context.c, c->iv, c->iv );
576         /* XOR the input with the IV and store input into IV */
577         for(ivp=c->iv,i=0; i < blocksize; i++ ) {
578             temp = *inbuf++;
579             *outbuf++ = *ivp ^ temp;
580             *ivp++ = temp;
581         }
582         nbytes -= blocksize;
583     }
584     if( nbytes ) { /* process the remaining bytes */
585         /* encrypt the IV (and save the current one) */
586         memcpy( c->lastiv, c->iv, blocksize );
587         (*c->encrypt)( &c->context.c, c->iv, c->iv );
588         c->unused = blocksize;
589         /* and apply the xor */
590         c->unused -= nbytes;
591         for(ivp=c->iv; nbytes; nbytes-- ) {
592             temp = *inbuf++;
593             *outbuf++ = *ivp ^ temp;
594             *ivp++ = temp;
595         }
596     }
597 }
598
599
600 /****************
601  * Encrypt INBUF to OUTBUF with the mode selected at open.
602  * inbuf and outbuf may overlap or be the same.
603  * Depending on the mode some some contraints apply to NBYTES.
604  */
605 void
606 cipher_encrypt( CIPHER_HANDLE c, byte *outbuf, byte *inbuf, unsigned nbytes )
607 {
608     switch( c->mode ) {
609       case CIPHER_MODE_ECB:
610         assert(!(nbytes%c->blocksize));
611         do_ecb_encrypt(c, outbuf, inbuf, nbytes/c->blocksize );
612         break;
613       case CIPHER_MODE_CBC:
614         assert(!(nbytes%c->blocksize));  
615         do_cbc_encrypt(c, outbuf, inbuf, nbytes/c->blocksize );
616         break;
617       case CIPHER_MODE_CFB:
618       case CIPHER_MODE_PHILS_CFB:
619         do_cfb_encrypt(c, outbuf, inbuf, nbytes );
620         break;
621 #ifdef ALLOW_DUMMY
622       case CIPHER_MODE_DUMMY:
623         if( inbuf != outbuf )
624             memmove( outbuf, inbuf, nbytes );
625         break;
626 #endif
627       default: log_fatal("cipher_encrypt: invalid mode %d\n", c->mode );
628     }
629 }
630
631
632 /****************
633  * Decrypt INBUF to OUTBUF with the mode selected at open.
634  * inbuf and outbuf may overlap or be the same.
635  * Depending on the mode some some contraints apply to NBYTES.
636  */
637 void
638 cipher_decrypt( CIPHER_HANDLE c, byte *outbuf, byte *inbuf, unsigned nbytes )
639 {
640     switch( c->mode ) {
641       case CIPHER_MODE_ECB:
642         assert(!(nbytes%c->blocksize));
643         do_ecb_decrypt(c, outbuf, inbuf, nbytes/c->blocksize );
644         break;
645       case CIPHER_MODE_CBC:
646         assert(!(nbytes%c->blocksize));
647         do_cbc_decrypt(c, outbuf, inbuf, nbytes/c->blocksize );
648         break;
649       case CIPHER_MODE_CFB:
650       case CIPHER_MODE_PHILS_CFB:
651         do_cfb_decrypt(c, outbuf, inbuf, nbytes );
652         break;
653 #ifdef ALLOW_DUMMY
654       case CIPHER_MODE_DUMMY:
655         if( inbuf != outbuf )
656             memmove( outbuf, inbuf, nbytes );
657         break;
658 #endif
659       default: log_fatal("cipher_decrypt: invalid mode %d\n", c->mode );
660     }
661 }
662
663
664
665 /****************
666  * Used for PGP's somewhat strange CFB mode. Only works if
667  * the handle is in PHILS_CFB mode
668  */
669 void
670 cipher_sync( CIPHER_HANDLE c )
671 {
672     if( c->mode == CIPHER_MODE_PHILS_CFB && c->unused ) {
673         memmove(c->iv + c->unused, c->iv, c->blocksize - c->unused );
674         memcpy(c->iv, c->lastiv + c->blocksize - c->unused, c->unused);
675         c->unused = 0;
676     }
677 }
678