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, see <http://www.gnu.org/licenses/>.
28 * Component: ldb ldap backend
30 * Description: core files for LDAP backend
32 * Author: Andrew Tridgell
36 * - description: make the module use asyncronous calls
41 #include "ldb_includes.h"
43 #define LDAP_DEPRECATED 1
48 struct ldb_module *module;
52 struct lldb_private *lldb;
53 struct ldb_handle *handle;
58 int (*callback)(struct ldb_context *, void *, struct ldb_reply *);
61 static int lldb_ldap_to_ldb(int err) {
62 /* Ldap errors and ldb errors are defined to the same values */
66 static struct lldb_context *init_lldb_handle(struct lldb_private *lldb, struct ldb_request *req)
68 struct lldb_context *ac;
71 h = talloc_zero(req, struct ldb_handle);
73 ldb_set_errstring(lldb->module->ldb, "Out of Memory");
77 h->module = lldb->module;
79 ac = talloc(h, struct lldb_context);
81 ldb_set_errstring(lldb->module->ldb, "Out of Memory");
88 h->state = LDB_ASYNC_INIT;
89 h->status = LDB_SUCCESS;
93 ac->context = req->context;
94 ac->callback = req->callback;
95 ac->timeout = req->timeout;
96 ac->starttime = req->starttime;
103 convert a ldb_message structure to a list of LDAPMod structures
104 ready for ldap_add() or ldap_modify()
106 static LDAPMod **lldb_msg_to_mods(void *mem_ctx, const struct ldb_message *msg, int use_flags)
112 /* allocate maximum number of elements needed */
113 mods = talloc_array(mem_ctx, LDAPMod *, msg->num_elements+1);
120 for (i=0;i<msg->num_elements;i++) {
121 const struct ldb_message_element *el = &msg->elements[i];
123 mods[num_mods] = talloc(mods, LDAPMod);
124 if (!mods[num_mods]) {
127 mods[num_mods+1] = NULL;
128 mods[num_mods]->mod_op = LDAP_MOD_BVALUES;
130 switch (el->flags & LDB_FLAG_MOD_MASK) {
131 case LDB_FLAG_MOD_ADD:
132 mods[num_mods]->mod_op |= LDAP_MOD_ADD;
134 case LDB_FLAG_MOD_DELETE:
135 mods[num_mods]->mod_op |= LDAP_MOD_DELETE;
137 case LDB_FLAG_MOD_REPLACE:
138 mods[num_mods]->mod_op |= LDAP_MOD_REPLACE;
142 mods[num_mods]->mod_type = discard_const_p(char, el->name);
143 mods[num_mods]->mod_vals.modv_bvals = talloc_array(mods[num_mods],
146 if (!mods[num_mods]->mod_vals.modv_bvals) {
150 for (j=0;j<el->num_values;j++) {
151 mods[num_mods]->mod_vals.modv_bvals[j] = talloc(mods[num_mods]->mod_vals.modv_bvals,
153 if (!mods[num_mods]->mod_vals.modv_bvals[j]) {
156 mods[num_mods]->mod_vals.modv_bvals[j]->bv_val = el->values[j].data;
157 mods[num_mods]->mod_vals.modv_bvals[j]->bv_len = el->values[j].length;
159 mods[num_mods]->mod_vals.modv_bvals[j] = NULL;
171 add a single set of ldap message values to a ldb_message
173 static int lldb_add_msg_attr(struct ldb_context *ldb,
174 struct ldb_message *msg,
175 const char *attr, struct berval **bval)
178 struct ldb_message_element *el;
180 count = ldap_count_values_len(bval);
186 el = talloc_realloc(msg, msg->elements, struct ldb_message_element,
187 msg->num_elements + 1);
195 el = &msg->elements[msg->num_elements];
197 el->name = talloc_strdup(msg->elements, attr);
205 el->values = talloc_array(msg->elements, struct ldb_val, count);
211 for (i=0;i<count;i++) {
212 /* we have to ensure this is null terminated so that
213 ldb_msg_find_attr_as_string() can work */
214 el->values[i].data = talloc_size(el->values, bval[i]->bv_len+1);
215 if (!el->values[i].data) {
219 memcpy(el->values[i].data, bval[i]->bv_val, bval[i]->bv_len);
220 el->values[i].data[bval[i]->bv_len] = 0;
221 el->values[i].length = bval[i]->bv_len;
231 search for matching records
233 static int lldb_search(struct ldb_module *module, struct ldb_request *req)
235 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
236 struct lldb_context *lldb_ac;
243 if (!req->callback || !req->context) {
244 ldb_set_errstring(module->ldb, "Async interface called with NULL callback function or NULL context");
245 return LDB_ERR_OPERATIONS_ERROR;
248 if (req->op.search.tree == NULL) {
249 ldb_set_errstring(module->ldb, "Invalid expression parse tree");
250 return LDB_ERR_OPERATIONS_ERROR;
253 if (req->controls != NULL) {
254 ldb_debug(module->ldb, LDB_DEBUG_WARNING, "Controls are not yet supported by ldb_ldap backend!\n");
257 lldb_ac = init_lldb_handle(lldb, req);
258 if (lldb_ac == NULL) {
259 return LDB_ERR_OPERATIONS_ERROR;
262 search_base = ldb_dn_alloc_linearized(lldb_ac, req->op.search.base);
263 if (req->op.search.base == NULL) {
264 search_base = talloc_strdup(lldb_ac, "");
266 if (search_base == NULL) {
267 return LDB_ERR_OPERATIONS_ERROR;
270 expression = ldb_filter_from_tree(lldb_ac, req->op.search.tree);
271 if (expression == NULL) {
272 return LDB_ERR_OPERATIONS_ERROR;
275 switch (req->op.search.scope) {
277 ldap_scope = LDAP_SCOPE_BASE;
279 case LDB_SCOPE_ONELEVEL:
280 ldap_scope = LDAP_SCOPE_ONELEVEL;
283 ldap_scope = LDAP_SCOPE_SUBTREE;
287 tv.tv_sec = req->timeout;
290 ret = ldap_search_ext(lldb->ldap, search_base, ldap_scope,
292 discard_const_p(char *, req->op.search.attrs),
300 if (ret != LDAP_SUCCESS) {
301 ldb_set_errstring(module->ldb, ldap_err2string(ret));
304 return lldb_ldap_to_ldb(ret);
310 static int lldb_add(struct ldb_module *module, struct ldb_request *req)
312 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
313 struct lldb_context *lldb_ac;
318 /* ltdb specials should not reach this point */
319 if (ldb_dn_is_special(req->op.add.message->dn)) {
320 return LDB_ERR_INVALID_DN_SYNTAX;
323 lldb_ac = init_lldb_handle(lldb, req);
324 if (lldb_ac == NULL) {
325 return LDB_ERR_OPERATIONS_ERROR;
328 mods = lldb_msg_to_mods(lldb_ac, req->op.add.message, 0);
330 return LDB_ERR_OPERATIONS_ERROR;
333 dn = ldb_dn_alloc_linearized(lldb_ac, req->op.add.message->dn);
335 return LDB_ERR_OPERATIONS_ERROR;
338 ret = ldap_add_ext(lldb->ldap, dn, mods,
343 if (ret != LDAP_SUCCESS) {
344 ldb_set_errstring(module->ldb, ldap_err2string(ret));
347 return lldb_ldap_to_ldb(ret);
353 static int lldb_modify(struct ldb_module *module, struct ldb_request *req)
355 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
356 struct lldb_context *lldb_ac;
361 /* ltdb specials should not reach this point */
362 if (ldb_dn_is_special(req->op.mod.message->dn)) {
363 return LDB_ERR_INVALID_DN_SYNTAX;
366 lldb_ac = init_lldb_handle(lldb, req);
367 if (req->handle == NULL) {
368 return LDB_ERR_OPERATIONS_ERROR;
371 mods = lldb_msg_to_mods(lldb_ac, req->op.mod.message, 1);
373 return LDB_ERR_OPERATIONS_ERROR;
376 dn = ldb_dn_alloc_linearized(lldb_ac, req->op.mod.message->dn);
378 return LDB_ERR_OPERATIONS_ERROR;
381 ret = ldap_modify_ext(lldb->ldap, dn, mods,
386 if (ret != LDAP_SUCCESS) {
387 ldb_set_errstring(module->ldb, ldap_err2string(ret));
390 return lldb_ldap_to_ldb(ret);
396 static int lldb_delete(struct ldb_module *module, struct ldb_request *req)
398 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
399 struct lldb_context *lldb_ac;
403 /* ltdb specials should not reach this point */
404 if (ldb_dn_is_special(req->op.del.dn)) {
405 return LDB_ERR_INVALID_DN_SYNTAX;
408 lldb_ac = init_lldb_handle(lldb, req);
409 if (lldb_ac == NULL) {
410 return LDB_ERR_OPERATIONS_ERROR;
413 dnstr = ldb_dn_alloc_linearized(lldb_ac, req->op.del.dn);
415 ret = ldap_delete_ext(lldb->ldap, dnstr,
420 if (ret != LDAP_SUCCESS) {
421 ldb_set_errstring(module->ldb, ldap_err2string(ret));
424 return lldb_ldap_to_ldb(ret);
430 static int lldb_rename(struct ldb_module *module, struct ldb_request *req)
432 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
433 struct lldb_context *lldb_ac;
439 /* ltdb specials should not reach this point */
440 if (ldb_dn_is_special(req->op.rename.olddn) || ldb_dn_is_special(req->op.rename.newdn)) {
441 return LDB_ERR_INVALID_DN_SYNTAX;
444 lldb_ac = init_lldb_handle(lldb, req);
445 if (lldb_ac == NULL) {
446 return LDB_ERR_OPERATIONS_ERROR;
449 old_dn = ldb_dn_alloc_linearized(lldb_ac, req->op.rename.olddn);
450 if (old_dn == NULL) {
451 return LDB_ERR_OPERATIONS_ERROR;
454 newrdn = talloc_asprintf(lldb_ac, "%s=%s",
455 ldb_dn_get_rdn_name(req->op.rename.newdn),
456 ldb_dn_escape_value(lldb, *(ldb_dn_get_rdn_val(req->op.rename.newdn))));
458 return LDB_ERR_OPERATIONS_ERROR;
461 parentdn = ldb_dn_alloc_linearized(lldb_ac, ldb_dn_get_parent(lldb_ac, req->op.rename.newdn));
463 return LDB_ERR_OPERATIONS_ERROR;
466 ret = ldap_rename(lldb->ldap, old_dn, newrdn, parentdn,
470 if (ret != LDAP_SUCCESS) {
471 ldb_set_errstring(module->ldb, ldap_err2string(ret));
474 return lldb_ldap_to_ldb(ret);
477 static int lldb_parse_result(struct lldb_context *ac, LDAPMessage *result)
479 struct ldb_handle *handle = ac->handle;
480 struct lldb_private *lldb = ac->lldb;
481 struct ldb_reply *ares = NULL;
484 char *matcheddnp = NULL;
485 char *errmsgp = NULL;
486 char **referralsp = NULL;
487 LDAPControl **serverctrlsp = NULL;
488 int ret = LDB_SUCCESS;
490 type = ldap_msgtype(result);
496 case LDAP_RES_SEARCH_ENTRY:
497 msg = ldap_first_entry(lldb->ldap, result);
499 BerElement *berptr = NULL;
502 ares = talloc_zero(ac, struct ldb_reply);
504 ret = LDB_ERR_OPERATIONS_ERROR;
508 ares->message = ldb_msg_new(ares);
509 if (!ares->message) {
510 ret = LDB_ERR_OPERATIONS_ERROR;
514 dn = ldap_get_dn(lldb->ldap, msg);
516 ret = LDB_ERR_OPERATIONS_ERROR;
519 ares->message->dn = ldb_dn_new(ares->message, ac->lldb->module->ldb, dn);
520 if ( ! ldb_dn_validate(ares->message->dn)) {
521 ret = LDB_ERR_OPERATIONS_ERROR;
526 ares->message->num_elements = 0;
527 ares->message->elements = NULL;
529 /* loop over all attributes */
530 for (attr=ldap_first_attribute(lldb->ldap, msg, &berptr);
532 attr=ldap_next_attribute(lldb->ldap, msg, berptr)) {
533 struct berval **bval;
534 bval = ldap_get_values_len(lldb->ldap, msg, attr);
537 lldb_add_msg_attr(ac->lldb->module->ldb, ares->message, attr, bval);
538 ldap_value_free_len(bval);
541 if (berptr) ber_free(berptr, 0);
544 ares->type = LDB_REPLY_ENTRY;
545 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
547 handle->status = LDB_ERR_PROTOCOL_ERROR;
548 handle->state = LDB_ASYNC_DONE;
552 case LDAP_RES_SEARCH_REFERENCE:
553 if (ldap_parse_result(lldb->ldap, result, &handle->status,
554 &matcheddnp, &errmsgp,
555 &referralsp, &serverctrlsp, 0) != LDAP_SUCCESS) {
556 ret = LDB_ERR_OPERATIONS_ERROR;
559 if (referralsp == NULL) {
560 handle->status = LDB_ERR_PROTOCOL_ERROR;
564 ares = talloc_zero(ac, struct ldb_reply);
566 ret = LDB_ERR_OPERATIONS_ERROR;
570 ares->referral = talloc_strdup(ares, *referralsp);
571 ares->type = LDB_REPLY_REFERRAL;
572 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
576 case LDAP_RES_SEARCH_RESULT:
577 if (ldap_parse_result(lldb->ldap, result, &handle->status,
578 &matcheddnp, &errmsgp,
579 &referralsp, &serverctrlsp, 0) != LDAP_SUCCESS) {
580 handle->status = LDB_ERR_OPERATIONS_ERROR;
584 ares = talloc_zero(ac, struct ldb_reply);
586 ret = LDB_ERR_OPERATIONS_ERROR;
590 if (serverctrlsp != NULL) {
591 /* FIXME: transform the LDAPControl list into an ldb_control one */
592 ares->controls = NULL;
595 ares->type = LDB_REPLY_DONE;
596 handle->state = LDB_ASYNC_DONE;
597 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
601 case LDAP_RES_MODIFY:
603 case LDAP_RES_DELETE:
605 if (ldap_parse_result(lldb->ldap, result, &handle->status,
606 &matcheddnp, &errmsgp,
607 &referralsp, &serverctrlsp, 0) != LDAP_SUCCESS) {
608 handle->status = LDB_ERR_OPERATIONS_ERROR;
611 if (ac->callback && handle->status == LDB_SUCCESS) {
612 ares = NULL; /* FIXME: build a corresponding ares to pass on */
613 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
615 handle->state = LDB_ASYNC_DONE;
619 ret = LDB_ERR_PROTOCOL_ERROR;
623 if (matcheddnp) ldap_memfree(matcheddnp);
624 if (errmsgp && *errmsgp) {
625 ldb_set_errstring(ac->lldb->module->ldb, errmsgp);
626 } else if (handle->status) {
627 ldb_set_errstring(ac->lldb->module->ldb, ldap_err2string(handle->status));
630 ldap_memfree(errmsgp);
632 if (referralsp) ldap_value_free(referralsp);
633 if (serverctrlsp) ldap_controls_free(serverctrlsp);
635 ldap_msgfree(result);
636 return lldb_ldap_to_ldb(handle->status);
639 handle->state = LDB_ASYNC_DONE;
640 ldap_msgfree(result);
644 static int lldb_wait(struct ldb_handle *handle, enum ldb_wait_type type)
646 struct lldb_context *ac = talloc_get_type(handle->private_data, struct lldb_context);
647 struct lldb_private *lldb = ac->lldb;
648 struct timeval timeout;
652 if (handle->state == LDB_ASYNC_DONE) {
653 return handle->status;
656 if (!ac || !ac->msgid) {
657 return LDB_ERR_OPERATIONS_ERROR;
660 handle->state = LDB_ASYNC_PENDING;
661 handle->status = LDB_SUCCESS;
666 if ((ac->timeout != -1) &&
667 ((ac->starttime + ac->timeout) > time(NULL))) {
668 return LDB_ERR_TIME_LIMIT_EXCEEDED;
674 lret = ldap_result(lldb->ldap, ac->msgid, 0, &timeout, &result);
676 return LDB_ERR_OPERATIONS_ERROR;
683 return lldb_parse_result(ac, result);
687 ret = LDB_ERR_OPERATIONS_ERROR;
689 while (handle->status == LDB_SUCCESS && handle->state != LDB_ASYNC_DONE) {
691 if (ac->timeout == -1) {
692 lret = ldap_result(lldb->ldap, ac->msgid, 0, NULL, &result);
694 timeout.tv_sec = ac->timeout - (time(NULL) - ac->starttime);
695 if (timeout.tv_sec <= 0)
696 return LDB_ERR_TIME_LIMIT_EXCEEDED;
697 lret = ldap_result(lldb->ldap, ac->msgid, 0, &timeout, &result);
700 return LDB_ERR_OPERATIONS_ERROR;
703 return LDB_ERR_TIME_LIMIT_EXCEEDED;
706 ret = lldb_parse_result(ac, result);
707 if (ret != LDB_SUCCESS) {
715 handle->state = LDB_ASYNC_DONE;
716 ret = LDB_ERR_OPERATIONS_ERROR;
723 static int lldb_start_trans(struct ldb_module *module)
725 /* TODO implement a local transaction mechanism here */
730 static int lldb_end_trans(struct ldb_module *module)
732 /* TODO implement a local transaction mechanism here */
737 static int lldb_del_trans(struct ldb_module *module)
739 /* TODO implement a local transaction mechanism here */
744 static int lldb_request(struct ldb_module *module, struct ldb_request *req)
746 return LDB_ERR_OPERATIONS_ERROR;
749 static const struct ldb_module_ops lldb_ops = {
751 .search = lldb_search,
753 .modify = lldb_modify,
755 .rename = lldb_rename,
756 .request = lldb_request,
757 .start_transaction = lldb_start_trans,
758 .end_transaction = lldb_end_trans,
759 .del_transaction = lldb_del_trans,
764 static int lldb_destructor(struct lldb_private *lldb)
766 ldap_unbind(lldb->ldap);
771 connect to the database
773 static int lldb_connect(struct ldb_context *ldb,
776 const char *options[],
777 struct ldb_module **_module)
779 struct ldb_module *module;
780 struct lldb_private *lldb;
784 module = talloc(ldb, struct ldb_module);
785 if (module == NULL) {
790 talloc_set_name_const(module, "ldb_ldap backend");
792 module->prev = module->next = NULL;
793 module->private_data = NULL;
794 module->ops = &lldb_ops;
796 lldb = talloc(module, struct lldb_private);
801 module->private_data = lldb;
802 lldb->module = module;
805 ret = ldap_initialize(&lldb->ldap, url);
806 if (ret != LDAP_SUCCESS) {
807 ldb_debug(ldb, LDB_DEBUG_FATAL, "ldap_initialize failed for URL '%s' - %s\n",
808 url, ldap_err2string(ret));
812 talloc_set_destructor(lldb, lldb_destructor);
814 ret = ldap_set_option(lldb->ldap, LDAP_OPT_PROTOCOL_VERSION, &version);
815 if (ret != LDAP_SUCCESS) {
816 ldb_debug(ldb, LDB_DEBUG_FATAL, "ldap_set_option failed - %s\n",
817 ldap_err2string(ret));
829 const struct ldb_backend_ops ldb_ldap_backend_ops = {
831 .connect_fn = lldb_connect
834 const struct ldb_backend_ops ldb_ldapi_backend_ops = {
836 .connect_fn = lldb_connect
839 const struct ldb_backend_ops ldb_ldaps_backend_ops = {
841 .connect_fn = lldb_connect