Coverage Report

Created: 2023-09-25 06:45

/src/openssl30/providers/implementations/rands/test_rng.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2020-2021 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 <openssl/core_dispatch.h>
12
#include <openssl/e_os2.h>
13
#include <openssl/params.h>
14
#include <openssl/core_names.h>
15
#include <openssl/evp.h>
16
#include <openssl/err.h>
17
#include <openssl/randerr.h>
18
#include "prov/providercommon.h"
19
#include "prov/provider_ctx.h"
20
#include "prov/provider_util.h"
21
#include "prov/implementations.h"
22
23
static OSSL_FUNC_rand_newctx_fn test_rng_new;
24
static OSSL_FUNC_rand_freectx_fn test_rng_free;
25
static OSSL_FUNC_rand_instantiate_fn test_rng_instantiate;
26
static OSSL_FUNC_rand_uninstantiate_fn test_rng_uninstantiate;
27
static OSSL_FUNC_rand_generate_fn test_rng_generate;
28
static OSSL_FUNC_rand_reseed_fn test_rng_reseed;
29
static OSSL_FUNC_rand_nonce_fn test_rng_nonce;
30
static OSSL_FUNC_rand_settable_ctx_params_fn test_rng_settable_ctx_params;
31
static OSSL_FUNC_rand_set_ctx_params_fn test_rng_set_ctx_params;
32
static OSSL_FUNC_rand_gettable_ctx_params_fn test_rng_gettable_ctx_params;
33
static OSSL_FUNC_rand_get_ctx_params_fn test_rng_get_ctx_params;
34
static OSSL_FUNC_rand_verify_zeroization_fn test_rng_verify_zeroization;
35
static OSSL_FUNC_rand_enable_locking_fn test_rng_enable_locking;
36
static OSSL_FUNC_rand_lock_fn test_rng_lock;
37
static OSSL_FUNC_rand_unlock_fn test_rng_unlock;
38
static OSSL_FUNC_rand_get_seed_fn test_rng_get_seed;
39
40
typedef struct {
41
    void *provctx;
42
    int state;
43
    unsigned int strength;
44
    size_t max_request;
45
    unsigned char *entropy, *nonce;
46
    size_t entropy_len, entropy_pos, nonce_len;
47
    CRYPTO_RWLOCK *lock;
48
} PROV_TEST_RNG;
49
50
static void *test_rng_new(void *provctx, void *parent,
51
                          const OSSL_DISPATCH *parent_dispatch)
52
0
{
53
0
    PROV_TEST_RNG *t;
54
55
0
    t = OPENSSL_zalloc(sizeof(*t));
56
0
    if (t == NULL)
57
0
        return NULL;
58
59
0
    t->max_request = INT_MAX;
60
0
    t->provctx = provctx;
61
0
    t->state = EVP_RAND_STATE_UNINITIALISED;
62
0
    return t;
63
0
}
64
65
static void test_rng_free(void *vtest)
66
0
{
67
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
68
69
0
    if (t == NULL)
70
0
        return;
71
0
    OPENSSL_free(t->entropy);
72
0
    OPENSSL_free(t->nonce);
73
0
    CRYPTO_THREAD_lock_free(t->lock);
74
0
    OPENSSL_free(t);
75
0
}
76
77
static int test_rng_instantiate(void *vtest, unsigned int strength,
78
                                int prediction_resistance,
79
                                const unsigned char *pstr, size_t pstr_len,
80
                                const OSSL_PARAM params[])
81
0
{
82
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
83
84
0
    if (!test_rng_set_ctx_params(t, params) || strength > t->strength)
85
0
        return 0;
86
87
0
    t->state = EVP_RAND_STATE_READY;
88
0
    t->entropy_pos = 0;
89
90
0
    return 1;
91
0
}
92
93
static int test_rng_uninstantiate(void *vtest)
94
0
{
95
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
96
97
0
    t->entropy_pos = 0;
98
0
    t->state = EVP_RAND_STATE_UNINITIALISED;
99
0
    return 1;
100
0
}
101
102
static int test_rng_generate(void *vtest, unsigned char *out, size_t outlen,
103
                             unsigned int strength, int prediction_resistance,
104
                             const unsigned char *adin, size_t adin_len)
