2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
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
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 "internal/property.h"
21 #include "crypto/evp.h" /* evp_local.h needs it */
22 #include "evp_local.h"
24 #define NAME_SEPARATOR ':'
26 static void evp_method_store_free(void *vstore)
28 ossl_method_store_free(vstore);
31 static void *evp_method_store_new(OSSL_LIB_CTX *ctx)
33 return ossl_method_store_new(ctx);
37 static const OSSL_LIB_CTX_METHOD evp_method_store_method = {
38 /* We want evp_method_store to be cleaned up before the provider store */
39 OSSL_LIB_CTX_METHOD_PRIORITY_2,
41 evp_method_store_free,
44 /* Data to be passed through ossl_method_construct() */
45 struct evp_method_data_st {
47 int operation_id; /* For get_evp_method_from_store() */
48 int name_id; /* For get_evp_method_from_store() */
49 const char *names; /* For get_evp_method_from_store() */
50 const char *propquery; /* For get_evp_method_from_store() */
52 OSSL_METHOD_STORE *tmp_store; /* For get_tmp_evp_method_store() */
54 unsigned int flag_construct_error_occurred : 1;
56 void *(*method_from_algorithm)(int name_id, const OSSL_ALGORITHM *,
58 int (*refcnt_up_method)(void *method);
59 void (*destruct_method)(void *method);
63 * Generic routines to fetch / create EVP methods with ossl_method_construct()
65 static void *get_tmp_evp_method_store(void *data)
67 struct evp_method_data_st *methdata = data;
69 if (methdata->tmp_store == NULL)
70 methdata->tmp_store = ossl_method_store_new(methdata->libctx);
71 return methdata->tmp_store;
74 static void dealloc_tmp_evp_method_store(void *store)
77 ossl_method_store_free(store);
80 static OSSL_METHOD_STORE *get_evp_method_store(OSSL_LIB_CTX *libctx)
82 return ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX,
83 &evp_method_store_method);
87 * To identify the method in the EVP method store, we mix the name identity
88 * with the operation identity, under the assumption that we don't have more
89 * than 2^23 names or more than 2^8 operation types.
91 * The resulting identity is a 31-bit integer, composed like this:
93 * +---------23 bits--------+-8 bits-+
94 * | name identity | op id |
95 * +------------------------+--------+
97 * We limit this composite number to 31 bits, thus leaving the top uint32_t
98 * bit always zero, to avoid negative sign extension when downshifting after
99 * this number happens to be passed to an int (which happens as soon as it's
100 * passed to ossl_method_store_cache_set(), and it's in that form that it
101 * gets passed along to filter_on_operation_id(), defined further down.
103 #define METHOD_ID_OPERATION_MASK 0x000000FF
104 #define METHOD_ID_OPERATION_MAX ((1 << 8) - 1)
105 #define METHOD_ID_NAME_MASK 0x7FFFFF00
106 #define METHOD_ID_NAME_OFFSET 8
107 #define METHOD_ID_NAME_MAX ((1 << 23) - 1)
108 static uint32_t evp_method_id(int name_id, unsigned int operation_id)
110 if (!ossl_assert(name_id > 0 && name_id <= METHOD_ID_NAME_MAX)
111 || !ossl_assert(operation_id > 0
112 && operation_id <= METHOD_ID_OPERATION_MAX))
114 return (((name_id << METHOD_ID_NAME_OFFSET) & METHOD_ID_NAME_MASK)
115 | (operation_id & METHOD_ID_OPERATION_MASK));
118 static void *get_evp_method_from_store(void *store, void *data)
120 struct evp_method_data_st *methdata = data;
126 * get_evp_method_from_store() is only called to try and get the method
127 * that evp_generic_fetch() is asking for, and the operation id as well
128 * as the name or name id are passed via methdata.
130 if ((name_id = methdata->name_id) == 0 && methdata->names != NULL) {
131 OSSL_NAMEMAP *namemap = ossl_namemap_stored(methdata->libctx);
132 const char *names = methdata->names;
133 const char *q = strchr(names, NAME_SEPARATOR);
134 size_t l = (q == NULL ? strlen(names) : (size_t)(q - names));
138 name_id = ossl_namemap_name2num_n(namemap, names, l);
142 || (meth_id = evp_method_id(name_id, methdata->operation_id)) == 0)
146 && (store = get_evp_method_store(methdata->libctx)) == NULL)
149 if (!ossl_method_store_fetch(store, meth_id, methdata->propquery,
155 static int put_evp_method_in_store(void *store, void *method,
156 const OSSL_PROVIDER *prov,
157 const char *names, const char *propdef,
160 struct evp_method_data_st *methdata = data;
161 OSSL_NAMEMAP *namemap;
167 * put_evp_method_in_store() is only called with an EVP method that was
168 * successfully created by construct_method() below, which means that
169 * all the names should already be stored in the namemap with the same
170 * numeric identity, so just use the first to get that identity.
173 const char *q = strchr(names, NAME_SEPARATOR);
175 l = (q == NULL ? strlen(names) : (size_t)(q - names));
178 if ((namemap = ossl_namemap_stored(methdata->libctx)) == NULL
179 || (name_id = ossl_namemap_name2num_n(namemap, names, l)) == 0
180 || (meth_id = evp_method_id(name_id, methdata->operation_id)) == 0)
184 && (store = get_evp_method_store(methdata->libctx)) == NULL)
187 return ossl_method_store_add(store, prov, meth_id, propdef, method,
188 methdata->refcnt_up_method,
189 methdata->destruct_method);
193 * The core fetching functionality passes the name of the implementation.
194 * This function is responsible to getting an identity number for it.
196 static void *construct_evp_method(const OSSL_ALGORITHM *algodef,
197 OSSL_PROVIDER *prov, void *data)
200 * This function is only called if get_evp_method_from_store() returned
201 * NULL, so it's safe to say that of all the spots to create a new
202 * namemap entry, this is it. Should the name already exist there, we
203 * know that ossl_namemap_add_name() will return its corresponding
206 struct evp_method_data_st *methdata = data;
207 OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
208 OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
209 const char *names = algodef->algorithm_names;
210 int name_id = ossl_namemap_add_names(namemap, 0, names, NAME_SEPARATOR);
216 method = methdata->method_from_algorithm(name_id, algodef, prov);
219 * Flag to indicate that there was actual construction errors. This
220 * helps inner_evp_generic_fetch() determine what error it should
221 * record on inaccessible algorithms.
224 methdata->flag_construct_error_occurred = 1;
229 static void destruct_evp_method(void *method, void *data)
231 struct evp_method_data_st *methdata = data;
233 methdata->destruct_method(method);
237 inner_evp_generic_fetch(struct evp_method_data_st *methdata, int operation_id,
238 int name_id, const char *name,
239 const char *properties,
240 void *(*new_method)(int name_id,
241 const OSSL_ALGORITHM *algodef,
242 OSSL_PROVIDER *prov),
243 int (*up_ref_method)(void *),
244 void (*free_method)(void *))
246 OSSL_METHOD_STORE *store = get_evp_method_store(methdata->libctx);
247 OSSL_NAMEMAP *namemap = ossl_namemap_stored(methdata->libctx);
248 uint32_t meth_id = 0;
252 if (store == NULL || namemap == NULL) {
253 ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_INVALID_ARGUMENT);
258 * If there's ever an operation_id == 0 passed, we have an internal
261 if (!ossl_assert(operation_id > 0)) {
262 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
267 * If we have been passed both a name_id and a name, we have an
268 * internal programming error.
270 if (!ossl_assert(name_id == 0 || name == NULL)) {
271 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
275 /* If we haven't received a name id yet, try to get one for the name */
276 if (name_id == 0 && name != NULL)
277 name_id = ossl_namemap_name2num(namemap, name);
280 * If we have a name id, calculate a method id with evp_method_id().
282 * evp_method_id returns 0 if we have too many operations (more than
283 * about 2^8) or too many names (more than about 2^24). In that case,
284 * we can't create any new method.
285 * For all intents and purposes, this is an internal error.
287 if (name_id != 0 && (meth_id = evp_method_id(name_id, operation_id)) == 0) {
288 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
293 * If we haven't found the name yet, chances are that the algorithm to
294 * be fetched is unsupported.
300 || !ossl_method_store_cache_get(store, meth_id, properties, &method)) {
301 OSSL_METHOD_CONSTRUCT_METHOD mcm = {
302 get_tmp_evp_method_store,
303 get_evp_method_from_store,
304 put_evp_method_in_store,
305 construct_evp_method,
309 methdata->operation_id = operation_id;
310 methdata->name_id = name_id;
311 methdata->names = name;
312 methdata->propquery = properties;
313 methdata->method_from_algorithm = new_method;
314 methdata->refcnt_up_method = up_ref_method;
315 methdata->destruct_method = free_method;
316 methdata->flag_construct_error_occurred = 0;
317 if ((method = ossl_method_construct(methdata->libctx, operation_id,
318 0 /* !force_cache */,
319 &mcm, methdata)) != NULL) {
321 * If construction did create a method for us, we know that
322 * there is a correct name_id and meth_id, since those have
323 * already been calculated in get_evp_method_from_store() and
324 * put_evp_method_in_store() above.
327 name_id = ossl_namemap_name2num(namemap, name);
328 meth_id = evp_method_id(name_id, operation_id);
330 ossl_method_store_cache_set(store, meth_id, properties, method,
331 up_ref_method, free_method);
335 * If we never were in the constructor, the algorithm to be fetched
338 unsupported = !methdata->flag_construct_error_occurred;
341 if ((name_id != 0 || name != NULL) && method == NULL) {
342 int code = unsupported ? ERR_R_UNSUPPORTED : ERR_R_FETCH_FAILED;
345 name = ossl_namemap_num2name(namemap, name_id, 0);
346 ERR_raise_data(ERR_LIB_EVP, code,
347 "%s, Algorithm (%s : %d), Properties (%s)",
348 ossl_lib_ctx_get_descriptor(methdata->libctx),
349 name = NULL ? "<null>" : name, name_id,
350 properties == NULL ? "<null>" : properties);
356 void *evp_generic_fetch(OSSL_LIB_CTX *libctx, int operation_id,
357 const char *name, const char *properties,
358 void *(*new_method)(int name_id,
359 const OSSL_ALGORITHM *algodef,
360 OSSL_PROVIDER *prov),
361 int (*up_ref_method)(void *),
362 void (*free_method)(void *))
364 struct evp_method_data_st methdata;
367 methdata.libctx = libctx;
368 methdata.tmp_store = NULL;
369 method = inner_evp_generic_fetch(&methdata,
370 operation_id, 0, name, properties,
371 new_method, up_ref_method, free_method);
372 dealloc_tmp_evp_method_store(methdata.tmp_store);
377 * evp_generic_fetch_by_number() is special, and only returns methods for
378 * already known names, i.e. it refuses to work if no name_id can be found
379 * (it's considered an internal programming error).
380 * This is meant to be used when one method needs to fetch an associated
383 void *evp_generic_fetch_by_number(OSSL_LIB_CTX *libctx, int operation_id,
384 int name_id, const char *properties,
385 void *(*new_method)(int name_id,
386 const OSSL_ALGORITHM *algodef,
387 OSSL_PROVIDER *prov),
388 int (*up_ref_method)(void *),
389 void (*free_method)(void *))
391 struct evp_method_data_st methdata;
394 methdata.libctx = libctx;
395 methdata.tmp_store = NULL;
396 method = inner_evp_generic_fetch(&methdata,
397 operation_id, name_id, NULL, properties,
398 new_method, up_ref_method, free_method);
399 dealloc_tmp_evp_method_store(methdata.tmp_store);
403 int evp_method_store_flush(OSSL_LIB_CTX *libctx)
405 OSSL_METHOD_STORE *store = get_evp_method_store(libctx);
408 return ossl_method_store_flush_cache(store, 1);
412 static int evp_set_parsed_default_properties(OSSL_LIB_CTX *libctx,
413 OSSL_PROPERTY_LIST *def_prop,
417 OSSL_METHOD_STORE *store = get_evp_method_store(libctx);
418 OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx, loadconfig);
420 if (plp != NULL && store != NULL) {
422 char *propstr = NULL;
426 if (ossl_global_properties_no_mirrored(libctx))
430 * These properties have been explicitly set on this libctx, so
431 * don't allow any mirroring from a parent libctx.
433 ossl_global_properties_stop_mirroring(libctx);
436 strsz = ossl_property_list_to_string(libctx, def_prop, NULL, 0);
438 propstr = OPENSSL_malloc(strsz);
439 if (propstr == NULL) {
440 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
443 if (ossl_property_list_to_string(libctx, def_prop, propstr,
445 OPENSSL_free(propstr);
446 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
449 ossl_provider_default_props_update(libctx, propstr);
450 OPENSSL_free(propstr);
452 ossl_property_free(*plp);
455 return ossl_method_store_flush_cache(store, 0);
457 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
461 int evp_set_default_properties_int(OSSL_LIB_CTX *libctx, const char *propq,
462 int loadconfig, int mirrored)
464 OSSL_PROPERTY_LIST *pl = NULL;
466 if (propq != NULL && (pl = ossl_parse_query(libctx, propq, 1)) == NULL) {
467 ERR_raise(ERR_LIB_EVP, EVP_R_DEFAULT_QUERY_PARSE_ERROR);
470 if (!evp_set_parsed_default_properties(libctx, pl, loadconfig, mirrored)) {
471 ossl_property_free(pl);
477 int EVP_set_default_properties(OSSL_LIB_CTX *libctx, const char *propq)
479 return evp_set_default_properties_int(libctx, propq, 1, 0);
482 static int evp_default_properties_merge(OSSL_LIB_CTX *libctx, const char *propq,
485 OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx, loadconfig);
486 OSSL_PROPERTY_LIST *pl1, *pl2;
490 if (plp == NULL || *plp == NULL)
491 return evp_set_default_properties_int(libctx, propq, 0, 0);
492 if ((pl1 = ossl_parse_query(libctx, propq, 1)) == NULL) {
493 ERR_raise(ERR_LIB_EVP, EVP_R_DEFAULT_QUERY_PARSE_ERROR);
496 pl2 = ossl_property_merge(pl1, *plp);
497 ossl_property_free(pl1);
499 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
502 if (!evp_set_parsed_default_properties(libctx, pl2, 0, 0)) {
503 ossl_property_free(pl2);
509 static int evp_default_property_is_enabled(OSSL_LIB_CTX *libctx,
510 const char *prop_name)
512 OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx, 1);
514 return plp != NULL && ossl_property_is_enabled(libctx, prop_name, *plp);
517 int EVP_default_properties_is_fips_enabled(OSSL_LIB_CTX *libctx)
519 return evp_default_property_is_enabled(libctx, "fips");
522 int evp_default_properties_enable_fips_int(OSSL_LIB_CTX *libctx, int enable,
525 const char *query = (enable != 0) ? "fips=yes" : "-fips";
527 return evp_default_properties_merge(libctx, query, loadconfig);
530 int EVP_default_properties_enable_fips(OSSL_LIB_CTX *libctx, int enable)
532 return evp_default_properties_enable_fips_int(libctx, enable, 1);
535 char *evp_get_global_properties_str(OSSL_LIB_CTX *libctx, int loadconfig)
537 OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx, loadconfig);
538 char *propstr = NULL;
542 return OPENSSL_strdup("");
544 sz = ossl_property_list_to_string(libctx, *plp, NULL, 0);
546 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
550 propstr = OPENSSL_malloc(sz);
551 if (propstr == NULL) {
552 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
555 if (ossl_property_list_to_string(libctx, *plp, propstr, sz) == 0) {
556 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
557 OPENSSL_free(propstr);
563 struct filter_data_st {
565 void (*user_fn)(void *method, void *arg);
569 static void filter_on_operation_id(int id, void *method, void *arg)
571 struct filter_data_st *data = arg;
573 if ((id & METHOD_ID_OPERATION_MASK) == data->operation_id)
574 data->user_fn(method, data->user_arg);
577 void evp_generic_do_all(OSSL_LIB_CTX *libctx, int operation_id,
578 void (*user_fn)(void *method, void *arg),
580 void *(*new_method)(int name_id,
581 const OSSL_ALGORITHM *algodef,
582 OSSL_PROVIDER *prov),
583 int (*up_ref_method)(void *),
584 void (*free_method)(void *))
586 struct evp_method_data_st methdata;
587 struct filter_data_st data;
589 methdata.libctx = libctx;
590 methdata.tmp_store = NULL;
591 (void)inner_evp_generic_fetch(&methdata, operation_id, 0, NULL, NULL,
592 new_method, up_ref_method, free_method);
594 data.operation_id = operation_id;
595 data.user_fn = user_fn;
596 data.user_arg = user_arg;
597 if (methdata.tmp_store != NULL)
598 ossl_method_store_do_all(methdata.tmp_store, &filter_on_operation_id,
600 ossl_method_store_do_all(get_evp_method_store(libctx),
601 &filter_on_operation_id, &data);
602 dealloc_tmp_evp_method_store(methdata.tmp_store);
605 int evp_is_a(OSSL_PROVIDER *prov, int number,
606 const char *legacy_name, const char *name)
609 * For a |prov| that is NULL, the library context will be NULL
611 OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
612 OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
615 number = ossl_namemap_name2num(namemap, legacy_name);
616 return ossl_namemap_name2num(namemap, name) == number;
619 int evp_names_do_all(OSSL_PROVIDER *prov, int number,
620 void (*fn)(const char *name, void *data),
623 OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
624 OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
626 return ossl_namemap_doall_names(namemap, number, fn, data);