crypto/ts/ts_conf.c

   1 /* crypto/ts/ts_conf.c */
   2 /*
   3  * Written by Zoltan Glozik (zglozik@stones.com) for the OpenSSL project
   4  * 2002.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 2006 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 <string.h>
  61
  62 #include <openssl/crypto.h>
  63 #include "internal/cryptlib.h"
  64 #include <openssl/pem.h>
  65 #ifndef OPENSSL_NO_ENGINE
  66 # include <openssl/engine.h>
  67 #endif
  68 #include <openssl/ts.h>
  69
  70 /* Macro definitions for the configuration file. */
  71
  72 #define BASE_SECTION                    "tsa"
  73 #define ENV_DEFAULT_TSA                 "default_tsa"
  74 #define ENV_SERIAL                      "serial"
  75 #define ENV_CRYPTO_DEVICE               "crypto_device"
  76 #define ENV_SIGNER_CERT                 "signer_cert"
  77 #define ENV_CERTS                       "certs"
  78 #define ENV_SIGNER_KEY                  "signer_key"
  79 #define ENV_DEFAULT_POLICY              "default_policy"
  80 #define ENV_OTHER_POLICIES              "other_policies"
  81 #define ENV_DIGESTS                     "digests"
  82 #define ENV_ACCURACY                    "accuracy"
  83 #define ENV_ORDERING                    "ordering"
  84 #define ENV_TSA_NAME                    "tsa_name"
  85 #define ENV_ESS_CERT_ID_CHAIN           "ess_cert_id_chain"
  86 #define ENV_VALUE_SECS                  "secs"
  87 #define ENV_VALUE_MILLISECS             "millisecs"
  88 #define ENV_VALUE_MICROSECS             "microsecs"
  89 #define ENV_CLOCK_PRECISION_DIGITS      "clock_precision_digits"
  90 #define ENV_VALUE_YES                   "yes"
  91 #define ENV_VALUE_NO                    "no"
  92
  93 /* Function definitions for certificate and key loading. */
  94
  95 X509 *TS_CONF_load_cert(const char *file)
  96 {
  97     BIO *cert = NULL;
  98     X509 *x = NULL;
  99
 100     if ((cert = BIO_new_file(file, "r")) == NULL)
 101         goto end;
 102     x = PEM_read_bio_X509_AUX(cert, NULL, NULL, NULL);
 103  end:
 104     if (x == NULL)
 105         TSerr(TS_F_TS_CONF_LOAD_CERT, TS_R_CANNOT_LOAD_CERT);
 106     BIO_free(cert);
 107     return x;
 108 }
 109
 110 STACK_OF(X509) *TS_CONF_load_certs(const char *file)
 111 {
 112     BIO *certs = NULL;
 113     STACK_OF(X509) *othercerts = NULL;
 114     STACK_OF(X509_INFO) *allcerts = NULL;
 115     int i;
 116
 117     if ((certs = BIO_new_file(file, "r")) == NULL)
 118         goto end;
 119     if ((othercerts = sk_X509_new_null()) == NULL)
 120         goto end;
 121
 122     allcerts = PEM_X509_INFO_read_bio(certs, NULL, NULL, NULL);
 123     for (i = 0; i < sk_X509_INFO_num(allcerts); i++) {
 124         X509_INFO *xi = sk_X509_INFO_value(allcerts, i);
 125         if (xi->x509) {
 126             sk_X509_push(othercerts, xi->x509);
 127             xi->x509 = NULL;
 128         }
 129     }
 130  end:
 131     if (othercerts == NULL)
 132         TSerr(TS_F_TS_CONF_LOAD_CERTS, TS_R_CANNOT_LOAD_CERT);
 133     sk_X509_INFO_pop_free(allcerts, X509_INFO_free);
 134     BIO_free(certs);
 135     return othercerts;
 136 }
 137
 138 EVP_PKEY *TS_CONF_load_key(const char *file, const char *pass)
 139 {
 140     BIO *key = NULL;
 141     EVP_PKEY *pkey = NULL;
 142
 143     if ((key = BIO_new_file(file, "r")) == NULL)
 144         goto end;
 145     pkey = PEM_read_bio_PrivateKey(key, NULL, NULL, (char *)pass);
 146  end:
 147     if (pkey == NULL)
 148         TSerr(TS_F_TS_CONF_LOAD_KEY, TS_R_CANNOT_LOAD_KEY);
 149     BIO_free(key);
 150     return pkey;
 151 }
 152
 153 /* Function definitions for handling configuration options. */
 154
 155 static void ts_CONF_lookup_fail(const char *name, const char *tag)
 156 {
 157     TSerr(TS_F_TS_CONF_LOOKUP_FAIL, TS_R_VAR_LOOKUP_FAILURE);
 158     ERR_add_error_data(3, name, "::", tag);
 159 }
 160
 161 static void ts_CONF_invalid(const char *name, const char *tag)
 162 {
 163     TSerr(TS_F_TS_CONF_INVALID, TS_R_VAR_BAD_VALUE);
 164     ERR_add_error_data(3, name, "::", tag);
 165 }
 166
 167 const char *TS_CONF_get_tsa_section(CONF *conf, const char *section)
 168 {
 169     if (!section) {
 170         section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_TSA);
 171         if (!section)
 172             ts_CONF_lookup_fail(BASE_SECTION, ENV_DEFAULT_TSA);
 173     }
 174     return section;
 175 }
 176
 177 int TS_CONF_set_serial(CONF *conf, const char *section, TS_serial_cb cb,
 178                        TS_RESP_CTX *ctx)
 179 {
 180     int ret = 0;
 181     char *serial = NCONF_get_string(conf, section, ENV_SERIAL);
 182     if (!serial) {
 183         ts_CONF_lookup_fail(section, ENV_SERIAL);
 184         goto err;
 185     }
 186     TS_RESP_CTX_set_serial_cb(ctx, cb, serial);
 187
 188     ret = 1;
 189  err:
 190     return ret;
 191 }
 192
 193 #ifndef OPENSSL_NO_ENGINE
 194
 195 int TS_CONF_set_crypto_device(CONF *conf, const char *section,
 196                               const char *device)
 197 {
 198     int ret = 0;
 199
 200     if (device == NULL)
 201         device = NCONF_get_string(conf, section, ENV_CRYPTO_DEVICE);
 202
 203     if (device && !TS_CONF_set_default_engine(device)) {
 204         ts_CONF_invalid(section, ENV_CRYPTO_DEVICE);
 205         goto err;
 206     }
 207     ret = 1;
 208  err:
 209     return ret;
 210 }
 211
 212 int TS_CONF_set_default_engine(const char *name)
 213 {
 214     ENGINE *e = NULL;
 215     int ret = 0;
 216
 217     /* Leave the default if builtin specified. */
 218     if (strcmp(name, "builtin") == 0)
 219         return 1;
 220
 221     if ((e = ENGINE_by_id(name)) == NULL)
 222         goto err;
 223
 224     /* Enable the use of the NCipher HSM for forked children. */
 225     if (strcmp(name, "chil") == 0)
 226         ENGINE_ctrl(e, ENGINE_CTRL_CHIL_SET_FORKCHECK, 1, 0, 0);
 227     /* All the operations are going to be carried out by the engine. */
 228     if (!ENGINE_set_default(e, ENGINE_METHOD_ALL))
 229         goto err;
 230     ret = 1;
 231  err:
 232     if (!ret) {
 233         TSerr(TS_F_TS_CONF_SET_DEFAULT_ENGINE, TS_R_COULD_NOT_SET_ENGINE);
 234         ERR_add_error_data(2, "engine:", name);
 235     }
 236     ENGINE_free(e);
 237     return ret;
 238 }
 239
 240 #endif
 241
 242 int TS_CONF_set_signer_cert(CONF *conf, const char *section,
 243                             const char *cert, TS_RESP_CTX *ctx)
 244 {
 245     int ret = 0;
 246     X509 *cert_obj = NULL;
 247
 248     if (cert == NULL) {
 249         cert = NCONF_get_string(conf, section, ENV_SIGNER_CERT);
 250         if (cert == NULL) {
 251             ts_CONF_lookup_fail(section, ENV_SIGNER_CERT);
 252             goto err;
 253         }
 254     }
 255     if ((cert_obj = TS_CONF_load_cert(cert)) == NULL)
 256         goto err;
 257     if (!TS_RESP_CTX_set_signer_cert(ctx, cert_obj))
 258         goto err;
 259
 260     ret = 1;
 261  err:
 262     X509_free(cert_obj);
 263     return ret;
 264 }
 265
 266 int TS_CONF_set_certs(CONF *conf, const char *section, const char *certs,
 267                       TS_RESP_CTX *ctx)
 268 {
 269     int ret = 0;
 270     STACK_OF(X509) *certs_obj = NULL;
 271
 272     if (certs == NULL) {
 273         /* Certificate chain is optional. */
 274         if ((certs = NCONF_get_string(conf, section, ENV_CERTS)) == NULL)
 275             goto end;
 276     }
 277     if ((certs_obj = TS_CONF_load_certs(certs)) == NULL)
 278         goto err;
 279     if (!TS_RESP_CTX_set_certs(ctx, certs_obj))
 280         goto err;
 281  end:
 282     ret = 1;
 283  err:
 284     sk_X509_pop_free(certs_obj, X509_free);
 285     return ret;
 286 }
 287
 288 int TS_CONF_set_signer_key(CONF *conf, const char *section,
 289                            const char *key, const char *pass,
 290                            TS_RESP_CTX *ctx)
 291 {
 292     int ret = 0;
 293     EVP_PKEY *key_obj = NULL;
 294     if (!key)
 295         key = NCONF_get_string(conf, section, ENV_SIGNER_KEY);
 296     if (!key) {
 297         ts_CONF_lookup_fail(section, ENV_SIGNER_KEY);
 298         goto err;
 299     }
 300     if ((key_obj = TS_CONF_load_key(key, pass)) == NULL)
 301         goto err;
 302     if (!TS_RESP_CTX_set_signer_key(ctx, key_obj))
 303         goto err;
 304
 305     ret = 1;
 306  err:
 307     EVP_PKEY_free(key_obj);
 308     return ret;
 309 }
 310
 311 int TS_CONF_set_def_policy(CONF *conf, const char *section,
 312                            const char *policy, TS_RESP_CTX *ctx)
 313 {
 314     int ret = 0;
 315     ASN1_OBJECT *policy_obj = NULL;
 316     if (!policy)
 317         policy = NCONF_get_string(conf, section, ENV_DEFAULT_POLICY);
 318     if (!policy) {
 319         ts_CONF_lookup_fail(section, ENV_DEFAULT_POLICY);
 320         goto err;
 321     }
 322     if ((policy_obj = OBJ_txt2obj(policy, 0)) == NULL) {
 323         ts_CONF_invalid(section, ENV_DEFAULT_POLICY);
 324         goto err;
 325     }
 326     if (!TS_RESP_CTX_set_def_policy(ctx, policy_obj))
 327         goto err;
 328
 329     ret = 1;
 330  err:
 331     ASN1_OBJECT_free(policy_obj);
 332     return ret;
 333 }
 334
 335 int TS_CONF_set_policies(CONF *conf, const char *section, TS_RESP_CTX *ctx)
 336 {
 337     int ret = 0;
 338     int i;
 339     STACK_OF(CONF_VALUE) *list = NULL;
 340     char *policies = NCONF_get_string(conf, section, ENV_OTHER_POLICIES);
 341
 342     /* If no other policy is specified, that's fine. */
 343     if (policies && (list = X509V3_parse_list(policies)) == NULL) {
 344         ts_CONF_invalid(section, ENV_OTHER_POLICIES);
 345         goto err;
 346     }
 347     for (i = 0; i < sk_CONF_VALUE_num(list); ++i) {
 348         CONF_VALUE *val = sk_CONF_VALUE_value(list, i);
 349         const char *extval = val->value ? val->value : val->name;
 350         ASN1_OBJECT *objtmp;
 351
 352         if ((objtmp = OBJ_txt2obj(extval, 0)) == NULL) {
 353             ts_CONF_invalid(section, ENV_OTHER_POLICIES);
 354             goto err;
 355         }
 356         if (!TS_RESP_CTX_add_policy(ctx, objtmp))
 357             goto err;
 358         ASN1_OBJECT_free(objtmp);
 359     }
 360
 361     ret = 1;
 362  err:
 363     sk_CONF_VALUE_pop_free(list, X509V3_conf_free);
 364     return ret;
 365 }
 366
 367 int TS_CONF_set_digests(CONF *conf, const char *section, TS_RESP_CTX *ctx)
 368 {
 369     int ret = 0;
 370     int i;
 371     STACK_OF(CONF_VALUE) *list = NULL;
 372     char *digests = NCONF_get_string(conf, section, ENV_DIGESTS);
 373
 374     if (digests == NULL) {
 375         ts_CONF_lookup_fail(section, ENV_DIGESTS);
 376         goto err;
 377     }
 378     if ((list = X509V3_parse_list(digests)) == NULL) {
 379         ts_CONF_invalid(section, ENV_DIGESTS);
 380         goto err;
 381     }
 382     if (sk_CONF_VALUE_num(list) == 0) {
 383         ts_CONF_invalid(section, ENV_DIGESTS);
 384         goto err;
 385     }
 386     for (i = 0; i < sk_CONF_VALUE_num(list); ++i) {
 387         CONF_VALUE *val = sk_CONF_VALUE_value(list, i);
 388         const char *extval = val->value ? val->value : val->name;
 389         const EVP_MD *md;
 390
 391         if ((md = EVP_get_digestbyname(extval)) == NULL) {
 392             ts_CONF_invalid(section, ENV_DIGESTS);
 393             goto err;
 394         }
 395         if (!TS_RESP_CTX_add_md(ctx, md))
 396             goto err;
 397     }
 398
 399     ret = 1;
 400  err:
 401     sk_CONF_VALUE_pop_free(list, X509V3_conf_free);
 402     return ret;
 403 }
 404
 405 int TS_CONF_set_accuracy(CONF *conf, const char *section, TS_RESP_CTX *ctx)
 406 {
 407     int ret = 0;
 408     int i;
 409     int secs = 0, millis = 0, micros = 0;
 410     STACK_OF(CONF_VALUE) *list = NULL;
 411     char *accuracy = NCONF_get_string(conf, section, ENV_ACCURACY);
 412
 413     if (accuracy && (list = X509V3_parse_list(accuracy)) == NULL) {
 414         ts_CONF_invalid(section, ENV_ACCURACY);
 415         goto err;
 416     }
 417     for (i = 0; i < sk_CONF_VALUE_num(list); ++i) {
 418         CONF_VALUE *val = sk_CONF_VALUE_value(list, i);
 419         if (strcmp(val->name, ENV_VALUE_SECS) == 0) {
 420             if (val->value)
 421                 secs = atoi(val->value);
 422         } else if (strcmp(val->name, ENV_VALUE_MILLISECS) == 0) {
 423             if (val->value)
 424                 millis = atoi(val->value);
 425         } else if (strcmp(val->name, ENV_VALUE_MICROSECS) == 0) {
 426             if (val->value)
 427                 micros = atoi(val->value);
 428         } else {
 429             ts_CONF_invalid(section, ENV_ACCURACY);
 430             goto err;
 431         }
 432     }
 433     if (!TS_RESP_CTX_set_accuracy(ctx, secs, millis, micros))
 434         goto err;
 435
 436     ret = 1;
 437  err:
 438     sk_CONF_VALUE_pop_free(list, X509V3_conf_free);
 439     return ret;
 440 }
 441
 442 int TS_CONF_set_clock_precision_digits(CONF *conf, const char *section,
 443                                        TS_RESP_CTX *ctx)
 444 {
 445     int ret = 0;
 446     long digits = 0;
 447
 448     /*
 449      * If not specified, set the default value to 0, i.e. sec precision
 450      */
 451     if (!NCONF_get_number_e(conf, section, ENV_CLOCK_PRECISION_DIGITS,
 452                             &digits))
 453         digits = 0;
 454     if (digits < 0 || digits > TS_MAX_CLOCK_PRECISION_DIGITS) {
 455         ts_CONF_invalid(section, ENV_CLOCK_PRECISION_DIGITS);
 456         goto err;
 457     }
 458
 459     if (!TS_RESP_CTX_set_clock_precision_digits(ctx, digits))
 460         goto err;
 461
 462     return 1;
 463  err:
 464     return ret;
 465 }
 466
 467 static int ts_CONF_add_flag(CONF *conf, const char *section,
 468                             const char *field, int flag, TS_RESP_CTX *ctx)
 469 {
 470     /* Default is false. */
 471     const char *value = NCONF_get_string(conf, section, field);
 472     if (value) {
 473         if (strcmp(value, ENV_VALUE_YES) == 0)
 474             TS_RESP_CTX_add_flags(ctx, flag);
 475         else if (strcmp(value, ENV_VALUE_NO) != 0) {
 476             ts_CONF_invalid(section, field);
 477             return 0;
 478         }
 479     }
 480
 481     return 1;
 482 }
 483
 484 int TS_CONF_set_ordering(CONF *conf, const char *section, TS_RESP_CTX *ctx)
 485 {
 486     return ts_CONF_add_flag(conf, section, ENV_ORDERING, TS_ORDERING, ctx);
 487 }
 488
 489 int TS_CONF_set_tsa_name(CONF *conf, const char *section, TS_RESP_CTX *ctx)
 490 {
 491     return ts_CONF_add_flag(conf, section, ENV_TSA_NAME, TS_TSA_NAME, ctx);
 492 }
 493
 494 int TS_CONF_set_ess_cert_id_chain(CONF *conf, const char *section,
 495                                   TS_RESP_CTX *ctx)
 496 {
 497     return ts_CONF_add_flag(conf, section, ENV_ESS_CERT_ID_CHAIN,
 498                             TS_ESS_CERT_ID_CHAIN, ctx);
 499 }