Update contrib.
2 /* Written by Stephen Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
59 © Portions copyright (c) 2006 Nokia Corporation. All rights reserved.
63 #include <openssl/crypto.h>
65 #include <openssl/conf.h>
66 #include <openssl/dso.h>
67 #include <openssl/x509.h>
68 #if (defined(SYMBIAN) && (defined(__WINSCW__) || defined(__WINS__)))
69 #include "libcrypto_wsd_macros.h"
70 #include "libcrypto_wsd.h"
74 #define DSO_mod_init_name "OPENSSL_init"
75 #define DSO_mod_finish_name "OPENSSL_finish"
78 /* This structure contains a data about supported modules.
79 * entries in this table correspond to either dynamic or
85 /* DSO of this module or NULL if static */
87 /* Name of the module */
92 conf_finish_func *finish;
93 /* Number of successfully initialized modules */
99 /* This structure contains information about modules that have been
100 * successfully initialized. There may be more than one entry for a
104 struct conf_imodule_st
113 static STACK_OF(CONF_MODULE) *supported_modules = NULL;
114 static STACK_OF(CONF_IMODULE) *initialized_modules = NULL;
116 GET_STATIC_VAR_FROM_TLS(supported_modules,conf_mod,STACK_OF(CONF_MODULE) *)
117 #define supported_modules (*GET_WSD_VAR_NAME(supported_modules,conf_mod, s)())
119 GET_STATIC_VAR_FROM_TLS(initialized_modules,conf_mod,STACK_OF(CONF_MODULE) *)
120 #define initialized_modules (*GET_WSD_VAR_NAME(initialized_modules,conf_mod, s)())
123 static void module_free(CONF_MODULE *md);
124 static void module_finish(CONF_IMODULE *imod);
125 static int module_run(const CONF *cnf, char *name, char *value,
126 unsigned long flags);
127 static CONF_MODULE *module_add(DSO *dso, const char *name,
128 conf_init_func *ifunc, conf_finish_func *ffunc);
129 static CONF_MODULE *module_find(char *name);
130 static int module_init(CONF_MODULE *pmod, char *name, char *value,
132 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
133 unsigned long flags);
135 /* Main function: load modules from a CONF structure */
137 EXPORT_C int CONF_modules_load(const CONF *cnf, const char *appname,
140 STACK_OF(CONF_VALUE) *values;
142 char *vsection = NULL;
151 vsection = NCONF_get_string(cnf, NULL, appname);
152 if (!appname || (!vsection && (flags & CONF_MFLAGS_DEFAULT_SECTION)))
153 vsection = NCONF_get_string(cnf, NULL, "openssl_conf");
161 values = NCONF_get_section(cnf, vsection);
166 for (i = 0; i < sk_CONF_VALUE_num(values); i++)
168 vl = sk_CONF_VALUE_value(values, i);
169 ret = module_run(cnf, vl->name, vl->value, flags);
171 if(!(flags & CONF_MFLAGS_IGNORE_ERRORS))
179 EXPORT_C int CONF_modules_load_file(const char *filename, const char *appname,
185 conf = NCONF_new(NULL);
189 if (filename == NULL)
191 file = CONF_get1_default_config_file();
196 file = (char *)filename;
198 if (NCONF_load(conf, file, NULL) <= 0)
200 if ((flags & CONF_MFLAGS_IGNORE_MISSING_FILE) &&
201 (ERR_GET_REASON(ERR_peek_last_error()) == CONF_R_NO_SUCH_FILE))
209 ret = CONF_modules_load(conf, appname, flags);
212 if (filename == NULL)
219 static int module_run(const CONF *cnf, char *name, char *value,
225 md = module_find(name);
227 /* Module not found: try to load DSO */
228 if (!md && !(flags & CONF_MFLAGS_NO_DSO))
229 md = module_load_dso(cnf, name, value, flags);
233 if (!(flags & CONF_MFLAGS_SILENT))
235 CONFerr(CONF_F_MODULE_RUN, CONF_R_UNKNOWN_MODULE_NAME);
236 ERR_add_error_data(2, "module=", name);
241 ret = module_init(md, name, value, cnf);
245 if (!(flags & CONF_MFLAGS_SILENT))
247 char rcode[DECIMAL_SIZE(ret)+1];
248 CONFerr(CONF_F_MODULE_RUN, CONF_R_MODULE_INITIALIZATION_ERROR);
249 BIO_snprintf(rcode, sizeof rcode, "%-8d", ret);
250 ERR_add_error_data(6, "module=", name, ", value=", value, ", retcode=", rcode);
257 /* Load a module from a DSO */
258 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
262 conf_init_func *ifunc;
263 conf_finish_func *ffunc;
267 /* Look for alternative path in module section */
268 path = NCONF_get_string(cnf, value, "path");
274 dso = DSO_load(NULL, path, NULL, 0);
277 errcode = CONF_R_ERROR_LOADING_DSO;
280 ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
283 errcode = CONF_R_MISSING_INIT_FUNCTION;
286 ffunc = (conf_finish_func *)DSO_bind_func(dso, DSO_mod_finish_name);
287 /* All OK, add module */
288 md = module_add(dso, name, ifunc, ffunc);
298 CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
299 ERR_add_error_data(4, "module=", name, ", path=", path);
303 /* add module to list */
304 static CONF_MODULE *module_add(DSO *dso, const char *name,
305 conf_init_func *ifunc, conf_finish_func *ffunc)
307 CONF_MODULE *tmod = NULL;
308 if (supported_modules == NULL)
309 supported_modules = sk_CONF_MODULE_new_null();
310 if (supported_modules == NULL)
312 tmod = OPENSSL_malloc(sizeof(CONF_MODULE));
317 tmod->name = BUF_strdup(name);
319 tmod->finish = ffunc;
322 if (!sk_CONF_MODULE_push(supported_modules, tmod))
331 /* Find a module from the list. We allow module names of the
332 * form modname.XXXX to just search for modname to allow the
333 * same module to be initialized more than once.
336 static CONF_MODULE *module_find(char *name)
341 p = strrchr(name, '.');
346 nchar = strlen(name);
348 for (i = 0; i < sk_CONF_MODULE_num(supported_modules); i++)
350 tmod = sk_CONF_MODULE_value(supported_modules, i);
351 if (!strncmp(tmod->name, name, nchar))
359 /* initialize a module */
360 static int module_init(CONF_MODULE *pmod, char *name, char *value,
365 CONF_IMODULE *imod = NULL;
367 /* Otherwise add initialized module to list */
368 imod = OPENSSL_malloc(sizeof(CONF_IMODULE));
373 imod->name = BUF_strdup(name);
374 imod->value = BUF_strdup(value);
375 imod->usr_data = NULL;
377 if (!imod->name || !imod->value)
380 /* Try to initialize module */
383 ret = pmod->init(imod, cnf);
385 /* Error occurred, exit */
390 if (initialized_modules == NULL)
392 initialized_modules = sk_CONF_IMODULE_new_null();
393 if (!initialized_modules)
395 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
400 if (!sk_CONF_IMODULE_push(initialized_modules, imod))
402 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
412 /* We've started the module so we'd better finish it */
413 if (pmod->finish && init_called)
420 OPENSSL_free(imod->name);
422 OPENSSL_free(imod->value);
430 /* Unload any dynamic modules that have a link count of zero:
431 * i.e. have no active initialized modules. If 'all' is set
432 * then all modules are unloaded including static ones.
435 EXPORT_C void CONF_modules_unload(int all)
439 CONF_modules_finish();
440 /* unload modules in reverse order */
441 for (i = sk_CONF_MODULE_num(supported_modules) - 1; i >= 0; i--)
443 md = sk_CONF_MODULE_value(supported_modules, i);
444 /* If static or in use and 'all' not set ignore it */
445 if (((md->links > 0) || !md->dso) && !all)
447 /* Since we're working in reverse this is OK */
448 (void)sk_CONF_MODULE_delete(supported_modules, i);
451 if (sk_CONF_MODULE_num(supported_modules) == 0)
453 sk_CONF_MODULE_free(supported_modules);
454 supported_modules = NULL;
458 /* unload a single module */
459 static void module_free(CONF_MODULE *md)
463 OPENSSL_free(md->name);
467 /* finish and free up all modules instances */
469 EXPORT_C void CONF_modules_finish(void)
472 while (sk_CONF_IMODULE_num(initialized_modules) > 0)
474 imod = sk_CONF_IMODULE_pop(initialized_modules);
477 sk_CONF_IMODULE_free(initialized_modules);
478 initialized_modules = NULL;
481 /* finish a module instance */
483 static void module_finish(CONF_IMODULE *imod)
485 if (imod->pmod->finish)
486 imod->pmod->finish(imod);
488 OPENSSL_free(imod->name);
489 OPENSSL_free(imod->value);
493 /* Add a static module to OpenSSL */
495 EXPORT_C int CONF_module_add(const char *name, conf_init_func *ifunc,
496 conf_finish_func *ffunc)
498 if (module_add(NULL, name, ifunc, ffunc))
504 EXPORT_C void CONF_modules_free(void)
506 CONF_modules_finish();
507 CONF_modules_unload(1);
510 /* Utility functions */
512 EXPORT_C const char *CONF_imodule_get_name(const CONF_IMODULE *md)
517 EXPORT_C const char *CONF_imodule_get_value(const CONF_IMODULE *md)
522 EXPORT_C void *CONF_imodule_get_usr_data(const CONF_IMODULE *md)
527 EXPORT_C void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data)
529 md->usr_data = usr_data;
532 EXPORT_C CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md)
537 EXPORT_C unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md)
542 EXPORT_C void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags)
547 EXPORT_C void *CONF_module_get_usr_data(CONF_MODULE *pmod)
549 return pmod->usr_data;
552 EXPORT_C void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data)
554 pmod->usr_data = usr_data;
557 /* Return default config file name */
559 EXPORT_C char *CONF_get1_default_config_file(void)
564 file = getenv("OPENSSL_CONF");
566 return BUF_strdup(file);
568 len = strlen(X509_get_default_cert_area());
569 #ifndef OPENSSL_SYS_VMS
572 len += strlen(OPENSSL_CONF);
574 file = OPENSSL_malloc(len + 1);
578 BUF_strlcpy(file,X509_get_default_cert_area(),len + 1);
579 #ifndef OPENSSL_SYS_VMS
580 BUF_strlcat(file,"/",len + 1);
582 BUF_strlcat(file,OPENSSL_CONF,len + 1);
587 /* This function takes a list separated by 'sep' and calls the
588 * callback function giving the start and length of each member
589 * optionally stripping leading and trailing whitespace. This can
590 * be used to parse comma separated lists for example.
593 EXPORT_C int CONF_parse_list(const char *list_, int sep, int nospc,
594 int (*list_cb)(const char *elem, int len, void *usr), void *arg)
597 const char *lstart, *tmpend, *p;
604 while(*lstart && isspace((unsigned char)*lstart))
607 p = strchr(lstart, sep);
608 if (p == lstart || !*lstart)
609 ret = list_cb(NULL, 0, arg);
615 tmpend = lstart + strlen(lstart) - 1;
618 while(isspace((unsigned char)*tmpend))
621 ret = list_cb(lstart, tmpend - lstart + 1, arg);