Replumbing: Adapt the default and legacy providers to use library context upcall
[openssl.git] / providers / legacy / legacyprov.c
1 /*
2  * Copyright 2019 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/core.h>
13 #include <openssl/core_numbers.h>
14 #include <openssl/core_names.h>
15 #include <openssl/params.h>
16 #include "internal/provider_algs.h"
17
18 /* Functions provided by the core */
19 static OSSL_core_get_param_types_fn *c_get_param_types = NULL;
20 static OSSL_core_get_params_fn *c_get_params = NULL;
21
22 /* Parameters we provide to the core */
23 static const OSSL_ITEM legacy_param_types[] = {
24     { OSSL_PARAM_UTF8_PTR, OSSL_PROV_PARAM_NAME },
25     { OSSL_PARAM_UTF8_PTR, OSSL_PROV_PARAM_VERSION },
26     { OSSL_PARAM_UTF8_PTR, OSSL_PROV_PARAM_BUILDINFO },
27     { 0, NULL }
28 };
29
30 static const OSSL_ITEM *legacy_get_param_types(const OSSL_PROVIDER *prov)
31 {
32     return legacy_param_types;
33 }
34
35 static int legacy_get_params(const OSSL_PROVIDER *prov,
36                             const OSSL_PARAM params[])
37 {
38     const OSSL_PARAM *p;
39
40     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
41     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL Legacy Provider"))
42         return 0;
43     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
44     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
45         return 0;
46     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
47     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
48         return 0;
49
50     return 1;
51 }
52
53 static const OSSL_ALGORITHM legacy_digests[] = {
54 #ifndef OPENSSL_NO_MD2
55     { "MD2", "legacy=yes", md2_functions },
56 #endif
57
58 #ifndef OPENSSL_NO_MD4
59     { "MD4", "legacy=yes", md4_functions },
60 #endif
61
62 #ifndef OPENSSL_NO_MDC2
63     { "MDC2", "legacy=yes", mdc2_functions },
64 #endif /* OPENSSL_NO_MDC2 */
65
66 #ifndef OPENSSL_NO_WHIRLPOOL
67     { "whirlpool", "legacy=yes", wp_functions },
68 #endif /* OPENSSL_NO_WHIRLPOOL */
69
70 #ifndef OPENSSL_NO_RMD160
71     { "RIPEMD160", "legacy=yes", ripemd160_functions },
72 #endif /* OPENSSL_NO_RMD160 */
73
74     { NULL, NULL, NULL }
75 };
76
77 static const OSSL_ALGORITHM *legacy_query(OSSL_PROVIDER *prov,
78                                           int operation_id,
79                                           int *no_cache)
80 {
81     *no_cache = 0;
82     switch (operation_id) {
83     case OSSL_OP_DIGEST:
84         return legacy_digests;
85     }
86     return NULL;
87 }
88
89 /* Functions we provide to the core */
90 static const OSSL_DISPATCH legacy_dispatch_table[] = {
91     { OSSL_FUNC_PROVIDER_GET_PARAM_TYPES, (void (*)(void))legacy_get_param_types },
92     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))legacy_get_params },
93     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))legacy_query },
94     { 0, NULL }
95 };
96
97 int OSSL_provider_init(const OSSL_PROVIDER *provider,
98                        const OSSL_DISPATCH *in,
99                        const OSSL_DISPATCH **out,
100                        void **provctx)
101 {
102     OSSL_core_get_library_context_fn *c_get_libctx = NULL;
103
104     for (; in->function_id != 0; in++) {
105         switch (in->function_id) {
106         case OSSL_FUNC_CORE_GET_PARAM_TYPES:
107             c_get_param_types = OSSL_get_core_get_param_types(in);
108             break;
109         case OSSL_FUNC_CORE_GET_PARAMS:
110             c_get_params = OSSL_get_core_get_params(in);
111             break;
112         case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
113             c_get_libctx = OSSL_get_core_get_library_context(in);
114             break;
115         /* Just ignore anything we don't understand */
116         default:
117             break;
118         }
119     }
120
121     if (c_get_libctx == NULL)
122         return 0;
123
124     *out = legacy_dispatch_table;
125
126     /*
127      * We want to make sure that all calls from this provider that requires
128      * a library context use the same context as the one used to call our
129      * functions.  We do that by passing it along as the provider context.
130      */
131     *provctx = c_get_libctx(provider);
132     return 1;
133 }