2 * Written by Stephen Henson (steve@openssl.org) for the OpenSSL project
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).
61 #include <openssl/crypto.h>
62 #include "internal/cryptlib.h"
63 #include "internal/conf.h"
64 #include "internal/dso.h"
65 #include <openssl/x509.h>
67 #define DSO_mod_init_name "OPENSSL_init"
68 #define DSO_mod_finish_name "OPENSSL_finish"
71 * This structure contains a data about supported modules. entries in this
72 * table correspond to either dynamic or static modules.
75 struct conf_module_st
{
76 /* DSO of this module or NULL if static */
78 /* Name of the module */
83 conf_finish_func
*finish
;
84 /* Number of successfully initialized modules */
90 * This structure contains information about modules that have been
91 * successfully initialized. There may be more than one entry for a given
95 struct conf_imodule_st
{
103 static STACK_OF(CONF_MODULE
) *supported_modules
= NULL
;
104 static STACK_OF(CONF_IMODULE
) *initialized_modules
= NULL
;
106 static void module_free(CONF_MODULE
*md
);
107 static void module_finish(CONF_IMODULE
*imod
);
108 static int module_run(const CONF
*cnf
, char *name
, char *value
,
109 unsigned long flags
);
110 static CONF_MODULE
*module_add(DSO
*dso
, const char *name
,
111 conf_init_func
*ifunc
,
112 conf_finish_func
*ffunc
);
113 static CONF_MODULE
*module_find(char *name
);
114 static int module_init(CONF_MODULE
*pmod
, char *name
, char *value
,
116 static CONF_MODULE
*module_load_dso(const CONF
*cnf
, char *name
, char *value
);
118 /* Main function: load modules from a CONF structure */
120 int CONF_modules_load(const CONF
*cnf
, const char *appname
,
123 STACK_OF(CONF_VALUE
) *values
;
125 char *vsection
= NULL
;
133 vsection
= NCONF_get_string(cnf
, NULL
, appname
);
135 if (!appname
|| (!vsection
&& (flags
& CONF_MFLAGS_DEFAULT_SECTION
)))
136 vsection
= NCONF_get_string(cnf
, NULL
, "openssl_conf");
143 values
= NCONF_get_section(cnf
, vsection
);
148 for (i
= 0; i
< sk_CONF_VALUE_num(values
); i
++) {
149 vl
= sk_CONF_VALUE_value(values
, i
);
150 ret
= module_run(cnf
, vl
->name
, vl
->value
, flags
);
152 if (!(flags
& CONF_MFLAGS_IGNORE_ERRORS
))
160 int CONF_modules_load_file(const char *filename
, const char *appname
,
166 conf
= NCONF_new(NULL
);
170 if (filename
== NULL
) {
171 file
= CONF_get1_default_config_file();
175 file
= (char *)filename
;
177 if (NCONF_load(conf
, file
, NULL
) <= 0) {
178 if ((flags
& CONF_MFLAGS_IGNORE_MISSING_FILE
) &&
179 (ERR_GET_REASON(ERR_peek_last_error()) == CONF_R_NO_SUCH_FILE
)) {
186 ret
= CONF_modules_load(conf
, appname
, flags
);
189 if (filename
== NULL
)
196 static int module_run(const CONF
*cnf
, char *name
, char *value
,
202 md
= module_find(name
);
204 /* Module not found: try to load DSO */
205 if (!md
&& !(flags
& CONF_MFLAGS_NO_DSO
))
206 md
= module_load_dso(cnf
, name
, value
);
209 if (!(flags
& CONF_MFLAGS_SILENT
)) {
210 CONFerr(CONF_F_MODULE_RUN
, CONF_R_UNKNOWN_MODULE_NAME
);
211 ERR_add_error_data(2, "module=", name
);
216 ret
= module_init(md
, name
, value
, cnf
);
219 if (!(flags
& CONF_MFLAGS_SILENT
)) {
220 char rcode
[DECIMAL_SIZE(ret
) + 1];
221 CONFerr(CONF_F_MODULE_RUN
, CONF_R_MODULE_INITIALIZATION_ERROR
);
222 BIO_snprintf(rcode
, sizeof rcode
, "%-8d", ret
);
223 ERR_add_error_data(6, "module=", name
, ", value=", value
,
224 ", retcode=", rcode
);
231 /* Load a module from a DSO */
232 static CONF_MODULE
*module_load_dso(const CONF
*cnf
, char *name
, char *value
)
235 conf_init_func
*ifunc
;
236 conf_finish_func
*ffunc
;
240 /* Look for alternative path in module section */
241 path
= NCONF_get_string(cnf
, value
, "path");
246 dso
= DSO_load(NULL
, path
, NULL
, 0);
248 errcode
= CONF_R_ERROR_LOADING_DSO
;
251 ifunc
= (conf_init_func
*)DSO_bind_func(dso
, DSO_mod_init_name
);
253 errcode
= CONF_R_MISSING_INIT_FUNCTION
;
256 ffunc
= (conf_finish_func
*)DSO_bind_func(dso
, DSO_mod_finish_name
);
257 /* All OK, add module */
258 md
= module_add(dso
, name
, ifunc
, ffunc
);
267 CONFerr(CONF_F_MODULE_LOAD_DSO
, errcode
);
268 ERR_add_error_data(4, "module=", name
, ", path=", path
);
272 /* add module to list */
273 static CONF_MODULE
*module_add(DSO
*dso
, const char *name
,
274 conf_init_func
*ifunc
, conf_finish_func
*ffunc
)
276 CONF_MODULE
*tmod
= NULL
;
277 if (supported_modules
== NULL
)
278 supported_modules
= sk_CONF_MODULE_new_null();
279 if (supported_modules
== NULL
)
281 tmod
= OPENSSL_zalloc(sizeof(*tmod
));
286 tmod
->name
= OPENSSL_strdup(name
);
288 tmod
->finish
= ffunc
;
290 if (!sk_CONF_MODULE_push(supported_modules
, tmod
)) {
299 * Find a module from the list. We allow module names of the form
300 * modname.XXXX to just search for modname to allow the same module to be
301 * initialized more than once.
304 static CONF_MODULE
*module_find(char *name
)
309 p
= strrchr(name
, '.');
314 nchar
= strlen(name
);
316 for (i
= 0; i
< sk_CONF_MODULE_num(supported_modules
); i
++) {
317 tmod
= sk_CONF_MODULE_value(supported_modules
, i
);
318 if (strncmp(tmod
->name
, name
, nchar
) == 0)
326 /* initialize a module */
327 static int module_init(CONF_MODULE
*pmod
, char *name
, char *value
,
332 CONF_IMODULE
*imod
= NULL
;
334 /* Otherwise add initialized module to list */
335 imod
= OPENSSL_malloc(sizeof(*imod
));
340 imod
->name
= OPENSSL_strdup(name
);
341 imod
->value
= OPENSSL_strdup(value
);
342 imod
->usr_data
= NULL
;
344 if (!imod
->name
|| !imod
->value
)
347 /* Try to initialize module */
349 ret
= pmod
->init(imod
, cnf
);
351 /* Error occurred, exit */
356 if (initialized_modules
== NULL
) {
357 initialized_modules
= sk_CONF_IMODULE_new_null();
358 if (!initialized_modules
) {
359 CONFerr(CONF_F_MODULE_INIT
, ERR_R_MALLOC_FAILURE
);
364 if (!sk_CONF_IMODULE_push(initialized_modules
, imod
)) {
365 CONFerr(CONF_F_MODULE_INIT
, ERR_R_MALLOC_FAILURE
);
375 /* We've started the module so we'd better finish it */
376 if (pmod
->finish
&& init_called
)
381 OPENSSL_free(imod
->name
);
382 OPENSSL_free(imod
->value
);
391 * Unload any dynamic modules that have a link count of zero: i.e. have no
392 * active initialized modules. If 'all' is set then all modules are unloaded
393 * including static ones.
396 void CONF_modules_unload(int all
)
400 CONF_modules_finish();
401 /* unload modules in reverse order */
402 for (i
= sk_CONF_MODULE_num(supported_modules
) - 1; i
>= 0; i
--) {
403 md
= sk_CONF_MODULE_value(supported_modules
, i
);
404 /* If static or in use and 'all' not set ignore it */
405 if (((md
->links
> 0) || !md
->dso
) && !all
)
407 /* Since we're working in reverse this is OK */
408 (void)sk_CONF_MODULE_delete(supported_modules
, i
);
411 if (sk_CONF_MODULE_num(supported_modules
) == 0) {
412 sk_CONF_MODULE_free(supported_modules
);
413 supported_modules
= NULL
;
417 /* unload a single module */
418 static void module_free(CONF_MODULE
*md
)
421 OPENSSL_free(md
->name
);
425 /* finish and free up all modules instances */
427 void CONF_modules_finish(void)
430 while (sk_CONF_IMODULE_num(initialized_modules
) > 0) {
431 imod
= sk_CONF_IMODULE_pop(initialized_modules
);
434 sk_CONF_IMODULE_free(initialized_modules
);
435 initialized_modules
= NULL
;
438 /* finish a module instance */
440 static void module_finish(CONF_IMODULE
*imod
)
444 if (imod
->pmod
->finish
)
445 imod
->pmod
->finish(imod
);
447 OPENSSL_free(imod
->name
);
448 OPENSSL_free(imod
->value
);
452 /* Add a static module to OpenSSL */
454 int CONF_module_add(const char *name
, conf_init_func
*ifunc
,
455 conf_finish_func
*ffunc
)
457 if (module_add(NULL
, name
, ifunc
, ffunc
))
463 void conf_modules_free_intern(void)
465 CONF_modules_finish();
466 CONF_modules_unload(1);
469 /* Utility functions */
471 const char *CONF_imodule_get_name(const CONF_IMODULE
*md
)
476 const char *CONF_imodule_get_value(const CONF_IMODULE
*md
)
481 void *CONF_imodule_get_usr_data(const CONF_IMODULE
*md
)
486 void CONF_imodule_set_usr_data(CONF_IMODULE
*md
, void *usr_data
)
488 md
->usr_data
= usr_data
;
491 CONF_MODULE
*CONF_imodule_get_module(const CONF_IMODULE
*md
)
496 unsigned long CONF_imodule_get_flags(const CONF_IMODULE
*md
)
501 void CONF_imodule_set_flags(CONF_IMODULE
*md
, unsigned long flags
)
506 void *CONF_module_get_usr_data(CONF_MODULE
*pmod
)
508 return pmod
->usr_data
;
511 void CONF_module_set_usr_data(CONF_MODULE
*pmod
, void *usr_data
)
513 pmod
->usr_data
= usr_data
;
516 /* Return default config file name */
518 char *CONF_get1_default_config_file(void)
523 file
= getenv("OPENSSL_CONF");
525 return OPENSSL_strdup(file
);
527 len
= strlen(X509_get_default_cert_area());
528 #ifndef OPENSSL_SYS_VMS
531 len
+= strlen(OPENSSL_CONF
);
533 file
= OPENSSL_malloc(len
+ 1);
537 OPENSSL_strlcpy(file
, X509_get_default_cert_area(), len
+ 1);
538 #ifndef OPENSSL_SYS_VMS
539 OPENSSL_strlcat(file
, "/", len
+ 1);
541 OPENSSL_strlcat(file
, OPENSSL_CONF
, len
+ 1);
547 * This function takes a list separated by 'sep' and calls the callback
548 * function giving the start and length of each member optionally stripping
549 * leading and trailing whitespace. This can be used to parse comma separated
553 int CONF_parse_list(const char *list_
, int sep
, int nospc
,
554 int (*list_cb
) (const char *elem
, int len
, void *usr
),
558 const char *lstart
, *tmpend
, *p
;
561 CONFerr(CONF_F_CONF_PARSE_LIST
, CONF_R_LIST_CANNOT_BE_NULL
);
568 while (*lstart
&& isspace((unsigned char)*lstart
))
571 p
= strchr(lstart
, sep
);
572 if (p
== lstart
|| !*lstart
)
573 ret
= list_cb(NULL
, 0, arg
);
578 tmpend
= lstart
+ strlen(lstart
) - 1;
580 while (isspace((unsigned char)*tmpend
))
583 ret
= list_cb(lstart
, tmpend
- lstart
+ 1, arg
);