/* ldb database library Copyright (C) Andrew Tridgell 2004 ** NOTE! The following LGPL license applies to the ldb ** library. This does NOT imply that all of Samba is released ** under the LGPL This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, see <http://www.gnu.org/licenses/>. */ /* * Name: ldb * * Component: ldb search functions * * Description: functions to search ldb+tdb databases * * Author: Andrew Tridgell */ #include "ldb_includes.h" #include "ldb_tdb.h" /* add one element to a message */ static int msg_add_element(struct ldb_message *ret, const struct ldb_message_element *el, int check_duplicates) { unsigned int i; struct ldb_message_element *e2, *elnew; if (check_duplicates && ldb_msg_find_element(ret, el->name)) { /* its already there */ return 0; } e2 = talloc_realloc(ret, ret->elements, struct ldb_message_element, ret->num_elements+1); if (!e2) { return -1; } ret->elements = e2; elnew = &e2[ret->num_elements]; elnew->name = talloc_strdup(ret->elements, el->name); if (!elnew->name) { return -1; } if (el->num_values) { elnew->values = talloc_array(ret->elements, struct ldb_val, el->num_values); if (!elnew->values) { return -1; } } else { elnew->values = NULL; } for (i=0;i<el->num_values;i++) { elnew->values[i] = ldb_val_dup(elnew->values, &el->values[i]); if (elnew->values[i].length != el->values[i].length) { return -1; } } elnew->num_values = el->num_values; ret->num_elements++; return 0; } /* add the special distinguishedName element */ static int msg_add_distinguished_name(struct ldb_message *msg) { struct ldb_message_element el; struct ldb_val val; int ret; el.flags = 0; el.name = "distinguishedName"; el.num_values = 1; el.values = &val; val.data = (uint8_t *)ldb_dn_alloc_linearized(msg, msg->dn); val.length = strlen((char *)val.data); ret = msg_add_element(msg, &el, 1); return ret; } /* add all elements from one message into another */ static int msg_add_all_elements(struct ldb_module *module, struct ldb_message *ret, const struct ldb_message *msg) { struct ldb_context *ldb = module->ldb; unsigned int i; int check_duplicates = (ret->num_elements != 0); if (msg_add_distinguished_name(ret) != 0) { return -1; } for (i=0;i<msg->num_elements;i++) { const struct ldb_schema_attribute *a; a = ldb_schema_attribute_by_name(ldb, msg->elements[i].name); if (a->flags & LDB_ATTR_FLAG_HIDDEN) { continue; } if (msg_add_element(ret, &msg->elements[i], check_duplicates) != 0) { return -1; } } return 0; } /* pull the specified list of attributes from a message */ static struct ldb_message *ltdb_pull_attrs(struct ldb_module *module, TALLOC_CTX *mem_ctx, const struct ldb_message *msg, const char * const *attrs) { struct ldb_message *ret; int i; ret = talloc(mem_ctx, struct ldb_message); if (!ret) { return NULL; } ret->dn = ldb_dn_copy(ret, msg->dn); if (!ret->dn) { talloc_free(ret); return NULL; } ret->num_elements = 0; ret->elements = NULL; if (!attrs) { if (msg_add_all_elements(module, ret, msg) != 0) { talloc_free(ret); return NULL; } return ret; } for (i=0;attrs[i];i++) { struct ldb_message_element *el; if (strcmp(attrs[i], "*") == 0) { if (msg_add_all_elements(module, ret, msg) != 0) { talloc_free(ret); return NULL; } continue; } if (ldb_attr_cmp(attrs[i], "distinguishedName") == 0) { if (msg_add_distinguished_name(ret) != 0) { return NULL; } continue; } el = ldb_msg_find_element(msg, attrs[i]); if (!el) { continue; } if (msg_add_element(ret, el, 1) != 0) { talloc_free(ret); return NULL; } } return ret; } /* search the database for a single simple dn. return LDB_ERR_NO_SUCH_OBJECT on record-not-found and LDB_SUCCESS on success */ int ltdb_search_base(struct ldb_module *module, struct ldb_dn *dn) { struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data; TDB_DATA tdb_key, tdb_data; if (ldb_dn_is_null(dn)) { return LDB_ERR_NO_SUCH_OBJECT; } /* form the key */ tdb_key = ltdb_key(module, dn); if (!tdb_key.dptr) { return LDB_ERR_OPERATIONS_ERROR; } tdb_data = tdb_fetch(ltdb->tdb, tdb_key); talloc_free(tdb_key.dptr); if (!tdb_data.dptr) { return LDB_ERR_NO_SUCH_OBJECT; } free(tdb_data.dptr); return LDB_SUCCESS; } /* search the database for a single simple dn, returning all attributes in a single message return LDB_ERR_NO_SUCH_OBJECT on record-not-found and LDB_SUCCESS on success */ int ltdb_search_dn1(struct ldb_module *module, struct ldb_dn *dn, struct ldb_message *msg) { struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data; int ret; TDB_DATA tdb_key, tdb_data; memset(msg, 0, sizeof(*msg)); /* form the key */ tdb_key = ltdb_key(module, dn); if (!tdb_key.dptr) { return LDB_ERR_OPERATIONS_ERROR; } tdb_data = tdb_fetch(ltdb->tdb, tdb_key); talloc_free(tdb_key.dptr); if (!tdb_data.dptr) { return LDB_ERR_NO_SUCH_OBJECT; } msg->num_elements = 0; msg->elements = NULL; ret = ltdb_unpack_data(module, &tdb_data, msg); free(tdb_data.dptr); if (ret == -1) { return LDB_ERR_OPERATIONS_ERROR; } if (!msg->dn) { msg->dn = ldb_dn_copy(msg, dn); } if (!msg->dn) { return LDB_ERR_OPERATIONS_ERROR; } return LDB_SUCCESS; } /* lock the database for read - use by ltdb_search */ static int ltdb_lock_read(struct ldb_module *module) { struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data; if (ltdb->in_transaction == 0) { return tdb_lockall_read(ltdb->tdb); } return 0; } /* unlock the database after a ltdb_lock_read() */ static int ltdb_unlock_read(struct ldb_module *module) { struct ltdb_private *ltdb = (struct ltdb_private *)module->private_data; if (ltdb->in_transaction == 0) { return tdb_unlockall_read(ltdb->tdb); } return 0; } /* add a set of attributes from a record to a set of results return 0 on success, -1 on failure */ int ltdb_add_attr_results(struct ldb_module *module, TALLOC_CTX *mem_ctx, struct ldb_message *msg, const char * const attrs[], unsigned int *count, struct ldb_message ***res) { struct ldb_message *msg2; struct ldb_message **res2; /* pull the attributes that the user wants */ msg2 = ltdb_pull_attrs(module, mem_ctx, msg, attrs); if (!msg2) { return -1; } /* add to the results list */ res2 = talloc_realloc(mem_ctx, *res, struct ldb_message *, (*count)+2); if (!res2) { talloc_free(msg2); return -1; } (*res) = res2; (*res)[*count] = talloc_move(*res, &msg2); (*res)[(*count)+1] = NULL; (*count)++; return 0; } /* filter the specified list of attributes from a message removing not requested attrs. */ int ltdb_filter_attrs(struct ldb_message *msg, const char * const *attrs) { int i, keep_all = 0; if (attrs) { /* check for special attrs */ for (i = 0; attrs[i]; i++) { if (strcmp(attrs[i], "*") == 0) { keep_all = 1; break; } if (ldb_attr_cmp(attrs[i], "distinguishedName") == 0) { if (msg_add_distinguished_name(msg) != 0) { return -1; } } } } else { keep_all = 1; } if (keep_all) { if (msg_add_distinguished_name(msg) != 0) { return -1; } return 0; } for (i = 0; i < msg->num_elements; i++) { int j, found; for (j = 0, found = 0; attrs[j]; j++) { if (ldb_attr_cmp(msg->elements[i].name, attrs[j]) == 0) { found = 1; break; } } if (!found) { ldb_msg_remove_attr(msg, msg->elements[i].name); i--; } } return 0; } /* search function for a non-indexed search */ static int search_func(struct tdb_context *tdb, TDB_DATA key, TDB_DATA data, void *state) { struct ldb_handle *handle = talloc_get_type(state, struct ldb_handle); struct ltdb_context *ac = talloc_get_type(handle->private_data, struct ltdb_context); struct ldb_reply *ares = NULL; int ret; if (key.dsize < 4 || strncmp((char *)key.dptr, "DN=", 3) != 0) { return 0; } ares = talloc_zero(ac, struct ldb_reply); if (!ares) { handle->status = LDB_ERR_OPERATIONS_ERROR; handle->state = LDB_ASYNC_DONE; return -1; } ares->message = ldb_msg_new(ares); if (!ares->message) { handle->status = LDB_ERR_OPERATIONS_ERROR; handle->state = LDB_ASYNC_DONE; talloc_free(ares); return -1; } /* unpack the record */ ret = ltdb_unpack_data(ac->module, &data, ares->message); if (ret == -1) { talloc_free(ares); return -1; } if (!ares->message->dn) { ares->message->dn = ldb_dn_new(ares->message, ac->module->ldb, (char *)key.dptr + 3); if (ares->message->dn == NULL) { handle->status = LDB_ERR_OPERATIONS_ERROR; handle->state = LDB_ASYNC_DONE; talloc_free(ares); return -1; } } /* see if it matches the given expression */ if (!ldb_match_msg(ac->module->ldb, ares->message, ac->tree, ac->base, ac->scope)) { talloc_free(ares); return 0; } /* filter the attributes that the user wants */ ret = ltdb_filter_attrs(ares->message, ac->attrs); if (ret == -1) { handle->status = LDB_ERR_OPERATIONS_ERROR; handle->state = LDB_ASYNC_DONE; talloc_free(ares); return -1; } ares->type = LDB_REPLY_ENTRY; handle->state = LDB_ASYNC_PENDING; handle->status = ac->callback(ac->module->ldb, ac->context, ares); if (handle->status != LDB_SUCCESS) { /* don't try to free ares here, the callback is in charge of that */ return -1; } return 0; } /* search the database with a LDAP-like expression. this is the "full search" non-indexed variant */ static int ltdb_search_full(struct ldb_handle *handle) { struct ltdb_context *ac = talloc_get_type(handle->private_data, struct ltdb_context); struct ltdb_private *ltdb = talloc_get_type(ac->module->private_data, struct ltdb_private); int ret; if (ltdb->in_transaction != 0) { ret = tdb_traverse(ltdb->tdb, search_func, handle); } else { ret = tdb_traverse_read(ltdb->tdb, search_func, handle); } if (ret == -1) { handle->status = LDB_ERR_OPERATIONS_ERROR; } handle->state = LDB_ASYNC_DONE; return LDB_SUCCESS; } /* search the database with a LDAP-like expression. choses a search method */ int ltdb_search(struct ldb_module *module, struct ldb_request *req) { struct ltdb_private *ltdb = talloc_get_type(module->private_data, struct ltdb_private); struct ltdb_context *ltdb_ac; struct ldb_reply *ares; int ret; if (ltdb_lock_read(module) != 0) { return LDB_ERR_OPERATIONS_ERROR; } if (ltdb_cache_load(module) != 0) { ltdb_unlock_read(module); return LDB_ERR_OPERATIONS_ERROR; } if (req->op.search.tree == NULL) { ltdb_unlock_read(module); return LDB_ERR_OPERATIONS_ERROR; } req->handle = init_ltdb_handle(ltdb, module, req); if (req->handle == NULL) { ltdb_unlock_read(module); return LDB_ERR_OPERATIONS_ERROR; } if ((req->op.search.base == NULL) || (ldb_dn_is_null(req->op.search.base) == true)) { /* Check what we should do with a NULL dn */ switch (req->op.search.scope) { case LDB_SCOPE_BASE: ldb_asprintf_errstring(module->ldb, "NULL Base DN invalid for a base search"); ret = LDB_ERR_INVALID_DN_SYNTAX; break; case LDB_SCOPE_ONELEVEL: ldb_asprintf_errstring(module->ldb, "NULL Base DN invalid for a one-level search"); ret = LDB_ERR_INVALID_DN_SYNTAX; break; case LDB_SCOPE_SUBTREE: default: /* We accept subtree searches from a NULL base DN, ie over the whole DB */ ret = LDB_SUCCESS; } } else if (ldb_dn_is_valid(req->op.search.base) == false) { /* We don't want invalid base DNs here */ ldb_asprintf_errstring(module->ldb, "Invalid Base DN: %s", ldb_dn_get_linearized(req->op.search.base)); ret = LDB_ERR_INVALID_DN_SYNTAX; } else if (ltdb->check_base) { /* This database has been marked as 'checkBaseOnSearch', so do a spot check of the base dn */ ret = ltdb_search_base(module, req->op.search.base); if (ret == LDB_ERR_NO_SUCH_OBJECT) { ldb_asprintf_errstring(module->ldb, "No such Base DN: %s", ldb_dn_get_linearized(req->op.search.base)); } } else { /* If we are not checking the base DN life is easy */ ret = LDB_SUCCESS; } ltdb_ac = talloc_get_type(req->handle->private_data, struct ltdb_context); ltdb_ac->tree = req->op.search.tree; ltdb_ac->scope = req->op.search.scope; ltdb_ac->base = req->op.search.base; ltdb_ac->attrs = req->op.search.attrs; if (ret == LDB_SUCCESS) { ret = ltdb_search_indexed(req->handle); if (ret == LDB_ERR_NO_SUCH_OBJECT) { /* Not in the index, therefore OK! */ ret = LDB_SUCCESS; } else if (ret == LDB_ERR_OPERATIONS_ERROR) { /* Not indexed, so we need to do a full scan */ ret = ltdb_search_full(req->handle); if (ret != LDB_SUCCESS) { ldb_set_errstring(module->ldb, "Indexed and full searches both failed!\n"); } } } if (ret != LDB_SUCCESS) { req->handle->state = LDB_ASYNC_DONE; req->handle->status = ret; } /* Finally send an LDB_REPLY_DONE packet when searching is finished */ ares = talloc_zero(req, struct ldb_reply); if (!ares) { ltdb_unlock_read(module); return LDB_ERR_OPERATIONS_ERROR; } req->handle->state = LDB_ASYNC_DONE; if (ret == LDB_SUCCESS) { ares->type = LDB_REPLY_DONE; ret = req->callback(module->ldb, req->context, ares); req->handle->status = ret; } ltdb_unlock_read(module); return LDB_SUCCESS; }