Coverage Report

Created: 2026-07-16 06:59

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/providers/baseprov.c
Line
Count
Source
1
/*
2
 * Copyright 2020-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
#include <string.h>
11
#include <stdio.h>
12
#include <openssl/opensslconf.h>
13
#include <openssl/core.h>
14
#include <openssl/core_dispatch.h>
15
#include <openssl/core_names.h>
16
#include <openssl/params.h>
17
#include "prov/bio.h"
18
#include "prov/provider_ctx.h"
19
#include "prov/providercommon.h"
20
#include "prov/implementations.h"
21
#include "prov/provider_util.h"
22
#include "prov/names.h"
23
24
/*
25
 * Forward declarations to ensure that interface functions are correctly
26
 * defined.
27
 */
28
static OSSL_FUNC_provider_gettable_params_fn base_gettable_params;
29
static OSSL_FUNC_provider_get_params_fn base_get_params;
30
static OSSL_FUNC_provider_query_operation_fn base_query;
31
32
/* Parameters we provide to the core */
33
static const OSSL_PARAM base_param_types[] = {
34
    OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
35
    OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
36
    OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
37
    OSSL_PARAM_DEFN(OSSL_PROV_PARAM_STATUS, OSSL_PARAM_INTEGER, NULL, 0),
38
    OSSL_PARAM_END
39
};
40
41
static const OSSL_PARAM *base_gettable_params(void *provctx)
42
0
{
43
0
    return base_param_types;
44
0
}
45
46
static int base_get_params(void *provctx, OSSL_PARAM params[])
47
0
{
48
0
    OSSL_PARAM *p;
49
50
0
    p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
51
0
    if (p != NULL
52
0
        && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL Base Provider"))
53
0
        return 0;
54
0
    p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
55
0
    if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
56
0
        return 0;
57
0
    p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
58
0
    if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
59
0
        return 0;
60
0
    p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_STATUS);
61
0
    if (p != NULL && !OSSL_PARAM_set_int(p, ossl_prov_is_running()))
62
0
        return 0;
63
64
0
    return 1;
65
0
}
66
67
static const OSSL_ALGORITHM base_encoder[] = {
68
#define ENCODER_PROVIDER "base"
69
#include "encoders.inc"
70
    { NULL, NULL, NULL }
71
#undef ENCODER_PROVIDER
72
};
73
74
static const OSSL_ALGORITHM base_decoder[] = {
75
#define DECODER_PROVIDER "base"
76
#include "decoders.inc"
77
    { NULL, NULL, NULL }
78
#undef DECODER_PROVIDER
79
};
80
81
static const OSSL_ALGORITHM base_store[] = {
82
#define STORE(name, _fips, func_table) \
83
    { name, "provider=base,fips=" _fips, (func_table) },
84
85
#include "stores.inc"
86
    { NULL, NULL, NULL }
87
#undef STORE
88
};
89
90
static const OSSL_ALGORITHM base_rands[] = {
91
    { PROV_NAMES_SEED_SRC, "provider=base", ossl_seed_src_functions },
92
#ifndef OPENSSL_NO_JITTER
93
    { PROV_NAMES_JITTER, "provider=base", ossl_jitter_functions },
94
#endif
95
    { NULL, NULL, NULL }
96
};
97
98
static const OSSL_ALGORITHM *base_query(void *provctx, int operation_id,
99
    int *no_cache)
100
0
{
101
0
    *no_cache = 0;
102
0
    switch (operation_id) {
103
0
    case OSSL_OP_ENCODER:
104
0
        return base_encoder;
105
0
    case OSSL_OP_DECODER:
106
0
        return base_decoder;
107
0
    case OSSL_OP_STORE:
108
0
        return base_store;
109
0
    case OSSL_OP_RAND:
110
0
        return base_rands;
111
0
    }
112
0
    return NULL;
113
0
}
114
115
static void base_teardown(void *provctx)
116
0
{
117
0
    BIO_meth_free(ossl_prov_ctx_get0_core_bio_method(provctx));
118
0
    ossl_prov_ctx_free(provctx);
119
0
}
120
121
/* Functions we provide to the core */
122
static const OSSL_DISPATCH base_dispatch_table[] = {
123
    { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))base_teardown },
124
    { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS,
125
        (void (*)(void))base_gettable_params },
126
    { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))base_get_params },
127
    { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))base_query },
128
    OSSL_DISPATCH_END
129
};
130
131
OSSL_provider_init_fn ossl_base_provider_init;
132
133
int ossl_base_provider_init(const OSSL_CORE_HANDLE *handle,
134
    const OSSL_DISPATCH *in, const OSSL_DISPATCH **out,
135
    void **provctx)
136
0
{
137
0
    OSSL_FUNC_core_get_libctx_fn *c_get_libctx = NULL;
138
0
    OSSL_FUNC_core_get_params_fn *c_get_params = NULL;
139
0
    BIO_METHOD *corebiometh;
140
141
0
    if (!ossl_prov_bio_from_dispatch(in))
142
0
        return 0;
143
0
    for (; in->function_id != 0; in++) {
144
0
        switch (in->function_id) {
145
0
        case OSSL_FUNC_CORE_GET_PARAMS:
146
0
            c_get_params = OSSL_FUNC_core_get_params(in);
147
0
            break;
148
0
        case OSSL_FUNC_CORE_GET_LIBCTX:
149
0
            c_get_libctx = OSSL_FUNC_core_get_libctx(in);
150
0
            break;
151
0
        default:
152
            /* Just ignore anything we don't understand */
153
0
            break;
154
0
        }
155
0
    }
156
157
0
    if (c_get_libctx == NULL)
158
0
        return 0;
159
160
    /*
161
     * We want to make sure that all calls from this provider that requires
162
     * a library context use the same context as the one used to call our
163
     * functions.  We do that by passing it along in the provider context.
164
     *
165
     * This only works for built-in providers.  Most providers should
166
     * create their own library context.
167
     */
168
0
    if ((*provctx = ossl_prov_ctx_new()) == NULL
169
0
        || (corebiometh = ossl_bio_prov_init_bio_method()) == NULL) {
170
0
        ossl_prov_ctx_free(*provctx);
171
0
        *provctx = NULL;
172
0
        return 0;
173
0
    }
174
0
    ossl_prov_ctx_set0_libctx(*provctx,
175
0
        (OSSL_LIB_CTX *)c_get_libctx(handle));
176
0
    ossl_prov_ctx_set0_handle(*provctx, handle);
177
0
    ossl_prov_ctx_set0_core_bio_method(*provctx, corebiometh);
178
0
    ossl_prov_ctx_set0_core_get_params(*provctx, c_get_params);
179
180
0
    *out = base_dispatch_table;
181
182
0
    return 1;
183
0
}