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