lib/libcrypto/engine/eng_cnf.c

   1 /* $OpenBSD: eng_cnf.c,v 1.14 2017/01/29 17:49:23 beck 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                 ENGINEerror(ENGINE_R_ENGINE_SECTION_ERROR);
 119                 return 0;
 120         }
 121
 122         for (i = 0; i < sk_CONF_VALUE_num(ecmds); i++) {
 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",
 128                     ctrlname, ctrlvalue);
 129 #endif
 130
 131                 /* First handle some special pseudo ctrls */
 132
 133                 /* Override engine name to use */
 134                 if (!strcmp(ctrlname, "engine_id"))
 135                         name = ctrlvalue;
 136                 else if (!strcmp(ctrlname, "soft_load"))
 137                         soft = 1;
 138                 /* Load a dynamic ENGINE */
 139                 else if (!strcmp(ctrlname, "dynamic_path")) {
 140                         e = ENGINE_by_id("dynamic");
 141                         if (!e)
 142                                 goto err;
 143                         if (!ENGINE_ctrl_cmd_string(e, "SO_PATH", ctrlvalue, 0))
 144                                 goto err;
 145                         if (!ENGINE_ctrl_cmd_string(e, "LIST_ADD", "2", 0))
 146                                 goto err;
 147                         if (!ENGINE_ctrl_cmd_string(e, "LOAD", NULL, 0))
 148                                 goto err;
 149                 }
 150                 /* ... add other pseudos here ... */
 151                 else {
 152                         /* At this point we need an ENGINE structural reference
 153                          * if we don't already have one.
 154                          */
 155                         if (!e) {
 156                                 e = ENGINE_by_id(name);
 157                                 if (!e && soft) {
 158                                         ERR_clear_error();
 159                                         return 1;
 160                                 }
 161                                 if (!e)
 162                                         goto err;
 163                         }
 164                         /* Allow "EMPTY" to mean no value: this allows a valid
 165                          * "value" to be passed to ctrls of type NO_INPUT
 166                          */
 167                         if (!strcmp(ctrlvalue, "EMPTY"))
 168                                 ctrlvalue = NULL;
 169                         if (!strcmp(ctrlname, "init")) {
 170                                 if (!NCONF_get_number_e(cnf, value, "init",
 171                                     &do_init))
 172                                         goto err;
 173                                 if (do_init == 1) {
 174                                         if (!int_engine_init(e))
 175                                                 goto err;
 176                                 } else if (do_init != 0) {
 177                                         ENGINEerror(ENGINE_R_INVALID_INIT_VALUE);
 178                                         goto err;
 179                                 }
 180                         }
 181                         else if (!strcmp(ctrlname, "default_algorithms")) {
 182                                 if (!ENGINE_set_default_string(e, ctrlvalue))
 183                                         goto err;
 184                         } else if (!ENGINE_ctrl_cmd_string(e,
 185                                 ctrlname, ctrlvalue, 0))
 186                                 goto err;
 187                 }
 188         }
 189         if (e && (do_init == -1) && !int_engine_init(e)) {
 190                 ecmd = NULL;
 191                 goto err;
 192         }
 193         ret = 1;
 194
 195 err:
 196         if (ret != 1) {
 197                 ENGINEerror(ENGINE_R_ENGINE_CONFIGURATION_ERROR);
 198                 if (ecmd)
 199                         ERR_asprintf_error_data(
 200                             "section=%s, name=%s, value=%s",
 201                             ecmd->section, ecmd->name, ecmd->value);
 202         }
 203         if (e)
 204                 ENGINE_free(e);
 205         return ret;
 206 }
 207
 208
 209 static int
 210 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
 216 #ifdef ENGINE_CONF_DEBUG
 217         fprintf(stderr, "Called engine module: name %s, value %s\n",
 218             CONF_imodule_get_name(md), CONF_imodule_get_value(md));
 219 #endif
 220         /* Value is a section containing ENGINEs to configure */
 221         elist = NCONF_get_section(cnf, CONF_imodule_get_value(md));
 222
 223         if (!elist) {
 224                 ENGINEerror(ENGINE_R_ENGINES_SECTION_ERROR);
 225                 return 0;
 226         }
 227
 228         for (i = 0; i < sk_CONF_VALUE_num(elist); i++) {
 229                 cval = sk_CONF_VALUE_value(elist, i);
 230                 if (!int_engine_configure(cval->name, cval->value, cnf))
 231                         return 0;
 232         }
 233
 234         return 1;
 235 }
 236
 237 static void
 238 int_engine_module_finish(CONF_IMODULE *md)
 239 {
 240         ENGINE *e;
 241
 242         while ((e = sk_ENGINE_pop(initialized_engines)))
 243                 ENGINE_finish(e);
 244         sk_ENGINE_free(initialized_engines);
 245         initialized_engines = NULL;
 246 }
 247
 248 void
 249 ENGINE_add_conf_module(void)
 250 {
 251         CONF_module_add("engines", int_engine_module_init,
 252             int_engine_module_finish);
 253 }