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