crypto/context.c

   1 /*
   2  * Copyright 2019-2022 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 "crypto/cryptlib.h"
  11 #include <openssl/conf.h>
  12 #include "internal/thread_once.h"
  13 #include "internal/property.h"
  14 #include "internal/core.h"
  15 #include "internal/bio.h"
  16 #include "internal/provider.h"
  17 #include "crypto/context.h"
  18
  19 struct ossl_lib_ctx_st {
  20     CRYPTO_RWLOCK *lock, *rand_crngt_lock;
  21     OSSL_EX_DATA_GLOBAL global;
  22
  23     void *property_string_data;
  24     void *evp_method_store;
  25     void *provider_store;
  26     void *namemap;
  27     void *property_defns;
  28     void *global_properties;
  29     void *drbg;
  30     void *drbg_nonce;
  31 #ifndef FIPS_MODULE
  32     void *provider_conf;
  33     void *bio_core;
  34     void *child_provider;
  35     OSSL_METHOD_STORE *decoder_store;
  36     OSSL_METHOD_STORE *encoder_store;
  37     OSSL_METHOD_STORE *store_loader_store;
  38     void *self_test_cb;
  39 #endif
  40     void *rand_crngt;
  41 #ifdef FIPS_MODULE
  42     void *thread_event_handler;
  43     void *fips_prov;
  44 #endif
  45
  46     unsigned int ischild:1;
  47 };
  48
  49 int ossl_lib_ctx_write_lock(OSSL_LIB_CTX *ctx)
  50 {
  51     return CRYPTO_THREAD_write_lock(ossl_lib_ctx_get_concrete(ctx)->lock);
  52 }
  53
  54 int ossl_lib_ctx_read_lock(OSSL_LIB_CTX *ctx)
  55 {
  56     return CRYPTO_THREAD_read_lock(ossl_lib_ctx_get_concrete(ctx)->lock);
  57 }
  58
  59 int ossl_lib_ctx_unlock(OSSL_LIB_CTX *ctx)
  60 {
  61     return CRYPTO_THREAD_unlock(ossl_lib_ctx_get_concrete(ctx)->lock);
  62 }
  63
  64 int ossl_lib_ctx_is_child(OSSL_LIB_CTX *ctx)
  65 {
  66     ctx = ossl_lib_ctx_get_concrete(ctx);
  67
  68     if (ctx == NULL)
  69         return 0;
  70     return ctx->ischild;
  71 }
  72
  73 static void context_deinit_objs(OSSL_LIB_CTX *ctx);
  74
  75 static int context_init(OSSL_LIB_CTX *ctx)
  76 {
  77     int exdata_done = 0;
  78
  79     ctx->lock = CRYPTO_THREAD_lock_new();
  80     if (ctx->lock == NULL)
  81         return 0;
  82
  83     ctx->rand_crngt_lock = CRYPTO_THREAD_lock_new();
  84     if (ctx->rand_crngt_lock == NULL)
  85         goto err;
  86
  87     /* Initialize ex_data. */
  88     if (!ossl_do_ex_data_init(ctx))
  89         goto err;
  90     exdata_done = 1;
  91
  92     /* P2. We want evp_method_store to be cleaned up before the provider store */
  93     ctx->evp_method_store = ossl_method_store_new(ctx);
  94     if (ctx->evp_method_store == NULL)
  95         goto err;
  96
  97 #ifndef FIPS_MODULE
  98     /* P2. Must be freed before the provider store is freed */
  99     ctx->provider_conf = ossl_prov_conf_ctx_new(ctx);
 100     if (ctx->provider_conf == NULL)
 101         goto err;
 102 #endif
 103
 104     /* P2. */
 105     ctx->drbg = ossl_rand_ctx_new(ctx);
 106     if (ctx->drbg == NULL)
 107         goto err;
 108
 109 #ifndef FIPS_MODULE
 110     /* P2. We want decoder_store to be cleaned up before the provider store */
 111     ctx->decoder_store = ossl_method_store_new(ctx);
 112     if (ctx->decoder_store == NULL)
 113         goto err;
 114
 115     /* P2. We want encoder_store to be cleaned up before the provider store */
 116     ctx->encoder_store = ossl_method_store_new(ctx);
 117     if (ctx->encoder_store == NULL)
 118         goto err;
 119
 120     /* P2. We want loader_store to be cleaned up before the provider store */
 121     ctx->store_loader_store = ossl_method_store_new(ctx);
 122     if (ctx->store_loader_store == NULL)
 123         goto err;
 124 #endif
 125
 126     /* P1. Needs to be freed before the child provider data is freed */
 127     ctx->provider_store = ossl_provider_store_new(ctx);
 128     if (ctx->provider_store == NULL)
 129         goto err;
 130
 131     /* Default priority. */
 132     ctx->property_string_data = ossl_property_string_data_new(ctx);
 133     if (ctx->property_string_data == NULL)
 134         goto err;
 135
 136     ctx->namemap = ossl_stored_namemap_new(ctx);
 137     if (ctx->namemap == NULL)
 138         goto err;
 139
 140     ctx->property_defns = ossl_property_defns_new(ctx);
 141     if (ctx->property_defns == NULL)
 142         goto err;
 143
 144     ctx->global_properties = ossl_ctx_global_properties_new(ctx);
 145     if (ctx->global_properties == NULL)
 146         goto err;
 147
 148 #ifndef FIPS_MODULE
 149     ctx->bio_core = ossl_bio_core_globals_new(ctx);
 150     if (ctx->bio_core == NULL)
 151         goto err;
 152 #endif
 153
 154     ctx->drbg_nonce = ossl_prov_drbg_nonce_ctx_new(ctx);
 155     if (ctx->drbg_nonce == NULL)
 156         goto err;
 157
 158 #ifndef FIPS_MODULE
 159     ctx->self_test_cb = ossl_self_test_set_callback_new(ctx);
 160     if (ctx->self_test_cb == NULL)
 161         goto err;
 162 #endif
 163
 164 #ifdef FIPS_MODULE
 165     ctx->thread_event_handler = ossl_thread_event_ctx_new(ctx);
 166     if (ctx->thread_event_handler == NULL)
 167         goto err;
 168
 169     ctx->fips_prov = ossl_fips_prov_ossl_ctx_new(ctx);
 170     if (ctx->fips_prov == NULL)
 171         goto err;
 172 #endif
 173
 174     /* Low priority. */
 175 #ifndef FIPS_MODULE
 176     ctx->child_provider = ossl_child_prov_ctx_new(ctx);
 177     if (ctx->child_provider == NULL)
 178         goto err;
 179 #endif
 180
 181     /* Everything depends on properties, so we also pre-initialise that */
 182     if (!ossl_property_parse_init(ctx))
 183         goto err;
 184
 185     return 1;
 186
 187  err:
 188     context_deinit_objs(ctx);
 189
 190     if (exdata_done)
 191         ossl_crypto_cleanup_all_ex_data_int(ctx);
 192
 193     CRYPTO_THREAD_lock_free(ctx->rand_crngt_lock);
 194     CRYPTO_THREAD_lock_free(ctx->lock);
 195     memset(ctx, '\0', sizeof(*ctx));
 196     return 0;
 197 }
 198
 199 static void context_deinit_objs(OSSL_LIB_CTX *ctx)
 200 {
 201     /* P2. We want evp_method_store to be cleaned up before the provider store */
 202     if (ctx->evp_method_store != NULL) {
 203         ossl_method_store_free(ctx->evp_method_store);
 204         ctx->evp_method_store = NULL;
 205     }
 206
 207     /* P2. */
 208     if (ctx->drbg != NULL) {
 209         ossl_rand_ctx_free(ctx->drbg);
 210         ctx->drbg = NULL;
 211     }
 212
 213 #ifndef FIPS_MODULE
 214     /* P2. */
 215     if (ctx->provider_conf != NULL) {
 216         ossl_prov_conf_ctx_free(ctx->provider_conf);
 217         ctx->provider_conf = NULL;
 218     }
 219
 220     /* P2. We want decoder_store to be cleaned up before the provider store */
 221     if (ctx->decoder_store != NULL) {
 222         ossl_method_store_free(ctx->decoder_store);
 223         ctx->decoder_store = NULL;
 224     }
 225
 226     /* P2. We want encoder_store to be cleaned up before the provider store */
 227     if (ctx->encoder_store != NULL) {
 228         ossl_method_store_free(ctx->encoder_store);
 229         ctx->encoder_store = NULL;
 230     }
 231
 232     /* P2. We want loader_store to be cleaned up before the provider store */
 233     if (ctx->store_loader_store != NULL) {
 234         ossl_method_store_free(ctx->store_loader_store);
 235         ctx->store_loader_store = NULL;
 236     }
 237 #endif
 238
 239     /* P1. Needs to be freed before the child provider data is freed */
 240     if (ctx->provider_store != NULL) {
 241         ossl_provider_store_free(ctx->provider_store);
 242         ctx->provider_store = NULL;
 243     }
 244
 245     /* Default priority. */
 246     if (ctx->property_string_data != NULL) {
 247         ossl_property_string_data_free(ctx->property_string_data);
 248         ctx->property_string_data = NULL;
 249     }
 250
 251     if (ctx->namemap != NULL) {
 252         ossl_stored_namemap_free(ctx->namemap);
 253         ctx->namemap = NULL;
 254     }
 255
 256     if (ctx->property_defns != NULL) {
 257         ossl_property_defns_free(ctx->property_defns);
 258         ctx->property_defns = NULL;
 259     }
 260
 261     if (ctx->global_properties != NULL) {
 262         ossl_ctx_global_properties_free(ctx->global_properties);
 263         ctx->global_properties = NULL;
 264     }
 265
 266 #ifndef FIPS_MODULE
 267     if (ctx->bio_core != NULL) {
 268         ossl_bio_core_globals_free(ctx->bio_core);
 269         ctx->bio_core = NULL;
 270     }
 271 #endif
 272
 273     if (ctx->drbg_nonce != NULL) {
 274         ossl_prov_drbg_nonce_ctx_free(ctx->drbg_nonce);
 275         ctx->drbg_nonce = NULL;
 276     }
 277
 278 #ifndef FIPS_MODULE
 279     if (ctx->self_test_cb != NULL) {
 280         ossl_self_test_set_callback_free(ctx->self_test_cb);
 281         ctx->self_test_cb = NULL;
 282     }
 283 #endif
 284
 285     if (ctx->rand_crngt != NULL) {
 286         ossl_rand_crng_ctx_free(ctx->rand_crngt);
 287         ctx->rand_crngt = NULL;
 288     }
 289
 290 #ifdef FIPS_MODULE
 291     if (ctx->thread_event_handler != NULL) {
 292         ossl_thread_event_ctx_free(ctx->thread_event_handler);
 293         ctx->thread_event_handler = NULL;
 294     }
 295
 296     if (ctx->fips_prov != NULL) {
 297         ossl_fips_prov_ossl_ctx_free(ctx->fips_prov);
 298         ctx->fips_prov = NULL;
 299     }
 300 #endif
 301
 302     /* Low priority. */
 303 #ifndef FIPS_MODULE
 304     if (ctx->child_provider != NULL) {
 305         ossl_child_prov_ctx_free(ctx->child_provider);
 306         ctx->child_provider = NULL;
 307     }
 308 #endif
 309 }
 310
 311 static int context_deinit(OSSL_LIB_CTX *ctx)
 312 {
 313     if (ctx == NULL)
 314         return 1;
 315
 316     ossl_ctx_thread_stop(ctx);
 317
 318     context_deinit_objs(ctx);
 319
 320     ossl_crypto_cleanup_all_ex_data_int(ctx);
 321
 322     CRYPTO_THREAD_lock_free(ctx->rand_crngt_lock);
 323     CRYPTO_THREAD_lock_free(ctx->lock);
 324     ctx->rand_crngt_lock = NULL;
 325     ctx->lock = NULL;
 326     return 1;
 327 }
 328
 329 #ifndef FIPS_MODULE
 330 /* The default default context */
 331 static OSSL_LIB_CTX default_context_int;
 332
 333 static CRYPTO_ONCE default_context_init = CRYPTO_ONCE_STATIC_INIT;
 334 static CRYPTO_THREAD_LOCAL default_context_thread_local;
 335
 336 DEFINE_RUN_ONCE_STATIC(default_context_do_init)
 337 {
 338     return CRYPTO_THREAD_init_local(&default_context_thread_local, NULL)
 339         && context_init(&default_context_int);
 340 }
 341
 342 void ossl_lib_ctx_default_deinit(void)
 343 {
 344     context_deinit(&default_context_int);
 345     CRYPTO_THREAD_cleanup_local(&default_context_thread_local);
 346 }
 347
 348 static OSSL_LIB_CTX *get_thread_default_context(void)
 349 {
 350     if (!RUN_ONCE(&default_context_init, default_context_do_init))
 351         return NULL;
 352
 353     return CRYPTO_THREAD_get_local(&default_context_thread_local);
 354 }
 355
 356 static OSSL_LIB_CTX *get_default_context(void)
 357 {
 358     OSSL_LIB_CTX *current_defctx = get_thread_default_context();
 359
 360     if (current_defctx == NULL)
 361         current_defctx = &default_context_int;
 362     return current_defctx;
 363 }
 364
 365 static int set_default_context(OSSL_LIB_CTX *defctx)
 366 {
 367     if (defctx == &default_context_int)
 368         defctx = NULL;
 369
 370     return CRYPTO_THREAD_set_local(&default_context_thread_local, defctx);
 371 }
 372 #endif
 373
 374 OSSL_LIB_CTX *OSSL_LIB_CTX_new(void)
 375 {
 376     OSSL_LIB_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
 377
 378     if (ctx != NULL && !context_init(ctx)) {
 379         OPENSSL_free(ctx);
 380         ctx = NULL;
 381     }
 382     return ctx;
 383 }
 384
 385 #ifndef FIPS_MODULE
 386 OSSL_LIB_CTX *OSSL_LIB_CTX_new_from_dispatch(const OSSL_CORE_HANDLE *handle,
 387                                              const OSSL_DISPATCH *in)
 388 {
 389     OSSL_LIB_CTX *ctx = OSSL_LIB_CTX_new();
 390
 391     if (ctx == NULL)
 392         return NULL;
 393
 394     if (!ossl_bio_init_core(ctx, in)) {
 395         OSSL_LIB_CTX_free(ctx);
 396         return NULL;
 397     }
 398
 399     return ctx;
 400 }
 401
 402 OSSL_LIB_CTX *OSSL_LIB_CTX_new_child(const OSSL_CORE_HANDLE *handle,
 403                                      const OSSL_DISPATCH *in)
 404 {
 405     OSSL_LIB_CTX *ctx = OSSL_LIB_CTX_new_from_dispatch(handle, in);
 406
 407     if (ctx == NULL)
 408         return NULL;
 409
 410     if (!ossl_provider_init_as_child(ctx, handle, in)) {
 411         OSSL_LIB_CTX_free(ctx);
 412         return NULL;
 413     }
 414     ctx->ischild = 1;
 415
 416     return ctx;
 417 }
 418
 419 int OSSL_LIB_CTX_load_config(OSSL_LIB_CTX *ctx, const char *config_file)
 420 {
 421     return CONF_modules_load_file_ex(ctx, config_file, NULL, 0) > 0;
 422 }
 423 #endif
 424
 425 void OSSL_LIB_CTX_free(OSSL_LIB_CTX *ctx)
 426 {
 427     if (ossl_lib_ctx_is_default(ctx))
 428         return;
 429
 430 #ifndef FIPS_MODULE
 431     if (ctx->ischild)
 432         ossl_provider_deinit_child(ctx);
 433 #endif
 434     context_deinit(ctx);
 435     OPENSSL_free(ctx);
 436 }
 437
 438 #ifndef FIPS_MODULE
 439 OSSL_LIB_CTX *OSSL_LIB_CTX_get0_global_default(void)
 440 {
 441     if (!RUN_ONCE(&default_context_init, default_context_do_init))
 442         return NULL;
 443
 444     return &default_context_int;
 445 }
 446
 447 OSSL_LIB_CTX *OSSL_LIB_CTX_set0_default(OSSL_LIB_CTX *libctx)
 448 {
 449     OSSL_LIB_CTX *current_defctx;
 450
 451     if ((current_defctx = get_default_context()) != NULL) {
 452         if (libctx != NULL)
 453             set_default_context(libctx);
 454         return current_defctx;
 455     }
 456
 457     return NULL;
 458 }
 459 #endif
 460
 461 OSSL_LIB_CTX *ossl_lib_ctx_get_concrete(OSSL_LIB_CTX *ctx)
 462 {
 463 #ifndef FIPS_MODULE
 464     if (ctx == NULL)
 465         return get_default_context();
 466 #endif
 467     return ctx;
 468 }
 469
 470 int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx)
 471 {
 472 #ifndef FIPS_MODULE
 473     if (ctx == NULL || ctx == get_default_context())
 474         return 1;
 475 #endif
 476     return 0;
 477 }
 478
 479 int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx)
 480 {
 481 #ifndef FIPS_MODULE
 482     if (ossl_lib_ctx_get_concrete(ctx) == &default_context_int)
 483         return 1;
 484 #endif
 485     return 0;
 486 }
 487
 488 void *ossl_lib_ctx_get_data(OSSL_LIB_CTX *ctx, int index)
 489 {
 490     void *p;
 491
 492     ctx = ossl_lib_ctx_get_concrete(ctx);
 493     if (ctx == NULL)
 494         return NULL;
 495
 496     switch (index) {
 497     case OSSL_LIB_CTX_PROPERTY_STRING_INDEX:
 498         return ctx->property_string_data;
 499     case OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX:
 500         return ctx->evp_method_store;
 501     case OSSL_LIB_CTX_PROVIDER_STORE_INDEX:
 502         return ctx->provider_store;
 503     case OSSL_LIB_CTX_NAMEMAP_INDEX:
 504         return ctx->namemap;
 505     case OSSL_LIB_CTX_PROPERTY_DEFN_INDEX:
 506         return ctx->property_defns;
 507     case OSSL_LIB_CTX_GLOBAL_PROPERTIES:
 508         return ctx->global_properties;
 509     case OSSL_LIB_CTX_DRBG_INDEX:
 510         return ctx->drbg;
 511     case OSSL_LIB_CTX_DRBG_NONCE_INDEX:
 512         return ctx->drbg_nonce;
 513 #ifndef FIPS_MODULE
 514     case OSSL_LIB_CTX_PROVIDER_CONF_INDEX:
 515         return ctx->provider_conf;
 516     case OSSL_LIB_CTX_BIO_CORE_INDEX:
 517         return ctx->bio_core;
 518     case OSSL_LIB_CTX_CHILD_PROVIDER_INDEX:
 519         return ctx->child_provider;
 520     case OSSL_LIB_CTX_DECODER_STORE_INDEX:
 521         return ctx->decoder_store;
 522     case OSSL_LIB_CTX_ENCODER_STORE_INDEX:
 523         return ctx->encoder_store;
 524     case OSSL_LIB_CTX_STORE_LOADER_STORE_INDEX:
 525         return ctx->store_loader_store;
 526     case OSSL_LIB_CTX_SELF_TEST_CB_INDEX:
 527         return ctx->self_test_cb;
 528 #endif
 529
 530     case OSSL_LIB_CTX_RAND_CRNGT_INDEX: {
 531
 532         /*
 533          * rand_crngt must be lazily initialized because it calls into
 534          * libctx, so must not be called from context_init, else a deadlock
 535          * will occur.
 536          *
 537          * We use a separate lock because code called by the instantiation
 538          * of rand_crngt is liable to try and take the libctx lock.
 539          */
 540         if (CRYPTO_THREAD_read_lock(ctx->rand_crngt_lock) != 1)
 541             return NULL;
 542
 543         if (ctx->rand_crngt == NULL) {
 544             CRYPTO_THREAD_unlock(ctx->rand_crngt_lock);
 545
 546             if (CRYPTO_THREAD_write_lock(ctx->rand_crngt_lock) != 1)
 547                 return NULL;
 548
 549             if (ctx->rand_crngt == NULL)
 550                 ctx->rand_crngt = ossl_rand_crng_ctx_new(ctx);
 551         }
 552
 553         p = ctx->rand_crngt;
 554
 555         CRYPTO_THREAD_unlock(ctx->rand_crngt_lock);
 556
 557         return p;
 558     }
 559
 560 #ifdef FIPS_MODULE
 561     case OSSL_LIB_CTX_THREAD_EVENT_HANDLER_INDEX:
 562         return ctx->thread_event_handler;
 563
 564     case OSSL_LIB_CTX_FIPS_PROV_INDEX:
 565         return ctx->fips_prov;
 566 #endif
 567
 568     default:
 569         return NULL;
 570     }
 571 }
 572
 573 OSSL_EX_DATA_GLOBAL *ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX *ctx)
 574 {
 575     ctx = ossl_lib_ctx_get_concrete(ctx);
 576     if (ctx == NULL)
 577         return NULL;
 578     return &ctx->global;
 579 }
 580
 581 const char *ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX *libctx)
 582 {
 583 #ifdef FIPS_MODULE
 584     return "FIPS internal library context";
 585 #else
 586     if (ossl_lib_ctx_is_global_default(libctx))
 587         return "Global default library context";
 588     if (ossl_lib_ctx_is_default(libctx))
 589         return "Thread-local default library context";
 590     return "Non-default library context";
 591 #endif
 592 }