crypto/provider_conf.c

   1 /*
   2  * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <string.h>
  11 #include <openssl/trace.h>
  12 #include <openssl/err.h>
  13 #include <openssl/conf.h>
  14 #include <openssl/safestack.h>
  15 #include <openssl/provider.h>
  16 #include "internal/provider.h"
  17 #include "internal/cryptlib.h"
  18 #include "provider_local.h"
  19
  20 DEFINE_STACK_OF(OSSL_PROVIDER)
  21
  22 /* PROVIDER config module */
  23
  24 typedef struct {
  25     CRYPTO_RWLOCK *lock;
  26     STACK_OF(OSSL_PROVIDER) *activated_providers;
  27 } PROVIDER_CONF_GLOBAL;
  28
  29 static void *prov_conf_ossl_ctx_new(OSSL_LIB_CTX *libctx)
  30 {
  31     PROVIDER_CONF_GLOBAL *pcgbl = OPENSSL_zalloc(sizeof(*pcgbl));
  32
  33     if (pcgbl == NULL)
  34         return NULL;
  35
  36     pcgbl->lock = CRYPTO_THREAD_lock_new();
  37     if (pcgbl->lock == NULL) {
  38         OPENSSL_free(pcgbl);
  39         return NULL;
  40     }
  41
  42     return pcgbl;
  43 }
  44
  45 static void prov_conf_ossl_ctx_free(void *vpcgbl)
  46 {
  47     PROVIDER_CONF_GLOBAL *pcgbl = vpcgbl;
  48
  49     sk_OSSL_PROVIDER_pop_free(pcgbl->activated_providers,
  50                               ossl_provider_free);
  51
  52     OSSL_TRACE(CONF, "Cleaned up providers\n");
  53     CRYPTO_THREAD_lock_free(pcgbl->lock);
  54     OPENSSL_free(pcgbl);
  55 }
  56
  57 static const OSSL_LIB_CTX_METHOD provider_conf_ossl_ctx_method = {
  58     /* Must be freed before the provider store is freed */
  59     OSSL_LIB_CTX_METHOD_PRIORITY_2,
  60     prov_conf_ossl_ctx_new,
  61     prov_conf_ossl_ctx_free,
  62 };
  63
  64 static const char *skip_dot(const char *name)
  65 {
  66     const char *p = strchr(name, '.');
  67
  68     if (p != NULL)
  69         return p + 1;
  70     return name;
  71 }
  72
  73 static int provider_conf_params(OSSL_PROVIDER *prov,
  74                                 OSSL_PROVIDER_INFO *provinfo,
  75                                 const char *name, const char *value,
  76                                 const CONF *cnf)
  77 {
  78     STACK_OF(CONF_VALUE) *sect;
  79     int ok = 1;
  80
  81     sect = NCONF_get_section(cnf, value);
  82     if (sect != NULL) {
  83         int i;
  84         char buffer[512];
  85         size_t buffer_len = 0;
  86
  87         OSSL_TRACE1(CONF, "Provider params: start section %s\n", value);
  88
  89         if (name != NULL) {
  90             OPENSSL_strlcpy(buffer, name, sizeof(buffer));
  91             OPENSSL_strlcat(buffer, ".", sizeof(buffer));
  92             buffer_len = strlen(buffer);
  93         }
  94
  95         for (i = 0; i < sk_CONF_VALUE_num(sect); i++) {
  96             CONF_VALUE *sectconf = sk_CONF_VALUE_value(sect, i);
  97
  98             if (buffer_len + strlen(sectconf->name) >= sizeof(buffer))
  99                 return 0;
 100             buffer[buffer_len] = '\0';
 101             OPENSSL_strlcat(buffer, sectconf->name, sizeof(buffer));
 102             if (!provider_conf_params(prov, provinfo, buffer, sectconf->value,
 103                                       cnf))
 104                 return 0;
 105         }
 106
 107         OSSL_TRACE1(CONF, "Provider params: finish section %s\n", value);
 108     } else {
 109         OSSL_TRACE2(CONF, "Provider params: %s = %s\n", name, value);
 110         if (prov != NULL)
 111             ok = ossl_provider_add_parameter(prov, name, value);
 112         else
 113             ok = ossl_provider_info_add_parameter(provinfo, name, value);
 114     }
 115
 116     return ok;
 117 }
 118
 119 static int prov_already_activated(const char *name,
 120                                   STACK_OF(OSSL_PROVIDER) *activated)
 121 {
 122     int i, max;
 123
 124     if (activated == NULL)
 125         return 0;
 126
 127     max = sk_OSSL_PROVIDER_num(activated);
 128     for (i = 0; i < max; i++) {
 129         OSSL_PROVIDER *tstprov = sk_OSSL_PROVIDER_value(activated, i);
 130
 131         if (strcmp(OSSL_PROVIDER_get0_name(tstprov), name) == 0) {
 132             return 1;
 133         }
 134     }
 135
 136     return 0;
 137 }
 138
 139 static int provider_conf_activate(OSSL_LIB_CTX *libctx, const char *name,
 140                                   const char *value, const char *path,
 141                                   int soft, const CONF *cnf)
 142 {
 143     PROVIDER_CONF_GLOBAL *pcgbl
 144         = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_PROVIDER_CONF_INDEX,
 145                                 &provider_conf_ossl_ctx_method);
 146     OSSL_PROVIDER *prov = NULL, *actual = NULL;
 147     int ok = 0;
 148
 149     if (pcgbl == NULL || !CRYPTO_THREAD_write_lock(pcgbl->lock)) {
 150         ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
 151         return 0;
 152     }
 153     if (!prov_already_activated(name, pcgbl->activated_providers)) {
 154         /*
 155         * There is an attempt to activate a provider, so we should disable
 156         * loading of fallbacks. Otherwise a misconfiguration could mean the
 157         * intended provider does not get loaded. Subsequent fetches could
 158         * then fallback to the default provider - which may be the wrong
 159         * thing.
 160         */
 161         if (!ossl_provider_disable_fallback_loading(libctx)) {
 162             CRYPTO_THREAD_unlock(pcgbl->lock);
 163             ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
 164             return 0;
 165         }
 166         prov = ossl_provider_find(libctx, name, 1);
 167         if (prov == NULL)
 168             prov = ossl_provider_new(libctx, name, NULL, 1);
 169         if (prov == NULL) {
 170             CRYPTO_THREAD_unlock(pcgbl->lock);
 171             if (soft)
 172                 ERR_clear_error();
 173             return 0;
 174         }
 175
 176         if (path != NULL)
 177             ossl_provider_set_module_path(prov, path);
 178
 179         ok = provider_conf_params(prov, NULL, NULL, value, cnf);
 180
 181         if (ok) {
 182             if (!ossl_provider_activate(prov, 1, 0)) {
 183                 ok = 0;
 184             } else if (!ossl_provider_add_to_store(prov, &actual, 0)) {
 185                 ossl_provider_deactivate(prov, 1);
 186                 ok = 0;
 187             } else if (actual != prov
 188                        && !ossl_provider_activate(actual, 1, 0)) {
 189                 ossl_provider_free(actual);
 190                 ok = 0;
 191             } else {
 192                 if (pcgbl->activated_providers == NULL)
 193                     pcgbl->activated_providers = sk_OSSL_PROVIDER_new_null();
 194                 if (pcgbl->activated_providers == NULL
 195                     || !sk_OSSL_PROVIDER_push(pcgbl->activated_providers,
 196                                               actual)) {
 197                     ossl_provider_deactivate(actual, 1);
 198                     ossl_provider_free(actual);
 199                     ok = 0;
 200                 } else {
 201                     ok = 1;
 202                 }
 203             }
 204         }
 205         if (!ok)
 206             ossl_provider_free(prov);
 207     }
 208     CRYPTO_THREAD_unlock(pcgbl->lock);
 209
 210     return ok;
 211 }
 212
 213 static int provider_conf_load(OSSL_LIB_CTX *libctx, const char *name,
 214                               const char *value, const CONF *cnf)
 215 {
 216     int i;
 217     STACK_OF(CONF_VALUE) *ecmds;
 218     int soft = 0;
 219     const char *path = NULL;
 220     long activate = 0;
 221     int ok = 0;
 222
 223     name = skip_dot(name);
 224     OSSL_TRACE1(CONF, "Configuring provider %s\n", name);
 225     /* Value is a section containing PROVIDER commands */
 226     ecmds = NCONF_get_section(cnf, value);
 227
 228     if (!ecmds) {
 229         ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_SECTION_ERROR,
 230                        "section=%s not found", value);
 231         return 0;
 232     }
 233
 234     /* Find the needed data first */
 235     for (i = 0; i < sk_CONF_VALUE_num(ecmds); i++) {
 236         CONF_VALUE *ecmd = sk_CONF_VALUE_value(ecmds, i);
 237         const char *confname = skip_dot(ecmd->name);
 238         const char *confvalue = ecmd->value;
 239
 240         OSSL_TRACE2(CONF, "Provider command: %s = %s\n",
 241                     confname, confvalue);
 242
 243         /* First handle some special pseudo confs */
 244
 245         /* Override provider name to use */
 246         if (strcmp(confname, "identity") == 0)
 247             name = confvalue;
 248         else if (strcmp(confname, "soft_load") == 0)
 249             soft = 1;
 250         /* Load a dynamic PROVIDER */
 251         else if (strcmp(confname, "module") == 0)
 252             path = confvalue;
 253         else if (strcmp(confname, "activate") == 0)
 254             activate = 1;
 255     }
 256
 257     if (activate) {
 258         ok = provider_conf_activate(libctx, name, value, path, soft, cnf);
 259     } else {
 260         OSSL_PROVIDER_INFO entry;
 261
 262         memset(&entry, 0, sizeof(entry));
 263         ok = 1;
 264         if (name != NULL) {
 265             entry.name = OPENSSL_strdup(name);
 266             if (entry.name == NULL) {
 267                 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
 268                 ok = 0;
 269             }
 270         }
 271         if (ok && path != NULL) {
 272             entry.path = OPENSSL_strdup(path);
 273             if (entry.path == NULL) {
 274                 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
 275                 ok = 0;
 276             }
 277         }
 278         if (ok)
 279             ok = provider_conf_params(NULL, &entry, NULL, value, cnf);
 280         if (ok && (entry.path != NULL || entry.parameters != NULL))
 281             ok = ossl_provider_info_add_to_store(libctx, &entry);
 282         if (!ok || (entry.path == NULL && entry.parameters == NULL)) {
 283             ossl_provider_info_clear(&entry);
 284         }
 285
 286     }
 287
 288     /*
 289      * Even if ok is 0, we still return success. Failure to load a provider is
 290      * not fatal. We want to continue to load the rest of the config file.
 291      */
 292     return 1;
 293 }
 294
 295 static int provider_conf_init(CONF_IMODULE *md, const CONF *cnf)
 296 {
 297     STACK_OF(CONF_VALUE) *elist;
 298     CONF_VALUE *cval;
 299     int i;
 300
 301     OSSL_TRACE1(CONF, "Loading providers module: section %s\n",
 302                 CONF_imodule_get_value(md));
 303
 304     /* Value is a section containing PROVIDERs to configure */
 305     elist = NCONF_get_section(cnf, CONF_imodule_get_value(md));
 306
 307     if (!elist) {
 308         ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_SECTION_ERROR);
 309         return 0;
 310     }
 311
 312     for (i = 0; i < sk_CONF_VALUE_num(elist); i++) {
 313         cval = sk_CONF_VALUE_value(elist, i);
 314         if (!provider_conf_load(NCONF_get0_libctx((CONF *)cnf),
 315                     cval->name, cval->value, cnf))
 316             return 0;
 317     }
 318
 319     return 1;
 320 }
 321
 322 void ossl_provider_add_conf_module(void)
 323 {
 324     OSSL_TRACE(CONF, "Adding config module 'providers'\n");
 325     CONF_module_add("providers", provider_conf_init, NULL);
 326 }