]> git.sur5r.net Git - openldap/blob - servers/slapd/filterentry.c
Fix approx matching when there is an equality index but no approx index.
[openldap] / servers / slapd / filterentry.c
1 /* filterentry.c - apply a filter to an entry */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 1998-2004 The OpenLDAP Foundation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted only as authorized by the OpenLDAP
10  * Public License.
11  *
12  * A copy of this license is available in the file LICENSE in the
13  * top-level directory of the distribution or, alternatively, at
14  * <http://www.OpenLDAP.org/license.html>.
15  */
16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
17  * All rights reserved.
18  *
19  * Redistribution and use in source and binary forms are permitted
20  * provided that this notice is preserved and that due credit is given
21  * to the University of Michigan at Ann Arbor. The name of the University
22  * may not be used to endorse or promote products derived from this
23  * software without specific prior written permission. This software
24  * is provided ``as is'' without express or implied warranty.
25  */
26
27 #include "portable.h"
28
29 #include <stdio.h>
30
31 #include <ac/socket.h>
32 #include <ac/string.h>
33
34
35 #include "slap.h"
36
37 static int      test_filter_and( Operation *op, Entry *e, Filter *flist );
38 static int      test_filter_or( Operation *op, Entry *e, Filter *flist );
39 static int      test_substrings_filter( Operation *op, Entry *e, Filter *f);
40 static int      test_ava_filter( Operation *op, Entry *e, AttributeAssertion *ava, int type );
41 static int      test_mra_filter( Operation *op, Entry *e, MatchingRuleAssertion *mra );
42 static int      test_presence_filter( Operation *op, Entry *e, AttributeDescription *desc );
43
44
45 /*
46  * test_filter - test a filter against a single entry.
47  * returns:
48  *              LDAP_COMPARE_TRUE               filter matched
49  *              LDAP_COMPARE_FALSE              filter did not match
50  *              SLAPD_COMPARE_UNDEFINED filter is undefined
51  *      or an ldap result code indicating error
52  */
53
54 int
55 test_filter(
56     Operation   *op,
57     Entry       *e,
58     Filter      *f
59 )
60 {
61         int     rc;
62 #ifdef NEW_LOGGING
63         LDAP_LOG( FILTER, ENTRY, "test_filter: begin\n", 0, 0, 0 );
64 #else
65         Debug( LDAP_DEBUG_FILTER, "=> test_filter\n", 0, 0, 0 );
66 #endif
67
68         switch ( f->f_choice ) {
69         case SLAPD_FILTER_COMPUTED:
70 #ifdef NEW_LOGGING
71                 LDAP_LOG( FILTER, DETAIL1,
72                         "test_filter:   COMPUTED %s (%d)\n",
73                         f->f_result == LDAP_COMPARE_FALSE ? "false" :
74                         f->f_result == LDAP_COMPARE_TRUE         ? "true"  :
75                         f->f_result == SLAPD_COMPARE_UNDEFINED ? "undefined" :
76                         "error", f->f_result, 0 );
77 #else
78                 Debug( LDAP_DEBUG_FILTER, "    COMPUTED %s (%d)\n",
79                         f->f_result == LDAP_COMPARE_FALSE ? "false" :
80                         f->f_result == LDAP_COMPARE_TRUE ? "true" :
81                         f->f_result == SLAPD_COMPARE_UNDEFINED ? "undefined" : "error",
82                         f->f_result, 0 );
83 #endif
84
85                 rc = f->f_result;
86                 break;
87
88         case LDAP_FILTER_EQUALITY:
89 #ifdef NEW_LOGGING
90                 LDAP_LOG( FILTER, DETAIL1, "test_filter:   EQUALITY\n", 0, 0, 0 );
91 #else
92                 Debug( LDAP_DEBUG_FILTER, "    EQUALITY\n", 0, 0, 0 );
93 #endif
94
95                 rc = test_ava_filter( op, e, f->f_ava,
96                     LDAP_FILTER_EQUALITY );
97                 break;
98
99         case LDAP_FILTER_SUBSTRINGS:
100 #ifdef NEW_LOGGING
101                 LDAP_LOG( FILTER, DETAIL1, "test_filter  SUBSTRINGS\n", 0, 0, 0 );
102 #else
103                 Debug( LDAP_DEBUG_FILTER, "    SUBSTRINGS\n", 0, 0, 0 );
104 #endif
105
106                 rc = test_substrings_filter( op, e, f );
107                 break;
108
109         case LDAP_FILTER_GE:
110                 rc = test_ava_filter( op, e, f->f_ava,
111                     LDAP_FILTER_GE );
112                 break;
113
114         case LDAP_FILTER_LE:
115                 rc = test_ava_filter( op, e, f->f_ava,
116                     LDAP_FILTER_LE );
117                 break;
118
119         case LDAP_FILTER_PRESENT:
120 #ifdef NEW_LOGGING
121                 LDAP_LOG( FILTER, DETAIL1, "test_filter:        PRESENT\n", 0, 0, 0 );
122 #else
123                 Debug( LDAP_DEBUG_FILTER, "    PRESENT\n", 0, 0, 0 );
124 #endif
125
126                 rc = test_presence_filter( op, e, f->f_desc );
127                 break;
128
129         case LDAP_FILTER_APPROX:
130 #ifdef NEW_LOGGING
131                 LDAP_LOG( FILTER, DETAIL1, "test_filter: APPROX\n", 0, 0, 0 );
132 #else
133                 Debug( LDAP_DEBUG_FILTER, "    APPROX\n", 0, 0, 0 );
134 #endif
135                 rc = test_ava_filter( op, e, f->f_ava,
136                     LDAP_FILTER_APPROX );
137                 break;
138
139         case LDAP_FILTER_AND:
140 #ifdef NEW_LOGGING
141                 LDAP_LOG( FILTER, DETAIL1, "test_filter:  AND\n", 0, 0, 0 );
142 #else
143                 Debug( LDAP_DEBUG_FILTER, "    AND\n", 0, 0, 0 );
144 #endif
145
146                 rc = test_filter_and( op, e, f->f_and );
147                 break;
148
149         case LDAP_FILTER_OR:
150 #ifdef NEW_LOGGING
151                 LDAP_LOG( FILTER, DETAIL1, "test_filter:        OR\n", 0, 0, 0 );
152 #else
153                 Debug( LDAP_DEBUG_FILTER, "    OR\n", 0, 0, 0 );
154 #endif
155
156                 rc = test_filter_or( op, e, f->f_or );
157                 break;
158
159         case LDAP_FILTER_NOT:
160 #ifdef NEW_LOGGING
161                 LDAP_LOG( FILTER, DETAIL1, "test_filter:        NOT\n", 0, 0, 0 );
162 #else
163                 Debug( LDAP_DEBUG_FILTER, "    NOT\n", 0, 0, 0 );
164 #endif
165
166                 rc = test_filter( op, e, f->f_not );
167
168                 /* Flip true to false and false to true
169                  * but leave Undefined alone.
170                  */
171                 switch( rc ) {
172                 case LDAP_COMPARE_TRUE:
173                         rc = LDAP_COMPARE_FALSE;
174                         break;
175                 case LDAP_COMPARE_FALSE:
176                         rc = LDAP_COMPARE_TRUE;
177                         break;
178                 }
179                 break;
180
181         case LDAP_FILTER_EXT:
182 #ifdef NEW_LOGGING
183                 LDAP_LOG( FILTER, DETAIL1, "test_filter:        EXT\n", 0, 0, 0 );
184 #else
185                 Debug( LDAP_DEBUG_FILTER, "    EXT\n", 0, 0, 0 );
186 #endif
187
188                 rc = test_mra_filter( op, e, f->f_mra );
189                 break;
190
191         default:
192 #ifdef NEW_LOGGING
193                 LDAP_LOG( FILTER, INFO, 
194                         "test_filter:  unknown filter type %lu\n", f->f_choice, 0, 0 );
195 #else
196                 Debug( LDAP_DEBUG_ANY, "    unknown filter type %lu\n",
197                     f->f_choice, 0, 0 );
198 #endif
199
200                 rc = LDAP_PROTOCOL_ERROR;
201         }
202
203 #ifdef NEW_LOGGING
204         LDAP_LOG( FILTER, RESULTS, "test_filter:  return=%d\n", rc, 0, 0 );
205 #else
206         Debug( LDAP_DEBUG_FILTER, "<= test_filter %d\n", rc, 0, 0 );
207 #endif
208
209         return( rc );
210 }
211
212 static int test_mra_filter(
213         Operation *op,
214         Entry *e,
215         MatchingRuleAssertion *mra )
216 {
217         Attribute       *a;
218         void *memctx = op ? op->o_tmpmemctx : NULL;
219
220         if ( mra->ma_desc ) {
221                 /*
222                  * if ma_desc is available, then we're filtering for
223                  * one attribute, and SEARCH permissions can be checked
224                  * directly.
225                  */
226                 if( !access_allowed( op, e,
227                         mra->ma_desc, &mra->ma_value, ACL_SEARCH, NULL ) )
228                 {
229                         return LDAP_INSUFFICIENT_ACCESS;
230                 }
231
232                 for(a = attrs_find( e->e_attrs, mra->ma_desc );
233                         a != NULL;
234                         a = attrs_find( a->a_next, mra->ma_desc ) )
235                 {
236                         struct berval *bv;
237                         /* If ma_rule is not the same as the attribute's
238                          * normal rule, then we can't use the a_nvals.
239                          */
240                         if (mra->ma_rule == a->a_desc->ad_type->sat_equality) {
241                                 bv = a->a_nvals;
242                         } else {
243                                 bv = a->a_vals;
244                         }
245
246                         for ( ; bv->bv_val != NULL; bv++ ) {
247                                 int ret;
248                                 int rc;
249                                 const char *text;
250         
251                                 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
252                                         bv, &mra->ma_value, &text );
253         
254                                 if( rc != LDAP_SUCCESS ) {
255                                         return rc;
256                                 }
257         
258                                 if ( ret == 0 ) {
259                                         return LDAP_COMPARE_TRUE;
260                                 }
261                         }
262                 }
263         } else {
264
265                 /*
266                  * No attribute description: test all
267                  */
268                 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
269                         struct berval   *bv, value;
270                         const char      *text = NULL;
271                         int             rc;
272
273                         /* check if matching is appropriate */
274                         if ( !mr_usable_with_at( mra->ma_rule, a->a_desc->ad_type )) {
275                                 continue;
276                         }
277
278                         /* normalize for equality */
279                         rc = asserted_value_validate_normalize( a->a_desc, mra->ma_rule,
280                                 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
281                                 &mra->ma_value, &value, &text, memctx );
282                         if ( rc != LDAP_SUCCESS ) {
283                                 continue;
284                         }
285
286                         /* check search access */
287                         if ( !access_allowed( op, e,
288                                 a->a_desc, &value, ACL_SEARCH, NULL ) ) {
289                                 continue;
290                         }
291
292                         /* check match */
293                         if (mra->ma_rule == a->a_desc->ad_type->sat_equality)
294                                 bv = a->a_nvals;
295                         else
296                                 bv = a->a_vals;
297                         for ( ; bv->bv_val != NULL; bv++ )
298                         {
299                                 int ret;
300                                 int rc;
301         
302                                 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
303                                         bv, &value, &text );
304         
305                                 if( rc != LDAP_SUCCESS ) {
306                                         return rc;
307                                 }
308         
309                                 if ( ret == 0 ) {
310                                         return LDAP_COMPARE_TRUE;
311                                 }
312                         }
313                 }
314         }
315
316         /* check attrs in DN AVAs if required */
317         if ( mra->ma_dnattrs ) {
318                 LDAPDN          dn = NULL;
319                 int             iRDN, iAVA;
320                 int             rc;
321
322                 /* parse and pretty the dn */
323                 rc = dnPrettyDN( NULL, &e->e_name, &dn, memctx );
324                 if ( rc != LDAP_SUCCESS ) {
325                         return LDAP_INVALID_SYNTAX;
326                 }
327
328                 /* for each AVA of each RDN ... */
329                 for ( iRDN = 0; dn[ iRDN ]; iRDN++ ) {
330                         LDAPRDN         rdn = dn[ iRDN ];
331
332                         for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
333                                 LDAPAVA         *ava = rdn[ iAVA ];
334                                 struct berval   *bv = &ava->la_value, value;
335                                 AttributeDescription *ad = (AttributeDescription *)ava->la_private;
336                                 int ret;
337                                 int rc;
338                                 const char *text;
339
340                                 assert( ad );
341
342                                 if ( mra->ma_desc ) {
343                                         /* have a mra type? check for subtype */
344                                         if ( !is_ad_subtype( ad, mra->ma_desc ) ) {
345                                                 continue;
346                                         }
347                                         value = mra->ma_value;
348
349                                 } else {
350                                         const char      *text = NULL;
351
352                                         /* check if matching is appropriate */
353                                         if ( !mr_usable_with_at( mra->ma_rule, ad->ad_type )) {
354                                                 continue;
355                                         }
356
357                                         /* normalize for equality */
358                                         rc = asserted_value_validate_normalize( ad,
359                                                 mra->ma_rule,
360                                                 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
361                                                 &mra->ma_value, &value, &text, memctx );
362                                         if ( rc != LDAP_SUCCESS ) {
363                                                 continue;
364                                         }
365
366                                         /* check search access */
367                                         if ( !access_allowed( op, e,
368                                                 ad, &value, ACL_SEARCH, NULL ) ) {
369                                                 continue;
370                                         }
371                                 }
372
373                                 /* check match */
374                                 rc = value_match( &ret, ad, mra->ma_rule, 0,
375                                         bv, &value, &text );
376
377                                 if( rc != LDAP_SUCCESS ) {
378                                         ldap_dnfree_x( dn, memctx );
379                                         return rc;
380                                 }
381
382                                 if ( ret == 0 ) {
383                                         ldap_dnfree_x( dn, memctx );
384                                         return LDAP_COMPARE_TRUE;
385                                 }
386                         }
387                 }
388         }
389
390         return LDAP_COMPARE_FALSE;
391 }
392
393 static int
394 test_ava_filter(
395         Operation       *op,
396         Entry           *e,
397         AttributeAssertion *ava,
398         int             type
399 )
400 {
401         Attribute       *a;
402
403         if ( !access_allowed( op, e,
404                 ava->aa_desc, &ava->aa_value, ACL_SEARCH, NULL ) )
405         {
406                 return LDAP_INSUFFICIENT_ACCESS;
407         }
408
409         for(a = attrs_find( e->e_attrs, ava->aa_desc );
410                 a != NULL;
411                 a = attrs_find( a->a_next, ava->aa_desc ) )
412         {
413                 MatchingRule *mr;
414                 struct berval *bv;
415
416                 switch ( type ) {
417                 case LDAP_FILTER_APPROX:
418                         mr = a->a_desc->ad_type->sat_approx;
419                         if( mr != NULL ) break;
420
421                         /* use EQUALITY matching rule if no APPROX rule */
422
423                 case LDAP_FILTER_EQUALITY:
424                         mr = a->a_desc->ad_type->sat_equality;
425                         break;
426
427                 case LDAP_FILTER_GE:
428                 case LDAP_FILTER_LE:
429                         mr = a->a_desc->ad_type->sat_ordering;
430                         break;
431
432                 default:
433                         mr = NULL;
434                 }
435
436                 if( mr == NULL ) {
437                         continue;
438                 }
439
440                 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ ) {
441                         int ret;
442                         int rc;
443                         const char *text;
444
445                         rc = value_match( &ret, a->a_desc, mr, 0,
446                                 bv, &ava->aa_value, &text );
447
448                         if( rc != LDAP_SUCCESS ) {
449                                 return rc;
450                         }
451
452                         switch ( type ) {
453                         case LDAP_FILTER_EQUALITY:
454                         case LDAP_FILTER_APPROX:
455                                 if ( ret == 0 ) {
456                                         return LDAP_COMPARE_TRUE;
457                                 }
458                                 break;
459
460                         case LDAP_FILTER_GE:
461                                 if ( ret >= 0 ) {
462                                         return LDAP_COMPARE_TRUE;
463                                 }
464                                 break;
465
466                         case LDAP_FILTER_LE:
467                                 if ( ret <= 0 ) {
468                                         return LDAP_COMPARE_TRUE;
469                                 }
470                                 break;
471                         }
472                 }
473         }
474
475         if ( ava->aa_desc == slap_schema.si_ad_hasSubordinates 
476                         && op && op->o_bd && op->o_bd->be_has_subordinates ) {
477                 int             hasSubordinates;
478                 struct berval   hs;
479
480                 /*
481                  * No other match should be allowed ...
482                  */
483                 assert( type == LDAP_FILTER_EQUALITY );
484                 
485                 if (op->o_bd->be_has_subordinates( op, e, &hasSubordinates ) != LDAP_SUCCESS) {
486                         return LDAP_OTHER;
487                 }
488
489                 if ( hasSubordinates == LDAP_COMPARE_TRUE ) {
490                         hs = slap_true_bv;
491
492                 } else if ( hasSubordinates == LDAP_COMPARE_FALSE ) {
493                         hs = slap_false_bv;
494
495                 } else {
496                         return LDAP_OTHER;
497                 }
498
499                 if ( bvmatch( &ava->aa_value, &hs ) ) {
500                         return LDAP_COMPARE_TRUE;
501                 }
502
503                 return LDAP_COMPARE_FALSE;
504         }
505
506         return( LDAP_COMPARE_FALSE );
507 }
508
509
510 static int
511 test_presence_filter(
512         Operation       *op,
513         Entry           *e,
514         AttributeDescription *desc
515 )
516 {
517         Attribute       *a;
518
519         if ( !access_allowed( op, e, desc, NULL, ACL_SEARCH, NULL ) )
520         {
521                 return LDAP_INSUFFICIENT_ACCESS;
522         }
523
524         a = attrs_find( e->e_attrs, desc );
525
526         if ( a == NULL && desc == slap_schema.si_ad_hasSubordinates ) {
527
528                 /*
529                  * XXX: fairly optimistic: if the function is defined,
530                  * then PRESENCE must succeed, because hasSubordinate
531                  * is boolean-valued; I think we may live with this 
532                  * simplification by now
533                  */
534                 if ( op && op->o_bd && op->o_bd->be_has_subordinates ) {
535                         return LDAP_COMPARE_TRUE;
536                 }
537
538                 return LDAP_COMPARE_FALSE;
539         }
540
541         return a != NULL ? LDAP_COMPARE_TRUE : LDAP_COMPARE_FALSE;
542 }
543
544
545 static int
546 test_filter_and(
547         Operation       *op,
548         Entry   *e,
549         Filter  *flist
550 )
551 {
552         Filter  *f;
553         int rtn = LDAP_COMPARE_TRUE; /* True if empty */
554
555 #ifdef NEW_LOGGING
556         LDAP_LOG( FILTER, ENTRY, "test_filter_and: begin\n", 0, 0, 0 );
557 #else
558         Debug( LDAP_DEBUG_FILTER, "=> test_filter_and\n", 0, 0, 0 );
559 #endif
560
561
562         for ( f = flist; f != NULL; f = f->f_next ) {
563                 int rc = test_filter( op, e, f );
564
565                 if ( rc == LDAP_COMPARE_FALSE ) {
566                         /* filter is False */
567                         rtn = rc;
568                         break;
569                 }
570
571                 if ( rc != LDAP_COMPARE_TRUE ) {
572                         /* filter is Undefined unless later elements are False */
573                         rtn = rc;
574                 }
575         }
576
577 #ifdef NEW_LOGGING
578         LDAP_LOG( FILTER, RESULTS, "test_filter_and:  rc=%d\n", rtn, 0, 0 );
579 #else
580         Debug( LDAP_DEBUG_FILTER, "<= test_filter_and %d\n", rtn, 0, 0 );
581 #endif
582
583         return rtn;
584 }
585
586 static int
587 test_filter_or(
588         Operation       *op,
589         Entry   *e,
590         Filter  *flist
591 )
592 {
593         Filter  *f;
594         int rtn = LDAP_COMPARE_FALSE; /* False if empty */
595
596 #ifdef NEW_LOGGING
597         LDAP_LOG( FILTER, ENTRY, "test_filter_or: begin\n", 0, 0, 0 );
598 #else
599         Debug( LDAP_DEBUG_FILTER, "=> test_filter_or\n", 0, 0, 0 );
600 #endif
601
602
603         for ( f = flist; f != NULL; f = f->f_next ) {
604                 int rc = test_filter( op, e, f );
605
606                 if ( rc == LDAP_COMPARE_TRUE ) {
607                         /* filter is True */
608                         rtn = rc;
609                         break;
610                 }
611
612                 if ( rc != LDAP_COMPARE_FALSE ) {
613                         /* filter is Undefined unless later elements are True */
614                         rtn = rc;
615                 }
616         }
617
618 #ifdef NEW_LOGGING
619         LDAP_LOG( FILTER, ENTRY, "test_filter_or: result=%d\n", rtn, 0, 0 );
620 #else
621         Debug( LDAP_DEBUG_FILTER, "<= test_filter_or %d\n", rtn, 0, 0 );
622 #endif
623
624         return rtn;
625 }
626
627
628 static int
629 test_substrings_filter(
630         Operation       *op,
631         Entry   *e,
632         Filter  *f
633 )
634 {
635         Attribute       *a;
636
637 #ifdef NEW_LOGGING
638         LDAP_LOG( FILTER, ENTRY, "test_substrings_filter: begin\n", 0, 0, 0 );
639 #else
640         Debug( LDAP_DEBUG_FILTER, "begin test_substrings_filter\n", 0, 0, 0 );
641 #endif
642
643
644         if ( !access_allowed( op, e,
645                 f->f_sub_desc, NULL, ACL_SEARCH, NULL ) )
646         {
647                 return LDAP_INSUFFICIENT_ACCESS;
648         }
649
650         for(a = attrs_find( e->e_attrs, f->f_sub_desc );
651                 a != NULL;
652                 a = attrs_find( a->a_next, f->f_sub_desc ) )
653         {
654                 MatchingRule *mr = a->a_desc->ad_type->sat_substr;
655                 struct berval *bv;
656
657                 if( mr == NULL ) {
658                         continue;
659                 }
660
661                 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ )
662                 {
663                         int ret;
664                         int rc;
665                         const char *text;
666
667                         rc = value_match( &ret, a->a_desc, mr, 0,
668                                 bv, f->f_sub, &text );
669
670                         if( rc != LDAP_SUCCESS ) {
671                                 return rc;
672                         }
673
674                         if ( ret == 0 ) {
675                                 return LDAP_COMPARE_TRUE;
676                         }
677                 }
678         }
679
680 #ifdef NEW_LOGGING
681         LDAP_LOG( FILTER, ENTRY, "test_substrings_filter: return FALSE\n", 0, 0, 0 );
682 #else
683         Debug( LDAP_DEBUG_FILTER, "end test_substrings_filter 1\n", 0, 0, 0 );
684 #endif
685
686         return LDAP_COMPARE_FALSE;
687 }