2 Unix SMB/CIFS implementation.
4 Copyright (C) 2004-2007, Jelmer Vernooij, jelmer@samba.org
5 Copyright (C) 2008 Matthias Dieter Wallnöfer, mwallnoefer@yahoo.de
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "lib/ldb/include/ldb.h"
24 #include "lib/ldb/include/ldb_errors.h"
26 #include "librpc/gen_ndr/winreg.h"
27 #include "param/param.h"
29 static struct hive_operations reg_backend_ldb;
34 struct ldb_context *ldb;
36 struct ldb_message **subkeys, **values;
37 int subkey_count, value_count;
40 static void reg_ldb_unpack_value(TALLOC_CTX *mem_ctx,
41 struct smb_iconv_convenience *iconv_convenience,
42 struct ldb_message *msg,
43 const char **name, uint32_t *type,
46 const struct ldb_val *val;
50 *name = talloc_strdup(mem_ctx,
51 ldb_msg_find_attr_as_string(msg, "value",
54 value_type = ldb_msg_find_attr_as_uint(msg, "type", 0);
57 val = ldb_msg_find_ldb_val(msg, "data");
64 data->length = convert_string_talloc(mem_ctx, iconv_convenience, CH_UTF8, CH_UTF16,
65 val->data, val->length,
66 (void **)&data->data);
75 *data = data_blob_talloc(mem_ctx, val->data, val->length);
83 uint32_t tmp = strtoul((char *)val->data, NULL, 0);
84 *data = data_blob_talloc(mem_ctx, &tmp, 4);
89 *data = data_blob_talloc(mem_ctx, val->data, val->length);
94 static struct ldb_message *reg_ldb_pack_value(struct ldb_context *ctx,
97 uint32_t type, DATA_BLOB data)
100 struct ldb_message *msg = talloc_zero(mem_ctx, struct ldb_message);
103 ldb_msg_add_string(msg, "value", talloc_strdup(mem_ctx, name));
108 if (data.data[0] != '\0') {
109 val.length = convert_string_talloc(mem_ctx, lp_iconv_convenience(global_loadparm), CH_UTF16, CH_UTF8,
113 ldb_msg_add_value(msg, "data", &val, NULL);
115 ldb_msg_add_empty(msg, "data", LDB_FLAG_MOD_DELETE, NULL);
121 ldb_msg_add_value(msg, "data", &data, NULL);
123 ldb_msg_add_empty(msg, "data", LDB_FLAG_MOD_DELETE, NULL);
127 ldb_msg_add_string(msg, "data",
128 talloc_asprintf(mem_ctx, "0x%x",
129 IVAL(data.data, 0)));
132 ldb_msg_add_value(msg, "data", &data, NULL);
136 type_s = talloc_asprintf(mem_ctx, "%u", type);
137 ldb_msg_add_string(msg, "type", type_s);
142 static char *reg_ldb_escape(TALLOC_CTX *mem_ctx, const char *value)
146 val.data = discard_const_p(uint8_t, value);
147 val.length = strlen(value);
149 return ldb_dn_escape_value(mem_ctx, val);
152 static int reg_close_ldb_key(struct ldb_key_data *key)
154 if (key->subkeys != NULL) {
155 talloc_free(key->subkeys);
159 if (key->values != NULL) {
160 talloc_free(key->values);
166 static struct ldb_dn *reg_path_to_ldb(TALLOC_CTX *mem_ctx,
167 const struct hive_key *from,
168 const char *path, const char *add)
170 TALLOC_CTX *local_ctx;
172 char *mypath = talloc_strdup(mem_ctx, path);
174 struct ldb_key_data *kd = talloc_get_type(from, struct ldb_key_data);
175 struct ldb_context *ldb = kd->ldb;
177 local_ctx = talloc_new(mem_ctx);
180 ret = ldb_dn_new(mem_ctx, ldb, add);
182 ret = ldb_dn_new(mem_ctx, ldb, NULL);
184 if (!ldb_dn_validate(ret)) {
186 talloc_free(local_ctx);
193 begin = strrchr(mypath, '\\');
195 if (begin) keyname = begin + 1;
196 else keyname = mypath;
198 if(strlen(keyname)) {
199 if (!ldb_dn_add_base_fmt(ret, "key=%s",
200 reg_ldb_escape(local_ctx,
203 talloc_free(local_ctx);
215 ldb_dn_add_base(ret, kd->dn);
217 talloc_free(local_ctx);
222 static WERROR cache_subkeys(struct ldb_key_data *kd)
224 struct ldb_context *c = kd->ldb;
225 struct ldb_result *res;
228 ret = ldb_search(c, c, &res, kd->dn, LDB_SCOPE_ONELEVEL, NULL, "(key=*)");
230 if (ret != LDB_SUCCESS) {
231 DEBUG(0, ("Error getting subkeys for '%s': %s\n",
232 ldb_dn_get_linearized(kd->dn), ldb_errstring(c)));
236 kd->subkey_count = res->count;
237 kd->subkeys = talloc_steal(kd, res->msgs);
243 static WERROR cache_values(struct ldb_key_data *kd)
245 struct ldb_context *c = kd->ldb;
246 struct ldb_result *res;
249 ret = ldb_search(c, c, &res, kd->dn, LDB_SCOPE_ONELEVEL,
252 if (ret != LDB_SUCCESS) {
253 DEBUG(0, ("Error getting values for '%s': %s\n",
254 ldb_dn_get_linearized(kd->dn), ldb_errstring(c)));
258 kd->value_count = res->count;
259 kd->values = talloc_steal(kd, res->msgs);
266 static WERROR ldb_get_subkey_by_id(TALLOC_CTX *mem_ctx,
267 const struct hive_key *k, uint32_t idx,
269 const char **classname,
270 NTTIME *last_mod_time)
272 struct ldb_message_element *el;
273 struct ldb_key_data *kd = talloc_get_type(k, struct ldb_key_data);
278 if (classname != NULL)
279 *classname = NULL; /* TODO: Store properly */
280 if (last_mod_time != NULL)
281 *last_mod_time = 0; /* TODO: we need to add this to the
282 ldb backend properly */
284 /* Do a search if necessary */
285 if (kd->subkeys == NULL) {
286 W_ERROR_NOT_OK_RETURN(cache_subkeys(kd));
289 if (idx >= kd->subkey_count)
290 return WERR_NO_MORE_ITEMS;
292 el = ldb_msg_find_element(kd->subkeys[idx], "key");
293 SMB_ASSERT(el != NULL);
294 SMB_ASSERT(el->num_values != 0);
297 *name = talloc_strdup(mem_ctx, (char *)el->values[0].data);
302 static WERROR ldb_get_default_value(TALLOC_CTX *mem_ctx, struct hive_key *k,
303 const char **name, uint32_t *data_type,
306 struct ldb_key_data *kd = talloc_get_type(k, struct ldb_key_data);
307 struct ldb_context *c = kd->ldb;
308 const char* attrs[] = { "data", "type", NULL };
309 struct ldb_result *res;
312 ret = ldb_search(c, mem_ctx, &res, kd->dn, LDB_SCOPE_BASE, attrs, "%s", "");
314 if (ret != LDB_SUCCESS) {
315 DEBUG(0, ("Error getting default value for '%s': %s\n",
316 ldb_dn_get_linearized(kd->dn), ldb_errstring(c)));
320 if (res->count == 0 || res->msgs[0]->num_elements == 0)
323 reg_ldb_unpack_value(mem_ctx, lp_iconv_convenience(global_loadparm),
324 res->msgs[0], name, data_type, data);
331 static WERROR ldb_get_value_by_id(TALLOC_CTX *mem_ctx, struct hive_key *k,
332 int idx, const char **name,
333 uint32_t *data_type, DATA_BLOB *data)
335 struct ldb_key_data *kd = talloc_get_type(k, struct ldb_key_data);
337 /* if default value exists, give it back */
338 if (W_ERROR_IS_OK(ldb_get_default_value(mem_ctx, k, name, data_type,
346 /* Do the search if necessary */
347 if (kd->values == NULL) {
348 W_ERROR_NOT_OK_RETURN(cache_values(kd));
351 if (idx >= kd->value_count)
352 return WERR_NO_MORE_ITEMS;
354 reg_ldb_unpack_value(mem_ctx, lp_iconv_convenience(global_loadparm),
355 kd->values[idx], name, data_type, data);
360 static WERROR ldb_get_value(TALLOC_CTX *mem_ctx, struct hive_key *k,
361 const char *name, uint32_t *data_type,
364 struct ldb_key_data *kd = talloc_get_type(k, struct ldb_key_data);
365 struct ldb_context *c = kd->ldb;
366 struct ldb_result *res;
370 if (strlen(name) == 0) {
372 return ldb_get_default_value(mem_ctx, k, NULL, data_type, data);
375 query = talloc_asprintf(mem_ctx, "(value=%s)", name);
376 ret = ldb_search(c, mem_ctx, &res, kd->dn, LDB_SCOPE_ONELEVEL, NULL, "%s", query);
379 if (ret != LDB_SUCCESS) {
380 DEBUG(0, ("Error getting values for '%s': %s\n",
381 ldb_dn_get_linearized(kd->dn), ldb_errstring(c)));
388 reg_ldb_unpack_value(mem_ctx, lp_iconv_convenience(global_loadparm),
389 res->msgs[0], NULL, data_type, data);
397 static WERROR ldb_open_key(TALLOC_CTX *mem_ctx, const struct hive_key *h,
398 const char *name, struct hive_key **key)
400 struct ldb_result *res;
401 struct ldb_dn *ldap_path;
403 struct ldb_key_data *newkd;
404 struct ldb_key_data *kd = talloc_get_type(h, struct ldb_key_data);
405 struct ldb_context *c = kd->ldb;
407 ldap_path = reg_path_to_ldb(mem_ctx, h, name, NULL);
409 ret = ldb_search(c, mem_ctx, &res, ldap_path, LDB_SCOPE_BASE, NULL, "(key=*)");
411 if (ret != LDB_SUCCESS) {
412 DEBUG(3, ("Error opening key '%s': %s\n",
413 ldb_dn_get_linearized(ldap_path), ldb_errstring(c)));
415 } else if (res->count == 0) {
416 DEBUG(3, ("Key '%s' not found\n",
417 ldb_dn_get_linearized(ldap_path)));
422 newkd = talloc_zero(mem_ctx, struct ldb_key_data);
423 newkd->key.ops = ®_backend_ldb;
424 newkd->ldb = talloc_reference(newkd, kd->ldb);
425 newkd->dn = ldb_dn_copy(mem_ctx, res->msgs[0]->dn);
427 *key = (struct hive_key *)newkd;
432 WERROR reg_open_ldb_file(TALLOC_CTX *parent_ctx, const char *location,
433 struct auth_session_info *session_info,
434 struct cli_credentials *credentials,
435 struct event_context *ev_ctx,
436 struct loadparm_context *lp_ctx,
439 struct ldb_key_data *kd;
440 struct ldb_context *wrap;
441 struct ldb_message *attrs_msg;
443 if (location == NULL)
444 return WERR_INVALID_PARAM;
446 wrap = ldb_wrap_connect(parent_ctx, ev_ctx, lp_ctx,
447 location, session_info, credentials, 0, NULL);
450 DEBUG(1, (__FILE__": unable to connect\n"));
454 attrs_msg = ldb_msg_new(wrap);
455 W_ERROR_HAVE_NO_MEMORY(attrs_msg);
456 attrs_msg->dn = ldb_dn_new(attrs_msg, wrap, "@ATTRIBUTES");
457 W_ERROR_HAVE_NO_MEMORY(attrs_msg->dn);
458 ldb_msg_add_string(attrs_msg, "key", "CASE_INSENSITIVE");
459 ldb_msg_add_string(attrs_msg, "value", "CASE_INSENSITIVE");
461 ldb_add(wrap, attrs_msg);
463 ldb_set_debug_stderr(wrap);
465 kd = talloc_zero(parent_ctx, struct ldb_key_data);
466 kd->key.ops = ®_backend_ldb;
467 kd->ldb = talloc_reference(kd, wrap);
468 talloc_set_destructor (kd, reg_close_ldb_key);
469 kd->dn = ldb_dn_new(kd, wrap, "hive=NONE");
471 *k = (struct hive_key *)kd;
476 static WERROR ldb_add_key(TALLOC_CTX *mem_ctx, const struct hive_key *parent,
477 const char *name, const char *classname,
478 struct security_descriptor *sd,
479 struct hive_key **newkey)
481 struct ldb_key_data *parentkd = discard_const_p(struct ldb_key_data, parent);
482 struct ldb_message *msg;
483 struct ldb_key_data *newkd;
486 msg = ldb_msg_new(mem_ctx);
488 msg->dn = reg_path_to_ldb(msg, parent, name, NULL);
490 ldb_msg_add_string(msg, "key", talloc_strdup(mem_ctx, name));
491 if (classname != NULL)
492 ldb_msg_add_string(msg, "classname",
493 talloc_strdup(mem_ctx, classname));
495 ret = ldb_add(parentkd->ldb, msg);
496 if (ret == LDB_ERR_ENTRY_ALREADY_EXISTS) {
497 return WERR_ALREADY_EXISTS;
500 if (ret != LDB_SUCCESS) {
501 DEBUG(1, ("ldb_add: %s\n", ldb_errstring(parentkd->ldb)));
505 DEBUG(2, ("key added: %s\n", ldb_dn_get_linearized(msg->dn)));
507 newkd = talloc_zero(mem_ctx, struct ldb_key_data);
508 newkd->ldb = talloc_reference(newkd, parentkd->ldb);
509 newkd->key.ops = ®_backend_ldb;
510 newkd->dn = talloc_steal(newkd, msg->dn);
512 *newkey = (struct hive_key *)newkd;
515 talloc_free(parentkd->subkeys);
516 parentkd->subkeys = NULL;
521 static WERROR ldb_del_value (struct hive_key *key, const char *child)
524 struct ldb_key_data *kd = talloc_get_type(key, struct ldb_key_data);
526 struct ldb_message *msg;
527 struct ldb_dn *childdn;
529 if (strlen(child) == 0) {
531 mem_ctx = talloc_init("ldb_del_value");
533 msg = talloc_zero(mem_ctx, struct ldb_message);
534 msg->dn = ldb_dn_copy(msg, kd->dn);
535 ldb_msg_add_empty(msg, "data", LDB_FLAG_MOD_DELETE, NULL);
536 ldb_msg_add_empty(msg, "type", LDB_FLAG_MOD_DELETE, NULL);
538 ret = ldb_modify(kd->ldb, msg);
539 if (ret != LDB_SUCCESS) {
540 DEBUG(1, ("ldb_del_value: %s\n", ldb_errstring(kd->ldb)));
541 talloc_free(mem_ctx);
545 talloc_free(mem_ctx);
548 childdn = ldb_dn_copy(kd->ldb, kd->dn);
549 if (!ldb_dn_add_child_fmt(childdn, "value=%s",
550 reg_ldb_escape(childdn, child)))
552 talloc_free(childdn);
556 ret = ldb_delete(kd->ldb, childdn);
558 talloc_free(childdn);
560 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
562 } else if (ret != LDB_SUCCESS) {
563 DEBUG(1, ("ldb_del_value: %s\n", ldb_errstring(kd->ldb)));
569 talloc_free(kd->values);
575 static WERROR ldb_del_key(const struct hive_key *key, const char *name)
578 struct ldb_key_data *parentkd = talloc_get_type(key, struct ldb_key_data);
579 struct ldb_dn *ldap_path;
580 TALLOC_CTX *mem_ctx = talloc_init("ldb_del_key");
581 struct ldb_context *c = parentkd->ldb;
582 struct ldb_result *res_keys;
583 struct ldb_result *res_vals;
587 /* Verify key exists by opening it */
588 werr = ldb_open_key(mem_ctx, key, name, &hk);
589 if (!W_ERROR_IS_OK(werr)) {
590 talloc_free(mem_ctx);
594 ldap_path = reg_path_to_ldb(mem_ctx, key, name, NULL);
596 talloc_free(mem_ctx);
600 /* Search for subkeys */
601 ret = ldb_search(c, mem_ctx, &res_keys, ldap_path, LDB_SCOPE_ONELEVEL,
604 if (ret != LDB_SUCCESS) {
605 DEBUG(0, ("Error getting subkeys for '%s': %s\n",
606 ldb_dn_get_linearized(ldap_path), ldb_errstring(c)));
607 talloc_free(mem_ctx);
611 /* Search for values */
612 ret = ldb_search(c, mem_ctx, &res_vals, ldap_path, LDB_SCOPE_ONELEVEL,
615 if (ret != LDB_SUCCESS) {
616 DEBUG(0, ("Error getting values for '%s': %s\n",
617 ldb_dn_get_linearized(ldap_path), ldb_errstring(c)));
618 talloc_free(mem_ctx);
622 /* Start an explicit transaction */
623 ret = ldb_transaction_start(c);
625 if (ret != LDB_SUCCESS) {
626 DEBUG(0, ("ldb_transaction_start: %s\n", ldb_errstring(c)));
627 talloc_free(mem_ctx);
631 if (res_keys->count || res_vals->count)
633 /* Delete any subkeys */
634 for (i = 0; i < res_keys->count; i++)
636 werr = ldb_del_key(hk, ldb_msg_find_attr_as_string(
639 if (!W_ERROR_IS_OK(werr)) {
640 ret = ldb_transaction_cancel(c);
641 talloc_free(mem_ctx);
646 /* Delete any values */
647 for (i = 0; i < res_vals->count; i++)
649 werr = ldb_del_value(hk, ldb_msg_find_attr_as_string(
652 if (!W_ERROR_IS_OK(werr)) {
653 ret = ldb_transaction_cancel(c);
654 talloc_free(mem_ctx);
660 /* Delete the key itself */
661 ret = ldb_delete(c, ldap_path);
663 if (ret != LDB_SUCCESS)
665 DEBUG(1, ("ldb_del_key: %s\n", ldb_errstring(c)));
666 ret = ldb_transaction_cancel(c);
667 talloc_free(mem_ctx);
671 /* Commit the transaction */
672 ret = ldb_transaction_commit(c);
674 if (ret != LDB_SUCCESS)
676 DEBUG(0, ("ldb_transaction_commit: %s\n", ldb_errstring(c)));
677 ret = ldb_transaction_cancel(c);
678 talloc_free(mem_ctx);
682 talloc_free(mem_ctx);
685 talloc_free(parentkd->subkeys);
686 parentkd->subkeys = NULL;
691 static WERROR ldb_set_value(struct hive_key *parent,
692 const char *name, uint32_t type,
693 const DATA_BLOB data)
695 struct ldb_message *msg;
696 struct ldb_key_data *kd = talloc_get_type(parent, struct ldb_key_data);
698 TALLOC_CTX *mem_ctx = talloc_init("ldb_set_value");
700 msg = reg_ldb_pack_value(kd->ldb, mem_ctx, name, type, data);
701 msg->dn = ldb_dn_copy(msg, kd->dn);
703 if (strlen(name) > 0) {
704 /* For a default value, we add/overwrite the attributes to/of the hive.
705 For a normal value, we create new childs. */
706 if (!ldb_dn_add_child_fmt(msg->dn, "value=%s",
707 reg_ldb_escape(mem_ctx, name)))
709 talloc_free(mem_ctx);
714 ret = ldb_add(kd->ldb, msg);
715 if (ret == LDB_ERR_ENTRY_ALREADY_EXISTS) {
717 for (i = 0; i < msg->num_elements; i++) {
718 if (msg->elements[i].flags != LDB_FLAG_MOD_DELETE)
719 msg->elements[i].flags = LDB_FLAG_MOD_REPLACE;
721 ret = ldb_modify(kd->ldb, msg);
724 if (ret != LDB_SUCCESS) {
725 DEBUG(1, ("ldb_set_value: %s\n", ldb_errstring(kd->ldb)));
726 talloc_free(mem_ctx);
731 talloc_free(kd->values);
734 talloc_free(mem_ctx);
738 static WERROR ldb_get_key_info(TALLOC_CTX *mem_ctx,
739 const struct hive_key *key,
740 const char **classname,
741 uint32_t *num_subkeys,
742 uint32_t *num_values,
743 NTTIME *last_change_time,
744 uint32_t *max_subkeynamelen,
745 uint32_t *max_valnamelen,
746 uint32_t *max_valbufsize)
748 struct ldb_key_data *kd = talloc_get_type(key, struct ldb_key_data);
751 if (classname != NULL)
753 if (num_subkeys != NULL)
755 if (num_values != NULL)
757 if (last_change_time != NULL)
758 *last_change_time = 0;
759 if (max_subkeynamelen != NULL)
760 *max_subkeynamelen = 0;
761 if (max_valnamelen != NULL)
763 if (max_valbufsize != NULL)
766 if (kd->subkeys == NULL) {
767 W_ERROR_NOT_OK_RETURN(cache_subkeys(kd));
770 if (kd->values == NULL) {
771 W_ERROR_NOT_OK_RETURN(cache_values(kd));
774 if (num_subkeys != NULL) {
775 *num_subkeys = kd->subkey_count;
777 if (num_values != NULL) {
778 *num_values = kd->value_count;
782 if (max_subkeynamelen != NULL) {
784 struct ldb_message_element *el;
786 *max_subkeynamelen = 0;
788 for (i = 0; i < kd->subkey_count; i++) {
789 el = ldb_msg_find_element(kd->subkeys[i], "key");
790 *max_subkeynamelen = MAX(*max_subkeynamelen, el->values[0].length);
794 if (max_valnamelen != NULL || max_valbufsize != NULL) {
796 struct ldb_message_element *el;
797 W_ERROR_NOT_OK_RETURN(cache_values(kd));
799 if (max_valbufsize != NULL)
802 if (max_valnamelen != NULL)
805 for (i = 0; i < kd->value_count; i++) {
806 if (max_valnamelen != NULL) {
807 el = ldb_msg_find_element(kd->values[i], "value");
808 *max_valnamelen = MAX(*max_valnamelen, el->values[0].length);
811 if (max_valbufsize != NULL) {
814 reg_ldb_unpack_value(mem_ctx,
815 lp_iconv_convenience(global_loadparm),
818 *max_valbufsize = MAX(*max_valbufsize, data.length);
819 talloc_free(data.data);
827 static struct hive_operations reg_backend_ldb = {
829 .add_key = ldb_add_key,
830 .del_key = ldb_del_key,
831 .get_key_by_name = ldb_open_key,
832 .enum_value = ldb_get_value_by_id,
833 .enum_key = ldb_get_subkey_by_id,
834 .set_value = ldb_set_value,
835 .get_value_by_name = ldb_get_value,
836 .delete_value = ldb_del_value,
837 .get_key_info = ldb_get_key_info,