Coverage Report

Created: 2025-06-13 06:58

/src/openssl31/providers/common/provider_util.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2019-2022 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
/* We need to use some engine deprecated APIs */
11
#define OPENSSL_SUPPRESS_DEPRECATED
12
13
#include <openssl/evp.h>
14
#include <openssl/core_names.h>
15
#include <openssl/err.h>
16
#include <openssl/proverr.h>
17
#ifndef FIPS_MODULE
18
# include <openssl/engine.h>
19
# include "crypto/evp.h"
20
#endif
21
#include "prov/provider_util.h"
22
23
void ossl_prov_cipher_reset(PROV_CIPHER *pc)
24
7.21k
{
25
7.21k
    EVP_CIPHER_free(pc->alloc_cipher);
26
7.21k
    pc->alloc_cipher = NULL;
27
7.21k
    pc->cipher = NULL;
28
7.21k
#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
29
7.21k
    ENGINE_finish(pc->engine);
30
7.21k
#endif
31
7.21k
    pc->engine = NULL;
32
7.21k
}
33
34
int ossl_prov_cipher_copy(PROV_CIPHER *dst, const PROV_CIPHER *src)
35
0
{
36
0
    if (src->alloc_cipher != NULL && !EVP_CIPHER_up_ref(src->alloc_cipher))
37
0
        return 0;
38
0
#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
39
0
    if (src->engine != NULL && !ENGINE_init(src->engine)) {
40
0
        EVP_CIPHER_free(src->alloc_cipher);
41
0
        return 0;
42
0
    }
43
0
#endif
44
0
    dst->engine = src->engine;
45
0
    dst->cipher = src->cipher;
46
0
    dst->alloc_cipher = src->alloc_cipher;
47
0
    return 1;
48
0
}
49
50
static int load_common(const OSSL_PARAM params[], const char **propquery,
51
                       ENGINE **engine)
52
778k
{
53
778k
    const OSSL_PARAM *p;
54
55
778k
    *propquery = NULL;
56
778k
    p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_PROPERTIES);
57
778k
    if (p != NULL) {
58
2.93k
        if (p->data_type != OSSL_PARAM_UTF8_STRING)
59
0
            return 0;
60
2.93k
        *propquery = p->data;
61
2.93k
    }
62
63
778k
#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
64
778k
    ENGINE_finish(*engine);
65
778k
#endif
66
778k
    *engine = NULL;
67
    /* Inside the FIPS module, we don't support legacy ciphers */
68
778k
#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
69
778k
    p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_ENGINE);
70
778k
    if (p != NULL) {
71
0
        if (p->data_type != OSSL_PARAM_UTF8_STRING)
72
0
            return 0;
73
        /* Get a structural reference */
74
0
        *engine = ENGINE_by_id(p->data);
75
0
        if (*engine == NULL)
76
0
            return 0;
77
        /* Get a functional reference */
78
0
        if (!ENGINE_init(*engine)) {
79
0
            ENGINE_free(*engine);
80
0
            *engine = NULL;
81
0
            return 0;
82
0
        }
83
        /* Free the structural reference */
84
0
        ENGINE_free(*engine);
85
0
    }
86
778k
#endif
87
778k
    return 1;
88
778k
}
89
90
int ossl_prov_cipher_load_from_params(PROV_CIPHER *pc,
91
                                      const OSSL_PARAM params[],
92
                                      OSSL_LIB_CTX *ctx)
93
0
{
94
0
    const OSSL_PARAM *p;
95
0
    const char *propquery;
96
97
0
    if (params == NULL)
98
0
        return 1;
99
100
0
    if (!load_common(params, &propquery, &pc->engine))
101
0
        return 0;
102
103
0
    p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_CIPHER);
104
0
    if (p == NULL)
105
0
        return 1;
106
0
    if (p->data_type != OSSL_PARAM_UTF8_STRING)
107
0
        return 0;
108
109
0
    EVP_CIPHER_free(pc->alloc_cipher);
110
0
    ERR_set_mark();
111
0
    pc->cipher = pc->alloc_cipher = EVP_CIPHER_fetch(ctx, p->data, propquery);
112
0
#ifndef FIPS_MODULE /* Inside the FIPS module, we don't support legacy ciphers */
113
0
    if (pc->cipher == NULL) {
114
0
        const EVP_CIPHER *cipher;
115
116
0
        cipher = EVP_get_cipherbyname(p->data);
117
        /* Do not use global EVP_CIPHERs */
118
0
        if (cipher != NULL && cipher->origin != EVP_ORIG_GLOBAL)
119
0
            pc->cipher = cipher;
120
0
    }
121
0
#endif
122
0
    if (pc->cipher != NULL)
123
0
        ERR_pop_to_mark();
124
0
    else
125
0
        ERR_clear_last_mark();
126
0
    return pc->cipher != NULL;
