Doc fixes.
[bertos.git] / algo / md2.h
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 algorithm takes as input a message of arbitrary length and produces
36  * as output a 128-bit message digest of the input.
37  * It is conjectured that it is computationally infeasible to produce
38  * two messages having the same message digest, or to produce any
39  * message having a given prespecified target message digest.
40  *
41  *
42  *
43  * \version $Id$
44  * \author Daniele Basile <asterix@develer.com>
45  */
46
47 #ifndef ALGO_MD2_H
48 #define ALGO_MD2_H
49
50 #include <cfg/compiler.h>
51 #include <appconfig.h>
52
53 #define NUM_COMPUTE_ROUNDS 18                        ///< Number of compute rounds.
54 #define COMPUTE_ARRAY_LEN  CONFIG_MD2_BLOCK_LEN * 3     ///< Lenght of compute array.
55 #define MD2_DIGEST_LEN CONFIG_MD2_BLOCK_LEN
56 /**
57  * Context for MD2 computation.
58  */
59 typedef struct Md2Context
60 {
61         uint8_t buffer[CONFIG_MD2_BLOCK_LEN];   ///< Input buffer.
62         uint8_t state[CONFIG_MD2_BLOCK_LEN];    ///< Current state buffer.
63         uint8_t checksum[CONFIG_MD2_BLOCK_LEN]; ///< Checksum.
64         size_t counter;                         ///< Counter of remaining bytes.
65
66 } Md2Context;
67
68 void md2_init(Md2Context *context);
69 void md2_update(Md2Context *context, const void *block_in, size_t block_len);
70 uint8_t *md2_end(Md2Context *context);
71 bool md2_test(void);
72
73 #endif /* ALGO_MD2_H */