4 Copyright (C) Andrew Tridgell 2004
6 ** NOTE! The following LGPL license applies to the ldb
7 ** library. This does NOT imply that all of Samba is released
10 This library is free software; you can redistribute it and/or
11 modify it under the terms of the GNU Lesser General Public
12 License as published by the Free Software Foundation; either
13 version 3 of the License, or (at your option) any later version.
15 This library is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public
21 License along with this library; if not, see <http://www.gnu.org/licenses/>.
27 * Component: ldb search functions
29 * Description: functions to search ldb+tdb databases
31 * Author: Andrew Tridgell
37 add one element to a message
39 static int msg_add_element(struct ldb_message *ret,
40 const struct ldb_message_element *el,
44 struct ldb_message_element *e2, *elnew;
46 if (check_duplicates && ldb_msg_find_element(ret, el->name)) {
47 /* its already there */
51 e2 = talloc_realloc(ret, ret->elements, struct ldb_message_element, ret->num_elements+1);
57 elnew = &e2[ret->num_elements];
59 elnew->name = talloc_strdup(ret->elements, el->name);
65 elnew->values = talloc_array(ret->elements, struct ldb_val, el->num_values);
73 for (i=0;i<el->num_values;i++) {
74 elnew->values[i] = ldb_val_dup(elnew->values, &el->values[i]);
75 if (elnew->values[i].length != el->values[i].length) {
80 elnew->num_values = el->num_values;
88 add the special distinguishedName element
90 static int msg_add_distinguished_name(struct ldb_message *msg)
92 struct ldb_message_element el;
97 el.name = "distinguishedName";
100 val.data = (uint8_t *)ldb_dn_alloc_linearized(msg, msg->dn);
101 val.length = strlen((char *)val.data);
103 ret = msg_add_element(msg, &el, 1);
108 add all elements from one message into another
110 static int msg_add_all_elements(struct ldb_module *module, struct ldb_message *ret,
111 const struct ldb_message *msg)
113 struct ldb_context *ldb;
115 int check_duplicates = (ret->num_elements != 0);
117 ldb = ldb_module_get_ctx(module);
119 if (msg_add_distinguished_name(ret) != 0) {
123 for (i=0;i<msg->num_elements;i++) {
124 const struct ldb_schema_attribute *a;
125 a = ldb_schema_attribute_by_name(ldb, msg->elements[i].name);
126 if (a->flags & LDB_ATTR_FLAG_HIDDEN) {
129 if (msg_add_element(ret, &msg->elements[i],
130 check_duplicates) != 0) {
140 pull the specified list of attributes from a message
142 static struct ldb_message *ltdb_pull_attrs(struct ldb_module *module,
144 const struct ldb_message *msg,
145 const char * const *attrs)
147 struct ldb_message *ret;
150 ret = talloc(mem_ctx, struct ldb_message);
155 ret->dn = ldb_dn_copy(ret, msg->dn);
161 ret->num_elements = 0;
162 ret->elements = NULL;
165 if (msg_add_all_elements(module, ret, msg) != 0) {
172 for (i=0;attrs[i];i++) {
173 struct ldb_message_element *el;
175 if (strcmp(attrs[i], "*") == 0) {
176 if (msg_add_all_elements(module, ret, msg) != 0) {
183 if (ldb_attr_cmp(attrs[i], "distinguishedName") == 0) {
184 if (msg_add_distinguished_name(ret) != 0) {
190 el = ldb_msg_find_element(msg, attrs[i]);
194 if (msg_add_element(ret, el, 1) != 0) {
204 search the database for a single simple dn.
205 return LDB_ERR_NO_SUCH_OBJECT on record-not-found
206 and LDB_SUCCESS on success
208 static int ltdb_search_base(struct ldb_module *module, struct ldb_dn *dn)
210 void *data = ldb_module_get_private(module);
211 struct ltdb_private *ltdb = talloc_get_type(data, struct ltdb_private);
212 TDB_DATA tdb_key, tdb_data;
214 if (ldb_dn_is_null(dn)) {
215 return LDB_ERR_NO_SUCH_OBJECT;
219 tdb_key = ltdb_key(module, dn);
221 return LDB_ERR_OPERATIONS_ERROR;
224 tdb_data = tdb_fetch(ltdb->tdb, tdb_key);
225 talloc_free(tdb_key.dptr);
226 if (!tdb_data.dptr) {
227 return LDB_ERR_NO_SUCH_OBJECT;
235 search the database for a single simple dn, returning all attributes
238 return LDB_ERR_NO_SUCH_OBJECT on record-not-found
239 and LDB_SUCCESS on success
241 int ltdb_search_dn1(struct ldb_module *module, struct ldb_dn *dn, struct ldb_message *msg)
243 void *data = ldb_module_get_private(module);
244 struct ltdb_private *ltdb = talloc_get_type(data, struct ltdb_private);
246 TDB_DATA tdb_key, tdb_data;
248 memset(msg, 0, sizeof(*msg));
251 tdb_key = ltdb_key(module, dn);
253 return LDB_ERR_OPERATIONS_ERROR;
256 tdb_data = tdb_fetch(ltdb->tdb, tdb_key);
257 talloc_free(tdb_key.dptr);
258 if (!tdb_data.dptr) {
259 return LDB_ERR_NO_SUCH_OBJECT;
262 msg->num_elements = 0;
263 msg->elements = NULL;
265 ret = ltdb_unpack_data(module, &tdb_data, msg);
268 struct ldb_context *ldb = ldb_module_get_ctx(module);
269 ldb_debug(ldb, LDB_DEBUG_ERROR, "Invalid data for index %s\n",
270 ldb_dn_get_linearized(msg->dn));
271 return LDB_ERR_OPERATIONS_ERROR;
275 msg->dn = ldb_dn_copy(msg, dn);
278 return LDB_ERR_OPERATIONS_ERROR;
285 add a set of attributes from a record to a set of results
286 return 0 on success, -1 on failure
288 int ltdb_add_attr_results(struct ldb_module *module,
290 struct ldb_message *msg,
291 const char * const attrs[],
293 struct ldb_message ***res)
295 struct ldb_message *msg2;
296 struct ldb_message **res2;
298 /* pull the attributes that the user wants */
299 msg2 = ltdb_pull_attrs(module, mem_ctx, msg, attrs);
304 /* add to the results list */
305 res2 = talloc_realloc(mem_ctx, *res, struct ldb_message *, (*count)+2);
313 (*res)[*count] = talloc_move(*res, &msg2);
314 (*res)[(*count)+1] = NULL;
323 filter the specified list of attributes from a message
324 removing not requested attrs.
326 int ltdb_filter_attrs(struct ldb_message *msg, const char * const *attrs)
331 /* check for special attrs */
332 for (i = 0; attrs[i]; i++) {
333 if (strcmp(attrs[i], "*") == 0) {
338 if (ldb_attr_cmp(attrs[i], "distinguishedName") == 0) {
339 if (msg_add_distinguished_name(msg) != 0) {
349 if (msg_add_distinguished_name(msg) != 0) {
355 for (i = 0; i < msg->num_elements; i++) {
358 for (j = 0, found = 0; attrs[j]; j++) {
359 if (ldb_attr_cmp(msg->elements[i].name, attrs[j]) == 0) {
366 ldb_msg_remove_attr(msg, msg->elements[i].name);
375 search function for a non-indexed search
377 static int search_func(struct tdb_context *tdb, TDB_DATA key, TDB_DATA data, void *state)
379 struct ldb_context *ldb;
380 struct ltdb_context *ac;
381 struct ldb_message *msg;
384 ac = talloc_get_type(state, struct ltdb_context);
385 ldb = ldb_module_get_ctx(ac->module);
388 strncmp((char *)key.dptr, "DN=", 3) != 0) {
392 msg = ldb_msg_new(ac);
397 /* unpack the record */
398 ret = ltdb_unpack_data(ac->module, &data, msg);
405 msg->dn = ldb_dn_new(msg, ldb,
406 (char *)key.dptr + 3);
407 if (msg->dn == NULL) {
413 /* see if it matches the given expression */
414 if (!ldb_match_msg(ldb, msg,
415 ac->tree, ac->base, ac->scope)) {
420 /* filter the attributes that the user wants */
421 ret = ltdb_filter_attrs(msg, ac->attrs);
428 ret = ldb_module_send_entry(ac->req, msg, NULL);
429 if (ret != LDB_SUCCESS) {
430 ac->request_terminated = true;
431 /* the callback failed, abort the operation */
440 search the database with a LDAP-like expression.
441 this is the "full search" non-indexed variant
443 static int ltdb_search_full(struct ltdb_context *ctx)
445 void *data = ldb_module_get_private(ctx->module);
446 struct ltdb_private *ltdb = talloc_get_type(data, struct ltdb_private);
449 if (ltdb->in_transaction != 0) {
450 ret = tdb_traverse(ltdb->tdb, search_func, ctx);
452 ret = tdb_traverse_read(ltdb->tdb, search_func, ctx);
456 return LDB_ERR_OPERATIONS_ERROR;
463 search the database with a LDAP-like expression.
464 choses a search method
466 int ltdb_search(struct ltdb_context *ctx)
468 struct ldb_context *ldb;
469 struct ldb_module *module = ctx->module;
470 struct ldb_request *req = ctx->req;
471 void *data = ldb_module_get_private(module);
472 struct ltdb_private *ltdb = talloc_get_type(data, struct ltdb_private);
475 ldb = ldb_module_get_ctx(module);
477 ldb_request_set_state(req, LDB_ASYNC_PENDING);
479 if (ltdb_lock_read(module) != 0) {
480 return LDB_ERR_OPERATIONS_ERROR;
483 if (ltdb_cache_load(module) != 0) {
484 ltdb_unlock_read(module);
485 return LDB_ERR_OPERATIONS_ERROR;
488 if (req->op.search.tree == NULL) {
489 ltdb_unlock_read(module);
490 return LDB_ERR_OPERATIONS_ERROR;
493 if ((req->op.search.base == NULL) || (ldb_dn_is_null(req->op.search.base) == true)) {
495 /* Check what we should do with a NULL dn */
496 switch (req->op.search.scope) {
498 ldb_asprintf_errstring(ldb,
499 "NULL Base DN invalid for a base search");
500 ret = LDB_ERR_INVALID_DN_SYNTAX;
502 case LDB_SCOPE_ONELEVEL:
503 ldb_asprintf_errstring(ldb,
504 "NULL Base DN invalid for a one-level search");
505 ret = LDB_ERR_INVALID_DN_SYNTAX;
507 case LDB_SCOPE_SUBTREE:
509 /* We accept subtree searches from a NULL base DN, ie over the whole DB */
512 } else if (ldb_dn_is_valid(req->op.search.base) == false) {
514 /* We don't want invalid base DNs here */
515 ldb_asprintf_errstring(ldb,
516 "Invalid Base DN: %s",
517 ldb_dn_get_linearized(req->op.search.base));
518 ret = LDB_ERR_INVALID_DN_SYNTAX;
520 } else if (ltdb->check_base) {
521 /* This database has been marked as 'checkBaseOnSearch', so do a spot check of the base dn */
522 ret = ltdb_search_base(module, req->op.search.base);
524 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
525 ldb_asprintf_errstring(ldb,
526 "No such Base DN: %s",
527 ldb_dn_get_linearized(req->op.search.base));
531 /* If we are not checking the base DN life is easy */
535 ctx->tree = req->op.search.tree;
536 ctx->scope = req->op.search.scope;
537 ctx->base = req->op.search.base;
538 ctx->attrs = req->op.search.attrs;
540 if (ret == LDB_SUCCESS) {
541 uint32_t match_count = 0;
543 ret = ltdb_search_indexed(ctx, &match_count);
544 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
545 /* Not in the index, therefore OK! */
549 /* Check if we got just a normal error.
550 * In that case proceed to a full search unless we got a
552 if ( ! ctx->request_terminated && ret != LDB_SUCCESS) {
553 /* Not indexed, so we need to do a full scan */
555 /* useful for debugging when slow performance
556 * is caused by unindexed searches */
557 char *expression = ldb_filter_from_tree(ctx, ctx->tree);
558 printf("FULL SEARCH: %s\n", expression);
559 talloc_free(expression);
561 if (match_count != 0) {
562 /* the indexing code gave an error
563 * after having returned at least one
564 * entry. This means the indexes are
565 * corrupt or a database record is
566 * corrupt. We cannot continue with a
567 * full search or we may return
570 return LDB_ERR_OPERATIONS_ERROR;
572 ret = ltdb_search_full(ctx);
573 if (ret != LDB_SUCCESS) {
574 ldb_set_errstring(ldb, "Indexed and full searches both failed!\n");
579 ltdb_unlock_read(module);