Coverage Report

Created: 2025-12-31 06:58

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