1 /* search.c - ldap backend search function */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1999-2007 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 oldbv = &bv_undefined;
106 if ( newbv->bv_len > oldbv->bv_len ) {
107 filter->bv_len += newbv->bv_len - oldbv->bv_len;
108 if ( filter->bv_val == op->ors_filterstr.bv_val ) {
109 filter->bv_val = op->o_tmpalloc( filter->bv_len + 1,
112 AC_MEMCPY( filter->bv_val, op->ors_filterstr.bv_val,
113 op->ors_filterstr.bv_len + 1 );
116 filter->bv_val = op->o_tmprealloc( filter->bv_val,
117 filter->bv_len + 1, op->o_tmpmemctx );
120 ptr = filter->bv_val + ( ptr - oldfilter.bv_val );
123 AC_MEMCPY( &ptr[ newbv->bv_len ],
124 &ptr[ oldbv->bv_len ],
125 oldfilter.bv_len - ( ptr - filter->bv_val ) - oldbv->bv_len + 1 );
126 AC_MEMCPY( ptr, newbv->bv_val, newbv->bv_len );
128 ptr += newbv->bv_len;
133 Debug( LDAP_DEBUG_ARGS, "<= ldap_back_munge_filter \"%s\" (%d)\n",
134 filter->bv_val, gotit, 0 );
144 ldapinfo_t *li = (ldapinfo_t *) op->o_bd->be_private;
146 ldapconn_t *lc = NULL;
148 time_t stoptime = (time_t)(-1);
153 struct berval match = BER_BVNULL,
159 int do_retry = 1, dont_retry = 0;
160 LDAPControl **ctrls = NULL;
161 /* FIXME: shouldn't this be null? */
162 const char *save_matched = rs->sr_matched;
164 if ( !ldap_back_dobind( &lc, op, rs, LDAP_BACK_SENDERR ) ) {
169 * FIXME: in case of values return filter, we might want
170 * to map attrs and maybe rewrite value
173 /* should we check return values? */
174 if ( op->ors_deref != -1 ) {
175 ldap_set_option( lc->lc_ld, LDAP_OPT_DEREF,
176 (void *)&op->ors_deref );
179 if ( op->ors_tlimit != SLAP_NO_LIMIT ) {
180 tv.tv_sec = op->ors_tlimit;
182 stoptime = op->o_time + op->ors_tlimit;
185 LDAP_BACK_TV_SET( &tv );
188 if ( op->ors_attrs ) {
189 for ( i = 0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++ )
190 /* just count attrs */ ;
192 attrs = ch_malloc( ( i + 1 )*sizeof( char * ) );
193 if ( attrs == NULL ) {
194 rs->sr_err = LDAP_NO_MEMORY;
199 for ( i = 0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++ ) {
200 attrs[ i ] = op->ors_attrs[i].an_name.bv_val;
206 rc = ldap_back_proxy_authz_ctrl( &lc->lc_bound_ndn,
207 li->li_version, &li->li_idassert, op, rs, &ctrls );
208 if ( rc != LDAP_SUCCESS ) {
212 /* deal with <draft-zeilenga-ldap-t-f> filters */
213 filter = op->ors_filterstr;
215 rs->sr_err = ldap_search_ext( lc->lc_ld, op->o_req_dn.bv_val,
216 op->ors_scope, filter.bv_val,
217 attrs, op->ors_attrsonly, ctrls, NULL,
218 tv.tv_sec ? &tv : NULL,
219 op->ors_slimit, &msgid );
221 if ( rs->sr_err != LDAP_SUCCESS ) {
222 switch ( rs->sr_err ) {
223 case LDAP_SERVER_DOWN:
226 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
232 /* reset by ldap_back_retry ... */
233 rs->sr_err = slap_map_api2result( rs );
236 rc = ldap_back_op_result( lc, op, rs, msgid, 0, LDAP_BACK_DONTSEND );
241 case LDAP_FILTER_ERROR:
242 if ( ldap_back_munge_filter( op, &filter ) ) {
247 /* invalid filters return success with no data */
248 rs->sr_err = LDAP_SUCCESS;
253 rs->sr_err = slap_map_api2result( rs );
259 /* if needed, initialize timeout */
260 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
261 if ( tv.tv_sec == 0 || tv.tv_sec > li->li_timeout[ SLAP_OP_SEARCH ] ) {
262 tv.tv_sec = li->li_timeout[ SLAP_OP_SEARCH ];
267 /* We pull apart the ber result, stuff it into a slapd entry, and
268 * let send_search_entry stuff it back into ber format. Slow & ugly,
269 * but this is necessary for version matching, and for ACL processing.
272 for ( rc = -2; rc != -1; rc = ldap_result( lc->lc_ld, msgid, LDAP_MSG_ONE, &tv, &res ) )
274 /* check for abandon */
275 if ( op->o_abandon || LDAP_BACK_CONN_ABANDON( lc ) ) {
279 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
284 if ( rc == 0 || rc == -2 ) {
285 ldap_pvt_thread_yield();
288 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
290 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
291 rs->sr_text = "Operation timed out";
292 rc = rs->sr_err = op->o_protocol >= LDAP_VERSION3 ?
293 LDAP_ADMINLIMIT_EXCEEDED : LDAP_OTHER;
298 LDAP_BACK_TV_SET( &tv );
301 /* check time limit */
302 if ( op->ors_tlimit != SLAP_NO_LIMIT
303 && slap_get_time() > stoptime )
305 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
306 rc = rs->sr_err = LDAP_TIMELIMIT_EXCEEDED;
312 /* only touch when activity actually took place... */
313 if ( li->li_idle_timeout && lc ) {
314 lc->lc_time = op->o_time;
317 /* don't retry any more */
322 if ( rc == LDAP_RES_SEARCH_ENTRY ) {
324 struct berval bdn = BER_BVNULL;
328 e = ldap_first_entry( lc->lc_ld, res );
329 rc = ldap_build_entry( op, e, &ent, &bdn );
330 if ( rc == LDAP_SUCCESS ) {
332 rs->sr_attrs = op->ors_attrs;
333 rs->sr_operational_attrs = NULL;
335 rs->sr_err = LDAP_SUCCESS;
336 rc = rs->sr_err = send_search_entry( op, rs );
337 if ( !BER_BVISNULL( &ent.e_name ) ) {
338 assert( ent.e_name.bv_val != bdn.bv_val );
339 op->o_tmpfree( ent.e_name.bv_val, op->o_tmpmemctx );
340 BER_BVZERO( &ent.e_name );
342 if ( !BER_BVISNULL( &ent.e_nname ) ) {
343 op->o_tmpfree( ent.e_nname.bv_val, op->o_tmpmemctx );
344 BER_BVZERO( &ent.e_nname );
349 if ( rc != LDAP_SUCCESS ) {
350 if ( rc == LDAP_UNAVAILABLE ) {
351 rc = rs->sr_err = LDAP_OTHER;
353 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
358 } else if ( rc == LDAP_RES_SEARCH_REFERENCE ) {
359 char **references = NULL;
362 rc = ldap_parse_reference( lc->lc_ld, res,
363 &references, &rs->sr_ctrls, 1 );
365 if ( rc != LDAP_SUCCESS ) {
369 /* FIXME: there MUST be at least one */
370 if ( references && references[ 0 ] && references[ 0 ][ 0 ] ) {
373 for ( cnt = 0; references[ cnt ]; cnt++ )
376 /* FIXME: there MUST be at least one */
377 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
380 for ( cnt = 0; references[ cnt ]; cnt++ ) {
381 ber_str2bv( references[ cnt ], 0, 0, &rs->sr_ref[ cnt ] );
383 BER_BVZERO( &rs->sr_ref[ cnt ] );
385 /* ignore return value by now */
386 ( void )send_search_reference( op, rs );
389 Debug( LDAP_DEBUG_ANY,
390 "%s ldap_back_search: "
391 "got SEARCH_REFERENCE "
392 "with no referrals\n",
393 op->o_log_prefix, 0, 0 );
398 ber_memvfree( (void **)references );
399 op->o_tmpfree( rs->sr_ref, op->o_tmpmemctx );
403 if ( rs->sr_ctrls ) {
404 ldap_controls_free( rs->sr_ctrls );
409 char **references = NULL, *err = NULL;
411 rc = ldap_parse_result( lc->lc_ld, res, &rs->sr_err,
413 &references, &rs->sr_ctrls, 1 );
414 if ( rc != LDAP_SUCCESS ) {
417 rs->sr_err = slap_map_api2result( rs );
423 /* RFC 4511: referrals can only appear
424 * if result code is LDAP_REFERRAL */
427 && references[ 0 ][ 0 ] )
429 if ( rs->sr_err != LDAP_REFERRAL ) {
430 Debug( LDAP_DEBUG_ANY,
431 "%s ldap_back_search: "
432 "got referrals with err=%d\n",
439 for ( cnt = 0; references[ cnt ]; cnt++ )
442 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
445 for ( cnt = 0; references[ cnt ]; cnt++ ) {
447 ber_str2bv( references[ cnt ], 0, 1, &rs->sr_ref[ cnt ] );
449 BER_BVZERO( &rs->sr_ref[ cnt ] );
452 } else if ( rs->sr_err == LDAP_REFERRAL ) {
453 Debug( LDAP_DEBUG_ANY,
454 "%s ldap_back_search: "
455 "got err=%d with null "
456 "or empty referrals\n",
460 rs->sr_err = LDAP_NO_SUCH_OBJECT;
463 ber_memvfree( (void **)references );
465 if ( match.bv_val != NULL ) {
466 #ifndef LDAP_NULL_IS_NULL
467 if ( match.bv_val[ 0 ] == '\0' ) {
468 LDAP_FREE( match.bv_val );
469 BER_BVZERO( &match );
471 #endif /* LDAP_NULL_IS_NULL */
473 match.bv_len = strlen( match.bv_val );
476 #ifndef LDAP_NULL_IS_NULL
477 if ( rs->sr_text != NULL && rs->sr_text[ 0 ] == '\0' ) {
478 LDAP_FREE( (char *)rs->sr_text );
481 #endif /* LDAP_NULL_IS_NULL */
487 /* if needed, restore timeout */
488 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
489 if ( tv.tv_sec == 0 || tv.tv_sec > li->li_timeout[ SLAP_OP_SEARCH ] ) {
490 tv.tv_sec = li->li_timeout[ SLAP_OP_SEARCH ];
496 if ( rc == -1 && dont_retry == 0 ) {
499 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
503 rs->sr_err = LDAP_SERVER_DOWN;
504 rs->sr_err = slap_map_api2result( rs );
509 * Rewrite the matched portion of the search base, if required
511 if ( !BER_BVISNULL( &match ) && !BER_BVISEMPTY( &match ) ) {
512 struct berval pmatch;
514 if ( dnPretty( NULL, &match, &pmatch, op->o_tmpmemctx ) == LDAP_SUCCESS ) {
515 rs->sr_matched = pmatch.bv_val;
516 LDAP_FREE( match.bv_val );
519 rs->sr_matched = match.bv_val;
523 if ( rs->sr_v2ref ) {
524 rs->sr_err = LDAP_REFERRAL;
528 if ( LDAP_BACK_QUARANTINE( li ) ) {
529 ldap_back_quarantine( op, rs );
533 /* let send_ldap_result play cleanup handlers (ITS#4645) */
534 if ( rc != SLAPD_ABANDON )
537 send_ldap_result( op, rs );
540 (void)ldap_back_proxy_authz_ctrl_free( op, &ctrls );
542 if ( rs->sr_ctrls ) {
543 ldap_controls_free( rs->sr_ctrls );
547 if ( rs->sr_matched != NULL && rs->sr_matched != save_matched ) {
548 if ( rs->sr_matched != match.bv_val ) {
549 ber_memfree_x( (char *)rs->sr_matched, op->o_tmpmemctx );
552 LDAP_FREE( match.bv_val );
554 rs->sr_matched = save_matched;
558 op->o_tmpfree( filter.bv_val, op->o_tmpmemctx );
563 LDAP_FREE( (char *)rs->sr_text );
569 ber_bvarray_free_x( rs->sr_ref, op->o_tmpmemctx );
578 ldap_back_release_conn( li, lc );
592 BerElement ber = *e->lm_ber;
593 Attribute *attr, **attrp;
597 /* safe assumptions ... */
598 assert( ent != NULL );
599 BER_BVZERO( &ent->e_bv );
601 if ( ber_scanf( &ber, "{m{", bdn ) == LBER_ERROR ) {
602 return LDAP_DECODING_ERROR;
606 * Note: this may fail if the target host(s) schema differs
607 * from the one known to the meta, and a DN with unknown
608 * attributes is returned.
610 * FIXME: should we log anything, or delegate to dnNormalize?
612 /* Note: if the distinguished values or the naming attributes
613 * change, should we massage them as well?
615 if ( dnPrettyNormal( NULL, bdn, &ent->e_name, &ent->e_nname,
616 op->o_tmpmemctx ) != LDAP_SUCCESS )
618 return LDAP_INVALID_DN_SYNTAX;
621 attrp = &ent->e_attrs;
623 while ( ber_scanf( &ber, "{m", &a ) != LBER_ERROR ) {
625 slap_syntax_validate_func *validate;
626 slap_syntax_transform_func *pretty;
628 attr = (Attribute *)ch_malloc( sizeof( Attribute ) );
629 if ( attr == NULL ) {
635 if ( slap_bv2ad( &a, &attr->a_desc, &text )
638 if ( slap_bv2undef_ad( &a, &attr->a_desc, &text,
639 SLAP_AD_PROXIED ) != LDAP_SUCCESS )
641 Debug( LDAP_DEBUG_ANY,
642 "%s ldap_build_entry: "
643 "slap_bv2undef_ad(%s): %s\n",
644 op->o_log_prefix, a.bv_val, text );
650 /* no subschemaSubentry */
651 if ( attr->a_desc == slap_schema.si_ad_subschemaSubentry
652 || attr->a_desc == slap_schema.si_ad_entryDN )
656 * We eat target's subschemaSubentry because
657 * a search for this value is likely not
658 * to resolve to the appropriate backend;
659 * later, the local subschemaSubentry is
662 * We also eat entryDN because the frontend
663 * will reattach it without checking if already
666 ( void )ber_scanf( &ber, "x" /* [W] */ );
672 if ( ber_scanf( &ber, "[W]", &attr->a_vals ) == LBER_ERROR
673 || attr->a_vals == NULL )
676 * Note: attr->a_vals can be null when using
677 * values result filter
679 attr->a_vals = (struct berval *)&slap_dummy_bv;
683 for ( last = 0; !BER_BVISNULL( &attr->a_vals[ last ] ); last++ )
684 /* just count vals */ ;
687 validate = attr->a_desc->ad_type->sat_syntax->ssyn_validate;
688 pretty = attr->a_desc->ad_type->sat_syntax->ssyn_pretty;
690 if ( !validate && !pretty ) {
691 attr->a_nvals = NULL;
696 for ( i = 0; i < last; i++ ) {
701 rc = pretty( attr->a_desc->ad_type->sat_syntax,
702 &attr->a_vals[i], &pval, NULL );
705 rc = validate( attr->a_desc->ad_type->sat_syntax,
709 if ( rc != LDAP_SUCCESS ) {
710 /* check if, by chance, it's an undefined objectClass */
711 if ( attr->a_desc == slap_schema.si_ad_objectClass &&
712 oc_bvfind_undef( &attr->a_vals[i] ) != NULL )
714 ber_dupbv( &pval, &attr->a_vals[i] );
717 attr->a_nvals = NULL;
724 LBER_FREE( attr->a_vals[i].bv_val );
725 attr->a_vals[i] = pval;
729 if ( last && attr->a_desc->ad_type->sat_equality &&
730 attr->a_desc->ad_type->sat_equality->smr_normalize )
732 attr->a_nvals = ch_malloc( ( last + 1 )*sizeof( struct berval ) );
733 for ( i = 0; i < last; i++ ) {
737 * check that each value is valid per syntax
738 * and pretty if appropriate
740 rc = attr->a_desc->ad_type->sat_equality->smr_normalize(
741 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
742 attr->a_desc->ad_type->sat_syntax,
743 attr->a_desc->ad_type->sat_equality,
744 &attr->a_vals[i], &attr->a_nvals[i],
747 if ( rc != LDAP_SUCCESS ) {
748 BER_BVZERO( &attr->a_nvals[i] );
753 BER_BVZERO( &attr->a_nvals[i] );
756 attr->a_nvals = attr->a_vals;
759 attrp = &attr->a_next;
767 /* return 0 IFF we can retrieve the entry with ndn
774 AttributeDescription *at,
778 ldapinfo_t *li = (ldapinfo_t *) op->o_bd->be_private;
780 ldapconn_t *lc = NULL;
784 LDAPMessage *result = NULL,
786 char *attr[3], **attrp = NULL;
790 LDAPControl **ctrls = NULL;
794 /* Tell getconn this is a privileged op */
795 do_not_cache = op->o_do_not_cache;
796 op->o_do_not_cache = 1;
797 if ( !ldap_back_dobind( &lc, op, &rs, LDAP_BACK_DONTSEND ) ) {
798 op->o_do_not_cache = do_not_cache;
801 op->o_do_not_cache = do_not_cache;
805 if ( oc && at != slap_schema.si_ad_objectClass ) {
806 attr[0] = slap_schema.si_ad_objectClass->ad_cname.bv_val;
807 attr[1] = at->ad_cname.bv_val;
811 attr[0] = at->ad_cname.bv_val;
819 filter = ch_malloc( STRLENOF( "(objectclass=)" )
820 + oc->soc_cname.bv_len + 1 );
821 ptr = lutil_strcopy( filter, "(objectclass=" );
822 ptr = lutil_strcopy( ptr, oc->soc_cname.bv_val );
829 rc = ldap_back_proxy_authz_ctrl( &lc->lc_bound_ndn,
830 li->li_version, &li->li_idassert, op, &rs, &ctrls );
831 if ( rc != LDAP_SUCCESS ) {
835 rc = ldap_search_ext_s( lc->lc_ld, ndn->bv_val, LDAP_SCOPE_BASE, filter,
836 attrp, 0, ctrls, NULL,
837 NULL, LDAP_NO_LIMIT, &result );
838 if ( rc != LDAP_SUCCESS ) {
839 if ( rc == LDAP_SERVER_DOWN && do_retry ) {
841 if ( ldap_back_retry( &lc, op, &rs, LDAP_BACK_DONTSEND ) ) {
842 /* if the identity changed, there might be need to re-authz */
843 (void)ldap_back_proxy_authz_ctrl_free( op, &ctrls );
850 e = ldap_first_entry( lc->lc_ld, result );
852 /* the entry exists, but it doesn't match the filter? */
856 *ent = ch_calloc( 1, sizeof( Entry ) );
857 if ( *ent == NULL ) {
862 rc = ldap_build_entry( op, e, *ent, &bdn );
864 if ( rc != LDAP_SUCCESS ) {
870 (void)ldap_back_proxy_authz_ctrl_free( op, &ctrls );
873 ldap_msgfree( result );
881 ldap_back_release_conn( li, lc );