knuth-lfib.h 2.16 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
/* knuth-lfib.h
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

   The "lagged fibonacci" pseudorandomness generator, described in
   Knuth, TAoCP, 3.6

   This file is part of GNU Nettle.

   GNU Nettle is free software: you can redistribute it and/or
   modify it under the terms of either:

     * the GNU Lesser General Public License as published by the Free
       Software Foundation; either version 3 of the License, or (at your
       option) any later version.

   or

     * the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your
       option) any later version.

   or both in parallel, as here.

   GNU Nettle is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received copies of the GNU General Public License and
   the GNU Lesser General Public License along with this program.  If
   not, see http://www.gnu.org/licenses/.
*/
Niels Möller's avatar
Niels Möller committed
32 33 34 35 36 37 38

/* NOTE: This generator is totally inappropriate for cryptographic
 * applications. It is useful for generating deterministic but
 * random-looking test data, and is used by the Nettle testsuite. */
#ifndef NETTLE_KNUTH_LFIB_H_INCLUDED
#define NETTLE_KNUTH_LFIB_H_INCLUDED

39
#include "nettle-types.h"
Niels Möller's avatar
Niels Möller committed
40

Niels Möller's avatar
Niels Möller committed
41 42 43 44
#ifdef __cplusplus
extern "C" {
#endif

45 46 47 48 49 50
/* Namespace mangling */
#define knuth_lfib_init nettle_knuth_lfib_init
#define knuth_lfib_get nettle_knuth_lfib_get
#define knuth_lfib_get_array nettle_knuth_lfib_get_array
#define knuth_lfib_random nettle_knuth_lfib_random

Niels Möller's avatar
Niels Möller committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
#define _KNUTH_LFIB_KK 100

struct knuth_lfib_ctx
{
  uint32_t x[_KNUTH_LFIB_KK];
  unsigned index;
};

void
knuth_lfib_init(struct knuth_lfib_ctx *ctx, uint32_t seed);

/* Get's a single number in the range 0 ... 2^30-1 */
uint32_t
knuth_lfib_get(struct knuth_lfib_ctx *ctx);

/* Get an array of numbers */
void
knuth_lfib_get_array(struct knuth_lfib_ctx *ctx,
69
		     size_t n, uint32_t *a);
Niels Möller's avatar
Niels Möller committed
70 71 72 73

/* Get an array of octets. */
void
knuth_lfib_random(struct knuth_lfib_ctx *ctx,
74
		  size_t n, uint8_t *dst);
Niels Möller's avatar
Niels Möller committed
75

Niels Möller's avatar
Niels Möller committed
76 77 78 79
#ifdef __cplusplus
}
#endif

Niels Möller's avatar
Niels Möller committed
80
#endif /* NETTLE_KNUTH_LFIB_H_INCLUDED */