1 /* search.c - ldap backend search function */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 /* This is an altered version */
9 * Copyright 1999, Howard Chu, All rights reserved. <hyc@highlandsun.com>
11 * Permission is granted to anyone to use this software for any purpose
12 * on any computer system, and to alter it and redistribute it, subject
13 * to the following restrictions:
15 * 1. The author is not responsible for the consequences of use of this
16 * software, no matter how awful, even if they arise from flaws in it.
18 * 2. The origin of this software must not be misrepresented, either by
19 * explicit claim or by omission. Since few users ever read sources,
20 * credits should appear in the documentation.
22 * 3. Altered versions must be plainly marked as such, and must not be
23 * misrepresented as being the original software. Since few users
24 * ever read sources, credits should appear in the documentation.
26 * 4. This notice may not be removed or altered.
30 * Copyright 2000, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
32 * This software is being modified by Pierangelo Masarati.
33 * The previously reported conditions apply to the modified code as well.
34 * Changes in the original code are highlighted where required.
35 * Credits for the original code go to the author, Howard Chu.
42 #include <ac/socket.h>
43 #include <ac/string.h>
47 #include "back-ldap.h"
48 #undef ldap_debug /* silence a warning in ldap-int.h */
49 #include "../../../libraries/libldap/ldap-int.h"
54 ldap_build_entry( Operation *op, LDAPMessage *e, Entry *ent,
55 struct berval *bdn, int flags );
56 #define LDAP_BUILD_ENTRY_PRIVATE 0x01
57 #define LDAP_BUILD_ENTRY_NORMALIZE 0x02
59 static struct berval dummy = { 0, NULL };
66 struct ldapinfo *li = (struct ldapinfo *) op->o_bd->be_private;
70 int count, rc = 0, msgid;
72 char **mapped_attrs = NULL;
74 struct berval mfilter = { 0, NULL };
75 struct slap_limits_set *limit = NULL;
78 lc = ldap_back_getconn(op, rs);
84 * FIXME: in case of values return filter, we might want
85 * to map attrs and maybe rewrite value
87 if ( !ldap_back_dobind( lc, op, rs ) ) {
91 /* if not root, get appropriate limits */
92 if ( be_isroot( op->o_bd, &op->o_ndn ) ) {
95 ( void ) get_limits( op->o_bd, &op->o_ndn, &limit );
98 /* if no time limit requested, rely on remote server limits */
99 /* if requested limit higher than hard limit, abort */
100 if ( !isroot && op->oq_search.rs_tlimit > limit->lms_t_hard ) {
101 /* no hard limit means use soft instead */
102 if ( limit->lms_t_hard == 0
103 && limit->lms_t_soft > -1
104 && op->oq_search.rs_tlimit > limit->lms_t_soft ) {
105 op->oq_search.rs_tlimit = limit->lms_t_soft;
107 /* positive hard limit means abort */
108 } else if ( limit->lms_t_hard > 0 ) {
109 rs->sr_err = LDAP_ADMINLIMIT_EXCEEDED;
110 send_ldap_result( op, rs );
115 /* negative hard limit means no limit */
118 /* if no size limit requested, rely on remote server limits */
119 /* if requested limit higher than hard limit, abort */
120 if ( !isroot && op->oq_search.rs_slimit > limit->lms_s_hard ) {
121 /* no hard limit means use soft instead */
122 if ( limit->lms_s_hard == 0
123 && limit->lms_s_soft > -1
124 && op->oq_search.rs_slimit > limit->lms_s_soft ) {
125 op->oq_search.rs_slimit = limit->lms_s_soft;
127 /* positive hard limit means abort */
128 } else if ( limit->lms_s_hard > 0 ) {
129 rs->sr_err = LDAP_ADMINLIMIT_EXCEEDED;
130 send_ldap_result( op, rs );
135 /* negative hard limit means no limit */
138 /* should we check return values? */
139 if (op->oq_search.rs_deref != -1)
140 ldap_set_option( lc->ld, LDAP_OPT_DEREF, (void *)&op->oq_search.rs_deref);
141 if (op->oq_search.rs_tlimit != -1) {
142 tv.tv_sec = op->oq_search.rs_tlimit;
149 * Rewrite the search base, if required
151 #ifdef ENABLE_REWRITE
152 switch ( rewrite_session( li->rwinfo, "searchBase",
153 op->o_req_dn.bv_val, op->o_conn, &mbase.bv_val ) ) {
154 case REWRITE_REGEXEC_OK:
155 if ( mbase.bv_val == NULL ) {
156 mbase = op->o_req_dn;
158 mbase.bv_len = strlen( mbase.bv_val );
161 LDAP_LOG( BACK_LDAP, DETAIL1,
162 "[rw] searchBase: \"%s\" -> \"%s\"\n",
163 op->o_req_dn.bv_val, mbase.bv_val, 0 );
164 #else /* !NEW_LOGGING */
165 Debug( LDAP_DEBUG_ARGS, "rw> searchBase: \"%s\" -> \"%s\"\n%s",
166 op->o_req_dn.bv_val, mbase.bv_val, "" );
167 #endif /* !NEW_LOGGING */
170 case REWRITE_REGEXEC_UNWILLING:
171 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
172 "Operation not allowed" );
176 case REWRITE_REGEXEC_ERR:
177 send_ldap_error( op, rs, LDAP_OTHER,
183 #else /* !ENABLE_REWRITE */
184 ldap_back_dn_massage( li, &op->o_req_dn, &mbase, 0, 1 );
185 #endif /* !ENABLE_REWRITE */
187 #ifdef ENABLE_REWRITE
188 rc = ldap_back_filter_map_rewrite_( li->rwinfo, op->o_conn,
189 &li->at_map, &li->oc_map, op->oq_search.rs_filter, &mfilter,
191 #else /* ! ENABLE_REWRITE */
192 rc = ldap_back_filter_map_rewrite_( &li->at_map, &li->oc_map,
193 op->oq_search.rs_filter, &mfilter, BACKLDAP_MAP );
194 #endif /* ! ENABLE_REWRITE */
201 mapped_attrs = ldap_back_map_attrs(&li->at_map, op->oq_search.rs_attrs, BACKLDAP_MAP);
202 if ( mapped_attrs == NULL && op->oq_search.rs_attrs) {
203 for (count=0; op->oq_search.rs_attrs[count].an_name.bv_val; count++);
204 mapped_attrs = ch_malloc( (count+1) * sizeof(char *));
205 for (count=0; op->oq_search.rs_attrs[count].an_name.bv_val; count++) {
206 mapped_attrs[count] = op->oq_search.rs_attrs[count].an_name.bv_val;
208 mapped_attrs[count] = NULL;
211 rs->sr_err = ldap_search_ext(lc->ld, mbase.bv_val, op->oq_search.rs_scope, mfilter.bv_val,
212 mapped_attrs, op->oq_search.rs_attrsonly, op->o_ctrls, NULL, tv.tv_sec ? &tv
213 : NULL, op->oq_search.rs_slimit, &msgid);
214 if ( rs->sr_err != LDAP_SUCCESS ) {
216 rc = ldap_back_op_result(lc, op, rs, msgid, 0);
220 /* We pull apart the ber result, stuff it into a slapd entry, and
221 * let send_search_entry stuff it back into ber format. Slow & ugly,
222 * but this is necessary for version matching, and for ACL processing.
225 for ( rc=0; rc != -1; rc = ldap_result(lc->ld, msgid, 0, &tv, &res))
227 /* check for abandon */
229 ldap_abandon(lc->ld, msgid);
237 ldap_pvt_thread_yield();
239 } else if (rc == LDAP_RES_SEARCH_ENTRY) {
242 e = ldap_first_entry(lc->ld,res);
243 if ( ldap_build_entry(op, e, &ent, &bdn,
244 LDAP_BUILD_ENTRY_PRIVATE) == LDAP_SUCCESS ) {
246 rs->sr_attrs = op->oq_search.rs_attrs;
247 send_search_entry( op, rs );
248 while (ent.e_attrs) {
253 ent.e_attrs = a->a_next;
256 if (a->a_vals != &dummy)
257 ber_bvarray_free(a->a_vals);
259 ber_bvarray_free(a->a_nvals);
263 if ( ent.e_dn && ( ent.e_dn != bdn.bv_val ) )
270 } else if ( rc == LDAP_RES_SEARCH_REFERENCE ) {
271 char **references = NULL;
274 rc = ldap_parse_reference( lc->ld, res,
275 &references, &rs->sr_ctrls, 1 );
277 if ( rc != LDAP_SUCCESS ) {
281 if ( references == NULL ) {
285 for ( cnt = 0; references[ cnt ]; cnt++ )
288 rs->sr_ref = ch_calloc( cnt + 1, sizeof( struct berval ) );
290 for ( cnt = 0; references[ cnt ]; cnt++ ) {
291 rs->sr_ref[ cnt ].bv_val = references[ cnt ];
292 rs->sr_ref[ cnt ].bv_len = strlen( references[ cnt ] );
295 /* ignore return value by now */
296 ( void )send_search_reference( op, rs );
300 ldap_value_free( references );
301 ch_free( rs->sr_ref );
305 if ( rs->sr_ctrls ) {
306 ldap_controls_free( rs->sr_ctrls );
311 rc = ldap_parse_result(lc->ld, res, &rs->sr_err, &match,
312 (char **)&rs->sr_text, NULL, NULL, 1);
313 if (rc != LDAP_SUCCESS ) rs->sr_err = rc;
314 rs->sr_err = ldap_back_map_result(rs);
323 #ifdef ENABLE_REWRITE
325 * Rewrite the matched portion of the search base, if required
327 if ( match != NULL ) {
328 switch ( rewrite_session( li->rwinfo, "matchedDn",
329 match, op->o_conn, (char **)&rs->sr_matched ) ) {
330 case REWRITE_REGEXEC_OK:
331 if ( rs->sr_matched == NULL ) {
332 rs->sr_matched = ( char * )match;
335 LDAP_LOG( BACK_LDAP, DETAIL1,
336 "[rw] matchedDn:" " \"%s\" -> \"%s\"\n", match, rs->sr_matched, 0 );
337 #else /* !NEW_LOGGING */
338 Debug( LDAP_DEBUG_ARGS, "rw> matchedDn:"
339 " \"%s\" -> \"%s\"\n%s",
340 match, rs->sr_matched, "" );
341 #endif /* !NEW_LOGGING */
344 case REWRITE_REGEXEC_UNWILLING:
346 case REWRITE_REGEXEC_ERR:
347 /* FIXME: no error, but no matched ... */
348 rs->sr_matched = NULL;
352 #else /* !ENABLE_REWRITE */
353 if ( match != NULL ) {
354 struct berval dn, mdn;
356 ber_str2bv(match, 0, 0, &dn);
357 ldap_back_dn_massage(li, &dn, &mdn, 0, 0);
358 rs->sr_matched = mdn.bv_val;
360 #endif /* !ENABLE_REWRITE */
361 if ( rs->sr_v2ref ) {
362 rs->sr_err = LDAP_REFERRAL;
364 send_ldap_result( op, rs );
368 if ( rs->sr_matched != match ) {
369 free( (char *)rs->sr_matched );
371 rs->sr_matched = NULL;
375 LDAP_FREE( (char *)rs->sr_text );
378 if ( mapped_attrs ) {
379 ch_free( mapped_attrs );
381 if ( mfilter.bv_val != op->oq_search.rs_filterstr.bv_val ) {
382 ch_free( mfilter.bv_val );
384 if ( mbase.bv_val != op->o_req_dn.bv_val ) {
385 free( mbase.bv_val );
400 struct ldapinfo *li = (struct ldapinfo *) op->o_bd->be_private;
401 struct berval a, mapped;
402 BerElement ber = *e->lm_ber;
403 Attribute *attr, **attrp;
407 int private = flags & LDAP_BUILD_ENTRY_PRIVATE;
408 int normalize = flags & LDAP_BUILD_ENTRY_NORMALIZE;
410 /* safe assumptions ... */
412 ent->e_bv.bv_val = NULL;
414 if ( ber_scanf( &ber, "{m{", bdn ) == LBER_ERROR ) {
415 return LDAP_DECODING_ERROR;
417 #ifdef ENABLE_REWRITE
420 * Rewrite the dn of the result, if needed
422 switch ( rewrite_session( li->rwinfo, "searchResult",
423 bdn->bv_val, op->o_conn,
424 &ent->e_name.bv_val ) ) {
425 case REWRITE_REGEXEC_OK:
426 if ( ent->e_name.bv_val == NULL ) {
430 LDAP_LOG( BACK_LDAP, DETAIL1,
431 "[rw] searchResult: \"%s\"" " -> \"%s\"\n",
432 bdn->bv_val, ent->e_dn, 0 );
433 #else /* !NEW_LOGGING */
434 Debug( LDAP_DEBUG_ARGS, "rw> searchResult: \"%s\""
435 " -> \"%s\"\n%s", bdn->bv_val, ent->e_dn, "" );
436 #endif /* !NEW_LOGGING */
437 ent->e_name.bv_len = strlen( ent->e_name.bv_val );
441 case REWRITE_REGEXEC_ERR:
442 case REWRITE_REGEXEC_UNWILLING:
445 #else /* !ENABLE_REWRITE */
446 ldap_back_dn_massage( li, bdn, &ent->e_name, 0, 0 );
447 #endif /* !ENABLE_REWRITE */
450 * Note: this may fail if the target host(s) schema differs
451 * from the one known to the meta, and a DN with unknown
452 * attributes is returned.
454 * FIXME: should we log anything, or delegate to dnNormalize2?
456 if ( dnNormalize2( NULL, &ent->e_name, &ent->e_nname ) != LDAP_SUCCESS ) {
457 return LDAP_INVALID_DN_SYNTAX;
463 attrp = &ent->e_attrs;
465 while ( ber_scanf( &ber, "{m", &a ) != LBER_ERROR ) {
466 ldap_back_map(&li->at_map, &a, &mapped, BACKLDAP_REMAP);
467 if (mapped.bv_val == NULL || mapped.bv_val[0] == '\0')
469 attr = (Attribute *)ch_malloc( sizeof(Attribute) );
475 if (slap_bv2ad(&mapped, &attr->a_desc, &text) != LDAP_SUCCESS) {
476 if (slap_bv2undef_ad(&mapped, &attr->a_desc, &text)
479 LDAP_LOG( BACK_LDAP, DETAIL1,
480 "slap_bv2undef_ad(%s): %s\n", mapped.bv_val, text, 0 );
481 #else /* !NEW_LOGGING */
482 Debug( LDAP_DEBUG_ANY,
483 "slap_bv2undef_ad(%s): "
484 "%s\n%s", mapped.bv_val, text, "" );
485 #endif /* !NEW_LOGGING */
491 /* no subschemaSubentry */
492 if ( attr->a_desc == slap_schema.si_ad_subschemaSubentry ) {
495 * We eat target's subschemaSubentry because
496 * a search for this value is likely not
497 * to resolve to the appropriate backend;
498 * later, the local subschemaSubentry is
501 ( void )ber_scanf( &ber, "x" /* [W] */ );
507 if ( ber_scanf( &ber, "[W]", &attr->a_vals ) == LBER_ERROR
508 || attr->a_vals == NULL ) {
510 * Note: attr->a_vals can be null when using
511 * values result filter
514 attr->a_vals = &dummy;
516 attr->a_vals = ch_malloc(sizeof(struct berval));
517 attr->a_vals->bv_val = NULL;
518 attr->a_vals->bv_len = 0;
522 for ( last = 0; attr->a_vals[last].bv_val; last++ );
526 } else if ( attr->a_desc == slap_schema.si_ad_objectClass
527 || attr->a_desc == slap_schema.si_ad_structuralObjectClass ) {
528 for ( bv = attr->a_vals; bv->bv_val; bv++ ) {
529 ldap_back_map(&li->oc_map, bv, &mapped,
531 if (mapped.bv_val == NULL || mapped.bv_val[0] == '\0') {
532 LBER_FREE(bv->bv_val);
536 *bv = attr->a_vals[last];
537 attr->a_vals[last].bv_val = NULL;
540 } else if ( mapped.bv_val != bv->bv_val ) {
542 * FIXME: after LBER_FREEing
543 * the value is replaced by
546 LBER_FREE(bv->bv_val);
547 ber_dupbv( bv, &mapped );
552 * It is necessary to try to rewrite attributes with
553 * dn syntax because they might be used in ACLs as
554 * members of groups; since ACLs are applied to the
555 * rewritten stuff, no dn-based subject clause could
556 * be used at the ldap backend side (see
557 * http://www.OpenLDAP.org/faq/data/cache/452.html)
558 * The problem can be overcome by moving the dn-based
559 * ACLs to the target directory server, and letting
560 * everything pass thru the ldap backend.
562 } else if ( strcmp( attr->a_desc->ad_type->sat_syntax->ssyn_oid,
563 SLAPD_DN_SYNTAX ) == 0 ) {
564 for ( bv = attr->a_vals; bv->bv_val; bv++ ) {
565 struct berval newval;
567 #ifdef ENABLE_REWRITE
568 switch ( rewrite_session( li->rwinfo,
573 case REWRITE_REGEXEC_OK:
575 if ( newval.bv_val == NULL ) {
578 newval.bv_len = strlen( newval.bv_val );
580 LDAP_LOG( BACK_LDAP, DETAIL1,
581 "[rw] searchResult on attr=%s: \"%s\" -> \"%s\"\n",
582 attr->a_desc->ad_type->sat_cname.bv_val,
583 bv->bv_val, newval.bv_val );
584 #else /* !NEW_LOGGING */
585 Debug( LDAP_DEBUG_ARGS,
586 "rw> searchResult on attr=%s: \"%s\" -> \"%s\"\n",
587 attr->a_desc->ad_type->sat_cname.bv_val,
588 bv->bv_val, newval.bv_val );
589 #endif /* !NEW_LOGGING */
594 case REWRITE_REGEXEC_UNWILLING:
595 LBER_FREE(bv->bv_val);
599 *bv = attr->a_vals[last];
600 attr->a_vals[last].bv_val = NULL;
604 case REWRITE_REGEXEC_ERR:
606 * FIXME: better give up,
608 * or leave it untouched?
612 #else /* !ENABLE_REWRITE */
613 ldap_back_dn_massage( li, bv, &newval, 0, 0 );
614 if ( bv->bv_val != newval.bv_val ) {
615 LBER_FREE( bv->bv_val );
618 #endif /* !ENABLE_REWRITE */
625 if ( last && attr->a_desc->ad_type->sat_equality &&
626 attr->a_desc->ad_type->sat_equality->smr_normalize ) {
629 attr->a_nvals = ch_malloc((last+1)*sizeof(struct berval));
630 for (i=0; i<last; i++) {
631 attr->a_desc->ad_type->sat_equality->smr_normalize(
632 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
633 attr->a_desc->ad_type->sat_syntax,
634 attr->a_desc->ad_type->sat_equality,
635 &attr->a_vals[i], &attr->a_nvals[i] );
637 attr->a_nvals[i].bv_val = NULL;
638 attr->a_nvals[i].bv_len = 0;
640 attr->a_nvals = attr->a_vals;
643 attr->a_nvals = NULL;
646 attrp = &attr->a_next;
648 /* make sure it's free'able */
649 if (!private && ent->e_name.bv_val == bdn->bv_val)
650 ber_dupbv( &ent->e_name, bdn );
654 /* return 0 IFF we can retrieve the entry with ndn
661 AttributeDescription *at,
666 struct ldapinfo *li = (struct ldapinfo *) op->o_bd->be_private;
669 struct berval mapped = { 0, NULL }, bdn, mdn;
670 LDAPMessage *result = NULL, *e = NULL;
676 /* Tell getconn this is a privileged op */
677 is_oc = op->o_do_not_cache;
678 op->o_do_not_cache = 1;
679 lc = ldap_back_getconn(op, &rs);
682 if ( !lc || !ldap_back_dobind(lc, op, &rs) ) {
683 op->o_do_not_cache = is_oc;
687 op->o_do_not_cache = is_oc;
691 * Rewrite the search base, if required
693 #ifdef ENABLE_REWRITE
694 switch ( rewrite_session( li->rwinfo, "searchBase",
695 ndn->bv_val, op->o_conn, &mdn.bv_val ) ) {
696 case REWRITE_REGEXEC_OK:
697 if ( mdn.bv_val == NULL ) {
700 mdn.bv_len = strlen( mdn.bv_val );
704 LDAP_LOG( BACK_LDAP, DETAIL1,
705 "[rw] searchBase: \"%s\" -> \"%s\"\n",
706 ndn->bv_val, mdn.bv_val, 0 );
707 #else /* !NEW_LOGGING */
708 Debug( LDAP_DEBUG_ARGS, "rw> searchBase: \"%s\" -> \"%s\"\n",
709 ndn->bv_val, mdn.bv_val, 0 );
710 #endif /* !NEW_LOGGING */
713 case REWRITE_REGEXEC_UNWILLING:
714 case REWRITE_REGEXEC_ERR:
718 #else /* !ENABLE_REWRITE */
719 ldap_back_dn_massage( li, ndn, &mdn, 0, 1 );
720 #endif /* !ENABLE_REWRITE */
722 ldap_back_map(&li->at_map, &at->ad_cname, &mapped, BACKLDAP_MAP);
723 if (mapped.bv_val == NULL || mapped.bv_val[0] == '\0') {
728 is_oc = (strcasecmp("objectclass", mapped.bv_val) == 0);
730 gattr[0] = "objectclass";
731 gattr[1] = mapped.bv_val;
734 gattr[0] = mapped.bv_val;
739 ldap_back_map(&li->oc_map, &oc->soc_cname, &mapped,
741 filter = ch_malloc(sizeof("(objectclass=)") + mapped.bv_len);
742 ptr = lutil_strcopy(filter, "(objectclass=");
743 ptr = lutil_strcopy(ptr, mapped.bv_val);
748 if (ldap_search_ext_s(lc->ld, mdn.bv_val, LDAP_SCOPE_BASE, filter,
749 gattr, 0, NULL, NULL, LDAP_NO_LIMIT,
750 LDAP_NO_LIMIT, &result) != LDAP_SUCCESS)
755 if ((e = ldap_first_entry(lc->ld, result)) == NULL) {
759 *ent = ch_calloc(1,sizeof(Entry));
761 rc = ldap_build_entry(op, e, *ent, &bdn, LDAP_BUILD_ENTRY_NORMALIZE);
763 if (rc != LDAP_SUCCESS) {
770 ldap_msgfree(result);
777 if ( mdn.bv_val != ndn->bv_val ) {
778 ch_free( mdn.bv_val );