apps/verify.c

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