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

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1998-2004 The OpenLDAP Foundation.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted only as authorized by the OpenLDAP
   9  * Public License.
  10  *
  11  * A copy of this license is available in the file LICENSE in the
  12  * top-level directory of the distribution or, alternatively, at
  13  * <http://www.OpenLDAP.org/license.html>.
  14  */
  15 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
  16  * All rights reserved.
  17  *
  18  * Redistribution and use in source and binary forms are permitted
  19  * provided that this notice is preserved and that due credit is given
  20  * to the University of Michigan at Ann Arbor. The name of the University
  21  * may not be used to endorse or promote products derived from this
  22  * software without specific prior written permission. This software
  23  * is provided ``as is'' without express or implied warranty.
  24  */
  25
  26 #include "portable.h"
  27
  28 #include <stdio.h>
  29
  30 #include <ac/string.h>
  31 #include <ac/socket.h>
  32
  33 #include "lutil.h"
  34 #include "slap.h"
  35
  36 #ifdef LDAP_SLAPI
  37 #include "slapi/slapi.h"
  38
  39 static void init_search_pblock( Operation *op, char **attrs, int managedsait );
  40 static int call_search_preop_plugins( Operation *op );
  41 static int call_search_rewrite_plugins( Operation *op );
  42 static void call_search_postop_plugins( Operation *op );
  43 #endif /* LDAPI_SLAPI */
  44
  45 int
  46 do_search(
  47     Operation   *op,    /* info about the op to which we're responding */
  48     SlapReply   *rs     /* all the response data we'll send */ )
  49 {
  50         struct berval base = BER_BVNULL;
  51         ber_len_t       siz, off, i;
  52
  53         Debug( LDAP_DEBUG_TRACE, "do_search\n", 0, 0, 0 );
  54
  55         /*
  56          * Parse the search request.  It looks like this:
  57          *
  58          *      SearchRequest := [APPLICATION 3] SEQUENCE {
  59          *              baseObject      DistinguishedName,
  60          *              scope           ENUMERATED {
  61          *                      baseObject      (0),
  62          *                      singleLevel     (1),
  63          *                      wholeSubtree (2),
  64          *          subordinate (3)  -- OpenLDAP extension
  65          *              },
  66          *              derefAliases    ENUMERATED {
  67          *                      neverDerefaliases       (0),
  68          *                      derefInSearching        (1),
  69          *                      derefFindingBaseObj     (2),
  70          *                      alwaysDerefAliases      (3)
  71          *              },
  72          *              sizelimit       INTEGER (0 .. 65535),
  73          *              timelimit       INTEGER (0 .. 65535),
  74          *              attrsOnly       BOOLEAN,
  75          *              filter          Filter,
  76          *              attributes      SEQUENCE OF AttributeType
  77          *      }
  78          */
  79
  80         /* baseObject, scope, derefAliases, sizelimit, timelimit, attrsOnly */
  81         if ( ber_scanf( op->o_ber, "{miiiib" /*}*/,
  82                 &base, &op->ors_scope, &op->ors_deref, &op->ors_slimit,
  83             &op->ors_tlimit, &op->ors_attrsonly ) == LBER_ERROR )
  84         {
  85                 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
  86                 rs->sr_err = SLAPD_DISCONNECT;
  87                 goto return_results;
  88         }
  89
  90         if ( op->ors_tlimit < 0 || op->ors_tlimit > SLAP_MAX_LIMIT ) {
  91                 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid time limit" );
  92                 goto return_results;
  93         }
  94
  95         if ( op->ors_slimit < 0 || op->ors_slimit > SLAP_MAX_LIMIT ) {
  96                 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid size limit" );
  97                 goto return_results;
  98         }
  99
 100         switch( op->ors_scope ) {
 101         case LDAP_SCOPE_BASE:
 102         case LDAP_SCOPE_ONELEVEL:
 103         case LDAP_SCOPE_SUBTREE:
 104 #ifdef LDAP_SCOPE_SUBORDINATE
 105         case LDAP_SCOPE_SUBORDINATE:
 106 #endif
 107                 break;
 108         default:
 109                 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid scope" );
 110                 goto return_results;
 111         }
 112
 113         switch( op->ors_deref ) {
 114         case LDAP_DEREF_NEVER:
 115         case LDAP_DEREF_FINDING:
 116         case LDAP_DEREF_SEARCHING:
 117         case LDAP_DEREF_ALWAYS:
 118                 break;
 119         default:
 120                 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid deref" );
 121                 goto return_results;
 122         }
 123
 124         rs->sr_err = dnPrettyNormal( NULL, &base, &op->o_req_dn, &op->o_req_ndn, op->o_tmpmemctx );
 125         if( rs->sr_err != LDAP_SUCCESS ) {
 126                 Debug( LDAP_DEBUG_ANY,
 127                         "do_search: invalid dn (%s)\n", base.bv_val, 0, 0 );
 128                 send_ldap_error( op, rs, LDAP_INVALID_DN_SYNTAX, "invalid DN" );
 129                 goto return_results;
 130         }
 131
 132         Debug( LDAP_DEBUG_ARGS, "SRCH \"%s\" %d %d",
 133                 base.bv_val, op->ors_scope, op->ors_deref );
 134         Debug( LDAP_DEBUG_ARGS, "    %d %d %d\n",
 135                 op->ors_slimit, op->ors_tlimit, op->ors_attrsonly);
 136
 137         /* filter - returns a "normalized" version */
 138         rs->sr_err = get_filter( op, op->o_ber, &op->ors_filter, &rs->sr_text );
 139         if( rs->sr_err != LDAP_SUCCESS ) {
 140                 if( rs->sr_err == SLAPD_DISCONNECT ) {
 141                         rs->sr_err = LDAP_PROTOCOL_ERROR;
 142                         send_ldap_disconnect( op, rs );
 143                         rs->sr_err = SLAPD_DISCONNECT;
 144                 } else {
 145                         send_ldap_result( op, rs );
 146                 }
 147                 goto return_results;
 148         }
 149         filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
 150
 151         Debug( LDAP_DEBUG_ARGS, "    filter: %s\n",
 152                 !BER_BVISEMPTY( &op->ors_filterstr ) ? op->ors_filterstr.bv_val : "empty", 0, 0 );
 153
 154         /* attributes */
 155         siz = sizeof(AttributeName);
 156         off = offsetof(AttributeName,an_name);
 157         if ( ber_scanf( op->o_ber, "{M}}", &op->ors_attrs, &siz, off ) == LBER_ERROR ) {
 158                 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding attrs error" );
 159                 rs->sr_err = SLAPD_DISCONNECT;
 160                 goto return_results;
 161         }
 162         for ( i=0; i<siz; i++ ) {
 163                 const char *dummy;      /* ignore msgs from bv2ad */
 164                 op->ors_attrs[i].an_desc = NULL;
 165                 op->ors_attrs[i].an_oc = NULL;
 166                 op->ors_attrs[i].an_oc_exclude = 0;
 167                 slap_bv2ad(&op->ors_attrs[i].an_name, &op->ors_attrs[i].an_desc, &dummy);
 168         }
 169
 170         if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
 171                 Debug( LDAP_DEBUG_ANY, "do_search: get_ctrls failed\n", 0, 0, 0 );
 172
 173                 goto return_results;
 174         }
 175
 176         Debug( LDAP_DEBUG_ARGS, "    attrs:", 0, 0, 0 );
 177
 178         if ( siz != 0 ) {
 179                 for ( i = 0; i<siz; i++ ) {
 180                         Debug( LDAP_DEBUG_ARGS, " %s", op->ors_attrs[i].an_name.bv_val, 0, 0 );
 181                 }
 182         }
 183
 184         Debug( LDAP_DEBUG_ARGS, "\n", 0, 0, 0 );
 185
 186         if ( StatslogTest( LDAP_DEBUG_STATS ) ) {
 187                 char abuf[BUFSIZ/2], *ptr = abuf;
 188                 int len = 0, alen;
 189
 190                 sprintf(abuf, "scope=%d deref=%d", op->ors_scope, op->ors_deref);
 191                 Statslog( LDAP_DEBUG_STATS,
 192                         "%s SRCH base=\"%s\" %s filter=\"%s\"\n",
 193                         op->o_log_prefix, op->o_req_dn.bv_val, abuf,
 194                         op->ors_filterstr.bv_val, 0 );
 195
 196                 for ( i = 0; i<siz; i++ ) {
 197                         alen = op->ors_attrs[i].an_name.bv_len;
 198                         if (alen >= sizeof(abuf)) {
 199                                 alen = sizeof(abuf)-1;
 200                         }
 201                         if (len && (len + 1 + alen >= sizeof(abuf))) {
 202                                 Statslog( LDAP_DEBUG_STATS, "%s SRCH attr=%s\n",
 203                                     op->o_log_prefix, abuf, 0, 0, 0 );
 204                                 len = 0;
 205                                 ptr = abuf;
 206                         }
 207                         if (len) {
 208                                 *ptr++ = ' ';
 209                                 len++;
 210                         }
 211                         ptr = lutil_strncopy(ptr, op->ors_attrs[i].an_name.bv_val, alen);
 212                         len += alen;
 213                         *ptr = '\0';
 214                 }
 215                 if (len) {
 216                         Statslog( LDAP_DEBUG_STATS, "%s SRCH attr=%s\n",
 217                                 op->o_log_prefix, abuf, 0, 0, 0 );
 218                 }
 219         }
 220
 221         op->o_bd = frontendDB;
 222         rs->sr_err = frontendDB->be_search( op, rs );
 223
 224 return_results:;
 225         if ( ( op->o_sync_mode & SLAP_SYNC_PERSIST ) ) {
 226                 return rs->sr_err;
 227         }
 228         if ( ( op->o_sync_slog_size != -1 ) ) {
 229                 return rs->sr_err;
 230         }
 231         if ( !BER_BVISNULL( &op->o_req_dn ) ) {
 232                 slap_sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
 233         }
 234         if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
 235                 slap_sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
 236         }
 237         if ( !BER_BVISNULL( &op->ors_filterstr ) ) {
 238                 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
 239         }
 240         if ( op->ors_filter != NULL) {
 241                 filter_free_x( op, op->ors_filter );
 242         }
 243         if ( op->ors_attrs != NULL ) {
 244                 op->o_tmpfree( op->ors_attrs, op->o_tmpmemctx );
 245         }
 246
 247         return rs->sr_err;
 248 }
 249
 250 int
 251 fe_op_search( Operation *op, SlapReply *rs )
 252 {
 253         int                     manageDSAit;
 254         int                     be_manageDSAit;
 255 #ifdef LDAP_SLAPI
 256         char                    **attrs = NULL;
 257 #endif
 258
 259         manageDSAit = get_manageDSAit( op );
 260
 261         /* fake while loop to allow breaking out */
 262         while ( op->ors_scope == LDAP_SCOPE_BASE ) {
 263                 Entry *entry = NULL;
 264
 265                 if ( BER_BVISEMPTY( &op->o_req_ndn ) ) {
 266 #ifdef LDAP_CONNECTIONLESS
 267                         /* Ignore LDAPv2 CLDAP Root DSE queries */
 268                         if (op->o_protocol == LDAP_VERSION2 && op->o_conn->c_is_udp) {
 269                                 goto return_results;
 270                         }
 271 #endif
 272                         /* check restrictions */
 273                         if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
 274                                 send_ldap_result( op, rs );
 275                                 goto return_results;
 276                         }
 277
 278 #ifdef LDAP_SLAPI
 279                         if ( op->o_pb ) {
 280                                 attrs = anlist2charray_x( op->ors_attrs, 0, op->o_tmpmemctx );
 281                                 init_search_pblock( op, attrs, manageDSAit );
 282                                 rs->sr_err = call_search_preop_plugins( op );
 283                                 if ( rs->sr_err ) break;
 284                                 call_search_rewrite_plugins( op );
 285                         }
 286 #endif /* LDAP_SLAPI */
 287                         rs->sr_err = root_dse_info( op->o_conn, &entry, &rs->sr_text );
 288
 289                 } else if ( bvmatch( &op->o_req_ndn, &frontendDB->be_schemandn ) ) {
 290                         /* check restrictions */
 291                         if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
 292                                 send_ldap_result( op, rs );
 293                                 goto return_results;
 294                         }
 295
 296 #ifdef LDAP_SLAPI
 297                         if ( op->o_pb ) {
 298                                 attrs = anlist2charray_x( op->ors_attrs, 0, op->o_tmpmemctx );
 299                                 init_search_pblock( op, attrs, manageDSAit );
 300                                 rs->sr_err = call_search_preop_plugins( op );
 301                                 if ( rs->sr_err ) break;
 302                                 call_search_rewrite_plugins( op );
 303                         }
 304 #endif /* LDAP_SLAPI */
 305                         rs->sr_err = schema_info( &entry, &rs->sr_text );
 306                 }
 307
 308                 if( rs->sr_err != LDAP_SUCCESS ) {
 309                         send_ldap_result( op, rs );
 310 #ifdef LDAP_SLAPI
 311                         if ( op->o_pb ) call_search_postop_plugins( op );
 312 #endif /* LDAP_SLAPI */
 313                         goto return_results;
 314
 315                 } else if ( entry != NULL ) {
 316                         rs->sr_err = test_filter( op, entry, op->ors_filter );
 317
 318                         if( rs->sr_err == LDAP_COMPARE_TRUE ) {
 319                                 rs->sr_entry = entry;
 320                                 rs->sr_attrs = op->ors_attrs;
 321                                 rs->sr_operational_attrs = NULL;
 322                                 send_search_entry( op, rs );
 323                                 rs->sr_entry = NULL;
 324                                 rs->sr_operational_attrs = NULL;
 325                         }
 326                         entry_free( entry );
 327
 328                         rs->sr_err = LDAP_SUCCESS;
 329                         send_ldap_result( op, rs );
 330 #ifdef LDAP_SLAPI
 331                         if ( op->o_pb ) call_search_postop_plugins( op );
 332 #endif /* LDAP_SLAPI */
 333                         goto return_results;
 334                 }
 335                 break;
 336         }
 337
 338         if( BER_BVISEMPTY( &op->o_req_ndn ) && !BER_BVISEMPTY( &default_search_nbase ) ) {
 339                 slap_sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
 340                 slap_sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
 341
 342                 ber_dupbv_x( &op->o_req_dn, &default_search_base, op->o_tmpmemctx );
 343                 ber_dupbv_x( &op->o_req_ndn, &default_search_nbase, op->o_tmpmemctx );
 344         }
 345
 346         /*
 347          * We could be serving multiple database backends.  Select the
 348          * appropriate one, or send a referral to our "referral server"
 349          * if we don't hold it.
 350          */
 351
 352         /* Sync control overrides manageDSAit */
 353
 354         if ( manageDSAit != SLAP_NO_CONTROL ) {
 355                 if ( op->o_sync_mode & SLAP_SYNC_REFRESH ) {
 356                         be_manageDSAit = SLAP_NO_CONTROL;
 357                 } else {
 358                         be_manageDSAit = manageDSAit;
 359                 }
 360         } else {
 361                 be_manageDSAit = manageDSAit;
 362         }
 363
 364         op->o_bd = select_backend( &op->o_req_ndn, be_manageDSAit, 1 );
 365         if ( op->o_bd == NULL ) {
 366                 rs->sr_ref = referral_rewrite( default_referral,
 367                         NULL, &op->o_req_dn, op->ors_scope );
 368
 369                 if (!rs->sr_ref) rs->sr_ref = default_referral;
 370                 rs->sr_err = LDAP_REFERRAL;
 371                 send_ldap_result( op, rs );
 372
 373                 if (rs->sr_ref != default_referral)
 374                 ber_bvarray_free( rs->sr_ref );
 375                 rs->sr_ref = NULL;
 376                 goto return_results;
 377         }
 378
 379         /* check restrictions */
 380         if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
 381                 send_ldap_result( op, rs );
 382                 goto return_results;
 383         }
 384
 385         /* check for referrals */
 386         if( backend_check_referrals( op, rs ) != LDAP_SUCCESS ) {
 387                 goto return_results;
 388         }
 389
 390 #ifdef LDAP_SLAPI
 391         if ( op->o_pb ) {
 392                 attrs = anlist2charray_x( op->ors_attrs, 0, op->o_tmpmemctx );
 393                 init_search_pblock( op, attrs, manageDSAit );
 394                 rs->sr_err = call_search_preop_plugins( op );
 395                 if ( rs->sr_err != LDAP_SUCCESS ) {
 396                         goto return_results;
 397                 }
 398
 399                 call_search_rewrite_plugins( op );
 400         }
 401 #endif /* LDAP_SLAPI */
 402
 403         /* actually do the search and send the result(s) */
 404         if ( op->o_bd->be_search ) {
 405                 if ( limits_check( op, rs ) == 0 ) {
 406                         (op->o_bd->be_search)( op, rs );
 407                 }
 408                 /* else limits_check() sends error */
 409
 410         } else {
 411                 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
 412                         "operation not supported within namingContext" );
 413         }
 414
 415 #ifdef LDAP_SLAPI
 416         if ( op->o_pb ) call_search_postop_plugins( op );
 417 #endif /* LDAP_SLAPI */
 418
 419 #ifdef LDAP_SLAPI
 420         if( attrs != NULL) op->o_tmpfree( attrs, op->o_tmpmemctx );
 421 #endif /* LDAP_SLAPI */
 422
 423 return_results:;
 424         return rs->sr_err;
 425 }
 426
 427 #ifdef LDAP_SLAPI
 428
 429 static void init_search_pblock( Operation *op,
 430         char **attrs, int managedsait )
 431 {
 432         slapi_int_pblock_set_operation( op->o_pb, op );
 433         slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TARGET, (void *)op->o_req_dn.bv_val );
 434         slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SCOPE, (void *)op->ors_scope );
 435         slapi_pblock_set( op->o_pb, SLAPI_SEARCH_DEREF, (void *)op->ors_deref );
 436         slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SIZELIMIT, (void *)op->ors_slimit );
 437         slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TIMELIMIT, (void *)op->ors_tlimit );
 438         slapi_pblock_set( op->o_pb, SLAPI_SEARCH_FILTER, (void *)op->ors_filter );
 439         slapi_pblock_set( op->o_pb, SLAPI_SEARCH_STRFILTER, (void *)op->ors_filterstr.bv_val );
 440         slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRS, (void *)attrs );
 441         slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRSONLY, (void *)op->ors_attrsonly );
 442         slapi_pblock_set( op->o_pb, SLAPI_MANAGEDSAIT, (void *)managedsait );
 443 }
 444
 445 static int call_search_preop_plugins( Operation *op )
 446 {
 447         int rc;
 448
 449         rc = slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_PRE_SEARCH_FN, op->o_pb );
 450         if ( rc < 0 ) {
 451                 /*
 452                  * A preoperation plugin failure will abort the
 453                  * entire operation.
 454                  */
 455                 Debug(LDAP_DEBUG_TRACE, "call_search_preop_plugins: search preoperation plugin "
 456                                 "returned %d.\n", rc, 0, 0);
 457                 if ( ( slapi_pblock_get( op->o_pb, SLAPI_RESULT_CODE, (void *)&rc ) != 0 ) ||
 458                      rc == LDAP_SUCCESS ) {
 459                         rc = LDAP_OTHER;
 460                 }
 461         } else {
 462                 rc = LDAP_SUCCESS;
 463         }
 464
 465         return rc;
 466 }
 467
 468 static int call_search_rewrite_plugins( Operation *op )
 469 {
 470         if ( slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN, op->o_pb ) == 0 ) {
 471                 int rc;
 472
 473                 /*
 474                  * The plugin can set the SLAPI_SEARCH_FILTER.
 475                  * SLAPI_SEARCH_STRFILER is not normative.
 476                  */
 477                 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_FILTER, (void *)&op->ors_filter );
 478                 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
 479                 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
 480
 481                 /*
 482                  * Also permit other search parameters to be reset. One thing
 483                  * this doesn't (yet) deal with is plugins that change a root
 484                  * DSE search to a non-root DSE search...
 485                  */
 486                 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_TARGET, (void **)&op->o_req_dn.bv_val );
 487                 op->o_req_dn.bv_len = strlen( op->o_req_dn.bv_val );
 488
 489                 if( !BER_BVISNULL( &op->o_req_ndn ) ) {
 490                         slap_sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
 491                 }
 492                 rc = dnNormalize( 0, NULL, NULL, &op->o_req_dn, &op->o_req_ndn,
 493                         op->o_tmpmemctx );
 494                 if ( rc != LDAP_SUCCESS ) {
 495                         return rc;
 496                 }
 497
 498                 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_SCOPE, (void **)&op->ors_scope );
 499                 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_DEREF, (void **)&op->ors_deref );
 500
 501                 Debug( LDAP_DEBUG_ARGS, "    after compute_rewrite_search filter: %s\n",
 502                         !BER_BVISEMPTY( &op->ors_filterstr ) ? op->ors_filterstr.bv_val : "empty", 0, 0 );
 503         }
 504
 505         return LDAP_SUCCESS;
 506 }
 507
 508 static void call_search_postop_plugins( Operation *op )
 509 {
 510         if ( slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_POST_SEARCH_FN, op->o_pb ) < 0 ) {
 511                 Debug(LDAP_DEBUG_TRACE, "call_search_postop_plugins: search postoperation plugins "
 512                                 "failed.\n", 0, 0, 0);
 513         }
 514 }
 515
 516 void slapi_int_dummy(void)
 517 {
 518         /*
 519          * XXX slapi_search_internal() was no getting pulled
 520          * in; all manner of linker flags failed to link it.
 521          * FIXME
 522          */
 523         slapi_search_internal( NULL, 0, NULL, NULL, NULL, 0 );
 524 }
 525 #endif /* LDAP_SLAPI */
 526