cipher: use size_t for internal buffer lengths
[libgcrypt.git] / cipher / arcfour.c
1 /* arcfour.c  -  The arcfour stream cipher
2  *      Copyright (C) 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser general Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt 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 Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License 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  * For a description of the algorithm, see:
21  *   Bruce Schneier: Applied Cryptography. John Wiley & Sons, 1996.
22  *   ISBN 0-471-11709-9. Pages 397 ff.
23  */
24
25
26 #include <config.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include "types.h"
31 #include "g10lib.h"
32 #include "cipher.h"
33
34 static const char *selftest(void);
35
36 typedef struct {
37     byte sbox[256];
38     int idx_i, idx_j;
39 } ARCFOUR_context;
40
41 static void
42 do_encrypt_stream( ARCFOUR_context *ctx,
43                    byte *outbuf, const byte *inbuf, size_t length )
44 {
45 #ifndef __i386__
46   register unsigned int i = ctx->idx_i;
47   register byte j = ctx->idx_j;
48   register byte *sbox = ctx->sbox;
49   register byte t, u;
50
51   while ( length-- )
52     {
53       i++;
54       t = sbox[(byte)i];
55       j += t;
56       u = sbox[j];
57       sbox[(byte)i] = u;
58       u += t;
59       sbox[j] = t;
60       *outbuf++ = sbox[u] ^ *inbuf++;
61     }
62
63   ctx->idx_i = (byte)i;
64   ctx->idx_j = (byte)j;
65 #else /*__i386__*/
66   /* Old implementation of arcfour is faster on i386 than the version above.
67    * This is because version above increases register pressure which on i386
68    * would push some of the variables to memory/stack.  Therefore keep this
69    * version for i386 to avoid regressing performance.  */
70   register int i = ctx->idx_i;
71   register int j = ctx->idx_j;
72   register byte *sbox = ctx->sbox;
73   register int t;
74
75   while ( length-- )
76     {
77       i++;
78       i = i & 255; /* The and-op seems to be faster than the mod-op. */
79       j += sbox[i];
80       j &= 255;
81       t = sbox[i]; sbox[i] = sbox[j]; sbox[j] = t;
82       *outbuf++ = *inbuf++ ^ sbox[(sbox[i] + sbox[j]) & 255];
83     }
84
85   ctx->idx_i = i;
86   ctx->idx_j = j;
87 #endif
88 }
89
90 static void
91 encrypt_stream (void *context,
92                 byte *outbuf, const byte *inbuf, size_t length)
93 {
94   ARCFOUR_context *ctx = (ARCFOUR_context *) context;
95   do_encrypt_stream (ctx, outbuf, inbuf, length );
96   _gcry_burn_stack (64);
97 }
98
99
100 static gcry_err_code_t
101 do_arcfour_setkey (void *context, const byte *key, unsigned int keylen)
102 {
103   static int initialized;
104   static const char* selftest_failed;
105   int i, j;
106   byte karr[256];
107   ARCFOUR_context *ctx = (ARCFOUR_context *) context;
108
109   if (!initialized )
110     {
111       initialized = 1;
112       selftest_failed = selftest();
113       if( selftest_failed )
114         log_error ("ARCFOUR selftest failed (%s)\n", selftest_failed );
115     }
116   if( selftest_failed )
117     return GPG_ERR_SELFTEST_FAILED;
118
119   if( keylen < 40/8 ) /* we want at least 40 bits */
120     return GPG_ERR_INV_KEYLEN;
121
122   ctx->idx_i = ctx->idx_j = 0;
123   for (i=0; i < 256; i++ )
124     ctx->sbox[i] = i;
125   for (i=j=0; i < 256; i++,j++ )
126     {
127       if (j >= keylen)
128         j = 0;
129       karr[i] = key[j];
130     }
131   for (i=j=0; i < 256; i++ )
132     {
133       int t;
134       j = (j + ctx->sbox[i] + karr[i]) & 255;
135       t = ctx->sbox[i];
136       ctx->sbox[i] = ctx->sbox[j];
137       ctx->sbox[j] = t;
138     }
139   wipememory( karr, sizeof(karr) );
140
141   return GPG_ERR_NO_ERROR;
142 }
143
144 static gcry_err_code_t
145 arcfour_setkey ( void *context, const byte *key, unsigned int keylen )
146 {
147   ARCFOUR_context *ctx = (ARCFOUR_context *) context;
148   gcry_err_code_t rc = do_arcfour_setkey (ctx, key, keylen );
149   return rc;
150 }
151
152
153 static const char*
154 selftest(void)
155 {
156   ARCFOUR_context ctx;
157   byte scratch[16];
158
159   /* Test vector from Cryptlib labeled there: "from the
160      State/Commerce Department". */
161   static const byte key_1[] =
162     { 0x61, 0x8A, 0x63, 0xD2, 0xFB };
163   static const byte plaintext_1[] =
164     { 0xDC, 0xEE, 0x4C, 0xF9, 0x2C };
165   static const byte ciphertext_1[] =
166     { 0xF1, 0x38, 0x29, 0xC9, 0xDE };
167
168   arcfour_setkey( &ctx, key_1, sizeof(key_1));
169   encrypt_stream( &ctx, scratch, plaintext_1, sizeof(plaintext_1));
170   if ( memcmp (scratch, ciphertext_1, sizeof (ciphertext_1)))
171     return "Arcfour encryption test 1 failed.";
172   arcfour_setkey( &ctx, key_1, sizeof(key_1));
173   encrypt_stream(&ctx, scratch, scratch, sizeof(plaintext_1)); /* decrypt */
174   if ( memcmp (scratch, plaintext_1, sizeof (plaintext_1)))
175     return "Arcfour decryption test 1 failed.";
176   return NULL;
177 }
178
179
180 gcry_cipher_spec_t _gcry_cipher_spec_arcfour =
181   {
182     GCRY_CIPHER_ARCFOUR, {0, 0},
183     "ARCFOUR", NULL, NULL, 1, 128, sizeof (ARCFOUR_context),
184     arcfour_setkey, NULL, NULL, encrypt_stream, encrypt_stream,
185   };