Release version 2.5.1.
[bertos.git] / 2.5 / bertos / algo / randpool.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 API function for to manage entropy pool.
34  *
35  * \version $Id$
36  * \author Daniele Basile <asterix@develer.com>
37  */
38
39 #include "randpool.h"
40 #include "md2.h"
41
42 #include <cfg/compiler.h>
43 #include <cfg/debug.h>       //ASSERT()
44 #include <cfg/macros.h>      //MIN(), ROUND_UP();
45
46 #include <stdio.h>           //sprintf();
47 #include <string.h>          //memset(), memcpy();
48
49 #if CONFIG_RANDPOOL_TIMER
50         #include <drv/timer.h>       //timer_clock();
51 #endif
52
53
54
55 /*
56  * Insert bytes in entropy pool, making a XOR of bytes present
57  * in entropy pool.
58  */
59 static void randpool_push(EntropyPool *pool, void *_byte, size_t n_byte)
60 {
61         size_t i = pool->pos_add; // Current number of byte insert in entropy pool.
62         uint8_t *byte;
63
64         byte = (uint8_t *)_byte;
65
66         /*
67          * Insert a bytes in entropy pool.
68          */
69         for(size_t j = 0; j < n_byte; j++)
70         {
71                 pool->pool_entropy[i] = pool->pool_entropy[i] ^ byte[j];
72                 i++;
73                 i = i % CONFIG_SIZE_ENTROPY_POOL;
74         }
75
76         pool->pos_add  =  i; // Update a insert bytes.
77 }
78
79
80 /*
81  * This function stir entropy pool with MD2 function hash.
82  *
83  */
84 static void randpool_stir(EntropyPool *pool)
85 {
86         size_t entropy = pool->entropy; //Save current calue of entropy.
87         Md2Context context;
88         uint8_t tmp_buf[((sizeof(size_t) * 2) + sizeof(int)) * 2 + 1]; //Temporary buffer.
89
90         md2_init(&context); //Init MD2 algorithm.
91
92         randpool_add(pool, NULL, 0);
93
94         for (int i = 0; i < (CONFIG_SIZE_ENTROPY_POOL / MD2_DIGEST_LEN); i++)
95         {
96                 sprintf((char *)tmp_buf, "%0x%0x%0x", pool->counter, i, pool->pos_add);
97
98                 /*
99                  * Hash with MD2 algorithm the entropy pool.
100                  */
101                 md2_update(&context, pool->pool_entropy, CONFIG_SIZE_ENTROPY_POOL);
102
103                 md2_update(&context, tmp_buf, sizeof(tmp_buf) - 1);
104
105                 /*Insert a message digest in entropy pool.*/
106                 randpool_push(pool, md2_end(&context), MD2_DIGEST_LEN);
107
108                 pool->counter = pool->counter + 1;
109
110         }
111
112         /*Insert in pool the difference between a two call of this function (see above).*/
113         randpool_add(pool, NULL, 0);
114
115         pool->entropy = entropy; //Restore old value of entropy. We haven't add entropy.
116 }
117
118 /**
119  * Add \param entropy bits from \param data buffer to the entropy \param pool
120  */
121 void randpool_add(EntropyPool *pool, void *data, size_t entropy)
122 {
123         uint8_t sep[] = "\xaa\xaa\xaa\xaa";  // ??
124         size_t data_len = ROUND_UP(entropy, 8) / 8; //Number of entropy byte in input.
125
126         randpool_push(pool, data, data_len); //Insert data to entropy pool.
127
128 #if CONFIG_RANDPOOL_TIMER
129
130         ticks_t event = timer_clock();
131         ticks_t delta;
132
133         /*Difference of time between a two accese to entropy pool.*/
134         delta = event - pool->last_counter;
135
136         randpool_push(pool, &event, sizeof(ticks_t));
137         randpool_push(pool, sep, sizeof(sep) - 1); // ??
138         randpool_push(pool, &delta, sizeof(delta));
139
140         /*
141          * Count of number entropy bit add with delta.
142          */
143         delta = delta & 0xff;
144         while(delta)
145         {
146                 delta >>= 1;
147                 entropy++;
148         }
149
150         pool->last_counter = event;
151
152 #endif
153
154         pool->entropy += entropy;      //Update a entropy of the pool.
155 }
156
157 /**
158  * Randpool function initialization.
159  * The entropy pool can be initialize also with
160  * a previous entropy pool.
161  */
162 void randpool_init(EntropyPool *pool, void *_data, size_t len)
163 {
164         uint8_t *data;
165
166         data = (uint8_t *)_data;
167
168         memset(pool, 0, sizeof(EntropyPool));
169         pool->pos_get = MD2_DIGEST_LEN;
170
171 #if CONFIG_RANDPOOL_TIMER
172         pool->last_counter = timer_clock();
173 #endif
174
175         if(data)
176         {
177                 /*
178                  * Initialize a entropy pool with a
179                  * previous pool, and assume all pool as
180                  * entropy.
181                  */
182                 len = MIN(len,(size_t)CONFIG_SIZE_ENTROPY_POOL);
183                 memcpy(pool->pool_entropy, data, len);
184                 pool->entropy = len;
185         }
186
187 }
188
189 /**
190  * Get the actual value of entropy.
191  */
192 size_t randpool_size(EntropyPool *pool)
193 {
194         return pool->entropy;
195 }
196
197 /**
198  * Get \param n_byte from entropy pool. If n_byte is larger than number
199  * byte of entropy in entropy pool, randpool_get continue
200  * to generate pseudocasual value from previous state of
201  * pool.
202  * \param n_byte number fo bytes to read.
203  * \param pool is the pool entropy context.
204  * \param _data is the pointer to write the random data to.
205  */
206 void randpool_get(EntropyPool *pool, void *_data, size_t n_byte)
207 {
208         Md2Context context;
209         size_t i = pool->pos_get;
210         size_t n = n_byte;
211         size_t pos_write = 0;  //Number of block has been written in data.
212         size_t len = MIN((size_t)MD2_DIGEST_LEN, n_byte);
213         uint8_t *data;
214
215         data = (uint8_t *)_data;
216
217         /* Test if i + CONFIG_MD2_BLOCK_LEN  is inside of entropy pool.*/
218         ASSERT((MD2_DIGEST_LEN + i) <= CONFIG_SIZE_ENTROPY_POOL);
219
220         md2_init(&context);
221
222         while(n > 0)
223         {
224
225                 /*Hash previous state of pool*/
226                 md2_update(&context, &pool->pool_entropy[i], MD2_DIGEST_LEN);
227
228                 memcpy(&data[pos_write], md2_end(&context), len);
229
230                 pos_write += len;   //Update number of block has been written in data.
231                 n -= len;           //Number of byte copied in data.
232
233                 len = MIN(n,(size_t)MD2_DIGEST_LEN);
234
235                 i = (i + MD2_DIGEST_LEN) % CONFIG_SIZE_ENTROPY_POOL;
236
237                 /* If we haven't more entropy pool to hash, we stir it.*/
238                 if(i < MD2_DIGEST_LEN)
239                 {
240                         randpool_stir(pool);
241                         i = pool->pos_get;
242                 }
243
244         }
245
246         pool->pos_get = i; //Current number of byte we get from pool.
247         pool->entropy -= n_byte; //Update a entropy.
248
249 }
250
251 /**
252  * Return a pointer to entropy pool.
253  */
254 uint8_t *randpool_pool(EntropyPool *pool)
255 {
256         return pool->pool_entropy;
257 }
258