CTR, HASH and HMAC DRBGs in provider
[openssl.git] / crypto / rand / rand_lib.c
1 /*
2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (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 #include <stdio.h>
11 #include <time.h>
12 #include "internal/cryptlib.h"
13 #include <openssl/opensslconf.h>
14 #include "crypto/rand.h"
15 #include <openssl/engine.h>
16 #include "internal/thread_once.h"
17 #include "rand_local.h"
18 #include "e_os.h"
19
20 #ifndef FIPS_MODULE
21 # include "prov/rand_pool.h"
22 # include "prov/seeding.h"
23
24 # ifndef OPENSSL_NO_ENGINE
25 /* non-NULL if default_RAND_meth is ENGINE-provided */
26 static ENGINE *funct_ref;
27 static CRYPTO_RWLOCK *rand_engine_lock;
28 # endif
29 static CRYPTO_RWLOCK *rand_meth_lock;
30 static const RAND_METHOD *default_RAND_meth;
31 static CRYPTO_ONCE rand_init = CRYPTO_ONCE_STATIC_INIT;
32
33 static int rand_inited = 0;
34
35 DEFINE_RUN_ONCE_STATIC(do_rand_init)
36 {
37 # ifndef OPENSSL_NO_ENGINE
38     rand_engine_lock = CRYPTO_THREAD_lock_new();
39     if (rand_engine_lock == NULL)
40         return 0;
41 # endif
42
43     rand_meth_lock = CRYPTO_THREAD_lock_new();
44     if (rand_meth_lock == NULL)
45         goto err;
46
47     if (!rand_pool_init())
48         goto err;
49
50     rand_inited = 1;
51     return 1;
52
53  err:
54     CRYPTO_THREAD_lock_free(rand_meth_lock);
55     rand_meth_lock = NULL;
56 # ifndef OPENSSL_NO_ENGINE
57     CRYPTO_THREAD_lock_free(rand_engine_lock);
58     rand_engine_lock = NULL;
59 # endif
60     return 0;
61 }
62
63 void rand_cleanup_int(void)
64 {
65     const RAND_METHOD *meth = default_RAND_meth;
66
67     if (!rand_inited)
68         return;
69
70     if (meth != NULL && meth->cleanup != NULL)
71         meth->cleanup();
72     RAND_set_rand_method(NULL);
73     rand_pool_cleanup();
74 # ifndef OPENSSL_NO_ENGINE
75     CRYPTO_THREAD_lock_free(rand_engine_lock);
76     rand_engine_lock = NULL;
77 # endif
78     CRYPTO_THREAD_lock_free(rand_meth_lock);
79     rand_meth_lock = NULL;
80     rand_inited = 0;
81 }
82
83 /*
84  * RAND_close_seed_files() ensures that any seed file descriptors are
85  * closed after use.  This only applies to libcrypto/default provider,
86  * it does not apply to other providers.
87  */
88 void RAND_keep_random_devices_open(int keep)
89 {
90     if (RUN_ONCE(&rand_init, do_rand_init))
91         rand_pool_keep_random_devices_open(keep);
92 }
93
94 /*
95  * RAND_poll() reseeds the default RNG using random input
96  *
97  * The random input is obtained from polling various entropy
98  * sources which depend on the operating system and are
99  * configurable via the --with-rand-seed configure option.
100  */
101 int RAND_poll(void)
102 {
103     const RAND_METHOD *meth = RAND_get_rand_method();
104     int ret = meth == RAND_OpenSSL();
105     RAND_POOL *pool;
106
107     if (meth == NULL)
108         return 0;
109
110     if (!ret) {
111         /* fill random pool and seed the current legacy RNG */
112         pool = rand_pool_new(RAND_DRBG_STRENGTH, 1,
113                              (RAND_DRBG_STRENGTH + 7) / 8,
114                              RAND_POOL_MAX_LENGTH);
115         if (pool == NULL)
116             return 0;
117
118         if (prov_pool_acquire_entropy(pool) == 0)
119             goto err;
120
121         if (meth->add == NULL
122             || meth->add(rand_pool_buffer(pool),
123                          rand_pool_length(pool),
124                          (rand_pool_entropy(pool) / 8.0)) == 0)
125             goto err;
126
127         ret = 1;
128      err:
129         rand_pool_free(pool);
130     }
131     return ret;
132 }
133
134 int RAND_set_rand_method(const RAND_METHOD *meth)
135 {
136     if (!RUN_ONCE(&rand_init, do_rand_init))
137         return 0;
138
139     CRYPTO_THREAD_write_lock(rand_meth_lock);
140 # ifndef OPENSSL_NO_ENGINE
141     ENGINE_finish(funct_ref);
142     funct_ref = NULL;
143 # endif
144     default_RAND_meth = meth;
145     CRYPTO_THREAD_unlock(rand_meth_lock);
146     return 1;
147 }
148
149 const RAND_METHOD *RAND_get_rand_method(void)
150 {
151     const RAND_METHOD *tmp_meth = NULL;
152
153     if (!RUN_ONCE(&rand_init, do_rand_init))
154         return NULL;
155
156     CRYPTO_THREAD_write_lock(rand_meth_lock);
157     if (default_RAND_meth == NULL) {
158 # ifndef OPENSSL_NO_ENGINE
159         ENGINE *e;
160
161         /* If we have an engine that can do RAND, use it. */
162         if ((e = ENGINE_get_default_RAND()) != NULL
163                 && (tmp_meth = ENGINE_get_RAND(e)) != NULL) {
164             funct_ref = e;
165             default_RAND_meth = tmp_meth;
166         } else {
167             ENGINE_finish(e);
168             default_RAND_meth = &rand_meth;
169         }
170 # else
171         default_RAND_meth = &rand_meth;
172 # endif
173     }
174     tmp_meth = default_RAND_meth;
175     CRYPTO_THREAD_unlock(rand_meth_lock);
176     return tmp_meth;
177 }
178
179 # if !defined(OPENSSL_NO_ENGINE)
180 int RAND_set_rand_engine(ENGINE *engine)
181 {
182     const RAND_METHOD *tmp_meth = NULL;
183
184     if (!RUN_ONCE(&rand_init, do_rand_init))
185         return 0;
186
187     if (engine != NULL) {
188         if (!ENGINE_init(engine))
189             return 0;
190         tmp_meth = ENGINE_get_RAND(engine);
191         if (tmp_meth == NULL) {
192             ENGINE_finish(engine);
193             return 0;
194         }
195     }
196     CRYPTO_THREAD_write_lock(rand_engine_lock);
197     /* This function releases any prior ENGINE so call it first */
198     RAND_set_rand_method(tmp_meth);
199     funct_ref = engine;
200     CRYPTO_THREAD_unlock(rand_engine_lock);
201     return 1;
202 }
203 # endif
204
205 void RAND_seed(const void *buf, int num)
206 {
207     const RAND_METHOD *meth = RAND_get_rand_method();
208
209     if (meth != NULL && meth->seed != NULL)
210         meth->seed(buf, num);
211 }
212
213 void RAND_add(const void *buf, int num, double randomness)
214 {
215     const RAND_METHOD *meth = RAND_get_rand_method();
216
217     if (meth != NULL && meth->add != NULL)
218         meth->add(buf, num, randomness);
219 }
220
221 # if !defined(OPENSSL_NO_DEPRECATED_1_1_0)
222 int RAND_pseudo_bytes(unsigned char *buf, int num)
223 {
224     const RAND_METHOD *meth = RAND_get_rand_method();
225
226     if (meth != NULL && meth->pseudorand != NULL)
227         return meth->pseudorand(buf, num);
228     RANDerr(RAND_F_RAND_PSEUDO_BYTES, RAND_R_FUNC_NOT_IMPLEMENTED);
229     return -1;
230 }
231 # endif
232
233 int RAND_status(void)
234 {
235     RAND_DRBG *drbg;
236     const RAND_METHOD *meth = RAND_get_rand_method();
237
238     if (meth != NULL && meth != RAND_OpenSSL())
239         return meth->status != NULL ? meth->status() : 0;
240
241     if ((drbg = RAND_DRBG_get0_master()) == NULL || drbg->rand == NULL)
242         return EVP_RAND_STATE_UNINITIALISED;
243     return EVP_RAND_state(drbg->rand) == EVP_RAND_STATE_READY;
244 }
245 #else  /* !FIPS_MODULE */
246
247 const RAND_METHOD *RAND_get_rand_method(void)
248 {
249     return NULL;
250 }
251 #endif /* !FIPS_MODULE */
252
253 /*
254  * This function is not part of RAND_METHOD, so if we're not using
255  * the default method, then just call RAND_bytes().  Otherwise make
256  * sure we're instantiated and use the private DRBG.
257  */
258 int RAND_priv_bytes_ex(OPENSSL_CTX *ctx, unsigned char *buf, int num)
259 {
260     RAND_DRBG *drbg;
261     const RAND_METHOD *meth = RAND_get_rand_method();
262
263     if (meth != NULL && meth != RAND_OpenSSL()) {
264         if (meth->bytes != NULL)
265             return meth->bytes(buf, num);
266         RANDerr(RAND_F_RAND_PRIV_BYTES_EX, RAND_R_FUNC_NOT_IMPLEMENTED);
267         return -1;
268     }
269
270     drbg = OPENSSL_CTX_get0_private_drbg(ctx);
271     if (drbg != NULL)
272         return RAND_DRBG_bytes(drbg, buf, num);
273
274     return 0;
275 }
276
277 int RAND_priv_bytes(unsigned char *buf, int num)
278 {
279     return RAND_priv_bytes_ex(NULL, buf, num);
280 }
281
282 int RAND_bytes_ex(OPENSSL_CTX *ctx, unsigned char *buf, int num)
283 {
284     RAND_DRBG *drbg;
285     const RAND_METHOD *meth = RAND_get_rand_method();
286
287     if (meth != NULL && meth != RAND_OpenSSL()) {
288         if (meth->bytes != NULL)
289             return meth->bytes(buf, num);
290         RANDerr(RAND_F_RAND_BYTES_EX, RAND_R_FUNC_NOT_IMPLEMENTED);
291         return -1;
292     }
293
294     drbg = OPENSSL_CTX_get0_public_drbg(ctx);
295     if (drbg != NULL)
296         return RAND_DRBG_bytes(drbg, buf, num);
297
298     return 0;
299 }
300
301 int RAND_bytes(unsigned char *buf, int num)
302 {
303     return RAND_bytes_ex(NULL, buf, num);
304 }