1 /* filterentry.c - apply a filter to an entry */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2005 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 #ifdef LDAP_COMP_MATCH
197 /* Component Matching */
199 mra->ma_rule->smr_usage & SLAP_MR_COMPONENT )
205 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
206 (struct berval *)a,(void*) mra , &text );
207 if ( rc != LDAP_SUCCESS ) return rc;
208 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
209 else return LDAP_COMPARE_FALSE;
213 /* If ma_rule is not the same as the attribute's
214 * normal rule, then we can't use the a_nvals.
216 if (mra->ma_rule == a->a_desc->ad_type->sat_equality) {
222 for ( ; bv->bv_val != NULL; bv++ ) {
227 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
228 bv, &mra->ma_value, &text );
230 if( rc != LDAP_SUCCESS ) return rc;
231 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
237 * No attribute description: test all
239 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
240 struct berval *bv, value;
241 const char *text = NULL;
244 /* check if matching is appropriate */
245 if ( !mr_usable_with_at( mra->ma_rule, a->a_desc->ad_type )) {
249 /* normalize for equality */
250 rc = asserted_value_validate_normalize( a->a_desc, mra->ma_rule,
251 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
252 &mra->ma_value, &value, &text, memctx );
253 if ( rc != LDAP_SUCCESS ) continue;
255 /* check search access */
256 if ( !access_allowed( op, e,
257 a->a_desc, &value, ACL_SEARCH, NULL ) ) {
258 memfree( value.bv_val, memctx );
261 #ifdef LDAP_COMP_MATCH
262 /* Component Matching */
264 mra->ma_rule->smr_usage & SLAP_MR_COMPONENT)
268 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
269 (struct berval*)a, (void*)mra, &text );
270 if( rc != LDAP_SUCCESS ) break;
273 rc = LDAP_COMPARE_TRUE;
281 if (mra->ma_rule == a->a_desc->ad_type->sat_equality) {
287 for ( ; bv->bv_val != NULL; bv++ ) {
290 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
293 if( rc != LDAP_SUCCESS ) break;
296 rc = LDAP_COMPARE_TRUE;
300 memfree( value.bv_val, memctx );
301 if ( rc != LDAP_SUCCESS ) return rc;
305 /* check attrs in DN AVAs if required */
306 if ( mra->ma_dnattrs ) {
311 /* parse and pretty the dn */
312 rc = dnPrettyDN( NULL, &e->e_name, &dn, memctx );
313 if ( rc != LDAP_SUCCESS ) {
314 return LDAP_INVALID_SYNTAX;
317 /* for each AVA of each RDN ... */
318 for ( iRDN = 0; dn[ iRDN ]; iRDN++ ) {
319 LDAPRDN rdn = dn[ iRDN ];
321 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
322 LDAPAVA *ava = rdn[ iAVA ];
323 struct berval *bv = &ava->la_value, value;
324 AttributeDescription *ad =
325 (AttributeDescription *)ava->la_private;
331 if ( mra->ma_desc ) {
332 /* have a mra type? check for subtype */
333 if ( !is_ad_subtype( ad, mra->ma_desc ) ) {
336 value = mra->ma_value;
339 const char *text = NULL;
341 /* check if matching is appropriate */
342 if ( !mr_usable_with_at( mra->ma_rule, ad->ad_type )) {
346 /* normalize for equality */
347 rc = asserted_value_validate_normalize( ad,
349 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
350 &mra->ma_value, &value, &text, memctx );
351 if ( rc != LDAP_SUCCESS ) continue;
353 /* check search access */
354 if ( !access_allowed( op, e,
355 ad, &value, ACL_SEARCH, NULL ) )
357 memfree( value.bv_val, memctx );
363 rc = value_match( &ret, ad, mra->ma_rule, 0,
365 if ( value.bv_val != mra->ma_value.bv_val ) {
366 memfree( value.bv_val, memctx );
369 if ( rc == LDAP_SUCCESS && ret == 0 ) rc = LDAP_COMPARE_TRUE;
371 if( rc != LDAP_SUCCESS ) {
372 ldap_dnfree_x( dn, memctx );
377 ldap_dnfree_x( dn, memctx );
380 return LDAP_COMPARE_FALSE;
387 AttributeAssertion *ava,
393 if ( !access_allowed( op, e,
394 ava->aa_desc, &ava->aa_value, ACL_SEARCH, NULL ) )
396 return LDAP_INSUFFICIENT_ACCESS;
399 if ( ava->aa_desc == slap_schema.si_ad_hasSubordinates
400 && op && op->o_bd && op->o_bd->be_has_subordinates )
405 if( type != LDAP_FILTER_EQUALITY &&
406 type != LDAP_FILTER_APPROX )
408 /* No other match is allowed */
409 return LDAP_INAPPROPRIATE_MATCHING;
412 if ( op->o_bd->be_has_subordinates( op, e, &hasSubordinates ) !=
418 if ( hasSubordinates == LDAP_COMPARE_TRUE ) {
421 } else if ( hasSubordinates == LDAP_COMPARE_FALSE ) {
428 if ( bvmatch( &ava->aa_value, &hs ) ) return LDAP_COMPARE_TRUE;
429 return LDAP_COMPARE_FALSE;
432 if ( ava->aa_desc == slap_schema.si_ad_entryDN ) {
437 if( type != LDAP_FILTER_EQUALITY &&
438 type != LDAP_FILTER_APPROX )
440 /* No other match is allowed */
441 return LDAP_INAPPROPRIATE_MATCHING;
444 mr = slap_schema.si_ad_entryDN->ad_type->sat_equality;
447 rc = value_match( &match, slap_schema.si_ad_entryDN, mr, 0,
448 &e->e_nname, &ava->aa_value, &text );
450 if( rc != LDAP_SUCCESS ) return rc;
451 if( match == 0 ) return LDAP_COMPARE_TRUE;
452 return LDAP_COMPARE_FALSE;
455 rc = LDAP_COMPARE_FALSE;
457 for(a = attrs_find( e->e_attrs, ava->aa_desc );
459 a = attrs_find( a->a_next, ava->aa_desc ) )
464 if (( ava->aa_desc != a->a_desc ) && !access_allowed( op,
465 e, a->a_desc, &ava->aa_value, ACL_SEARCH, NULL ))
467 rc = LDAP_INSUFFICIENT_ACCESS;
472 case LDAP_FILTER_APPROX:
473 mr = a->a_desc->ad_type->sat_approx;
474 if( mr != NULL ) break;
476 /* use EQUALITY matching rule if no APPROX rule */
478 case LDAP_FILTER_EQUALITY:
479 mr = a->a_desc->ad_type->sat_equality;
484 mr = a->a_desc->ad_type->sat_ordering;
492 rc = LDAP_INAPPROPRIATE_MATCHING;
496 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ ) {
500 ret = value_match( &match, a->a_desc, mr, 0,
501 bv, &ava->aa_value, &text );
503 if( ret != LDAP_SUCCESS ) {
509 case LDAP_FILTER_EQUALITY:
510 case LDAP_FILTER_APPROX:
511 if ( match == 0 ) return LDAP_COMPARE_TRUE;
515 if ( match >= 0 ) return LDAP_COMPARE_TRUE;
519 if ( match <= 0 ) return LDAP_COMPARE_TRUE;
530 test_presence_filter(
533 AttributeDescription *desc )
538 if ( !access_allowed( op, e, desc, NULL, ACL_SEARCH, NULL ) ) {
539 return LDAP_INSUFFICIENT_ACCESS;
542 if ( desc == slap_schema.si_ad_hasSubordinates ) {
544 * XXX: fairly optimistic: if the function is defined,
545 * then PRESENCE must succeed, because hasSubordinate
546 * is boolean-valued; I think we may live with this
547 * simplification by now
549 if ( op && op->o_bd && op->o_bd->be_has_subordinates ) {
550 return LDAP_COMPARE_TRUE;
553 return LDAP_COMPARE_FALSE;
556 if ( desc == slap_schema.si_ad_entryDN ||
557 desc == slap_schema.si_ad_subschemaSubentry )
559 /* entryDN and subschemaSubentry are always present */
560 return LDAP_COMPARE_TRUE;
563 rc = LDAP_COMPARE_FALSE;
565 for(a = attrs_find( e->e_attrs, desc );
567 a = attrs_find( a->a_next, desc ) )
569 if (( desc != a->a_desc ) && !access_allowed( op,
570 e, a->a_desc, NULL, ACL_SEARCH, NULL ))
572 rc = LDAP_INSUFFICIENT_ACCESS;
576 rc = LDAP_COMPARE_TRUE;
591 int rtn = LDAP_COMPARE_TRUE; /* True if empty */
593 Debug( LDAP_DEBUG_FILTER, "=> test_filter_and\n", 0, 0, 0 );
595 for ( f = flist; f != NULL; f = f->f_next ) {
596 int rc = test_filter( op, e, f );
598 if ( rc == LDAP_COMPARE_FALSE ) {
599 /* filter is False */
604 if ( rc != LDAP_COMPARE_TRUE ) {
605 /* filter is Undefined unless later elements are False */
610 Debug( LDAP_DEBUG_FILTER, "<= test_filter_and %d\n", rtn, 0, 0 );
622 int rtn = LDAP_COMPARE_FALSE; /* False if empty */
624 Debug( LDAP_DEBUG_FILTER, "=> test_filter_or\n", 0, 0, 0 );
626 for ( f = flist; f != NULL; f = f->f_next ) {
627 int rc = test_filter( op, e, f );
629 if ( rc == LDAP_COMPARE_TRUE ) {
635 if ( rc != LDAP_COMPARE_FALSE ) {
636 /* filter is Undefined unless later elements are True */
641 Debug( LDAP_DEBUG_FILTER, "<= test_filter_or %d\n", rtn, 0, 0 );
647 test_substrings_filter(
655 Debug( LDAP_DEBUG_FILTER, "begin test_substrings_filter\n", 0, 0, 0 );
657 if ( !access_allowed( op, e,
658 f->f_sub_desc, NULL, ACL_SEARCH, NULL ) )
660 return LDAP_INSUFFICIENT_ACCESS;
663 rc = LDAP_COMPARE_FALSE;
665 for(a = attrs_find( e->e_attrs, f->f_sub_desc );
667 a = attrs_find( a->a_next, f->f_sub_desc ) )
672 if (( f->f_sub_desc != a->a_desc ) && !access_allowed( op,
673 e, a->a_desc, NULL, ACL_SEARCH, NULL ))
675 rc = LDAP_INSUFFICIENT_ACCESS;
679 mr = a->a_desc->ad_type->sat_substr;
681 rc = LDAP_INAPPROPRIATE_MATCHING;
685 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ ) {
689 ret = value_match( &match, a->a_desc, mr, 0,
690 bv, f->f_sub, &text );
692 if( ret != LDAP_SUCCESS ) {
696 if ( match == 0 ) return LDAP_COMPARE_TRUE;
700 Debug( LDAP_DEBUG_FILTER, "end test_substrings_filter %d\n",