crypto/evp/evp_fetch.c

   1 /*
   2  * Copyright 2019-2021 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 "internal/property.h"
  21 #include "crypto/evp.h"    /* evp_local.h needs it */
  22 #include "evp_local.h"
  23
  24 #define NAME_SEPARATOR ':'
  25
  26 static void evp_method_store_free(void *vstore)
  27 {
  28     ossl_method_store_free(vstore);
  29 }
  30
  31 static void *evp_method_store_new(OSSL_LIB_CTX *ctx)
  32 {
  33     return ossl_method_store_new(ctx);
  34 }
  35
  36
  37 static const OSSL_LIB_CTX_METHOD evp_method_store_method = {
  38     evp_method_store_new,
  39     evp_method_store_free,
  40 };
  41
  42 /* Data to be passed through ossl_method_construct() */
  43 struct evp_method_data_st {
  44     OSSL_LIB_CTX *libctx;
  45     OSSL_METHOD_CONSTRUCT_METHOD *mcm;
  46     int operation_id;            /* For get_evp_method_from_store() */
  47     int name_id;                 /* For get_evp_method_from_store() */
  48     const char *names;           /* For get_evp_method_from_store() */
  49     const char *propquery;       /* For get_evp_method_from_store() */
  50
  51     unsigned int flag_construct_error_occurred : 1;
  52
  53     void *(*method_from_algorithm)(int name_id, const OSSL_ALGORITHM *,
  54                                    OSSL_PROVIDER *);
  55     int (*refcnt_up_method)(void *method);
  56     void (*destruct_method)(void *method);
  57 };
  58
  59 /*
  60  * Generic routines to fetch / create EVP methods with ossl_method_construct()
  61  */
  62 static void *alloc_tmp_evp_method_store(OSSL_LIB_CTX *ctx)
  63 {
  64     return ossl_method_store_new(ctx);
  65 }
  66
  67  static void dealloc_tmp_evp_method_store(void *store)
  68 {
  69     if (store != NULL)
  70         ossl_method_store_free(store);
  71 }
  72
  73 static OSSL_METHOD_STORE *get_evp_method_store(OSSL_LIB_CTX *libctx)
  74 {
  75     return ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX,
  76                                  &evp_method_store_method);
  77 }
  78
  79 /*
  80  * To identify the method in the EVP method store, we mix the name identity
  81  * with the operation identity, under the assumption that we don't have more
  82  * than 2^24 names or more than 2^8 operation types.
  83  *
  84  * The resulting identity is a 32-bit integer, composed like this:
  85  *
  86  * +---------24 bits--------+-8 bits-+
  87  * |      name identity     | op id  |
  88  * +------------------------+--------+
  89  */
  90 static uint32_t evp_method_id(int name_id, unsigned int operation_id)
  91 {
  92     if (!ossl_assert(name_id > 0 && name_id < (1 << 24))
  93         || !ossl_assert(operation_id > 0 && operation_id < (1 << 8)))
  94         return 0;
  95     return ((name_id << 8) & 0xFFFFFF00) | (operation_id & 0x000000FF);
  96 }
  97
  98 static void *get_evp_method_from_store(OSSL_LIB_CTX *libctx, void *store,
  99                                        void *data)
 100 {
 101     struct evp_method_data_st *methdata = data;
 102     void *method = NULL;
 103     int name_id;
 104     uint32_t meth_id;
 105
 106     /*
 107      * get_evp_method_from_store() is only called to try and get the method
 108      * that evp_generic_fetch() is asking for, and the operation id as well
 109      * as the name or name id are passed via methdata.
 110      */
 111     if ((name_id = methdata->name_id) == 0) {
 112         OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 113         const char *names = methdata->names;
 114         const char *q = strchr(names, NAME_SEPARATOR);
 115         size_t l = (q == NULL ? strlen(names) : (size_t)(q - names));
 116
 117         if (namemap == 0)
 118             return NULL;
 119         name_id = ossl_namemap_name2num_n(namemap, names, l);
 120     }
 121
 122     if (name_id == 0
 123         || (meth_id = evp_method_id(name_id, methdata->operation_id)) == 0)
 124         return NULL;
 125
 126     if (store == NULL
 127         && (store = get_evp_method_store(libctx)) == NULL)
 128         return NULL;
 129
 130     if (!ossl_method_store_fetch(store, meth_id, methdata->propquery,
 131                                  &method))
 132         return NULL;
 133     return method;
 134 }
 135
 136 static int put_evp_method_in_store(OSSL_LIB_CTX *libctx, void *store,
 137                                    void *method, const OSSL_PROVIDER *prov,
 138                                    int operation_id, const char *names,
 139                                    const char *propdef, void *data)
 140 {
 141     struct evp_method_data_st *methdata = data;
 142     OSSL_NAMEMAP *namemap;
 143     int name_id;
 144     uint32_t meth_id;
 145     size_t l = 0;
 146
 147     /*
 148      * put_evp_method_in_store() is only called with an EVP method that was
 149      * successfully created by construct_method() below, which means that
 150      * all the names should already be stored in the namemap with the same
 151      * numeric identity, so just use the first to get that identity.
 152      */
 153     if (names != NULL) {
 154         const char *q = strchr(names, NAME_SEPARATOR);
 155
 156         l = (q == NULL ? strlen(names) : (size_t)(q - names));
 157     }
 158
 159     if ((namemap = ossl_namemap_stored(libctx)) == NULL
 160         || (name_id = ossl_namemap_name2num_n(namemap, names, l)) == 0
 161         || (meth_id = evp_method_id(name_id, operation_id)) == 0)
 162         return 0;
 163
 164     if (store == NULL
 165         && (store = get_evp_method_store(libctx)) == NULL)
 166         return 0;
 167
 168     return ossl_method_store_add(store, prov, meth_id, propdef, method,
 169                                  methdata->refcnt_up_method,
 170                                  methdata->destruct_method);
 171 }
 172
 173 /*
 174  * The core fetching functionality passes the name of the implementation.
 175  * This function is responsible to getting an identity number for it.
 176  */
 177 static void *construct_evp_method(const OSSL_ALGORITHM *algodef,
 178                                   OSSL_PROVIDER *prov, void *data)
 179 {
 180     /*
 181      * This function is only called if get_evp_method_from_store() returned
 182      * NULL, so it's safe to say that of all the spots to create a new
 183      * namemap entry, this is it.  Should the name already exist there, we
 184      * know that ossl_namemap_add_name() will return its corresponding
 185      * number.
 186      */
 187     struct evp_method_data_st *methdata = data;
 188     OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
 189     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 190     const char *names = algodef->algorithm_names;
 191     int name_id = ossl_namemap_add_names(namemap, 0, names, NAME_SEPARATOR);
 192     void *method;
 193
 194     if (name_id == 0)
 195         return NULL;
 196
 197     method = methdata->method_from_algorithm(name_id, algodef, prov);
 198
 199     /*
 200      * Flag to indicate that there was actual construction errors.  This
 201      * helps inner_evp_generic_fetch() determine what error it should
 202      * record on inaccessible algorithms.
 203      */
 204     if (method == NULL)
 205         methdata->flag_construct_error_occurred = 1;
 206
 207     return method;
 208 }
 209
 210 static void destruct_evp_method(void *method, void *data)
 211 {
 212     struct evp_method_data_st *methdata = data;
 213
 214     methdata->destruct_method(method);
 215 }
 216
 217 static void *
 218 inner_evp_generic_fetch(OSSL_LIB_CTX *libctx, int operation_id,
 219                         int name_id, const char *name,
 220                         const char *properties,
 221                         void *(*new_method)(int name_id,
 222                                             const OSSL_ALGORITHM *algodef,
 223                                             OSSL_PROVIDER *prov),
 224                         int (*up_ref_method)(void *),
 225                         void (*free_method)(void *))
 226 {
 227     OSSL_METHOD_STORE *store = get_evp_method_store(libctx);
 228     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 229     uint32_t meth_id = 0;
 230     void *method = NULL;
 231     int unsupported = 0;
 232
 233     if (store == NULL || namemap == NULL) {
 234         ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_INVALID_ARGUMENT);
 235         return NULL;
 236     }
 237
 238     /*
 239      * If there's ever an operation_id == 0 passed, we have an internal
 240      * programming error.
 241      */
 242     if (!ossl_assert(operation_id > 0)) {
 243         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
 244         return NULL;
 245     }
 246
 247     /*
 248      * If we have been passed neither a name_id or a name, we have an
 249      * internal programming error.
 250      */
 251     if (!ossl_assert(name_id != 0 || name != NULL)) {
 252         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
 253         return NULL;
 254     }
 255
 256     /* If we haven't received a name id yet, try to get one for the name */
 257     if (name_id == 0)
 258         name_id = ossl_namemap_name2num(namemap, name);
 259
 260     /*
 261      * If we have a name id, calculate a method id with evp_method_id().
 262      *
 263      * evp_method_id returns 0 if we have too many operations (more than
 264      * about 2^8) or too many names (more than about 2^24).  In that case,
 265      * we can't create any new method.
 266      * For all intents and purposes, this is an internal error.
 267      */
 268     if (name_id != 0 && (meth_id = evp_method_id(name_id, operation_id)) == 0) {
 269         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
 270         return NULL;
 271     }
 272
 273     /*
 274      * If we haven't found the name yet, chances are that the algorithm to
 275      * be fetched is unsupported.
 276      */
 277     if (name_id == 0)
 278         unsupported = 1;
 279
 280     if (meth_id == 0
 281         || !ossl_method_store_cache_get(store, meth_id, properties, &method)) {
 282         OSSL_METHOD_CONSTRUCT_METHOD mcm = {
 283             alloc_tmp_evp_method_store,
 284             dealloc_tmp_evp_method_store,
 285             get_evp_method_from_store,
 286             put_evp_method_in_store,
 287             construct_evp_method,
 288             destruct_evp_method
 289         };
 290         struct evp_method_data_st mcmdata;
 291
 292         mcmdata.mcm = &mcm;
 293         mcmdata.libctx = libctx;
 294         mcmdata.operation_id = operation_id;
 295         mcmdata.name_id = name_id;
 296         mcmdata.names = name;
 297         mcmdata.propquery = properties;
 298         mcmdata.method_from_algorithm = new_method;
 299         mcmdata.refcnt_up_method = up_ref_method;
 300         mcmdata.destruct_method = free_method;
 301         mcmdata.flag_construct_error_occurred = 0;
 302         if ((method = ossl_method_construct(libctx, operation_id,
 303                                             0 /* !force_cache */,
 304                                             &mcm, &mcmdata)) != NULL) {
 305             /*
 306              * If construction did create a method for us, we know that
 307              * there is a correct name_id and meth_id, since those have
 308              * already been calculated in get_evp_method_from_store() and
 309              * put_evp_method_in_store() above.
 310              */
 311             if (name_id == 0)
 312                 name_id = ossl_namemap_name2num(namemap, name);
 313             meth_id = evp_method_id(name_id, operation_id);
 314             ossl_method_store_cache_set(store, meth_id, properties, method,
 315                                         up_ref_method, free_method);
 316         }
 317
 318         /*
 319          * If we never were in the constructor, the algorithm to be fetched
 320          * is unsupported.
 321          */
 322         unsupported = !mcmdata.flag_construct_error_occurred;
 323     }
 324
 325     if (method == NULL) {
 326         int code = unsupported ? ERR_R_UNSUPPORTED : ERR_R_FETCH_FAILED;
 327
 328         if (name == NULL)
 329             name = ossl_namemap_num2name(namemap, name_id, 0);
 330         ERR_raise_data(ERR_LIB_EVP, code,
 331                        "%s, Algorithm (%s : %d), Properties (%s)",
 332                        ossl_lib_ctx_get_descriptor(libctx),
 333                        name = NULL ? "<null>" : name, name_id,
 334                        properties == NULL ? "<null>" : properties);
 335     }
 336
 337     return method;
 338 }
 339
 340 void *evp_generic_fetch(OSSL_LIB_CTX *libctx, int operation_id,
 341                         const char *name, const char *properties,
 342                         void *(*new_method)(int name_id,
 343                                             const OSSL_ALGORITHM *algodef,
 344                                             OSSL_PROVIDER *prov),
 345                         int (*up_ref_method)(void *),
 346                         void (*free_method)(void *))
 347 {
 348     return inner_evp_generic_fetch(libctx,
 349                                    operation_id, 0, name, properties,
 350                                    new_method, up_ref_method, free_method);
 351 }
 352
 353 /*
 354  * evp_generic_fetch_by_number() is special, and only returns methods for
 355  * already known names, i.e. it refuses to work if no name_id can be found
 356  * (it's considered an internal programming error).
 357  * This is meant to be used when one method needs to fetch an associated
 358  * other method.
 359  */
 360 void *evp_generic_fetch_by_number(OSSL_LIB_CTX *libctx, int operation_id,
 361                                   int name_id, const char *properties,
 362                                   void *(*new_method)(int name_id,
 363                                                       const OSSL_ALGORITHM *algodef,
 364                                                       OSSL_PROVIDER *prov),
 365                                   int (*up_ref_method)(void *),
 366                                   void (*free_method)(void *))
 367 {
 368     return inner_evp_generic_fetch(libctx,
 369                                    operation_id, name_id, NULL,
 370                                    properties, new_method, up_ref_method,
 371                                    free_method);
 372 }
 373
 374 void evp_method_store_flush(OSSL_LIB_CTX *libctx)
 375 {
 376     OSSL_METHOD_STORE *store = get_evp_method_store(libctx);
 377
 378     if (store != NULL)
 379         ossl_method_store_flush_cache(store, 1);
 380 }
 381
 382 static int evp_set_parsed_default_properties(OSSL_LIB_CTX *libctx,
 383                                              OSSL_PROPERTY_LIST *def_prop,
 384                                              int loadconfig)
 385 {
 386     OSSL_METHOD_STORE *store = get_evp_method_store(libctx);
 387     OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx, loadconfig);
 388
 389     if (plp != NULL) {
 390         ossl_property_free(*plp);
 391         *plp = def_prop;
 392         if (store != NULL)
 393             ossl_method_store_flush_cache(store, 0);
 394         return 1;
 395     }
 396     ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
 397     return 0;
 398 }
 399
 400 int evp_set_default_properties_int(OSSL_LIB_CTX *libctx, const char *propq,
 401                                    int loadconfig)
 402 {
 403     OSSL_PROPERTY_LIST *pl = NULL;
 404
 405     if (propq != NULL && (pl = ossl_parse_query(libctx, propq, 1)) == NULL) {
 406         ERR_raise(ERR_LIB_EVP, EVP_R_DEFAULT_QUERY_PARSE_ERROR);
 407         return 0;
 408     }
 409     return evp_set_parsed_default_properties(libctx, pl, loadconfig);
 410 }
 411
 412 int EVP_set_default_properties(OSSL_LIB_CTX *libctx, const char *propq)
 413 {
 414     return evp_set_default_properties_int(libctx, propq, 1);
 415 }
 416
 417 static int evp_default_properties_merge(OSSL_LIB_CTX *libctx, const char *propq)
 418 {
 419     OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx, 1);
 420     OSSL_PROPERTY_LIST *pl1, *pl2;
 421
 422     if (propq == NULL)
 423         return 1;
 424     if (plp == NULL || *plp == NULL)
 425         return EVP_set_default_properties(libctx, propq);
 426     if ((pl1 = ossl_parse_query(libctx, propq, 1)) == NULL) {
 427         ERR_raise(ERR_LIB_EVP, EVP_R_DEFAULT_QUERY_PARSE_ERROR);
 428         return 0;
 429     }
 430     pl2 = ossl_property_merge(pl1, *plp);
 431     ossl_property_free(pl1);
 432     if (pl2 == NULL) {
 433         ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
 434         return 0;
 435     }
 436     return evp_set_parsed_default_properties(libctx, pl2, 0);
 437 }
 438
 439 static int evp_default_property_is_enabled(OSSL_LIB_CTX *libctx,
 440                                            const char *prop_name)
 441 {
 442     OSSL_PROPERTY_LIST **plp = ossl_ctx_global_properties(libctx, 1);
 443
 444     return plp != NULL && ossl_property_is_enabled(libctx, prop_name, *plp);
 445 }
 446
 447 int EVP_default_properties_is_fips_enabled(OSSL_LIB_CTX *libctx)
 448 {
 449     return evp_default_property_is_enabled(libctx, "fips");
 450 }
 451
 452 int EVP_default_properties_enable_fips(OSSL_LIB_CTX *libctx, int enable)
 453 {
 454     const char *query = (enable != 0) ? "fips=yes" : "-fips";
 455
 456     return evp_default_properties_merge(libctx, query);
 457 }
 458
 459
 460 struct do_all_data_st {
 461     void (*user_fn)(void *method, void *arg);
 462     void *user_arg;
 463     void *(*new_method)(const int name_id, const OSSL_ALGORITHM *algodef,
 464                         OSSL_PROVIDER *prov);
 465     void (*free_method)(void *);
 466 };
 467
 468 static void do_one(OSSL_PROVIDER *provider, const OSSL_ALGORITHM *algo,
 469                    int no_store, void *vdata)
 470 {
 471     struct do_all_data_st *data = vdata;
 472     OSSL_LIB_CTX *libctx = ossl_provider_libctx(provider);
 473     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 474     int name_id = ossl_namemap_add_names(namemap, 0, algo->algorithm_names,
 475                                          NAME_SEPARATOR);
 476     void *method = NULL;
 477
 478     if (name_id != 0)
 479         method = data->new_method(name_id, algo, provider);
 480
 481     if (method != NULL) {
 482         data->user_fn(method, data->user_arg);
 483         data->free_method(method);
 484     }
 485 }
 486
 487 void evp_generic_do_all(OSSL_LIB_CTX *libctx, int operation_id,
 488                         void (*user_fn)(void *method, void *arg),
 489                         void *user_arg,
 490                         void *(*new_method)(int name_id,
 491                                             const OSSL_ALGORITHM *algodef,
 492                                             OSSL_PROVIDER *prov),
 493                         void (*free_method)(void *))
 494 {
 495     struct do_all_data_st data;
 496
 497     data.new_method = new_method;
 498     data.free_method = free_method;
 499     data.user_fn = user_fn;
 500     data.user_arg = user_arg;
 501
 502     /*
 503      * No pre- or post-condition for this call, as this only creates methods
 504      * temporarly and then promptly destroys them.
 505      */
 506     ossl_algorithm_do_all(libctx, operation_id, NULL, NULL, do_one, NULL,
 507                           &data);
 508 }
 509
 510 const char *evp_first_name(const OSSL_PROVIDER *prov, int name_id)
 511 {
 512     OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
 513     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 514
 515     return ossl_namemap_num2name(namemap, name_id, 0);
 516 }
 517
 518 int evp_is_a(OSSL_PROVIDER *prov, int number,
 519              const char *legacy_name, const char *name)
 520 {
 521     /*
 522      * For a |prov| that is NULL, the library context will be NULL
 523      */
 524     OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
 525     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 526
 527     if (prov == NULL)
 528         number = ossl_namemap_name2num(namemap, legacy_name);
 529     return ossl_namemap_name2num(namemap, name) == number;
 530 }
 531
 532 int evp_names_do_all(OSSL_PROVIDER *prov, int number,
 533                      void (*fn)(const char *name, void *data),
 534                      void *data)
 535 {
 536     OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
 537     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
 538
 539     return ossl_namemap_doall_names(namemap, number, fn, data);
 540 }