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, 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 )
206 void *memctx = op ? op->o_tmpmemctx : NULL;
208 if ( mra->ma_desc ) {
210 * if ma_desc is available, then we're filtering for
211 * one attribute, and SEARCH permissions can be checked
214 if( !access_allowed( op, e,
215 mra->ma_desc, &mra->ma_value, ACL_SEARCH, NULL ) )
217 return LDAP_INSUFFICIENT_ACCESS;
220 for(a = attrs_find( e->e_attrs, mra->ma_desc );
222 a = attrs_find( a->a_next, mra->ma_desc ) )
225 /* If ma_rule is not the same as the attribute's
226 * normal rule, then we can't use the a_nvals.
228 if (mra->ma_rule == a->a_desc->ad_type->sat_equality) {
234 for ( ; bv->bv_val != NULL; bv++ ) {
239 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
240 bv, &mra->ma_value, &text );
242 if( rc != LDAP_SUCCESS ) return rc;
243 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
249 * No attribute description: test all
251 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
252 struct berval *bv, value;
253 const char *text = NULL;
256 /* check if matching is appropriate */
257 if ( !mr_usable_with_at( mra->ma_rule, a->a_desc->ad_type )) {
261 /* normalize for equality */
262 rc = asserted_value_validate_normalize( a->a_desc, mra->ma_rule,
263 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
264 &mra->ma_value, &value, &text, memctx );
265 if ( rc != LDAP_SUCCESS ) continue;
267 /* check search access */
268 if ( !access_allowed( op, e,
269 a->a_desc, &value, ACL_SEARCH, NULL ) ) {
270 op->o_tmpfree( value.bv_val, memctx );
275 if (mra->ma_rule == a->a_desc->ad_type->sat_equality) {
281 for ( ; bv->bv_val != NULL; bv++ ) {
284 rc = value_match( &ret, a->a_desc, mra->ma_rule, 0,
287 if( rc != LDAP_SUCCESS ) break;
290 rc = LDAP_COMPARE_TRUE;
294 op->o_tmpfree( value.bv_val, memctx );
295 if ( rc != LDAP_SUCCESS ) return rc;
299 /* check attrs in DN AVAs if required */
300 if ( mra->ma_dnattrs ) {
305 /* parse and pretty the dn */
306 rc = dnPrettyDN( NULL, &e->e_name, &dn, memctx );
307 if ( rc != LDAP_SUCCESS ) {
308 return LDAP_INVALID_SYNTAX;
311 /* for each AVA of each RDN ... */
312 for ( iRDN = 0; dn[ iRDN ]; iRDN++ ) {
313 LDAPRDN rdn = dn[ iRDN ];
315 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
316 LDAPAVA *ava = rdn[ iAVA ];
317 struct berval *bv = &ava->la_value, value;
318 AttributeDescription *ad =
319 (AttributeDescription *)ava->la_private;
325 if ( mra->ma_desc ) {
326 /* have a mra type? check for subtype */
327 if ( !is_ad_subtype( ad, mra->ma_desc ) ) {
330 value = mra->ma_value;
333 const char *text = NULL;
335 /* check if matching is appropriate */
336 if ( !mr_usable_with_at( mra->ma_rule, ad->ad_type )) {
340 /* normalize for equality */
341 rc = asserted_value_validate_normalize( ad,
343 SLAP_MR_EXT|SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
344 &mra->ma_value, &value, &text, memctx );
345 if ( rc != LDAP_SUCCESS ) continue;
347 /* check search access */
348 if ( !access_allowed( op, e,
349 ad, &value, ACL_SEARCH, NULL ) )
351 op->o_tmpfree( value.bv_val, memctx );
357 rc = value_match( &ret, ad, mra->ma_rule, 0,
360 if ( value.bv_val != mra->ma_value.bv_val ) {
361 op->o_tmpfree( value.bv_val, memctx );
364 if ( rc == LDAP_SUCCESS && ret == 0 ) rc = LDAP_COMPARE_TRUE;
366 if( rc != LDAP_SUCCESS ) {
367 ldap_dnfree_x( dn, memctx );
372 ldap_dnfree_x( dn, memctx );
375 return LDAP_COMPARE_FALSE;
382 AttributeAssertion *ava,
387 if ( !access_allowed( op, e,
388 ava->aa_desc, &ava->aa_value, ACL_SEARCH, NULL ) )
390 return LDAP_INSUFFICIENT_ACCESS;
393 for(a = attrs_find( e->e_attrs, ava->aa_desc );
395 a = attrs_find( a->a_next, ava->aa_desc ) )
401 case LDAP_FILTER_APPROX:
402 mr = a->a_desc->ad_type->sat_approx;
403 if( mr != NULL ) break;
405 /* use EQUALITY matching rule if no APPROX rule */
407 case LDAP_FILTER_EQUALITY:
408 mr = a->a_desc->ad_type->sat_equality;
413 mr = a->a_desc->ad_type->sat_ordering;
424 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ ) {
429 rc = value_match( &ret, a->a_desc, mr, 0,
430 bv, &ava->aa_value, &text );
432 if( rc != LDAP_SUCCESS ) return rc;
435 case LDAP_FILTER_EQUALITY:
436 case LDAP_FILTER_APPROX:
437 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
441 if ( ret >= 0 ) return LDAP_COMPARE_TRUE;
445 if ( ret <= 0 ) return LDAP_COMPARE_TRUE;
451 if ( ava->aa_desc == slap_schema.si_ad_hasSubordinates
452 && op && op->o_bd && op->o_bd->be_has_subordinates )
458 * No other match should be allowed ...
460 assert( type == LDAP_FILTER_EQUALITY );
462 if ( op->o_bd->be_has_subordinates( op, e, &hasSubordinates ) !=
468 if ( hasSubordinates == LDAP_COMPARE_TRUE ) {
471 } else if ( hasSubordinates == LDAP_COMPARE_FALSE ) {
478 if ( bvmatch( &ava->aa_value, &hs ) ) return LDAP_COMPARE_TRUE;
479 return LDAP_COMPARE_FALSE;
482 return( LDAP_COMPARE_FALSE );
487 test_presence_filter(
490 AttributeDescription *desc )
494 if ( !access_allowed( op, e, desc, NULL, ACL_SEARCH, NULL ) ) {
495 return LDAP_INSUFFICIENT_ACCESS;
498 a = attrs_find( e->e_attrs, desc );
499 if ( a == NULL && desc == slap_schema.si_ad_hasSubordinates ) {
502 * XXX: fairly optimistic: if the function is defined,
503 * then PRESENCE must succeed, because hasSubordinate
504 * is boolean-valued; I think we may live with this
505 * simplification by now
507 if ( op && op->o_bd && op->o_bd->be_has_subordinates ) {
508 return LDAP_COMPARE_TRUE;
511 return LDAP_COMPARE_FALSE;
514 return a != NULL ? LDAP_COMPARE_TRUE : LDAP_COMPARE_FALSE;
525 int rtn = LDAP_COMPARE_TRUE; /* True if empty */
528 LDAP_LOG( FILTER, ENTRY, "test_filter_and: begin\n", 0, 0, 0 );
530 Debug( LDAP_DEBUG_FILTER, "=> test_filter_and\n", 0, 0, 0 );
534 for ( f = flist; f != NULL; f = f->f_next ) {
535 int rc = test_filter( op, e, f );
537 if ( rc == LDAP_COMPARE_FALSE ) {
538 /* filter is False */
543 if ( rc != LDAP_COMPARE_TRUE ) {
544 /* filter is Undefined unless later elements are False */
550 LDAP_LOG( FILTER, RESULTS, "test_filter_and: rc=%d\n", rtn, 0, 0 );
552 Debug( LDAP_DEBUG_FILTER, "<= test_filter_and %d\n", rtn, 0, 0 );
566 int rtn = LDAP_COMPARE_FALSE; /* False if empty */
569 LDAP_LOG( FILTER, ENTRY, "test_filter_or: begin\n", 0, 0, 0 );
571 Debug( LDAP_DEBUG_FILTER, "=> test_filter_or\n", 0, 0, 0 );
574 for ( f = flist; f != NULL; f = f->f_next ) {
575 int rc = test_filter( op, e, f );
577 if ( rc == LDAP_COMPARE_TRUE ) {
583 if ( rc != LDAP_COMPARE_FALSE ) {
584 /* filter is Undefined unless later elements are True */
590 LDAP_LOG( FILTER, ENTRY, "test_filter_or: result=%d\n", rtn, 0, 0 );
592 Debug( LDAP_DEBUG_FILTER, "<= test_filter_or %d\n", rtn, 0, 0 );
599 test_substrings_filter(
607 LDAP_LOG( FILTER, ENTRY, "test_substrings_filter: begin\n", 0, 0, 0 );
609 Debug( LDAP_DEBUG_FILTER, "begin test_substrings_filter\n", 0, 0, 0 );
612 if ( !access_allowed( op, e,
613 f->f_sub_desc, NULL, ACL_SEARCH, NULL ) )
615 return LDAP_INSUFFICIENT_ACCESS;
618 for(a = attrs_find( e->e_attrs, f->f_sub_desc );
620 a = attrs_find( a->a_next, f->f_sub_desc ) )
622 MatchingRule *mr = a->a_desc->ad_type->sat_substr;
625 if( mr == NULL ) continue;
627 for ( bv = a->a_nvals; bv->bv_val != NULL; bv++ ) {
632 rc = value_match( &ret, a->a_desc, mr, 0,
633 bv, f->f_sub, &text );
635 if( rc != LDAP_SUCCESS ) return rc;
636 if ( ret == 0 ) return LDAP_COMPARE_TRUE;
641 LDAP_LOG( FILTER, ENTRY, "test_substrings_filter: return FALSE\n",
644 Debug( LDAP_DEBUG_FILTER, "end test_substrings_filter 1\n",
647 return LDAP_COMPARE_FALSE;