105
0
{
106
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
107
108
0
    if (strength > t->strength || t->entropy_len - t->entropy_pos < outlen)
109
0
        return 0;
110
0
    memcpy(out, t->entropy + t->entropy_pos, outlen);
111
0
    t->entropy_pos += outlen;
112
0
    return 1;
113
0
}
114
115
static int test_rng_reseed(ossl_unused void *vtest,
116
                           ossl_unused int prediction_resistance,
117
                           ossl_unused const unsigned char *ent,
118
                           ossl_unused size_t ent_len,
119
                           ossl_unused const unsigned char *adin,
120
                           ossl_unused size_t adin_len)
121
0
{
122
0
    return 1;
123
0
}
124
125
static size_t test_rng_nonce(void *vtest, unsigned char *out,
126
                             unsigned int strength,
127
                             ossl_unused size_t min_noncelen,
128
                             ossl_unused size_t max_noncelen)
129
0
{
130
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
131
132
0
    if (t->nonce == NULL || strength > t->strength)
133
0
        return 0;
134
135
0
    if (out != NULL)
136
0
        memcpy(out, t->nonce, t->nonce_len);
137
0
    return t->nonce_len;
138
0
}
139
140
static int test_rng_get_ctx_params(void *vtest, OSSL_PARAM params[])
141
0
{
142
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
143
0
    OSSL_PARAM *p;
144
145
0
    p = OSSL_PARAM_locate(params, OSSL_RAND_PARAM_STATE);
146
0
    if (p != NULL && !OSSL_PARAM_set_int(p, t->state))
147
0
        return 0;
148
149
0
    p = OSSL_PARAM_locate(params, OSSL_RAND_PARAM_STRENGTH);
150
0
    if (p != NULL && !OSSL_PARAM_set_int(p, t->strength))
151
0
        return 0;
152
153
0
    p = OSSL_PARAM_locate(params, OSSL_RAND_PARAM_MAX_REQUEST);
154
0
    if (p != NULL && !OSSL_PARAM_set_size_t(p, t->max_request))
155
0
        return 0;
156
0
    return 1;
157
0
}
158
159
static const OSSL_PARAM *test_rng_gettable_ctx_params(ossl_unused void *vtest,
160
                                                      ossl_unused void *provctx)
161
0
{
162
0
    static const OSSL_PARAM known_gettable_ctx_params[] = {
163
0
        OSSL_PARAM_int(OSSL_RAND_PARAM_STATE, NULL),
164
0
        OSSL_PARAM_uint(OSSL_RAND_PARAM_STRENGTH, NULL),
165
0
        OSSL_PARAM_size_t(OSSL_RAND_PARAM_MAX_REQUEST, NULL),
166
0
        OSSL_PARAM_END
167
0
    };
168
0
    return known_gettable_ctx_params;
169
0
}
170
171
static int test_rng_set_ctx_params(void *vtest, const OSSL_PARAM params[])
172
0
{
173
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
174
0
    const OSSL_PARAM *p;
175
0
    void *ptr = NULL;
176
0
    size_t size = 0;
177
178
0
    if (params == NULL)
179
0
        return 1;
180
181
0
    p = OSSL_PARAM_locate_const(params, OSSL_RAND_PARAM_STRENGTH);
182
0
    if (p != NULL && !OSSL_PARAM_get_uint(p, &t->strength))
183
0
        return 0;
184
185
0
    p = OSSL_PARAM_locate_const(params, OSSL_RAND_PARAM_TEST_ENTROPY);
186
0
    if (p != NULL) {
187
0
        if (!OSSL_PARAM_get_octet_string(p, &ptr, 0, &size))
188
0
            return 0;
189
0
        OPENSSL_free(t->entropy);
190
0
        t->entropy = ptr;
191
0
        t->entropy_len = size;
192
0
        t->entropy_pos = 0;
193
0
        ptr = NULL;
194
0
    }
195
196
0
    p = OSSL_PARAM_locate_const(params, OSSL_RAND_PARAM_TEST_NONCE);
197
0
    if (p != NULL) {
198
0
        if (!OSSL_PARAM_get_octet_string(p, &ptr, 0, &size))
199
0
            return 0;
200
0
        OPENSSL_free(t->nonce);
201
0
        t->nonce = ptr;
202
0
        t->nonce_len = size;
203
0
    }
204
205
0
    p = OSSL_PARAM_locate_const(params, OSSL_RAND_PARAM_MAX_REQUEST);
206
0
    if (p != NULL  && !OSSL_PARAM_get_size_t(p, &t->max_request))
207
0
        return 0;
208
209
0
    return 1;
210
0
}
211
212
static const OSSL_PARAM *test_rng_settable_ctx_params(ossl_unused void *vtest,
213
                                                      ossl_unused void *provctx)
