Coverage Report

Created: 2025-12-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl30/providers/common/provider_util.c
Line
Count
Source
1
/*
2
 * Copyright 2019-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
/* 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
#include "internal/nelem.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
263
{
95
263
    const OSSL_PARAM *p;
96
263
    const char *propquery;
97
98
263
    if (params == NULL)
99
0
        return 1;
100
101
263
    if (!load_common(params, &propquery, &pc->engine))
102
0
        return 0;
103
104
263
    p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_CIPHER);
105
263
    if (p == NULL)
106
0
        return 1;
107
263
    if (p->data_type != OSSL_PARAM_UTF8_STRING)
108
0
        return 0;
109
110
263
    EVP_CIPHER_free(pc->alloc_cipher);
111
263
    ERR_set_mark();
112
263
    pc->cipher = pc->alloc_cipher = EVP_CIPHER_fetch(ctx, p->data, propquery);
113
263
#ifndef FIPS_MODULE /* Inside the FIPS module, we don't support legacy ciphers */
114
263
    if (pc->cipher == NULL) {
115
45
        const EVP_CIPHER *cipher;
116
117
45
        cipher = EVP_get_cipherbyname(p->data);
118
        /* Do not use global EVP_CIPHERs */
119
45
        if (cipher != NULL && cipher->origin != EVP_ORIG_GLOBAL)
120
0
            pc->cipher = cipher;
121
45
    }
122
263
#endif
123
263
    if (pc->cipher != NULL)
124
218
        ERR_pop_to_mark();
125
45
    else
126
45
        ERR_clear_last_mark();
127
263
    return pc->cipher != NULL;
128
263
}
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
763k
{
180
763k
    const OSSL_PARAM *p;
181
763k
    const char *propquery;
182
183
763k
    if (params == NULL)
184
0
        return 1;
185
186
763k
    if (!load_common(params, &propquery, &pd->engine))
187
0
        return 0;
188
189
763k
    p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_DIGEST);
190
763k
    if (p == NULL)
191
81.7k
        return 1;
192
682k
    if (p->data_type != OSSL_PARAM_UTF8_STRING)
193
0
        return 0;
194
195
682k
    ERR_set_mark();
196
682k
    ossl_prov_digest_fetch(pd, ctx, p->data, propquery);
197
682k
#ifndef FIPS_MODULE /* Inside the FIPS module, we don't support legacy digests */
198
682k
    if (pd->md == NULL) {
199
519
        const EVP_MD *md;
200
201
519
        md = EVP_get_digestbyname(p->data);
202
        /* Do not use global EVP_MDs */
203
519
        if (md != NULL && md->origin != EVP_ORIG_GLOBAL)
204
0
            pd->md = md;
205
519
    }
206
682k
#endif
207
682k
    if (pd->md != NULL)
208
681k
        ERR_pop_to_mark();
209
519
    else
210
519
        ERR_clear_last_mark();
211
682k
    return pd->md != NULL;
212
682k
}
213
214
const EVP_MD *ossl_prov_digest_md(const PROV_DIGEST *pd)
215
2.96M
{
216
2.96M
    return pd->md;
217
2.96M
}
218
219
ENGINE *ossl_prov_digest_engine(const PROV_DIGEST *pd)
220
227k
{
221
227k
    return pd->engine;
222
227k
}
223
224
int ossl_prov_set_macctx(EVP_MAC_CTX *macctx,
225
    const OSSL_PARAM params[],
226
    const char *ciphername,
227
    const char *mdname,
228
    const char *engine,
229
    const char *properties,
230
    const unsigned char *key,
231
    size_t keylen)
232
75.4k
{
233
75.4k
    const OSSL_PARAM *p;
234
75.4k
    OSSL_PARAM mac_params[6], *mp = mac_params;
235
236
75.4k
    if (params != NULL) {
237
62.8k
        if (mdname == NULL) {
238
34.0k
            if ((p = OSSL_PARAM_locate_const(params,
239
34.0k
                     OSSL_ALG_PARAM_DIGEST))
240
34.0k
                != NULL) {
241
34.0k
                if (p->data_type != OSSL_PARAM_UTF8_STRING)
242
0
                    return 0;
243
34.0k
                mdname = p->data;
244
34.0k
            }
245
34.0k
        }
246
62.8k
        if (ciphername == NULL) {
247
62.8k
            if ((p = OSSL_PARAM_locate_const(params,
248
62.8k
                     OSSL_ALG_PARAM_CIPHER))
249
62.8k
                != NULL) {
250
183
                if (p->data_type != OSSL_PARAM_UTF8_STRING)
251
0
                    return 0;
252
183
                ciphername = p->data;
253
183
            }
254
62.8k
        }
255
62.8k
        if (engine == NULL) {
256
62.8k
            if ((p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_ENGINE))
257
62.8k
                != NULL) {
258
0
                if (p->data_type != OSSL_PARAM_UTF8_STRING)
259
0
                    return 0;
260
0
                engine = p->data;
261
0
            }
262
62.8k
        }
263
62.8k
    }
