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