2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #include "crypto/cryptlib.h"
11 #include "internal/thread_once.h"
13 int do_ex_data_init(OPENSSL_CTX
*ctx
)
15 OSSL_EX_DATA_GLOBAL
*global
= openssl_ctx_get_ex_data_global(ctx
);
20 global
->ex_data_lock
= CRYPTO_THREAD_lock_new();
21 return global
->ex_data_lock
!= NULL
;
25 * Return the EX_CALLBACKS from the |ex_data| array that corresponds to
26 * a given class. On success, *holds the lock.*
27 * The |global| parameter is assumed to be non null (checked by the caller).
29 static EX_CALLBACKS
*get_and_lock(OSSL_EX_DATA_GLOBAL
*global
, int class_index
)
33 if (class_index
< 0 || class_index
>= CRYPTO_EX_INDEX__COUNT
) {
34 CRYPTOerr(CRYPTO_F_GET_AND_LOCK
, ERR_R_PASSED_INVALID_ARGUMENT
);
38 if (global
->ex_data_lock
== NULL
) {
40 * If we get here, someone (who?) cleaned up the lock, so just
41 * treat it as an error.
46 CRYPTO_THREAD_write_lock(global
->ex_data_lock
);
47 ip
= &global
->ex_data
[class_index
];
51 static void cleanup_cb(EX_CALLBACK
*funcs
)
57 * Release all "ex_data" state to prevent memory leaks. This can't be made
58 * thread-safe without overhauling a lot of stuff, and shouldn't really be
59 * called under potential race-conditions anyway (it's for program shutdown
62 void crypto_cleanup_all_ex_data_int(OPENSSL_CTX
*ctx
)
65 OSSL_EX_DATA_GLOBAL
*global
= openssl_ctx_get_ex_data_global(ctx
);
70 for (i
= 0; i
< CRYPTO_EX_INDEX__COUNT
; ++i
) {
71 EX_CALLBACKS
*ip
= &global
->ex_data
[i
];
73 sk_EX_CALLBACK_pop_free(ip
->meth
, cleanup_cb
);
77 CRYPTO_THREAD_lock_free(global
->ex_data_lock
);
78 global
->ex_data_lock
= NULL
;
83 * Unregister a new index by replacing the callbacks with no-ops.
84 * Any in-use instances are leaked.
86 static void dummy_new(void *parent
, void *ptr
, CRYPTO_EX_DATA
*ad
, int idx
,
87 long argl
, void *argp
)
91 static void dummy_free(void *parent
, void *ptr
, CRYPTO_EX_DATA
*ad
, int idx
,
92 long argl
, void *argp
)
96 static int dummy_dup(CRYPTO_EX_DATA
*to
, const CRYPTO_EX_DATA
*from
,
97 void **from_d
, int idx
,
98 long argl
, void *argp
)
103 int crypto_free_ex_index_ex(OPENSSL_CTX
*ctx
, int class_index
, int idx
)
108 OSSL_EX_DATA_GLOBAL
*global
= openssl_ctx_get_ex_data_global(ctx
);
113 ip
= get_and_lock(global
, class_index
);
117 if (idx
< 0 || idx
>= sk_EX_CALLBACK_num(ip
->meth
))
119 a
= sk_EX_CALLBACK_value(ip
->meth
, idx
);
122 a
->new_func
= dummy_new
;
123 a
->dup_func
= dummy_dup
;
124 a
->free_func
= dummy_free
;
127 CRYPTO_THREAD_unlock(global
->ex_data_lock
);
131 int CRYPTO_free_ex_index(int class_index
, int idx
)
133 return crypto_free_ex_index_ex(NULL
, class_index
, idx
);
137 * Register a new index.
139 int crypto_get_ex_new_index_ex(OPENSSL_CTX
*ctx
, int class_index
, long argl
,
140 void *argp
, CRYPTO_EX_new
*new_func
,
141 CRYPTO_EX_dup
*dup_func
,
142 CRYPTO_EX_free
*free_func
)
147 OSSL_EX_DATA_GLOBAL
*global
= openssl_ctx_get_ex_data_global(ctx
);
152 ip
= get_and_lock(global
, class_index
);
156 if (ip
->meth
== NULL
) {
157 ip
->meth
= sk_EX_CALLBACK_new_null();
158 /* We push an initial value on the stack because the SSL
159 * "app_data" routines use ex_data index zero. See RT 3710. */
161 || !sk_EX_CALLBACK_push(ip
->meth
, NULL
)) {
162 CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX_EX
, ERR_R_MALLOC_FAILURE
);
167 a
= (EX_CALLBACK
*)OPENSSL_malloc(sizeof(*a
));
169 CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX_EX
, ERR_R_MALLOC_FAILURE
);
174 a
->new_func
= new_func
;
175 a
->dup_func
= dup_func
;
176 a
->free_func
= free_func
;
178 if (!sk_EX_CALLBACK_push(ip
->meth
, NULL
)) {
179 CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX_EX
, ERR_R_MALLOC_FAILURE
);
183 toret
= sk_EX_CALLBACK_num(ip
->meth
) - 1;
184 (void)sk_EX_CALLBACK_set(ip
->meth
, toret
, a
);
187 CRYPTO_THREAD_unlock(global
->ex_data_lock
);
191 int CRYPTO_get_ex_new_index(int class_index
, long argl
, void *argp
,
192 CRYPTO_EX_new
*new_func
, CRYPTO_EX_dup
*dup_func
,
193 CRYPTO_EX_free
*free_func
)
195 return crypto_get_ex_new_index_ex(NULL
, class_index
, argl
, argp
, new_func
,
196 dup_func
, free_func
);
200 * Initialise a new CRYPTO_EX_DATA for use in a particular class - including
201 * calling new() callbacks for each index in the class used by this variable
202 * Thread-safe by copying a class's array of "EX_CALLBACK" entries
203 * in the lock, then using them outside the lock. Note this only applies
204 * to the global "ex_data" state (ie. class definitions), not 'ad' itself.
206 int crypto_new_ex_data_ex(OPENSSL_CTX
*ctx
, int class_index
, void *obj
,
211 EX_CALLBACK
**storage
= NULL
;
212 EX_CALLBACK
*stack
[10];
214 OSSL_EX_DATA_GLOBAL
*global
= openssl_ctx_get_ex_data_global(ctx
);
219 ip
= get_and_lock(global
, class_index
);
225 mx
= sk_EX_CALLBACK_num(ip
->meth
);
227 if (mx
< (int)OSSL_NELEM(stack
))
230 storage
= OPENSSL_malloc(sizeof(*storage
) * mx
);
232 for (i
= 0; i
< mx
; i
++)
233 storage
[i
] = sk_EX_CALLBACK_value(ip
->meth
, i
);
235 CRYPTO_THREAD_unlock(global
->ex_data_lock
);
237 if (mx
> 0 && storage
== NULL
) {
238 CRYPTOerr(CRYPTO_F_CRYPTO_NEW_EX_DATA_EX
, ERR_R_MALLOC_FAILURE
);
241 for (i
= 0; i
< mx
; i
++) {
242 if (storage
[i
] != NULL
&& storage
[i
]->new_func
!= NULL
) {
243 ptr
= CRYPTO_get_ex_data(ad
, i
);
244 storage
[i
]->new_func(obj
, ptr
, ad
, i
,
245 storage
[i
]->argl
, storage
[i
]->argp
);
248 if (storage
!= stack
)
249 OPENSSL_free(storage
);
253 int CRYPTO_new_ex_data(int class_index
, void *obj
, CRYPTO_EX_DATA
*ad
)
255 return crypto_new_ex_data_ex(NULL
, class_index
, obj
, ad
);
259 * Duplicate a CRYPTO_EX_DATA variable - including calling dup() callbacks
260 * for each index in the class used by this variable
262 int CRYPTO_dup_ex_data(int class_index
, CRYPTO_EX_DATA
*to
,
263 const CRYPTO_EX_DATA
*from
)
267 EX_CALLBACK
*stack
[10];
268 EX_CALLBACK
**storage
= NULL
;
271 OSSL_EX_DATA_GLOBAL
*global
;
274 if (from
->sk
== NULL
)
275 /* Nothing to copy over */
278 global
= openssl_ctx_get_ex_data_global(from
->ctx
);
282 ip
= get_and_lock(global
, class_index
);
286 mx
= sk_EX_CALLBACK_num(ip
->meth
);
287 j
= sk_void_num(from
->sk
);
291 if (mx
< (int)OSSL_NELEM(stack
))
294 storage
= OPENSSL_malloc(sizeof(*storage
) * mx
);
296 for (i
= 0; i
< mx
; i
++)
297 storage
[i
] = sk_EX_CALLBACK_value(ip
->meth
, i
);
299 CRYPTO_THREAD_unlock(global
->ex_data_lock
);
303 if (storage
== NULL
) {
304 CRYPTOerr(CRYPTO_F_CRYPTO_DUP_EX_DATA
, ERR_R_MALLOC_FAILURE
);
308 * Make sure the ex_data stack is at least |mx| elements long to avoid
309 * issues in the for loop that follows; so go get the |mx|'th element
310 * (if it does not exist CRYPTO_get_ex_data() returns NULL), and assign
311 * to itself. This is normally a no-op; but ensures the stack is the
314 if (!CRYPTO_set_ex_data(to
, mx
- 1, CRYPTO_get_ex_data(to
, mx
- 1)))
317 for (i
= 0; i
< mx
; i
++) {
318 ptr
= CRYPTO_get_ex_data(from
, i
);
319 if (storage
[i
] != NULL
&& storage
[i
]->dup_func
!= NULL
)
320 if (!storage
[i
]->dup_func(to
, from
, &ptr
, i
,
321 storage
[i
]->argl
, storage
[i
]->argp
))
323 CRYPTO_set_ex_data(to
, i
, ptr
);
327 if (storage
!= stack
)
328 OPENSSL_free(storage
);
334 * Cleanup a CRYPTO_EX_DATA variable - including calling free() callbacks for
335 * each index in the class used by this variable
337 void CRYPTO_free_ex_data(int class_index
, void *obj
, CRYPTO_EX_DATA
*ad
)
343 EX_CALLBACK
*stack
[10];
344 EX_CALLBACK
**storage
= NULL
;
345 OSSL_EX_DATA_GLOBAL
*global
= openssl_ctx_get_ex_data_global(ad
->ctx
);
350 ip
= get_and_lock(global
, class_index
);
354 mx
= sk_EX_CALLBACK_num(ip
->meth
);
356 if (mx
< (int)OSSL_NELEM(stack
))
359 storage
= OPENSSL_malloc(sizeof(*storage
) * mx
);
361 for (i
= 0; i
< mx
; i
++)
362 storage
[i
] = sk_EX_CALLBACK_value(ip
->meth
, i
);
364 CRYPTO_THREAD_unlock(global
->ex_data_lock
);
366 for (i
= 0; i
< mx
; i
++) {
370 CRYPTO_THREAD_write_lock(global
->ex_data_lock
);
371 f
= sk_EX_CALLBACK_value(ip
->meth
, i
);
372 CRYPTO_THREAD_unlock(global
->ex_data_lock
);
374 if (f
!= NULL
&& f
->free_func
!= NULL
) {
375 ptr
= CRYPTO_get_ex_data(ad
, i
);
376 f
->free_func(obj
, ptr
, ad
, i
, f
->argl
, f
->argp
);
380 if (storage
!= stack
)
381 OPENSSL_free(storage
);
383 sk_void_free(ad
->sk
);
389 * Allocate a given CRYPTO_EX_DATA item using the class specific allocation
392 int CRYPTO_alloc_ex_data(int class_index
, void *obj
, CRYPTO_EX_DATA
*ad
,
398 OSSL_EX_DATA_GLOBAL
*global
;
400 curval
= CRYPTO_get_ex_data(ad
, idx
);
401 /* Already there, no need to allocate */
405 global
= openssl_ctx_get_ex_data_global(ad
->ctx
);
409 ip
= get_and_lock(global
, class_index
);
412 f
= sk_EX_CALLBACK_value(ip
->meth
, idx
);
413 CRYPTO_THREAD_unlock(global
->ex_data_lock
);
416 * This should end up calling CRYPTO_set_ex_data(), which allocates
417 * everything necessary to support placing the new data in the right spot.
419 if (f
->new_func
== NULL
)
422 f
->new_func(obj
, NULL
, ad
, idx
, f
->argl
, f
->argp
);
428 * For a given CRYPTO_EX_DATA variable, set the value corresponding to a
429 * particular index in the class used by this variable
431 int CRYPTO_set_ex_data(CRYPTO_EX_DATA
*ad
, int idx
, void *val
)
435 if (ad
->sk
== NULL
) {
436 if ((ad
->sk
= sk_void_new_null()) == NULL
) {
437 CRYPTOerr(CRYPTO_F_CRYPTO_SET_EX_DATA
, ERR_R_MALLOC_FAILURE
);
442 for (i
= sk_void_num(ad
->sk
); i
<= idx
; ++i
) {
443 if (!sk_void_push(ad
->sk
, NULL
)) {
444 CRYPTOerr(CRYPTO_F_CRYPTO_SET_EX_DATA
, ERR_R_MALLOC_FAILURE
);
448 if (sk_void_set(ad
->sk
, idx
, val
) != val
) {
449 /* Probably the index is out of bounds */
450 CRYPTOerr(CRYPTO_F_CRYPTO_SET_EX_DATA
, ERR_R_PASSED_INVALID_ARGUMENT
);
457 * For a given CRYPTO_EX_DATA_ variable, get the value corresponding to a
458 * particular index in the class used by this variable
460 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA
*ad
, int idx
)
462 if (ad
->sk
== NULL
|| idx
>= sk_void_num(ad
->sk
))
464 return sk_void_value(ad
->sk
, idx
);
467 OPENSSL_CTX
*crypto_ex_data_get_openssl_ctx(const CRYPTO_EX_DATA
*ad
)