3 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1995 Regents of the University of Michigan.
10 * Redistribution and use in source and binary forms are permitted
11 * provided that this notice is preserved and that due credit is given
12 * to the University of Michigan at Ann Arbor. The name of the University
13 * may not be used to endorse or promote products derived from this
14 * software without specific prior written permission. This software
15 * is provided ``as is'' without express or implied warranty.
22 #include <ac/string.h>
23 #include <ac/socket.h>
31 static char **anlist2charray( Operation *op, AttributeName *an );
32 static void initSearchPlugin( Operation *op, char **attrs, int managedsait );
33 static int doPreSearchPluginFNs( Operation *op );
34 static int doSearchRewriteFNs( Operation *op );
35 static void doPostSearchPluginFNs( Operation *op );
36 #endif /* LDAPI_SLAPI */
40 Operation *op, /* info about the op to which we're responding */
41 SlapReply *rs /* all the response data we'll send */
43 struct berval base = { 0, NULL };
44 ber_len_t siz, off, i;
52 LDAP_LOG( OPERATION, ENTRY, "do_search: conn %d\n", op->o_connid, 0, 0 );
54 Debug( LDAP_DEBUG_TRACE, "do_search\n", 0, 0, 0 );
58 * Parse the search request. It looks like this:
60 * SearchRequest := [APPLICATION 3] SEQUENCE {
61 * baseObject DistinguishedName,
67 * derefAliases ENUMERATED {
68 * neverDerefaliases (0),
69 * derefInSearching (1),
70 * derefFindingBaseObj (2),
71 * alwaysDerefAliases (3)
73 * sizelimit INTEGER (0 .. 65535),
74 * timelimit INTEGER (0 .. 65535),
77 * attributes SEQUENCE OF AttributeType
81 /* baseObject, scope, derefAliases, sizelimit, timelimit, attrsOnly */
82 if ( ber_scanf( op->o_ber, "{miiiib" /*}*/,
83 &base, &op->ors_scope, &op->ors_deref, &op->ors_slimit,
84 &op->ors_tlimit, &op->ors_attrsonly ) == LBER_ERROR )
86 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
87 rs->sr_err = SLAPD_DISCONNECT;
91 switch( op->ors_scope ) {
93 case LDAP_SCOPE_ONELEVEL:
94 case LDAP_SCOPE_SUBTREE:
97 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid scope" );
101 switch( op->ors_deref ) {
102 case LDAP_DEREF_NEVER:
103 case LDAP_DEREF_FINDING:
104 case LDAP_DEREF_SEARCHING:
105 case LDAP_DEREF_ALWAYS:
108 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "invalid deref" );
112 rs->sr_err = dnPrettyNormal( NULL, &base, &op->o_req_dn, &op->o_req_ndn, op->o_tmpmemctx );
113 if( rs->sr_err != LDAP_SUCCESS ) {
115 LDAP_LOG( OPERATION, ERR,
116 "do_search: conn %d invalid dn (%s)\n",
117 op->o_connid, base.bv_val, 0 );
119 Debug( LDAP_DEBUG_ANY,
120 "do_search: invalid dn (%s)\n", base.bv_val, 0, 0 );
122 send_ldap_error( op, rs, LDAP_INVALID_DN_SYNTAX, "invalid DN" );
127 LDAP_LOG( OPERATION, ARGS, "SRCH \"%s\" %d %d",
128 base.bv_val, op->ors_scope, op->ors_deref );
129 LDAP_LOG( OPERATION, ARGS, " %d %d %d\n",
130 op->ors_slimit, op->ors_tlimit, op->ors_attrsonly);
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);
138 /* filter - returns a "normalized" version */
139 rs->sr_err = get_filter( op, op->o_ber, &op->ors_filter, &rs->sr_text );
140 if( rs->sr_err != LDAP_SUCCESS ) {
141 if( rs->sr_err == SLAPD_DISCONNECT ) {
142 rs->sr_err = LDAP_PROTOCOL_ERROR;
143 send_ldap_disconnect( op, rs );
145 send_ldap_result( op, rs );
149 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
152 LDAP_LOG( OPERATION, ARGS,
153 "do_search: conn %d filter: %s\n",
154 op->o_connid, op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0 );
156 Debug( LDAP_DEBUG_ARGS, " filter: %s\n",
157 op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0, 0 );
161 siz = sizeof(AttributeName);
163 if ( ber_scanf( op->o_ber, "{M}}", &op->ors_attrs, &siz, off ) == LBER_ERROR ) {
164 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding attrs error" );
165 rs->sr_err = SLAPD_DISCONNECT;
168 for ( i=0; i<siz; i++ ) {
169 const char *dummy; /* ignore msgs from bv2ad */
170 op->ors_attrs[i].an_desc = NULL;
171 op->ors_attrs[i].an_oc = NULL;
172 slap_bv2ad(&op->ors_attrs[i].an_name, &op->ors_attrs[i].an_desc, &dummy);
175 if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
177 LDAP_LOG( OPERATION, INFO,
178 "do_search: conn %d get_ctrls failed (%d)\n",
179 op->o_connid, rs->sr_err, 0 );
181 Debug( LDAP_DEBUG_ANY, "do_search: get_ctrls failed\n", 0, 0, 0 );
188 LDAP_LOG( OPERATION, ARGS,
189 "do_search: conn %d attrs:", op->o_connid, 0, 0 );
191 Debug( LDAP_DEBUG_ARGS, " attrs:", 0, 0, 0 );
195 for ( i = 0; i<siz; i++ ) {
197 LDAP_LOG( OPERATION, ARGS,
198 "do_search: %s", op->ors_attrs[i].an_name.bv_val, 0, 0 );
200 Debug( LDAP_DEBUG_ARGS, " %s", op->ors_attrs[i].an_name.bv_val, 0, 0 );
206 LDAP_LOG( OPERATION, ARGS, "\n" , 0, 0, 0 );
208 Debug( LDAP_DEBUG_ARGS, "\n", 0, 0, 0 );
211 if ( StatslogTest( LDAP_DEBUG_STATS ) ) {
212 char abuf[BUFSIZ/2], *ptr = abuf;
215 Statslog( LDAP_DEBUG_STATS,
216 "conn=%lu op=%lu SRCH base=\"%s\" scope=%d filter=\"%s\"\n",
217 op->o_connid, op->o_opid, op->o_req_dn.bv_val, op->ors_scope, op->ors_filterstr.bv_val );
219 for ( i = 0; i<siz; i++ ) {
220 alen = op->ors_attrs[i].an_name.bv_len;
221 if (alen >= sizeof(abuf)) {
222 alen = sizeof(abuf)-1;
224 if (len && (len + 1 + alen >= sizeof(abuf))) {
225 Statslog( LDAP_DEBUG_STATS, "conn=%lu op=%lu SRCH attr=%s\n",
226 op->o_connid, op->o_opid, abuf, 0, 0 );
234 ptr = lutil_strncopy(ptr, op->ors_attrs[i].an_name.bv_val, alen);
239 Statslog( LDAP_DEBUG_STATS, "conn=%lu op=%lu SRCH attr=%s\n",
240 op->o_connid, op->o_opid, abuf, 0, 0 );
244 manageDSAit = get_manageDSAit( op );
246 if ( op->ors_scope == LDAP_SCOPE_BASE ) {
249 if ( op->o_req_ndn.bv_len == 0 ) {
250 #ifdef LDAP_CONNECTIONLESS
251 /* Ignore LDAPv2 CLDAP Root DSE queries */
252 if (op->o_protocol == LDAP_VERSION2 && op->o_conn->c_is_udp) {
256 /* check restrictions */
257 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
258 send_ldap_result( op, rs );
263 attrs = anlist2charray( op, op->ors_attrs );
264 initSearchPlugin( op, attrs, manageDSAit );
265 rs->sr_err = doPreSearchPluginFNs( op );
266 if ( rs->sr_err == LDAP_SUCCESS ) {
267 doSearchRewriteFNs( op );
268 #endif /* LDAP_SLAPI */
269 rs->sr_err = root_dse_info( op->o_conn, &entry, &rs->sr_text );
272 #endif /* LDAP_SLAPI */
274 } else if ( bvmatch( &op->o_req_ndn, &global_schemandn ) ) {
275 /* check restrictions */
276 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
277 send_ldap_result( op, rs );
282 attrs = anlist2charray( op, op->ors_attrs );
283 initSearchPlugin( op, attrs, manageDSAit );
284 rs->sr_err = doPreSearchPluginFNs( op );
285 if ( rs->sr_err == LDAP_SUCCESS ) {
286 doSearchRewriteFNs( op );
287 #endif /* LDAP_SLAPI */
288 rs->sr_err = schema_info( &entry, &rs->sr_text );
291 #endif /* LDAP_SLAPI */
294 if( rs->sr_err != LDAP_SUCCESS ) {
295 send_ldap_result( op, rs );
297 doPostSearchPluginFNs( op );
298 #endif /* LDAP_SLAPI */
301 } else if ( entry != NULL ) {
302 rs->sr_err = test_filter( op, entry, op->ors_filter );
304 if( rs->sr_err == LDAP_COMPARE_TRUE ) {
305 rs->sr_entry = entry;
306 rs->sr_attrs = op->ors_attrs;
307 send_search_entry( op, rs );
312 rs->sr_err = LDAP_SUCCESS;
313 send_ldap_result( op, rs );
315 doPostSearchPluginFNs( op );
316 #endif /* LDAP_SLAPI */
321 if( !op->o_req_ndn.bv_len && default_search_nbase.bv_len ) {
322 sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
323 sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
325 ber_dupbv_x( &op->o_req_dn, &default_search_base, op->o_tmpmemctx );
326 ber_dupbv_x( &op->o_req_ndn, &default_search_nbase, op->o_tmpmemctx );
330 * We could be serving multiple database backends. Select the
331 * appropriate one, or send a referral to our "referral server"
332 * if we don't hold it.
335 /* Sync / LCUP controls override manageDSAit */
337 if ( manageDSAit != SLAP_NO_CONTROL ) {
338 #ifdef LDAP_CLIENT_UPDATE
339 if ( op->o_clientupdate_type & SLAP_LCUP_SYNC ) {
340 be_manageDSAit = SLAP_NO_CONTROL;
344 if ( op->o_sync_mode & SLAP_SYNC_REFRESH ) {
345 be_manageDSAit = SLAP_NO_CONTROL;
349 be_manageDSAit = manageDSAit;
352 be_manageDSAit = manageDSAit;
355 if ( (op->o_bd = select_backend( &op->o_req_ndn, be_manageDSAit, 1 )) == NULL ) {
356 rs->sr_ref = referral_rewrite( default_referral,
357 NULL, &op->o_req_dn, op->ors_scope );
359 if (!rs->sr_ref) rs->sr_ref = default_referral;
360 rs->sr_err = LDAP_REFERRAL;
361 send_ldap_result( op, rs );
363 if (rs->sr_ref != default_referral)
364 ber_bvarray_free( rs->sr_ref );
369 /* check restrictions */
370 if( backend_check_restrictions( op, rs, NULL ) != LDAP_SUCCESS ) {
371 send_ldap_result( op, rs );
375 /* check for referrals */
376 if( backend_check_referrals( op, rs ) != LDAP_SUCCESS ) {
381 attrs = anlist2charray( op, op->ors_attrs );
382 initSearchPlugin( op, attrs, manageDSAit );
383 rs->sr_err = doPreSearchPluginFNs( op );
384 if ( rs->sr_err != LDAP_SUCCESS ) {
388 doSearchRewriteFNs( op );
389 #endif /* LDAP_SLAPI */
391 /* actually do the search and send the result(s) */
392 if ( op->o_bd->be_search ) {
393 (op->o_bd->be_search)( op, rs );
395 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
396 "operation not supported within namingContext" );
400 doPostSearchPluginFNs( op );
401 #endif /* LDAP_SLAPI */
405 #ifdef LDAP_CLIENT_UPDATE
406 if ( ( op->o_clientupdate_type & SLAP_LCUP_PERSIST ) )
409 #if defined(LDAP_CLIENT_UPDATE) && defined(LDAP_SYNC)
413 if ( ( op->o_sync_mode & SLAP_SYNC_PERSIST ) )
417 if( op->o_req_dn.bv_val != NULL) sl_free( op->o_req_dn.bv_val, op->o_tmpmemctx );
418 if( op->o_req_ndn.bv_val != NULL) sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
420 if( op->ors_filterstr.bv_val != NULL) op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
421 if( op->ors_filter != NULL) filter_free_x( op, op->ors_filter );
422 if( op->ors_attrs != NULL ) op->o_tmpfree( op->ors_attrs, op->o_tmpmemctx );
424 if( attrs != NULL) op->o_tmpfree( attrs, op->o_tmpmemctx );
425 #endif /* LDAP_SLAPI */
432 static char **anlist2charray( Operation *op, AttributeName *an )
438 for ( i = 0; an[i].an_name.bv_val != NULL; i++ )
440 attrs = (char **)op->o_tmpalloc( (i + 1) * sizeof(char *), op->o_tmpmemctx );
441 for ( i = 0; an[i].an_name.bv_val != NULL; i++ ) {
442 attrs[i] = an[i].an_name.bv_val;
452 static void initSearchPlugin( Operation *op,
453 char **attrs, int managedsait )
455 slapi_x_pblock_set_operation( op->o_pb, op );
456 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TARGET, (void *)op->o_req_dn.bv_val );
457 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SCOPE, (void *)op->ors_scope );
458 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_DEREF, (void *)op->ors_deref );
459 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_SIZELIMIT, (void *)op->ors_slimit );
460 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_TIMELIMIT, (void *)op->ors_tlimit );
461 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_FILTER, (void *)op->ors_filter );
462 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_STRFILTER, (void *)op->ors_filterstr.bv_val );
463 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRS, (void *)attrs );
464 slapi_pblock_set( op->o_pb, SLAPI_SEARCH_ATTRSONLY, (void *)op->ors_attrsonly );
465 slapi_pblock_set( op->o_pb, SLAPI_MANAGEDSAIT, (void *)managedsait );
468 static int doPreSearchPluginFNs( Operation *op )
472 rc = doPluginFNs( op->o_bd, SLAPI_PLUGIN_PRE_SEARCH_FN, op->o_pb );
475 * A preoperation plugin failure will abort the
479 LDAP_LOG( OPERATION, INFO, "doPreSearchPluginFNs: search preoperation plugin "
480 "returned %d\n", rc, 0, 0 );
482 Debug(LDAP_DEBUG_TRACE, "doPreSearchPluginFNs: search preoperation plugin "
483 "returned %d.\n", rc, 0, 0);
485 if ( ( slapi_pblock_get( op->o_pb, SLAPI_RESULT_CODE, (void *)&rc ) != 0 ) ||
486 rc == LDAP_SUCCESS ) {
496 static int doSearchRewriteFNs( Operation *op )
498 if ( doPluginFNs( op->o_bd, SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN, op->o_pb ) == 0 ) {
502 * The plugin can set the SLAPI_SEARCH_FILTER.
503 * SLAPI_SEARCH_STRFILER is not normative.
505 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_FILTER, (void *)&op->ors_filter );
506 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
507 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
510 * Also permit other search parameters to be reset. One thing
511 * this doesn't (yet) deal with is plugins that change a root
512 * DSE search to a non-root DSE search...
514 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_TARGET, (void **)&op->o_req_dn.bv_val );
515 op->o_req_dn.bv_len = strlen( op->o_req_dn.bv_val );
517 if( op->o_req_ndn.bv_val != NULL) {
518 sl_free( op->o_req_ndn.bv_val, op->o_tmpmemctx );
520 rc = dnNormalize( 0, NULL, NULL, &op->o_req_dn, &op->o_req_ndn,
522 if ( rc != LDAP_SUCCESS ) {
526 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_SCOPE, (void **)&op->ors_scope );
527 slapi_pblock_get( op->o_pb, SLAPI_SEARCH_DEREF, (void **)&op->ors_deref );
530 LDAP_LOG( OPERATION, ARGS,
531 "doSearchRewriteFNs: after compute_rewrite_search filter: %s\n",
532 op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0, 0 );
534 Debug( LDAP_DEBUG_ARGS, " after compute_rewrite_search filter: %s\n",
535 op->ors_filterstr.bv_len ? op->ors_filterstr.bv_val : "empty", 0, 0 );
542 static void doPostSearchPluginFNs( Operation *op )
544 if ( doPluginFNs( op->o_bd, SLAPI_PLUGIN_POST_SEARCH_FN, op->o_pb ) < 0 ) {
546 LDAP_LOG( OPERATION, INFO, "doPostSearchPluginFNs: search postoperation plugins "
547 "failed\n", 0, 0, 0 );
549 Debug(LDAP_DEBUG_TRACE, "doPostSearchPluginFNs: search postoperation plugins "
550 "failed.\n", 0, 0, 0);
558 * XXX slapi_search_internal() was no getting pulled
559 * in; all manner of linker flags failed to link it.
562 slapi_search_internal( NULL, 0, NULL, NULL, NULL, 0 );
564 #endif /* LDAP_SLAPI */