2 * Copyright 2019-2020 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 "e_os.h" /* strcasecmp */
11 #include "internal/namemap.h"
12 #include <openssl/lhash.h>
13 #include "crypto/lhash.h" /* openssl_lh_strcasehash */
14 #include "internal/tsan_assist.h"
25 DEFINE_LHASH_OF(NAMENUM_ENTRY);
32 struct ossl_namemap_st {
34 unsigned int stored:1; /* If 1, it's stored in a library context */
37 LHASH_OF(NAMENUM_ENTRY) *namenum; /* Name->number mapping */
40 TSAN_QUALIFIER int max_number; /* Current max number TSAN version */
42 int max_number; /* Current max number plain version */
48 static unsigned long namenum_hash(const NAMENUM_ENTRY *n)
50 return openssl_lh_strcasehash(n->name);
53 static int namenum_cmp(const NAMENUM_ENTRY *a, const NAMENUM_ENTRY *b)
55 return strcasecmp(a->name, b->name);
58 static void namenum_free(NAMENUM_ENTRY *n)
61 OPENSSL_free(n->name);
65 /* OPENSSL_CTX_METHOD functions for a namemap stored in a library context */
67 static void *stored_namemap_new(OPENSSL_CTX *libctx)
69 OSSL_NAMEMAP *namemap = ossl_namemap_new();
77 static void stored_namemap_free(void *vnamemap)
79 OSSL_NAMEMAP *namemap = vnamemap;
81 if (namemap != NULL) {
82 /* Pretend it isn't stored, or ossl_namemap_free() will do nothing */
84 ossl_namemap_free(namemap);
88 static const OPENSSL_CTX_METHOD stored_namemap_method = {
98 int ossl_namemap_empty(OSSL_NAMEMAP *namemap)
101 /* Have TSAN support */
102 return namemap == NULL || tsan_load(&namemap->max_number) == 0;
104 /* No TSAN support */
110 CRYPTO_THREAD_read_lock(namemap->lock);
111 rv = namemap->max_number == 0;
112 CRYPTO_THREAD_unlock(namemap->lock);
117 typedef struct doall_names_data_st {
119 void (*fn)(const char *name, void *data);
123 static void do_name(const NAMENUM_ENTRY *namenum, DOALL_NAMES_DATA *data)
125 if (namenum->number == data->number)
126 data->fn(namenum->name, data->data);
129 IMPLEMENT_LHASH_DOALL_ARG_CONST(NAMENUM_ENTRY, DOALL_NAMES_DATA);
131 void ossl_namemap_doall_names(const OSSL_NAMEMAP *namemap, int number,
132 void (*fn)(const char *name, void *data),
135 DOALL_NAMES_DATA cbdata;
137 cbdata.number = number;
140 CRYPTO_THREAD_read_lock(namemap->lock);
141 lh_NAMENUM_ENTRY_doall_DOALL_NAMES_DATA(namemap->namenum, do_name,
143 CRYPTO_THREAD_unlock(namemap->lock);
146 int ossl_namemap_name2num_n(const OSSL_NAMEMAP *namemap,
147 const char *name, size_t name_len)
149 NAMENUM_ENTRY *namenum_entry, namenum_tmpl;
154 namemap = ossl_namemap_stored(NULL);
160 if ((namenum_tmpl.name = OPENSSL_strndup(name, name_len)) == NULL)
162 namenum_tmpl.number = 0;
163 CRYPTO_THREAD_read_lock(namemap->lock);
165 lh_NAMENUM_ENTRY_retrieve(namemap->namenum, &namenum_tmpl);
166 if (namenum_entry != NULL)
167 number = namenum_entry->number;
168 CRYPTO_THREAD_unlock(namemap->lock);
169 OPENSSL_free(namenum_tmpl.name);
174 int ossl_namemap_name2num(const OSSL_NAMEMAP *namemap, const char *name)
179 return ossl_namemap_name2num_n(namemap, name, strlen(name));
182 struct num2name_data_st {
183 size_t idx; /* Countdown */
184 const char *name; /* Result */
187 static void do_num2name(const char *name, void *vdata)
189 struct num2name_data_st *data = vdata;
193 else if (data->name == NULL)
197 const char *ossl_namemap_num2name(const OSSL_NAMEMAP *namemap, int number,
200 struct num2name_data_st data;
204 ossl_namemap_doall_names(namemap, number, do_num2name, &data);
208 int ossl_namemap_add_name_n(OSSL_NAMEMAP *namemap, int number,
209 const char *name, size_t name_len)
211 NAMENUM_ENTRY *namenum = NULL;
216 namemap = ossl_namemap_stored(NULL);
219 if (name == NULL || name_len == 0 || namemap == NULL)
222 if ((tmp_number = ossl_namemap_name2num_n(namemap, name, name_len)) != 0)
223 return tmp_number; /* Pretend success */
225 CRYPTO_THREAD_write_lock(namemap->lock);
227 if ((namenum = OPENSSL_zalloc(sizeof(*namenum))) == NULL
228 || (namenum->name = OPENSSL_strndup(name, name_len)) == NULL)
231 namenum->number = tmp_number =
232 number != 0 ? number : 1 + tsan_counter(&namemap->max_number);
233 (void)lh_NAMENUM_ENTRY_insert(namemap->namenum, namenum);
235 if (lh_NAMENUM_ENTRY_error(namemap->namenum))
238 CRYPTO_THREAD_unlock(namemap->lock);
243 namenum_free(namenum);
245 CRYPTO_THREAD_unlock(namemap->lock);
249 int ossl_namemap_add_name(OSSL_NAMEMAP *namemap, int number, const char *name)
254 return ossl_namemap_add_name_n(namemap, number, name, strlen(name));
257 int ossl_namemap_add_names(OSSL_NAMEMAP *namemap, int number,
258 const char *names, const char separator)
263 /* Check that we have a namemap */
264 if (!ossl_assert(namemap != NULL)) {
265 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
270 * Check that no name is an empty string, and that all names have at
271 * most one numeric identity together.
273 for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
276 if ((q = strchr(p, separator)) == NULL)
277 l = strlen(p); /* offset to \0 */
279 l = q - p; /* offset to the next separator */
281 this_number = ossl_namemap_name2num_n(namemap, p, l);
283 if (*p == '\0' || *p == separator) {
284 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_BAD_ALGORITHM_NAME);
288 number = this_number;
289 } else if (this_number != 0 && this_number != number) {
290 ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_CONFLICTING_NAMES,
291 "\"%.*s\" has an existing different identity %d (from \"%s\")",
292 l, p, this_number, names);
297 /* Now that we have checked, register all names */
298 for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
301 if ((q = strchr(p, separator)) == NULL)
302 l = strlen(p); /* offset to \0 */
304 l = q - p; /* offset to the next separator */
306 this_number = ossl_namemap_add_name_n(namemap, number, p, l);
308 number = this_number;
309 } else if (this_number != number) {
310 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR,
311 "Got number %d when expecting %d",
312 this_number, number);
326 #include <openssl/evp.h>
328 /* Creates an initial namemap with names found in the legacy method db */
329 static void get_legacy_evp_names(const char *main_name, const char *alias,
332 int main_id = ossl_namemap_add_name(arg, 0, main_name);
335 * We could check that the returned value is the same as main_id,
336 * but since this is a void function, there's no sane way to report
337 * the error. The best we can do is trust ourselve to keep the legacy
338 * method database conflict free.
340 * This registers any alias with the same number as the main name.
341 * Should it be that the current |on| *has* the main name, this is
345 (void)ossl_namemap_add_name(arg, main_id, alias);
349 static void get_legacy_cipher_names(const OBJ_NAME *on, void *arg)
351 const EVP_CIPHER *cipher = (void *)OBJ_NAME_get(on->name, on->type);
353 get_legacy_evp_names(EVP_CIPHER_name(cipher), on->name, arg);
356 static void get_legacy_md_names(const OBJ_NAME *on, void *arg)
358 const EVP_MD *md = (void *)OBJ_NAME_get(on->name, on->type);
359 /* We don't want the pkey_type names, so we need some extra care */
362 snid = OBJ_sn2nid(on->name);
363 lnid = OBJ_ln2nid(on->name);
364 if (snid != EVP_MD_pkey_type(md) && lnid != EVP_MD_pkey_type(md))
365 get_legacy_evp_names(EVP_MD_name(md), on->name, arg);
367 get_legacy_evp_names(EVP_MD_name(md), NULL, arg);
372 * Constructors / destructors
373 * ==========================
376 OSSL_NAMEMAP *ossl_namemap_stored(OPENSSL_CTX *libctx)
378 OSSL_NAMEMAP *namemap =
379 openssl_ctx_get_data(libctx, OPENSSL_CTX_NAMEMAP_INDEX,
380 &stored_namemap_method);
383 if (namemap != NULL && ossl_namemap_empty(namemap)) {
384 /* Before pilfering, we make sure the legacy database is populated */
385 OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS
386 | OPENSSL_INIT_ADD_ALL_DIGESTS, NULL);
388 OBJ_NAME_do_all(OBJ_NAME_TYPE_CIPHER_METH,
389 get_legacy_cipher_names, namemap);
390 OBJ_NAME_do_all(OBJ_NAME_TYPE_MD_METH,
391 get_legacy_md_names, namemap);
398 OSSL_NAMEMAP *ossl_namemap_new(void)
400 OSSL_NAMEMAP *namemap;
402 if ((namemap = OPENSSL_zalloc(sizeof(*namemap))) != NULL
403 && (namemap->lock = CRYPTO_THREAD_lock_new()) != NULL
404 && (namemap->namenum =
405 lh_NAMENUM_ENTRY_new(namenum_hash, namenum_cmp)) != NULL)
408 ossl_namemap_free(namemap);
412 void ossl_namemap_free(OSSL_NAMEMAP *namemap)
414 if (namemap == NULL || namemap->stored)
417 lh_NAMENUM_ENTRY_doall(namemap->namenum, namenum_free);
418 lh_NAMENUM_ENTRY_free(namemap->namenum);
420 CRYPTO_THREAD_lock_free(namemap->lock);
421 OPENSSL_free(namemap);