Source/lib/crypto/prfs/hmac_prf.h

   1 /**
   2  * @file hmac_prf.h
   3  *
   4  * @brief Interface of hmac_prf_t.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005 Jan Hutter, Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef PRF_HMAC_H_
  24 #define PRF_HMAC_H_
  25
  26 #include <types.h>
  27 #include <crypto/prfs/prf.h>
  28 #include <crypto/hashers/hasher.h>
  29
  30 typedef struct hmac_prf_t hmac_prf_t;
  31
  32 /**
  33  * @brief Implementation of prf_t interface using the
  34  * HMAC algorithm.
  35  *
  36  * This simply wraps a hmac_t in a prf_t. More a question of
  37  * interface matching.
  38  *
  39  * @b Constructors:
  40  *  - hmac_prf_create()
  41  *
  42  * @ingroup prfs
  43  */
  44 struct hmac_prf_t {
  45
  46         /**
  47          * Generic prf_t interface for this hmac_prf_t class.
  48          */
  49         prf_t prf_interface;
  50 };
  51
  52 /**
  53  * @brief Creates a new hmac_prf_t object.
  54  *
  55  * @param hash_algorithm        hmac's hash algorithm
  56  * @return
  57  *                                                      - hmac_prf_t object
  58  *                                                      - NULL if hash not supported
  59  *
  60  * @ingroup prfs
  61  */
  62 hmac_prf_t *hmac_prf_create(hash_algorithm_t hash_algorithm);
  63
  64 #endif /*PRF_HMAC_SHA1_H_*/