1 /* search.c - ldap backend search function */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1999-2006 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;
148 time_t stoptime = (time_t)-1;
153 struct berval match = BER_BVNULL,
158 int do_retry = 1, dont_retry = 0;
159 LDAPControl **ctrls = NULL;
160 /* FIXME: shouldn't this be null? */
161 const char *save_matched = rs->sr_matched;
163 lc = ldap_back_getconn( op, rs, LDAP_BACK_SENDERR );
164 if ( !lc || !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, op, rs, &ctrls );
207 if ( rc != LDAP_SUCCESS ) {
211 /* deal with <draft-zeilenga-ldap-t-f> filters */
212 filter = op->ors_filterstr;
214 rs->sr_err = ldap_search_ext( lc->lc_ld, op->o_req_dn.bv_val,
215 op->ors_scope, filter.bv_val,
216 attrs, op->ors_attrsonly, ctrls, NULL,
217 tv.tv_sec ? &tv : NULL,
218 op->ors_slimit, &msgid );
220 if ( rs->sr_err != LDAP_SUCCESS ) {
221 switch ( rs->sr_err ) {
222 case LDAP_SERVER_DOWN:
225 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
231 /* reset by ldap_back_retry ... */
232 rs->sr_err = slap_map_api2result( rs );
235 rc = ldap_back_op_result( lc, op, rs, msgid, 0, LDAP_BACK_DONTSEND );
240 case LDAP_FILTER_ERROR:
241 if ( ldap_back_munge_filter( op, &filter ) ) {
245 /* invalid filters return success with no data */
246 rs->sr_err = LDAP_SUCCESS;
251 rs->sr_err = slap_map_api2result( rs );
257 /* We pull apart the ber result, stuff it into a slapd entry, and
258 * let send_search_entry stuff it back into ber format. Slow & ugly,
259 * but this is necessary for version matching, and for ACL processing.
262 for ( rc = 0; rc != -1; rc = ldap_result( lc->lc_ld, msgid, LDAP_MSG_ONE, &tv, &res ) )
264 /* check for abandon */
265 if ( op->o_abandon ) {
269 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
275 LDAP_BACK_TV_SET( &tv );
276 ldap_pvt_thread_yield();
278 /* check time limit */
279 if ( op->ors_tlimit != SLAP_NO_LIMIT
280 && slap_get_time() > stoptime )
282 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
283 rc = rs->sr_err = LDAP_TIMELIMIT_EXCEEDED;
289 /* don't retry any more */
294 if ( rc == LDAP_RES_SEARCH_ENTRY ) {
296 struct berval bdn = BER_BVNULL;
300 e = ldap_first_entry( lc->lc_ld, res );
301 rc = ldap_build_entry( op, e, &ent, &bdn );
302 if ( rc == LDAP_SUCCESS ) {
304 rs->sr_attrs = op->ors_attrs;
305 rs->sr_operational_attrs = NULL;
307 rs->sr_err = LDAP_SUCCESS;
308 rc = rs->sr_err = send_search_entry( op, rs );
309 if ( !BER_BVISNULL( &ent.e_name ) ) {
310 assert( ent.e_name.bv_val != bdn.bv_val );
311 op->o_tmpfree( ent.e_name.bv_val, op->o_tmpmemctx );
312 BER_BVZERO( &ent.e_name );
314 if ( !BER_BVISNULL( &ent.e_nname ) ) {
315 op->o_tmpfree( ent.e_nname.bv_val, op->o_tmpmemctx );
316 BER_BVZERO( &ent.e_nname );
321 if ( rc != LDAP_SUCCESS ) {
322 if ( rc == LDAP_UNAVAILABLE ) {
323 rc = rs->sr_err = LDAP_OTHER;
325 (void)ldap_back_cancel( lc, op, rs, msgid, LDAP_BACK_DONTSEND );
330 } else if ( rc == LDAP_RES_SEARCH_REFERENCE ) {
331 char **references = NULL;
334 rc = ldap_parse_reference( lc->lc_ld, res,
335 &references, &rs->sr_ctrls, 1 );
337 if ( rc != LDAP_SUCCESS ) {
341 /* FIXME: there MUST be at least one */
342 if ( references && references[ 0 ] && references[ 0 ][ 0 ] ) {
345 for ( cnt = 0; references[ cnt ]; cnt++ )
348 /* FIXME: there MUST be at least one */
349 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
352 for ( cnt = 0; references[ cnt ]; cnt++ ) {
353 ber_str2bv( references[ cnt ], 0, 0, &rs->sr_ref[ cnt ] );
355 BER_BVZERO( &rs->sr_ref[ cnt ] );
357 /* ignore return value by now */
358 ( void )send_search_reference( op, rs );
361 Debug( LDAP_DEBUG_ANY,
362 "%s ldap_back_search: "
363 "got SEARCH_REFERENCE "
364 "with no referrals\n",
365 op->o_log_prefix, 0, 0 );
370 ber_memvfree( (void **)references );
371 op->o_tmpfree( rs->sr_ref, op->o_tmpmemctx );
375 if ( rs->sr_ctrls ) {
376 ldap_controls_free( rs->sr_ctrls );
381 char **references = NULL, *err = NULL;
383 rc = ldap_parse_result( lc->lc_ld, res, &rs->sr_err,
385 &references, &rs->sr_ctrls, 1 );
386 if ( rc != LDAP_SUCCESS ) {
389 rs->sr_err = slap_map_api2result( rs );
395 if ( references && references[ 0 ] && references[ 0 ][ 0 ] ) {
398 if ( rs->sr_err != LDAP_REFERRAL ) {
400 Debug( LDAP_DEBUG_ANY,
401 "%s ldap_back_search: "
402 "got referrals with %d\n",
405 rs->sr_err = LDAP_REFERRAL;
408 for ( cnt = 0; references[ cnt ]; cnt++ )
411 rs->sr_ref = op->o_tmpalloc( ( cnt + 1 ) * sizeof( struct berval ),
414 for ( cnt = 0; references[ cnt ]; cnt++ ) {
416 ber_str2bv( references[ cnt ], 0, 1, &rs->sr_ref[ cnt ] );
418 BER_BVZERO( &rs->sr_ref[ cnt ] );
421 if ( match.bv_val != NULL ) {
423 match.bv_len = strlen( match.bv_val );
429 ber_memvfree( (void **)references );
437 if ( rc == -1 && dont_retry == 0 ) {
440 if ( ldap_back_retry( &lc, op, rs, LDAP_BACK_DONTSEND ) ) {
444 rs->sr_err = LDAP_SERVER_DOWN;
445 rs->sr_err = slap_map_api2result( rs );
450 * Rewrite the matched portion of the search base, if required
452 if ( !BER_BVISNULL( &match ) && !BER_BVISEMPTY( &match ) ) {
453 struct berval pmatch;
455 if ( dnPretty( NULL, &match, &pmatch, op->o_tmpmemctx ) == LDAP_SUCCESS ) {
456 rs->sr_matched = pmatch.bv_val;
457 LDAP_FREE( match.bv_val );
460 rs->sr_matched = match.bv_val;
464 if ( rs->sr_v2ref ) {
465 rs->sr_err = LDAP_REFERRAL;
469 if ( LDAP_BACK_QUARANTINE( li ) ) {
470 ldap_back_quarantine( op, rs, 1 );
473 if ( rc != SLAPD_ABANDON ) {
474 send_ldap_result( op, rs );
477 (void)ldap_back_proxy_authz_ctrl_free( op, &ctrls );
479 if ( rs->sr_ctrls ) {
480 ldap_controls_free( rs->sr_ctrls );
484 if ( rs->sr_matched != NULL && rs->sr_matched != save_matched ) {
485 if ( rs->sr_matched != match.bv_val ) {
486 ber_memfree_x( (char *)rs->sr_matched, op->o_tmpmemctx );
489 LDAP_FREE( match.bv_val );
491 rs->sr_matched = save_matched;
494 if ( !BER_BVISNULL( &filter ) && filter.bv_val != op->ors_filterstr.bv_val ) {
495 op->o_tmpfree( filter.bv_val, op->o_tmpmemctx );
500 LDAP_FREE( (char *)rs->sr_text );
506 ber_bvarray_free_x( rs->sr_ref, op->o_tmpmemctx );
515 ldap_back_release_conn( op, rs, lc );
529 BerElement ber = *e->lm_ber;
530 Attribute *attr, **attrp;
534 /* safe assumptions ... */
535 assert( ent != NULL );
536 BER_BVZERO( &ent->e_bv );
538 if ( ber_scanf( &ber, "{m{", bdn ) == LBER_ERROR ) {
539 return LDAP_DECODING_ERROR;
543 * Note: this may fail if the target host(s) schema differs
544 * from the one known to the meta, and a DN with unknown
545 * attributes is returned.
547 * FIXME: should we log anything, or delegate to dnNormalize?
549 /* Note: if the distinguished values or the naming attributes
550 * change, should we massage them as well?
552 if ( dnPrettyNormal( NULL, bdn, &ent->e_name, &ent->e_nname,
553 op->o_tmpmemctx ) != LDAP_SUCCESS )
555 return LDAP_INVALID_DN_SYNTAX;
558 attrp = &ent->e_attrs;
560 while ( ber_scanf( &ber, "{m", &a ) != LBER_ERROR ) {
562 slap_syntax_validate_func *validate;
563 slap_syntax_transform_func *pretty;
565 attr = (Attribute *)ch_malloc( sizeof( Attribute ) );
566 if ( attr == NULL ) {
572 if ( slap_bv2ad( &a, &attr->a_desc, &text )
575 if ( slap_bv2undef_ad( &a, &attr->a_desc, &text,
576 SLAP_AD_PROXIED ) != LDAP_SUCCESS )
578 Debug( LDAP_DEBUG_ANY,
579 "%s ldap_build_entry: "
580 "slap_bv2undef_ad(%s): %s\n",
581 op->o_log_prefix, a.bv_val, text );
587 /* no subschemaSubentry */
588 if ( attr->a_desc == slap_schema.si_ad_subschemaSubentry
589 || attr->a_desc == slap_schema.si_ad_entryDN )
593 * We eat target's subschemaSubentry because
594 * a search for this value is likely not
595 * to resolve to the appropriate backend;
596 * later, the local subschemaSubentry is
599 * We also eat entryDN because the frontend
600 * will reattach it without checking if already
603 ( void )ber_scanf( &ber, "x" /* [W] */ );
609 if ( ber_scanf( &ber, "[W]", &attr->a_vals ) == LBER_ERROR
610 || attr->a_vals == NULL )
613 * Note: attr->a_vals can be null when using
614 * values result filter
616 attr->a_vals = (struct berval *)&slap_dummy_bv;
620 for ( last = 0; !BER_BVISNULL( &attr->a_vals[ last ] ); last++ )
621 /* just count vals */ ;
624 validate = attr->a_desc->ad_type->sat_syntax->ssyn_validate;
625 pretty = attr->a_desc->ad_type->sat_syntax->ssyn_pretty;
627 if ( !validate && !pretty ) {
628 attr->a_nvals = NULL;
633 for ( i = 0; i < last; i++ ) {
638 rc = pretty( attr->a_desc->ad_type->sat_syntax,
639 &attr->a_vals[i], &pval, NULL );
642 rc = validate( attr->a_desc->ad_type->sat_syntax,
646 if ( rc != LDAP_SUCCESS ) {
647 /* check if, by chance, it's an undefined objectClass */
648 if ( attr->a_desc == slap_schema.si_ad_objectClass &&
649 oc_bvfind_undef( &attr->a_vals[i] ) != NULL )
651 ber_dupbv( &pval, &attr->a_vals[i] );
654 attr->a_nvals = NULL;
661 LBER_FREE( attr->a_vals[i].bv_val );
662 attr->a_vals[i] = pval;
666 if ( last && attr->a_desc->ad_type->sat_equality &&
667 attr->a_desc->ad_type->sat_equality->smr_normalize )
669 attr->a_nvals = ch_malloc( ( last + 1 )*sizeof( struct berval ) );
670 for ( i = 0; i < last; i++ ) {
674 * check that each value is valid per syntax
675 * and pretty if appropriate
677 rc = attr->a_desc->ad_type->sat_equality->smr_normalize(
678 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
679 attr->a_desc->ad_type->sat_syntax,
680 attr->a_desc->ad_type->sat_equality,
681 &attr->a_vals[i], &attr->a_nvals[i],
684 if ( rc != LDAP_SUCCESS ) {
685 BER_BVZERO( &attr->a_nvals[i] );
690 BER_BVZERO( &attr->a_nvals[i] );
693 attr->a_nvals = attr->a_vals;
696 attrp = &attr->a_next;
704 /* return 0 IFF we can retrieve the entry with ndn
711 AttributeDescription *at,
720 LDAPMessage *result = NULL,
722 char *attr[3], **attrp = NULL;
726 LDAPControl **ctrls = NULL;
730 /* Tell getconn this is a privileged op */
731 do_not_cache = op->o_do_not_cache;
732 op->o_do_not_cache = 1;
733 lc = ldap_back_getconn( op, &rs, LDAP_BACK_DONTSEND );
734 if ( !lc || !ldap_back_dobind( lc, op, &rs, LDAP_BACK_DONTSEND ) ) {
735 op->o_do_not_cache = do_not_cache;
738 op->o_do_not_cache = do_not_cache;
742 if ( oc && at != slap_schema.si_ad_objectClass ) {
743 attr[0] = slap_schema.si_ad_objectClass->ad_cname.bv_val;
744 attr[1] = at->ad_cname.bv_val;
748 attr[0] = at->ad_cname.bv_val;
756 filter = ch_malloc( STRLENOF( "(objectclass=)" )
757 + oc->soc_cname.bv_len + 1 );
758 ptr = lutil_strcopy( filter, "(objectclass=" );
759 ptr = lutil_strcopy( ptr, oc->soc_cname.bv_val );
765 rc = ldap_back_proxy_authz_ctrl( lc, op, &rs, &ctrls );
766 if ( rc != LDAP_SUCCESS ) {
771 rc = ldap_search_ext_s( lc->lc_ld, ndn->bv_val, LDAP_SCOPE_BASE, filter,
772 attrp, 0, ctrls, NULL,
773 NULL, LDAP_NO_LIMIT, &result );
774 if ( rc != LDAP_SUCCESS ) {
775 if ( rc == LDAP_SERVER_DOWN && do_retry ) {
777 if ( ldap_back_retry( &lc, op, &rs, LDAP_BACK_DONTSEND ) ) {
784 e = ldap_first_entry( lc->lc_ld, result );
786 /* the entry exists, but it doesn't match the filter? */
790 *ent = ch_calloc( 1, sizeof( Entry ) );
791 if ( *ent == NULL ) {
796 rc = ldap_build_entry( op, e, *ent, &bdn );
798 if ( rc != LDAP_SUCCESS ) {
804 (void)ldap_back_proxy_authz_ctrl_free( op, &ctrls );
807 ldap_msgfree( result );
815 ldap_back_release_conn( op, &rs, lc );