crypto/ex_data.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  */
 110
 111 #include "internal/cryptlib_int.h"
 112 #include "internal/threads.h"
 113 #include <openssl/lhash.h>
 114
 115 /*
 116  * Each structure type (sometimes called a class), that supports
 117  * exdata has a stack of callbacks for each instance.
 118  */
 119 struct ex_callback_st {
 120     long argl;                  /* Arbitrary long */
 121     void *argp;                 /* Arbitrary void * */
 122     CRYPTO_EX_new *new_func;
 123     CRYPTO_EX_free *free_func;
 124     CRYPTO_EX_dup *dup_func;
 125 };
 126
 127 /*
 128  * The state for each class.  This could just be a typedef, but
 129  * a structure allows future changes.
 130  */
 131 typedef struct ex_callbacks_st {
 132     STACK_OF(EX_CALLBACK) *meth;
 133 } EX_CALLBACKS;
 134
 135 static EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
 136
 137 static CRYPTO_RWLOCK *ex_data_lock;
 138 static CRYPTO_ONCE ex_data_init = CRYPTO_ONCE_STATIC_INIT;
 139
 140 static void do_ex_data_init(void)
 141 {
 142     ex_data_lock = CRYPTO_THREAD_lock_new();
 143 }
 144
 145 void ex_data_cleanup(void)
 146 {
 147     CRYPTO_THREAD_lock_free(ex_data_lock);
 148     ex_data_lock = NULL;
 149 }
 150
 151 /*
 152  * Return the EX_CALLBACKS from the |ex_data| array that corresponds to
 153  * a given class.  On success, *holds the lock.*
 154  */
 155 static EX_CALLBACKS *get_and_lock(int class_index)
 156 {
 157     EX_CALLBACKS *ip;
 158
 159     if (class_index < 0 || class_index >= CRYPTO_EX_INDEX__COUNT) {
 160         CRYPTOerr(CRYPTO_F_GET_AND_LOCK, ERR_R_PASSED_INVALID_ARGUMENT);
 161         return NULL;
 162     }
 163
 164     CRYPTO_THREAD_run_once(&ex_data_init, do_ex_data_init);
 165
 166     ip = &ex_data[class_index];
 167     CRYPTO_THREAD_write_lock(ex_data_lock);
 168     return ip;
 169 }
 170
 171 static void cleanup_cb(EX_CALLBACK *funcs)
 172 {
 173     OPENSSL_free(funcs);
 174 }
 175
 176 /*
 177  * Release all "ex_data" state to prevent memory leaks. This can't be made
 178  * thread-safe without overhauling a lot of stuff, and shouldn't really be
 179  * called under potential race-conditions anyway (it's for program shutdown
 180  * after all).
 181  */
 182 void crypto_cleanup_all_ex_data_int(void)
 183 {
 184     int i;
 185
 186     for (i = 0; i < CRYPTO_EX_INDEX__COUNT; ++i) {
 187         EX_CALLBACKS *ip = &ex_data[i];
 188
 189         sk_EX_CALLBACK_pop_free(ip->meth, cleanup_cb);
 190         ip->meth = NULL;
 191     }
 192 }
 193
 194
 195 /*
 196  * Unregister a new index by replacing the callbacks with no-ops.
 197  * Any in-use instances are leaked.
 198  */
 199 static void dummy_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx,
 200                      long argl, void *argp)
 201 {
 202 }
 203
 204 static void dummy_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx,
 205                        long argl, void *argp)
 206 {
 207 }
 208
 209 static int dummy_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from,
 210                      void *from_d, int idx,
 211                      long argl, void *argp)
 212 {
 213     return 0;
 214 }
 215
 216 int CRYPTO_free_ex_index(int class_index, int idx)
 217 {
 218     EX_CALLBACKS *ip = get_and_lock(class_index);
 219     EX_CALLBACK *a;
 220     int toret = 0;
 221
 222     if (ip == NULL)
 223         return 0;
 224     if (idx < 0 || idx >= sk_EX_CALLBACK_num(ip->meth))
 225         goto err;
 226     a = sk_EX_CALLBACK_value(ip->meth, idx);
 227     if (a == NULL)
 228         goto err;
 229     a->new_func = dummy_new;
 230     a->dup_func = dummy_dup;
 231     a->free_func = dummy_free;
 232     toret = 1;
 233 err:
 234     CRYPTO_THREAD_unlock(ex_data_lock);
 235     return toret;
 236 }
 237
 238 /*
 239  * Register a new index.
 240  */
 241 int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
 242                             CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
 243                             CRYPTO_EX_free *free_func)
 244 {
 245     int toret = -1;
 246     EX_CALLBACK *a;
 247     EX_CALLBACKS *ip = get_and_lock(class_index);
 248
 249     if (ip == NULL)
 250         return -1;
 251
 252     if (ip->meth == NULL) {
 253         ip->meth = sk_EX_CALLBACK_new_null();
 254         /* We push an initial value on the stack because the SSL
 255          * "app_data" routines use ex_data index zero.  See RT 3710. */
 256         if (ip->meth == NULL
 257             || !sk_EX_CALLBACK_push(ip->meth, NULL)) {
 258             CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX, ERR_R_MALLOC_FAILURE);
 259             goto err;
 260         }
 261     }
 262
 263     a = (EX_CALLBACK *)OPENSSL_malloc(sizeof(*a));
 264     if (a == NULL) {
 265         CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX, ERR_R_MALLOC_FAILURE);
 266         goto err;
 267     }
 268     a->argl = argl;
 269     a->argp = argp;
 270     a->new_func = new_func;
 271     a->dup_func = dup_func;
 272     a->free_func = free_func;
 273
 274     if (!sk_EX_CALLBACK_push(ip->meth, NULL)) {
 275         CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX, ERR_R_MALLOC_FAILURE);
 276         OPENSSL_free(a);
 277         goto err;
 278     }
 279     toret = sk_EX_CALLBACK_num(ip->meth) - 1;
 280     (void)sk_EX_CALLBACK_set(ip->meth, toret, a);
 281
 282  err:
 283     CRYPTO_THREAD_unlock(ex_data_lock);
 284     return toret;
 285 }
 286
 287 /*
 288  * Initialise a new CRYPTO_EX_DATA for use in a particular class - including
 289  * calling new() callbacks for each index in the class used by this variable
 290  * Thread-safe by copying a class's array of "EX_CALLBACK" entries
 291  * in the lock, then using them outside the lock. Note this only applies
 292  * to the global "ex_data" state (ie. class definitions), not 'ad' itself.
 293  */
 294 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad)
 295 {
 296     int mx, i;
 297     void *ptr;
 298     EX_CALLBACK **storage = NULL;
 299     EX_CALLBACK *stack[10];
 300     EX_CALLBACKS *ip = get_and_lock(class_index);
 301
 302     if (ip == NULL)
 303         return 0;
 304
 305     ad->sk = NULL;
 306
 307     mx = sk_EX_CALLBACK_num(ip->meth);
 308     if (mx > 0) {
 309         if (mx < (int)OSSL_NELEM(stack))
 310             storage = stack;
 311         else
 312             storage = OPENSSL_malloc(sizeof(*storage) * mx);
 313         if (storage != NULL)
 314             for (i = 0; i < mx; i++)
 315                 storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
 316     }
 317     CRYPTO_THREAD_unlock(ex_data_lock);
 318
 319     if (mx > 0 && storage == NULL) {
 320         CRYPTOerr(CRYPTO_F_CRYPTO_NEW_EX_DATA, ERR_R_MALLOC_FAILURE);
 321         return 0;
 322     }
 323     for (i = 0; i < mx; i++) {
 324         if (storage[i] && storage[i]->new_func) {
 325             ptr = CRYPTO_get_ex_data(ad, i);
 326             storage[i]->new_func(obj, ptr, ad, i,
 327                                  storage[i]->argl, storage[i]->argp);
 328         }
 329     }
 330     if (storage != stack)
 331         OPENSSL_free(storage);
 332     return 1;
 333 }
 334
 335 /*
 336  * Duplicate a CRYPTO_EX_DATA variable - including calling dup() callbacks
 337  * for each index in the class used by this variable
 338  */
 339 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
 340                        CRYPTO_EX_DATA *from)
 341 {
 342     int mx, j, i;
 343     char *ptr;
 344     EX_CALLBACK *stack[10];
 345     EX_CALLBACK **storage = NULL;
 346     EX_CALLBACKS *ip;
 347
 348     if (from->sk == NULL)
 349         /* Nothing to copy over */
 350         return 1;
 351     if ((ip = get_and_lock(class_index)) == NULL)
 352         return 0;
 353
 354     mx = sk_EX_CALLBACK_num(ip->meth);
 355     j = sk_void_num(from->sk);
 356     if (j < mx)
 357         mx = j;
 358     if (mx > 0) {
 359         if (mx < (int)OSSL_NELEM(stack))
 360             storage = stack;
 361         else
 362             storage = OPENSSL_malloc(sizeof(*storage) * mx);
 363         if (storage != NULL)
 364             for (i = 0; i < mx; i++)
 365                 storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
 366     }
 367     CRYPTO_THREAD_unlock(ex_data_lock);
 368
 369     if (mx > 0 && storage == NULL) {
 370         CRYPTOerr(CRYPTO_F_CRYPTO_DUP_EX_DATA, ERR_R_MALLOC_FAILURE);
 371         return 0;
 372     }
 373
 374     for (i = 0; i < mx; i++) {
 375         ptr = CRYPTO_get_ex_data(from, i);
 376         if (storage[i] && storage[i]->dup_func)
 377             storage[i]->dup_func(to, from, &ptr, i,
 378                                  storage[i]->argl, storage[i]->argp);
 379         CRYPTO_set_ex_data(to, i, ptr);
 380     }
 381     if (storage != stack)
 382         OPENSSL_free(storage);
 383     return 1;
 384 }
 385
 386
 387 /*
 388  * Cleanup a CRYPTO_EX_DATA variable - including calling free() callbacks for
 389  * each index in the class used by this variable
 390  */
 391 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad)
 392 {
 393     int mx, i;
 394     EX_CALLBACKS *ip;
 395     void *ptr;
 396     EX_CALLBACK *stack[10];
 397     EX_CALLBACK **storage = NULL;
 398
 399     if ((ip = get_and_lock(class_index)) == NULL)
 400         return;
 401
 402     mx = sk_EX_CALLBACK_num(ip->meth);
 403     if (mx > 0) {
 404         if (mx < (int)OSSL_NELEM(stack))
 405             storage = stack;
 406         else
 407             storage = OPENSSL_malloc(sizeof(*storage) * mx);
 408         if (storage != NULL)
 409             for (i = 0; i < mx; i++)
 410                 storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
 411     }
 412     CRYPTO_THREAD_unlock(ex_data_lock);
 413
 414     if (mx > 0 && storage == NULL) {
 415         CRYPTOerr(CRYPTO_F_CRYPTO_FREE_EX_DATA, ERR_R_MALLOC_FAILURE);
 416         return;
 417     }
 418     for (i = 0; i < mx; i++) {
 419         if (storage[i] && storage[i]->free_func) {
 420             ptr = CRYPTO_get_ex_data(ad, i);
 421             storage[i]->free_func(obj, ptr, ad, i,
 422                                   storage[i]->argl, storage[i]->argp);
 423         }
 424     }
 425
 426     if (storage != stack)
 427         OPENSSL_free(storage);
 428     sk_void_free(ad->sk);
 429     ad->sk = NULL;
 430 }
 431
 432 /*
 433  * For a given CRYPTO_EX_DATA variable, set the value corresponding to a
 434  * particular index in the class used by this variable
 435  */
 436 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val)
 437 {
 438     int i;
 439
 440     if (ad->sk == NULL) {
 441         if ((ad->sk = sk_void_new_null()) == NULL) {
 442             CRYPTOerr(CRYPTO_F_CRYPTO_SET_EX_DATA, ERR_R_MALLOC_FAILURE);
 443             return 0;
 444         }
 445     }
 446
 447     for (i = sk_void_num(ad->sk); i <= idx; ++i) {
 448         if (!sk_void_push(ad->sk, NULL)) {
 449             CRYPTOerr(CRYPTO_F_CRYPTO_SET_EX_DATA, ERR_R_MALLOC_FAILURE);
 450             return 0;
 451         }
 452     }
 453     sk_void_set(ad->sk, idx, val);
 454     return 1;
 455 }
 456
 457 /*
 458  * For a given CRYPTO_EX_DATA_ variable, get the value corresponding to a
 459  * particular index in the class used by this variable
 460  */
 461 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx)
 462 {
 463     if (ad->sk == NULL || idx >= sk_void_num(ad->sk))
 464         return NULL;
 465     return sk_void_value(ad->sk, idx);
 466 }