1 /* $OpenBSD: eng_cnf.c,v 1.12 2014/07/10 13:58:22 jsing Exp $ */
2 /* Written by Stephen Henson (steve@openssl.org) 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 #include <string.h>
60 
61 #include <openssl/err.h>
62 
63 #include "eng_int.h"
64 #include <openssl/conf.h>
65 
66 /* #define ENGINE_CONF_DEBUG */
67 
68 /* ENGINE config module */
69 
70 static char *
71 skip_dot(char *name)
72 {
73 	char *p;
74 
75 	p = strchr(name, '.');
76 	if (p)
77 		return p + 1;
78 	return name;
79 }
80 
81 static STACK_OF(ENGINE) *initialized_engines = NULL;
82 
83 static int
84 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 		ENGINE_finish(e);
92 		return 0;
93 	}
94 	return 1;
95 }
96 
97 
98 static int
99 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 = NULL;
106 	char *ctrlname, *ctrlvalue;
107 	ENGINE *e = NULL;
108 	int soft = 0;
109 
110 	name = skip_dot(name);
111 #ifdef ENGINE_CONF_DEBUG
112 	fprintf(stderr, "Configuring engine %s\n", name);
113 #endif
114 	/* Value is a section containing ENGINE commands */
115 	ecmds = NCONF_get_section(cnf, value);
116 
117 	if (!ecmds) {
118 		ENGINEerr(ENGINE_F_INT_ENGINE_CONFIGURE,
119 		    ENGINE_R_ENGINE_SECTION_ERROR);
120 		return 0;
121 	}
122 
123 	for (i = 0; i < sk_CONF_VALUE_num(ecmds); i++) {
124 		ecmd = sk_CONF_VALUE_value(ecmds, i);
125 		ctrlname = skip_dot(ecmd->name);
126 		ctrlvalue = ecmd->value;
127 #ifdef ENGINE_CONF_DEBUG
128 		fprintf(stderr, "ENGINE conf: doing ctrl(%s,%s)\n",
129 		    ctrlname, ctrlvalue);
130 #endif
131 
132 		/* First handle some special pseudo ctrls */
133 
134 		/* Override engine name to use */
135 		if (!strcmp(ctrlname, "engine_id"))
136 			name = ctrlvalue;
137 		else if (!strcmp(ctrlname, "soft_load"))
138 			soft = 1;
139 		/* Load a dynamic ENGINE */
140 		else if (!strcmp(ctrlname, "dynamic_path")) {
141 			e = ENGINE_by_id("dynamic");
142 			if (!e)
143 				goto err;
144 			if (!ENGINE_ctrl_cmd_string(e, "SO_PATH", ctrlvalue, 0))
145 				goto err;
146 			if (!ENGINE_ctrl_cmd_string(e, "LIST_ADD", "2", 0))
147 				goto err;
148 			if (!ENGINE_ctrl_cmd_string(e, "LOAD", NULL, 0))
149 				goto err;
150 		}
151 		/* ... add other pseudos here ... */
152 		else {
153 			/* At this point we need an ENGINE structural reference
154 			 * if we don't already have one.
155 			 */
156 			if (!e) {
157 				e = ENGINE_by_id(name);
158 				if (!e && soft) {
159 					ERR_clear_error();
160 					return 1;
161 				}
162 				if (!e)
163 					goto err;
164 			}
165 			/* Allow "EMPTY" to mean no value: this allows a valid
166 			 * "value" to be passed to ctrls of type NO_INPUT
167 		 	 */
168 			if (!strcmp(ctrlvalue, "EMPTY"))
169 				ctrlvalue = NULL;
170 			if (!strcmp(ctrlname, "init")) {
171 				if (!NCONF_get_number_e(cnf, value, "init",
172 				    &do_init))
173 					goto err;
174 				if (do_init == 1) {
175 					if (!int_engine_init(e))
176 						goto err;
177 				} else if (do_init != 0) {
178 					ENGINEerr(ENGINE_F_INT_ENGINE_CONFIGURE,
179 					    ENGINE_R_INVALID_INIT_VALUE);
180 					goto err;
181 				}
182 			}
183 			else if (!strcmp(ctrlname, "default_algorithms")) {
184 				if (!ENGINE_set_default_string(e, ctrlvalue))
185 					goto err;
186 			} else if (!ENGINE_ctrl_cmd_string(e,
187 				ctrlname, ctrlvalue, 0))
188 				goto err;
189 		}
190 	}
191 	if (e && (do_init == -1) && !int_engine_init(e)) {
192 		ecmd = NULL;
193 		goto err;
194 	}
195 	ret = 1;
196 
197 err:
198 	if (ret != 1) {
199 		ENGINEerr(ENGINE_F_INT_ENGINE_CONFIGURE,
200 		    ENGINE_R_ENGINE_CONFIGURATION_ERROR);
201 		if (ecmd)
202 			ERR_asprintf_error_data(
203 			    "section=%s, name=%s, value=%s",
204 			    ecmd->section, ecmd->name, ecmd->value);
205 	}
206 	if (e)
207 		ENGINE_free(e);
208 	return ret;
209 }
210 
211 
212 static int
213 int_engine_module_init(CONF_IMODULE *md, const CONF *cnf)
214 {
215 	STACK_OF(CONF_VALUE) *elist;
216 	CONF_VALUE *cval;
217 	int i;
218 
219 #ifdef ENGINE_CONF_DEBUG
220 	fprintf(stderr, "Called engine module: name %s, value %s\n",
221 	    CONF_imodule_get_name(md), CONF_imodule_get_value(md));
222 #endif
223 	/* Value is a section containing ENGINEs to configure */
224 	elist = NCONF_get_section(cnf, CONF_imodule_get_value(md));
225 
226 	if (!elist) {
227 		ENGINEerr(ENGINE_F_INT_ENGINE_MODULE_INIT,
228 		    ENGINE_R_ENGINES_SECTION_ERROR);
229 		return 0;
230 	}
231 
232 	for (i = 0; i < sk_CONF_VALUE_num(elist); i++) {
233 		cval = sk_CONF_VALUE_value(elist, i);
234 		if (!int_engine_configure(cval->name, cval->value, cnf))
235 			return 0;
236 	}
237 
238 	return 1;
239 }
240 
241 static void
242 int_engine_module_finish(CONF_IMODULE *md)
243 {
244 	ENGINE *e;
245 
246 	while ((e = sk_ENGINE_pop(initialized_engines)))
247 		ENGINE_finish(e);
248 	sk_ENGINE_free(initialized_engines);
249 	initialized_engines = NULL;
250 }
251 
252 void
253 ENGINE_add_conf_module(void)
254 {
255 	CONF_module_add("engines", int_engine_module_init,
256 	    int_engine_module_finish);
257 }
258