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