crypto/ex_data.c

   1 /*
   2  * Copyright 1995-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 <stdlib.h>
  11 #include "crypto/cryptlib.h"
  12 #include "internal/thread_once.h"
  13
  14 int ossl_do_ex_data_init(OSSL_LIB_CTX *ctx)
  15 {
  16     OSSL_EX_DATA_GLOBAL *global = ossl_lib_ctx_get_ex_data_global(ctx);
  17
  18     if (global == NULL)
  19         return 0;
  20
  21     global->ex_data_lock = CRYPTO_THREAD_lock_new();
  22     return global->ex_data_lock != NULL;
  23 }
  24
  25 /*
  26  * Return the EX_CALLBACKS from the |ex_data| array that corresponds to
  27  * a given class.  On success, *holds the lock.*
  28  * The |global| parameter is assumed to be non null (checked by the caller).
  29  */
  30 static EX_CALLBACKS *get_and_lock(OSSL_EX_DATA_GLOBAL *global, int class_index)
  31 {
  32     EX_CALLBACKS *ip;
  33
  34     if (class_index < 0 || class_index >= CRYPTO_EX_INDEX__COUNT) {
  35         ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_INVALID_ARGUMENT);
  36         return NULL;
  37     }
  38
  39     if (global->ex_data_lock == NULL) {
  40         /*
  41          * If we get here, someone (who?) cleaned up the lock, so just
  42          * treat it as an error.
  43          */
  44          return NULL;
  45     }
  46
  47     if (!CRYPTO_THREAD_write_lock(global->ex_data_lock))
  48         return NULL;
  49     ip = &global->ex_data[class_index];
  50     return ip;
  51 }
  52
  53 static void cleanup_cb(EX_CALLBACK *funcs)
  54 {
  55     OPENSSL_free(funcs);
  56 }
  57
  58 /*
  59  * Release all "ex_data" state to prevent memory leaks. This can't be made
  60  * thread-safe without overhauling a lot of stuff, and shouldn't really be
  61  * called under potential race-conditions anyway (it's for program shutdown
  62  * after all).
  63  */
  64 void ossl_crypto_cleanup_all_ex_data_int(OSSL_LIB_CTX *ctx)
  65 {
  66     int i;
  67     OSSL_EX_DATA_GLOBAL *global = ossl_lib_ctx_get_ex_data_global(ctx);
  68
  69     if (global == NULL)
  70         return;
  71
  72     for (i = 0; i < CRYPTO_EX_INDEX__COUNT; ++i) {
  73         EX_CALLBACKS *ip = &global->ex_data[i];
  74
  75         sk_EX_CALLBACK_pop_free(ip->meth, cleanup_cb);
  76         ip->meth = NULL;
  77     }
  78
  79     CRYPTO_THREAD_lock_free(global->ex_data_lock);
  80     global->ex_data_lock = NULL;
  81 }
  82
  83
  84 /*
  85  * Unregister a new index by replacing the callbacks with no-ops.
  86  * Any in-use instances are leaked.
  87  */
  88 static void dummy_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx,
  89                      long argl, void *argp)
  90 {
  91 }
  92
  93 static void dummy_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx,
  94                        long argl, void *argp)
  95 {
  96 }
  97
  98 static int dummy_dup(CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
  99                      void **from_d, int idx,
 100                      long argl, void *argp)
 101 {
 102     return 1;
 103 }
 104
 105 int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx)
 106 {
 107     EX_CALLBACKS *ip;
 108     EX_CALLBACK *a;
 109     int toret = 0;
 110     OSSL_EX_DATA_GLOBAL *global = ossl_lib_ctx_get_ex_data_global(ctx);
 111
 112     if (global == NULL)
 113         return 0;
 114
 115     ip = get_and_lock(global, class_index);
 116     if (ip == NULL)
 117         return 0;
 118
 119     if (idx < 0 || idx >= sk_EX_CALLBACK_num(ip->meth))
 120         goto err;
 121     a = sk_EX_CALLBACK_value(ip->meth, idx);
 122     if (a == NULL)
 123         goto err;
 124     a->new_func = dummy_new;
 125     a->dup_func = dummy_dup;
 126     a->free_func = dummy_free;
 127     toret = 1;
 128 err:
 129     CRYPTO_THREAD_unlock(global->ex_data_lock);
 130     return toret;
 131 }
 132
 133 int CRYPTO_free_ex_index(int class_index, int idx)
 134 {
 135     return ossl_crypto_free_ex_index_ex(NULL, class_index, idx);
 136 }
 137
 138 /*
 139  * Register a new index.
 140  */
 141 int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index,
 142                                     long argl, void *argp,
 143                                     CRYPTO_EX_new *new_func,
 144                                     CRYPTO_EX_dup *dup_func,
 145                                     CRYPTO_EX_free *free_func,
 146                                     int priority)
 147 {
 148     int toret = -1;
 149     EX_CALLBACK *a;
 150     EX_CALLBACKS *ip;
 151     OSSL_EX_DATA_GLOBAL *global = ossl_lib_ctx_get_ex_data_global(ctx);
 152
 153     if (global == NULL)
 154         return -1;
 155
 156     ip = get_and_lock(global, class_index);
 157     if (ip == NULL)
 158         return -1;
 159
 160     if (ip->meth == NULL) {
 161         ip->meth = sk_EX_CALLBACK_new_null();
 162         /* We push an initial value on the stack because the SSL
 163          * "app_data" routines use ex_data index zero.  See RT 3710. */
 164         if (ip->meth == NULL
 165             || !sk_EX_CALLBACK_push(ip->meth, NULL)) {
 166             ERR_raise(ERR_LIB_CRYPTO, ERR_R_CRYPTO_LIB);
 167             goto err;
 168         }
 169     }
 170
 171     a = (EX_CALLBACK *)OPENSSL_malloc(sizeof(*a));
 172     if (a == NULL)
 173         goto err;
 174     a->argl = argl;
 175     a->argp = argp;
 176     a->new_func = new_func;
 177     a->dup_func = dup_func;
 178     a->free_func = free_func;
 179     a->priority = priority;
 180
 181     if (!sk_EX_CALLBACK_push(ip->meth, NULL)) {
 182         ERR_raise(ERR_LIB_CRYPTO, ERR_R_CRYPTO_LIB);
 183         OPENSSL_free(a);
 184         goto err;
 185     }
 186     toret = sk_EX_CALLBACK_num(ip->meth) - 1;
 187     (void)sk_EX_CALLBACK_set(ip->meth, toret, a);
 188
 189  err:
 190     CRYPTO_THREAD_unlock(global->ex_data_lock);
 191     return toret;
 192 }
 193
 194 int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
 195                             CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
 196                             CRYPTO_EX_free *free_func)
 197 {
 198     return ossl_crypto_get_ex_new_index_ex(NULL, class_index, argl, argp,
 199                                            new_func, dup_func, free_func, 0);
 200 }
 201
 202 /*
 203  * Initialise a new CRYPTO_EX_DATA for use in a particular class - including
 204  * calling new() callbacks for each index in the class used by this variable
 205  * Thread-safe by copying a class's array of "EX_CALLBACK" entries
 206  * in the lock, then using them outside the lock. Note this only applies
 207  * to the global "ex_data" state (ie. class definitions), not 'ad' itself.
 208  */
 209 int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX *ctx, int class_index, void *obj,
 210                                CRYPTO_EX_DATA *ad)
 211 {
 212     int mx, i;
 213     void *ptr;
 214     EX_CALLBACK **storage = NULL;
 215     EX_CALLBACK *stack[10];
 216     EX_CALLBACKS *ip;
 217     OSSL_EX_DATA_GLOBAL *global = ossl_lib_ctx_get_ex_data_global(ctx);
 218
 219     if (global == NULL)
 220         return 0;
 221
 222     ip = get_and_lock(global, class_index);
 223     if (ip == NULL)
 224         return 0;
 225
 226     ad->ctx = ctx;
 227     ad->sk = NULL;
 228     mx = sk_EX_CALLBACK_num(ip->meth);
 229     if (mx > 0) {
 230         if (mx < (int)OSSL_NELEM(stack))
 231             storage = stack;
 232         else
 233             storage = OPENSSL_malloc(sizeof(*storage) * mx);
 234         if (storage != NULL)
 235             for (i = 0; i < mx; i++)
 236                 storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
 237     }
 238     CRYPTO_THREAD_unlock(global->ex_data_lock);
 239
 240     if (mx > 0 && storage == NULL)
 241         return 0;
 242     for (i = 0; i < mx; i++) {
 243         if (storage[i] != NULL && storage[i]->new_func != NULL) {
 244             ptr = CRYPTO_get_ex_data(ad, i);
 245             storage[i]->new_func(obj, ptr, ad, i,
 246                                  storage[i]->argl, storage[i]->argp);
 247         }
 248     }
 249     if (storage != stack)
 250         OPENSSL_free(storage);
 251     return 1;
 252 }
 253
 254 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad)
 255 {
 256     return ossl_crypto_new_ex_data_ex(NULL, class_index, obj, ad);
 257 }
 258
 259 /*
 260  * Duplicate a CRYPTO_EX_DATA variable - including calling dup() callbacks
 261  * for each index in the class used by this variable
 262  */
 263 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
 264                        const CRYPTO_EX_DATA *from)
 265 {
 266     int mx, j, i;
 267     void *ptr;
 268     EX_CALLBACK *stack[10];
 269     EX_CALLBACK **storage = NULL;
 270     EX_CALLBACKS *ip;
 271     int toret = 0;
 272     OSSL_EX_DATA_GLOBAL *global;
 273
 274     to->ctx = from->ctx;
 275     if (from->sk == NULL)
 276         /* Nothing to copy over */
 277         return 1;
 278
 279     global = ossl_lib_ctx_get_ex_data_global(from->ctx);
 280     if (global == NULL)
 281         return 0;
 282
 283     ip = get_and_lock(global, class_index);
 284     if (ip == NULL)
 285         return 0;
 286
 287     mx = sk_EX_CALLBACK_num(ip->meth);
 288     j = sk_void_num(from->sk);
 289     if (j < mx)
 290         mx = j;
 291     if (mx > 0) {
 292         if (mx < (int)OSSL_NELEM(stack))
 293             storage = stack;
 294         else
 295             storage = OPENSSL_malloc(sizeof(*storage) * mx);
 296         if (storage != NULL)
 297             for (i = 0; i < mx; i++)
 298                 storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
 299     }
 300     CRYPTO_THREAD_unlock(global->ex_data_lock);
 301
 302     if (mx == 0)
 303         return 1;
 304     if (storage == NULL)
 305         return 0;
 306     /*
 307      * Make sure the ex_data stack is at least |mx| elements long to avoid
 308      * issues in the for loop that follows; so go get the |mx|'th element
 309      * (if it does not exist CRYPTO_get_ex_data() returns NULL), and assign
 310      * to itself. This is normally a no-op; but ensures the stack is the
 311      * proper size
 312      */
 313     if (!CRYPTO_set_ex_data(to, mx - 1, CRYPTO_get_ex_data(to, mx - 1)))
 314         goto err;
 315
 316     for (i = 0; i < mx; i++) {
 317         ptr = CRYPTO_get_ex_data(from, i);
 318         if (storage[i] != NULL && storage[i]->dup_func != NULL)
 319             if (!storage[i]->dup_func(to, from, &ptr, i,
 320                                       storage[i]->argl, storage[i]->argp))
 321                 goto err;
 322         CRYPTO_set_ex_data(to, i, ptr);
 323     }
 324     toret = 1;
 325  err:
 326     if (storage != stack)
 327         OPENSSL_free(storage);
 328     return toret;
 329 }
 330
 331 struct ex_callback_entry {
 332     const EX_CALLBACK *excb;
 333     int index;
 334 };
 335
 336 static int ex_callback_compare(const void *a, const void *b)
 337 {
 338     const struct ex_callback_entry *ap = (const struct ex_callback_entry *)a;
 339     const struct ex_callback_entry *bp = (const struct ex_callback_entry *)b;
 340
 341     if (ap->excb == bp->excb)
 342         return 0;
 343
 344     if (ap->excb == NULL)
 345         return 1;
 346     if (bp->excb == NULL)
 347         return -1;
 348     if (ap->excb->priority == bp->excb->priority)
 349         return 0;
 350     return ap->excb->priority > bp->excb->priority ? -1 : 1;
 351 }
 352
 353 /*
 354  * Cleanup a CRYPTO_EX_DATA variable - including calling free() callbacks for
 355  * each index in the class used by this variable
 356  */
 357 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad)
 358 {
 359     int mx, i;
 360     EX_CALLBACKS *ip;
 361     void *ptr;
 362     const EX_CALLBACK *f;
 363     struct ex_callback_entry stack[10];
 364     struct ex_callback_entry *storage = NULL;
 365     OSSL_EX_DATA_GLOBAL *global = ossl_lib_ctx_get_ex_data_global(ad->ctx);
 366
 367     if (global == NULL)
 368         goto err;
 369
 370     ip = get_and_lock(global, class_index);
 371     if (ip == NULL)
 372         goto err;
 373
 374     mx = sk_EX_CALLBACK_num(ip->meth);
 375     if (mx > 0) {
 376         if (mx < (int)OSSL_NELEM(stack))
 377             storage = stack;
 378         else
 379             storage = OPENSSL_malloc(sizeof(*storage) * mx);
 380         if (storage != NULL)
 381             for (i = 0; i < mx; i++) {
 382                 storage[i].excb = sk_EX_CALLBACK_value(ip->meth, i);
 383                 storage[i].index = i;
 384             }
 385     }
 386     CRYPTO_THREAD_unlock(global->ex_data_lock);
 387
 388     if (storage != NULL) {
 389         /* Sort according to priority. High priority first */
 390         qsort(storage, mx, sizeof(*storage), ex_callback_compare);
 391         for (i = 0; i < mx; i++) {
 392             f = storage[i].excb;
 393
 394             if (f != NULL && f->free_func != NULL) {
 395                 ptr = CRYPTO_get_ex_data(ad, storage[i].index);
 396                 f->free_func(obj, ptr, ad, storage[i].index, f->argl, f->argp);
 397             }
 398         }
 399     }
 400
 401     if (storage != stack)
 402         OPENSSL_free(storage);
 403  err:
 404     sk_void_free(ad->sk);
 405     ad->sk = NULL;
 406     ad->ctx = NULL;
 407 }
 408
 409 /*
 410  * Allocate a given CRYPTO_EX_DATA item using the class specific allocation
 411  * function
 412  */
 413 int CRYPTO_alloc_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad,
 414                          int idx)
 415 {
 416     void *curval;
 417
 418     curval = CRYPTO_get_ex_data(ad, idx);
 419     /* Already there, no need to allocate */
 420     if (curval != NULL)
 421         return 1;
 422
 423     return ossl_crypto_alloc_ex_data_intern(class_index, obj, ad, idx);
 424 }
 425
 426 int ossl_crypto_alloc_ex_data_intern(int class_index, void *obj,
 427                                      CRYPTO_EX_DATA *ad, int idx)
 428 {
 429     EX_CALLBACK *f;
 430     EX_CALLBACKS *ip;
 431     OSSL_EX_DATA_GLOBAL *global;
 432
 433     global = ossl_lib_ctx_get_ex_data_global(ad->ctx);
 434     if (global == NULL)
 435         return 0;
 436
 437     ip = get_and_lock(global, class_index);
 438     if (ip == NULL)
 439         return 0;
 440     f = sk_EX_CALLBACK_value(ip->meth, idx);
 441     CRYPTO_THREAD_unlock(global->ex_data_lock);
 442
 443     /*
 444      * This should end up calling CRYPTO_set_ex_data(), which allocates
 445      * everything necessary to support placing the new data in the right spot.
 446      */
 447     if (f->new_func == NULL)
 448         return 0;
 449
 450     f->new_func(obj, NULL, ad, idx, f->argl, f->argp);
 451
 452     return 1;
 453 }
 454
 455 /*
 456  * For a given CRYPTO_EX_DATA variable, set the value corresponding to a
 457  * particular index in the class used by this variable
 458  */
 459 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val)
 460 {
 461     int i;
 462
 463     if (ad->sk == NULL) {
 464         if ((ad->sk = sk_void_new_null()) == NULL) {
 465             ERR_raise(ERR_LIB_CRYPTO, ERR_R_CRYPTO_LIB);
 466             return 0;
 467         }
 468     }
 469
 470     for (i = sk_void_num(ad->sk); i <= idx; ++i) {
 471         if (!sk_void_push(ad->sk, NULL)) {
 472             ERR_raise(ERR_LIB_CRYPTO, ERR_R_CRYPTO_LIB);
 473             return 0;
 474         }
 475     }
 476     if (sk_void_set(ad->sk, idx, val) != val) {
 477         /* Probably the index is out of bounds */
 478         ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_INVALID_ARGUMENT);
 479         return 0;
 480     }
 481     return 1;
 482 }
 483
 484 /*
 485  * For a given CRYPTO_EX_DATA_ variable, get the value corresponding to a
 486  * particular index in the class used by this variable
 487  */
 488 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx)
 489 {
 490     if (ad->sk == NULL || idx >= sk_void_num(ad->sk))
 491         return NULL;
 492     return sk_void_value(ad->sk, idx);
 493 }
 494
 495 OSSL_LIB_CTX *ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA *ad)
 496 {
 497     return ad->ctx;
 498 }