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 = LDAP_ADMINLIMIT_EXCEEDED;
297 LDAP_BACK_TV_SET( &tv );
300 /* check time limit */
301 if ( op->ors_tlimit != SLAP_NO_LIMIT
302 && slap_get_time() > stoptime )
304 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
305 rc = rs->sr_err = LDAP_TIMELIMIT_EXCEEDED;
311 /* only touch when activity actually took place... */
312 if ( li->li_idle_timeout && lc ) {
313 lc->lc_time = op->o_time;
316 /* don't retry any more */
321 if ( rc == LDAP_RES_SEARCH_ENTRY ) {
323 struct berval bdn = BER_BVNULL;
327 e = ldap_first_entry( lc->lc_ld, res );
328 rc = ldap_build_entry( op, e, &ent, &bdn );
329 if ( rc == LDAP_SUCCESS ) {
331 rs->sr_attrs = op->ors_attrs;
332 rs->sr_operational_attrs = NULL;
334 rs->sr_err = LDAP_SUCCESS;
335 rc = rs->sr_err = send_search_entry( op, rs );
336 if ( !BER_BVISNULL( &ent.e_name ) ) {
337 assert( ent.e_name.bv_val != bdn.bv_val );
338 op->o_tmpfree( ent.e_name.bv_val, op->o_tmpmemctx );
339 BER_BVZERO( &ent.e_name );
341 if ( !BER_BVISNULL( &ent.e_nname ) ) {
342 op->o_tmpfree( ent.e_nname.bv_val, op->o_tmpmemctx );
343 BER_BVZERO( &ent.e_nname );
348 if ( rc != LDAP_SUCCESS ) {
349 if ( rc == LDAP_UNAVAILABLE ) {
350 rc = rs->sr_err = LDAP_OTHER;
352 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
357 } else if ( rc == LDAP_RES_SEARCH_REFERENCE ) {
358 char **references = NULL;
361 rc = ldap_parse_reference( lc->lc_ld, res,
362 &references, &rs->sr_ctrls, 1 );
364 if ( rc != LDAP_SUCCESS ) {
368 /* FIXME: there MUST be at least one */
369 if ( references && references[ 0 ] && references[ 0 ][ 0 ] ) {
372 for ( cnt = 0; references[ cnt ]; cnt++ )
375 /* FIXME: there MUST be at least one */
376 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
379 for ( cnt = 0; references[ cnt ]; cnt++ ) {
380 ber_str2bv( references[ cnt ], 0, 0, &rs->sr_ref[ cnt ] );
382 BER_BVZERO( &rs->sr_ref[ cnt ] );
384 /* ignore return value by now */
385 ( void )send_search_reference( op, rs );
388 Debug( LDAP_DEBUG_ANY,
389 "%s ldap_back_search: "
390 "got SEARCH_REFERENCE "
391 "with no referrals\n",
392 op->o_log_prefix, 0, 0 );
397 ber_memvfree( (void **)references );
398 op->o_tmpfree( rs->sr_ref, op->o_tmpmemctx );
402 if ( rs->sr_ctrls ) {
403 ldap_controls_free( rs->sr_ctrls );
408 char **references = NULL, *err = NULL;
410 rc = ldap_parse_result( lc->lc_ld, res, &rs->sr_err,
412 &references, &rs->sr_ctrls, 1 );
413 if ( rc != LDAP_SUCCESS ) {
416 rs->sr_err = slap_map_api2result( rs );
422 if ( references && references[ 0 ] && references[ 0 ][ 0 ] ) {
425 if ( rs->sr_err != LDAP_REFERRAL ) {
427 Debug( LDAP_DEBUG_ANY,
428 "%s ldap_back_search: "
429 "got referrals with %d\n",
432 rs->sr_err = LDAP_REFERRAL;
435 for ( cnt = 0; references[ cnt ]; cnt++ )
438 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
441 for ( cnt = 0; references[ cnt ]; cnt++ ) {
443 ber_str2bv( references[ cnt ], 0, 1, &rs->sr_ref[ cnt ] );
445 BER_BVZERO( &rs->sr_ref[ cnt ] );
448 if ( match.bv_val != NULL ) {
449 match.bv_len = strlen( match.bv_val );
454 ber_memvfree( (void **)references );
461 /* if needed, restore timeout */
462 if ( li->li_timeout[ SLAP_OP_SEARCH ] ) {
463 if ( tv.tv_sec == 0 || tv.tv_sec > li->li_timeout[ SLAP_OP_SEARCH ] ) {
464 tv.tv_sec = li->li_timeout[ SLAP_OP_SEARCH ];
470 if ( rc == -1 && dont_retry == 0 ) {
473 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
477 rs->sr_err = LDAP_SERVER_DOWN;
478 rs->sr_err = slap_map_api2result( rs );
483 * Rewrite the matched portion of the search base, if required
485 if ( !BER_BVISNULL( &match ) && !BER_BVISEMPTY( &match ) ) {
486 struct berval pmatch;
488 if ( dnPretty( NULL, &match, &pmatch, op->o_tmpmemctx ) == LDAP_SUCCESS ) {
489 rs->sr_matched = pmatch.bv_val;
490 LDAP_FREE( match.bv_val );
493 rs->sr_matched = match.bv_val;
497 if ( rs->sr_v2ref ) {
498 rs->sr_err = LDAP_REFERRAL;
502 if ( LDAP_BACK_QUARANTINE( li ) ) {
503 ldap_back_quarantine( op, rs );
507 /* let send_ldap_result play cleanup handlers (ITS#4645) */
508 if ( rc != SLAPD_ABANDON )
511 send_ldap_result( op, rs );
514 (void)ldap_back_proxy_authz_ctrl_free( op, &ctrls );
516 if ( rs->sr_ctrls ) {
517 ldap_controls_free( rs->sr_ctrls );
521 if ( rs->sr_matched != NULL && rs->sr_matched != save_matched ) {
522 if ( rs->sr_matched != match.bv_val ) {
523 ber_memfree_x( (char *)rs->sr_matched, op->o_tmpmemctx );
526 LDAP_FREE( match.bv_val );
528 rs->sr_matched = save_matched;
532 op->o_tmpfree( filter.bv_val, op->o_tmpmemctx );
537 LDAP_FREE( (char *)rs->sr_text );
543 ber_bvarray_free_x( rs->sr_ref, op->o_tmpmemctx );
552 ldap_back_release_conn( li, lc );
566 BerElement ber = *e->lm_ber;
567 Attribute *attr, **attrp;
571 /* safe assumptions ... */
572 assert( ent != NULL );
573 BER_BVZERO( &ent->e_bv );
575 if ( ber_scanf( &ber, "{m{", bdn ) == LBER_ERROR ) {
576 return LDAP_DECODING_ERROR;
580 * Note: this may fail if the target host(s) schema differs
581 * from the one known to the meta, and a DN with unknown
582 * attributes is returned.
584 * FIXME: should we log anything, or delegate to dnNormalize?
586 /* Note: if the distinguished values or the naming attributes
587 * change, should we massage them as well?
589 if ( dnPrettyNormal( NULL, bdn, &ent->e_name, &ent->e_nname,
590 op->o_tmpmemctx ) != LDAP_SUCCESS )
592 return LDAP_INVALID_DN_SYNTAX;
595 attrp = &ent->e_attrs;
597 while ( ber_scanf( &ber, "{m", &a ) != LBER_ERROR ) {
599 slap_syntax_validate_func *validate;
600 slap_syntax_transform_func *pretty;
602 attr = attr_alloc( NULL );
603 if ( attr == NULL ) {
606 if ( slap_bv2ad( &a, &attr->a_desc, &text )
609 if ( slap_bv2undef_ad( &a, &attr->a_desc, &text,
610 SLAP_AD_PROXIED ) != LDAP_SUCCESS )
612 Debug( LDAP_DEBUG_ANY,
613 "%s ldap_build_entry: "
614 "slap_bv2undef_ad(%s): %s\n",
615 op->o_log_prefix, a.bv_val, text );
621 /* no subschemaSubentry */
622 if ( attr->a_desc == slap_schema.si_ad_subschemaSubentry
623 || attr->a_desc == slap_schema.si_ad_entryDN )
627 * We eat target's subschemaSubentry because
628 * a search for this value is likely not
629 * to resolve to the appropriate backend;
630 * later, the local subschemaSubentry is
633 * We also eat entryDN because the frontend
634 * will reattach it without checking if already
637 ( void )ber_scanf( &ber, "x" /* [W] */ );
643 if ( ber_scanf( &ber, "[W]", &attr->a_vals ) == LBER_ERROR
644 || attr->a_vals == NULL )
647 * Note: attr->a_vals can be null when using
648 * values result filter
650 attr->a_vals = (struct berval *)&slap_dummy_bv;
654 for ( last = 0; !BER_BVISNULL( &attr->a_vals[ last ] ); last++ )
655 /* just count vals */ ;
658 validate = attr->a_desc->ad_type->sat_syntax->ssyn_validate;
659 pretty = attr->a_desc->ad_type->sat_syntax->ssyn_pretty;
661 if ( !validate && !pretty ) {
662 attr->a_nvals = NULL;
667 for ( i = 0; i < last; i++ ) {
672 rc = pretty( attr->a_desc->ad_type->sat_syntax,
673 &attr->a_vals[i], &pval, NULL );
676 rc = validate( attr->a_desc->ad_type->sat_syntax,
680 if ( rc != LDAP_SUCCESS ) {
681 /* check if, by chance, it's an undefined objectClass */
682 if ( attr->a_desc == slap_schema.si_ad_objectClass &&
683 oc_bvfind_undef( &attr->a_vals[i] ) != NULL )
685 ber_dupbv( &pval, &attr->a_vals[i] );
688 attr->a_nvals = NULL;
695 LBER_FREE( attr->a_vals[i].bv_val );
696 attr->a_vals[i] = pval;
700 if ( last && attr->a_desc->ad_type->sat_equality &&
701 attr->a_desc->ad_type->sat_equality->smr_normalize )
703 attr->a_nvals = ch_malloc( ( last + 1 )*sizeof( struct berval ) );
704 for ( i = 0; i < last; i++ ) {
708 * check that each value is valid per syntax
709 * and pretty if appropriate
711 rc = attr->a_desc->ad_type->sat_equality->smr_normalize(
712 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
713 attr->a_desc->ad_type->sat_syntax,
714 attr->a_desc->ad_type->sat_equality,
715 &attr->a_vals[i], &attr->a_nvals[i],
718 if ( rc != LDAP_SUCCESS ) {
719 BER_BVZERO( &attr->a_nvals[i] );
724 BER_BVZERO( &attr->a_nvals[i] );
727 attr->a_nvals = attr->a_vals;
730 attrp = &attr->a_next;
738 /* return 0 IFF we can retrieve the entry with ndn
745 AttributeDescription *at,
749 ldapinfo_t *li = (ldapinfo_t *) op->o_bd->be_private;
751 ldapconn_t *lc = NULL;
755 LDAPMessage *result = NULL,
757 char *attr[3], **attrp = NULL;
761 LDAPControl **ctrls = NULL;
765 /* Tell getconn this is a privileged op */
766 do_not_cache = op->o_do_not_cache;
767 op->o_do_not_cache = 1;
768 if ( !ldap_back_dobind( &lc, op, &rs, LDAP_BACK_DONTSEND ) ) {
769 op->o_do_not_cache = do_not_cache;
772 op->o_do_not_cache = do_not_cache;
776 if ( oc && at != slap_schema.si_ad_objectClass ) {
777 attr[0] = slap_schema.si_ad_objectClass->ad_cname.bv_val;
778 attr[1] = at->ad_cname.bv_val;
782 attr[0] = at->ad_cname.bv_val;
790 filter = ch_malloc( STRLENOF( "(objectclass=)" )
791 + oc->soc_cname.bv_len + 1 );
792 ptr = lutil_strcopy( filter, "(objectclass=" );
793 ptr = lutil_strcopy( ptr, oc->soc_cname.bv_val );
800 rc = ldap_back_proxy_authz_ctrl( &lc->lc_bound_ndn,
801 li->li_version, &li->li_idassert, op, &rs, &ctrls );
802 if ( rc != LDAP_SUCCESS ) {
806 rc = ldap_search_ext_s( lc->lc_ld, ndn->bv_val, LDAP_SCOPE_BASE, filter,
807 attrp, 0, ctrls, NULL,
808 NULL, LDAP_NO_LIMIT, &result );
809 if ( rc != LDAP_SUCCESS ) {
810 if ( rc == LDAP_SERVER_DOWN && do_retry ) {
812 if ( ldap_back_retry( &lc, op, &rs, LDAP_BACK_DONTSEND ) ) {
813 /* if the identity changed, there might be need to re-authz */
814 (void)ldap_back_proxy_authz_ctrl_free( op, &ctrls );
821 e = ldap_first_entry( lc->lc_ld, result );
823 /* the entry exists, but it doesn't match the filter? */
827 *ent = entry_alloc();
828 if ( *ent == NULL ) {
833 rc = ldap_build_entry( op, e, *ent, &bdn );
835 if ( rc != LDAP_SUCCESS ) {
841 (void)ldap_back_proxy_authz_ctrl_free( op, &ctrls );
844 ldap_msgfree( result );
852 ldap_back_release_conn( li, lc );