DRBG: fix reseeding via RAND_add()/RAND_seed() with large input
[openssl.git] / crypto / include / internal / rand_int.h
1 /*
2  * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /*
11  * Licensed under the OpenSSL licenses, (the "License");
12  * you may not use this file except in compliance with the License.
13  * You may obtain a copy of the License at
14  * https://www.openssl.org/source/license.html
15  * or in the file LICENSE in the source distribution.
16  */
17
18 #ifndef HEADER_RAND_INT_H
19 # define HEADER_RAND_INT_H
20
21 # include <openssl/rand.h>
22
23 /* forward declaration */
24 typedef struct rand_pool_st RAND_POOL;
25
26 void rand_cleanup_int(void);
27 void rand_drbg_cleanup_int(void);
28 void drbg_delete_thread_state(void);
29 void rand_fork(void);
30
31 /* Hardware-based seeding functions. */
32 size_t rand_acquire_entropy_from_tsc(RAND_POOL *pool);
33 size_t rand_acquire_entropy_from_cpu(RAND_POOL *pool);
34
35 /* DRBG entropy callbacks. */
36 size_t rand_drbg_get_entropy(RAND_DRBG *drbg,
37                              unsigned char **pout,
38                              int entropy, size_t min_len, size_t max_len,
39                              int prediction_resistance);
40 void rand_drbg_cleanup_entropy(RAND_DRBG *drbg,
41                                unsigned char *out, size_t outlen);
42 size_t rand_drbg_get_nonce(RAND_DRBG *drbg,
43                            unsigned char **pout,
44                            int entropy, size_t min_len, size_t max_len);
45 void rand_drbg_cleanup_nonce(RAND_DRBG *drbg,
46                              unsigned char *out, size_t outlen);
47
48 size_t rand_drbg_get_additional_data(unsigned char **pout, size_t max_len);
49
50 void rand_drbg_cleanup_additional_data(unsigned char *out, size_t outlen);
51
52 /*
53  * RAND_POOL functions
54  */
55 RAND_POOL *rand_pool_new(int entropy_requested, size_t min_len, size_t max_len);
56 RAND_POOL *rand_pool_attach(const unsigned char *buffer, size_t len,
57                             size_t entropy);
58 void rand_pool_free(RAND_POOL *pool);
59
60 const unsigned char *rand_pool_buffer(RAND_POOL *pool);
61 unsigned char *rand_pool_detach(RAND_POOL *pool);
62
63 size_t rand_pool_entropy(RAND_POOL *pool);
64 size_t rand_pool_length(RAND_POOL *pool);
65
66 size_t rand_pool_entropy_available(RAND_POOL *pool);
67 size_t rand_pool_entropy_needed(RAND_POOL *pool);
68 /* |entropy_factor| expresses how many bits of data contain 1 bit of entropy */
69 size_t rand_pool_bytes_needed(RAND_POOL *pool, unsigned int entropy_factor);
70 size_t rand_pool_bytes_remaining(RAND_POOL *pool);
71
72 int rand_pool_add(RAND_POOL *pool,
73                   const unsigned char *buffer, size_t len, size_t entropy);
74 unsigned char *rand_pool_add_begin(RAND_POOL *pool, size_t len);
75 int rand_pool_add_end(RAND_POOL *pool, size_t len, size_t entropy);
76
77
78 /*
79  * Add random bytes to the pool to acquire requested amount of entropy
80  *
81  * This function is platform specific and tries to acquire the requested
82  * amount of entropy by polling platform specific entropy sources.
83  *
84  * If the function succeeds in acquiring at least |entropy_requested| bits
85  * of entropy, the total entropy count is returned. If it fails, it returns
86  * an entropy count of 0.
87  */
88 size_t rand_pool_acquire_entropy(RAND_POOL *pool);
89
90 /*
91  * Add some application specific nonce data
92  *
93  * This function is platform specific and adds some application specific
94  * data to the nonce used for instantiating the drbg.
95  *
96  * This data currently consists of the process and thread id, and a high
97  * resolution timestamp. The data does not include an atomic counter,
98  * because that is added by the calling function rand_drbg_get_nonce().
99  *
100  * Returns 1 on success and 0 on failure.
101  */
102 int rand_pool_add_nonce_data(RAND_POOL *pool);
103
104
105 /*
106  * Add some platform specific additional data
107  *
108  * This function is platform specific and adds some random noise to the
109  * additional data used for generating random bytes and for reseeding
110  * the drbg.
111  *
112  * Returns 1 on success and 0 on failure.
113  */
114 int rand_pool_add_additional_data(RAND_POOL *pool);
115
116 /*
117  * Initialise the random pool reseeding sources.
118  *
119  * Returns 1 on success and 0 on failure.
120  */
121 int rand_pool_init(void);
122
123 /*
124  * Finalise the random pool reseeding sources.
125  */
126 void rand_pool_cleanup(void);
127
128 /*
129  * Control the random pool use of open file descriptors.
130  */
131 void rand_pool_keep_random_devices_open(int keep);
132
133 #endif