2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2005 The OpenLDAP Foundation.
5 * Portions Copyright 2001-2003 Pierangelo Masarati.
6 * Portions Copyright 1999-2003 Howard Chu.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by the Howard Chu for inclusion
19 * in OpenLDAP Software and subsequently enhanced by Pierangelo
27 #include <ac/socket.h>
28 #include <ac/string.h>
32 #include "../back-ldap/back-ldap.h"
33 #include "back-meta.h"
34 #undef ldap_debug /* silence a warning in ldap-int.h */
36 #include "../../../libraries/libldap/ldap-int.h"
48 meta_back_search( Operation *op, SlapReply *rs )
50 struct metainfo *li = ( struct metainfo * )op->o_bd->be_private;
52 struct metasingleconn *lsc;
53 struct timeval tv = { 0, 0 };
54 LDAPMessage *res = NULL, *e;
55 int rc = 0, *msgid, sres = LDAP_SUCCESS;
57 struct berval match = BER_BVNULL, mmatch = BER_BVNULL;
58 BerVarray v2refs = NULL;
60 int i, last = 0, candidates = 0, initial_candidates = 0,
68 * controls are set in ldap_back_dobind()
70 * FIXME: in case of values return filter, we might want
71 * to map attrs and maybe rewrite value
73 lc = meta_back_getconn( op, rs, META_OP_ALLOW_MULTIPLE,
74 &op->o_req_ndn, NULL );
76 send_ldap_result( op, rs );
80 if ( !meta_back_dobind( lc, op ) ) {
81 rs->sr_err = LDAP_UNAVAILABLE;
82 send_ldap_result( op, rs );
87 * Array of message id of each target
89 msgid = ch_calloc( sizeof( int ), li->ntargets );
90 if ( msgid == NULL ) {
91 rs->sr_err = LDAP_OTHER;
92 send_ldap_result( op, rs );
102 for ( i = 0, lsc = lc->mc_conns; !META_LAST( lsc ); ++i, ++lsc ) {
103 struct berval realbase = op->o_req_dn;
104 int realscope = op->ors_scope;
105 ber_len_t suffixlen = 0;
106 struct berval mbase = BER_BVNULL;
107 struct berval mfilter = BER_BVNULL;
108 char **mapped_attrs = NULL;
110 if ( lsc->msc_candidate != META_CANDIDATE ) {
115 /* should we check return values? */
116 if ( op->ors_deref != -1 ) {
117 ldap_set_option( lsc->msc_ld, LDAP_OPT_DEREF,
118 ( void * )&op->ors_deref);
120 if ( op->ors_tlimit != SLAP_NO_LIMIT ) {
121 ldap_set_option( lsc->msc_ld, LDAP_OPT_TIMELIMIT,
122 ( void * )&op->ors_tlimit);
124 if ( op->ors_slimit != SLAP_NO_LIMIT ) {
125 ldap_set_option( lsc->msc_ld, LDAP_OPT_SIZELIMIT,
126 ( void * )&op->ors_slimit);
129 dc.rwmap = &li->targets[ i ]->mt_rwmap;
132 * modifies the base according to the scope, if required
134 suffixlen = li->targets[ i ]->mt_nsuffix.bv_len;
135 if ( suffixlen > op->o_req_ndn.bv_len ) {
136 switch ( op->ors_scope ) {
137 case LDAP_SCOPE_SUBTREE:
139 * make the target suffix the new base
140 * FIXME: this is very forgiving, because
141 * illegal bases may be turned into
142 * the suffix of the target.
144 if ( dnIsSuffix( &li->targets[ i ]->mt_nsuffix,
146 realbase = li->targets[ i ]->mt_nsuffix;
151 * this target is no longer candidate
158 case LDAP_SCOPE_ONELEVEL:
160 struct berval rdn = li->targets[ i ]->mt_nsuffix;
161 rdn.bv_len -= op->o_req_ndn.bv_len + STRLENOF( "," );
162 if ( dnIsOneLevelRDN( &rdn )
163 && dnIsSuffix( &li->targets[ i ]->mt_nsuffix, &op->o_req_ndn ) )
166 * if there is exactly one level,
167 * make the target suffix the new
168 * base, and make scope "base"
170 realbase = li->targets[ i ]->mt_nsuffix;
171 realscope = LDAP_SCOPE_BASE;
174 } /* else continue with the next case */
177 case LDAP_SCOPE_BASE:
179 * this target is no longer candidate
190 * Rewrite the search base, if required
192 dc.ctx = "searchBase";
193 switch ( ldap_back_dn_massage( &dc, &realbase, &mbase ) ) {
197 case REWRITE_REGEXEC_UNWILLING:
198 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
199 rs->sr_text = "Operation not allowed";
200 send_ldap_result( op, rs );
204 case REWRITE_REGEXEC_ERR:
206 rs->sr_err = LDAP_OTHER;
207 rs->sr_text = "Rewrite error";
208 send_ldap_result( op, rs );
214 * this target is no longer candidate
223 rc = ldap_back_filter_map_rewrite( &dc,
225 &mfilter, BACKLDAP_MAP );
231 case LDAP_COMPARE_FALSE:
236 * this target is no longer candidate
243 * Maps required attributes
245 rc = ldap_back_map_attrs( &li->targets[ i ]->mt_rwmap.rwm_at,
246 op->ors_attrs, BACKLDAP_MAP,
248 if ( rc != LDAP_SUCCESS ) {
250 * this target is no longer candidate
259 rc = ldap_search_ext( lsc->msc_ld,
260 mbase.bv_val, realscope, mfilter.bv_val,
261 mapped_attrs, op->ors_attrsonly,
263 NULL, op->ors_slimit, &msgid[ i ] );
264 if ( mapped_attrs ) {
265 free( mapped_attrs );
268 if ( mfilter.bv_val != op->ors_filterstr.bv_val ) {
269 free( mfilter.bv_val );
270 BER_BVZERO( &mfilter );
272 if ( mbase.bv_val != realbase.bv_val ) {
273 free( mbase.bv_val );
274 BER_BVZERO( &mbase );
277 if ( rc != LDAP_SUCCESS ) {
286 initial_candidates = candidates;
288 /* We pull apart the ber result, stuff it into a slapd entry, and
289 * let send_search_entry stuff it back into ber format. Slow & ugly,
290 * but this is necessary for version matching, and for ACL processing.
295 * In case there are no candidates, no cycle takes place...
297 * FIXME: we might use a queue, to balance the load
298 * among the candidates
300 for ( rc = 0; candidates > 0; ) {
303 /* check for abandon */
306 for ( i = 0, lsc = lc->mc_conns; !META_LAST( lsc ); lsc++, i++ ) {
307 if ( msgid[ i ] == -1 ) {
312 ldap_abandon_ext( lsc->msc_ld, msgid[ i ], NULL, NULL );
317 if ( op->ors_slimit > 0
318 && rs->sr_nentries == op->ors_slimit ) {
319 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
320 rs->sr_v2ref = v2refs;
321 send_ldap_result( op, rs );
326 * FIXME: handle time limit as well?
327 * Note that target servers are likely
328 * to handle it, so at some time we'll
329 * get a LDAP_TIMELIMIT_EXCEEDED from
332 rc = ldap_result( lsc->msc_ld, msgid[ i ],
336 /* timeout exceeded */
338 /* FIXME: res should not need to be freed */
339 assert( res == NULL );
343 } else if ( rc == -1 ) {
345 /* something REALLY bad happened! */
346 ( void )meta_clear_unused_candidates( li,
348 rs->sr_err = LDAP_OTHER;
349 rs->sr_v2ref = v2refs;
350 send_ldap_result( op, rs );
352 /* anything else needs be done? */
354 /* FIXME: res should not need to be freed */
355 assert( res == NULL );
359 } else if ( rc == LDAP_RES_SEARCH_ENTRY ) {
360 e = ldap_first_entry( lsc->msc_ld, res );
361 meta_send_entry( op, rs, lc, i, e );
367 * If scope is BASE, we need to jump out
368 * as soon as one entry is found; if
369 * the target pool is properly crafted,
370 * this should correspond to the sole
371 * entry that has the base DN
373 if ( op->ors_scope == LDAP_SCOPE_BASE
374 && rs->sr_nentries > 0 ) {
382 } else if ( rc == LDAP_RES_SEARCH_REFERENCE ) {
383 char **references = NULL;
386 rc = ldap_parse_reference( lsc->msc_ld, res,
387 &references, &rs->sr_ctrls, 1 );
390 if ( rc != LDAP_SUCCESS ) {
394 if ( references == NULL ) {
398 #ifdef ENABLE_REWRITE
399 dc.ctx = "referralDN";
400 #else /* ! ENABLE_REWRITE */
403 #endif /* ! ENABLE_REWRITE */
404 for ( cnt = 0; references[ cnt ]; cnt++ )
407 rs->sr_ref = ch_calloc( sizeof( struct berval ), cnt + 1 );
409 for ( cnt = 0; references[ cnt ]; cnt++ ) {
410 ber_str2bv( references[ cnt ], 0, 1, &rs->sr_ref[ cnt ] );
412 BER_BVZERO( &rs->sr_ref[ cnt ] );
414 ( void )ldap_back_referral_result_rewrite( &dc, rs->sr_ref );
416 if ( rs->sr_ref != NULL && !BER_BVISNULL( &rs->sr_ref[ 0 ] ) ) {
417 /* ignore return value by now */
418 ( void )send_search_reference( op, rs );
420 ber_bvarray_free( rs->sr_ref );
426 ldap_value_free( references );
429 if ( rs->sr_ctrls ) {
430 ldap_controls_free( rs->sr_ctrls );
435 if ( ldap_parse_result( lsc->msc_ld, res,
437 NULL, NULL, NULL, NULL, 1 ) )
444 sres = slap_map_api2result( rs );
448 ldap_get_option( lsc->msc_ld,
449 LDAP_OPT_ERROR_STRING, &err );
450 if ( match.bv_val != NULL ) {
451 free( match.bv_val );
453 ldap_get_option( lsc->msc_ld,
454 LDAP_OPT_MATCHED_DN, &match.bv_val );
456 Debug( LDAP_DEBUG_ANY,
457 "=>meta_back_search [%d] "
458 "match=\"%s\" err=\"%s\"\n",
459 i, match.bv_val, err );
465 * When no candidates are left,
466 * the outer cycle finishes
479 tv.tv_usec = 100000; /* 0.1 s */
480 ldap_pvt_thread_yield();
490 * FIXME: need a strategy to handle errors
492 rc = meta_back_op_result( lc, op, rs );
497 * Rewrite the matched portion of the search base, if required
499 * FIXME: only the last one gets caught!
501 if ( candidate_match == initial_candidates
502 && match.bv_val != NULL && *match.bv_val ) {
503 dc.ctx = "matchedDN";
504 dc.rwmap = &li->targets[ last ]->mt_rwmap;
506 if ( ldap_back_dn_massage( &dc, &match, &mmatch ) ) {
507 mmatch.bv_val = NULL;
512 * In case we returned at least one entry, we return LDAP_SUCCESS
513 * otherwise, the latter error code we got
515 * FIXME: we should handle error codes and return the more
516 * important/reasonable
518 if ( is_scope == 0 ) {
519 sres = LDAP_NO_SUCH_OBJECT;
522 if ( sres == LDAP_SUCCESS && v2refs ) {
523 sres = LDAP_REFERRAL;
526 rs->sr_matched = mmatch.bv_val;
527 rs->sr_v2ref = v2refs;
528 send_ldap_result( op, rs );
529 rs->sr_matched = NULL;
534 if ( match.bv_val ) {
535 if ( mmatch.bv_val != match.bv_val ) {
536 free( mmatch.bv_val );
538 free( match.bv_val );
561 struct metainfo *li = ( struct metainfo * )op->o_bd->be_private;
562 struct berval a, mapped;
564 BerElement ber = *e->lm_ber;
565 Attribute *attr, **attrp;
566 struct berval *bv, bdn;
570 if ( ber_scanf( &ber, "{m{", &bdn ) == LBER_ERROR ) {
571 return LDAP_DECODING_ERROR;
575 * Rewrite the dn of the result, if needed
577 dc.rwmap = &li->targets[ target ]->mt_rwmap;
578 dc.conn = op->o_conn;
580 dc.ctx = "searchResult";
582 rs->sr_err = ldap_back_dn_massage( &dc, &bdn, &ent.e_name );
583 if ( rs->sr_err != LDAP_SUCCESS) {
588 * Note: this may fail if the target host(s) schema differs
589 * from the one known to the meta, and a DN with unknown
590 * attributes is returned.
592 * FIXME: should we log anything, or delegate to dnNormalize?
594 if ( dnNormalize( 0, NULL, NULL, &ent.e_name, &ent.e_nname,
595 op->o_tmpmemctx ) != LDAP_SUCCESS )
597 return LDAP_INVALID_DN_SYNTAX;
603 if ( li->cache.ttl != META_DNCACHE_DISABLED ) {
604 ( void )meta_dncache_update_entry( &li->cache,
605 &ent.e_nname, target );
608 attrp = &ent.e_attrs;
610 dc.ctx = "searchAttrDN";
611 while ( ber_scanf( &ber, "{m", &a ) != LBER_ERROR ) {
614 ldap_back_map( &li->targets[ target ]->mt_rwmap.rwm_at,
615 &a, &mapped, BACKLDAP_REMAP );
616 if ( mapped.bv_val == NULL || mapped.bv_val[0] == '\0' ) {
619 attr = ( Attribute * )ch_malloc( sizeof( Attribute ) );
620 if ( attr == NULL ) {
626 if ( slap_bv2ad( &mapped, &attr->a_desc, &text )
628 if ( slap_bv2undef_ad( &mapped, &attr->a_desc, &text )
630 Debug( LDAP_DEBUG_ANY,
631 "slap_bv2undef_ad(%s): "
632 "%s\n%s", mapped.bv_val, text, "" );
638 /* no subschemaSubentry */
639 if ( attr->a_desc == slap_schema.si_ad_subschemaSubentry ) {
642 * We eat target's subschemaSubentry because
643 * a search for this value is likely not
644 * to resolve to the appropriate backend;
645 * later, the local subschemaSubentry is
648 ( void )ber_scanf( &ber, "x" /* [W] */ );
654 if ( ber_scanf( &ber, "[W]", &attr->a_vals ) == LBER_ERROR
655 || attr->a_vals == NULL ) {
656 attr->a_vals = (struct berval *)&slap_dummy_bv;
658 } else if ( attr->a_desc == slap_schema.si_ad_objectClass
659 || attr->a_desc == slap_schema.si_ad_structuralObjectClass ) {
661 for ( last = 0; attr->a_vals[ last ].bv_val; ++last );
663 for ( bv = attr->a_vals; bv->bv_val; bv++ ) {
664 ldap_back_map( &li->targets[ target ]->mt_rwmap.rwm_oc,
665 bv, &mapped, BACKLDAP_REMAP );
666 if ( mapped.bv_val == NULL || mapped.bv_val[0] == '\0') {
672 *bv = attr->a_vals[ last ];
673 attr->a_vals[ last ].bv_val = NULL;
676 } else if ( mapped.bv_val != bv->bv_val ) {
678 ber_dupbv( bv, &mapped );
682 * It is necessary to try to rewrite attributes with
683 * dn syntax because they might be used in ACLs as
684 * members of groups; since ACLs are applied to the
685 * rewritten stuff, no dn-based subecj clause could
686 * be used at the ldap backend side (see
687 * http://www.OpenLDAP.org/faq/data/cache/452.html)
688 * The problem can be overcome by moving the dn-based
689 * ACLs to the target directory server, and letting
690 * everything pass thru the ldap backend.
692 } else if ( attr->a_desc->ad_type->sat_syntax ==
693 slap_schema.si_syn_distinguishedName ) {
694 ldap_dnattr_result_rewrite( &dc, attr->a_vals );
696 } else if ( attr->a_desc == slap_schema.si_ad_ref ) {
697 ldap_back_referral_result_rewrite( &dc, attr->a_vals );
700 if ( last && attr->a_desc->ad_type->sat_equality &&
701 attr->a_desc->ad_type->sat_equality->smr_normalize ) {
704 attr->a_nvals = ch_malloc((last + 1)*sizeof(struct berval));
705 for ( i = 0; i<last; i++ ) {
706 attr->a_desc->ad_type->sat_equality->smr_normalize(
707 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
708 attr->a_desc->ad_type->sat_syntax,
709 attr->a_desc->ad_type->sat_equality,
710 &attr->a_vals[i], &attr->a_nvals[i],
713 attr->a_nvals[i].bv_val = NULL;
714 attr->a_nvals[i].bv_len = 0;
716 attr->a_nvals = attr->a_vals;
720 attrp = &attr->a_next;
723 rs->sr_attrs = op->ors_attrs;
725 send_search_entry( op, rs );
728 while ( ent.e_attrs ) {
730 ent.e_attrs = attr->a_next;
731 if ( attr->a_vals != &slap_dummy_bv ) {
732 ber_bvarray_free( attr->a_vals );
737 if ( ent.e_dn && ent.e_dn != bdn.bv_val ) {