crypto/x509/t_x509.c

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