bertos/sec/kdf.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 key derivation functions.
  34  * \author Giovanni Bajo <rasky@develer.com>
  35  *
  36  */
  37
  38 #ifndef SEC_KDF_H
  39 #define SEC_KDF_H
  40
  41 #include <cfg/compiler.h>
  42 #include <cfg/macros.h>
  43 #include <cfg/debug.h>
  44 #include <string.h>
  45
  46 typedef struct Kdf
  47 {
  48         const uint8_t* block;
  49         size_t block_len;
  50         size_t to_read;
  51
  52         void (*begin)(struct Kdf *kdf, const char *pwd, size_t pwd_len,
  53                                   const uint8_t *salt, size_t salt_len);
  54         void (*next)(struct Kdf *kdf);
  55 } Kdf;
  56
  57 /**
  58  * Initialize the key derivation function, with the specified \a password and \a salt.
  59  */
  60 INLINE void kdf_begin(Kdf *kdf, const char *pwd, size_t pwd_len,
  61                                           const uint8_t *salt, size_t salt_len)
  62 {
  63         ASSERT(kdf->begin);
  64         kdf->begin(kdf, pwd, pwd_len, salt, salt_len);
  65 }
  66
  67 /**
  68  * Extract \a len derived bytes into the \a out buffer.
  69  *
  70  * After having initialized the derivation function iwth \a kdf_begin, you can call
  71  * this function multiple times, to produce several batches of derived data.
  72  *
  73  * \note Some algorithms implementing this API might have a maximum length of bytes
  74  * that can be derived, after which they will simply ASSERT().
  75  */
  76 INLINE void kdf_read(Kdf *kdf, uint8_t *out, size_t len)
  77 {
  78         do
  79         {
  80                 if (kdf->to_read == 0)
  81                 {
  82                         kdf->next(kdf);
  83                         ASSERT(kdf->to_read != 0);
  84                 }
  85
  86                 size_t c = MIN(len, kdf->to_read);
  87                 memcpy(out, kdf->block, c);
  88                 len -= c;
  89                 out += c;
  90                 kdf->block += c;
  91                 kdf->to_read -= c;
  92         } while (len);
  93 }
  94
  95 #endif /* SEC_KDF_H */