PROV: Re-implement all the keypair decoders
[openssl.git] / providers / baseprov.c
1 /*
2  * Copyright 2020 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 "internal/nelem.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 /* Functions provided by the core */
33 static OSSL_FUNC_core_gettable_params_fn *c_gettable_params = NULL;
34 static OSSL_FUNC_core_get_params_fn *c_get_params = NULL;
35
36 /* Parameters we provide to the core */
37 static const OSSL_PARAM base_param_types[] = {
38     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
39     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
40     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
41     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_STATUS, OSSL_PARAM_INTEGER, NULL, 0),
42     OSSL_PARAM_END
43 };
44
45 static const OSSL_PARAM *base_gettable_params(void *provctx)
46 {
47     return base_param_types;
48 }
49
50 static int base_get_params(void *provctx, OSSL_PARAM params[])
51 {
52     OSSL_PARAM *p;
53
54     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
55     if (p != NULL
56             && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL Base Provider"))
57         return 0;
58     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
59     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
60         return 0;
61     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
62     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
63         return 0;
64     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_STATUS);
65     if (p != NULL && !OSSL_PARAM_set_int(p, ossl_prov_is_running()))
66         return 0;
67
68     return 1;
69 }
70
71 static const OSSL_ALGORITHM base_encoder[] = {
72 #define ENCODER(name, _fips, _output, func_table)                           \
73     { name,                                                                 \
74       "provider=base,fips=" _fips ",output=" _output,                       \
75       (func_table) }
76
77 #include "encoders.inc"
78     { NULL, NULL, NULL }
79 };
80 #undef ENCODER
81
82 static const OSSL_ALGORITHM base_decoder[] = {
83 #define DECODER_PROVIDER "base"
84 #include "decoders.inc"
85     { NULL, NULL, NULL }
86 #undef DECODER_PROVIDER
87 };
88
89 static const OSSL_ALGORITHM base_store[] = {
90 #define STORE(name, _fips, func_table)                           \
91     { name, "provider=base,fips=" _fips, (func_table) },
92
93 #include "stores.inc"
94     { NULL, NULL, NULL }
95 #undef STORE
96 };
97
98 static const OSSL_ALGORITHM *base_query(void *provctx, int operation_id,
99                                          int *no_cache)
100 {
101     *no_cache = 0;
102     switch (operation_id) {
103     case OSSL_OP_ENCODER:
104         return base_encoder;
105     case OSSL_OP_DECODER:
106         return base_decoder;
107     case OSSL_OP_STORE:
108         return base_store;
109     }
110     return NULL;
111 }
112
113 static void base_teardown(void *provctx)
114 {
115     BIO_meth_free(ossl_prov_ctx_get0_core_bio_method(provctx));
116     ossl_prov_ctx_free(provctx);
117 }
118
119 /* Functions we provide to the core */
120 static const OSSL_DISPATCH base_dispatch_table[] = {
121     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))base_teardown },
122     { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS,
123       (void (*)(void))base_gettable_params },
124     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))base_get_params },
125     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))base_query },
126     { 0, NULL }
127 };
128
129 OSSL_provider_init_fn ossl_base_provider_init;
130
131 int ossl_base_provider_init(const OSSL_CORE_HANDLE *handle,
132                             const OSSL_DISPATCH *in, const OSSL_DISPATCH **out,
133                             void **provctx)
134 {
135     OSSL_FUNC_core_get_libctx_fn *c_get_libctx = NULL;
136     BIO_METHOD *corebiometh;
137
138     if (!ossl_prov_bio_from_dispatch(in))
139         return 0;
140     for (; in->function_id != 0; in++) {
141         switch (in->function_id) {
142         case OSSL_FUNC_CORE_GETTABLE_PARAMS:
143             c_gettable_params = OSSL_FUNC_core_gettable_params(in);
144             break;
145         case OSSL_FUNC_CORE_GET_PARAMS:
146             c_get_params = OSSL_FUNC_core_get_params(in);
147             break;
148         case OSSL_FUNC_CORE_GET_LIBCTX:
149             c_get_libctx = OSSL_FUNC_core_get_libctx(in);
150             break;
151         default:
152             /* Just ignore anything we don't understand */
153             break;
154         }
155     }
156
157     if (c_get_libctx == NULL)
158         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     if ((*provctx = ossl_prov_ctx_new()) == NULL
169             || (corebiometh = bio_prov_init_bio_method()) == NULL) {
170         ossl_prov_ctx_free(*provctx);
171         *provctx = NULL;
172         return 0;
173     }
174     ossl_prov_ctx_set0_libctx(*provctx,
175                                        (OSSL_LIB_CTX *)c_get_libctx(handle));
176     ossl_prov_ctx_set0_handle(*provctx, handle);
177     ossl_prov_ctx_set0_core_bio_method(*provctx, corebiometh);
178
179     *out = base_dispatch_table;
180
181     return 1;
182 }