Add MD2_DIGEST_LEN macro.
[bertos.git] / algos / md2.c
1 /**
2  * \file
3  * <!--
4  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
5  * This file is part of DevLib - See README.devlib for information.
6  * -->
7  *
8  * \brief MD2 Message-Digest algorithm.
9  *
10  * The MD2 algorithm work with a constant array of 256 permutationt
11  * defined in RFC1319. If you don't want to use a standard array of 
12  * permutatione you can use a md2_perm() function that generate an 
13  * array of 256 "casual" permutation. To swich from a standard array 
14  * to md2_perm function you must chanche CONFIG_MD2_STD_PERM defined in 
15  * appconfig.h.
16  * If you need to store array in program memory you must define 
17  * a macro _PROGMEM (for more info see mware/pgm.h).
18  *
19  *
20  * \version $Id$
21  * \author Daniele Basile <asterix@develer.com>
22  */
23
24 /*#*
25  *#* $Log$
26  *#* Revision 1.16  2007/02/15 13:29:49  asterix
27  *#* Add MD2_DIGEST_LEN macro.
28  *#*
29  *#* Revision 1.15  2007/02/06 15:53:34  asterix
30  *#* Add ROTR macro in m2d_perm, add comments, typos.
31  *#*
32  *#* Revision 1.13  2007/02/05 18:44:42  asterix
33  *#* Add md2_perm function.
34  *#*
35  *#* Revision 1.12  2007/02/05 16:52:44  asterix
36  *#* Add define for harvard architecture.
37  *#*
38  *#* Revision 1.11  2007/02/02 18:15:31  asterix
39  *#* Add function MD2_test. Fix bug in md2_update function.
40  *#*
41  *#* Revision 1.9  2007/02/02 13:10:01  asterix
42  *#* Fix some bugs in md2_pad and md2_update fuction.
43  *#*
44  *#* Revision 1.8  2007/02/01 14:45:56  asterix
45  *#* Rewrite md2_update function and fix some bug.
46  *#*
47  *#* Revision 1.7  2007/01/31 18:04:15  asterix
48  *#* Write md2_end function
49  *#*
50  *#* Revision 1.4  2007/01/31 13:51:57  asterix
51  *#* Write md2_compute function.
52  *#*
53  *#* Revision 1.2  2007/01/30 17:31:44  asterix
54  *#* Add function prototypes.
55  *#*
56  *#* Revision 1.1  2007/01/30 15:53:26  batt
57  *#* Add first md2 skel.
58  *#*
59  *#*/
60
61 #include "md2.h"
62
63 #include <string.h>           //memset(), memcpy();
64 #include <cfg/compiler.h>
65 #include <cfg/debug.h>        //ASSERT()
66 #include <cfg/macros.h>       //MIN(), countof(), ROTR();
67 #include <mware/pgm.h>   
68
69
70 #if CONFIG_MD2_STD_PERM
71         /*
72         * Official array of 256 byte pemutation contructed from digits of pi, defined
73         * in the RFC 1319.
74         */
75         static const uint8_t PGM_ATTR md2_perm[256] = 
76         {
77         41, 46, 67, 201, 162, 216, 124, 1, 61, 54, 84, 161, 236, 240, 6,
78         19, 98, 167, 5, 243, 192, 199, 115, 140, 152, 147, 43, 217, 188,
79         76, 130, 202, 30, 155, 87, 60, 253, 212, 224, 22, 103, 66, 111, 24,
80         138, 23, 229, 18, 190, 78, 196, 214, 218, 158, 222, 73, 160, 251,
81         245, 142, 187, 47, 238, 122, 169, 104, 121, 145, 21, 178, 7, 63,
82         148, 194, 16, 137, 11, 34, 95, 33, 128, 127, 93, 154, 90, 144, 50,
83         39, 53, 62, 204, 231, 191, 247, 151, 3, 255, 25, 48, 179, 72, 165,
84         181, 209, 215, 94, 146, 42, 172, 86, 170, 198, 79, 184, 56, 210,
85         150, 164, 125, 182, 118, 252, 107, 226, 156, 116, 4, 241, 69, 157,
86         112, 89, 100, 113, 135, 32, 134, 91, 207, 101, 230, 45, 168, 2, 27,
87         96, 37, 173, 174, 176, 185, 246, 28, 70, 97, 105, 52, 64, 126, 15,
88         85, 71, 163, 35, 221, 81, 175, 58, 195, 92, 249, 206, 186, 197,
89         234, 38, 44, 83, 13, 110, 133, 40, 132, 9, 211, 223, 205, 244, 65,
90         129, 77, 82, 106, 220, 55, 200, 108, 193, 171, 250, 36, 225, 123,
91         8, 12, 189, 177, 74, 120, 136, 149, 139, 227, 99, 232, 109, 233,
92         203, 213, 254, 59, 0, 29, 57, 242, 239, 183, 14, 102, 88, 208, 228,
93         166, 119, 114, 248, 235, 117, 75, 10, 49, 68, 80, 180, 143, 237,
94         31, 26, 219, 153, 141, 51, 159, 17, 131, 20
95         };
96
97         #define MD2_PERM(x) PGM_READ_CHAR(&md2_perm[x])
98 #else
99         /**
100          * Md2_perm() function generate an array of 256 "casual" permutation.
101          */
102         
103         /**
104          * Costant define for computing an array of 256 "casual" permutation.
105          * \{
106          */
107         #define K1 5
108         #define K2 3
109         #define R  2
110         #define X  172
111         /*\}*/
112
113         static uint8_t md2_perm(uint8_t i)
114         {
115
116                 i = i * K1;
117                 i = ROTR(i, R);
118                 i ^=  X;
119                 i = i * K2;
120
121                 return i;
122         }
123
124         #define MD2_PERM(x) md2_perm(x)
125                 
126 #endif
127
128
129 /**
130  * Pad function. Put len_pad unsigned char in
131  * input block.
132  */
133 static void md2_pad(void *_block, size_t len_pad)
134 {
135         uint8_t *block;
136
137         block = (uint8_t *)_block;
138
139         ASSERT(len_pad <= CONFIG_MD2_BLOCK_LEN);
140
141         /*
142          * Fill input block with len_pad char.
143          */
144         memset(block, len_pad, len_pad);
145
146 }
147
148 static void md2_compute(void *_state, void *_checksum, void *_block)
149 {
150         int i = 0;
151         uint16_t t = 0;
152         uint8_t compute_array[COMPUTE_ARRAY_LEN];
153         uint8_t *state;
154         uint8_t *checksum;
155         uint8_t *block;
156
157         state = (uint8_t *)_state;
158         checksum  = (uint8_t *)_checksum;
159         block = (uint8_t *)_block;
160
161         /*
162          * Copy state and checksum context in compute array.
163          */
164         memcpy(compute_array, state, CONFIG_MD2_BLOCK_LEN);
165         memcpy(compute_array + CONFIG_MD2_BLOCK_LEN, block, CONFIG_MD2_BLOCK_LEN);
166
167         /*
168          * Fill compute array with state XOR block
169          */
170         for(i = 0; i < CONFIG_MD2_BLOCK_LEN; i++)
171                 compute_array[i + (CONFIG_MD2_BLOCK_LEN * 2)] = state[i] ^ block[i];
172
173         /*
174          * Encryt block.
175          */
176         for(i = 0; i < NUM_COMPUTE_ROUNDS; i++)
177         {
178                 for(int j = 0; j < COMPUTE_ARRAY_LEN; j++)
179                 {
180                         compute_array[j] ^= MD2_PERM(t);
181                         t = compute_array[j];
182                 }
183
184                 t = (t + i) & 0xff; //modulo 256.
185         }
186         /*
187          * Update checksum.
188          */
189         t = checksum[CONFIG_MD2_BLOCK_LEN - 1];
190
191         for(i = 0; i < CONFIG_MD2_BLOCK_LEN; i++)
192         {
193                 checksum[i]  ^= MD2_PERM(block[i] ^ t);
194                 t = checksum[i];
195         }
196
197         /*
198          * Update state and clean compute array.
199          */
200         memcpy(state, compute_array, CONFIG_MD2_BLOCK_LEN);
201         memset(compute_array, 0, sizeof(compute_array));
202 }
203
204 /**
205  * Algorithm initialization.
206  *
207  * \param empty context.
208  */
209 void md2_init(Md2Context *context)
210 {
211
212         memset(context, 0, sizeof(Md2Context));
213
214 }
215
216 /**
217  * Update block.
218  */
219 void md2_update(Md2Context *context, const void *_block_in, size_t block_len)
220 {
221
222         const uint8_t *block_in;
223         size_t cpy_len;
224
225
226         block_in = (const uint8_t *)_block_in;
227
228         while(block_len > 0)
229         {
230                 /*
231                  * Choose a number of block that fill input context buffer.
232                  */
233                 cpy_len = MIN(block_len, CONFIG_MD2_BLOCK_LEN - context->counter);
234
235                 
236                 /*
237                  * Copy in the buffer input block.
238                  */
239                 memcpy(&context->buffer[context->counter], block_in, cpy_len);
240
241                 /*
242                  * Update a context counter, input block length and remaning 
243                  * context buffer block lenght.
244                  */
245                 context->counter += cpy_len;
246                 block_len -= cpy_len;
247                 block_in += cpy_len;
248
249                 /*
250                  * If buffer is full, compute it.
251                  */
252                 if (context->counter >= CONFIG_MD2_BLOCK_LEN)
253                 {
254                         md2_compute(context->state, context->checksum, context->buffer);
255                         context->counter = 0;
256                 }
257         }
258
259
260 }
261 /**
262  * Ends an MD2 message digest operation.
263  * This fuction take an context and return a pointer
264  * to context state.
265  *
266  * \param context in input.
267  * \return a pointer to context state (message digest).
268  */
269 uint8_t  *md2_end(Md2Context *context)
270 {
271
272         uint8_t buf[CONFIG_MD2_BLOCK_LEN];
273
274         /*
275          * Fill remaning empty context buffer.
276          */
277         md2_pad(buf, CONFIG_MD2_BLOCK_LEN - context->counter);
278
279         /*
280          * Update context buffer and compute it.
281          */
282         md2_update(context, buf, CONFIG_MD2_BLOCK_LEN - context->counter);
283
284         /*
285          * Add context checksum to message input.
286          */
287         md2_update(context, context->checksum, CONFIG_MD2_BLOCK_LEN);
288
289
290         return context->state; //return a pointer to message digest.
291 }
292 /**
293  * MD2 test fuction.
294  * This function test MD2 algorithm with a standard string specified
295  * in RFC 1319.
296  *
297  * \note This test work with official array of 256 byte pemutation
298  * contructed from digits of pi, defined in the RFC 1319.
299  *
300  */
301 bool md2_test(void)
302 {
303
304         Md2Context context;
305
306         const char *test[] =
307         {
308                 "",
309                 "message digest",
310                 "abcdefghijklmnopqrstuvwxyz",
311                 "12345678901234567890123456789012345678901234567890123456789012345678901234567890"
312         };
313
314
315         const uint8_t *result[] = {
316                 "\x83\x50\xe5\xa3\xe2\x4c\x15\x3d\xf2\x27\x5c\x9f\x80\x69\x27\x73",
317                 "\xab\x4f\x49\x6b\xfb\x2a\x53\x0b\x21\x9f\xf3\x30\x31\xfe\x06\xb0",
318                 "\x4e\x8d\xdf\xf3\x65\x02\x92\xab\x5a\x41\x08\xc3\xaa\x47\x94\x0b",
319                 "\xd5\x97\x6f\x79\xd8\x3d\x3a\x0d\xc9\x80\x6c\x3c\x66\xf3\xef\xd8",
320         };
321
322
323         for (int i = 0; i < countof(test); i++)
324         {
325                 md2_init(&context);
326                 md2_update(&context, test[i], strlen(test[i]));
327
328                 if(memcmp(result[i], md2_end(&context), MD2_DIGEST_LEN))
329                         return false;
330         }
331
332         return true;
333 }
334
335 #if 0
336
337 #include <stdio.h>
338 int main(int argc, char * argv[])
339 {
340
341         if(md2_test())
342                 printf("MD2 algorithm work well!\n");
343         else
344                 printf("MD2 algorithm doesn't work well.\n");
345
346 }
347
348 #endif
349