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