2 * Unix SMB/CIFS implementation.
3 * Virtual Windows Registry Layer
4 * Copyright (C) Gerald Carter 2002-2005
5 * Copyright (C) Michael Adam 2007-2011
6 * Copyright (C) Gregor Beck 2011
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, see <http://www.gnu.org/licenses/>.
22 /* Implementation of internal registry database functions. */
25 #include "system/filesys.h"
28 #include "reg_util_internal.h"
29 #include "reg_backend_db.h"
30 #include "reg_objects.h"
31 #include "nt_printing.h"
33 #include "dbwrap/dbwrap.h"
34 #include "dbwrap/dbwrap_open.h"
35 #include "../libcli/security/secdesc.h"
38 #define DBGC_CLASS DBGC_REGISTRY
40 #define REGDB_VERSION_KEYNAME "INFO/version"
42 static struct db_context *regdb = NULL;
43 static int regdb_refcount;
45 static bool regdb_key_exists(struct db_context *db, const char *key);
46 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
47 struct regsubkey_ctr *ctr);
48 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
49 struct regsubkey_ctr *ctr);
50 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
51 struct regval_ctr *values);
52 static bool regdb_store_values_internal(struct db_context *db, const char *key,
53 struct regval_ctr *values);
54 static WERROR regdb_store_subkey_list(struct db_context *db, const char *parent,
57 static WERROR regdb_create_basekey(struct db_context *db, const char *key);
58 static WERROR regdb_create_subkey_internal(struct db_context *db,
63 struct regdb_trans_ctx {
64 NTSTATUS (*action)(struct db_context *, void *);
68 static NTSTATUS regdb_trans_do_action(struct db_context *db, void *private_data)
72 struct regdb_trans_ctx *ctx = (struct regdb_trans_ctx *)private_data;
74 version_id = dbwrap_fetch_int32(db, REGDB_VERSION_KEYNAME);
76 if (version_id != REGVER_V3) {
77 DEBUG(0, ("ERROR: changed registry version %d found while "
78 "trying to write to the registry. Version %d "
79 "expected. Denying access.\n",
80 version_id, REGVER_V3));
81 return NT_STATUS_ACCESS_DENIED;
84 status = ctx->action(db, ctx->private_data);
88 static WERROR regdb_trans_do(struct db_context *db,
89 NTSTATUS (*action)(struct db_context *, void *),
93 struct regdb_trans_ctx ctx;
97 ctx.private_data = private_data;
99 status = dbwrap_trans_do(db, regdb_trans_do_action, &ctx);
101 return ntstatus_to_werror(status);
104 /* List the deepest path into the registry. All part components will be created.*/
106 /* If you want to have a part of the path controlled by the tdb and part by
107 a virtual registry db (e.g. printing), then you have to list the deepest path.
108 For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
109 allows the reg_db backend to handle everything up to
110 "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
111 the reg_printing backend onto the last component of the path (see
112 KEY_PRINTING_2K in include/rpc_reg.h) --jerry */
114 static const char *builtin_registry_paths[] = {
118 KEY_PRINTING "\\Forms",
119 KEY_PRINTING "\\Printers",
120 KEY_PRINTING "\\Environments\\Windows NT x86\\Print Processors\\winprint",
127 KEY_SAMBA_GROUP_POLICY,
128 KEY_GP_MACHINE_POLICY,
129 KEY_GP_MACHINE_WIN_POLICY,
132 KEY_GP_USER_WIN_POLICY,
133 "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Winlogon\\GPExtensions",
134 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
136 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
145 struct builtin_regkey_value {
147 const char *valuename;
155 static struct builtin_regkey_value builtin_registry_values[] = {
156 { KEY_PRINTING_PORTS,
157 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
159 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
161 "DisplayName", REG_SZ, { "Event Log" } },
163 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
164 { NULL, NULL, 0, { NULL } }
167 static WERROR create_key_recursive(struct db_context *db,
174 if (subkey == NULL) {
175 return WERR_INVALID_PARAM;
179 return regdb_create_basekey(db, subkey);
182 p = strrchr_m(path, '\\');
185 werr = create_key_recursive(db, NULL, path);
188 werr = create_key_recursive(db, path, p+1);
192 if (!W_ERROR_IS_OK(werr)) {
196 werr = regdb_create_subkey_internal(db, path, subkey);
203 * Initialize a key in the registry:
204 * create each component key of the specified path.
206 static WERROR init_registry_key_internal(struct db_context *db,
207 const char *add_path)
211 TALLOC_CTX *frame = talloc_stackframe();
213 if (add_path == NULL) {
214 werr = WERR_INVALID_PARAM;
218 key = talloc_strdup(frame, add_path);
220 subkey = strrchr_m(key, '\\');
221 if (subkey == NULL) {
229 werr = create_key_recursive(db, key, subkey);
236 struct init_registry_key_context {
237 const char *add_path;
240 static NTSTATUS init_registry_key_action(struct db_context *db,
243 struct init_registry_key_context *init_ctx =
244 (struct init_registry_key_context *)private_data;
246 return werror_to_ntstatus(init_registry_key_internal(
247 db, init_ctx->add_path));
251 * Initialize a key in the registry:
252 * create each component key of the specified path,
253 * wrapped in one db transaction.
255 WERROR init_registry_key(const char *add_path)
257 struct init_registry_key_context init_ctx;
259 if (regdb_key_exists(regdb, add_path)) {
263 init_ctx.add_path = add_path;
265 return ntstatus_to_werror(dbwrap_trans_do(regdb,
266 init_registry_key_action,
270 /***********************************************************************
271 Open the registry data in the tdb
272 ***********************************************************************/
274 static void regdb_ctr_add_value(struct regval_ctr *ctr,
275 struct builtin_regkey_value *value)
277 switch(value->type) {
279 regval_ctr_addvalue(ctr, value->valuename, REG_DWORD,
280 (uint8_t *)&value->data.dw_value,
285 regval_ctr_addvalue_sz(ctr, value->valuename,
290 DEBUG(0, ("regdb_ctr_add_value: invalid value type in "
291 "registry values [%d]\n", value->type));
295 static NTSTATUS init_registry_data_action(struct db_context *db,
299 TALLOC_CTX *frame = talloc_stackframe();
300 struct regval_ctr *values;
303 /* loop over all of the predefined paths and add each component */
305 for (i=0; builtin_registry_paths[i] != NULL; i++) {
306 if (regdb_key_exists(db, builtin_registry_paths[i])) {
309 status = werror_to_ntstatus(init_registry_key_internal(db,
310 builtin_registry_paths[i]));
311 if (!NT_STATUS_IS_OK(status)) {
316 /* loop over all of the predefined values and add each component */
318 for (i=0; builtin_registry_values[i].path != NULL; i++) {
321 werr = regval_ctr_init(frame, &values);
322 if (!W_ERROR_IS_OK(werr)) {
323 status = werror_to_ntstatus(werr);
327 regdb_fetch_values_internal(db,
328 builtin_registry_values[i].path,
331 /* preserve existing values across restarts. Only add new ones */
333 if (!regval_ctr_key_exists(values,
334 builtin_registry_values[i].valuename))
336 regdb_ctr_add_value(values,
337 &builtin_registry_values[i]);
338 regdb_store_values_internal(db,
339 builtin_registry_values[i].path,
345 status = NT_STATUS_OK;
353 WERROR init_registry_data(void)
356 TALLOC_CTX *frame = talloc_stackframe();
357 struct regval_ctr *values;
361 * First, check for the existence of the needed keys and values.
362 * If all do already exist, we can save the writes.
364 for (i=0; builtin_registry_paths[i] != NULL; i++) {
365 if (!regdb_key_exists(regdb, builtin_registry_paths[i])) {
370 for (i=0; builtin_registry_values[i].path != NULL; i++) {
371 werr = regval_ctr_init(frame, &values);
372 W_ERROR_NOT_OK_GOTO_DONE(werr);
374 regdb_fetch_values_internal(regdb,
375 builtin_registry_values[i].path,
377 if (!regval_ctr_key_exists(values,
378 builtin_registry_values[i].valuename))
393 * There are potentially quite a few store operations which are all
394 * indiviually wrapped in tdb transactions. Wrapping them in a single
395 * transaction gives just a single transaction_commit() to actually do
396 * its fsync()s. See tdb/common/transaction.c for info about nested
397 * transaction behaviour.
400 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
401 init_registry_data_action,
409 static int regdb_normalize_keynames_fn(struct db_record *rec,
412 TALLOC_CTX *mem_ctx = talloc_tos();
415 struct db_context *db = (struct db_context *)private_data;
417 if (rec->key.dptr == NULL || rec->key.dsize == 0) {
422 DEBUG(0, ("regdb_normalize_keynames_fn: ERROR: "
423 "NULL db context handed in via private_data\n"));
427 if (strncmp((const char *)rec->key.dptr, REGDB_VERSION_KEYNAME,
428 strlen(REGDB_VERSION_KEYNAME)) == 0)
433 keyname = strchr((const char *) rec->key.dptr, '/');
435 keyname = talloc_string_sub(mem_ctx,
436 (const char *) rec->key.dptr,
440 DEBUG(2, ("regdb_normalize_keynames_fn: Convert %s to %s\n",
441 (const char *) rec->key.dptr,
444 /* Delete the original record and store the normalized key */
445 status = rec->delete_rec(rec);
446 if (!NT_STATUS_IS_OK(status)) {
447 DEBUG(0,("regdb_normalize_keynames_fn: "
448 "tdb_delete for [%s] failed!\n",
453 status = dbwrap_store_bystring(db, keyname, rec->value,
455 if (!NT_STATUS_IS_OK(status)) {
456 DEBUG(0,("regdb_normalize_keynames_fn: "
457 "failed to store new record for [%s]!\n",
466 static WERROR regdb_store_regdb_version(struct db_context *db, uint32_t version)
470 return WERR_CAN_NOT_COMPLETE;
473 status = dbwrap_trans_store_int32(db, REGDB_VERSION_KEYNAME, version);
474 if (!NT_STATUS_IS_OK(status)) {
475 DEBUG(1, ("regdb_store_regdb_version: error storing %s = %d: %s\n",
476 REGDB_VERSION_KEYNAME, version, nt_errstr(status)));
477 return ntstatus_to_werror(status);
479 DEBUG(10, ("regdb_store_regdb_version: stored %s = %d\n",
480 REGDB_VERSION_KEYNAME, version));
485 static WERROR regdb_upgrade_v1_to_v2(struct db_context *db)
491 mem_ctx = talloc_stackframe();
493 rc = db->traverse(db, regdb_normalize_keynames_fn, db);
495 talloc_free(mem_ctx);
498 return WERR_REG_IO_FAILURE;
501 werr = regdb_store_regdb_version(db, REGVER_V2);
505 static int regdb_upgrade_v2_to_v3_fn(struct db_record *rec, void *private_data)
512 uint32_t buflen, len;
515 struct db_context *db = (struct db_context *)private_data;
517 if (rec->key.dptr == NULL || rec->key.dsize == 0) {
522 DEBUG(0, ("regdb_normalize_keynames_fn: ERROR: "
523 "NULL db context handed in via private_data\n"));
527 keyname = (const char *)rec->key.dptr;
529 if (strncmp(keyname, REGDB_VERSION_KEYNAME,
530 strlen(REGDB_VERSION_KEYNAME)) == 0)
535 if (strncmp(keyname, REG_SORTED_SUBKEYS_PREFIX,
536 strlen(REG_SORTED_SUBKEYS_PREFIX)) == 0)
538 /* Delete the deprecated sorted subkeys cache. */
540 DEBUG(10, ("regdb_upgrade_v2_to_v3: deleting [%s]\n", keyname));
542 status = rec->delete_rec(rec);
543 if (!NT_STATUS_IS_OK(status)) {
544 DEBUG(0, ("regdb_upgrade_v2_to_v3: tdb_delete for [%s] "
545 "failed!\n", keyname));
552 if (strncmp(keyname, REG_VALUE_PREFIX, strlen(REG_VALUE_PREFIX)) == 0) {
553 DEBUG(10, ("regdb_upgrade_v2_to_v3: skipping [%s]\n", keyname));
557 if (strncmp(keyname, REG_SECDESC_PREFIX,
558 strlen(REG_SECDESC_PREFIX)) == 0)
560 DEBUG(10, ("regdb_upgrade_v2_to_v3: skipping [%s]\n", keyname));
565 * Found a regular subkey list record.
566 * Walk the list and create the list record for those
567 * subkeys that don't already have one.
569 DEBUG(10, ("regdb_upgrade_v2_to_v3: scanning subkey list of [%s]\n",
572 buf = rec->value.dptr;
573 buflen = rec->value.dsize;
575 len = tdb_unpack(buf, buflen, "d", &num_items);
576 if (len == (uint32_t)-1) {
577 /* invalid or empty - skip */
581 for (i=0; i<num_items; i++) {
582 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
583 DEBUG(10, ("regdb_upgrade_v2_to_v3: "
584 "writing subkey list for [%s\\%s]\n",
585 keyname, subkeyname));
586 werr = regdb_store_subkey_list(db, keyname, subkeyname);
587 if (!W_ERROR_IS_OK(werr)) {
595 static WERROR regdb_upgrade_v2_to_v3(struct db_context *db)
600 rc = regdb->traverse(db, regdb_upgrade_v2_to_v3_fn, db);
602 werr = WERR_REG_IO_FAILURE;
606 werr = regdb_store_regdb_version(db, REGVER_V3);
612 /***********************************************************************
613 Open the registry database
614 ***********************************************************************/
616 WERROR regdb_init(void)
618 uint32 vers_id, expected_version;
622 DEBUG(10, ("regdb_init: incrementing refcount (%d->%d)\n",
623 regdb_refcount, regdb_refcount+1));
628 regdb = db_open(NULL, state_path("registry.tdb"), 0,
629 REG_TDB_FLAGS, O_RDWR, 0600);
631 regdb = db_open(NULL, state_path("registry.tdb"), 0,
632 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
634 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
635 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
636 state_path("registry.tdb"), strerror(errno) ));
640 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
644 DEBUG(10, ("regdb_init: registry db openend. refcount reset (%d)\n",
647 expected_version = REGVER_V3;
649 vers_id = dbwrap_fetch_int32(regdb, REGDB_VERSION_KEYNAME);
651 DEBUG(10, ("regdb_init: registry version uninitialized "
652 "(got %d), initializing to version %d\n",
653 vers_id, expected_version));
655 werr = regdb_store_regdb_version(regdb, expected_version);
659 if (vers_id > expected_version || vers_id == 0) {
660 DEBUG(0, ("regdb_init: unknown registry version %d "
661 "(code version = %d), refusing initialization\n",
662 vers_id, expected_version));
663 return WERR_CAN_NOT_COMPLETE;
666 if (regdb->transaction_start(regdb) != 0) {
667 return WERR_REG_IO_FAILURE;
670 if (vers_id == REGVER_V1) {
671 DEBUG(10, ("regdb_init: upgrading registry fromversion %d "
672 "to %d\n", REGVER_V1, REGVER_V2));
674 werr = regdb_upgrade_v1_to_v2(regdb);
675 if (!W_ERROR_IS_OK(werr)) {
676 regdb->transaction_cancel(regdb);
683 if (vers_id == REGVER_V2) {
684 DEBUG(10, ("regdb_init: upgrading registry from version %d "
685 "to %d\n", REGVER_V2, REGVER_V3));
687 werr = regdb_upgrade_v2_to_v3(regdb);
688 if (!W_ERROR_IS_OK(werr)) {
689 regdb->transaction_cancel(regdb);
696 /* future upgrade code should go here */
698 if (regdb->transaction_commit(regdb) != 0) {
699 return WERR_REG_IO_FAILURE;
705 /***********************************************************************
706 Open the registry. Must already have been initialized by regdb_init()
707 ***********************************************************************/
709 WERROR regdb_open( void )
711 WERROR result = WERR_OK;
714 DEBUG(10, ("regdb_open: incrementing refcount (%d->%d)\n",
715 regdb_refcount, regdb_refcount+1));
722 regdb = db_open(NULL, state_path("registry.tdb"), 0,
723 REG_TDB_FLAGS, O_RDWR, 0600);
725 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
726 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
727 state_path("registry.tdb"), strerror(errno) ));
733 DEBUG(10, ("regdb_open: registry db opened. refcount reset (%d)\n",
739 /***********************************************************************
740 ***********************************************************************/
742 int regdb_close( void )
744 if (regdb_refcount == 0) {
750 DEBUG(10, ("regdb_close: decrementing refcount (%d->%d)\n",
751 regdb_refcount+1, regdb_refcount));
753 if ( regdb_refcount > 0 )
756 SMB_ASSERT( regdb_refcount >= 0 );
762 WERROR regdb_transaction_start(void)
764 return (regdb->transaction_start(regdb) == 0) ?
765 WERR_OK : WERR_REG_IO_FAILURE;
768 WERROR regdb_transaction_commit(void)
770 return (regdb->transaction_commit(regdb) == 0) ?
771 WERR_OK : WERR_REG_IO_FAILURE;
774 WERROR regdb_transaction_cancel(void)
776 return (regdb->transaction_cancel(regdb) == 0) ?
777 WERR_OK : WERR_REG_IO_FAILURE;
780 /***********************************************************************
781 return the tdb sequence number of the registry tdb.
782 this is an indicator for the content of the registry
783 having changed. it will change upon regdb_init, too, though.
784 ***********************************************************************/
785 int regdb_get_seqnum(void)
787 return regdb->get_seqnum(regdb);
791 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
796 WERROR werr = WERR_NOMEM;
797 TALLOC_CTX *mem_ctx = talloc_stackframe();
799 if (keyname == NULL) {
800 werr = WERR_INVALID_PARAM;
804 if (prefix == NULL) {
805 path = discard_const_p(char, keyname);
807 path = talloc_asprintf(mem_ctx, "%s\\%s", prefix, keyname);
813 path = normalize_reg_path(mem_ctx, path);
818 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
820 /* treat "not found" as ok */
821 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
826 talloc_free(mem_ctx);
831 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
833 return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
836 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
838 return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
841 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
843 return regdb_delete_key_with_prefix(db, keyname, NULL);
847 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
851 werr = regdb_delete_values(db, keyname);
852 if (!W_ERROR_IS_OK(werr)) {
853 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
854 REG_VALUE_PREFIX, keyname, win_errstr(werr)));
858 werr = regdb_delete_secdesc(db, keyname);
859 if (!W_ERROR_IS_OK(werr)) {
860 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
861 REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
865 werr = regdb_delete_subkeylist(db, keyname);
866 if (!W_ERROR_IS_OK(werr)) {
867 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
868 keyname, win_errstr(werr)));
876 /***********************************************************************
877 Add subkey strings to the registry tdb under a defined key
878 fmt is the same format as tdb_pack except this function only supports
880 ***********************************************************************/
882 static WERROR regdb_store_keys_internal2(struct db_context *db,
884 struct regsubkey_ctr *ctr)
887 uint8 *buffer = NULL;
890 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
891 char *keyname = NULL;
892 TALLOC_CTX *ctx = talloc_stackframe();
896 werr = WERR_INVALID_PARAM;
900 keyname = talloc_strdup(ctx, key);
906 keyname = normalize_reg_path(ctx, keyname);
912 /* allocate some initial memory */
914 buffer = (uint8 *)SMB_MALLOC(1024);
915 if (buffer == NULL) {
922 /* store the number of subkeys */
924 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
926 /* pack all the strings */
928 for (i=0; i<num_subkeys; i++) {
931 thistime = tdb_pack(buffer+len, buflen-len, "f",
932 regsubkey_ctr_specific_key(ctr, i));
933 if (len+thistime > buflen) {
936 * tdb_pack hasn't done anything because of the short
937 * buffer, allocate extra space.
939 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
942 DEBUG(0, ("regdb_store_keys: Failed to realloc "
943 "memory of size [%u]\n",
944 (unsigned int)(len+thistime)*2));
948 buflen = (len+thistime)*2;
949 thistime2 = tdb_pack(
950 buffer+len, buflen-len, "f",
951 regsubkey_ctr_specific_key(ctr, i));
952 if (thistime2 != thistime) {
953 DEBUG(0, ("tdb_pack failed\n"));
954 werr = WERR_CAN_NOT_COMPLETE;
961 /* finally write out the data */
965 werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
975 * Utility function to store a new empty list of
976 * subkeys of given key specified as parent and subkey name
977 * (thereby creating the key).
978 * If the parent keyname is NULL, then the "subkey" is
979 * interpreted as a base key.
980 * If the subkey list does already exist, it is not modified.
982 * Must be called from within a transaction.
984 static WERROR regdb_store_subkey_list(struct db_context *db, const char *parent,
989 struct regsubkey_ctr *subkeys = NULL;
990 TALLOC_CTX *frame = talloc_stackframe();
992 if (parent == NULL) {
993 path = talloc_strdup(frame, key);
995 path = talloc_asprintf(frame, "%s\\%s", parent, key);
1002 werr = regsubkey_ctr_init(frame, &subkeys);
1003 W_ERROR_NOT_OK_GOTO_DONE(werr);
1005 werr = regdb_fetch_keys_internal(db, path, subkeys);
1006 if (W_ERROR_IS_OK(werr)) {
1007 /* subkey list exists already - don't modify */
1011 werr = regsubkey_ctr_reinit(subkeys);
1012 W_ERROR_NOT_OK_GOTO_DONE(werr);
1014 /* create a record with 0 subkeys */
1015 werr = regdb_store_keys_internal2(db, path, subkeys);
1016 if (!W_ERROR_IS_OK(werr)) {
1017 DEBUG(0, ("regdb_store_keys: Failed to store new record for "
1018 "key [%s]: %s\n", path, win_errstr(werr)));
1027 /***********************************************************************
1028 Store the new subkey record and create any child key records that
1029 do not currently exist
1030 ***********************************************************************/
1032 struct regdb_store_keys_context {
1034 struct regsubkey_ctr *ctr;
1037 static NTSTATUS regdb_store_keys_action(struct db_context *db,
1040 struct regdb_store_keys_context *store_ctx;
1044 struct regsubkey_ctr *old_subkeys = NULL;
1045 char *oldkeyname = NULL;
1046 TALLOC_CTX *mem_ctx = talloc_stackframe();
1048 store_ctx = (struct regdb_store_keys_context *)private_data;
1051 * Re-fetch the old keys inside the transaction
1054 werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
1055 W_ERROR_NOT_OK_GOTO_DONE(werr);
1057 werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
1058 if (!W_ERROR_IS_OK(werr) &&
1059 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1065 * Make the store operation as safe as possible without transactions:
1067 * (1) For each subkey removed from ctr compared with old_subkeys:
1069 * (a) First delete the value db entry.
1071 * (b) Next delete the secdesc db record.
1073 * (c) Then delete the subkey list entry.
1075 * (2) Now write the list of subkeys of the parent key,
1076 * deleting removed entries and adding new ones.
1078 * (3) Finally create the subkey list entries for the added keys.
1080 * This way if we crash half-way in between deleting the subkeys
1081 * and storing the parent's list of subkeys, no old data can pop up
1082 * out of the blue when re-adding keys later on.
1085 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
1087 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1088 for (i=0; i<num_subkeys; i++) {
1089 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
1091 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
1093 * It's still around, don't delete
1098 path = talloc_asprintf(mem_ctx, "%s\\%s", store_ctx->key,
1105 werr = regdb_delete_key_lists(db, path);
1106 W_ERROR_NOT_OK_GOTO_DONE(werr);
1111 TALLOC_FREE(old_subkeys);
1113 /* (2) store the subkey list for the parent */
1115 werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
1116 if (!W_ERROR_IS_OK(werr)) {
1117 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
1118 "for parent [%s]: %s\n", store_ctx->key,
1123 /* (3) now create records for any subkeys that don't already exist */
1125 num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
1127 for (i=0; i<num_subkeys; i++) {
1130 subkey = regsubkey_ctr_specific_key(store_ctx->ctr, i);
1132 werr = regdb_store_subkey_list(db, store_ctx->key, subkey);
1133 W_ERROR_NOT_OK_GOTO_DONE(werr);
1139 talloc_free(mem_ctx);
1140 return werror_to_ntstatus(werr);
1143 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
1144 struct regsubkey_ctr *ctr)
1146 int num_subkeys, old_num_subkeys, i;
1147 struct regsubkey_ctr *old_subkeys = NULL;
1148 TALLOC_CTX *ctx = talloc_stackframe();
1151 struct regdb_store_keys_context store_ctx;
1153 if (!regdb_key_exists(db, key)) {
1158 * fetch a list of the old subkeys so we can determine if anything has
1162 werr = regsubkey_ctr_init(ctx, &old_subkeys);
1163 if (!W_ERROR_IS_OK(werr)) {
1164 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
1168 werr = regdb_fetch_keys_internal(db, key, old_subkeys);
1169 if (!W_ERROR_IS_OK(werr) &&
1170 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1175 num_subkeys = regsubkey_ctr_numkeys(ctr);
1176 old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1177 if ((num_subkeys && old_num_subkeys) &&
1178 (num_subkeys == old_num_subkeys)) {
1180 for (i = 0; i < num_subkeys; i++) {
1181 if (strcmp(regsubkey_ctr_specific_key(ctr, i),
1182 regsubkey_ctr_specific_key(old_subkeys, i))
1188 if (i == num_subkeys) {
1190 * Nothing changed, no point to even start a tdb
1199 TALLOC_FREE(old_subkeys);
1201 store_ctx.key = key;
1202 store_ctx.ctr = ctr;
1204 werr = ntstatus_to_werror(dbwrap_trans_do(db,
1205 regdb_store_keys_action,
1208 ret = W_ERROR_IS_OK(werr);
1216 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
1218 return regdb_store_keys_internal(regdb, key, ctr);
1222 * create a subkey of a given key
1225 struct regdb_create_subkey_context {
1230 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
1234 struct regdb_create_subkey_context *create_ctx;
1235 struct regsubkey_ctr *subkeys;
1236 TALLOC_CTX *mem_ctx = talloc_stackframe();
1238 create_ctx = (struct regdb_create_subkey_context *)private_data;
1240 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1241 W_ERROR_NOT_OK_GOTO_DONE(werr);
1243 werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
1244 W_ERROR_NOT_OK_GOTO_DONE(werr);
1246 werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
1247 W_ERROR_NOT_OK_GOTO_DONE(werr);
1249 werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
1250 if (!W_ERROR_IS_OK(werr)) {
1251 DEBUG(0, (__location__ " failed to store new subkey list for "
1252 "parent key %s: %s\n", create_ctx->key,
1256 werr = regdb_store_subkey_list(db, create_ctx->key, create_ctx->subkey);
1259 talloc_free(mem_ctx);
1260 return werror_to_ntstatus(werr);
1263 static WERROR regdb_create_subkey_internal(struct db_context *db,
1268 struct regsubkey_ctr *subkeys;
1269 TALLOC_CTX *mem_ctx = talloc_stackframe();
1270 struct regdb_create_subkey_context create_ctx;
1272 if (!regdb_key_exists(db, key)) {
1273 werr = WERR_NOT_FOUND;
1277 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1278 W_ERROR_NOT_OK_GOTO_DONE(werr);
1280 werr = regdb_fetch_keys_internal(db, key, subkeys);
1281 W_ERROR_NOT_OK_GOTO_DONE(werr);
1283 if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1288 talloc_free(subkeys);
1290 create_ctx.key = key;
1291 create_ctx.subkey = subkey;
1293 werr = ntstatus_to_werror(dbwrap_trans_do(db,
1294 regdb_create_subkey_action,
1298 talloc_free(mem_ctx);
1302 static WERROR regdb_create_subkey(const char *key, const char *subkey)
1304 return regdb_create_subkey_internal(regdb, key, subkey);
1311 struct regdb_create_basekey_context {
1315 static NTSTATUS regdb_create_basekey_action(struct db_context *db,
1319 struct regdb_create_basekey_context *create_ctx;
1321 create_ctx = (struct regdb_create_basekey_context *)private_data;
1323 werr = regdb_store_subkey_list(db, NULL, create_ctx->key);
1325 return werror_to_ntstatus(werr);
1328 static WERROR regdb_create_basekey(struct db_context *db, const char *key)
1331 struct regdb_create_subkey_context create_ctx;
1333 create_ctx.key = key;
1335 werr = ntstatus_to_werror(dbwrap_trans_do(db,
1336 regdb_create_basekey_action,
1343 * create a subkey of a given key
1346 struct regdb_delete_subkey_context {
1353 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1357 struct regdb_delete_subkey_context *delete_ctx;
1358 struct regsubkey_ctr *subkeys;
1359 TALLOC_CTX *mem_ctx = talloc_stackframe();
1361 delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1363 werr = regdb_delete_key_lists(db, delete_ctx->path);
1364 W_ERROR_NOT_OK_GOTO_DONE(werr);
1366 if (delete_ctx->lazy) {
1370 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1371 W_ERROR_NOT_OK_GOTO_DONE(werr);
1373 werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1374 W_ERROR_NOT_OK_GOTO_DONE(werr);
1376 werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1377 W_ERROR_NOT_OK_GOTO_DONE(werr);
1379 werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1380 if (!W_ERROR_IS_OK(werr)) {
1381 DEBUG(0, (__location__ " failed to store new subkey_list for "
1382 "parent key %s: %s\n", delete_ctx->key,
1387 talloc_free(mem_ctx);
1388 return werror_to_ntstatus(werr);
1391 static WERROR regdb_delete_subkey(const char *key, const char *subkey, bool lazy)
1395 struct regdb_delete_subkey_context delete_ctx;
1396 TALLOC_CTX *mem_ctx = talloc_stackframe();
1398 if (!regdb_key_exists(regdb, key)) {
1399 werr = WERR_NOT_FOUND;
1403 path = talloc_asprintf(mem_ctx, "%s\\%s", key, subkey);
1409 if (!regdb_key_exists(regdb, path)) {
1414 delete_ctx.key = key;
1415 delete_ctx.subkey = subkey;
1416 delete_ctx.path = path;
1417 delete_ctx.lazy = lazy;
1419 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1420 regdb_delete_subkey_action,
1424 talloc_free(mem_ctx);
1428 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1429 TALLOC_CTX *mem_ctx, const char *key)
1434 path = normalize_reg_path(mem_ctx, key);
1436 return make_tdb_data(NULL, 0);
1439 data = dbwrap_fetch_bystring(db, mem_ctx, path);
1447 * Check for the existence of a key.
1449 * Existence of a key is authoritatively defined by
1450 * the existence of the record that contains the list
1453 * Return false, if the record does not match the correct
1454 * structure of an initial 4-byte counter and then a
1455 * list of the corresponding number of zero-terminated
1458 static bool regdb_key_exists(struct db_context *db, const char *key)
1460 TALLOC_CTX *mem_ctx = talloc_stackframe();
1466 uint32_t num_items, i;
1473 path = normalize_reg_path(mem_ctx, key);
1475 DEBUG(0, ("out of memory! (talloc failed)\n"));
1479 if (*path == '\0') {
1483 value = regdb_fetch_key_internal(db, mem_ctx, path);
1484 if (value.dptr == NULL) {
1488 if (value.dsize == 0) {
1489 DEBUG(10, ("regdb_key_exists: subkeylist-record for key "
1490 "[%s] is empty: Could be a deleted record in a "
1491 "clustered (ctdb) environment?\n",
1496 len = tdb_unpack(value.dptr, value.dsize, "d", &num_items);
1497 if (len == (int32_t)-1) {
1498 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1499 "[%s] is invalid: Could not parse initial 4-byte "
1500 "counter. record data length is %u.\n",
1501 path, (unsigned int)value.dsize));
1506 * Note: the tdb_unpack check above implies that len <= value.dsize
1508 buflen = value.dsize - len;
1509 buf = (const char *)value.dptr + len;
1513 for (i = 0; i < num_items; i++) {
1517 len = strnlen(buf, buflen) + 1;
1519 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record "
1520 "for key [%s] is corrupt: %u items expected, "
1521 "item number %u is not zero terminated.\n",
1522 path, num_items, i+1));
1531 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1532 "[%s] is corrupt: %u items expected and found, but "
1533 "the record contains additional %u bytes\n",
1534 path, num_items, buflen));
1538 if (i < num_items) {
1539 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1540 "[%s] is corrupt: %u items expected, but only %u "
1542 path, num_items, i+1));
1549 TALLOC_FREE(mem_ctx);
1554 /***********************************************************************
1555 Retrieve an array of strings containing subkeys. Memory should be
1556 released by the caller.
1557 ***********************************************************************/
1559 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1560 struct regsubkey_ctr *ctr)
1568 TALLOC_CTX *frame = talloc_stackframe();
1571 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
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_reinit(ctr);
1580 W_ERROR_NOT_OK_GOTO_DONE(werr);
1582 werr = regsubkey_ctr_set_seqnum(ctr, db->get_seqnum(db));
1583 W_ERROR_NOT_OK_GOTO_DONE(werr);
1585 value = regdb_fetch_key_internal(db, frame, key);
1587 if (value.dsize == 0 || value.dptr == NULL) {
1588 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1594 buflen = value.dsize;
1595 len = tdb_unpack( buf, buflen, "d", &num_items);
1596 if (len == (uint32_t)-1) {
1597 werr = WERR_NOT_FOUND;
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 regval_ctr_addvalue(values, valuename, type,
1663 (uint8_t *)data_p, size);
1664 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1666 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1672 /****************************************************************************
1673 Pack all values in all printer keys
1674 ***************************************************************************/
1676 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1680 struct regval_blob *val;
1686 num_values = regval_ctr_numvals( values );
1688 /* pack the number of values first */
1690 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1692 /* loop over all values */
1694 for ( i=0; i<num_values; i++ ) {
1695 val = regval_ctr_specific_value( values, i );
1696 len += tdb_pack(buf+len, buflen-len, "fdB",
1700 regval_data_p(val) );
1706 /***********************************************************************
1707 Retrieve an array of strings containing subkeys. Memory should be
1708 released by the caller.
1709 ***********************************************************************/
1711 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1712 struct regval_ctr *values)
1714 char *keystr = NULL;
1715 TALLOC_CTX *ctx = talloc_stackframe();
1720 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1722 if (!regdb_key_exists(db, key)) {
1726 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key);
1731 werr = regval_ctr_set_seqnum(values, db->get_seqnum(db));
1732 W_ERROR_NOT_OK_GOTO_DONE(werr);
1734 value = regdb_fetch_key_internal(db, ctx, keystr);
1737 /* all keys have zero values by default */
1741 regdb_unpack_values(values, value.dptr, value.dsize);
1742 ret = regval_ctr_numvals(values);
1749 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1751 return regdb_fetch_values_internal(regdb, key, values);
1754 static bool regdb_store_values_internal(struct db_context *db, const char *key,
1755 struct regval_ctr *values)
1757 TDB_DATA old_data, data;
1758 char *keystr = NULL;
1759 TALLOC_CTX *ctx = talloc_stackframe();
1762 bool result = false;
1764 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1766 if (!regdb_key_exists(db, key)) {
1772 len = regdb_pack_values(values, data.dptr, data.dsize);
1774 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1778 data.dptr = talloc_array(ctx, uint8, len);
1781 len = regdb_pack_values(values, data.dptr, data.dsize);
1783 SMB_ASSERT( len == data.dsize );
1785 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key );
1789 keystr = normalize_reg_path(ctx, keystr);
1794 old_data = dbwrap_fetch_bystring(db, ctx, keystr);
1796 if ((old_data.dptr != NULL)
1797 && (old_data.dsize == data.dsize)
1798 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1804 status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1806 result = NT_STATUS_IS_OK(status);
1813 bool regdb_store_values(const char *key, struct regval_ctr *values)
1815 return regdb_store_values_internal(regdb, key, values);
1818 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1819 struct security_descriptor **psecdesc)
1824 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1825 WERROR err = WERR_OK;
1827 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1829 if (!regdb_key_exists(regdb, key)) {
1834 tdbkey = talloc_asprintf(tmp_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1835 if (tdbkey == NULL) {
1840 tdbkey = normalize_reg_path(tmp_ctx, tdbkey);
1841 if (tdbkey == NULL) {
1846 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1847 if (data.dptr == NULL) {
1852 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1855 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1857 } else if (!NT_STATUS_IS_OK(status)) {
1858 err = WERR_REG_CORRUPT;
1862 TALLOC_FREE(tmp_ctx);
1866 static WERROR regdb_set_secdesc(const char *key,
1867 struct security_descriptor *secdesc)
1869 TALLOC_CTX *mem_ctx = talloc_stackframe();
1871 WERROR err = WERR_NOMEM;
1874 if (!regdb_key_exists(regdb, key)) {
1879 tdbkey = talloc_asprintf(mem_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1880 if (tdbkey == NULL) {
1884 tdbkey = normalize_reg_path(mem_ctx, tdbkey);
1885 if (tdbkey == NULL) {
1890 if (secdesc == NULL) {
1891 /* assuming a delete */
1892 err = ntstatus_to_werror(dbwrap_trans_delete_bystring(regdb,
1897 err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1900 W_ERROR_NOT_OK_GOTO_DONE(err);
1902 err = ntstatus_to_werror(dbwrap_trans_store_bystring(regdb, tdbkey,
1906 TALLOC_FREE(mem_ctx);
1910 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1912 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1915 bool regdb_values_need_update(struct regval_ctr *values)
1917 return (regdb_get_seqnum() != regval_ctr_get_seqnum(values));
1921 * Table of function pointers for default access
1924 struct registry_ops regdb_ops = {
1925 .fetch_subkeys = regdb_fetch_keys,
1926 .fetch_values = regdb_fetch_values,
1927 .store_subkeys = regdb_store_keys,
1928 .store_values = regdb_store_values,
1929 .create_subkey = regdb_create_subkey,
1930 .delete_subkey = regdb_delete_subkey,
1931 .get_secdesc = regdb_get_secdesc,
1932 .set_secdesc = regdb_set_secdesc,
1933 .subkeys_need_update = regdb_subkeys_need_update,
1934 .values_need_update = regdb_values_need_update