127
0
}
128
129
const EVP_CIPHER *ossl_prov_cipher_cipher(const PROV_CIPHER *pc)
130
110
{
131
110
    return pc->cipher;
132
110
}
133
134
ENGINE *ossl_prov_cipher_engine(const PROV_CIPHER *pc)
135
86
{
136
86
    return pc->engine;
137
86
}
138
139
void ossl_prov_digest_reset(PROV_DIGEST *pd)
140
1.25M
{
141
1.25M
    EVP_MD_free(pd->alloc_md);
142
1.25M
    pd->alloc_md = NULL;
143
1.25M
    pd->md = NULL;
144
1.25M
#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
145
1.25M
    ENGINE_finish(pd->engine);
146
1.25M
#endif
147
1.25M
    pd->engine = NULL;
148
1.25M
}
149
150
int ossl_prov_digest_copy(PROV_DIGEST *dst, const PROV_DIGEST *src)
151
523k
{
152
523k
    if (src->alloc_md != NULL && !EVP_MD_up_ref(src->alloc_md))
153
0
        return 0;
154
523k
#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
155
523k
    if (src->engine != NULL && !ENGINE_init(src->engine)) {
156
0
        EVP_MD_free(src->alloc_md);
157
0
        return 0;
158
0
    }
159
523k
#endif
160
523k
    dst->engine = src->engine;
161
523k
    dst->md = src->md;
162
523k
    dst->alloc_md = src->alloc_md;
163
523k
    return 1;
164
523k
}
165
166
const EVP_MD *ossl_prov_digest_fetch(PROV_DIGEST *pd, OSSL_LIB_CTX *libctx,
167
                                     const char *mdname, const char *propquery)
168
726k
{
169
726k
    EVP_MD_free(pd->alloc_md);
170
726k
    pd->md = pd->alloc_md = EVP_MD_fetch(libctx, mdname, propquery);
171
172
726k
    return pd->md;
173
726k
}
174
175
int ossl_prov_digest_load_from_params(PROV_DIGEST *pd,
176
                                      const OSSL_PARAM params[],
177
                                      OSSL_LIB_CTX *ctx)
178
381k
{
179
381k
    const OSSL_PARAM *p;
180
381k
    const char *propquery;
181
182
381k
    if (params == NULL)
183
0
        return 1;
184
185
381k
    if (!load_common(params, &propquery, &pd->engine))
186
0
        return 0;
187
188
381k
    p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_DIGEST);
189
381k
    if (p == NULL)
190
15.1k
        return 1;
191
366k
    if (p->data_type != OSSL_PARAM_UTF8_STRING)
192
0
        return 0;
193
194
366k
    ERR_set_mark();
195
366k
    ossl_prov_digest_fetch(pd, ctx, p->data, propquery);
196
366k
#ifndef FIPS_MODULE /* Inside the FIPS module, we don't support legacy digests */
197
366k
    if (pd->md == NULL) {
198
3
        const EVP_MD *md;
199
200
3
        md = EVP_get_digestbyname(p->data);
201
        /* Do not use global EVP_MDs */
202
3
        if (md != NULL && md->origin != EVP_ORIG_GLOBAL)
203
0
            pd->md = md;
204
3
    }
205
366k
#endif
206
366k
    if (pd->md != NULL)
207
366k
        ERR_pop_to_mark();
208
3
    else
209
3
        ERR_clear_last_mark();
210
366k
    return pd->md != NULL;
211
366k
}
212
213
const EVP_MD *ossl_prov_digest_md(const PROV_DIGEST *pd)
214
1.07M
{
215
1.07M
    return pd->md;
216
1.07M
}
217
218
ENGINE *ossl_prov_digest_engine(const PROV_DIGEST *pd)
219
118k
{
220
118k
    return pd->engine;
221
118k
}
222
223
int ossl_prov_set_macctx(EVP_MAC_CTX *macctx,
224
                         const OSSL_PARAM params[],
225
                         const char *ciphername,
226
                         const char *mdname,
227
                         const char *engine,
228
                         const char *properties,
229
                         const unsigned char *key,
230
                         size_t keylen)
231
43.2k
{
232
43.2k
    const OSSL_PARAM *p;
233
43.2k
    OSSL_PARAM mac_params[6], *mp = mac_params;
234
235
43.2k
    if (params != NULL) {
236
36.1k
        if (mdname == NULL) {
237
21.4k
            if ((p = OSSL_PARAM_locate_const(params,
238
21.4k
                                            OSSL_ALG_PARAM_DIGEST)) != NULL) {
239
21.4k
                if (p->data_type != OSSL_PARAM_UTF8_STRING)
240
0
                    return 0;
241
21.4k
                mdname = p->data;
242
21.4k
            }
243
21.4k
        }
244
36.1k
        if (ciphername == NULL) {
245
36.1k
            if ((p = OSSL_PARAM_locate_const(params,
246
36.1k
                                            OSSL_ALG_PARAM_CIPHER)) != NULL) {
247
83
                if (p->data_type != OSSL_PARAM_UTF8_STRING)
248
0
                    return 0;
249
83
                ciphername = p->data;
250
83
            }
251
36.1k
        }
252
36.1k
        if (engine == NULL) {
253
36.1k
            if ((p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_ENGINE))
254
36.1k
                    != NULL) {
255
0
                if (p->data_type != OSSL_PARAM_UTF8_STRING)
256
0
                    return 0;
257
0
                engine = p->data;
258
0
            }
259
36.1k
        }
260
36.1k
    }
