crypto/x509/t_x509.c

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