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
34 #include "ldb_includes.h"
39 add one element to a message
41 static int msg_add_element(struct ldb_message *ret,
42 const struct ldb_message_element *el,
46 struct ldb_message_element *e2, *elnew;
48 if (check_duplicates && ldb_msg_find_element(ret, el->name)) {
49 /* its already there */
53 e2 = talloc_realloc(ret, ret->elements, struct ldb_message_element, ret->num_elements+1);
59 elnew = &e2[ret->num_elements];
61 elnew->name = talloc_strdup(ret->elements, el->name);
67 elnew->values = talloc_array(ret->elements, struct ldb_val, el->num_values);
75 for (i=0;i<el->num_values;i++) {
76 elnew->values[i] = ldb_val_dup(elnew->values, &el->values[i]);
77 if (elnew->values[i].length != el->values[i].length) {
82 elnew->num_values = el->num_values;
90 add the special distinguishedName element
92 static int msg_add_distinguished_name(struct ldb_message *msg)
94 struct ldb_message_element el;
99 el.name = "distinguishedName";
102 val.data = (uint8_t *)ldb_dn_alloc_linearized(msg, msg->dn);
103 val.length = strlen((char *)val.data);
105 ret = msg_add_element(msg, &el, 1);
110 add all elements from one message into another
112 static int msg_add_all_elements(struct ldb_module *module, struct ldb_message *ret,
113 const struct ldb_message *msg)
115 struct ldb_context *ldb = module->ldb;
117 int check_duplicates = (ret->num_elements != 0);
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 int ltdb_search_base(struct ldb_module *module, struct ldb_dn *dn)
210 struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data;
211 TDB_DATA tdb_key, tdb_data;
213 if (ldb_dn_is_null(dn)) {
214 return LDB_ERR_NO_SUCH_OBJECT;
218 tdb_key = ltdb_key(module, dn);
220 return LDB_ERR_OPERATIONS_ERROR;
223 tdb_data = tdb_fetch(ltdb->tdb, tdb_key);
224 talloc_free(tdb_key.dptr);
225 if (!tdb_data.dptr) {
226 return LDB_ERR_NO_SUCH_OBJECT;
234 search the database for a single simple dn, returning all attributes
237 return LDB_ERR_NO_SUCH_OBJECT on record-not-found
238 and LDB_SUCCESS on success
240 int ltdb_search_dn1(struct ldb_module *module, struct ldb_dn *dn, struct ldb_message *msg)
242 struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data;
244 TDB_DATA tdb_key, tdb_data;
246 memset(msg, 0, sizeof(*msg));
249 tdb_key = ltdb_key(module, dn);
251 return LDB_ERR_OPERATIONS_ERROR;
254 tdb_data = tdb_fetch(ltdb->tdb, tdb_key);
255 talloc_free(tdb_key.dptr);
256 if (!tdb_data.dptr) {
257 return LDB_ERR_NO_SUCH_OBJECT;
260 msg->num_elements = 0;
261 msg->elements = NULL;
263 ret = ltdb_unpack_data(module, &tdb_data, msg);
265 if (ret != LDB_SUCCESS) {
266 return LDB_ERR_OPERATIONS_ERROR;
270 msg->dn = ldb_dn_copy(msg, dn);
273 return LDB_ERR_OPERATIONS_ERROR;
280 lock the database for read - use by ltdb_search
282 static int ltdb_lock_read(struct ldb_module *module)
284 struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data;
285 if (ltdb->in_transaction == 0) {
286 return tdb_lockall_read(ltdb->tdb);
292 unlock the database after a ltdb_lock_read()
294 static int ltdb_unlock_read(struct ldb_module *module)
296 struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data;
297 if (ltdb->in_transaction == 0) {
298 return tdb_unlockall_read(ltdb->tdb);
304 add a set of attributes from a record to a set of results
305 return 0 on success, -1 on failure
307 int ltdb_add_attr_results(struct ldb_module *module,
309 struct ldb_message *msg,
310 const char * const attrs[],
312 struct ldb_message ***res)
314 struct ldb_message *msg2;
315 struct ldb_message **res2;
317 /* pull the attributes that the user wants */
318 msg2 = ltdb_pull_attrs(module, mem_ctx, msg, attrs);
320 return LDB_ERR_OPERATIONS_ERROR;
323 /* add to the results list */
324 res2 = talloc_realloc(mem_ctx, *res, struct ldb_message *, (*count)+2);
327 return LDB_ERR_OPERATIONS_ERROR;
332 (*res)[*count] = talloc_move(*res, &msg2);
333 (*res)[(*count)+1] = NULL;
342 filter the specified list of attributes from a message
343 removing not requested attrs.
345 int ltdb_filter_attrs(struct ldb_message *msg, const char * const *attrs)
350 /* check for special attrs */
351 for (i = 0; attrs[i]; i++) {
352 if (strcmp(attrs[i], "*") == 0) {
357 if (ldb_attr_cmp(attrs[i], "distinguishedName") == 0) {
358 if (msg_add_distinguished_name(msg) != 0) {
359 return LDB_ERR_OPERATIONS_ERROR;
368 if (msg_add_distinguished_name(msg) != 0) {
369 return LDB_ERR_OPERATIONS_ERROR;
374 for (i = 0; i < msg->num_elements; i++) {
377 for (j = 0, found = 0; attrs[j]; j++) {
378 if (ldb_attr_cmp(msg->elements[i].name, attrs[j]) == 0) {
385 ldb_msg_remove_attr(msg, msg->elements[i].name);
394 search function for a non-indexed search
396 static int search_func(struct tdb_context *tdb, TDB_DATA key, TDB_DATA data, void *state)
398 struct ldb_handle *handle = talloc_get_type(state, struct ldb_handle);
399 struct ltdb_context *ac = talloc_get_type(handle->private_data, struct ltdb_context);
400 struct ldb_reply *ares = NULL;
404 strncmp((char *)key.dptr, "DN=", 3) != 0) {
408 ares = talloc_zero(ac, struct ldb_reply);
410 handle->status = LDB_ERR_OPERATIONS_ERROR;
411 handle->state = LDB_ASYNC_DONE;
412 return LDB_ERR_OPERATIONS_ERROR;
415 ares->message = ldb_msg_new(ares);
416 if (!ares->message) {
417 handle->status = LDB_ERR_OPERATIONS_ERROR;
418 handle->state = LDB_ASYNC_DONE;
420 return LDB_ERR_OPERATIONS_ERROR;
423 /* unpack the record */
424 ret = ltdb_unpack_data(ac->module, &data, ares->message);
427 return LDB_ERR_OPERATIONS_ERROR;
430 if (!ares->message->dn) {
431 ares->message->dn = ldb_dn_new(ares->message, ac->module->ldb, (char *)key.dptr + 3);
432 if (ares->message->dn == NULL) {
433 handle->status = LDB_ERR_OPERATIONS_ERROR;
434 handle->state = LDB_ASYNC_DONE;
436 return LDB_ERR_OPERATIONS_ERROR;
440 /* see if it matches the given expression */
441 if (!ldb_match_msg(ac->module->ldb, ares->message, ac->tree,
442 ac->base, ac->scope)) {
447 /* filter the attributes that the user wants */
448 ret = ltdb_filter_attrs(ares->message, ac->attrs);
450 if (ret != LDB_SUCCESS) {
451 handle->status = LDB_ERR_OPERATIONS_ERROR;
452 handle->state = LDB_ASYNC_DONE;
454 return LDB_ERR_OPERATIONS_ERROR;
457 ares->type = LDB_REPLY_ENTRY;
458 handle->state = LDB_ASYNC_PENDING;
459 handle->status = ac->callback(ac->module->ldb, ac->context, ares);
461 if (handle->status != LDB_SUCCESS) {
462 /* don't try to free ares here, the callback is in charge of that */
463 return LDB_ERR_OPERATIONS_ERROR;
471 search the database with a LDAP-like expression.
472 this is the "full search" non-indexed variant
474 static int ltdb_search_full(struct ldb_handle *handle)
476 struct ltdb_context *ac = talloc_get_type(handle->private_data, struct ltdb_context);
477 struct ltdb_private *ltdb = talloc_get_type(ac->module->private_data, struct ltdb_private);
480 if (ltdb->in_transaction != 0) {
481 ret = tdb_traverse(ltdb->tdb, search_func, handle);
483 ret = tdb_traverse_read(ltdb->tdb, search_func, handle);
487 handle->status = LDB_ERR_OPERATIONS_ERROR;
490 handle->state = LDB_ASYNC_DONE;
495 search the database with a LDAP-like expression.
496 choses a search method
498 int ltdb_search(struct ldb_module *module, struct ldb_request *req)
500 struct ltdb_private *ltdb = talloc_get_type(module->private_data, struct ltdb_private);
501 struct ltdb_context *ltdb_ac;
502 struct ldb_reply *ares;
505 if (ltdb_lock_read(module) != 0) {
506 return LDB_ERR_OPERATIONS_ERROR;
509 if (ltdb_cache_load(module) != 0) {
510 ltdb_unlock_read(module);
511 return LDB_ERR_OPERATIONS_ERROR;
514 if (req->op.search.tree == NULL) {
515 ltdb_unlock_read(module);
516 return LDB_ERR_OPERATIONS_ERROR;
519 req->handle = init_ltdb_handle(ltdb, module, req);
520 if (req->handle == NULL) {
521 ltdb_unlock_read(module);
522 return LDB_ERR_OPERATIONS_ERROR;
525 if ((req->op.search.base == NULL) || (ldb_dn_is_null(req->op.search.base) == true)) {
527 /* Check what we should do with a NULL dn */
528 switch (req->op.search.scope) {
530 ldb_asprintf_errstring(module->ldb,
531 "NULL Base DN invalid for a base search");
532 ret = LDB_ERR_INVALID_DN_SYNTAX;
534 case LDB_SCOPE_ONELEVEL:
535 ldb_asprintf_errstring(module->ldb,
536 "NULL Base DN invalid for a one-level search");
537 ret = LDB_ERR_INVALID_DN_SYNTAX;
539 case LDB_SCOPE_SUBTREE:
541 /* We accept subtree searches from a NULL base DN, ie over the whole DB */
544 } else if (ldb_dn_is_valid(req->op.search.base) == false) {
546 /* We don't want invalid base DNs here */
547 ldb_asprintf_errstring(module->ldb,
548 "Invalid Base DN: %s",
549 ldb_dn_get_linearized(req->op.search.base));
550 ret = LDB_ERR_INVALID_DN_SYNTAX;
552 } else if (ltdb->check_base) {
553 /* This database has been marked as 'checkBaseOnSearch', so do a spot check of the base dn */
554 ret = ltdb_search_base(module, req->op.search.base);
556 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
557 ldb_asprintf_errstring(module->ldb,
558 "No such Base DN: %s",
559 ldb_dn_get_linearized(req->op.search.base));
563 /* If we are not checking the base DN life is easy */
567 ltdb_ac = talloc_get_type(req->handle->private_data, struct ltdb_context);
569 ltdb_ac->tree = req->op.search.tree;
570 ltdb_ac->scope = req->op.search.scope;
571 ltdb_ac->base = req->op.search.base;
572 ltdb_ac->attrs = req->op.search.attrs;
575 if (ret == LDB_SUCCESS) {
576 ret = ltdb_search_indexed(req->handle);
577 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
578 /* Not in the index, therefore OK! */
581 } else if (ret == LDB_ERR_OPERATIONS_ERROR) {
582 /* Not indexed, so we need to do a full scan */
583 ret = ltdb_search_full(req->handle);
584 if (ret != LDB_SUCCESS) {
585 ldb_set_errstring(module->ldb, "Indexed and full searches both failed!\n");
590 if (ret != LDB_SUCCESS) {
591 req->handle->state = LDB_ASYNC_DONE;
592 req->handle->status = ret;
595 /* Finally send an LDB_REPLY_DONE packet when searching is finished */
597 ares = talloc_zero(req, struct ldb_reply);
599 ltdb_unlock_read(module);
600 return LDB_ERR_OPERATIONS_ERROR;
603 req->handle->state = LDB_ASYNC_DONE;
605 if (ret == LDB_SUCCESS) {
606 ares->type = LDB_REPLY_DONE;
608 ret = req->callback(module->ldb, req->context, ares);
609 req->handle->status = ret;
612 ltdb_unlock_read(module);