Source/charon/transforms/prfs/prf_hmac.h

   1 /**
   2  * @file prf_hmac.h
   3  *
   4  * @brief Interface for prf_hmac_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 <transforms/prfs/prf.h>
  28 #include <transforms/hashers/hasher.h>
  29
  30 typedef struct prf_hmac_t prf_hmac_t;
  31
  32 /**
  33  * @brief Implementation of prf_t interface using the
  34  * a HMAC algorithm.
  35  *
  36  * This simply wraps a hmac_t in a prf_t. More a question of
  37  * interface matchig.
  38  *
  39  * @ingroup prfs
  40  */
  41 struct prf_hmac_t {
  42
  43         /**
  44          * Generic prf_t interface for this prf_hmac_t class.
  45          */
  46         prf_t prf_interface;
  47 };
  48
  49 /**
  50  * @brief Creates a new prf_hmac_t object
  51  *
  52  * @param hash_algorithm                        hmac's hash algorithm
  53  * @return
  54  *                                                                      - prf_hmac_t if successfully
  55  *                                                                      - NULL if out of ressources
  56  *
  57  * @ingroup prfs
  58  */
  59 prf_hmac_t *prf_hmac_create(hash_algorithm_t hash_algorithm);
  60
  61 #endif /*PRF_HMAC_SHA1_H_*/