1
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/** \file
* \brief The pseudorandom number generator interface
*/
/*
* Copyright (c) 2019-2021 David Timber <mieabby@gmail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#pragma once
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
/**
* \brief The fixed byte length of the seed data for WELL512
*/
#define PRNE_RND_WELL512_SEEDLEN 64
/**
* \brief The PRNG engine object
*/
struct prne_rnd {
void *ctx; // The opaque context
void (*free_ctx_f)(void*); // The function for freeing the opaque context
// The generator function
bool (*random)(void*, uint8_t *buf, size_t len);
};
/* Aliases and forward declarations */
typedef struct prne_rnd prne_rnd_t;
/**
* \brief Initialise the PRNG engine object
* \note Initialises the members of \p p to initial values. Prepares \p p so
* that it can be freed using \c prne_free_rnd()
*/
void prne_init_rnd (prne_rnd_t *p);
/**
* \brief Free the resources allocated for the PRNG engine object
* \param p The pointer to the object that has been initialised using
* \c prne_init_rnd()
*/
void prne_free_rnd (prne_rnd_t *p);
/**
* \brief Generate random numbers using the engine
* \param p The pointer to the engine object
* \param[out] buf The buffer for random number output
* \param len The requested byte length of random numbers
* \retval true on success
* \retval false on failure. The underlying engine may set \c errno to describe
* the nature of the error
*/
bool prne_rnd (prne_rnd_t *p, uint8_t *buf, const size_t len);
/**
* \brief Allocate resources to set up the object as an instance of the WELL512
* PRNG engine
* \param p The poiner to the object
* \param is The seed data. Must be 64 bytes(512 bits) or more
* \retval true on success
* \retval false on memory allocation failure, \c errno set to \c ENOMEM
*/
bool prne_rnd_alloc_well512 (
prne_rnd_t *p,
const uint8_t *is);
|
