test/conf_include_test.c

   1 /*
   2  * Copyright 2016-2018 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 <stdlib.h>
  11 #include <string.h>
  12 #include <openssl/conf.h>
  13 #include <openssl/err.h>
  14 #include "testutil.h"
  15
  16 #ifdef _WIN32
  17 # include <direct.h>
  18 # define DIRSEP "/\\"
  19 # define chdir _chdir
  20 # define DIRSEP_PRESERVE 0
  21 #elif !defined(OPENSSL_NO_POSIX_IO)
  22 # include <unistd.h>
  23 # ifndef OPENSSL_SYS_VMS
  24 #  define DIRSEP "/"
  25 #  define DIRSEP_PRESERVE 0
  26 # else
  27 #  define DIRSEP "/]:"
  28 #  define DIRSEP_PRESERVE 1
  29 # endif
  30 #else
  31 /* the test does not work without chdir() */
  32 # define chdir(x) (-1);
  33 # define DIRSEP "/"
  34 #  define DIRSEP_PRESERVE 0
  35 #endif
  36
  37 /* changes path to that of the filename */
  38 static int change_path(const char *file)
  39 {
  40     char *s = OPENSSL_strdup(file);
  41     char *p = s;
  42     char *last = NULL;
  43     int ret;
  44
  45     if (s == NULL)
  46         return -1;
  47
  48     while ((p = strpbrk(p, DIRSEP)) != NULL) {
  49         last = p++;
  50     }
  51     if (last == NULL)
  52         return 0;
  53     last[DIRSEP_PRESERVE] = 0;
  54
  55     TEST_note("changing path to %s", s);
  56     ret = chdir(s);
  57     OPENSSL_free(s);
  58     return ret;
  59 }
  60
  61 /*
  62  * This test program checks the operation of the .include directive.
  63  */
  64
  65 static CONF *conf;
  66 static BIO *in;
  67 static int expect_failure = 0;
  68
  69 static int test_load_config(void)
  70 {
  71     long errline;
  72     long val;
  73     char *str;
  74     long err;
  75
  76     if (!TEST_int_gt(NCONF_load_bio(conf, in, &errline), 0)
  77         || !TEST_int_eq(err = ERR_peek_error(), 0)) {
  78         if (expect_failure)
  79             return 1;
  80         TEST_note("Failure loading the configuration at line %ld", errline);
  81         return 0;
  82     }
  83     if (expect_failure) {
  84         TEST_note("Failure expected but did not happen");
  85         return 0;
  86     }
  87
  88     if (!TEST_int_gt(CONF_modules_load(conf, NULL, 0), 0)) {
  89         TEST_note("Failed in CONF_modules_load");
  90         return 0;
  91     }
  92
  93     /* verify whether CA_default/default_days is set */
  94     val = 0;
  95     if (!TEST_int_eq(NCONF_get_number(conf, "CA_default", "default_days", &val), 1)
  96         || !TEST_int_eq(val, 365)) {
  97         TEST_note("default_days incorrect");
  98         return 0;
  99     }
 100
 101     /* verify whether req/default_bits is set */
 102     val = 0;
 103     if (!TEST_int_eq(NCONF_get_number(conf, "req", "default_bits", &val), 1)
 104         || !TEST_int_eq(val, 2048)) {
 105         TEST_note("default_bits incorrect");
 106         return 0;
 107     }
 108
 109     /* verify whether countryName_default is set correctly */
 110     str = NCONF_get_string(conf, "req_distinguished_name", "countryName_default");
 111     if (!TEST_ptr(str) || !TEST_str_eq(str, "AU")) {
 112         TEST_note("countryName_default incorrect");
 113         return 0;
 114     }
 115
 116     return 1;
 117 }
 118
 119 static int test_check_null_numbers(void)
 120 {
 121 #if defined(_BSD_SOURCE) \
 122         || (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 200112L) \
 123         || (defined(_XOPEN_SOURCE) && _XOPEN_SOURCE >= 600)
 124     long val = 0;
 125
 126     /* Verify that a NULL config with a present environment variable returns
 127      * success and the value.
 128      */
 129     if (!TEST_int_eq(setenv("FNORD", "123", 1), 0)
 130             || !TEST_true(NCONF_get_number(NULL, "missing", "FNORD", &val))
 131             || !TEST_long_eq(val, 123)) {
 132         TEST_note("environment variable with NULL conf failed");
 133         return 0;
 134     }
 135
 136     /*
 137      * Verify that a NULL config with a missing environment variable returns
 138      * a failure code.
 139      */
 140     if (!TEST_int_eq(unsetenv("FNORD"), 0)
 141             || !TEST_false(NCONF_get_number(NULL, "missing", "FNORD", &val))) {
 142         TEST_note("missing environment variable with NULL conf failed");
 143         return 0;
 144     }
 145 #endif
 146     return 1;
 147 }
 148
 149 static int test_check_overflow(void)
 150 {
 151 #if defined(_BSD_SOURCE) \
 152         || (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 200112L) \
 153         || (defined(_XOPEN_SOURCE) && _XOPEN_SOURCE >= 600)
 154     long val = 0;
 155     char max[(sizeof(long) * 8) / 3 + 3];
 156     char *p;
 157
 158     p = max + sprintf(max, "0%ld", LONG_MAX) - 1;
 159     setenv("FNORD", max, 1);
 160     if (!TEST_true(NCONF_get_number(NULL, "missing", "FNORD", &val))
 161             || !TEST_long_eq(val, LONG_MAX))
 162         return 0;
 163
 164     while (++*p > '9')
 165         *p-- = '0';
 166
 167     setenv("FNORD", max, 1);
 168     if (!TEST_false(NCONF_get_number(NULL, "missing", "FNORD", &val)))
 169         return 0;
 170 #endif
 171     return 1;
 172 }
 173
 174 typedef enum OPTION_choice {
 175     OPT_ERR = -1,
 176     OPT_EOF = 0,
 177     OPT_FAIL,
 178     OPT_TEST_ENUM
 179 } OPTION_CHOICE;
 180
 181 const OPTIONS *test_get_options(void)
 182 {
 183     static const OPTIONS test_options[] = {
 184         OPT_TEST_OPTIONS_WITH_EXTRA_USAGE("conf_file\n"),
 185         { "f", OPT_FAIL, '-', "A failure is expected" },
 186         { NULL }
 187     };
 188     return test_options;
 189 }
 190
 191 int setup_tests(void)
 192 {
 193     const char *conf_file;
 194     OPTION_CHOICE o;
 195
 196     if (!TEST_ptr(conf = NCONF_new(NULL)))
 197         return 0;
 198
 199     while ((o = opt_next()) != OPT_EOF) {
 200         switch (o) {
 201         case OPT_FAIL:
 202             expect_failure = 1;
 203             break;
 204         case OPT_TEST_CASES:
 205             break;
 206         default:
 207             return 0;
 208         }
 209     }
 210
 211     conf_file = test_get_argument(0);
 212     if (!TEST_ptr(conf_file)
 213         || !TEST_ptr(in = BIO_new_file(conf_file, "r"))) {
 214         TEST_note("Unable to open the file argument");
 215         return 0;
 216     }
 217
 218     /*
 219      * For this test we need to chdir as we use relative
 220      * path names in the config files.
 221      */
 222     change_path(conf_file);
 223
 224     ADD_TEST(test_load_config);
 225     ADD_TEST(test_check_null_numbers);
 226     ADD_TEST(test_check_overflow);
 227     return 1;
 228 }
 229
 230 void cleanup_tests(void)
 231 {
 232     BIO_vfree(in);
 233     NCONF_free(conf);
 234     CONF_modules_unload(1);
 235 }