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 NTSTATUS 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 != REGDB_CODE_VERSION) {
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, REGDB_CODE_VERSION));
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 regdb_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 status = regdb_store_values_internal(db,
339 builtin_registry_values[i].path,
341 if (!NT_STATUS_IS_OK(status)) {
348 status = NT_STATUS_OK;
356 WERROR init_registry_data(void)
359 TALLOC_CTX *frame = talloc_stackframe();
360 struct regval_ctr *values;
364 * First, check for the existence of the needed keys and values.
365 * If all do already exist, we can save the writes.
367 for (i=0; builtin_registry_paths[i] != NULL; i++) {
368 if (!regdb_key_exists(regdb, builtin_registry_paths[i])) {
373 for (i=0; builtin_registry_values[i].path != NULL; i++) {
374 werr = regval_ctr_init(frame, &values);
375 W_ERROR_NOT_OK_GOTO_DONE(werr);
377 regdb_fetch_values_internal(regdb,
378 builtin_registry_values[i].path,
380 if (!regval_ctr_key_exists(values,
381 builtin_registry_values[i].valuename))
396 * There are potentially quite a few store operations which are all
397 * indiviually wrapped in tdb transactions. Wrapping them in a single
398 * transaction gives just a single transaction_commit() to actually do
399 * its fsync()s. See tdb/common/transaction.c for info about nested
400 * transaction behaviour.
403 werr = regdb_trans_do(regdb,
404 init_registry_data_action,
412 static int regdb_normalize_keynames_fn(struct db_record *rec,
415 TALLOC_CTX *mem_ctx = talloc_tos();
420 struct db_context *db = (struct db_context *)private_data;
422 key = dbwrap_record_get_key(rec);
423 if (key.dptr == NULL || key.dsize == 0) {
427 value = dbwrap_record_get_value(rec);
430 DEBUG(0, ("regdb_normalize_keynames_fn: ERROR: "
431 "NULL db context handed in via private_data\n"));
435 if (strncmp((const char *)key.dptr, REGDB_VERSION_KEYNAME,
436 strlen(REGDB_VERSION_KEYNAME)) == 0)
441 keyname = strchr((const char *)key.dptr, '/');
443 keyname = talloc_string_sub(mem_ctx,
444 (const char *)key.dptr,
448 DEBUG(2, ("regdb_normalize_keynames_fn: Convert %s to %s\n",
449 (const char *)key.dptr,
452 /* Delete the original record and store the normalized key */
453 status = dbwrap_record_delete(rec);
454 if (!NT_STATUS_IS_OK(status)) {
455 DEBUG(0,("regdb_normalize_keynames_fn: "
456 "tdb_delete for [%s] failed!\n",
457 (const char *)key.dptr));
461 status = dbwrap_store_bystring(db, keyname, value, TDB_REPLACE);
462 if (!NT_STATUS_IS_OK(status)) {
463 DEBUG(0,("regdb_normalize_keynames_fn: "
464 "failed to store new record for [%s]!\n",
473 static WERROR regdb_store_regdb_version(struct db_context *db, uint32_t version)
477 return WERR_CAN_NOT_COMPLETE;
480 status = dbwrap_trans_store_int32(db, REGDB_VERSION_KEYNAME, version);
481 if (!NT_STATUS_IS_OK(status)) {
482 DEBUG(1, ("regdb_store_regdb_version: error storing %s = %d: %s\n",
483 REGDB_VERSION_KEYNAME, version, nt_errstr(status)));
484 return ntstatus_to_werror(status);
486 DEBUG(10, ("regdb_store_regdb_version: stored %s = %d\n",
487 REGDB_VERSION_KEYNAME, version));
492 static WERROR regdb_upgrade_v1_to_v2(struct db_context *db)
498 mem_ctx = talloc_stackframe();
500 status = dbwrap_traverse(db, regdb_normalize_keynames_fn, db, NULL);
501 if (!NT_STATUS_IS_OK(status)) {
502 werr = WERR_REG_IO_FAILURE;
506 werr = regdb_store_regdb_version(db, REGDB_VERSION_V2);
509 talloc_free(mem_ctx);
513 static int regdb_upgrade_v2_to_v3_fn(struct db_record *rec, void *private_data)
520 uint32_t buflen, len;
525 struct db_context *db = (struct db_context *)private_data;
527 key = dbwrap_record_get_key(rec);
528 if (key.dptr == NULL || key.dsize == 0) {
533 DEBUG(0, ("regdb_upgrade_v2_to_v3_fn: ERROR: "
534 "NULL db context handed in via private_data\n"));
538 keyname = (const char *)key.dptr;
540 if (strncmp(keyname, REGDB_VERSION_KEYNAME,
541 strlen(REGDB_VERSION_KEYNAME)) == 0)
546 if (strncmp(keyname, REG_SORTED_SUBKEYS_PREFIX,
547 strlen(REG_SORTED_SUBKEYS_PREFIX)) == 0)
549 /* Delete the deprecated sorted subkeys cache. */
551 DEBUG(10, ("regdb_upgrade_v2_to_v3: deleting [%s]\n", keyname));
553 status = dbwrap_record_delete(rec);
554 if (!NT_STATUS_IS_OK(status)) {
555 DEBUG(0, ("regdb_upgrade_v2_to_v3: tdb_delete for [%s] "
556 "failed!\n", keyname));
563 if (strncmp(keyname, REG_VALUE_PREFIX, strlen(REG_VALUE_PREFIX)) == 0) {
564 DEBUG(10, ("regdb_upgrade_v2_to_v3: skipping [%s]\n", keyname));
568 if (strncmp(keyname, REG_SECDESC_PREFIX,
569 strlen(REG_SECDESC_PREFIX)) == 0)
571 DEBUG(10, ("regdb_upgrade_v2_to_v3: skipping [%s]\n", keyname));
576 * Found a regular subkey list record.
577 * Walk the list and create the list record for those
578 * subkeys that don't already have one.
580 DEBUG(10, ("regdb_upgrade_v2_to_v3: scanning subkey list of [%s]\n",
583 value = dbwrap_record_get_value(rec);
585 buflen = value.dsize;
587 len = tdb_unpack(buf, buflen, "d", &num_items);
588 if (len == (uint32_t)-1) {
589 /* invalid or empty - skip */
593 for (i=0; i<num_items; i++) {
594 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
595 DEBUG(10, ("regdb_upgrade_v2_to_v3: "
596 "writing subkey list for [%s\\%s]\n",
597 keyname, subkeyname));
598 werr = regdb_store_subkey_list(db, keyname, subkeyname);
599 if (!W_ERROR_IS_OK(werr)) {
607 static WERROR regdb_upgrade_v2_to_v3(struct db_context *db)
612 status = dbwrap_traverse(db, regdb_upgrade_v2_to_v3_fn, db, NULL);
613 if (!NT_STATUS_IS_OK(status)) {
614 werr = WERR_REG_IO_FAILURE;
618 werr = regdb_store_regdb_version(db, REGDB_VERSION_V3);
624 /***********************************************************************
625 Open the registry database
626 ***********************************************************************/
628 WERROR regdb_init(void)
634 DEBUG(10, ("regdb_init: incrementing refcount (%d->%d)\n",
635 regdb_refcount, regdb_refcount+1));
640 regdb = db_open(NULL, state_path("registry.tdb"), 0,
641 REG_TDB_FLAGS, O_RDWR, 0600);
643 regdb = db_open(NULL, state_path("registry.tdb"), 0,
644 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
646 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
647 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
648 state_path("registry.tdb"), strerror(errno) ));
652 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
656 DEBUG(10, ("regdb_init: registry db openend. refcount reset (%d)\n",
659 vers_id = dbwrap_fetch_int32(regdb, REGDB_VERSION_KEYNAME);
661 DEBUG(10, ("regdb_init: registry version uninitialized "
662 "(got %d), initializing to version %d\n",
663 vers_id, REGDB_CODE_VERSION));
665 werr = regdb_store_regdb_version(regdb, REGDB_CODE_VERSION);
669 if (vers_id > REGDB_CODE_VERSION || vers_id == 0) {
670 DEBUG(0, ("regdb_init: unknown registry version %d "
671 "(code version = %d), refusing initialization\n",
672 vers_id, REGDB_CODE_VERSION));
673 return WERR_CAN_NOT_COMPLETE;
676 if (dbwrap_transaction_start(regdb) != 0) {
677 return WERR_REG_IO_FAILURE;
680 if (vers_id == REGDB_VERSION_V1) {
681 DEBUG(10, ("regdb_init: upgrading registry from version %d "
682 "to %d\n", REGDB_VERSION_V1, REGDB_VERSION_V2));
684 werr = regdb_upgrade_v1_to_v2(regdb);
685 if (!W_ERROR_IS_OK(werr)) {
686 dbwrap_transaction_cancel(regdb);
690 vers_id = REGDB_VERSION_V2;
693 if (vers_id == REGDB_VERSION_V2) {
694 DEBUG(10, ("regdb_init: upgrading registry from version %d "
695 "to %d\n", REGDB_VERSION_V2, REGDB_VERSION_V3));
697 werr = regdb_upgrade_v2_to_v3(regdb);
698 if (!W_ERROR_IS_OK(werr)) {
699 dbwrap_transaction_cancel(regdb);
703 vers_id = REGDB_VERSION_V3;
706 /* future upgrade code should go here */
708 if (dbwrap_transaction_commit(regdb) != 0) {
709 return WERR_REG_IO_FAILURE;
715 /***********************************************************************
716 Open the registry. Must already have been initialized by regdb_init()
717 ***********************************************************************/
719 WERROR regdb_open( void )
721 WERROR result = WERR_OK;
724 DEBUG(10, ("regdb_open: incrementing refcount (%d->%d)\n",
725 regdb_refcount, regdb_refcount+1));
732 regdb = db_open(NULL, state_path("registry.tdb"), 0,
733 REG_TDB_FLAGS, O_RDWR, 0600);
735 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
736 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
737 state_path("registry.tdb"), strerror(errno) ));
743 DEBUG(10, ("regdb_open: registry db opened. refcount reset (%d)\n",
749 /***********************************************************************
750 ***********************************************************************/
752 int regdb_close( void )
754 if (regdb_refcount == 0) {
760 DEBUG(10, ("regdb_close: decrementing refcount (%d->%d)\n",
761 regdb_refcount+1, regdb_refcount));
763 if ( regdb_refcount > 0 )
766 SMB_ASSERT( regdb_refcount >= 0 );
772 WERROR regdb_transaction_start(void)
774 return (dbwrap_transaction_start(regdb) == 0) ?
775 WERR_OK : WERR_REG_IO_FAILURE;
778 WERROR regdb_transaction_commit(void)
780 return (dbwrap_transaction_commit(regdb) == 0) ?
781 WERR_OK : WERR_REG_IO_FAILURE;
784 WERROR regdb_transaction_cancel(void)
786 return (dbwrap_transaction_cancel(regdb) == 0) ?
787 WERR_OK : WERR_REG_IO_FAILURE;
790 /***********************************************************************
791 return the tdb sequence number of the registry tdb.
792 this is an indicator for the content of the registry
793 having changed. it will change upon regdb_init, too, though.
794 ***********************************************************************/
795 int regdb_get_seqnum(void)
797 return dbwrap_get_seqnum(regdb);
801 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
806 WERROR werr = WERR_NOMEM;
807 TALLOC_CTX *mem_ctx = talloc_stackframe();
809 if (keyname == NULL) {
810 werr = WERR_INVALID_PARAM;
814 if (prefix == NULL) {
815 path = discard_const_p(char, keyname);
817 path = talloc_asprintf(mem_ctx, "%s\\%s", prefix, keyname);
823 path = normalize_reg_path(mem_ctx, path);
828 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
830 /* treat "not found" as ok */
831 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
836 talloc_free(mem_ctx);
841 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
843 return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
846 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
848 return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
851 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
853 return regdb_delete_key_with_prefix(db, keyname, NULL);
857 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
861 werr = regdb_delete_values(db, keyname);
862 if (!W_ERROR_IS_OK(werr)) {
863 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
864 REG_VALUE_PREFIX, keyname, win_errstr(werr)));
868 werr = regdb_delete_secdesc(db, keyname);
869 if (!W_ERROR_IS_OK(werr)) {
870 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
871 REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
875 werr = regdb_delete_subkeylist(db, keyname);
876 if (!W_ERROR_IS_OK(werr)) {
877 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
878 keyname, win_errstr(werr)));
886 /***********************************************************************
887 Add subkey strings to the registry tdb under a defined key
888 fmt is the same format as tdb_pack except this function only supports
890 ***********************************************************************/
892 static WERROR regdb_store_keys_internal2(struct db_context *db,
894 struct regsubkey_ctr *ctr)
897 uint8 *buffer = NULL;
900 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
901 char *keyname = NULL;
902 TALLOC_CTX *ctx = talloc_stackframe();
906 werr = WERR_INVALID_PARAM;
910 keyname = talloc_strdup(ctx, key);
916 keyname = normalize_reg_path(ctx, keyname);
922 /* allocate some initial memory */
924 buffer = (uint8 *)SMB_MALLOC(1024);
925 if (buffer == NULL) {
932 /* store the number of subkeys */
934 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
936 /* pack all the strings */
938 for (i=0; i<num_subkeys; i++) {
941 thistime = tdb_pack(buffer+len, buflen-len, "f",
942 regsubkey_ctr_specific_key(ctr, i));
943 if (len+thistime > buflen) {
946 * tdb_pack hasn't done anything because of the short
947 * buffer, allocate extra space.
949 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
952 DEBUG(0, ("regdb_store_keys: Failed to realloc "
953 "memory of size [%u]\n",
954 (unsigned int)(len+thistime)*2));
958 buflen = (len+thistime)*2;
959 thistime2 = tdb_pack(
960 buffer+len, buflen-len, "f",
961 regsubkey_ctr_specific_key(ctr, i));
962 if (thistime2 != thistime) {
963 DEBUG(0, ("tdb_pack failed\n"));
964 werr = WERR_CAN_NOT_COMPLETE;
971 /* finally write out the data */
975 werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
985 * Utility function to store a new empty list of
986 * subkeys of given key specified as parent and subkey name
987 * (thereby creating the key).
988 * If the parent keyname is NULL, then the "subkey" is
989 * interpreted as a base key.
990 * If the subkey list does already exist, it is not modified.
992 * Must be called from within a transaction.
994 static WERROR regdb_store_subkey_list(struct db_context *db, const char *parent,
999 struct regsubkey_ctr *subkeys = NULL;
1000 TALLOC_CTX *frame = talloc_stackframe();
1002 if (parent == NULL) {
1003 path = talloc_strdup(frame, key);
1005 path = talloc_asprintf(frame, "%s\\%s", parent, key);
1012 werr = regsubkey_ctr_init(frame, &subkeys);
1013 W_ERROR_NOT_OK_GOTO_DONE(werr);
1015 werr = regdb_fetch_keys_internal(db, path, subkeys);
1016 if (W_ERROR_IS_OK(werr)) {
1017 /* subkey list exists already - don't modify */
1021 werr = regsubkey_ctr_reinit(subkeys);
1022 W_ERROR_NOT_OK_GOTO_DONE(werr);
1024 /* create a record with 0 subkeys */
1025 werr = regdb_store_keys_internal2(db, path, subkeys);
1026 if (!W_ERROR_IS_OK(werr)) {
1027 DEBUG(0, ("regdb_store_keys: Failed to store new record for "
1028 "key [%s]: %s\n", path, win_errstr(werr)));
1037 /***********************************************************************
1038 Store the new subkey record and create any child key records that
1039 do not currently exist
1040 ***********************************************************************/
1042 struct regdb_store_keys_context {
1044 struct regsubkey_ctr *ctr;
1047 static NTSTATUS regdb_store_keys_action(struct db_context *db,
1050 struct regdb_store_keys_context *store_ctx;
1054 struct regsubkey_ctr *old_subkeys = NULL;
1055 char *oldkeyname = NULL;
1056 TALLOC_CTX *mem_ctx = talloc_stackframe();
1058 store_ctx = (struct regdb_store_keys_context *)private_data;
1061 * Re-fetch the old keys inside the transaction
1064 werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
1065 W_ERROR_NOT_OK_GOTO_DONE(werr);
1067 werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
1068 if (!W_ERROR_IS_OK(werr) &&
1069 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1075 * Make the store operation as safe as possible without transactions:
1077 * (1) For each subkey removed from ctr compared with old_subkeys:
1079 * (a) First delete the value db entry.
1081 * (b) Next delete the secdesc db record.
1083 * (c) Then delete the subkey list entry.
1085 * (2) Now write the list of subkeys of the parent key,
1086 * deleting removed entries and adding new ones.
1088 * (3) Finally create the subkey list entries for the added keys.
1090 * This way if we crash half-way in between deleting the subkeys
1091 * and storing the parent's list of subkeys, no old data can pop up
1092 * out of the blue when re-adding keys later on.
1095 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
1097 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1098 for (i=0; i<num_subkeys; i++) {
1099 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
1101 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
1103 * It's still around, don't delete
1108 path = talloc_asprintf(mem_ctx, "%s\\%s", store_ctx->key,
1115 werr = regdb_delete_key_lists(db, path);
1116 W_ERROR_NOT_OK_GOTO_DONE(werr);
1121 TALLOC_FREE(old_subkeys);
1123 /* (2) store the subkey list for the parent */
1125 werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
1126 if (!W_ERROR_IS_OK(werr)) {
1127 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
1128 "for parent [%s]: %s\n", store_ctx->key,
1133 /* (3) now create records for any subkeys that don't already exist */
1135 num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
1137 for (i=0; i<num_subkeys; i++) {
1140 subkey = regsubkey_ctr_specific_key(store_ctx->ctr, i);
1142 werr = regdb_store_subkey_list(db, store_ctx->key, subkey);
1143 W_ERROR_NOT_OK_GOTO_DONE(werr);
1149 talloc_free(mem_ctx);
1150 return werror_to_ntstatus(werr);
1153 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
1154 struct regsubkey_ctr *ctr)
1156 int num_subkeys, old_num_subkeys, i;
1157 struct regsubkey_ctr *old_subkeys = NULL;
1158 TALLOC_CTX *ctx = talloc_stackframe();
1161 struct regdb_store_keys_context store_ctx;
1163 if (!regdb_key_exists(db, key)) {
1168 * fetch a list of the old subkeys so we can determine if anything has
1172 werr = regsubkey_ctr_init(ctx, &old_subkeys);
1173 if (!W_ERROR_IS_OK(werr)) {
1174 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
1178 werr = regdb_fetch_keys_internal(db, key, old_subkeys);
1179 if (!W_ERROR_IS_OK(werr) &&
1180 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1185 num_subkeys = regsubkey_ctr_numkeys(ctr);
1186 old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1187 if ((num_subkeys && old_num_subkeys) &&
1188 (num_subkeys == old_num_subkeys)) {
1190 for (i = 0; i < num_subkeys; i++) {
1191 if (strcmp(regsubkey_ctr_specific_key(ctr, i),
1192 regsubkey_ctr_specific_key(old_subkeys, i))
1198 if (i == num_subkeys) {
1200 * Nothing changed, no point to even start a tdb
1209 TALLOC_FREE(old_subkeys);
1211 store_ctx.key = key;
1212 store_ctx.ctr = ctr;
1214 werr = regdb_trans_do(db,
1215 regdb_store_keys_action,
1218 ret = W_ERROR_IS_OK(werr);
1226 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
1228 return regdb_store_keys_internal(regdb, key, ctr);
1232 * create a subkey of a given key
1235 struct regdb_create_subkey_context {
1240 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
1244 struct regdb_create_subkey_context *create_ctx;
1245 struct regsubkey_ctr *subkeys;
1246 TALLOC_CTX *mem_ctx = talloc_stackframe();
1248 create_ctx = (struct regdb_create_subkey_context *)private_data;
1250 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1251 W_ERROR_NOT_OK_GOTO_DONE(werr);
1253 werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
1254 W_ERROR_NOT_OK_GOTO_DONE(werr);
1256 werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
1257 W_ERROR_NOT_OK_GOTO_DONE(werr);
1259 werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
1260 if (!W_ERROR_IS_OK(werr)) {
1261 DEBUG(0, (__location__ " failed to store new subkey list for "
1262 "parent key %s: %s\n", create_ctx->key,
1266 werr = regdb_store_subkey_list(db, create_ctx->key, create_ctx->subkey);
1269 talloc_free(mem_ctx);
1270 return werror_to_ntstatus(werr);
1273 static WERROR regdb_create_subkey_internal(struct db_context *db,
1278 struct regsubkey_ctr *subkeys;
1279 TALLOC_CTX *mem_ctx = talloc_stackframe();
1280 struct regdb_create_subkey_context create_ctx;
1282 if (!regdb_key_exists(db, key)) {
1283 werr = WERR_NOT_FOUND;
1287 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1288 W_ERROR_NOT_OK_GOTO_DONE(werr);
1290 werr = regdb_fetch_keys_internal(db, key, subkeys);
1291 W_ERROR_NOT_OK_GOTO_DONE(werr);
1293 if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1298 talloc_free(subkeys);
1300 create_ctx.key = key;
1301 create_ctx.subkey = subkey;
1303 werr = regdb_trans_do(db,
1304 regdb_create_subkey_action,
1308 talloc_free(mem_ctx);
1312 static WERROR regdb_create_subkey(const char *key, const char *subkey)
1314 return regdb_create_subkey_internal(regdb, key, subkey);
1321 struct regdb_create_basekey_context {
1325 static NTSTATUS regdb_create_basekey_action(struct db_context *db,
1329 struct regdb_create_basekey_context *create_ctx;
1331 create_ctx = (struct regdb_create_basekey_context *)private_data;
1333 werr = regdb_store_subkey_list(db, NULL, create_ctx->key);
1335 return werror_to_ntstatus(werr);
1338 static WERROR regdb_create_basekey(struct db_context *db, const char *key)
1341 struct regdb_create_subkey_context create_ctx;
1343 create_ctx.key = key;
1345 werr = regdb_trans_do(db,
1346 regdb_create_basekey_action,
1353 * create a subkey of a given key
1356 struct regdb_delete_subkey_context {
1363 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1367 struct regdb_delete_subkey_context *delete_ctx;
1368 struct regsubkey_ctr *subkeys;
1369 TALLOC_CTX *mem_ctx = talloc_stackframe();
1371 delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1373 werr = regdb_delete_key_lists(db, delete_ctx->path);
1374 W_ERROR_NOT_OK_GOTO_DONE(werr);
1376 if (delete_ctx->lazy) {
1380 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1381 W_ERROR_NOT_OK_GOTO_DONE(werr);
1383 werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1384 W_ERROR_NOT_OK_GOTO_DONE(werr);
1386 werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1387 W_ERROR_NOT_OK_GOTO_DONE(werr);
1389 werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1390 if (!W_ERROR_IS_OK(werr)) {
1391 DEBUG(0, (__location__ " failed to store new subkey_list for "
1392 "parent key %s: %s\n", delete_ctx->key,
1397 talloc_free(mem_ctx);
1398 return werror_to_ntstatus(werr);
1401 static WERROR regdb_delete_subkey(const char *key, const char *subkey, bool lazy)
1405 struct regdb_delete_subkey_context delete_ctx;
1406 TALLOC_CTX *mem_ctx = talloc_stackframe();
1408 if (!regdb_key_exists(regdb, key)) {
1409 werr = WERR_NOT_FOUND;
1413 path = talloc_asprintf(mem_ctx, "%s\\%s", key, subkey);
1419 if (!regdb_key_exists(regdb, path)) {
1424 delete_ctx.key = key;
1425 delete_ctx.subkey = subkey;
1426 delete_ctx.path = path;
1427 delete_ctx.lazy = lazy;
1429 werr = regdb_trans_do(regdb,
1430 regdb_delete_subkey_action,
1434 talloc_free(mem_ctx);
1438 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1439 TALLOC_CTX *mem_ctx, const char *key)
1445 path = normalize_reg_path(mem_ctx, key);
1447 return make_tdb_data(NULL, 0);
1450 status = dbwrap_fetch_bystring(db, mem_ctx, path, &data);
1451 if (!NT_STATUS_IS_OK(status)) {
1461 * Check for the existence of a key.
1463 * Existence of a key is authoritatively defined by
1464 * the existence of the record that contains the list
1467 * Return false, if the record does not match the correct
1468 * structure of an initial 4-byte counter and then a
1469 * list of the corresponding number of zero-terminated
1472 static bool regdb_key_exists(struct db_context *db, const char *key)
1474 TALLOC_CTX *mem_ctx = talloc_stackframe();
1480 uint32_t num_items, i;
1487 path = normalize_reg_path(mem_ctx, key);
1489 DEBUG(0, ("out of memory! (talloc failed)\n"));
1493 if (*path == '\0') {
1497 value = regdb_fetch_key_internal(db, mem_ctx, path);
1498 if (value.dptr == NULL) {
1502 if (value.dsize == 0) {
1503 DEBUG(10, ("regdb_key_exists: subkeylist-record for key "
1504 "[%s] is empty: Could be a deleted record in a "
1505 "clustered (ctdb) environment?\n",
1510 len = tdb_unpack(value.dptr, value.dsize, "d", &num_items);
1511 if (len == (int32_t)-1) {
1512 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1513 "[%s] is invalid: Could not parse initial 4-byte "
1514 "counter. record data length is %u.\n",
1515 path, (unsigned int)value.dsize));
1520 * Note: the tdb_unpack check above implies that len <= value.dsize
1522 buflen = value.dsize - len;
1523 buf = (const char *)value.dptr + len;
1527 for (i = 0; i < num_items; i++) {
1531 len = strnlen(buf, buflen) + 1;
1533 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record "
1534 "for key [%s] is corrupt: %u items expected, "
1535 "item number %u is not zero terminated.\n",
1536 path, num_items, i+1));
1545 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1546 "[%s] is corrupt: %u items expected and found, but "
1547 "the record contains additional %u bytes\n",
1548 path, num_items, buflen));
1552 if (i < num_items) {
1553 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1554 "[%s] is corrupt: %u items expected, but only %u "
1556 path, num_items, i+1));
1563 TALLOC_FREE(mem_ctx);
1568 /***********************************************************************
1569 Retrieve an array of strings containing subkeys. Memory should be
1570 released by the caller.
1571 ***********************************************************************/
1573 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1574 struct regsubkey_ctr *ctr)
1582 TALLOC_CTX *frame = talloc_stackframe();
1585 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1587 if (!regdb_key_exists(db, key)) {
1588 DEBUG(10, ("key [%s] not found\n", key));
1589 werr = WERR_NOT_FOUND;
1593 werr = regsubkey_ctr_reinit(ctr);
1594 W_ERROR_NOT_OK_GOTO_DONE(werr);
1596 werr = regsubkey_ctr_set_seqnum(ctr, dbwrap_get_seqnum(db));
1597 W_ERROR_NOT_OK_GOTO_DONE(werr);
1599 value = regdb_fetch_key_internal(db, frame, key);
1601 if (value.dsize == 0 || value.dptr == NULL) {
1602 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1608 buflen = value.dsize;
1609 len = tdb_unpack( buf, buflen, "d", &num_items);
1610 if (len == (uint32_t)-1) {
1611 werr = WERR_NOT_FOUND;
1615 for (i=0; i<num_items; i++) {
1616 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1617 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1618 if (!W_ERROR_IS_OK(werr)) {
1619 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1620 "failed: %s\n", win_errstr(werr)));
1626 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1633 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1637 werr = regdb_fetch_keys_internal(regdb, key, ctr);
1638 if (!W_ERROR_IS_OK(werr)) {
1642 return regsubkey_ctr_numkeys(ctr);
1645 /****************************************************************************
1646 Unpack a list of registry values frem the TDB
1647 ***************************************************************************/
1649 static int regdb_unpack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1656 uint32 num_values = 0;
1659 /* loop and unpack the rest of the registry values */
1661 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1663 for ( i=0; i<num_values; i++ ) {
1664 /* unpack the next regval */
1669 valuename[0] = '\0';
1670 len += tdb_unpack(buf+len, buflen-len, "fdB",
1676 regval_ctr_addvalue(values, valuename, type,
1677 (uint8_t *)data_p, size);
1678 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1680 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1686 /****************************************************************************
1687 Pack all values in all printer keys
1688 ***************************************************************************/
1690 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1694 struct regval_blob *val;
1700 num_values = regval_ctr_numvals( values );
1702 /* pack the number of values first */
1704 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1706 /* loop over all values */
1708 for ( i=0; i<num_values; i++ ) {
1709 val = regval_ctr_specific_value( values, i );
1710 len += tdb_pack(buf+len, buflen-len, "fdB",
1714 regval_data_p(val) );
1720 /***********************************************************************
1721 Retrieve an array of strings containing subkeys. Memory should be
1722 released by the caller.
1723 ***********************************************************************/
1725 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1726 struct regval_ctr *values)
1728 char *keystr = NULL;
1729 TALLOC_CTX *ctx = talloc_stackframe();
1734 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1736 if (!regdb_key_exists(db, key)) {
1740 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key);
1745 werr = regval_ctr_set_seqnum(values, dbwrap_get_seqnum(db));
1746 W_ERROR_NOT_OK_GOTO_DONE(werr);
1748 value = regdb_fetch_key_internal(db, ctx, keystr);
1751 /* all keys have zero values by default */
1755 regdb_unpack_values(values, value.dptr, value.dsize);
1756 ret = regval_ctr_numvals(values);
1763 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1765 return regdb_fetch_values_internal(regdb, key, values);
1768 static NTSTATUS regdb_store_values_internal(struct db_context *db,
1770 struct regval_ctr *values)
1772 TDB_DATA old_data, data;
1773 char *keystr = NULL;
1774 TALLOC_CTX *ctx = talloc_stackframe();
1778 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1780 if (!regdb_key_exists(db, key)) {
1781 status = NT_STATUS_NOT_FOUND;
1787 len = regdb_pack_values(values, data.dptr, data.dsize);
1789 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1790 status = NT_STATUS_UNSUCCESSFUL;
1794 data.dptr = talloc_array(ctx, uint8, len);
1797 len = regdb_pack_values(values, data.dptr, data.dsize);
1799 SMB_ASSERT( len == data.dsize );
1801 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key );
1803 status = NT_STATUS_NO_MEMORY;
1806 keystr = normalize_reg_path(ctx, keystr);
1808 status = NT_STATUS_NO_MEMORY;
1812 status = dbwrap_fetch_bystring(db, ctx, keystr, &old_data);
1814 if (NT_STATUS_IS_OK(status)
1815 && (old_data.dptr != NULL)
1816 && (old_data.dsize == data.dsize)
1817 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1819 status = NT_STATUS_OK;
1823 status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1830 struct regdb_store_values_ctx {
1832 struct regval_ctr *values;
1835 static NTSTATUS regdb_store_values_action(struct db_context *db,
1839 struct regdb_store_values_ctx *ctx =
1840 (struct regdb_store_values_ctx *)private_data;
1842 status = regdb_store_values_internal(db, ctx->key, ctx->values);
1847 bool regdb_store_values(const char *key, struct regval_ctr *values)
1850 struct regdb_store_values_ctx ctx;
1853 ctx.values = values;
1855 werr = regdb_trans_do(regdb, regdb_store_values_action, &ctx);
1857 return W_ERROR_IS_OK(werr);
1860 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1861 struct security_descriptor **psecdesc)
1866 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1867 WERROR err = WERR_OK;
1869 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1871 if (!regdb_key_exists(regdb, key)) {
1876 tdbkey = talloc_asprintf(tmp_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1877 if (tdbkey == NULL) {
1882 tdbkey = normalize_reg_path(tmp_ctx, tdbkey);
1883 if (tdbkey == NULL) {
1888 status = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey, &data);
1889 if (!NT_STATUS_IS_OK(status)) {
1894 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1897 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1899 } else if (!NT_STATUS_IS_OK(status)) {
1900 err = WERR_REG_CORRUPT;
1904 TALLOC_FREE(tmp_ctx);
1908 struct regdb_set_secdesc_ctx {
1910 struct security_descriptor *secdesc;
1913 static NTSTATUS regdb_set_secdesc_action(struct db_context *db,
1919 struct regdb_set_secdesc_ctx *ctx =
1920 (struct regdb_set_secdesc_ctx *)private_data;
1921 TALLOC_CTX *frame = talloc_stackframe();
1923 tdbkey = talloc_asprintf(frame, "%s\\%s", REG_SECDESC_PREFIX, ctx->key);
1924 if (tdbkey == NULL) {
1925 status = NT_STATUS_NO_MEMORY;
1929 tdbkey = normalize_reg_path(frame, tdbkey);
1930 if (tdbkey == NULL) {
1931 status = NT_STATUS_NO_MEMORY;
1935 if (ctx->secdesc == NULL) {
1936 /* assuming a delete */
1937 status = dbwrap_delete_bystring(db, tdbkey);
1941 status = marshall_sec_desc(frame, ctx->secdesc, &tdbdata.dptr,
1943 if (!NT_STATUS_IS_OK(status)) {
1947 status = dbwrap_store_bystring(db, tdbkey, tdbdata, 0);
1954 static WERROR regdb_set_secdesc(const char *key,
1955 struct security_descriptor *secdesc)
1958 struct regdb_set_secdesc_ctx ctx;
1960 if (!regdb_key_exists(regdb, key)) {
1966 ctx.secdesc = secdesc;
1968 err = regdb_trans_do(regdb, regdb_set_secdesc_action, &ctx);
1974 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1976 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1979 bool regdb_values_need_update(struct regval_ctr *values)
1981 return (regdb_get_seqnum() != regval_ctr_get_seqnum(values));
1985 * Table of function pointers for default access
1988 struct registry_ops regdb_ops = {
1989 .fetch_subkeys = regdb_fetch_keys,
1990 .fetch_values = regdb_fetch_values,
1991 .store_subkeys = regdb_store_keys,
1992 .store_values = regdb_store_values,
1993 .create_subkey = regdb_create_subkey,
1994 .delete_subkey = regdb_delete_subkey,
1995 .get_secdesc = regdb_get_secdesc,
1996 .set_secdesc = regdb_set_secdesc,
1997 .subkeys_need_update = regdb_subkeys_need_update,
1998 .values_need_update = regdb_values_need_update