crypto/x509/t_x509.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 "internal/cryptlib.h"
  12 #include <openssl/buffer.h>
  13 #include <openssl/bn.h>
  14 #include <openssl/objects.h>
  15 #include <openssl/x509.h>
  16 #include <openssl/x509v3.h>
  17 #include "crypto/asn1.h"
  18 #include "crypto/x509.h"
  19
  20 DEFINE_STACK_OF(ASN1_OBJECT)
  21
  22 #ifndef OPENSSL_NO_STDIO
  23 int X509_print_fp(FILE *fp, X509 *x)
  24 {
  25     return X509_print_ex_fp(fp, x, XN_FLAG_COMPAT, X509_FLAG_COMPAT);
  26 }
  27
  28 int X509_print_ex_fp(FILE *fp, X509 *x, unsigned long nmflag,
  29                      unsigned long cflag)
  30 {
  31     BIO *b;
  32     int ret;
  33
  34     if ((b = BIO_new(BIO_s_file())) == NULL) {
  35         X509err(X509_F_X509_PRINT_EX_FP, ERR_R_BUF_LIB);
  36         return 0;
  37     }
  38     BIO_set_fp(b, fp, BIO_NOCLOSE);
  39     ret = X509_print_ex(b, x, nmflag, cflag);
  40     BIO_free(b);
  41     return ret;
  42 }
  43 #endif
  44
  45 int X509_print(BIO *bp, X509 *x)
  46 {
  47     return X509_print_ex(bp, x, XN_FLAG_COMPAT, X509_FLAG_COMPAT);
  48 }
  49
  50 int X509_print_ex(BIO *bp, X509 *x, unsigned long nmflags,
  51                   unsigned long cflag)
  52 {
  53     long l;
  54     int ret = 0, i;
  55     char *m = NULL, mlch = ' ';
  56     int nmindent = 0;
  57     EVP_PKEY *pkey = NULL;
  58     const char *neg;
  59
  60     if ((nmflags & XN_FLAG_SEP_MASK) == XN_FLAG_SEP_MULTILINE) {
  61         mlch = '\n';
  62         nmindent = 12;
  63     }
  64
  65     if (nmflags == X509_FLAG_COMPAT)
  66         nmindent = 16;
  67
  68     if (!(cflag & X509_FLAG_NO_HEADER)) {
  69         if (BIO_write(bp, "Certificate:\n", 13) <= 0)
  70             goto err;
  71         if (BIO_write(bp, "    Data:\n", 10) <= 0)
  72             goto err;
  73     }
  74     if (!(cflag & X509_FLAG_NO_VERSION)) {
  75         l = X509_get_version(x);
  76         if (l >= 0 && l <= 2) {
  77             if (BIO_printf(bp, "%8sVersion: %ld (0x%lx)\n", "", l + 1, (unsigned long)l) <= 0)
  78                 goto err;
  79         } else {
  80             if (BIO_printf(bp, "%8sVersion: Unknown (%ld)\n", "", l) <= 0)
  81                 goto err;
  82         }
  83     }
  84     if (!(cflag & X509_FLAG_NO_SERIAL)) {
  85         const ASN1_INTEGER *bs = X509_get0_serialNumber(x);
  86
  87         if (BIO_write(bp, "        Serial Number:", 22) <= 0)
  88             goto err;
  89
  90         if (bs->length <= (int)sizeof(long)) {
  91                 ERR_set_mark();
  92                 l = ASN1_INTEGER_get(bs);
  93                 ERR_pop_to_mark();
  94         } else {
  95             l = -1;
  96         }
  97         if (l != -1) {
  98             unsigned long ul;
  99             if (bs->type == V_ASN1_NEG_INTEGER) {
 100                 ul = 0 - (unsigned long)l;
 101                 neg = "-";
 102             } else {
 103                 ul = l;
 104                 neg = "";
 105             }
 106             if (BIO_printf(bp, " %s%lu (%s0x%lx)\n", neg, ul, neg, ul) <= 0)
 107                 goto err;
 108         } else {
 109             neg = (bs->type == V_ASN1_NEG_INTEGER) ? " (Negative)" : "";
 110             if (BIO_printf(bp, "\n%12s%s", "", neg) <= 0)
 111                 goto err;
 112
 113             for (i = 0; i < bs->length; i++) {
 114                 if (BIO_printf(bp, "%02x%c", bs->data[i],
 115                                ((i + 1 == bs->length) ? '\n' : ':')) <= 0)
 116                     goto err;
 117             }
 118         }
 119
 120     }
 121
 122     if (!(cflag & X509_FLAG_NO_SIGNAME)) {
 123         const X509_ALGOR *tsig_alg = X509_get0_tbs_sigalg(x);
 124
 125         if (BIO_puts(bp, "    ") <= 0)
 126             goto err;
 127         if (X509_signature_print(bp, tsig_alg, NULL) <= 0)
 128             goto err;
 129     }
 130
 131     if (!(cflag & X509_FLAG_NO_ISSUER)) {
 132         if (BIO_printf(bp, "        Issuer:%c", mlch) <= 0)
 133             goto err;
 134         if (X509_NAME_print_ex(bp, X509_get_issuer_name(x), nmindent, nmflags)
 135             < 0)
 136             goto err;
 137         if (BIO_write(bp, "\n", 1) <= 0)
 138             goto err;
 139     }
 140     if (!(cflag & X509_FLAG_NO_VALIDITY)) {
 141         if (BIO_write(bp, "        Validity\n", 17) <= 0)
 142             goto err;
 143         if (BIO_write(bp, "            Not Before: ", 24) <= 0)
 144             goto err;
 145         if (!ASN1_TIME_print(bp, X509_get0_notBefore(x)))
 146             goto err;
 147         if (BIO_write(bp, "\n            Not After : ", 25) <= 0)
 148             goto err;
 149         if (!ASN1_TIME_print(bp, X509_get0_notAfter(x)))
 150             goto err;
 151         if (BIO_write(bp, "\n", 1) <= 0)
 152             goto err;
 153     }
 154     if (!(cflag & X509_FLAG_NO_SUBJECT)) {
 155         if (BIO_printf(bp, "        Subject:%c", mlch) <= 0)
 156             goto err;
 157         if (X509_NAME_print_ex
 158             (bp, X509_get_subject_name(x), nmindent, nmflags) < 0)
 159             goto err;
 160         if (BIO_write(bp, "\n", 1) <= 0)
 161             goto err;
 162     }
 163     if (!(cflag & X509_FLAG_NO_PUBKEY)) {
 164         X509_PUBKEY *xpkey = X509_get_X509_PUBKEY(x);
 165         ASN1_OBJECT *xpoid;
 166         X509_PUBKEY_get0_param(&xpoid, NULL, NULL, NULL, xpkey);
 167         if (BIO_write(bp, "        Subject Public Key Info:\n", 33) <= 0)
 168             goto err;
 169         if (BIO_printf(bp, "%12sPublic Key Algorithm: ", "") <= 0)
 170             goto err;
 171         if (i2a_ASN1_OBJECT(bp, xpoid) <= 0)
 172             goto err;
 173         if (BIO_puts(bp, "\n") <= 0)
 174             goto err;
 175
 176         pkey = X509_get0_pubkey(x);
 177         if (pkey == NULL) {
 178             BIO_printf(bp, "%12sUnable to load Public Key\n", "");
 179             ERR_print_errors(bp);
 180         } else {
 181             EVP_PKEY_print_public(bp, pkey, 16, NULL);
 182         }
 183     }
 184
 185     if (!(cflag & X509_FLAG_NO_IDS)) {
 186         const ASN1_BIT_STRING *iuid, *suid;
 187         X509_get0_uids(x, &iuid, &suid);
 188         if (iuid != NULL) {
 189             if (BIO_printf(bp, "%8sIssuer Unique ID: ", "") <= 0)
 190                 goto err;
 191             if (!X509_signature_dump(bp, iuid, 12))
 192                 goto err;
 193         }
 194         if (suid != NULL) {
 195             if (BIO_printf(bp, "%8sSubject Unique ID: ", "") <= 0)
 196                 goto err;
 197             if (!X509_signature_dump(bp, suid, 12))
 198                 goto err;
 199         }
 200     }
 201
 202     if (!(cflag & X509_FLAG_NO_EXTENSIONS)
 203         && !X509V3_extensions_print(bp, "X509v3 extensions",
 204                                     X509_get0_extensions(x), cflag, 8))
 205         goto err;
 206
 207     if (!(cflag & X509_FLAG_NO_SIGDUMP)) {
 208         const X509_ALGOR *sig_alg;
 209         const ASN1_BIT_STRING *sig;
 210         X509_get0_signature(&sig, &sig_alg, x);
 211         if (X509_signature_print(bp, sig_alg, sig) <= 0)
 212             goto err;
 213     }
 214     if (!(cflag & X509_FLAG_NO_AUX)) {
 215         if (!X509_aux_print(bp, x, 0))
 216             goto err;
 217     }
 218     ret = 1;
 219  err:
 220     OPENSSL_free(m);
 221     return ret;
 222 }
 223
 224 int X509_ocspid_print(BIO *bp, X509 *x)
 225 {
 226     unsigned char *der = NULL;
 227     unsigned char *dertmp;
 228     int derlen;
 229     int i;
 230     unsigned char SHA1md[SHA_DIGEST_LENGTH];
 231     ASN1_BIT_STRING *keybstr;
 232     const X509_NAME *subj;
 233
 234     /*
 235      * display the hash of the subject as it would appear in OCSP requests
 236      */
 237     if (BIO_printf(bp, "        Subject OCSP hash: ") <= 0)
 238         goto err;
 239     subj = X509_get_subject_name(x);
 240     derlen = i2d_X509_NAME(subj, NULL);
 241     if ((der = dertmp = OPENSSL_malloc(derlen)) == NULL)
 242         goto err;
 243     i2d_X509_NAME(subj, &dertmp);
 244
 245     if (!EVP_Digest(der, derlen, SHA1md, NULL, EVP_sha1(), NULL))
 246         goto err;
 247     for (i = 0; i < SHA_DIGEST_LENGTH; i++) {
 248         if (BIO_printf(bp, "%02X", SHA1md[i]) <= 0)
 249             goto err;
 250     }
 251     OPENSSL_free(der);
 252     der = NULL;
 253
 254     /*
 255      * display the hash of the public key as it would appear in OCSP requests
 256      */
 257     if (BIO_printf(bp, "\n        Public key OCSP hash: ") <= 0)
 258         goto err;
 259
 260     keybstr = X509_get0_pubkey_bitstr(x);
 261
 262     if (keybstr == NULL)
 263         goto err;
 264
 265     if (!EVP_Digest(ASN1_STRING_get0_data(keybstr),
 266                     ASN1_STRING_length(keybstr), SHA1md, NULL, EVP_sha1(),
 267                     NULL))
 268         goto err;
 269     for (i = 0; i < SHA_DIGEST_LENGTH; i++) {
 270         if (BIO_printf(bp, "%02X", SHA1md[i]) <= 0)
 271             goto err;
 272     }
 273     BIO_printf(bp, "\n");
 274
 275     return 1;
 276  err:
 277     OPENSSL_free(der);
 278     return 0;
 279 }
 280
 281 int X509_signature_dump(BIO *bp, const ASN1_STRING *sig, int indent)
 282 {
 283     const unsigned char *s;
 284     int i, n;
 285
 286     n = sig->length;
 287     s = sig->data;
 288     for (i = 0; i < n; i++) {
 289         if ((i % 18) == 0) {
 290             if (i > 0 && BIO_write(bp, "\n", 1) <= 0)
 291                 return 0;
 292             if (BIO_indent(bp, indent, indent) <= 0)
 293                 return 0;
 294         }
 295         if (BIO_printf(bp, "%02x%s", s[i], ((i + 1) == n) ? "" : ":") <= 0)
 296             return 0;
 297     }
 298     if (BIO_write(bp, "\n", 1) != 1)
 299         return 0;
 300
 301     return 1;
 302 }
 303
 304 int X509_signature_print(BIO *bp, const X509_ALGOR *sigalg,
 305                          const ASN1_STRING *sig)
 306 {
 307     int sig_nid;
 308     int indent = 4;
 309     if (BIO_printf(bp, "%*sSignature Algorithm: ", indent, "") <= 0)
 310         return 0;
 311     if (i2a_ASN1_OBJECT(bp, sigalg->algorithm) <= 0)
 312         return 0;
 313
 314     if (sig && BIO_printf(bp, "\n%*sSignature Value:", indent, "") <= 0)
 315         return 0;
 316     sig_nid = OBJ_obj2nid(sigalg->algorithm);
 317     if (sig_nid != NID_undef) {
 318         int pkey_nid, dig_nid;
 319         const EVP_PKEY_ASN1_METHOD *ameth;
 320         if (OBJ_find_sigid_algs(sig_nid, &dig_nid, &pkey_nid)) {
 321             ameth = EVP_PKEY_asn1_find(NULL, pkey_nid);
 322             if (ameth && ameth->sig_print)
 323                 return ameth->sig_print(bp, sigalg, sig, indent + 4, 0);
 324         }
 325     }
 326     if (BIO_write(bp, "\n", 1) != 1)
 327         return 0;
 328     if (sig)
 329         return X509_signature_dump(bp, sig, indent + 4);
 330     return 1;
 331 }
 332
 333 int X509_aux_print(BIO *out, X509 *x, int indent)
 334 {
 335     char oidstr[80], first;
 336     STACK_OF(ASN1_OBJECT) *trust, *reject;
 337     const unsigned char *alias, *keyid;
 338     int keyidlen;
 339     int i;
 340     if (X509_trusted(x) == 0)
 341         return 1;
 342     trust = X509_get0_trust_objects(x);
 343     reject = X509_get0_reject_objects(x);
 344     if (trust) {
 345         first = 1;
 346         BIO_printf(out, "%*sTrusted Uses:\n%*s", indent, "", indent + 2, "");
 347         for (i = 0; i < sk_ASN1_OBJECT_num(trust); i++) {
 348             if (!first)
 349                 BIO_puts(out, ", ");
 350             else
 351                 first = 0;
 352             OBJ_obj2txt(oidstr, sizeof(oidstr),
 353                         sk_ASN1_OBJECT_value(trust, i), 0);
 354             BIO_puts(out, oidstr);
 355         }
 356         BIO_puts(out, "\n");
 357     } else
 358         BIO_printf(out, "%*sNo Trusted Uses.\n", indent, "");
 359     if (reject) {
 360         first = 1;
 361         BIO_printf(out, "%*sRejected Uses:\n%*s", indent, "", indent + 2, "");
 362         for (i = 0; i < sk_ASN1_OBJECT_num(reject); i++) {
 363             if (!first)
 364                 BIO_puts(out, ", ");
 365             else
 366                 first = 0;
 367             OBJ_obj2txt(oidstr, sizeof(oidstr),
 368                         sk_ASN1_OBJECT_value(reject, i), 0);
 369             BIO_puts(out, oidstr);
 370         }
 371         BIO_puts(out, "\n");
 372     } else
 373         BIO_printf(out, "%*sNo Rejected Uses.\n", indent, "");
 374     alias = X509_alias_get0(x, NULL);
 375     if (alias)
 376         BIO_printf(out, "%*sAlias: %s\n", indent, "", alias);
 377     keyid = X509_keyid_get0(x, &keyidlen);
 378     if (keyid) {
 379         BIO_printf(out, "%*sKey Id: ", indent, "");
 380         for (i = 0; i < keyidlen; i++)
 381             BIO_printf(out, "%s%02X", i ? ":" : "", keyid[i]);
 382         BIO_write(out, "\n", 1);
 383     }
 384     return 1;
 385 }
 386
 387 /*
 388  * Helper functions for improving certificate verification error diagnostics
 389  */
 390
 391 int x509_print_ex_brief(BIO *bio, X509 *cert, unsigned long neg_cflags)
 392 {
 393     unsigned long flags = ASN1_STRFLGS_RFC2253 | ASN1_STRFLGS_ESC_QUOTE |
 394         XN_FLAG_SEP_CPLUS_SPC | XN_FLAG_FN_SN;
 395
 396     if (cert == NULL)
 397         return BIO_printf(bio, "    (no certificate)\n") > 0;
 398     if (BIO_printf(bio, "    certificate\n") <= 0
 399             || !X509_print_ex(bio, cert, flags, ~X509_FLAG_NO_SUBJECT))
 400         return 0;
 401     if (X509_check_issued((X509 *)cert, cert) == X509_V_OK) {
 402         if (BIO_printf(bio, "        self-issued\n") <= 0)
 403             return 0;
 404     } else {
 405         if (BIO_printf(bio, " ") <= 0
 406             || !X509_print_ex(bio, cert, flags, ~X509_FLAG_NO_ISSUER))
 407             return 0;
 408     }
 409     if (!X509_print_ex(bio, cert, flags,
 410                        ~(X509_FLAG_NO_SERIAL | X509_FLAG_NO_VALIDITY)))
 411         return 0;
 412     if (X509_cmp_current_time(X509_get0_notBefore(cert)) > 0)
 413         if (BIO_printf(bio, "        not yet valid\n") <= 0)
 414             return 0;
 415     if (X509_cmp_current_time(X509_get0_notAfter(cert)) < 0)
 416         if (BIO_printf(bio, "        no more valid\n") <= 0)
 417             return 0;
 418     return X509_print_ex(bio, cert, flags,
 419                          ~neg_cflags & ~X509_FLAG_EXTENSIONS_ONLY_KID);
 420 }
 421
 422 static int print_certs(BIO *bio, const STACK_OF(X509) *certs)
 423 {
 424     int i;
 425
 426     if (certs == NULL || sk_X509_num(certs) <= 0)
 427         return BIO_printf(bio, "    (no certificates)\n") >= 0;
 428
 429     for (i = 0; i < sk_X509_num(certs); i++) {
 430         X509 *cert = sk_X509_value(certs, i);
 431
 432         if (cert != NULL) {
 433             if (!x509_print_ex_brief(bio, cert, 0))
 434                 return 0;
 435             if (!X509V3_extensions_print(bio, NULL,
 436                                          X509_get0_extensions(cert),
 437                                          X509_FLAG_EXTENSIONS_ONLY_KID, 8))
 438                 return 0;
 439             }
 440     }
 441     return 1;
 442 }
 443
 444 static int print_store_certs(BIO *bio, X509_STORE *store)
 445 {
 446     if (store != NULL) {
 447         STACK_OF(X509) *certs = X509_STORE_get1_all_certs(store);
 448         int ret = print_certs(bio, certs);
 449
 450         sk_X509_pop_free(certs, X509_free);
 451         return ret;
 452     } else {
 453         return BIO_printf(bio, "    (no trusted store)\n") >= 0;
 454     }
 455 }
 456
 457 /* Extend the error queue with details on a failed cert verification */
 458 int X509_STORE_CTX_print_verify_cb(int ok, X509_STORE_CTX *ctx)
 459 {
 460     if (ok == 0 && ctx != NULL) {
 461         int cert_error = X509_STORE_CTX_get_error(ctx);
 462         BIO *bio = BIO_new(BIO_s_mem()); /* may be NULL */
 463
 464         BIO_printf(bio, "%s at depth = %d error = %d (%s)\n",
 465                    X509_STORE_CTX_get0_parent_ctx(ctx) != NULL
 466                    ? "CRL path validation"
 467                    : "Certificate verification",
 468                    X509_STORE_CTX_get_error_depth(ctx),
 469                    cert_error, X509_verify_cert_error_string(cert_error));
 470         {
 471             X509_STORE *ts = X509_STORE_CTX_get0_store(ctx);
 472             X509_VERIFY_PARAM *vpm = X509_STORE_get0_param(ts);
 473             char *str;
 474             int idx = 0;
 475
 476             switch (cert_error) {
 477             case X509_V_ERR_HOSTNAME_MISMATCH:
 478                 BIO_printf(bio, "Expected hostname(s) = ");
 479                 while ((str = X509_VERIFY_PARAM_get0_host(vpm, idx++)) != NULL)
 480                     BIO_printf(bio, "%s%s", idx == 1 ? "" : ", ", str);
 481                 BIO_printf(bio, "\n");
 482                 break;
 483             case X509_V_ERR_EMAIL_MISMATCH:
 484                 str = X509_VERIFY_PARAM_get0_email(vpm);
 485                 if (str != NULL)
 486                     BIO_printf(bio, "Expected email address = %s\n", str);
 487                 break;
 488             case X509_V_ERR_IP_ADDRESS_MISMATCH:
 489                 str = X509_VERIFY_PARAM_get1_ip_asc(vpm);
 490                 if (str != NULL)
 491                     BIO_printf(bio, "Expected IP address = %s\n", str);
 492                 OPENSSL_free(str);
 493                 break;
 494             default:
 495                 break;
 496             }
 497         }
 498
 499         BIO_printf(bio, "Failure for:\n");
 500         x509_print_ex_brief(bio, X509_STORE_CTX_get_current_cert(ctx),
 501                             X509_FLAG_NO_EXTENSIONS);
 502         if (cert_error == X509_V_ERR_CERT_UNTRUSTED
 503                 || cert_error == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
 504                 || cert_error == X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN
 505                 || cert_error == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT
 506                 || cert_error == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY
 507                 || cert_error == X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER
 508                 || cert_error == X509_V_ERR_STORE_LOOKUP) {
 509             BIO_printf(bio, "Non-trusted certs:\n");
 510             print_certs(bio, X509_STORE_CTX_get0_untrusted(ctx));
 511             BIO_printf(bio, "Certs in trust store:\n");
 512             print_store_certs(bio, X509_STORE_CTX_get0_store(ctx));
 513         }
 514         X509err(0, X509_R_CERTIFICATE_VERIFICATION_FAILED);
 515         ERR_add_error_mem_bio("\n", bio);
 516         BIO_free(bio);
 517     }
 518
 519     /*
 520      * TODO we could check policies here too, e.g.:
 521      * if (cert_error == X509_V_OK && ok == 2)
 522      *     policies_print(NULL, ctx);
 523      */
 524
 525     return ok;
 526 }