Add X509_NAME_hash_ex() to be able to check if it failed due to unsupported SHA1
[openssl.git] / 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_ex(x->cert_info.issuer, NULL, NULL, NULL);
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_ex(x->cert_info.subject, NULL, NULL, NULL);
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     if (a == b) /* for efficiency */
146         return 0;
147     /* ensure hash is valid */
148     if (X509_check_purpose((X509 *)a, -1, 0) != 1)
149         return -2;
150     if (X509_check_purpose((X509 *)b, -1, 0) != 1)
151         return -2;
152
153     rv = memcmp(a->sha1_hash, b->sha1_hash, SHA_DIGEST_LENGTH);
154     if (rv != 0)
155         return rv < 0 ? -1 : 1;
156     /* Check for match against stored encoding too */
157     if (!a->cert_info.enc.modified && !b->cert_info.enc.modified) {
158         if (a->cert_info.enc.len < b->cert_info.enc.len)
159             return -1;
160         if (a->cert_info.enc.len > b->cert_info.enc.len)
161             return 1;
162         rv = memcmp(a->cert_info.enc.enc,
163                     b->cert_info.enc.enc, a->cert_info.enc.len);
164     }
165     return rv < 0 ? -1 : rv > 0;
166 }
167
168 int X509_add_cert_new(STACK_OF(X509) **sk, X509 *cert, int flags)
169 {
170     if (*sk == NULL
171             && (*sk = sk_X509_new_null()) == NULL) {
172         ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
173         return 0;
174     }
175     return X509_add_cert(*sk, cert, flags);
176 }
177
178 int X509_add_cert(STACK_OF(X509) *sk, X509 *cert, int flags)
179 {
180     if (sk == NULL) {
181         ERR_raise(ERR_LIB_X509, ERR_R_PASSED_NULL_PARAMETER);
182         return 0;
183     }
184     if ((flags & X509_ADD_FLAG_NO_DUP) != 0) {
185         /*
186          * not using sk_X509_set_cmp_func() and sk_X509_find()
187          * because this re-orders the certs on the stack
188          */
189         int i;
190
191         for (i = 0; i < sk_X509_num(sk); i++) {
192             if (X509_cmp(sk_X509_value(sk, i), cert) == 0)
193                 return 1;
194         }
195     }
196     if ((flags & X509_ADD_FLAG_NO_SS) != 0 && X509_self_signed(cert, 0))
197         return 1;
198     if (!sk_X509_insert(sk, cert,
199                         (flags & X509_ADD_FLAG_PREPEND) != 0 ? 0 : -1)) {
200         ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
201         return 0;
202     }
203     if ((flags & X509_ADD_FLAG_UP_REF) != 0)
204         (void)X509_up_ref(cert);
205     return 1;
206 }
207
208 int X509_add_certs(STACK_OF(X509) *sk, STACK_OF(X509) *certs, int flags)
209 /* compiler would allow 'const' for the list of certs, yet they are up-ref'ed */
210 {
211     int n = sk_X509_num(certs); /* certs may be NULL */
212     int i;
213
214     for (i = 0; i < n; i++) {
215         int j = (flags & X509_ADD_FLAG_PREPEND) == 0 ? i : n - 1 - i;
216         /* if prepend, add certs in reverse order to keep original order */
217
218         if (!X509_add_cert(sk, sk_X509_value(certs, j), flags))
219             return 0;
220     }
221     return 1;
222 }
223
224 int X509_NAME_cmp(const X509_NAME *a, const X509_NAME *b)
225 {
226     int ret;
227
228     if (b == NULL)
229         return a != NULL;
230     if (a == NULL)
231         return -1;
232
233     /* Ensure canonical encoding is present and up to date */
234     if (!a->canon_enc || a->modified) {
235         ret = i2d_X509_NAME((X509_NAME *)a, NULL);
236         if (ret < 0)
237             return -2;
238     }
239
240     if (!b->canon_enc || b->modified) {
241         ret = i2d_X509_NAME((X509_NAME *)b, NULL);
242         if (ret < 0)
243             return -2;
244     }
245
246     ret = a->canon_enclen - b->canon_enclen;
247     if (ret == 0 && a->canon_enclen != 0)
248         ret = memcmp(a->canon_enc, b->canon_enc, a->canon_enclen);
249
250     return ret < 0 ? -1 : ret > 0;
251 }
252
253 unsigned long X509_NAME_hash_ex(const X509_NAME *x, OSSL_LIB_CTX *libctx,
254                                 const char *propq, int *ok)
255 {
256     unsigned long ret = 0;
257     unsigned char md[SHA_DIGEST_LENGTH];
258     EVP_MD *sha1 = EVP_MD_fetch(libctx, "SHA1", propq);
259
260     /* Make sure X509_NAME structure contains valid cached encoding */
261     i2d_X509_NAME(x, NULL);
262     if (ok != NULL)
263         *ok = 0;
264     if (sha1 != NULL
265         && EVP_Digest(x->canon_enc, x->canon_enclen, md, NULL, sha1, NULL)) {
266         ret = (((unsigned long)md[0]) | ((unsigned long)md[1] << 8L) |
267                ((unsigned long)md[2] << 16L) | ((unsigned long)md[3] << 24L)
268                ) & 0xffffffffL;
269         if (ok != NULL)
270             *ok = 1;
271     }
272     EVP_MD_free(sha1);
273     return ret;
274 }
275
276 #ifndef OPENSSL_NO_MD5
277 /*
278  * I now DER encode the name and hash it.  Since I cache the DER encoding,
279  * this is reasonably efficient.
280  */
281 unsigned long X509_NAME_hash_old(const X509_NAME *x)
282 {
283     EVP_MD *md5 = EVP_MD_fetch(NULL, OSSL_DIGEST_NAME_MD5, "-fips");
284     EVP_MD_CTX *md_ctx = EVP_MD_CTX_new();
285     unsigned long ret = 0;
286     unsigned char md[16];
287
288     if (md5 == NULL || md_ctx == NULL)
289         goto end;
290
291     /* Make sure X509_NAME structure contains valid cached encoding */
292     i2d_X509_NAME(x, NULL);
293     if (EVP_DigestInit_ex(md_ctx, md5, NULL)
294         && EVP_DigestUpdate(md_ctx, x->bytes->data, x->bytes->length)
295         && EVP_DigestFinal_ex(md_ctx, md, NULL))
296         ret = (((unsigned long)md[0]) | ((unsigned long)md[1] << 8L) |
297                ((unsigned long)md[2] << 16L) | ((unsigned long)md[3] << 24L)
298             ) & 0xffffffffL;
299
300  end:
301     EVP_MD_CTX_free(md_ctx);
302     EVP_MD_free(md5);
303
304     return ret;
305 }
306 #endif
307
308 /* Search a stack of X509 for a match */
309 X509 *X509_find_by_issuer_and_serial(STACK_OF(X509) *sk, const X509_NAME *name,
310                                      const ASN1_INTEGER *serial)
311 {
312     int i;
313     X509 x, *x509 = NULL;
314
315     if (!sk)
316         return NULL;
317
318     x.cert_info.serialNumber = *serial;
319     x.cert_info.issuer = (X509_NAME *)name; /* won't modify it */
320
321     for (i = 0; i < sk_X509_num(sk); i++) {
322         x509 = sk_X509_value(sk, i);
323         if (X509_issuer_and_serial_cmp(x509, &x) == 0)
324             return x509;
325     }
326     return NULL;
327 }
328
329 X509 *X509_find_by_subject(STACK_OF(X509) *sk, const X509_NAME *name)
330 {
331     X509 *x509;
332     int i;
333
334     for (i = 0; i < sk_X509_num(sk); i++) {
335         x509 = sk_X509_value(sk, i);
336         if (X509_NAME_cmp(X509_get_subject_name(x509), name) == 0)
337             return x509;
338     }
339     return NULL;
340 }
341
342 EVP_PKEY *X509_get0_pubkey(const X509 *x)
343 {
344     if (x == NULL)
345         return NULL;
346     return X509_PUBKEY_get0(x->cert_info.key);
347 }
348
349 EVP_PKEY *X509_get_pubkey(X509 *x)
350 {
351     if (x == NULL)
352         return NULL;
353     return X509_PUBKEY_get(x->cert_info.key);
354 }
355
356 int X509_check_private_key(const X509 *x, const EVP_PKEY *k)
357 {
358     const EVP_PKEY *xk;
359     int ret;
360
361     xk = X509_get0_pubkey(x);
362
363     if (xk)
364         ret = EVP_PKEY_eq(xk, k);
365     else
366         ret = -2;
367
368     switch (ret) {
369     case 1:
370         break;
371     case 0:
372         ERR_raise(ERR_LIB_X509, X509_R_KEY_VALUES_MISMATCH);
373         break;
374     case -1:
375         ERR_raise(ERR_LIB_X509, X509_R_KEY_TYPE_MISMATCH);
376         break;
377     case -2:
378         ERR_raise(ERR_LIB_X509, X509_R_UNKNOWN_KEY_TYPE);
379     }
380     if (ret > 0)
381         return 1;
382     return 0;
383 }
384
385 /*
386  * Check a suite B algorithm is permitted: pass in a public key and the NID
387  * of its signature (or 0 if no signature). The pflags is a pointer to a
388  * flags field which must contain the suite B verification flags.
389  */
390
391 #ifndef OPENSSL_NO_EC
392
393 static int check_suite_b(EVP_PKEY *pkey, int sign_nid, unsigned long *pflags)
394 {
395     const EC_GROUP *grp = NULL;
396     int curve_nid;
397     if (pkey && EVP_PKEY_id(pkey) == EVP_PKEY_EC)
398         grp = EC_KEY_get0_group(EVP_PKEY_get0_EC_KEY(pkey));
399     if (!grp)
400         return X509_V_ERR_SUITE_B_INVALID_ALGORITHM;
401     curve_nid = EC_GROUP_get_curve_name(grp);
402     /* Check curve is consistent with LOS */
403     if (curve_nid == NID_secp384r1) { /* P-384 */
404         /*
405          * Check signature algorithm is consistent with curve.
406          */
407         if (sign_nid != -1 && sign_nid != NID_ecdsa_with_SHA384)
408             return X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM;
409         if (!(*pflags & X509_V_FLAG_SUITEB_192_LOS))
410             return X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED;
411         /* If we encounter P-384 we cannot use P-256 later */
412         *pflags &= ~X509_V_FLAG_SUITEB_128_LOS_ONLY;
413     } else if (curve_nid == NID_X9_62_prime256v1) { /* P-256 */
414         if (sign_nid != -1 && sign_nid != NID_ecdsa_with_SHA256)
415             return X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM;
416         if (!(*pflags & X509_V_FLAG_SUITEB_128_LOS_ONLY))
417             return X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED;
418     } else {
419         return X509_V_ERR_SUITE_B_INVALID_CURVE;
420     }
421     return X509_V_OK;
422 }
423
424 int X509_chain_check_suiteb(int *perror_depth, X509 *x, STACK_OF(X509) *chain,
425                             unsigned long flags)
426 {
427     int rv, i, sign_nid;
428     EVP_PKEY *pk;
429     unsigned long tflags = flags;
430
431     if (!(flags & X509_V_FLAG_SUITEB_128_LOS))
432         return X509_V_OK;
433
434     /* If no EE certificate passed in must be first in chain */
435     if (x == NULL) {
436         x = sk_X509_value(chain, 0);
437         i = 1;
438     } else {
439         i = 0;
440     }
441     pk = X509_get0_pubkey(x);
442
443     /*
444      * With DANE-EE(3) success, or DANE-EE(3)/PKIX-EE(1) failure we don't build
445      * a chain all, just report trust success or failure, but must also report
446      * Suite-B errors if applicable.  This is indicated via a NULL chain
447      * pointer.  All we need to do is check the leaf key algorithm.
448      */
449     if (chain == NULL)
450         return check_suite_b(pk, -1, &tflags);
451
452     if (X509_get_version(x) != 2) {
453         rv = X509_V_ERR_SUITE_B_INVALID_VERSION;
454         /* Correct error depth */
455         i = 0;
456         goto end;
457     }
458
459     /* Check EE key only */
460     rv = check_suite_b(pk, -1, &tflags);
461     if (rv != X509_V_OK) {
462         /* Correct error depth */
463         i = 0;
464         goto end;
465     }
466     for (; i < sk_X509_num(chain); i++) {
467         sign_nid = X509_get_signature_nid(x);
468         x = sk_X509_value(chain, i);
469         if (X509_get_version(x) != 2) {
470             rv = X509_V_ERR_SUITE_B_INVALID_VERSION;
471             goto end;
472         }
473         pk = X509_get0_pubkey(x);
474         rv = check_suite_b(pk, sign_nid, &tflags);
475         if (rv != X509_V_OK)
476             goto end;
477     }
478
479     /* Final check: root CA signature */
480     rv = check_suite_b(pk, X509_get_signature_nid(x), &tflags);
481  end:
482     if (rv != X509_V_OK) {
483         /* Invalid signature or LOS errors are for previous cert */
484         if ((rv == X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM
485              || rv == X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED) && i)
486             i--;
487         /*
488          * If we have LOS error and flags changed then we are signing P-384
489          * with P-256. Use more meaningful error.
490          */
491         if (rv == X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED && flags != tflags)
492             rv = X509_V_ERR_SUITE_B_CANNOT_SIGN_P_384_WITH_P_256;
493         if (perror_depth)
494             *perror_depth = i;
495     }
496     return rv;
497 }
498
499 int X509_CRL_check_suiteb(X509_CRL *crl, EVP_PKEY *pk, unsigned long flags)
500 {
501     int sign_nid;
502     if (!(flags & X509_V_FLAG_SUITEB_128_LOS))
503         return X509_V_OK;
504     sign_nid = OBJ_obj2nid(crl->crl.sig_alg.algorithm);
505     return check_suite_b(pk, sign_nid, &flags);
506 }
507
508 #else
509 int X509_chain_check_suiteb(int *perror_depth, X509 *x, STACK_OF(X509) *chain,
510                             unsigned long flags)
511 {
512     return 0;
513 }
514
515 int X509_CRL_check_suiteb(X509_CRL *crl, EVP_PKEY *pk, unsigned long flags)
516 {
517     return 0;
518 }
519
520 #endif
521 /*
522  * Not strictly speaking an "up_ref" as a STACK doesn't have a reference
523  * count but it has the same effect by duping the STACK and upping the ref of
524  * each X509 structure.
525  */
526 STACK_OF(X509) *X509_chain_up_ref(STACK_OF(X509) *chain)
527 {
528     STACK_OF(X509) *ret;
529     int i;
530     ret = sk_X509_dup(chain);
531     if (ret == NULL)
532         return NULL;
533     for (i = 0; i < sk_X509_num(ret); i++) {
534         X509 *x = sk_X509_value(ret, i);
535         if (!X509_up_ref(x))
536             goto err;
537     }
538     return ret;
539  err:
540     while (i-- > 0)
541         X509_free(sk_X509_value(ret, i));
542     sk_X509_free(ret);
543     return NULL;
544 }