Coverage Report

Created: 2025-06-13 06:58

/src/openssl30/crypto/provider_conf.c
Line
Count
Source (jump to first uncovered line)
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
#include <string.h>
11
#include <openssl/trace.h>
12
#include <openssl/err.h>
13
#include <openssl/conf.h>
14
#include <openssl/safestack.h>
15
#include <openssl/provider.h>
16
#include "internal/provider.h"
17
#include "internal/cryptlib.h"
18
#include "provider_local.h"
19
20
DEFINE_STACK_OF(OSSL_PROVIDER)
21
22
/* PROVIDER config module */
23
24
typedef struct {
25
    CRYPTO_RWLOCK *lock;
26
    STACK_OF(OSSL_PROVIDER) *activated_providers;
27
} PROVIDER_CONF_GLOBAL;
28
29
static void *prov_conf_ossl_ctx_new(OSSL_LIB_CTX *libctx)
30
0
{
31
0
    PROVIDER_CONF_GLOBAL *pcgbl = OPENSSL_zalloc(sizeof(*pcgbl));
32
33
0
    if (pcgbl == NULL)
34
0
        return NULL;
35
36
0
    pcgbl->lock = CRYPTO_THREAD_lock_new();
37
0
    if (pcgbl->lock == NULL) {
38
0
        OPENSSL_free(pcgbl);
39
0
        return NULL;
40
0
    }
41
42
0
    return pcgbl;
43
0
}
44
45
static void prov_conf_ossl_ctx_free(void *vpcgbl)
46
0
{
47
0
    PROVIDER_CONF_GLOBAL *pcgbl = vpcgbl;
48
49
0
    sk_OSSL_PROVIDER_pop_free(pcgbl->activated_providers,
50
0
                              ossl_provider_free);
51
52
0
    OSSL_TRACE(CONF, "Cleaned up providers\n");
53
0
    CRYPTO_THREAD_lock_free(pcgbl->lock);
54
0
    OPENSSL_free(pcgbl);
55
0
}
56
57
static const OSSL_LIB_CTX_METHOD provider_conf_ossl_ctx_method = {
58
    /* Must be freed before the provider store is freed */
59
    OSSL_LIB_CTX_METHOD_PRIORITY_2,
60
    prov_conf_ossl_ctx_new,
61
    prov_conf_ossl_ctx_free,
62
};
63
64
static const char *skip_dot(const char *name)
65
0
{
66
0
    const char *p = strchr(name, '.');
67
68
0
    if (p != NULL)
69
0
        return p + 1;
70
0
    return name;
71
0
}
72
73
/*
74
 * Parse the provider params section
75
 * Returns:
76
 * 1 for success
77
 * 0 for non-fatal errors
78
 * < 0 for fatal errors
79
 */
80
static int provider_conf_params_internal(OSSL_PROVIDER *prov,
81
                                         OSSL_PROVIDER_INFO *provinfo,
82
                                         const char *name, const char *value,
83
                                         const CONF *cnf,
84
                                         STACK_OF(OPENSSL_CSTRING) *visited)
85
0
{
86
0
    STACK_OF(CONF_VALUE) *sect;
87
0
    int ok = 1;
88
0
    int rc = 0;
89
90
0
    sect = NCONF_get_section(cnf, value);
91
0
    if (sect != NULL) {
92
0
        int i;
93
0
        char buffer[512];
94
0
        size_t buffer_len = 0;
95
96
0
        OSSL_TRACE1(CONF, "Provider params: start section %s\n", value);
97
98
        /*
99
         * Check to see if the provided section value has already
100
         * been visited.  If it has, then we have a recursive lookup
101
         * in the configuration which isn't valid.  As such we should error
102
         * out
103
         */
104
0
        for (i = 0; i < sk_OPENSSL_CSTRING_num(visited); i++) {
105
0
            if (sk_OPENSSL_CSTRING_value(visited, i) == value) {
106
0
                ERR_raise(ERR_LIB_CONF, CONF_R_RECURSIVE_SECTION_REFERENCE);
107
0
                return -1;
108
0
            }
109
0
        }
110
111
        /*
112
         * We've not visited this node yet, so record it on the stack
113
         */
114
0
        if (!sk_OPENSSL_CSTRING_push(visited, value))
115
0
            return -1;
116
117
0
        if (name != NULL) {
118
0
            OPENSSL_strlcpy(buffer, name, sizeof(buffer));
119
0
            OPENSSL_strlcat(buffer, ".", sizeof(buffer));
120
0
            buffer_len = strlen(buffer);
121
0
        }
122
123
0
        for (i = 0; i < sk_CONF_VALUE_num(sect); i++) {
124
0
            CONF_VALUE *sectconf = sk_CONF_VALUE_value(sect, i);
125
126
0
            if (buffer_len + strlen(sectconf->name) >= sizeof(buffer)) {
127
0
                sk_OPENSSL_CSTRING_pop(visited);
128
0
                return -1;
129
0
            }
130
0
            buffer[buffer_len] = '\0';
131
0
            OPENSSL_strlcat(buffer, sectconf->name, sizeof(buffer));
132
0
            rc = provider_conf_params_internal(prov, provinfo, buffer,
133
0
                                               sectconf->value, cnf, visited);
134
0
            if (rc < 0) {
135
0
                sk_OPENSSL_CSTRING_pop(visited);
136
0
                return rc;
137
0
            }
138
0
        }
139
0
        sk_OPENSSL_CSTRING_pop(visited);
140
141
0
        OSSL_TRACE1(CONF, "Provider params: finish section %s\n", value);
142
0
    } else {
143
0
        OSSL_TRACE2(CONF, "Provider params: %s = %s\n", name, value);
144
0
        if (prov != NULL)
145
0
            ok = ossl_provider_add_parameter(prov, name, value);
146
0
        else
147
0
            ok = ossl_provider_info_add_parameter(provinfo, name, value);
148
0
    }
149
150
0
    return ok;
151
0
}
152
153
/*
154
 * recursively parse the provider configuration section
155
 * of the config file. 
156
 * Returns
157
 * 1 on success
158
 * 0 on non-fatal error
159
 * < 0 on fatal errors
160
 */
