CORE: Add an internal function to distinguish the global default context
[openssl.git] / crypto / evp / evp_fetch.c
1 /*
2  * Copyright 2019-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 <stddef.h>
11 #include <openssl/types.h>
12 #include <openssl/evp.h>
13 #include <openssl/core.h>
14 #include "internal/cryptlib.h"
15 #include "internal/thread_once.h"
16 #include "internal/property.h"
17 #include "internal/core.h"
18 #include "internal/provider.h"
19 #include "internal/namemap.h"
20 #include "crypto/evp.h"    /* evp_local.h needs it */
21 #include "evp_local.h"
22
23 #define NAME_SEPARATOR ':'
24
25 static void evp_method_store_free(void *vstore)
26 {
27     ossl_method_store_free(vstore);
28 }
29
30 static void *evp_method_store_new(OPENSSL_CTX *ctx)
31 {
32     return ossl_method_store_new(ctx);
33 }
34
35
36 static const OPENSSL_CTX_METHOD evp_method_store_method = {
37     evp_method_store_new,
38     evp_method_store_free,
39 };
40
41 /* Data to be passed through ossl_method_construct() */
42 struct evp_method_data_st {
43     OPENSSL_CTX *libctx;
44     OSSL_METHOD_CONSTRUCT_METHOD *mcm;
45     int operation_id;            /* For get_evp_method_from_store() */
46     int name_id;                 /* For get_evp_method_from_store() */
47     const char *names;           /* For get_evp_method_from_store() */
48     const char *propquery;       /* For get_evp_method_from_store() */
49     void *(*method_from_dispatch)(int name_id, const OSSL_DISPATCH *,
50                                   OSSL_PROVIDER *);
51     int (*refcnt_up_method)(void *method);
52     void (*destruct_method)(void *method);
53 };
54
55 /*
56  * Generic routines to fetch / create EVP methods with ossl_method_construct()
57  */
58 static void *alloc_tmp_evp_method_store(OPENSSL_CTX *ctx)
59 {
60     return ossl_method_store_new(ctx);
61 }
62
63  static void dealloc_tmp_evp_method_store(void *store)
64 {
65     if (store != NULL)
66         ossl_method_store_free(store);
67 }
68
69 static OSSL_METHOD_STORE *get_evp_method_store(OPENSSL_CTX *libctx)
70 {
71     return openssl_ctx_get_data(libctx, OPENSSL_CTX_EVP_METHOD_STORE_INDEX,
72                                 &evp_method_store_method);
73 }
74
75 /*
76  * To identify the method in the EVP method store, we mix the name identity
77  * with the operation identity, under the assumption that we don't have more
78  * than 2^24 names or more than 2^8 operation types.
79  *
80  * The resulting identity is a 32-bit integer, composed like this:
81  *
82  * +---------24 bits--------+-8 bits-+
83  * |      name identity     | op id  |
84  * +------------------------+--------+
85  */
86 static uint32_t evp_method_id(int name_id, unsigned int operation_id)
87 {
88     if (!ossl_assert(name_id > 0 && name_id < (1 << 24))
89         || !ossl_assert(operation_id > 0 && operation_id < (1 << 8)))
90         return 0;
91     return ((name_id << 8) & 0xFFFFFF00) | (operation_id & 0x000000FF);
92 }
93
94 static void *get_evp_method_from_store(OPENSSL_CTX *libctx, void *store,
95                                        void *data)
96 {
97     struct evp_method_data_st *methdata = data;
98     void *method = NULL;
99     int name_id;
100     uint32_t meth_id;
101
102     /*
103      * get_evp_method_from_store() is only called to try and get the method
104      * that evp_generic_fetch() is asking for, and the operation id as well
105      * as the name or name id are passed via methdata.
106      */
107     if ((name_id = methdata->name_id) == 0) {
108         OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
109         const char *names = methdata->names;
110         const char *q = strchr(names, NAME_SEPARATOR);
111         size_t l = (q == NULL ? strlen(names) : (size_t)(q - names));
112
113         if (namemap == 0)
114             return NULL;
115         name_id = ossl_namemap_name2num_n(namemap, names, l);
116     }
117
118     if (name_id == 0
119         || (meth_id = evp_method_id(name_id, methdata->operation_id)) == 0)
120         return NULL;
121
122     if (store == NULL
123         && (store = get_evp_method_store(libctx)) == NULL)
124         return NULL;
125
126     if (!ossl_method_store_fetch(store, meth_id, methdata->propquery,
127                                  &method))
128         return NULL;
129     return method;
130 }
131
132 static int put_evp_method_in_store(OPENSSL_CTX *libctx, void *store,
133                                    void *method, const OSSL_PROVIDER *prov,
134                                    int operation_id, const char *names,
135                                    const char *propdef, void *data)
136 {
137     struct evp_method_data_st *methdata = data;
138     OSSL_NAMEMAP *namemap;
139     int name_id;
140     uint32_t meth_id;
141     size_t l = 0;
142
143     /*
144      * put_evp_method_in_store() is only called with an EVP method that was
145      * successfully created by construct_method() below, which means that
146      * all the names should already be stored in the namemap with the same
147      * numeric identity, so just use the first to get that identity.
148      */
149     if (names != NULL) {
150         const char *q = strchr(names, NAME_SEPARATOR);
151
152         l = (q == NULL ? strlen(names) : (size_t)(q - names));
153     }
154
155     if ((namemap = ossl_namemap_stored(libctx)) == NULL
156         || (name_id = ossl_namemap_name2num_n(namemap, names, l)) == 0
157         || (meth_id = evp_method_id(name_id, operation_id)) == 0)
158         return 0;
159
160     if (store == NULL
161         && (store = get_evp_method_store(libctx)) == NULL)
162         return 0;
163
164     return ossl_method_store_add(store, prov, meth_id, propdef, method,
165                                  methdata->refcnt_up_method,
166                                  methdata->destruct_method);
167 }
168
169 /*
170  * The core fetching functionality passes the name of the implementation.
171  * This function is responsible to getting an identity number for it.
172  */
173 static void *construct_evp_method(const OSSL_ALGORITHM *algodef,
174                                   OSSL_PROVIDER *prov, void *data)
175 {
176     /*
177      * This function is only called if get_evp_method_from_store() returned
178      * NULL, so it's safe to say that of all the spots to create a new
179      * namemap entry, this is it.  Should the name already exist there, we
180      * know that ossl_namemap_add_name() will return its corresponding
181      * number.
182      */
183     struct evp_method_data_st *methdata = data;
184     OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
185     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
186     const char *names = algodef->algorithm_names;
187     int name_id = ossl_namemap_add_names(namemap, 0, names, NAME_SEPARATOR);
188
189     if (name_id == 0)
190         return NULL;
191     return methdata->method_from_dispatch(name_id, algodef->implementation,
192                                           prov);
193 }
194
195 static void destruct_evp_method(void *method, void *data)
196 {
197     struct evp_method_data_st *methdata = data;
198
199     methdata->destruct_method(method);
200 }
201
202 static void *
203 inner_evp_generic_fetch(OPENSSL_CTX *libctx, int operation_id,
204                         int name_id, const char *name,
205                         const char *properties,
206                         void *(*new_method)(int name_id,
207                                             const OSSL_DISPATCH *fns,
208                                             OSSL_PROVIDER *prov),
209                         int (*up_ref_method)(void *),
210                         void (*free_method)(void *))
211 {
212     OSSL_METHOD_STORE *store = get_evp_method_store(libctx);
213     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
214     uint32_t meth_id = 0;
215     void *method = NULL;
216
217     if (store == NULL || namemap == NULL)
218         return NULL;
219
220     /*
221      * If there's ever an operation_id == 0 passed, we have an internal
222      * programming error.
223      */
224     if (!ossl_assert(operation_id > 0))
225         return NULL;
226
227     /*
228      * If we have been passed neither a name_id or a name, we have an
229      * internal programming error.
230      */
231     if (!ossl_assert(name_id != 0 || name != NULL))
232         return NULL;
233
234     /* If we haven't received a name id yet, try to get one for the name */
235     if (name_id == 0)
236         name_id = ossl_namemap_name2num(namemap, name);
237
238     /*
239      * If we have a name id, calculate a method id with evp_method_id().
240      *
241      * evp_method_id returns 0 if we have too many operations (more than
242      * about 2^8) or too many names (more than about 2^24).  In that case,
243      * we can't create any new method.
244      */
245     if (name_id != 0 && (meth_id = evp_method_id(name_id, operation_id)) == 0)
246         return NULL;
247
248     if (meth_id == 0
249         || !ossl_method_store_cache_get(store, meth_id, properties, &method)) {
250         OSSL_METHOD_CONSTRUCT_METHOD mcm = {
251             alloc_tmp_evp_method_store,
252             dealloc_tmp_evp_method_store,
253             get_evp_method_from_store,
254             put_evp_method_in_store,
255             construct_evp_method,
256             destruct_evp_method
257         };
258         struct evp_method_data_st mcmdata;
259
260         mcmdata.mcm = &mcm;
261         mcmdata.libctx = libctx;
262         mcmdata.operation_id = operation_id;
263         mcmdata.name_id = name_id;
264         mcmdata.names = name;
265         mcmdata.propquery = properties;
266         mcmdata.method_from_dispatch = new_method;
267         mcmdata.refcnt_up_method = up_ref_method;
268         mcmdata.destruct_method = free_method;
269         if ((method = ossl_method_construct(libctx, operation_id,
270                                             0 /* !force_cache */,
271                                             &mcm, &mcmdata)) != NULL) {
272             /*
273              * If construction did create a method for us, we know that
274              * there is a correct name_id and meth_id, since those have
275              * already been calculated in get_evp_method_from_store() and
276              * put_evp_method_in_store() above.
277              */
278             if (name_id == 0)
279                 name_id = ossl_namemap_name2num(namemap, name);
280             meth_id = evp_method_id(name_id, operation_id);
281             ossl_method_store_cache_set(store, meth_id, properties, method,
282                                         up_ref_method, free_method);
283         }
284     }
285
286     return method;
287 }
288
289 #ifndef FIPS_MODULE
290 static const char *libctx_descriptor(OPENSSL_CTX *libctx)
291 {
292     if (openssl_ctx_is_global_default(libctx))
293         return "Global default library context";
294     if (openssl_ctx_is_default(libctx))
295         return "Thread-local default library context";
296     return "Non-default library context";
297 }
298 #endif
299
300 void *evp_generic_fetch(OPENSSL_CTX *libctx, int operation_id,
301                         const char *name, const char *properties,
302                         void *(*new_method)(int name_id,
303                                             const OSSL_DISPATCH *fns,
304                                             OSSL_PROVIDER *prov),
305                         int (*up_ref_method)(void *),
306                         void (*free_method)(void *))
307 {
308     void *ret = inner_evp_generic_fetch(libctx,
309                                         operation_id, 0, name, properties,
310                                         new_method, up_ref_method, free_method);
311
312     if (ret == NULL) {
313         int code = EVP_R_FETCH_FAILED;
314
315 #ifdef FIPS_MODULE
316         ERR_raise(ERR_LIB_EVP, code);
317 #else
318         ERR_raise_data(ERR_LIB_EVP, code,
319                        "%s, Algorithm (%s), Properties (%s)",
320                        libctx_descriptor(libctx),
321                        name = NULL ? "<null>" : name,
322                        properties == NULL ? "<null>" : properties);
323 #endif
324     }
325     return ret;
326 }
327
328 /*
329  * evp_generic_fetch_by_number() is special, and only returns methods for
330  * already known names, i.e. it refuses to work if no name_id can be found
331  * (it's considered an internal programming error).
332  * This is meant to be used when one method needs to fetch an associated
333  * other method.
334  */
335 void *evp_generic_fetch_by_number(OPENSSL_CTX *libctx, int operation_id,
336                                   int name_id, const char *properties,
337                                   void *(*new_method)(int name_id,
338                                                       const OSSL_DISPATCH *fns,
339                                                       OSSL_PROVIDER *prov),
340                                   int (*up_ref_method)(void *),
341                                   void (*free_method)(void *))
342 {
343     void *ret = inner_evp_generic_fetch(libctx,
344                                         operation_id, name_id, NULL,
345                                         properties, new_method, up_ref_method,
346                                         free_method);
347
348     if (ret == NULL) {
349         int code = EVP_R_FETCH_FAILED;
350
351 #ifdef FIPS_MODULE
352         ERR_raise(ERR_LIB_EVP, code);
353 #else
354         {
355             OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
356             const char *name = (namemap == NULL)
357                                ? NULL
358                                : ossl_namemap_num2name(namemap, name_id, 0);
359
360             ERR_raise_data(ERR_LIB_EVP, code,
361                            "%s, Algorithm (%s), Properties (%s)",
362                            libctx_descriptor(libctx),
363                            name = NULL ? "<null>" : name,
364                            properties == NULL ? "<null>" : properties);
365         }
366 #endif
367     }
368     return ret;
369 }
370
371 static int evp_set_default_properties(OPENSSL_CTX *libctx,
372                                       OSSL_PROPERTY_LIST *def_prop)
373 {
374     OSSL_METHOD_STORE *store = get_evp_method_store(libctx);
375     OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx);
376
377     if (plp != NULL) {
378         ossl_property_free(*plp);
379         *plp = def_prop;
380         if (store != NULL)
381             ossl_method_store_flush_cache(store);
382         return 1;
383     }
384     EVPerr(0, ERR_R_INTERNAL_ERROR);
385     return 0;
386 }
387
388 int EVP_set_default_properties(OPENSSL_CTX *libctx, const char *propq)
389 {
390     OSSL_PROPERTY_LIST *pl = NULL;
391
392     if (propq != NULL && (pl = ossl_parse_query(libctx, propq)) == NULL) {
393         EVPerr(0, EVP_R_DEFAULT_QUERY_PARSE_ERROR);
394         return 0;
395     }
396     return evp_set_default_properties(libctx, pl);
397 }
398
399
400 static int evp_default_properties_merge(OPENSSL_CTX *libctx, const char *propq)
401 {
402     OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx);
403     OSSL_PROPERTY_LIST *pl1, *pl2;
404
405     if (propq == NULL)
406         return 1;
407     if (plp == NULL || *plp == NULL)
408         return EVP_set_default_properties(libctx, propq);
409     if ((pl1 = ossl_parse_query(libctx, propq)) == NULL) {
410         EVPerr(0, EVP_R_DEFAULT_QUERY_PARSE_ERROR);
411         return 0;
412     }
413     pl2 = ossl_property_merge(pl1, *plp);
414     ossl_property_free(pl1);
415     if (pl2 == NULL) {
416         EVPerr(0, ERR_R_MALLOC_FAILURE);
417         return 0;
418     }
419     return evp_set_default_properties(libctx, pl2);
420 }
421
422 static int evp_default_property_is_enabled(OPENSSL_CTX *libctx,
423                                            const char *prop_name)
424 {
425     OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx);
426
427     return plp != NULL && ossl_property_is_enabled(libctx, prop_name, *plp);
428 }
429
430 int EVP_default_properties_is_fips_enabled(OPENSSL_CTX *libctx)
431 {
432     return evp_default_property_is_enabled(libctx, "fips");
433 }
434
435 int EVP_default_properties_enable_fips(OPENSSL_CTX *libctx, int enable)
436 {
437     const char *query = (enable != 0) ? "fips=yes" : "-fips";
438
439     return evp_default_properties_merge(libctx, query);
440 }
441
442
443 struct do_all_data_st {
444     void (*user_fn)(void *method, void *arg);
445     void *user_arg;
446     void *(*new_method)(const int name_id, const OSSL_DISPATCH *fns,
447                         OSSL_PROVIDER *prov);
448     void (*free_method)(void *);
449 };
450
451 static void do_one(OSSL_PROVIDER *provider, const OSSL_ALGORITHM *algo,
452                    int no_store, void *vdata)
453 {
454     struct do_all_data_st *data = vdata;
455     OPENSSL_CTX *libctx = ossl_provider_library_context(provider);
456     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
457     int name_id = ossl_namemap_add_names(namemap, 0, algo->algorithm_names,
458                                          NAME_SEPARATOR);
459     void *method = NULL;
460
461     if (name_id != 0)
462         method = data->new_method(name_id, algo->implementation, provider);
463
464     if (method != NULL) {
465         data->user_fn(method, data->user_arg);
466         data->free_method(method);
467     }
468 }
469
470 void evp_generic_do_all(OPENSSL_CTX *libctx, int operation_id,
471                         void (*user_fn)(void *method, void *arg),
472                         void *user_arg,
473                         void *(*new_method)(int name_id,
474                                             const OSSL_DISPATCH *fns,
475                                             OSSL_PROVIDER *prov),
476                         void (*free_method)(void *))
477 {
478     struct do_all_data_st data;
479
480     data.new_method = new_method;
481     data.free_method = free_method;
482     data.user_fn = user_fn;
483     data.user_arg = user_arg;
484
485     /*
486      * No pre- or post-condition for this call, as this only creates methods
487      * temporarly and then promptly destroys them.
488      */
489     ossl_algorithm_do_all(libctx, operation_id, NULL, NULL, do_one, NULL,
490                           &data);
491 }
492
493 const char *evp_first_name(const OSSL_PROVIDER *prov, int name_id)
494 {
495     OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
496     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
497
498     return ossl_namemap_num2name(namemap, name_id, 0);
499 }
500
501 int evp_is_a(OSSL_PROVIDER *prov, int number,
502              const char *legacy_name, const char *name)
503 {
504     /*
505      * For a |prov| that is NULL, the library context will be NULL
506      */
507     OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
508     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
509
510     if (prov == NULL)
511         number = ossl_namemap_name2num(namemap, legacy_name);
512     return ossl_namemap_name2num(namemap, name) == number;
513 }
514
515 void evp_names_do_all(OSSL_PROVIDER *prov, int number,
516                       void (*fn)(const char *name, void *data),
517                       void *data)
518 {
519     OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
520     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
521
522     ossl_namemap_doall_names(namemap, number, fn, data);
523 }