xref: /freebsd/crypto/openssl/crypto/x509/x_crl.c (revision 88b8b7f0c4e9948667a2279e78e975a784049cba)
1 /*
2  * Copyright 1995-2025 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/asn1t.h>
13 #include <openssl/x509.h>
14 #include "crypto/x509.h"
15 #include <openssl/x509v3.h>
16 #include "x509_local.h"
17 
18 static int X509_REVOKED_cmp(const X509_REVOKED *const *a,
19                             const X509_REVOKED *const *b);
20 static int setup_idp(X509_CRL *crl, ISSUING_DIST_POINT *idp);
21 
22 ASN1_SEQUENCE(X509_REVOKED) = {
23         ASN1_EMBED(X509_REVOKED, serialNumber, ASN1_INTEGER),
24         ASN1_SIMPLE(X509_REVOKED, revocationDate, ASN1_TIME),
25         ASN1_SEQUENCE_OF_OPT(X509_REVOKED, extensions, X509_EXTENSION)
26 } ASN1_SEQUENCE_END(X509_REVOKED)
27 
28 static int def_crl_verify(X509_CRL *crl, EVP_PKEY *r);
29 static int def_crl_lookup(X509_CRL *crl,
30                           X509_REVOKED **ret, const ASN1_INTEGER *serial,
31                           const X509_NAME *issuer);
32 
33 static X509_CRL_METHOD int_crl_meth = {
34     0,
35     0, 0,
36     def_crl_lookup,
37     def_crl_verify
38 };
39 
40 static const X509_CRL_METHOD *default_crl_method = &int_crl_meth;
41 
42 /*
43  * The X509_CRL_INFO structure needs a bit of customisation. Since we cache
44  * the original encoding the signature won't be affected by reordering of the
45  * revoked field.
46  */
crl_inf_cb(int operation,ASN1_VALUE ** pval,const ASN1_ITEM * it,void * exarg)47 static int crl_inf_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
48                       void *exarg)
49 {
50     X509_CRL_INFO *a = (X509_CRL_INFO *)*pval;
51 
52     if (!a || !a->revoked)
53         return 1;
54     switch (operation) {
55         /*
56          * Just set cmp function here. We don't sort because that would
57          * affect the output of X509_CRL_print().
58          */
59     case ASN1_OP_D2I_POST:
60         (void)sk_X509_REVOKED_set_cmp_func(a->revoked, X509_REVOKED_cmp);
61         break;
62     }
63     return 1;
64 }
65 
66 
67 ASN1_SEQUENCE_enc(X509_CRL_INFO, enc, crl_inf_cb) = {
68         ASN1_OPT(X509_CRL_INFO, version, ASN1_INTEGER),
69         ASN1_EMBED(X509_CRL_INFO, sig_alg, X509_ALGOR),
70         ASN1_SIMPLE(X509_CRL_INFO, issuer, X509_NAME),
71         ASN1_SIMPLE(X509_CRL_INFO, lastUpdate, ASN1_TIME),
72         ASN1_OPT(X509_CRL_INFO, nextUpdate, ASN1_TIME),
73         ASN1_SEQUENCE_OF_OPT(X509_CRL_INFO, revoked, X509_REVOKED),
74         ASN1_EXP_SEQUENCE_OF_OPT(X509_CRL_INFO, extensions, X509_EXTENSION, 0)
75 } ASN1_SEQUENCE_END_enc(X509_CRL_INFO, X509_CRL_INFO)
76 
77 /*
78  * Set CRL entry issuer according to CRL certificate issuer extension. Check
79  * for unhandled critical CRL entry extensions.
80  */
81 
82 static int crl_set_issuers(X509_CRL *crl)
83 {
84 
85     int i, j;
86     GENERAL_NAMES *gens, *gtmp;
87     STACK_OF(X509_REVOKED) *revoked;
88 
89     revoked = X509_CRL_get_REVOKED(crl);
90 
91     gens = NULL;
92     for (i = 0; i < sk_X509_REVOKED_num(revoked); i++) {
93         X509_REVOKED *rev = sk_X509_REVOKED_value(revoked, i);
94         STACK_OF(X509_EXTENSION) *exts;
95         ASN1_ENUMERATED *reason;
96         X509_EXTENSION *ext;
97 
98         gtmp = X509_REVOKED_get_ext_d2i(rev,
99                                         NID_certificate_issuer, &j, NULL);
100         if (gtmp == NULL && j != -1) {
101             crl->flags |= EXFLAG_INVALID;
102             return 1;
103         }
104 
105         if (gtmp != NULL) {
106             if (crl->issuers == NULL) {
107                 crl->issuers = sk_GENERAL_NAMES_new_null();
108                 if (crl->issuers == NULL) {
109                     GENERAL_NAMES_free(gtmp);
110                     return 0;
111                 }
112             }
113             if (!sk_GENERAL_NAMES_push(crl->issuers, gtmp)) {
114                 GENERAL_NAMES_free(gtmp);
115                 return 0;
116             }
117             gens = gtmp;
118         }
119         rev->issuer = gens;
120 
121         reason = X509_REVOKED_get_ext_d2i(rev, NID_crl_reason, &j, NULL);
122         if (reason == NULL && j != -1) {
123             crl->flags |= EXFLAG_INVALID;
124             return 1;
125         }
126 
127         if (reason != NULL) {
128             rev->reason = ASN1_ENUMERATED_get(reason);
129             ASN1_ENUMERATED_free(reason);
130         } else
131             rev->reason = CRL_REASON_NONE;
132 
133         /* Check for critical CRL entry extensions */
134 
135         exts = rev->extensions;
136 
137         for (j = 0; j < sk_X509_EXTENSION_num(exts); j++) {
138             ext = sk_X509_EXTENSION_value(exts, j);
139             if (X509_EXTENSION_get_critical(ext)) {
140                 if (OBJ_obj2nid(X509_EXTENSION_get_object(ext))
141                     == NID_certificate_issuer)
142                     continue;
143                 crl->flags |= EXFLAG_CRITICAL;
144                 break;
145             }
146         }
147 
148     }
149 
150     return 1;
151 
152 }
153 
154 /*
155  * The X509_CRL structure needs a bit of customisation. Cache some extensions
156  * and hash of the whole CRL or set EXFLAG_NO_FINGERPRINT if this fails.
157  */
crl_cb(int operation,ASN1_VALUE ** pval,const ASN1_ITEM * it,void * exarg)158 static int crl_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
159                   void *exarg)
160 {
161     X509_CRL *crl = (X509_CRL *)*pval;
162     STACK_OF(X509_EXTENSION) *exts;
163     X509_EXTENSION *ext;
164     int idx, i;
165 
166     switch (operation) {
167     case ASN1_OP_D2I_PRE:
168         if (crl->meth->crl_free) {
169             if (!crl->meth->crl_free(crl))
170                 return 0;
171         }
172         AUTHORITY_KEYID_free(crl->akid);
173         ISSUING_DIST_POINT_free(crl->idp);
174         ASN1_INTEGER_free(crl->crl_number);
175         ASN1_INTEGER_free(crl->base_crl_number);
176         sk_GENERAL_NAMES_pop_free(crl->issuers, GENERAL_NAMES_free);
177         /* fall through */
178 
179     case ASN1_OP_NEW_POST:
180         crl->idp = NULL;
181         crl->akid = NULL;
182         crl->flags = 0;
183         crl->idp_flags = 0;
184         crl->idp_reasons = CRLDP_ALL_REASONS;
185         crl->meth = default_crl_method;
186         crl->meth_data = NULL;
187         crl->issuers = NULL;
188         crl->crl_number = NULL;
189         crl->base_crl_number = NULL;
190         break;
191 
192     case ASN1_OP_D2I_POST:
193         if (!X509_CRL_digest(crl, EVP_sha1(), crl->sha1_hash, NULL))
194             crl->flags |= EXFLAG_NO_FINGERPRINT;
195         crl->idp = X509_CRL_get_ext_d2i(crl,
196                                         NID_issuing_distribution_point, &i,
197                                         NULL);
198         if (crl->idp != NULL) {
199             if (!setup_idp(crl, crl->idp))
200                 crl->flags |= EXFLAG_INVALID;
201         }
202         else if (i != -1) {
203             crl->flags |= EXFLAG_INVALID;
204         }
205 
206         crl->akid = X509_CRL_get_ext_d2i(crl,
207                                          NID_authority_key_identifier, &i,
208                                          NULL);
209         if (crl->akid == NULL && i != -1)
210             crl->flags |= EXFLAG_INVALID;
211 
212         crl->crl_number = X509_CRL_get_ext_d2i(crl,
213                                                NID_crl_number, &i, NULL);
214         if (crl->crl_number == NULL && i != -1)
215             crl->flags |= EXFLAG_INVALID;
216 
217         crl->base_crl_number = X509_CRL_get_ext_d2i(crl,
218                                                     NID_delta_crl, &i,
219                                                     NULL);
220         if (crl->base_crl_number == NULL && i != -1)
221             crl->flags |= EXFLAG_INVALID;
222         /* Delta CRLs must have CRL number */
223         if (crl->base_crl_number && !crl->crl_number)
224             crl->flags |= EXFLAG_INVALID;
225 
226         /*
227          * See if we have any unhandled critical CRL extensions and indicate
228          * this in a flag. We only currently handle IDP so anything else
229          * critical sets the flag. This code accesses the X509_CRL structure
230          * directly: applications shouldn't do this.
231          */
232 
233         exts = crl->crl.extensions;
234 
235         for (idx = 0; idx < sk_X509_EXTENSION_num(exts); idx++) {
236             int nid;
237             ext = sk_X509_EXTENSION_value(exts, idx);
238             nid = OBJ_obj2nid(X509_EXTENSION_get_object(ext));
239             if (nid == NID_freshest_crl)
240                 crl->flags |= EXFLAG_FRESHEST;
241             if (X509_EXTENSION_get_critical(ext)) {
242                 /* We handle IDP and deltas */
243                 if ((nid == NID_issuing_distribution_point)
244                     || (nid == NID_authority_key_identifier)
245                     || (nid == NID_delta_crl))
246                     continue;
247                 crl->flags |= EXFLAG_CRITICAL;
248                 break;
249             }
250         }
251 
252         if (!crl_set_issuers(crl))
253             return 0;
254 
255         if (crl->meth->crl_init) {
256             if (crl->meth->crl_init(crl) == 0)
257                 return 0;
258         }
259 
260         crl->flags |= EXFLAG_SET;
261         break;
262 
263     case ASN1_OP_FREE_POST:
264         if (crl->meth != NULL && crl->meth->crl_free != NULL) {
265             if (!crl->meth->crl_free(crl))
266                 return 0;
267         }
268         AUTHORITY_KEYID_free(crl->akid);
269         ISSUING_DIST_POINT_free(crl->idp);
270         ASN1_INTEGER_free(crl->crl_number);
271         ASN1_INTEGER_free(crl->base_crl_number);
272         sk_GENERAL_NAMES_pop_free(crl->issuers, GENERAL_NAMES_free);
273         OPENSSL_free(crl->propq);
274         break;
275     case ASN1_OP_DUP_POST:
276         {
277             X509_CRL *old = exarg;
278 
279             if (!ossl_x509_crl_set0_libctx(crl, old->libctx, old->propq))
280                 return 0;
281         }
282         break;
283     }
284     return 1;
285 }
286 
287 /* Convert IDP into a more convenient form */
288 
setup_idp(X509_CRL * crl,ISSUING_DIST_POINT * idp)289 static int setup_idp(X509_CRL *crl, ISSUING_DIST_POINT *idp)
290 {
291     int idp_only = 0;
292     int ret = 0;
293 
294     /* Set various flags according to IDP */
295     crl->idp_flags |= IDP_PRESENT;
296     if (idp->onlyuser > 0) {
297         idp_only++;
298         crl->idp_flags |= IDP_ONLYUSER;
299     }
300     if (idp->onlyCA > 0) {
301         idp_only++;
302         crl->idp_flags |= IDP_ONLYCA;
303     }
304     if (idp->onlyattr > 0) {
305         idp_only++;
306         crl->idp_flags |= IDP_ONLYATTR;
307     }
308 
309     if (idp_only > 1)
310         crl->idp_flags |= IDP_INVALID;
311 
312     if (idp->indirectCRL > 0)
313         crl->idp_flags |= IDP_INDIRECT;
314 
315     if (idp->onlysomereasons) {
316         crl->idp_flags |= IDP_REASONS;
317         if (idp->onlysomereasons->length > 0)
318             crl->idp_reasons = idp->onlysomereasons->data[0];
319         if (idp->onlysomereasons->length > 1)
320             crl->idp_reasons |= (idp->onlysomereasons->data[1] << 8);
321         crl->idp_reasons &= CRLDP_ALL_REASONS;
322     }
323 
324     ret = DIST_POINT_set_dpname(idp->distpoint, X509_CRL_get_issuer(crl));
325 
326     /*
327      * RFC5280 specifies that if onlyContainsUserCerts, onlyContainsCACerts,
328      * indirectCRL, and OnlyContainsAttributeCerts are all FALSE, there must
329      * be either a distributionPoint field or an onlySomeReasons field present.
330      */
331     if (crl->idp_flags == IDP_PRESENT && idp->distpoint == NULL)
332         crl->idp_flags |= IDP_INVALID;
333 
334     return ret;
335 }
336 
337 ASN1_SEQUENCE_ref(X509_CRL, crl_cb) = {
338         ASN1_EMBED(X509_CRL, crl, X509_CRL_INFO),
339         ASN1_EMBED(X509_CRL, sig_alg, X509_ALGOR),
340         ASN1_EMBED(X509_CRL, signature, ASN1_BIT_STRING)
341 } ASN1_SEQUENCE_END_ref(X509_CRL, X509_CRL)
342 
343 IMPLEMENT_ASN1_FUNCTIONS(X509_REVOKED)
344 
345 IMPLEMENT_ASN1_DUP_FUNCTION(X509_REVOKED)
346 
347 IMPLEMENT_ASN1_FUNCTIONS(X509_CRL_INFO)
348 
349 IMPLEMENT_ASN1_FUNCTIONS(X509_CRL)
350 
351 IMPLEMENT_ASN1_DUP_FUNCTION(X509_CRL)
352 
353 static int X509_REVOKED_cmp(const X509_REVOKED *const *a,
354                             const X509_REVOKED *const *b)
355 {
356     return (ASN1_STRING_cmp((ASN1_STRING *)&(*a)->serialNumber,
357                             (ASN1_STRING *)&(*b)->serialNumber));
358 }
359 
X509_CRL_new_ex(OSSL_LIB_CTX * libctx,const char * propq)360 X509_CRL *X509_CRL_new_ex(OSSL_LIB_CTX *libctx, const char *propq)
361 {
362     X509_CRL *crl = NULL;
363 
364     crl = (X509_CRL *)ASN1_item_new((X509_CRL_it()));
365     if (!ossl_x509_crl_set0_libctx(crl, libctx, propq)) {
366         X509_CRL_free(crl);
367         crl = NULL;
368     }
369     return crl;
370 }
371 
X509_CRL_add0_revoked(X509_CRL * crl,X509_REVOKED * rev)372 int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev)
373 {
374     X509_CRL_INFO *inf;
375 
376     inf = &crl->crl;
377     if (inf->revoked == NULL)
378         inf->revoked = sk_X509_REVOKED_new(X509_REVOKED_cmp);
379     if (inf->revoked == NULL || !sk_X509_REVOKED_push(inf->revoked, rev)) {
380         ERR_raise(ERR_LIB_ASN1, ERR_R_CRYPTO_LIB);
381         return 0;
382     }
383     inf->enc.modified = 1;
384     return 1;
385 }
386 
X509_CRL_verify(X509_CRL * crl,EVP_PKEY * r)387 int X509_CRL_verify(X509_CRL *crl, EVP_PKEY *r)
388 {
389     if (crl->meth->crl_verify)
390         return crl->meth->crl_verify(crl, r);
391     return 0;
392 }
393 
X509_CRL_get0_by_serial(X509_CRL * crl,X509_REVOKED ** ret,const ASN1_INTEGER * serial)394 int X509_CRL_get0_by_serial(X509_CRL *crl,
395                             X509_REVOKED **ret, const ASN1_INTEGER *serial)
396 {
397     if (crl->meth->crl_lookup)
398         return crl->meth->crl_lookup(crl, ret, serial, NULL);
399     return 0;
400 }
401 
X509_CRL_get0_by_cert(X509_CRL * crl,X509_REVOKED ** ret,X509 * x)402 int X509_CRL_get0_by_cert(X509_CRL *crl, X509_REVOKED **ret, X509 *x)
403 {
404     if (crl->meth->crl_lookup)
405         return crl->meth->crl_lookup(crl, ret,
406                                      X509_get0_serialNumber(x),
407                                      X509_get_issuer_name(x));
408     return 0;
409 }
410 
def_crl_verify(X509_CRL * crl,EVP_PKEY * r)411 static int def_crl_verify(X509_CRL *crl, EVP_PKEY *r)
412 {
413     return ASN1_item_verify_ex(ASN1_ITEM_rptr(X509_CRL_INFO),
414                                &crl->sig_alg, &crl->signature, &crl->crl, NULL,
415                                r, crl->libctx, crl->propq);
416 }
417 
crl_revoked_issuer_match(X509_CRL * crl,const X509_NAME * nm,X509_REVOKED * rev)418 static int crl_revoked_issuer_match(X509_CRL *crl, const X509_NAME *nm,
419                                     X509_REVOKED *rev)
420 {
421     int i;
422 
423     if (!rev->issuer) {
424         if (!nm)
425             return 1;
426         if (!X509_NAME_cmp(nm, X509_CRL_get_issuer(crl)))
427             return 1;
428         return 0;
429     }
430 
431     if (!nm)
432         nm = X509_CRL_get_issuer(crl);
433 
434     for (i = 0; i < sk_GENERAL_NAME_num(rev->issuer); i++) {
435         GENERAL_NAME *gen = sk_GENERAL_NAME_value(rev->issuer, i);
436         if (gen->type != GEN_DIRNAME)
437             continue;
438         if (!X509_NAME_cmp(nm, gen->d.directoryName))
439             return 1;
440     }
441     return 0;
442 
443 }
444 
def_crl_lookup(X509_CRL * crl,X509_REVOKED ** ret,const ASN1_INTEGER * serial,const X509_NAME * issuer)445 static int def_crl_lookup(X509_CRL *crl,
446                           X509_REVOKED **ret, const ASN1_INTEGER *serial,
447                           const X509_NAME *issuer)
448 {
449     X509_REVOKED rtmp, *rev;
450     int idx, num;
451 
452     if (crl->crl.revoked == NULL)
453         return 0;
454 
455     /*
456      * Sort revoked into serial number order if not already sorted. Do this
457      * under a lock to avoid race condition.
458      */
459     if (!sk_X509_REVOKED_is_sorted(crl->crl.revoked)) {
460         if (!CRYPTO_THREAD_write_lock(crl->lock))
461             return 0;
462         sk_X509_REVOKED_sort(crl->crl.revoked);
463         CRYPTO_THREAD_unlock(crl->lock);
464     }
465     rtmp.serialNumber = *serial;
466     idx = sk_X509_REVOKED_find(crl->crl.revoked, &rtmp);
467     if (idx < 0)
468         return 0;
469     /* Need to look for matching name */
470     for (num = sk_X509_REVOKED_num(crl->crl.revoked); idx < num; idx++) {
471         rev = sk_X509_REVOKED_value(crl->crl.revoked, idx);
472         if (ASN1_INTEGER_cmp(&rev->serialNumber, serial))
473             return 0;
474         if (crl_revoked_issuer_match(crl, issuer, rev)) {
475             if (ret)
476                 *ret = rev;
477             if (rev->reason == CRL_REASON_REMOVE_FROM_CRL)
478                 return 2;
479             return 1;
480         }
481     }
482     return 0;
483 }
484 
X509_CRL_set_default_method(const X509_CRL_METHOD * meth)485 void X509_CRL_set_default_method(const X509_CRL_METHOD *meth)
486 {
487     if (meth == NULL)
488         default_crl_method = &int_crl_meth;
489     else
490         default_crl_method = meth;
491 }
492 
X509_CRL_METHOD_new(int (* crl_init)(X509_CRL * crl),int (* crl_free)(X509_CRL * crl),int (* crl_lookup)(X509_CRL * crl,X509_REVOKED ** ret,const ASN1_INTEGER * ser,const X509_NAME * issuer),int (* crl_verify)(X509_CRL * crl,EVP_PKEY * pk))493 X509_CRL_METHOD *X509_CRL_METHOD_new(int (*crl_init) (X509_CRL *crl),
494                                      int (*crl_free) (X509_CRL *crl),
495                                      int (*crl_lookup) (X509_CRL *crl,
496                                                         X509_REVOKED **ret,
497                                                         const ASN1_INTEGER *ser,
498                                                         const X509_NAME *issuer),
499                                      int (*crl_verify) (X509_CRL *crl,
500                                                         EVP_PKEY *pk))
501 {
502     X509_CRL_METHOD *m = OPENSSL_malloc(sizeof(*m));
503 
504     if (m == NULL)
505         return NULL;
506     m->crl_init = crl_init;
507     m->crl_free = crl_free;
508     m->crl_lookup = crl_lookup;
509     m->crl_verify = crl_verify;
510     m->flags = X509_CRL_METHOD_DYNAMIC;
511     return m;
512 }
513 
X509_CRL_METHOD_free(X509_CRL_METHOD * m)514 void X509_CRL_METHOD_free(X509_CRL_METHOD *m)
515 {
516     if (m == NULL || !(m->flags & X509_CRL_METHOD_DYNAMIC))
517         return;
518     OPENSSL_free(m);
519 }
520 
X509_CRL_set_meth_data(X509_CRL * crl,void * dat)521 void X509_CRL_set_meth_data(X509_CRL *crl, void *dat)
522 {
523     crl->meth_data = dat;
524 }
525 
X509_CRL_get_meth_data(X509_CRL * crl)526 void *X509_CRL_get_meth_data(X509_CRL *crl)
527 {
528     return crl->meth_data;
529 }
530 
ossl_x509_crl_set0_libctx(X509_CRL * x,OSSL_LIB_CTX * libctx,const char * propq)531 int ossl_x509_crl_set0_libctx(X509_CRL *x, OSSL_LIB_CTX *libctx,
532                               const char *propq)
533 {
534     if (x != NULL) {
535         x->libctx = libctx;
536         OPENSSL_free(x->propq);
537         x->propq = NULL;
538         if (propq != NULL) {
539             x->propq = OPENSSL_strdup(propq);
540             if (x->propq == NULL)
541                 return 0;
542         }
543     }
544     return 1;
545 }
546