]> git.sur5r.net Git - openldap/blob - servers/slapd/back-ldap/search.c
45c5bd43df769e5a8e8009198d42e093eeabe27e
[openldap] / servers / slapd / back-ldap / search.c
1 /* search.c - ldap backend search function */
2 /* $OpenLDAP$ */
3 /*
4  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6  */
7 /* This is an altered version */
8 /*
9  * Copyright 1999, Howard Chu, All rights reserved. <hyc@highlandsun.com>
10  * 
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:
14  * 
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.
17  * 
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.
21  * 
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.
25  * 
26  * 4. This notice may not be removed or altered.
27  *
28  *
29  *
30  * Copyright 2000, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
31  * 
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.
36  */
37
38 #include "portable.h"
39
40 #include <stdio.h>
41
42 #include <ac/socket.h>
43 #include <ac/string.h>
44 #include <ac/time.h>
45
46 #include "slap.h"
47 #include "back-ldap.h"
48 #undef ldap_debug       /* silence a warning in ldap-int.h */
49 #include "../../../libraries/libldap/ldap-int.h"
50
51 static void ldap_send_entry( Backend *be, Operation *op, struct ldapconn *lc,
52                              LDAPMessage *e, AttributeName *attrs, int attrsonly );
53
54 int
55 ldap_back_search(
56     Backend     *be,
57     Connection  *conn,
58     Operation   *op,
59     struct berval       *base,
60     struct berval       *nbase,
61     int         scope,
62     int         deref,
63     int         slimit,
64     int         tlimit,
65     Filter      *filter,
66     struct berval       *filterstr,
67     AttributeName       *attrs,
68     int         attrsonly
69 )
70 {
71         struct ldapinfo *li = (struct ldapinfo *) be->be_private;
72         struct ldapconn *lc;
73         struct timeval  tv;
74         LDAPMessage             *res, *e;
75         int     count, rc = 0, msgid, sres = LDAP_SUCCESS; 
76         char *match = NULL, *err = NULL;
77         char *mapped_filter = NULL, **mapped_attrs = NULL;
78         struct berval mbase;
79 #ifdef ENABLE_REWRITE
80         char *mmatch = NULL;
81         struct berval mfilter = { 0, NULL };
82 #endif /* ENABLE_REWRITE */
83         struct slap_limits_set *limit = NULL;
84         int isroot = 0;
85
86         lc = ldap_back_getconn(li, conn, op);
87         if ( !lc ) {
88                 return( -1 );
89         }
90
91         /* if not root, get appropriate limits */
92         if ( be_isroot( be, &op->o_ndn ) ) {
93                 isroot = 1;
94         } else {
95                 ( void ) get_limits( be, &op->o_ndn, &limit );
96         }
97         
98         /* if no time limit requested, rely on remote server limits */
99         /* if requested limit higher than hard limit, abort */
100         if ( !isroot && tlimit > limit->lms_t_hard ) {
101                 /* no hard limit means use soft instead */
102                 if ( limit->lms_t_hard == 0 && tlimit > limit->lms_t_soft ) {
103                         tlimit = limit->lms_t_soft;
104                         
105                 /* positive hard limit means abort */
106                 } else if ( limit->lms_t_hard > 0 ) {
107                         send_search_result( conn, op, LDAP_UNWILLING_TO_PERFORM,
108                                         NULL, NULL, NULL, NULL, 0 );
109                         rc = 0;
110                         goto finish;
111                 }
112                 
113                 /* negative hard limit means no limit */
114         }
115         
116         /* if no size limit requested, rely on remote server limits */
117         /* if requested limit higher than hard limit, abort */
118         if ( !isroot && slimit > limit->lms_s_hard ) {
119                 /* no hard limit means use soft instead */
120                 if ( limit->lms_s_hard == 0 && slimit > limit->lms_s_soft ) {
121                         slimit = limit->lms_s_soft;
122                         
123                 /* positive hard limit means abort */
124                 } else if ( limit->lms_s_hard > 0 ) {
125                         send_search_result( conn, op, LDAP_UNWILLING_TO_PERFORM,
126                                         NULL, NULL, NULL, NULL, 0 );
127                         rc = 0;
128                         goto finish;
129                 }
130                 
131                 /* negative hard limit means no limit */
132         }
133
134         if (deref != -1)
135                 ldap_set_option( lc->ld, LDAP_OPT_DEREF, (void *)&deref);
136         if (tlimit != -1)
137                 ldap_set_option( lc->ld, LDAP_OPT_TIMELIMIT, (void *)&tlimit);
138         if (slimit != -1)
139                 ldap_set_option( lc->ld, LDAP_OPT_SIZELIMIT, (void *)&slimit);
140         
141         if ( !ldap_back_dobind( lc, op ) ) {
142                 return( -1 );
143         }
144
145         /*
146          * Rewrite the search base, if required
147          */
148 #ifdef ENABLE_REWRITE
149         switch ( rewrite_session( li->rwinfo, "searchBase",
150                                 base->bv_val, conn, &mbase.bv_val ) ) {
151         case REWRITE_REGEXEC_OK:
152                 if ( mbase.bv_val == NULL ) {
153                         mbase = *base;
154                 }
155 #ifdef NEW_LOGGING
156                 LDAP_LOG( BACK_LDAP, DETAIL1, 
157                         "[rw] searchBase: \"%s\" -> \"%s\"\n", 
158                         base->bv_val, mbase.bv_val, 0 );
159 #else /* !NEW_LOGGING */
160                 Debug( LDAP_DEBUG_ARGS, "rw> searchBase: \"%s\" -> \"%s\"\n%s",
161                                 base->bv_val, mbase.bv_val, "" );
162 #endif /* !NEW_LOGGING */
163                 break;
164                 
165         case REWRITE_REGEXEC_UNWILLING:
166                 send_ldap_result( conn, op, LDAP_UNWILLING_TO_PERFORM,
167                                 NULL, "Unwilling to perform", NULL, NULL );
168                 rc = -1;
169                 goto finish;
170
171         case REWRITE_REGEXEC_ERR:
172                 send_ldap_result( conn, op, LDAP_OTHER,
173                                 NULL, "Operations error", NULL, NULL );
174                 rc = -1;
175                 goto finish;
176         }
177         
178         /*
179          * Rewrite the search filter, if required
180          */
181         switch ( rewrite_session( li->rwinfo, "searchFilter",
182                                 filterstr->bv_val, conn, &mfilter.bv_val ) ) {
183         case REWRITE_REGEXEC_OK:
184                 if ( mfilter.bv_val == NULL || mfilter.bv_val[0] == '\0') {
185                         if ( mfilter.bv_val != NULL ) {
186                                 free( mfilter.bv_val );
187                         }
188                         mfilter = *filterstr;
189                 } else {
190                         mfilter.bv_len = strlen( mfilter.bv_val );
191                 }
192
193 #ifdef NEW_LOGGING
194                 LDAP_LOG( BACK_LDAP, DETAIL1, 
195                         "[rw] searchFilter: \"%s\" -> \"%s\"\n",
196                         filterstr->bv_val, mfilter.bv_val, 0 );
197 #else /* !NEW_LOGGING */
198                 Debug( LDAP_DEBUG_ARGS,
199                                 "rw> searchFilter: \"%s\" -> \"%s\"\n%s",
200                                 filterstr->bv_val, mfilter.bv_val, "" );
201 #endif /* !NEW_LOGGING */
202                 break;
203                 
204         case REWRITE_REGEXEC_UNWILLING:
205                 send_ldap_result( conn, op, LDAP_UNWILLING_TO_PERFORM,
206                                 NULL, "Unwilling to perform", NULL, NULL );
207         case REWRITE_REGEXEC_ERR:
208                 rc = -1;
209                 goto finish;
210         }
211 #else /* !ENABLE_REWRITE */
212         ldap_back_dn_massage( li, base, &mbase, 0, 1 );
213 #endif /* !ENABLE_REWRITE */
214
215         mapped_filter = ldap_back_map_filter(&li->at_map, &li->oc_map,
216 #ifdef ENABLE_REWRITE
217                         &mfilter,
218 #else /* !ENABLE_REWRITE */
219                         filterstr,
220 #endif /* !ENABLE_REWRITE */
221                         0);
222         if ( mapped_filter == NULL ) {
223 #ifdef ENABLE_REWRITE
224                 mapped_filter = mfilter.bv_val;
225 #else /* !ENABLE_REWRITE */
226                 mapped_filter = filterstr->bv_val;
227 #endif /* !ENABLE_REWRITE */
228         }
229
230 #ifdef ENABLE_REWRITE
231         if ( mfilter.bv_val != filterstr->bv_val ) {
232                 free( mfilter.bv_val );
233         }
234 #endif /* ENABLE_REWRITE */
235
236         mapped_attrs = ldap_back_map_attrs(&li->at_map, attrs, 0);
237         if ( mapped_attrs == NULL && attrs) {
238                 for (count=0; attrs[count].an_name.bv_val; count++);
239                 mapped_attrs = ch_malloc( (count+1) * sizeof(char *));
240                 for (count=0; attrs[count].an_name.bv_val; count++) {
241                         mapped_attrs[count] = attrs[count].an_name.bv_val;
242                 }
243                 mapped_attrs[count] = NULL;
244         }
245
246         if ((msgid = ldap_search(lc->ld, mbase.bv_val, scope, mapped_filter, mapped_attrs,
247                 attrsonly)) == -1)
248         {
249 fail:;
250                 rc = ldap_back_op_result(lc, op);
251                 goto finish;
252         }
253
254         /* We pull apart the ber result, stuff it into a slapd entry, and
255          * let send_search_entry stuff it back into ber format. Slow & ugly,
256          * but this is necessary for version matching, and for ACL processing.
257          */
258         
259         for (   count=0, rc=0;
260                         rc != -1;
261                         rc = ldap_result(lc->ld, msgid, 0, &tv, &res))
262         {
263                 /* check for abandon */
264                 if (op->o_abandon) {
265                         ldap_abandon(lc->ld, msgid);
266                         rc = 0;
267                         goto finish;
268                 }
269                 if (rc == 0) {
270                         tv.tv_sec = 0;
271                         tv.tv_usec = 100000;
272                         ldap_pvt_thread_yield();
273                 } else if (rc == LDAP_RES_SEARCH_ENTRY) {
274                         e = ldap_first_entry(lc->ld,res);
275                         ldap_send_entry(be, op, lc, e, attrs, attrsonly);
276                         count++;
277                         ldap_msgfree(res);
278                 } else {
279                         sres = ldap_result2error(lc->ld, res, 1);
280                         sres = ldap_back_map_result(sres);
281                         ldap_get_option(lc->ld, LDAP_OPT_ERROR_STRING, &err);
282                         ldap_get_option(lc->ld, LDAP_OPT_MATCHED_DN, &match);
283                         rc = 0;
284                         break;
285                 }
286         }
287
288         if (rc == -1)
289                 goto fail;
290
291 #ifdef ENABLE_REWRITE
292         /*
293          * Rewrite the matched portion of the search base, if required
294          */
295         if ( match != NULL ) {
296                 switch ( rewrite_session( li->rwinfo, "matchedDn",
297                                 match, conn, &mmatch ) ) {
298                 case REWRITE_REGEXEC_OK:
299                         if ( mmatch == NULL ) {
300                                 mmatch = ( char * )match;
301                         }
302 #ifdef NEW_LOGGING
303                         LDAP_LOG( BACK_LDAP, DETAIL1, 
304                                 "[rw]  matchedDn:" " \"%s\" -> \"%s\"\n", match, mmatch, 0 );
305 #else /* !NEW_LOGGING */
306                         Debug( LDAP_DEBUG_ARGS, "rw> matchedDn:"
307                                         " \"%s\" -> \"%s\"\n%s",
308                                         match, mmatch, "" );
309 #endif /* !NEW_LOGGING */
310                         break;
311                         
312                 case REWRITE_REGEXEC_UNWILLING:
313                         send_ldap_result( conn, op, LDAP_UNWILLING_TO_PERFORM,
314                                         NULL, "Unwilling to perform",
315                                         NULL, NULL );
316                         
317                 case REWRITE_REGEXEC_ERR:
318                         rc = -1;
319                         goto finish;
320                 }
321         }
322
323         send_search_result( conn, op, sres,
324                 mmatch, err, NULL, NULL, count );
325
326 #else /* !ENABLE_REWRITE */
327         send_search_result( conn, op, sres,
328                 match, err, NULL, NULL, count );
329 #endif /* !ENABLE_REWRITE */
330
331 finish:;
332         if ( match ) {
333 #ifdef ENABLE_REWRITE
334                 if ( mmatch != match ) {
335                         free( mmatch );
336                 }
337 #endif /* ENABLE_REWRITE */
338                 LDAP_FREE(match);
339         }
340         if ( err ) {
341                 LDAP_FREE( err );
342         }
343         if ( mapped_attrs ) {
344                 ch_free( mapped_attrs );
345         }
346         if ( mapped_filter != filterstr->bv_val ) {
347                 ch_free( mapped_filter );
348         }
349         if ( mbase.bv_val != base->bv_val ) {
350                 free( mbase.bv_val );
351         }
352         
353         return rc;
354 }
355
356 static void
357 ldap_send_entry(
358         Backend *be,
359         Operation *op,
360         struct ldapconn *lc,
361         LDAPMessage *e,
362         AttributeName *attrs,
363         int attrsonly
364 )
365 {
366         struct ldapinfo *li = (struct ldapinfo *) be->be_private;
367         struct berval a, mapped;
368         Entry ent;
369         BerElement ber = *e->lm_ber;
370         Attribute *attr, **attrp;
371         struct berval dummy = { 0, NULL };
372         struct berval *bv, bdn;
373         const char *text;
374
375         if ( ber_scanf( &ber, "{m{", &bdn ) == LBER_ERROR ) {
376                 return;
377         }
378 #ifdef ENABLE_REWRITE
379
380         /*
381          * Rewrite the dn of the result, if needed
382          */
383         switch ( rewrite_session( li->rwinfo, "searchResult",
384                                 bdn.bv_val, lc->conn, &ent.e_name.bv_val ) ) {
385         case REWRITE_REGEXEC_OK:
386                 if ( ent.e_name.bv_val == NULL ) {
387                         ent.e_name = bdn;
388                 } else {
389 #ifdef NEW_LOGGING
390                         LDAP_LOG( BACK_LDAP, DETAIL1, 
391                                 "[rw] searchResult: \"%s\"" " -> \"%s\"\n", 
392                                 bdn.bv_val, ent.e_dn, 0 );
393 #else /* !NEW_LOGGING */
394                         Debug( LDAP_DEBUG_ARGS, "rw> searchResult: \"%s\""
395                                         " -> \"%s\"\n%s", bdn.bv_val, ent.e_dn, "" );
396 #endif /* !NEW_LOGGING */
397                         ent.e_name.bv_len = strlen( ent.e_name.bv_val );
398                 }
399                 break;
400                 
401         case REWRITE_REGEXEC_ERR:
402         case REWRITE_REGEXEC_UNWILLING:
403                 return;
404         }
405 #else /* !ENABLE_REWRITE */
406         ldap_back_dn_massage( li, &bdn, &ent.e_name, 0, 0 );
407 #endif /* !ENABLE_REWRITE */
408
409         /*
410          * Note: this may fail if the target host(s) schema differs
411          * from the one known to the meta, and a DN with unknown
412          * attributes is returned.
413          * 
414          * FIXME: should we log anything, or delegate to dnNormalize2?
415          */
416         if ( dnNormalize2( NULL, &ent.e_name, &ent.e_nname ) != LDAP_SUCCESS ) {
417                 return;
418         }
419         
420         ent.e_id = 0;
421         ent.e_attrs = 0;
422         ent.e_private = 0;
423         attrp = &ent.e_attrs;
424
425         while ( ber_scanf( &ber, "{m", &a ) != LBER_ERROR ) {
426                 ldap_back_map(&li->at_map, &a, &mapped, 1);
427                 if (mapped.bv_val == NULL)
428                         continue;
429                 attr = (Attribute *)ch_malloc( sizeof(Attribute) );
430                 if (attr == NULL)
431                         continue;
432                 attr->a_flags = 0;
433                 attr->a_next = 0;
434                 attr->a_desc = NULL;
435                 if (slap_bv2ad(&mapped, &attr->a_desc, &text) != LDAP_SUCCESS) {
436                         if (slap_bv2undef_ad(&mapped, &attr->a_desc, &text) 
437                                         != LDAP_SUCCESS) {
438 #ifdef NEW_LOGGING
439                                 LDAP_LOG( BACK_LDAP, DETAIL1, 
440                                         "slap_bv2undef_ad(%s):  %s\n", mapped.bv_val, text, 0 );
441 #else /* !NEW_LOGGING */
442                                 Debug( LDAP_DEBUG_ANY, 
443                                                 "slap_bv2undef_ad(%s):  "
444                                                 "%s\n%s", mapped.bv_val, text, "" );
445 #endif /* !NEW_LOGGING */
446                                 ch_free(attr);
447                                 continue;
448                         }
449                 }
450
451                 /* no subschemaSubentry */
452                 if ( attr->a_desc == slap_schema.si_ad_subschemaSubentry ) {
453                         ch_free(attr);
454                         continue;
455                 }
456                 
457                 if (ber_scanf( &ber, "[W]", &attr->a_vals ) == LBER_ERROR ) {
458                         attr->a_vals = &dummy;
459                 } else if ( attr->a_desc == slap_schema.si_ad_objectClass
460                                 || attr->a_desc == slap_schema.si_ad_structuralObjectClass ) {
461                         int i, last;
462                         assert( attr->a_vals );
463                         for ( last = 0; attr->a_vals[last].bv_val; last++ ) ;
464                         for ( i = 0, bv = attr->a_vals; bv->bv_val; bv++, i++ ) {
465                                 ldap_back_map(&li->oc_map, bv, &mapped, 1);
466                                 if (mapped.bv_val == NULL) {
467                                         LBER_FREE(bv->bv_val);
468                                         bv->bv_val = NULL;
469                                         if (--last < 0)
470                                                 break;
471                                         *bv = attr->a_vals[last];
472                                         attr->a_vals[last].bv_val = NULL;
473                                         i--;
474                                 } else if ( mapped.bv_val != bv->bv_val ) {
475                                         /*
476                                          * FIXME: after LBER_FREEing
477                                          * the value is replaced by
478                                          * ch_alloc'ed memory
479                                          */
480                                         LBER_FREE(bv->bv_val);
481                                         ber_dupbv( bv, &mapped );
482                                 }
483                         }
484
485                 /*
486                  * It is necessary to try to rewrite attributes with
487                  * dn syntax because they might be used in ACLs as
488                  * members of groups; since ACLs are applied to the
489                  * rewritten stuff, no dn-based subject clause could
490                  * be used at the ldap backend side (see
491                  * http://www.OpenLDAP.org/faq/data/cache/452.html)
492                  * The problem can be overcome by moving the dn-based
493                  * ACLs to the target directory server, and letting
494                  * everything pass thru the ldap backend.
495                  */
496                 } else if ( strcmp( attr->a_desc->ad_type->sat_syntax->ssyn_oid,
497                                         SLAPD_DN_SYNTAX ) == 0 ) {
498                         int i;
499                         assert( attr->a_vals );
500                         for ( i = 0, bv = attr->a_vals; bv->bv_val; bv++, i++ ) {
501                                 struct berval newval;
502                                 
503 #ifdef ENABLE_REWRITE
504                                 switch ( rewrite_session( li->rwinfo,
505                                                         "searchResult",
506                                                         bv->bv_val,
507                                                         lc->conn, 
508                                                         &newval.bv_val )) {
509                                 case REWRITE_REGEXEC_OK:
510                                         /* left as is */
511                                         if ( newval.bv_val == NULL ) {
512                                                 break;
513                                         }
514                                         newval.bv_len = strlen( newval.bv_val );
515 #ifdef NEW_LOGGING
516                                         LDAP_LOG( BACK_LDAP, DETAIL1, 
517                                                 "[rw] searchResult on attr=%s: \"%s\" -> \"%s\"\n",
518                                                 attr->a_desc->ad_type->sat_cname.bv_val,
519                                                 bv->bv_val, newval.bv_val );
520 #else /* !NEW_LOGGING */
521                                         Debug( LDAP_DEBUG_ARGS,
522                 "rw> searchResult on attr=%s: \"%s\" -> \"%s\"\n",
523                                                 attr->a_desc->ad_type->sat_cname.bv_val,
524                                                 bv->bv_val, newval.bv_val );
525 #endif /* !NEW_LOGGING */
526                                         free( bv->bv_val );
527                                         *bv = newval;
528                                         break;
529                                         
530                                 case REWRITE_REGEXEC_UNWILLING:
531                                         
532                                 case REWRITE_REGEXEC_ERR:
533                                         /*
534                                          * FIXME: better give up,
535                                          * skip the attribute
536                                          * or leave it untouched?
537                                          */
538                                         break;
539                                 }
540 #else /* !ENABLE_REWRITE */
541                                 ldap_back_dn_massage( li, bv, &newval, 0, 0 );
542                                 *bv = newval;
543 #endif /* !ENABLE_REWRITE */
544                         }
545                 }
546
547                 *attrp = attr;
548                 attrp = &attr->a_next;
549         }
550         send_search_entry( be, lc->conn, op, &ent, attrs, attrsonly, NULL );
551         while (ent.e_attrs) {
552                 attr = ent.e_attrs;
553                 ent.e_attrs = attr->a_next;
554                 if (attr->a_vals != &dummy)
555                         ber_bvarray_free(attr->a_vals);
556                 ch_free(attr);
557         }
558         
559         if ( ent.e_dn && ( ent.e_dn != bdn.bv_val ) )
560                 free( ent.e_dn );
561         if ( ent.e_ndn )
562                 free( ent.e_ndn );
563 }