1 /* search.c - ldap backend search function */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1999-2008 The OpenLDAP Foundation.
6 * Portions Copyright 1999-2003 Howard Chu.
7 * Portions Copyright 2000-2003 Pierangelo Masarati.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted only as authorized by the OpenLDAP
14 * A copy of this license is available in the file LICENSE in the
15 * top-level directory of the distribution or, alternatively, at
16 * <http://www.OpenLDAP.org/license.html>.
19 * This work was initially developed by the Howard Chu for inclusion
20 * in OpenLDAP Software and subsequently enhanced by Pierangelo
28 #include <ac/socket.h>
29 #include <ac/string.h>
33 #include "back-ldap.h"
34 #undef ldap_debug /* silence a warning in ldap-int.h */
35 #include "../../../libraries/libldap/ldap-int.h"
40 ldap_build_entry( Operation *op, LDAPMessage *e, Entry *ent,
44 * Quick'n'dirty rewrite of filter in case of error, to deal with
45 * <draft-zeilenga-ldap-t-f>.
48 ldap_back_munge_filter(
50 struct berval *filter )
52 ldapinfo_t *li = (ldapinfo_t *) op->o_bd->be_private;
57 Debug( LDAP_DEBUG_ARGS, "=> ldap_back_munge_filter \"%s\"\n",
58 filter->bv_val, 0, 0 );
60 for ( ptr = strstr( filter->bv_val, "(?=" );
62 ptr = strstr( ptr, "(?=" ) )
65 bv_true = BER_BVC( "(?=true)" ),
66 bv_false = BER_BVC( "(?=false)" ),
67 bv_undefined = BER_BVC( "(?=undefined)" ),
68 bv_t = BER_BVC( "(&)" ),
69 bv_f = BER_BVC( "(|)" ),
70 bv_T = BER_BVC( "(objectClass=*)" ),
71 bv_F = BER_BVC( "(!(objectClass=*))" );
72 struct berval *oldbv = NULL,
74 oldfilter = BER_BVNULL;
76 if ( strncmp( ptr, bv_true.bv_val, bv_true.bv_len ) == 0 ) {
78 if ( LDAP_BACK_T_F( li ) ) {
85 } else if ( strncmp( ptr, bv_false.bv_val, bv_false.bv_len ) == 0 )
88 if ( LDAP_BACK_T_F( li ) ) {
95 } else if ( strncmp( ptr, bv_undefined.bv_val, bv_undefined.bv_len ) == 0 )
97 /* if undef or invalid filter is not allowed,
98 * don't rewrite filter */
99 if ( LDAP_BACK_NOUNDEFFILTER( li ) ) {
100 if ( filter->bv_val != op->ors_filterstr.bv_val ) {
101 op->o_tmpfree( filter->bv_val, op->o_tmpmemctx );
103 BER_BVZERO( filter );
108 oldbv = &bv_undefined;
117 filter->bv_len += newbv->bv_len - oldbv->bv_len;
118 if ( filter->bv_val == op->ors_filterstr.bv_val ) {
119 filter->bv_val = op->o_tmpalloc( filter->bv_len + 1,
122 AC_MEMCPY( filter->bv_val, op->ors_filterstr.bv_val,
123 op->ors_filterstr.bv_len + 1 );
126 filter->bv_val = op->o_tmprealloc( filter->bv_val,
127 filter->bv_len + 1, op->o_tmpmemctx );
130 ptr = filter->bv_val + ( ptr - oldfilter.bv_val );
132 AC_MEMCPY( &ptr[ newbv->bv_len ],
133 &ptr[ oldbv->bv_len ],
134 oldfilter.bv_len - ( ptr - filter->bv_val ) - oldbv->bv_len + 1 );
135 AC_MEMCPY( ptr, newbv->bv_val, newbv->bv_len );
137 ptr += newbv->bv_len;
142 Debug( LDAP_DEBUG_ARGS, "<= ldap_back_munge_filter \"%s\" (%d)\n",
143 filter->bv_val, gotit, 0 );
153 ldapinfo_t *li = (ldapinfo_t *) op->o_bd->be_private;
155 ldapconn_t *lc = NULL;
157 time_t stoptime = (time_t)(-1);
162 struct berval match = BER_BVNULL,
167 int do_retry = 1, dont_retry = 0;
168 LDAPControl **ctrls = NULL;
169 char **references = NULL;
171 /* FIXME: shouldn't this be null? */
172 const char *save_matched = rs->sr_matched;
174 if ( !ldap_back_dobind( &lc, op, rs, LDAP_BACK_SENDERR ) ) {
179 * FIXME: in case of values return filter, we might want
180 * to map attrs and maybe rewrite value
183 /* should we check return values? */
184 if ( op->ors_deref != -1 ) {
185 ldap_set_option( lc->lc_ld, LDAP_OPT_DEREF,
186 (void *)&op->ors_deref );
189 if ( op->ors_tlimit != SLAP_NO_LIMIT ) {
190 tv.tv_sec = op->ors_tlimit;
192 stoptime = op->o_time + op->ors_tlimit;
195 LDAP_BACK_TV_SET( &tv );
198 if ( op->ors_attrs ) {
199 for ( i = 0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++ )
200 /* just count attrs */ ;
202 attrs = ch_malloc( ( i + 1 )*sizeof( char * ) );
203 if ( attrs == NULL ) {
204 rs->sr_err = LDAP_NO_MEMORY;
209 for ( i = 0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++ ) {
210 attrs[ i ] = op->ors_attrs[i].an_name.bv_val;
216 rc = ldap_back_controls_add( op, rs, lc, &ctrls );
217 if ( rc != LDAP_SUCCESS ) {
221 /* deal with <draft-zeilenga-ldap-t-f> filters */
222 filter = op->ors_filterstr;
224 rs->sr_err = ldap_search_ext( lc->lc_ld, op->o_req_dn.bv_val,
225 op->ors_scope, filter.bv_val,
226 attrs, op->ors_attrsonly, ctrls, NULL,
227 tv.tv_sec ? &tv : NULL,
228 op->ors_slimit, &msgid );
230 if ( rs->sr_err != LDAP_SUCCESS ) {
231 switch ( rs->sr_err ) {
232 case LDAP_SERVER_DOWN:
235 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
241 /* reset by ldap_back_retry ... */
242 rs->sr_err = slap_map_api2result( rs );
245 rc = ldap_back_op_result( lc, op, rs, msgid, 0, LDAP_BACK_DONTSEND );
250 case LDAP_FILTER_ERROR:
251 if (ldap_back_munge_filter( op, &filter ) > 0 ) {
255 /* invalid filters return success with no data */
256 rs->sr_err = LDAP_SUCCESS;
261 rs->sr_err = slap_map_api2result( rs );
267 /* if needed, initialize timeout */
268 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
269 if ( tv.tv_sec == 0 || tv.tv_sec > li->li_timeout[ SLAP_OP_SEARCH ] ) {
270 tv.tv_sec = li->li_timeout[ SLAP_OP_SEARCH ];
275 /* We pull apart the ber result, stuff it into a slapd entry, and
276 * let send_search_entry stuff it back into ber format. Slow & ugly,
277 * but this is necessary for version matching, and for ACL processing.
280 for ( rc = -2; rc != -1; rc = ldap_result( lc->lc_ld, msgid, LDAP_MSG_ONE, &tv, &res ) )
282 /* check for abandon */
283 if ( op->o_abandon || LDAP_BACK_CONN_ABANDON( lc ) ) {
287 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
292 if ( rc == 0 || rc == -2 ) {
293 ldap_pvt_thread_yield();
296 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
298 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
299 rs->sr_text = "Operation timed out";
300 rc = rs->sr_err = op->o_protocol >= LDAP_VERSION3 ?
301 LDAP_ADMINLIMIT_EXCEEDED : LDAP_OTHER;
306 LDAP_BACK_TV_SET( &tv );
309 /* check time limit */
310 if ( op->ors_tlimit != SLAP_NO_LIMIT
311 && slap_get_time() > stoptime )
313 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
314 rc = rs->sr_err = LDAP_TIMELIMIT_EXCEEDED;
320 /* only touch when activity actually took place... */
321 if ( li->li_idle_timeout && lc ) {
322 lc->lc_time = op->o_time;
325 /* don't retry any more */
330 if ( rc == LDAP_RES_SEARCH_ENTRY ) {
332 struct berval bdn = BER_BVNULL;
336 e = ldap_first_entry( lc->lc_ld, res );
337 rc = ldap_build_entry( op, e, &ent, &bdn );
338 if ( rc == LDAP_SUCCESS ) {
339 ldap_get_entry_controls( lc->lc_ld, res, &rs->sr_ctrls );
341 rs->sr_attrs = op->ors_attrs;
342 rs->sr_operational_attrs = NULL;
344 rs->sr_err = LDAP_SUCCESS;
345 rc = rs->sr_err = send_search_entry( op, rs );
346 if ( rs->sr_ctrls ) {
347 ldap_controls_free( rs->sr_ctrls );
351 if ( !BER_BVISNULL( &ent.e_name ) ) {
352 assert( ent.e_name.bv_val != bdn.bv_val );
353 op->o_tmpfree( ent.e_name.bv_val, op->o_tmpmemctx );
354 BER_BVZERO( &ent.e_name );
356 if ( !BER_BVISNULL( &ent.e_nname ) ) {
357 op->o_tmpfree( ent.e_nname.bv_val, op->o_tmpmemctx );
358 BER_BVZERO( &ent.e_nname );
363 if ( rc != LDAP_SUCCESS ) {
364 if ( rc == LDAP_UNAVAILABLE ) {
365 rc = rs->sr_err = LDAP_OTHER;
367 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
372 } else if ( rc == LDAP_RES_SEARCH_REFERENCE ) {
373 if ( LDAP_BACK_NOREFS( li ) ) {
379 rc = ldap_parse_reference( lc->lc_ld, res,
380 &references, &rs->sr_ctrls, 1 );
382 if ( rc != LDAP_SUCCESS ) {
386 /* FIXME: there MUST be at least one */
387 if ( references && references[ 0 ] && references[ 0 ][ 0 ] ) {
390 for ( cnt = 0; references[ cnt ]; cnt++ )
393 /* FIXME: there MUST be at least one */
394 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
397 for ( cnt = 0; references[ cnt ]; cnt++ ) {
398 ber_str2bv( references[ cnt ], 0, 0, &rs->sr_ref[ cnt ] );
400 BER_BVZERO( &rs->sr_ref[ cnt ] );
402 /* ignore return value by now */
404 ( void )send_search_reference( op, rs );
407 Debug( LDAP_DEBUG_ANY,
408 "%s ldap_back_search: "
409 "got SEARCH_REFERENCE "
410 "with no referrals\n",
411 op->o_log_prefix, 0, 0 );
416 ber_memvfree( (void **)references );
417 op->o_tmpfree( rs->sr_ref, op->o_tmpmemctx );
422 if ( rs->sr_ctrls ) {
423 ldap_controls_free( rs->sr_ctrls );
430 rc = ldap_parse_result( lc->lc_ld, res, &rs->sr_err,
432 &references, &rs->sr_ctrls, 1 );
433 if ( rc != LDAP_SUCCESS ) {
436 rs->sr_err = slap_map_api2result( rs );
442 /* RFC 4511: referrals can only appear
443 * if result code is LDAP_REFERRAL */
446 && references[ 0 ][ 0 ] )
448 if ( rs->sr_err != LDAP_REFERRAL ) {
449 Debug( LDAP_DEBUG_ANY,
450 "%s ldap_back_search: "
451 "got referrals with err=%d\n",
458 for ( cnt = 0; references[ cnt ]; cnt++ )
461 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
464 for ( cnt = 0; references[ cnt ]; cnt++ ) {
466 ber_str2bv( references[ cnt ], 0, 0, &rs->sr_ref[ cnt ] );
468 BER_BVZERO( &rs->sr_ref[ cnt ] );
471 } else if ( rs->sr_err == LDAP_REFERRAL ) {
472 Debug( LDAP_DEBUG_ANY,
473 "%s ldap_back_search: "
474 "got err=%d with null "
475 "or empty referrals\n",
479 rs->sr_err = LDAP_NO_SUCH_OBJECT;
482 if ( match.bv_val != NULL ) {
483 match.bv_len = strlen( match.bv_val );
490 /* if needed, restore timeout */
491 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
492 if ( tv.tv_sec == 0 || tv.tv_sec > li->li_timeout[ SLAP_OP_SEARCH ] ) {
493 tv.tv_sec = li->li_timeout[ SLAP_OP_SEARCH ];
499 if ( rc == -1 && dont_retry == 0 ) {
502 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
506 rs->sr_err = LDAP_SERVER_DOWN;
507 rs->sr_err = slap_map_api2result( rs );
512 * Rewrite the matched portion of the search base, if required
514 if ( !BER_BVISNULL( &match ) && !BER_BVISEMPTY( &match ) ) {
515 struct berval pmatch;
517 if ( dnPretty( NULL, &match, &pmatch, op->o_tmpmemctx ) == LDAP_SUCCESS ) {
518 rs->sr_matched = pmatch.bv_val;
519 LDAP_FREE( match.bv_val );
522 rs->sr_matched = match.bv_val;
526 if ( rs->sr_v2ref ) {
527 rs->sr_err = LDAP_REFERRAL;
531 if ( LDAP_BACK_QUARANTINE( li ) ) {
532 ldap_back_quarantine( op, rs );
535 if ( filter.bv_val != op->ors_filterstr.bv_val ) {
536 op->o_tmpfree( filter.bv_val, op->o_tmpmemctx );
540 /* let send_ldap_result play cleanup handlers (ITS#4645) */
541 if ( rc != SLAPD_ABANDON )
544 send_ldap_result( op, rs );
547 (void)ldap_back_controls_free( op, rs, &ctrls );
549 if ( rs->sr_ctrls ) {
550 ldap_controls_free( rs->sr_ctrls );
554 if ( rs->sr_matched != NULL && rs->sr_matched != save_matched ) {
555 if ( rs->sr_matched != match.bv_val ) {
556 ber_memfree_x( (char *)rs->sr_matched, op->o_tmpmemctx );
559 LDAP_FREE( match.bv_val );
561 rs->sr_matched = save_matched;
566 LDAP_FREE( (char *)rs->sr_text );
572 op->o_tmpfree( rs->sr_ref, op->o_tmpmemctx );
577 ber_memvfree( (void **)references );
585 ldap_back_release_conn( li, lc );
599 BerElement ber = *e->lm_ber;
600 Attribute *attr, **attrp;
606 /* safe assumptions ... */
607 assert( ent != NULL );
608 BER_BVZERO( &ent->e_bv );
610 if ( ber_scanf( &ber, "{m", bdn ) == LBER_ERROR ) {
611 return LDAP_DECODING_ERROR;
615 * Note: this may fail if the target host(s) schema differs
616 * from the one known to the meta, and a DN with unknown
617 * attributes is returned.
619 * FIXME: should we log anything, or delegate to dnNormalize?
621 /* Note: if the distinguished values or the naming attributes
622 * change, should we massage them as well?
624 if ( dnPrettyNormal( NULL, bdn, &ent->e_name, &ent->e_nname,
625 op->o_tmpmemctx ) != LDAP_SUCCESS )
627 return LDAP_INVALID_DN_SYNTAX;
631 if ( ber_first_element( &ber, &len, &lastb ) != LBER_SEQUENCE ) {
635 attrp = &ent->e_attrs;
636 while ( ber_next_element( &ber, &len, lastb ) == LBER_SEQUENCE &&
637 ber_scanf( &ber, "{m", &a ) != LBER_ERROR ) {
639 slap_syntax_validate_func *validate;
640 slap_syntax_transform_func *pretty;
642 attr = attr_alloc( NULL );
643 if ( attr == NULL ) {
646 if ( slap_bv2ad( &a, &attr->a_desc, &text )
649 if ( slap_bv2undef_ad( &a, &attr->a_desc, &text,
650 SLAP_AD_PROXIED ) != LDAP_SUCCESS )
652 Debug( LDAP_DEBUG_ANY,
653 "%s ldap_build_entry: "
654 "slap_bv2undef_ad(%s): %s\n",
655 op->o_log_prefix, a.bv_val, text );
661 /* no subschemaSubentry */
662 if ( attr->a_desc == slap_schema.si_ad_subschemaSubentry
663 || attr->a_desc == slap_schema.si_ad_entryDN )
667 * We eat target's subschemaSubentry because
668 * a search for this value is likely not
669 * to resolve to the appropriate backend;
670 * later, the local subschemaSubentry is
673 * We also eat entryDN because the frontend
674 * will reattach it without checking if already
677 ( void )ber_scanf( &ber, "x" /* [W] */ );
683 if ( ber_scanf( &ber, "[W]", &attr->a_vals ) == LBER_ERROR
684 || attr->a_vals == NULL )
687 * Note: attr->a_vals can be null when using
688 * values result filter
690 attr->a_vals = (struct berval *)&slap_dummy_bv;
693 validate = attr->a_desc->ad_type->sat_syntax->ssyn_validate;
694 pretty = attr->a_desc->ad_type->sat_syntax->ssyn_pretty;
696 if ( !validate && !pretty ) {
697 attr->a_nvals = NULL;
702 for ( i = 0; !BER_BVISNULL( &attr->a_vals[i] ); i++ ) {
707 rc = pretty( attr->a_desc->ad_type->sat_syntax,
708 &attr->a_vals[i], &pval, NULL );
711 rc = validate( attr->a_desc->ad_type->sat_syntax,
715 if ( rc != LDAP_SUCCESS ) {
718 /* check if, by chance, it's an undefined objectClass */
719 if ( attr->a_desc == slap_schema.si_ad_objectClass &&
720 ( oc = oc_bvfind_undef( &attr->a_vals[i] ) ) != NULL )
722 ber_dupbv( &pval, &oc->soc_cname );
725 attr->a_nvals = NULL;
732 LBER_FREE( attr->a_vals[i].bv_val );
733 attr->a_vals[i] = pval;
736 attr->a_numvals = last = i;
738 if ( last && attr->a_desc->ad_type->sat_equality &&
739 attr->a_desc->ad_type->sat_equality->smr_normalize )
741 attr->a_nvals = ch_malloc( ( last + 1 )*sizeof( struct berval ) );
742 for ( i = 0; i < last; i++ ) {
746 * check that each value is valid per syntax
747 * and pretty if appropriate
749 rc = attr->a_desc->ad_type->sat_equality->smr_normalize(
750 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
751 attr->a_desc->ad_type->sat_syntax,
752 attr->a_desc->ad_type->sat_equality,
753 &attr->a_vals[i], &attr->a_nvals[i],
756 if ( rc != LDAP_SUCCESS ) {
757 BER_BVZERO( &attr->a_nvals[i] );
762 BER_BVZERO( &attr->a_nvals[i] );
765 attr->a_nvals = attr->a_vals;
768 attrp = &attr->a_next;
776 /* return 0 IFF we can retrieve the entry with ndn
783 AttributeDescription *at,
787 ldapinfo_t *li = (ldapinfo_t *) op->o_bd->be_private;
789 ldapconn_t *lc = NULL;
794 LDAPMessage *result = NULL,
796 char *attr[3], **attrp = NULL;
800 LDAPControl **ctrls = NULL;
804 /* Tell getconn this is a privileged op */
805 do_not_cache = op->o_do_not_cache;
808 op->o_do_not_cache = 1;
809 /* ldap_back_entry_get() is an entry lookup, so it does not need
810 * to know what the entry is being looked up for */
811 op->o_tag = LDAP_REQ_SEARCH;
812 rc = ldap_back_dobind( &lc, op, &rs, LDAP_BACK_DONTSEND );
813 op->o_do_not_cache = do_not_cache;
821 if ( oc && at != slap_schema.si_ad_objectClass ) {
822 attr[0] = slap_schema.si_ad_objectClass->ad_cname.bv_val;
823 attr[1] = at->ad_cname.bv_val;
827 attr[0] = at->ad_cname.bv_val;
835 filter = op->o_tmpalloc( STRLENOF( "(objectClass=" ")" )
836 + oc->soc_cname.bv_len + 1, op->o_tmpmemctx );
837 ptr = lutil_strcopy( filter, "(objectClass=" );
838 ptr = lutil_strcopy( ptr, oc->soc_cname.bv_val );
845 rc = ldap_back_controls_add( op, &rs, lc, &ctrls );
846 if ( rc != LDAP_SUCCESS ) {
851 rc = ldap_search_ext_s( lc->lc_ld, ndn->bv_val, LDAP_SCOPE_BASE, filter,
852 attrp, 0, ctrls, NULL,
853 NULL, LDAP_NO_LIMIT, &result );
854 if ( rc != LDAP_SUCCESS ) {
855 if ( rc == LDAP_SERVER_DOWN && do_retry ) {
857 if ( ldap_back_retry( &lc, op, &rs, LDAP_BACK_DONTSEND ) ) {
858 /* if the identity changed, there might be need to re-authz */
859 (void)ldap_back_controls_free( op, &rs, &ctrls );
866 e = ldap_first_entry( lc->lc_ld, result );
868 /* the entry exists, but it doesn't match the filter? */
872 *ent = entry_alloc();
873 if ( *ent == NULL ) {
878 rc = ldap_build_entry( op, e, *ent, &bdn );
880 if ( rc != LDAP_SUCCESS ) {
886 (void)ldap_back_controls_free( op, &rs, &ctrls );
889 ldap_msgfree( result );
893 op->o_tmpfree( filter, op->o_tmpmemctx );
897 ldap_back_release_conn( li, lc );