59a7b60e8389efe4055cf6145de7000737811746
[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      * KECCAK_KMAC128 and KECCAK_KMAC256 as hashes are mostly useful for
70      * the KMAC128 and KMAC256.
71      */
72     { "KECCAK_KMAC128", "default=yes", keccak_kmac_128_functions },
73     { "KECCAK_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     { NULL, NULL, NULL }
93 };
94
95 static const OSSL_ALGORITHM deflt_ciphers[] = {
96     { "AES-256-ECB", "default=yes", aes256ecb_functions },
97     { "AES-192-ECB", "default=yes", aes192ecb_functions },
98     { "AES-128-ECB", "default=yes", aes128ecb_functions },
99     { "AES-256-CBC", "default=yes", aes256cbc_functions },
100     { "AES-192-CBC", "default=yes", aes192cbc_functions },
101     { "AES-128-CBC", "default=yes", aes128cbc_functions },
102     { "AES-256-OFB", "default=yes", aes256ofb_functions },
103     { "AES-192-OFB", "default=yes", aes192ofb_functions },
104     { "AES-128-OFB", "default=yes", aes128ofb_functions },
105     { "AES-256-CFB", "default=yes", aes256cfb_functions },
106     { "AES-192-CFB", "default=yes", aes192cfb_functions },
107     { "AES-128-CFB", "default=yes", aes128cfb_functions },
108     { "AES-256-CFB1", "default=yes", aes256cfb1_functions },
109     { "AES-192-CFB1", "default=yes", aes192cfb1_functions },
110     { "AES-128-CFB1", "default=yes", aes128cfb1_functions },
111     { "AES-256-CFB8", "default=yes", aes256cfb8_functions },
112     { "AES-192-CFB8", "default=yes", aes192cfb8_functions },
113     { "AES-128-CFB8", "default=yes", aes128cfb8_functions },
114     { "AES-256-CTR", "default=yes", aes256ctr_functions },
115     { "AES-192-CTR", "default=yes", aes192ctr_functions },
116     { "AES-128-CTR", "default=yes", aes128ctr_functions },
117     { "AES-256-XTS", "default=yes", aes256xts_functions },
118     { "AES-128-XTS", "default=yes", aes128xts_functions },
119 /* TODO(3.0) Add aliases when they are supported */
120     { "id-aes256-GCM", "default=yes", aes256gcm_functions },
121     { "id-aes192-GCM", "default=yes", aes192gcm_functions },
122     { "id-aes128-GCM", "default=yes", aes128gcm_functions },
123     { "id-aes256-CCM", "default=yes", aes256ccm_functions },
124     { "id-aes192-CCM", "default=yes", aes192ccm_functions },
125     { "id-aes128-CCM", "default=yes", aes128ccm_functions },
126 #ifndef OPENSSL_NO_ARIA
127     { "ARIA-256-GCM", "default=yes", aria256gcm_functions },
128     { "ARIA-192-GCM", "default=yes", aria192gcm_functions },
129     { "ARIA-128-GCM", "default=yes", aria128gcm_functions },
130     { "ARIA-256-CCM", "default=yes", aria256ccm_functions },
131     { "ARIA-192-CCM", "default=yes", aria192ccm_functions },
132     { "ARIA-128-CCM", "default=yes", aria128ccm_functions },
133     { "ARIA-256-ECB", "default=yes", aria256ecb_functions },
134     { "ARIA-192-ECB", "default=yes", aria192ecb_functions },
135     { "ARIA-128-ECB", "default=yes", aria128ecb_functions },
136     { "ARIA-256-CBC", "default=yes", aria256cbc_functions },
137     { "ARIA-192-CBC", "default=yes", aria192cbc_functions },
138     { "ARIA-128-CBC", "default=yes", aria128cbc_functions },
139     { "ARIA-256-OFB", "default=yes", aria256ofb_functions },
140     { "ARIA-192-OFB", "default=yes", aria192ofb_functions },
141     { "ARIA-128-OFB", "default=yes", aria128ofb_functions },
142     { "ARIA-256-CFB", "default=yes", aria256cfb_functions },
143     { "ARIA-192-CFB", "default=yes", aria192cfb_functions },
144     { "ARIA-128-CFB", "default=yes", aria128cfb_functions },
145     { "ARIA-256-CFB1", "default=yes", aria256cfb1_functions },
146     { "ARIA-192-CFB1", "default=yes", aria192cfb1_functions },
147     { "ARIA-128-CFB1", "default=yes", aria128cfb1_functions },
148     { "ARIA-256-CFB8", "default=yes", aria256cfb8_functions },
149     { "ARIA-192-CFB8", "default=yes", aria192cfb8_functions },
150     { "ARIA-128-CFB8", "default=yes", aria128cfb8_functions },
151     { "ARIA-256-CTR", "default=yes", aria256ctr_functions },
152     { "ARIA-192-CTR", "default=yes", aria192ctr_functions },
153     { "ARIA-128-CTR", "default=yes", aria128ctr_functions },
154 #endif /* OPENSSL_NO_ARIA */
155 #ifndef OPENSSL_NO_CAMELLIA
156     { "CAMELLIA-256-ECB", "default=yes", camellia256ecb_functions },
157     { "CAMELLIA-192-ECB", "default=yes", camellia192ecb_functions },
158     { "CAMELLIA-128-ECB", "default=yes", camellia128ecb_functions },
159     { "CAMELLIA-256-CBC", "default=yes", camellia256cbc_functions },
160     { "CAMELLIA-192-CBC", "default=yes", camellia192cbc_functions },
161     { "CAMELLIA-128-CBC", "default=yes", camellia128cbc_functions },
162     { "CAMELLIA-256-OFB", "default=yes", camellia256ofb_functions },
163     { "CAMELLIA-192-OFB", "default=yes", camellia192ofb_functions },
164     { "CAMELLIA-128-OFB", "default=yes", camellia128ofb_functions },
165     { "CAMELLIA-256-CFB", "default=yes", camellia256cfb_functions },
166     { "CAMELLIA-192-CFB", "default=yes", camellia192cfb_functions },
167     { "CAMELLIA-128-CFB", "default=yes", camellia128cfb_functions },
168     { "CAMELLIA-256-CFB1", "default=yes", camellia256cfb1_functions },
169     { "CAMELLIA-192-CFB1", "default=yes", camellia192cfb1_functions },
170     { "CAMELLIA-128-CFB1", "default=yes", camellia128cfb1_functions },
171     { "CAMELLIA-256-CFB8", "default=yes", camellia256cfb8_functions },
172     { "CAMELLIA-192-CFB8", "default=yes", camellia192cfb8_functions },
173     { "CAMELLIA-128-CFB8", "default=yes", camellia128cfb8_functions },
174     { "CAMELLIA-256-CTR", "default=yes", camellia256ctr_functions },
175     { "CAMELLIA-192-CTR", "default=yes", camellia192ctr_functions },
176     { "CAMELLIA-128-CTR", "default=yes", camellia128ctr_functions },
177 #endif /* OPENSSL_NO_CAMELLIA */
178 #ifndef OPENSSL_NO_DES
179     { "DES-EDE3", "default=yes", tdes_ede3_ecb_functions },
180     { "DES-EDE3-CBC", "default=yes", tdes_ede3_cbc_functions },
181     { "DES-EDE3-OFB", "default=yes", tdes_ede3_ofb_functions },
182     { "DES-EDE3-CFB", "default=yes", tdes_ede3_cfb_functions },
183     { "DES-EDE3-CFB8", "default=yes", tdes_ede3_cfb8_functions },
184     { "DES-EDE3-CFB1", "default=yes", tdes_ede3_cfb1_functions },
185     { "DES-EDE", "default=yes", tdes_ede2_ecb_functions },
186     { "DES-EDE-CBC", "default=yes", tdes_ede2_cbc_functions },
187     { "DES-EDE-OFB", "default=yes", tdes_ede2_ofb_functions },
188     { "DES-EDE-CFB", "default=yes", tdes_ede2_cfb_functions },
189     { "DESX-CBC", "default=yes", tdes_desx_cbc_functions },
190     { "id-smime-alg-CMS3DESwrap", "default=yes", tdes_wrap_cbc_functions },
191 #endif /* OPENSSL_NO_DES */
192 #ifndef OPENSSL_NO_BF
193     { "BF-ECB", "default=yes", blowfish128ecb_functions },
194     { "BF-CBC", "default=yes", blowfish128cbc_functions },
195     { "BF-OFB", "default=yes", blowfish64ofb64_functions },
196     { "BF-CFB", "default=yes", blowfish64cfb64_functions },
197 #endif /* OPENSSL_NO_BF */
198     { NULL, NULL, NULL }
199 };
200
201 static const OSSL_ALGORITHM deflt_macs[] = {
202 #ifndef OPENSSL_NO_BLAKE2
203     { "BLAKE2BMAC", "default=yes", blake2bmac_functions },
204     { "BLAKE2SMAC", "default=yes", blake2smac_functions },
205 #endif
206 #ifndef OPENSSL_NO_CMAC
207     { "CMAC", "default=yes", cmac_functions },
208 #endif
209     { "GMAC", "default=yes", gmac_functions },
210     { "HMAC", "default=yes", hmac_functions },
211     { "KMAC128", "default=yes", kmac128_functions },
212     { "KMAC256", "default=yes", kmac256_functions },
213 #ifndef OPENSSL_NO_SIPHASH
214     { "SipHash", "default=yes", siphash_functions },
215 #endif
216 #ifndef OPENSSL_NO_POLY1305
217     { "Poly1305", "default=yes", poly1305_functions },
218 #endif
219     { NULL, NULL, NULL }
220 };
221
222 static const OSSL_ALGORITHM deflt_kdfs[] = {
223     { OSSL_KDF_NAME_HKDF, "default=yes", kdf_hkdf_functions },
224     { OSSL_KDF_NAME_SSKDF, "default=yes", kdf_sskdf_functions },
225     { OSSL_KDF_NAME_PBKDF2, "default=yes", kdf_pbkdf2_functions },
226     { OSSL_KDF_NAME_SSHKDF, "default=yes", kdf_sshkdf_functions },
227     { OSSL_KDF_NAME_X963KDF, "default=yes", kdf_x963_kdf_functions },
228     { OSSL_KDF_NAME_TLS1_PRF, "default=yes", kdf_tls1_prf_functions },
229 #ifndef OPENSSL_NO_CMS
230     { OSSL_KDF_NAME_X942KDF, "default=yes", kdf_x942_kdf_functions },
231 #endif
232 #ifndef OPENSSL_NO_SCRYPT
233     { OSSL_KDF_NAME_SCRYPT, "default=yes", kdf_scrypt_functions },
234 #endif
235    { NULL, NULL, NULL }
236 };
237
238 static const OSSL_ALGORITHM deflt_keyexch[] = {
239 #ifndef OPENSSL_NO_DH
240     { "dhKeyAgreement", "default=yes", dh_keyexch_functions },
241 #endif
242     { NULL, NULL, NULL }
243 };
244
245 static const OSSL_ALGORITHM deflt_signature[] = {
246 #ifndef OPENSSL_NO_DSA
247     { "DSA", "default=yes", dsa_signature_functions },
248 #endif
249     { NULL, NULL, NULL }
250 };
251
252
253 static const OSSL_ALGORITHM deflt_keymgmt[] = {
254 #ifndef OPENSSL_NO_DH
255     { "dhKeyAgreement", "default=yes", dh_keymgmt_functions },
256 #endif
257 #ifndef OPENSSL_NO_DSA
258     { "DSA", "default=yes", dsa_keymgmt_functions },
259 #endif
260     { NULL, NULL, NULL }
261 };
262
263 static const OSSL_ALGORITHM *deflt_query(OSSL_PROVIDER *prov,
264                                          int operation_id,
265                                          int *no_cache)
266 {
267     *no_cache = 0;
268     switch (operation_id) {
269     case OSSL_OP_DIGEST:
270         return deflt_digests;
271     case OSSL_OP_CIPHER:
272         return deflt_ciphers;
273     case OSSL_OP_MAC:
274         return deflt_macs;
275     case OSSL_OP_KDF:
276         return deflt_kdfs;
277     case OSSL_OP_KEYMGMT:
278         return deflt_keymgmt;
279     case OSSL_OP_KEYEXCH:
280         return deflt_keyexch;
281     case OSSL_OP_SIGNATURE:
282         return deflt_signature;
283     }
284     return NULL;
285 }
286
287 /* Functions we provide to the core */
288 static const OSSL_DISPATCH deflt_dispatch_table[] = {
289     { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))deflt_gettable_params },
290     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))deflt_get_params },
291     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))deflt_query },
292     { 0, NULL }
293 };
294
295 OSSL_provider_init_fn ossl_default_provider_init;
296
297 int ossl_default_provider_init(const OSSL_PROVIDER *provider,
298                                const OSSL_DISPATCH *in,
299                                const OSSL_DISPATCH **out,
300                                void **provctx)
301 {
302     OSSL_core_get_library_context_fn *c_get_libctx = NULL;
303
304     for (; in->function_id != 0; in++) {
305         switch (in->function_id) {
306         case OSSL_FUNC_CORE_GETTABLE_PARAMS:
307             c_gettable_params = OSSL_get_core_gettable_params(in);
308             break;
309         case OSSL_FUNC_CORE_GET_PARAMS:
310             c_get_params = OSSL_get_core_get_params(in);
311             break;
312         case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
313             c_get_libctx = OSSL_get_core_get_library_context(in);
314             break;
315         default:
316             /* Just ignore anything we don't understand */
317             break;
318         }
319     }
320
321     if (c_get_libctx == NULL)
322         return 0;
323
324     *out = deflt_dispatch_table;
325
326     /*
327      * We want to make sure that all calls from this provider that requires
328      * a library context use the same context as the one used to call our
329      * functions.  We do that by passing it along as the provider context.
330      */
331     *provctx = c_get_libctx(provider);
332     return 1;
333 }