Make X509_PUBKEY opaque
[openssl.git] / crypto / x509 / x509_cmp.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <stdio.h>
59 #include <ctype.h>
60 #include "internal/cryptlib.h"
61 #include <openssl/asn1.h>
62 #include <openssl/objects.h>
63 #include <openssl/x509.h>
64 #include <openssl/x509v3.h>
65 #include "internal/x509_int.h"
66
67 int X509_issuer_and_serial_cmp(const X509 *a, const X509 *b)
68 {
69     int i;
70     const X509_CINF *ai, *bi;
71
72     ai = &a->cert_info;
73     bi = &b->cert_info;
74     i = ASN1_INTEGER_cmp(&ai->serialNumber, &bi->serialNumber);
75     if (i)
76         return (i);
77     return (X509_NAME_cmp(ai->issuer, bi->issuer));
78 }
79
80 #ifndef OPENSSL_NO_MD5
81 unsigned long X509_issuer_and_serial_hash(X509 *a)
82 {
83     unsigned long ret = 0;
84     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
85     unsigned char md[16];
86     char *f;
87
88     if (ctx == NULL)
89         goto err;
90     f = X509_NAME_oneline(a->cert_info.issuer, NULL, 0);
91     if (!EVP_DigestInit_ex(ctx, EVP_md5(), NULL))
92         goto err;
93     if (!EVP_DigestUpdate(ctx, (unsigned char *)f, strlen(f)))
94         goto err;
95     OPENSSL_free(f);
96     if (!EVP_DigestUpdate
97         (ctx, (unsigned char *)a->cert_info.serialNumber.data,
98          (unsigned long)a->cert_info.serialNumber.length))
99         goto err;
100     if (!EVP_DigestFinal_ex(ctx, &(md[0]), NULL))
101         goto err;
102     ret = (((unsigned long)md[0]) | ((unsigned long)md[1] << 8L) |
103            ((unsigned long)md[2] << 16L) | ((unsigned long)md[3] << 24L)
104         ) & 0xffffffffL;
105  err:
106     EVP_MD_CTX_free(ctx);
107     return (ret);
108 }
109 #endif
110
111 int X509_issuer_name_cmp(const X509 *a, const X509 *b)
112 {
113     return (X509_NAME_cmp(a->cert_info.issuer, b->cert_info.issuer));
114 }
115
116 int X509_subject_name_cmp(const X509 *a, const X509 *b)
117 {
118     return (X509_NAME_cmp(a->cert_info.subject, b->cert_info.subject));
119 }
120
121 int X509_CRL_cmp(const X509_CRL *a, const X509_CRL *b)
122 {
123     return (X509_NAME_cmp(a->crl.issuer, b->crl.issuer));
124 }
125
126 int X509_CRL_match(const X509_CRL *a, const X509_CRL *b)
127 {
128     return memcmp(a->sha1_hash, b->sha1_hash, 20);
129 }
130
131 X509_NAME *X509_get_issuer_name(X509 *a)
132 {
133     return (a->cert_info.issuer);
134 }
135
136 unsigned long X509_issuer_name_hash(X509 *x)
137 {
138     return (X509_NAME_hash(x->cert_info.issuer));
139 }
140
141 #ifndef OPENSSL_NO_MD5
142 unsigned long X509_issuer_name_hash_old(X509 *x)
143 {
144     return (X509_NAME_hash_old(x->cert_info.issuer));
145 }
146 #endif
147
148 X509_NAME *X509_get_subject_name(X509 *a)
149 {
150     return (a->cert_info.subject);
151 }
152
153 ASN1_INTEGER *X509_get_serialNumber(X509 *a)
154 {
155     return &a->cert_info.serialNumber;
156 }
157
158 unsigned long X509_subject_name_hash(X509 *x)
159 {
160     return (X509_NAME_hash(x->cert_info.subject));
161 }
162
163 #ifndef OPENSSL_NO_MD5
164 unsigned long X509_subject_name_hash_old(X509 *x)
165 {
166     return (X509_NAME_hash_old(x->cert_info.subject));
167 }
168 #endif
169
170 /*
171  * Compare two certificates: they must be identical for this to work. NB:
172  * Although "cmp" operations are generally prototyped to take "const"
173  * arguments (eg. for use in STACKs), the way X509 handling is - these
174  * operations may involve ensuring the hashes are up-to-date and ensuring
175  * certain cert information is cached. So this is the point where the
176  * "depth-first" constification tree has to halt with an evil cast.
177  */
178 int X509_cmp(const X509 *a, const X509 *b)
179 {
180     int rv;
181     /* ensure hash is valid */
182     X509_check_purpose((X509 *)a, -1, 0);
183     X509_check_purpose((X509 *)b, -1, 0);
184
185     rv = memcmp(a->sha1_hash, b->sha1_hash, SHA_DIGEST_LENGTH);
186     if (rv)
187         return rv;
188     /* Check for match against stored encoding too */
189     if (!a->cert_info.enc.modified && !b->cert_info.enc.modified) {
190         rv = (int)(a->cert_info.enc.len - b->cert_info.enc.len);
191         if (rv)
192             return rv;
193         return memcmp(a->cert_info.enc.enc, b->cert_info.enc.enc,
194                       a->cert_info.enc.len);
195     }
196     return rv;
197 }
198
199 int X509_NAME_cmp(const X509_NAME *a, const X509_NAME *b)
200 {
201     int ret;
202
203     /* Ensure canonical encoding is present and up to date */
204
205     if (!a->canon_enc || a->modified) {
206         ret = i2d_X509_NAME((X509_NAME *)a, NULL);
207         if (ret < 0)
208             return -2;
209     }
210
211     if (!b->canon_enc || b->modified) {
212         ret = i2d_X509_NAME((X509_NAME *)b, NULL);
213         if (ret < 0)
214             return -2;
215     }
216
217     ret = a->canon_enclen - b->canon_enclen;
218
219     if (ret)
220         return ret;
221
222     return memcmp(a->canon_enc, b->canon_enc, a->canon_enclen);
223
224 }
225
226 unsigned long X509_NAME_hash(X509_NAME *x)
227 {
228     unsigned long ret = 0;
229     unsigned char md[SHA_DIGEST_LENGTH];
230
231     /* Make sure X509_NAME structure contains valid cached encoding */
232     i2d_X509_NAME(x, NULL);
233     if (!EVP_Digest(x->canon_enc, x->canon_enclen, md, NULL, EVP_sha1(),
234                     NULL))
235         return 0;
236
237     ret = (((unsigned long)md[0]) | ((unsigned long)md[1] << 8L) |
238            ((unsigned long)md[2] << 16L) | ((unsigned long)md[3] << 24L)
239         ) & 0xffffffffL;
240     return (ret);
241 }
242
243 #ifndef OPENSSL_NO_MD5
244 /*
245  * I now DER encode the name and hash it.  Since I cache the DER encoding,
246  * this is reasonably efficient.
247  */
248
249 unsigned long X509_NAME_hash_old(X509_NAME *x)
250 {
251     EVP_MD_CTX *md_ctx = EVP_MD_CTX_new();
252     unsigned long ret = 0;
253     unsigned char md[16];
254
255     if (md_ctx == NULL)
256         return ret;
257
258     /* Make sure X509_NAME structure contains valid cached encoding */
259     i2d_X509_NAME(x, NULL);
260     EVP_MD_CTX_set_flags(md_ctx, EVP_MD_CTX_FLAG_NON_FIPS_ALLOW);
261     if (EVP_DigestInit_ex(md_ctx, EVP_md5(), NULL)
262         && EVP_DigestUpdate(md_ctx, x->bytes->data, x->bytes->length)
263         && EVP_DigestFinal_ex(md_ctx, md, NULL))
264         ret = (((unsigned long)md[0]) | ((unsigned long)md[1] << 8L) |
265                ((unsigned long)md[2] << 16L) | ((unsigned long)md[3] << 24L)
266             ) & 0xffffffffL;
267     EVP_MD_CTX_free(md_ctx);
268
269     return (ret);
270 }
271 #endif
272
273 /* Search a stack of X509 for a match */
274 X509 *X509_find_by_issuer_and_serial(STACK_OF(X509) *sk, X509_NAME *name,
275                                      ASN1_INTEGER *serial)
276 {
277     int i;
278     X509 x, *x509 = NULL;
279
280     if (!sk)
281         return NULL;
282
283     x.cert_info.serialNumber = *serial;
284     x.cert_info.issuer = name;
285
286     for (i = 0; i < sk_X509_num(sk); i++) {
287         x509 = sk_X509_value(sk, i);
288         if (X509_issuer_and_serial_cmp(x509, &x) == 0)
289             return (x509);
290     }
291     return (NULL);
292 }
293
294 X509 *X509_find_by_subject(STACK_OF(X509) *sk, X509_NAME *name)
295 {
296     X509 *x509;
297     int i;
298
299     for (i = 0; i < sk_X509_num(sk); i++) {
300         x509 = sk_X509_value(sk, i);
301         if (X509_NAME_cmp(X509_get_subject_name(x509), name) == 0)
302             return (x509);
303     }
304     return (NULL);
305 }
306
307 EVP_PKEY *X509_get0_pubkey(X509 *x)
308 {
309     if (x == NULL)
310         return NULL;
311     return X509_PUBKEY_get0(x->cert_info.key);
312 }
313
314 EVP_PKEY *X509_get_pubkey(X509 *x)
315 {
316     if (x == NULL)
317         return NULL;
318     return X509_PUBKEY_get(x->cert_info.key);
319 }
320
321 int X509_check_private_key(X509 *x, EVP_PKEY *k)
322 {
323     EVP_PKEY *xk;
324     int ret;
325
326     xk = X509_get0_pubkey(x);
327
328     if (xk)
329         ret = EVP_PKEY_cmp(xk, k);
330     else
331         ret = -2;
332
333     switch (ret) {
334     case 1:
335         break;
336     case 0:
337         X509err(X509_F_X509_CHECK_PRIVATE_KEY, X509_R_KEY_VALUES_MISMATCH);
338         break;
339     case -1:
340         X509err(X509_F_X509_CHECK_PRIVATE_KEY, X509_R_KEY_TYPE_MISMATCH);
341         break;
342     case -2:
343         X509err(X509_F_X509_CHECK_PRIVATE_KEY, X509_R_UNKNOWN_KEY_TYPE);
344     }
345     if (ret > 0)
346         return 1;
347     return 0;
348 }
349
350 /*
351  * Check a suite B algorithm is permitted: pass in a public key and the NID
352  * of its signature (or 0 if no signature). The pflags is a pointer to a
353  * flags field which must contain the suite B verification flags.
354  */
355
356 #ifndef OPENSSL_NO_EC
357
358 static int check_suite_b(EVP_PKEY *pkey, int sign_nid, unsigned long *pflags)
359 {
360     const EC_GROUP *grp = NULL;
361     int curve_nid;
362     if (pkey && EVP_PKEY_id(pkey) == EVP_PKEY_EC)
363         grp = EC_KEY_get0_group(EVP_PKEY_get0_EC_KEY(pkey));
364     if (!grp)
365         return X509_V_ERR_SUITE_B_INVALID_ALGORITHM;
366     curve_nid = EC_GROUP_get_curve_name(grp);
367     /* Check curve is consistent with LOS */
368     if (curve_nid == NID_secp384r1) { /* P-384 */
369         /*
370          * Check signature algorithm is consistent with curve.
371          */
372         if (sign_nid != -1 && sign_nid != NID_ecdsa_with_SHA384)
373             return X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM;
374         if (!(*pflags & X509_V_FLAG_SUITEB_192_LOS))
375             return X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED;
376         /* If we encounter P-384 we cannot use P-256 later */
377         *pflags &= ~X509_V_FLAG_SUITEB_128_LOS_ONLY;
378     } else if (curve_nid == NID_X9_62_prime256v1) { /* P-256 */
379         if (sign_nid != -1 && sign_nid != NID_ecdsa_with_SHA256)
380             return X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM;
381         if (!(*pflags & X509_V_FLAG_SUITEB_128_LOS_ONLY))
382             return X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED;
383     } else
384         return X509_V_ERR_SUITE_B_INVALID_CURVE;
385
386     return X509_V_OK;
387 }
388
389 int X509_chain_check_suiteb(int *perror_depth, X509 *x, STACK_OF(X509) *chain,
390                             unsigned long flags)
391 {
392     int rv, i, sign_nid;
393     EVP_PKEY *pk;
394     unsigned long tflags = flags;
395
396     if (!(flags & X509_V_FLAG_SUITEB_128_LOS))
397         return X509_V_OK;
398
399     /* If no EE certificate passed in must be first in chain */
400     if (x == NULL) {
401         x = sk_X509_value(chain, 0);
402         i = 1;
403     } else
404         i = 0;
405
406     pk = X509_get0_pubkey(x);
407
408     /*
409      * With DANE-EE(3) success, or DANE-EE(3)/PKIX-EE(1) failure we don't build
410      * a chain all, just report trust success or failure, but must also report
411      * Suite-B errors if applicable.  This is indicated via a NULL chain
412      * pointer.  All we need to do is check the leaf key algorithm.
413      */
414     if (chain == NULL)
415         return check_suite_b(pk, -1, &tflags);
416
417     if (X509_get_version(x) != 2) {
418         rv = X509_V_ERR_SUITE_B_INVALID_VERSION;
419         /* Correct error depth */
420         i = 0;
421         goto end;
422     }
423
424     /* Check EE key only */
425     rv = check_suite_b(pk, -1, &tflags);
426     if (rv != X509_V_OK) {
427         /* Correct error depth */
428         i = 0;
429         goto end;
430     }
431     for (; i < sk_X509_num(chain); i++) {
432         sign_nid = X509_get_signature_nid(x);
433         x = sk_X509_value(chain, i);
434         if (X509_get_version(x) != 2) {
435             rv = X509_V_ERR_SUITE_B_INVALID_VERSION;
436             goto end;
437         }
438         pk = X509_get0_pubkey(x);
439         rv = check_suite_b(pk, sign_nid, &tflags);
440         if (rv != X509_V_OK)
441             goto end;
442     }
443
444     /* Final check: root CA signature */
445     rv = check_suite_b(pk, X509_get_signature_nid(x), &tflags);
446  end:
447     if (rv != X509_V_OK) {
448         /* Invalid signature or LOS errors are for previous cert */
449         if ((rv == X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM
450              || rv == X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED) && i)
451             i--;
452         /*
453          * If we have LOS error and flags changed then we are signing P-384
454          * with P-256. Use more meaningful error.
455          */
456         if (rv == X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED && flags != tflags)
457             rv = X509_V_ERR_SUITE_B_CANNOT_SIGN_P_384_WITH_P_256;
458         if (perror_depth)
459             *perror_depth = i;
460     }
461     return rv;
462 }
463
464 int X509_CRL_check_suiteb(X509_CRL *crl, EVP_PKEY *pk, unsigned long flags)
465 {
466     int sign_nid;
467     if (!(flags & X509_V_FLAG_SUITEB_128_LOS))
468         return X509_V_OK;
469     sign_nid = OBJ_obj2nid(crl->crl.sig_alg.algorithm);
470     return check_suite_b(pk, sign_nid, &flags);
471 }
472
473 #else
474 int X509_chain_check_suiteb(int *perror_depth, X509 *x, STACK_OF(X509) *chain,
475                             unsigned long flags)
476 {
477     return 0;
478 }
479
480 int X509_CRL_check_suiteb(X509_CRL *crl, EVP_PKEY *pk, unsigned long flags)
481 {
482     return 0;
483 }
484
485 #endif
486 /*
487  * Not strictly speaking an "up_ref" as a STACK doesn't have a reference
488  * count but it has the same effect by duping the STACK and upping the ref of
489  * each X509 structure.
490  */
491 STACK_OF(X509) *X509_chain_up_ref(STACK_OF(X509) *chain)
492 {
493     STACK_OF(X509) *ret;
494     int i;
495     ret = sk_X509_dup(chain);
496     for (i = 0; i < sk_X509_num(ret); i++) {
497         X509 *x = sk_X509_value(ret, i);
498         X509_up_ref(x);
499     }
500     return ret;
501 }