src/third_party/boringssl/src/crypto/ex_data_impl.c

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57 /* ====================================================================
  58  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
  59  *
  60  * Redistribution and use in source and binary forms, with or without
  61  * modification, are permitted provided that the following conditions
  62  * are met:
  63  *
  64  * 1. Redistributions of source code must retain the above copyright
  65  *    notice, this list of conditions and the following disclaimer.
  66  *
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in
  69  *    the documentation and/or other materials provided with the
  70  *    distribution.
  71  *
  72  * 3. All advertising materials mentioning features or use of this
  73  *    software must display the following acknowledgment:
  74  *    "This product includes software developed by the OpenSSL Project
  75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  76  *
  77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  78  *    endorse or promote products derived from this software without
  79  *    prior written permission. For written permission, please contact
  80  *    openssl-core@openssl.org.
  81  *
  82  * 5. Products derived from this software may not be called "OpenSSL"
  83  *    nor may "OpenSSL" appear in their names without prior written
  84  *    permission of the OpenSSL Project.
  85  *
  86  * 6. Redistributions of any form whatsoever must retain the following
  87  *    acknowledgment:
  88  *    "This product includes software developed by the OpenSSL Project
  89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  90  *
  91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 102  * OF THE POSSIBILITY OF SUCH DAMAGE.
 103  * ====================================================================
 104  *
 105  * This product includes cryptographic software written by Eric Young
 106  * (eay@cryptsoft.com).  This product includes software written by Tim
 107  * Hudson (tjh@cryptsoft.com). */
 108
 109 #include <openssl/ex_data.h>
 110
 111 #include <assert.h>
 112
 113 #include <openssl/err.h>
 114 #include <openssl/lhash.h>
 115 #include <openssl/mem.h>
 116 #include <openssl/stack.h>
 117 #include <openssl/thread.h>
 118
 119 #include "crypto_error.h"
 120 #include "internal.h"
 121
 122 typedef struct crypto_ex_data_func_st {
 123   long argl;  /* Arbitary long */
 124   void *argp; /* Arbitary void pointer */
 125   CRYPTO_EX_new *new_func;
 126   CRYPTO_EX_free *free_func;
 127   CRYPTO_EX_dup *dup_func;
 128 } CRYPTO_EX_DATA_FUNCS;
 129
 130 typedef struct st_ex_class_item {
 131   STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth;
 132   int class_value;
 133 } EX_CLASS_ITEM;
 134
 135 static LHASH_OF(EX_CLASS_ITEM) *global_classes = NULL;
 136
 137 static int global_next_class = 100;
 138
 139 static int new_class(void) {
 140   int ret;
 141   CRYPTO_w_lock(CRYPTO_LOCK_EX_DATA);
 142   ret = global_next_class++;
 143   CRYPTO_w_unlock(CRYPTO_LOCK_EX_DATA);
 144
 145   return ret;
 146 }
 147
 148 /* class_hash is a hash function used by an LHASH of |EX_CLASS_ITEM|
 149  * structures. */
 150 static uint32_t class_hash(const EX_CLASS_ITEM *a) {
 151   return a->class_value;
 152 }
 153
 154 /* class_cmp is a comparision function for an LHASH of |EX_CLASS_ITEM|
 155  * structures. */
 156 static int class_cmp(const EX_CLASS_ITEM *a, const EX_CLASS_ITEM *b) {
 157   return a->class_value - b->class_value;
 158 }
 159
 160 /* data_funcs_free is a callback function from |sk_pop_free| that frees a
 161  * |CRYPTO_EX_DATA_FUNCS|. */
 162 static void data_funcs_free(CRYPTO_EX_DATA_FUNCS *funcs) {
 163   OPENSSL_free(funcs);
 164 }
 165
 166 /* class_free is a callback function from lh_doall to free the EX_CLASS_ITEM
 167  * structures. */
 168 static void class_free(EX_CLASS_ITEM *item) {
 169   sk_CRYPTO_EX_DATA_FUNCS_pop_free(item->meth, data_funcs_free);
 170 }
 171
 172 static LHASH_OF(EX_CLASS_ITEM) *get_classes(void) {
 173   LHASH_OF(EX_CLASS_ITEM) *ret;
 174
 175   CRYPTO_r_lock(CRYPTO_LOCK_EX_DATA);
 176   ret = global_classes;
 177   CRYPTO_r_unlock(CRYPTO_LOCK_EX_DATA);
 178
 179   if (ret != NULL) {
 180     return ret;
 181   }
 182
 183   CRYPTO_w_lock(CRYPTO_LOCK_EX_DATA);
 184   if (global_classes == NULL) {
 185     global_classes = lh_EX_CLASS_ITEM_new(class_hash, class_cmp);
 186   }
 187   ret = global_classes;
 188   CRYPTO_w_unlock(CRYPTO_LOCK_EX_DATA);
 189
 190   return ret;
 191 }
 192
 193 static void cleanup(void) {
 194   LHASH_OF(EX_CLASS_ITEM) *classes = get_classes();
 195
 196   lh_EX_CLASS_ITEM_doall(classes, class_free);
 197   lh_EX_CLASS_ITEM_free(classes);
 198
 199   global_classes = NULL;
 200 }
 201
 202 static EX_CLASS_ITEM *get_class(int class_value) {
 203   LHASH_OF(EX_CLASS_ITEM) *const classes = get_classes();
 204   EX_CLASS_ITEM template, *class_item;
 205   int ok = 0;
 206
 207   CRYPTO_w_lock(CRYPTO_LOCK_EX_DATA);
 208   template.class_value = class_value;
 209   class_item = lh_EX_CLASS_ITEM_retrieve(classes, &template);
 210   if (class_item != NULL) {
 211     ok = 1;
 212   } else {
 213     class_item = OPENSSL_malloc(sizeof(EX_CLASS_ITEM));
 214     if (class_item) {
 215       class_item->class_value = class_value;
 216       class_item->meth = sk_CRYPTO_EX_DATA_FUNCS_new_null();
 217       if (class_item->meth != NULL) {
 218         EX_CLASS_ITEM *old_data;
 219         ok = lh_EX_CLASS_ITEM_insert(classes, &old_data, class_item);
 220         assert(old_data == NULL);
 221       }
 222     }
 223   }
 224   CRYPTO_w_unlock(CRYPTO_LOCK_EX_DATA);
 225
 226   if (!ok) {
 227     if (class_item) {
 228       if (class_item->meth) {
 229         sk_CRYPTO_EX_DATA_FUNCS_free(class_item->meth);
 230       }
 231       OPENSSL_free(class_item);
 232       class_item = NULL;
 233     }
 234
 235     OPENSSL_PUT_ERROR(CRYPTO, get_class, ERR_R_MALLOC_FAILURE);
 236   }
 237
 238   return class_item;
 239 }
 240
 241 static int get_new_index(int class_value, long argl, void *argp,
 242                          CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
 243                          CRYPTO_EX_free *free_func) {
 244   EX_CLASS_ITEM *const item = get_class(class_value);
 245   CRYPTO_EX_DATA_FUNCS *funcs;
 246   int ret = -1;
 247
 248   if (!item) {
 249     return -1;
 250   }
 251
 252   funcs = OPENSSL_malloc(sizeof(CRYPTO_EX_DATA_FUNCS));
 253   if (funcs == NULL) {
 254     OPENSSL_PUT_ERROR(CRYPTO, get_new_index, ERR_R_MALLOC_FAILURE);
 255     return -1;
 256   }
 257
 258   funcs->argl = argl;
 259   funcs->argp = argp;
 260   funcs->new_func = new_func;
 261   funcs->dup_func = dup_func;
 262   funcs->free_func = free_func;
 263
 264   CRYPTO_w_lock(CRYPTO_LOCK_EX_DATA);
 265
 266   if (!sk_CRYPTO_EX_DATA_FUNCS_push(item->meth, funcs)) {
 267     OPENSSL_PUT_ERROR(CRYPTO, get_new_index, ERR_R_MALLOC_FAILURE);
 268     OPENSSL_free(funcs);
 269     goto err;
 270   }
 271
 272   ret = sk_CRYPTO_EX_DATA_FUNCS_num(item->meth) - 1;
 273
 274 err:
 275   CRYPTO_w_unlock(CRYPTO_LOCK_EX_DATA);
 276   return ret;
 277 }
 278
 279 /* get_func_pointers takes a copy of the CRYPTO_EX_DATA_FUNCS pointers, if any,
 280  * for the given class. If there are some pointers, it sets |*out| to point to
 281  * a fresh stack of them. Otherwise it sets |*out| to NULL. It returns one on
 282  * success or zero on error. */
 283 static int get_func_pointers(STACK_OF(CRYPTO_EX_DATA_FUNCS) **out,
 284                              int class_value) {
 285   EX_CLASS_ITEM *const item = get_class(class_value);
 286   size_t n;
 287
 288   if (!item) {
 289     return 0;
 290   }
 291
 292   *out = NULL;
 293
 294   /* CRYPTO_EX_DATA_FUNCS structures are static once set, so we can take a
 295    * shallow copy of the list under lock and then use the structures without
 296    * the lock held. */
 297   CRYPTO_r_lock(CRYPTO_LOCK_EX_DATA);
 298   n = sk_CRYPTO_EX_DATA_FUNCS_num(item->meth);
 299   if (n > 0) {
 300     *out = sk_CRYPTO_EX_DATA_FUNCS_dup(item->meth);
 301   }
 302   CRYPTO_r_unlock(CRYPTO_LOCK_EX_DATA);
 303
 304   if (n > 0 && *out == NULL) {
 305     OPENSSL_PUT_ERROR(CRYPTO, get_func_pointers, ERR_R_MALLOC_FAILURE);
 306     return 0;
 307   }
 308
 309   return 1;
 310 }
 311
 312 static int new_ex_data(int class_value, void *obj, CRYPTO_EX_DATA *ad) {
 313   STACK_OF(CRYPTO_EX_DATA_FUNCS) *func_pointers;
 314   size_t i;
 315
 316   ad->sk = NULL;
 317
 318   if (!get_func_pointers(&func_pointers, class_value)) {
 319     return 0;
 320   }
 321
 322   for (i = 0; i < sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers); i++) {
 323     CRYPTO_EX_DATA_FUNCS *func_pointer =
 324         sk_CRYPTO_EX_DATA_FUNCS_value(func_pointers, i);
 325     if (func_pointer->new_func) {
 326       func_pointer->new_func(obj, NULL, ad, i, func_pointer->argl,
 327                              func_pointer->argp);
 328     }
 329   }
 330
 331   sk_CRYPTO_EX_DATA_FUNCS_free(func_pointers);
 332
 333   return 1;
 334 }
 335
 336 static int dup_ex_data(int class_value, CRYPTO_EX_DATA *to,
 337                        const CRYPTO_EX_DATA *from) {
 338   STACK_OF(CRYPTO_EX_DATA_FUNCS) *func_pointers;
 339   size_t i;
 340
 341   if (!from->sk) {
 342     /* In this case, |from| is blank, which is also the initial state of |to|,
 343      * so there's nothing to do. */
 344     return 1;
 345   }
 346
 347   if (!get_func_pointers(&func_pointers, class_value)) {
 348     return 0;
 349   }
 350
 351   for (i = 0; i < sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers); i++) {
 352     CRYPTO_EX_DATA_FUNCS *func_pointer =
 353         sk_CRYPTO_EX_DATA_FUNCS_value(func_pointers, i);
 354     void *ptr = CRYPTO_get_ex_data(from, i);
 355     if (func_pointer->dup_func) {
 356       func_pointer->dup_func(to, from, &ptr, i, func_pointer->argl,
 357                              func_pointer->argp);
 358     }
 359     CRYPTO_set_ex_data(to, i, ptr);
 360   }
 361
 362   sk_CRYPTO_EX_DATA_FUNCS_free(func_pointers);
 363
 364   return 1;
 365 }
 366
 367 static void free_ex_data(int class_value, void *obj, CRYPTO_EX_DATA *ad) {
 368   STACK_OF(CRYPTO_EX_DATA_FUNCS) *func_pointers;
 369   size_t i;
 370
 371   if (!get_func_pointers(&func_pointers, class_value)) {
 372     return;
 373   }
 374
 375   for (i = 0; i < sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers); i++) {
 376     CRYPTO_EX_DATA_FUNCS *func_pointer =
 377         sk_CRYPTO_EX_DATA_FUNCS_value(func_pointers, i);
 378     if (func_pointer->free_func) {
 379       void *ptr = CRYPTO_get_ex_data(ad, i);
 380       func_pointer->free_func(obj, ptr, ad, i, func_pointer->argl,
 381                               func_pointer->argp);
 382     }
 383   }
 384
 385   sk_CRYPTO_EX_DATA_FUNCS_free(func_pointers);
 386
 387   if (ad->sk) {
 388     sk_void_free(ad->sk);
 389     ad->sk = NULL;
 390   }
 391 }
 392
 393 const CRYPTO_EX_DATA_IMPL ex_data_default_impl = {
 394     new_class, cleanup, get_new_index, new_ex_data, dup_ex_data, free_ex_data};