214
0
{
215
0
    static const OSSL_PARAM known_settable_ctx_params[] = {
216
0
        OSSL_PARAM_octet_string(OSSL_RAND_PARAM_TEST_ENTROPY, NULL, 0),
217
0
        OSSL_PARAM_octet_string(OSSL_RAND_PARAM_TEST_NONCE, NULL, 0),
218
0
        OSSL_PARAM_uint(OSSL_RAND_PARAM_STRENGTH, NULL),
219
0
        OSSL_PARAM_size_t(OSSL_RAND_PARAM_MAX_REQUEST, NULL),
220
0
        OSSL_PARAM_END
221
0
    };
222
0
    return known_settable_ctx_params;
223
0
}
224
225
static int test_rng_verify_zeroization(ossl_unused void *vtest)
226
0
{
227
0
    return 1;
228
0
}
229
230
static size_t test_rng_get_seed(void *vtest, unsigned char **pout,
231
                                int entropy, size_t min_len, size_t max_len,
232
                                ossl_unused int prediction_resistance,
233
                                ossl_unused const unsigned char *adin,
234
                                ossl_unused size_t adin_len)
235
0
{
236
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
237
238
0
    *pout = t->entropy;
239
0
    return  t->entropy_len > max_len ? max_len : t->entropy_len;
240
0
}
241
242
static int test_rng_enable_locking(void *vtest)
243
0
{
244
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
245
246
0
    if (t != NULL && t->lock == NULL) {
247
0
        t->lock = CRYPTO_THREAD_lock_new();
248
0
        if (t->lock == NULL) {
249
0
            ERR_raise(ERR_LIB_PROV, RAND_R_FAILED_TO_CREATE_LOCK);
250
0
            return 0;
251
0
        }
252
0
    }
253
0
    return 1;
254
0
}
255
256
static int test_rng_lock(void *vtest)
257
0
{
258
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
259
260
0
    if (t == NULL || t->lock == NULL)
261
0
        return 1;
262
0
    return CRYPTO_THREAD_write_lock(t->lock);
263
0
}
264
265
static void test_rng_unlock(void *vtest)
266
0
{
267
0
    PROV_TEST_RNG *t = (PROV_TEST_RNG *)vtest;
268
269
0
    if (t != NULL && t->lock != NULL)
270
0
        CRYPTO_THREAD_unlock(t->lock);
271
0
}
272
273
const OSSL_DISPATCH ossl_test_rng_functions[] = {
274
    { OSSL_FUNC_RAND_NEWCTX, (void(*)(void))test_rng_new },
275
    { OSSL_FUNC_RAND_FREECTX, (void(*)(void))test_rng_free },
276
    { OSSL_FUNC_RAND_INSTANTIATE,
277
      (void(*)(void))test_rng_instantiate },
278
    { OSSL_FUNC_RAND_UNINSTANTIATE,
279
      (void(*)(void))test_rng_uninstantiate },
280
    { OSSL_FUNC_RAND_GENERATE, (void(*)(void))test_rng_generate },
281
    { OSSL_FUNC_RAND_RESEED, (void(*)(void))test_rng_reseed },
282
    { OSSL_FUNC_RAND_NONCE, (void(*)(void))test_rng_nonce },
283
    { OSSL_FUNC_RAND_ENABLE_LOCKING, (void(*)(void))test_rng_enable_locking },
284
    { OSSL_FUNC_RAND_LOCK, (void(*)(void))test_rng_lock },
285
    { OSSL_FUNC_RAND_UNLOCK, (void(*)(void))test_rng_unlock },
286
    { OSSL_FUNC_RAND_SETTABLE_CTX_PARAMS,
287
      (void(*)(void))test_rng_settable_ctx_params },
288
    { OSSL_FUNC_RAND_SET_CTX_PARAMS, (void(*)(void))test_rng_set_ctx_params },
289
    { OSSL_FUNC_RAND_GETTABLE_CTX_PARAMS,
290
      (void(*)(void))test_rng_gettable_ctx_params },
291
    { OSSL_FUNC_RAND_GET_CTX_PARAMS, (void(*)(void))test_rng_get_ctx_params },
292
    { OSSL_FUNC_RAND_VERIFY_ZEROIZATION,
293
      (void(*)(void))test_rng_verify_zeroization },
294
    { OSSL_FUNC_RAND_GET_SEED, (void(*)(void))test_rng_get_seed },
295
    { 0, NULL }
296
};