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