src/libpolarssl/md2.h

   1 /**
   2  * \file md2.h
   3  *
   4  * \brief MD2 message digest algorithm (hash function)
   5  *
   6  *  Copyright (C) 2006-2013, Brainspark B.V.
   7  *
   8  *  This file is part of PolarSSL (http://www.polarssl.org)
   9  *  Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
  10  *
  11  *  All rights reserved.
  12  *
  13  *  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.
  26  */
  27 #ifndef POLARSSL_MD2_H
  28 #define POLARSSL_MD2_H
  29
  30 #include "config.h"
  31
  32 #include <string.h>
  33
  34 #define POLARSSL_ERR_MD2_FILE_IO_ERROR                 -0x0070  /**< Read/write error in file. */
  35
  36 #if !defined(POLARSSL_MD2_ALT)
  37 // Regular implementation
  38 //
  39
  40 /**
  41  * \brief          MD2 context structure
  42  */
  43 typedef 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
  49     unsigned char ipad[16];     /*!< HMAC: inner padding        */
  50     unsigned char opad[16];     /*!< HMAC: outer padding        */
  51     size_t left;                /*!< amount of data in buffer   */
  52 }
  53 md2_context;
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 /**
  60  * \brief          MD2 context setup
  61  *
  62  * \param ctx      context to be initialized
  63  */
  64 void 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  */
  73 void md2_update( md2_context *ctx, const unsigned char *input, size_t ilen );
  74
  75 /**
  76  * \brief          MD2 final digest
  77  *
  78  * \param ctx      MD2 context
  79  * \param output   MD2 checksum result
  80  */
  81 void md2_finish( md2_context *ctx, unsigned char output[16] );
  82
  83 #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
  92 extern "C" {
  93 #endif
  94
  95 /**
  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  */
 102 void md2( const unsigned char *input, size_t ilen, unsigned char output[16] );
 103
 104 /**
 105  * \brief          Output = MD2( file contents )
 106  *
 107  * \param path     input file name
 108  * \param output   MD2 checksum result
 109  *
 110  * \return         0 if successful, or POLARSSL_ERR_MD2_FILE_IO_ERROR
 111  */
 112 int md2_file( const char *path, unsigned char output[16] );
 113
 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  */
 121 void md2_hmac_starts( md2_context *ctx, const unsigned char *key, size_t keylen );
 122
 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  */
 130 void md2_hmac_update( md2_context *ctx, const unsigned char *input, size_t ilen );
 131
 132 /**
 133  * \brief          MD2 HMAC final digest
 134  *
 135  * \param ctx      HMAC context
 136  * \param output   MD2 HMAC checksum result
 137  */
 138 void md2_hmac_finish( md2_context *ctx, unsigned char output[16] );
 139
 140 /**
 141  * \brief          MD2 HMAC context reset
 142  *
 143  * \param ctx      HMAC context to be reset
 144  */
 145 void md2_hmac_reset( md2_context *ctx );
 146
 147 /**
 148  * \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  */
 156 void md2_hmac( const unsigned char *key, size_t keylen,
 157                const unsigned char *input, size_t ilen,
 158                unsigned char output[16] );
 159
 160 /**
 161  * \brief          Checkup routine
 162  *
 163  * \return         0 if successful, or 1 if the test failed
 164  */
 165 int md2_self_test( int verbose );
 166
 167 #ifdef __cplusplus
 168 }
 169 #endif
 170
 171 #endif /* md2.h */