/src/openssl/crypto/engine/eng_init.c
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Copyright 2001-2022 The OpenSSL Project Authors. All Rights Reserved. |
3 | | * |
4 | | * Licensed under the Apache License 2.0 (the "License"). You may not use |
5 | | * this file except in compliance with the License. You can obtain a copy |
6 | | * in the file LICENSE in the source distribution or at |
7 | | * https://www.openssl.org/source/license.html |
8 | | */ |
9 | | |
10 | | /* We need to use some engine deprecated APIs */ |
11 | | #define OPENSSL_SUPPRESS_DEPRECATED |
12 | | |
13 | | #include "internal/e_os.h" |
14 | | #include "eng_local.h" |
15 | | |
16 | | /* |
17 | | * Initialise an engine type for use (or up its functional reference count if |
18 | | * it's already in use). This version is only used internally. |
19 | | */ |
20 | | int engine_unlocked_init(ENGINE *e) |
21 | 0 | { |
22 | 0 | int to_return = 1; |
23 | |
|
24 | 0 | if ((e->funct_ref == 0) && e->init) |
25 | | /* |
26 | | * This is the first functional reference and the engine requires |
27 | | * initialisation so we do it now. |
28 | | */ |
29 | 0 | to_return = e->init(e); |
30 | 0 | if (to_return) { |
31 | 0 | int ref; |
32 | | |
33 | | /* |
34 | | * OK, we return a functional reference which is also a structural |
35 | | * reference. |
36 | | */ |
37 | 0 | if (!CRYPTO_UP_REF(&e->struct_ref, &ref, e->refcnt_lock)) { |
38 | 0 | e->finish(e); |
39 | 0 | return 0; |
40 | 0 | } |
41 | 0 | e->funct_ref++; |
42 | 0 | ENGINE_REF_PRINT(e, 0, 1); |
43 | 0 | ENGINE_REF_PRINT(e, 1, 1); |
44 | 0 | } |
45 | 0 | return to_return; |
46 | 0 | } |
47 | | |
48 | | /* |
49 | | * Free a functional reference to an engine type. This version is only used |
50 | | * internally. |
51 | | */ |
52 | | int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers) |
53 | 0 | { |
54 | 0 | int to_return = 1; |
55 | | |
56 | | /* |
57 | | * Reduce the functional reference count here so if it's the terminating |
58 | | * case, we can release the lock safely and call the finish() handler |
59 | | * without risk of a race. We get a race if we leave the count until |
60 | | * after and something else is calling "finish" at the same time - |
61 | | * there's a chance that both threads will together take the count from 2 |
62 | | * to 0 without either calling finish(). |
63 | | */ |
64 | 0 | e->funct_ref--; |
65 | 0 | ENGINE_REF_PRINT(e, 1, -1); |
66 | 0 | if ((e->funct_ref == 0) && e->finish) { |
67 | 0 | if (unlock_for_handlers) |
68 | 0 | CRYPTO_THREAD_unlock(global_engine_lock); |
69 | 0 | to_return = e->finish(e); |
70 | 0 | if (unlock_for_handlers) |
71 | 0 | if (!CRYPTO_THREAD_write_lock(global_engine_lock)) |
72 | 0 | return 0; |
73 | 0 | if (!to_return) |
74 | 0 | return 0; |
75 | 0 | } |
76 | 0 | REF_ASSERT_ISNT(e->funct_ref < 0); |
77 | | /* Release the structural reference too */ |
78 | 0 | if (!engine_free_util(e, 0)) { |
79 | 0 | ERR_raise(ERR_LIB_ENGINE, ENGINE_R_FINISH_FAILED); |
80 | 0 | return 0; |
81 | 0 | } |
82 | 0 | return to_return; |
83 | 0 | } |
84 | | |
85 | | /* The API (locked) version of "init" */ |
86 | | int ENGINE_init(ENGINE *e) |
87 | 0 | { |
88 | 0 | int ret; |
89 | 0 | if (e == NULL) { |
90 | 0 | ERR_raise(ERR_LIB_ENGINE, ERR_R_PASSED_NULL_PARAMETER); |
91 | 0 | return 0; |
92 | 0 | } |
93 | 0 | if (!RUN_ONCE(&engine_lock_init, do_engine_lock_init)) { |
94 | | /* Maybe this should be raised in do_engine_lock_init() */ |
95 | 0 | ERR_raise(ERR_LIB_ENGINE, ERR_R_CRYPTO_LIB); |
96 | 0 | return 0; |
97 | 0 | } |
98 | 0 | if (!CRYPTO_THREAD_write_lock(global_engine_lock)) |
99 | 0 | return 0; |
100 | 0 | ret = engine_unlocked_init(e); |
101 | 0 | CRYPTO_THREAD_unlock(global_engine_lock); |
102 | 0 | return ret; |
103 | 0 | } |
104 | | |
105 | | /* The API (locked) version of "finish" */ |
106 | | int ENGINE_finish(ENGINE *e) |
107 | 4 | { |
108 | 4 | int to_return = 1; |
109 | | |
110 | 4 | if (e == NULL) |
111 | 4 | return 1; |
112 | 0 | if (!CRYPTO_THREAD_write_lock(global_engine_lock)) |
113 | 0 | return 0; |
114 | 0 | to_return = engine_unlocked_finish(e, 1); |
115 | 0 | CRYPTO_THREAD_unlock(global_engine_lock); |
116 | 0 | if (!to_return) { |
117 | 0 | ERR_raise(ERR_LIB_ENGINE, ENGINE_R_FINISH_FAILED); |
118 | 0 | return 0; |
119 | 0 | } |
120 | 0 | return to_return; |
121 | 0 | } |