/** * \file md.h * * \brief Generic message digest wrapper * * \author Adriaan de Jong * * Copyright (C) 2006-2014, ARM Limited, All Rights Reserved * * This file is part of mbed TLS (https://tls.mbed.org) * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #ifndef POLARSSL_MD_H #define POLARSSL_MD_H #include #if !defined(POLARSSL_CONFIG_FILE) #include "config.h" #else #include POLARSSL_CONFIG_FILE #endif #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \ !defined(inline) && !defined(__cplusplus) #define inline __inline #endif #define POLARSSL_ERR_MD_FEATURE_UNAVAILABLE -0x5080 /**< The selected feature is not available. */ #define POLARSSL_ERR_MD_BAD_INPUT_DATA -0x5100 /**< Bad input parameters to function. */ #define POLARSSL_ERR_MD_ALLOC_FAILED -0x5180 /**< Failed to allocate memory. */ #define POLARSSL_ERR_MD_FILE_IO_ERROR -0x5200 /**< Opening or reading of file failed. */ #ifdef __cplusplus extern "C" { #endif typedef enum { POLARSSL_MD_NONE=0, POLARSSL_MD_MD2, POLARSSL_MD_MD4, POLARSSL_MD_MD5, POLARSSL_MD_SHA1, POLARSSL_MD_SHA224, POLARSSL_MD_SHA256, POLARSSL_MD_SHA384, POLARSSL_MD_SHA512, POLARSSL_MD_RIPEMD160, } md_type_t; #if defined(POLARSSL_SHA512_C) #define POLARSSL_MD_MAX_SIZE 64 /* longest known is SHA512 */ #else #define POLARSSL_MD_MAX_SIZE 32 /* longest known is SHA256 or less */ #endif /** * Message digest information. Allows message digest functions to be called * in a generic way. */ typedef struct { /** Digest identifier */ md_type_t type; /** Name of the message digest */ const char * name; /** Output length of the digest function */ int size; /** Digest initialisation function */ void (*starts_func)( void *ctx ); /** Digest update function */ void (*update_func)( void *ctx, const unsigned char *input, size_t ilen ); /** Digest finalisation function */ void (*finish_func)( void *ctx, unsigned char *output ); /** Generic digest function */ void (*digest_func)( const unsigned char *input, size_t ilen, unsigned char *output ); /** Generic file digest function */ int (*file_func)( const char *path, unsigned char *output ); /** HMAC Initialisation function */ void (*hmac_starts_func)( void *ctx, const unsigned char *key, size_t keylen ); /** HMAC update function */ void (*hmac_update_func)( void *ctx, const unsigned char *input, size_t ilen ); /** HMAC finalisation function */ void (*hmac_finish_func)( void *ctx, unsigned char *output); /** HMAC context reset function */ void (*hmac_reset_func)( void *ctx ); /** Generic HMAC function */ void (*hmac_func)( const unsigned char *key, size_t keylen, const unsigned char *input, size_t ilen, unsigned char *output ); /** Allocate a new context */ void * (*ctx_alloc_func)( void ); /** Free the given context */ void (*ctx_free_func)( void *ctx ); /** Internal use only */ void (*process_func)( void *ctx, const unsigned char *input ); } md_info_t; /** * Generic message digest context. */ typedef struct { /** Information about the associated message digest */ const md_info_t *md_info; /** Digest-specific context */ void *md_ctx; } md_context_t; #define MD_CONTEXT_T_INIT { \ NULL, /* md_info */ \ NULL, /* md_ctx */ \ } /** * \brief Returns the list of digests supported by the generic digest module. * * \return a statically allocated array of digests, the last entry * is 0. */ const int *md_list( void ); /** * \brief Returns the message digest information associated with the * given digest name. * * \param md_name Name of the digest to search for. * * \return The message digest information associated with md_name or * NULL if not found. */ const md_info_t *md_info_from_string( const char *md_name ); /** * \brief Returns the message digest information associated with the * given digest type. * * \param md_type type of digest to search for. * * \return The message digest information associated with md_type or * NULL if not found. */ const md_info_t *md_info_from_type( md_type_t md_type ); /** * \brief Initialize a md_context (as NONE) */ void md_init( md_context_t *ctx ); /** * \brief Free and clear the message-specific context of ctx. * Freeing ctx itself remains the responsibility of the * caller. */ void md_free( md_context_t *ctx ); /** * \brief Initialises and fills the message digest context structure * with the appropriate values. * * \note Currently also clears structure. In future versions you * will be required to call md_init() on the structure * first. * * \param ctx context to initialise. May not be NULL. The * digest-specific context (ctx->md_ctx) must be NULL. It will * be allocated, and must be freed using md_free_ctx() later. * \param md_info message digest to use. * * \returns \c 0 on success, \c POLARSSL_ERR_MD_BAD_INPUT_DATA on * parameter failure, \c POLARSSL_ERR_MD_ALLOC_FAILED if * allocation of the digest-specific context failed. */ int md_init_ctx( md_context_t *ctx, const md_info_t *md_info ); #if ! defined(POLARSSL_DEPRECATED_REMOVED) #if defined(POLARSSL_DEPRECATED_WARNING) #define DEPRECATED __attribute__((deprecated)) #else #define DEPRECATED #endif /** * \brief Free the message-specific context of ctx. Freeing ctx itself * remains the responsibility of the caller. * * \deprecated Use md_free() instead * * \param ctx Free the message-specific context * * \returns 0 */ int md_free_ctx( md_context_t *ctx ) DEPRECATED; #undef DEPRECATED #endif /* POLARSSL_DEPRECATED_REMOVED */ /** * \brief Returns the size of the message digest output. * * \param md_info message digest info * * \return size of the message digest output. */ static inline unsigned char md_get_size( const md_info_t *md_info ) { if( md_info == NULL ) return( 0 ); return md_info->size; } /** * \brief Returns the type of the message digest output. * * \param md_info message digest info * * \return type of the message digest output. */ static inline md_type_t md_get_type( const md_info_t *md_info ) { if( md_info == NULL ) return( POLARSSL_MD_NONE ); return md_info->type; } /** * \brief Returns the name of the message digest output. * * \param md_info message digest info * * \return name of the message digest output. */ static inline const char *md_get_name( const md_info_t *md_info ) { if( md_info == NULL ) return( NULL ); return md_info->name; } /** * \brief Set-up the given context for a new message digest * * \param ctx generic message digest context. * * \returns 0 on success, POLARSSL_ERR_MD_BAD_INPUT_DATA if parameter * verification fails. */ int md_starts( md_context_t *ctx ); /** * \brief Generic message digest process buffer * * \param ctx Generic message digest context * \param input buffer holding the datal * \param ilen length of the input data * * \returns 0 on success, POLARSSL_ERR_MD_BAD_INPUT_DATA if parameter * verification fails. */ int md_update( md_context_t *ctx, const unsigned char *input, size_t ilen ); /** * \brief Generic message digest final digest * * \param ctx Generic message digest context * \param output Generic message digest checksum result * * \returns 0 on success, POLARSSL_ERR_MD_BAD_INPUT_DATA if parameter * verification fails. */ int md_finish( md_context_t *ctx, unsigned char *output ); /** * \brief Output = message_digest( input buffer ) * * \param md_info message digest info * \param input buffer holding the data * \param ilen length of the input data * \param output Generic message digest checksum result * * \returns 0 on success, POLARSSL_ERR_MD_BAD_INPUT_DATA if parameter * verification fails. */ int md( const md_info_t *md_info, const unsigned char *input, size_t ilen, unsigned char *output ); /** * \brief Output = message_digest( file contents ) * * \param md_info message digest info * \param path input file name * \param output generic message digest checksum result * * \return 0 if successful, POLARSSL_ERR_MD_FILE_OPEN_FAILED if fopen * failed, POLARSSL_ERR_MD_FILE_READ_FAILED if fread failed, * POLARSSL_ERR_MD_BAD_INPUT_DATA if md_info was NULL. */ int md_file( const md_info_t *md_info, const char *path, unsigned char *output ); /** * \brief Generic HMAC context setup * * \param ctx HMAC context to be initialized * \param key HMAC secret key * \param keylen length of the HMAC key * * \returns 0 on success, POLARSSL_ERR_MD_BAD_INPUT_DATA if parameter * verification fails. */ int md_hmac_starts( md_context_t *ctx, const unsigned char *key, size_t keylen ); /** * \brief Generic HMAC process buffer * * \param ctx HMAC context * \param input buffer holding the data * \param ilen length of the input data * * \returns 0 on success, POLARSSL_ERR_MD_BAD_INPUT_DATA if parameter * verification fails. */ int md_hmac_update( md_context_t *ctx, const unsigned char *input, size_t ilen ); /** * \brief Generic HMAC final digest * * \param ctx HMAC context * \param output Generic HMAC checksum result * * \returns 0 on success, POLARSSL_ERR_MD_BAD_INPUT_DATA if parameter * verification fails. */ int md_hmac_finish( md_context_t *ctx, unsigned char *output); /** * \brief Generic HMAC context reset * * \param ctx HMAC context to be reset * * \returns 0 on success, POLARSSL_ERR_MD_BAD_INPUT_DATA if parameter * verification fails. */ int md_hmac_reset( md_context_t *ctx ); /** * \brief Output = Generic_HMAC( hmac key, input buffer ) * * \param md_info message digest info * \param key HMAC secret key * \param keylen length of the HMAC key * \param input buffer holding the data * \param ilen length of the input data * \param output Generic HMAC-result * * \returns 0 on success, POLARSSL_ERR_MD_BAD_INPUT_DATA if parameter * verification fails. */ int md_hmac( const md_info_t *md_info, const unsigned char *key, size_t keylen, const unsigned char *input, size_t ilen, unsigned char *output ); /* Internal use */ int md_process( md_context_t *ctx, const unsigned char *data ); #ifdef __cplusplus } #endif #endif /* POLARSSL_MD_H */