include/tropicssl/md2.h

   1 /**
   2  * \file md2.h
   3  *
   4  *  Based on XySSL: Copyright (C) 2006-2008  Christophe Devine
   5  *
   6  *  Copyright (C) 2009  Paul Bakker <polarssl_maintainer at polarssl dot org>
   7  *
   8  *  All rights reserved.
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *
  14  *    * Redistributions of source code must retain the above copyright
  15  *      notice, this list of conditions and the following disclaimer.
  16  *    * Redistributions in binary form must reproduce the above copyright
  17  *      notice, this list of conditions and the following disclaimer in the
  18  *      documentation and/or other materials provided with the distribution.
  19  *    * Neither the names of PolarSSL or XySSL nor the names of its contributors
  20  *      may be used to endorse or promote products derived from this software
  21  *      without specific prior written permission.
  22  *
  23  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  26  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  29  *  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  30  *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  31  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  32  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35 #ifndef TROPICSSL_MD2_H
  36 #define TROPICSSL_MD2_H
  37
  38 /**
  39  * \brief          MD2 context structure
  40  */
  41 typedef struct {
  42         unsigned char cksum[16];        /*!< checksum of the data block */
  43         unsigned char state[48];        /*!< intermediate digest state  */
  44         unsigned char buffer[16];       /*!< data block being processed */
  45
  46         unsigned char ipad[64]; /*!< HMAC: inner padding        */
  47         unsigned char opad[64]; /*!< HMAC: outer padding        */
  48         int left;               /*!< amount of data in buffer   */
  49 } md2_context;
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55         /**
  56          * \brief          MD2 context setup
  57          *
  58          * \param ctx      context to be initialized
  59          */
  60         void md2_starts(md2_context * ctx);
  61
  62         /**
  63          * \brief          MD2 process buffer
  64          *
  65          * \param ctx      MD2 context
  66          * \param input    buffer holding the  data
  67          * \param ilen     length of the input data
  68          */
  69         void md2_update(md2_context * ctx, const unsigned char *input, int ilen);
  70
  71         /**
  72          * \brief          MD2 final digest
  73          *
  74          * \param ctx      MD2 context
  75          * \param output   MD2 checksum result
  76          */
  77         void md2_finish(md2_context * ctx, unsigned char output[16]);
  78
  79         /**
  80          * \brief          Output = MD2( input buffer )
  81          *
  82          * \param input    buffer holding the  data
  83          * \param ilen     length of the input data
  84          * \param output   MD2 checksum result
  85          */
  86         void md2(const unsigned char *input, int ilen, unsigned char output[16]);
  87
  88         /**
  89          * \brief          Output = MD2( file contents )
  90          *
  91          * \param path     input file name
  92          * \param output   MD2 checksum result
  93          *
  94          * \return         0 if successful, 1 if fopen failed,
  95          *                 or 2 if fread failed
  96          */
  97         int md2_file(const char *path, unsigned char output[16]);
  98
  99         /**
 100          * \brief          MD2 HMAC context setup
 101          *
 102          * \param ctx      HMAC context to be initialized
 103          * \param key      HMAC secret key
 104          * \param keylen   length of the HMAC key
 105          */
 106         void md2_hmac_starts(md2_context * ctx, const unsigned char *key, int keylen);
 107
 108         /**
 109          * \brief          MD2 HMAC process buffer
 110          *
 111          * \param ctx      HMAC context
 112          * \param input    buffer holding the  data
 113          * \param ilen     length of the input data
 114          */
 115         void md2_hmac_update(md2_context * ctx, const unsigned char *input, int ilen);
 116
 117         /**
 118          * \brief          MD2 HMAC final digest
 119          *
 120          * \param ctx      HMAC context
 121          * \param output   MD2 HMAC checksum result
 122          */
 123         void md2_hmac_finish(md2_context * ctx, unsigned char output[16]);
 124
 125         /**
 126          * \brief          Output = HMAC-MD2( hmac key, input buffer )
 127          *
 128          * \param key      HMAC secret key
 129          * \param keylen   length of the HMAC key
 130          * \param input    buffer holding the  data
 131          * \param ilen     length of the input data
 132          * \param output   HMAC-MD2 result
 133          */
 134         void md2_hmac(const unsigned char *key, int keylen,
 135                       const unsigned char *input, int ilen, unsigned char output[16]);
 136
 137         /**
 138          * \brief          Checkup routine
 139          *
 140          * \return         0 if successful, or 1 if the test failed
 141          */
 142         int md2_self_test(int verbose);
 143
 144 #ifdef __cplusplus
 145 }
 146 #endif
 147 #endif                          /* md2.h */