crypto/evp/evp_fetch.c

   1 /*
   2  * Copyright 2019 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 <stddef.h>
  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 "crypto/evp.h"    /* evp_local.h needs it */
  21 #include "evp_local.h"
  22
  23 #define NAME_SEPARATOR ':'
  24
  25 static void evp_method_store_free(void *vstore)
  26 {
  27     ossl_method_store_free(vstore);
  28 }
  29
  30 static void *evp_method_store_new(OPENSSL_CTX *ctx)
  31 {
  32     return ossl_method_store_new(ctx);
  33 }
  34
  35
  36 static const OPENSSL_CTX_METHOD evp_method_store_method = {
  37     evp_method_store_new,
  38     evp_method_store_free,
  39 };
  40
  41 /* Data to be passed through ossl_method_construct() */
  42 struct evp_method_data_st {
  43     OPENSSL_CTX *libctx;
  44     OSSL_METHOD_CONSTRUCT_METHOD *mcm;
  45     int operation_id;            /* For get_evp_method_from_store() */
  46     int name_id;                 /* For get_evp_method_from_store() */
  47     const char *names;           /* For get_evp_method_from_store() */
  48     const char *propquery;       /* For get_evp_method_from_store() */
  49     void *(*method_from_dispatch)(int name_id, const OSSL_DISPATCH *,
  50                                   OSSL_PROVIDER *, void *);
  51     void *method_data;
  52     int (*refcnt_up_method)(void *method);
  53     void (*destruct_method)(void *method);
  54 };
  55
  56 static int add_names_to_namemap(OSSL_NAMEMAP *namemap,
  57                                 const char *names)
  58 {
  59     const char *p, *q;
  60     size_t l;
  61     int id = 0;
  62
  63     /* Check that we have a namemap and that there is at least one name */
  64     if (namemap == NULL) {
  65         ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
  66         return 0;
  67     }
  68
  69     /*
  70      * Check that no name is an empty string, and that all names have at
  71      * most one numeric identity together.
  72      */
  73     for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
  74         int this_id;
  75
  76         if ((q = strchr(p, NAME_SEPARATOR)) == NULL)
  77             l = strlen(p);       /* offset to \0 */
  78         else
  79             l = q - p;           /* offset to the next separator */
  80
  81         this_id = ossl_namemap_name2num_n(namemap, p, l);
  82
  83         if (*p == '\0' || *p == NAME_SEPARATOR) {
  84             ERR_raise(ERR_LIB_EVP, EVP_R_BAD_ALGORITHM_NAME);
  85             return 0;
  86         }
  87         if (id == 0)
  88             id = this_id;
  89         else if (this_id != 0 && this_id != id) {
  90             ERR_raise_data(ERR_LIB_EVP, EVP_R_CONFLICTING_ALGORITHM_NAME,
  91                            "\"%.*s\" has an existing different identity %d (from \"%s\")",
  92                            l, p, this_id, names);
  93             return 0;
  94         }
  95     }
  96
  97     /* Now that we have checked, register all names */
  98     for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
  99         int this_id;
 100
 101         if ((q = strchr(p, NAME_SEPARATOR)) == NULL)
 102             l = strlen(p);       /* offset to \0 */
 103         else
 104             l = q - p;           /* offset to the next separator */
 105
 106         this_id = ossl_namemap_add_n(namemap, id, p, l);
 107         if (id == 0)
 108             id = this_id;
 109         else if (this_id != id) {
 110             ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
 111                            "Got id %d when expecting %d", this_id, id);
 112             return 0;
 113         }
 114     }
 115
 116     return id;
 117 }
 118
 119 /*
 120  * Generic routines to fetch / create EVP methods with ossl_method_construct()
 121  */
 122 static void *alloc_tmp_evp_method_store(OPENSSL_CTX *ctx)
 123 {
 124     return ossl_method_store_new(ctx);
 125 }
 126
 127  static void dealloc_tmp_evp_method_store(void *store)
 128 {
 129     if (store != NULL)
 130         ossl_method_store_free(store);
 131 }
 132
 133 static OSSL_METHOD_STORE *get_evp_method_store(OPENSSL_CTX *libctx)
 134 {
 135     return openssl_ctx_get_data(libctx, OPENSSL_CTX_EVP_METHOD_STORE_INDEX,
 136                                 &evp_method_store_method);
 137 }
 138
 139 /*
 140  * To identity the method in the EVP method store, we mix the name identity
 141  * with the operation identity, with the assumption that we don't have more
 142  * than 2^24 names or more than 2^8 operation types.
 143  *
 144  * The resulting identity is a 32-bit integer, composed like this:
 145  *
 146  * +---------24 bits--------+-8 bits-+
 147  * |      name identity     | op id  |
 148  * +------------------------+--------+
 149  */
 150 static uint32_t evp_method_id(unsigned int operation_id, int name_id)
 151 {
 152     if (!ossl_assert(name_id < (1 << 24) || operation_id < (1 << 8))
 153         || !ossl_assert(name_id > 0 && operation_id > 0))
 154         return 0;
 155     return ((name_id << 8) & 0xFFFFFF00) | (operation_id & 0x000000FF);
 156 }
 157
 158 static void *get_evp_method_from_store(OPENSSL_CTX *libctx, void *store,
 159                                        void *data)
 160 {
 161     struct evp_method_data_st *methdata = data;
 162     void *method = NULL;
 163     int name_id;
 164     uint32_t meth_id;
 165
 166     /*
 167      * get_evp_method_from_store() is only called to try and get the method
 168      * that evp_generic_fetch() is asking for, and the operation id as well
 169      * as the name or name id are passed via methdata.
 170      */
 171     if ((name_id = methdata->name_id) == 0) {
 172         OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 173         const char *names = methdata->names;
 174         const char *q = strchr(names, NAME_SEPARATOR);
 175         size_t l = (q == NULL ? strlen(names) : (size_t)(q - names));
 176
 177         if (namemap == 0)
 178             return NULL;
 179         name_id = ossl_namemap_name2num_n(namemap, names, l);
 180     }
 181
 182     if (name_id == 0
 183         || (meth_id = evp_method_id(methdata->operation_id, name_id)) == 0)
 184         return NULL;
 185
 186     if (store == NULL
 187         && (store = get_evp_method_store(libctx)) == NULL)
 188         return NULL;
 189
 190     (void)ossl_method_store_fetch(store, meth_id, methdata->propquery,
 191                                   &method);
 192
 193     if (method != NULL
 194         && !methdata->refcnt_up_method(method)) {
 195         method = NULL;
 196     }
 197     return method;
 198 }
 199
 200 static int put_evp_method_in_store(OPENSSL_CTX *libctx, void *store,
 201                                    void *method, const OSSL_PROVIDER *prov,
 202                                    int operation_id, const char *names,
 203                                    const char *propdef, void *data)
 204 {
 205     struct evp_method_data_st *methdata = data;
 206     OSSL_NAMEMAP *namemap;
 207     int name_id;
 208     uint32_t meth_id;
 209     size_t l = 0;
 210
 211     /*
 212      * put_evp_method_in_store() is only called with an EVP method that was
 213      * successfully created by construct_method() below, which means that
 214      * all the names should already be stored in the namemap with the same
 215      * numeric identity, so just use the first to get that identity.
 216      */
 217     if (names != NULL) {
 218         const char *q = strchr(names, NAME_SEPARATOR);
 219
 220         l = (q == NULL ? strlen(names) : (size_t)(q - names));
 221     }
 222
 223     if ((namemap = ossl_namemap_stored(libctx)) == NULL
 224         || (name_id = ossl_namemap_name2num_n(namemap, names, l)) == 0
 225         || (meth_id = evp_method_id(operation_id, name_id)) == 0)
 226         return 0;
 227
 228     if (store == NULL
 229         && (store = get_evp_method_store(libctx)) == NULL)
 230         return 0;
 231
 232     return ossl_method_store_add(store, prov, meth_id, propdef, method,
 233                                  methdata->refcnt_up_method,
 234                                  methdata->destruct_method);
 235 }
 236
 237 /*
 238  * The core fetching functionality passes the name of the implementation.
 239  * This function is responsible to getting an identity number for it.
 240  */
 241 static void *construct_evp_method(const char *names, const OSSL_DISPATCH *fns,
 242                                   OSSL_PROVIDER *prov, void *data)
 243 {
 244     /*
 245      * This function is only called if get_evp_method_from_store() returned
 246      * NULL, so it's safe to say that of all the spots to create a new
 247      * namemap entry, this is it.  Should the name already exist there, we
 248      * know that ossl_namemap_add() will return its corresponding number.
 249      */
 250     struct evp_method_data_st *methdata = data;
 251     OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
 252     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 253     int name_id = add_names_to_namemap(namemap, names);
 254
 255     if (name_id == 0)
 256         return NULL;
 257     return methdata->method_from_dispatch(name_id, fns, prov,
 258                                           methdata->method_data);
 259 }
 260
 261 static void destruct_evp_method(void *method, void *data)
 262 {
 263     struct evp_method_data_st *methdata = data;
 264
 265     methdata->destruct_method(method);
 266 }
 267
 268 static void *
 269 inner_evp_generic_fetch(OPENSSL_CTX *libctx, int operation_id,
 270                         int name_id, const char *name,
 271                         const char *properties,
 272                         void *(*new_method)(int name_id,
 273                                             const OSSL_DISPATCH *fns,
 274                                             OSSL_PROVIDER *prov,
 275                                             void *method_data),
 276                         void *method_data,
 277                         int (*up_ref_method)(void *),
 278                         void (*free_method)(void *))
 279 {
 280     OSSL_METHOD_STORE *store = get_evp_method_store(libctx);
 281     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 282     uint32_t meth_id = 0;
 283     void *method = NULL;
 284
 285     if (store == NULL || namemap == NULL)
 286         return NULL;
 287
 288     /*
 289      * If there's ever an operation_id == 0 passed, we have an internal
 290      * programming error.
 291      */
 292     if (!ossl_assert(operation_id > 0))
 293         return NULL;
 294
 295     /*
 296      * If we have been passed neither a name_id or a name, we have an
 297      * internal programming error.
 298      */
 299     if (!ossl_assert(name_id != 0 || name != NULL))
 300         return NULL;
 301
 302     /* If we haven't received a name id yet, try to get one for the name */
 303     if (name_id == 0)
 304         name_id = ossl_namemap_name2num(namemap, name);
 305
 306     /*
 307      * If we have a name id, calculate a method id with evp_method_id().
 308      *
 309      * evp_method_id returns 0 if we have too many operations (more than
 310      * about 2^8) or too many names (more than about 2^24).  In that case,
 311      * we can't create any new method.
 312      */
 313     if (name_id != 0 && (meth_id = evp_method_id(operation_id, name_id)) == 0)
 314         return NULL;
 315
 316     if (meth_id == 0
 317         || !ossl_method_store_cache_get(store, meth_id, properties, &method)) {
 318         OSSL_METHOD_CONSTRUCT_METHOD mcm = {
 319             alloc_tmp_evp_method_store,
 320             dealloc_tmp_evp_method_store,
 321             get_evp_method_from_store,
 322             put_evp_method_in_store,
 323             construct_evp_method,
 324             destruct_evp_method
 325         };
 326         struct evp_method_data_st mcmdata;
 327
 328         mcmdata.mcm = &mcm;
 329         mcmdata.libctx = libctx;
 330         mcmdata.operation_id = operation_id;
 331         mcmdata.name_id = name_id;
 332         mcmdata.names = name;
 333         mcmdata.propquery = properties;
 334         mcmdata.method_from_dispatch = new_method;
 335         mcmdata.destruct_method = free_method;
 336         mcmdata.refcnt_up_method = up_ref_method;
 337         mcmdata.destruct_method = free_method;
 338         mcmdata.method_data = method_data;
 339         if ((method = ossl_method_construct(libctx, operation_id,
 340                                             0 /* !force_cache */,
 341                                             &mcm, &mcmdata)) != NULL) {
 342             /*
 343              * If construction did create a method for us, we know that
 344              * there is a correct name_id and meth_id, since those have
 345              * already been calculated in get_evp_method_from_store() and
 346              * put_evp_method_in_store() above.
 347              */
 348             if (name_id == 0)
 349                 name_id = ossl_namemap_name2num(namemap, name);
 350             meth_id = evp_method_id(operation_id, name_id);
 351             ossl_method_store_cache_set(store, meth_id, properties, method);
 352         }
 353     } else {
 354         up_ref_method(method);
 355     }
 356
 357     return method;
 358 }
 359
 360 void *evp_generic_fetch(OPENSSL_CTX *libctx, int operation_id,
 361                         const char *name, const char *properties,
 362                         void *(*new_method)(int name_id,
 363                                             const OSSL_DISPATCH *fns,
 364                                             OSSL_PROVIDER *prov,
 365                                             void *method_data),
 366                         void *method_data,
 367                         int (*up_ref_method)(void *),
 368                         void (*free_method)(void *))
 369 {
 370     return inner_evp_generic_fetch(libctx,
 371                                    operation_id, 0, name, properties,
 372                                    new_method, method_data,
 373                                    up_ref_method, free_method);
 374 }
 375
 376 /*
 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
 381  * other method.
 382  */
 383 void *evp_generic_fetch_by_number(OPENSSL_CTX *libctx, int operation_id,
 384                                   int name_id, const char *properties,
 385                                   void *(*new_method)(int name_id,
 386                                                       const OSSL_DISPATCH *fns,
 387                                                       OSSL_PROVIDER *prov,
 388                                                       void *method_data),
 389                                   void *method_data,
 390                                   int (*up_ref_method)(void *),
 391                                   void (*free_method)(void *))
 392 {
 393     return inner_evp_generic_fetch(libctx,
 394                                    operation_id, name_id, NULL, properties,
 395                                    new_method, method_data,
 396                                    up_ref_method, free_method);
 397 }
 398
 399 int EVP_set_default_properties(OPENSSL_CTX *libctx, const char *propq)
 400 {
 401     OSSL_METHOD_STORE *store = get_evp_method_store(libctx);
 402
 403     if (store != NULL)
 404         return ossl_method_store_set_global_properties(store, propq);
 405     EVPerr(EVP_F_EVP_SET_DEFAULT_PROPERTIES, ERR_R_INTERNAL_ERROR);
 406     return 0;
 407 }
 408
 409 struct do_all_data_st {
 410     void (*user_fn)(void *method, void *arg);
 411     void *user_arg;
 412     void *(*new_method)(const int name_id, const OSSL_DISPATCH *fns,
 413                         OSSL_PROVIDER *prov, void *method_data);
 414     void *method_data;
 415     void (*free_method)(void *);
 416 };
 417
 418 static void do_one(OSSL_PROVIDER *provider, const OSSL_ALGORITHM *algo,
 419                    int no_store, void *vdata)
 420 {
 421     struct do_all_data_st *data = vdata;
 422     OPENSSL_CTX *libctx = ossl_provider_library_context(provider);
 423     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 424     int name_id = add_names_to_namemap(namemap, algo->algorithm_names);
 425     void *method = NULL;
 426
 427     if (name_id != 0)
 428         method = data->new_method(name_id, algo->implementation, provider,
 429                                   data->method_data);
 430
 431     if (method != NULL) {
 432         data->user_fn(method, data->user_arg);
 433         data->free_method(method);
 434     }
 435 }
 436
 437 void evp_generic_do_all(OPENSSL_CTX *libctx, int operation_id,
 438                         void (*user_fn)(void *method, void *arg),
 439                         void *user_arg,
 440                         void *(*new_method)(int name_id,
 441                                             const OSSL_DISPATCH *fns,
 442                                             OSSL_PROVIDER *prov,
 443                                             void *method_data),
 444                         void *method_data,
 445                         void (*free_method)(void *))
 446 {
 447     struct do_all_data_st data;
 448
 449     data.new_method = new_method;
 450     data.method_data = method_data;
 451     data.free_method = free_method;
 452     data.user_fn = user_fn;
 453     data.user_arg = user_arg;
 454     ossl_algorithm_do_all(libctx, operation_id, NULL, do_one, &data);
 455 }
 456
 457 const char *evp_first_name(OSSL_PROVIDER *prov, int name_id)
 458 {
 459     OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
 460     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 461
 462     return ossl_namemap_num2name(namemap, name_id, 0);
 463 }
 464
 465 int evp_is_a(OSSL_PROVIDER *prov, int number, const char *name)
 466 {
 467     OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
 468     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 469
 470     return ossl_namemap_name2num(namemap, name) == number;
 471 }
 472
 473 void evp_names_do_all(OSSL_PROVIDER *prov, int number,
 474                       void (*fn)(const char *name, void *data),
 475                       void *data)
 476 {
 477     OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
 478     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 479
 480     ossl_namemap_doall_names(namemap, number, fn, data);
 481 }