2 * Unix SMB/CIFS implementation.
3 * Virtual Windows Registry Layer
4 * Copyright (C) Gerald Carter 2002-2005
5 * Copyright (C) Michael Adam 2007-2009
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/>.
21 /* Implementation of internal registry database functions. */
27 #include "reg_util_internal.h"
28 #include "reg_backend_db.h"
29 #include "reg_objects.h"
32 #define DBGC_CLASS DBGC_REGISTRY
34 static struct db_context *regdb = NULL;
35 static int regdb_refcount;
37 static bool regdb_key_exists(struct db_context *db, const char *key);
38 static bool regdb_key_is_base_key(const char *key);
39 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
40 struct regsubkey_ctr *ctr);
41 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
42 struct regsubkey_ctr *ctr);
43 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
44 struct regval_ctr *values);
45 static bool regdb_store_values_internal(struct db_context *db, const char *key,
46 struct regval_ctr *values);
48 /* List the deepest path into the registry. All part components will be created.*/
50 /* If you want to have a part of the path controlled by the tdb and part by
51 a virtual registry db (e.g. printing), then you have to list the deepest path.
52 For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
53 allows the reg_db backend to handle everything up to
54 "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
55 the reg_printing backend onto the last component of the path (see
56 KEY_PRINTING_2K in include/rpc_reg.h) --jerry */
58 static const char *builtin_registry_paths[] = {
68 KEY_SAMBA_GROUP_POLICY,
69 KEY_GP_MACHINE_POLICY,
70 KEY_GP_MACHINE_WIN_POLICY,
73 KEY_GP_USER_WIN_POLICY,
74 "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Winlogon\\GPExtensions",
75 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
77 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
86 struct builtin_regkey_value {
88 const char *valuename;
96 static struct builtin_regkey_value builtin_registry_values[] = {
98 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
100 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
102 "DisplayName", REG_SZ, { "Event Log" } },
104 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
105 { NULL, NULL, 0, { NULL } }
109 * Initialize a key in the registry:
110 * create each component key of the specified path.
112 static WERROR init_registry_key_internal(struct db_context *db,
113 const char *add_path)
116 TALLOC_CTX *frame = talloc_stackframe();
119 char *remaining = NULL;
122 struct regsubkey_ctr *subkeys;
125 DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path));
127 path = talloc_strdup(frame, add_path);
128 base = talloc_strdup(frame, "");
129 if (!path || !base) {
135 while (next_token_talloc(frame, &p, &keyname, "\\")) {
137 /* build up the registry path from the components */
140 base = talloc_asprintf(frame, "%s\\", base);
146 base = talloc_asprintf_append(base, "%s", keyname);
152 /* get the immediate subkeyname (if we have one ) */
154 subkeyname = talloc_strdup(frame, "");
160 remaining = talloc_strdup(frame, p);
167 if (!next_token_talloc(frame, &p2,
170 subkeyname = talloc_strdup(frame,p2);
178 DEBUG(10,("init_registry_key: Storing key [%s] with "
179 "subkey [%s]\n", base,
180 *subkeyname ? subkeyname : "NULL"));
182 /* we don't really care if the lookup succeeds or not
183 * since we are about to update the record.
184 * We just want any subkeys already present */
186 werr = regsubkey_ctr_init(frame, &subkeys);
187 if (!W_ERROR_IS_OK(werr)) {
188 DEBUG(0,("talloc() failure!\n"));
192 werr = regdb_fetch_keys_internal(db, base, subkeys);
193 if (!W_ERROR_IS_OK(werr) &&
194 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
200 werr = regsubkey_ctr_addkey(subkeys, subkeyname);
201 if (!W_ERROR_IS_OK(werr)) {
205 if (!regdb_store_keys_internal(db, base, subkeys)) {
206 werr = WERR_CAN_NOT_COMPLETE;
218 struct init_registry_key_context {
219 const char *add_path;
222 static NTSTATUS init_registry_key_action(struct db_context *db,
225 struct init_registry_key_context *init_ctx =
226 (struct init_registry_key_context *)private_data;
228 return werror_to_ntstatus(init_registry_key_internal(
229 db, init_ctx->add_path));
233 * Initialize a key in the registry:
234 * create each component key of the specified path,
235 * wrapped in one db transaction.
237 WERROR init_registry_key(const char *add_path)
239 struct init_registry_key_context init_ctx;
241 if (regdb_key_exists(regdb, add_path)) {
245 init_ctx.add_path = add_path;
247 return ntstatus_to_werror(dbwrap_trans_do(regdb,
248 init_registry_key_action,
252 /***********************************************************************
253 Open the registry data in the tdb
254 ***********************************************************************/
256 static void regdb_ctr_add_value(struct regval_ctr *ctr,
257 struct builtin_regkey_value *value)
259 switch(value->type) {
261 regval_ctr_addvalue(ctr, value->valuename, REG_DWORD,
262 (uint8_t *)&value->data.dw_value,
267 regval_ctr_addvalue_sz(ctr, value->valuename,
272 DEBUG(0, ("regdb_ctr_add_value: invalid value type in "
273 "registry values [%d]\n", value->type));
277 static NTSTATUS init_registry_data_action(struct db_context *db,
281 TALLOC_CTX *frame = talloc_stackframe();
282 struct regval_ctr *values;
285 /* loop over all of the predefined paths and add each component */
287 for (i=0; builtin_registry_paths[i] != NULL; i++) {
288 if (regdb_key_exists(db, builtin_registry_paths[i])) {
291 status = werror_to_ntstatus(init_registry_key_internal(db,
292 builtin_registry_paths[i]));
293 if (!NT_STATUS_IS_OK(status)) {
298 /* loop over all of the predefined values and add each component */
300 for (i=0; builtin_registry_values[i].path != NULL; i++) {
303 werr = regval_ctr_init(frame, &values);
304 if (!W_ERROR_IS_OK(werr)) {
305 status = werror_to_ntstatus(werr);
309 regdb_fetch_values_internal(db,
310 builtin_registry_values[i].path,
313 /* preserve existing values across restarts. Only add new ones */
315 if (!regval_ctr_key_exists(values,
316 builtin_registry_values[i].valuename))
318 regdb_ctr_add_value(values,
319 &builtin_registry_values[i]);
320 regdb_store_values_internal(db,
321 builtin_registry_values[i].path,
327 status = NT_STATUS_OK;
335 WERROR init_registry_data(void)
338 TALLOC_CTX *frame = talloc_stackframe();
339 struct regval_ctr *values;
343 * First, check for the existence of the needed keys and values.
344 * If all do already exist, we can save the writes.
346 for (i=0; builtin_registry_paths[i] != NULL; i++) {
347 if (!regdb_key_exists(regdb, builtin_registry_paths[i])) {
352 for (i=0; builtin_registry_values[i].path != NULL; i++) {
353 werr = regval_ctr_init(frame, &values);
354 W_ERROR_NOT_OK_GOTO_DONE(werr);
356 regdb_fetch_values_internal(regdb,
357 builtin_registry_values[i].path,
359 if (!regval_ctr_key_exists(values,
360 builtin_registry_values[i].valuename))
375 * There are potentially quite a few store operations which are all
376 * indiviually wrapped in tdb transactions. Wrapping them in a single
377 * transaction gives just a single transaction_commit() to actually do
378 * its fsync()s. See tdb/common/transaction.c for info about nested
379 * transaction behaviour.
382 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
383 init_registry_data_action,
391 static int regdb_normalize_keynames_fn(struct db_record *rec,
394 TALLOC_CTX *mem_ctx = talloc_tos();
398 if (rec->key.dptr == NULL || rec->key.dsize == 0) {
402 keyname = strchr((const char *) rec->key.dptr, '/');
404 struct db_record new_rec;
406 keyname = talloc_string_sub(mem_ctx,
407 (const char *) rec->key.dptr,
411 DEBUG(2, ("regdb_normalize_keynames_fn: Convert %s to %s\n",
412 (const char *) rec->key.dptr,
415 new_rec.value.dptr = rec->value.dptr;
416 new_rec.value.dsize = rec->value.dsize;
417 new_rec.key.dptr = (unsigned char *) keyname;
418 new_rec.key.dsize = strlen(keyname);
419 new_rec.private_data = rec->private_data;
421 /* Delete the original record and store the normalized key */
422 status = rec->delete_rec(rec);
423 if (!NT_STATUS_IS_OK(status)) {
424 DEBUG(0,("regdb_normalize_keynames_fn: "
425 "tdb_delete for [%s] failed!\n",
430 status = rec->store(&new_rec, new_rec.value, TDB_REPLACE);
431 if (!NT_STATUS_IS_OK(status)) {
432 DEBUG(0,("regdb_normalize_keynames_fn: "
433 "failed to store new record for [%s]!\n",
442 static WERROR regdb_upgrade_to_version_2(void)
447 mem_ctx = talloc_stackframe();
448 if (mem_ctx == NULL) {
452 rc = regdb->traverse(regdb, regdb_normalize_keynames_fn, mem_ctx);
454 talloc_destroy(mem_ctx);
455 return (rc == -1 ? WERR_REG_IO_FAILURE : WERR_OK);
458 /***********************************************************************
459 Open the registry database
460 ***********************************************************************/
462 WERROR regdb_init(void)
464 const char *vstring = "INFO/version";
469 DEBUG(10, ("regdb_init: incrementing refcount (%d)\n",
475 regdb = db_open(NULL, state_path("registry.tdb"), 0,
476 REG_TDB_FLAGS, O_RDWR, 0600);
478 regdb = db_open(NULL, state_path("registry.tdb"), 0,
479 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
481 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
482 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
483 state_path("registry.tdb"), strerror(errno) ));
487 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
492 vers_id = dbwrap_fetch_int32(regdb, vstring);
496 DEBUG(10, ("regdb_init: got %s = %d != %d\n", vstring,
497 vers_id, REGVER_V2));
498 status = dbwrap_trans_store_int32(regdb, vstring, REGVER_V2);
499 if (!NT_STATUS_IS_OK(status)) {
500 DEBUG(1, ("regdb_init: error storing %s = %d: %s\n",
501 vstring, REGVER_V1, nt_errstr(status)));
502 return ntstatus_to_werror(status);
504 DEBUG(10, ("regdb_init: stored %s = %d\n",
505 vstring, REGVER_V1));
510 if (vers_id != REGVER_V2) {
513 if (vers_id == REGVER_V1) {
514 if (regdb->transaction_start(regdb) != 0) {
515 return WERR_REG_IO_FAILURE;
518 werr = regdb_upgrade_to_version_2();
519 if (!W_ERROR_IS_OK(werr)) {
520 regdb->transaction_cancel(regdb);
524 status = dbwrap_trans_store_int32(regdb, vstring, REGVER_V2);
525 if (!NT_STATUS_IS_OK(status)) {
526 DEBUG(1, ("regdb_init: error storing %s = %d: %s\n",
527 vstring, REGVER_V1, nt_errstr(status)));
528 regdb->transaction_cancel(regdb);
529 return ntstatus_to_werror(status);
531 DEBUG(10, ("regdb_init: stored %s = %d\n",
532 vstring, REGVER_V1));
534 if (regdb->transaction_commit(regdb) != 0) {
535 return WERR_REG_IO_FAILURE;
545 /***********************************************************************
546 Open the registry. Must already have been initialized by regdb_init()
547 ***********************************************************************/
549 WERROR regdb_open( void )
551 WERROR result = WERR_OK;
554 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount));
561 regdb = db_open(NULL, state_path("registry.tdb"), 0,
562 REG_TDB_FLAGS, O_RDWR, 0600);
564 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
565 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
566 state_path("registry.tdb"), strerror(errno) ));
572 DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount));
577 /***********************************************************************
578 ***********************************************************************/
580 int regdb_close( void )
582 if (regdb_refcount == 0) {
588 DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount));
590 if ( regdb_refcount > 0 )
593 SMB_ASSERT( regdb_refcount >= 0 );
599 WERROR regdb_transaction_start(void)
601 return (regdb->transaction_start(regdb) == 0) ?
602 WERR_OK : WERR_REG_IO_FAILURE;
605 WERROR regdb_transaction_commit(void)
607 return (regdb->transaction_commit(regdb) == 0) ?
608 WERR_OK : WERR_REG_IO_FAILURE;
611 WERROR regdb_transaction_cancel(void)
613 return (regdb->transaction_cancel(regdb) == 0) ?
614 WERR_OK : WERR_REG_IO_FAILURE;
617 /***********************************************************************
618 return the tdb sequence number of the registry tdb.
619 this is an indicator for the content of the registry
620 having changed. it will change upon regdb_init, too, though.
621 ***********************************************************************/
622 int regdb_get_seqnum(void)
624 return regdb->get_seqnum(regdb);
628 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
633 WERROR werr = WERR_NOMEM;
634 TALLOC_CTX *mem_ctx = talloc_stackframe();
636 if (keyname == NULL) {
637 werr = WERR_INVALID_PARAM;
641 if (prefix == NULL) {
642 path = discard_const_p(char, keyname);
644 path = talloc_asprintf(mem_ctx, "%s\\%s", prefix, keyname);
650 path = normalize_reg_path(mem_ctx, path);
655 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
657 /* treat "not" found" as ok */
658 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
663 talloc_free(mem_ctx);
668 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
670 return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
673 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
675 return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
678 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
680 return regdb_delete_key_with_prefix(db, keyname, NULL);
683 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
687 werr = regdb_delete_values(db, keyname);
688 if (!W_ERROR_IS_OK(werr)) {
689 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
690 REG_VALUE_PREFIX, keyname, win_errstr(werr)));
694 werr = regdb_delete_secdesc(db, keyname);
695 if (!W_ERROR_IS_OK(werr)) {
696 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
697 REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
701 werr = regdb_delete_subkeylist(db, keyname);
702 if (!W_ERROR_IS_OK(werr)) {
703 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
704 keyname, win_errstr(werr)));
712 /***********************************************************************
713 Add subkey strings to the registry tdb under a defined key
714 fmt is the same format as tdb_pack except this function only supports
716 ***********************************************************************/
718 static WERROR regdb_store_keys_internal2(struct db_context *db,
720 struct regsubkey_ctr *ctr)
723 uint8 *buffer = NULL;
726 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
727 char *keyname = NULL;
728 TALLOC_CTX *ctx = talloc_stackframe();
732 werr = WERR_INVALID_PARAM;
736 keyname = talloc_strdup(ctx, key);
742 keyname = normalize_reg_path(ctx, keyname);
748 /* allocate some initial memory */
750 buffer = (uint8 *)SMB_MALLOC(1024);
751 if (buffer == NULL) {
758 /* store the number of subkeys */
760 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
762 /* pack all the strings */
764 for (i=0; i<num_subkeys; i++) {
767 thistime = tdb_pack(buffer+len, buflen-len, "f",
768 regsubkey_ctr_specific_key(ctr, i));
769 if (len+thistime > buflen) {
772 * tdb_pack hasn't done anything because of the short
773 * buffer, allocate extra space.
775 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
778 DEBUG(0, ("regdb_store_keys: Failed to realloc "
779 "memory of size [%u]\n",
780 (unsigned int)(len+thistime)*2));
784 buflen = (len+thistime)*2;
785 thistime2 = tdb_pack(
786 buffer+len, buflen-len, "f",
787 regsubkey_ctr_specific_key(ctr, i));
788 if (thistime2 != thistime) {
789 DEBUG(0, ("tdb_pack failed\n"));
790 werr = WERR_CAN_NOT_COMPLETE;
797 /* finally write out the data */
801 werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
803 W_ERROR_NOT_OK_GOTO_DONE(werr);
806 * Delete a sorted subkey cache for regdb_key_exists, will be
807 * recreated automatically
809 keyname = talloc_asprintf(ctx, "%s\\%s", REG_SORTED_SUBKEYS_PREFIX,
811 if (keyname == NULL) {
816 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, keyname));
818 /* don't treat WERR_NOT_FOUND as an error here */
819 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
829 /***********************************************************************
830 Store the new subkey record and create any child key records that
831 do not currently exist
832 ***********************************************************************/
834 struct regdb_store_keys_context {
836 struct regsubkey_ctr *ctr;
839 static NTSTATUS regdb_store_keys_action(struct db_context *db,
842 struct regdb_store_keys_context *store_ctx;
846 struct regsubkey_ctr *subkeys = NULL, *old_subkeys = NULL;
847 char *oldkeyname = NULL;
848 TALLOC_CTX *mem_ctx = talloc_stackframe();
850 store_ctx = (struct regdb_store_keys_context *)private_data;
853 * Re-fetch the old keys inside the transaction
856 werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
857 W_ERROR_NOT_OK_GOTO_DONE(werr);
859 werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
860 if (!W_ERROR_IS_OK(werr) &&
861 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
867 * Make the store operation as safe as possible without transactions:
869 * (1) For each subkey removed from ctr compared with old_subkeys:
871 * (a) First delete the value db entry.
873 * (b) Next delete the secdesc db record.
875 * (c) Then delete the subkey list entry.
877 * (2) Now write the list of subkeys of the parent key,
878 * deleting removed entries and adding new ones.
880 * (3) Finally create the subkey list entries for the added keys.
882 * This way if we crash half-way in between deleting the subkeys
883 * and storing the parent's list of subkeys, no old data can pop up
884 * out of the blue when re-adding keys later on.
887 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
889 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
890 for (i=0; i<num_subkeys; i++) {
891 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
893 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
895 * It's still around, don't delete
900 path = talloc_asprintf(mem_ctx, "%s\\%s", store_ctx->key,
907 werr = regdb_delete_key_lists(db, path);
908 W_ERROR_NOT_OK_GOTO_DONE(werr);
913 TALLOC_FREE(old_subkeys);
915 /* (2) store the subkey list for the parent */
917 werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
918 if (!W_ERROR_IS_OK(werr)) {
919 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
920 "for parent [%s]: %s\n", store_ctx->key,
925 /* (3) now create records for any subkeys that don't already exist */
927 num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
929 if (num_subkeys == 0) {
930 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
931 W_ERROR_NOT_OK_GOTO_DONE(werr);
933 werr = regdb_store_keys_internal2(db, store_ctx->key, subkeys);
934 if (!W_ERROR_IS_OK(werr)) {
935 DEBUG(0,("regdb_store_keys: Failed to store "
936 "new record for key [%s]: %s\n",
937 store_ctx->key, win_errstr(werr)));
940 TALLOC_FREE(subkeys);
943 for (i=0; i<num_subkeys; i++) {
944 path = talloc_asprintf(mem_ctx, "%s\\%s", store_ctx->key,
945 regsubkey_ctr_specific_key(store_ctx->ctr, i));
950 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
951 W_ERROR_NOT_OK_GOTO_DONE(werr);
953 werr = regdb_fetch_keys_internal(db, path, subkeys);
954 if (!W_ERROR_IS_OK(werr)) {
955 /* create a record with 0 subkeys */
956 werr = regdb_store_keys_internal2(db, path, subkeys);
957 if (!W_ERROR_IS_OK(werr)) {
958 DEBUG(0,("regdb_store_keys: Failed to store "
959 "new record for key [%s]: %s\n", path,
965 TALLOC_FREE(subkeys);
972 talloc_free(mem_ctx);
973 return werror_to_ntstatus(werr);
976 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
977 struct regsubkey_ctr *ctr)
979 int num_subkeys, old_num_subkeys, i;
980 struct regsubkey_ctr *old_subkeys = NULL;
981 TALLOC_CTX *ctx = talloc_stackframe();
984 struct regdb_store_keys_context store_ctx;
986 if (!regdb_key_is_base_key(key) && !regdb_key_exists(db, key)) {
991 * fetch a list of the old subkeys so we can determine if anything has
995 werr = regsubkey_ctr_init(ctx, &old_subkeys);
996 if (!W_ERROR_IS_OK(werr)) {
997 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
1001 werr = regdb_fetch_keys_internal(db, key, old_subkeys);
1002 if (!W_ERROR_IS_OK(werr) &&
1003 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1008 num_subkeys = regsubkey_ctr_numkeys(ctr);
1009 old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1010 if ((num_subkeys && old_num_subkeys) &&
1011 (num_subkeys == old_num_subkeys)) {
1013 for (i = 0; i < num_subkeys; i++) {
1014 if (strcmp(regsubkey_ctr_specific_key(ctr, i),
1015 regsubkey_ctr_specific_key(old_subkeys, i))
1021 if (i == num_subkeys) {
1023 * Nothing changed, no point to even start a tdb
1032 TALLOC_FREE(old_subkeys);
1034 store_ctx.key = key;
1035 store_ctx.ctr = ctr;
1037 werr = ntstatus_to_werror(dbwrap_trans_do(db,
1038 regdb_store_keys_action,
1041 ret = W_ERROR_IS_OK(werr);
1049 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
1051 return regdb_store_keys_internal(regdb, key, ctr);
1055 * create a subkey of a given key
1058 struct regdb_create_subkey_context {
1063 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
1067 struct regdb_create_subkey_context *create_ctx;
1068 struct regsubkey_ctr *subkeys;
1069 TALLOC_CTX *mem_ctx = talloc_stackframe();
1071 create_ctx = (struct regdb_create_subkey_context *)private_data;
1073 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1074 W_ERROR_NOT_OK_GOTO_DONE(werr);
1076 werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
1077 W_ERROR_NOT_OK_GOTO_DONE(werr);
1079 werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
1080 W_ERROR_NOT_OK_GOTO_DONE(werr);
1082 werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
1083 if (!W_ERROR_IS_OK(werr)) {
1084 DEBUG(0, (__location__ " failed to store new subkey list for "
1085 "parent key %s: %s\n", create_ctx->key,
1090 talloc_free(mem_ctx);
1091 return werror_to_ntstatus(werr);
1094 static WERROR regdb_create_subkey(const char *key, const char *subkey)
1097 struct regsubkey_ctr *subkeys;
1098 TALLOC_CTX *mem_ctx = talloc_stackframe();
1099 struct regdb_create_subkey_context create_ctx;
1101 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
1102 werr = WERR_NOT_FOUND;
1106 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1107 W_ERROR_NOT_OK_GOTO_DONE(werr);
1109 werr = regdb_fetch_keys_internal(regdb, key, subkeys);
1110 W_ERROR_NOT_OK_GOTO_DONE(werr);
1112 if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1117 talloc_free(subkeys);
1119 create_ctx.key = key;
1120 create_ctx.subkey = subkey;
1122 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1123 regdb_create_subkey_action,
1127 talloc_free(mem_ctx);
1132 * create a subkey of a given key
1135 struct regdb_delete_subkey_context {
1141 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1145 struct regdb_delete_subkey_context *delete_ctx;
1146 struct regsubkey_ctr *subkeys;
1147 TALLOC_CTX *mem_ctx = talloc_stackframe();
1149 delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1151 werr = regdb_delete_key_lists(db, delete_ctx->path);
1152 W_ERROR_NOT_OK_GOTO_DONE(werr);
1154 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1155 W_ERROR_NOT_OK_GOTO_DONE(werr);
1157 werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1158 W_ERROR_NOT_OK_GOTO_DONE(werr);
1160 werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1161 W_ERROR_NOT_OK_GOTO_DONE(werr);
1163 werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1164 if (!W_ERROR_IS_OK(werr)) {
1165 DEBUG(0, (__location__ " failed to store new subkey_list for "
1166 "parent key %s: %s\n", delete_ctx->key,
1171 talloc_free(mem_ctx);
1172 return werror_to_ntstatus(werr);
1175 static WERROR regdb_delete_subkey(const char *key, const char *subkey)
1179 struct regdb_delete_subkey_context delete_ctx;
1180 TALLOC_CTX *mem_ctx = talloc_stackframe();
1182 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
1183 werr = WERR_NOT_FOUND;
1187 path = talloc_asprintf(mem_ctx, "%s\\%s", key, subkey);
1193 if (!regdb_key_exists(regdb, path)) {
1198 delete_ctx.key = key;
1199 delete_ctx.subkey = subkey;
1200 delete_ctx.path = path;
1202 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1203 regdb_delete_subkey_action,
1207 talloc_free(mem_ctx);
1211 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1212 TALLOC_CTX *mem_ctx, const char *key)
1217 path = normalize_reg_path(mem_ctx, key);
1219 return make_tdb_data(NULL, 0);
1222 data = dbwrap_fetch_bystring(db, mem_ctx, path);
1230 * check whether a given key name represents a base key,
1231 * i.e one without a subkey separator ('\').
1233 static bool regdb_key_is_base_key(const char *key)
1235 TALLOC_CTX *mem_ctx = talloc_stackframe();
1243 path = normalize_reg_path(mem_ctx, key);
1245 DEBUG(0, ("out of memory! (talloc failed)\n"));
1249 if (*path == '\0') {
1253 ret = (strrchr(path, '\\') == NULL);
1256 TALLOC_FREE(mem_ctx);
1261 * regdb_key_exists() is a very frequent operation. It can be quite
1262 * time-consuming to fully fetch the parent's subkey list, talloc_strdup all
1263 * subkeys and then compare the keyname linearly to all the parent's subkeys.
1265 * The following code tries to make this operation as efficient as possible:
1266 * Per registry key we create a list of subkeys that is very efficient to
1267 * search for existence of a subkey. Its format is:
1269 * 4 bytes num_subkeys
1270 * 4*num_subkey bytes offset into the string array
1271 * then follows a sorted list of subkeys in uppercase
1273 * This record is created by create_sorted_subkeys() on demand if it does not
1274 * exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
1275 * list, the parsing code and the binary search can be found in
1276 * parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
1277 * the potentially large subkey record.
1279 * The sorted subkey record is deleted in regdb_store_keys_internal2 and
1280 * recreated on demand.
1283 static int cmp_keynames(char **p1, char **p2)
1285 return StrCaseCmp(*p1, *p2);
1288 struct create_sorted_subkeys_context {
1290 const char *sorted_keyname;
1293 static NTSTATUS create_sorted_subkeys_action(struct db_context *db,
1296 char **sorted_subkeys;
1297 struct regsubkey_ctr *ctr;
1304 struct create_sorted_subkeys_context *sorted_ctx;
1306 sorted_ctx = (struct create_sorted_subkeys_context *)private_data;
1309 * In this function, we only treat failing of the actual write to
1310 * the db as a real error. All preliminary errors, at a stage when
1311 * nothing has been written to the DB yet are treated as success
1312 * to be committed (as an empty transaction).
1314 * The reason is that this (disposable) call might be nested in other
1315 * transactions. Doing a cancel here would destroy the possibility of
1316 * a transaction_commit for transactions that we might be wrapped in.
1319 status = werror_to_ntstatus(regsubkey_ctr_init(talloc_tos(), &ctr));
1320 if (!NT_STATUS_IS_OK(status)) {
1321 /* don't treat this as an error */
1322 status = NT_STATUS_OK;
1326 status = werror_to_ntstatus(regdb_fetch_keys_internal(db,
1329 if (!NT_STATUS_IS_OK(status)) {
1330 /* don't treat this as an error */
1331 status = NT_STATUS_OK;
1335 num_subkeys = regsubkey_ctr_numkeys(ctr);
1336 sorted_subkeys = talloc_array(ctr, char *, num_subkeys);
1337 if (sorted_subkeys == NULL) {
1338 /* don't treat this as an error */
1342 len = 4 + 4*num_subkeys;
1344 for (i = 0; i < num_subkeys; i++) {
1345 sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
1346 regsubkey_ctr_specific_key(ctr, i));
1347 if (sorted_subkeys[i] == NULL) {
1348 /* don't treat this as an error */
1351 len += strlen(sorted_subkeys[i])+1;
1354 TYPESAFE_QSORT(sorted_subkeys, num_subkeys, cmp_keynames);
1356 buf = talloc_array(ctr, char, len);
1358 /* don't treat this as an error */
1361 p = buf + 4 + 4*num_subkeys;
1363 SIVAL(buf, 0, num_subkeys);
1365 for (i=0; i < num_subkeys; i++) {
1366 ptrdiff_t offset = p - buf;
1367 SIVAL(buf, 4 + 4*i, offset);
1368 strlcpy(p, sorted_subkeys[i], len-offset);
1369 p += strlen(sorted_subkeys[i]) + 1;
1372 status = dbwrap_store_bystring(
1373 db, sorted_ctx->sorted_keyname, make_tdb_data((uint8_t *)buf,
1382 static bool create_sorted_subkeys(const char *key, const char *sorted_keyname)
1385 struct create_sorted_subkeys_context sorted_ctx;
1387 sorted_ctx.key = key;
1388 sorted_ctx.sorted_keyname = sorted_keyname;
1390 status = dbwrap_trans_do(regdb,
1391 create_sorted_subkeys_action,
1394 return NT_STATUS_IS_OK(status);
1397 struct scan_subkey_state {
1403 static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
1406 struct scan_subkey_state *state =
1407 (struct scan_subkey_state *)private_data;
1408 uint32_t num_subkeys;
1411 if (data.dsize < sizeof(uint32_t)) {
1415 state->scanned = true;
1416 state->found = false;
1418 tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
1424 uint32_t idx = (l+u)/2;
1425 char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
1426 int comparison = strcmp(state->name, s);
1428 if (comparison < 0) {
1430 } else if (comparison > 0) {
1433 state->found = true;
1440 static bool scan_parent_subkeys(struct db_context *db, const char *parent,
1445 struct scan_subkey_state state = { 0, };
1446 bool result = false;
1451 path = normalize_reg_path(talloc_tos(), parent);
1456 key = talloc_asprintf(talloc_tos(), "%s\\%s",
1457 REG_SORTED_SUBKEYS_PREFIX, path);
1462 state.name = talloc_strdup_upper(talloc_tos(), name);
1463 if (state.name == NULL) {
1466 state.scanned = false;
1468 res = db->parse_record(db, string_term_tdb_data(key),
1469 parent_subkey_scanner, &state);
1471 if (state.scanned) {
1472 result = state.found;
1474 res = db->transaction_start(db);
1476 DEBUG(0, ("error starting transacion\n"));
1480 if (!create_sorted_subkeys(path, key)) {
1481 res = db->transaction_cancel(db);
1483 smb_panic("Failed to cancel transaction.");
1488 res = db->parse_record(db, string_term_tdb_data(key),
1489 parent_subkey_scanner, &state);
1490 if ((res == 0) && (state.scanned)) {
1491 result = state.found;
1494 res = db->transaction_commit(db);
1496 DEBUG(0, ("error committing transaction\n"));
1503 TALLOC_FREE(state.name);
1508 * Check for the existence of a key.
1510 * Existence of a key is authoritatively defined by its
1511 * existence in the list of subkeys of its parent key.
1512 * The exeption of this are keys without a parent key,
1513 * i.e. the "base" keys (HKLM, HKCU, ...).
1515 static bool regdb_key_exists(struct db_context *db, const char *key)
1517 TALLOC_CTX *mem_ctx = talloc_stackframe();
1526 path = normalize_reg_path(mem_ctx, key);
1528 DEBUG(0, ("out of memory! (talloc failed)\n"));
1532 if (*path == '\0') {
1536 p = strrchr(path, '\\');
1538 /* this is a base key */
1539 value = regdb_fetch_key_internal(db, mem_ctx, path);
1540 ret = (value.dptr != NULL);
1543 ret = scan_parent_subkeys(db, path, p+1);
1547 TALLOC_FREE(mem_ctx);
1552 /***********************************************************************
1553 Retrieve an array of strings containing subkeys. Memory should be
1554 released by the caller.
1555 ***********************************************************************/
1557 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1558 struct regsubkey_ctr *ctr)
1566 TALLOC_CTX *frame = talloc_stackframe();
1569 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1571 frame = talloc_stackframe();
1573 if (!regdb_key_exists(db, key)) {
1574 DEBUG(10, ("key [%s] not found\n", key));
1575 werr = WERR_NOT_FOUND;
1579 werr = regsubkey_ctr_set_seqnum(ctr, db->get_seqnum(db));
1580 W_ERROR_NOT_OK_GOTO_DONE(werr);
1582 value = regdb_fetch_key_internal(db, frame, key);
1584 if (value.dsize == 0 || value.dptr == NULL) {
1585 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1591 buflen = value.dsize;
1592 len = tdb_unpack( buf, buflen, "d", &num_items);
1593 if (len == (uint32_t)-1) {
1594 werr = WERR_NOT_FOUND;
1598 werr = regsubkey_ctr_reinit(ctr);
1599 W_ERROR_NOT_OK_GOTO_DONE(werr);
1601 for (i=0; i<num_items; i++) {
1602 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1603 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1604 if (!W_ERROR_IS_OK(werr)) {
1605 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1606 "failed: %s\n", win_errstr(werr)));
1612 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1619 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1623 werr = regdb_fetch_keys_internal(regdb, key, ctr);
1624 if (!W_ERROR_IS_OK(werr)) {
1628 return regsubkey_ctr_numkeys(ctr);
1631 /****************************************************************************
1632 Unpack a list of registry values frem the TDB
1633 ***************************************************************************/
1635 static int regdb_unpack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1642 uint32 num_values = 0;
1645 /* loop and unpack the rest of the registry values */
1647 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1649 for ( i=0; i<num_values; i++ ) {
1650 /* unpack the next regval */
1655 valuename[0] = '\0';
1656 len += tdb_unpack(buf+len, buflen-len, "fdB",
1662 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1664 if (size && data_p) {
1665 regval_ctr_addvalue(values, valuename, type,
1666 (uint8_t *)data_p, size);
1668 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1670 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1676 /****************************************************************************
1677 Pack all values in all printer keys
1678 ***************************************************************************/
1680 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1684 struct regval_blob *val;
1690 num_values = regval_ctr_numvals( values );
1692 /* pack the number of values first */
1694 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1696 /* loop over all values */
1698 for ( i=0; i<num_values; i++ ) {
1699 val = regval_ctr_specific_value( values, i );
1700 len += tdb_pack(buf+len, buflen-len, "fdB",
1704 regval_data_p(val) );
1710 /***********************************************************************
1711 Retrieve an array of strings containing subkeys. Memory should be
1712 released by the caller.
1713 ***********************************************************************/
1715 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1716 struct regval_ctr *values)
1718 char *keystr = NULL;
1719 TALLOC_CTX *ctx = talloc_stackframe();
1724 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1726 if (!regdb_key_exists(db, key)) {
1730 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key);
1735 werr = regval_ctr_set_seqnum(values, db->get_seqnum(db));
1736 W_ERROR_NOT_OK_GOTO_DONE(werr);
1738 value = regdb_fetch_key_internal(db, ctx, keystr);
1741 /* all keys have zero values by default */
1745 regdb_unpack_values(values, value.dptr, value.dsize);
1746 ret = regval_ctr_numvals(values);
1753 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1755 return regdb_fetch_values_internal(regdb, key, values);
1758 static bool regdb_store_values_internal(struct db_context *db, const char *key,
1759 struct regval_ctr *values)
1761 TDB_DATA old_data, data;
1762 char *keystr = NULL;
1763 TALLOC_CTX *ctx = talloc_stackframe();
1766 bool result = false;
1768 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1770 if (!regdb_key_exists(db, key)) {
1776 len = regdb_pack_values(values, data.dptr, data.dsize);
1778 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1782 data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1785 len = regdb_pack_values(values, data.dptr, data.dsize);
1787 SMB_ASSERT( len == data.dsize );
1789 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key );
1793 keystr = normalize_reg_path(ctx, keystr);
1798 old_data = dbwrap_fetch_bystring(db, ctx, keystr);
1800 if ((old_data.dptr != NULL)
1801 && (old_data.dsize == data.dsize)
1802 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1808 status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1810 result = NT_STATUS_IS_OK(status);
1817 bool regdb_store_values(const char *key, struct regval_ctr *values)
1819 return regdb_store_values_internal(regdb, key, values);
1822 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1823 struct security_descriptor **psecdesc)
1828 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1829 WERROR err = WERR_OK;
1831 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1833 if (!regdb_key_exists(regdb, key)) {
1838 tdbkey = talloc_asprintf(tmp_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1839 if (tdbkey == NULL) {
1844 tdbkey = normalize_reg_path(tmp_ctx, tdbkey);
1845 if (tdbkey == NULL) {
1850 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1851 if (data.dptr == NULL) {
1856 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1859 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1861 } else if (!NT_STATUS_IS_OK(status)) {
1862 err = WERR_REG_CORRUPT;
1866 TALLOC_FREE(tmp_ctx);
1870 static WERROR regdb_set_secdesc(const char *key,
1871 struct security_descriptor *secdesc)
1873 TALLOC_CTX *mem_ctx = talloc_stackframe();
1875 WERROR err = WERR_NOMEM;
1878 if (!regdb_key_exists(regdb, key)) {
1883 tdbkey = talloc_asprintf(mem_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1884 if (tdbkey == NULL) {
1888 tdbkey = normalize_reg_path(mem_ctx, tdbkey);
1889 if (tdbkey == NULL) {
1894 if (secdesc == NULL) {
1895 /* assuming a delete */
1896 err = ntstatus_to_werror(dbwrap_trans_delete_bystring(regdb,
1901 err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1904 W_ERROR_NOT_OK_GOTO_DONE(err);
1906 err = ntstatus_to_werror(dbwrap_trans_store_bystring(regdb, tdbkey,
1910 TALLOC_FREE(mem_ctx);
1914 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1916 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1919 bool regdb_values_need_update(struct regval_ctr *values)
1921 return (regdb_get_seqnum() != regval_ctr_get_seqnum(values));
1925 * Table of function pointers for default access
1928 struct registry_ops regdb_ops = {
1929 .fetch_subkeys = regdb_fetch_keys,
1930 .fetch_values = regdb_fetch_values,
1931 .store_subkeys = regdb_store_keys,
1932 .store_values = regdb_store_values,
1933 .create_subkey = regdb_create_subkey,
1934 .delete_subkey = regdb_delete_subkey,
1935 .get_secdesc = regdb_get_secdesc,
1936 .set_secdesc = regdb_set_secdesc,
1937 .subkeys_need_update = regdb_subkeys_need_update,
1938 .values_need_update = regdb_values_need_update