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 != 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 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();
418 struct db_context *db = (struct db_context *)private_data;
420 if (rec->key.dptr == NULL || rec->key.dsize == 0) {
425 DEBUG(0, ("regdb_normalize_keynames_fn: ERROR: "
426 "NULL db context handed in via private_data\n"));
430 if (strncmp((const char *)rec->key.dptr, REGDB_VERSION_KEYNAME,
431 strlen(REGDB_VERSION_KEYNAME)) == 0)
436 keyname = strchr((const char *) rec->key.dptr, '/');
438 keyname = talloc_string_sub(mem_ctx,
439 (const char *) rec->key.dptr,
443 DEBUG(2, ("regdb_normalize_keynames_fn: Convert %s to %s\n",
444 (const char *) rec->key.dptr,
447 /* Delete the original record and store the normalized key */
448 status = rec->delete_rec(rec);
449 if (!NT_STATUS_IS_OK(status)) {
450 DEBUG(0,("regdb_normalize_keynames_fn: "
451 "tdb_delete for [%s] failed!\n",
456 status = dbwrap_store_bystring(db, keyname, rec->value,
458 if (!NT_STATUS_IS_OK(status)) {
459 DEBUG(0,("regdb_normalize_keynames_fn: "
460 "failed to store new record for [%s]!\n",
469 static WERROR regdb_store_regdb_version(struct db_context *db, uint32_t version)
473 return WERR_CAN_NOT_COMPLETE;
476 status = dbwrap_trans_store_int32(db, REGDB_VERSION_KEYNAME, version);
477 if (!NT_STATUS_IS_OK(status)) {
478 DEBUG(1, ("regdb_store_regdb_version: error storing %s = %d: %s\n",
479 REGDB_VERSION_KEYNAME, version, nt_errstr(status)));
480 return ntstatus_to_werror(status);
482 DEBUG(10, ("regdb_store_regdb_version: stored %s = %d\n",
483 REGDB_VERSION_KEYNAME, version));
488 static WERROR regdb_upgrade_v1_to_v2(struct db_context *db)
494 mem_ctx = talloc_stackframe();
496 rc = db->traverse(db, regdb_normalize_keynames_fn, db);
498 talloc_free(mem_ctx);
501 return WERR_REG_IO_FAILURE;
504 werr = regdb_store_regdb_version(db, REGVER_V2);
508 static int regdb_upgrade_v2_to_v3_fn(struct db_record *rec, void *private_data)
515 uint32_t buflen, len;
518 struct db_context *db = (struct db_context *)private_data;
520 if (rec->key.dptr == NULL || rec->key.dsize == 0) {
525 DEBUG(0, ("regdb_normalize_keynames_fn: ERROR: "
526 "NULL db context handed in via private_data\n"));
530 keyname = (const char *)rec->key.dptr;
532 if (strncmp(keyname, REGDB_VERSION_KEYNAME,
533 strlen(REGDB_VERSION_KEYNAME)) == 0)
538 if (strncmp(keyname, REG_SORTED_SUBKEYS_PREFIX,
539 strlen(REG_SORTED_SUBKEYS_PREFIX)) == 0)
541 /* Delete the deprecated sorted subkeys cache. */
543 DEBUG(10, ("regdb_upgrade_v2_to_v3: deleting [%s]\n", keyname));
545 status = rec->delete_rec(rec);
546 if (!NT_STATUS_IS_OK(status)) {
547 DEBUG(0, ("regdb_upgrade_v2_to_v3: tdb_delete for [%s] "
548 "failed!\n", keyname));
555 if (strncmp(keyname, REG_VALUE_PREFIX, strlen(REG_VALUE_PREFIX)) == 0) {
556 DEBUG(10, ("regdb_upgrade_v2_to_v3: skipping [%s]\n", keyname));
560 if (strncmp(keyname, REG_SECDESC_PREFIX,
561 strlen(REG_SECDESC_PREFIX)) == 0)
563 DEBUG(10, ("regdb_upgrade_v2_to_v3: skipping [%s]\n", keyname));
568 * Found a regular subkey list record.
569 * Walk the list and create the list record for those
570 * subkeys that don't already have one.
572 DEBUG(10, ("regdb_upgrade_v2_to_v3: scanning subkey list of [%s]\n",
575 buf = rec->value.dptr;
576 buflen = rec->value.dsize;
578 len = tdb_unpack(buf, buflen, "d", &num_items);
579 if (len == (uint32_t)-1) {
580 /* invalid or empty - skip */
584 for (i=0; i<num_items; i++) {
585 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
586 DEBUG(10, ("regdb_upgrade_v2_to_v3: "
587 "writing subkey list for [%s\\%s]\n",
588 keyname, subkeyname));
589 werr = regdb_store_subkey_list(db, keyname, subkeyname);
590 if (!W_ERROR_IS_OK(werr)) {
598 static WERROR regdb_upgrade_v2_to_v3(struct db_context *db)
603 rc = regdb->traverse(db, regdb_upgrade_v2_to_v3_fn, db);
605 werr = WERR_REG_IO_FAILURE;
609 werr = regdb_store_regdb_version(db, REGVER_V3);
615 /***********************************************************************
616 Open the registry database
617 ***********************************************************************/
619 WERROR regdb_init(void)
621 uint32 vers_id, expected_version;
625 DEBUG(10, ("regdb_init: incrementing refcount (%d->%d)\n",
626 regdb_refcount, regdb_refcount+1));
631 regdb = db_open(NULL, state_path("registry.tdb"), 0,
632 REG_TDB_FLAGS, O_RDWR, 0600);
634 regdb = db_open(NULL, state_path("registry.tdb"), 0,
635 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
637 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
638 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
639 state_path("registry.tdb"), strerror(errno) ));
643 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
647 DEBUG(10, ("regdb_init: registry db openend. refcount reset (%d)\n",
650 expected_version = REGVER_V3;
652 vers_id = dbwrap_fetch_int32(regdb, REGDB_VERSION_KEYNAME);
654 DEBUG(10, ("regdb_init: registry version uninitialized "
655 "(got %d), initializing to version %d\n",
656 vers_id, expected_version));
658 werr = regdb_store_regdb_version(regdb, expected_version);
662 if (vers_id > expected_version || vers_id == 0) {
663 DEBUG(0, ("regdb_init: unknown registry version %d "
664 "(code version = %d), refusing initialization\n",
665 vers_id, expected_version));
666 return WERR_CAN_NOT_COMPLETE;
669 if (regdb->transaction_start(regdb) != 0) {
670 return WERR_REG_IO_FAILURE;
673 if (vers_id == REGVER_V1) {
674 DEBUG(10, ("regdb_init: upgrading registry fromversion %d "
675 "to %d\n", REGVER_V1, REGVER_V2));
677 werr = regdb_upgrade_v1_to_v2(regdb);
678 if (!W_ERROR_IS_OK(werr)) {
679 regdb->transaction_cancel(regdb);
686 if (vers_id == REGVER_V2) {
687 DEBUG(10, ("regdb_init: upgrading registry from version %d "
688 "to %d\n", REGVER_V2, REGVER_V3));
690 werr = regdb_upgrade_v2_to_v3(regdb);
691 if (!W_ERROR_IS_OK(werr)) {
692 regdb->transaction_cancel(regdb);
699 /* future upgrade code should go here */
701 if (regdb->transaction_commit(regdb) != 0) {
702 return WERR_REG_IO_FAILURE;
708 /***********************************************************************
709 Open the registry. Must already have been initialized by regdb_init()
710 ***********************************************************************/
712 WERROR regdb_open( void )
714 WERROR result = WERR_OK;
717 DEBUG(10, ("regdb_open: incrementing refcount (%d->%d)\n",
718 regdb_refcount, regdb_refcount+1));
725 regdb = db_open(NULL, state_path("registry.tdb"), 0,
726 REG_TDB_FLAGS, O_RDWR, 0600);
728 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
729 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
730 state_path("registry.tdb"), strerror(errno) ));
736 DEBUG(10, ("regdb_open: registry db opened. refcount reset (%d)\n",
742 /***********************************************************************
743 ***********************************************************************/
745 int regdb_close( void )
747 if (regdb_refcount == 0) {
753 DEBUG(10, ("regdb_close: decrementing refcount (%d->%d)\n",
754 regdb_refcount+1, regdb_refcount));
756 if ( regdb_refcount > 0 )
759 SMB_ASSERT( regdb_refcount >= 0 );
765 WERROR regdb_transaction_start(void)
767 return (regdb->transaction_start(regdb) == 0) ?
768 WERR_OK : WERR_REG_IO_FAILURE;
771 WERROR regdb_transaction_commit(void)
773 return (regdb->transaction_commit(regdb) == 0) ?
774 WERR_OK : WERR_REG_IO_FAILURE;
777 WERROR regdb_transaction_cancel(void)
779 return (regdb->transaction_cancel(regdb) == 0) ?
780 WERR_OK : WERR_REG_IO_FAILURE;
783 /***********************************************************************
784 return the tdb sequence number of the registry tdb.
785 this is an indicator for the content of the registry
786 having changed. it will change upon regdb_init, too, though.
787 ***********************************************************************/
788 int regdb_get_seqnum(void)
790 return regdb->get_seqnum(regdb);
794 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
799 WERROR werr = WERR_NOMEM;
800 TALLOC_CTX *mem_ctx = talloc_stackframe();
802 if (keyname == NULL) {
803 werr = WERR_INVALID_PARAM;
807 if (prefix == NULL) {
808 path = discard_const_p(char, keyname);
810 path = talloc_asprintf(mem_ctx, "%s\\%s", prefix, keyname);
816 path = normalize_reg_path(mem_ctx, path);
821 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
823 /* treat "not found" as ok */
824 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
829 talloc_free(mem_ctx);
834 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
836 return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
839 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
841 return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
844 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
846 return regdb_delete_key_with_prefix(db, keyname, NULL);
850 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
854 werr = regdb_delete_values(db, keyname);
855 if (!W_ERROR_IS_OK(werr)) {
856 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
857 REG_VALUE_PREFIX, keyname, win_errstr(werr)));
861 werr = regdb_delete_secdesc(db, keyname);
862 if (!W_ERROR_IS_OK(werr)) {
863 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
864 REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
868 werr = regdb_delete_subkeylist(db, keyname);
869 if (!W_ERROR_IS_OK(werr)) {
870 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
871 keyname, win_errstr(werr)));
879 /***********************************************************************
880 Add subkey strings to the registry tdb under a defined key
881 fmt is the same format as tdb_pack except this function only supports
883 ***********************************************************************/
885 static WERROR regdb_store_keys_internal2(struct db_context *db,
887 struct regsubkey_ctr *ctr)
890 uint8 *buffer = NULL;
893 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
894 char *keyname = NULL;
895 TALLOC_CTX *ctx = talloc_stackframe();
899 werr = WERR_INVALID_PARAM;
903 keyname = talloc_strdup(ctx, key);
909 keyname = normalize_reg_path(ctx, keyname);
915 /* allocate some initial memory */
917 buffer = (uint8 *)SMB_MALLOC(1024);
918 if (buffer == NULL) {
925 /* store the number of subkeys */
927 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
929 /* pack all the strings */
931 for (i=0; i<num_subkeys; i++) {
934 thistime = tdb_pack(buffer+len, buflen-len, "f",
935 regsubkey_ctr_specific_key(ctr, i));
936 if (len+thistime > buflen) {
939 * tdb_pack hasn't done anything because of the short
940 * buffer, allocate extra space.
942 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
945 DEBUG(0, ("regdb_store_keys: Failed to realloc "
946 "memory of size [%u]\n",
947 (unsigned int)(len+thistime)*2));
951 buflen = (len+thistime)*2;
952 thistime2 = tdb_pack(
953 buffer+len, buflen-len, "f",
954 regsubkey_ctr_specific_key(ctr, i));
955 if (thistime2 != thistime) {
956 DEBUG(0, ("tdb_pack failed\n"));
957 werr = WERR_CAN_NOT_COMPLETE;
964 /* finally write out the data */
968 werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
978 * Utility function to store a new empty list of
979 * subkeys of given key specified as parent and subkey name
980 * (thereby creating the key).
981 * If the parent keyname is NULL, then the "subkey" is
982 * interpreted as a base key.
983 * If the subkey list does already exist, it is not modified.
985 * Must be called from within a transaction.
987 static WERROR regdb_store_subkey_list(struct db_context *db, const char *parent,
992 struct regsubkey_ctr *subkeys = NULL;
993 TALLOC_CTX *frame = talloc_stackframe();
995 if (parent == NULL) {
996 path = talloc_strdup(frame, key);
998 path = talloc_asprintf(frame, "%s\\%s", parent, key);
1005 werr = regsubkey_ctr_init(frame, &subkeys);
1006 W_ERROR_NOT_OK_GOTO_DONE(werr);
1008 werr = regdb_fetch_keys_internal(db, path, subkeys);
1009 if (W_ERROR_IS_OK(werr)) {
1010 /* subkey list exists already - don't modify */
1014 werr = regsubkey_ctr_reinit(subkeys);
1015 W_ERROR_NOT_OK_GOTO_DONE(werr);
1017 /* create a record with 0 subkeys */
1018 werr = regdb_store_keys_internal2(db, path, subkeys);
1019 if (!W_ERROR_IS_OK(werr)) {
1020 DEBUG(0, ("regdb_store_keys: Failed to store new record for "
1021 "key [%s]: %s\n", path, win_errstr(werr)));
1030 /***********************************************************************
1031 Store the new subkey record and create any child key records that
1032 do not currently exist
1033 ***********************************************************************/
1035 struct regdb_store_keys_context {
1037 struct regsubkey_ctr *ctr;
1040 static NTSTATUS regdb_store_keys_action(struct db_context *db,
1043 struct regdb_store_keys_context *store_ctx;
1047 struct regsubkey_ctr *old_subkeys = NULL;
1048 char *oldkeyname = NULL;
1049 TALLOC_CTX *mem_ctx = talloc_stackframe();
1051 store_ctx = (struct regdb_store_keys_context *)private_data;
1054 * Re-fetch the old keys inside the transaction
1057 werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
1058 W_ERROR_NOT_OK_GOTO_DONE(werr);
1060 werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
1061 if (!W_ERROR_IS_OK(werr) &&
1062 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1068 * Make the store operation as safe as possible without transactions:
1070 * (1) For each subkey removed from ctr compared with old_subkeys:
1072 * (a) First delete the value db entry.
1074 * (b) Next delete the secdesc db record.
1076 * (c) Then delete the subkey list entry.
1078 * (2) Now write the list of subkeys of the parent key,
1079 * deleting removed entries and adding new ones.
1081 * (3) Finally create the subkey list entries for the added keys.
1083 * This way if we crash half-way in between deleting the subkeys
1084 * and storing the parent's list of subkeys, no old data can pop up
1085 * out of the blue when re-adding keys later on.
1088 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
1090 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1091 for (i=0; i<num_subkeys; i++) {
1092 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
1094 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
1096 * It's still around, don't delete
1101 path = talloc_asprintf(mem_ctx, "%s\\%s", store_ctx->key,
1108 werr = regdb_delete_key_lists(db, path);
1109 W_ERROR_NOT_OK_GOTO_DONE(werr);
1114 TALLOC_FREE(old_subkeys);
1116 /* (2) store the subkey list for the parent */
1118 werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
1119 if (!W_ERROR_IS_OK(werr)) {
1120 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
1121 "for parent [%s]: %s\n", store_ctx->key,
1126 /* (3) now create records for any subkeys that don't already exist */
1128 num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
1130 for (i=0; i<num_subkeys; i++) {
1133 subkey = regsubkey_ctr_specific_key(store_ctx->ctr, i);
1135 werr = regdb_store_subkey_list(db, store_ctx->key, subkey);
1136 W_ERROR_NOT_OK_GOTO_DONE(werr);
1142 talloc_free(mem_ctx);
1143 return werror_to_ntstatus(werr);
1146 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
1147 struct regsubkey_ctr *ctr)
1149 int num_subkeys, old_num_subkeys, i;
1150 struct regsubkey_ctr *old_subkeys = NULL;
1151 TALLOC_CTX *ctx = talloc_stackframe();
1154 struct regdb_store_keys_context store_ctx;
1156 if (!regdb_key_exists(db, key)) {
1161 * fetch a list of the old subkeys so we can determine if anything has
1165 werr = regsubkey_ctr_init(ctx, &old_subkeys);
1166 if (!W_ERROR_IS_OK(werr)) {
1167 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
1171 werr = regdb_fetch_keys_internal(db, key, old_subkeys);
1172 if (!W_ERROR_IS_OK(werr) &&
1173 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1178 num_subkeys = regsubkey_ctr_numkeys(ctr);
1179 old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1180 if ((num_subkeys && old_num_subkeys) &&
1181 (num_subkeys == old_num_subkeys)) {
1183 for (i = 0; i < num_subkeys; i++) {
1184 if (strcmp(regsubkey_ctr_specific_key(ctr, i),
1185 regsubkey_ctr_specific_key(old_subkeys, i))
1191 if (i == num_subkeys) {
1193 * Nothing changed, no point to even start a tdb
1202 TALLOC_FREE(old_subkeys);
1204 store_ctx.key = key;
1205 store_ctx.ctr = ctr;
1207 werr = regdb_trans_do(db,
1208 regdb_store_keys_action,
1211 ret = W_ERROR_IS_OK(werr);
1219 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
1221 return regdb_store_keys_internal(regdb, key, ctr);
1225 * create a subkey of a given key
1228 struct regdb_create_subkey_context {
1233 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
1237 struct regdb_create_subkey_context *create_ctx;
1238 struct regsubkey_ctr *subkeys;
1239 TALLOC_CTX *mem_ctx = talloc_stackframe();
1241 create_ctx = (struct regdb_create_subkey_context *)private_data;
1243 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1244 W_ERROR_NOT_OK_GOTO_DONE(werr);
1246 werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
1247 W_ERROR_NOT_OK_GOTO_DONE(werr);
1249 werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
1250 W_ERROR_NOT_OK_GOTO_DONE(werr);
1252 werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
1253 if (!W_ERROR_IS_OK(werr)) {
1254 DEBUG(0, (__location__ " failed to store new subkey list for "
1255 "parent key %s: %s\n", create_ctx->key,
1259 werr = regdb_store_subkey_list(db, create_ctx->key, create_ctx->subkey);
1262 talloc_free(mem_ctx);
1263 return werror_to_ntstatus(werr);
1266 static WERROR regdb_create_subkey_internal(struct db_context *db,
1271 struct regsubkey_ctr *subkeys;
1272 TALLOC_CTX *mem_ctx = talloc_stackframe();
1273 struct regdb_create_subkey_context create_ctx;
1275 if (!regdb_key_exists(db, key)) {
1276 werr = WERR_NOT_FOUND;
1280 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1281 W_ERROR_NOT_OK_GOTO_DONE(werr);
1283 werr = regdb_fetch_keys_internal(db, key, subkeys);
1284 W_ERROR_NOT_OK_GOTO_DONE(werr);
1286 if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1291 talloc_free(subkeys);
1293 create_ctx.key = key;
1294 create_ctx.subkey = subkey;
1296 werr = regdb_trans_do(db,
1297 regdb_create_subkey_action,
1301 talloc_free(mem_ctx);
1305 static WERROR regdb_create_subkey(const char *key, const char *subkey)
1307 return regdb_create_subkey_internal(regdb, key, subkey);
1314 struct regdb_create_basekey_context {
1318 static NTSTATUS regdb_create_basekey_action(struct db_context *db,
1322 struct regdb_create_basekey_context *create_ctx;
1324 create_ctx = (struct regdb_create_basekey_context *)private_data;
1326 werr = regdb_store_subkey_list(db, NULL, create_ctx->key);
1328 return werror_to_ntstatus(werr);
1331 static WERROR regdb_create_basekey(struct db_context *db, const char *key)
1334 struct regdb_create_subkey_context create_ctx;
1336 create_ctx.key = key;
1338 werr = regdb_trans_do(db,
1339 regdb_create_basekey_action,
1346 * create a subkey of a given key
1349 struct regdb_delete_subkey_context {
1356 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1360 struct regdb_delete_subkey_context *delete_ctx;
1361 struct regsubkey_ctr *subkeys;
1362 TALLOC_CTX *mem_ctx = talloc_stackframe();
1364 delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1366 werr = regdb_delete_key_lists(db, delete_ctx->path);
1367 W_ERROR_NOT_OK_GOTO_DONE(werr);
1369 if (delete_ctx->lazy) {
1373 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1374 W_ERROR_NOT_OK_GOTO_DONE(werr);
1376 werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1377 W_ERROR_NOT_OK_GOTO_DONE(werr);
1379 werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1380 W_ERROR_NOT_OK_GOTO_DONE(werr);
1382 werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1383 if (!W_ERROR_IS_OK(werr)) {
1384 DEBUG(0, (__location__ " failed to store new subkey_list for "
1385 "parent key %s: %s\n", delete_ctx->key,
1390 talloc_free(mem_ctx);
1391 return werror_to_ntstatus(werr);
1394 static WERROR regdb_delete_subkey(const char *key, const char *subkey, bool lazy)
1398 struct regdb_delete_subkey_context delete_ctx;
1399 TALLOC_CTX *mem_ctx = talloc_stackframe();
1401 if (!regdb_key_exists(regdb, key)) {
1402 werr = WERR_NOT_FOUND;
1406 path = talloc_asprintf(mem_ctx, "%s\\%s", key, subkey);
1412 if (!regdb_key_exists(regdb, path)) {
1417 delete_ctx.key = key;
1418 delete_ctx.subkey = subkey;
1419 delete_ctx.path = path;
1420 delete_ctx.lazy = lazy;
1422 werr = regdb_trans_do(regdb,
1423 regdb_delete_subkey_action,
1427 talloc_free(mem_ctx);
1431 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1432 TALLOC_CTX *mem_ctx, const char *key)
1437 path = normalize_reg_path(mem_ctx, key);
1439 return make_tdb_data(NULL, 0);
1442 data = dbwrap_fetch_bystring(db, mem_ctx, path);
1450 * Check for the existence of a key.
1452 * Existence of a key is authoritatively defined by
1453 * the existence of the record that contains the list
1456 * Return false, if the record does not match the correct
1457 * structure of an initial 4-byte counter and then a
1458 * list of the corresponding number of zero-terminated
1461 static bool regdb_key_exists(struct db_context *db, const char *key)
1463 TALLOC_CTX *mem_ctx = talloc_stackframe();
1469 uint32_t num_items, i;
1476 path = normalize_reg_path(mem_ctx, key);
1478 DEBUG(0, ("out of memory! (talloc failed)\n"));
1482 if (*path == '\0') {
1486 value = regdb_fetch_key_internal(db, mem_ctx, path);
1487 if (value.dptr == NULL) {
1491 if (value.dsize == 0) {
1492 DEBUG(10, ("regdb_key_exists: subkeylist-record for key "
1493 "[%s] is empty: Could be a deleted record in a "
1494 "clustered (ctdb) environment?\n",
1499 len = tdb_unpack(value.dptr, value.dsize, "d", &num_items);
1500 if (len == (int32_t)-1) {
1501 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1502 "[%s] is invalid: Could not parse initial 4-byte "
1503 "counter. record data length is %u.\n",
1504 path, (unsigned int)value.dsize));
1509 * Note: the tdb_unpack check above implies that len <= value.dsize
1511 buflen = value.dsize - len;
1512 buf = (const char *)value.dptr + len;
1516 for (i = 0; i < num_items; i++) {
1520 len = strnlen(buf, buflen) + 1;
1522 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record "
1523 "for key [%s] is corrupt: %u items expected, "
1524 "item number %u is not zero terminated.\n",
1525 path, num_items, i+1));
1534 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1535 "[%s] is corrupt: %u items expected and found, but "
1536 "the record contains additional %u bytes\n",
1537 path, num_items, buflen));
1541 if (i < num_items) {
1542 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1543 "[%s] is corrupt: %u items expected, but only %u "
1545 path, num_items, i+1));
1552 TALLOC_FREE(mem_ctx);
1557 /***********************************************************************
1558 Retrieve an array of strings containing subkeys. Memory should be
1559 released by the caller.
1560 ***********************************************************************/
1562 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1563 struct regsubkey_ctr *ctr)
1571 TALLOC_CTX *frame = talloc_stackframe();
1574 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1576 if (!regdb_key_exists(db, key)) {
1577 DEBUG(10, ("key [%s] not found\n", key));
1578 werr = WERR_NOT_FOUND;
1582 werr = regsubkey_ctr_reinit(ctr);
1583 W_ERROR_NOT_OK_GOTO_DONE(werr);
1585 werr = regsubkey_ctr_set_seqnum(ctr, db->get_seqnum(db));
1586 W_ERROR_NOT_OK_GOTO_DONE(werr);
1588 value = regdb_fetch_key_internal(db, frame, key);
1590 if (value.dsize == 0 || value.dptr == NULL) {
1591 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1597 buflen = value.dsize;
1598 len = tdb_unpack( buf, buflen, "d", &num_items);
1599 if (len == (uint32_t)-1) {
1600 werr = WERR_NOT_FOUND;
1604 for (i=0; i<num_items; i++) {
1605 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1606 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1607 if (!W_ERROR_IS_OK(werr)) {
1608 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1609 "failed: %s\n", win_errstr(werr)));
1615 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1622 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1626 werr = regdb_fetch_keys_internal(regdb, key, ctr);
1627 if (!W_ERROR_IS_OK(werr)) {
1631 return regsubkey_ctr_numkeys(ctr);
1634 /****************************************************************************
1635 Unpack a list of registry values frem the TDB
1636 ***************************************************************************/
1638 static int regdb_unpack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1645 uint32 num_values = 0;
1648 /* loop and unpack the rest of the registry values */
1650 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1652 for ( i=0; i<num_values; i++ ) {
1653 /* unpack the next regval */
1658 valuename[0] = '\0';
1659 len += tdb_unpack(buf+len, buflen-len, "fdB",
1665 regval_ctr_addvalue(values, valuename, type,
1666 (uint8_t *)data_p, size);
1667 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1669 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1675 /****************************************************************************
1676 Pack all values in all printer keys
1677 ***************************************************************************/
1679 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1683 struct regval_blob *val;
1689 num_values = regval_ctr_numvals( values );
1691 /* pack the number of values first */
1693 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1695 /* loop over all values */
1697 for ( i=0; i<num_values; i++ ) {
1698 val = regval_ctr_specific_value( values, i );
1699 len += tdb_pack(buf+len, buflen-len, "fdB",
1703 regval_data_p(val) );
1709 /***********************************************************************
1710 Retrieve an array of strings containing subkeys. Memory should be
1711 released by the caller.
1712 ***********************************************************************/
1714 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1715 struct regval_ctr *values)
1717 char *keystr = NULL;
1718 TALLOC_CTX *ctx = talloc_stackframe();
1723 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1725 if (!regdb_key_exists(db, key)) {
1729 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key);
1734 werr = regval_ctr_set_seqnum(values, db->get_seqnum(db));
1735 W_ERROR_NOT_OK_GOTO_DONE(werr);
1737 value = regdb_fetch_key_internal(db, ctx, keystr);
1740 /* all keys have zero values by default */
1744 regdb_unpack_values(values, value.dptr, value.dsize);
1745 ret = regval_ctr_numvals(values);
1752 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1754 return regdb_fetch_values_internal(regdb, key, values);
1757 static NTSTATUS regdb_store_values_internal(struct db_context *db,
1759 struct regval_ctr *values)
1761 TDB_DATA old_data, data;
1762 char *keystr = NULL;
1763 TALLOC_CTX *ctx = talloc_stackframe();
1767 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1769 if (!regdb_key_exists(db, key)) {
1770 status = NT_STATUS_NOT_FOUND;
1776 len = regdb_pack_values(values, data.dptr, data.dsize);
1778 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1779 status = NT_STATUS_UNSUCCESSFUL;
1783 data.dptr = talloc_array(ctx, uint8, len);
1786 len = regdb_pack_values(values, data.dptr, data.dsize);
1788 SMB_ASSERT( len == data.dsize );
1790 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key );
1792 status = NT_STATUS_NO_MEMORY;
1795 keystr = normalize_reg_path(ctx, keystr);
1800 old_data = dbwrap_fetch_bystring(db, ctx, keystr);
1802 if ((old_data.dptr != NULL)
1803 && (old_data.dsize == data.dsize)
1804 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1806 status = NT_STATUS_OK;
1810 status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1817 struct regdb_store_values_ctx {
1819 struct regval_ctr *values;
1822 static NTSTATUS regdb_store_values_action(struct db_context *db,
1826 struct regdb_store_values_ctx *ctx =
1827 (struct regdb_store_values_ctx *)private_data;
1829 status = regdb_store_values_internal(db, ctx->key, ctx->values);
1834 bool regdb_store_values(const char *key, struct regval_ctr *values)
1837 struct regdb_store_values_ctx ctx;
1840 ctx.values = values;
1842 werr = regdb_trans_do(regdb, regdb_store_values_action, &ctx);
1844 return W_ERROR_IS_OK(werr);
1847 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1848 struct security_descriptor **psecdesc)
1853 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1854 WERROR err = WERR_OK;
1856 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1858 if (!regdb_key_exists(regdb, key)) {
1863 tdbkey = talloc_asprintf(tmp_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1864 if (tdbkey == NULL) {
1869 tdbkey = normalize_reg_path(tmp_ctx, tdbkey);
1870 if (tdbkey == NULL) {
1875 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1876 if (data.dptr == NULL) {
1881 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1884 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1886 } else if (!NT_STATUS_IS_OK(status)) {
1887 err = WERR_REG_CORRUPT;
1891 TALLOC_FREE(tmp_ctx);
1895 struct regdb_set_secdesc_ctx {
1897 struct security_descriptor *secdesc;
1900 static NTSTATUS regdb_set_secdesc_action(struct db_context *db,
1906 struct regdb_set_secdesc_ctx *ctx =
1907 (struct regdb_set_secdesc_ctx *)private_data;
1908 TALLOC_CTX *frame = talloc_stackframe();
1910 tdbkey = talloc_asprintf(frame, "%s\\%s", REG_SECDESC_PREFIX, ctx->key);
1911 if (tdbkey == NULL) {
1915 tdbkey = normalize_reg_path(frame, tdbkey);
1916 if (tdbkey == NULL) {
1917 status = NT_STATUS_NO_MEMORY;
1921 if (ctx->secdesc == NULL) {
1922 /* assuming a delete */
1923 status = dbwrap_delete_bystring(db, tdbkey);
1927 status = marshall_sec_desc(frame, ctx->secdesc, &tdbdata.dptr,
1929 if (!NT_STATUS_IS_OK(status)) {
1933 status = dbwrap_store_bystring(db, tdbkey, tdbdata, 0);
1940 static WERROR regdb_set_secdesc(const char *key,
1941 struct security_descriptor *secdesc)
1944 struct regdb_set_secdesc_ctx ctx;
1946 if (!regdb_key_exists(regdb, key)) {
1952 ctx.secdesc = secdesc;
1954 err = regdb_trans_do(regdb, regdb_set_secdesc_action, &ctx);
1960 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1962 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1965 bool regdb_values_need_update(struct regval_ctr *values)
1967 return (regdb_get_seqnum() != regval_ctr_get_seqnum(values));
1971 * Table of function pointers for default access
1974 struct registry_ops regdb_ops = {
1975 .fetch_subkeys = regdb_fetch_keys,
1976 .fetch_values = regdb_fetch_values,
1977 .store_subkeys = regdb_store_keys,
1978 .store_values = regdb_store_values,
1979 .create_subkey = regdb_create_subkey,
1980 .delete_subkey = regdb_delete_subkey,
1981 .get_secdesc = regdb_get_secdesc,
1982 .set_secdesc = regdb_set_secdesc,
1983 .subkeys_need_update = regdb_subkeys_need_update,
1984 .values_need_update = regdb_values_need_update