4 Copyright (C) Andrew Tridgell 2004
5 Copyright (C) Simo Sorce 2006
7 ** NOTE! The following LGPL license applies to the ldb
8 ** library. This does NOT imply that all of Samba is released
11 This library is free software; you can redistribute it and/or
12 modify it under the terms of the GNU Lesser General Public
13 License as published by the Free Software Foundation; either
14 version 3 of the License, or (at your option) any later version.
16 This library is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public
22 License along with this library; if not, write to the Free Software
23 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 * Component: ldb ldap backend
31 * Description: core files for LDAP backend
33 * Author: Andrew Tridgell
37 * - description: make the module use asyncronous calls
42 #include "ldb_includes.h"
44 #define LDAP_DEPRECATED 1
49 struct ldb_module *module;
53 struct lldb_private *lldb;
54 struct ldb_handle *handle;
59 int (*callback)(struct ldb_context *, void *, struct ldb_reply *);
62 static int lldb_ldap_to_ldb(int err) {
63 /* Ldap errors and ldb errors are defined to the same values */
67 static struct lldb_context *init_lldb_handle(struct lldb_private *lldb, struct ldb_request *req)
69 struct lldb_context *ac;
72 h = talloc_zero(req, struct ldb_handle);
74 ldb_set_errstring(lldb->module->ldb, "Out of Memory");
78 h->module = lldb->module;
80 ac = talloc(h, struct lldb_context);
82 ldb_set_errstring(lldb->module->ldb, "Out of Memory");
89 h->state = LDB_ASYNC_INIT;
90 h->status = LDB_SUCCESS;
94 ac->context = req->context;
95 ac->callback = req->callback;
96 ac->timeout = req->timeout;
97 ac->starttime = req->starttime;
104 convert a ldb_message structure to a list of LDAPMod structures
105 ready for ldap_add() or ldap_modify()
107 static LDAPMod **lldb_msg_to_mods(void *mem_ctx, const struct ldb_message *msg, int use_flags)
113 /* allocate maximum number of elements needed */
114 mods = talloc_array(mem_ctx, LDAPMod *, msg->num_elements+1);
121 for (i=0;i<msg->num_elements;i++) {
122 const struct ldb_message_element *el = &msg->elements[i];
124 mods[num_mods] = talloc(mods, LDAPMod);
125 if (!mods[num_mods]) {
128 mods[num_mods+1] = NULL;
129 mods[num_mods]->mod_op = LDAP_MOD_BVALUES;
131 switch (el->flags & LDB_FLAG_MOD_MASK) {
132 case LDB_FLAG_MOD_ADD:
133 mods[num_mods]->mod_op |= LDAP_MOD_ADD;
135 case LDB_FLAG_MOD_DELETE:
136 mods[num_mods]->mod_op |= LDAP_MOD_DELETE;
138 case LDB_FLAG_MOD_REPLACE:
139 mods[num_mods]->mod_op |= LDAP_MOD_REPLACE;
143 mods[num_mods]->mod_type = discard_const_p(char, el->name);
144 mods[num_mods]->mod_vals.modv_bvals = talloc_array(mods[num_mods],
147 if (!mods[num_mods]->mod_vals.modv_bvals) {
151 for (j=0;j<el->num_values;j++) {
152 mods[num_mods]->mod_vals.modv_bvals[j] = talloc(mods[num_mods]->mod_vals.modv_bvals,
154 if (!mods[num_mods]->mod_vals.modv_bvals[j]) {
157 mods[num_mods]->mod_vals.modv_bvals[j]->bv_val = el->values[j].data;
158 mods[num_mods]->mod_vals.modv_bvals[j]->bv_len = el->values[j].length;
160 mods[num_mods]->mod_vals.modv_bvals[j] = NULL;
172 add a single set of ldap message values to a ldb_message
174 static int lldb_add_msg_attr(struct ldb_context *ldb,
175 struct ldb_message *msg,
176 const char *attr, struct berval **bval)
179 struct ldb_message_element *el;
181 count = ldap_count_values_len(bval);
187 el = talloc_realloc(msg, msg->elements, struct ldb_message_element,
188 msg->num_elements + 1);
196 el = &msg->elements[msg->num_elements];
198 el->name = talloc_strdup(msg->elements, attr);
206 el->values = talloc_array(msg->elements, struct ldb_val, count);
212 for (i=0;i<count;i++) {
213 /* we have to ensure this is null terminated so that
214 ldb_msg_find_attr_as_string() can work */
215 el->values[i].data = talloc_size(el->values, bval[i]->bv_len+1);
216 if (!el->values[i].data) {
220 memcpy(el->values[i].data, bval[i]->bv_val, bval[i]->bv_len);
221 el->values[i].data[bval[i]->bv_len] = 0;
222 el->values[i].length = bval[i]->bv_len;
232 search for matching records
234 static int lldb_search(struct ldb_module *module, struct ldb_request *req)
236 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
237 struct lldb_context *lldb_ac;
244 if (!req->callback || !req->context) {
245 ldb_set_errstring(module->ldb, "Async interface called with NULL callback function or NULL context");
246 return LDB_ERR_OPERATIONS_ERROR;
249 if (req->op.search.tree == NULL) {
250 ldb_set_errstring(module->ldb, "Invalid expression parse tree");
251 return LDB_ERR_OPERATIONS_ERROR;
254 if (req->controls != NULL) {
255 ldb_debug(module->ldb, LDB_DEBUG_WARNING, "Controls are not yet supported by ldb_ldap backend!\n");
258 lldb_ac = init_lldb_handle(lldb, req);
259 if (lldb_ac == NULL) {
260 return LDB_ERR_OPERATIONS_ERROR;
263 search_base = ldb_dn_alloc_linearized(lldb_ac, req->op.search.base);
264 if (req->op.search.base == NULL) {
265 search_base = talloc_strdup(lldb_ac, "");
267 if (search_base == NULL) {
268 return LDB_ERR_OPERATIONS_ERROR;
271 expression = ldb_filter_from_tree(lldb_ac, req->op.search.tree);
272 if (expression == NULL) {
273 return LDB_ERR_OPERATIONS_ERROR;
276 switch (req->op.search.scope) {
278 ldap_scope = LDAP_SCOPE_BASE;
280 case LDB_SCOPE_ONELEVEL:
281 ldap_scope = LDAP_SCOPE_ONELEVEL;
284 ldap_scope = LDAP_SCOPE_SUBTREE;
288 tv.tv_sec = req->timeout;
291 ret = ldap_search_ext(lldb->ldap, search_base, ldap_scope,
293 discard_const_p(char *, req->op.search.attrs),
301 if (ret != LDAP_SUCCESS) {
302 ldb_set_errstring(module->ldb, ldap_err2string(ret));
305 return lldb_ldap_to_ldb(ret);
311 static int lldb_add(struct ldb_module *module, struct ldb_request *req)
313 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
314 struct lldb_context *lldb_ac;
319 /* ltdb specials should not reach this point */
320 if (ldb_dn_is_special(req->op.add.message->dn)) {
321 return LDB_ERR_INVALID_DN_SYNTAX;
324 lldb_ac = init_lldb_handle(lldb, req);
325 if (lldb_ac == NULL) {
326 return LDB_ERR_OPERATIONS_ERROR;
329 mods = lldb_msg_to_mods(lldb_ac, req->op.add.message, 0);
331 return LDB_ERR_OPERATIONS_ERROR;
334 dn = ldb_dn_alloc_linearized(lldb_ac, req->op.add.message->dn);
336 return LDB_ERR_OPERATIONS_ERROR;
339 ret = ldap_add_ext(lldb->ldap, dn, mods,
344 if (ret != LDAP_SUCCESS) {
345 ldb_set_errstring(module->ldb, ldap_err2string(ret));
348 return lldb_ldap_to_ldb(ret);
354 static int lldb_modify(struct ldb_module *module, struct ldb_request *req)
356 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
357 struct lldb_context *lldb_ac;
362 /* ltdb specials should not reach this point */
363 if (ldb_dn_is_special(req->op.mod.message->dn)) {
364 return LDB_ERR_INVALID_DN_SYNTAX;
367 lldb_ac = init_lldb_handle(lldb, req);
368 if (req->handle == NULL) {
369 return LDB_ERR_OPERATIONS_ERROR;
372 mods = lldb_msg_to_mods(lldb_ac, req->op.mod.message, 1);
374 return LDB_ERR_OPERATIONS_ERROR;
377 dn = ldb_dn_alloc_linearized(lldb_ac, req->op.mod.message->dn);
379 return LDB_ERR_OPERATIONS_ERROR;
382 ret = ldap_modify_ext(lldb->ldap, dn, mods,
387 if (ret != LDAP_SUCCESS) {
388 ldb_set_errstring(module->ldb, ldap_err2string(ret));
391 return lldb_ldap_to_ldb(ret);
397 static int lldb_delete(struct ldb_module *module, struct ldb_request *req)
399 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
400 struct lldb_context *lldb_ac;
404 /* ltdb specials should not reach this point */
405 if (ldb_dn_is_special(req->op.del.dn)) {
406 return LDB_ERR_INVALID_DN_SYNTAX;
409 lldb_ac = init_lldb_handle(lldb, req);
410 if (lldb_ac == NULL) {
411 return LDB_ERR_OPERATIONS_ERROR;
414 dnstr = ldb_dn_alloc_linearized(lldb_ac, req->op.del.dn);
416 ret = ldap_delete_ext(lldb->ldap, dnstr,
421 if (ret != LDAP_SUCCESS) {
422 ldb_set_errstring(module->ldb, ldap_err2string(ret));
425 return lldb_ldap_to_ldb(ret);
431 static int lldb_rename(struct ldb_module *module, struct ldb_request *req)
433 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
434 struct lldb_context *lldb_ac;
440 /* ltdb specials should not reach this point */
441 if (ldb_dn_is_special(req->op.rename.olddn) || ldb_dn_is_special(req->op.rename.newdn)) {
442 return LDB_ERR_INVALID_DN_SYNTAX;
445 lldb_ac = init_lldb_handle(lldb, req);
446 if (lldb_ac == NULL) {
447 return LDB_ERR_OPERATIONS_ERROR;
450 old_dn = ldb_dn_alloc_linearized(lldb_ac, req->op.rename.olddn);
451 if (old_dn == NULL) {
452 return LDB_ERR_OPERATIONS_ERROR;
455 newrdn = talloc_asprintf(lldb_ac, "%s=%s",
456 ldb_dn_get_rdn_name(req->op.rename.newdn),
457 ldb_dn_escape_value(lldb, *(ldb_dn_get_rdn_val(req->op.rename.newdn))));
459 return LDB_ERR_OPERATIONS_ERROR;
462 parentdn = ldb_dn_alloc_linearized(lldb_ac, ldb_dn_get_parent(lldb_ac, req->op.rename.newdn));
464 return LDB_ERR_OPERATIONS_ERROR;
467 ret = ldap_rename(lldb->ldap, old_dn, newrdn, parentdn,
471 if (ret != LDAP_SUCCESS) {
472 ldb_set_errstring(module->ldb, ldap_err2string(ret));
475 return lldb_ldap_to_ldb(ret);
478 static int lldb_parse_result(struct lldb_context *ac, LDAPMessage *result)
480 struct ldb_handle *handle = ac->handle;
481 struct lldb_private *lldb = ac->lldb;
482 struct ldb_reply *ares = NULL;
485 char *matcheddnp = NULL;
486 char *errmsgp = NULL;
487 char **referralsp = NULL;
488 LDAPControl **serverctrlsp = NULL;
489 int ret = LDB_SUCCESS;
491 type = ldap_msgtype(result);
497 case LDAP_RES_SEARCH_ENTRY:
498 msg = ldap_first_entry(lldb->ldap, result);
500 BerElement *berptr = NULL;
503 ares = talloc_zero(ac, struct ldb_reply);
505 ret = LDB_ERR_OPERATIONS_ERROR;
509 ares->message = ldb_msg_new(ares);
510 if (!ares->message) {
511 ret = LDB_ERR_OPERATIONS_ERROR;
515 dn = ldap_get_dn(lldb->ldap, msg);
517 ret = LDB_ERR_OPERATIONS_ERROR;
520 ares->message->dn = ldb_dn_new(ares->message, ac->lldb->module->ldb, dn);
521 if ( ! ldb_dn_validate(ares->message->dn)) {
522 ret = LDB_ERR_OPERATIONS_ERROR;
527 ares->message->num_elements = 0;
528 ares->message->elements = NULL;
530 /* loop over all attributes */
531 for (attr=ldap_first_attribute(lldb->ldap, msg, &berptr);
533 attr=ldap_next_attribute(lldb->ldap, msg, berptr)) {
534 struct berval **bval;
535 bval = ldap_get_values_len(lldb->ldap, msg, attr);
538 lldb_add_msg_attr(ac->lldb->module->ldb, ares->message, attr, bval);
539 ldap_value_free_len(bval);
542 if (berptr) ber_free(berptr, 0);
545 ares->type = LDB_REPLY_ENTRY;
546 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
548 handle->status = LDB_ERR_PROTOCOL_ERROR;
549 handle->state = LDB_ASYNC_DONE;
553 case LDAP_RES_SEARCH_REFERENCE:
554 if (ldap_parse_result(lldb->ldap, result, &handle->status,
555 &matcheddnp, &errmsgp,
556 &referralsp, &serverctrlsp, 0) != LDAP_SUCCESS) {
557 ret = LDB_ERR_OPERATIONS_ERROR;
560 if (referralsp == NULL) {
561 handle->status = LDB_ERR_PROTOCOL_ERROR;
565 ares = talloc_zero(ac, struct ldb_reply);
567 ret = LDB_ERR_OPERATIONS_ERROR;
571 ares->referral = talloc_strdup(ares, *referralsp);
572 ares->type = LDB_REPLY_REFERRAL;
573 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
577 case LDAP_RES_SEARCH_RESULT:
578 if (ldap_parse_result(lldb->ldap, result, &handle->status,
579 &matcheddnp, &errmsgp,
580 &referralsp, &serverctrlsp, 0) != LDAP_SUCCESS) {
581 handle->status = LDB_ERR_OPERATIONS_ERROR;
585 ares = talloc_zero(ac, struct ldb_reply);
587 ret = LDB_ERR_OPERATIONS_ERROR;
591 if (serverctrlsp != NULL) {
592 /* FIXME: transform the LDAPControl list into an ldb_control one */
593 ares->controls = NULL;
596 ares->type = LDB_REPLY_DONE;
597 handle->state = LDB_ASYNC_DONE;
598 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
602 case LDAP_RES_MODIFY:
604 case LDAP_RES_DELETE:
606 if (ldap_parse_result(lldb->ldap, result, &handle->status,
607 &matcheddnp, &errmsgp,
608 &referralsp, &serverctrlsp, 0) != LDAP_SUCCESS) {
609 handle->status = LDB_ERR_OPERATIONS_ERROR;
612 if (ac->callback && handle->status == LDB_SUCCESS) {
613 ares = NULL; /* FIXME: build a corresponding ares to pass on */
614 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
616 handle->state = LDB_ASYNC_DONE;
620 ret = LDB_ERR_PROTOCOL_ERROR;
624 if (matcheddnp) ldap_memfree(matcheddnp);
625 if (errmsgp && *errmsgp) {
626 ldb_set_errstring(ac->lldb->module->ldb, errmsgp);
627 } else if (handle->status) {
628 ldb_set_errstring(ac->lldb->module->ldb, ldap_err2string(handle->status));
631 ldap_memfree(errmsgp);
633 if (referralsp) ldap_value_free(referralsp);
634 if (serverctrlsp) ldap_controls_free(serverctrlsp);
636 ldap_msgfree(result);
637 return lldb_ldap_to_ldb(handle->status);
640 handle->state = LDB_ASYNC_DONE;
641 ldap_msgfree(result);
645 static int lldb_wait(struct ldb_handle *handle, enum ldb_wait_type type)
647 struct lldb_context *ac = talloc_get_type(handle->private_data, struct lldb_context);
648 struct lldb_private *lldb = ac->lldb;
649 struct timeval timeout;
653 if (handle->state == LDB_ASYNC_DONE) {
654 return handle->status;
657 if (!ac || !ac->msgid) {
658 return LDB_ERR_OPERATIONS_ERROR;
661 handle->state = LDB_ASYNC_PENDING;
662 handle->status = LDB_SUCCESS;
667 if ((ac->timeout != -1) &&
668 ((ac->starttime + ac->timeout) > time(NULL))) {
669 return LDB_ERR_TIME_LIMIT_EXCEEDED;
675 lret = ldap_result(lldb->ldap, ac->msgid, 0, &timeout, &result);
677 return LDB_ERR_OPERATIONS_ERROR;
684 return lldb_parse_result(ac, result);
688 ret = LDB_ERR_OPERATIONS_ERROR;
690 while (handle->status == LDB_SUCCESS && handle->state != LDB_ASYNC_DONE) {
692 if (ac->timeout == -1) {
693 lret = ldap_result(lldb->ldap, ac->msgid, 0, NULL, &result);
695 timeout.tv_sec = ac->timeout - (time(NULL) - ac->starttime);
696 if (timeout.tv_sec <= 0)
697 return LDB_ERR_TIME_LIMIT_EXCEEDED;
698 lret = ldap_result(lldb->ldap, ac->msgid, 0, &timeout, &result);
701 return LDB_ERR_OPERATIONS_ERROR;
704 return LDB_ERR_TIME_LIMIT_EXCEEDED;
707 ret = lldb_parse_result(ac, result);
708 if (ret != LDB_SUCCESS) {
716 handle->state = LDB_ASYNC_DONE;
717 ret = LDB_ERR_OPERATIONS_ERROR;
724 static int lldb_start_trans(struct ldb_module *module)
726 /* TODO implement a local transaction mechanism here */
731 static int lldb_end_trans(struct ldb_module *module)
733 /* TODO implement a local transaction mechanism here */
738 static int lldb_del_trans(struct ldb_module *module)
740 /* TODO implement a local transaction mechanism here */
745 static int lldb_request(struct ldb_module *module, struct ldb_request *req)
747 return LDB_ERR_OPERATIONS_ERROR;
750 static const struct ldb_module_ops lldb_ops = {
752 .search = lldb_search,
754 .modify = lldb_modify,
756 .rename = lldb_rename,
757 .request = lldb_request,
758 .start_transaction = lldb_start_trans,
759 .end_transaction = lldb_end_trans,
760 .del_transaction = lldb_del_trans,
765 static int lldb_destructor(struct lldb_private *lldb)
767 ldap_unbind(lldb->ldap);
772 connect to the database
774 static int lldb_connect(struct ldb_context *ldb,
777 const char *options[],
778 struct ldb_module **_module)
780 struct ldb_module *module;
781 struct lldb_private *lldb;
785 module = talloc(ldb, struct ldb_module);
786 if (module == NULL) {
791 talloc_set_name_const(module, "ldb_ldap backend");
793 module->prev = module->next = NULL;
794 module->private_data = NULL;
795 module->ops = &lldb_ops;
797 lldb = talloc(module, struct lldb_private);
802 module->private_data = lldb;
803 lldb->module = module;
806 ret = ldap_initialize(&lldb->ldap, url);
807 if (ret != LDAP_SUCCESS) {
808 ldb_debug(ldb, LDB_DEBUG_FATAL, "ldap_initialize failed for URL '%s' - %s\n",
809 url, ldap_err2string(ret));
813 talloc_set_destructor(lldb, lldb_destructor);
815 ret = ldap_set_option(lldb->ldap, LDAP_OPT_PROTOCOL_VERSION, &version);
816 if (ret != LDAP_SUCCESS) {
817 ldb_debug(ldb, LDB_DEBUG_FATAL, "ldap_set_option failed - %s\n",
818 ldap_err2string(ret));
830 int ldb_ldap_init(void)
832 return ldb_register_backend("ldap", lldb_connect) +
833 ldb_register_backend("ldapi", lldb_connect) +
834 ldb_register_backend("ldaps", lldb_connect);