random: Add finalizer for rndjent.
[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 #define RANDOM_CONF_DISABLE_JENT 1
39 #define RANDOM_CONF_ONLY_URANDOM 2
40
41
42 /*-- random.c --*/
43 unsigned int _gcry_random_read_conf (void);
44 void _gcry_random_progress (const char *what, int printchar,
45                             int current, int total);
46
47
48 /*-- random-csprng.c --*/
49 void _gcry_rngcsprng_initialize (int full);
50 void _gcry_rngcsprng_close_fds (void);
51 void _gcry_rngcsprng_dump_stats (void);
52 void _gcry_rngcsprng_secure_alloc (void);
53 void _gcry_rngcsprng_enable_quick_gen (void);
54 void _gcry_rngcsprng_set_daemon_socket (const char *socketname);
55 int  _gcry_rngcsprng_use_daemon (int onoff);
56 int  _gcry_rngcsprng_is_faked (void);
57 gcry_error_t _gcry_rngcsprng_add_bytes (const void *buf, size_t buflen,
58                                         int quality);
59 void *_gcry_rngcsprng_get_bytes (size_t nbytes,
60                                  enum gcry_random_level level);
61 void *_gcry_rngcsprng_get_bytes_secure (size_t nbytes,
62                                         enum gcry_random_level level);
63 void _gcry_rngcsprng_randomize (void *buffer, size_t length,
64                                 enum gcry_random_level level);
65 void _gcry_rngcsprng_set_seed_file (const char *name);
66 void _gcry_rngcsprng_update_seed_file (void);
67 void _gcry_rngcsprng_fast_poll (void);
68
69 /*-- random-drbg.c --*/
70 void _gcry_rngdrbg_inititialize (int full);
71 void _gcry_rngdrbg_close_fds (void);
72 void _gcry_rngdrbg_dump_stats (void);
73 int  _gcry_rngdrbg_is_faked (void);
74 gcry_error_t _gcry_rngdrbg_add_bytes (const void *buf, size_t buflen,
75                                       int quality);
76 void _gcry_rngdrbg_randomize (void *buffer, size_t length,
77                               enum gcry_random_level level);
78 gcry_error_t _gcry_rngdrbg_selftest (selftest_report_func_t report);
79
80 /*-- random-system.c --*/
81 void _gcry_rngsystem_initialize (int full);
82 void _gcry_rngsystem_close_fds (void);
83 void _gcry_rngsystem_dump_stats (void);
84 int  _gcry_rngsystem_is_faked (void);
85 gcry_error_t _gcry_rngsystem_add_bytes (const void *buf, size_t buflen,
86                                         int quality);
87 void _gcry_rngsystem_randomize (void *buffer, size_t length,
88                                 enum gcry_random_level level);
89
90
91
92 /*-- rndlinux.c --*/
93 int _gcry_rndlinux_gather_random (void (*add) (const void *, size_t,
94                                                enum random_origins),
95                                    enum random_origins origin,
96                                   size_t length, int level);
97
98 /*-- rndunix.c --*/
99 int _gcry_rndunix_gather_random (void (*add) (const void *, size_t,
100                                               enum random_origins),
101                                  enum random_origins origin,
102                                  size_t length, int level);
103
104 /*-- rndegd.c --*/
105 int _gcry_rndegd_gather_random (void (*add) (const void *, size_t,
106                                              enum random_origins),
107                                 enum random_origins origin,
108                                 size_t length, int level);
109 int _gcry_rndegd_connect_socket (int nofail);
110
111 /*-- rndw32.c --*/
112 int _gcry_rndw32_gather_random (void (*add) (const void *, size_t,
113                                              enum random_origins),
114                                 enum random_origins origin,
115                                 size_t length, int level);
116 void _gcry_rndw32_gather_random_fast (void (*add)(const void*, size_t,
117                                                   enum random_origins),
118                                       enum random_origins origin );
119
120 /*-- rndw32ce.c --*/
121 int _gcry_rndw32ce_gather_random (void (*add) (const void *, size_t,
122                                                enum random_origins),
123                                   enum random_origins origin,
124                                   size_t length, int level);
125 void _gcry_rndw32ce_gather_random_fast (void (*add)(const void*, size_t,
126                                                     enum random_origins),
127                                         enum random_origins origin );
128
129 /*-- rndjent.c --*/
130 size_t _gcry_rndjent_poll (void (*add)(const void*,
131                                        size_t, enum random_origins),
132                            enum random_origins origin,
133                            size_t length);
134 void _gcry_rndjent_dump_stats (void);
135 void _gcry_rndjent_fini (void);
136
137 /*-- rndhw.c --*/
138 int _gcry_rndhw_failed_p (void);
139 void _gcry_rndhw_poll_fast (void (*add)(const void*, size_t,
140                                         enum random_origins),
141                             enum random_origins origin);
142 size_t _gcry_rndhw_poll_slow (void (*add)(const void*, size_t,
143                                           enum random_origins),
144                               enum random_origins origin);
145
146
147
148 #endif /*G10_RAND_INTERNAL_H*/