blob: 02a0a10e9a129af3c4c80f82e7b7b15e27322776 [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 Bakker84f12b72010-07-18 10:13:04 +00006 * Copyright (C) 2006-2010, 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 Bakker23986e52011-04-24 08:57:21 +000030#include <string.h>
31
Paul Bakker69e095c2011-12-10 21:55:01 +000032#define POLARSSL_ERR_MD2_FILE_IO_ERROR -0x0070 /**< Read/write error in file. */
33
Paul Bakker5121ce52009-01-03 21:22:43 +000034/**
35 * \brief MD2 context structure
36 */
37typedef struct
38{
39 unsigned char cksum[16]; /*!< checksum of the data block */
40 unsigned char state[48]; /*!< intermediate digest state */
41 unsigned char buffer[16]; /*!< data block being processed */
42
Paul Bakkerfa1c5922011-10-06 14:18:49 +000043 unsigned char ipad[16]; /*!< HMAC: inner padding */
44 unsigned char opad[16]; /*!< HMAC: outer padding */
Paul Bakker23986e52011-04-24 08:57:21 +000045 size_t left; /*!< amount of data in buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +000046}
47md2_context;
48
49#ifdef __cplusplus
50extern "C" {
51#endif
52
53/**
54 * \brief MD2 context setup
55 *
56 * \param ctx context to be initialized
57 */
58void md2_starts( md2_context *ctx );
59
60/**
61 * \brief MD2 process buffer
62 *
63 * \param ctx MD2 context
64 * \param input buffer holding the data
65 * \param ilen length of the input data
66 */
Paul Bakker23986e52011-04-24 08:57:21 +000067void md2_update( md2_context *ctx, const unsigned char *input, size_t ilen );
Paul Bakker5121ce52009-01-03 21:22:43 +000068
69/**
70 * \brief MD2 final digest
71 *
72 * \param ctx MD2 context
73 * \param output MD2 checksum result
74 */
75void md2_finish( md2_context *ctx, unsigned char output[16] );
76
77/**
78 * \brief Output = MD2( input buffer )
79 *
80 * \param input buffer holding the data
81 * \param ilen length of the input data
82 * \param output MD2 checksum result
83 */
Paul Bakker23986e52011-04-24 08:57:21 +000084void md2( const unsigned char *input, size_t ilen, unsigned char output[16] );
Paul Bakker5121ce52009-01-03 21:22:43 +000085
86/**
87 * \brief Output = MD2( file contents )
88 *
89 * \param path input file name
90 * \param output MD2 checksum result
91 *
Paul Bakker69e095c2011-12-10 21:55:01 +000092 * \return 0 if successful, or POLARSSL_ERR_MD2_FILE_IO_ERROR
Paul Bakker5121ce52009-01-03 21:22:43 +000093 */
Paul Bakkerff60ee62010-03-16 21:09:09 +000094int md2_file( const char *path, unsigned char output[16] );
Paul Bakker5121ce52009-01-03 21:22:43 +000095
96/**
97 * \brief MD2 HMAC context setup
98 *
99 * \param ctx HMAC context to be initialized
100 * \param key HMAC secret key
101 * \param keylen length of the HMAC key
102 */
Paul Bakker23986e52011-04-24 08:57:21 +0000103void md2_hmac_starts( md2_context *ctx, const unsigned char *key, size_t keylen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000104
105/**
106 * \brief MD2 HMAC process buffer
107 *
108 * \param ctx HMAC context
109 * \param input buffer holding the data
110 * \param ilen length of the input data
111 */
Paul Bakker23986e52011-04-24 08:57:21 +0000112void md2_hmac_update( md2_context *ctx, const unsigned char *input, size_t ilen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000113
114/**
115 * \brief MD2 HMAC final digest
116 *
117 * \param ctx HMAC context
118 * \param output MD2 HMAC checksum result
119 */
120void md2_hmac_finish( md2_context *ctx, unsigned char output[16] );
121
122/**
Paul Bakker7d3b6612010-03-21 16:23:13 +0000123 * \brief MD2 HMAC context reset
124 *
125 * \param ctx HMAC context to be reset
126 */
127void md2_hmac_reset( md2_context *ctx );
128
129/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000130 * \brief Output = HMAC-MD2( hmac key, input buffer )
131 *
132 * \param key HMAC secret key
133 * \param keylen length of the HMAC key
134 * \param input buffer holding the data
135 * \param ilen length of the input data
136 * \param output HMAC-MD2 result
137 */
Paul Bakker23986e52011-04-24 08:57:21 +0000138void md2_hmac( const unsigned char *key, size_t keylen,
139 const unsigned char *input, size_t ilen,
Paul Bakker5121ce52009-01-03 21:22:43 +0000140 unsigned char output[16] );
141
142/**
143 * \brief Checkup routine
144 *
145 * \return 0 if successful, or 1 if the test failed
146 */
147int md2_self_test( int verbose );
148
Paul Bakker1bd3ae82013-03-13 10:26:44 +0100149/* Internal use */
150void md2_process( md2_context *ctx );
151
Paul Bakker5121ce52009-01-03 21:22:43 +0000152#ifdef __cplusplus
153}
154#endif
155
156#endif /* md2.h */