crypto/x509/x509_cmp.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/asn1.h>
  13 #include <openssl/objects.h>
  14 #include <openssl/x509.h>
  15 #include <openssl/x509v3.h>
  16 #include <openssl/core_names.h>
  17 #include "crypto/x509.h"
  18
  19 int X509_issuer_and_serial_cmp(const X509 *a, const X509 *b)
  20 {
  21     int i;
  22     const X509_CINF *ai, *bi;
  23
  24     if (b == NULL)
  25         return a != NULL;
  26     if (a == NULL)
  27         return -1;
  28     ai = &a->cert_info;
  29     bi = &b->cert_info;
  30     i = ASN1_INTEGER_cmp(&ai->serialNumber, &bi->serialNumber);
  31     if (i != 0)
  32         return i < 0 ? -1 : 1;
  33     return X509_NAME_cmp(ai->issuer, bi->issuer);
  34 }
  35
  36 #ifndef OPENSSL_NO_MD5
  37 unsigned long X509_issuer_and_serial_hash(X509 *a)
  38 {
  39     unsigned long ret = 0;
  40     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
  41     unsigned char md[16];
  42     char *f;
  43
  44     if (ctx == NULL)
  45         goto err;
  46     f = X509_NAME_oneline(a->cert_info.issuer, NULL, 0);
  47     if (!EVP_DigestInit_ex(ctx, EVP_md5(), NULL))
  48         goto err;
  49     if (!EVP_DigestUpdate(ctx, (unsigned char *)f, strlen(f)))
  50         goto err;
  51     OPENSSL_free(f);
  52     if (!EVP_DigestUpdate
  53         (ctx, (unsigned char *)a->cert_info.serialNumber.data,
  54          (unsigned long)a->cert_info.serialNumber.length))
  55         goto err;
  56     if (!EVP_DigestFinal_ex(ctx, &(md[0]), NULL))
  57         goto err;
  58     ret = (((unsigned long)md[0]) | ((unsigned long)md[1] << 8L) |
  59            ((unsigned long)md[2] << 16L) | ((unsigned long)md[3] << 24L)
  60         ) & 0xffffffffL;
  61  err:
  62     EVP_MD_CTX_free(ctx);
  63     return ret;
  64 }
  65 #endif
  66
  67 int X509_issuer_name_cmp(const X509 *a, const X509 *b)
  68 {
  69     return X509_NAME_cmp(a->cert_info.issuer, b->cert_info.issuer);
  70 }
  71
  72 int X509_subject_name_cmp(const X509 *a, const X509 *b)
  73 {
  74     return X509_NAME_cmp(a->cert_info.subject, b->cert_info.subject);
  75 }
  76
  77 int X509_CRL_cmp(const X509_CRL *a, const X509_CRL *b)
  78 {
  79     return X509_NAME_cmp(a->crl.issuer, b->crl.issuer);
  80 }
  81
  82 int X509_CRL_match(const X509_CRL *a, const X509_CRL *b)
  83 {
  84     int rv = memcmp(a->sha1_hash, b->sha1_hash, 20);
  85
  86     return rv < 0 ? -1 : rv > 0;
  87 }
  88
  89 X509_NAME *X509_get_issuer_name(const X509 *a)
  90 {
  91     return a->cert_info.issuer;
  92 }
  93
  94 unsigned long X509_issuer_name_hash(X509 *x)
  95 {
  96     return X509_NAME_hash(x->cert_info.issuer);
  97 }
  98
  99 #ifndef OPENSSL_NO_MD5
 100 unsigned long X509_issuer_name_hash_old(X509 *x)
 101 {
 102     return X509_NAME_hash_old(x->cert_info.issuer);
 103 }
 104 #endif
 105
 106 X509_NAME *X509_get_subject_name(const X509 *a)
 107 {
 108     return a->cert_info.subject;
 109 }
 110
 111 ASN1_INTEGER *X509_get_serialNumber(X509 *a)
 112 {
 113     return &a->cert_info.serialNumber;
 114 }
 115
 116 const ASN1_INTEGER *X509_get0_serialNumber(const X509 *a)
 117 {
 118     return &a->cert_info.serialNumber;
 119 }
 120
 121 unsigned long X509_subject_name_hash(X509 *x)
 122 {
 123     return X509_NAME_hash(x->cert_info.subject);
 124 }
 125
 126 #ifndef OPENSSL_NO_MD5
 127 unsigned long X509_subject_name_hash_old(X509 *x)
 128 {
 129     return X509_NAME_hash_old(x->cert_info.subject);
 130 }
 131 #endif
 132
 133 /*
 134  * Compare two certificates: they must be identical for this to work. NB:
 135  * Although "cmp" operations are generally prototyped to take "const"
 136  * arguments (eg. for use in STACKs), the way X509 handling is - these
 137  * operations may involve ensuring the hashes are up-to-date and ensuring
 138  * certain cert information is cached. So this is the point where the
 139  * "depth-first" constification tree has to halt with an evil cast.
 140  */
 141 int X509_cmp(const X509 *a, const X509 *b)
 142 {
 143     int rv;
 144
 145     /* ensure hash is valid */
 146     if (X509_check_purpose((X509 *)a, -1, 0) != 1)
 147         return -2;
 148     if (X509_check_purpose((X509 *)b, -1, 0) != 1)
 149         return -2;
 150
 151     rv = memcmp(a->sha1_hash, b->sha1_hash, SHA_DIGEST_LENGTH);
 152     if (rv != 0)
 153         return rv < 0 ? -1 : 1;
 154     /* Check for match against stored encoding too */
 155     if (!a->cert_info.enc.modified && !b->cert_info.enc.modified) {
 156         if (a->cert_info.enc.len < b->cert_info.enc.len)
 157             return -1;
 158         if (a->cert_info.enc.len > b->cert_info.enc.len)
 159             return 1;
 160         rv = memcmp(a->cert_info.enc.enc,
 161                     b->cert_info.enc.enc, a->cert_info.enc.len);
 162     }
 163     return rv < 0 ? -1 : rv > 0;
 164 }
 165
 166 int X509_add_cert_new(STACK_OF(X509) **sk, X509 *cert, int flags)
 167 {
 168     if (*sk == NULL
 169             && (*sk = sk_X509_new_null()) == NULL) {
 170         X509err(0, ERR_R_MALLOC_FAILURE);
 171         return 0;
 172     }
 173     return X509_add_cert(*sk, cert, flags);
 174 }
 175
 176 int X509_add_cert(STACK_OF(X509) *sk, X509 *cert, int flags)
 177 {
 178     if (sk == NULL) {
 179         X509err(0, ERR_R_PASSED_NULL_PARAMETER);
 180         return 0;
 181     }
 182     if ((flags & X509_ADD_FLAG_NO_DUP) != 0) {
 183         /*
 184          * not using sk_X509_set_cmp_func() and sk_X509_find()
 185          * because this re-orders the certs on the stack
 186          */
 187         int i;
 188
 189         for (i = 0; i < sk_X509_num(sk); i++) {
 190             if (X509_cmp(sk_X509_value(sk, i), cert) == 0)
 191                 return 1;
 192         }
 193     }
 194     if ((flags & X509_ADD_FLAG_NO_SS) != 0 && X509_self_signed(cert, 0))
 195         return 1;
 196     if (!sk_X509_insert(sk, cert,
 197                         (flags & X509_ADD_FLAG_PREPEND) != 0 ? 0 : -1)) {
 198         X509err(0, ERR_R_MALLOC_FAILURE);
 199         return 0;
 200     }
 201     if ((flags & X509_ADD_FLAG_UP_REF) != 0)
 202         (void)X509_up_ref(cert);
 203     return 1;
 204 }
 205
 206 int X509_add_certs(STACK_OF(X509) *sk, STACK_OF(X509) *certs, int flags)
 207 /* compiler would allow 'const' for the list of certs, yet they are up-ref'ed */
 208 {
 209     int n = sk_X509_num(certs); /* certs may be NULL */
 210     int i;
 211
 212     for (i = 0; i < n; i++) {
 213         int j = (flags & X509_ADD_FLAG_PREPEND) == 0 ? i : n - 1 - i;
 214         /* if prepend, add certs in reverse order to keep original order */
 215
 216         if (!X509_add_cert(sk, sk_X509_value(certs, j), flags))
 217             return 0;
 218     }
 219     return 1;
 220 }
 221
 222 int X509_NAME_cmp(const X509_NAME *a, const X509_NAME *b)
 223 {
 224     int ret;
 225
 226     if (b == NULL)
 227         return a != NULL;
 228     if (a == NULL)
 229         return -1;
 230
 231     /* Ensure canonical encoding is present and up to date */
 232     if (!a->canon_enc || a->modified) {
 233         ret = i2d_X509_NAME((X509_NAME *)a, NULL);
 234         if (ret < 0)
 235             return -2;
 236     }
 237
 238     if (!b->canon_enc || b->modified) {
 239         ret = i2d_X509_NAME((X509_NAME *)b, NULL);
 240         if (ret < 0)
 241             return -2;
 242     }
 243
 244     ret = a->canon_enclen - b->canon_enclen;
 245     if (ret == 0 && a->canon_enclen != 0)
 246         ret = memcmp(a->canon_enc, b->canon_enc, a->canon_enclen);
 247
 248     return ret < 0 ? -1 : ret > 0;
 249 }
 250
 251 unsigned long X509_NAME_hash(const X509_NAME *x)
 252 {
 253     unsigned long ret = 0;
 254     unsigned char md[SHA_DIGEST_LENGTH];
 255
 256     /* Make sure X509_NAME structure contains valid cached encoding */
 257     i2d_X509_NAME(x, NULL);
 258     if (!EVP_Digest(x->canon_enc, x->canon_enclen, md, NULL, EVP_sha1(),
 259                     NULL))
 260         return 0;
 261
 262     ret = (((unsigned long)md[0]) | ((unsigned long)md[1] << 8L) |
 263            ((unsigned long)md[2] << 16L) | ((unsigned long)md[3] << 24L)
 264         ) & 0xffffffffL;
 265     return ret;
 266 }
 267
 268 #ifndef OPENSSL_NO_MD5
 269 /*
 270  * I now DER encode the name and hash it.  Since I cache the DER encoding,
 271  * this is reasonably efficient.
 272  */
 273
 274 unsigned long X509_NAME_hash_old(const X509_NAME *x)
 275 {
 276     EVP_MD *md5 = EVP_MD_fetch(NULL, OSSL_DIGEST_NAME_MD5, "-fips");
 277     EVP_MD_CTX *md_ctx = EVP_MD_CTX_new();
 278     unsigned long ret = 0;
 279     unsigned char md[16];
 280
 281     if (md5 == NULL || md_ctx == NULL)
 282         goto end;
 283
 284     /* Make sure X509_NAME structure contains valid cached encoding */
 285     i2d_X509_NAME(x, NULL);
 286     if (EVP_DigestInit_ex(md_ctx, md5, NULL)
 287         && EVP_DigestUpdate(md_ctx, x->bytes->data, x->bytes->length)
 288         && EVP_DigestFinal_ex(md_ctx, md, NULL))
 289         ret = (((unsigned long)md[0]) | ((unsigned long)md[1] << 8L) |
 290                ((unsigned long)md[2] << 16L) | ((unsigned long)md[3] << 24L)
 291             ) & 0xffffffffL;
 292
 293  end:
 294     EVP_MD_CTX_free(md_ctx);
 295     EVP_MD_free(md5);
 296
 297     return ret;
 298 }
 299 #endif
 300
 301 /* Search a stack of X509 for a match */
 302 X509 *X509_find_by_issuer_and_serial(STACK_OF(X509) *sk, const X509_NAME *name,
 303                                      const ASN1_INTEGER *serial)
 304 {
 305     int i;
 306     X509 x, *x509 = NULL;
 307
 308     if (!sk)
 309         return NULL;
 310
 311     x.cert_info.serialNumber = *serial;
 312     x.cert_info.issuer = (X509_NAME *)name; /* won't modify it */
 313
 314     for (i = 0; i < sk_X509_num(sk); i++) {
 315         x509 = sk_X509_value(sk, i);
 316         if (X509_issuer_and_serial_cmp(x509, &x) == 0)
 317             return x509;
 318     }
 319     return NULL;
 320 }
 321
 322 X509 *X509_find_by_subject(STACK_OF(X509) *sk, const X509_NAME *name)
 323 {
 324     X509 *x509;
 325     int i;
 326
 327     for (i = 0; i < sk_X509_num(sk); i++) {
 328         x509 = sk_X509_value(sk, i);
 329         if (X509_NAME_cmp(X509_get_subject_name(x509), name) == 0)
 330             return x509;
 331     }
 332     return NULL;
 333 }
 334
 335 EVP_PKEY *X509_get0_pubkey(const X509 *x)
 336 {
 337     if (x == NULL)
 338         return NULL;
 339     return X509_PUBKEY_get0(x->cert_info.key);
 340 }
 341
 342 EVP_PKEY *X509_get_pubkey(X509 *x)
 343 {
 344     if (x == NULL)
 345         return NULL;
 346     return X509_PUBKEY_get(x->cert_info.key);
 347 }
 348
 349 int X509_check_private_key(const X509 *x, const EVP_PKEY *k)
 350 {
 351     const EVP_PKEY *xk;
 352     int ret;
 353
 354     xk = X509_get0_pubkey(x);
 355
 356     if (xk)
 357         ret = EVP_PKEY_eq(xk, k);
 358     else
 359         ret = -2;
 360
 361     switch (ret) {
 362     case 1:
 363         break;
 364     case 0:
 365         X509err(X509_F_X509_CHECK_PRIVATE_KEY, X509_R_KEY_VALUES_MISMATCH);
 366         break;
 367     case -1:
 368         X509err(X509_F_X509_CHECK_PRIVATE_KEY, X509_R_KEY_TYPE_MISMATCH);
 369         break;
 370     case -2:
 371         X509err(X509_F_X509_CHECK_PRIVATE_KEY, X509_R_UNKNOWN_KEY_TYPE);
 372     }
 373     if (ret > 0)
 374         return 1;
 375     return 0;
 376 }
 377
 378 /*
 379  * Check a suite B algorithm is permitted: pass in a public key and the NID
 380  * of its signature (or 0 if no signature). The pflags is a pointer to a
 381  * flags field which must contain the suite B verification flags.
 382  */
 383
 384 #ifndef OPENSSL_NO_EC
 385
 386 static int check_suite_b(EVP_PKEY *pkey, int sign_nid, unsigned long *pflags)
 387 {
 388     const EC_GROUP *grp = NULL;
 389     int curve_nid;
 390     if (pkey && EVP_PKEY_id(pkey) == EVP_PKEY_EC)
 391         grp = EC_KEY_get0_group(EVP_PKEY_get0_EC_KEY(pkey));
 392     if (!grp)
 393         return X509_V_ERR_SUITE_B_INVALID_ALGORITHM;
 394     curve_nid = EC_GROUP_get_curve_name(grp);
 395     /* Check curve is consistent with LOS */
 396     if (curve_nid == NID_secp384r1) { /* P-384 */
 397         /*
 398          * Check signature algorithm is consistent with curve.
 399          */
 400         if (sign_nid != -1 && sign_nid != NID_ecdsa_with_SHA384)
 401             return X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM;
 402         if (!(*pflags & X509_V_FLAG_SUITEB_192_LOS))
 403             return X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED;
 404         /* If we encounter P-384 we cannot use P-256 later */
 405         *pflags &= ~X509_V_FLAG_SUITEB_128_LOS_ONLY;
 406     } else if (curve_nid == NID_X9_62_prime256v1) { /* P-256 */
 407         if (sign_nid != -1 && sign_nid != NID_ecdsa_with_SHA256)
 408             return X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM;
 409         if (!(*pflags & X509_V_FLAG_SUITEB_128_LOS_ONLY))
 410             return X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED;
 411     } else {
 412         return X509_V_ERR_SUITE_B_INVALID_CURVE;
 413     }
 414     return X509_V_OK;
 415 }
 416
 417 int X509_chain_check_suiteb(int *perror_depth, X509 *x, STACK_OF(X509) *chain,
 418                             unsigned long flags)
 419 {
 420     int rv, i, sign_nid;
 421     EVP_PKEY *pk;
 422     unsigned long tflags = flags;
 423
 424     if (!(flags & X509_V_FLAG_SUITEB_128_LOS))
 425         return X509_V_OK;
 426
 427     /* If no EE certificate passed in must be first in chain */
 428     if (x == NULL) {
 429         x = sk_X509_value(chain, 0);
 430         i = 1;
 431     } else {
 432         i = 0;
 433     }
 434     pk = X509_get0_pubkey(x);
 435
 436     /*
 437      * With DANE-EE(3) success, or DANE-EE(3)/PKIX-EE(1) failure we don't build
 438      * a chain all, just report trust success or failure, but must also report
 439      * Suite-B errors if applicable.  This is indicated via a NULL chain
 440      * pointer.  All we need to do is check the leaf key algorithm.
 441      */
 442     if (chain == NULL)
 443         return check_suite_b(pk, -1, &tflags);
 444
 445     if (X509_get_version(x) != 2) {
 446         rv = X509_V_ERR_SUITE_B_INVALID_VERSION;
 447         /* Correct error depth */
 448         i = 0;
 449         goto end;
 450     }
 451
 452     /* Check EE key only */
 453     rv = check_suite_b(pk, -1, &tflags);
 454     if (rv != X509_V_OK) {
 455         /* Correct error depth */
 456         i = 0;
 457         goto end;
 458     }
 459     for (; i < sk_X509_num(chain); i++) {
 460         sign_nid = X509_get_signature_nid(x);
 461         x = sk_X509_value(chain, i);
 462         if (X509_get_version(x) != 2) {
 463             rv = X509_V_ERR_SUITE_B_INVALID_VERSION;
 464             goto end;
 465         }
 466         pk = X509_get0_pubkey(x);
 467         rv = check_suite_b(pk, sign_nid, &tflags);
 468         if (rv != X509_V_OK)
 469             goto end;
 470     }
 471
 472     /* Final check: root CA signature */
 473     rv = check_suite_b(pk, X509_get_signature_nid(x), &tflags);
 474  end:
 475     if (rv != X509_V_OK) {
 476         /* Invalid signature or LOS errors are for previous cert */
 477         if ((rv == X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM
 478              || rv == X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED) && i)
 479             i--;
 480         /*
 481          * If we have LOS error and flags changed then we are signing P-384
 482          * with P-256. Use more meaningful error.
 483          */
 484         if (rv == X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED && flags != tflags)
 485             rv = X509_V_ERR_SUITE_B_CANNOT_SIGN_P_384_WITH_P_256;
 486         if (perror_depth)
 487             *perror_depth = i;
 488     }
 489     return rv;
 490 }
 491
 492 int X509_CRL_check_suiteb(X509_CRL *crl, EVP_PKEY *pk, unsigned long flags)
 493 {
 494     int sign_nid;
 495     if (!(flags & X509_V_FLAG_SUITEB_128_LOS))
 496         return X509_V_OK;
 497     sign_nid = OBJ_obj2nid(crl->crl.sig_alg.algorithm);
 498     return check_suite_b(pk, sign_nid, &flags);
 499 }
 500
 501 #else
 502 int X509_chain_check_suiteb(int *perror_depth, X509 *x, STACK_OF(X509) *chain,
 503                             unsigned long flags)
 504 {
 505     return 0;
 506 }
 507
 508 int X509_CRL_check_suiteb(X509_CRL *crl, EVP_PKEY *pk, unsigned long flags)
 509 {
 510     return 0;
 511 }
 512
 513 #endif
 514 /*
 515  * Not strictly speaking an "up_ref" as a STACK doesn't have a reference
 516  * count but it has the same effect by duping the STACK and upping the ref of
 517  * each X509 structure.
 518  */
 519 STACK_OF(X509) *X509_chain_up_ref(STACK_OF(X509) *chain)
 520 {
 521     STACK_OF(X509) *ret;
 522     int i;
 523     ret = sk_X509_dup(chain);
 524     if (ret == NULL)
 525         return NULL;
 526     for (i = 0; i < sk_X509_num(ret); i++) {
 527         X509 *x = sk_X509_value(ret, i);
 528         if (!X509_up_ref(x))
 529             goto err;
 530     }
 531     return ret;
 532  err:
 533     while (i-- > 0)
 534         X509_free(sk_X509_value(ret, i));
 535     sk_X509_free(ret);
 536     return NULL;
 537 }