• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #include <limits.h>
113 #include <stdlib.h>
114 #include <string.h>
115 
116 #include <openssl/crypto.h>
117 #include <openssl/err.h>
118 #include <openssl/mem.h>
119 #include <openssl/stack.h>
120 #include <openssl/thread.h>
121 
122 #include "internal.h"
123 
124 
125 DEFINE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
126 
127 struct crypto_ex_data_func_st {
128   long argl;   // Arbitary long
129   void *argp;  // Arbitary void pointer
130   CRYPTO_EX_free *free_func;
131 };
132 
CRYPTO_get_ex_new_index(CRYPTO_EX_DATA_CLASS * ex_data_class,int * out_index,long argl,void * argp,CRYPTO_EX_free * free_func)133 int CRYPTO_get_ex_new_index(CRYPTO_EX_DATA_CLASS *ex_data_class, int *out_index,
134                             long argl, void *argp, CRYPTO_EX_free *free_func) {
135   CRYPTO_EX_DATA_FUNCS *funcs;
136   int ret = 0;
137 
138   funcs = OPENSSL_malloc(sizeof(CRYPTO_EX_DATA_FUNCS));
139   if (funcs == NULL) {
140     return 0;
141   }
142 
143   funcs->argl = argl;
144   funcs->argp = argp;
145   funcs->free_func = free_func;
146 
147   CRYPTO_STATIC_MUTEX_lock_write(&ex_data_class->lock);
148 
149   if (ex_data_class->meth == NULL) {
150     ex_data_class->meth = sk_CRYPTO_EX_DATA_FUNCS_new_null();
151   }
152 
153   if (ex_data_class->meth == NULL) {
154     goto err;
155   }
156 
157   // The index must fit in |int|.
158   if (sk_CRYPTO_EX_DATA_FUNCS_num(ex_data_class->meth) >
159           (size_t)(INT_MAX - ex_data_class->num_reserved)) {
160     OPENSSL_PUT_ERROR(CRYPTO, ERR_R_OVERFLOW);
161     goto err;
162   }
163 
164   if (!sk_CRYPTO_EX_DATA_FUNCS_push(ex_data_class->meth, funcs)) {
165     goto err;
166   }
167   funcs = NULL;  // |sk_CRYPTO_EX_DATA_FUNCS_push| takes ownership.
168 
169   *out_index = (int)sk_CRYPTO_EX_DATA_FUNCS_num(ex_data_class->meth) - 1 +
170                ex_data_class->num_reserved;
171   ret = 1;
172 
173 err:
174   CRYPTO_STATIC_MUTEX_unlock_write(&ex_data_class->lock);
175   OPENSSL_free(funcs);
176   return ret;
177 }
178 
CRYPTO_set_ex_data(CRYPTO_EX_DATA * ad,int index,void * val)179 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int index, void *val) {
180   if (index < 0) {
181     // A caller that can accidentally pass in an invalid index into this
182     // function will hit an memory error if |index| happened to be valid, and
183     // expected |val| to be of a different type.
184     abort();
185   }
186 
187   if (ad->sk == NULL) {
188     ad->sk = sk_void_new_null();
189     if (ad->sk == NULL) {
190       return 0;
191     }
192   }
193 
194   // Add NULL values until the stack is long enough.
195   for (size_t i = sk_void_num(ad->sk); i <= (size_t)index; i++) {
196     if (!sk_void_push(ad->sk, NULL)) {
197       return 0;
198     }
199   }
200 
201   sk_void_set(ad->sk, (size_t)index, val);
202   return 1;
203 }
204 
CRYPTO_get_ex_data(const CRYPTO_EX_DATA * ad,int idx)205 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx) {
206   if (ad->sk == NULL || idx < 0 || (size_t)idx >= sk_void_num(ad->sk)) {
207     return NULL;
208   }
209   return sk_void_value(ad->sk, idx);
210 }
211 
212 // get_func_pointers takes a copy of the CRYPTO_EX_DATA_FUNCS pointers, if any,
213 // for the given class. If there are some pointers, it sets |*out| to point to
214 // a fresh stack of them. Otherwise it sets |*out| to NULL. It returns one on
215 // success or zero on error.
get_func_pointers(STACK_OF (CRYPTO_EX_DATA_FUNCS)** out,CRYPTO_EX_DATA_CLASS * ex_data_class)216 static int get_func_pointers(STACK_OF(CRYPTO_EX_DATA_FUNCS) **out,
217                              CRYPTO_EX_DATA_CLASS *ex_data_class) {
218   size_t n;
219 
220   *out = NULL;
221 
222   // CRYPTO_EX_DATA_FUNCS structures are static once set, so we can take a
223   // shallow copy of the list under lock and then use the structures without
224   // the lock held.
225   CRYPTO_STATIC_MUTEX_lock_read(&ex_data_class->lock);
226   n = sk_CRYPTO_EX_DATA_FUNCS_num(ex_data_class->meth);
227   if (n > 0) {
228     *out = sk_CRYPTO_EX_DATA_FUNCS_dup(ex_data_class->meth);
229   }
230   CRYPTO_STATIC_MUTEX_unlock_read(&ex_data_class->lock);
231 
232   if (n > 0 && *out == NULL) {
233     return 0;
234   }
235 
236   return 1;
237 }
238 
CRYPTO_new_ex_data(CRYPTO_EX_DATA * ad)239 void CRYPTO_new_ex_data(CRYPTO_EX_DATA *ad) {
240   ad->sk = NULL;
241 }
242 
CRYPTO_free_ex_data(CRYPTO_EX_DATA_CLASS * ex_data_class,void * obj,CRYPTO_EX_DATA * ad)243 void CRYPTO_free_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class, void *obj,
244                          CRYPTO_EX_DATA *ad) {
245   if (ad->sk == NULL) {
246     // Nothing to do.
247     return;
248   }
249 
250   STACK_OF(CRYPTO_EX_DATA_FUNCS) *func_pointers;
251   if (!get_func_pointers(&func_pointers, ex_data_class)) {
252     // TODO(davidben): This leaks memory on malloc error.
253     return;
254   }
255 
256   // |CRYPTO_get_ex_new_index| will not allocate indices beyond |INT_MAX|.
257   assert(sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers) <=
258          (size_t)(INT_MAX - ex_data_class->num_reserved));
259   for (int i = 0; i < (int)sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers); i++) {
260     CRYPTO_EX_DATA_FUNCS *func_pointer =
261         sk_CRYPTO_EX_DATA_FUNCS_value(func_pointers, i);
262     if (func_pointer->free_func) {
263       void *ptr = CRYPTO_get_ex_data(ad, i + ex_data_class->num_reserved);
264       func_pointer->free_func(obj, ptr, ad, i + ex_data_class->num_reserved,
265                               func_pointer->argl, func_pointer->argp);
266     }
267   }
268 
269   sk_CRYPTO_EX_DATA_FUNCS_free(func_pointers);
270 
271   sk_void_free(ad->sk);
272   ad->sk = NULL;
273 }
274 
CRYPTO_cleanup_all_ex_data(void)275 void CRYPTO_cleanup_all_ex_data(void) {}
276