crypto/conf/conf_lib.c

   1 /*
   2  * Copyright 2000-2020 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 "e_os.h"
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include "internal/conf.h"
  14 #include "crypto/ctype.h"
  15 #include <openssl/crypto.h>
  16 #include <openssl/err.h>
  17 #include <openssl/conf.h>
  18 #include <openssl/conf_api.h>
  19 #include "conf_local.h"
  20 #include <openssl/lhash.h>
  21
  22 static CONF_METHOD *default_CONF_method = NULL;
  23
  24 /* Init a 'CONF' structure from an old LHASH */
  25
  26 void CONF_set_nconf(CONF *conf, LHASH_OF(CONF_VALUE) *hash)
  27 {
  28     if (default_CONF_method == NULL)
  29         default_CONF_method = NCONF_default();
  30
  31     default_CONF_method->init(conf);
  32     conf->data = hash;
  33 }
  34
  35 /*
  36  * The following section contains the "CONF classic" functions, rewritten in
  37  * terms of the new CONF interface.
  38  */
  39
  40 int CONF_set_default_method(CONF_METHOD *meth)
  41 {
  42     default_CONF_method = meth;
  43     return 1;
  44 }
  45
  46 LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
  47                                 long *eline)
  48 {
  49     LHASH_OF(CONF_VALUE) *ltmp;
  50     BIO *in = NULL;
  51
  52 #ifdef OPENSSL_SYS_VMS
  53     in = BIO_new_file(file, "r");
  54 #else
  55     in = BIO_new_file(file, "rb");
  56 #endif
  57     if (in == NULL) {
  58         ERR_raise(ERR_LIB_CONF, ERR_R_SYS_LIB);
  59         return NULL;
  60     }
  61
  62     ltmp = CONF_load_bio(conf, in, eline);
  63     BIO_free(in);
  64
  65     return ltmp;
  66 }
  67
  68 #ifndef OPENSSL_NO_STDIO
  69 LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
  70                                    long *eline)
  71 {
  72     BIO *btmp;
  73     LHASH_OF(CONF_VALUE) *ltmp;
  74     if ((btmp = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
  75         ERR_raise(ERR_LIB_CONF, ERR_R_BUF_LIB);
  76         return NULL;
  77     }
  78     ltmp = CONF_load_bio(conf, btmp, eline);
  79     BIO_free(btmp);
  80     return ltmp;
  81 }
  82 #endif
  83
  84 LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp,
  85                                     long *eline)
  86 {
  87     CONF ctmp;
  88     int ret;
  89
  90     CONF_set_nconf(&ctmp, conf);
  91
  92     ret = NCONF_load_bio(&ctmp, bp, eline);
  93     if (ret)
  94         return ctmp.data;
  95     return NULL;
  96 }
  97
  98 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
  99                                        const char *section)
 100 {
 101     if (conf == NULL) {
 102         return NULL;
 103     } else {
 104         CONF ctmp;
 105
 106         CONF_set_nconf(&ctmp, conf);
 107         return NCONF_get_section(&ctmp, section);
 108     }
 109 }
 110
 111 char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
 112                       const char *name)
 113 {
 114     if (conf == NULL) {
 115         return NCONF_get_string(NULL, group, name);
 116     } else {
 117         CONF ctmp;
 118
 119         CONF_set_nconf(&ctmp, conf);
 120         return NCONF_get_string(&ctmp, group, name);
 121     }
 122 }
 123
 124 long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
 125                      const char *name)
 126 {
 127     int status;
 128     long result = 0;
 129
 130     ERR_set_mark();
 131     if (conf == NULL) {
 132         status = NCONF_get_number_e(NULL, group, name, &result);
 133     } else {
 134         CONF ctmp;
 135
 136         CONF_set_nconf(&ctmp, conf);
 137         status = NCONF_get_number_e(&ctmp, group, name, &result);
 138     }
 139     ERR_pop_to_mark();
 140     return status == 0 ? 0L : result;
 141 }
 142
 143 void CONF_free(LHASH_OF(CONF_VALUE) *conf)
 144 {
 145     CONF ctmp;
 146     CONF_set_nconf(&ctmp, conf);
 147     NCONF_free_data(&ctmp);
 148 }
 149
 150 #ifndef OPENSSL_NO_STDIO
 151 int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out)
 152 {
 153     BIO *btmp;
 154     int ret;
 155
 156     if ((btmp = BIO_new_fp(out, BIO_NOCLOSE)) == NULL) {
 157         ERR_raise(ERR_LIB_CONF, ERR_R_BUF_LIB);
 158         return 0;
 159     }
 160     ret = CONF_dump_bio(conf, btmp);
 161     BIO_free(btmp);
 162     return ret;
 163 }
 164 #endif
 165
 166 int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out)
 167 {
 168     CONF ctmp;
 169
 170     CONF_set_nconf(&ctmp, conf);
 171     return NCONF_dump_bio(&ctmp, out);
 172 }
 173
 174 /*
 175  * The following section contains the "New CONF" functions.  They are
 176  * completely centralised around a new CONF structure that may contain
 177  * basically anything, but at least a method pointer and a table of data.
 178  * These functions are also written in terms of the bridge functions used by
 179  * the "CONF classic" functions, for consistency.
 180  */
 181
 182 CONF *NCONF_new_ex(OSSL_LIB_CTX *libctx, CONF_METHOD *meth)
 183 {
 184     CONF *ret;
 185
 186     if (meth == NULL)
 187         meth = NCONF_default();
 188
 189     ret = meth->create(meth);
 190     if (ret == NULL) {
 191         ERR_raise(ERR_LIB_CONF, ERR_R_MALLOC_FAILURE);
 192         return NULL;
 193     }
 194     ret->libctx = libctx;
 195
 196     return ret;
 197 }
 198
 199 CONF *NCONF_new(CONF_METHOD *meth)
 200 {
 201     return NCONF_new_ex(NULL, meth);
 202 }
 203
 204 void NCONF_free(CONF *conf)
 205 {
 206     if (conf == NULL)
 207         return;
 208     conf->meth->destroy(conf);
 209 }
 210
 211 void NCONF_free_data(CONF *conf)
 212 {
 213     if (conf == NULL)
 214         return;
 215     conf->meth->destroy_data(conf);
 216 }
 217
 218 int NCONF_load(CONF *conf, const char *file, long *eline)
 219 {
 220     if (conf == NULL) {
 221         ERR_raise(ERR_LIB_CONF, CONF_R_NO_CONF);
 222         return 0;
 223     }
 224
 225     return conf->meth->load(conf, file, eline);
 226 }
 227
 228 #ifndef OPENSSL_NO_STDIO
 229 int NCONF_load_fp(CONF *conf, FILE *fp, long *eline)
 230 {
 231     BIO *btmp;
 232     int ret;
 233     if ((btmp = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
 234         ERR_raise(ERR_LIB_CONF, ERR_R_BUF_LIB);
 235         return 0;
 236     }
 237     ret = NCONF_load_bio(conf, btmp, eline);
 238     BIO_free(btmp);
 239     return ret;
 240 }
 241 #endif
 242
 243 int NCONF_load_bio(CONF *conf, BIO *bp, long *eline)
 244 {
 245     if (conf == NULL) {
 246         ERR_raise(ERR_LIB_CONF, CONF_R_NO_CONF);
 247         return 0;
 248     }
 249
 250     return conf->meth->load_bio(conf, bp, eline);
 251 }
 252
 253 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *section)
 254 {
 255     if (conf == NULL) {
 256         ERR_raise(ERR_LIB_CONF, CONF_R_NO_CONF);
 257         return NULL;
 258     }
 259
 260     if (section == NULL) {
 261         ERR_raise(ERR_LIB_CONF, CONF_R_NO_SECTION);
 262         return NULL;
 263     }
 264
 265     return _CONF_get_section_values(conf, section);
 266 }
 267
 268 char *NCONF_get_string(const CONF *conf, const char *group, const char *name)
 269 {
 270     char *s = _CONF_get_string(conf, group, name);
 271
 272     /*
 273      * Since we may get a value from an environment variable even if conf is
 274      * NULL, let's check the value first
 275      */
 276     if (s)
 277         return s;
 278
 279     if (conf == NULL) {
 280         ERR_raise(ERR_LIB_CONF, CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE);
 281         return NULL;
 282     }
 283     ERR_raise_data(ERR_LIB_CONF, CONF_R_NO_VALUE,
 284                    "group=%s name=%s", group, name);
 285     return NULL;
 286 }
 287
 288 static int default_is_number(const CONF *conf, char c)
 289 {
 290     return ossl_isdigit(c);
 291 }
 292
 293 static int default_to_int(const CONF *conf, char c)
 294 {
 295     return (int)(c - '0');
 296 }
 297
 298 int NCONF_get_number_e(const CONF *conf, const char *group, const char *name,
 299                        long *result)
 300 {
 301     char *str;
 302     long res;
 303     int (*is_number)(const CONF *, char) = &default_is_number;
 304     int (*to_int)(const CONF *, char) = &default_to_int;
 305
 306     if (result == NULL) {
 307         ERR_raise(ERR_LIB_CONF, ERR_R_PASSED_NULL_PARAMETER);
 308         return 0;
 309     }
 310
 311     str = NCONF_get_string(conf, group, name);
 312
 313     if (str == NULL)
 314         return 0;
 315
 316     if (conf != NULL) {
 317         if (conf->meth->is_number != NULL)
 318             is_number = conf->meth->is_number;
 319         if (conf->meth->to_int != NULL)
 320             to_int = conf->meth->to_int;
 321     }
 322     for (res = 0; is_number(conf, *str); str++) {
 323         const int d = to_int(conf, *str);
 324
 325         if (res > (LONG_MAX - d) / 10L) {
 326             ERR_raise(ERR_LIB_CONF, CONF_R_NUMBER_TOO_LARGE);
 327             return 0;
 328         }
 329         res = res * 10 + d;
 330     }
 331
 332     *result = res;
 333     return 1;
 334 }
 335
 336 long _CONF_get_number(const CONF *conf, const char *section,
 337                       const char *name)
 338 {
 339     int status;
 340     long result = 0;
 341
 342     ERR_set_mark();
 343     status = NCONF_get_number_e(conf, section, name, &result);
 344     ERR_pop_to_mark();
 345     return status == 0 ? 0L : result;
 346 }
 347
 348 #ifndef OPENSSL_NO_STDIO
 349 int NCONF_dump_fp(const CONF *conf, FILE *out)
 350 {
 351     BIO *btmp;
 352     int ret;
 353     if ((btmp = BIO_new_fp(out, BIO_NOCLOSE)) == NULL) {
 354         ERR_raise(ERR_LIB_CONF, ERR_R_BUF_LIB);
 355         return 0;
 356     }
 357     ret = NCONF_dump_bio(conf, btmp);
 358     BIO_free(btmp);
 359     return ret;
 360 }
 361 #endif
 362
 363 int NCONF_dump_bio(const CONF *conf, BIO *out)
 364 {
 365     if (conf == NULL) {
 366         ERR_raise(ERR_LIB_CONF, CONF_R_NO_CONF);
 367         return 0;
 368     }
 369
 370     return conf->meth->dump(conf, out);
 371 }
 372
 373 /*
 374  * These routines call the C malloc/free, to avoid intermixing with
 375  * OpenSSL function pointers before the library is initialized.
 376  */
 377 OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void)
 378 {
 379     OPENSSL_INIT_SETTINGS *ret = malloc(sizeof(*ret));
 380
 381     if (ret == NULL)
 382         return NULL;
 383
 384     memset(ret, 0, sizeof(*ret));
 385     ret->flags = DEFAULT_CONF_MFLAGS;
 386
 387     return ret;
 388 }
 389
 390
 391 #ifndef OPENSSL_NO_STDIO
 392 int OPENSSL_INIT_set_config_filename(OPENSSL_INIT_SETTINGS *settings,
 393                                      const char *filename)
 394 {
 395     char *newfilename = NULL;
 396
 397     if (filename != NULL) {
 398         newfilename = strdup(filename);
 399         if (newfilename == NULL)
 400             return 0;
 401     }
 402
 403     free(settings->filename);
 404     settings->filename = newfilename;
 405
 406     return 1;
 407 }
 408
 409 void OPENSSL_INIT_set_config_file_flags(OPENSSL_INIT_SETTINGS *settings,
 410                                         unsigned long flags)
 411 {
 412     settings->flags = flags;
 413 }
 414
 415 int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *settings,
 416                                     const char *appname)
 417 {
 418     char *newappname = NULL;
 419
 420     if (appname != NULL) {
 421         newappname = strdup(appname);
 422         if (newappname == NULL)
 423             return 0;
 424     }
 425
 426     free(settings->appname);
 427     settings->appname = newappname;
 428
 429     return 1;
 430 }
 431 #endif
 432
 433 void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *settings)
 434 {
 435     free(settings->filename);
 436     free(settings->appname);
 437     free(settings);
 438 }