eng_lib.c revision bdfb8ad83da0647e9b9a32792598e8ce7ba3ef4d
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#include "eng_int.h" 60#include <openssl/rand.h> 61 62/* The "new"/"free" stuff first */ 63 64ENGINE *ENGINE_new(void) 65 { 66 ENGINE *ret; 67 68 ret = (ENGINE *)OPENSSL_malloc(sizeof(ENGINE)); 69 if(ret == NULL) 70 { 71 ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE); 72 return NULL; 73 } 74 memset(ret, 0, sizeof(ENGINE)); 75 ret->struct_ref = 1; 76 engine_ref_debug(ret, 0, 1) 77 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data); 78 return ret; 79 } 80 81/* Placed here (close proximity to ENGINE_new) so that modifications to the 82 * elements of the ENGINE structure are more likely to be caught and changed 83 * here. */ 84void engine_set_all_null(ENGINE *e) 85 { 86 e->id = NULL; 87 e->name = NULL; 88 e->rsa_meth = NULL; 89 e->dsa_meth = NULL; 90 e->dh_meth = NULL; 91 e->rand_meth = NULL; 92 e->store_meth = NULL; 93 e->ciphers = NULL; 94 e->digests = NULL; 95 e->destroy = NULL; 96 e->init = NULL; 97 e->finish = NULL; 98 e->ctrl = NULL; 99 e->load_privkey = NULL; 100 e->load_pubkey = NULL; 101 e->cmd_defns = NULL; 102 e->flags = 0; 103 } 104 105int engine_free_util(ENGINE *e, int locked) 106 { 107 int i; 108 109 if(e == NULL) 110 { 111 ENGINEerr(ENGINE_F_ENGINE_FREE_UTIL, 112 ERR_R_PASSED_NULL_PARAMETER); 113 return 0; 114 } 115 if(locked) 116 i = CRYPTO_add(&e->struct_ref,-1,CRYPTO_LOCK_ENGINE); 117 else 118 i = --e->struct_ref; 119 engine_ref_debug(e, 0, -1) 120 if (i > 0) return 1; 121#ifdef REF_CHECK 122 if (i < 0) 123 { 124 fprintf(stderr,"ENGINE_free, bad structural reference count\n"); 125 abort(); 126 } 127#endif 128 /* Give the ENGINE a chance to do any structural cleanup corresponding 129 * to allocation it did in its constructor (eg. unload error strings) */ 130 if(e->destroy) 131 e->destroy(e); 132 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data); 133 OPENSSL_free(e); 134 return 1; 135 } 136 137int ENGINE_free(ENGINE *e) 138 { 139 return engine_free_util(e, 1); 140 } 141 142/* Cleanup stuff */ 143 144/* ENGINE_cleanup() is coded such that anything that does work that will need 145 * cleanup can register a "cleanup" callback here. That way we don't get linker 146 * bloat by referring to all *possible* cleanups, but any linker bloat into code 147 * "X" will cause X's cleanup function to end up here. */ 148static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL; 149static int int_cleanup_check(int create) 150 { 151 if(cleanup_stack) return 1; 152 if(!create) return 0; 153 cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null(); 154 return (cleanup_stack ? 1 : 0); 155 } 156static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb) 157 { 158 ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof( 159 ENGINE_CLEANUP_ITEM)); 160 if(!item) return NULL; 161 item->cb = cb; 162 return item; 163 } 164void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb) 165 { 166 ENGINE_CLEANUP_ITEM *item; 167 if(!int_cleanup_check(1)) return; 168 item = int_cleanup_item(cb); 169 if(item) 170 sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0); 171 } 172void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb) 173 { 174 ENGINE_CLEANUP_ITEM *item; 175 if(!int_cleanup_check(1)) return; 176 item = int_cleanup_item(cb); 177 if(item) 178 sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item); 179 } 180/* The API function that performs all cleanup */ 181static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item) 182 { 183 (*(item->cb))(); 184 OPENSSL_free(item); 185 } 186void ENGINE_cleanup(void) 187 { 188 if(int_cleanup_check(0)) 189 { 190 sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack, 191 engine_cleanup_cb_free); 192 cleanup_stack = NULL; 193 } 194 /* FIXME: This should be handled (somehow) through RAND, eg. by it 195 * registering a cleanup callback. */ 196 RAND_set_rand_method(NULL); 197 } 198 199/* Now the "ex_data" support */ 200 201int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 202 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func) 203 { 204 return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp, 205 new_func, dup_func, free_func); 206 } 207 208int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg) 209 { 210 return(CRYPTO_set_ex_data(&e->ex_data, idx, arg)); 211 } 212 213void *ENGINE_get_ex_data(const ENGINE *e, int idx) 214 { 215 return(CRYPTO_get_ex_data(&e->ex_data, idx)); 216 } 217 218/* Functions to get/set an ENGINE's elements - mainly to avoid exposing the 219 * ENGINE structure itself. */ 220 221int ENGINE_set_id(ENGINE *e, const char *id) 222 { 223 if(id == NULL) 224 { 225 ENGINEerr(ENGINE_F_ENGINE_SET_ID, 226 ERR_R_PASSED_NULL_PARAMETER); 227 return 0; 228 } 229 e->id = id; 230 return 1; 231 } 232 233int ENGINE_set_name(ENGINE *e, const char *name) 234 { 235 if(name == NULL) 236 { 237 ENGINEerr(ENGINE_F_ENGINE_SET_NAME, 238 ERR_R_PASSED_NULL_PARAMETER); 239 return 0; 240 } 241 e->name = name; 242 return 1; 243 } 244 245int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f) 246 { 247 e->destroy = destroy_f; 248 return 1; 249 } 250 251int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f) 252 { 253 e->init = init_f; 254 return 1; 255 } 256 257int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f) 258 { 259 e->finish = finish_f; 260 return 1; 261 } 262 263int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f) 264 { 265 e->ctrl = ctrl_f; 266 return 1; 267 } 268 269int ENGINE_set_flags(ENGINE *e, int flags) 270 { 271 e->flags = flags; 272 return 1; 273 } 274 275int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns) 276 { 277 e->cmd_defns = defns; 278 return 1; 279 } 280 281const char *ENGINE_get_id(const ENGINE *e) 282 { 283 return e->id; 284 } 285 286const char *ENGINE_get_name(const ENGINE *e) 287 { 288 return e->name; 289 } 290 291ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e) 292 { 293 return e->destroy; 294 } 295 296ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e) 297 { 298 return e->init; 299 } 300 301ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e) 302 { 303 return e->finish; 304 } 305 306ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e) 307 { 308 return e->ctrl; 309 } 310 311int ENGINE_get_flags(const ENGINE *e) 312 { 313 return e->flags; 314 } 315 316const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e) 317 { 318 return e->cmd_defns; 319 } 320 321/* eng_lib.o is pretty much linked into anything that touches ENGINE already, so 322 * put the "static_state" hack here. */ 323 324static int internal_static_hack = 0; 325 326void *ENGINE_get_static_state(void) 327 { 328 return &internal_static_hack; 329 } 330