/src/openssl/providers/implementations/rands/test_rng.c
Line  | Count  | Source (jump to first uncovered line)  | 
1  |  | /*  | 
2  |  |  * Copyright 2020-2024 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 <string.h>  | 
11  |  | #include <stdlib.h>  | 
12  |  | #include <openssl/core_dispatch.h>  | 
13  |  | #include <openssl/e_os2.h>  | 
14  |  | #include <openssl/params.h>  | 
15  |  | #include <openssl/core_names.h>  | 
16  |  | #include <openssl/evp.h>  | 
17  |  | #include <openssl/err.h>  | 
18  |  | #include <openssl/randerr.h>  | 
19  |  | #include "prov/securitycheck.h"  | 
20  |  | #include "prov/providercommon.h"  | 
21  |  | #include "prov/provider_ctx.h"  | 
22  |  | #include "prov/provider_util.h"  | 
23  |  | #include "prov/implementations.h"  | 
24  |  |  | 
25  |  | static OSSL_FUNC_rand_newctx_fn test_rng_new;  | 
26  |  | static OSSL_FUNC_rand_freectx_fn test_rng_free;  | 
27  |  | static OSSL_FUNC_rand_instantiate_fn test_rng_instantiate;  | 
28  |  | static OSSL_FUNC_rand_uninstantiate_fn test_rng_uninstantiate;  | 
29  |  | static OSSL_FUNC_rand_generate_fn test_rng_generate;  | 
30  |  | static OSSL_FUNC_rand_reseed_fn test_rng_reseed;  | 
31  |  | static OSSL_FUNC_rand_nonce_fn test_rng_nonce;  | 
32  |  | static OSSL_FUNC_rand_settable_ctx_params_fn test_rng_settable_ctx_params;  | 
33  |  | static OSSL_FUNC_rand_set_ctx_params_fn test_rng_set_ctx_params;  | 
34  |  | static OSSL_FUNC_rand_gettable_ctx_params_fn test_rng_gettable_ctx_params;  | 
35  |  | static OSSL_FUNC_rand_get_ctx_params_fn test_rng_get_ctx_params;  | 
36  |  | static OSSL_FUNC_rand_verify_zeroization_fn test_rng_verify_zeroization;  | 
37  |  | static OSSL_FUNC_rand_enable_locking_fn test_rng_enable_locking;  | 
38  |  | static OSSL_FUNC_rand_lock_fn test_rng_lock;  | 
39  |  | static OSSL_FUNC_rand_unlock_fn test_rng_unlock;  | 
40  |  | static OSSL_FUNC_rand_get_seed_fn test_rng_get_seed;  | 
41  |  |  | 
42  |  | typedef struct { | 
43  |  |     void *provctx;  | 
44  |  |     unsigned int generate;  | 
45  |  |     int state;  | 
46  |  |     unsigned int strength;  | 
47  |  |     size_t max_request;  | 
48  |  |     unsigned char *entropy, *nonce;  | 
49  |  |     size_t entropy_len, entropy_pos, nonce_len;  | 
50  |  |     CRYPTO_RWLOCK *lock;  | 
51  |  |     uint32_t seed;  | 
52  |  | } PROV_TEST_RNG;  | 
53  |  |  | 
54  |  | static void *test_rng_new(void *provctx, void *parent,  | 
55  |  |                           const OSSL_DISPATCH *parent_dispatch)  | 
56  | 0  | { | 
57  | 0  |     PROV_TEST_RNG *t;  | 
58  |  | 
  | 
59  | 0  |     t = OPENSSL_zalloc(sizeof(*t));  | 
60  | 0  |     if (t == NULL)  | 
61  | 0  |         return NULL;  | 
62  |  |  | 
63  | 0  |     t->max_request = INT_MAX;  | 
64  | 0  |     t->provctx = provctx;  | 
65  | 0  |     t->state = EVP_RAND_STATE_UNINITIALISED;  | 
66  | 0  |     return t;  | 
67  | 0  | }  | 
68  |  |  | 
69  |  | static void test_rng_free(void *vtest)  | 
70  | 0  | { | 
71  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
72  |  | 
  | 
73  | 0  |     if (t == NULL)  | 
74  | 0  |         return;  | 
75  | 0  |     OPENSSL_free(t->entropy);  | 
76  | 0  |     OPENSSL_free(t->nonce);  | 
77  | 0  |     CRYPTO_THREAD_lock_free(t->lock);  | 
78  | 0  |     OPENSSL_free(t);  | 
79  | 0  | }  | 
80  |  |  | 
81  |  | static int test_rng_instantiate(void *vtest, unsigned int strength,  | 
82  |  |                                 int prediction_resistance,  | 
83  |  |                                 const unsigned char *pstr, size_t pstr_len,  | 
84  |  |                                 const OSSL_PARAM params[])  | 
85  | 0  | { | 
86  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
87  |  | 
  | 
88  | 0  |     if (!test_rng_set_ctx_params(t, params) || strength > t->strength)  | 
89  | 0  |         return 0;  | 
90  |  |  | 
91  | 0  |     t->state = EVP_RAND_STATE_READY;  | 
92  | 0  |     t->entropy_pos = 0;  | 
93  | 0  |     t->seed = 221953166;    /* Value doesn't matter, so long as it isn't zero */  | 
94  |  | 
  | 
