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 <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
124struct crypto_ex_data_func_st {
125  long argl;  /* Arbitary long */
126  void *argp; /* Arbitary void pointer */
127  CRYPTO_EX_new *new_func;
128  CRYPTO_EX_free *free_func;
129  CRYPTO_EX_dup *dup_func;
130};
131
132int CRYPTO_get_ex_new_index(CRYPTO_EX_DATA_CLASS *ex_data_class, int *out_index,
133                            long argl, void *argp, CRYPTO_EX_new *new_func,
134                            CRYPTO_EX_dup *dup_func,
135                            CRYPTO_EX_free *free_func) {
136  CRYPTO_EX_DATA_FUNCS *funcs;
137  int ret = 0;
138
139  funcs = OPENSSL_malloc(sizeof(CRYPTO_EX_DATA_FUNCS));
140  if (funcs == NULL) {
141    OPENSSL_PUT_ERROR(CRYPTO, CRYPTO_get_ex_new_index, ERR_R_MALLOC_FAILURE);
142    return 0;
143  }
144
145  funcs->argl = argl;
146  funcs->argp = argp;
147  funcs->new_func = new_func;
148  funcs->dup_func = dup_func;
149  funcs->free_func = free_func;
150
151  CRYPTO_STATIC_MUTEX_lock_write(&ex_data_class->lock);
152
153  if (ex_data_class->meth == NULL) {
154    ex_data_class->meth = sk_CRYPTO_EX_DATA_FUNCS_new_null();
155  }
156
157  if (ex_data_class->meth == NULL ||
158      !sk_CRYPTO_EX_DATA_FUNCS_push(ex_data_class->meth, funcs)) {
159    OPENSSL_PUT_ERROR(CRYPTO, CRYPTO_get_ex_new_index, ERR_R_MALLOC_FAILURE);
160    OPENSSL_free(funcs);
161    goto err;
162  }
163
164  *out_index = sk_CRYPTO_EX_DATA_FUNCS_num(ex_data_class->meth) - 1;
165  ret = 1;
166
167err:
168  CRYPTO_STATIC_MUTEX_unlock(&ex_data_class->lock);
169  return ret;
170}
171
172int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int index, void *val) {
173  int n, i;
174
175  if (ad->sk == NULL) {
176    ad->sk = sk_void_new_null();
177    if (ad->sk == NULL) {
178      OPENSSL_PUT_ERROR(CRYPTO, CRYPTO_set_ex_data, ERR_R_MALLOC_FAILURE);
179      return 0;
180    }
181  }
182
183  n = sk_void_num(ad->sk);
184
185  /* Add NULL values until the stack is long enough. */
186  for (i = n; i <= index; i++) {
187    if (!sk_void_push(ad->sk, NULL)) {
188      OPENSSL_PUT_ERROR(CRYPTO, CRYPTO_set_ex_data, ERR_R_MALLOC_FAILURE);
189      return 0;
190    }
191  }
192
193  sk_void_set(ad->sk, index, val);
194  return 1;
195}
196
197void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx) {
198  if (ad->sk == NULL || idx < 0 || (size_t)idx >= sk_void_num(ad->sk)) {
199    return NULL;
200  }
201  return sk_void_value(ad->sk, idx);
202}
203
204/* get_func_pointers takes a copy of the CRYPTO_EX_DATA_FUNCS pointers, if any,
205 * for the given class. If there are some pointers, it sets |*out| to point to
206 * a fresh stack of them. Otherwise it sets |*out| to NULL. It returns one on
207 * success or zero on error. */
208static int get_func_pointers(STACK_OF(CRYPTO_EX_DATA_FUNCS) **out,
209                             CRYPTO_EX_DATA_CLASS *ex_data_class) {
210  size_t n;
211
212  *out = NULL;
213
214  /* CRYPTO_EX_DATA_FUNCS structures are static once set, so we can take a
215   * shallow copy of the list under lock and then use the structures without
216   * the lock held. */
217  CRYPTO_STATIC_MUTEX_lock_read(&ex_data_class->lock);
218  n = sk_CRYPTO_EX_DATA_FUNCS_num(ex_data_class->meth);
219  if (n > 0) {
220    *out = sk_CRYPTO_EX_DATA_FUNCS_dup(ex_data_class->meth);
221  }
222  CRYPTO_STATIC_MUTEX_unlock(&ex_data_class->lock);
223
224  if (n > 0 && *out == NULL) {
225    OPENSSL_PUT_ERROR(CRYPTO, get_func_pointers, ERR_R_MALLOC_FAILURE);
226    return 0;
227  }
228
229  return 1;
230}
231
232int CRYPTO_new_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class, void *obj,
233                       CRYPTO_EX_DATA *ad) {
234  STACK_OF(CRYPTO_EX_DATA_FUNCS) *func_pointers;
235  size_t i;
236
237  ad->sk = NULL;
238
239  if (!get_func_pointers(&func_pointers, ex_data_class)) {
240    return 0;
241  }
242
243  for (i = 0; i < sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers); i++) {
244    CRYPTO_EX_DATA_FUNCS *func_pointer =
245        sk_CRYPTO_EX_DATA_FUNCS_value(func_pointers, i);
246    if (func_pointer->new_func) {
247      func_pointer->new_func(obj, NULL, ad, i, func_pointer->argl,
248                             func_pointer->argp);
249    }
250  }
251
252  sk_CRYPTO_EX_DATA_FUNCS_free(func_pointers);
253
254  return 1;
255}
256
257int CRYPTO_dup_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class, CRYPTO_EX_DATA *to,
258                       const CRYPTO_EX_DATA *from) {
259  STACK_OF(CRYPTO_EX_DATA_FUNCS) *func_pointers;
260  size_t i;
261
262  if (!from->sk) {
263    /* In this case, |from| is blank, which is also the initial state of |to|,
264     * so there's nothing to do. */
265    return 1;
266  }
267
268  if (!get_func_pointers(&func_pointers, ex_data_class)) {
269    return 0;
270  }
271
272  for (i = 0; i < sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers); i++) {
273    CRYPTO_EX_DATA_FUNCS *func_pointer =
274        sk_CRYPTO_EX_DATA_FUNCS_value(func_pointers, i);
275    void *ptr = CRYPTO_get_ex_data(from, i);
276    if (func_pointer->dup_func) {
277      func_pointer->dup_func(to, from, &ptr, i, func_pointer->argl,
278                             func_pointer->argp);
279    }
280    CRYPTO_set_ex_data(to, i, ptr);
281  }
282
283  sk_CRYPTO_EX_DATA_FUNCS_free(func_pointers);
284
285  return 1;
286}
287
288void CRYPTO_free_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class, void *obj,
289                         CRYPTO_EX_DATA *ad) {
290  STACK_OF(CRYPTO_EX_DATA_FUNCS) *func_pointers;
291  size_t i;
292
293  if (!get_func_pointers(&func_pointers, ex_data_class)) {
294    return;
295  }
296
297  for (i = 0; i < sk_CRYPTO_EX_DATA_FUNCS_num(func_pointers); i++) {
298    CRYPTO_EX_DATA_FUNCS *func_pointer =
299        sk_CRYPTO_EX_DATA_FUNCS_value(func_pointers, i);
300    if (func_pointer->free_func) {
301      void *ptr = CRYPTO_get_ex_data(ad, i);
302      func_pointer->free_func(obj, ptr, ad, i, func_pointer->argl,
303                              func_pointer->argp);
304    }
305  }
306
307  sk_CRYPTO_EX_DATA_FUNCS_free(func_pointers);
308
309  sk_void_free(ad->sk);
310  ad->sk = NULL;
311}
312
313void CRYPTO_cleanup_all_ex_data(void) {}
314