2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2003 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>
39 static char **anlist2charray( Operation *op, AttributeName *an );
40 static void initSearchPlugin( Operation *op, char **attrs, int managedsait );
41 static int doPreSearchPluginFNs( Operation *op );
42 static int doSearchRewriteFNs( Operation *op );
43 static void doPostSearchPluginFNs( Operation *op );
44 #endif /* LDAPI_SLAPI */
48 Operation *op, /* info about the op to which we're responding */
49 SlapReply *rs /* all the response data we'll send */
51 struct berval base = { 0, NULL };
52 ber_len_t siz, off, i;
60 LDAP_LOG( OPERATION, ENTRY, "do_search: conn %d\n", op->o_connid, 0, 0 );
62 Debug( LDAP_DEBUG_TRACE, "do_search\n", 0, 0, 0 );
66 * Parse the search request. It looks like this:
68 * SearchRequest := [APPLICATION 3] SEQUENCE {
69 * baseObject DistinguishedName,
75 * derefAliases ENUMERATED {
76 * neverDerefaliases (0),
77 * derefInSearching (1),
78 * derefFindingBaseObj (2),
79 * alwaysDerefAliases (3)
81 * sizelimit INTEGER (0 .. 65535),
82 * timelimit INTEGER (0 .. 65535),
85 * attributes SEQUENCE OF AttributeType
89 /* baseObject, scope, derefAliases, sizelimit, timelimit, attrsOnly */
90 if ( ber_scanf( op->o_ber, "{miiiib" /*}*/,
91 &base, &op->ors_scope, &op->ors_deref, &op->ors_slimit,
92 &op->ors_tlimit, &op->ors_attrsonly ) == LBER_ERROR )
94 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
95 rs->sr_err = SLAPD_DISCONNECT;
99 switch( op->ors_scope ) {
100 case LDAP_SCOPE_BASE:
101 case LDAP_SCOPE_ONELEVEL:
102 case LDAP_SCOPE_SUBTREE:
105 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid scope" );
109 switch( op->ors_deref ) {
110 case LDAP_DEREF_NEVER:
111 case LDAP_DEREF_FINDING:
112 case LDAP_DEREF_SEARCHING:
113 case LDAP_DEREF_ALWAYS:
116 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid deref" );
120 rs->sr_err = dnPrettyNormal( NULL, &base, &op->o_req_dn, &op->o_req_ndn, op->o_tmpmemctx );
121 if( rs->sr_err != LDAP_SUCCESS ) {
123 LDAP_LOG( OPERATION, ERR,
124 "do_search: conn %d invalid dn (%s)\n",
125 op->o_connid, base.bv_val, 0 );
127 Debug( LDAP_DEBUG_ANY,
128 "do_search: invalid dn (%s)\n", base.bv_val, 0, 0 );
130 send_ldap_error( op, rs, LDAP_INVALID_DN_SYNTAX, "invalid DN" );
135 LDAP_LOG( OPERATION, ARGS, "SRCH \"%s\" %d %d",
136 base.bv_val, op->ors_scope, op->ors_deref );
137 LDAP_LOG( OPERATION, ARGS, " %d %d %d\n",
138 op->ors_slimit, op->ors_tlimit, op->ors_attrsonly);
140 Debug( LDAP_DEBUG_ARGS, "SRCH \"%s\" %d %d",
141 base.bv_val, op->ors_scope, op->ors_deref );
142 Debug( LDAP_DEBUG_ARGS, " %d %d %d\n",
143 op->ors_slimit, op->ors_tlimit, op->ors_attrsonly);
146 /* filter - returns a "normalized" version */
147 rs->sr_err = get_filter( op, op->o_ber, &op->ors_filter, &rs->sr_text );
148 if( rs->sr_err != LDAP_SUCCESS ) {
149 if( rs->sr_err == SLAPD_DISCONNECT ) {
150 rs->sr_err = LDAP_PROTOCOL_ERROR;
151 send_ldap_disconnect( op, rs );
153 send_ldap_result( op, rs );
157 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
160 LDAP_LOG( OPERATION, ARGS,
161 "do_search: conn %d filter: %s\n",
162 op->o_connid, op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0 );
164 Debug( LDAP_DEBUG_ARGS, " filter: %s\n",
165 op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0, 0 );
169 siz = sizeof(AttributeName);
170 off = offsetof(AttributeName,an_name);
171 if ( ber_scanf( op->o_ber, "{M}}", &op->ors_attrs, &siz, off ) == LBER_ERROR ) {
172 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding attrs error" );
173 rs->sr_err = SLAPD_DISCONNECT;
176 for ( i=0; i<siz; i++ ) {
177 const char *dummy; /* ignore msgs from bv2ad */
178 op->ors_attrs[i].an_desc = NULL;
179 op->ors_attrs[i].an_oc = NULL;
180 slap_bv2ad(&op->ors_attrs[i].an_name, &op->ors_attrs[i].an_desc, &dummy);
183 if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
185 LDAP_LOG( OPERATION, INFO,
186 "do_search: conn %d get_ctrls failed (%d)\n",
187 op->o_connid, rs->sr_err, 0 );
189 Debug( LDAP_DEBUG_ANY, "do_search: get_ctrls failed\n", 0, 0, 0 );
196 LDAP_LOG( OPERATION, ARGS,
197 "do_search: conn %d attrs:", op->o_connid, 0, 0 );
199 Debug( LDAP_DEBUG_ARGS, " attrs:", 0, 0, 0 );
203 for ( i = 0; i<siz; i++ ) {
205 LDAP_LOG( OPERATION, ARGS,
206 "do_search: %s", op->ors_attrs[i].an_name.bv_val, 0, 0 );
208 Debug( LDAP_DEBUG_ARGS, " %s", op->ors_attrs[i].an_name.bv_val, 0, 0 );
214 LDAP_LOG( OPERATION, ARGS, "\n" , 0, 0, 0 );
216 Debug( LDAP_DEBUG_ARGS, "\n", 0, 0, 0 );
219 if ( StatslogTest( LDAP_DEBUG_STATS ) ) {
220 char abuf[BUFSIZ/2], *ptr = abuf;
223 sprintf(abuf, "scope=%d deref=%d", op->ors_scope, op->ors_deref);
224 Statslog( LDAP_DEBUG_STATS,
225 "conn=%lu op=%lu SRCH base=\"%s\" %s filter=\"%s\"\n",
226 op->o_connid, op->o_opid, op->o_req_dn.bv_val, abuf,
227 op->ors_filterstr.bv_val );
229 for ( i = 0; i<siz; i++ ) {
230 alen = op->ors_attrs[i].an_name.bv_len;
231 if (alen >= sizeof(abuf)) {
232 alen = sizeof(abuf)-1;
234 if (len && (len + 1 + alen >= sizeof(abuf))) {
235 Statslog( LDAP_DEBUG_STATS, "conn=%lu op=%lu SRCH attr=%s\n",
236 op->o_connid, op->o_opid, abuf, 0, 0 );
244 ptr = lutil_strncopy(ptr, op->ors_attrs[i].an_name.bv_val, alen);
249 Statslog( LDAP_DEBUG_STATS, "conn=%lu op=%lu SRCH attr=%s\n",
250 op->o_connid, op->o_opid, abuf, 0, 0 );
254 manageDSAit = get_manageDSAit( op );
256 /* fake while loop to allow breaking out */
257 while ( op->ors_scope == LDAP_SCOPE_BASE ) {
260 if ( op->o_req_ndn.bv_len == 0 ) {
261 #ifdef LDAP_CONNECTIONLESS
262 /* Ignore LDAPv2 CLDAP Root DSE queries */
263 if (op->o_protocol == LDAP_VERSION2 && op->o_conn->c_is_udp) {
267 /* check restrictions */
268 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
269 send_ldap_result( op, rs );
275 attrs = anlist2charray( op, op->ors_attrs );
276 initSearchPlugin( op, attrs, manageDSAit );
277 rs->sr_err = doPreSearchPluginFNs( op );
278 if ( rs->sr_err ) break;
279 doSearchRewriteFNs( op );
281 #endif /* LDAP_SLAPI */
282 rs->sr_err = root_dse_info( op->o_conn, &entry, &rs->sr_text );
284 } else if ( bvmatch( &op->o_req_ndn, &global_schemandn ) ) {
285 /* check restrictions */
286 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
287 send_ldap_result( op, rs );
293 attrs = anlist2charray( op, op->ors_attrs );
294 initSearchPlugin( op, attrs, manageDSAit );
295 rs->sr_err = doPreSearchPluginFNs( op );
296 if ( rs->sr_err ) break;
297 doSearchRewriteFNs( op );
299 #endif /* LDAP_SLAPI */
300 rs->sr_err = schema_info( &entry, &rs->sr_text );
303 if( rs->sr_err != LDAP_SUCCESS ) {
304 send_ldap_result( op, rs );
306 if ( op->o_pb ) doPostSearchPluginFNs( op );
307 #endif /* LDAP_SLAPI */
310 } else if ( entry != NULL ) {
311 rs->sr_err = test_filter( op, entry, op->ors_filter );
313 if( rs->sr_err == LDAP_COMPARE_TRUE ) {
314 rs->sr_entry = entry;
315 rs->sr_attrs = op->ors_attrs;
316 send_search_entry( op, rs );
321 rs->sr_err = LDAP_SUCCESS;
322 send_ldap_result( op, rs );
324 if ( op->o_pb ) doPostSearchPluginFNs( op );
325 #endif /* LDAP_SLAPI */
331 if( !op->o_req_ndn.bv_len && default_search_nbase.bv_len ) {
332 sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
333 sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
335 ber_dupbv_x( &op->o_req_dn, &default_search_base, op->o_tmpmemctx );
336 ber_dupbv_x( &op->o_req_ndn, &default_search_nbase, op->o_tmpmemctx );
340 * We could be serving multiple database backends. Select the
341 * appropriate one, or send a referral to our "referral server"
342 * if we don't hold it.
345 /* Sync control overrides manageDSAit */
347 if ( manageDSAit != SLAP_NO_CONTROL ) {
348 if ( op->o_sync_mode & SLAP_SYNC_REFRESH ) {
349 be_manageDSAit = SLAP_NO_CONTROL;
351 be_manageDSAit = manageDSAit;
354 be_manageDSAit = manageDSAit;
357 if ( (op->o_bd = select_backend( &op->o_req_ndn, be_manageDSAit, 1 )) == NULL ) {
358 rs->sr_ref = referral_rewrite( default_referral,
359 NULL, &op->o_req_dn, op->ors_scope );
361 if (!rs->sr_ref) rs->sr_ref = default_referral;
362 rs->sr_err = LDAP_REFERRAL;
363 send_ldap_result( op, rs );
365 if (rs->sr_ref != default_referral)
366 ber_bvarray_free( rs->sr_ref );
371 /* check restrictions */
372 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
373 send_ldap_result( op, rs );
377 /* check for referrals */
378 if( backend_check_referrals( op, rs ) != LDAP_SUCCESS ) {
384 attrs = anlist2charray( op, op->ors_attrs );
385 initSearchPlugin( op, attrs, manageDSAit );
386 rs->sr_err = doPreSearchPluginFNs( op );
387 if ( rs->sr_err != LDAP_SUCCESS ) {
391 doSearchRewriteFNs( op );
393 #endif /* LDAP_SLAPI */
395 /* actually do the search and send the result(s) */
396 if ( op->o_bd->be_search ) {
397 (op->o_bd->be_search)( op, rs );
399 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
400 "operation not supported within namingContext" );
404 if ( op->o_pb ) doPostSearchPluginFNs( op );
405 #endif /* LDAP_SLAPI */
409 if ( ( op->o_sync_mode & SLAP_SYNC_PERSIST ) )
412 if ( ( op->o_sync_slog_size != -1 ) )
415 if( op->o_req_dn.bv_val != NULL) sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
416 if( op->o_req_ndn.bv_val != NULL) sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
418 if( op->ors_filterstr.bv_val != NULL) op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
419 if( op->ors_filter != NULL) filter_free_x( op, op->ors_filter );
420 if( op->ors_attrs != NULL ) op->o_tmpfree( op->ors_attrs, op->o_tmpmemctx );
422 if( attrs != NULL) op->o_tmpfree( attrs, op->o_tmpmemctx );
423 #endif /* LDAP_SLAPI */
430 static char **anlist2charray( Operation *op, AttributeName *an )
436 for ( i = 0; an[i].an_name.bv_val != NULL; i++ )
438 attrs = (char **)op->o_tmpalloc( (i + 1) * sizeof(char *), op->o_tmpmemctx );
439 for ( i = 0; an[i].an_name.bv_val != NULL; i++ ) {
440 attrs[i] = an[i].an_name.bv_val;
450 static void initSearchPlugin( Operation *op,
451 char **attrs, int managedsait )
453 slapi_x_pblock_set_operation( op->o_pb, op );
454 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TARGET, (void *)op->o_req_dn.bv_val );
455 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SCOPE, (void *)op->ors_scope );
456 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_DEREF, (void *)op->ors_deref );
457 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SIZELIMIT, (void *)op->ors_slimit );
458 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TIMELIMIT, (void *)op->ors_tlimit );
459 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_FILTER, (void *)op->ors_filter );
460 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_STRFILTER, (void *)op->ors_filterstr.bv_val );
461 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRS, (void *)attrs );
462 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRSONLY, (void *)op->ors_attrsonly );
463 slapi_pblock_set( op->o_pb, SLAPI_MANAGEDSAIT, (void *)managedsait );
466 static int doPreSearchPluginFNs( Operation *op )
470 rc = doPluginFNs( op->o_bd, SLAPI_PLUGIN_PRE_SEARCH_FN, op->o_pb );
473 * A preoperation plugin failure will abort the
477 LDAP_LOG( OPERATION, INFO, "doPreSearchPluginFNs: search preoperation plugin "
478 "returned %d\n", rc, 0, 0 );
480 Debug(LDAP_DEBUG_TRACE, "doPreSearchPluginFNs: search preoperation plugin "
481 "returned %d.\n", rc, 0, 0);
483 if ( ( slapi_pblock_get( op->o_pb, SLAPI_RESULT_CODE, (void *)&rc ) != 0 ) ||
484 rc == LDAP_SUCCESS ) {
494 static int doSearchRewriteFNs( Operation *op )
496 if ( doPluginFNs( op->o_bd, SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN, op->o_pb ) == 0 ) {
500 * The plugin can set the SLAPI_SEARCH_FILTER.
501 * SLAPI_SEARCH_STRFILER is not normative.
503 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_FILTER, (void *)&op->ors_filter );
504 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
505 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
508 * Also permit other search parameters to be reset. One thing
509 * this doesn't (yet) deal with is plugins that change a root
510 * DSE search to a non-root DSE search...
512 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_TARGET, (void **)&op->o_req_dn.bv_val );
513 op->o_req_dn.bv_len = strlen( op->o_req_dn.bv_val );
515 if( op->o_req_ndn.bv_val != NULL) {
516 sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
518 rc = dnNormalize( 0, NULL, NULL, &op->o_req_dn, &op->o_req_ndn,
520 if ( rc != LDAP_SUCCESS ) {
524 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_SCOPE, (void **)&op->ors_scope );
525 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_DEREF, (void **)&op->ors_deref );
528 LDAP_LOG( OPERATION, ARGS,
529 "doSearchRewriteFNs: after compute_rewrite_search filter: %s\n",
530 op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0, 0 );
532 Debug( LDAP_DEBUG_ARGS, " after compute_rewrite_search filter: %s\n",
533 op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0, 0 );
540 static void doPostSearchPluginFNs( Operation *op )
542 if ( doPluginFNs( op->o_bd, SLAPI_PLUGIN_POST_SEARCH_FN, op->o_pb ) < 0 ) {
544 LDAP_LOG( OPERATION, INFO, "doPostSearchPluginFNs: search postoperation plugins "
545 "failed\n", 0, 0, 0 );
547 Debug(LDAP_DEBUG_TRACE, "doPostSearchPluginFNs: search postoperation plugins "
548 "failed.\n", 0, 0, 0);
556 * XXX slapi_search_internal() was no getting pulled
557 * in; all manner of linker flags failed to link it.
560 slapi_search_internal( NULL, 0, NULL, NULL, NULL, 0 );
562 #endif /* LDAP_SLAPI */