1 /* search.c - ldap backend search function */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1999-2009 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 if ( op->ors_tlimit != SLAP_NO_LIMIT ) {
184 tv.tv_sec = op->ors_tlimit;
186 stoptime = op->o_time + op->ors_tlimit;
189 LDAP_BACK_TV_SET( &tv );
192 if ( op->ors_attrs ) {
193 for ( i = 0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++ )
194 /* just count attrs */ ;
196 attrs = ch_malloc( ( i + 1 )*sizeof( char * ) );
197 if ( attrs == NULL ) {
198 rs->sr_err = LDAP_NO_MEMORY;
203 for ( i = 0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++ ) {
204 attrs[ i ] = op->ors_attrs[i].an_name.bv_val;
210 rc = ldap_back_controls_add( op, rs, lc, &ctrls );
211 if ( rc != LDAP_SUCCESS ) {
215 /* deal with <draft-zeilenga-ldap-t-f> filters */
216 filter = op->ors_filterstr;
218 rs->sr_err = ldap_pvt_search( lc->lc_ld, op->o_req_dn.bv_val,
219 op->ors_scope, filter.bv_val,
220 attrs, op->ors_attrsonly, ctrls, NULL,
221 tv.tv_sec ? &tv : NULL,
222 op->ors_slimit, op->ors_deref, &msgid );
224 if ( rs->sr_err != LDAP_SUCCESS ) {
225 switch ( rs->sr_err ) {
226 case LDAP_SERVER_DOWN:
229 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
235 /* reset by ldap_back_retry ... */
236 rs->sr_err = slap_map_api2result( rs );
239 rc = ldap_back_op_result( lc, op, rs, msgid, 0, LDAP_BACK_DONTSEND );
244 case LDAP_FILTER_ERROR:
245 if (ldap_back_munge_filter( op, &filter ) > 0 ) {
249 /* invalid filters return success with no data */
250 rs->sr_err = LDAP_SUCCESS;
255 rs->sr_err = slap_map_api2result( rs );
261 /* if needed, initialize timeout */
262 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
263 if ( tv.tv_sec == 0 || tv.tv_sec > li->li_timeout[ SLAP_OP_SEARCH ] ) {
264 tv.tv_sec = li->li_timeout[ SLAP_OP_SEARCH ];
269 /* We pull apart the ber result, stuff it into a slapd entry, and
270 * let send_search_entry stuff it back into ber format. Slow & ugly,
271 * but this is necessary for version matching, and for ACL processing.
274 for ( rc = -2; rc != -1; rc = ldap_result( lc->lc_ld, msgid, LDAP_MSG_ONE, &tv, &res ) )
276 /* check for abandon */
277 if ( op->o_abandon || LDAP_BACK_CONN_ABANDON( lc ) ) {
281 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
286 if ( rc == 0 || rc == -2 ) {
287 ldap_pvt_thread_yield();
290 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
292 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
293 rs->sr_text = "Operation timed out";
294 rc = rs->sr_err = op->o_protocol >= LDAP_VERSION3 ?
295 LDAP_ADMINLIMIT_EXCEEDED : LDAP_OTHER;
300 LDAP_BACK_TV_SET( &tv );
303 /* check time limit */
304 if ( op->ors_tlimit != SLAP_NO_LIMIT
305 && slap_get_time() > stoptime )
307 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
308 rc = rs->sr_err = LDAP_TIMELIMIT_EXCEEDED;
314 /* only touch when activity actually took place... */
315 if ( li->li_idle_timeout && lc ) {
316 lc->lc_time = op->o_time;
319 /* don't retry any more */
324 if ( rc == LDAP_RES_SEARCH_ENTRY ) {
326 struct berval bdn = BER_BVNULL;
330 e = ldap_first_entry( lc->lc_ld, res );
331 rc = ldap_build_entry( op, e, &ent, &bdn );
332 if ( rc == LDAP_SUCCESS ) {
333 ldap_get_entry_controls( lc->lc_ld, res, &rs->sr_ctrls );
335 rs->sr_attrs = op->ors_attrs;
336 rs->sr_operational_attrs = NULL;
338 rs->sr_err = LDAP_SUCCESS;
339 rc = rs->sr_err = send_search_entry( op, rs );
340 if ( rs->sr_ctrls ) {
341 ldap_controls_free( rs->sr_ctrls );
345 if ( !BER_BVISNULL( &ent.e_name ) ) {
346 assert( ent.e_name.bv_val != bdn.bv_val );
347 op->o_tmpfree( ent.e_name.bv_val, op->o_tmpmemctx );
348 BER_BVZERO( &ent.e_name );
350 if ( !BER_BVISNULL( &ent.e_nname ) ) {
351 op->o_tmpfree( ent.e_nname.bv_val, op->o_tmpmemctx );
352 BER_BVZERO( &ent.e_nname );
359 case LDAP_INSUFFICIENT_ACCESS:
363 if ( rc == LDAP_UNAVAILABLE ) {
364 rc = rs->sr_err = LDAP_OTHER;
366 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
371 } else if ( rc == LDAP_RES_SEARCH_REFERENCE ) {
372 if ( LDAP_BACK_NOREFS( li ) ) {
378 rc = ldap_parse_reference( lc->lc_ld, res,
379 &references, &rs->sr_ctrls, 1 );
381 if ( rc != LDAP_SUCCESS ) {
385 /* FIXME: there MUST be at least one */
386 if ( references && references[ 0 ] && references[ 0 ][ 0 ] ) {
389 for ( cnt = 0; references[ cnt ]; cnt++ )
392 /* FIXME: there MUST be at least one */
393 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
396 for ( cnt = 0; references[ cnt ]; cnt++ ) {
397 ber_str2bv( references[ cnt ], 0, 0, &rs->sr_ref[ cnt ] );
399 BER_BVZERO( &rs->sr_ref[ cnt ] );
401 /* ignore return value by now */
403 ( void )send_search_reference( op, rs );
406 Debug( LDAP_DEBUG_ANY,
407 "%s ldap_back_search: "
408 "got SEARCH_REFERENCE "
409 "with no referrals\n",
410 op->o_log_prefix, 0, 0 );
415 ber_memvfree( (void **)references );
416 op->o_tmpfree( rs->sr_ref, op->o_tmpmemctx );
421 if ( rs->sr_ctrls ) {
422 ldap_controls_free( rs->sr_ctrls );
426 } else if ( rc == LDAP_RES_INTERMEDIATE ) {
427 /* FIXME: response controls
428 * are passed without checks */
429 rc = ldap_parse_intermediate( lc->lc_ld,
435 if ( rc != LDAP_SUCCESS ) {
439 slap_send_ldap_intermediate( op, rs );
441 if ( rs->sr_rspoid != NULL ) {
442 ber_memfree( rs->sr_rspoid );
443 rs->sr_rspoid = NULL;
446 if ( rs->sr_rspdata != NULL ) {
447 ber_bvfree( rs->sr_rspdata );
448 rs->sr_rspdata = NULL;
451 if ( rs->sr_ctrls != NULL ) {
452 ldap_controls_free( rs->sr_ctrls );
459 rc = ldap_parse_result( lc->lc_ld, res, &rs->sr_err,
461 &references, &rs->sr_ctrls, 1 );
462 if ( rc != LDAP_SUCCESS ) {
465 rs->sr_err = slap_map_api2result( rs );
471 /* RFC 4511: referrals can only appear
472 * if result code is LDAP_REFERRAL */
475 && references[ 0 ][ 0 ] )
477 if ( rs->sr_err != LDAP_REFERRAL ) {
478 Debug( LDAP_DEBUG_ANY,
479 "%s ldap_back_search: "
480 "got referrals with err=%d\n",
487 for ( cnt = 0; references[ cnt ]; cnt++ )
490 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
493 for ( cnt = 0; references[ cnt ]; cnt++ ) {
495 ber_str2bv( references[ cnt ], 0, 0, &rs->sr_ref[ cnt ] );
497 BER_BVZERO( &rs->sr_ref[ cnt ] );
500 } else if ( rs->sr_err == LDAP_REFERRAL ) {
501 Debug( LDAP_DEBUG_ANY,
502 "%s ldap_back_search: "
503 "got err=%d with null "
504 "or empty referrals\n",
508 rs->sr_err = LDAP_NO_SUCH_OBJECT;
511 if ( match.bv_val != NULL ) {
512 match.bv_len = strlen( match.bv_val );
519 /* if needed, restore timeout */
520 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
521 if ( tv.tv_sec == 0 || tv.tv_sec > li->li_timeout[ SLAP_OP_SEARCH ] ) {
522 tv.tv_sec = li->li_timeout[ SLAP_OP_SEARCH ];
528 if ( rc == -1 && dont_retry == 0 ) {
531 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
535 rs->sr_err = LDAP_SERVER_DOWN;
536 rs->sr_err = slap_map_api2result( rs );
541 * Rewrite the matched portion of the search base, if required
543 if ( !BER_BVISNULL( &match ) && !BER_BVISEMPTY( &match ) ) {
544 struct berval pmatch;
546 if ( dnPretty( NULL, &match, &pmatch, op->o_tmpmemctx ) == LDAP_SUCCESS ) {
547 rs->sr_matched = pmatch.bv_val;
548 LDAP_FREE( match.bv_val );
551 rs->sr_matched = match.bv_val;
555 if ( rs->sr_v2ref ) {
556 rs->sr_err = LDAP_REFERRAL;
560 if ( LDAP_BACK_QUARANTINE( li ) ) {
561 ldap_back_quarantine( op, rs );
564 if ( filter.bv_val != op->ors_filterstr.bv_val ) {
565 op->o_tmpfree( filter.bv_val, op->o_tmpmemctx );
569 /* let send_ldap_result play cleanup handlers (ITS#4645) */
570 if ( rc != SLAPD_ABANDON )
573 send_ldap_result( op, rs );
576 (void)ldap_back_controls_free( op, rs, &ctrls );
578 if ( rs->sr_ctrls ) {
579 ldap_controls_free( rs->sr_ctrls );
583 if ( rs->sr_matched != NULL && rs->sr_matched != save_matched ) {
584 if ( rs->sr_matched != match.bv_val ) {
585 ber_memfree_x( (char *)rs->sr_matched, op->o_tmpmemctx );
588 LDAP_FREE( match.bv_val );
590 rs->sr_matched = save_matched;
595 LDAP_FREE( (char *)rs->sr_text );
601 op->o_tmpfree( rs->sr_ref, op->o_tmpmemctx );
606 ber_memvfree( (void **)references );
614 ldap_back_release_conn( li, lc );
628 BerElement ber = *e->lm_ber;
629 Attribute *attr, **attrp;
635 /* safe assumptions ... */
636 assert( ent != NULL );
637 BER_BVZERO( &ent->e_bv );
639 if ( ber_scanf( &ber, "{m", bdn ) == LBER_ERROR ) {
640 return LDAP_DECODING_ERROR;
644 * Note: this may fail if the target host(s) schema differs
645 * from the one known to the meta, and a DN with unknown
646 * attributes is returned.
648 * FIXME: should we log anything, or delegate to dnNormalize?
650 /* Note: if the distinguished values or the naming attributes
651 * change, should we massage them as well?
653 if ( dnPrettyNormal( NULL, bdn, &ent->e_name, &ent->e_nname,
654 op->o_tmpmemctx ) != LDAP_SUCCESS )
656 return LDAP_INVALID_DN_SYNTAX;
660 if ( ber_first_element( &ber, &len, &lastb ) != LBER_SEQUENCE ) {
664 attrp = &ent->e_attrs;
665 while ( ber_next_element( &ber, &len, lastb ) == LBER_SEQUENCE &&
666 ber_scanf( &ber, "{m", &a ) != LBER_ERROR ) {
668 slap_syntax_validate_func *validate;
669 slap_syntax_transform_func *pretty;
671 attr = attr_alloc( NULL );
672 if ( attr == NULL ) {
675 if ( slap_bv2ad( &a, &attr->a_desc, &text )
678 if ( slap_bv2undef_ad( &a, &attr->a_desc, &text,
679 SLAP_AD_PROXIED ) != LDAP_SUCCESS )
681 Debug( LDAP_DEBUG_ANY,
682 "%s ldap_build_entry: "
683 "slap_bv2undef_ad(%s): %s\n",
684 op->o_log_prefix, a.bv_val, text );
686 ( void )ber_scanf( &ber, "x" /* [W] */ );
692 /* no subschemaSubentry */
693 if ( attr->a_desc == slap_schema.si_ad_subschemaSubentry
694 || attr->a_desc == slap_schema.si_ad_entryDN )
698 * We eat target's subschemaSubentry because
699 * a search for this value is likely not
700 * to resolve to the appropriate backend;
701 * later, the local subschemaSubentry is
704 * We also eat entryDN because the frontend
705 * will reattach it without checking if already
708 ( void )ber_scanf( &ber, "x" /* [W] */ );
713 if ( ber_scanf( &ber, "[W]", &attr->a_vals ) == LBER_ERROR
714 || attr->a_vals == NULL )
717 * Note: attr->a_vals can be null when using
718 * values result filter
720 attr->a_vals = (struct berval *)&slap_dummy_bv;
723 validate = attr->a_desc->ad_type->sat_syntax->ssyn_validate;
724 pretty = attr->a_desc->ad_type->sat_syntax->ssyn_pretty;
726 if ( !validate && !pretty ) {
727 attr->a_nvals = NULL;
732 for ( i = 0; !BER_BVISNULL( &attr->a_vals[i] ); i++ ) {
737 rc = pretty( attr->a_desc->ad_type->sat_syntax,
738 &attr->a_vals[i], &pval, NULL );
741 rc = validate( attr->a_desc->ad_type->sat_syntax,
745 if ( rc != LDAP_SUCCESS ) {
748 /* check if, by chance, it's an undefined objectClass */
749 if ( attr->a_desc == slap_schema.si_ad_objectClass &&
750 ( oc = oc_bvfind_undef( &attr->a_vals[i] ) ) != NULL )
752 ber_dupbv( &pval, &oc->soc_cname );
755 attr->a_nvals = NULL;
762 LBER_FREE( attr->a_vals[i].bv_val );
763 attr->a_vals[i] = pval;
766 attr->a_numvals = last = i;
768 if ( last && attr->a_desc->ad_type->sat_equality &&
769 attr->a_desc->ad_type->sat_equality->smr_normalize )
771 attr->a_nvals = ch_malloc( ( last + 1 )*sizeof( struct berval ) );
772 for ( i = 0; i < last; i++ ) {
776 * check that each value is valid per syntax
777 * and pretty if appropriate
779 rc = attr->a_desc->ad_type->sat_equality->smr_normalize(
780 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
781 attr->a_desc->ad_type->sat_syntax,
782 attr->a_desc->ad_type->sat_equality,
783 &attr->a_vals[i], &attr->a_nvals[i],
786 if ( rc != LDAP_SUCCESS ) {
787 BER_BVZERO( &attr->a_nvals[i] );
792 BER_BVZERO( &attr->a_nvals[i] );
795 attr->a_nvals = attr->a_vals;
798 attrp = &attr->a_next;
806 /* return 0 IFF we can retrieve the entry with ndn
813 AttributeDescription *at,
817 ldapinfo_t *li = (ldapinfo_t *) op->o_bd->be_private;
819 ldapconn_t *lc = NULL;
824 LDAPMessage *result = NULL,
826 char *attr[3], **attrp = NULL;
830 LDAPControl **ctrls = NULL;
834 /* Tell getconn this is a privileged op */
835 do_not_cache = op->o_do_not_cache;
838 op->o_do_not_cache = 1;
839 /* ldap_back_entry_get() is an entry lookup, so it does not need
840 * to know what the entry is being looked up for */
841 op->o_tag = LDAP_REQ_SEARCH;
842 rc = ldap_back_dobind( &lc, op, &rs, LDAP_BACK_DONTSEND );
843 op->o_do_not_cache = do_not_cache;
851 if ( oc && at != slap_schema.si_ad_objectClass ) {
852 attr[0] = slap_schema.si_ad_objectClass->ad_cname.bv_val;
853 attr[1] = at->ad_cname.bv_val;
857 attr[0] = at->ad_cname.bv_val;
865 filter = op->o_tmpalloc( STRLENOF( "(objectClass=" ")" )
866 + oc->soc_cname.bv_len + 1, op->o_tmpmemctx );
867 ptr = lutil_strcopy( filter, "(objectClass=" );
868 ptr = lutil_strcopy( ptr, oc->soc_cname.bv_val );
875 rc = ldap_back_controls_add( op, &rs, lc, &ctrls );
876 if ( rc != LDAP_SUCCESS ) {
881 rc = ldap_pvt_search_s( lc->lc_ld, ndn->bv_val, LDAP_SCOPE_BASE, filter,
882 attrp, 0, ctrls, NULL,
883 NULL, LDAP_NO_LIMIT, op->ors_deref, &result );
884 if ( rc != LDAP_SUCCESS ) {
885 if ( rc == LDAP_SERVER_DOWN && do_retry ) {
887 if ( ldap_back_retry( &lc, op, &rs, LDAP_BACK_DONTSEND ) ) {
888 /* if the identity changed, there might be need to re-authz */
889 (void)ldap_back_controls_free( op, &rs, &ctrls );
896 e = ldap_first_entry( lc->lc_ld, result );
898 /* the entry exists, but it doesn't match the filter? */
902 *ent = entry_alloc();
903 if ( *ent == NULL ) {
908 rc = ldap_build_entry( op, e, *ent, &bdn );
910 if ( rc != LDAP_SUCCESS ) {
916 (void)ldap_back_controls_free( op, &rs, &ctrls );
919 ldap_msgfree( result );
923 op->o_tmpfree( filter, op->o_tmpmemctx );
927 ldap_back_release_conn( li, lc );