crypto/core_namemap.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 "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"
  15
  16 /*-
  17  * The namenum entry
  18  * =================
  19  */
  20 typedef struct {
  21     char *name;
  22     int number;
  23 } NAMENUM_ENTRY;
  24
  25 DEFINE_LHASH_OF(NAMENUM_ENTRY);
  26
  27 /*-
  28  * The namemap itself
  29  * ==================
  30  */
  31
  32 struct ossl_namemap_st {
  33     /* Flags */
  34     unsigned int stored:1; /* If 1, it's stored in a library context */
  35
  36     CRYPTO_RWLOCK *lock;
  37     LHASH_OF(NAMENUM_ENTRY) *namenum;  /* Name->number mapping */
  38
  39 #ifdef tsan_ld_acq
  40     TSAN_QUALIFIER int max_number;     /* Current max number TSAN version */
  41 #else
  42     int max_number;                    /* Current max number plain version */
  43 #endif
  44 };
  45
  46 /* LHASH callbacks */
  47
  48 static unsigned long namenum_hash(const NAMENUM_ENTRY *n)
  49 {
  50     return openssl_lh_strcasehash(n->name);
  51 }
  52
  53 static int namenum_cmp(const NAMENUM_ENTRY *a, const NAMENUM_ENTRY *b)
  54 {
  55     return strcasecmp(a->name, b->name);
  56 }
  57
  58 static void namenum_free(NAMENUM_ENTRY *n)
  59 {
  60     if (n != NULL)
  61         OPENSSL_free(n->name);
  62     OPENSSL_free(n);
  63 }
  64
  65 /* OPENSSL_CTX_METHOD functions for a namemap stored in a library context */
  66
  67 static void *stored_namemap_new(OPENSSL_CTX *libctx)
  68 {
  69     OSSL_NAMEMAP *namemap = ossl_namemap_new();
  70
  71     if (namemap != NULL)
  72         namemap->stored = 1;
  73
  74     return namemap;
  75 }
  76
  77 static void stored_namemap_free(void *vnamemap)
  78 {
  79     OSSL_NAMEMAP *namemap = vnamemap;
  80
  81     if (namemap != NULL) {
  82         /* Pretend it isn't stored, or ossl_namemap_free() will do nothing */
  83         namemap->stored = 0;
  84         ossl_namemap_free(namemap);
  85     }
  86 }
  87
  88 static const OPENSSL_CTX_METHOD stored_namemap_method = {
  89     stored_namemap_new,
  90     stored_namemap_free,
  91 };
  92
  93 /*-
  94  * API functions
  95  * =============
  96  */
  97
  98 int ossl_namemap_empty(OSSL_NAMEMAP *namemap)
  99 {
 100 #ifdef tsan_ld_acq
 101     /* Have TSAN support */
 102     return namemap == NULL || tsan_load(&namemap->max_number) == 0;
 103 #else
 104     /* No TSAN support */
 105     int rv;
 106
 107     if (namemap == NULL)
 108         return 1;
 109
 110     CRYPTO_THREAD_read_lock(namemap->lock);
 111     rv = namemap->max_number == 0;
 112     CRYPTO_THREAD_unlock(namemap->lock);
 113     return rv;
 114 #endif
 115 }
 116
 117 typedef struct doall_names_data_st {
 118     int number;
 119     void (*fn)(const char *name, void *data);
 120     void *data;
 121 } DOALL_NAMES_DATA;
 122
 123 static void do_name(const NAMENUM_ENTRY *namenum, DOALL_NAMES_DATA *data)
 124 {
 125     if (namenum->number == data->number)
 126         data->fn(namenum->name, data->data);
 127 }
 128
 129 IMPLEMENT_LHASH_DOALL_ARG_CONST(NAMENUM_ENTRY, DOALL_NAMES_DATA);
 130
 131 void ossl_namemap_doall_names(const OSSL_NAMEMAP *namemap, int number,
 132                               void (*fn)(const char *name, void *data),
 133                               void *data)
 134 {
 135     DOALL_NAMES_DATA cbdata;
 136
 137     cbdata.number = number;
 138     cbdata.fn = fn;
 139     cbdata.data = data;
 140     CRYPTO_THREAD_read_lock(namemap->lock);
 141     lh_NAMENUM_ENTRY_doall_DOALL_NAMES_DATA(namemap->namenum, do_name,
 142                                             &cbdata);
 143     CRYPTO_THREAD_unlock(namemap->lock);
 144 }
 145
 146 int ossl_namemap_name2num_n(const OSSL_NAMEMAP *namemap,
 147                             const char *name, size_t name_len)
 148 {
 149     NAMENUM_ENTRY *namenum_entry, namenum_tmpl;
 150     int number = 0;
 151
 152 #ifndef FIPS_MODULE
 153     if (namemap == NULL)
 154         namemap = ossl_namemap_stored(NULL);
 155 #endif
 156
 157     if (namemap == NULL)
 158         return 0;
 159
 160     if ((namenum_tmpl.name = OPENSSL_strndup(name, name_len)) == NULL)
 161         return 0;
 162     namenum_tmpl.number = 0;
 163     CRYPTO_THREAD_read_lock(namemap->lock);
 164     namenum_entry =
 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);
 170
 171     return number;
 172 }
 173
 174 int ossl_namemap_name2num(const OSSL_NAMEMAP *namemap, const char *name)
 175 {
 176     if (name == NULL)
 177         return 0;
 178
 179     return ossl_namemap_name2num_n(namemap, name, strlen(name));
 180 }
 181
 182 struct num2name_data_st {
 183     size_t idx;                  /* Countdown */
 184     const char *name;            /* Result */
 185 };
 186
 187 static void do_num2name(const char *name, void *vdata)
 188 {
 189     struct num2name_data_st *data = vdata;
 190
 191     if (data->idx > 0)
 192         data->idx--;
 193     else if (data->name == NULL)
 194         data->name = name;
 195 }
 196
 197 const char *ossl_namemap_num2name(const OSSL_NAMEMAP *namemap, int number,
 198                                   size_t idx)
 199 {
 200     struct num2name_data_st data;
 201
 202     data.idx = idx;
 203     data.name = NULL;
 204     ossl_namemap_doall_names(namemap, number, do_num2name, &data);
 205     return data.name;
 206 }
 207
 208 int ossl_namemap_add_name_n(OSSL_NAMEMAP *namemap, int number,
 209                             const char *name, size_t name_len)
 210 {
 211     NAMENUM_ENTRY *namenum = NULL;
 212     int tmp_number;
 213
 214 #ifndef FIPS_MODULE
 215     if (namemap == NULL)
 216         namemap = ossl_namemap_stored(NULL);
 217 #endif
 218
 219     if (name == NULL || name_len == 0 || namemap == NULL)
 220         return 0;
 221
 222     if ((tmp_number = ossl_namemap_name2num_n(namemap, name, name_len)) != 0)
 223         return tmp_number;       /* Pretend success */
 224
 225     CRYPTO_THREAD_write_lock(namemap->lock);
 226
 227     if ((namenum = OPENSSL_zalloc(sizeof(*namenum))) == NULL
 228         || (namenum->name = OPENSSL_strndup(name, name_len)) == NULL)
 229         goto err;
 230
 231     namenum->number = tmp_number =
 232         number != 0 ? number : 1 + tsan_counter(&namemap->max_number);
 233     (void)lh_NAMENUM_ENTRY_insert(namemap->namenum, namenum);
 234
 235     if (lh_NAMENUM_ENTRY_error(namemap->namenum))
 236         goto err;
 237
 238     CRYPTO_THREAD_unlock(namemap->lock);
 239
 240     return tmp_number;
 241
 242  err:
 243     namenum_free(namenum);
 244
 245     CRYPTO_THREAD_unlock(namemap->lock);
 246     return 0;
 247 }
 248
 249 int ossl_namemap_add_name(OSSL_NAMEMAP *namemap, int number, const char *name)
 250 {
 251     if (name == NULL)
 252         return 0;
 253
 254     return ossl_namemap_add_name_n(namemap, number, name, strlen(name));
 255 }
 256
 257 int ossl_namemap_add_names(OSSL_NAMEMAP *namemap, int number,
 258                            const char *names, const char separator)
 259 {
 260     const char *p, *q;
 261     size_t l;
 262
 263     /* Check that we have a namemap */
 264     if (!ossl_assert(namemap != NULL)) {
 265         ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
 266         return 0;
 267     }
 268
 269     /*
 270      * Check that no name is an empty string, and that all names have at
 271      * most one numeric identity together.
 272      */
 273     for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
 274         int this_number;
 275
 276         if ((q = strchr(p, separator)) == NULL)
 277             l = strlen(p);       /* offset to \0 */
 278         else
 279             l = q - p;           /* offset to the next separator */
 280
 281         this_number = ossl_namemap_name2num_n(namemap, p, l);
 282
 283         if (*p == '\0' || *p == separator) {
 284             ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_BAD_ALGORITHM_NAME);
 285             return 0;
 286         }
 287         if (number == 0) {
 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);
 293             return 0;
 294         }
 295     }
 296
 297     /* Now that we have checked, register all names */
 298     for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
 299         int this_number;
 300
 301         if ((q = strchr(p, separator)) == NULL)
 302             l = strlen(p);       /* offset to \0 */
 303         else
 304             l = q - p;           /* offset to the next separator */
 305
 306         this_number = ossl_namemap_add_name_n(namemap, number, p, l);
 307         if (number == 0) {
 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);
 313             return 0;
 314         }
 315     }
 316
 317     return number;
 318 }
 319
 320 /*-
 321  * Pre-population
 322  * ==============
 323  */
 324
 325 #ifndef FIPS_MODULE
 326 #include <openssl/evp.h>
 327
 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,
 330                                  void *arg)
 331 {
 332     int main_id = ossl_namemap_add_name(arg, 0, main_name);
 333
 334     /*
 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.
 339      *
 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
 342      * simply a no-op.
 343      */
 344     if (alias != NULL) {
 345         (void)ossl_namemap_add_name(arg, main_id, alias);
 346     }
 347 }
 348
 349 static void get_legacy_cipher_names(const OBJ_NAME *on, void *arg)
 350 {
 351     const EVP_CIPHER *cipher = (void *)OBJ_NAME_get(on->name, on->type);
 352
 353     get_legacy_evp_names(EVP_CIPHER_name(cipher), on->name, arg);
 354 }
 355
 356 static void get_legacy_md_names(const OBJ_NAME *on, void *arg)
 357 {
 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 */
 360     int snid, lnid;
 361
 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);
 366     else
 367         get_legacy_evp_names(EVP_MD_name(md), NULL, arg);
 368 }
 369 #endif
 370
 371 /*-
 372  * Constructors / destructors
 373  * ==========================
 374  */
 375
 376 OSSL_NAMEMAP *ossl_namemap_stored(OPENSSL_CTX *libctx)
 377 {
 378     OSSL_NAMEMAP *namemap =
 379         openssl_ctx_get_data(libctx, OPENSSL_CTX_NAMEMAP_INDEX,
 380                              &stored_namemap_method);
 381
 382 #ifndef FIPS_MODULE
 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);
 387
 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);
 392     }
 393 #endif
 394
 395     return namemap;
 396 }
 397
 398 OSSL_NAMEMAP *ossl_namemap_new(void)
 399 {
 400     OSSL_NAMEMAP *namemap;
 401
 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)
 406         return namemap;
 407
 408     ossl_namemap_free(namemap);
 409     return NULL;
 410 }
 411
 412 void ossl_namemap_free(OSSL_NAMEMAP *namemap)
 413 {
 414     if (namemap == NULL || namemap->stored)
 415         return;
 416
 417     lh_NAMENUM_ENTRY_doall(namemap->namenum, namenum_free);
 418     lh_NAMENUM_ENTRY_free(namemap->namenum);
 419
 420     CRYPTO_THREAD_lock_free(namemap->lock);
 421     OPENSSL_free(namemap);
 422 }