apps/verify.c

   1 /*
   2  * Copyright 1995-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 <stdio.h>
  11 #include <stdlib.h>
  12 #include <string.h>
  13 #include "apps.h"
  14 #include "progs.h"
  15 #include <openssl/bio.h>
  16 #include <openssl/err.h>
  17 #include <openssl/x509.h>
  18 #include <openssl/x509v3.h>
  19 #include <openssl/pem.h>
  20
  21 static int cb(int ok, X509_STORE_CTX *ctx);
  22 static int check(X509_STORE *ctx, const char *file,
  23                  STACK_OF(X509) *uchain, STACK_OF(X509) *tchain,
  24                  STACK_OF(X509_CRL) *crls, int show_chain,
  25                  unsigned char *sm2id, size_t sm2idlen);
  26 static int v_verbose = 0, vflags = 0;
  27
  28 typedef enum OPTION_choice {
  29     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
  30     OPT_ENGINE, OPT_CAPATH, OPT_CAFILE, OPT_CASTORE,
  31     OPT_NOCAPATH, OPT_NOCAFILE, OPT_NOCASTORE,
  32     OPT_UNTRUSTED, OPT_TRUSTED, OPT_CRLFILE, OPT_CRL_DOWNLOAD, OPT_SHOW_CHAIN,
  33     OPT_V_ENUM, OPT_NAMEOPT,
  34     OPT_VERBOSE, OPT_SM2ID, OPT_SM2HEXID
  35 } OPTION_CHOICE;
  36
  37 const OPTIONS verify_options[] = {
  38     {OPT_HELP_STR, 1, '-', "Usage: %s [options] cert.pem...\n"},
  39
  40     OPT_SECTION("General"),
  41     {"help", OPT_HELP, '-', "Display this summary"},
  42 #ifndef OPENSSL_NO_ENGINE
  43     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
  44 #endif
  45     {"verbose", OPT_VERBOSE, '-',
  46         "Print extra information about the operations being performed."},
  47     {"nameopt", OPT_NAMEOPT, 's', "Various certificate name options"},
  48
  49     OPT_SECTION("Certificate chain"),
  50     {"CApath", OPT_CAPATH, '/', "A directory of trusted certificates"},
  51     {"CAfile", OPT_CAFILE, '<', "A file of trusted certificates"},
  52     {"CAstore", OPT_CASTORE, ':', "URI to a store of trusted certificates"},
  53     {"no-CAfile", OPT_NOCAFILE, '-',
  54      "Do not load the default certificates file"},
  55     {"no-CApath", OPT_NOCAPATH, '-',
  56      "Do not load certificates from the default certificates directory"},
  57     {"no-CAstore", OPT_NOCAPATH, '-',
  58      "Do not load certificates from the default certificates store"},
  59     {"untrusted", OPT_UNTRUSTED, '<', "A file of untrusted certificates"},
  60     {"trusted", OPT_TRUSTED, '<', "A file of trusted certificates"},
  61     {"CRLfile", OPT_CRLFILE, '<',
  62         "File containing one or more CRL's (in PEM format) to load"},
  63     {"crl_download", OPT_CRL_DOWNLOAD, '-',
  64         "Attempt to download CRL information for this certificate"},
  65     {"show_chain", OPT_SHOW_CHAIN, '-',
  66         "Display information about the certificate chain"},
  67
  68     OPT_V_OPTIONS,
  69 #ifndef OPENSSL_NO_SM2
  70     {"sm2-id", OPT_SM2ID, 's',
  71      "Specify an ID string to verify an SM2 certificate"},
  72     {"sm2-hex-id", OPT_SM2HEXID, 's',
  73      "Specify a hex ID string to verify an SM2 certificate"},
  74 #endif
  75     {NULL}
  76 };
  77
  78 int verify_main(int argc, char **argv)
  79 {
  80     ENGINE *e = NULL;
  81     STACK_OF(X509) *untrusted = NULL, *trusted = NULL;
  82     STACK_OF(X509_CRL) *crls = NULL;
  83     X509_STORE *store = NULL;
  84     X509_VERIFY_PARAM *vpm = NULL;
  85     const char *prog, *CApath = NULL, *CAfile = NULL, *CAstore = NULL;
  86     int noCApath = 0, noCAfile = 0, noCAstore = 0;
  87     int vpmtouched = 0, crl_download = 0, show_chain = 0, i = 0, ret = 1;
  88     OPTION_CHOICE o;
  89     unsigned char *sm2_id = NULL;
  90     size_t sm2_idlen = 0;
  91     int sm2_free = 0;
  92
  93     if ((vpm = X509_VERIFY_PARAM_new()) == NULL)
  94         goto end;
  95
  96     prog = opt_init(argc, argv, verify_options);
  97     while ((o = opt_next()) != OPT_EOF) {
  98         switch (o) {
  99         case OPT_EOF:
 100         case OPT_ERR:
 101             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 102             goto end;
 103         case OPT_HELP:
 104             opt_help(verify_options);
 105             BIO_printf(bio_err, "Recognized usages:\n");
 106             for (i = 0; i < X509_PURPOSE_get_count(); i++) {
 107                 X509_PURPOSE *ptmp;
 108                 ptmp = X509_PURPOSE_get0(i);
 109                 BIO_printf(bio_err, "\t%-10s\t%s\n",
 110                         X509_PURPOSE_get0_sname(ptmp),
 111                         X509_PURPOSE_get0_name(ptmp));
 112             }
 113
 114             BIO_printf(bio_err, "Recognized verify names:\n");
 115             for (i = 0; i < X509_VERIFY_PARAM_get_count(); i++) {
 116                 const X509_VERIFY_PARAM *vptmp;
 117                 vptmp = X509_VERIFY_PARAM_get0(i);
 118                 BIO_printf(bio_err, "\t%-10s\n",
 119                         X509_VERIFY_PARAM_get0_name(vptmp));
 120             }
 121             ret = 0;
 122             goto end;
 123         case OPT_V_CASES:
 124             if (!opt_verify(o, vpm))
 125                 goto end;
 126             vpmtouched++;
 127             break;
 128         case OPT_CAPATH:
 129             CApath = opt_arg();
 130             break;
 131         case OPT_CAFILE:
 132             CAfile = opt_arg();
 133             break;
 134         case OPT_CASTORE:
 135             CAstore = opt_arg();
 136             break;
 137         case OPT_NOCAPATH:
 138             noCApath = 1;
 139             break;
 140         case OPT_NOCAFILE:
 141             noCAfile = 1;
 142             break;
 143         case OPT_NOCASTORE:
 144             noCAstore = 1;
 145             break;
 146         case OPT_UNTRUSTED:
 147             /* Zero or more times */
 148             if (!load_certs(opt_arg(), &untrusted, FORMAT_PEM, NULL,
 149                             "untrusted certificates"))
 150                 goto end;
 151             break;
 152         case OPT_TRUSTED:
 153             /* Zero or more times */
 154             noCAfile = 1;
 155             noCApath = 1;
 156             noCAstore = 1;
 157             if (!load_certs(opt_arg(), &trusted, FORMAT_PEM, NULL,
 158                             "trusted certificates"))
 159                 goto end;
 160             break;
 161         case OPT_CRLFILE:
 162             /* Zero or more times */
 163             if (!load_crls(opt_arg(), &crls, FORMAT_PEM, NULL,
 164                            "other CRLs"))
 165                 goto end;
 166             break;
 167         case OPT_CRL_DOWNLOAD:
 168             crl_download = 1;
 169             break;
 170         case OPT_ENGINE:
 171             if ((e = setup_engine(opt_arg(), 0)) == NULL) {
 172                 /* Failure message already displayed */
 173                 goto end;
 174             }
 175             break;
 176         case OPT_SHOW_CHAIN:
 177             show_chain = 1;
 178             break;
 179         case OPT_NAMEOPT:
 180             if (!set_nameopt(opt_arg()))
 181                 goto end;
 182             break;
 183         case OPT_VERBOSE:
 184             v_verbose = 1;
 185             break;
 186         case OPT_SM2ID:
 187             if (sm2_id != NULL) {
 188                 BIO_printf(bio_err,
 189                            "Use one of the options 'sm2-hex-id' or 'sm2-id' \n");
 190                 goto end;
 191             }
 192             sm2_id = (unsigned char *)opt_arg();
 193             sm2_idlen = strlen((const char *)sm2_id);
 194             break;
 195         case OPT_SM2HEXID:
 196             if (sm2_id != NULL) {
 197                 BIO_printf(bio_err,
 198                            "Use one of the options 'sm2-hex-id' or 'sm2-id' \n");
 199                 goto end;
 200             }
 201             /* try to parse the input as hex string first */
 202             sm2_free = 1;
 203             sm2_id = OPENSSL_hexstr2buf(opt_arg(), (long *)&sm2_idlen);
 204             if (sm2_id == NULL) {
 205                 BIO_printf(bio_err, "Invalid hex string input\n");
 206                 goto end;
 207             }
 208             break;
 209         }
 210     }
 211     argc = opt_num_rest();
 212     argv = opt_rest();
 213     if (trusted != NULL
 214         && (CAfile != NULL || CApath != NULL || CAstore != NULL)) {
 215         BIO_printf(bio_err,
 216                    "%s: Cannot use -trusted with -CAfile, -CApath or -CAstore\n",
 217                    prog);
 218         goto end;
 219     }
 220
 221     if ((store = setup_verify(CAfile, noCAfile, CApath, noCApath,
 222                               CAstore, noCAstore)) == NULL)
 223         goto end;
 224     X509_STORE_set_verify_cb(store, cb);
 225
 226     if (vpmtouched)
 227         X509_STORE_set1_param(store, vpm);
 228
 229     ERR_clear_error();
 230
 231     if (crl_download)
 232         store_setup_crl_download(store);
 233
 234     ret = 0;
 235     if (argc < 1) {
 236         if (check(store, NULL, untrusted, trusted, crls, show_chain,
 237                   sm2_id, sm2_idlen) != 1)
 238             ret = -1;
 239     } else {
 240         for (i = 0; i < argc; i++)
 241             if (check(store, argv[i], untrusted, trusted, crls,
 242                       show_chain, sm2_id, sm2_idlen) != 1)
 243                 ret = -1;
 244     }
 245
 246  end:
 247     if (sm2_free)
 248         OPENSSL_free(sm2_id);
 249     X509_VERIFY_PARAM_free(vpm);
 250     X509_STORE_free(store);
 251     sk_X509_pop_free(untrusted, X509_free);
 252     sk_X509_pop_free(trusted, X509_free);
 253     sk_X509_CRL_pop_free(crls, X509_CRL_free);
 254     release_engine(e);
 255     return (ret < 0 ? 2 : ret);
 256 }
 257
 258 static int check(X509_STORE *ctx, const char *file,
 259                  STACK_OF(X509) *uchain, STACK_OF(X509) *tchain,
 260                  STACK_OF(X509_CRL) *crls, int show_chain,
 261                  unsigned char *sm2id, size_t sm2idlen)
 262 {
 263     X509 *x = NULL;
 264     int i = 0, ret = 0;
 265     X509_STORE_CTX *csc;
 266     STACK_OF(X509) *chain = NULL;
 267     int num_untrusted;
 268
 269     x = load_cert(file, FORMAT_PEM, "certificate file");
 270     if (x == NULL)
 271         goto end;
 272
 273     if (sm2id != NULL) {
 274 #ifndef OPENSSL_NO_SM2
 275         ASN1_OCTET_STRING *v;
 276
 277         v = ASN1_OCTET_STRING_new();
 278         if (v == NULL) {
 279             BIO_printf(bio_err, "error: SM2 ID allocation failed\n");
 280             goto end;
 281         }
 282
 283         if (!ASN1_OCTET_STRING_set(v, sm2id, sm2idlen)) {
 284             BIO_printf(bio_err, "error: setting SM2 ID failed\n");
 285             ASN1_OCTET_STRING_free(v);
 286             goto end;
 287         }
 288
 289         X509_set0_sm2_id(x, v);
 290 #endif
 291     }
 292
 293     csc = X509_STORE_CTX_new();
 294     if (csc == NULL) {
 295         BIO_printf(bio_err, "error %s: X.509 store context allocation failed\n",
 296                    (file == NULL) ? "stdin" : file);
 297         goto end;
 298     }
 299
 300     X509_STORE_set_flags(ctx, vflags);
 301     if (!X509_STORE_CTX_init(csc, ctx, x, uchain)) {
 302         X509_STORE_CTX_free(csc);
 303         BIO_printf(bio_err,
 304                    "error %s: X.509 store context initialization failed\n",
 305                    (file == NULL) ? "stdin" : file);
 306         goto end;
 307     }
 308     if (tchain != NULL)
 309         X509_STORE_CTX_set0_trusted_stack(csc, tchain);
 310     if (crls != NULL)
 311         X509_STORE_CTX_set0_crls(csc, crls);
 312     i = X509_verify_cert(csc);
 313     if (i > 0 && X509_STORE_CTX_get_error(csc) == X509_V_OK) {
 314         BIO_printf(bio_out, "%s: OK\n", (file == NULL) ? "stdin" : file);
 315         ret = 1;
 316         if (show_chain) {
 317             int j;
 318
 319             chain = X509_STORE_CTX_get1_chain(csc);
 320             num_untrusted = X509_STORE_CTX_get_num_untrusted(csc);
 321             BIO_printf(bio_out, "Chain:\n");
 322             for (j = 0; j < sk_X509_num(chain); j++) {
 323                 X509 *cert = sk_X509_value(chain, j);
 324                 BIO_printf(bio_out, "depth=%d: ", j);
 325                 X509_NAME_print_ex_fp(stdout,
 326                                       X509_get_subject_name(cert),
 327                                       0, get_nameopt());
 328                 if (j < num_untrusted)
 329                     BIO_printf(bio_out, " (untrusted)");
 330                 BIO_printf(bio_out, "\n");
 331             }
 332             sk_X509_pop_free(chain, X509_free);
 333         }
 334     } else {
 335         BIO_printf(bio_err,
 336                    "error %s: verification failed\n",
 337                    (file == NULL) ? "stdin" : file);
 338     }
 339     X509_STORE_CTX_free(csc);
 340
 341  end:
 342     if (i <= 0)
 343         ERR_print_errors(bio_err);
 344     X509_free(x);
 345
 346     return ret;
 347 }
 348
 349 static int cb(int ok, X509_STORE_CTX *ctx)
 350 {
 351     int cert_error = X509_STORE_CTX_get_error(ctx);
 352     X509 *current_cert = X509_STORE_CTX_get_current_cert(ctx);
 353
 354     if (!ok) {
 355         if (current_cert != NULL) {
 356             X509_NAME_print_ex(bio_err,
 357                             X509_get_subject_name(current_cert),
 358                             0, get_nameopt());
 359             BIO_printf(bio_err, "\n");
 360         }
 361         BIO_printf(bio_err, "%serror %d at %d depth lookup: %s\n",
 362                X509_STORE_CTX_get0_parent_ctx(ctx) ? "[CRL path] " : "",
 363                cert_error,
 364                X509_STORE_CTX_get_error_depth(ctx),
 365                X509_verify_cert_error_string(cert_error));
 366
 367         /*
 368          * Pretend that some errors are ok, so they don't stop further
 369          * processing of the certificate chain.  Setting ok = 1 does this.
 370          * After X509_verify_cert() is done, we verify that there were
 371          * no actual errors, even if the returned value was positive.
 372          */
 373         switch (cert_error) {
 374         case X509_V_ERR_NO_EXPLICIT_POLICY:
 375             policies_print(ctx);
 376             /* fall thru */
 377         case X509_V_ERR_CERT_HAS_EXPIRED:
 378             /* Continue even if the leaf is a self signed cert */
 379         case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT:
 380             /* Continue after extension errors too */
 381         case X509_V_ERR_INVALID_CA:
 382         case X509_V_ERR_INVALID_NON_CA:
 383         case X509_V_ERR_PATH_LENGTH_EXCEEDED:
 384         case X509_V_ERR_INVALID_PURPOSE:
 385         case X509_V_ERR_CRL_HAS_EXPIRED:
 386         case X509_V_ERR_CRL_NOT_YET_VALID:
 387         case X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION:
 388             ok = 1;
 389         }
 390
 391         return ok;
 392
 393     }
 394     if (cert_error == X509_V_OK && ok == 2)
 395         policies_print(ctx);
 396     if (!v_verbose)
 397         ERR_clear_error();
 398     return ok;
 399 }