1*0Sstevel@tonic-gate /* crypto/engine/eng_init.c */ 2*0Sstevel@tonic-gate /* ==================================================================== 3*0Sstevel@tonic-gate * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved. 4*0Sstevel@tonic-gate * 5*0Sstevel@tonic-gate * Redistribution and use in source and binary forms, with or without 6*0Sstevel@tonic-gate * modification, are permitted provided that the following conditions 7*0Sstevel@tonic-gate * are met: 8*0Sstevel@tonic-gate * 9*0Sstevel@tonic-gate * 1. Redistributions of source code must retain the above copyright 10*0Sstevel@tonic-gate * notice, this list of conditions and the following disclaimer. 11*0Sstevel@tonic-gate * 12*0Sstevel@tonic-gate * 2. Redistributions in binary form must reproduce the above copyright 13*0Sstevel@tonic-gate * notice, this list of conditions and the following disclaimer in 14*0Sstevel@tonic-gate * the documentation and/or other materials provided with the 15*0Sstevel@tonic-gate * distribution. 16*0Sstevel@tonic-gate * 17*0Sstevel@tonic-gate * 3. All advertising materials mentioning features or use of this 18*0Sstevel@tonic-gate * software must display the following acknowledgment: 19*0Sstevel@tonic-gate * "This product includes software developed by the OpenSSL Project 20*0Sstevel@tonic-gate * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 21*0Sstevel@tonic-gate * 22*0Sstevel@tonic-gate * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 23*0Sstevel@tonic-gate * endorse or promote products derived from this software without 24*0Sstevel@tonic-gate * prior written permission. For written permission, please contact 25*0Sstevel@tonic-gate * licensing@OpenSSL.org. 26*0Sstevel@tonic-gate * 27*0Sstevel@tonic-gate * 5. Products derived from this software may not be called "OpenSSL" 28*0Sstevel@tonic-gate * nor may "OpenSSL" appear in their names without prior written 29*0Sstevel@tonic-gate * permission of the OpenSSL Project. 30*0Sstevel@tonic-gate * 31*0Sstevel@tonic-gate * 6. Redistributions of any form whatsoever must retain the following 32*0Sstevel@tonic-gate * acknowledgment: 33*0Sstevel@tonic-gate * "This product includes software developed by the OpenSSL Project 34*0Sstevel@tonic-gate * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 35*0Sstevel@tonic-gate * 36*0Sstevel@tonic-gate * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 37*0Sstevel@tonic-gate * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 38*0Sstevel@tonic-gate * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 39*0Sstevel@tonic-gate * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 40*0Sstevel@tonic-gate * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 41*0Sstevel@tonic-gate * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 42*0Sstevel@tonic-gate * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 43*0Sstevel@tonic-gate * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 44*0Sstevel@tonic-gate * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 45*0Sstevel@tonic-gate * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 46*0Sstevel@tonic-gate * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 47*0Sstevel@tonic-gate * OF THE POSSIBILITY OF SUCH DAMAGE. 48*0Sstevel@tonic-gate * ==================================================================== 49*0Sstevel@tonic-gate * 50*0Sstevel@tonic-gate * This product includes cryptographic software written by Eric Young 51*0Sstevel@tonic-gate * (eay@cryptsoft.com). This product includes software written by Tim 52*0Sstevel@tonic-gate * Hudson (tjh@cryptsoft.com). 53*0Sstevel@tonic-gate * 54*0Sstevel@tonic-gate */ 55*0Sstevel@tonic-gate 56*0Sstevel@tonic-gate #include <openssl/crypto.h> 57*0Sstevel@tonic-gate #include "cryptlib.h" 58*0Sstevel@tonic-gate #include "eng_int.h" 59*0Sstevel@tonic-gate #include <openssl/engine.h> 60*0Sstevel@tonic-gate 61*0Sstevel@tonic-gate /* Initialise a engine type for use (or up its functional reference count 62*0Sstevel@tonic-gate * if it's already in use). This version is only used internally. */ 63*0Sstevel@tonic-gate int engine_unlocked_init(ENGINE *e) 64*0Sstevel@tonic-gate { 65*0Sstevel@tonic-gate int to_return = 1; 66*0Sstevel@tonic-gate 67*0Sstevel@tonic-gate if((e->funct_ref == 0) && e->init) 68*0Sstevel@tonic-gate /* This is the first functional reference and the engine 69*0Sstevel@tonic-gate * requires initialisation so we do it now. */ 70*0Sstevel@tonic-gate to_return = e->init(e); 71*0Sstevel@tonic-gate if(to_return) 72*0Sstevel@tonic-gate { 73*0Sstevel@tonic-gate /* OK, we return a functional reference which is also a 74*0Sstevel@tonic-gate * structural reference. */ 75*0Sstevel@tonic-gate e->struct_ref++; 76*0Sstevel@tonic-gate e->funct_ref++; 77*0Sstevel@tonic-gate engine_ref_debug(e, 0, 1) 78*0Sstevel@tonic-gate engine_ref_debug(e, 1, 1) 79*0Sstevel@tonic-gate } 80*0Sstevel@tonic-gate return to_return; 81*0Sstevel@tonic-gate } 82*0Sstevel@tonic-gate 83*0Sstevel@tonic-gate /* Free a functional reference to a engine type. This version is only used 84*0Sstevel@tonic-gate * internally. */ 85*0Sstevel@tonic-gate int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers) 86*0Sstevel@tonic-gate { 87*0Sstevel@tonic-gate int to_return = 1; 88*0Sstevel@tonic-gate 89*0Sstevel@tonic-gate /* Reduce the functional reference count here so if it's the terminating 90*0Sstevel@tonic-gate * case, we can release the lock safely and call the finish() handler 91*0Sstevel@tonic-gate * without risk of a race. We get a race if we leave the count until 92*0Sstevel@tonic-gate * after and something else is calling "finish" at the same time - 93*0Sstevel@tonic-gate * there's a chance that both threads will together take the count from 94*0Sstevel@tonic-gate * 2 to 0 without either calling finish(). */ 95*0Sstevel@tonic-gate e->funct_ref--; 96*0Sstevel@tonic-gate engine_ref_debug(e, 1, -1); 97*0Sstevel@tonic-gate if((e->funct_ref == 0) && e->finish) 98*0Sstevel@tonic-gate { 99*0Sstevel@tonic-gate if(unlock_for_handlers) 100*0Sstevel@tonic-gate CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE); 101*0Sstevel@tonic-gate to_return = e->finish(e); 102*0Sstevel@tonic-gate if(unlock_for_handlers) 103*0Sstevel@tonic-gate CRYPTO_w_lock(CRYPTO_LOCK_ENGINE); 104*0Sstevel@tonic-gate if(!to_return) 105*0Sstevel@tonic-gate return 0; 106*0Sstevel@tonic-gate } 107*0Sstevel@tonic-gate #ifdef REF_CHECK 108*0Sstevel@tonic-gate if(e->funct_ref < 0) 109*0Sstevel@tonic-gate { 110*0Sstevel@tonic-gate fprintf(stderr,"ENGINE_finish, bad functional reference count\n"); 111*0Sstevel@tonic-gate abort(); 112*0Sstevel@tonic-gate } 113*0Sstevel@tonic-gate #endif 114*0Sstevel@tonic-gate /* Release the structural reference too */ 115*0Sstevel@tonic-gate if(!engine_free_util(e, 0)) 116*0Sstevel@tonic-gate { 117*0Sstevel@tonic-gate ENGINEerr(ENGINE_F_ENGINE_FINISH,ENGINE_R_FINISH_FAILED); 118*0Sstevel@tonic-gate return 0; 119*0Sstevel@tonic-gate } 120*0Sstevel@tonic-gate return to_return; 121*0Sstevel@tonic-gate } 122*0Sstevel@tonic-gate 123*0Sstevel@tonic-gate /* The API (locked) version of "init" */ 124*0Sstevel@tonic-gate int ENGINE_init(ENGINE *e) 125*0Sstevel@tonic-gate { 126*0Sstevel@tonic-gate int ret; 127*0Sstevel@tonic-gate if(e == NULL) 128*0Sstevel@tonic-gate { 129*0Sstevel@tonic-gate ENGINEerr(ENGINE_F_ENGINE_INIT,ERR_R_PASSED_NULL_PARAMETER); 130*0Sstevel@tonic-gate return 0; 131*0Sstevel@tonic-gate } 132*0Sstevel@tonic-gate CRYPTO_w_lock(CRYPTO_LOCK_ENGINE); 133*0Sstevel@tonic-gate ret = engine_unlocked_init(e); 134*0Sstevel@tonic-gate CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE); 135*0Sstevel@tonic-gate return ret; 136*0Sstevel@tonic-gate } 137*0Sstevel@tonic-gate 138*0Sstevel@tonic-gate /* The API (locked) version of "finish" */ 139*0Sstevel@tonic-gate int ENGINE_finish(ENGINE *e) 140*0Sstevel@tonic-gate { 141*0Sstevel@tonic-gate int to_return = 1; 142*0Sstevel@tonic-gate 143*0Sstevel@tonic-gate if(e == NULL) 144*0Sstevel@tonic-gate { 145*0Sstevel@tonic-gate ENGINEerr(ENGINE_F_ENGINE_FINISH,ERR_R_PASSED_NULL_PARAMETER); 146*0Sstevel@tonic-gate return 0; 147*0Sstevel@tonic-gate } 148*0Sstevel@tonic-gate CRYPTO_w_lock(CRYPTO_LOCK_ENGINE); 149*0Sstevel@tonic-gate to_return = engine_unlocked_finish(e, 1); 150*0Sstevel@tonic-gate CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE); 151*0Sstevel@tonic-gate if(!to_return) 152*0Sstevel@tonic-gate { 153*0Sstevel@tonic-gate ENGINEerr(ENGINE_F_ENGINE_FINISH,ENGINE_R_FINISH_FAILED); 154*0Sstevel@tonic-gate return 0; 155*0Sstevel@tonic-gate } 156*0Sstevel@tonic-gate return to_return; 157*0Sstevel@tonic-gate } 158