1 /* crypto/engine/eng_lib.c */

     2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL

     3  * project 2000.

     4  */

     5 /* ====================================================================

     6  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.

     7  *

     8  * Redistribution and use in source and binary forms, with or without

     9  * modification, are permitted provided that the following conditions

    10  * are met:

    11  *

    12  * 1. Redistributions of source code must retain the above copyright

    13  *    notice, this list of conditions and the following disclaimer. 

    14  *

    15  * 2. Redistributions in binary form must reproduce the above copyright

    16  *    notice, this list of conditions and the following disclaimer in

    17  *    the documentation and/or other materials provided with the

    18  *    distribution.

    19  *

    20  * 3. All advertising materials mentioning features or use of this

    21  *    software must display the following acknowledgment:

    22  *    "This product includes software developed by the OpenSSL Project

    23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"

    24  *

    25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to

    26  *    endorse or promote products derived from this software without

    27  *    prior written permission. For written permission, please contact

    28  *    licensing@OpenSSL.org.

    29  *

    30  * 5. Products derived from this software may not be called "OpenSSL"

    31  *    nor may "OpenSSL" appear in their names without prior written

    32  *    permission of the OpenSSL Project.

    33  *

    34  * 6. Redistributions of any form whatsoever must retain the following

    35  *    acknowledgment:

    36  *    "This product includes software developed by the OpenSSL Project

    37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"

    38  *

    39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY

    40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

    42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR

    43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

    44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

    45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

    46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

    47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

    48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

    49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED

    50  * OF THE POSSIBILITY OF SUCH DAMAGE.

    51  * ====================================================================

    52  *

    53  * This product includes cryptographic software written by Eric Young

    54  * (eay@cryptsoft.com).  This product includes software written by Tim

    55  * Hudson (tjh@cryptsoft.com).

    56  *

    57  */

    58 /*

    59  © Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.

    60  */

    61 #include "eng_int.h"

    62 #include <openssl/rand.h>

    63 #if (defined(SYMBIAN) && (defined(__WINSCW__) || defined(__WINS__)))

    64 #include "libcrypto_wsd_macros.h"

    65 #include "libcrypto_wsd.h"

    66 #endif

    67 

    68 

    69 /* The "new"/"free" stuff first */

    70 

    71 EXPORT_C ENGINE *ENGINE_new(void)

    72 	{

    73 	ENGINE *ret;

    74 

    75 	ret = (ENGINE *)OPENSSL_malloc(sizeof(ENGINE));

    76 	if(ret == NULL)

    77 		{

    78 		ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);

    79 		return NULL;

    80 		}

    81 	memset(ret, 0, sizeof(ENGINE));

    82 	ret->struct_ref = 1;

    83 	engine_ref_debug(ret, 0, 1)

    84 	CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);

    85 	return ret;

    86 	}

    87 

    88 /* Placed here (close proximity to ENGINE_new) so that modifications to the

    89  * elements of the ENGINE structure are more likely to be caught and changed

    90  * here. */

    91 EXPORT_C void engine_set_all_null(ENGINE *e)

    92 	{

    93 	e->id = NULL;

    94 	e->name = NULL;

    95 	e->rsa_meth = NULL;

    96 	e->dsa_meth = NULL;

    97 	e->dh_meth = NULL;

    98 	e->rand_meth = NULL;

    99 	e->store_meth = NULL;

   100 	e->ciphers = NULL;

   101 	e->digests = NULL;

   102 	e->destroy = NULL;

   103 	e->init = NULL;

   104 	e->finish = NULL;

   105 	e->ctrl = NULL;

   106 	e->load_privkey = NULL;

   107 	e->load_pubkey = NULL;

   108 	e->cmd_defns = NULL;

   109 	e->flags = 0;

   110 	}

   111 

   112 EXPORT_C int engine_free_util(ENGINE *e, int locked)

   113 	{

   114 	int i;

   115 

   116 	if(e == NULL)

   117 		{

   118 		ENGINEerr(ENGINE_F_ENGINE_FREE_UTIL,

   119 			ERR_R_PASSED_NULL_PARAMETER);

   120 		return 0;

   121 		}

   122 	if(locked)

   123 		i = CRYPTO_add(&e->struct_ref,-1,CRYPTO_LOCK_ENGINE);

   124 	else

   125 		i = --e->struct_ref;

   126 	engine_ref_debug(e, 0, -1)

   127 	if (i > 0) return 1;

   128 #ifdef REF_CHECK

   129 	if (i < 0)

   130 		{

   131 		fprintf(stderr,"ENGINE_free, bad structural reference count\n");

   132 		abort();

   133 		}

   134 #endif

   135 	/* Give the ENGINE a chance to do any structural cleanup corresponding

   136 	 * to allocation it did in its constructor (eg. unload error strings) */

   137 	if(e->destroy)

   138 		e->destroy(e);

   139 	CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);

   140 	OPENSSL_free(e);

   141 	return 1;

   142 	}

   143 

   144 EXPORT_C int ENGINE_free(ENGINE *e)

   145 	{

   146 	return engine_free_util(e, 1);

   147 	}

   148 

   149 /* Cleanup stuff */

   150 

   151 /* ENGINE_cleanup() is coded such that anything that does work that will need

   152  * cleanup can register a "cleanup" callback here. That way we don't get linker

   153  * bloat by referring to all *possible* cleanups, but any linker bloat into code

   154  * "X" will cause X's cleanup function to end up here. */

   155 #ifndef EMULATOR 

   156 static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;

   157 #else

   158 GET_STATIC_VAR_FROM_TLS(cleanup_stack,eng_lib,STACK_OF(ENGINE_CLEANUP_ITEM) *)

   159 #define cleanup_stack (*GET_WSD_VAR_NAME(cleanup_stack,eng_lib, s)())

   160 #endif

   161 static int int_cleanup_check(int create)

   162 	{

   163 	if(cleanup_stack) return 1;

   164 	if(!create) return 0;

   165 	cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();

   166 	return (cleanup_stack ? 1 : 0);

   167 	}

   168 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)

   169 	{

   170 	ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(

   171 					ENGINE_CLEANUP_ITEM));

   172 	if(!item) return NULL;

   173 	item->cb = cb;

   174 	return item;

   175 	}

   176 EXPORT_C void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)

   177 	{

   178 	ENGINE_CLEANUP_ITEM *item;

   179 	if(!int_cleanup_check(1)) return;

   180 	item = int_cleanup_item(cb);

   181 	if(item)

   182 		sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);

   183 	}

   184 EXPORT_C void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)

   185 	{

   186 	ENGINE_CLEANUP_ITEM *item;

   187 	if(!int_cleanup_check(1)) return;

   188 	item = int_cleanup_item(cb);

   189 	if(item)

   190 		sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);

   191 	}

   192 /* The API function that performs all cleanup */

   193 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)

   194 	{

   195 	(*(item->cb))();

   196 	OPENSSL_free(item);

   197 	}

   198 EXPORT_C void ENGINE_cleanup(void)

   199 	{

   200 	if(int_cleanup_check(0))

   201 		{

   202 		sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,

   203 			engine_cleanup_cb_free);

   204 		cleanup_stack = NULL;

   205 		}

   206 	/* FIXME: This should be handled (somehow) through RAND, eg. by it

   207 	 * registering a cleanup callback. */

   208 	RAND_set_rand_method(NULL);

   209 	}

   210 

   211 /* Now the "ex_data" support */

   212 

   213 EXPORT_C int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,

   214 		CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)

   215 	{

   216 	return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp,

   217 			new_func, dup_func, free_func);

   218 	}

   219 

   220 EXPORT_C int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)

   221 	{

   222 	return(CRYPTO_set_ex_data(&e->ex_data, idx, arg));

   223 	}

   224 

   225 EXPORT_C void *ENGINE_get_ex_data(const ENGINE *e, int idx)

   226 	{

   227 	return(CRYPTO_get_ex_data(&e->ex_data, idx));

   228 	}

   229 

   230 /* Functions to get/set an ENGINE's elements - mainly to avoid exposing the

   231  * ENGINE structure itself. */

   232 

   233 EXPORT_C int ENGINE_set_id(ENGINE *e, const char *id)

   234 	{

   235 	if(id == NULL)

   236 		{

   237 		ENGINEerr(ENGINE_F_ENGINE_SET_ID,

   238 			ERR_R_PASSED_NULL_PARAMETER);

   239 		return 0;

   240 		}

   241 	e->id = id;

   242 	return 1;

   243 	}

   244 

   245 EXPORT_C int ENGINE_set_name(ENGINE *e, const char *name)

   246 	{

   247 	if(name == NULL)

   248 		{

   249 		ENGINEerr(ENGINE_F_ENGINE_SET_NAME,

   250 			ERR_R_PASSED_NULL_PARAMETER);

   251 		return 0;

   252 		}

   253 	e->name = name;

   254 	return 1;

   255 	}

   256 

   257 EXPORT_C int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)

   258 	{

   259 	e->destroy = destroy_f;

   260 	return 1;

   261 	}

   262 

   263 EXPORT_C int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)

   264 	{

   265 	e->init = init_f;

   266 	return 1;

   267 	}

   268 

   269 EXPORT_C int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)

   270 	{

   271 	e->finish = finish_f;

   272 	return 1;

   273 	}

   274 

   275 EXPORT_C int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)

   276 	{

   277 	e->ctrl = ctrl_f;

   278 	return 1;

   279 	}

   280 

   281 EXPORT_C int ENGINE_set_flags(ENGINE *e, int flags)

   282 	{

   283 	e->flags = flags;

   284 	return 1;

   285 	}

   286 

   287 EXPORT_C int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)

   288 	{

   289 	e->cmd_defns = defns;

   290 	return 1;

   291 	}

   292 

   293 EXPORT_C const char *ENGINE_get_id(const ENGINE *e)

   294 	{

   295 	return e->id;

   296 	}

   297 

   298 EXPORT_C const char *ENGINE_get_name(const ENGINE *e)

   299 	{

   300 	return e->name;

   301 	}

   302 

   303 EXPORT_C ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)

   304 	{

   305 	return e->destroy;

   306 	}

   307 

   308 EXPORT_C ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)

   309 	{

   310 	return e->init;

   311 	}

   312 

   313 EXPORT_C ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)

   314 	{

   315 	return e->finish;

   316 	}

   317 

   318 EXPORT_C ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)

   319 	{

   320 	return e->ctrl;

   321 	}

   322 

   323 EXPORT_C int ENGINE_get_flags(const ENGINE *e)

   324 	{

   325 	return e->flags;

   326 	}

   327 

   328 EXPORT_C const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)

   329 	{

   330 	return e->cmd_defns;

   331 	}

   332 

   333 /* eng_lib.o is pretty much linked into anything that touches ENGINE already, so

   334  * put the "static_state" hack here. */

   335 #ifndef EMULATOR

   336 static int internal_static_hack = 0;

   337 #else

   338 GET_STATIC_VAR_FROM_TLS(internal_static_hack,eng_lib,int)

   339 #define internal_static_hack (*GET_WSD_VAR_NAME(internal_static_hack,eng_lib, s)())

   340 #endif

   341 

   342 EXPORT_C void *ENGINE_get_static_state(void)

   343 	{

   344 	return &internal_static_hack;

   345 	}