1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
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)"
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
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.]
57 /* ====================================================================
58 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
86 * 6. Redistributions of any form whatsoever must retain the following
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
111 #include "internal/cryptlib_int.h"
112 #include "internal/threads.h"
113 #include <openssl/lhash.h>
116 * Each structure type (sometimes called a class), that supports
117 * exdata has a stack of callbacks for each instance.
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;
128 * The state for each class. This could just be a typedef, but
129 * a structure allows future changes.
131 typedef struct ex_callbacks_st {
132 STACK_OF(EX_CALLBACK) *meth;
135 static EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
137 static CRYPTO_RWLOCK *ex_data_lock;
138 static CRYPTO_ONCE ex_data_init = CRYPTO_ONCE_STATIC_INIT;
140 static void do_ex_data_init(void)
142 ex_data_lock = CRYPTO_THREAD_lock_new();
145 void ex_data_cleanup(void)
147 CRYPTO_THREAD_lock_free(ex_data_lock);
152 * Return the EX_CALLBACKS from the |ex_data| array that corresponds to
153 * a given class. On success, *holds the lock.*
155 static EX_CALLBACKS *get_and_lock(int class_index)
159 if (class_index < 0 || class_index >= CRYPTO_EX_INDEX__COUNT) {
160 CRYPTOerr(CRYPTO_F_GET_AND_LOCK, ERR_R_PASSED_INVALID_ARGUMENT);
164 CRYPTO_THREAD_run_once(&ex_data_init, do_ex_data_init);
166 ip = &ex_data[class_index];
167 CRYPTO_THREAD_write_lock(ex_data_lock);
171 static void cleanup_cb(EX_CALLBACK *funcs)
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
182 void crypto_cleanup_all_ex_data_int(void)
186 for (i = 0; i < CRYPTO_EX_INDEX__COUNT; ++i) {
187 EX_CALLBACKS *ip = &ex_data[i];
189 sk_EX_CALLBACK_pop_free(ip->meth, cleanup_cb);
196 * Unregister a new index by replacing the callbacks with no-ops.
197 * Any in-use instances are leaked.
199 static void dummy_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx,
200 long argl, void *argp)
204 static void dummy_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx,
205 long argl, void *argp)
209 static int dummy_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from,
210 void *from_d, int idx,
211 long argl, void *argp)
216 int CRYPTO_free_ex_index(int class_index, int idx)
218 EX_CALLBACKS *ip = get_and_lock(class_index);
224 if (idx < 0 || idx >= sk_EX_CALLBACK_num(ip->meth))
226 a = sk_EX_CALLBACK_value(ip->meth, idx);
229 a->new_func = dummy_new;
230 a->dup_func = dummy_dup;
231 a->free_func = dummy_free;
234 CRYPTO_THREAD_unlock(ex_data_lock);
239 * Register a new index.
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)
247 EX_CALLBACKS *ip = get_and_lock(class_index);
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. */
257 || !sk_EX_CALLBACK_push(ip->meth, NULL)) {
258 CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX, ERR_R_MALLOC_FAILURE);
263 a = (EX_CALLBACK *)OPENSSL_malloc(sizeof(*a));
265 CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX, ERR_R_MALLOC_FAILURE);
270 a->new_func = new_func;
271 a->dup_func = dup_func;
272 a->free_func = free_func;
274 if (!sk_EX_CALLBACK_push(ip->meth, NULL)) {
275 CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX, ERR_R_MALLOC_FAILURE);
279 toret = sk_EX_CALLBACK_num(ip->meth) - 1;
280 (void)sk_EX_CALLBACK_set(ip->meth, toret, a);
283 CRYPTO_THREAD_unlock(ex_data_lock);
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.
294 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad)
298 EX_CALLBACK **storage = NULL;
299 EX_CALLBACK *stack[10];
300 EX_CALLBACKS *ip = get_and_lock(class_index);
307 mx = sk_EX_CALLBACK_num(ip->meth);
309 if (mx < (int)OSSL_NELEM(stack))
312 storage = OPENSSL_malloc(sizeof(*storage) * mx);
314 for (i = 0; i < mx; i++)
315 storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
317 CRYPTO_THREAD_unlock(ex_data_lock);
319 if (mx > 0 && storage == NULL) {
320 CRYPTOerr(CRYPTO_F_CRYPTO_NEW_EX_DATA, ERR_R_MALLOC_FAILURE);
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);
330 if (storage != stack)
331 OPENSSL_free(storage);
336 * Duplicate a CRYPTO_EX_DATA variable - including calling dup() callbacks
337 * for each index in the class used by this variable
339 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
340 CRYPTO_EX_DATA *from)
344 EX_CALLBACK *stack[10];
345 EX_CALLBACK **storage = NULL;
348 if (from->sk == NULL)
349 /* Nothing to copy over */
351 if ((ip = get_and_lock(class_index)) == NULL)
354 mx = sk_EX_CALLBACK_num(ip->meth);
355 j = sk_void_num(from->sk);
359 if (mx < (int)OSSL_NELEM(stack))
362 storage = OPENSSL_malloc(sizeof(*storage) * mx);
364 for (i = 0; i < mx; i++)
365 storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
367 CRYPTO_THREAD_unlock(ex_data_lock);
369 if (mx > 0 && storage == NULL) {
370 CRYPTOerr(CRYPTO_F_CRYPTO_DUP_EX_DATA, ERR_R_MALLOC_FAILURE);
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);
381 if (storage != stack)
382 OPENSSL_free(storage);
388 * Cleanup a CRYPTO_EX_DATA variable - including calling free() callbacks for
389 * each index in the class used by this variable
391 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad)
396 EX_CALLBACK *stack[10];
397 EX_CALLBACK **storage = NULL;
399 if ((ip = get_and_lock(class_index)) == NULL)
402 mx = sk_EX_CALLBACK_num(ip->meth);
404 if (mx < (int)OSSL_NELEM(stack))
407 storage = OPENSSL_malloc(sizeof(*storage) * mx);
409 for (i = 0; i < mx; i++)
410 storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
412 CRYPTO_THREAD_unlock(ex_data_lock);
414 if (mx > 0 && storage == NULL) {
415 CRYPTOerr(CRYPTO_F_CRYPTO_FREE_EX_DATA, ERR_R_MALLOC_FAILURE);
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);
426 if (storage != stack)
427 OPENSSL_free(storage);
428 sk_void_free(ad->sk);
433 * For a given CRYPTO_EX_DATA variable, set the value corresponding to a
434 * particular index in the class used by this variable
436 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val)
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);
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);
453 sk_void_set(ad->sk, idx, val);
458 * For a given CRYPTO_EX_DATA_ variable, get the value corresponding to a
459 * particular index in the class used by this variable
461 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx)
463 if (ad->sk == NULL || idx >= sk_void_num(ad->sk))
465 return sk_void_value(ad->sk, idx);