1 /* filterentry.c - apply a filter to an entry */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2004 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
17 * All rights reserved.
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.
31 #include <ac/socket.h>
32 #include <ac/string.h>
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,
41 Entry *e, AttributeAssertion *ava, int type );
42 static int test_mra_filter( Operation *op,
43 Entry *e, MatchingRuleAssertion *mra );
44 static int test_presence_filter( Operation *op,
45 Entry *e, AttributeDescription *desc );
49 * test_filter - test a filter against a single entry.
51 * LDAP_COMPARE_TRUE filter matched
52 * LDAP_COMPARE_FALSE filter did not match
53 * SLAPD_COMPARE_UNDEFINED filter is undefined
54 * or an ldap result code indicating error
64 Debug( LDAP_DEBUG_FILTER, "=> test_filter\n", 0, 0, 0 );
66 switch ( f->f_choice ) {
67 case SLAPD_FILTER_COMPUTED:
68 Debug( LDAP_DEBUG_FILTER, " COMPUTED %s (%d)\n",
69 f->f_result == LDAP_COMPARE_FALSE ? "false" :
70 f->f_result == LDAP_COMPARE_TRUE ? "true" :
71 f->f_result == SLAPD_COMPARE_UNDEFINED ? "undefined" : "error",
77 case LDAP_FILTER_EQUALITY:
78 Debug( LDAP_DEBUG_FILTER, " EQUALITY\n", 0, 0, 0 );
79 rc = test_ava_filter( op, e, f->f_ava, LDAP_FILTER_EQUALITY );
82 case LDAP_FILTER_SUBSTRINGS:
83 Debug( LDAP_DEBUG_FILTER, " SUBSTRINGS\n", 0, 0, 0 );
84 rc = test_substrings_filter( op, e, f );
88 Debug( LDAP_DEBUG_FILTER, " GE\n", 0, 0, 0 );
89 rc = test_ava_filter( op, e, f->f_ava, LDAP_FILTER_GE );
93 Debug( LDAP_DEBUG_FILTER, " LE\n", 0, 0, 0 );
94 rc = test_ava_filter( op, e, f->f_ava, LDAP_FILTER_LE );
97 case LDAP_FILTER_PRESENT:
98 Debug( LDAP_DEBUG_FILTER, " PRESENT\n", 0, 0, 0 );
99 rc = test_presence_filter( op, e, f->f_desc );
102 case LDAP_FILTER_APPROX:
103 Debug( LDAP_DEBUG_FILTER, " APPROX\n", 0, 0, 0 );
104 rc = test_ava_filter( op, e, f->f_ava, LDAP_FILTER_APPROX );
107 case LDAP_FILTER_AND:
108 Debug( LDAP_DEBUG_FILTER, " AND\n", 0, 0, 0 );
109 rc = test_filter_and( op, e, f->f_and );
113 Debug( LDAP_DEBUG_FILTER, " OR\n", 0, 0, 0 );
114 rc = test_filter_or( op, e, f->f_or );
117 case LDAP_FILTER_NOT:
118 Debug( LDAP_DEBUG_FILTER, " NOT\n", 0, 0, 0 );
119 rc = test_filter( op, e, f->f_not );
121 /* Flip true to false and false to true
122 * but leave Undefined alone.
125 case LDAP_COMPARE_TRUE:
126 rc = LDAP_COMPARE_FALSE;
128 case LDAP_COMPARE_FALSE:
129 rc = LDAP_COMPARE_TRUE;
134 case LDAP_FILTER_EXT:
135 Debug( LDAP_DEBUG_FILTER, " EXT\n", 0, 0, 0 );
136 rc = test_mra_filter( op, e, f->f_mra );
140 Debug( LDAP_DEBUG_ANY, " unknown filter type %lu\n",
142 rc = LDAP_PROTOCOL_ERROR;
145 Debug( LDAP_DEBUG_FILTER, "<= test_filter %d\n", rc, 0, 0 );
149 static int test_mra_filter(
152 MatchingRuleAssertion *mra )
156 BER_MEMFREE_FN *memfree;
160 memfree = slap_sl_free;
162 memctx = op->o_tmpmemctx;
163 memfree = op->o_tmpfree;
166 if ( mra->ma_desc ) {
168 * if ma_desc is available, then we're filtering for
169 * one attribute, and SEARCH permissions can be checked
172 if( !access_allowed( op, e,
173 mra->ma_desc, &mra->ma_value, ACL_SEARCH, NULL ) )
175 return LDAP_INSUFFICIENT_ACCESS;
178 if ( mra->ma_desc == slap_schema.si_ad_entryDN ) {
182 rc = value_match( &ret, slap_schema.si_ad_entryDN, mra->ma_rule,
183 0, &e->e_nname, &mra->ma_value, &text );
186 if( rc != LDAP_SUCCESS ) return rc;
187 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
188 return LDAP_COMPARE_FALSE;
191 for(a = attrs_find( e->e_attrs, mra->ma_desc );
193 a = attrs_find( a->a_next, mra->ma_desc ) )
196 /* If ma_rule is not the same as the attribute's
197 * normal rule, then we can't use the a_nvals.
199 if (mra->ma_rule == a->a_desc->ad_type->sat_equality) {
205 for ( ; bv->bv_val != NULL; bv++ ) {
210 #ifdef LDAP_COMP_MATCH
211 /* Component Matching */
213 mra->ma_rule->smr_usage & SLAP_MR_COMPONENT )
215 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
216 (struct berval *)a,(void*) mra , &text );
220 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
221 bv, &mra->ma_value, &text );
224 if( rc != LDAP_SUCCESS ) return rc;
225 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
231 * No attribute description: test all
233 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
234 struct berval *bv, value;
235 const char *text = NULL;
238 /* check if matching is appropriate */
239 if ( !mr_usable_with_at( mra->ma_rule, a->a_desc->ad_type )) {
243 /* normalize for equality */
244 rc = asserted_value_validate_normalize( a->a_desc, mra->ma_rule,
245 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
246 &mra->ma_value, &value, &text, memctx );
247 if ( rc != LDAP_SUCCESS ) continue;
249 /* check search access */
250 if ( !access_allowed( op, e,
251 a->a_desc, &value, ACL_SEARCH, NULL ) ) {
252 memfree( value.bv_val, memctx );
257 if (mra->ma_rule == a->a_desc->ad_type->sat_equality) {
263 for ( ; bv->bv_val != NULL; bv++ ) {
266 #ifdef LDAP_COMP_MATCH
267 /* Component Matching */
269 mra->ma_rule->smr_usage & SLAP_MR_COMPONENT)
271 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
272 (struct berval*)a, (void*)mra, &text );
276 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
280 if( rc != LDAP_SUCCESS ) break;
283 rc = LDAP_COMPARE_TRUE;
287 memfree( value.bv_val, memctx );
288 if ( rc != LDAP_SUCCESS ) return rc;
292 /* check attrs in DN AVAs if required */
293 if ( mra->ma_dnattrs ) {
298 /* parse and pretty the dn */
299 rc = dnPrettyDN( NULL, &e->e_name, &dn, memctx );
300 if ( rc != LDAP_SUCCESS ) {
301 return LDAP_INVALID_SYNTAX;
304 /* for each AVA of each RDN ... */
305 for ( iRDN = 0; dn[ iRDN ]; iRDN++ ) {
306 LDAPRDN rdn = dn[ iRDN ];
308 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
309 LDAPAVA *ava = rdn[ iAVA ];
310 struct berval *bv = &ava->la_value, value;
311 AttributeDescription *ad =
312 (AttributeDescription *)ava->la_private;
318 if ( mra->ma_desc ) {
319 /* have a mra type? check for subtype */
320 if ( !is_ad_subtype( ad, mra->ma_desc ) ) {
323 value = mra->ma_value;
326 const char *text = NULL;
328 /* check if matching is appropriate */
329 if ( !mr_usable_with_at( mra->ma_rule, ad->ad_type )) {
333 /* normalize for equality */
334 rc = asserted_value_validate_normalize( ad,
336 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
337 &mra->ma_value, &value, &text, memctx );
338 if ( rc != LDAP_SUCCESS ) continue;
340 /* check search access */
341 if ( !access_allowed( op, e,
342 ad, &value, ACL_SEARCH, NULL ) )
344 memfree( value.bv_val, memctx );
350 rc = value_match( &ret, ad, mra->ma_rule, 0,
352 if ( value.bv_val != mra->ma_value.bv_val ) {
353 memfree( value.bv_val, memctx );
356 if ( rc == LDAP_SUCCESS && ret == 0 ) rc = LDAP_COMPARE_TRUE;
358 if( rc != LDAP_SUCCESS ) {
359 ldap_dnfree_x( dn, memctx );
364 ldap_dnfree_x( dn, memctx );
367 return LDAP_COMPARE_FALSE;
374 AttributeAssertion *ava,
380 if ( !access_allowed( op, e,
381 ava->aa_desc, &ava->aa_value, ACL_SEARCH, NULL ) )
383 return LDAP_INSUFFICIENT_ACCESS;
386 if ( ava->aa_desc == slap_schema.si_ad_hasSubordinates
387 && op && op->o_bd && op->o_bd->be_has_subordinates )
392 if( type != LDAP_FILTER_EQUALITY &&
393 type != LDAP_FILTER_APPROX )
395 /* No other match is allowed */
396 return LDAP_INAPPROPRIATE_MATCHING;
399 if ( op->o_bd->be_has_subordinates( op, e, &hasSubordinates ) !=
405 if ( hasSubordinates == LDAP_COMPARE_TRUE ) {
408 } else if ( hasSubordinates == LDAP_COMPARE_FALSE ) {
415 if ( bvmatch( &ava->aa_value, &hs ) ) return LDAP_COMPARE_TRUE;
416 return LDAP_COMPARE_FALSE;
419 if ( ava->aa_desc == slap_schema.si_ad_entryDN ) {
424 if( type != LDAP_FILTER_EQUALITY &&
425 type != LDAP_FILTER_APPROX )
427 /* No other match is allowed */
428 return LDAP_INAPPROPRIATE_MATCHING;
431 mr = slap_schema.si_ad_entryDN->ad_type->sat_equality;
434 rc = value_match( &match, slap_schema.si_ad_entryDN, mr, 0,
435 &e->e_nname, &ava->aa_value, &text );
437 if( rc != LDAP_SUCCESS ) return rc;
438 if( match == 0 ) return LDAP_COMPARE_TRUE;
439 return LDAP_COMPARE_FALSE;
442 rc = LDAP_COMPARE_FALSE;
444 for(a = attrs_find( e->e_attrs, ava->aa_desc );
446 a = attrs_find( a->a_next, ava->aa_desc ) )
451 if (( ava->aa_desc != a->a_desc ) && !access_allowed( op,
452 e, a->a_desc, &ava->aa_value, ACL_SEARCH, NULL ))
454 rc = LDAP_INSUFFICIENT_ACCESS;
459 case LDAP_FILTER_APPROX:
460 mr = a->a_desc->ad_type->sat_approx;
461 if( mr != NULL ) break;
463 /* use EQUALITY matching rule if no APPROX rule */
465 case LDAP_FILTER_EQUALITY:
466 mr = a->a_desc->ad_type->sat_equality;
471 mr = a->a_desc->ad_type->sat_ordering;
479 rc = LDAP_INAPPROPRIATE_MATCHING;
483 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ ) {
487 ret = value_match( &match, a->a_desc, mr, 0,
488 bv, &ava->aa_value, &text );
490 if( ret != LDAP_SUCCESS ) {
496 case LDAP_FILTER_EQUALITY:
497 case LDAP_FILTER_APPROX:
498 if ( match == 0 ) return LDAP_COMPARE_TRUE;
502 if ( match >= 0 ) return LDAP_COMPARE_TRUE;
506 if ( match <= 0 ) return LDAP_COMPARE_TRUE;
517 test_presence_filter(
520 AttributeDescription *desc )
525 if ( !access_allowed( op, e, desc, NULL, ACL_SEARCH, NULL ) ) {
526 return LDAP_INSUFFICIENT_ACCESS;
529 if ( desc == slap_schema.si_ad_hasSubordinates ) {
531 * XXX: fairly optimistic: if the function is defined,
532 * then PRESENCE must succeed, because hasSubordinate
533 * is boolean-valued; I think we may live with this
534 * simplification by now
536 if ( op && op->o_bd && op->o_bd->be_has_subordinates ) {
537 return LDAP_COMPARE_TRUE;
540 return LDAP_COMPARE_FALSE;
543 if ( desc == slap_schema.si_ad_entryDN ||
544 desc == slap_schema.si_ad_subschemaSubentry )
546 /* entryDN and subschemaSubentry are always present */
547 return LDAP_COMPARE_TRUE;
550 rc = LDAP_COMPARE_FALSE;
552 for(a = attrs_find( e->e_attrs, desc );
554 a = attrs_find( a->a_next, desc ) )
556 if (( desc != a->a_desc ) && !access_allowed( op,
557 e, a->a_desc, NULL, ACL_SEARCH, NULL ))
559 rc = LDAP_INSUFFICIENT_ACCESS;
563 rc = LDAP_COMPARE_TRUE;
578 int rtn = LDAP_COMPARE_TRUE; /* True if empty */
580 Debug( LDAP_DEBUG_FILTER, "=> test_filter_and\n", 0, 0, 0 );
582 for ( f = flist; f != NULL; f = f->f_next ) {
583 int rc = test_filter( op, e, f );
585 if ( rc == LDAP_COMPARE_FALSE ) {
586 /* filter is False */
591 if ( rc != LDAP_COMPARE_TRUE ) {
592 /* filter is Undefined unless later elements are False */
597 Debug( LDAP_DEBUG_FILTER, "<= test_filter_and %d\n", rtn, 0, 0 );
609 int rtn = LDAP_COMPARE_FALSE; /* False if empty */
611 Debug( LDAP_DEBUG_FILTER, "=> test_filter_or\n", 0, 0, 0 );
613 for ( f = flist; f != NULL; f = f->f_next ) {
614 int rc = test_filter( op, e, f );
616 if ( rc == LDAP_COMPARE_TRUE ) {
622 if ( rc != LDAP_COMPARE_FALSE ) {
623 /* filter is Undefined unless later elements are True */
628 Debug( LDAP_DEBUG_FILTER, "<= test_filter_or %d\n", rtn, 0, 0 );
634 test_substrings_filter(
642 Debug( LDAP_DEBUG_FILTER, "begin test_substrings_filter\n", 0, 0, 0 );
644 if ( !access_allowed( op, e,
645 f->f_sub_desc, NULL, ACL_SEARCH, NULL ) )
647 return LDAP_INSUFFICIENT_ACCESS;
650 rc = LDAP_COMPARE_FALSE;
652 for(a = attrs_find( e->e_attrs, f->f_sub_desc );
654 a = attrs_find( a->a_next, f->f_sub_desc ) )
659 if (( f->f_sub_desc != a->a_desc ) && !access_allowed( op,
660 e, a->a_desc, NULL, ACL_SEARCH, NULL ))
662 rc = LDAP_INSUFFICIENT_ACCESS;
666 mr = a->a_desc->ad_type->sat_substr;
668 rc = LDAP_INAPPROPRIATE_MATCHING;
672 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ ) {
676 ret = value_match( &match, a->a_desc, mr, 0,
677 bv, f->f_sub, &text );
679 if( ret != LDAP_SUCCESS ) {
683 if ( match == 0 ) return LDAP_COMPARE_TRUE;
687 Debug( LDAP_DEBUG_FILTER, "end test_substrings_filter %d\n",