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, 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 );
46 * test_filter - test a filter against a single entry.
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
62 LDAP_LOG( FILTER, ENTRY, "test_filter: begin\n", 0, 0, 0 );
64 Debug( LDAP_DEBUG_FILTER, "=> test_filter\n", 0, 0, 0 );
67 switch ( f->f_choice ) {
68 case SLAPD_FILTER_COMPUTED:
70 LDAP_LOG( FILTER, DETAIL1,
71 "test_filter: COMPUTED %s (%d)\n",
72 f->f_result == LDAP_COMPARE_FALSE ? "false" :
73 f->f_result == LDAP_COMPARE_TRUE ? "true" :
74 f->f_result == SLAPD_COMPARE_UNDEFINED ? "undefined" :
75 "error", f->f_result, 0 );
77 Debug( LDAP_DEBUG_FILTER, " COMPUTED %s (%d)\n",
78 f->f_result == LDAP_COMPARE_FALSE ? "false" :
79 f->f_result == LDAP_COMPARE_TRUE ? "true" :
80 f->f_result == SLAPD_COMPARE_UNDEFINED ? "undefined" : "error",
87 case LDAP_FILTER_EQUALITY:
89 LDAP_LOG( FILTER, DETAIL1, "test_filter: EQUALITY\n", 0, 0, 0 );
91 Debug( LDAP_DEBUG_FILTER, " EQUALITY\n", 0, 0, 0 );
94 rc = test_ava_filter( op, e, f->f_ava, LDAP_FILTER_EQUALITY );
97 case LDAP_FILTER_SUBSTRINGS:
99 LDAP_LOG( FILTER, DETAIL1, "test_filter SUBSTRINGS\n", 0, 0, 0 );
101 Debug( LDAP_DEBUG_FILTER, " SUBSTRINGS\n", 0, 0, 0 );
104 rc = test_substrings_filter( op, e, f );
108 rc = test_ava_filter( op, e, f->f_ava, LDAP_FILTER_GE );
112 rc = test_ava_filter( op, e, f->f_ava, LDAP_FILTER_LE );
115 case LDAP_FILTER_PRESENT:
117 LDAP_LOG( FILTER, DETAIL1, "test_filter: PRESENT\n", 0, 0, 0 );
119 Debug( LDAP_DEBUG_FILTER, " PRESENT\n", 0, 0, 0 );
121 rc = test_presence_filter( op, e, f->f_desc );
124 case LDAP_FILTER_APPROX:
126 LDAP_LOG( FILTER, DETAIL1, "test_filter: APPROX\n", 0, 0, 0 );
128 Debug( LDAP_DEBUG_FILTER, " APPROX\n", 0, 0, 0 );
130 rc = test_ava_filter( op, e, f->f_ava, LDAP_FILTER_APPROX );
133 case LDAP_FILTER_AND:
135 LDAP_LOG( FILTER, DETAIL1, "test_filter: AND\n", 0, 0, 0 );
137 Debug( LDAP_DEBUG_FILTER, " AND\n", 0, 0, 0 );
139 rc = test_filter_and( op, e, f->f_and );
144 LDAP_LOG( FILTER, DETAIL1, "test_filter: OR\n", 0, 0, 0 );
146 Debug( LDAP_DEBUG_FILTER, " OR\n", 0, 0, 0 );
148 rc = test_filter_or( op, e, f->f_or );
151 case LDAP_FILTER_NOT:
153 LDAP_LOG( FILTER, DETAIL1, "test_filter: NOT\n", 0, 0, 0 );
155 Debug( LDAP_DEBUG_FILTER, " NOT\n", 0, 0, 0 );
157 rc = test_filter( op, e, f->f_not );
159 /* Flip true to false and false to true
160 * but leave Undefined alone.
163 case LDAP_COMPARE_TRUE:
164 rc = LDAP_COMPARE_FALSE;
166 case LDAP_COMPARE_FALSE:
167 rc = LDAP_COMPARE_TRUE;
172 case LDAP_FILTER_EXT:
174 LDAP_LOG( FILTER, DETAIL1, "test_filter: EXT\n", 0, 0, 0 );
176 Debug( LDAP_DEBUG_FILTER, " EXT\n", 0, 0, 0 );
178 rc = test_mra_filter( op, e, f->f_mra );
183 LDAP_LOG( FILTER, INFO,
184 "test_filter: unknown filter type %lu\n", f->f_choice, 0, 0 );
186 Debug( LDAP_DEBUG_ANY, " unknown filter type %lu\n",
189 rc = LDAP_PROTOCOL_ERROR;
193 LDAP_LOG( FILTER, RESULTS, "test_filter: return=%d\n", rc, 0, 0 );
195 Debug( LDAP_DEBUG_FILTER, "<= test_filter %d\n", rc, 0, 0 );
200 static int test_mra_filter(
203 MatchingRuleAssertion *mra )
207 BER_MEMFREE_FN *memfree;
211 memfree = slap_sl_free;
213 memctx = op->o_tmpmemctx;
214 memfree = op->o_tmpfree;
217 if ( mra->ma_desc ) {
219 * if ma_desc is available, then we're filtering for
220 * one attribute, and SEARCH permissions can be checked
223 if( !access_allowed( op, e,
224 mra->ma_desc, &mra->ma_value, ACL_SEARCH, NULL ) )
226 return LDAP_INSUFFICIENT_ACCESS;
229 for(a = attrs_find( e->e_attrs, mra->ma_desc );
231 a = attrs_find( a->a_next, mra->ma_desc ) )
234 /* If ma_rule is not the same as the attribute's
235 * normal rule, then we can't use the a_nvals.
237 if (mra->ma_rule == a->a_desc->ad_type->sat_equality) {
243 for ( ; bv->bv_val != NULL; bv++ ) {
248 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
249 bv, &mra->ma_value, &text );
251 if( rc != LDAP_SUCCESS ) return rc;
252 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
258 * No attribute description: test all
260 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
261 struct berval *bv, value;
262 const char *text = NULL;
265 /* check if matching is appropriate */
266 if ( !mr_usable_with_at( mra->ma_rule, a->a_desc->ad_type )) {
270 /* normalize for equality */
271 rc = asserted_value_validate_normalize( a->a_desc, mra->ma_rule,
272 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
273 &mra->ma_value, &value, &text, memctx );
274 if ( rc != LDAP_SUCCESS ) continue;
276 /* check search access */
277 if ( !access_allowed( op, e,
278 a->a_desc, &value, ACL_SEARCH, NULL ) ) {
279 memfree( value.bv_val, memctx );
284 if (mra->ma_rule == a->a_desc->ad_type->sat_equality) {
290 for ( ; bv->bv_val != NULL; bv++ ) {
293 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
296 if( rc != LDAP_SUCCESS ) break;
299 rc = LDAP_COMPARE_TRUE;
303 memfree( value.bv_val, memctx );
304 if ( rc != LDAP_SUCCESS ) return rc;
308 /* check attrs in DN AVAs if required */
309 if ( mra->ma_dnattrs && !BER_BVISEMPTY( &e->e_nname ) ) {
314 /* parse and pretty the dn */
315 rc = dnPrettyDN( NULL, &e->e_name, &dn, memctx );
316 if ( rc != LDAP_SUCCESS ) {
317 return LDAP_INVALID_SYNTAX;
320 /* for each AVA of each RDN ... */
321 for ( iRDN = 0; dn[ iRDN ]; iRDN++ ) {
322 LDAPRDN rdn = dn[ iRDN ];
324 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
325 LDAPAVA *ava = rdn[ iAVA ];
326 struct berval *bv = &ava->la_value, value;
327 AttributeDescription *ad =
328 (AttributeDescription *)ava->la_private;
334 if ( mra->ma_desc ) {
335 /* have a mra type? check for subtype */
336 if ( !is_ad_subtype( ad, mra->ma_desc ) ) {
339 value = mra->ma_value;
342 const char *text = NULL;
344 /* check if matching is appropriate */
345 if ( !mr_usable_with_at( mra->ma_rule, ad->ad_type )) {
349 /* normalize for equality */
350 rc = asserted_value_validate_normalize( ad,
352 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
353 &mra->ma_value, &value, &text, memctx );
354 if ( rc != LDAP_SUCCESS ) continue;
356 /* check search access */
357 if ( !access_allowed( op, e,
358 ad, &value, ACL_SEARCH, NULL ) )
360 memfree( value.bv_val, memctx );
366 rc = value_match( &ret, ad, mra->ma_rule, 0,
369 if ( value.bv_val != mra->ma_value.bv_val ) {
370 memfree( value.bv_val, memctx );
373 if ( rc == LDAP_SUCCESS && ret == 0 ) rc = LDAP_COMPARE_TRUE;
375 if( rc != LDAP_SUCCESS ) {
376 ldap_dnfree_x( dn, memctx );
381 ldap_dnfree_x( dn, memctx );
384 return LDAP_COMPARE_FALSE;
391 AttributeAssertion *ava,
396 if ( !access_allowed( op, e,
397 ava->aa_desc, &ava->aa_value, ACL_SEARCH, NULL ) )
399 return LDAP_INSUFFICIENT_ACCESS;
402 for(a = attrs_find( e->e_attrs, ava->aa_desc );
404 a = attrs_find( a->a_next, ava->aa_desc ) )
410 case LDAP_FILTER_APPROX:
411 mr = a->a_desc->ad_type->sat_approx;
412 if( mr != NULL ) break;
414 /* use EQUALITY matching rule if no APPROX rule */
416 case LDAP_FILTER_EQUALITY:
417 mr = a->a_desc->ad_type->sat_equality;
422 mr = a->a_desc->ad_type->sat_ordering;
433 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ ) {
438 rc = value_match( &ret, a->a_desc, mr, 0,
439 bv, &ava->aa_value, &text );
441 if( rc != LDAP_SUCCESS ) return rc;
444 case LDAP_FILTER_EQUALITY:
445 case LDAP_FILTER_APPROX:
446 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
450 if ( ret >= 0 ) return LDAP_COMPARE_TRUE;
454 if ( ret <= 0 ) return LDAP_COMPARE_TRUE;
460 if ( ava->aa_desc == slap_schema.si_ad_hasSubordinates
461 && op && op->o_bd && op->o_bd->be_has_subordinates )
466 /* No other match is supported */
467 if( type != LDAP_FILTER_EQUALITY ) return LDAP_OTHER;
469 if ( op->o_bd->be_has_subordinates( op, e, &hasSubordinates ) !=
475 if ( hasSubordinates == LDAP_COMPARE_TRUE ) {
478 } else if ( hasSubordinates == LDAP_COMPARE_FALSE ) {
485 if ( bvmatch( &ava->aa_value, &hs ) ) return LDAP_COMPARE_TRUE;
486 return LDAP_COMPARE_FALSE;
489 return( LDAP_COMPARE_FALSE );
494 test_presence_filter(
497 AttributeDescription *desc )
501 if ( !access_allowed( op, e, desc, NULL, ACL_SEARCH, NULL ) ) {
502 return LDAP_INSUFFICIENT_ACCESS;
505 a = attrs_find( e->e_attrs, desc );
506 if ( a == NULL && desc == slap_schema.si_ad_hasSubordinates ) {
509 * XXX: fairly optimistic: if the function is defined,
510 * then PRESENCE must succeed, because hasSubordinate
511 * is boolean-valued; I think we may live with this
512 * simplification by now
514 if ( op && op->o_bd && op->o_bd->be_has_subordinates ) {
515 return LDAP_COMPARE_TRUE;
518 return LDAP_COMPARE_FALSE;
521 return a != NULL ? LDAP_COMPARE_TRUE : LDAP_COMPARE_FALSE;
532 int rtn = LDAP_COMPARE_TRUE; /* True if empty */
535 LDAP_LOG( FILTER, ENTRY, "test_filter_and: begin\n", 0, 0, 0 );
537 Debug( LDAP_DEBUG_FILTER, "=> test_filter_and\n", 0, 0, 0 );
541 for ( f = flist; f != NULL; f = f->f_next ) {
542 int rc = test_filter( op, e, f );
544 if ( rc == LDAP_COMPARE_FALSE ) {
545 /* filter is False */
550 if ( rc != LDAP_COMPARE_TRUE ) {
551 /* filter is Undefined unless later elements are False */
557 LDAP_LOG( FILTER, RESULTS, "test_filter_and: rc=%d\n", rtn, 0, 0 );
559 Debug( LDAP_DEBUG_FILTER, "<= test_filter_and %d\n", rtn, 0, 0 );
573 int rtn = LDAP_COMPARE_FALSE; /* False if empty */
576 LDAP_LOG( FILTER, ENTRY, "test_filter_or: begin\n", 0, 0, 0 );
578 Debug( LDAP_DEBUG_FILTER, "=> test_filter_or\n", 0, 0, 0 );
581 for ( f = flist; f != NULL; f = f->f_next ) {
582 int rc = test_filter( op, e, f );
584 if ( rc == LDAP_COMPARE_TRUE ) {
590 if ( rc != LDAP_COMPARE_FALSE ) {
591 /* filter is Undefined unless later elements are True */
597 LDAP_LOG( FILTER, ENTRY, "test_filter_or: result=%d\n", rtn, 0, 0 );
599 Debug( LDAP_DEBUG_FILTER, "<= test_filter_or %d\n", rtn, 0, 0 );
606 test_substrings_filter(
614 LDAP_LOG( FILTER, ENTRY, "test_substrings_filter: begin\n", 0, 0, 0 );
616 Debug( LDAP_DEBUG_FILTER, "begin test_substrings_filter\n", 0, 0, 0 );
619 if ( !access_allowed( op, e,
620 f->f_sub_desc, NULL, ACL_SEARCH, NULL ) )
622 return LDAP_INSUFFICIENT_ACCESS;
625 for(a = attrs_find( e->e_attrs, f->f_sub_desc );
627 a = attrs_find( a->a_next, f->f_sub_desc ) )
629 MatchingRule *mr = a->a_desc->ad_type->sat_substr;
632 if( mr == NULL ) continue;
634 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ ) {
639 rc = value_match( &ret, a->a_desc, mr, 0,
640 bv, f->f_sub, &text );
642 if( rc != LDAP_SUCCESS ) return rc;
643 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
648 LDAP_LOG( FILTER, ENTRY, "test_substrings_filter: return FALSE\n",
651 Debug( LDAP_DEBUG_FILTER, "end test_substrings_filter 1\n",
654 return LDAP_COMPARE_FALSE;