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