1 /* eng_cnf.c */
2 /* Written by Stephen Henson (shenson@bigfoot.com) for the OpenSSL
3 * project 2001.
4 */
5 /* ====================================================================
6 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
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
18 * distribution.
19 *
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/)"
24 *
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.
29 *
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.
33 *
34 * 6. Redistributions of any form whatsoever must retain the following
35 * acknowledgment:
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38 *
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 * ====================================================================
52 *
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).
56 *
57 */
58
59 /*
60 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
61 * Use is subject to license terms.
62 */
63
64 #pragma ident "%Z%%M% %I% %E% SMI"
65
66 #include "eng_int.h"
67 #include <openssl/conf.h>
68
69 /* #define ENGINE_CONF_DEBUG */
70
71 /* ENGINE config module */
72
skip_dot(char * name)73 static char *skip_dot(char *name)
74 {
75 char *p;
76 p = strchr(name, '.');
77 if (p)
78 return p + 1;
79 return name;
80 }
81
82 static STACK_OF(ENGINE) *initialized_engines = NULL;
83
int_engine_init(ENGINE * e)84 static int int_engine_init(ENGINE *e)
85 {
86 if (!ENGINE_init(e))
87 return 0;
88 if (!initialized_engines)
89 initialized_engines = sk_ENGINE_new_null();
90 if (!initialized_engines || !sk_ENGINE_push(initialized_engines, e))
91 {
92 ENGINE_finish(e);
93 return 0;
94 }
95 return 1;
96 }
97
98
int_engine_configure(char * name,char * value,const CONF * cnf)99 static int int_engine_configure(char *name, char *value, const CONF *cnf)
100 {
101 int i;
102 int ret = 0;
103 long do_init = -1;
104 STACK_OF(CONF_VALUE) *ecmds;
105 CONF_VALUE *ecmd;
106 char *ctrlname, *ctrlvalue;
107 ENGINE *e = NULL;
108 name = skip_dot(name);
109 #ifdef ENGINE_CONF_DEBUG
110 fprintf(stderr, "Configuring engine %s\n", name);
111 #endif
112 /* Value is a section containing ENGINE commands */
113 ecmds = NCONF_get_section(cnf, value);
114
115 if (!ecmds)
116 {
117 ENGINEerr(ENGINE_F_INT_ENGINE_CONFIGURE, ENGINE_R_ENGINE_SECTION_ERROR);
118 return 0;
119 }
120
121 for (i = 0; i < sk_CONF_VALUE_num(ecmds); i++)
122 {
123 ecmd = sk_CONF_VALUE_value(ecmds, i);
124 ctrlname = skip_dot(ecmd->name);
125 ctrlvalue = ecmd->value;
126 #ifdef ENGINE_CONF_DEBUG
127 fprintf(stderr, "ENGINE conf: doing ctrl(%s,%s)\n", ctrlname, ctrlvalue);
128 #endif
129
130 /* First handle some special pseudo ctrls */
131
132 /* Override engine name to use */
133 if (!strcmp(ctrlname, "engine_id"))
134 name = ctrlvalue;
135 /* Load a dynamic ENGINE */
136 else if (!strcmp(ctrlname, "dynamic_path"))
137 {
138 #ifdef SOLARIS_OPENSSL
139 /*
140 * Dynamic engines must be disabled until signature
141 * verification is implemented.
142 */
143 goto err;
144 #endif /* SOLARIS_OPENSSL */
145 e = ENGINE_by_id("dynamic");
146 if (!e)
147 goto err;
148 if (!ENGINE_ctrl_cmd_string(e, "SO_PATH", ctrlvalue, 0))
149 goto err;
150 if (!ENGINE_ctrl_cmd_string(e, "LIST_ADD", "2", 0))
151 goto err;
152 if (!ENGINE_ctrl_cmd_string(e, "LOAD", NULL, 0))
153 goto err;
154 }
155 /* ... add other pseudos here ... */
156 else
157 {
158 /* At this point we need an ENGINE structural reference
159 * if we don't already have one.
160 */
161 if (!e)
162 {
163 e = ENGINE_by_id(name);
164 if (!e)
165 return 0;
166 }
167 /* Allow "EMPTY" to mean no value: this allows a valid
168 * "value" to be passed to ctrls of type NO_INPUT
169 */
170 if (!strcmp(ctrlvalue, "EMPTY"))
171 ctrlvalue = NULL;
172 if (!strcmp(ctrlname, "init"))
173 {
174 if (!NCONF_get_number_e(cnf, value, "init", &do_init))
175 goto err;
176 if (do_init == 1)
177 {
178 if (!int_engine_init(e))
179 goto err;
180 }
181 else if (do_init != 0)
182 {
183 ENGINEerr(ENGINE_F_INT_ENGINE_CONFIGURE, ENGINE_R_INVALID_INIT_VALUE);
184 goto err;
185 }
186 }
187 else if (!strcmp(ctrlname, "default_algorithms"))
188 {
189 if (!ENGINE_set_default_string(e, ctrlvalue))
190 goto err;
191 }
192 else if (!ENGINE_ctrl_cmd_string(e,
193 ctrlname, ctrlvalue, 0))
194 return 0;
195 }
196
197
198
199 }
200 if (e && (do_init == -1) && !int_engine_init(e))
201 goto err;
202 ret = 1;
203 err:
204 if (e)
205 ENGINE_free(e);
206 return ret;
207 }
208
209
int_engine_module_init(CONF_IMODULE * md,const CONF * cnf)210 static int int_engine_module_init(CONF_IMODULE *md, const CONF *cnf)
211 {
212 STACK_OF(CONF_VALUE) *elist;
213 CONF_VALUE *cval;
214 int i;
215 #ifdef ENGINE_CONF_DEBUG
216 fprintf(stderr, "Called engine module: name %s, value %s\n",
217 CONF_imodule_get_name(md), CONF_imodule_get_value(md));
218 #endif
219 /* Value is a section containing ENGINEs to configure */
220 elist = NCONF_get_section(cnf, CONF_imodule_get_value(md));
221
222 if (!elist)
223 {
224 ENGINEerr(ENGINE_F_INT_ENGINE_MODULE_INIT, ENGINE_R_ENGINES_SECTION_ERROR);
225 return 0;
226 }
227
228 for (i = 0; i < sk_CONF_VALUE_num(elist); i++)
229 {
230 cval = sk_CONF_VALUE_value(elist, i);
231 if (!int_engine_configure(cval->name, cval->value, cnf))
232 return 0;
233 }
234
235 return 1;
236 }
237
int_engine_module_finish(CONF_IMODULE * md)238 static void int_engine_module_finish(CONF_IMODULE *md)
239 {
240 ENGINE *e;
241 while ((e = sk_ENGINE_pop(initialized_engines)))
242 ENGINE_finish(e);
243 sk_ENGINE_free(initialized_engines);
244 initialized_engines = NULL;
245 }
246
247
ENGINE_add_conf_module(void)248 void ENGINE_add_conf_module(void)
249 {
250 CONF_module_add("engines",
251 int_engine_module_init,
252 int_engine_module_finish);
253 }
254