1f0626164b6dc20b7cfb42142a071c1e4e4726ac
[openssl.git] / providers / default / defltprov.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/opensslconf.h>
13 #include <openssl/core.h>
14 #include <openssl/core_numbers.h>
15 #include <openssl/core_names.h>
16 #include <openssl/params.h>
17 #include "internal/provider_algs.h"
18
19 /* Functions provided by the core */
20 static OSSL_core_gettable_params_fn *c_gettable_params = NULL;
21 static OSSL_core_get_params_fn *c_get_params = NULL;
22
23 /* Parameters we provide to the core */
24 static const OSSL_PARAM deflt_param_types[] = {
25     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
26     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
27     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
28     OSSL_PARAM_END
29 };
30
31 static const OSSL_PARAM *deflt_gettable_params(const OSSL_PROVIDER *prov)
32 {
33     return deflt_param_types;
34 }
35
36 static int deflt_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
37 {
38     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 Default 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 deflt_digests[] = {
54     { "SHA1", "default=yes", sha1_functions },
55
56     { "SHA224", "default=yes", sha224_functions },
57     { "SHA256", "default=yes", sha256_functions },
58     { "SHA384", "default=yes", sha384_functions },
59     { "SHA512", "default=yes", sha512_functions },
60     { "SHA512-224", "default=yes", sha512_224_functions },
61     { "SHA512-256", "default=yes", sha512_256_functions },
62
63     { "SHA3-224", "default=yes", sha3_224_functions },
64     { "SHA3-256", "default=yes", sha3_256_functions },
65     { "SHA3-384", "default=yes", sha3_384_functions },
66     { "SHA3-512", "default=yes", sha3_512_functions },
67
68     /*
69      * KMAC128 and KMAC256 as hashes are mostly useful for the MACs with the
70      * same names
71      */
72     { "KMAC128", "default=yes", keccak_kmac_128_functions },
73     { "KMAC256", "default=yes", keccak_kmac_256_functions },
74
75     { "SHAKE128", "default=yes", shake_128_functions },
76     { "SHAKE256", "default=yes", shake_256_functions },
77
78 #ifndef OPENSSL_NO_BLAKE2
79     { "BLAKE2s256", "default=yes", blake2s256_functions },
80     { "BLAKE2b512", "default=yes", blake2b512_functions },
81 #endif /* OPENSSL_NO_BLAKE2 */
82
83 #ifndef OPENSSL_NO_SM3
84     { "SM3", "default=yes", sm3_functions },
85 #endif /* OPENSSL_NO_SM3 */
86
87 #ifndef OPENSSL_NO_MD5
88     { "MD5", "default=yes", md5_functions },
89     { "MD5-SHA1", "default=yes", md5_sha1_functions },
90 #endif /* OPENSSL_NO_MD5 */
91
92     /*{ "UNDEF", "default=yes", nullmd_functions }, */
93
94     { NULL, NULL, NULL }
95 };
96
97 static const OSSL_ALGORITHM deflt_ciphers[] = {
98     { "AES-256-ECB", "default=yes", aes256ecb_functions },
99     { "AES-192-ECB", "default=yes", aes192ecb_functions },
100     { "AES-128-ECB", "default=yes", aes128ecb_functions },
101     { "AES-256-CBC", "default=yes", aes256cbc_functions },
102     { "AES-192-CBC", "default=yes", aes192cbc_functions },
103     { "AES-128-CBC", "default=yes", aes128cbc_functions },
104     { "AES-256-OFB", "default=yes", aes256ofb_functions },
105     { "AES-192-OFB", "default=yes", aes192ofb_functions },
106     { "AES-128-OFB", "default=yes", aes128ofb_functions },
107     { "AES-256-CFB", "default=yes", aes256cfb_functions },
108     { "AES-192-CFB", "default=yes", aes192cfb_functions },
109     { "AES-128-CFB", "default=yes", aes128cfb_functions },
110     { "AES-256-CFB1", "default=yes", aes256cfb1_functions },
111     { "AES-192-CFB1", "default=yes", aes192cfb1_functions },
112     { "AES-128-CFB1", "default=yes", aes128cfb1_functions },
113     { "AES-256-CFB8", "default=yes", aes256cfb8_functions },
114     { "AES-192-CFB8", "default=yes", aes192cfb8_functions },
115     { "AES-128-CFB8", "default=yes", aes128cfb8_functions },
116     { "AES-256-CTR", "default=yes", aes256ctr_functions },
117     { "AES-192-CTR", "default=yes", aes192ctr_functions },
118     { "AES-128-CTR", "default=yes", aes128ctr_functions },
119     { "id-aes256-GCM", "default=yes", aes256gcm_functions },
120     { "id-aes192-GCM", "default=yes", aes192gcm_functions },
121     { "id-aes128-GCM", "default=yes", aes128gcm_functions },
122 #ifndef OPENSSL_NO_ARIA
123     { "ARIA-256-GCM", "default=yes", aria256gcm_functions },
124     { "ARIA-192-GCM", "default=yes", aria192gcm_functions },
125     { "ARIA-128-GCM", "default=yes", aria128gcm_functions },
126 #endif /* OPENSSL_NO_ARIA */
127     { NULL, NULL, NULL }
128 };
129
130 static const OSSL_ALGORITHM deflt_macs[] = {
131 #ifndef OPENSSL_NO_BLAKE2
132     { "BLAKE2BMAC", "default=yes", blake2bmac_functions },
133     { "BLAKE2SMAC", "default=yes", blake2smac_functions },
134 #endif
135 #ifndef OPENSSL_NO_CMAC
136     { "CMAC", "default=yes", cmac_functions },
137 #endif
138     { "GMAC", "default=yes", gmac_functions },
139     { "HMAC", "default=yes", hmac_functions },
140     { "KMAC128", "default=yes", kmac128_functions },
141     { "KMAC256", "default=yes", kmac256_functions },
142 #ifndef OPENSSL_NO_SIPHASH
143     { "SipHash", "default=yes", siphash_functions },
144 #endif
145     { NULL, NULL, NULL }
146 };
147
148 static const OSSL_ALGORITHM deflt_keyexch[] = {
149 #ifndef OPENSSL_NO_DH
150     { "dhKeyAgreement", "default=yes", dh_keyexch_functions },
151 #endif
152     { NULL, NULL, NULL }
153 };
154
155 static const OSSL_ALGORITHM deflt_keymgmt[] = {
156 #ifndef OPENSSL_NO_DH
157     { "dhKeyAgreement", "default=yes", dh_keymgmt_functions },
158 #endif
159     { NULL, NULL, NULL }
160 };
161
162 static const OSSL_ALGORITHM *deflt_query(OSSL_PROVIDER *prov,
163                                          int operation_id,
164                                          int *no_cache)
165 {
166     *no_cache = 0;
167     switch (operation_id) {
168     case OSSL_OP_DIGEST:
169         return deflt_digests;
170     case OSSL_OP_CIPHER:
171         return deflt_ciphers;
172     case OSSL_OP_MAC:
173         return deflt_macs;
174     case OSSL_OP_KEYMGMT:
175         return deflt_keymgmt;
176     case OSSL_OP_KEYEXCH:
177         return deflt_keyexch;
178     }
179     return NULL;
180 }
181
182 /* Functions we provide to the core */
183 static const OSSL_DISPATCH deflt_dispatch_table[] = {
184     { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))deflt_gettable_params },
185     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))deflt_get_params },
186     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))deflt_query },
187     { 0, NULL }
188 };
189
190 OSSL_provider_init_fn ossl_default_provider_init;
191
192 int ossl_default_provider_init(const OSSL_PROVIDER *provider,
193                                const OSSL_DISPATCH *in,
194                                const OSSL_DISPATCH **out,
195                                void **provctx)
196 {
197     OSSL_core_get_library_context_fn *c_get_libctx = NULL;
198
199     for (; in->function_id != 0; in++) {
200         switch (in->function_id) {
201         case OSSL_FUNC_CORE_GETTABLE_PARAMS:
202             c_gettable_params = OSSL_get_core_gettable_params(in);
203             break;
204         case OSSL_FUNC_CORE_GET_PARAMS:
205             c_get_params = OSSL_get_core_get_params(in);
206             break;
207         case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
208             c_get_libctx = OSSL_get_core_get_library_context(in);
209             break;
210         default:
211             /* Just ignore anything we don't understand */
212             break;
213         }
214     }
215
216     if (c_get_libctx == NULL)
217         return 0;
218
219     *out = deflt_dispatch_table;
220
221     /*
222      * We want to make sure that all calls from this provider that requires
223      * a library context use the same context as the one used to call our
224      * functions.  We do that by passing it along as the provider context.
225      */
226     *provctx = c_get_libctx(provider);
227     return 1;
228 }