Line data Source code
1 : /* crypto/engine/eng_list.c */
2 : /*
3 : * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
4 : * 2000.
5 : */
6 : /* ====================================================================
7 : * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
8 : *
9 : * Redistribution and use in source and binary forms, with or without
10 : * modification, are permitted provided that the following conditions
11 : * are met:
12 : *
13 : * 1. Redistributions of source code must retain the above copyright
14 : * notice, this list of conditions and the following disclaimer.
15 : *
16 : * 2. Redistributions in binary form must reproduce the above copyright
17 : * notice, this list of conditions and the following disclaimer in
18 : * the documentation and/or other materials provided with the
19 : * distribution.
20 : *
21 : * 3. All advertising materials mentioning features or use of this
22 : * software must display the following acknowledgment:
23 : * "This product includes software developed by the OpenSSL Project
24 : * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 : *
26 : * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 : * endorse or promote products derived from this software without
28 : * prior written permission. For written permission, please contact
29 : * licensing@OpenSSL.org.
30 : *
31 : * 5. Products derived from this software may not be called "OpenSSL"
32 : * nor may "OpenSSL" appear in their names without prior written
33 : * permission of the OpenSSL Project.
34 : *
35 : * 6. Redistributions of any form whatsoever must retain the following
36 : * acknowledgment:
37 : * "This product includes software developed by the OpenSSL Project
38 : * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 : *
40 : * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 : * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 : * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 : * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 : * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 : * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 : * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 : * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 : * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 : * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 : * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 : * OF THE POSSIBILITY OF SUCH DAMAGE.
52 : * ====================================================================
53 : *
54 : * This product includes cryptographic software written by Eric Young
55 : * (eay@cryptsoft.com). This product includes software written by Tim
56 : * Hudson (tjh@cryptsoft.com).
57 : *
58 : */
59 : /* ====================================================================
60 : * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
61 : * ECDH support in OpenSSL originally developed by
62 : * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
63 : */
64 :
65 : #include "eng_int.h"
66 :
67 : /*
68 : * The linked-list of pointers to engine types. engine_list_head incorporates
69 : * an implicit structural reference but engine_list_tail does not - the
70 : * latter is a computational niceity and only points to something that is
71 : * already pointed to by its predecessor in the list (or engine_list_head
72 : * itself). In the same way, the use of the "prev" pointer in each ENGINE is
73 : * to save excessive list iteration, it doesn't correspond to an extra
74 : * structural reference. Hence, engine_list_head, and each non-null "next"
75 : * pointer account for the list itself assuming exactly 1 structural
76 : * reference on each list member.
77 : */
78 : static ENGINE *engine_list_head = NULL;
79 : static ENGINE *engine_list_tail = NULL;
80 :
81 : /*
82 : * This cleanup function is only needed internally. If it should be called,
83 : * we register it with the "ENGINE_cleanup()" stack to be called during
84 : * cleanup.
85 : */
86 :
87 0 : static void engine_list_cleanup(void)
88 : {
89 0 : ENGINE *iterator = engine_list_head;
90 :
91 0 : while (iterator != NULL) {
92 0 : ENGINE_remove(iterator);
93 0 : iterator = engine_list_head;
94 : }
95 0 : return;
96 : }
97 :
98 : /*
99 : * These static functions starting with a lower case "engine_" always take
100 : * place when CRYPTO_LOCK_ENGINE has been locked up.
101 : */
102 0 : static int engine_list_add(ENGINE *e)
103 : {
104 : int conflict = 0;
105 : ENGINE *iterator = NULL;
106 :
107 0 : if (e == NULL) {
108 0 : ENGINEerr(ENGINE_F_ENGINE_LIST_ADD, ERR_R_PASSED_NULL_PARAMETER);
109 0 : return 0;
110 : }
111 0 : iterator = engine_list_head;
112 0 : while (iterator && !conflict) {
113 0 : conflict = (strcmp(iterator->id, e->id) == 0);
114 0 : iterator = iterator->next;
115 : }
116 0 : if (conflict) {
117 0 : ENGINEerr(ENGINE_F_ENGINE_LIST_ADD, ENGINE_R_CONFLICTING_ENGINE_ID);
118 0 : return 0;
119 : }
120 0 : if (engine_list_head == NULL) {
121 : /* We are adding to an empty list. */
122 0 : if (engine_list_tail) {
123 0 : ENGINEerr(ENGINE_F_ENGINE_LIST_ADD, ENGINE_R_INTERNAL_LIST_ERROR);
124 0 : return 0;
125 : }
126 0 : engine_list_head = e;
127 0 : e->prev = NULL;
128 : /*
129 : * The first time the list allocates, we should register the cleanup.
130 : */
131 0 : engine_cleanup_add_last(engine_list_cleanup);
132 : } else {
133 : /* We are adding to the tail of an existing list. */
134 0 : if ((engine_list_tail == NULL) || (engine_list_tail->next != NULL)) {
135 0 : ENGINEerr(ENGINE_F_ENGINE_LIST_ADD, ENGINE_R_INTERNAL_LIST_ERROR);
136 0 : return 0;
137 : }
138 0 : engine_list_tail->next = e;
139 0 : e->prev = engine_list_tail;
140 : }
141 : /*
142 : * Having the engine in the list assumes a structural reference.
143 : */
144 0 : e->struct_ref++;
145 : engine_ref_debug(e, 0, 1)
146 : /* However it came to be, e is the last item in the list. */
147 0 : engine_list_tail = e;
148 0 : e->next = NULL;
149 0 : return 1;
150 : }
151 :
152 0 : static int engine_list_remove(ENGINE *e)
153 : {
154 : ENGINE *iterator;
155 :
156 0 : if (e == NULL) {
157 0 : ENGINEerr(ENGINE_F_ENGINE_LIST_REMOVE, ERR_R_PASSED_NULL_PARAMETER);
158 0 : return 0;
159 : }
160 : /* We need to check that e is in our linked list! */
161 0 : iterator = engine_list_head;
162 0 : while (iterator && (iterator != e))
163 0 : iterator = iterator->next;
164 0 : if (iterator == NULL) {
165 0 : ENGINEerr(ENGINE_F_ENGINE_LIST_REMOVE,
166 : ENGINE_R_ENGINE_IS_NOT_IN_LIST);
167 0 : return 0;
168 : }
169 : /* un-link e from the chain. */
170 0 : if (e->next)
171 0 : e->next->prev = e->prev;
172 0 : if (e->prev)
173 0 : e->prev->next = e->next;
174 : /* Correct our head/tail if necessary. */
175 0 : if (engine_list_head == e)
176 0 : engine_list_head = e->next;
177 0 : if (engine_list_tail == e)
178 0 : engine_list_tail = e->prev;
179 0 : engine_free_util(e, 0);
180 0 : return 1;
181 : }
182 :
183 : /* Get the first/last "ENGINE" type available. */
184 0 : ENGINE *ENGINE_get_first(void)
185 : {
186 : ENGINE *ret;
187 :
188 0 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
189 0 : ret = engine_list_head;
190 0 : if (ret) {
191 0 : ret->struct_ref++;
192 : engine_ref_debug(ret, 0, 1)
193 : }
194 0 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
195 0 : return ret;
196 : }
197 :
198 0 : ENGINE *ENGINE_get_last(void)
199 : {
200 : ENGINE *ret;
201 :
202 0 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
203 0 : ret = engine_list_tail;
204 0 : if (ret) {
205 0 : ret->struct_ref++;
206 : engine_ref_debug(ret, 0, 1)
207 : }
208 0 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
209 0 : return ret;
210 : }
211 :
212 : /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
213 0 : ENGINE *ENGINE_get_next(ENGINE *e)
214 : {
215 : ENGINE *ret = NULL;
216 0 : if (e == NULL) {
217 0 : ENGINEerr(ENGINE_F_ENGINE_GET_NEXT, ERR_R_PASSED_NULL_PARAMETER);
218 0 : return 0;
219 : }
220 0 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
221 0 : ret = e->next;
222 0 : if (ret) {
223 : /* Return a valid structural refernce to the next ENGINE */
224 0 : ret->struct_ref++;
225 : engine_ref_debug(ret, 0, 1)
226 : }
227 0 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
228 : /* Release the structural reference to the previous ENGINE */
229 0 : ENGINE_free(e);
230 0 : return ret;
231 : }
232 :
233 0 : ENGINE *ENGINE_get_prev(ENGINE *e)
234 : {
235 : ENGINE *ret = NULL;
236 0 : if (e == NULL) {
237 0 : ENGINEerr(ENGINE_F_ENGINE_GET_PREV, ERR_R_PASSED_NULL_PARAMETER);
238 0 : return 0;
239 : }
240 0 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
241 0 : ret = e->prev;
242 0 : if (ret) {
243 : /* Return a valid structural reference to the next ENGINE */
244 0 : ret->struct_ref++;
245 : engine_ref_debug(ret, 0, 1)
246 : }
247 0 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
248 : /* Release the structural reference to the previous ENGINE */
249 0 : ENGINE_free(e);
250 0 : return ret;
251 : }
252 :
253 : /* Add another "ENGINE" type into the list. */
254 0 : int ENGINE_add(ENGINE *e)
255 : {
256 : int to_return = 1;
257 0 : if (e == NULL) {
258 0 : ENGINEerr(ENGINE_F_ENGINE_ADD, ERR_R_PASSED_NULL_PARAMETER);
259 0 : return 0;
260 : }
261 0 : if ((e->id == NULL) || (e->name == NULL)) {
262 0 : ENGINEerr(ENGINE_F_ENGINE_ADD, ENGINE_R_ID_OR_NAME_MISSING);
263 : }
264 0 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
265 0 : if (!engine_list_add(e)) {
266 0 : ENGINEerr(ENGINE_F_ENGINE_ADD, ENGINE_R_INTERNAL_LIST_ERROR);
267 : to_return = 0;
268 : }
269 0 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
270 0 : return to_return;
271 : }
272 :
273 : /* Remove an existing "ENGINE" type from the array. */
274 0 : int ENGINE_remove(ENGINE *e)
275 : {
276 : int to_return = 1;
277 0 : if (e == NULL) {
278 0 : ENGINEerr(ENGINE_F_ENGINE_REMOVE, ERR_R_PASSED_NULL_PARAMETER);
279 0 : return 0;
280 : }
281 0 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
282 0 : if (!engine_list_remove(e)) {
283 0 : ENGINEerr(ENGINE_F_ENGINE_REMOVE, ENGINE_R_INTERNAL_LIST_ERROR);
284 : to_return = 0;
285 : }
286 0 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
287 0 : return to_return;
288 : }
289 :
290 0 : static void engine_cpy(ENGINE *dest, const ENGINE *src)
291 : {
292 0 : dest->id = src->id;
293 0 : dest->name = src->name;
294 : #ifndef OPENSSL_NO_RSA
295 0 : dest->rsa_meth = src->rsa_meth;
296 : #endif
297 : #ifndef OPENSSL_NO_DSA
298 0 : dest->dsa_meth = src->dsa_meth;
299 : #endif
300 : #ifndef OPENSSL_NO_DH
301 0 : dest->dh_meth = src->dh_meth;
302 : #endif
303 : #ifndef OPENSSL_NO_ECDH
304 0 : dest->ecdh_meth = src->ecdh_meth;
305 : #endif
306 : #ifndef OPENSSL_NO_ECDSA
307 0 : dest->ecdsa_meth = src->ecdsa_meth;
308 : #endif
309 0 : dest->rand_meth = src->rand_meth;
310 0 : dest->store_meth = src->store_meth;
311 0 : dest->ciphers = src->ciphers;
312 0 : dest->digests = src->digests;
313 0 : dest->pkey_meths = src->pkey_meths;
314 0 : dest->destroy = src->destroy;
315 0 : dest->init = src->init;
316 0 : dest->finish = src->finish;
317 0 : dest->ctrl = src->ctrl;
318 0 : dest->load_privkey = src->load_privkey;
319 0 : dest->load_pubkey = src->load_pubkey;
320 0 : dest->cmd_defns = src->cmd_defns;
321 0 : dest->flags = src->flags;
322 0 : }
323 :
324 0 : ENGINE *ENGINE_by_id(const char *id)
325 : {
326 : ENGINE *iterator;
327 : char *load_dir = NULL;
328 0 : if (id == NULL) {
329 0 : ENGINEerr(ENGINE_F_ENGINE_BY_ID, ERR_R_PASSED_NULL_PARAMETER);
330 0 : return NULL;
331 : }
332 0 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
333 0 : iterator = engine_list_head;
334 0 : while (iterator && (strcmp(id, iterator->id) != 0))
335 0 : iterator = iterator->next;
336 0 : if (iterator) {
337 : /*
338 : * We need to return a structural reference. If this is an ENGINE
339 : * type that returns copies, make a duplicate - otherwise increment
340 : * the existing ENGINE's reference count.
341 : */
342 0 : if (iterator->flags & ENGINE_FLAGS_BY_ID_COPY) {
343 0 : ENGINE *cp = ENGINE_new();
344 0 : if (!cp)
345 : iterator = NULL;
346 : else {
347 0 : engine_cpy(cp, iterator);
348 : iterator = cp;
349 : }
350 : } else {
351 0 : iterator->struct_ref++;
352 : engine_ref_debug(iterator, 0, 1)
353 : }
354 : }
355 0 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
356 : #if 0
357 : if (iterator == NULL) {
358 : ENGINEerr(ENGINE_F_ENGINE_BY_ID, ENGINE_R_NO_SUCH_ENGINE);
359 : ERR_add_error_data(2, "id=", id);
360 : }
361 : return iterator;
362 : #else
363 : /* EEK! Experimental code starts */
364 0 : if (iterator)
365 : return iterator;
366 : /*
367 : * Prevent infinite recusrion if we're looking for the dynamic engine.
368 : */
369 0 : if (strcmp(id, "dynamic")) {
370 : # ifdef OPENSSL_SYS_VMS
371 : if ((load_dir = getenv("OPENSSL_ENGINES")) == 0)
372 : load_dir = "SSLROOT:[ENGINES]";
373 : # else
374 0 : if ((load_dir = getenv("OPENSSL_ENGINES")) == 0)
375 : load_dir = ENGINESDIR;
376 : # endif
377 0 : iterator = ENGINE_by_id("dynamic");
378 0 : if (!iterator || !ENGINE_ctrl_cmd_string(iterator, "ID", id, 0) ||
379 0 : !ENGINE_ctrl_cmd_string(iterator, "DIR_LOAD", "2", 0) ||
380 0 : !ENGINE_ctrl_cmd_string(iterator, "DIR_ADD",
381 0 : load_dir, 0) ||
382 0 : !ENGINE_ctrl_cmd_string(iterator, "LIST_ADD", "1", 0) ||
383 0 : !ENGINE_ctrl_cmd_string(iterator, "LOAD", NULL, 0))
384 : goto notfound;
385 : return iterator;
386 : }
387 : notfound:
388 0 : ENGINE_free(iterator);
389 0 : ENGINEerr(ENGINE_F_ENGINE_BY_ID, ENGINE_R_NO_SUCH_ENGINE);
390 0 : ERR_add_error_data(2, "id=", id);
391 0 : return NULL;
392 : /* EEK! Experimental code ends */
393 : #endif
394 : }
395 :
396 0 : int ENGINE_up_ref(ENGINE *e)
397 : {
398 0 : if (e == NULL) {
399 0 : ENGINEerr(ENGINE_F_ENGINE_UP_REF, ERR_R_PASSED_NULL_PARAMETER);
400 0 : return 0;
401 : }
402 0 : CRYPTO_add(&e->struct_ref, 1, CRYPTO_LOCK_ENGINE);
403 0 : return 1;
404 : }
|
