Coverage Report

Created: 2026-04-01 06:39

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