161
static int provider_conf_params(OSSL_PROVIDER *prov,
162
                                OSSL_PROVIDER_INFO *provinfo,
163
                                const char *name, const char *value,
164
                                const CONF *cnf)
165
0
{
166
0
    int rc;
167
0
    STACK_OF(OPENSSL_CSTRING) *visited = sk_OPENSSL_CSTRING_new_null();
168
169
0
    if (visited == NULL)
170
0
        return -1;
171
172
0
    rc = provider_conf_params_internal(prov, provinfo, name,
173
0
                                       value, cnf, visited);
174
175
0
    sk_OPENSSL_CSTRING_free(visited);
176
177
0
    return rc;
178
0
}
179
180
static int prov_already_activated(const char *name,
181
                                  STACK_OF(OSSL_PROVIDER) *activated)
182
0
{
183
0
    int i, max;
184
185
0
    if (activated == NULL)
186
0
        return 0;
187
188
0
    max = sk_OSSL_PROVIDER_num(activated);
189
0
    for (i = 0; i < max; i++) {
190
0
        OSSL_PROVIDER *tstprov = sk_OSSL_PROVIDER_value(activated, i);
191
192
0
        if (strcmp(OSSL_PROVIDER_get0_name(tstprov), name) == 0) {
193
0
            return 1;
194
0
        }
195
0
    }
196
197
0
    return 0;
198
0
}
199
200
static int provider_conf_load(OSSL_LIB_CTX *libctx, const char *name,
201
                              const char *value, const CONF *cnf)
202
0
{
203
0
    int i;
204
0
    STACK_OF(CONF_VALUE) *ecmds;
205
0
    int soft = 0;
206
0
    OSSL_PROVIDER *prov = NULL, *actual = NULL;
207
0
    const char *path = NULL;
208
0
    long activate = 0;
209
0
    int ok = 0;
210
0
    int added = 0;
211
212
0
    name = skip_dot(name);
213
0
    OSSL_TRACE1(CONF, "Configuring provider %s\n", name);
214
    /* Value is a section containing PROVIDER commands */
215
0
    ecmds = NCONF_get_section(cnf, value);
216
217
0
    if (!ecmds) {
218
0
        ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_SECTION_ERROR,
219
0
                       "section=%s not found", value);
220
0
        return 0;
221
0
    }
222
223
    /* Find the needed data first */
224
0
    for (i = 0; i < sk_CONF_VALUE_num(ecmds); i++) {
225
0
        CONF_VALUE *ecmd = sk_CONF_VALUE_value(ecmds, i);
226
0
        const char *confname = skip_dot(ecmd->name);
227
0
        const char *confvalue = ecmd->value;
228
229
0
        OSSL_TRACE2(CONF, "Provider command: %s = %s\n",
230
0
                    confname, confvalue);
231
232
        /* First handle some special pseudo confs */
233
234
        /* Override provider name to use */
235
0
        if (strcmp(confname, "identity") == 0)
236
0
            name = confvalue;
237
0
        else if (strcmp(confname, "soft_load") == 0)
238
0
            soft = 1;
239
        /* Load a dynamic PROVIDER */
240
0
        else if (strcmp(confname, "module") == 0)
241
0
            path = confvalue;
242
0
        else if (strcmp(confname, "activate") == 0)
243
0
            activate = 1;
244
0
    }
245
246
0
    if (activate) {
247
0
        PROVIDER_CONF_GLOBAL *pcgbl
248
0
            = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_PROVIDER_CONF_INDEX,
249
0
                                    &provider_conf_ossl_ctx_method);
250
251
0
        if (pcgbl == NULL || !CRYPTO_THREAD_write_lock(pcgbl->lock)) {
252
0
            ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
253
0
            return 0;
254
0
        }
