2 * Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
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
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>
18 #include "prov/provider_ctx.h"
19 #include "prov/providercommon.h"
20 #include "prov/implementations.h"
21 #include "prov/provider_util.h"
24 * Forward declarations to ensure that interface functions are correctly
27 static OSSL_FUNC_provider_gettable_params_fn base_gettable_params;
28 static OSSL_FUNC_provider_get_params_fn base_get_params;
29 static OSSL_FUNC_provider_query_operation_fn base_query;
31 /* Functions provided by the core */
32 static OSSL_FUNC_core_gettable_params_fn *c_gettable_params = NULL;
33 static OSSL_FUNC_core_get_params_fn *c_get_params = NULL;
35 /* Parameters we provide to the core */
36 static const OSSL_PARAM base_param_types[] = {
37 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
38 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
39 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
40 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_STATUS, OSSL_PARAM_INTEGER, NULL, 0),
44 static const OSSL_PARAM *base_gettable_params(void *provctx)
46 return base_param_types;
49 static int base_get_params(void *provctx, OSSL_PARAM params[])
53 p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
55 && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL Base Provider"))
57 p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
58 if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
60 p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
61 if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
63 p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_STATUS);
64 if (p != NULL && !OSSL_PARAM_set_int(p, ossl_prov_is_running()))
70 static const OSSL_ALGORITHM base_encoder[] = {
71 #define ENCODER_PROVIDER "base"
72 #include "encoders.inc"
74 #undef ENCODER_PROVIDER
77 static const OSSL_ALGORITHM base_decoder[] = {
78 #define DECODER_PROVIDER "base"
79 #include "decoders.inc"
81 #undef DECODER_PROVIDER
84 static const OSSL_ALGORITHM base_store[] = {
85 #define STORE(name, _fips, func_table) \
86 { name, "provider=base,fips=" _fips, (func_table) },
93 static const OSSL_ALGORITHM *base_query(void *provctx, int operation_id,
97 switch (operation_id) {
100 case OSSL_OP_DECODER:
108 static void base_teardown(void *provctx)
110 BIO_meth_free(ossl_prov_ctx_get0_core_bio_method(provctx));
111 ossl_prov_ctx_free(provctx);
114 /* Functions we provide to the core */
115 static const OSSL_DISPATCH base_dispatch_table[] = {
116 { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))base_teardown },
117 { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS,
118 (void (*)(void))base_gettable_params },
119 { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))base_get_params },
120 { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))base_query },
124 OSSL_provider_init_fn ossl_base_provider_init;
126 int ossl_base_provider_init(const OSSL_CORE_HANDLE *handle,
127 const OSSL_DISPATCH *in, const OSSL_DISPATCH **out,
130 OSSL_FUNC_core_get_libctx_fn *c_get_libctx = NULL;
131 BIO_METHOD *corebiometh;
133 if (!ossl_prov_bio_from_dispatch(in))
135 for (; in->function_id != 0; in++) {
136 switch (in->function_id) {
137 case OSSL_FUNC_CORE_GETTABLE_PARAMS:
138 c_gettable_params = OSSL_FUNC_core_gettable_params(in);
140 case OSSL_FUNC_CORE_GET_PARAMS:
141 c_get_params = OSSL_FUNC_core_get_params(in);
143 case OSSL_FUNC_CORE_GET_LIBCTX:
144 c_get_libctx = OSSL_FUNC_core_get_libctx(in);
147 /* Just ignore anything we don't understand */
152 if (c_get_libctx == NULL)
156 * We want to make sure that all calls from this provider that requires
157 * a library context use the same context as the one used to call our
158 * functions. We do that by passing it along in the provider context.
160 * This only works for built-in providers. Most providers should
161 * create their own library context.
163 if ((*provctx = ossl_prov_ctx_new()) == NULL
164 || (corebiometh = ossl_bio_prov_init_bio_method()) == NULL) {
165 ossl_prov_ctx_free(*provctx);
169 ossl_prov_ctx_set0_libctx(*provctx,
170 (OSSL_LIB_CTX *)c_get_libctx(handle));
171 ossl_prov_ctx_set0_handle(*provctx, handle);
172 ossl_prov_ctx_set0_core_bio_method(*provctx, corebiometh);
174 *out = base_dispatch_table;