Home | History | Annotate | Download | only in crypto
      1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com)
      2  * All rights reserved.
      3  *
      4  * This package is an SSL implementation written
      5  * by Eric Young (eay (at) 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 (at) 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 (at) 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 (at) 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 (at) 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 (at) cryptsoft.com).  This product includes software written by Tim
    107  * Hudson (tjh (at) cryptsoft.com). */
    108 
    109 #include <openssl/ex_data.h>
    110 
    111 #include <assert.h>
    112 #include <string.h>
    113 
    114 #include <openssl/crypto.h>
    115 #include <openssl/err.h>
    116 #include <openssl/lhash.h>
    117 #include <openssl/mem.h>
    118 #include <openssl/stack.h>
    119 #include <openssl/thread.h>
    120 
    121 #include "internal.h"
    122 
    123 
    124 struct crypto_ex_data_func_st {
    125   long argl;  /* Arbitary long */
    126   void *argp; /* Arbitary void pointer */
    127   CRYPTO_EX_free *free_func;
    128   CRYPTO_EX_dup *dup_func;
    129 };
    130 
    131 int CRYPTO_get_ex_new_index(CRYPTO_EX_DATA_CLASS *ex_data_class, int *out_index,
    132                             long argl, void *argp, CRYPTO_EX_dup *dup_func,
    133                             CRYPTO_EX_free *free_func) {
    134   CRYPTO_EX_DATA_FUNCS *funcs;
    135   int ret = 0;
    136 
    137   funcs = OPENSSL_malloc(sizeof(CRYPTO_EX_DATA_FUNCS));
    138   if (funcs == NULL) {
    139     OPENSSL_PUT_ERROR(CRYPTO, ERR_R_MALLOC_FAILURE);
    140     return 0;
    141   }
    142 
    143   funcs->argl = argl;
    144   funcs->argp = argp;
    145   funcs->dup_func = dup_func;
    146   funcs->free_func = free_func;
    147 
    148   CRYPTO_STATIC_MUTEX_lock_write(&ex_data_class->lock);
    149 
    150   if (ex_data_class->meth == NULL) {
    151     ex_data_class->meth = sk_CRYPTO_EX_DATA_FUNCS_new_null();
    152   }
    153 
    154   if (ex_data_class->meth == NULL ||
    155       !sk_CRYPTO_EX_DATA_FUNCS_push(ex_data_class->meth, funcs)) {
    156     OPENSSL_PUT_ERROR(CRYPTO, ERR_R_MALLOC_FAILURE);
    157     OPENSSL_free(funcs);
    158     goto err;
    159   }
    160 
    161   *out_index = sk_CRYPTO_EX_DATA_FUNCS_num(ex_data_class->meth) - 1 +
    162                ex_data_class->num_reserved;
    163   ret = 1;
    164 
    165 err:
    166   CRYPTO_STATIC_MUTEX_unlock(&ex_data_class->lock);
    167   return ret;
    168 }
    169 
    170 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int index, void *val) {
    171   int n, i;
    172 
    173   if (ad->sk == NULL) {
    174     ad->sk = sk_void_new_null();
    175     if (ad->sk == NULL) {
    176       OPENSSL_PUT_ERROR(CRYPTO, ERR_R_MALLOC_FAILURE);
    177       return 0;
    178     }
    179   }
    180 
    181   n = sk_void_num(ad->sk);
    182 
    183   /* Add NULL values until the stack is long enough. */
    184   for (i = n; i <= index; i++) {
    185     if (!sk_void_push(ad->sk, NULL)) {
    186       OPENSSL_PUT_ERROR(CRYPTO, ERR_R_MALLOC_FAILURE);
    187       return 0;
    188     }
    189   }
    190 
    191   sk_void_set(ad->sk, index, val);
    192   return 1;
    193 }
    194 
    195 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx) {
    196   if (ad->sk == NULL || idx < 0 || (size_t)idx >= sk_void_num(ad->sk)) {
    197     return NULL;
    198   }
    199   return sk_void_value(ad->sk, idx);
    200 }
    201 
    202 /* get_func_pointers takes a copy of the CRYPTO_EX_DATA_FUNCS pointers, if any,
    203  * for the given class. If there are some pointers, it sets |*out| to point to
    204  * a fresh stack of them. Otherwise it sets |*out| to NULL. It returns one on
    205  * success or zero on error. */
    206 static int get_func_pointers(STACK_OF(CRYPTO_EX_DATA_FUNCS) **out,
    207                              CRYPTO_EX_DATA_CLASS *ex_data_class) {
    208   size_t n;
    209 
    210   *out = NULL;
    211 
    212   /* CRYPTO_EX_DATA_FUNCS structures are static once set, so we can take a
    213    * shallow copy of the list under lock and then use the structures without
    214    * the lock held. */
    215   CRYPTO_STATIC_MUTEX_lock_read(&ex_data_class->lock);
    216   n = sk_CRYPTO_EX_DATA_FUNCS_num(ex_data_class->meth);
    217   if (n > 0) {
    218     *out = sk_CRYPTO_EX_DATA_FUNCS_dup(ex_data_class->meth);
    219   }
    220   CRYPTO_STATIC_MUTEX_unlock(&ex_data_class->lock);
    221 
    222   if (n > 0 && *out == NULL) {
    223     OPENSSL_PUT_ERROR(CRYPTO, ERR_R_MALLOC_FAILURE);
    224     return 0;
    225   }
    226 
    227   return 1;
    228 }
    229 
    230 void CRYPTO_new_ex_data(CRYPTO_EX_DATA *ad) {
    231   ad->sk = NULL;
    232 }
    233 
    234 int CRYPTO_dup_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class, CRYPTO_EX_DATA *to,
    235                        const CRYPTO_EX_DATA *from) {
    236   if (from->sk == NULL) {
    237     /* In this case, |from| is blank, which is also the initial state of |to|,
    238      * so there's nothing to do. */
    239     return 1;
    240   }
    241 
    242   STACK_OF(CRYPTO_EX_DATA_FUNCS) *func_pointers;
    243   if (!get_func_pointers(&func_pointers, ex_data_class)) {
    244     return 0;
    245   }
    246 
    247   size_t i;
    248   for (i = 0; i < sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers); i++) {
    249     CRYPTO_EX_DATA_FUNCS *func_pointer =
    250         sk_CRYPTO_EX_DATA_FUNCS_value(func_pointers, i);
    251     void *ptr = CRYPTO_get_ex_data(from, i + ex_data_class->num_reserved);
    252     if (func_pointer->dup_func) {
    253       func_pointer->dup_func(to, from, &ptr, i + ex_data_class->num_reserved,
    254                              func_pointer->argl, func_pointer->argp);
    255     }
    256     CRYPTO_set_ex_data(to, i + ex_data_class->num_reserved, ptr);
    257   }
    258 
    259   sk_CRYPTO_EX_DATA_FUNCS_free(func_pointers);
    260 
    261   return 1;
    262 }
    263 
    264 void CRYPTO_free_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class, void *obj,
    265                          CRYPTO_EX_DATA *ad) {
    266   if (ad->sk == NULL) {
    267     /* Nothing to do. */
    268     return;
    269   }
    270 
    271   STACK_OF(CRYPTO_EX_DATA_FUNCS) *func_pointers;
    272   if (!get_func_pointers(&func_pointers, ex_data_class)) {
    273     /* TODO(davidben): This leaks memory on malloc error. */
    274     return;
    275   }
    276 
    277   size_t i;
    278   for (i = 0; i < sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers); i++) {
    279     CRYPTO_EX_DATA_FUNCS *func_pointer =
    280         sk_CRYPTO_EX_DATA_FUNCS_value(func_pointers, i);
    281     if (func_pointer->free_func) {
    282       void *ptr = CRYPTO_get_ex_data(ad, i + ex_data_class->num_reserved);
    283       func_pointer->free_func(obj, ptr, ad, i + ex_data_class->num_reserved,
    284                               func_pointer->argl, func_pointer->argp);
    285     }
    286   }
    287 
    288   sk_CRYPTO_EX_DATA_FUNCS_free(func_pointers);
    289 
    290   sk_void_free(ad->sk);
    291   ad->sk = NULL;
    292 }
    293 
    294 void CRYPTO_cleanup_all_ex_data(void) {}
    295