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 2 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
43 #include "ldb/include/includes.h"
45 #define LDAP_DEPRECATED 1
50 struct ldb_module *module;
54 struct lldb_private *lldb;
55 struct ldb_handle *handle;
60 int (*callback)(struct ldb_context *, void *, struct ldb_reply *);
63 static int lldb_ldap_to_ldb(int err) {
64 /* Ldap errors and ldb errors are defined to the same values */
68 static struct lldb_context *init_lldb_handle(struct lldb_private *lldb, struct ldb_request *req)
70 struct lldb_context *ac;
73 h = talloc_zero(req, struct ldb_handle);
75 ldb_set_errstring(lldb->module->ldb, "Out of Memory");
79 h->module = lldb->module;
81 ac = talloc(h, struct lldb_context);
83 ldb_set_errstring(lldb->module->ldb, "Out of Memory");
90 h->state = LDB_ASYNC_INIT;
91 h->status = LDB_SUCCESS;
95 ac->context = req->context;
96 ac->callback = req->callback;
97 ac->timeout = req->timeout;
98 ac->starttime = req->starttime;
105 convert a ldb_message structure to a list of LDAPMod structures
106 ready for ldap_add() or ldap_modify()
108 static LDAPMod **lldb_msg_to_mods(void *mem_ctx, const struct ldb_message *msg, int use_flags)
114 /* allocate maximum number of elements needed */
115 mods = talloc_array(mem_ctx, LDAPMod *, msg->num_elements+1);
122 for (i=0;i<msg->num_elements;i++) {
123 const struct ldb_message_element *el = &msg->elements[i];
125 mods[num_mods] = talloc(mods, LDAPMod);
126 if (!mods[num_mods]) {
129 mods[num_mods+1] = NULL;
130 mods[num_mods]->mod_op = LDAP_MOD_BVALUES;
132 switch (el->flags & LDB_FLAG_MOD_MASK) {
133 case LDB_FLAG_MOD_ADD:
134 mods[num_mods]->mod_op |= LDAP_MOD_ADD;
136 case LDB_FLAG_MOD_DELETE:
137 mods[num_mods]->mod_op |= LDAP_MOD_DELETE;
139 case LDB_FLAG_MOD_REPLACE:
140 mods[num_mods]->mod_op |= LDAP_MOD_REPLACE;
144 mods[num_mods]->mod_type = discard_const_p(char, el->name);
145 mods[num_mods]->mod_vals.modv_bvals = talloc_array(mods[num_mods],
148 if (!mods[num_mods]->mod_vals.modv_bvals) {
152 for (j=0;j<el->num_values;j++) {
153 mods[num_mods]->mod_vals.modv_bvals[j] = talloc(mods[num_mods]->mod_vals.modv_bvals,
155 if (!mods[num_mods]->mod_vals.modv_bvals[j]) {
158 mods[num_mods]->mod_vals.modv_bvals[j]->bv_val = el->values[j].data;
159 mods[num_mods]->mod_vals.modv_bvals[j]->bv_len = el->values[j].length;
161 mods[num_mods]->mod_vals.modv_bvals[j] = NULL;
173 add a single set of ldap message values to a ldb_message
175 static int lldb_add_msg_attr(struct ldb_context *ldb,
176 struct ldb_message *msg,
177 const char *attr, struct berval **bval)
180 struct ldb_message_element *el;
182 count = ldap_count_values_len(bval);
188 el = talloc_realloc(msg, msg->elements, struct ldb_message_element,
189 msg->num_elements + 1);
197 el = &msg->elements[msg->num_elements];
199 el->name = talloc_strdup(msg->elements, attr);
207 el->values = talloc_array(msg->elements, struct ldb_val, count);
213 for (i=0;i<count;i++) {
214 /* we have to ensure this is null terminated so that
215 ldb_msg_find_attr_as_string() can work */
216 el->values[i].data = talloc_size(el->values, bval[i]->bv_len+1);
217 if (!el->values[i].data) {
221 memcpy(el->values[i].data, bval[i]->bv_val, bval[i]->bv_len);
222 el->values[i].data[bval[i]->bv_len] = 0;
223 el->values[i].length = bval[i]->bv_len;
233 search for matching records
235 static int lldb_search(struct ldb_module *module, struct ldb_request *req)
237 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
238 struct lldb_context *lldb_ac;
245 if (!req->callback || !req->context) {
246 ldb_set_errstring(module->ldb, "Async interface called with NULL callback function or NULL context");
247 return LDB_ERR_OPERATIONS_ERROR;
250 if (req->op.search.tree == NULL) {
251 ldb_set_errstring(module->ldb, "Invalid expression parse tree");
252 return LDB_ERR_OPERATIONS_ERROR;
255 if (req->controls != NULL) {
256 ldb_debug(module->ldb, LDB_DEBUG_WARNING, "Controls are not yet supported by ldb_ldap backend!\n");
259 lldb_ac = init_lldb_handle(lldb, req);
260 if (lldb_ac == NULL) {
261 return LDB_ERR_OPERATIONS_ERROR;
264 search_base = ldb_dn_alloc_linearized(lldb_ac, req->op.search.base);
265 if (req->op.search.base == NULL) {
266 search_base = talloc_strdup(lldb_ac, "");
268 if (search_base == NULL) {
269 return LDB_ERR_OPERATIONS_ERROR;
272 expression = ldb_filter_from_tree(lldb_ac, req->op.search.tree);
273 if (expression == NULL) {
274 return LDB_ERR_OPERATIONS_ERROR;
277 switch (req->op.search.scope) {
279 ldap_scope = LDAP_SCOPE_BASE;
281 case LDB_SCOPE_ONELEVEL:
282 ldap_scope = LDAP_SCOPE_ONELEVEL;
285 ldap_scope = LDAP_SCOPE_SUBTREE;
289 tv.tv_sec = req->timeout;
292 ret = ldap_search_ext(lldb->ldap, search_base, ldap_scope,
294 discard_const_p(char *, req->op.search.attrs),
302 if (ret != LDAP_SUCCESS) {
303 ldb_set_errstring(module->ldb, ldap_err2string(ret));
306 return lldb_ldap_to_ldb(ret);
312 static int lldb_add(struct ldb_module *module, struct ldb_request *req)
314 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
315 struct lldb_context *lldb_ac;
320 /* ltdb specials should not reach this point */
321 if (ldb_dn_is_special(req->op.add.message->dn)) {
322 return LDB_ERR_INVALID_DN_SYNTAX;
325 lldb_ac = init_lldb_handle(lldb, req);
326 if (lldb_ac == NULL) {
327 return LDB_ERR_OPERATIONS_ERROR;
330 mods = lldb_msg_to_mods(lldb_ac, req->op.add.message, 0);
332 return LDB_ERR_OPERATIONS_ERROR;
335 dn = ldb_dn_alloc_linearized(lldb_ac, req->op.add.message->dn);
337 return LDB_ERR_OPERATIONS_ERROR;
340 ret = ldap_add_ext(lldb->ldap, dn, mods,
345 if (ret != LDAP_SUCCESS) {
346 ldb_set_errstring(module->ldb, ldap_err2string(ret));
349 return lldb_ldap_to_ldb(ret);
355 static int lldb_modify(struct ldb_module *module, struct ldb_request *req)
357 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
358 struct lldb_context *lldb_ac;
363 /* ltdb specials should not reach this point */
364 if (ldb_dn_is_special(req->op.mod.message->dn)) {
365 return LDB_ERR_INVALID_DN_SYNTAX;
368 lldb_ac = init_lldb_handle(lldb, req);
369 if (req->handle == NULL) {
370 return LDB_ERR_OPERATIONS_ERROR;
373 mods = lldb_msg_to_mods(lldb_ac, req->op.mod.message, 1);
375 return LDB_ERR_OPERATIONS_ERROR;
378 dn = ldb_dn_alloc_linearized(lldb_ac, req->op.mod.message->dn);
380 return LDB_ERR_OPERATIONS_ERROR;
383 ret = ldap_modify_ext(lldb->ldap, dn, mods,
388 if (ret != LDAP_SUCCESS) {
389 ldb_set_errstring(module->ldb, ldap_err2string(ret));
392 return lldb_ldap_to_ldb(ret);
398 static int lldb_delete(struct ldb_module *module, struct ldb_request *req)
400 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
401 struct lldb_context *lldb_ac;
405 /* ltdb specials should not reach this point */
406 if (ldb_dn_is_special(req->op.del.dn)) {
407 return LDB_ERR_INVALID_DN_SYNTAX;
410 lldb_ac = init_lldb_handle(lldb, req);
411 if (lldb_ac == NULL) {
412 return LDB_ERR_OPERATIONS_ERROR;
415 dnstr = ldb_dn_alloc_linearized(lldb_ac, req->op.del.dn);
417 ret = ldap_delete_ext(lldb->ldap, dnstr,
422 if (ret != LDAP_SUCCESS) {
423 ldb_set_errstring(module->ldb, ldap_err2string(ret));
426 return lldb_ldap_to_ldb(ret);
432 static int lldb_rename(struct ldb_module *module, struct ldb_request *req)
434 struct lldb_private *lldb = talloc_get_type(module->private_data, struct lldb_private);
435 struct lldb_context *lldb_ac;
441 /* ltdb specials should not reach this point */
442 if (ldb_dn_is_special(req->op.rename.olddn) || ldb_dn_is_special(req->op.rename.newdn)) {
443 return LDB_ERR_INVALID_DN_SYNTAX;
446 lldb_ac = init_lldb_handle(lldb, req);
447 if (lldb_ac == NULL) {
448 return LDB_ERR_OPERATIONS_ERROR;
451 old_dn = ldb_dn_alloc_linearized(lldb_ac, req->op.rename.olddn);
452 if (old_dn == NULL) {
453 return LDB_ERR_OPERATIONS_ERROR;
456 newrdn = talloc_asprintf(lldb_ac, "%s=%s",
457 ldb_dn_get_rdn_name(req->op.rename.newdn),
458 ldb_dn_escape_value(lldb, *(ldb_dn_get_rdn_val(req->op.rename.newdn))));
460 return LDB_ERR_OPERATIONS_ERROR;
463 parentdn = ldb_dn_alloc_linearized(lldb_ac, ldb_dn_get_parent(lldb_ac, req->op.rename.newdn));
465 return LDB_ERR_OPERATIONS_ERROR;
468 ret = ldap_rename(lldb->ldap, old_dn, newrdn, parentdn,
472 if (ret != LDAP_SUCCESS) {
473 ldb_set_errstring(module->ldb, ldap_err2string(ret));
476 return lldb_ldap_to_ldb(ret);
479 static int lldb_parse_result(struct lldb_context *ac, LDAPMessage *result)
481 struct ldb_handle *handle = ac->handle;
482 struct lldb_private *lldb = ac->lldb;
483 struct ldb_reply *ares = NULL;
486 char *matcheddnp = NULL;
487 char *errmsgp = NULL;
488 char **referralsp = NULL;
489 LDAPControl **serverctrlsp = NULL;
490 int ret = LDB_SUCCESS;
492 type = ldap_msgtype(result);
498 case LDAP_RES_SEARCH_ENTRY:
499 msg = ldap_first_entry(lldb->ldap, result);
501 BerElement *berptr = NULL;
504 ares = talloc_zero(ac, struct ldb_reply);
506 ret = LDB_ERR_OPERATIONS_ERROR;
510 ares->message = ldb_msg_new(ares);
511 if (!ares->message) {
512 ret = LDB_ERR_OPERATIONS_ERROR;
516 dn = ldap_get_dn(lldb->ldap, msg);
518 ret = LDB_ERR_OPERATIONS_ERROR;
521 ares->message->dn = ldb_dn_new(ares->message, ac->lldb->module->ldb, dn);
522 if ( ! ldb_dn_validate(ares->message->dn)) {
523 ret = LDB_ERR_OPERATIONS_ERROR;
528 ares->message->num_elements = 0;
529 ares->message->elements = NULL;
531 /* loop over all attributes */
532 for (attr=ldap_first_attribute(lldb->ldap, msg, &berptr);
534 attr=ldap_next_attribute(lldb->ldap, msg, berptr)) {
535 struct berval **bval;
536 bval = ldap_get_values_len(lldb->ldap, msg, attr);
539 lldb_add_msg_attr(ac->lldb->module->ldb, ares->message, attr, bval);
540 ldap_value_free_len(bval);
543 if (berptr) ber_free(berptr, 0);
546 ares->type = LDB_REPLY_ENTRY;
547 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
549 handle->status = LDB_ERR_PROTOCOL_ERROR;
550 handle->state = LDB_ASYNC_DONE;
554 case LDAP_RES_SEARCH_REFERENCE:
555 if (ldap_parse_result(lldb->ldap, result, &handle->status,
556 &matcheddnp, &errmsgp,
557 &referralsp, &serverctrlsp, 0) != LDAP_SUCCESS) {
558 ret = LDB_ERR_OPERATIONS_ERROR;
561 if (referralsp == NULL) {
562 handle->status = LDB_ERR_PROTOCOL_ERROR;
566 ares = talloc_zero(ac, struct ldb_reply);
568 ret = LDB_ERR_OPERATIONS_ERROR;
572 ares->referral = talloc_strdup(ares, *referralsp);
573 ares->type = LDB_REPLY_REFERRAL;
574 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
578 case LDAP_RES_SEARCH_RESULT:
579 if (ldap_parse_result(lldb->ldap, result, &handle->status,
580 &matcheddnp, &errmsgp,
581 &referralsp, &serverctrlsp, 0) != LDAP_SUCCESS) {
582 handle->status = LDB_ERR_OPERATIONS_ERROR;
586 ares = talloc_zero(ac, struct ldb_reply);
588 ret = LDB_ERR_OPERATIONS_ERROR;
592 if (serverctrlsp != NULL) {
593 /* FIXME: transform the LDAPControl list into an ldb_control one */
594 ares->controls = NULL;
597 ares->type = LDB_REPLY_DONE;
598 handle->state = LDB_ASYNC_DONE;
599 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
603 case LDAP_RES_MODIFY:
605 case LDAP_RES_DELETE:
607 if (ldap_parse_result(lldb->ldap, result, &handle->status,
608 &matcheddnp, &errmsgp,
609 &referralsp, &serverctrlsp, 0) != LDAP_SUCCESS) {
610 handle->status = LDB_ERR_OPERATIONS_ERROR;
613 if (ac->callback && handle->status == LDB_SUCCESS) {
614 ares = NULL; /* FIXME: build a corresponding ares to pass on */
615 ret = ac->callback(ac->lldb->module->ldb, ac->context, ares);
617 handle->state = LDB_ASYNC_DONE;
621 ret = LDB_ERR_PROTOCOL_ERROR;
625 if (matcheddnp) ldap_memfree(matcheddnp);
626 if (errmsgp && *errmsgp) {
627 ldb_set_errstring(ac->lldb->module->ldb, errmsgp);
628 } else if (handle->status) {
629 ldb_set_errstring(ac->lldb->module->ldb, ldap_err2string(handle->status));
632 ldap_memfree(errmsgp);
634 if (referralsp) ldap_value_free(referralsp);
635 if (serverctrlsp) ldap_controls_free(serverctrlsp);
637 ldap_msgfree(result);
638 return lldb_ldap_to_ldb(handle->status);
641 handle->state = LDB_ASYNC_DONE;
642 ldap_msgfree(result);
646 static int lldb_wait(struct ldb_handle *handle, enum ldb_wait_type type)
648 struct lldb_context *ac = talloc_get_type(handle->private_data, struct lldb_context);
649 struct lldb_private *lldb = ac->lldb;
650 struct timeval timeout;
654 if (handle->state == LDB_ASYNC_DONE) {
655 return handle->status;
658 if (!ac || !ac->msgid) {
659 return LDB_ERR_OPERATIONS_ERROR;
662 handle->state = LDB_ASYNC_PENDING;
663 handle->status = LDB_SUCCESS;
668 if ((ac->timeout != -1) &&
669 ((ac->starttime + ac->timeout) > time(NULL))) {
670 return LDB_ERR_TIME_LIMIT_EXCEEDED;
676 lret = ldap_result(lldb->ldap, ac->msgid, 0, &timeout, &result);
678 return LDB_ERR_OPERATIONS_ERROR;
685 return lldb_parse_result(ac, result);
689 ret = LDB_ERR_OPERATIONS_ERROR;
691 while (handle->status == LDB_SUCCESS && handle->state != LDB_ASYNC_DONE) {
693 if (ac->timeout == -1) {
694 lret = ldap_result(lldb->ldap, ac->msgid, 0, NULL, &result);
696 timeout.tv_sec = ac->timeout - (time(NULL) - ac->starttime);
697 if (timeout.tv_sec <= 0)
698 return LDB_ERR_TIME_LIMIT_EXCEEDED;
699 lret = ldap_result(lldb->ldap, ac->msgid, 0, &timeout, &result);
702 return LDB_ERR_OPERATIONS_ERROR;
705 return LDB_ERR_TIME_LIMIT_EXCEEDED;
708 ret = lldb_parse_result(ac, result);
709 if (ret != LDB_SUCCESS) {
717 handle->state = LDB_ASYNC_DONE;
718 ret = LDB_ERR_OPERATIONS_ERROR;
725 static int lldb_start_trans(struct ldb_module *module)
727 /* TODO implement a local transaction mechanism here */
732 static int lldb_end_trans(struct ldb_module *module)
734 /* TODO implement a local transaction mechanism here */
739 static int lldb_del_trans(struct ldb_module *module)
741 /* TODO implement a local transaction mechanism here */
746 static int lldb_request(struct ldb_module *module, struct ldb_request *req)
748 return LDB_ERR_OPERATIONS_ERROR;
751 static const struct ldb_module_ops lldb_ops = {
753 .search = lldb_search,
755 .modify = lldb_modify,
757 .rename = lldb_rename,
758 .request = lldb_request,
759 .start_transaction = lldb_start_trans,
760 .end_transaction = lldb_end_trans,
761 .del_transaction = lldb_del_trans,
766 static int lldb_destructor(struct lldb_private *lldb)
768 ldap_unbind(lldb->ldap);
773 connect to the database
775 static int lldb_connect(struct ldb_context *ldb,
778 const char *options[],
779 struct ldb_module **_module)
781 struct ldb_module *module;
782 struct lldb_private *lldb;
786 module = talloc(ldb, struct ldb_module);
787 if (module == NULL) {
792 talloc_set_name_const(module, "ldb_ldap backend");
794 module->prev = module->next = NULL;
795 module->private_data = NULL;
796 module->ops = &lldb_ops;
798 lldb = talloc(module, struct lldb_private);
803 module->private_data = lldb;
804 lldb->module = module;
807 ret = ldap_initialize(&lldb->ldap, url);
808 if (ret != LDAP_SUCCESS) {
809 ldb_debug(ldb, LDB_DEBUG_FATAL, "ldap_initialize failed for URL '%s' - %s\n",
810 url, ldap_err2string(ret));
814 talloc_set_destructor(lldb, lldb_destructor);
816 ret = ldap_set_option(lldb->ldap, LDAP_OPT_PROTOCOL_VERSION, &version);
817 if (ret != LDAP_SUCCESS) {
818 ldb_debug(ldb, LDB_DEBUG_FATAL, "ldap_set_option failed - %s\n",
819 ldap_err2string(ret));
831 int ldb_ldap_init(void)
833 return ldb_register_backend("ldap", lldb_connect) +
834 ldb_register_backend("ldapi", lldb_connect) +
835 ldb_register_backend("ldaps", lldb_connect);