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