Doug Anson / mbedTLSLibrary

mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

include/polarssl/md2.h@0:137634ff4186, 2015-06-11 (annotated)

Committer:
ansond
Date:
Thu Jun 11 03:27:03 2015 +0000
Revision:
0:137634ff4186
initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:137634ff4186 1 /**
ansond 0:137634ff4186 2 * \file md2.h
ansond 0:137634ff4186 3 *
ansond 0:137634ff4186 4 * \brief MD2 message digest algorithm (hash function)
ansond 0:137634ff4186 5 *
ansond 0:137634ff4186 6 * Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
ansond 0:137634ff4186 7 *
ansond 0:137634ff4186 8 * This file is part of mbed TLS (https://tls.mbed.org)
ansond 0:137634ff4186 9 *
ansond 0:137634ff4186 10 * This program is free software; you can redistribute it and/or modify
ansond 0:137634ff4186 11 * it under the terms of the GNU General Public License as published by
ansond 0:137634ff4186 12 * the Free Software Foundation; either version 2 of the License, or
ansond 0:137634ff4186 13 * (at your option) any later version.
ansond 0:137634ff4186 14 *
ansond 0:137634ff4186 15 * This program is distributed in the hope that it will be useful,
ansond 0:137634ff4186 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ansond 0:137634ff4186 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ansond 0:137634ff4186 18 * GNU General Public License for more details.
ansond 0:137634ff4186 19 *
ansond 0:137634ff4186 20 * You should have received a copy of the GNU General Public License along
ansond 0:137634ff4186 21 * with this program; if not, write to the Free Software Foundation, Inc.,
ansond 0:137634ff4186 22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
ansond 0:137634ff4186 23 */
ansond 0:137634ff4186 24 #ifndef POLARSSL_MD2_H
ansond 0:137634ff4186 25 #define POLARSSL_MD2_H
ansond 0:137634ff4186 26
ansond 0:137634ff4186 27 #if !defined(POLARSSL_CONFIG_FILE)
ansond 0:137634ff4186 28 #include "config.h"
ansond 0:137634ff4186 29 #else
ansond 0:137634ff4186 30 #include POLARSSL_CONFIG_FILE
ansond 0:137634ff4186 31 #endif
ansond 0:137634ff4186 32
ansond 0:137634ff4186 33 #include <stddef.h>
ansond 0:137634ff4186 34
ansond 0:137634ff4186 35 #define POLARSSL_ERR_MD2_FILE_IO_ERROR -0x0070 /**< Read/write error in file. */
ansond 0:137634ff4186 36
ansond 0:137634ff4186 37 #if !defined(POLARSSL_MD2_ALT)
ansond 0:137634ff4186 38 // Regular implementation
ansond 0:137634ff4186 39 //
ansond 0:137634ff4186 40
ansond 0:137634ff4186 41 #ifdef __cplusplus
ansond 0:137634ff4186 42 extern "C" {
ansond 0:137634ff4186 43 #endif
ansond 0:137634ff4186 44
ansond 0:137634ff4186 45 /**
ansond 0:137634ff4186 46 * \brief MD2 context structure
ansond 0:137634ff4186 47 */
ansond 0:137634ff4186 48 typedef struct
ansond 0:137634ff4186 49 {
ansond 0:137634ff4186 50 unsigned char cksum[16]; /*!< checksum of the data block */
ansond 0:137634ff4186 51 unsigned char state[48]; /*!< intermediate digest state */
ansond 0:137634ff4186 52 unsigned char buffer[16]; /*!< data block being processed */
ansond 0:137634ff4186 53
ansond 0:137634ff4186 54 unsigned char ipad[16]; /*!< HMAC: inner padding */
ansond 0:137634ff4186 55 unsigned char opad[16]; /*!< HMAC: outer padding */
ansond 0:137634ff4186 56 size_t left; /*!< amount of data in buffer */
ansond 0:137634ff4186 57 }
ansond 0:137634ff4186 58 md2_context;
ansond 0:137634ff4186 59
ansond 0:137634ff4186 60 /**
ansond 0:137634ff4186 61 * \brief Initialize MD2 context
ansond 0:137634ff4186 62 *
ansond 0:137634ff4186 63 * \param ctx MD2 context to be initialized
ansond 0:137634ff4186 64 */
ansond 0:137634ff4186 65 void md2_init( md2_context *ctx );
ansond 0:137634ff4186 66
ansond 0:137634ff4186 67 /**
ansond 0:137634ff4186 68 * \brief Clear MD2 context
ansond 0:137634ff4186 69 *
ansond 0:137634ff4186 70 * \param ctx MD2 context to be cleared
ansond 0:137634ff4186 71 */
ansond 0:137634ff4186 72 void md2_free( md2_context *ctx );
ansond 0:137634ff4186 73
ansond 0:137634ff4186 74 /**
ansond 0:137634ff4186 75 * \brief MD2 context setup
ansond 0:137634ff4186 76 *
ansond 0:137634ff4186 77 * \param ctx context to be initialized
ansond 0:137634ff4186 78 */
ansond 0:137634ff4186 79 void md2_starts( md2_context *ctx );
ansond 0:137634ff4186 80
ansond 0:137634ff4186 81 /**
ansond 0:137634ff4186 82 * \brief MD2 process buffer
ansond 0:137634ff4186 83 *
ansond 0:137634ff4186 84 * \param ctx MD2 context
ansond 0:137634ff4186 85 * \param input buffer holding the data
ansond 0:137634ff4186 86 * \param ilen length of the input data
ansond 0:137634ff4186 87 */
ansond 0:137634ff4186 88 void md2_update( md2_context *ctx, const unsigned char *input, size_t ilen );
ansond 0:137634ff4186 89
ansond 0:137634ff4186 90 /**
ansond 0:137634ff4186 91 * \brief MD2 final digest
ansond 0:137634ff4186 92 *
ansond 0:137634ff4186 93 * \param ctx MD2 context
ansond 0:137634ff4186 94 * \param output MD2 checksum result
ansond 0:137634ff4186 95 */
ansond 0:137634ff4186 96 void md2_finish( md2_context *ctx, unsigned char output[16] );
ansond 0:137634ff4186 97
ansond 0:137634ff4186 98 #ifdef __cplusplus
ansond 0:137634ff4186 99 }
ansond 0:137634ff4186 100 #endif
ansond 0:137634ff4186 101
ansond 0:137634ff4186 102 #else /* POLARSSL_MD2_ALT */
ansond 0:137634ff4186 103 #include "md2_alt.h"
ansond 0:137634ff4186 104 #endif /* POLARSSL_MD2_ALT */
ansond 0:137634ff4186 105
ansond 0:137634ff4186 106 #ifdef __cplusplus
ansond 0:137634ff4186 107 extern "C" {
ansond 0:137634ff4186 108 #endif
ansond 0:137634ff4186 109
ansond 0:137634ff4186 110 /**
ansond 0:137634ff4186 111 * \brief Output = MD2( input buffer )
ansond 0:137634ff4186 112 *
ansond 0:137634ff4186 113 * \param input buffer holding the data
ansond 0:137634ff4186 114 * \param ilen length of the input data
ansond 0:137634ff4186 115 * \param output MD2 checksum result
ansond 0:137634ff4186 116 */
ansond 0:137634ff4186 117 void md2( const unsigned char *input, size_t ilen, unsigned char output[16] );
ansond 0:137634ff4186 118
ansond 0:137634ff4186 119 /**
ansond 0:137634ff4186 120 * \brief Output = MD2( file contents )
ansond 0:137634ff4186 121 *
ansond 0:137634ff4186 122 * \param path input file name
ansond 0:137634ff4186 123 * \param output MD2 checksum result
ansond 0:137634ff4186 124 *
ansond 0:137634ff4186 125 * \return 0 if successful, or POLARSSL_ERR_MD2_FILE_IO_ERROR
ansond 0:137634ff4186 126 */
ansond 0:137634ff4186 127 int md2_file( const char *path, unsigned char output[16] );
ansond 0:137634ff4186 128
ansond 0:137634ff4186 129 /**
ansond 0:137634ff4186 130 * \brief MD2 HMAC context setup
ansond 0:137634ff4186 131 *
ansond 0:137634ff4186 132 * \param ctx HMAC context to be initialized
ansond 0:137634ff4186 133 * \param key HMAC secret key
ansond 0:137634ff4186 134 * \param keylen length of the HMAC key
ansond 0:137634ff4186 135 */
ansond 0:137634ff4186 136 void md2_hmac_starts( md2_context *ctx, const unsigned char *key,
ansond 0:137634ff4186 137 size_t keylen );
ansond 0:137634ff4186 138
ansond 0:137634ff4186 139 /**
ansond 0:137634ff4186 140 * \brief MD2 HMAC process buffer
ansond 0:137634ff4186 141 *
ansond 0:137634ff4186 142 * \param ctx HMAC context
ansond 0:137634ff4186 143 * \param input buffer holding the data
ansond 0:137634ff4186 144 * \param ilen length of the input data
ansond 0:137634ff4186 145 */
ansond 0:137634ff4186 146 void md2_hmac_update( md2_context *ctx, const unsigned char *input,
ansond 0:137634ff4186 147 size_t ilen );
ansond 0:137634ff4186 148
ansond 0:137634ff4186 149 /**
ansond 0:137634ff4186 150 * \brief MD2 HMAC final digest
ansond 0:137634ff4186 151 *
ansond 0:137634ff4186 152 * \param ctx HMAC context
ansond 0:137634ff4186 153 * \param output MD2 HMAC checksum result
ansond 0:137634ff4186 154 */
ansond 0:137634ff4186 155 void md2_hmac_finish( md2_context *ctx, unsigned char output[16] );
ansond 0:137634ff4186 156
ansond 0:137634ff4186 157 /**
ansond 0:137634ff4186 158 * \brief MD2 HMAC context reset
ansond 0:137634ff4186 159 *
ansond 0:137634ff4186 160 * \param ctx HMAC context to be reset
ansond 0:137634ff4186 161 */
ansond 0:137634ff4186 162 void md2_hmac_reset( md2_context *ctx );
ansond 0:137634ff4186 163
ansond 0:137634ff4186 164 /**
ansond 0:137634ff4186 165 * \brief Output = HMAC-MD2( hmac key, input buffer )
ansond 0:137634ff4186 166 *
ansond 0:137634ff4186 167 * \param key HMAC secret key
ansond 0:137634ff4186 168 * \param keylen length of the HMAC key
ansond 0:137634ff4186 169 * \param input buffer holding the data
ansond 0:137634ff4186 170 * \param ilen length of the input data
ansond 0:137634ff4186 171 * \param output HMAC-MD2 result
ansond 0:137634ff4186 172 */
ansond 0:137634ff4186 173 void md2_hmac( const unsigned char *key, size_t keylen,
ansond 0:137634ff4186 174 const unsigned char *input, size_t ilen,
ansond 0:137634ff4186 175 unsigned char output[16] );
ansond 0:137634ff4186 176
ansond 0:137634ff4186 177 /**
ansond 0:137634ff4186 178 * \brief Checkup routine
ansond 0:137634ff4186 179 *
ansond 0:137634ff4186 180 * \return 0 if successful, or 1 if the test failed
ansond 0:137634ff4186 181 */
ansond 0:137634ff4186 182 int md2_self_test( int verbose );
ansond 0:137634ff4186 183
ansond 0:137634ff4186 184 /* Internal use */
ansond 0:137634ff4186 185 void md2_process( md2_context *ctx );
ansond 0:137634ff4186 186
ansond 0:137634ff4186 187 #ifdef __cplusplus
ansond 0:137634ff4186 188 }
ansond 0:137634ff4186 189 #endif
ansond 0:137634ff4186 190
ansond 0:137634ff4186 191 #endif /* md2.h */
ansond 0:137634ff4186 192