blob: 1dc77c28099175eb895f86ce63fcc0823c289cc0 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file md2.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief MD2 message digest algorithm (hash function)
5 *
Paul Bakker90995b52013-06-24 19:20:35 +02006 * Copyright (C) 2006-2013, Brainspark B.V.
Paul Bakkerb96f1542010-07-18 20:36:00 +00007 *
8 * This file is part of PolarSSL (http://www.polarssl.org)
Paul Bakker84f12b72010-07-18 10:13:04 +00009 * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
Paul Bakkerb96f1542010-07-18 20:36:00 +000010 *
Paul Bakker77b385e2009-07-28 17:23:11 +000011 * All rights reserved.
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000012 *
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000013 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Paul Bakker5121ce52009-01-03 21:22:43 +000026 */
Paul Bakker40e46942009-01-03 21:51:57 +000027#ifndef POLARSSL_MD2_H
28#define POLARSSL_MD2_H
Paul Bakker5121ce52009-01-03 21:22:43 +000029
Paul Bakker90995b52013-06-24 19:20:35 +020030#include "config.h"
31
Paul Bakker23986e52011-04-24 08:57:21 +000032#include <string.h>
33
Paul Bakker69e095c2011-12-10 21:55:01 +000034#define POLARSSL_ERR_MD2_FILE_IO_ERROR -0x0070 /**< Read/write error in file. */
35
Paul Bakker90995b52013-06-24 19:20:35 +020036#if !defined(POLARSSL_MD2_ALT)
37// Regular implementation
38//
39
Paul Bakker5121ce52009-01-03 21:22:43 +000040/**
41 * \brief MD2 context structure
42 */
43typedef struct
44{
45 unsigned char cksum[16]; /*!< checksum of the data block */
46 unsigned char state[48]; /*!< intermediate digest state */
47 unsigned char buffer[16]; /*!< data block being processed */
48
Paul Bakkerfa1c5922011-10-06 14:18:49 +000049 unsigned char ipad[16]; /*!< HMAC: inner padding */
50 unsigned char opad[16]; /*!< HMAC: outer padding */
Paul Bakker23986e52011-04-24 08:57:21 +000051 size_t left; /*!< amount of data in buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +000052}
53md2_context;
54
55#ifdef __cplusplus
56extern "C" {
57#endif
58
59/**
60 * \brief MD2 context setup
61 *
62 * \param ctx context to be initialized
63 */
64void md2_starts( md2_context *ctx );
65
66/**
67 * \brief MD2 process buffer
68 *
69 * \param ctx MD2 context
70 * \param input buffer holding the data
71 * \param ilen length of the input data
72 */
Paul Bakker23986e52011-04-24 08:57:21 +000073void md2_update( md2_context *ctx, const unsigned char *input, size_t ilen );
Paul Bakker5121ce52009-01-03 21:22:43 +000074
75/**
76 * \brief MD2 final digest
77 *
78 * \param ctx MD2 context
79 * \param output MD2 checksum result
80 */
81void md2_finish( md2_context *ctx, unsigned char output[16] );
82
Paul Bakker90995b52013-06-24 19:20:35 +020083#ifdef __cplusplus
84}
85#endif
86
87#else /* POLARSSL_MD2_ALT */
88#include "md2_alt.h"
89#endif /* POLARSSL_MD2_ALT */
90
91#ifdef __cplusplus
92extern "C" {
93#endif
94
Paul Bakker5121ce52009-01-03 21:22:43 +000095/**
96 * \brief Output = MD2( input buffer )
97 *
98 * \param input buffer holding the data
99 * \param ilen length of the input data
100 * \param output MD2 checksum result
101 */
Paul Bakker23986e52011-04-24 08:57:21 +0000102void md2( const unsigned char *input, size_t ilen, unsigned char output[16] );
Paul Bakker5121ce52009-01-03 21:22:43 +0000103
104/**
105 * \brief Output = MD2( file contents )
106 *
107 * \param path input file name
108 * \param output MD2 checksum result
109 *
Paul Bakker69e095c2011-12-10 21:55:01 +0000110 * \return 0 if successful, or POLARSSL_ERR_MD2_FILE_IO_ERROR
Paul Bakker5121ce52009-01-03 21:22:43 +0000111 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000112int md2_file( const char *path, unsigned char output[16] );
Paul Bakker5121ce52009-01-03 21:22:43 +0000113
114/**
115 * \brief MD2 HMAC context setup
116 *
117 * \param ctx HMAC context to be initialized
118 * \param key HMAC secret key
119 * \param keylen length of the HMAC key
120 */
Paul Bakker23986e52011-04-24 08:57:21 +0000121void md2_hmac_starts( md2_context *ctx, const unsigned char *key, size_t keylen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000122
123/**
124 * \brief MD2 HMAC process buffer
125 *
126 * \param ctx HMAC context
127 * \param input buffer holding the data
128 * \param ilen length of the input data
129 */
Paul Bakker23986e52011-04-24 08:57:21 +0000130void md2_hmac_update( md2_context *ctx, const unsigned char *input, size_t ilen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000131
132/**
133 * \brief MD2 HMAC final digest
134 *
135 * \param ctx HMAC context
136 * \param output MD2 HMAC checksum result
137 */
138void md2_hmac_finish( md2_context *ctx, unsigned char output[16] );
139
140/**
Paul Bakker7d3b6612010-03-21 16:23:13 +0000141 * \brief MD2 HMAC context reset
142 *
143 * \param ctx HMAC context to be reset
144 */
145void md2_hmac_reset( md2_context *ctx );
146
147/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000148 * \brief Output = HMAC-MD2( hmac key, input buffer )
149 *
150 * \param key HMAC secret key
151 * \param keylen length of the HMAC key
152 * \param input buffer holding the data
153 * \param ilen length of the input data
154 * \param output HMAC-MD2 result
155 */
Paul Bakker23986e52011-04-24 08:57:21 +0000156void md2_hmac( const unsigned char *key, size_t keylen,
157 const unsigned char *input, size_t ilen,
Paul Bakker5121ce52009-01-03 21:22:43 +0000158 unsigned char output[16] );
159
160/**
161 * \brief Checkup routine
162 *
163 * \return 0 if successful, or 1 if the test failed
164 */
165int md2_self_test( int verbose );
166
Paul Bakker1bd3ae82013-03-13 10:26:44 +0100167/* Internal use */
168void md2_process( md2_context *ctx );
169
Paul Bakker5121ce52009-01-03 21:22:43 +0000170#ifdef __cplusplus
171}
172#endif
173
174#endif /* md2.h */