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