git.sur5r.net Git - openldap/blob - servers/slapd/back-mdb/search.c

   1 /* search.c - search operation */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2013 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16
  17 #include "portable.h"
  18
  19 #include <stdio.h>
  20 #include <ac/string.h>
  21
  22 #include "back-mdb.h"
  23 #include "idl.h"
  24
  25 static int base_candidate(
  26         BackendDB       *be,
  27         Entry   *e,
  28         ID              *ids );
  29
  30 static int search_candidates(
  31         Operation *op,
  32         SlapReply *rs,
  33         Entry *e,
  34         MDB_txn *txn,
  35         MDB_cursor *mci,
  36         ID      *ids,
  37         ID2L    scopes );
  38
  39 static int parse_paged_cookie( Operation *op, SlapReply *rs );
  40
  41 static void send_paged_response(
  42         Operation *op,
  43         SlapReply *rs,
  44         ID  *lastid,
  45         int tentries );
  46
  47 /* Dereference aliases for a single alias entry. Return the final
  48  * dereferenced entry on success, NULL on any failure.
  49  */
  50 static Entry * deref_base (
  51         Operation *op,
  52         SlapReply *rs,
  53         Entry *e,
  54         Entry **matched,
  55         MDB_txn *txn,
  56         ID      *tmp,
  57         ID      *visited )
  58 {
  59         struct berval ndn;
  60
  61         rs->sr_err = LDAP_ALIAS_DEREF_PROBLEM;
  62         rs->sr_text = "maximum deref depth exceeded";
  63
  64         for (;;) {
  65                 /* Remember the last entry we looked at, so we can
  66                  * report broken links
  67                  */
  68                 *matched = e;
  69
  70                 if (MDB_IDL_N(tmp) >= op->o_bd->be_max_deref_depth) {
  71                         e = NULL;
  72                         break;
  73                 }
  74
  75                 /* If this is part of a subtree or onelevel search,
  76                  * have we seen this ID before? If so, quit.
  77                  */
  78                 if ( visited && mdb_idl_insert( visited, e->e_id ) ) {
  79                         e = NULL;
  80                         break;
  81                 }
  82
  83                 /* If we've seen this ID during this deref iteration,
  84                  * we've hit a loop.
  85                  */
  86                 if ( mdb_idl_insert( tmp, e->e_id ) ) {
  87                         rs->sr_err = LDAP_ALIAS_PROBLEM;
  88                         rs->sr_text = "circular alias";
  89                         e = NULL;
  90                         break;
  91                 }
  92
  93                 /* If there was a problem getting the aliasedObjectName,
  94                  * get_alias_dn will have set the error status.
  95                  */
  96                 if ( get_alias_dn(e, &ndn, &rs->sr_err, &rs->sr_text) ) {
  97                         e = NULL;
  98                         break;
  99                 }
 100
 101                 rs->sr_err = mdb_dn2entry( op, txn, NULL, &ndn, &e, 0 );
 102                 if (rs->sr_err) {
 103                         rs->sr_err = LDAP_ALIAS_PROBLEM;
 104                         rs->sr_text = "aliasedObject not found";
 105                         break;
 106                 }
 107
 108                 /* Free the previous entry, continue to work with the
 109                  * one we just retrieved.
 110                  */
 111                 mdb_entry_return( op, *matched );
 112
 113                 /* We found a regular entry. Return this to the caller.
 114                  */
 115                 if (!is_entry_alias(e)) {
 116                         rs->sr_err = LDAP_SUCCESS;
 117                         rs->sr_text = NULL;
 118                         break;
 119                 }
 120         }
 121         return e;
 122 }
 123
 124 /* Look for and dereference all aliases within the search scope.
 125  * Requires "stack" to be able to hold 6 levels of DB_SIZE IDLs.
 126  * Of course we're hardcoded to require a minimum of 8 UM_SIZE
 127  * IDLs so this is never a problem.
 128  */
 129 static int search_aliases(
 130         Operation *op,
 131         SlapReply *rs,
 132         ID e_id,
 133         MDB_txn *txn,
 134         MDB_cursor *mci,
 135         ID2L scopes,
 136         ID *stack )
 137 {
 138         ID *aliases, *curscop, *visited, *newsubs, *oldsubs, *tmp;
 139         ID cursora, ida, cursoro, ido;
 140         Entry *matched, *a;
 141         struct berval bv_alias = BER_BVC( "alias" );
 142         AttributeAssertion aa_alias = ATTRIBUTEASSERTION_INIT;
 143         Filter  af;
 144         int first = 1;
 145
 146         aliases = stack;        /* IDL of all aliases in the database */
 147         curscop = aliases + MDB_IDL_DB_SIZE;    /* Aliases in the current scope */
 148         visited = curscop + MDB_IDL_DB_SIZE;    /* IDs we've seen in this search */
 149         newsubs = visited + MDB_IDL_DB_SIZE;    /* New subtrees we've added */
 150         oldsubs = newsubs + MDB_IDL_DB_SIZE;    /* Subtrees added previously */
 151         tmp = oldsubs + MDB_IDL_DB_SIZE;        /* Scratch space for deref_base() */
 152
 153         af.f_choice = LDAP_FILTER_EQUALITY;
 154         af.f_ava = &aa_alias;
 155         af.f_av_desc = slap_schema.si_ad_objectClass;
 156         af.f_av_value = bv_alias;
 157         af.f_next = NULL;
 158
 159         /* Find all aliases in database */
 160         MDB_IDL_ZERO( aliases );
 161         rs->sr_err = mdb_filter_candidates( op, txn, &af, aliases,
 162                 curscop, visited );
 163         if (rs->sr_err != LDAP_SUCCESS || MDB_IDL_IS_ZERO( aliases )) {
 164                 return rs->sr_err;
 165         }
 166         oldsubs[0] = 1;
 167         oldsubs[1] = e_id;
 168
 169         MDB_IDL_ZERO( visited );
 170         MDB_IDL_ZERO( newsubs );
 171
 172         cursoro = 0;
 173         ido = mdb_idl_first( oldsubs, &cursoro );
 174
 175         for (;;) {
 176                 /* Set curscop to only the aliases in the current scope. Start with
 177                  * all the aliases, then get the intersection with the scope.
 178                  */
 179                 rs->sr_err = mdb_idscope( op, txn, e_id, aliases, curscop );
 180
 181                 /* Dereference all of the aliases in the current scope. */
 182                 cursora = 0;
 183                 for (ida = mdb_idl_first(curscop, &cursora); ida != NOID;
 184                         ida = mdb_idl_next(curscop, &cursora))
 185                 {
 186                         rs->sr_err = mdb_id2entry(op, mci, ida, &a);
 187                         if (rs->sr_err != LDAP_SUCCESS) {
 188                                 continue;
 189                         }
 190
 191                         /* This should only happen if the curscop IDL has maxed out and
 192                          * turned into a range that spans IDs indiscriminately
 193                          */
 194                         if (!is_entry_alias(a)) {
 195                                 mdb_entry_return(op, a);
 196                                 continue;
 197                         }
 198
 199                         /* Actually dereference the alias */
 200                         MDB_IDL_ZERO(tmp);
 201                         a = deref_base( op, rs, a, &matched, txn,
 202                                 tmp, visited );
 203                         if (a) {
 204                                 /* If the target was not already in our current scopes,
 205                                  * make note of it in the newsubs list.
 206                                  */
 207                                 ID2 mid;
 208                                 mid.mid = a->e_id;
 209                                 mid.mval.mv_data = NULL;
 210                                 if (mdb_id2l_insert(scopes, &mid) == 0) {
 211                                         mdb_idl_insert(newsubs, a->e_id);
 212                                 }
 213                                 mdb_entry_return( op, a );
 214
 215                         } else if (matched) {
 216                                 /* Alias could not be dereferenced, or it deref'd to
 217                                  * an ID we've already seen. Ignore it.
 218                                  */
 219                                 mdb_entry_return( op, matched );
 220                                 rs->sr_text = NULL;
 221                         }
 222                 }
 223                 /* If this is a OneLevel search, we're done; oldsubs only had one
 224                  * ID in it. For a Subtree search, oldsubs may be a list of scope IDs.
 225                  */
 226                 if ( op->ors_scope == LDAP_SCOPE_ONELEVEL ) break;
 227 nextido:
 228                 ido = mdb_idl_next( oldsubs, &cursoro );
 229
 230                 /* If we're done processing the old scopes, did we add any new
 231                  * scopes in this iteration? If so, go back and do those now.
 232                  */
 233                 if (ido == NOID) {
 234                         if (MDB_IDL_IS_ZERO(newsubs)) break;
 235                         MDB_IDL_CPY(oldsubs, newsubs);
 236                         MDB_IDL_ZERO(newsubs);
 237                         cursoro = 0;
 238                         ido = mdb_idl_first( oldsubs, &cursoro );
 239                 }
 240
 241                 /* Find the entry corresponding to the next scope. If it can't
 242                  * be found, ignore it and move on. This should never happen;
 243                  * we should never see the ID of an entry that doesn't exist.
 244                  */
 245                 {
 246                         MDB_val edata;
 247                         rs->sr_err = mdb_id2edata(op, mci, ido, &edata);
 248                         if ( rs->sr_err != MDB_SUCCESS ) {
 249                                 goto nextido;
 250                         }
 251                         e_id = ido;
 252                 }
 253         }
 254         return rs->sr_err;
 255 }
 256
 257 /* Get the next ID from the DB. Used if the candidate list is
 258  * a range and simple iteration hits missing entryIDs
 259  */
 260 static int
 261 mdb_get_nextid(MDB_cursor *mci, ID *cursor)
 262 {
 263         MDB_val key;
 264         ID id;
 265         int rc;
 266
 267         id = *cursor + 1;
 268         key.mv_data = &id;
 269         key.mv_size = sizeof(ID);
 270         rc = mdb_cursor_get( mci, &key, NULL, MDB_SET_RANGE );
 271         if ( rc )
 272                 return rc;
 273         memcpy( cursor, key.mv_data, sizeof(ID));
 274         return 0;
 275 }
 276
 277 static void scope_chunk_free( void *key, void *data )
 278 {
 279         ID2 *p1, *p2;
 280         for (p1 = data; p1; p1 = p2) {
 281                 p2 = p1[0].mval.mv_data;
 282                 ber_memfree_x(p1, NULL);
 283         }
 284 }
 285
 286 static ID2 *scope_chunk_get( Operation *op )
 287 {
 288         struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
 289         ID2 *ret = NULL;
 290
 291         ldap_pvt_thread_pool_getkey( op->o_threadctx, (void *)scope_chunk_get,
 292                         (void *)&ret, NULL );
 293         if ( !ret ) {
 294                 ret = ch_malloc( MDB_IDL_UM_SIZE * sizeof( ID2 ));
 295         } else {
 296                 void *r2 = ret[0].mval.mv_data;
 297                 ldap_pvt_thread_pool_setkey( op->o_threadctx, (void *)scope_chunk_get,
 298                         r2, scope_chunk_free, NULL, NULL );
 299         }
 300         return ret;
 301 }
 302
 303 static void scope_chunk_ret( Operation *op, ID2 *scopes )
 304 {
 305         struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
 306         void *ret = NULL;
 307
 308         ldap_pvt_thread_pool_getkey( op->o_threadctx, (void *)scope_chunk_get,
 309                         &ret, NULL );
 310         scopes[0].mval.mv_data = ret;
 311         ldap_pvt_thread_pool_setkey( op->o_threadctx, (void *)scope_chunk_get,
 312                         (void *)scopes, scope_chunk_free, NULL, NULL );
 313 }
 314
 315 int
 316 mdb_search( Operation *op, SlapReply *rs )
 317 {
 318         struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
 319         ID              id, cursor;
 320         ID              lastid = NOID;
 321         ID              candidates[MDB_IDL_UM_SIZE];
 322         ID2             *scopes;
 323         Entry           *e = NULL, *base = NULL;
 324         Entry           *matched = NULL;
 325         AttributeName   *attrs;
 326         slap_mask_t     mask;
 327         time_t          stoptime;
 328         int             manageDSAit;
 329         int             tentries = 0;
 330         IdScopes        isc;
 331         MDB_cursor      *mci;
 332
 333         mdb_op_info     opinfo = {{{0}}}, *moi = &opinfo;
 334         MDB_txn                 *ltid = NULL;
 335
 336         Debug( LDAP_DEBUG_TRACE, "=> " LDAP_XSTRING(mdb_search) "\n", 0, 0, 0);
 337         attrs = op->oq_search.rs_attrs;
 338
 339         manageDSAit = get_manageDSAit( op );
 340
 341         rs->sr_err = mdb_opinfo_get( op, mdb, 1, &moi );
 342         switch(rs->sr_err) {
 343         case 0:
 344                 break;
 345         default:
 346                 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
 347                 return rs->sr_err;
 348         }
 349
 350         ltid = moi->moi_txn;
 351
 352         rs->sr_err = mdb_cursor_open( ltid, mdb->mi_id2entry, &mci );
 353         if ( rs->sr_err ) {
 354                 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
 355                 return rs->sr_err;
 356         }
 357
 358         scopes = scope_chunk_get( op );
 359         isc.mt = ltid;
 360         isc.mc = NULL;
 361         isc.scopes = scopes;
 362
 363         if ( op->ors_deref & LDAP_DEREF_FINDING ) {
 364                 MDB_IDL_ZERO(candidates);
 365         }
 366 dn2entry_retry:
 367         /* get entry with reader lock */
 368         rs->sr_err = mdb_dn2entry( op, ltid, NULL, &op->o_req_ndn, &e, 1 );
 369
 370         switch(rs->sr_err) {
 371         case MDB_NOTFOUND:
 372                 matched = e;
 373                 e = NULL;
 374                 break;
 375         case 0:
 376                 break;
 377         case LDAP_BUSY:
 378                 send_ldap_error( op, rs, LDAP_BUSY, "ldap server busy" );
 379                 goto done;
 380         default:
 381                 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
 382                 goto done;
 383         }
 384
 385         if ( op->ors_deref & LDAP_DEREF_FINDING ) {
 386                 if ( matched && is_entry_alias( matched )) {
 387                         struct berval stub;
 388
 389                         stub.bv_val = op->o_req_ndn.bv_val;
 390                         stub.bv_len = op->o_req_ndn.bv_len - matched->e_nname.bv_len - 1;
 391                         e = deref_base( op, rs, matched, &matched, ltid,
 392                                 candidates, NULL );
 393                         if ( e ) {
 394                                 build_new_dn( &op->o_req_ndn, &e->e_nname, &stub,
 395                                         op->o_tmpmemctx );
 396                                 mdb_entry_return(op, e);
 397                                 matched = NULL;
 398                                 goto dn2entry_retry;
 399                         }
 400                 } else if ( e && is_entry_alias( e )) {
 401                         e = deref_base( op, rs, e, &matched, ltid,
 402                                 candidates, NULL );
 403                 }
 404         }
 405
 406         if ( e == NULL ) {
 407                 struct berval matched_dn = BER_BVNULL;
 408
 409                 if ( matched != NULL ) {
 410                         BerVarray erefs = NULL;
 411
 412                         /* return referral only if "disclose"
 413                          * is granted on the object */
 414                         if ( ! access_allowed( op, matched,
 415                                                 slap_schema.si_ad_entry,
 416                                                 NULL, ACL_DISCLOSE, NULL ) )
 417                         {
 418                                 rs->sr_err = LDAP_NO_SUCH_OBJECT;
 419
 420                         } else {
 421                                 ber_dupbv( &matched_dn, &matched->e_name );
 422
 423                                 erefs = is_entry_referral( matched )
 424                                         ? get_entry_referrals( op, matched )
 425                                         : NULL;
 426                                 if ( rs->sr_err == MDB_NOTFOUND )
 427                                         rs->sr_err = LDAP_REFERRAL;
 428                                 rs->sr_matched = matched_dn.bv_val;
 429                         }
 430
 431                         mdb_entry_return(op, matched);
 432                         matched = NULL;
 433
 434                         if ( erefs ) {
 435                                 rs->sr_ref = referral_rewrite( erefs, &matched_dn,
 436                                         &op->o_req_dn, op->oq_search.rs_scope );
 437                                 ber_bvarray_free( erefs );
 438                         }
 439
 440                 } else {
 441                         rs->sr_ref = referral_rewrite( default_referral,
 442                                 NULL, &op->o_req_dn, op->oq_search.rs_scope );
 443                         rs->sr_err = rs->sr_ref != NULL ? LDAP_REFERRAL : LDAP_NO_SUCH_OBJECT;
 444                 }
 445
 446                 send_ldap_result( op, rs );
 447
 448                 if ( rs->sr_ref ) {
 449                         ber_bvarray_free( rs->sr_ref );
 450                         rs->sr_ref = NULL;
 451                 }
 452                 if ( !BER_BVISNULL( &matched_dn ) ) {
 453                         ber_memfree( matched_dn.bv_val );
 454                         rs->sr_matched = NULL;
 455                 }
 456                 goto done;
 457         }
 458
 459         /* NOTE: __NEW__ "search" access is required
 460          * on searchBase object */
 461         if ( ! access_allowed_mask( op, e, slap_schema.si_ad_entry,
 462                                 NULL, ACL_SEARCH, NULL, &mask ) )
 463         {
 464                 if ( !ACL_GRANT( mask, ACL_DISCLOSE ) ) {
 465                         rs->sr_err = LDAP_NO_SUCH_OBJECT;
 466                 } else {
 467                         rs->sr_err = LDAP_INSUFFICIENT_ACCESS;
 468                 }
 469
 470                 mdb_entry_return( op,e);
 471                 send_ldap_result( op, rs );
 472                 goto done;
 473         }
 474
 475         if ( !manageDSAit && is_entry_referral( e ) ) {
 476                 /* entry is a referral */
 477                 struct berval matched_dn = BER_BVNULL;
 478                 BerVarray erefs = NULL;
 479
 480                 ber_dupbv( &matched_dn, &e->e_name );
 481                 erefs = get_entry_referrals( op, e );
 482
 483                 rs->sr_err = LDAP_REFERRAL;
 484
 485                 mdb_entry_return( op, e );
 486                 e = NULL;
 487
 488                 if ( erefs ) {
 489                         rs->sr_ref = referral_rewrite( erefs, &matched_dn,
 490                                 &op->o_req_dn, op->oq_search.rs_scope );
 491                         ber_bvarray_free( erefs );
 492
 493                         if ( !rs->sr_ref ) {
 494                                 rs->sr_text = "bad_referral object";
 495                         }
 496                 }
 497
 498                 Debug( LDAP_DEBUG_TRACE,
 499                         LDAP_XSTRING(mdb_search) ": entry is referral\n",
 500                         0, 0, 0 );
 501
 502                 rs->sr_matched = matched_dn.bv_val;
 503                 send_ldap_result( op, rs );
 504
 505                 ber_bvarray_free( rs->sr_ref );
 506                 rs->sr_ref = NULL;
 507                 ber_memfree( matched_dn.bv_val );
 508                 rs->sr_matched = NULL;
 509                 goto done;
 510         }
 511
 512         if ( get_assert( op ) &&
 513                 ( test_filter( op, e, get_assertion( op )) != LDAP_COMPARE_TRUE ))
 514         {
 515                 rs->sr_err = LDAP_ASSERTION_FAILED;
 516                 mdb_entry_return( op,e);
 517                 send_ldap_result( op, rs );
 518                 goto done;
 519         }
 520
 521         /* compute it anyway; root does not use it */
 522         stoptime = op->o_time + op->ors_tlimit;
 523
 524         base = e;
 525
 526         e = NULL;
 527
 528         /* select candidates */
 529         if ( op->oq_search.rs_scope == LDAP_SCOPE_BASE ) {
 530                 rs->sr_err = base_candidate( op->o_bd, base, candidates );
 531
 532         } else {
 533                 MDB_IDL_ZERO( candidates );
 534                 scopes[0].mid = 1;
 535                 scopes[1].mid = base->e_id;
 536                 scopes[1].mval.mv_data = NULL;
 537                 rs->sr_err = search_candidates( op, rs, base,
 538                         ltid, mci, candidates, scopes );
 539         }
 540
 541         /* start cursor at beginning of candidates.
 542          */
 543         cursor = 0;
 544
 545         if ( candidates[0] == 0 ) {
 546                 Debug( LDAP_DEBUG_TRACE,
 547                         LDAP_XSTRING(mdb_search) ": no candidates\n",
 548                         0, 0, 0 );
 549
 550                 goto nochange;
 551         }
 552
 553         /* if not root and candidates exceed to-be-checked entries, abort */
 554         if ( op->ors_limit      /* isroot == FALSE */ &&
 555                 op->ors_limit->lms_s_unchecked != -1 &&
 556                 MDB_IDL_N(candidates) > (unsigned) op->ors_limit->lms_s_unchecked )
 557         {
 558                 rs->sr_err = LDAP_ADMINLIMIT_EXCEEDED;
 559                 send_ldap_result( op, rs );
 560                 rs->sr_err = LDAP_SUCCESS;
 561                 goto done;
 562         }
 563
 564         if ( op->ors_limit == NULL      /* isroot == TRUE */ ||
 565                 !op->ors_limit->lms_s_pr_hide )
 566         {
 567                 tentries = MDB_IDL_N(candidates);
 568         }
 569
 570         if ( get_pagedresults( op ) > SLAP_CONTROL_IGNORED ) {
 571                 PagedResultsState *ps = op->o_pagedresults_state;
 572                 /* deferred cookie parsing */
 573                 rs->sr_err = parse_paged_cookie( op, rs );
 574                 if ( rs->sr_err != LDAP_SUCCESS ) {
 575                         send_ldap_result( op, rs );
 576                         goto done;
 577                 }
 578
 579                 cursor = (ID) ps->ps_cookie;
 580                 if ( cursor && ps->ps_size == 0 ) {
 581                         rs->sr_err = LDAP_SUCCESS;
 582                         rs->sr_text = "search abandoned by pagedResult size=0";
 583                         send_ldap_result( op, rs );
 584                         goto done;
 585                 }
 586                 id = mdb_idl_first( candidates, &cursor );
 587                 if ( id == NOID ) {
 588                         Debug( LDAP_DEBUG_TRACE,
 589                                 LDAP_XSTRING(mdb_search)
 590                                 ": no paged results candidates\n",
 591                                 0, 0, 0 );
 592                         send_paged_response( op, rs, &lastid, 0 );
 593
 594                         rs->sr_err = LDAP_OTHER;
 595                         goto done;
 596                 }
 597                 if ( id == (ID)ps->ps_cookie )
 598                         id = mdb_idl_next( candidates, &cursor );
 599                 goto loop_begin;
 600         }
 601
 602         for ( id = mdb_idl_first( candidates, &cursor );
 603                   id != NOID ; id = mdb_idl_next( candidates, &cursor ) )
 604         {
 605                 int scopeok;
 606                 MDB_val edata;
 607
 608 loop_begin:
 609
 610                 /* check for abandon */
 611                 if ( op->o_abandon ) {
 612                         rs->sr_err = SLAPD_ABANDON;
 613                         send_ldap_result( op, rs );
 614                         goto done;
 615                 }
 616
 617                 /* mostly needed by internal searches,
 618                  * e.g. related to syncrepl, for whom
 619                  * abandon does not get set... */
 620                 if ( slapd_shutdown ) {
 621                         rs->sr_err = LDAP_UNAVAILABLE;
 622                         send_ldap_disconnect( op, rs );
 623                         goto done;
 624                 }
 625
 626                 /* check time limit */
 627                 if ( op->ors_tlimit != SLAP_NO_LIMIT
 628                                 && slap_get_time() > stoptime )
 629                 {
 630                         rs->sr_err = LDAP_TIMELIMIT_EXCEEDED;
 631                         rs->sr_ref = rs->sr_v2ref;
 632                         send_ldap_result( op, rs );
 633                         rs->sr_err = LDAP_SUCCESS;
 634                         goto done;
 635                 }
 636
 637                 if ( id == base->e_id ) {
 638                         e = base;
 639                 } else {
 640
 641                         /* get the entry */
 642                         rs->sr_err = mdb_id2edata( op, mci, id, &edata );
 643                         if ( rs->sr_err == MDB_NOTFOUND ) {
 644                                 if( !MDB_IDL_IS_RANGE(candidates) ) {
 645                                         /* only complain for non-range IDLs */
 646                                         Debug( LDAP_DEBUG_TRACE,
 647                                                 LDAP_XSTRING(mdb_search)
 648                                                 ": candidate %ld not found\n",
 649                                                 (long) id, 0, 0 );
 650                                 } else {
 651                                         /* get the next ID from the DB */
 652                                         rs->sr_err = mdb_get_nextid( mci, &cursor );
 653                                         if ( rs->sr_err == MDB_NOTFOUND ) {
 654                                                 break;
 655                                         }
 656                                         if ( rs->sr_err ) {
 657                                                 rs->sr_err = LDAP_OTHER;
 658                                                 rs->sr_text = "internal error in get_nextid";
 659                                                 send_ldap_result( op, rs );
 660                                                 goto done;
 661                                         }
 662                                         cursor--;
 663                                 }
 664
 665                                 goto loop_continue;
 666                         } else if ( rs->sr_err ) {
 667                                 rs->sr_err = LDAP_OTHER;
 668                                 rs->sr_text = "internal error in mdb_id2edata";
 669                                 send_ldap_result( op, rs );
 670                                 goto done;
 671                         }
 672                 }
 673
 674                 /* Does this candidate actually satisfy the search scope?
 675                  */
 676                 scopeok = 0;
 677                 isc.numrdns = 0;
 678                 switch( op->ors_scope ) {
 679                 case LDAP_SCOPE_BASE:
 680                         /* This is always true, yes? */
 681                         if ( id == base->e_id ) scopeok = 1;
 682                         break;
 683
 684 #ifdef LDAP_SCOPE_CHILDREN
 685                 case LDAP_SCOPE_CHILDREN:
 686                         if ( id == base->e_id ) break;
 687                         /* Fall-thru */
 688 #endif
 689                 case LDAP_SCOPE_SUBTREE:
 690                         if ( id == base->e_id ) {
 691                                 scopeok = 1;
 692                                 break;
 693                         }
 694                         /* Fall-thru */
 695                 case LDAP_SCOPE_ONELEVEL:
 696                         isc.id = id;
 697                         if ( mdb_idscopes( op, &isc ) == MDB_SUCCESS ) scopeok = 1;
 698                         break;
 699                 }
 700
 701                 /* Not in scope, ignore it */
 702                 if ( !scopeok )
 703                 {
 704                         Debug( LDAP_DEBUG_TRACE,
 705                                 LDAP_XSTRING(mdb_search)
 706                                 ": %ld scope not okay\n",
 707                                 (long) id, 0, 0 );
 708                         goto loop_continue;
 709                 }
 710
 711                 if ( id != base->e_id ) {
 712                         rs->sr_err = mdb_entry_decode( op, &edata, &e );
 713                         if ( rs->sr_err ) {
 714                                 rs->sr_err = LDAP_OTHER;
 715                                 rs->sr_text = "internal error in mdb_entry_decode";
 716                                 send_ldap_result( op, rs );
 717                                 goto done;
 718                         }
 719                         e->e_id = id;
 720                         e->e_name.bv_val = NULL;
 721                         e->e_nname.bv_val = NULL;
 722                 }
 723
 724                 if ( is_entry_subentry( e ) ) {
 725                         if( op->oq_search.rs_scope != LDAP_SCOPE_BASE ) {
 726                                 if(!get_subentries_visibility( op )) {
 727                                         /* only subentries are visible */
 728                                         goto loop_continue;
 729                                 }
 730
 731                         } else if ( get_subentries( op ) &&
 732                                 !get_subentries_visibility( op ))
 733                         {
 734                                 /* only subentries are visible */
 735                                 goto loop_continue;
 736                         }
 737
 738                 } else if ( get_subentries_visibility( op )) {
 739                         /* only subentries are visible */
 740                         goto loop_continue;
 741                 }
 742
 743                 /* aliases were already dereferenced in candidate list */
 744                 if ( op->ors_deref & LDAP_DEREF_SEARCHING ) {
 745                         /* but if the search base is an alias, and we didn't
 746                          * deref it when finding, return it.
 747                          */
 748                         if ( is_entry_alias(e) &&
 749                                 ((op->ors_deref & LDAP_DEREF_FINDING) ||
 750                                         !bvmatch(&e->e_nname, &op->o_req_ndn)))
 751                         {
 752                                 goto loop_continue;
 753                         }
 754                 }
 755
 756                 if ( !manageDSAit && is_entry_glue( e )) {
 757                         goto loop_continue;
 758                 }
 759
 760                 if (e != base) {
 761                         struct berval pdn, pndn;
 762                         char *d, *n;
 763                         int i;
 764                         /* child of base, just append RDNs to base->e_name */
 765                         if ( isc.nscope == 1 ) {
 766                                 pdn = base->e_name;
 767                                 pndn = base->e_nname;
 768                         } else {
 769                                 mdb_id2name( op, ltid, &isc.mc, scopes[isc.nscope].mid, &pdn, &pndn );
 770                         }
 771                         e->e_name.bv_len = pdn.bv_len;
 772                         e->e_nname.bv_len = pndn.bv_len;
 773                         for (i=0; i<isc.numrdns; i++) {
 774                                 e->e_name.bv_len += isc.rdns[i].bv_len + 1;
 775                                 e->e_nname.bv_len += isc.nrdns[i].bv_len + 1;
 776                         }
 777                         e->e_name.bv_val = op->o_tmpalloc(e->e_name.bv_len + 1, op->o_tmpmemctx);
 778                         e->e_nname.bv_val = op->o_tmpalloc(e->e_nname.bv_len + 1, op->o_tmpmemctx);
 779                         d = e->e_name.bv_val;
 780                         n = e->e_nname.bv_val;
 781                         for (i=0; i<isc.numrdns; i++) {
 782                                 memcpy(d, isc.rdns[i].bv_val, isc.rdns[i].bv_len);
 783                                 d += isc.rdns[i].bv_len;
 784                                 *d++ = ',';
 785                                 memcpy(n, isc.nrdns[i].bv_val, isc.nrdns[i].bv_len);
 786                                 n += isc.nrdns[i].bv_len;
 787                                 *n++ = ',';
 788                         }
 789                         if (pdn.bv_len) {
 790                                 memcpy(d, pdn.bv_val, pdn.bv_len+1);
 791                                 memcpy(n, pndn.bv_val, pndn.bv_len+1);
 792                         } else {
 793                                 *--d = '\0';
 794                                 *--n = '\0';
 795                                 e->e_name.bv_len--;
 796                                 e->e_nname.bv_len--;
 797                         }
 798                         if (isc.nscope != 1) {
 799                                 op->o_tmpfree(pndn.bv_val, op->o_tmpmemctx);
 800                                 op->o_tmpfree(pdn.bv_val, op->o_tmpmemctx);
 801                         }
 802                 }
 803
 804                 /*
 805                  * if it's a referral, add it to the list of referrals. only do
 806                  * this for non-base searches, and don't check the filter
 807                  * explicitly here since it's only a candidate anyway.
 808                  */
 809                 if ( !manageDSAit && op->oq_search.rs_scope != LDAP_SCOPE_BASE
 810                         && is_entry_referral( e ) )
 811                 {
 812                         BerVarray erefs = get_entry_referrals( op, e );
 813                         rs->sr_ref = referral_rewrite( erefs, &e->e_name, NULL,
 814                                 op->oq_search.rs_scope == LDAP_SCOPE_ONELEVEL
 815                                         ? LDAP_SCOPE_BASE : LDAP_SCOPE_SUBTREE );
 816
 817                         rs->sr_entry = e;
 818                         rs->sr_flags = 0;
 819
 820                         send_search_reference( op, rs );
 821
 822                         mdb_entry_return( op, e );
 823                         rs->sr_entry = NULL;
 824                         e = NULL;
 825
 826                         ber_bvarray_free( rs->sr_ref );
 827                         ber_bvarray_free( erefs );
 828                         rs->sr_ref = NULL;
 829
 830                         goto loop_continue;
 831                 }
 832
 833                 /* if it matches the filter and scope, send it */
 834                 rs->sr_err = test_filter( op, e, op->oq_search.rs_filter );
 835
 836                 if ( rs->sr_err == LDAP_COMPARE_TRUE ) {
 837                         /* check size limit */
 838                         if ( get_pagedresults(op) > SLAP_CONTROL_IGNORED ) {
 839                                 if ( rs->sr_nentries >= ((PagedResultsState *)op->o_pagedresults_state)->ps_size ) {
 840                                         mdb_entry_return( op, e );
 841                                         e = NULL;
 842                                         send_paged_response( op, rs, &lastid, tentries );
 843                                         goto done;
 844                                 }
 845                                 lastid = id;
 846                         }
 847
 848                         if (e) {
 849                                 /* safe default */
 850                                 rs->sr_attrs = op->oq_search.rs_attrs;
 851                                 rs->sr_operational_attrs = NULL;
 852                                 rs->sr_ctrls = NULL;
 853                                 rs->sr_entry = e;
 854                                 RS_ASSERT( e->e_private != NULL );
 855                                 rs->sr_flags = 0;
 856                                 rs->sr_err = LDAP_SUCCESS;
 857                                 rs->sr_err = send_search_entry( op, rs );
 858                                 rs->sr_attrs = NULL;
 859                                 rs->sr_entry = NULL;
 860                                 if (e != base)
 861                                         mdb_entry_return( op, e );
 862                                 e = NULL;
 863
 864                                 switch ( rs->sr_err ) {
 865                                 case LDAP_SUCCESS:      /* entry sent ok */
 866                                         break;
 867                                 default:                /* entry not sent */
 868                                         break;
 869                                 case LDAP_UNAVAILABLE:
 870                                 case LDAP_SIZELIMIT_EXCEEDED:
 871                                         if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED ) {
 872                                                 rs->sr_ref = rs->sr_v2ref;
 873                                                 send_ldap_result( op, rs );
 874                                                 rs->sr_err = LDAP_SUCCESS;
 875
 876                                         } else {
 877                                                 rs->sr_err = LDAP_OTHER;
 878                                         }
 879                                         goto done;
 880                                 }
 881                         }
 882
 883                 } else {
 884                         Debug( LDAP_DEBUG_TRACE,
 885                                 LDAP_XSTRING(mdb_search)
 886                                 ": %ld does not match filter\n",
 887                                 (long) id, 0, 0 );
 888                 }
 889
 890 loop_continue:
 891                 if( e != NULL ) {
 892                         if ( e != base )
 893                                 mdb_entry_return( op, e );
 894                         RS_ASSERT( rs->sr_entry == NULL );
 895                         e = NULL;
 896                         rs->sr_entry = NULL;
 897                 }
 898         }
 899
 900 nochange:
 901         rs->sr_ctrls = NULL;
 902         rs->sr_ref = rs->sr_v2ref;
 903         rs->sr_err = (rs->sr_v2ref == NULL) ? LDAP_SUCCESS : LDAP_REFERRAL;
 904         rs->sr_rspoid = NULL;
 905         if ( get_pagedresults(op) > SLAP_CONTROL_IGNORED ) {
 906                 send_paged_response( op, rs, NULL, 0 );
 907         } else {
 908                 send_ldap_result( op, rs );
 909         }
 910
 911         rs->sr_err = LDAP_SUCCESS;
 912
 913 done:
 914         if( isc.mc )
 915                 mdb_cursor_close( isc.mc );
 916         if (mci)
 917                 mdb_cursor_close( mci );
 918         if ( moi == &opinfo ) {
 919                 mdb_txn_reset( moi->moi_txn );
 920                 LDAP_SLIST_REMOVE( &op->o_extra, &moi->moi_oe, OpExtra, oe_next );
 921         }
 922         if( rs->sr_v2ref ) {
 923                 ber_bvarray_free( rs->sr_v2ref );
 924                 rs->sr_v2ref = NULL;
 925         }
 926         if (base)
 927                 mdb_entry_return( op,base);
 928         scope_chunk_ret( op, scopes );
 929
 930         return rs->sr_err;
 931 }
 932
 933
 934 static int base_candidate(
 935         BackendDB       *be,
 936         Entry   *e,
 937         ID              *ids )
 938 {
 939         Debug(LDAP_DEBUG_ARGS, "base_candidates: base: \"%s\" (0x%08lx)\n",
 940                 e->e_nname.bv_val, (long) e->e_id, 0);
 941
 942         ids[0] = 1;
 943         ids[1] = e->e_id;
 944         return 0;
 945 }
 946
 947 /* Look for "objectClass Present" in this filter.
 948  * Also count depth of filter tree while we're at it.
 949  */
 950 static int oc_filter(
 951         Filter *f,
 952         int cur,
 953         int *max )
 954 {
 955         int rc = 0;
 956
 957         assert( f != NULL );
 958
 959         if( cur > *max ) *max = cur;
 960
 961         switch( f->f_choice ) {
 962         case LDAP_FILTER_PRESENT:
 963                 if (f->f_desc == slap_schema.si_ad_objectClass) {
 964                         rc = 1;
 965                 }
 966                 break;
 967
 968         case LDAP_FILTER_AND:
 969         case LDAP_FILTER_OR:
 970                 cur++;
 971                 for ( f=f->f_and; f; f=f->f_next ) {
 972                         (void) oc_filter(f, cur, max);
 973                 }
 974                 break;
 975
 976         default:
 977                 break;
 978         }
 979         return rc;
 980 }
 981
 982 static void search_stack_free( void *key, void *data )
 983 {
 984         ber_memfree_x(data, NULL);
 985 }
 986
 987 static void *search_stack( Operation *op )
 988 {
 989         struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
 990         void *ret = NULL;
 991
 992         if ( op->o_threadctx ) {
 993                 ldap_pvt_thread_pool_getkey( op->o_threadctx, (void *)search_stack,
 994                         &ret, NULL );
 995         } else {
 996                 ret = mdb->mi_search_stack;
 997         }
 998
 999         if ( !ret ) {
1000                 ret = ch_malloc( mdb->mi_search_stack_depth * MDB_IDL_UM_SIZE
1001                         * sizeof( ID ) );
1002                 if ( op->o_threadctx ) {
1003                         ldap_pvt_thread_pool_setkey( op->o_threadctx, (void *)search_stack,
1004                                 ret, search_stack_free, NULL, NULL );
1005                 } else {
1006                         mdb->mi_search_stack = ret;
1007                 }
1008         }
1009         return ret;
1010 }
1011
1012 static int search_candidates(
1013         Operation *op,
1014         SlapReply *rs,
1015         Entry *e,
1016         MDB_txn *txn,
1017         MDB_cursor *mci,
1018         ID      *ids,
1019         ID2L    scopes )
1020 {
1021         struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
1022         int rc, depth = 1;
1023         Filter          *f, rf, xf, nf, sf;
1024         ID              *stack;
1025         AttributeAssertion aa_ref = ATTRIBUTEASSERTION_INIT;
1026         AttributeAssertion aa_subentry = ATTRIBUTEASSERTION_INIT;
1027
1028         /*
1029          * This routine takes as input a filter (user-filter)
1030          * and rewrites it as follows:
1031          *      (&(scope=DN)[(objectClass=subentry)]
1032          *              (|[(objectClass=referral)](user-filter))
1033          */
1034
1035         Debug(LDAP_DEBUG_TRACE,
1036                 "search_candidates: base=\"%s\" (0x%08lx) scope=%d\n",
1037                 e->e_nname.bv_val, (long) e->e_id, op->oq_search.rs_scope );
1038
1039         f = op->oq_search.rs_filter;
1040
1041         /* If the user's filter uses objectClass=*,
1042          * these clauses are redundant.
1043          */
1044         if (!oc_filter(op->oq_search.rs_filter, 1, &depth)
1045                 && !get_subentries_visibility(op)) {
1046                 if( !get_manageDSAit(op) && !get_domainScope(op) ) {
1047                         /* match referral objects */
1048                         struct berval bv_ref = BER_BVC( "referral" );
1049                         rf.f_choice = LDAP_FILTER_EQUALITY;
1050                         rf.f_ava = &aa_ref;
1051                         rf.f_av_desc = slap_schema.si_ad_objectClass;
1052                         rf.f_av_value = bv_ref;
1053                         rf.f_next = f;
1054                         xf.f_or = &rf;
1055                         xf.f_choice = LDAP_FILTER_OR;
1056                         xf.f_next = NULL;
1057                         f = &xf;
1058                         depth++;
1059                 }
1060         }
1061
1062         if( get_subentries_visibility( op ) ) {
1063                 struct berval bv_subentry = BER_BVC( "subentry" );
1064                 sf.f_choice = LDAP_FILTER_EQUALITY;
1065                 sf.f_ava = &aa_subentry;
1066                 sf.f_av_desc = slap_schema.si_ad_objectClass;
1067                 sf.f_av_value = bv_subentry;
1068                 sf.f_next = f;
1069                 nf.f_choice = LDAP_FILTER_AND;
1070                 nf.f_and = &sf;
1071                 nf.f_next = NULL;
1072                 f = &nf;
1073                 depth++;
1074         }
1075
1076         /* Allocate IDL stack, plus 1 more for former tmp */
1077         if ( depth+1 > mdb->mi_search_stack_depth ) {
1078                 stack = ch_malloc( (depth + 1) * MDB_IDL_UM_SIZE * sizeof( ID ) );
1079         } else {
1080                 stack = search_stack( op );
1081         }
1082
1083         if( op->ors_deref & LDAP_DEREF_SEARCHING ) {
1084                 rc = search_aliases( op, rs, e->e_id, txn, mci, scopes, stack );
1085         } else {
1086                 rc = LDAP_SUCCESS;
1087         }
1088
1089         if ( rc == LDAP_SUCCESS ) {
1090                 rc = mdb_filter_candidates( op, txn, f, ids,
1091                         stack, stack+MDB_IDL_UM_SIZE );
1092         }
1093
1094         if ( depth+1 > mdb->mi_search_stack_depth ) {
1095                 ch_free( stack );
1096         }
1097
1098         if( rc ) {
1099                 Debug(LDAP_DEBUG_TRACE,
1100                         "mdb_search_candidates: failed (rc=%d)\n",
1101                         rc, NULL, NULL );
1102
1103         } else {
1104                 Debug(LDAP_DEBUG_TRACE,
1105                         "mdb_search_candidates: id=%ld first=%ld last=%ld\n",
1106                         (long) ids[0],
1107                         (long) MDB_IDL_FIRST(ids),
1108                         (long) MDB_IDL_LAST(ids) );
1109         }
1110
1111         return rc;
1112 }
1113
1114 static int
1115 parse_paged_cookie( Operation *op, SlapReply *rs )
1116 {
1117         int             rc = LDAP_SUCCESS;
1118         PagedResultsState *ps = op->o_pagedresults_state;
1119
1120         /* this function must be invoked only if the pagedResults
1121          * control has been detected, parsed and partially checked
1122          * by the frontend */
1123         assert( get_pagedresults( op ) > SLAP_CONTROL_IGNORED );
1124
1125         /* cookie decoding/checks deferred to backend... */
1126         if ( ps->ps_cookieval.bv_len ) {
1127                 PagedResultsCookie reqcookie;
1128                 if( ps->ps_cookieval.bv_len != sizeof( reqcookie ) ) {
1129                         /* bad cookie */
1130                         rs->sr_text = "paged results cookie is invalid";
1131                         rc = LDAP_PROTOCOL_ERROR;
1132                         goto done;
1133                 }
1134
1135                 AC_MEMCPY( &reqcookie, ps->ps_cookieval.bv_val, sizeof( reqcookie ));
1136
1137                 if ( reqcookie > ps->ps_cookie ) {
1138                         /* bad cookie */
1139                         rs->sr_text = "paged results cookie is invalid";
1140                         rc = LDAP_PROTOCOL_ERROR;
1141                         goto done;
1142
1143                 } else if ( reqcookie < ps->ps_cookie ) {
1144                         rs->sr_text = "paged results cookie is invalid or old";
1145                         rc = LDAP_UNWILLING_TO_PERFORM;
1146                         goto done;
1147                 }
1148
1149         } else {
1150                 /* we're going to use ps_cookie */
1151                 op->o_conn->c_pagedresults_state.ps_cookie = 0;
1152         }
1153
1154 done:;
1155
1156         return rc;
1157 }
1158
1159 static void
1160 send_paged_response(
1161         Operation       *op,
1162         SlapReply       *rs,
1163         ID              *lastid,
1164         int             tentries )
1165 {
1166         LDAPControl     *ctrls[2];
1167         BerElementBuffer berbuf;
1168         BerElement      *ber = (BerElement *)&berbuf;
1169         PagedResultsCookie respcookie;
1170         struct berval cookie;
1171
1172         Debug(LDAP_DEBUG_ARGS,
1173                 "send_paged_response: lastid=0x%08lx nentries=%d\n",
1174                 lastid ? *lastid : 0, rs->sr_nentries, NULL );
1175
1176         ctrls[1] = NULL;
1177
1178         ber_init2( ber, NULL, LBER_USE_DER );
1179
1180         if ( lastid ) {
1181                 respcookie = ( PagedResultsCookie )(*lastid);
1182                 cookie.bv_len = sizeof( respcookie );
1183                 cookie.bv_val = (char *)&respcookie;
1184
1185         } else {
1186                 respcookie = ( PagedResultsCookie )0;
1187                 BER_BVSTR( &cookie, "" );
1188         }
1189
1190         op->o_conn->c_pagedresults_state.ps_cookie = respcookie;
1191         op->o_conn->c_pagedresults_state.ps_count =
1192                 ((PagedResultsState *)op->o_pagedresults_state)->ps_count +
1193                 rs->sr_nentries;
1194
1195         /* return size of 0 -- no estimate */
1196         ber_printf( ber, "{iO}", 0, &cookie );
1197
1198         ctrls[0] = op->o_tmpalloc( sizeof(LDAPControl), op->o_tmpmemctx );
1199         if ( ber_flatten2( ber, &ctrls[0]->ldctl_value, 0 ) == -1 ) {
1200                 goto done;
1201         }
1202
1203         ctrls[0]->ldctl_oid = LDAP_CONTROL_PAGEDRESULTS;
1204         ctrls[0]->ldctl_iscritical = 0;
1205
1206         slap_add_ctrls( op, rs, ctrls );
1207         rs->sr_err = LDAP_SUCCESS;
1208         send_ldap_result( op, rs );
1209
1210 done:
1211         (void) ber_free_buf( ber );
1212 }