summaryrefslogtreecommitdiff
path: root/support/dktools/dk-pwg-rnd.h
blob: 41402971033235df65138fc4e15ed4f86dfdd4dc (plain)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/*
	WARNING: This file was generated by dkct.
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk-pwg-rnd.ctr
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef DK_PWG_RND_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK_PWG_RND_H_INCLUDED 1


#line 10 "dk-pwg-rnd.ctr"

/**	@file	dk4rnd.h	Random number generation.

NOT A GOOD IDEA: WE EITHER NEED CRYPTOGRAPHICALLY STRONG RANDOM DATA
OR LIGHTWEIGHT RANDOM DATA FOR GAMES OR SIMULATIONS.
ONE SIZE DOESN'T FIT ALL!
*/


#ifdef __cplusplus
extern "C" {
#endif

/**	Retrieve PRNG type.
	@return	PRNG type.
*/
int
dk4rnd_get_prng_type(void);

/**	Initialize (seed) PRNG.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_NOT_FOUND<br>
	  if the function failed to obtain seed data.
*/
int
dk4rnd_init(dk4_er_t *erp);

/**	Retrieve random bytes.
	@param	bptr	Pointer to destination buffer.
	@param	bs	Destination buffer size.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if bptr is NULL or bs is either 0 or too large,
	- DK4_E_SYNTAX<br>
	  if the PRNG was not yet initialized successfully,
	- DK4_E_NOT_FOUND<br>
	  if the function failed to obtain random data.
*/
int
dk4rnd_get_data(void *bptr, size_t bs, dk4_er_t *erp);

/**	Clean up PRNG.
*/
void
dk4rnd_cleanup(void);

#ifdef __cplusplus
}
#endif

/**	Random number generators.
*/
enum {
			/**	Use rand() function.
			*/
  DK4_PRNG_SIMPLE	=	1,

			/**	Use nrand48() function.
			*/
  DK4_PRNG_RAND48	=	2,

			/**	Use initstate()/setstate() functions.
			*/
  DK4_PRNG_STATE	=	4,

			/**	Use OpenSSL PRNG.
			*/
  DK4_PRNG_OPENSSL	=	8,

			/**	All the PRNGs above.
			*/
  DK4_PRNG_ALL		=	(
  					DK4_PRNG_SIMPLE
					| DK4_PRNG_RAND48
					| DK4_PRNG_STATE
					| DK4_PRNG_OPENSSL
  				)

};


#endif