/src/openssl/providers/implementations/rands/seed_src.c
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Copyright 2020-2023 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 | | |
11 | | #include <string.h> |
12 | | #include <openssl/rand.h> |
13 | | #include <openssl/core_dispatch.h> |
14 | | #include <openssl/e_os2.h> |
15 | | #include <openssl/params.h> |
16 | | #include <openssl/core_names.h> |
17 | | #include <openssl/evp.h> |
18 | | #include <openssl/err.h> |
19 | | #include <openssl/randerr.h> |
20 | | #include <openssl/proverr.h> |
21 | | #include "internal/common.h" |
22 | | #include "prov/implementations.h" |
23 | | #include "prov/provider_ctx.h" |
24 | | #include "crypto/rand.h" |
25 | | #include "crypto/rand_pool.h" |
26 | | |
27 | | static OSSL_FUNC_rand_newctx_fn seed_src_new; |
28 | | static OSSL_FUNC_rand_freectx_fn seed_src_free; |
29 | | static OSSL_FUNC_rand_instantiate_fn seed_src_instantiate; |
30 | | static OSSL_FUNC_rand_uninstantiate_fn seed_src_uninstantiate; |
31 | | static OSSL_FUNC_rand_generate_fn seed_src_generate; |
32 | | static OSSL_FUNC_rand_reseed_fn seed_src_reseed; |
33 | | static OSSL_FUNC_rand_gettable_ctx_params_fn seed_src_gettable_ctx_params; |
34 | | static OSSL_FUNC_rand_get_ctx_params_fn seed_src_get_ctx_params; |
35 | | static OSSL_FUNC_rand_verify_zeroization_fn seed_src_verify_zeroization; |
36 | | static OSSL_FUNC_rand_enable_locking_fn seed_src_enable_locking; |
37 | | static OSSL_FUNC_rand_lock_fn seed_src_lock; |
38 | | static OSSL_FUNC_rand_unlock_fn seed_src_unlock; |
39 | | static OSSL_FUNC_rand_get_seed_fn seed_get_seed; |
40 | | static OSSL_FUNC_rand_clear_seed_fn seed_clear_seed; |
41 | | |
42 | | typedef struct { |
43 | | void *provctx; |
44 | | int state; |
45 | | } PROV_SEED_SRC; |
46 | | |
47 | | static void *seed_src_new(void *provctx, void *parent, |
48 | | const OSSL_DISPATCH *parent_dispatch) |
49 | 16 | { |
50 | 16 | PROV_SEED_SRC *s; |
51 | | |
52 | 16 | if (parent != NULL) { |
53 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_SEED_SOURCES_MUST_NOT_HAVE_A_PARENT); |
54 | 0 | return NULL; |
55 | 0 | } |
56 | | |
57 | 16 | s = OPENSSL_zalloc(sizeof(*s)); |
58 | 16 | if (s == NULL) |
59 | 0 | return NULL; |
60 | | |
61 | 16 | s->provctx = provctx; |
62 | 16 | s->state = EVP_RAND_STATE_UNINITIALISED; |
63 | 16 | return s; |
64 | 16 | } |
65 | | |
66 | | static void seed_src_free(void *vseed) |
67 | 16 | { |
68 | 16 | OPENSSL_free(vseed); |
69 | 16 | } |
70 | | |
71 | | static int seed_src_instantiate(void *vseed, unsigned int strength, |
72 | | int prediction_resistance, |
73 | | const unsigned char *pstr, size_t pstr_len, |
74 | | ossl_unused const OSSL_PARAM params[]) |
75 | 16 | { |
76 | 16 | PROV_SEED_SRC *s = (PROV_SEED_SRC *)vseed; |
77 | | |
78 | 16 | s->state = EVP_RAND_STATE_READY; |
79 | 16 | return 1; |
80 | 16 | } |
81 | | |
82 | | static int seed_src_uninstantiate(void *vseed) |
83 | 0 | { |
84 | 0 | PROV_SEED_SRC *s = (PROV_SEED_SRC *)vseed; |
85 | |
|
86 | 0 | s->state = EVP_RAND_STATE_UNINITIALISED; |
87 | 0 | return 1; |
88 | 0 | } |
89 | | |
90 | | static int seed_src_generate(void *vseed, unsigned char *out, size_t outlen, |
91 | | unsigned int strength, |
92 | | ossl_unused int prediction_resistance, |
93 | | const unsigned char *adin, |
94 | | size_t adin_len) |
95 | 0 | { |
96 | 0 | PROV_SEED_SRC *s = (PROV_SEED_SRC *)vseed; |
97 | 0 | size_t entropy_available; |
98 | 0 | RAND_POOL *pool; |
99 | |
|
100 | 0 | if (s->state != EVP_RAND_STATE_READY) { |
101 | 0 | ERR_raise(ERR_LIB_PROV, |
102 | 0 | s->state == EVP_RAND_STATE_ERROR ? PROV_R_IN_ERROR_STATE |
103 | 0 | : PROV_R_NOT_INSTANTIATED); |
104 | 0 | return 0; |
105 | 0 | } |
106 | | |
107 | 0 | pool = ossl_rand_pool_new(strength, 1, outlen, outlen); |
108 | 0 | if (pool == NULL) { |
109 | 0 | ERR_raise(ERR_LIB_PROV, ERR_R_RAND_LIB); |
110 | 0 | return 0; |
111 | 0 | } |
112 | | |
113 | | /* Get entropy by polling system entropy sources. */ |
114 | 0 | entropy_available = ossl_pool_acquire_entropy(pool); |
115 | |
|
116 | 0 | if (entropy_available > 0) { |
117 | 0 | if (!ossl_rand_pool_adin_mix_in(pool, adin, adin_len)) { |
118 | 0 | ossl_rand_pool_free(pool); |
119 | 0 | return 0; |
120 | 0 | } |
121 | 0 | memcpy(out, ossl_rand_pool_buffer(pool), ossl_rand_pool_length(pool)); |
122 | 0 | } |
123 | | |
124 | 0 | ossl_rand_pool_free(pool); |
125 | 0 | return entropy_available > 0; |
126 | 0 | } |
127 | | |
128 | | static int seed_src_reseed(void *vseed, |
129 | | ossl_unused int prediction_resistance, |
130 | | ossl_unused const unsigned char *ent, |
131 | | ossl_unused size_t ent_len, |
132 | | ossl_unused const unsigned char *adin, |
133 | | ossl_unused size_t adin_len) |
134 | 0 | { |
135 | 0 | PROV_SEED_SRC *s = (PROV_SEED_SRC *)vseed; |
136 | |
|
137 | 0 | if (s->state != EVP_RAND_STATE_READY) { |
138 | 0 | ERR_raise(ERR_LIB_PROV, |
139 | 0 | s->state == EVP_RAND_STATE_ERROR ? PROV_R_IN_ERROR_STATE |
140 | 0 | : PROV_R_NOT_INSTANTIATED); |
141 | 0 | return 0; |
142 | 0 | } |
143 | 0 | return 1; |
144 | 0 | } |
145 | | |
146 | | /* Machine generated by util/perl/OpenSSL/paramnames.pm */ |
147 | | #ifndef seed_src_get_ctx_params_list |
148 | | static const OSSL_PARAM seed_src_get_ctx_params_list[] = { |
149 | | OSSL_PARAM_int(OSSL_RAND_PARAM_STATE, NULL), |
150 | | OSSL_PARAM_uint(OSSL_RAND_PARAM_STRENGTH, NULL), |
151 | | OSSL_PARAM_size_t(OSSL_RAND_PARAM_MAX_REQUEST, NULL), |
152 | | OSSL_PARAM_END |
153 | | }; |
154 | | #endif |
155 | | |
156 | | #ifndef seed_src_get_ctx_params_st |
157 | | struct seed_src_get_ctx_params_st { |
158 | | OSSL_PARAM *maxreq; |
159 | | OSSL_PARAM *state; |
160 | | OSSL_PARAM *str; |
161 | | }; |
162 | | #endif |
163 | | |
164 | | #ifndef seed_src_get_ctx_params_decoder |
165 | | static int seed_src_get_ctx_params_decoder |
166 | | (const OSSL_PARAM *p, struct seed_src_get_ctx_params_st *r) |
167 | 128 | { |
168 | 128 | const char *s; |
169 | | |
170 | 128 | memset(r, 0, sizeof(*r)); |
171 | 128 | if (p != NULL) |
172 | 256 | for (; (s = p->key) != NULL; p++) |
173 | 128 | switch(s[0]) { |
174 | 64 | default: |
175 | 64 | break; |
176 | 64 | case 'm': |
177 | 0 | if (ossl_likely(strcmp("ax_request", s + 1) == 0)) { |
178 | | /* RAND_PARAM_MAX_REQUEST */ |
179 | 0 | if (ossl_unlikely(r->maxreq != NULL)) { |
180 | 0 | ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER, |
181 | 0 | "param %s is repeated", s); |
182 | 0 | return 0; |
183 | 0 | } |
184 | 0 | r->maxreq = (OSSL_PARAM *)p; |
185 | 0 | } |
186 | 0 | break; |
187 | 64 | case 's': |
188 | 64 | switch(s[1]) { |
189 | 0 | default: |
190 | 0 | break; |
191 | 64 | case 't': |
192 | 64 | switch(s[2]) { |
193 | 0 | default: |
194 | 0 | break; |
195 | 0 | case 'a': |
196 | 0 | if (ossl_likely(strcmp("te", s + 3) == 0)) { |
197 | | /* RAND_PARAM_STATE */ |
198 | 0 | if (ossl_unlikely(r->state != NULL)) { |
199 | 0 | ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER, |
200 | 0 | "param %s is repeated", s); |
201 | 0 | return 0; |
202 | 0 | } |
203 | 0 | r->state = (OSSL_PARAM *)p; |
204 | 0 | } |
205 | 0 | break; |
206 | 64 | case 'r': |
207 | 64 | if (ossl_likely(strcmp("ength", s + 3) == 0)) { |
208 | | /* RAND_PARAM_STRENGTH */ |
209 | 64 | if (ossl_unlikely(r->str != NULL)) { |
210 | 0 | ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER, |
211 | 0 | "param %s is repeated", s); |
212 | 0 | return 0; |
213 | 0 | } |
214 | 64 | r->str = (OSSL_PARAM *)p; |
215 | 64 | } |
216 | 64 | } |
217 | 64 | } |
218 | 128 | } |
219 | 128 | return 1; |
220 | 128 | } |
221 | | #endif |
222 | | /* End of machine generated */ |
223 | | |
224 | | static int seed_src_get_ctx_params(void *vseed, OSSL_PARAM params[]) |
225 | 128 | { |
226 | 128 | PROV_SEED_SRC *s = (PROV_SEED_SRC *)vseed; |
227 | 128 | struct seed_src_get_ctx_params_st p; |
228 | | |
229 | 128 | if (s == NULL || !seed_src_get_ctx_params_decoder(params, &p)) |
230 | 0 | return 0; |
231 | | |
232 | 128 | if (p.state != NULL && !OSSL_PARAM_set_int(p.state, s->state)) |
233 | 0 | return 0; |
234 | | |
235 | 128 | if (p.str != NULL && !OSSL_PARAM_set_uint(p.str, 1024)) |
236 | 0 | return 0; |
237 | | |
238 | 128 | if (p.maxreq != NULL && !OSSL_PARAM_set_size_t(p.maxreq, 128)) |
239 | 0 | return 0; |
240 | 128 | return 1; |
241 | 128 | } |
242 | | |
243 | | static const OSSL_PARAM *seed_src_gettable_ctx_params(ossl_unused void *vseed, |
244 | | ossl_unused void *provctx) |
245 | 0 | { |
246 | 0 | return seed_src_get_ctx_params_list; |
247 | 0 | } |
248 | | |
249 | | static int seed_src_verify_zeroization(ossl_unused void *vseed) |
250 | 0 | { |
251 | 0 | return 1; |
252 | 0 | } |
253 | | |
254 | | static size_t seed_get_seed(void *vseed, unsigned char **pout, |
255 | | int entropy, size_t min_len, size_t max_len, |
256 | | int prediction_resistance, |
257 | | const unsigned char *adin, size_t adin_len) |
258 | 48 | { |
259 | 48 | size_t ret = 0; |
260 | 48 | size_t entropy_available = 0; |
261 | 48 | RAND_POOL *pool; |
262 | | |
263 | 48 | pool = ossl_rand_pool_new(entropy, 1, min_len, max_len); |
264 | 48 | if (pool == NULL) { |
265 | 0 | ERR_raise(ERR_LIB_PROV, ERR_R_RAND_LIB); |
266 | 0 | return 0; |
267 | 0 | } |
268 | | |
269 | | /* Get entropy by polling system entropy sources. */ |
270 | 48 | entropy_available = ossl_pool_acquire_entropy(pool); |
271 | | |
272 | 48 | if (entropy_available > 0 |
273 | 48 | && ossl_rand_pool_adin_mix_in(pool, adin, adin_len)) { |
274 | 48 | ret = ossl_rand_pool_length(pool); |
275 | 48 | *pout = ossl_rand_pool_detach(pool); |
276 | 48 | } else { |
277 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_ENTROPY_SOURCE_STRENGTH_TOO_WEAK); |
278 | 0 | } |
279 | 48 | ossl_rand_pool_free(pool); |
280 | 48 | return ret; |
281 | 48 | } |
282 | | |
283 | | static void seed_clear_seed(ossl_unused void *vdrbg, |
284 | | unsigned char *out, size_t outlen) |
285 | 48 | { |
286 | 48 | OPENSSL_secure_clear_free(out, outlen); |
287 | 48 | } |
288 | | |
289 | | static int seed_src_enable_locking(ossl_unused void *vseed) |
290 | 16 | { |
291 | 16 | return 1; |
292 | 16 | } |
293 | | |
294 | | int seed_src_lock(ossl_unused void *vctx) |
295 | 240 | { |
296 | 240 | return 1; |
297 | 240 | } |
298 | | |
299 | | void seed_src_unlock(ossl_unused void *vctx) |
300 | 240 | { |
301 | 240 | } |
302 | | |
303 | | const OSSL_DISPATCH ossl_seed_src_functions[] = { |
304 | | { OSSL_FUNC_RAND_NEWCTX, (void(*)(void))seed_src_new }, |
305 | | { OSSL_FUNC_RAND_FREECTX, (void(*)(void))seed_src_free }, |
306 | | { OSSL_FUNC_RAND_INSTANTIATE, |
307 | | (void(*)(void))seed_src_instantiate }, |
308 | | { OSSL_FUNC_RAND_UNINSTANTIATE, |
309 | | (void(*)(void))seed_src_uninstantiate }, |
310 | | { OSSL_FUNC_RAND_GENERATE, (void(*)(void))seed_src_generate }, |
311 | | { OSSL_FUNC_RAND_RESEED, (void(*)(void))seed_src_reseed }, |
312 | | { OSSL_FUNC_RAND_ENABLE_LOCKING, (void(*)(void))seed_src_enable_locking }, |
313 | | { OSSL_FUNC_RAND_LOCK, (void(*)(void))seed_src_lock }, |
314 | | { OSSL_FUNC_RAND_UNLOCK, (void(*)(void))seed_src_unlock }, |
315 | | { OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS, |
316 | | (void(*)(void))seed_src_gettable_ctx_params }, |
317 | | { OSSL_FUNC_RAND_GET_CTX_PARAMS, (void(*)(void))seed_src_get_ctx_params }, |
318 | | { OSSL_FUNC_RAND_VERIFY_ZEROIZATION, |
319 | | (void(*)(void))seed_src_verify_zeroization }, |
320 | | { OSSL_FUNC_RAND_GET_SEED, (void(*)(void))seed_get_seed }, |
321 | | { OSSL_FUNC_RAND_CLEAR_SEED, (void(*)(void))seed_clear_seed }, |
322 | | OSSL_DISPATCH_END |
323 | | }; |