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>
37 #include "slapi/slapi.h"
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 */
47 Operation *op, /* info about the op to which we're responding */
48 SlapReply *rs /* all the response data we'll send */ )
50 struct berval base = BER_BVNULL;
51 ber_len_t siz, off, i;
53 Debug( LDAP_DEBUG_TRACE, "do_search\n", 0, 0, 0 );
56 * Parse the search request. It looks like this:
58 * SearchRequest := [APPLICATION 3] SEQUENCE {
59 * baseObject DistinguishedName,
64 * subordinate (3) -- OpenLDAP extension
66 * derefAliases ENUMERATED {
67 * neverDerefaliases (0),
68 * derefInSearching (1),
69 * derefFindingBaseObj (2),
70 * alwaysDerefAliases (3)
72 * sizelimit INTEGER (0 .. 65535),
73 * timelimit INTEGER (0 .. 65535),
76 * attributes SEQUENCE OF AttributeType
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 )
85 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
86 rs->sr_err = SLAPD_DISCONNECT;
90 if ( op->ors_tlimit < 0 || op->ors_tlimit > SLAP_MAX_LIMIT ) {
91 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid time limit" );
95 if ( op->ors_slimit < 0 || op->ors_slimit > SLAP_MAX_LIMIT ) {
96 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid size limit" );
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:
109 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid scope" );
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:
120 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid deref" );
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" );
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);
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;
145 send_ldap_result( op, rs );
149 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
151 Debug( LDAP_DEBUG_ARGS, " filter: %s\n",
152 !BER_BVISEMPTY( &op->ors_filterstr ) ? op->ors_filterstr.bv_val : "empty", 0, 0 );
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;
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,
168 &op->ors_attrs[i].an_desc, &dummy);
171 if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
172 Debug( LDAP_DEBUG_ANY, "do_search: get_ctrls failed\n", 0, 0, 0 );
177 Debug( LDAP_DEBUG_ARGS, " attrs:", 0, 0, 0 );
180 for ( i = 0; i<siz; i++ ) {
181 Debug( LDAP_DEBUG_ARGS, " %s", op->ors_attrs[i].an_name.bv_val, 0, 0 );
185 Debug( LDAP_DEBUG_ARGS, "\n", 0, 0, 0 );
187 if ( StatslogTest( LDAP_DEBUG_STATS ) ) {
188 char abuf[BUFSIZ/2], *ptr = abuf;
191 sprintf(abuf, "scope=%d deref=%d", op->ors_scope, op->ors_deref);
192 Statslog( LDAP_DEBUG_STATS,
193 "%s SRCH base=\"%s\" %s filter=\"%s\"\n",
194 op->o_log_prefix, op->o_req_dn.bv_val, abuf,
195 op->ors_filterstr.bv_val, 0 );
197 for ( i = 0; i<siz; i++ ) {
198 alen = op->ors_attrs[i].an_name.bv_len;
199 if (alen >= sizeof(abuf)) {
200 alen = sizeof(abuf)-1;
202 if (len && (len + 1 + alen >= sizeof(abuf))) {
203 Statslog( LDAP_DEBUG_STATS, "%s SRCH attr=%s\n",
204 op->o_log_prefix, abuf, 0, 0, 0 );
212 ptr = lutil_strncopy(ptr, op->ors_attrs[i].an_name.bv_val, alen);
217 Statslog( LDAP_DEBUG_STATS, "%s SRCH attr=%s\n",
218 op->o_log_prefix, abuf, 0, 0, 0 );
222 op->o_bd = frontendDB;
223 rs->sr_err = frontendDB->be_search( op, rs );
226 #if 0 /* DELETE ME */
227 if ( ( op->o_sync_mode & SLAP_SYNC_PERSIST ) ) {
230 if ( ( op->o_sync_slog_size != -1 ) ) {
234 if ( !BER_BVISNULL( &op->o_req_dn ) ) {
235 slap_sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
237 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
238 slap_sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
240 if ( !BER_BVISNULL( &op->ors_filterstr ) ) {
241 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
243 if ( op->ors_filter != NULL) {
244 filter_free_x( op, op->ors_filter );
246 if ( op->ors_attrs != NULL ) {
247 op->o_tmpfree( op->ors_attrs, op->o_tmpmemctx );
254 fe_op_search( Operation *op, SlapReply *rs )
262 manageDSAit = get_manageDSAit( op );
264 /* fake while loop to allow breaking out */
265 while ( op->ors_scope == LDAP_SCOPE_BASE ) {
268 if ( BER_BVISEMPTY( &op->o_req_ndn ) ) {
269 #ifdef LDAP_CONNECTIONLESS
270 /* Ignore LDAPv2 CLDAP Root DSE queries */
271 if (op->o_protocol == LDAP_VERSION2 && op->o_conn->c_is_udp) {
275 /* check restrictions */
276 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
277 send_ldap_result( op, rs );
283 attrs = anlist2charray_x( op->ors_attrs, 0, op->o_tmpmemctx );
284 init_search_pblock( op, attrs, manageDSAit );
285 rs->sr_err = call_search_preop_plugins( op );
286 if ( rs->sr_err ) break;
287 call_search_rewrite_plugins( op );
289 #endif /* LDAP_SLAPI */
290 rs->sr_err = root_dse_info( op->o_conn, &entry, &rs->sr_text );
292 } else if ( bvmatch( &op->o_req_ndn, &frontendDB->be_schemandn ) ) {
293 /* check restrictions */
294 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
295 send_ldap_result( op, rs );
301 attrs = anlist2charray_x( op->ors_attrs, 0, op->o_tmpmemctx );
302 init_search_pblock( op, attrs, manageDSAit );
303 rs->sr_err = call_search_preop_plugins( op );
304 if ( rs->sr_err ) break;
305 call_search_rewrite_plugins( op );
307 #endif /* LDAP_SLAPI */
308 rs->sr_err = schema_info( &entry, &rs->sr_text );
311 if( rs->sr_err != LDAP_SUCCESS ) {
312 send_ldap_result( op, rs );
314 if ( op->o_pb ) call_search_postop_plugins( op );
315 #endif /* LDAP_SLAPI */
318 } else if ( entry != NULL ) {
319 rs->sr_err = test_filter( op, entry, op->ors_filter );
321 if( rs->sr_err == LDAP_COMPARE_TRUE ) {
322 rs->sr_entry = entry;
323 rs->sr_attrs = op->ors_attrs;
324 rs->sr_operational_attrs = NULL;
325 send_search_entry( op, rs );
327 rs->sr_operational_attrs = NULL;
331 rs->sr_err = LDAP_SUCCESS;
332 send_ldap_result( op, rs );
334 if ( op->o_pb ) call_search_postop_plugins( op );
335 #endif /* LDAP_SLAPI */
341 if( BER_BVISEMPTY( &op->o_req_ndn ) && !BER_BVISEMPTY( &default_search_nbase ) ) {
342 slap_sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
343 slap_sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
345 ber_dupbv_x( &op->o_req_dn, &default_search_base, op->o_tmpmemctx );
346 ber_dupbv_x( &op->o_req_ndn, &default_search_nbase, op->o_tmpmemctx );
350 * We could be serving multiple database backends. Select the
351 * appropriate one, or send a referral to our "referral server"
352 * if we don't hold it.
355 #if 0 /* DELETE ME */
356 /* Sync control overrides manageDSAit */
358 if ( manageDSAit != SLAP_CONTROL_NONE ) {
359 if ( op->o_sync_mode & SLAP_SYNC_REFRESH ) {
360 be_manageDSAit = SLAP_CONTROL_NONE;
362 be_manageDSAit = manageDSAit;
365 be_manageDSAit = manageDSAit;
368 be_manageDSAit = manageDSAit;
371 op->o_bd = select_backend( &op->o_req_ndn, be_manageDSAit, 1 );
372 if ( op->o_bd == NULL ) {
373 rs->sr_ref = referral_rewrite( default_referral,
374 NULL, &op->o_req_dn, op->ors_scope );
376 if (!rs->sr_ref) rs->sr_ref = default_referral;
377 rs->sr_err = LDAP_REFERRAL;
378 send_ldap_result( op, rs );
380 if (rs->sr_ref != default_referral)
381 ber_bvarray_free( rs->sr_ref );
386 /* check restrictions */
387 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
388 send_ldap_result( op, rs );
392 /* check for referrals */
393 if( backend_check_referrals( op, rs ) != LDAP_SUCCESS ) {
399 attrs = anlist2charray_x( op->ors_attrs, 0, op->o_tmpmemctx );
400 init_search_pblock( op, attrs, manageDSAit );
401 rs->sr_err = call_search_preop_plugins( op );
402 if ( rs->sr_err != LDAP_SUCCESS ) {
406 call_search_rewrite_plugins( op );
408 #endif /* LDAP_SLAPI */
410 /* actually do the search and send the result(s) */
411 if ( op->o_bd->be_search ) {
412 if ( limits_check( op, rs ) == 0 ) {
413 (op->o_bd->be_search)( op, rs );
415 /* else limits_check() sends error */
418 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
419 "operation not supported within namingContext" );
423 if ( op->o_pb ) call_search_postop_plugins( op );
424 #endif /* LDAP_SLAPI */
427 if( attrs != NULL) op->o_tmpfree( attrs, op->o_tmpmemctx );
428 #endif /* LDAP_SLAPI */
436 static void init_search_pblock( Operation *op,
437 char **attrs, int managedsait )
439 slapi_int_pblock_set_operation( op->o_pb, op );
440 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TARGET, (void *)op->o_req_dn.bv_val );
441 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SCOPE, (void *)op->ors_scope );
442 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_DEREF, (void *)op->ors_deref );
443 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SIZELIMIT, (void *)op->ors_slimit );
444 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TIMELIMIT, (void *)op->ors_tlimit );
445 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_FILTER, (void *)op->ors_filter );
446 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_STRFILTER, (void *)op->ors_filterstr.bv_val );
447 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRS, (void *)attrs );
448 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRSONLY, (void *)op->ors_attrsonly );
449 slapi_pblock_set( op->o_pb, SLAPI_MANAGEDSAIT, (void *)managedsait );
452 static int call_search_preop_plugins( Operation *op )
456 rc = slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_PRE_SEARCH_FN, op->o_pb );
459 * A preoperation plugin failure will abort the
462 Debug(LDAP_DEBUG_TRACE, "call_search_preop_plugins: search preoperation plugin "
463 "returned %d.\n", rc, 0, 0);
464 if ( ( slapi_pblock_get( op->o_pb, SLAPI_RESULT_CODE, (void *)&rc ) != 0 ) ||
465 rc == LDAP_SUCCESS ) {
475 static int call_search_rewrite_plugins( Operation *op )
477 if ( slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN, op->o_pb ) == 0 ) {
481 * The plugin can set the SLAPI_SEARCH_FILTER.
482 * SLAPI_SEARCH_STRFILER is not normative.
484 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_FILTER, (void *)&op->ors_filter );
485 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
486 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
489 * Also permit other search parameters to be reset. One thing
490 * this doesn't (yet) deal with is plugins that change a root
491 * DSE search to a non-root DSE search...
493 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_TARGET, (void **)&op->o_req_dn.bv_val );
494 op->o_req_dn.bv_len = strlen( op->o_req_dn.bv_val );
496 if( !BER_BVISNULL( &op->o_req_ndn ) ) {
497 slap_sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
499 rc = dnNormalize( 0, NULL, NULL, &op->o_req_dn, &op->o_req_ndn,
501 if ( rc != LDAP_SUCCESS ) {
505 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_SCOPE, (void **)&op->ors_scope );
506 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_DEREF, (void **)&op->ors_deref );
508 Debug( LDAP_DEBUG_ARGS, " after compute_rewrite_search filter: %s\n",
509 !BER_BVISEMPTY( &op->ors_filterstr ) ? op->ors_filterstr.bv_val : "empty", 0, 0 );
515 static void call_search_postop_plugins( Operation *op )
517 if ( slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_POST_SEARCH_FN, op->o_pb ) < 0 ) {
518 Debug(LDAP_DEBUG_TRACE, "call_search_postop_plugins: search postoperation plugins "
519 "failed.\n", 0, 0, 0);
523 void slapi_int_dummy(void)
526 * XXX slapi_search_internal() was no getting pulled
527 * in; all manner of linker flags failed to link it.
530 slapi_search_internal( NULL, 0, NULL, NULL, NULL, 0 );
532 #endif /* LDAP_SLAPI */