aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/utils/randomizer.h
blob: cf6870aa5f7d50c5068ad89bae39b7c7b3bed5be (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
/**
 * @file randomizer.h
 * 
 * @brief Class used to get random and pseudo random values
 * 
 */

/*
 * Copyright (C) 2005 Jan Hutter, Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of 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.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program 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.
 */

#ifndef RANDOMIZER_H_
#define RANDOMIZER_H_

#include "../types.h"

/**
 * Object representing an randomizer
 * 
 * This class is thread save as file system read calls are thread save...
 */
typedef struct randomizer_s randomizer_t;

struct randomizer_s {
	
	/**
	 * @brief Reads a specific number of bytes from random device.
	 * 
	 * @param this 					calling randomizer_t object
	 * @param bytes					Number of bytes to read
	 * @param[out] buffer			Pointer to buffer where to write the data in.
	 * 								Size of buffer has to be at least bytes.
	 * @return
	 * 								- SUCCESS
	 * 								- FAILED
	 */
	status_t (*get_random_bytes) (randomizer_t *this,size_t bytes, u_int8_t *buffer);
	
	/**
	 * @brief Allocates space and writes in random bytes
	 * 
	 * @param this 					calling randomizer_t object
	 * @param bytes					Number of bytes to allocate
	 * @param[out] chunk			chunk which will hold the allocated random bytes
	 * @return
	 * 								- SUCCESS
	 * 								- OUT_OF_RES
	 * 								- FAILED
	 */	
	status_t (*allocate_random_bytes) (randomizer_t *this, size_t bytes, chunk_t *chunk);
	
	/**
	 * @brief Reads a specific number of bytes from pseudo random device.
	 * 
	 * @param this 					calling randomizer_t object
	 * @param bytes					Number of bytes to read
	 * @param[out] buffer			Pointer to buffer where to write the data in.
	 * 								Size of buffer has to be at least bytes.
	 * @return
	 * 								- SUCCESS
	 * 								- FAILED
	 */
	status_t (*get_pseudo_random_bytes) (randomizer_t *this,size_t bytes, u_int8_t *buffer);
	
	/**
	 * @brief Allocates space and writes in pseudo random bytes
	 * 
	 * @param this 					calling randomizer_t object
	 * @param bytes					Number of bytes to allocate
	 * @param[out] chunk			chunk which will hold the allocated random bytes
	 * @return
	 * 								- SUCCESS
	 * 								- OUT_OF_RES
	 * 								- FAILED
	 */	
	status_t (*allocate_pseudo_random_bytes) (randomizer_t *this, size_t bytes, chunk_t *chunk);

	/**
	 * @brief Destroys a randomizer_t object.
	 *
	 * @param this 	randomizer_t object to destroy
	 * @return 		
	 * 				SUCCESS in any case
	 */
	status_t (*destroy) (randomizer_t *this);
};

/**
 * @brief Create an randomizer_t object
 * 
 * @return			
 * 					- created randomizer_t, or
 * 					- NULL if failed
 */
randomizer_t *randomizer_create();

/**
 * @brief Create an randomizer_t object with specific random device names
 * 
 * @param random_dev_name	Device name for random values, etc /dev/random
 * @param prandom_dev_name	Device name for pseudo random values, etc /dev/urandom
 * @return					
 *	 						- created randomizer_t, or
 * 							- NULL if failed
 */
randomizer_t *randomizer_create_on_devices(char * random_dev_name,char * prandom_dev_name);

#endif /*RANDOMIZER_H_*/