bertos/sec/prng.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 cryptographically-secure pseudo-RNG
  34  * \author Giovanni Bajo <rasky@develer.com>
  35  *
  36  */
  37
  38 #ifndef SEC_PRNG_H
  39 #define SEC_PRNG_H
  40
  41 #include <cfg/compiler.h>
  42 #include <cfg/debug.h>
  43
  44 typedef struct PRNG
  45 {
  46     void (*reseed)(struct PRNG *ctx, const uint8_t *seed);
  47     void (*generate)(struct PRNG *ctx, uint8_t *data, size_t len);
  48     size_t seed_len;
  49 } PRNG;
  50
  51 /**
  52  * Feed a new seed into the PRNG.
  53  *
  54  * \note: Being a cryptographically-secure PRNG, the seed will be
  55  * mixed to the current state of the generator, so it is NOT possible
  56  * to generate the same sequence simply by using the same seed. If you
  57  * need such a property, use a normale PRGN like \a rand().
  58  */
  59 INLINE void prng_reseed(PRNG *ctx, const uint8_t *seed)
  60 {
  61     ASSERT(ctx->reseed);
  62     ctx->reseed(ctx, seed);
  63 }
  64
  65 /**
  66  * Get the length of the seed in bytes required by this generator.
  67  */
  68 INLINE size_t prng_seed_len(PRNG *ctx)
  69 {
  70     return ctx->seed_len;
  71 }
  72
  73 /**
  74  * Generate some cryptographically-secure random bytes into the specified
  75  * buffer.
  76  */
  77 INLINE void prng_generate(PRNG *ctx, uint8_t *data, size_t len)
  78 {
  79     ASSERT(ctx->generate);
  80     ctx->generate(ctx, data, len);
  81 }
  82
  83
  84 #endif /* SEC_PRNG_H */