2016-05-18 03:38:09 +08:00
|
|
|
/*
|
|
|
|
|
* Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
|
2001-09-04 19:02:23 +08:00
|
|
|
*
|
2016-05-18 03:38:09 +08:00
|
|
|
* Licensed under the OpenSSL license (the "License"). You may not use
|
|
|
|
|
* this file except in compliance with the License. You can obtain a copy
|
|
|
|
|
* in the file LICENSE in the source distribution or at
|
|
|
|
|
* https://www.openssl.org/source/license.html
|
2001-09-04 19:02:23 +08:00
|
|
|
*/
|
1998-12-21 18:56:39 +08:00
|
|
|
|
2016-03-12 05:53:18 +08:00
|
|
|
#include "internal/cryptlib_int.h"
|
2016-07-20 01:42:11 +08:00
|
|
|
#include "internal/thread_once.h"
|
2004-04-20 02:09:28 +08:00
|
|
|
#include <openssl/lhash.h>
|
1998-12-21 18:56:39 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
/*
|
|
|
|
|
* Each structure type (sometimes called a class), that supports
|
|
|
|
|
* exdata has a stack of callbacks for each instance.
|
|
|
|
|
*/
|
2016-01-06 10:54:18 +08:00
|
|
|
struct ex_callback_st {
|
2016-02-06 04:23:54 +08:00
|
|
|
long argl; /* Arbitrary long */
|
|
|
|
|
void *argp; /* Arbitrary void * */
|
2015-04-25 04:33:34 +08:00
|
|
|
CRYPTO_EX_new *new_func;
|
|
|
|
|
CRYPTO_EX_free *free_func;
|
|
|
|
|
CRYPTO_EX_dup *dup_func;
|
2016-01-06 10:54:18 +08:00
|
|
|
};
|
2015-01-22 11:40:55 +08:00
|
|
|
|
|
|
|
|
/*
|
2015-07-21 22:06:03 +08:00
|
|
|
* The state for each class. This could just be a typedef, but
|
|
|
|
|
* a structure allows future changes.
|
2015-01-22 11:40:55 +08:00
|
|
|
*/
|
2015-07-21 22:06:03 +08:00
|
|
|
typedef struct ex_callbacks_st {
|
|
|
|
|
STACK_OF(EX_CALLBACK) *meth;
|
|
|
|
|
} EX_CALLBACKS;
|
First step in fixing "ex_data" support. Warning: big commit log ...
Currently, this change merely addresses where ex_data indexes are stored
and managed, and thus fixes the thread-safety issues that existed at that
level. "Class" code (eg. RSA, DSA, etc) no longer store their own STACKS
and per-class index counters - all such data is stored inside ex_data.c. So
rather than passing both STACK+counter to index-management ex_data
functions, a 'class_index' is instead passed to indicate the class (eg.
CRYPTO_EX_INDEX_RSA). New classes can be dynamically registered on-the-fly
and this is also thread-safe inside ex_data.c (though whether the caller
manages the return value in a thread-safe way is not addressed).
This does not change the "get/set" functions on individual "ex_data"
structures, and so thread-safety at that level isn't (yet) assured.
Likewise, the method of getting and storing per-class indexes has not
changed, so locking may still be required at the "caller" end but is
nonetheless thread-safe inside "ex_data"'s internal implementation.
Typically this occurs when code implements a new method of some kind and
stores its own per-class index in a global variable without locking the
setting and usage of that variable. If the code in question is likely to be
used in multiple threads, locking the setting and use of that index is
still up to the code in question. Possible fixes to this are being
sketched, but definitely require more major changes to the API itself than
this change undertakes.
The underlying implementation in ex_data.c has also been modularised so
that alternative "ex_data" implementations (that control all access to
state) can be plugged in. Eg. a loaded module can have its implementation
set to that of the application loaded it - the result being that
thread-safety and consistency of "ex_data" classes and indexes can be
maintained in the same place rather than the loaded module using its own
copy of ex_data support code and state.
Due to the centralisation of "state" with this change, cleanup of all
"ex_data" state can now be performed properly. Previously all allocation of
ex_data state was guaranteed to leak - and MemCheck_off() had been used to
avoid it flagging up the memory debugging. A new function has been added to
perfrom all this cleanup, CRYPTO_cleanup_all_ex_data(). The "openssl"
command(s) have been changed to use this cleanup, as have the relevant test
programs. External application code may want to do so too - failure to
cleanup will not induce more memory leaking than was the case before, but
the memory debugging is not tricked into hiding it any more so it may
"appear" where it previously did not.
2001-09-02 03:56:46 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
static EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
|
First step in fixing "ex_data" support. Warning: big commit log ...
Currently, this change merely addresses where ex_data indexes are stored
and managed, and thus fixes the thread-safety issues that existed at that
level. "Class" code (eg. RSA, DSA, etc) no longer store their own STACKS
and per-class index counters - all such data is stored inside ex_data.c. So
rather than passing both STACK+counter to index-management ex_data
functions, a 'class_index' is instead passed to indicate the class (eg.
CRYPTO_EX_INDEX_RSA). New classes can be dynamically registered on-the-fly
and this is also thread-safe inside ex_data.c (though whether the caller
manages the return value in a thread-safe way is not addressed).
This does not change the "get/set" functions on individual "ex_data"
structures, and so thread-safety at that level isn't (yet) assured.
Likewise, the method of getting and storing per-class indexes has not
changed, so locking may still be required at the "caller" end but is
nonetheless thread-safe inside "ex_data"'s internal implementation.
Typically this occurs when code implements a new method of some kind and
stores its own per-class index in a global variable without locking the
setting and usage of that variable. If the code in question is likely to be
used in multiple threads, locking the setting and use of that index is
still up to the code in question. Possible fixes to this are being
sketched, but definitely require more major changes to the API itself than
this change undertakes.
The underlying implementation in ex_data.c has also been modularised so
that alternative "ex_data" implementations (that control all access to
state) can be plugged in. Eg. a loaded module can have its implementation
set to that of the application loaded it - the result being that
thread-safety and consistency of "ex_data" classes and indexes can be
maintained in the same place rather than the loaded module using its own
copy of ex_data support code and state.
Due to the centralisation of "state" with this change, cleanup of all
"ex_data" state can now be performed properly. Previously all allocation of
ex_data state was guaranteed to leak - and MemCheck_off() had been used to
avoid it flagging up the memory debugging. A new function has been added to
perfrom all this cleanup, CRYPTO_cleanup_all_ex_data(). The "openssl"
command(s) have been changed to use this cleanup, as have the relevant test
programs. External application code may want to do so too - failure to
cleanup will not induce more memory leaking than was the case before, but
the memory debugging is not tricked into hiding it any more so it may
"appear" where it previously did not.
2001-09-02 03:56:46 +08:00
|
|
|
|
2016-04-15 04:28:54 +08:00
|
|
|
static CRYPTO_RWLOCK *ex_data_lock = NULL;
|
2016-03-06 05:54:02 +08:00
|
|
|
static CRYPTO_ONCE ex_data_init = CRYPTO_ONCE_STATIC_INIT;
|
|
|
|
|
|
2016-07-20 01:42:11 +08:00
|
|
|
DEFINE_RUN_ONCE_STATIC(do_ex_data_init)
|
2016-03-06 05:54:02 +08:00
|
|
|
{
|
2016-09-05 21:12:58 +08:00
|
|
|
OPENSSL_init_crypto(0, NULL);
|
2016-03-06 05:54:02 +08:00
|
|
|
ex_data_lock = CRYPTO_THREAD_lock_new();
|
2016-07-20 01:42:11 +08:00
|
|
|
return ex_data_lock != NULL;
|
2016-03-12 05:53:18 +08:00
|
|
|
}
|
|
|
|
|
|
2015-01-22 11:40:55 +08:00
|
|
|
/*
|
2015-07-21 22:06:03 +08:00
|
|
|
* Return the EX_CALLBACKS from the |ex_data| array that corresponds to
|
2015-04-25 04:33:34 +08:00
|
|
|
* a given class. On success, *holds the lock.*
|
2015-01-22 11:40:55 +08:00
|
|
|
*/
|
2015-07-21 22:06:03 +08:00
|
|
|
static EX_CALLBACKS *get_and_lock(int class_index)
|
2015-01-22 11:40:55 +08:00
|
|
|
{
|
2015-07-21 22:06:03 +08:00
|
|
|
EX_CALLBACKS *ip;
|
2015-04-25 04:33:34 +08:00
|
|
|
|
|
|
|
|
if (class_index < 0 || class_index >= CRYPTO_EX_INDEX__COUNT) {
|
2016-03-15 04:46:54 +08:00
|
|
|
CRYPTOerr(CRYPTO_F_GET_AND_LOCK, ERR_R_PASSED_INVALID_ARGUMENT);
|
2015-04-25 04:33:34 +08:00
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
|
2016-07-20 01:42:11 +08:00
|
|
|
if (!RUN_ONCE(&ex_data_init, do_ex_data_init)) {
|
|
|
|
|
CRYPTOerr(CRYPTO_F_GET_AND_LOCK, ERR_R_MALLOC_FAILURE);
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
2016-03-06 05:54:02 +08:00
|
|
|
|
2016-04-15 04:28:54 +08:00
|
|
|
if (ex_data_lock == NULL) {
|
|
|
|
|
/*
|
|
|
|
|
* This can happen in normal operation when using CRYPTO_mem_leaks().
|
|
|
|
|
* The CRYPTO_mem_leaks() function calls OPENSSL_cleanup() which cleans
|
|
|
|
|
* up the locks. Subsequently the BIO that CRYPTO_mem_leaks() uses gets
|
|
|
|
|
* freed, which also attempts to free the ex_data. However
|
|
|
|
|
* CRYPTO_mem_leaks() ensures that the ex_data is freed early (i.e.
|
|
|
|
|
* before OPENSSL_cleanup() is called), so if we get here we can safely
|
|
|
|
|
* ignore this operation. We just treat it as an error.
|
|
|
|
|
*/
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
|
2015-04-25 04:33:34 +08:00
|
|
|
ip = &ex_data[class_index];
|
2016-03-06 05:54:02 +08:00
|
|
|
CRYPTO_THREAD_write_lock(ex_data_lock);
|
2015-04-25 04:33:34 +08:00
|
|
|
return ip;
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
|
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
static void cleanup_cb(EX_CALLBACK *funcs)
|
2015-01-22 11:40:55 +08:00
|
|
|
{
|
|
|
|
|
OPENSSL_free(funcs);
|
|
|
|
|
}
|
First step in fixing "ex_data" support. Warning: big commit log ...
Currently, this change merely addresses where ex_data indexes are stored
and managed, and thus fixes the thread-safety issues that existed at that
level. "Class" code (eg. RSA, DSA, etc) no longer store their own STACKS
and per-class index counters - all such data is stored inside ex_data.c. So
rather than passing both STACK+counter to index-management ex_data
functions, a 'class_index' is instead passed to indicate the class (eg.
CRYPTO_EX_INDEX_RSA). New classes can be dynamically registered on-the-fly
and this is also thread-safe inside ex_data.c (though whether the caller
manages the return value in a thread-safe way is not addressed).
This does not change the "get/set" functions on individual "ex_data"
structures, and so thread-safety at that level isn't (yet) assured.
Likewise, the method of getting and storing per-class indexes has not
changed, so locking may still be required at the "caller" end but is
nonetheless thread-safe inside "ex_data"'s internal implementation.
Typically this occurs when code implements a new method of some kind and
stores its own per-class index in a global variable without locking the
setting and usage of that variable. If the code in question is likely to be
used in multiple threads, locking the setting and use of that index is
still up to the code in question. Possible fixes to this are being
sketched, but definitely require more major changes to the API itself than
this change undertakes.
The underlying implementation in ex_data.c has also been modularised so
that alternative "ex_data" implementations (that control all access to
state) can be plugged in. Eg. a loaded module can have its implementation
set to that of the application loaded it - the result being that
thread-safety and consistency of "ex_data" classes and indexes can be
maintained in the same place rather than the loaded module using its own
copy of ex_data support code and state.
Due to the centralisation of "state" with this change, cleanup of all
"ex_data" state can now be performed properly. Previously all allocation of
ex_data state was guaranteed to leak - and MemCheck_off() had been used to
avoid it flagging up the memory debugging. A new function has been added to
perfrom all this cleanup, CRYPTO_cleanup_all_ex_data(). The "openssl"
command(s) have been changed to use this cleanup, as have the relevant test
programs. External application code may want to do so too - failure to
cleanup will not induce more memory leaking than was the case before, but
the memory debugging is not tricked into hiding it any more so it may
"appear" where it previously did not.
2001-09-02 03:56:46 +08:00
|
|
|
|
2015-01-22 11:40:55 +08:00
|
|
|
/*
|
2015-04-25 04:33:34 +08:00
|
|
|
* Release all "ex_data" state to prevent memory leaks. This can't be made
|
|
|
|
|
* thread-safe without overhauling a lot of stuff, and shouldn't really be
|
|
|
|
|
* called under potential race-conditions anyway (it's for program shutdown
|
|
|
|
|
* after all).
|
2015-01-22 11:40:55 +08:00
|
|
|
*/
|
2016-04-12 19:20:16 +08:00
|
|
|
void crypto_cleanup_all_ex_data_int(void)
|
2015-01-22 11:40:55 +08:00
|
|
|
{
|
2015-04-25 04:33:34 +08:00
|
|
|
int i;
|
2015-01-22 11:40:55 +08:00
|
|
|
|
2015-04-25 04:33:34 +08:00
|
|
|
for (i = 0; i < CRYPTO_EX_INDEX__COUNT; ++i) {
|
2015-07-21 22:06:03 +08:00
|
|
|
EX_CALLBACKS *ip = &ex_data[i];
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
sk_EX_CALLBACK_pop_free(ip->meth, cleanup_cb);
|
2015-04-25 04:33:34 +08:00
|
|
|
ip->meth = NULL;
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
2016-04-15 04:28:54 +08:00
|
|
|
|
|
|
|
|
CRYPTO_THREAD_lock_free(ex_data_lock);
|
|
|
|
|
ex_data_lock = NULL;
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
|
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Unregister a new index by replacing the callbacks with no-ops.
|
|
|
|
|
* Any in-use instances are leaked.
|
|
|
|
|
*/
|
|
|
|
|
static void dummy_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx,
|
|
|
|
|
long argl, void *argp)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void dummy_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx,
|
|
|
|
|
long argl, void *argp)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
2016-07-31 18:04:48 +08:00
|
|
|
static int dummy_dup(CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
|
2015-07-21 22:06:03 +08:00
|
|
|
void *from_d, int idx,
|
|
|
|
|
long argl, void *argp)
|
|
|
|
|
{
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
int CRYPTO_free_ex_index(int class_index, int idx)
|
|
|
|
|
{
|
|
|
|
|
EX_CALLBACKS *ip = get_and_lock(class_index);
|
|
|
|
|
EX_CALLBACK *a;
|
|
|
|
|
int toret = 0;
|
|
|
|
|
|
|
|
|
|
if (ip == NULL)
|
|
|
|
|
return 0;
|
|
|
|
|
if (idx < 0 || idx >= sk_EX_CALLBACK_num(ip->meth))
|
|
|
|
|
goto err;
|
|
|
|
|
a = sk_EX_CALLBACK_value(ip->meth, idx);
|
|
|
|
|
if (a == NULL)
|
|
|
|
|
goto err;
|
|
|
|
|
a->new_func = dummy_new;
|
|
|
|
|
a->dup_func = dummy_dup;
|
|
|
|
|
a->free_func = dummy_free;
|
|
|
|
|
toret = 1;
|
|
|
|
|
err:
|
2016-03-06 05:54:02 +08:00
|
|
|
CRYPTO_THREAD_unlock(ex_data_lock);
|
2015-07-21 22:06:03 +08:00
|
|
|
return toret;
|
|
|
|
|
}
|
|
|
|
|
|
2015-01-22 11:40:55 +08:00
|
|
|
/*
|
2015-07-21 22:06:03 +08:00
|
|
|
* Register a new index.
|
2015-01-22 11:40:55 +08:00
|
|
|
*/
|
2015-04-25 04:33:34 +08:00
|
|
|
int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
|
|
|
|
|
CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
|
|
|
|
|
CRYPTO_EX_free *free_func)
|
2015-01-22 11:40:55 +08:00
|
|
|
{
|
|
|
|
|
int toret = -1;
|
2015-07-21 22:06:03 +08:00
|
|
|
EX_CALLBACK *a;
|
|
|
|
|
EX_CALLBACKS *ip = get_and_lock(class_index);
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
if (ip == NULL)
|
2015-01-22 11:40:55 +08:00
|
|
|
return -1;
|
2016-03-13 03:46:13 +08:00
|
|
|
|
|
|
|
|
if (ip->meth == NULL) {
|
|
|
|
|
ip->meth = sk_EX_CALLBACK_new_null();
|
|
|
|
|
/* We push an initial value on the stack because the SSL
|
|
|
|
|
* "app_data" routines use ex_data index zero. See RT 3710. */
|
|
|
|
|
if (ip->meth == NULL
|
|
|
|
|
|| !sk_EX_CALLBACK_push(ip->meth, NULL)) {
|
2016-03-13 21:54:51 +08:00
|
|
|
CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX, ERR_R_MALLOC_FAILURE);
|
2016-03-13 03:46:13 +08:00
|
|
|
goto err;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
a = (EX_CALLBACK *)OPENSSL_malloc(sizeof(*a));
|
2015-10-30 19:12:26 +08:00
|
|
|
if (a == NULL) {
|
2015-04-25 04:33:34 +08:00
|
|
|
CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX, ERR_R_MALLOC_FAILURE);
|
|
|
|
|
goto err;
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
|
|
|
|
a->argl = argl;
|
|
|
|
|
a->argp = argp;
|
|
|
|
|
a->new_func = new_func;
|
|
|
|
|
a->dup_func = dup_func;
|
|
|
|
|
a->free_func = free_func;
|
First step in fixing "ex_data" support. Warning: big commit log ...
Currently, this change merely addresses where ex_data indexes are stored
and managed, and thus fixes the thread-safety issues that existed at that
level. "Class" code (eg. RSA, DSA, etc) no longer store their own STACKS
and per-class index counters - all such data is stored inside ex_data.c. So
rather than passing both STACK+counter to index-management ex_data
functions, a 'class_index' is instead passed to indicate the class (eg.
CRYPTO_EX_INDEX_RSA). New classes can be dynamically registered on-the-fly
and this is also thread-safe inside ex_data.c (though whether the caller
manages the return value in a thread-safe way is not addressed).
This does not change the "get/set" functions on individual "ex_data"
structures, and so thread-safety at that level isn't (yet) assured.
Likewise, the method of getting and storing per-class indexes has not
changed, so locking may still be required at the "caller" end but is
nonetheless thread-safe inside "ex_data"'s internal implementation.
Typically this occurs when code implements a new method of some kind and
stores its own per-class index in a global variable without locking the
setting and usage of that variable. If the code in question is likely to be
used in multiple threads, locking the setting and use of that index is
still up to the code in question. Possible fixes to this are being
sketched, but definitely require more major changes to the API itself than
this change undertakes.
The underlying implementation in ex_data.c has also been modularised so
that alternative "ex_data" implementations (that control all access to
state) can be plugged in. Eg. a loaded module can have its implementation
set to that of the application loaded it - the result being that
thread-safety and consistency of "ex_data" classes and indexes can be
maintained in the same place rather than the loaded module using its own
copy of ex_data support code and state.
Due to the centralisation of "state" with this change, cleanup of all
"ex_data" state can now be performed properly. Previously all allocation of
ex_data state was guaranteed to leak - and MemCheck_off() had been used to
avoid it flagging up the memory debugging. A new function has been added to
perfrom all this cleanup, CRYPTO_cleanup_all_ex_data(). The "openssl"
command(s) have been changed to use this cleanup, as have the relevant test
programs. External application code may want to do so too - failure to
cleanup will not induce more memory leaking than was the case before, but
the memory debugging is not tricked into hiding it any more so it may
"appear" where it previously did not.
2001-09-02 03:56:46 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
if (!sk_EX_CALLBACK_push(ip->meth, NULL)) {
|
2015-04-25 04:33:34 +08:00
|
|
|
CRYPTOerr(CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX, ERR_R_MALLOC_FAILURE);
|
|
|
|
|
OPENSSL_free(a);
|
|
|
|
|
goto err;
|
|
|
|
|
}
|
2015-07-21 22:06:03 +08:00
|
|
|
toret = sk_EX_CALLBACK_num(ip->meth) - 1;
|
|
|
|
|
(void)sk_EX_CALLBACK_set(ip->meth, toret, a);
|
First step in fixing "ex_data" support. Warning: big commit log ...
Currently, this change merely addresses where ex_data indexes are stored
and managed, and thus fixes the thread-safety issues that existed at that
level. "Class" code (eg. RSA, DSA, etc) no longer store their own STACKS
and per-class index counters - all such data is stored inside ex_data.c. So
rather than passing both STACK+counter to index-management ex_data
functions, a 'class_index' is instead passed to indicate the class (eg.
CRYPTO_EX_INDEX_RSA). New classes can be dynamically registered on-the-fly
and this is also thread-safe inside ex_data.c (though whether the caller
manages the return value in a thread-safe way is not addressed).
This does not change the "get/set" functions on individual "ex_data"
structures, and so thread-safety at that level isn't (yet) assured.
Likewise, the method of getting and storing per-class indexes has not
changed, so locking may still be required at the "caller" end but is
nonetheless thread-safe inside "ex_data"'s internal implementation.
Typically this occurs when code implements a new method of some kind and
stores its own per-class index in a global variable without locking the
setting and usage of that variable. If the code in question is likely to be
used in multiple threads, locking the setting and use of that index is
still up to the code in question. Possible fixes to this are being
sketched, but definitely require more major changes to the API itself than
this change undertakes.
The underlying implementation in ex_data.c has also been modularised so
that alternative "ex_data" implementations (that control all access to
state) can be plugged in. Eg. a loaded module can have its implementation
set to that of the application loaded it - the result being that
thread-safety and consistency of "ex_data" classes and indexes can be
maintained in the same place rather than the loaded module using its own
copy of ex_data support code and state.
Due to the centralisation of "state" with this change, cleanup of all
"ex_data" state can now be performed properly. Previously all allocation of
ex_data state was guaranteed to leak - and MemCheck_off() had been used to
avoid it flagging up the memory debugging. A new function has been added to
perfrom all this cleanup, CRYPTO_cleanup_all_ex_data(). The "openssl"
command(s) have been changed to use this cleanup, as have the relevant test
programs. External application code may want to do so too - failure to
cleanup will not induce more memory leaking than was the case before, but
the memory debugging is not tricked into hiding it any more so it may
"appear" where it previously did not.
2001-09-02 03:56:46 +08:00
|
|
|
|
2015-04-25 04:33:34 +08:00
|
|
|
err:
|
2016-03-06 05:54:02 +08:00
|
|
|
CRYPTO_THREAD_unlock(ex_data_lock);
|
2015-01-22 11:40:55 +08:00
|
|
|
return toret;
|
|
|
|
|
}
|
First step in fixing "ex_data" support. Warning: big commit log ...
Currently, this change merely addresses where ex_data indexes are stored
and managed, and thus fixes the thread-safety issues that existed at that
level. "Class" code (eg. RSA, DSA, etc) no longer store their own STACKS
and per-class index counters - all such data is stored inside ex_data.c. So
rather than passing both STACK+counter to index-management ex_data
functions, a 'class_index' is instead passed to indicate the class (eg.
CRYPTO_EX_INDEX_RSA). New classes can be dynamically registered on-the-fly
and this is also thread-safe inside ex_data.c (though whether the caller
manages the return value in a thread-safe way is not addressed).
This does not change the "get/set" functions on individual "ex_data"
structures, and so thread-safety at that level isn't (yet) assured.
Likewise, the method of getting and storing per-class indexes has not
changed, so locking may still be required at the "caller" end but is
nonetheless thread-safe inside "ex_data"'s internal implementation.
Typically this occurs when code implements a new method of some kind and
stores its own per-class index in a global variable without locking the
setting and usage of that variable. If the code in question is likely to be
used in multiple threads, locking the setting and use of that index is
still up to the code in question. Possible fixes to this are being
sketched, but definitely require more major changes to the API itself than
this change undertakes.
The underlying implementation in ex_data.c has also been modularised so
that alternative "ex_data" implementations (that control all access to
state) can be plugged in. Eg. a loaded module can have its implementation
set to that of the application loaded it - the result being that
thread-safety and consistency of "ex_data" classes and indexes can be
maintained in the same place rather than the loaded module using its own
copy of ex_data support code and state.
Due to the centralisation of "state" with this change, cleanup of all
"ex_data" state can now be performed properly. Previously all allocation of
ex_data state was guaranteed to leak - and MemCheck_off() had been used to
avoid it flagging up the memory debugging. A new function has been added to
perfrom all this cleanup, CRYPTO_cleanup_all_ex_data(). The "openssl"
command(s) have been changed to use this cleanup, as have the relevant test
programs. External application code may want to do so too - failure to
cleanup will not induce more memory leaking than was the case before, but
the memory debugging is not tricked into hiding it any more so it may
"appear" where it previously did not.
2001-09-02 03:56:46 +08:00
|
|
|
|
2015-01-22 11:40:55 +08:00
|
|
|
/*
|
2015-04-25 04:33:34 +08:00
|
|
|
* Initialise a new CRYPTO_EX_DATA for use in a particular class - including
|
|
|
|
|
* calling new() callbacks for each index in the class used by this variable
|
2015-07-21 22:06:03 +08:00
|
|
|
* Thread-safe by copying a class's array of "EX_CALLBACK" entries
|
2015-04-25 04:33:34 +08:00
|
|
|
* in the lock, then using them outside the lock. Note this only applies
|
|
|
|
|
* to the global "ex_data" state (ie. class definitions), not 'ad' itself.
|
2015-01-22 11:40:55 +08:00
|
|
|
*/
|
2015-04-25 04:33:34 +08:00
|
|
|
int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad)
|
2015-01-22 11:40:55 +08:00
|
|
|
{
|
|
|
|
|
int mx, i;
|
|
|
|
|
void *ptr;
|
2015-07-21 22:06:03 +08:00
|
|
|
EX_CALLBACK **storage = NULL;
|
|
|
|
|
EX_CALLBACK *stack[10];
|
|
|
|
|
EX_CALLBACKS *ip = get_and_lock(class_index);
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
if (ip == NULL)
|
2015-01-22 11:40:55 +08:00
|
|
|
return 0;
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-01-22 11:40:55 +08:00
|
|
|
ad->sk = NULL;
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
mx = sk_EX_CALLBACK_num(ip->meth);
|
2015-01-22 11:40:55 +08:00
|
|
|
if (mx > 0) {
|
2015-04-25 04:33:34 +08:00
|
|
|
if (mx < (int)OSSL_NELEM(stack))
|
|
|
|
|
storage = stack;
|
|
|
|
|
else
|
|
|
|
|
storage = OPENSSL_malloc(sizeof(*storage) * mx);
|
2015-10-30 19:12:26 +08:00
|
|
|
if (storage != NULL)
|
2015-04-25 04:33:34 +08:00
|
|
|
for (i = 0; i < mx; i++)
|
2015-07-21 22:06:03 +08:00
|
|
|
storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
2016-03-06 05:54:02 +08:00
|
|
|
CRYPTO_THREAD_unlock(ex_data_lock);
|
2015-04-25 04:33:34 +08:00
|
|
|
|
|
|
|
|
if (mx > 0 && storage == NULL) {
|
|
|
|
|
CRYPTOerr(CRYPTO_F_CRYPTO_NEW_EX_DATA, ERR_R_MALLOC_FAILURE);
|
2015-01-22 11:40:55 +08:00
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
for (i = 0; i < mx; i++) {
|
|
|
|
|
if (storage[i] && storage[i]->new_func) {
|
|
|
|
|
ptr = CRYPTO_get_ex_data(ad, i);
|
|
|
|
|
storage[i]->new_func(obj, ptr, ad, i,
|
|
|
|
|
storage[i]->argl, storage[i]->argp);
|
|
|
|
|
}
|
|
|
|
|
}
|
2015-04-25 04:33:34 +08:00
|
|
|
if (storage != stack)
|
|
|
|
|
OPENSSL_free(storage);
|
2015-01-22 11:40:55 +08:00
|
|
|
return 1;
|
|
|
|
|
}
|
First step in fixing "ex_data" support. Warning: big commit log ...
Currently, this change merely addresses where ex_data indexes are stored
and managed, and thus fixes the thread-safety issues that existed at that
level. "Class" code (eg. RSA, DSA, etc) no longer store their own STACKS
and per-class index counters - all such data is stored inside ex_data.c. So
rather than passing both STACK+counter to index-management ex_data
functions, a 'class_index' is instead passed to indicate the class (eg.
CRYPTO_EX_INDEX_RSA). New classes can be dynamically registered on-the-fly
and this is also thread-safe inside ex_data.c (though whether the caller
manages the return value in a thread-safe way is not addressed).
This does not change the "get/set" functions on individual "ex_data"
structures, and so thread-safety at that level isn't (yet) assured.
Likewise, the method of getting and storing per-class indexes has not
changed, so locking may still be required at the "caller" end but is
nonetheless thread-safe inside "ex_data"'s internal implementation.
Typically this occurs when code implements a new method of some kind and
stores its own per-class index in a global variable without locking the
setting and usage of that variable. If the code in question is likely to be
used in multiple threads, locking the setting and use of that index is
still up to the code in question. Possible fixes to this are being
sketched, but definitely require more major changes to the API itself than
this change undertakes.
The underlying implementation in ex_data.c has also been modularised so
that alternative "ex_data" implementations (that control all access to
state) can be plugged in. Eg. a loaded module can have its implementation
set to that of the application loaded it - the result being that
thread-safety and consistency of "ex_data" classes and indexes can be
maintained in the same place rather than the loaded module using its own
copy of ex_data support code and state.
Due to the centralisation of "state" with this change, cleanup of all
"ex_data" state can now be performed properly. Previously all allocation of
ex_data state was guaranteed to leak - and MemCheck_off() had been used to
avoid it flagging up the memory debugging. A new function has been added to
perfrom all this cleanup, CRYPTO_cleanup_all_ex_data(). The "openssl"
command(s) have been changed to use this cleanup, as have the relevant test
programs. External application code may want to do so too - failure to
cleanup will not induce more memory leaking than was the case before, but
the memory debugging is not tricked into hiding it any more so it may
"appear" where it previously did not.
2001-09-02 03:56:46 +08:00
|
|
|
|
2015-04-25 04:33:34 +08:00
|
|
|
/*
|
|
|
|
|
* Duplicate a CRYPTO_EX_DATA variable - including calling dup() callbacks
|
|
|
|
|
* for each index in the class used by this variable
|
|
|
|
|
*/
|
|
|
|
|
int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
|
2016-07-31 18:04:48 +08:00
|
|
|
const CRYPTO_EX_DATA *from)
|
2015-01-22 11:40:55 +08:00
|
|
|
{
|
|
|
|
|
int mx, j, i;
|
|
|
|
|
char *ptr;
|
2015-07-21 22:06:03 +08:00
|
|
|
EX_CALLBACK *stack[10];
|
|
|
|
|
EX_CALLBACK **storage = NULL;
|
|
|
|
|
EX_CALLBACKS *ip;
|
2015-04-25 04:33:34 +08:00
|
|
|
|
|
|
|
|
if (from->sk == NULL)
|
|
|
|
|
/* Nothing to copy over */
|
2015-01-22 11:40:55 +08:00
|
|
|
return 1;
|
2015-07-21 22:06:03 +08:00
|
|
|
if ((ip = get_and_lock(class_index)) == NULL)
|
2015-01-22 11:40:55 +08:00
|
|
|
return 0;
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
mx = sk_EX_CALLBACK_num(ip->meth);
|
2015-01-22 11:40:55 +08:00
|
|
|
j = sk_void_num(from->sk);
|
|
|
|
|
if (j < mx)
|
|
|
|
|
mx = j;
|
|
|
|
|
if (mx > 0) {
|
2015-04-25 04:33:34 +08:00
|
|
|
if (mx < (int)OSSL_NELEM(stack))
|
|
|
|
|
storage = stack;
|
|
|
|
|
else
|
|
|
|
|
storage = OPENSSL_malloc(sizeof(*storage) * mx);
|
2015-10-30 19:12:26 +08:00
|
|
|
if (storage != NULL)
|
2015-04-25 04:33:34 +08:00
|
|
|
for (i = 0; i < mx; i++)
|
2015-07-21 22:06:03 +08:00
|
|
|
storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
2016-03-06 05:54:02 +08:00
|
|
|
CRYPTO_THREAD_unlock(ex_data_lock);
|
2015-04-25 04:33:34 +08:00
|
|
|
|
|
|
|
|
if (mx > 0 && storage == NULL) {
|
|
|
|
|
CRYPTOerr(CRYPTO_F_CRYPTO_DUP_EX_DATA, ERR_R_MALLOC_FAILURE);
|
2015-01-22 11:40:55 +08:00
|
|
|
return 0;
|
|
|
|
|
}
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-01-22 11:40:55 +08:00
|
|
|
for (i = 0; i < mx; i++) {
|
|
|
|
|
ptr = CRYPTO_get_ex_data(from, i);
|
|
|
|
|
if (storage[i] && storage[i]->dup_func)
|
|
|
|
|
storage[i]->dup_func(to, from, &ptr, i,
|
|
|
|
|
storage[i]->argl, storage[i]->argp);
|
|
|
|
|
CRYPTO_set_ex_data(to, i, ptr);
|
|
|
|
|
}
|
2015-04-25 04:33:34 +08:00
|
|
|
if (storage != stack)
|
|
|
|
|
OPENSSL_free(storage);
|
2015-01-22 11:40:55 +08:00
|
|
|
return 1;
|
|
|
|
|
}
|
First step in fixing "ex_data" support. Warning: big commit log ...
Currently, this change merely addresses where ex_data indexes are stored
and managed, and thus fixes the thread-safety issues that existed at that
level. "Class" code (eg. RSA, DSA, etc) no longer store their own STACKS
and per-class index counters - all such data is stored inside ex_data.c. So
rather than passing both STACK+counter to index-management ex_data
functions, a 'class_index' is instead passed to indicate the class (eg.
CRYPTO_EX_INDEX_RSA). New classes can be dynamically registered on-the-fly
and this is also thread-safe inside ex_data.c (though whether the caller
manages the return value in a thread-safe way is not addressed).
This does not change the "get/set" functions on individual "ex_data"
structures, and so thread-safety at that level isn't (yet) assured.
Likewise, the method of getting and storing per-class indexes has not
changed, so locking may still be required at the "caller" end but is
nonetheless thread-safe inside "ex_data"'s internal implementation.
Typically this occurs when code implements a new method of some kind and
stores its own per-class index in a global variable without locking the
setting and usage of that variable. If the code in question is likely to be
used in multiple threads, locking the setting and use of that index is
still up to the code in question. Possible fixes to this are being
sketched, but definitely require more major changes to the API itself than
this change undertakes.
The underlying implementation in ex_data.c has also been modularised so
that alternative "ex_data" implementations (that control all access to
state) can be plugged in. Eg. a loaded module can have its implementation
set to that of the application loaded it - the result being that
thread-safety and consistency of "ex_data" classes and indexes can be
maintained in the same place rather than the loaded module using its own
copy of ex_data support code and state.
Due to the centralisation of "state" with this change, cleanup of all
"ex_data" state can now be performed properly. Previously all allocation of
ex_data state was guaranteed to leak - and MemCheck_off() had been used to
avoid it flagging up the memory debugging. A new function has been added to
perfrom all this cleanup, CRYPTO_cleanup_all_ex_data(). The "openssl"
command(s) have been changed to use this cleanup, as have the relevant test
programs. External application code may want to do so too - failure to
cleanup will not induce more memory leaking than was the case before, but
the memory debugging is not tricked into hiding it any more so it may
"appear" where it previously did not.
2001-09-02 03:56:46 +08:00
|
|
|
|
2015-04-25 04:33:34 +08:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Cleanup a CRYPTO_EX_DATA variable - including calling free() callbacks for
|
|
|
|
|
* each index in the class used by this variable
|
|
|
|
|
*/
|
|
|
|
|
void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad)
|
2015-01-22 11:40:55 +08:00
|
|
|
{
|
|
|
|
|
int mx, i;
|
2015-07-21 22:06:03 +08:00
|
|
|
EX_CALLBACKS *ip;
|
2015-01-22 11:40:55 +08:00
|
|
|
void *ptr;
|
2017-02-02 01:29:47 +08:00
|
|
|
EX_CALLBACK *f;
|
2015-07-21 22:06:03 +08:00
|
|
|
EX_CALLBACK *stack[10];
|
|
|
|
|
EX_CALLBACK **storage = NULL;
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
if ((ip = get_and_lock(class_index)) == NULL)
|
2017-02-02 01:29:47 +08:00
|
|
|
goto err;
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-07-21 22:06:03 +08:00
|
|
|
mx = sk_EX_CALLBACK_num(ip->meth);
|
2015-01-22 11:40:55 +08:00
|
|
|
if (mx > 0) {
|
2015-04-25 04:33:34 +08:00
|
|
|
if (mx < (int)OSSL_NELEM(stack))
|
|
|
|
|
storage = stack;
|
|
|
|
|
else
|
|
|
|
|
storage = OPENSSL_malloc(sizeof(*storage) * mx);
|
2015-10-30 19:12:26 +08:00
|
|
|
if (storage != NULL)
|
2015-04-25 04:33:34 +08:00
|
|
|
for (i = 0; i < mx; i++)
|
2015-07-21 22:06:03 +08:00
|
|
|
storage[i] = sk_EX_CALLBACK_value(ip->meth, i);
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
2016-03-06 05:54:02 +08:00
|
|
|
CRYPTO_THREAD_unlock(ex_data_lock);
|
2015-04-25 04:33:34 +08:00
|
|
|
|
2015-01-22 11:40:55 +08:00
|
|
|
for (i = 0; i < mx; i++) {
|
2017-02-02 01:29:47 +08:00
|
|
|
if (storage != NULL)
|
|
|
|
|
f = storage[i];
|
|
|
|
|
else {
|
|
|
|
|
CRYPTO_THREAD_write_lock(ex_data_lock);
|
|
|
|
|
f = sk_EX_CALLBACK_value(ip->meth, i);
|
|
|
|
|
CRYPTO_THREAD_unlock(ex_data_lock);
|
|
|
|
|
}
|
|
|
|
|
if (f != NULL && f->free_func != NULL) {
|
2015-01-22 11:40:55 +08:00
|
|
|
ptr = CRYPTO_get_ex_data(ad, i);
|
2017-02-02 01:29:47 +08:00
|
|
|
f->free_func(obj, ptr, ad, i, f->argl, f->argp);
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
|
|
|
|
}
|
2015-04-25 04:33:34 +08:00
|
|
|
|
|
|
|
|
if (storage != stack)
|
|
|
|
|
OPENSSL_free(storage);
|
2017-02-02 01:29:47 +08:00
|
|
|
err:
|
2015-05-02 02:37:16 +08:00
|
|
|
sk_void_free(ad->sk);
|
|
|
|
|
ad->sk = NULL;
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
First step in fixing "ex_data" support. Warning: big commit log ...
Currently, this change merely addresses where ex_data indexes are stored
and managed, and thus fixes the thread-safety issues that existed at that
level. "Class" code (eg. RSA, DSA, etc) no longer store their own STACKS
and per-class index counters - all such data is stored inside ex_data.c. So
rather than passing both STACK+counter to index-management ex_data
functions, a 'class_index' is instead passed to indicate the class (eg.
CRYPTO_EX_INDEX_RSA). New classes can be dynamically registered on-the-fly
and this is also thread-safe inside ex_data.c (though whether the caller
manages the return value in a thread-safe way is not addressed).
This does not change the "get/set" functions on individual "ex_data"
structures, and so thread-safety at that level isn't (yet) assured.
Likewise, the method of getting and storing per-class indexes has not
changed, so locking may still be required at the "caller" end but is
nonetheless thread-safe inside "ex_data"'s internal implementation.
Typically this occurs when code implements a new method of some kind and
stores its own per-class index in a global variable without locking the
setting and usage of that variable. If the code in question is likely to be
used in multiple threads, locking the setting and use of that index is
still up to the code in question. Possible fixes to this are being
sketched, but definitely require more major changes to the API itself than
this change undertakes.
The underlying implementation in ex_data.c has also been modularised so
that alternative "ex_data" implementations (that control all access to
state) can be plugged in. Eg. a loaded module can have its implementation
set to that of the application loaded it - the result being that
thread-safety and consistency of "ex_data" classes and indexes can be
maintained in the same place rather than the loaded module using its own
copy of ex_data support code and state.
Due to the centralisation of "state" with this change, cleanup of all
"ex_data" state can now be performed properly. Previously all allocation of
ex_data state was guaranteed to leak - and MemCheck_off() had been used to
avoid it flagging up the memory debugging. A new function has been added to
perfrom all this cleanup, CRYPTO_cleanup_all_ex_data(). The "openssl"
command(s) have been changed to use this cleanup, as have the relevant test
programs. External application code may want to do so too - failure to
cleanup will not induce more memory leaking than was the case before, but
the memory debugging is not tricked into hiding it any more so it may
"appear" where it previously did not.
2001-09-02 03:56:46 +08:00
|
|
|
|
2015-01-22 11:40:55 +08:00
|
|
|
/*
|
|
|
|
|
* For a given CRYPTO_EX_DATA variable, set the value corresponding to a
|
|
|
|
|
* particular index in the class used by this variable
|
|
|
|
|
*/
|
2000-01-24 07:41:49 +08:00
|
|
|
int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val)
|
2015-01-22 11:40:55 +08:00
|
|
|
{
|
|
|
|
|
int i;
|
|
|
|
|
|
|
|
|
|
if (ad->sk == NULL) {
|
|
|
|
|
if ((ad->sk = sk_void_new_null()) == NULL) {
|
|
|
|
|
CRYPTOerr(CRYPTO_F_CRYPTO_SET_EX_DATA, ERR_R_MALLOC_FAILURE);
|
2015-04-25 04:33:34 +08:00
|
|
|
return 0;
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-04-25 04:33:34 +08:00
|
|
|
for (i = sk_void_num(ad->sk); i <= idx; ++i) {
|
2015-01-22 11:40:55 +08:00
|
|
|
if (!sk_void_push(ad->sk, NULL)) {
|
|
|
|
|
CRYPTOerr(CRYPTO_F_CRYPTO_SET_EX_DATA, ERR_R_MALLOC_FAILURE);
|
2015-04-25 04:33:34 +08:00
|
|
|
return 0;
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
sk_void_set(ad->sk, idx, val);
|
2015-04-25 04:33:34 +08:00
|
|
|
return 1;
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* For a given CRYPTO_EX_DATA_ variable, get the value corresponding to a
|
|
|
|
|
* particular index in the class used by this variable
|
|
|
|
|
*/
|
2000-11-07 07:24:59 +08:00
|
|
|
void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx)
|
2015-01-22 11:40:55 +08:00
|
|
|
{
|
2015-04-25 04:33:34 +08:00
|
|
|
if (ad->sk == NULL || idx >= sk_void_num(ad->sk))
|
|
|
|
|
return NULL;
|
|
|
|
|
return sk_void_value(ad->sk, idx);
|
2015-01-22 11:40:55 +08:00
|
|
|
}
|