95  | 0  |     return 1;  | 
96  | 0  | }  | 
97  |  |  | 
98  |  | static int test_rng_uninstantiate(void *vtest)  | 
99  | 0  | { | 
100  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
101  |  | 
  | 
102  | 0  |     t->entropy_pos = 0;  | 
103  | 0  |     t->state = EVP_RAND_STATE_UNINITIALISED;  | 
104  | 0  |     return 1;  | 
105  | 0  | }  | 
106  |  |  | 
107  |  | static unsigned char gen_byte(PROV_TEST_RNG *t)  | 
108  | 0  | { | 
109  | 0  |     uint32_t n;  | 
110  |  |  | 
111  |  |     /*  | 
112  |  |      * Implement the 32 bit xorshift as suggested by George Marsaglia in:  | 
113  |  |      *      https://doi.org/10.18637/jss.v008.i14  | 
114  |  |      *  | 
115  |  |      * This is a very fast PRNG so there is no need to extract bytes one at a  | 
116  |  |      * time and use the entire value each time.  | 
117  |  |      */  | 
118  | 0  |     n = t->seed;  | 
119  | 0  |     n ^= n << 13;  | 
120  | 0  |     n ^= n >> 17;  | 
121  | 0  |     n ^= n << 5;  | 
122  | 0  |     t->seed = n;  | 
123  |  | 
  | 
124  | 0  |     return n & 0xff;  | 
125  | 0  | }  | 
126  |  |  | 
127  |  | static int test_rng_generate(void *vtest, unsigned char *out, size_t outlen,  | 
128  |  |                              unsigned int strength, int prediction_resistance,  | 
129  |  |                              const unsigned char *adin, size_t adin_len)  | 
130  | 0  | { | 
131  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
132  | 0  |     size_t i;  | 
133  |  | 
  | 
134  | 0  |     if (strength > t->strength)  | 
135  | 0  |         return 0;  | 
136  | 0  |     if (t->generate) { | 
137  | 0  |         for (i = 0; i < outlen; i++)  | 
138  | 0  |             out[i] = gen_byte(t);  | 
139  | 0  |     } else { | 
140  | 0  |         if (t->entropy_len - t->entropy_pos < outlen)  | 
141  | 0  |             return 0;  | 
142  |  |  | 
143  | 0  |         memcpy(out, t->entropy + t->entropy_pos, outlen);  | 
144  | 0  |         t->entropy_pos += outlen;  | 
145  | 0  |     }  | 
146  | 0  |     return 1;  | 
147  | 0  | }  | 
148  |  |  | 
149  |  | static int test_rng_reseed(ossl_unused void *vtest,  | 
150  |  |                            ossl_unused int prediction_resistance,  | 
151  |  |                            ossl_unused const unsigned char *ent,  | 
152  |  |                            ossl_unused size_t ent_len,  | 
153  |  |                            ossl_unused const unsigned char *adin,  | 
154  |  |                            ossl_unused size_t adin_len)  | 
155  | 0  | { | 
156  | 0  |     return 1;  | 
157  | 0  | }  | 
158  |  |  | 
159  |  | static size_t test_rng_nonce(void *vtest, unsigned char *out,  | 
160  |  |                              unsigned int strength, size_t min_noncelen,  | 
161  |  |                              size_t max_noncelen)  | 
162  | 0  | { | 
163  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
164  | 0  |     size_t i;  | 
165  |  | 
  | 
166  | 0  |     if (strength > t->strength)  | 
167  | 0  |         return 0;  | 
168  |  |  | 
169  | 0  |     if (t->generate) { | 
170  | 0  |         for (i = 0; i < min_noncelen; i++)  | 
171  | 0  |             out[i] = gen_byte(t);  | 
172  | 0  |         return min_noncelen;  | 
173  | 0  |     }  | 
174  |  |  | 
175  | 0  |     if (t->nonce == NULL)  | 
176  | 0  |         return 0;  | 
177  | 0  |     i = t->nonce_len > max_noncelen ? max_noncelen : t->nonce_len;  | 
178  | 0  |     if (out != NULL)  | 
179  | 0  |         memcpy(out, t->nonce, i);  | 
180  | 0  |     return i;  | 
181  | 0  | }  | 
182  |  |  | 
183  |  | static int test_rng_get_ctx_params(void *vtest, OSSL_PARAM params[])  | 
184  | 0  | { | 
185  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
186  | 0  |     OSSL_PARAM *p;  | 
187  |  | 
  | 
188  | 0  |     p = OSSL_PARAM_locate(params, OSSL_RAND_PARAM_STATE);  | 
189  | 0  |     if (p != NULL && !OSSL_PARAM_set_int(p, t->state))  | 
190  | 0  |         return 0;  | 
191  |  |  | 
192  | 0  |     p = OSSL_PARAM_locate(params, OSSL_RAND_PARAM_STRENGTH);  | 
193  | 0  |     if (p != NULL && !OSSL_PARAM_set_int(p, t->strength))  | 
194  | 0  |         return 0;  | 
195  |  |  | 
196  | 0  |     p = OSSL_PARAM_locate(params, OSSL_RAND_PARAM_MAX_REQUEST);  | 
197  | 0  |     if (p != NULL && !OSSL_PARAM_set_size_t(p, t->max_request))  | 
198  | 0  |         return 0;  | 
199  |  |  | 
200  | 0  |     p = OSSL_PARAM_locate(params, OSSL_RAND_PARAM_GENERATE);  | 
201  | 0  |     if (p != NULL && !OSSL_PARAM_set_uint(p, t->generate))  | 
202  | 0  |         return 0;  | 
203  |  |  | 
204  |  | #ifdef FIPS_MODULE  | 
205  |  |     p = OSSL_PARAM_locate(params, OSSL_RAND_PARAM_FIPS_APPROVED_INDICATOR);  | 
206  |  |     if (p != NULL && !OSSL_PARAM_set_int(p, 0))  | 
207  |  |         return 0;  | 
208  |  | #endif  /* FIPS_MODULE */  | 
209  | 0  |     return 1;  | 
210  | 0  | }  | 
211  |  |  | 
212  |  | static const OSSL_PARAM *test_rng_gettable_ctx_params(ossl_unused void *vtest,  | 
213  |  |                                                       ossl_unused void *provctx)  | 
214  | 0  | { | 
215  | 0  |     static const OSSL_PARAM known_gettable_ctx_params[] = { | 
216  | 0  |         OSSL_PARAM_int(OSSL_RAND_PARAM_STATE, NULL),  | 
217  | 0  |         OSSL_PARAM_uint(OSSL_RAND_PARAM_STRENGTH, NULL),  | 
218  | 0  |         OSSL_PARAM_size_t(OSSL_RAND_PARAM_MAX_REQUEST, NULL),  | 
219  | 0  |         OSSL_PARAM_uint(OSSL_RAND_PARAM_GENERATE, NULL),  | 
220  | 0  |         OSSL_FIPS_IND_GETTABLE_CTX_PARAM()  | 
221  | 0  |         OSSL_PARAM_END  | 
222  | 0  |     };  | 
223  | 0  |     return known_gettable_ctx_params;  | 
224  | 0  | }  | 
225  |  |  | 
226  |  | static int test_rng_set_ctx_params(void *vtest, const OSSL_PARAM params[])  | 
227  | 0  | { | 
228  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
229  | 0  |     const OSSL_PARAM *p;  | 
230  | 0  |     void *ptr = NULL;  | 
231  | 0  |     size_t size = 0;  | 
232  |  | 
  | 
233  | 0  |     if (ossl_param_is_empty(params))  | 
234  | 0  |         return 1;  | 
235  |  |  | 
236  | 0  |     p = OSSL_PARAM_locate_const(params, OSSL_RAND_PARAM_STRENGTH);  | 
237  | 0  |     if (p != NULL && !OSSL_PARAM_get_uint(p, &t->strength))  | 
238  | 0  |         return 0;  | 
239  |  |  | 
240  | 0  |     p = OSSL_PARAM_locate_const(params, OSSL_RAND_PARAM_TEST_ENTROPY);  | 
241  | 0  |     if (p != NULL) { | 
242  | 0  |         if (!OSSL_PARAM_get_octet_string(p, &ptr, 0, &size))  | 
243  | 0  |             return 0;  | 
244  | 0  |         OPENSSL_free(t->entropy);  | 
245  | 0  |         t->entropy = ptr;  | 
246  | 0  |         t->entropy_len = size;  | 
247  | 0  |         t->entropy_pos = 0;  | 
248  | 0  |         ptr = NULL;  | 
249  | 0  |     }  | 
250  |  |  | 
251  | 0  |     p = OSSL_PARAM_locate_const(params, OSSL_RAND_PARAM_TEST_NONCE);  | 
252  | 0  |     if (p != NULL) { | 
253  | 0  |         if (!OSSL_PARAM_get_octet_string(p, &ptr, 0, &size))  | 
254  | 0  |             return 0;  | 
255  | 0  |         OPENSSL_free(t->nonce);  | 
256  | 0  |         t->nonce = ptr;  | 
257  | 0  |         t->nonce_len = size;  | 
258  | 0  |     }  | 
259  |  |  | 
260  | 0  |     p = OSSL_PARAM_locate_const(params, OSSL_RAND_PARAM_MAX_REQUEST);  | 
261  | 0  |     if (p != NULL && !OSSL_PARAM_get_size_t(p, &t->max_request))  | 
262  | 0  |         return 0;  | 
263  |  |  | 
264  | 0  |     p = OSSL_PARAM_locate_const(params, OSSL_RAND_PARAM_GENERATE);  | 
265  | 0  |     if (p != NULL && !OSSL_PARAM_get_uint(p, &t->generate))  | 
266  | 0  |         return 0;  | 
267  | 0  |     return 1;  | 
268  | 0  | }  | 
269  |  |  | 
270  |  | static const OSSL_PARAM *test_rng_settable_ctx_params(ossl_unused void *vtest,  | 
271  |  |                                                       ossl_unused void *provctx)  | 
272  | 0  | { | 
273  | 0  |     static const OSSL_PARAM known_settable_ctx_params[] = { | 
274  | 0  |         OSSL_PARAM_octet_string(OSSL_RAND_PARAM_TEST_ENTROPY, NULL, 0),  | 
275  | 0  |         OSSL_PARAM_octet_string(OSSL_RAND_PARAM_TEST_NONCE, NULL, 0),  | 
276  | 0  |         OSSL_PARAM_uint(OSSL_RAND_PARAM_STRENGTH, NULL),  | 
277  | 0  |         OSSL_PARAM_size_t(OSSL_RAND_PARAM_MAX_REQUEST, NULL),  | 
278  | 0  |         OSSL_PARAM_uint(OSSL_RAND_PARAM_GENERATE, NULL),  | 
279  | 0  |         OSSL_PARAM_END  | 
280  | 0  |     };  | 
281  | 0  |     return known_settable_ctx_params;  | 
282  | 0  | }  | 
283  |  |  | 
284  |  | static int test_rng_verify_zeroization(ossl_unused void *vtest)  | 
285  | 0  | { | 
286  | 0  |     return 1;  | 
287  | 0  | }  | 
288  |  |  | 
289  |  | static size_t test_rng_get_seed(void *vtest, unsigned char **pout,  | 
290  |  |                                 int entropy, size_t min_len, size_t max_len,  | 
291  |  |                                 ossl_unused int prediction_resistance,  | 
292  |  |                                 ossl_unused const unsigned char *adin,  | 
293  |  |                                 ossl_unused size_t adin_len)  | 
294  | 0  | { | 
295  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
296  |  | 
  | 
297  | 0  |     *pout = t->entropy;  | 
298  | 0  |     return  t->entropy_len > max_len ? max_len : t->entropy_len;  | 
299  | 0  | }  | 
300  |  |  | 
301  |  | static int test_rng_enable_locking(void *vtest)  | 
302  | 0  | { | 
303  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
304  |  | 
  | 
305  | 0  |     if (t != NULL && t->lock == NULL) { | 
306  | 0  |         t->lock = CRYPTO_THREAD_lock_new();  | 
307  | 0  |         if (t->lock == NULL) { | 
308  | 0  |             ERR_raise(ERR_LIB_PROV, RAND_R_FAILED_TO_CREATE_LOCK);  | 
309  | 0  |             return 0;  | 
310  | 0  |         }  | 
311  | 0  |     }  | 
312  | 0  |     return 1;  | 
313  | 0  | }  | 
314  |  |  | 
315  |  | static int test_rng_lock(void *vtest)  | 
316  | 0  | { | 
317  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
318  |  | 
  | 
319  | 0  |     if (t == NULL || t->lock == NULL)  | 
320  | 0  |         return 1;  | 
321  | 0  |     return CRYPTO_THREAD_write_lock(t->lock);  | 
322  | 0  | }  | 
323  |  |  | 
324  |  | static void test_rng_unlock(void *vtest)  | 
325  | 0  | { | 
326  | 0  |     PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;  | 
327  |  | 
  | 
328  | 0  |     if (t != NULL && t->lock != NULL)  | 
329  | 0  |         CRYPTO_THREAD_unlock(t->lock);  | 
330  | 0  | }  | 
331  |  |  | 
332  |  | const OSSL_DISPATCH ossl_test_rng_functions[] = { | 
333  |  |     { OSSL_FUNC_RAND_NEWCTX, (void(*)(void))test_rng_new }, | 
334  |  |     { OSSL_FUNC_RAND_FREECTX, (void(*)(void))test_rng_free }, | 
335  |  |     { OSSL_FUNC_RAND_INSTANTIATE, | 
336  |  |       (void(*)(void))test_rng_instantiate },  | 
337  |  |     { OSSL_FUNC_RAND_UNINSTANTIATE, | 
338  |  |       (void(*)(void))test_rng_uninstantiate },  | 
339  |  |     { OSSL_FUNC_RAND_GENERATE, (void(*)(void))test_rng_generate }, | 
340  |  |     { OSSL_FUNC_RAND_RESEED, (void(*)(void))test_rng_reseed }, | 
341  |  |     { OSSL_FUNC_RAND_NONCE, (void(*)(void))test_rng_nonce }, | 
342  |  |     { OSSL_FUNC_RAND_ENABLE_LOCKING, (void(*)(void))test_rng_enable_locking }, | 
343  |  |     { OSSL_FUNC_RAND_LOCK, (void(*)(void))test_rng_lock }, | 
344  |  |     { OSSL_FUNC_RAND_UNLOCK, (void(*)(void))test_rng_unlock }, | 
345  |  |     { OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS, | 
346  |  |       (void(*)(void))test_rng_settable_ctx_params },  | 
347  |  |     { OSSL_FUNC_RAND_SET_CTX_PARAMS, (void(*)(void))test_rng_set_ctx_params }, | 
348  |  |     { OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS, | 
349  |  |       (void(*)(void))test_rng_gettable_ctx_params },  | 
350  |  |     { OSSL_FUNC_RAND_GET_CTX_PARAMS, (void(*)(void))test_rng_get_ctx_params }, | 
351  |  |     { OSSL_FUNC_RAND_VERIFY_ZEROIZATION, | 
352  |  |       (void(*)(void))test_rng_verify_zeroization },  | 
353  |  |     { OSSL_FUNC_RAND_GET_SEED, (void(*)(void))test_rng_get_seed }, | 
354  |  |     OSSL_DISPATCH_END  | 
355  |  | };  |