2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2004 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
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>.
15 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
16 * All rights reserved.
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.
30 #include <ac/string.h>
31 #include <ac/socket.h>
38 #include "slapi/slapi.h"
40 static char **anlist2charray( Operation *op, AttributeName *an );
41 static void init_search_pblock( Operation *op, char **attrs, int managedsait );
42 static int call_search_preop_plugins( Operation *op );
43 static int call_search_rewrite_plugins( Operation *op );
44 static void call_search_postop_plugins( Operation *op );
45 #endif /* LDAPI_SLAPI */
49 Operation *op, /* info about the op to which we're responding */
50 SlapReply *rs /* all the response data we'll send */
52 struct berval base = BER_BVNULL;
53 ber_len_t siz, off, i;
61 LDAP_LOG( OPERATION, ENTRY, "do_search: conn %d\n", op->o_connid, 0, 0 );
63 Debug( LDAP_DEBUG_TRACE, "do_search\n", 0, 0, 0 );
67 * Parse the search request. It looks like this:
69 * SearchRequest := [APPLICATION 3] SEQUENCE {
70 * baseObject DistinguishedName,
76 * derefAliases ENUMERATED {
77 * neverDerefaliases (0),
78 * derefInSearching (1),
79 * derefFindingBaseObj (2),
80 * alwaysDerefAliases (3)
82 * sizelimit INTEGER (0 .. 65535),
83 * timelimit INTEGER (0 .. 65535),
86 * attributes SEQUENCE OF AttributeType
90 /* baseObject, scope, derefAliases, sizelimit, timelimit, attrsOnly */
91 if ( ber_scanf( op->o_ber, "{miiiib" /*}*/,
92 &base, &op->ors_scope, &op->ors_deref, &op->ors_slimit,
93 &op->ors_tlimit, &op->ors_attrsonly ) == LBER_ERROR )
95 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
96 rs->sr_err = SLAPD_DISCONNECT;
100 switch( op->ors_scope ) {
101 case LDAP_SCOPE_BASE:
102 case LDAP_SCOPE_ONELEVEL:
103 case LDAP_SCOPE_SUBTREE:
106 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid scope" );
110 switch( op->ors_deref ) {
111 case LDAP_DEREF_NEVER:
112 case LDAP_DEREF_FINDING:
113 case LDAP_DEREF_SEARCHING:
114 case LDAP_DEREF_ALWAYS:
117 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid deref" );
121 rs->sr_err = dnPrettyNormal( NULL, &base, &op->o_req_dn, &op->o_req_ndn, op->o_tmpmemctx );
122 if( rs->sr_err != LDAP_SUCCESS ) {
124 LDAP_LOG( OPERATION, ERR,
125 "do_search: conn %d invalid dn (%s)\n",
126 op->o_connid, base.bv_val, 0 );
128 Debug( LDAP_DEBUG_ANY,
129 "do_search: invalid dn (%s)\n", base.bv_val, 0, 0 );
131 send_ldap_error( op, rs, LDAP_INVALID_DN_SYNTAX, "invalid DN" );
136 LDAP_LOG( OPERATION, ARGS, "SRCH \"%s\" %d %d",
137 base.bv_val, op->ors_scope, op->ors_deref );
138 LDAP_LOG( OPERATION, ARGS, " %d %d %d\n",
139 op->ors_slimit, op->ors_tlimit, op->ors_attrsonly);
141 Debug( LDAP_DEBUG_ARGS, "SRCH \"%s\" %d %d",
142 base.bv_val, op->ors_scope, op->ors_deref );
143 Debug( LDAP_DEBUG_ARGS, " %d %d %d\n",
144 op->ors_slimit, op->ors_tlimit, op->ors_attrsonly);
147 /* filter - returns a "normalized" version */
148 rs->sr_err = get_filter( op, op->o_ber, &op->ors_filter, &rs->sr_text );
149 if( rs->sr_err != LDAP_SUCCESS ) {
150 if( rs->sr_err == SLAPD_DISCONNECT ) {
151 rs->sr_err = LDAP_PROTOCOL_ERROR;
152 send_ldap_disconnect( op, rs );
154 send_ldap_result( op, rs );
158 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
161 LDAP_LOG( OPERATION, ARGS,
162 "do_search: conn %d filter: %s\n",
163 op->o_connid, op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0 );
165 Debug( LDAP_DEBUG_ARGS, " filter: %s\n",
166 op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0, 0 );
170 siz = sizeof(AttributeName);
171 off = offsetof(AttributeName,an_name);
172 if ( ber_scanf( op->o_ber, "{M}}", &op->ors_attrs, &siz, off ) == LBER_ERROR ) {
173 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding attrs error" );
174 rs->sr_err = SLAPD_DISCONNECT;
177 for ( i=0; i<siz; i++ ) {
178 const char *dummy; /* ignore msgs from bv2ad */
179 op->ors_attrs[i].an_desc = NULL;
180 op->ors_attrs[i].an_oc = NULL;
181 op->ors_attrs[i].an_oc_exclude = 0;
182 slap_bv2ad(&op->ors_attrs[i].an_name, &op->ors_attrs[i].an_desc, &dummy);
185 if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
187 LDAP_LOG( OPERATION, INFO,
188 "do_search: conn %d get_ctrls failed (%d)\n",
189 op->o_connid, rs->sr_err, 0 );
191 Debug( LDAP_DEBUG_ANY, "do_search: get_ctrls failed\n", 0, 0, 0 );
198 LDAP_LOG( OPERATION, ARGS,
199 "do_search: conn %d attrs:", op->o_connid, 0, 0 );
201 Debug( LDAP_DEBUG_ARGS, " attrs:", 0, 0, 0 );
205 for ( i = 0; i<siz; i++ ) {
207 LDAP_LOG( OPERATION, ARGS,
208 "do_search: %s", op->ors_attrs[i].an_name.bv_val, 0, 0 );
210 Debug( LDAP_DEBUG_ARGS, " %s", op->ors_attrs[i].an_name.bv_val, 0, 0 );
216 LDAP_LOG( OPERATION, ARGS, "\n" , 0, 0, 0 );
218 Debug( LDAP_DEBUG_ARGS, "\n", 0, 0, 0 );
221 if ( StatslogTest( LDAP_DEBUG_STATS ) ) {
222 char abuf[BUFSIZ/2], *ptr = abuf;
225 sprintf(abuf, "scope=%d deref=%d", op->ors_scope, op->ors_deref);
226 Statslog( LDAP_DEBUG_STATS,
227 "conn=%lu op=%lu SRCH base=\"%s\" %s filter=\"%s\"\n",
228 op->o_connid, op->o_opid, op->o_req_dn.bv_val, abuf,
229 op->ors_filterstr.bv_val );
231 for ( i = 0; i<siz; i++ ) {
232 alen = op->ors_attrs[i].an_name.bv_len;
233 if (alen >= sizeof(abuf)) {
234 alen = sizeof(abuf)-1;
236 if (len && (len + 1 + alen >= sizeof(abuf))) {
237 Statslog( LDAP_DEBUG_STATS, "conn=%lu op=%lu SRCH attr=%s\n",
238 op->o_connid, op->o_opid, abuf, 0, 0 );
246 ptr = lutil_strncopy(ptr, op->ors_attrs[i].an_name.bv_val, alen);
251 Statslog( LDAP_DEBUG_STATS, "conn=%lu op=%lu SRCH attr=%s\n",
252 op->o_connid, op->o_opid, abuf, 0, 0 );
256 manageDSAit = get_manageDSAit( op );
258 /* fake while loop to allow breaking out */
259 while ( op->ors_scope == LDAP_SCOPE_BASE ) {
262 if ( op->o_req_ndn.bv_len == 0 ) {
263 #ifdef LDAP_CONNECTIONLESS
264 /* Ignore LDAPv2 CLDAP Root DSE queries */
265 if (op->o_protocol == LDAP_VERSION2 && op->o_conn->c_is_udp) {
269 /* check restrictions */
270 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
271 send_ldap_result( op, rs );
277 attrs = anlist2charray( op, op->ors_attrs );
278 init_search_pblock( op, attrs, manageDSAit );
279 rs->sr_err = call_search_preop_plugins( op );
280 if ( rs->sr_err ) break;
281 call_search_rewrite_plugins( op );
283 #endif /* LDAP_SLAPI */
284 rs->sr_err = root_dse_info( op->o_conn, &entry, &rs->sr_text );
286 } else if ( bvmatch( &op->o_req_ndn, &global_schemandn ) ) {
287 /* check restrictions */
288 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
289 send_ldap_result( op, rs );
295 attrs = anlist2charray( op, op->ors_attrs );
296 init_search_pblock( op, attrs, manageDSAit );
297 rs->sr_err = call_search_preop_plugins( op );
298 if ( rs->sr_err ) break;
299 call_search_rewrite_plugins( op );
301 #endif /* LDAP_SLAPI */
302 rs->sr_err = schema_info( &entry, &rs->sr_text );
305 if( rs->sr_err != LDAP_SUCCESS ) {
306 send_ldap_result( op, rs );
308 if ( op->o_pb ) call_search_postop_plugins( op );
309 #endif /* LDAP_SLAPI */
312 } else if ( entry != NULL ) {
313 rs->sr_err = test_filter( op, entry, op->ors_filter );
315 if( rs->sr_err == LDAP_COMPARE_TRUE ) {
316 rs->sr_entry = entry;
317 rs->sr_attrs = op->ors_attrs;
318 send_search_entry( op, rs );
323 rs->sr_err = LDAP_SUCCESS;
324 send_ldap_result( op, rs );
326 if ( op->o_pb ) call_search_postop_plugins( op );
327 #endif /* LDAP_SLAPI */
333 if( !op->o_req_ndn.bv_len && default_search_nbase.bv_len ) {
334 sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
335 sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
337 ber_dupbv_x( &op->o_req_dn, &default_search_base, op->o_tmpmemctx );
338 ber_dupbv_x( &op->o_req_ndn, &default_search_nbase, op->o_tmpmemctx );
342 * We could be serving multiple database backends. Select the
343 * appropriate one, or send a referral to our "referral server"
344 * if we don't hold it.
347 /* Sync control overrides manageDSAit */
349 if ( manageDSAit != SLAP_NO_CONTROL ) {
350 if ( op->o_sync_mode & SLAP_SYNC_REFRESH ) {
351 be_manageDSAit = SLAP_NO_CONTROL;
353 be_manageDSAit = manageDSAit;
356 be_manageDSAit = manageDSAit;
359 op->o_bd = select_backend( &op->o_req_ndn, be_manageDSAit, 1 );
360 if ( op->o_bd == NULL ) {
361 rs->sr_ref = referral_rewrite( default_referral,
362 NULL, &op->o_req_dn, op->ors_scope );
364 if (!rs->sr_ref) rs->sr_ref = default_referral;
365 rs->sr_err = LDAP_REFERRAL;
366 send_ldap_result( op, rs );
368 if (rs->sr_ref != default_referral)
369 ber_bvarray_free( rs->sr_ref );
374 /* check restrictions */
375 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
376 send_ldap_result( op, rs );
380 /* check for referrals */
381 if( backend_check_referrals( op, rs ) != LDAP_SUCCESS ) {
387 attrs = anlist2charray( op, op->ors_attrs );
388 init_search_pblock( op, attrs, manageDSAit );
389 rs->sr_err = call_search_preop_plugins( op );
390 if ( rs->sr_err != LDAP_SUCCESS ) {
394 call_search_rewrite_plugins( op );
396 #endif /* LDAP_SLAPI */
398 /* actually do the search and send the result(s) */
399 if ( op->o_bd->be_search ) {
400 if ( limits_check( op, rs ) == 0 ) {
401 (op->o_bd->be_search)( op, rs );
403 /* else limits_check() sends error */
406 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
407 "operation not supported within namingContext" );
411 if ( op->o_pb ) call_search_postop_plugins( op );
412 #endif /* LDAP_SLAPI */
416 if ( ( op->o_sync_mode & SLAP_SYNC_PERSIST ) )
419 if ( ( op->o_sync_slog_size != -1 ) )
422 if( op->o_req_dn.bv_val != NULL) sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
423 if( op->o_req_ndn.bv_val != NULL) sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
425 if( op->ors_filterstr.bv_val != NULL) op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
426 if( op->ors_filter != NULL) filter_free_x( op, op->ors_filter );
427 if( op->ors_attrs != NULL ) op->o_tmpfree( op->ors_attrs, op->o_tmpmemctx );
429 if( attrs != NULL) op->o_tmpfree( attrs, op->o_tmpmemctx );
430 #endif /* LDAP_SLAPI */
437 static char **anlist2charray( Operation *op, AttributeName *an )
443 for ( i = 0; an[i].an_name.bv_val != NULL; i++ )
445 attrs = (char **)op->o_tmpalloc( (i + 1) * sizeof(char *), op->o_tmpmemctx );
446 for ( i = 0; an[i].an_name.bv_val != NULL; i++ ) {
447 attrs[i] = an[i].an_name.bv_val;
457 static void init_search_pblock( Operation *op,
458 char **attrs, int managedsait )
460 slapi_int_pblock_set_operation( op->o_pb, op );
461 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TARGET, (void *)op->o_req_dn.bv_val );
462 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SCOPE, (void *)op->ors_scope );
463 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_DEREF, (void *)op->ors_deref );
464 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SIZELIMIT, (void *)op->ors_slimit );
465 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TIMELIMIT, (void *)op->ors_tlimit );
466 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_FILTER, (void *)op->ors_filter );
467 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_STRFILTER, (void *)op->ors_filterstr.bv_val );
468 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRS, (void *)attrs );
469 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRSONLY, (void *)op->ors_attrsonly );
470 slapi_pblock_set( op->o_pb, SLAPI_MANAGEDSAIT, (void *)managedsait );
473 static int call_search_preop_plugins( Operation *op )
477 rc = slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_PRE_SEARCH_FN, op->o_pb );
480 * A preoperation plugin failure will abort the
484 LDAP_LOG( OPERATION, INFO, "call_search_preop_plugins: search preoperation plugin "
485 "returned %d\n", rc, 0, 0 );
487 Debug(LDAP_DEBUG_TRACE, "call_search_preop_plugins: search preoperation plugin "
488 "returned %d.\n", rc, 0, 0);
490 if ( ( slapi_pblock_get( op->o_pb, SLAPI_RESULT_CODE, (void *)&rc ) != 0 ) ||
491 rc == LDAP_SUCCESS ) {
501 static int call_search_rewrite_plugins( Operation *op )
503 if ( slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN, op->o_pb ) == 0 ) {
507 * The plugin can set the SLAPI_SEARCH_FILTER.
508 * SLAPI_SEARCH_STRFILER is not normative.
510 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_FILTER, (void *)&op->ors_filter );
511 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
512 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
515 * Also permit other search parameters to be reset. One thing
516 * this doesn't (yet) deal with is plugins that change a root
517 * DSE search to a non-root DSE search...
519 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_TARGET, (void **)&op->o_req_dn.bv_val );
520 op->o_req_dn.bv_len = strlen( op->o_req_dn.bv_val );
522 if( op->o_req_ndn.bv_val != NULL) {
523 sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
525 rc = dnNormalize( 0, NULL, NULL, &op->o_req_dn, &op->o_req_ndn,
527 if ( rc != LDAP_SUCCESS ) {
531 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_SCOPE, (void **)&op->ors_scope );
532 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_DEREF, (void **)&op->ors_deref );
535 LDAP_LOG( OPERATION, ARGS,
536 "call_search_rewrite_plugins: after compute_rewrite_search filter: %s\n",
537 op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0, 0 );
539 Debug( LDAP_DEBUG_ARGS, " after compute_rewrite_search filter: %s\n",
540 op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0, 0 );
547 static void call_search_postop_plugins( Operation *op )
549 if ( slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_POST_SEARCH_FN, op->o_pb ) < 0 ) {
551 LDAP_LOG( OPERATION, INFO, "call_search_postop_plugins: search postoperation plugins "
552 "failed\n", 0, 0, 0 );
554 Debug(LDAP_DEBUG_TRACE, "call_search_postop_plugins: search postoperation plugins "
555 "failed.\n", 0, 0, 0);
560 void slapi_int_dummy(void)
563 * XXX slapi_search_internal() was no getting pulled
564 * in; all manner of linker flags failed to link it.
567 slapi_search_internal( NULL, 0, NULL, NULL, NULL, 0 );
569 #endif /* LDAP_SLAPI */