264
265
75.4k
    if (mdname != NULL)
266
75.4k
        *mp++ = OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_DIGEST,
267
75.4k
            (char *)mdname, 0);
268
75.4k
    if (ciphername != NULL)
269
183
        *mp++ = OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_CIPHER,
270
183
            (char *)ciphername, 0);
271
75.4k
    if (properties != NULL)
272
2.35k
        *mp++ = OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_PROPERTIES,
273
2.35k
            (char *)properties, 0);
274
275
75.4k
#if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
276
75.4k
    if (engine != NULL)
277
0
        *mp++ = OSSL_PARAM_construct_utf8_string(OSSL_ALG_PARAM_ENGINE,
278
0
            (char *)engine, 0);
279
75.4k
#endif
280
281
75.4k
    if (key != NULL)
282
0
        *mp++ = OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY,
283
0
            (unsigned char *)key,
284
0
            keylen);
285
286
75.4k
    *mp = OSSL_PARAM_construct_end();
287
288
75.4k
    return EVP_MAC_CTX_set_params(macctx, mac_params);
289
75.4k
}
290
291
int ossl_prov_macctx_load_from_params(EVP_MAC_CTX **macctx,
292
    const OSSL_PARAM params[],
293
    const char *macname,
294
    const char *ciphername,
295
    const char *mdname,
296
    OSSL_LIB_CTX *libctx)
297
62.9k
{
298
62.9k
    const OSSL_PARAM *p;
299
62.9k
    const char *properties = NULL;
300
301
62.9k
    if (macname == NULL
302
425
        && (p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_MAC)) != NULL) {
303
425
        if (p->data_type != OSSL_PARAM_UTF8_STRING)
304
0
            return 0;
305
425
        macname = p->data;
306
425
    }
307
62.9k
    if ((p = OSSL_PARAM_locate_const(params,
308
62.9k
             OSSL_ALG_PARAM_PROPERTIES))
309
62.9k
        != NULL) {
310
2.53k
        if (p->data_type != OSSL_PARAM_UTF8_STRING)
311
0
            return 0;
312
2.53k
        properties = p->data;
313
2.53k
    }
314
315
    /* If we got a new mac name, we make a new EVP_MAC_CTX */
316
62.9k
    if (macname != NULL) {
317
62.9k
        EVP_MAC *mac = EVP_MAC_fetch(libctx, macname, properties);
318
319
62.9k
        EVP_MAC_CTX_free(*macctx);
320
62.9k
        *macctx = mac == NULL ? NULL : EVP_MAC_CTX_new(mac);
321
        /* The context holds on to the MAC */
322
62.9k
        EVP_MAC_free(mac);
323
62.9k
        if (*macctx == NULL)
324
176
            return 0;
325
62.9k
    }
326
327
    /*
328
     * If there is no MAC yet (and therefore, no MAC context), we ignore
329
     * all other parameters.
330
     */
331
62.8k
    if (*macctx == NULL)
332
0
        return 1;
333
334
62.8k
    if (ossl_prov_set_macctx(*macctx, params, ciphername, mdname, NULL,
335
62.8k
            properties, NULL, 0))
336
62.0k
        return 1;
337
338
782
    EVP_MAC_CTX_free(*macctx);
339
782
    *macctx = NULL;
340
782
    return 0;
341
62.8k
}
342
343
void ossl_prov_cache_exported_algorithms(const OSSL_ALGORITHM_CAPABLE *in,
344
    OSSL_ALGORITHM *out)
345
99
{
346
99
    int i, j;
347
348
99
    if (out[0].algorithm_names == NULL) {
349
12.7k
        for (i = j = 0; in[i].alg.algorithm_names != NULL; ++i) {
350
12.6k
            if (in[i].capable == NULL || in[i].capable())
351
12.3k
                out[j++] = in[i].alg;
352
12.6k
        }
353
95
        out[j++] = in[i].alg;
354
95
    }
355
99
}