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 );
365 case LDAP_INSUFFICIENT_ACCESS:
369 if ( rc == LDAP_UNAVAILABLE ) {
370 rc = rs->sr_err = LDAP_OTHER;
372 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
377 } else if ( rc == LDAP_RES_SEARCH_REFERENCE ) {
378 if ( LDAP_BACK_NOREFS( li ) ) {
384 rc = ldap_parse_reference( lc->lc_ld, res,
385 &references, &rs->sr_ctrls, 1 );
387 if ( rc != LDAP_SUCCESS ) {
391 /* FIXME: there MUST be at least one */
392 if ( references && references[ 0 ] && references[ 0 ][ 0 ] ) {
395 for ( cnt = 0; references[ cnt ]; cnt++ )
398 /* FIXME: there MUST be at least one */
399 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
402 for ( cnt = 0; references[ cnt ]; cnt++ ) {
403 ber_str2bv( references[ cnt ], 0, 0, &rs->sr_ref[ cnt ] );
405 BER_BVZERO( &rs->sr_ref[ cnt ] );
407 /* ignore return value by now */
409 ( void )send_search_reference( op, rs );
412 Debug( LDAP_DEBUG_ANY,
413 "%s ldap_back_search: "
414 "got SEARCH_REFERENCE "
415 "with no referrals\n",
416 op->o_log_prefix, 0, 0 );
421 ber_memvfree( (void **)references );
422 op->o_tmpfree( rs->sr_ref, op->o_tmpmemctx );
427 if ( rs->sr_ctrls ) {
428 ldap_controls_free( rs->sr_ctrls );
435 rc = ldap_parse_result( lc->lc_ld, res, &rs->sr_err,
437 &references, &rs->sr_ctrls, 1 );
438 if ( rc != LDAP_SUCCESS ) {
441 rs->sr_err = slap_map_api2result( rs );
447 /* RFC 4511: referrals can only appear
448 * if result code is LDAP_REFERRAL */
451 && references[ 0 ][ 0 ] )
453 if ( rs->sr_err != LDAP_REFERRAL ) {
454 Debug( LDAP_DEBUG_ANY,
455 "%s ldap_back_search: "
456 "got referrals with err=%d\n",
463 for ( cnt = 0; references[ cnt ]; cnt++ )
466 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
469 for ( cnt = 0; references[ cnt ]; cnt++ ) {
471 ber_str2bv( references[ cnt ], 0, 0, &rs->sr_ref[ cnt ] );
473 BER_BVZERO( &rs->sr_ref[ cnt ] );
476 } else if ( rs->sr_err == LDAP_REFERRAL ) {
477 Debug( LDAP_DEBUG_ANY,
478 "%s ldap_back_search: "
479 "got err=%d with null "
480 "or empty referrals\n",
484 rs->sr_err = LDAP_NO_SUCH_OBJECT;
487 if ( match.bv_val != NULL ) {
488 match.bv_len = strlen( match.bv_val );
495 /* if needed, restore timeout */
496 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
497 if ( tv.tv_sec == 0 || tv.tv_sec > li->li_timeout[ SLAP_OP_SEARCH ] ) {
498 tv.tv_sec = li->li_timeout[ SLAP_OP_SEARCH ];
504 if ( rc == -1 && dont_retry == 0 ) {
507 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
511 rs->sr_err = LDAP_SERVER_DOWN;
512 rs->sr_err = slap_map_api2result( rs );
517 * Rewrite the matched portion of the search base, if required
519 if ( !BER_BVISNULL( &match ) && !BER_BVISEMPTY( &match ) ) {
520 struct berval pmatch;
522 if ( dnPretty( NULL, &match, &pmatch, op->o_tmpmemctx ) == LDAP_SUCCESS ) {
523 rs->sr_matched = pmatch.bv_val;
524 LDAP_FREE( match.bv_val );
527 rs->sr_matched = match.bv_val;
531 if ( rs->sr_v2ref ) {
532 rs->sr_err = LDAP_REFERRAL;
536 if ( LDAP_BACK_QUARANTINE( li ) ) {
537 ldap_back_quarantine( op, rs );
540 if ( filter.bv_val != op->ors_filterstr.bv_val ) {
541 op->o_tmpfree( filter.bv_val, op->o_tmpmemctx );
545 /* let send_ldap_result play cleanup handlers (ITS#4645) */
546 if ( rc != SLAPD_ABANDON )
549 send_ldap_result( op, rs );
552 (void)ldap_back_controls_free( op, rs, &ctrls );
554 if ( rs->sr_ctrls ) {
555 ldap_controls_free( rs->sr_ctrls );
559 if ( rs->sr_matched != NULL && rs->sr_matched != save_matched ) {
560 if ( rs->sr_matched != match.bv_val ) {
561 ber_memfree_x( (char *)rs->sr_matched, op->o_tmpmemctx );
564 LDAP_FREE( match.bv_val );
566 rs->sr_matched = save_matched;
571 LDAP_FREE( (char *)rs->sr_text );
577 op->o_tmpfree( rs->sr_ref, op->o_tmpmemctx );
582 ber_memvfree( (void **)references );
590 ldap_back_release_conn( li, lc );
604 BerElement ber = *e->lm_ber;
605 Attribute *attr, **attrp;
611 /* safe assumptions ... */
612 assert( ent != NULL );
613 BER_BVZERO( &ent->e_bv );
615 if ( ber_scanf( &ber, "{m", bdn ) == LBER_ERROR ) {
616 return LDAP_DECODING_ERROR;
620 * Note: this may fail if the target host(s) schema differs
621 * from the one known to the meta, and a DN with unknown
622 * attributes is returned.
624 * FIXME: should we log anything, or delegate to dnNormalize?
626 /* Note: if the distinguished values or the naming attributes
627 * change, should we massage them as well?
629 if ( dnPrettyNormal( NULL, bdn, &ent->e_name, &ent->e_nname,
630 op->o_tmpmemctx ) != LDAP_SUCCESS )
632 return LDAP_INVALID_DN_SYNTAX;
636 if ( ber_first_element( &ber, &len, &lastb ) != LBER_SEQUENCE ) {
640 attrp = &ent->e_attrs;
641 while ( ber_next_element( &ber, &len, lastb ) == LBER_SEQUENCE &&
642 ber_scanf( &ber, "{m", &a ) != LBER_ERROR ) {
644 slap_syntax_validate_func *validate;
645 slap_syntax_transform_func *pretty;
647 attr = attr_alloc( NULL );
648 if ( attr == NULL ) {
651 if ( slap_bv2ad( &a, &attr->a_desc, &text )
654 if ( slap_bv2undef_ad( &a, &attr->a_desc, &text,
655 SLAP_AD_PROXIED ) != LDAP_SUCCESS )
657 Debug( LDAP_DEBUG_ANY,
658 "%s ldap_build_entry: "
659 "slap_bv2undef_ad(%s): %s\n",
660 op->o_log_prefix, a.bv_val, text );
666 /* no subschemaSubentry */
667 if ( attr->a_desc == slap_schema.si_ad_subschemaSubentry
668 || attr->a_desc == slap_schema.si_ad_entryDN )
672 * We eat target's subschemaSubentry because
673 * a search for this value is likely not
674 * to resolve to the appropriate backend;
675 * later, the local subschemaSubentry is
678 * We also eat entryDN because the frontend
679 * will reattach it without checking if already
682 ( void )ber_scanf( &ber, "x" /* [W] */ );
688 if ( ber_scanf( &ber, "[W]", &attr->a_vals ) == LBER_ERROR
689 || attr->a_vals == NULL )
692 * Note: attr->a_vals can be null when using
693 * values result filter
695 attr->a_vals = (struct berval *)&slap_dummy_bv;
698 validate = attr->a_desc->ad_type->sat_syntax->ssyn_validate;
699 pretty = attr->a_desc->ad_type->sat_syntax->ssyn_pretty;
701 if ( !validate && !pretty ) {
702 attr->a_nvals = NULL;
707 for ( i = 0; !BER_BVISNULL( &attr->a_vals[i] ); i++ ) {
712 rc = pretty( attr->a_desc->ad_type->sat_syntax,
713 &attr->a_vals[i], &pval, NULL );
716 rc = validate( attr->a_desc->ad_type->sat_syntax,
720 if ( rc != LDAP_SUCCESS ) {
723 /* check if, by chance, it's an undefined objectClass */
724 if ( attr->a_desc == slap_schema.si_ad_objectClass &&
725 ( oc = oc_bvfind_undef( &attr->a_vals[i] ) ) != NULL )
727 ber_dupbv( &pval, &oc->soc_cname );
730 attr->a_nvals = NULL;
737 LBER_FREE( attr->a_vals[i].bv_val );
738 attr->a_vals[i] = pval;
741 attr->a_numvals = last = i;
743 if ( last && attr->a_desc->ad_type->sat_equality &&
744 attr->a_desc->ad_type->sat_equality->smr_normalize )
746 attr->a_nvals = ch_malloc( ( last + 1 )*sizeof( struct berval ) );
747 for ( i = 0; i < last; i++ ) {
751 * check that each value is valid per syntax
752 * and pretty if appropriate
754 rc = attr->a_desc->ad_type->sat_equality->smr_normalize(
755 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
756 attr->a_desc->ad_type->sat_syntax,
757 attr->a_desc->ad_type->sat_equality,
758 &attr->a_vals[i], &attr->a_nvals[i],
761 if ( rc != LDAP_SUCCESS ) {
762 BER_BVZERO( &attr->a_nvals[i] );
767 BER_BVZERO( &attr->a_nvals[i] );
770 attr->a_nvals = attr->a_vals;
773 attrp = &attr->a_next;
781 /* return 0 IFF we can retrieve the entry with ndn
788 AttributeDescription *at,
792 ldapinfo_t *li = (ldapinfo_t *) op->o_bd->be_private;
794 ldapconn_t *lc = NULL;
799 LDAPMessage *result = NULL,
801 char *attr[3], **attrp = NULL;
805 LDAPControl **ctrls = NULL;
809 /* Tell getconn this is a privileged op */
810 do_not_cache = op->o_do_not_cache;
813 op->o_do_not_cache = 1;
814 /* ldap_back_entry_get() is an entry lookup, so it does not need
815 * to know what the entry is being looked up for */
816 op->o_tag = LDAP_REQ_SEARCH;
817 rc = ldap_back_dobind( &lc, op, &rs, LDAP_BACK_DONTSEND );
818 op->o_do_not_cache = do_not_cache;
826 if ( oc && at != slap_schema.si_ad_objectClass ) {
827 attr[0] = slap_schema.si_ad_objectClass->ad_cname.bv_val;
828 attr[1] = at->ad_cname.bv_val;
832 attr[0] = at->ad_cname.bv_val;
840 filter = op->o_tmpalloc( STRLENOF( "(objectClass=" ")" )
841 + oc->soc_cname.bv_len + 1, op->o_tmpmemctx );
842 ptr = lutil_strcopy( filter, "(objectClass=" );
843 ptr = lutil_strcopy( ptr, oc->soc_cname.bv_val );
850 rc = ldap_back_controls_add( op, &rs, lc, &ctrls );
851 if ( rc != LDAP_SUCCESS ) {
856 rc = ldap_search_ext_s( lc->lc_ld, ndn->bv_val, LDAP_SCOPE_BASE, filter,
857 attrp, 0, ctrls, NULL,
858 NULL, LDAP_NO_LIMIT, &result );
859 if ( rc != LDAP_SUCCESS ) {
860 if ( rc == LDAP_SERVER_DOWN && do_retry ) {
862 if ( ldap_back_retry( &lc, op, &rs, LDAP_BACK_DONTSEND ) ) {
863 /* if the identity changed, there might be need to re-authz */
864 (void)ldap_back_controls_free( op, &rs, &ctrls );
871 e = ldap_first_entry( lc->lc_ld, result );
873 /* the entry exists, but it doesn't match the filter? */
877 *ent = entry_alloc();
878 if ( *ent == NULL ) {
883 rc = ldap_build_entry( op, e, *ent, &bdn );
885 if ( rc != LDAP_SUCCESS ) {
891 (void)ldap_back_controls_free( op, &rs, &ctrls );
894 ldap_msgfree( result );
898 op->o_tmpfree( filter, op->o_tmpmemctx );
902 ldap_back_release_conn( li, lc );