md4.h

00001 /**
00002  * \file md4.h
00003  *
00004  * \brief MD4 message digest algorithm (hash function)
00005  *
00006  *  Copyright (C) 2006-2014, Brainspark B.V.
00007  *
00008  *  This file is part of PolarSSL (http://www.polarssl.org)
00009  *  Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
00010  *
00011  *  All rights reserved.
00012  *
00013  *  This program is free software; you can redistribute it and/or modify
00014  *  it under the terms of the GNU General Public License as published by
00015  *  the Free Software Foundation; either version 2 of the License, or
00016  *  (at your option) any later version.
00017  *
00018  *  This program is distributed in the hope that it will be useful,
00019  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00020  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00021  *  GNU General Public License for more details.
00022  *
00023  *  You should have received a copy of the GNU General Public License along
00024  *  with this program; if not, write to the Free Software Foundation, Inc.,
00025  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
00026  */
00027 #ifndef POLARSSL_MD4_H
00028 #define POLARSSL_MD4_H
00029 
00030 #if !defined(POLARSSL_CONFIG_FILE)
00031 #include "config.h"
00032 #else
00033 #include POLARSSL_CONFIG_FILE
00034 #endif
00035 
00036 #include <string.h>
00037 
00038 #if defined(_MSC_VER) && !defined(EFIX64) && !defined(EFI32)
00039 #include <basetsd.h>
00040 typedef UINT32 uint32_t;
00041 #else
00042 #include <inttypes.h>
00043 #endif
00044 
00045 #define POLARSSL_ERR_MD4_FILE_IO_ERROR                 -0x0072  /**< Read/write error in file. */
00046 
00047 #if !defined(POLARSSL_MD4_ALT)
00048 // Regular implementation
00049 //
00050 
00051 #ifdef __cplusplus
00052 extern "C" {
00053 #endif
00054 
00055 /**
00056  * \brief          MD4 context structure
00057  */
00058 typedef struct
00059 {
00060     uint32_t total[2];          /*!< number of bytes processed  */
00061     uint32_t state[4];          /*!< intermediate digest state  */
00062     unsigned char buffer[64];   /*!< data block being processed */
00063 
00064     unsigned char ipad[64];     /*!< HMAC: inner padding        */
00065     unsigned char opad[64];     /*!< HMAC: outer padding        */
00066 }
00067 md4_context;
00068 
00069 /**
00070  * \brief          MD4 context setup
00071  *
00072  * \param ctx      context to be initialized
00073  */
00074 void md4_starts( md4_context *ctx );
00075 
00076 /**
00077  * \brief          MD4 process buffer
00078  *
00079  * \param ctx      MD4 context
00080  * \param input    buffer holding the  data
00081  * \param ilen     length of the input data
00082  */
00083 void md4_update( md4_context *ctx, const unsigned char *input, size_t ilen );
00084 
00085 /**
00086  * \brief          MD4 final digest
00087  *
00088  * \param ctx      MD4 context
00089  * \param output   MD4 checksum result
00090  */
00091 void md4_finish( md4_context *ctx, unsigned char output[16] );
00092 
00093 #ifdef __cplusplus
00094 }
00095 #endif
00096 
00097 #else  /* POLARSSL_MD4_ALT */
00098 #include "md4_alt.h"
00099 #endif /* POLARSSL_MD4_ALT */
00100 
00101 #ifdef __cplusplus
00102 extern "C" {
00103 #endif
00104 
00105 /**
00106  * \brief          Output = MD4( input buffer )
00107  *
00108  * \param input    buffer holding the  data
00109  * \param ilen     length of the input data
00110  * \param output   MD4 checksum result
00111  */
00112 void md4( const unsigned char *input, size_t ilen, unsigned char output[16] );
00113 
00114 /**
00115  * \brief          Output = MD4( file contents )
00116  *
00117  * \param path     input file name
00118  * \param output   MD4 checksum result
00119  *
00120  * \return         0 if successful, or POLARSSL_ERR_MD4_FILE_IO_ERROR
00121  */
00122 int md4_file( const char *path, unsigned char output[16] );
00123 
00124 /**
00125  * \brief          MD4 HMAC context setup
00126  *
00127  * \param ctx      HMAC context to be initialized
00128  * \param key      HMAC secret key
00129  * \param keylen   length of the HMAC key
00130  */
00131 void md4_hmac_starts( md4_context *ctx, const unsigned char *key,
00132                       size_t keylen );
00133 
00134 /**
00135  * \brief          MD4 HMAC process buffer
00136  *
00137  * \param ctx      HMAC context
00138  * \param input    buffer holding the  data
00139  * \param ilen     length of the input data
00140  */
00141 void md4_hmac_update( md4_context *ctx, const unsigned char *input,
00142                       size_t ilen );
00143 
00144 /**
00145  * \brief          MD4 HMAC final digest
00146  *
00147  * \param ctx      HMAC context
00148  * \param output   MD4 HMAC checksum result
00149  */
00150 void md4_hmac_finish( md4_context *ctx, unsigned char output[16] );
00151 
00152 /**
00153  * \brief          MD4 HMAC context reset
00154  *
00155  * \param ctx      HMAC context to be reset
00156  */
00157 void md4_hmac_reset( md4_context *ctx );
00158 
00159 /**
00160  * \brief          Output = HMAC-MD4( hmac key, input buffer )
00161  *
00162  * \param key      HMAC secret key
00163  * \param keylen   length of the HMAC key
00164  * \param input    buffer holding the  data
00165  * \param ilen     length of the input data
00166  * \param output   HMAC-MD4 result
00167  */
00168 void md4_hmac( const unsigned char *key, size_t keylen,
00169                const unsigned char *input, size_t ilen,
00170                unsigned char output[16] );
00171 
00172 /**
00173  * \brief          Checkup routine
00174  *
00175  * \return         0 if successful, or 1 if the test failed
00176  */
00177 int md4_self_test( int verbose );
00178 
00179 /* Internal use */
00180 void md4_process( md4_context *ctx, const unsigned char data[64] );
00181 
00182 #ifdef __cplusplus
00183 }
00184 #endif
00185 
00186 #endif /* md4.h */
00187 
00188