261
262
43.2k
    if (mdname != NULL)
263
43.2k
        *mp++ = OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_DIGEST,
264
43.2k
                                                 (char *)mdname, 0);
265
43.2k
    if (ciphername != NULL)
266
83
        *mp++ = OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_CIPHER,
267
83
                                                 (char *)ciphername, 0);
268
43.2k
    if (properties != NULL)
269
1.57k
        *mp++ = OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_PROPERTIES,
270
1.57k
                                                 (char *)properties, 0);
271
272
43.2k
#if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
273
43.2k
    if (engine != NULL)
274
0
        *mp++ = OSSL_PARAM_construct_utf8_string(OSSL_ALG_PARAM_ENGINE,
275
0
                                                 (char *) engine, 0);
276
43.2k
#endif
277
278
43.2k
    if (key != NULL)
279
0
        *mp++ = OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY,
280
0
                                                  (unsigned char *)key,
281
0
                                                  keylen);
282
283
43.2k
    *mp = OSSL_PARAM_construct_end();
284
285
43.2k
    return EVP_MAC_CTX_set_params(macctx, mac_params);
286
287
43.2k
}
288
289
int ossl_prov_macctx_load_from_params(EVP_MAC_CTX **macctx,
290
                                      const OSSL_PARAM params[],
291
                                      const char *macname,
292
                                      const char *ciphername,
293
                                      const char *mdname,
294
                                      OSSL_LIB_CTX *libctx)
295
36.3k
{
296
36.3k
    const OSSL_PARAM *p;
297
36.3k
    const char *properties = NULL;
298
299
36.3k
    if (macname == NULL
300
36.3k
        && (p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_MAC)) != NULL) {
301
192
        if (p->data_type != OSSL_PARAM_UTF8_STRING)
302
0
            return 0;
303
192
        macname = p->data;
304
192
    }
305
36.3k
    if ((p = OSSL_PARAM_locate_const(params,
306
36.3k
                                     OSSL_ALG_PARAM_PROPERTIES)) != NULL) {
307
1.77k
        if (p->data_type != OSSL_PARAM_UTF8_STRING)
308
0
            return 0;
309
1.77k
        properties = p->data;
310
1.77k
    }
311
312
    /* If we got a new mac name, we make a new EVP_MAC_CTX */
313
36.3k
    if (macname != NULL) {
314
36.3k
        EVP_MAC *mac = EVP_MAC_fetch(libctx, macname, properties);
315
316
36.3k
        EVP_MAC_CTX_free(*macctx);
317
36.3k
        *macctx = mac == NULL ? NULL : EVP_MAC_CTX_new(mac);
318
        /* The context holds on to the MAC */
319
36.3k
        EVP_MAC_free(mac);
320
36.3k
        if (*macctx == NULL)
321
206
            return 0;
322
36.3k
    }
323
324
    /*
325
     * If there is no MAC yet (and therefore, no MAC context), we ignore
326
     * all other parameters.
327
     */
328
36.1k
    if (*macctx == NULL)
329
0
        return 1;
330
331
36.1k
    if (ossl_prov_set_macctx(*macctx, params, ciphername, mdname, NULL,
332
36.1k
                             properties, NULL, 0))
333
35.6k
        return 1;
334
335
493
    EVP_MAC_CTX_free(*macctx);
336
493
    *macctx = NULL;
337
493
    return 0;
338
36.1k
}
339
340
void ossl_prov_cache_exported_algorithms(const OSSL_ALGORITHM_CAPABLE *in,
341
                                         OSSL_ALGORITHM *out)
342
45
{
343
45
    int i, j;
344
345
45
    if (out[0].algorithm_names == NULL) {
346
5.87k
        for (i = j = 0; in[i].alg.algorithm_names != NULL; ++i) {
347
5.83k
            if (in[i].capable == NULL || in[i].capable())
348
5.65k
                out[j++] = in[i].alg;
349
5.83k
        }
350
44
        out[j++] = in[i].alg;
351
44
    }
352
45
}
353
354
/* Duplicate a lump of memory safely */
355
int ossl_prov_memdup(const void *src, size_t src_len,
356
                     unsigned char **dest, size_t *dest_len)
357
0
{
358
0
    if (src != NULL) {
359
0
        if ((*dest = OPENSSL_memdup(src, src_len)) == NULL) {
360
0
            ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
361
0
            return 0;
362
0
        }
363
0
        *dest_len = src_len;
364
0
    } else {
365
0
        *dest = NULL;
366
0
        *dest_len = 0;
367
0
    }
368
0
    return 1;
369
0
}