random: Add a feature to close device file descriptors.
[libgcrypt.git] / random / rand-internal.h
1 /* rand-internal.h - header to glue the random functions
2  *      Copyright (C) 1998, 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser general Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt 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 Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef G10_RAND_INTERNAL_H
21 #define G10_RAND_INTERNAL_H
22
23 #include "../src/cipher-proto.h"
24
25 /* Constants used to define the origin of random added to the pool.
26    The code is sensitive to the order of the values.  */
27 enum random_origins
28   {
29     RANDOM_ORIGIN_INIT = 0,      /* Used only for initialization. */
30     RANDOM_ORIGIN_EXTERNAL = 1,  /* Added from an external source.  */
31     RANDOM_ORIGIN_FASTPOLL = 2,  /* Fast random poll function.  */
32     RANDOM_ORIGIN_SLOWPOLL = 3,  /* Slow poll function.  */
33     RANDOM_ORIGIN_EXTRAPOLL = 4  /* Used to mark an extra pool seed
34                                     due to a GCRY_VERY_STRONG_RANDOM
35                                     random request.  */
36   };
37
38
39
40 /*-- random.c --*/
41 void _gcry_random_progress (const char *what, int printchar,
42                             int current, int total);
43
44
45 /*-- random-csprng.c --*/
46 void _gcry_rngcsprng_initialize (int full);
47 void _gcry_rngcsprng_close_fds (void);
48 void _gcry_rngcsprng_dump_stats (void);
49 void _gcry_rngcsprng_secure_alloc (void);
50 void _gcry_rngcsprng_enable_quick_gen (void);
51 void _gcry_rngcsprng_set_daemon_socket (const char *socketname);
52 int  _gcry_rngcsprng_use_daemon (int onoff);
53 int  _gcry_rngcsprng_is_faked (void);
54 gcry_error_t _gcry_rngcsprng_add_bytes (const void *buf, size_t buflen,
55                                         int quality);
56 void *_gcry_rngcsprng_get_bytes (size_t nbytes,
57                                  enum gcry_random_level level);
58 void *_gcry_rngcsprng_get_bytes_secure (size_t nbytes,
59                                         enum gcry_random_level level);
60 void _gcry_rngcsprng_randomize (void *buffer, size_t length,
61                                 enum gcry_random_level level);
62 void _gcry_rngcsprng_set_seed_file (const char *name);
63 void _gcry_rngcsprng_update_seed_file (void);
64 void _gcry_rngcsprng_fast_poll (void);
65
66 /*-- random-fips.c --*/
67 void _gcry_rngfips_initialize (int full);
68 void _gcry_rngfips_close_fds (void);
69 void _gcry_rngfips_dump_stats (void);
70 int  _gcry_rngfips_is_faked (void);
71 gcry_error_t _gcry_rngfips_add_bytes (const void *buf, size_t buflen,
72                                         int quality);
73 void _gcry_rngfips_randomize (void *buffer, size_t length,
74                                 enum gcry_random_level level);
75 void _gcry_rngfips_create_nonce (void *buffer, size_t length);
76
77 gcry_error_t _gcry_rngfips_selftest (selftest_report_func_t report);
78
79 gcry_err_code_t _gcry_rngfips_init_external_test (void **r_context,
80                                                   unsigned int flags,
81                                                   const void *key,
82                                                   size_t keylen,
83                                                   const void *seed,
84                                                   size_t seedlen,
85                                                   const void *dt,
86                                                   size_t dtlen);
87 gcry_err_code_t _gcry_rngfips_run_external_test (void *context,
88                                                  char *buffer, size_t buflen);
89 void _gcry_rngfips_deinit_external_test (void *context);
90
91
92 /*-- random-system.c --*/
93 void _gcry_rngsystem_initialize (int full);
94 void _gcry_rngsystem_close_fds (void);
95 void _gcry_rngsystem_dump_stats (void);
96 int  _gcry_rngsystem_is_faked (void);
97 gcry_error_t _gcry_rngsystem_add_bytes (const void *buf, size_t buflen,
98                                         int quality);
99 void _gcry_rngsystem_randomize (void *buffer, size_t length,
100                                 enum gcry_random_level level);
101
102
103
104 /*-- rndlinux.c --*/
105 int _gcry_rndlinux_gather_random (void (*add) (const void *, size_t,
106                                                enum random_origins),
107                                    enum random_origins origin,
108                                   size_t length, int level);
109
110 /*-- rndunix.c --*/
111 int _gcry_rndunix_gather_random (void (*add) (const void *, size_t,
112                                               enum random_origins),
113                                  enum random_origins origin,
114                                  size_t length, int level);
115
116 /*-- rndelg.c --*/
117 int _gcry_rndegd_gather_random (void (*add) (const void *, size_t,
118                                              enum random_origins),
119                                 enum random_origins origin,
120                                 size_t length, int level);
121 int _gcry_rndegd_connect_socket (int nofail);
122
123 /*-- rndw32.c --*/
124 int _gcry_rndw32_gather_random (void (*add) (const void *, size_t,
125                                              enum random_origins),
126                                 enum random_origins origin,
127                                 size_t length, int level);
128 void _gcry_rndw32_gather_random_fast (void (*add)(const void*, size_t,
129                                                   enum random_origins),
130                                       enum random_origins origin );
131
132 /*-- rndw32ce.c --*/
133 int _gcry_rndw32ce_gather_random (void (*add) (const void *, size_t,
134                                                enum random_origins),
135                                   enum random_origins origin,
136                                   size_t length, int level);
137 void _gcry_rndw32ce_gather_random_fast (void (*add)(const void*, size_t,
138                                                     enum random_origins),
139                                         enum random_origins origin );
140
141 /*-- rndhw.c --*/
142 int _gcry_rndhw_failed_p (void);
143 void _gcry_rndhw_poll_fast (void (*add)(const void*, size_t,
144                                         enum random_origins),
145                             enum random_origins origin);
146 size_t _gcry_rndhw_poll_slow (void (*add)(const void*, size_t,
147                                           enum random_origins),
148                               enum random_origins origin);
149
150
151
152 #endif /*G10_RAND_INTERNAL_H*/