tor  0.4.1.0-alpha-dev
crypto_rand.h
Go to the documentation of this file.
1 /* Copyright (c) 2001, Matej Pfajfar.
2  * Copyright (c) 2001-2004, Roger Dingledine.
3  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4  * Copyright (c) 2007-2019, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
6 
13 #ifndef TOR_CRYPTO_RAND_H
14 #define TOR_CRYPTO_RAND_H
15 
16 #include "lib/cc/compat_compiler.h"
17 #include "lib/cc/torint.h"
19 #include "lib/malloc/malloc.h"
20 
21 /* random numbers */
22 int crypto_seed_rng(void) ATTR_WUR;
23 MOCK_DECL(void,crypto_rand,(char *to, size_t n));
24 void crypto_rand_unmocked(char *to, size_t n);
25 void crypto_strongest_rand(uint8_t *out, size_t out_len);
26 MOCK_DECL(void,crypto_strongest_rand_,(uint8_t *out, size_t out_len));
27 int crypto_rand_int(unsigned int max);
28 unsigned crypto_rand_uint(unsigned limit);
29 int crypto_rand_int_range(unsigned int min, unsigned int max);
30 uint64_t crypto_rand_uint64_range(uint64_t min, uint64_t max);
31 time_t crypto_rand_time_range(time_t min, time_t max);
32 uint32_t crypto_rand_u32(void);
33 uint64_t crypto_rand_uint64(uint64_t max);
34 double crypto_rand_double(void);
35 struct tor_weak_rng_t;
36 void crypto_seed_weak_rng(struct tor_weak_rng_t *rng);
37 
38 char *crypto_random_hostname(int min_rand_len, int max_rand_len,
39  const char *prefix, const char *suffix);
40 
41 struct smartlist_t;
42 void *smartlist_choose(const struct smartlist_t *sl);
43 void smartlist_shuffle(struct smartlist_t *sl);
44 int crypto_force_rand_ssleay(void);
45 
60 #define CRYPTO_FAST_RNG_SEED_LEN 48
62 void crypto_fast_rng_getbytes(crypto_fast_rng_t *rng, uint8_t *out, size_t n);
64 #define crypto_fast_rng_free(c) \
65  FREE_AND_NULL(crypto_fast_rng_t, crypto_fast_rng_free_, (c))
66 
67 unsigned crypto_fast_rng_get_uint(crypto_fast_rng_t *rng, unsigned limit);
68 uint64_t crypto_fast_rng_get_uint64(crypto_fast_rng_t *rng, uint64_t limit);
71  uint64_t min, uint64_t max);
73 
80 #define crypto_fast_rng_one_in_n(rng, n) \
81  (0 == (crypto_fast_rng_get_uint((rng), (n))))
82 
84 
85 #ifdef CRYPTO_PRIVATE
86 /* These are only used from crypto_init.c */
87 void destroy_thread_fast_rng(void);
88 void crypto_rand_fast_init(void);
89 void crypto_rand_fast_shutdown(void);
90 #endif
91 
92 #if defined(TOR_UNIT_TESTS)
93 /* Used for white-box testing */
94 size_t crypto_fast_rng_get_bytes_used_per_stream(void);
95 #endif
96 
97 #ifdef CRYPTO_RAND_PRIVATE
98 
99 STATIC int crypto_strongest_rand_raw(uint8_t *out, size_t out_len);
100 
101 #ifdef TOR_UNIT_TESTS
102 extern int break_strongest_rng_syscall;
103 extern int break_strongest_rng_fallback;
104 #endif
105 #endif /* defined(CRYPTO_RAND_PRIVATE) */
106 
107 #endif /* !defined(TOR_CRYPTO_RAND_H) */
uint32_t crypto_rand_u32(void)
Definition: crypto_rand.c:535
char * crypto_random_hostname(int min_rand_len, int max_rand_len, const char *prefix, const char *suffix)
Definition: crypto_rand.c:551
void crypto_rand_fast_shutdown(void)
unsigned crypto_fast_rng_get_uint(crypto_fast_rng_t *rng, unsigned limit)
uint64_t crypto_fast_rng_get_uint64(crypto_fast_rng_t *rng, uint64_t limit)
void crypto_rand_fast_init(void)
int crypto_force_rand_ssleay(void)
Definition: crypto_rand.c:617
double crypto_fast_rng_get_double(crypto_fast_rng_t *rng)
uint64_t crypto_rand_uint64_range(uint64_t min, uint64_t max)
int crypto_rand_int_range(unsigned int min, unsigned int max)
double crypto_rand_double(void)
Integer definitions used throughout Tor.
unsigned crypto_rand_uint(unsigned limit)
Headers for util_malloc.c.
void smartlist_shuffle(struct smartlist_t *sl)
Definition: crypto_rand.c:601
STATIC int crypto_strongest_rand_raw(uint8_t *out, size_t out_len)
Definition: crypto_rand.c:288
Utility macros to handle different features and behavior in different compilers.
void crypto_fast_rng_getbytes(crypto_fast_rng_t *rng, uint8_t *out, size_t n)
int crypto_rand_int(unsigned int max)
uint64_t crypto_fast_rng_uint64_range(crypto_fast_rng_t *rng, uint64_t min, uint64_t max)
uint64_t crypto_rand_uint64(uint64_t max)
crypto_fast_rng_t * crypto_fast_rng_new(void)
void crypto_seed_weak_rng(struct tor_weak_rng_t *rng)
Definition: crypto_rand.c:109
crypto_fast_rng_t * get_thread_fast_rng(void)
void crypto_fast_rng_free_(crypto_fast_rng_t *)
crypto_fast_rng_t * crypto_fast_rng_new_from_seed(const uint8_t *seed)
Macros to implement mocking and selective exposure for the test code.
int crypto_seed_rng(void) ATTR_WUR
Definition: crypto_rand.c:451
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:94
void crypto_strongest_rand(uint8_t *out, size_t out_len)
Definition: crypto_rand.c:339
time_t crypto_rand_time_range(time_t min, time_t max)
uint32_t crypto_fast_rng_get_u32(crypto_fast_rng_t *rng)
void crypto_rand_unmocked(char *to, size_t n)
Definition: crypto_rand.c:489
void * smartlist_choose(const smartlist_t *sl)
Definition: crypto_rand.c:589
void destroy_thread_fast_rng(void)