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