bertos/sec/hash.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Generic interface for hashing algorithms.
  34  * \author Giovanni Bajo <rasky@develer.com>
  35  *
  36  */
  37
  38 #ifndef SEC_HASH_H
  39 #define SEC_HASH_H
  40
  41 #include <cfg/compiler.h>
  42 #include <cfg/debug.h>
  43
  44 typedef struct Hash
  45 {
  46         void (*begin)(struct Hash *h);
  47         void (*update)(struct Hash *h, const void *data, size_t len);
  48         uint8_t* (*final)(struct Hash *h);
  49         uint8_t digest_len;
  50         uint8_t block_len;
  51 } Hash;
  52
  53 /**
  54  * Initialize a hash computation.
  55  */
  56 INLINE void hash_begin(Hash *h)
  57 {
  58         ASSERT(h->begin);
  59         h->begin(h);
  60 }
  61
  62 /**
  63  * Add some data to the computation.
  64  */
  65 INLINE void hash_update(Hash *h, const void* data, size_t len)
  66 {
  67         ASSERT(h->update);
  68         h->update(h, data, len);
  69 }
  70
  71 /**
  72  * Finalize the hash computation and return the digest.
  73  *
  74  * \note This function must be called exactly once per each computation.
  75  * Calling it twice leads to undefined behaviour.
  76  *
  77  * \note The pointer returned is within the hash context structure \a h, so it
  78  * has the same lifetime as the hash instance. The data will be invalidated
  79  * as soon as \a hash_begin is called again on the same instance.
  80  */
  81 INLINE uint8_t* hash_final(Hash *h)
  82 {
  83         ASSERT(h->final);
  84         return h->final(h);
  85 }
  86
  87 /**
  88  * Return the digest length in bytes.
  89  */
  90 INLINE int hash_digest_len(Hash *h)
  91 {
  92         return h->digest_len;
  93 }
  94
  95 /*
  96  * Return the internal block length in bytes.
  97  *
  98  * Hash functions operate on a fixed-size block. This information is useful
  99  * for composite functions like HMAC to adjust their internal operations.
 100  */
 101 INLINE int hash_block_len(Hash *h)
 102 {
 103         return h->block_len;
 104 }
 105
 106 #endif /* SEC_HASH_H */