2 * Copyright 2019-2023 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
10 #include "internal/namemap.h"
11 #include <openssl/lhash.h>
12 #include "crypto/lhash.h" /* ossl_lh_strcasehash */
13 #include "internal/tsan_assist.h"
14 #include "internal/sizes.h"
15 #include "crypto/context.h"
26 DEFINE_LHASH_OF_EX(NAMENUM_ENTRY);
33 struct ossl_namemap_st {
35 unsigned int stored:1; /* If 1, it's stored in a library context */
38 LHASH_OF(NAMENUM_ENTRY) *namenum; /* Name->number mapping */
40 TSAN_QUALIFIER int max_number; /* Current max number */
45 static unsigned long namenum_hash(const NAMENUM_ENTRY *n)
47 return ossl_lh_strcasehash(n->name);
50 static int namenum_cmp(const NAMENUM_ENTRY *a, const NAMENUM_ENTRY *b)
52 return OPENSSL_strcasecmp(a->name, b->name);
55 static void namenum_free(NAMENUM_ENTRY *n)
58 OPENSSL_free(n->name);
62 /* OSSL_LIB_CTX_METHOD functions for a namemap stored in a library context */
64 void *ossl_stored_namemap_new(OSSL_LIB_CTX *libctx)
66 OSSL_NAMEMAP *namemap = ossl_namemap_new();
74 void ossl_stored_namemap_free(void *vnamemap)
76 OSSL_NAMEMAP *namemap = vnamemap;
78 if (namemap != NULL) {
79 /* Pretend it isn't stored, or ossl_namemap_free() will do nothing */
81 ossl_namemap_free(namemap);
90 int ossl_namemap_empty(OSSL_NAMEMAP *namemap)
92 #ifdef TSAN_REQUIRES_LOCKING
99 if (!CRYPTO_THREAD_read_lock(namemap->lock))
101 rv = namemap->max_number == 0;
102 CRYPTO_THREAD_unlock(namemap->lock);
105 /* Have TSAN support */
106 return namemap == NULL || tsan_load(&namemap->max_number) == 0;
110 typedef struct doall_names_data_st {
116 static void do_name(const NAMENUM_ENTRY *namenum, DOALL_NAMES_DATA *data)
118 if (namenum->number == data->number)
119 data->names[data->found++] = namenum->name;
122 IMPLEMENT_LHASH_DOALL_ARG_CONST(NAMENUM_ENTRY, DOALL_NAMES_DATA);
125 * Call the callback for all names in the namemap with the given number.
126 * A return value 1 means that the callback was called for all names. A
127 * return value of 0 means that the callback was not called for any names.
129 int ossl_namemap_doall_names(const OSSL_NAMEMAP *namemap, int number,
130 void (*fn)(const char *name, void *data),
133 DOALL_NAMES_DATA cbdata;
137 cbdata.number = number;
144 * We collect all the names first under a read lock. Subsequently we call
145 * the user function, so that we're not holding the read lock when in user
146 * code. This could lead to deadlocks.
148 if (!CRYPTO_THREAD_read_lock(namemap->lock))
151 num_names = lh_NAMENUM_ENTRY_num_items(namemap->namenum);
152 if (num_names == 0) {
153 CRYPTO_THREAD_unlock(namemap->lock);
156 cbdata.names = OPENSSL_malloc(sizeof(*cbdata.names) * num_names);
157 if (cbdata.names == NULL) {
158 CRYPTO_THREAD_unlock(namemap->lock);
161 lh_NAMENUM_ENTRY_doall_DOALL_NAMES_DATA(namemap->namenum, do_name,
163 CRYPTO_THREAD_unlock(namemap->lock);
165 for (i = 0; i < cbdata.found; i++)
166 fn(cbdata.names[i], data);
168 OPENSSL_free(cbdata.names);
172 /* This function is not thread safe, the namemap must be locked */
173 static int namemap_name2num(const OSSL_NAMEMAP *namemap,
176 NAMENUM_ENTRY *namenum_entry, namenum_tmpl;
178 namenum_tmpl.name = (char *)name;
179 namenum_tmpl.number = 0;
181 lh_NAMENUM_ENTRY_retrieve(namemap->namenum, &namenum_tmpl);
182 return namenum_entry != NULL ? namenum_entry->number : 0;
185 int ossl_namemap_name2num(const OSSL_NAMEMAP *namemap, const char *name)
191 namemap = ossl_namemap_stored(NULL);
197 if (!CRYPTO_THREAD_read_lock(namemap->lock))
199 number = namemap_name2num(namemap, name);
200 CRYPTO_THREAD_unlock(namemap->lock);
205 int ossl_namemap_name2num_n(const OSSL_NAMEMAP *namemap,
206 const char *name, size_t name_len)
211 if (name == NULL || (tmp = OPENSSL_strndup(name, name_len)) == NULL)
214 ret = ossl_namemap_name2num(namemap, tmp);
219 struct num2name_data_st {
220 size_t idx; /* Countdown */
221 const char *name; /* Result */
224 static void do_num2name(const char *name, void *vdata)
226 struct num2name_data_st *data = vdata;
230 else if (data->name == NULL)
234 const char *ossl_namemap_num2name(const OSSL_NAMEMAP *namemap, int number,
237 struct num2name_data_st data;
241 if (!ossl_namemap_doall_names(namemap, number, do_num2name, &data))
246 /* This function is not thread safe, the namemap must be locked */
247 static int namemap_add_name(OSSL_NAMEMAP *namemap, int number,
250 NAMENUM_ENTRY *namenum = NULL;
253 /* If it already exists, we don't add it */
254 if ((tmp_number = namemap_name2num(namemap, name)) != 0)
257 if ((namenum = OPENSSL_zalloc(sizeof(*namenum))) == NULL)
260 if ((namenum->name = OPENSSL_strdup(name)) == NULL)
263 /* The tsan_counter use here is safe since we're under lock */
265 number != 0 ? number : 1 + tsan_counter(&namemap->max_number);
266 (void)lh_NAMENUM_ENTRY_insert(namemap->namenum, namenum);
268 if (lh_NAMENUM_ENTRY_error(namemap->namenum))
270 return namenum->number;
273 namenum_free(namenum);
277 int ossl_namemap_add_name(OSSL_NAMEMAP *namemap, int number,
284 namemap = ossl_namemap_stored(NULL);
287 if (name == NULL || *name == 0 || namemap == NULL)
290 if (!CRYPTO_THREAD_write_lock(namemap->lock))
292 tmp_number = namemap_add_name(namemap, number, name);
293 CRYPTO_THREAD_unlock(namemap->lock);
297 int ossl_namemap_add_names(OSSL_NAMEMAP *namemap, int number,
298 const char *names, const char separator)
300 char *tmp, *p, *q, *endp;
302 /* Check that we have a namemap */
303 if (!ossl_assert(namemap != NULL)) {
304 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
308 if ((tmp = OPENSSL_strdup(names)) == NULL)
311 if (!CRYPTO_THREAD_write_lock(namemap->lock)) {
316 * Check that no name is an empty string, and that all names have at
317 * most one numeric identity together.
319 for (p = tmp; *p != '\0'; p = q) {
323 if ((q = strchr(p, separator)) == NULL) {
324 l = strlen(p); /* offset to \0 */
327 l = q - p; /* offset to the next separator */
332 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_BAD_ALGORITHM_NAME);
337 this_number = namemap_name2num(namemap, p);
340 number = this_number;
341 } else if (this_number != 0 && this_number != number) {
342 ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_CONFLICTING_NAMES,
343 "\"%s\" has an existing different identity %d (from \"%s\")",
344 p, this_number, names);
351 /* Now that we have checked, register all names */
352 for (p = tmp; p < endp; p = q) {
355 q = p + strlen(p) + 1;
357 this_number = namemap_add_name(namemap, number, p);
359 number = this_number;
360 } else if (this_number != number) {
361 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR,
362 "Got number %d when expecting %d",
363 this_number, number);
370 CRYPTO_THREAD_unlock(namemap->lock);
381 #include <openssl/evp.h>
383 /* Creates an initial namemap with names found in the legacy method db */
384 static void get_legacy_evp_names(int base_nid, int nid, const char *pem_name,
390 if (base_nid != NID_undef) {
391 num = ossl_namemap_add_name(arg, num, OBJ_nid2sn(base_nid));
392 num = ossl_namemap_add_name(arg, num, OBJ_nid2ln(base_nid));
395 if (nid != NID_undef) {
396 num = ossl_namemap_add_name(arg, num, OBJ_nid2sn(nid));
397 num = ossl_namemap_add_name(arg, num, OBJ_nid2ln(nid));
398 if ((obj = OBJ_nid2obj(nid)) != NULL) {
399 char txtoid[OSSL_MAX_NAME_SIZE];
401 if (OBJ_obj2txt(txtoid, sizeof(txtoid), obj, 1) > 0)
402 num = ossl_namemap_add_name(arg, num, txtoid);
405 if (pem_name != NULL)
406 num = ossl_namemap_add_name(arg, num, pem_name);
409 static void get_legacy_cipher_names(const OBJ_NAME *on, void *arg)
411 const EVP_CIPHER *cipher = (void *)OBJ_NAME_get(on->name, on->type);
414 get_legacy_evp_names(NID_undef, EVP_CIPHER_get_type(cipher), NULL, arg);
417 static void get_legacy_md_names(const OBJ_NAME *on, void *arg)
419 const EVP_MD *md = (void *)OBJ_NAME_get(on->name, on->type);
422 get_legacy_evp_names(0, EVP_MD_get_type(md), NULL, arg);
425 static void get_legacy_pkey_meth_names(const EVP_PKEY_ASN1_METHOD *ameth,
428 int nid = 0, base_nid = 0, flags = 0;
429 const char *pem_name = NULL;
431 EVP_PKEY_asn1_get0_info(&nid, &base_nid, &flags, NULL, &pem_name, ameth);
432 if (nid != NID_undef) {
433 if ((flags & ASN1_PKEY_ALIAS) == 0) {
436 /* We know that the name "DHX" is used too */
437 get_legacy_evp_names(0, nid, "DHX", arg);
440 get_legacy_evp_names(0, nid, pem_name, arg);
444 * Treat aliases carefully, some of them are undesirable, or
445 * should not be treated as such for providers.
451 * SM2 is a separate keytype with providers, not an alias for
454 get_legacy_evp_names(0, nid, pem_name, arg);
457 /* Use the short name of the base nid as the common reference */
458 get_legacy_evp_names(base_nid, nid, pem_name, arg);
466 * Constructors / destructors
467 * ==========================
470 OSSL_NAMEMAP *ossl_namemap_stored(OSSL_LIB_CTX *libctx)
475 OSSL_NAMEMAP *namemap =
476 ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_NAMEMAP_INDEX);
482 nms = ossl_namemap_empty(namemap);
485 * Could not get lock to make the count, so maybe internal objects
486 * weren't added. This seems safest.
493 /* Before pilfering, we make sure the legacy database is populated */
494 OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS
495 | OPENSSL_INIT_ADD_ALL_DIGESTS, NULL);
497 OBJ_NAME_do_all(OBJ_NAME_TYPE_CIPHER_METH,
498 get_legacy_cipher_names, namemap);
499 OBJ_NAME_do_all(OBJ_NAME_TYPE_MD_METH,
500 get_legacy_md_names, namemap);
502 /* We also pilfer data from the legacy EVP_PKEY_ASN1_METHODs */
503 for (i = 0, end = EVP_PKEY_asn1_get_count(); i < end; i++)
504 get_legacy_pkey_meth_names(EVP_PKEY_asn1_get0(i), namemap);
511 OSSL_NAMEMAP *ossl_namemap_new(void)
513 OSSL_NAMEMAP *namemap;
515 if ((namemap = OPENSSL_zalloc(sizeof(*namemap))) != NULL
516 && (namemap->lock = CRYPTO_THREAD_lock_new()) != NULL
517 && (namemap->namenum =
518 lh_NAMENUM_ENTRY_new(namenum_hash, namenum_cmp)) != NULL)
521 ossl_namemap_free(namemap);
525 void ossl_namemap_free(OSSL_NAMEMAP *namemap)
527 if (namemap == NULL || namemap->stored)
530 lh_NAMENUM_ENTRY_doall(namemap->namenum, namenum_free);
531 lh_NAMENUM_ENTRY_free(namemap->namenum);
533 CRYPTO_THREAD_lock_free(namemap->lock);
534 OPENSSL_free(namemap);