make X509_CRL opaque
[openssl.git] / crypto / asn1 / x_crl.c
1 /* crypto/asn1/x_crl.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include "internal/cryptlib.h"
61 #include <openssl/asn1t.h>
62 #include "asn1_locl.h"
63 #include <openssl/x509.h>
64 #include "internal/x509_int.h"
65 #include <openssl/x509v3.h>
66
67 static int X509_REVOKED_cmp(const X509_REVOKED *const *a,
68                             const X509_REVOKED *const *b);
69 static void setup_idp(X509_CRL *crl, ISSUING_DIST_POINT *idp);
70
71 ASN1_SEQUENCE(X509_REVOKED) = {
72         ASN1_SIMPLE(X509_REVOKED,serialNumber, ASN1_INTEGER),
73         ASN1_SIMPLE(X509_REVOKED,revocationDate, ASN1_TIME),
74         ASN1_SEQUENCE_OF_OPT(X509_REVOKED,extensions, X509_EXTENSION)
75 } ASN1_SEQUENCE_END(X509_REVOKED)
76
77 static int def_crl_verify(X509_CRL *crl, EVP_PKEY *r);
78 static int def_crl_lookup(X509_CRL *crl,
79                           X509_REVOKED **ret, ASN1_INTEGER *serial,
80                           X509_NAME *issuer);
81
82 static X509_CRL_METHOD int_crl_meth = {
83     0,
84     0, 0,
85     def_crl_lookup,
86     def_crl_verify
87 };
88
89 static const X509_CRL_METHOD *default_crl_method = &int_crl_meth;
90
91 /*
92  * The X509_CRL_INFO structure needs a bit of customisation. Since we cache
93  * the original encoding the signature wont be affected by reordering of the
94  * revoked field.
95  */
96 static int crl_inf_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
97                       void *exarg)
98 {
99     X509_CRL_INFO *a = (X509_CRL_INFO *)*pval;
100
101     if (!a || !a->revoked)
102         return 1;
103     switch (operation) {
104         /*
105          * Just set cmp function here. We don't sort because that would
106          * affect the output of X509_CRL_print().
107          */
108     case ASN1_OP_D2I_POST:
109         (void)sk_X509_REVOKED_set_cmp_func(a->revoked, X509_REVOKED_cmp);
110         break;
111     }
112     return 1;
113 }
114
115
116 ASN1_SEQUENCE_enc(X509_CRL_INFO, enc, crl_inf_cb) = {
117         ASN1_OPT(X509_CRL_INFO, version, ASN1_INTEGER),
118         ASN1_SIMPLE(X509_CRL_INFO, sig_alg, X509_ALGOR),
119         ASN1_SIMPLE(X509_CRL_INFO, issuer, X509_NAME),
120         ASN1_SIMPLE(X509_CRL_INFO, lastUpdate, ASN1_TIME),
121         ASN1_OPT(X509_CRL_INFO, nextUpdate, ASN1_TIME),
122         ASN1_SEQUENCE_OF_OPT(X509_CRL_INFO, revoked, X509_REVOKED),
123         ASN1_EXP_SEQUENCE_OF_OPT(X509_CRL_INFO, extensions, X509_EXTENSION, 0)
124 } ASN1_SEQUENCE_END_enc(X509_CRL_INFO, X509_CRL_INFO)
125
126 /*
127  * Set CRL entry issuer according to CRL certificate issuer extension. Check
128  * for unhandled critical CRL entry extensions.
129  */
130
131 static int crl_set_issuers(X509_CRL *crl)
132 {
133
134     int i, j;
135     GENERAL_NAMES *gens, *gtmp;
136     STACK_OF(X509_REVOKED) *revoked;
137
138     revoked = X509_CRL_get_REVOKED(crl);
139
140     gens = NULL;
141     for (i = 0; i < sk_X509_REVOKED_num(revoked); i++) {
142         X509_REVOKED *rev = sk_X509_REVOKED_value(revoked, i);
143         STACK_OF(X509_EXTENSION) *exts;
144         ASN1_ENUMERATED *reason;
145         X509_EXTENSION *ext;
146         gtmp = X509_REVOKED_get_ext_d2i(rev,
147                                         NID_certificate_issuer, &j, NULL);
148         if (!gtmp && (j != -1)) {
149             crl->flags |= EXFLAG_INVALID;
150             return 1;
151         }
152
153         if (gtmp) {
154             gens = gtmp;
155             if (!crl->issuers) {
156                 crl->issuers = sk_GENERAL_NAMES_new_null();
157                 if (!crl->issuers)
158                     return 0;
159             }
160             if (!sk_GENERAL_NAMES_push(crl->issuers, gtmp))
161                 return 0;
162         }
163         rev->issuer = gens;
164
165         reason = X509_REVOKED_get_ext_d2i(rev, NID_crl_reason, &j, NULL);
166         if (!reason && (j != -1)) {
167             crl->flags |= EXFLAG_INVALID;
168             return 1;
169         }
170
171         if (reason) {
172             rev->reason = ASN1_ENUMERATED_get(reason);
173             ASN1_ENUMERATED_free(reason);
174         } else
175             rev->reason = CRL_REASON_NONE;
176
177         /* Check for critical CRL entry extensions */
178
179         exts = rev->extensions;
180
181         for (j = 0; j < sk_X509_EXTENSION_num(exts); j++) {
182             ext = sk_X509_EXTENSION_value(exts, j);
183             if (X509_EXTENSION_get_critical(ext)) {
184                 if (OBJ_obj2nid(X509_EXTENSION_get_object(ext)) == NID_certificate_issuer)
185                     continue;
186                 crl->flags |= EXFLAG_CRITICAL;
187                 break;
188             }
189         }
190
191     }
192
193     return 1;
194
195 }
196
197 /*
198  * The X509_CRL structure needs a bit of customisation. Cache some extensions
199  * and hash of the whole CRL.
200  */
201 static int crl_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
202                   void *exarg)
203 {
204     X509_CRL *crl = (X509_CRL *)*pval;
205     STACK_OF(X509_EXTENSION) *exts;
206     X509_EXTENSION *ext;
207     int idx;
208
209     switch (operation) {
210     case ASN1_OP_NEW_POST:
211         crl->idp = NULL;
212         crl->akid = NULL;
213         crl->flags = 0;
214         crl->idp_flags = 0;
215         crl->idp_reasons = CRLDP_ALL_REASONS;
216         crl->meth = default_crl_method;
217         crl->meth_data = NULL;
218         crl->issuers = NULL;
219         crl->crl_number = NULL;
220         crl->base_crl_number = NULL;
221         break;
222
223     case ASN1_OP_D2I_POST:
224         X509_CRL_digest(crl, EVP_sha1(), crl->sha1_hash, NULL);
225         crl->idp = X509_CRL_get_ext_d2i(crl,
226                                         NID_issuing_distribution_point, NULL,
227                                         NULL);
228         if (crl->idp)
229             setup_idp(crl, crl->idp);
230
231         crl->akid = X509_CRL_get_ext_d2i(crl,
232                                          NID_authority_key_identifier, NULL,
233                                          NULL);
234
235         crl->crl_number = X509_CRL_get_ext_d2i(crl,
236                                                NID_crl_number, NULL, NULL);
237
238         crl->base_crl_number = X509_CRL_get_ext_d2i(crl,
239                                                     NID_delta_crl, NULL,
240                                                     NULL);
241         /* Delta CRLs must have CRL number */
242         if (crl->base_crl_number && !crl->crl_number)
243             crl->flags |= EXFLAG_INVALID;
244
245         /*
246          * See if we have any unhandled critical CRL extensions and indicate
247          * this in a flag. We only currently handle IDP so anything else
248          * critical sets the flag. This code accesses the X509_CRL structure
249          * directly: applications shouldn't do this.
250          */
251
252         exts = crl->crl->extensions;
253
254         for (idx = 0; idx < sk_X509_EXTENSION_num(exts); idx++) {
255             int nid;
256             ext = sk_X509_EXTENSION_value(exts, idx);
257             nid = OBJ_obj2nid(X509_EXTENSION_get_object(ext));
258             if (nid == NID_freshest_crl)
259                 crl->flags |= EXFLAG_FRESHEST;
260             if (X509_EXTENSION_get_critical(ext)) {
261                 /* We handle IDP and deltas */
262                 if ((nid == NID_issuing_distribution_point)
263                     || (nid == NID_authority_key_identifier)
264                     || (nid == NID_delta_crl))
265                     break;;
266                 crl->flags |= EXFLAG_CRITICAL;
267                 break;
268             }
269         }
270
271         if (!crl_set_issuers(crl))
272             return 0;
273
274         if (crl->meth->crl_init) {
275             if (crl->meth->crl_init(crl) == 0)
276                 return 0;
277         }
278         break;
279
280     case ASN1_OP_FREE_POST:
281         if (crl->meth->crl_free) {
282             if (!crl->meth->crl_free(crl))
283                 return 0;
284         }
285         AUTHORITY_KEYID_free(crl->akid);
286         ISSUING_DIST_POINT_free(crl->idp);
287         ASN1_INTEGER_free(crl->crl_number);
288         ASN1_INTEGER_free(crl->base_crl_number);
289         sk_GENERAL_NAMES_pop_free(crl->issuers, GENERAL_NAMES_free);
290         break;
291     }
292     return 1;
293 }
294
295 /* Convert IDP into a more convenient form */
296
297 static void setup_idp(X509_CRL *crl, ISSUING_DIST_POINT *idp)
298 {
299     int idp_only = 0;
300     /* Set various flags according to IDP */
301     crl->idp_flags |= IDP_PRESENT;
302     if (idp->onlyuser > 0) {
303         idp_only++;
304         crl->idp_flags |= IDP_ONLYUSER;
305     }
306     if (idp->onlyCA > 0) {
307         idp_only++;
308         crl->idp_flags |= IDP_ONLYCA;
309     }
310     if (idp->onlyattr > 0) {
311         idp_only++;
312         crl->idp_flags |= IDP_ONLYATTR;
313     }
314
315     if (idp_only > 1)
316         crl->idp_flags |= IDP_INVALID;
317
318     if (idp->indirectCRL > 0)
319         crl->idp_flags |= IDP_INDIRECT;
320
321     if (idp->onlysomereasons) {
322         crl->idp_flags |= IDP_REASONS;
323         if (idp->onlysomereasons->length > 0)
324             crl->idp_reasons = idp->onlysomereasons->data[0];
325         if (idp->onlysomereasons->length > 1)
326             crl->idp_reasons |= (idp->onlysomereasons->data[1] << 8);
327         crl->idp_reasons &= CRLDP_ALL_REASONS;
328     }
329
330     DIST_POINT_set_dpname(idp->distpoint, X509_CRL_get_issuer(crl));
331 }
332
333 ASN1_SEQUENCE_ref(X509_CRL, crl_cb, CRYPTO_LOCK_X509_CRL) = {
334         ASN1_SIMPLE(X509_CRL, crl, X509_CRL_INFO),
335         ASN1_SIMPLE(X509_CRL, sig_alg, X509_ALGOR),
336         ASN1_SIMPLE(X509_CRL, signature, ASN1_BIT_STRING)
337 } ASN1_SEQUENCE_END_ref(X509_CRL, X509_CRL)
338
339 IMPLEMENT_ASN1_FUNCTIONS(X509_REVOKED)
340
341 IMPLEMENT_ASN1_DUP_FUNCTION(X509_REVOKED)
342
343 IMPLEMENT_ASN1_FUNCTIONS(X509_CRL_INFO)
344
345 IMPLEMENT_ASN1_FUNCTIONS(X509_CRL)
346
347 IMPLEMENT_ASN1_DUP_FUNCTION(X509_CRL)
348
349 static int X509_REVOKED_cmp(const X509_REVOKED *const *a,
350                             const X509_REVOKED *const *b)
351 {
352     return (ASN1_STRING_cmp((ASN1_STRING *)(*a)->serialNumber,
353                             (ASN1_STRING *)(*b)->serialNumber));
354 }
355
356 int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev)
357 {
358     X509_CRL_INFO *inf;
359     inf = crl->crl;
360     if (!inf->revoked)
361         inf->revoked = sk_X509_REVOKED_new(X509_REVOKED_cmp);
362     if (!inf->revoked || !sk_X509_REVOKED_push(inf->revoked, rev)) {
363         ASN1err(ASN1_F_X509_CRL_ADD0_REVOKED, ERR_R_MALLOC_FAILURE);
364         return 0;
365     }
366     inf->enc.modified = 1;
367     return 1;
368 }
369
370 int X509_CRL_verify(X509_CRL *crl, EVP_PKEY *r)
371 {
372     if (crl->meth->crl_verify)
373         return crl->meth->crl_verify(crl, r);
374     return 0;
375 }
376
377 int X509_CRL_get0_by_serial(X509_CRL *crl,
378                             X509_REVOKED **ret, ASN1_INTEGER *serial)
379 {
380     if (crl->meth->crl_lookup)
381         return crl->meth->crl_lookup(crl, ret, serial, NULL);
382     return 0;
383 }
384
385 int X509_CRL_get0_by_cert(X509_CRL *crl, X509_REVOKED **ret, X509 *x)
386 {
387     if (crl->meth->crl_lookup)
388         return crl->meth->crl_lookup(crl, ret,
389                                      X509_get_serialNumber(x),
390                                      X509_get_issuer_name(x));
391     return 0;
392 }
393
394 static int def_crl_verify(X509_CRL *crl, EVP_PKEY *r)
395 {
396     return (ASN1_item_verify(ASN1_ITEM_rptr(X509_CRL_INFO),
397                              crl->sig_alg, crl->signature, crl->crl, r));
398 }
399
400 static int crl_revoked_issuer_match(X509_CRL *crl, X509_NAME *nm,
401                                     X509_REVOKED *rev)
402 {
403     int i;
404
405     if (!rev->issuer) {
406         if (!nm)
407             return 1;
408         if (!X509_NAME_cmp(nm, X509_CRL_get_issuer(crl)))
409             return 1;
410         return 0;
411     }
412
413     if (!nm)
414         nm = X509_CRL_get_issuer(crl);
415
416     for (i = 0; i < sk_GENERAL_NAME_num(rev->issuer); i++) {
417         GENERAL_NAME *gen = sk_GENERAL_NAME_value(rev->issuer, i);
418         if (gen->type != GEN_DIRNAME)
419             continue;
420         if (!X509_NAME_cmp(nm, gen->d.directoryName))
421             return 1;
422     }
423     return 0;
424
425 }
426
427 static int def_crl_lookup(X509_CRL *crl,
428                           X509_REVOKED **ret, ASN1_INTEGER *serial,
429                           X509_NAME *issuer)
430 {
431     X509_REVOKED rtmp, *rev;
432     int idx;
433     rtmp.serialNumber = serial;
434     /*
435      * Sort revoked into serial number order if not already sorted. Do this
436      * under a lock to avoid race condition.
437      */
438     if (!sk_X509_REVOKED_is_sorted(crl->crl->revoked)) {
439         CRYPTO_w_lock(CRYPTO_LOCK_X509_CRL);
440         sk_X509_REVOKED_sort(crl->crl->revoked);
441         CRYPTO_w_unlock(CRYPTO_LOCK_X509_CRL);
442     }
443     idx = sk_X509_REVOKED_find(crl->crl->revoked, &rtmp);
444     if (idx < 0)
445         return 0;
446     /* Need to look for matching name */
447     for (; idx < sk_X509_REVOKED_num(crl->crl->revoked); idx++) {
448         rev = sk_X509_REVOKED_value(crl->crl->revoked, idx);
449         if (ASN1_INTEGER_cmp(rev->serialNumber, serial))
450             return 0;
451         if (crl_revoked_issuer_match(crl, issuer, rev)) {
452             if (ret)
453                 *ret = rev;
454             if (rev->reason == CRL_REASON_REMOVE_FROM_CRL)
455                 return 2;
456             return 1;
457         }
458     }
459     return 0;
460 }
461
462 void X509_CRL_set_default_method(const X509_CRL_METHOD *meth)
463 {
464     if (meth == NULL)
465         default_crl_method = &int_crl_meth;
466     else
467         default_crl_method = meth;
468 }
469
470 X509_CRL_METHOD *X509_CRL_METHOD_new(int (*crl_init) (X509_CRL *crl),
471                                      int (*crl_free) (X509_CRL *crl),
472                                      int (*crl_lookup) (X509_CRL *crl,
473                                                         X509_REVOKED **ret,
474                                                         ASN1_INTEGER *ser,
475                                                         X509_NAME *issuer),
476                                      int (*crl_verify) (X509_CRL *crl,
477                                                         EVP_PKEY *pk))
478 {
479     X509_CRL_METHOD *m;
480     m = OPENSSL_malloc(sizeof(*m));
481     if (!m)
482         return NULL;
483     m->crl_init = crl_init;
484     m->crl_free = crl_free;
485     m->crl_lookup = crl_lookup;
486     m->crl_verify = crl_verify;
487     m->flags = X509_CRL_METHOD_DYNAMIC;
488     return m;
489 }
490
491 void X509_CRL_METHOD_free(X509_CRL_METHOD *m)
492 {
493     if (!(m->flags & X509_CRL_METHOD_DYNAMIC))
494         return;
495     OPENSSL_free(m);
496 }
497
498 void X509_CRL_set_meth_data(X509_CRL *crl, void *dat)
499 {
500     crl->meth_data = dat;
501 }
502
503 void *X509_CRL_get_meth_data(X509_CRL *crl)
504 {
505     return crl->meth_data;
506 }