255
0
        if (!prov_already_activated(name, pcgbl->activated_providers)) {
256
            /*
257
            * There is an attempt to activate a provider, so we should disable
258
            * loading of fallbacks. Otherwise a misconfiguration could mean the
259
            * intended provider does not get loaded. Subsequent fetches could
260
            * then fallback to the default provider - which may be the wrong
261
            * thing.
262
            */
263
0
            if (!ossl_provider_disable_fallback_loading(libctx)) {
264
0
                CRYPTO_THREAD_unlock(pcgbl->lock);
265
0
                ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
266
0
                return 0;
267
0
            }
268
0
            prov = ossl_provider_find(libctx, name, 1);
269
0
            if (prov == NULL)
270
0
                prov = ossl_provider_new(libctx, name, NULL, 1);
271
0
            if (prov == NULL) {
272
0
                CRYPTO_THREAD_unlock(pcgbl->lock);
273
0
                if (soft)
274
0
                    ERR_clear_error();
275
0
                return 0;
276
0
            }
277
278
0
            if (path != NULL)
279
0
                ossl_provider_set_module_path(prov, path);
280
281
0
            ok = provider_conf_params(prov, NULL, NULL, value, cnf);
282
283
0
            if (ok > 0) {
284
0
                if (!ossl_provider_activate(prov, 1, 0)) {
285
0
                    ok = 0;
286
0
                } else if (!ossl_provider_add_to_store(prov, &actual, 0)) {
287
0
                    ossl_provider_deactivate(prov, 1);
288
0
                    ok = 0;
289
0
                } else if (actual != prov
290
0
                           && !ossl_provider_activate(actual, 1, 0)) {
291
0
                    ossl_provider_free(actual);
292
0
                    ok = 0;
293
0
                } else {
294
0
                    if (pcgbl->activated_providers == NULL)
295
0
                        pcgbl->activated_providers = sk_OSSL_PROVIDER_new_null();
296
0
                    if (pcgbl->activated_providers == NULL
297
0
                        || !sk_OSSL_PROVIDER_push(pcgbl->activated_providers,
298
0
                                                  actual)) {
299
0
                        ossl_provider_deactivate(actual, 1);
300
0
                        ossl_provider_free(actual);
301
0
                        ok = 0;
302
0
                    } else {
303
0
                        ok = 1;
304
0
                    }
305
0
                }
306
0
            }
307
0
            if (ok <= 0)
308
0
                ossl_provider_free(prov);
309
0
        }
310
0
        CRYPTO_THREAD_unlock(pcgbl->lock);
311
0
    } else {
312
0
        OSSL_PROVIDER_INFO entry;
313
314
0
        memset(&entry, 0, sizeof(entry));
315
0
        ok = 1;
316
0
        if (name != NULL) {
317
0
            entry.name = OPENSSL_strdup(name);
318
0
            if (entry.name == NULL) {
319
0
                ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
320
0
                ok = 0;
321
0
            }
322
0
        }
323
0
        if (ok && path != NULL) {
324
0
            entry.path = OPENSSL_strdup(path);
325
0
            if (entry.path == NULL) {
326
0
                ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
327
0
                ok = 0;
328
0
            }
329
0
        }
330
0
        if (ok)
331
0
            ok = provider_conf_params(NULL, &entry, NULL, value, cnf);
332
0
        if (ok >= 1 && (entry.path != NULL || entry.parameters != NULL)) {
333
0
            ok = ossl_provider_info_add_to_store(libctx, &entry);
334
0
            added = ok;
335
0
        }
336
0
        if (added == 0)
337
0
            ossl_provider_info_clear(&entry);
338
0
    }
339
340
    /*
341
     * Provider activation returns a tristate:
342
     * 1 for successful activation
343
     * 0 for non-fatal activation failure
344
     * < 0 for fatal activation failure
345
     * We return success (1) for activation, (1) for non-fatal activation
346
     * failure, and (0) for fatal activation failure
347
     */
348
0
    return ok >= 0;
349
0
}
350
351
static int provider_conf_init(CONF_IMODULE *md, const CONF *cnf)
352
0
{
353
0
    STACK_OF(CONF_VALUE) *elist;
354
0
    CONF_VALUE *cval;
355
0
    int i;
356
357
0
    OSSL_TRACE1(CONF, "Loading providers module: section %s\n",
358
0
                CONF_imodule_get_value(md));
359
360
    /* Value is a section containing PROVIDERs to configure */
361
0
    elist = NCONF_get_section(cnf, CONF_imodule_get_value(md));
362
363
0
    if (!elist) {
364
0
        ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_SECTION_ERROR);
365
0
        return 0;
366
0
    }
367
368
0
    for (i = 0; i < sk_CONF_VALUE_num(elist); i++) {
369
0
        cval = sk_CONF_VALUE_value(elist, i);
370
0
        if (!provider_conf_load(NCONF_get0_libctx((CONF *)cnf),
371
0
                                cval->name, cval->value, cnf))
372
0
            return 0;
373
0
    }
374
375
0
    return 1;
376
0
}
377
378
void ossl_provider_add_conf_module(void)
379
0
{
380
0
    OSSL_TRACE(CONF, "Adding config module 'providers'\n");
381
0
    CONF_module_add("providers", provider_conf_init, NULL);
382
0
}