crypto/engine/eng_cnf.c

   1 /* eng_cnf.c */
   2 /*
   3  * Written by Stephen Henson (steve@openssl.org) for the OpenSSL project
   4  * 2001.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 2001 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59
  60 #include "eng_int.h"
  61 #include <openssl/conf.h>
  62
  63 /* #define ENGINE_CONF_DEBUG */
  64
  65 /* ENGINE config module */
  66
  67 static char *skip_dot(char *name)
  68 {
  69     char *p;
  70     p = strchr(name, '.');
  71     if (p)
  72         return p + 1;
  73     return name;
  74 }
  75
  76 static STACK_OF(ENGINE) *initialized_engines = NULL;
  77
  78 static int int_engine_init(ENGINE *e)
  79 {
  80     if (!ENGINE_init(e))
  81         return 0;
  82     if (!initialized_engines)
  83         initialized_engines = sk_ENGINE_new_null();
  84     if (!initialized_engines || !sk_ENGINE_push(initialized_engines, e)) {
  85         ENGINE_finish(e);
  86         return 0;
  87     }
  88     return 1;
  89 }
  90
  91 static int int_engine_configure(char *name, char *value, const CONF *cnf)
  92 {
  93     int i;
  94     int ret = 0;
  95     long do_init = -1;
  96     STACK_OF(CONF_VALUE) *ecmds;
  97     CONF_VALUE *ecmd = NULL;
  98     char *ctrlname, *ctrlvalue;
  99     ENGINE *e = NULL;
 100     int soft = 0;
 101
 102     name = skip_dot(name);
 103 #ifdef ENGINE_CONF_DEBUG
 104     fprintf(stderr, "Configuring engine %s\n", name);
 105 #endif
 106     /* Value is a section containing ENGINE commands */
 107     ecmds = NCONF_get_section(cnf, value);
 108
 109     if (!ecmds) {
 110         ENGINEerr(ENGINE_F_INT_ENGINE_CONFIGURE,
 111                   ENGINE_R_ENGINE_SECTION_ERROR);
 112         return 0;
 113     }
 114
 115     for (i = 0; i < sk_CONF_VALUE_num(ecmds); i++) {
 116         ecmd = sk_CONF_VALUE_value(ecmds, i);
 117         ctrlname = skip_dot(ecmd->name);
 118         ctrlvalue = ecmd->value;
 119 #ifdef ENGINE_CONF_DEBUG
 120         fprintf(stderr, "ENGINE conf: doing ctrl(%s,%s)\n", ctrlname,
 121                 ctrlvalue);
 122 #endif
 123
 124         /* First handle some special pseudo ctrls */
 125
 126         /* Override engine name to use */
 127         if (!strcmp(ctrlname, "engine_id"))
 128             name = ctrlvalue;
 129         else if (!strcmp(ctrlname, "soft_load"))
 130             soft = 1;
 131         /* Load a dynamic ENGINE */
 132         else if (!strcmp(ctrlname, "dynamic_path")) {
 133             e = ENGINE_by_id("dynamic");
 134             if (!e)
 135                 goto err;
 136             if (!ENGINE_ctrl_cmd_string(e, "SO_PATH", ctrlvalue, 0))
 137                 goto err;
 138             if (!ENGINE_ctrl_cmd_string(e, "LIST_ADD", "2", 0))
 139                 goto err;
 140             if (!ENGINE_ctrl_cmd_string(e, "LOAD", NULL, 0))
 141                 goto err;
 142         }
 143         /* ... add other pseudos here ... */
 144         else {
 145             /*
 146              * At this point we need an ENGINE structural reference if we
 147              * don't already have one.
 148              */
 149             if (!e) {
 150                 e = ENGINE_by_id(name);
 151                 if (!e && soft) {
 152                     ERR_clear_error();
 153                     return 1;
 154                 }
 155                 if (!e)
 156                     goto err;
 157             }
 158             /*
 159              * Allow "EMPTY" to mean no value: this allows a valid "value" to
 160              * be passed to ctrls of type NO_INPUT
 161              */
 162             if (!strcmp(ctrlvalue, "EMPTY"))
 163                 ctrlvalue = NULL;
 164             if (!strcmp(ctrlname, "init")) {
 165                 if (!NCONF_get_number_e(cnf, value, "init", &do_init))
 166                     goto err;
 167                 if (do_init == 1) {
 168                     if (!int_engine_init(e))
 169                         goto err;
 170                 } else if (do_init != 0) {
 171                     ENGINEerr(ENGINE_F_INT_ENGINE_CONFIGURE,
 172                               ENGINE_R_INVALID_INIT_VALUE);
 173                     goto err;
 174                 }
 175             } else if (!strcmp(ctrlname, "default_algorithms")) {
 176                 if (!ENGINE_set_default_string(e, ctrlvalue))
 177                     goto err;
 178             } else if (!ENGINE_ctrl_cmd_string(e, ctrlname, ctrlvalue, 0))
 179                 goto err;
 180         }
 181
 182     }
 183     if (e && (do_init == -1) && !int_engine_init(e)) {
 184         ecmd = NULL;
 185         goto err;
 186     }
 187     ret = 1;
 188  err:
 189     if (ret != 1) {
 190         ENGINEerr(ENGINE_F_INT_ENGINE_CONFIGURE,
 191                   ENGINE_R_ENGINE_CONFIGURATION_ERROR);
 192         if (ecmd)
 193             ERR_add_error_data(6, "section=", ecmd->section,
 194                                ", name=", ecmd->name,
 195                                ", value=", ecmd->value);
 196     }
 197     if (e)
 198         ENGINE_free(e);
 199     return ret;
 200 }
 201
 202 static int int_engine_module_init(CONF_IMODULE *md, const CONF *cnf)
 203 {
 204     STACK_OF(CONF_VALUE) *elist;
 205     CONF_VALUE *cval;
 206     int i;
 207 #ifdef ENGINE_CONF_DEBUG
 208     fprintf(stderr, "Called engine module: name %s, value %s\n",
 209             CONF_imodule_get_name(md), CONF_imodule_get_value(md));
 210 #endif
 211     /* Value is a section containing ENGINEs to configure */
 212     elist = NCONF_get_section(cnf, CONF_imodule_get_value(md));
 213
 214     if (!elist) {
 215         ENGINEerr(ENGINE_F_INT_ENGINE_MODULE_INIT,
 216                   ENGINE_R_ENGINES_SECTION_ERROR);
 217         return 0;
 218     }
 219
 220     for (i = 0; i < sk_CONF_VALUE_num(elist); i++) {
 221         cval = sk_CONF_VALUE_value(elist, i);
 222         if (!int_engine_configure(cval->name, cval->value, cnf))
 223             return 0;
 224     }
 225
 226     return 1;
 227 }
 228
 229 static void int_engine_module_finish(CONF_IMODULE *md)
 230 {
 231     ENGINE *e;
 232     while ((e = sk_ENGINE_pop(initialized_engines)))
 233         ENGINE_finish(e);
 234     sk_ENGINE_free(initialized_engines);
 235     initialized_engines = NULL;
 236 }
 237
 238 void ENGINE_add_conf_module(void)
 239 {
 240     CONF_module_add("engines",
 241                     int_engine_module_init, int_engine_module_finish);
 242 }