2 * Copyright 2019 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 */
24 DEFINE_LHASH_OF(NAMENUM_ENTRY);
31 struct ossl_namemap_st {
33 unsigned int stored:1; /* If 1, it's stored in a library context */
36 LHASH_OF(NAMENUM_ENTRY) *namenum; /* Name->number mapping */
37 int max_number; /* Current max number */
42 static unsigned long namenum_hash(const NAMENUM_ENTRY *n)
44 return openssl_lh_strcasehash(n->name);
47 static int namenum_cmp(const NAMENUM_ENTRY *a, const NAMENUM_ENTRY *b)
49 return strcasecmp(a->name, b->name);
52 static void namenum_free(NAMENUM_ENTRY *n)
55 OPENSSL_free(n->name);
59 /* OPENSSL_CTX_METHOD functions for a namemap stored in a library context */
61 static void *stored_namemap_new(OPENSSL_CTX *libctx)
63 OSSL_NAMEMAP *namemap = ossl_namemap_new();
71 static void stored_namemap_free(void *vnamemap)
73 OSSL_NAMEMAP *namemap = vnamemap;
75 if (namemap != NULL) {
76 /* Pretend it isn't stored, or ossl_namemap_free() will do nothing */
78 ossl_namemap_free(namemap);
82 static const OPENSSL_CTX_METHOD stored_namemap_method = {
92 OSSL_NAMEMAP *ossl_namemap_stored(OPENSSL_CTX *libctx)
94 return openssl_ctx_get_data(libctx, OPENSSL_CTX_NAMEMAP_INDEX,
95 &stored_namemap_method);
98 OSSL_NAMEMAP *ossl_namemap_new(void)
100 OSSL_NAMEMAP *namemap;
102 if ((namemap = OPENSSL_zalloc(sizeof(*namemap))) != NULL
103 && (namemap->lock = CRYPTO_THREAD_lock_new()) != NULL
104 && (namemap->namenum =
105 lh_NAMENUM_ENTRY_new(namenum_hash, namenum_cmp)) != NULL)
108 ossl_namemap_free(namemap);
112 void ossl_namemap_free(OSSL_NAMEMAP *namemap)
114 if (namemap == NULL || namemap->stored)
117 lh_NAMENUM_ENTRY_doall(namemap->namenum, namenum_free);
118 lh_NAMENUM_ENTRY_free(namemap->namenum);
120 CRYPTO_THREAD_lock_free(namemap->lock);
121 OPENSSL_free(namemap);
124 int ossl_namemap_empty(OSSL_NAMEMAP *namemap)
128 CRYPTO_THREAD_read_lock(namemap->lock);
129 if (namemap->max_number == 0)
131 CRYPTO_THREAD_unlock(namemap->lock);
136 typedef struct doall_names_data_st {
138 void (*fn)(const char *name, void *data);
142 static void do_name(const NAMENUM_ENTRY *namenum, DOALL_NAMES_DATA *data)
144 if (namenum->number == data->number)
145 data->fn(namenum->name, data->data);
148 IMPLEMENT_LHASH_DOALL_ARG_CONST(NAMENUM_ENTRY, DOALL_NAMES_DATA);
150 void ossl_namemap_doall_names(const OSSL_NAMEMAP *namemap, int number,
151 void (*fn)(const char *name, void *data),
154 DOALL_NAMES_DATA cbdata;
156 cbdata.number = number;
159 CRYPTO_THREAD_read_lock(namemap->lock);
160 lh_NAMENUM_ENTRY_doall_DOALL_NAMES_DATA(namemap->namenum, do_name,
162 CRYPTO_THREAD_unlock(namemap->lock);
165 int ossl_namemap_name2num_n(const OSSL_NAMEMAP *namemap,
166 const char *name, size_t name_len)
168 NAMENUM_ENTRY *namenum_entry, namenum_tmpl;
173 namemap = ossl_namemap_stored(NULL);
179 if ((namenum_tmpl.name = OPENSSL_strndup(name, name_len)) == NULL)
181 namenum_tmpl.number = 0;
182 CRYPTO_THREAD_read_lock(namemap->lock);
184 lh_NAMENUM_ENTRY_retrieve(namemap->namenum, &namenum_tmpl);
185 if (namenum_entry != NULL)
186 number = namenum_entry->number;
187 CRYPTO_THREAD_unlock(namemap->lock);
188 OPENSSL_free(namenum_tmpl.name);
193 int ossl_namemap_name2num(const OSSL_NAMEMAP *namemap, const char *name)
198 return ossl_namemap_name2num_n(namemap, name, strlen(name));
201 struct num2name_data_st {
202 size_t idx; /* Countdown */
203 const char *name; /* Result */
206 static void do_num2name(const char *name, void *vdata)
208 struct num2name_data_st *data = vdata;
212 else if (data->name == NULL)
216 const char *ossl_namemap_num2name(const OSSL_NAMEMAP *namemap, int number,
219 struct num2name_data_st data;
223 ossl_namemap_doall_names(namemap, number, do_num2name, &data);
227 int ossl_namemap_add_name_n(OSSL_NAMEMAP *namemap, int number,
228 const char *name, size_t name_len)
230 NAMENUM_ENTRY *namenum = NULL;
235 namemap = ossl_namemap_stored(NULL);
238 if (name == NULL || name_len == 0 || namemap == NULL)
241 if ((tmp_number = ossl_namemap_name2num_n(namemap, name, name_len)) != 0)
242 return tmp_number; /* Pretend success */
244 CRYPTO_THREAD_write_lock(namemap->lock);
246 if ((namenum = OPENSSL_zalloc(sizeof(*namenum))) == NULL
247 || (namenum->name = OPENSSL_strndup(name, name_len)) == NULL)
250 namenum->number = tmp_number =
251 number != 0 ? number : ++namemap->max_number;
252 (void)lh_NAMENUM_ENTRY_insert(namemap->namenum, namenum);
254 if (lh_NAMENUM_ENTRY_error(namemap->namenum))
257 CRYPTO_THREAD_unlock(namemap->lock);
262 namenum_free(namenum);
264 CRYPTO_THREAD_unlock(namemap->lock);
268 int ossl_namemap_add_name(OSSL_NAMEMAP *namemap, int number, const char *name)
273 return ossl_namemap_add_name_n(namemap, number, name, strlen(name));
276 int ossl_namemap_add_names(OSSL_NAMEMAP *namemap, int number,
277 const char *names, const char separator)
282 /* Check that we have a namemap */
283 if (!ossl_assert(namemap != NULL)) {
284 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
289 * Check that no name is an empty string, and that all names have at
290 * most one numeric identity together.
292 for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
295 if ((q = strchr(p, separator)) == NULL)
296 l = strlen(p); /* offset to \0 */
298 l = q - p; /* offset to the next separator */
300 this_number = ossl_namemap_name2num_n(namemap, p, l);
302 if (*p == '\0' || *p == separator) {
303 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_BAD_ALGORITHM_NAME);
307 number = this_number;
308 } else if (this_number != 0 && this_number != number) {
309 ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_CONFLICTING_NAMES,
310 "\"%.*s\" has an existing different identity %d (from \"%s\")",
311 l, p, this_number, names);
316 /* Now that we have checked, register all names */
317 for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
320 if ((q = strchr(p, separator)) == NULL)
321 l = strlen(p); /* offset to \0 */
323 l = q - p; /* offset to the next separator */
325 this_number = ossl_namemap_add_name_n(namemap, number, p, l);
327 number = this_number;
328 } else if (this_number != number) {
329 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
330 "Got number %d when expecting %d",
331 this_number, number);