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();
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, REGDB_VERSION_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, REGDB_VERSION_V3);
615 /***********************************************************************
616 Open the registry database
617 ***********************************************************************/
619 WERROR regdb_init(void)
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 vers_id = dbwrap_fetch_int32(regdb, REGDB_VERSION_KEYNAME);
652 DEBUG(10, ("regdb_init: registry version uninitialized "
653 "(got %d), initializing to version %d\n",
654 vers_id, REGDB_CODE_VERSION));
656 werr = regdb_store_regdb_version(regdb, REGDB_CODE_VERSION);
660 if (vers_id > REGDB_CODE_VERSION || vers_id == 0) {
661 DEBUG(0, ("regdb_init: unknown registry version %d "
662 "(code version = %d), refusing initialization\n",
663 vers_id, REGDB_CODE_VERSION));
664 return WERR_CAN_NOT_COMPLETE;
667 if (regdb->transaction_start(regdb) != 0) {
668 return WERR_REG_IO_FAILURE;
671 if (vers_id == REGDB_VERSION_V1) {
672 DEBUG(10, ("regdb_init: upgrading registry fromversion %d "
673 "to %d\n", REGDB_VERSION_V1, REGDB_VERSION_V2));
675 werr = regdb_upgrade_v1_to_v2(regdb);
676 if (!W_ERROR_IS_OK(werr)) {
677 regdb->transaction_cancel(regdb);
681 vers_id = REGDB_VERSION_V2;
684 if (vers_id == REGDB_VERSION_V2) {
685 DEBUG(10, ("regdb_init: upgrading registry from version %d "
686 "to %d\n", REGDB_VERSION_V2, REGDB_VERSION_V3));
688 werr = regdb_upgrade_v2_to_v3(regdb);
689 if (!W_ERROR_IS_OK(werr)) {
690 regdb->transaction_cancel(regdb);
694 vers_id = REGDB_VERSION_V3;
697 /* future upgrade code should go here */
699 if (regdb->transaction_commit(regdb) != 0) {
700 return WERR_REG_IO_FAILURE;
706 /***********************************************************************
707 Open the registry. Must already have been initialized by regdb_init()
708 ***********************************************************************/
710 WERROR regdb_open( void )
712 WERROR result = WERR_OK;
715 DEBUG(10, ("regdb_open: incrementing refcount (%d->%d)\n",
716 regdb_refcount, regdb_refcount+1));
723 regdb = db_open(NULL, state_path("registry.tdb"), 0,
724 REG_TDB_FLAGS, O_RDWR, 0600);
726 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
727 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
728 state_path("registry.tdb"), strerror(errno) ));
734 DEBUG(10, ("regdb_open: registry db opened. refcount reset (%d)\n",
740 /***********************************************************************
741 ***********************************************************************/
743 int regdb_close( void )
745 if (regdb_refcount == 0) {
751 DEBUG(10, ("regdb_close: decrementing refcount (%d->%d)\n",
752 regdb_refcount+1, regdb_refcount));
754 if ( regdb_refcount > 0 )
757 SMB_ASSERT( regdb_refcount >= 0 );
763 WERROR regdb_transaction_start(void)
765 return (regdb->transaction_start(regdb) == 0) ?
766 WERR_OK : WERR_REG_IO_FAILURE;
769 WERROR regdb_transaction_commit(void)
771 return (regdb->transaction_commit(regdb) == 0) ?
772 WERR_OK : WERR_REG_IO_FAILURE;
775 WERROR regdb_transaction_cancel(void)
777 return (regdb->transaction_cancel(regdb) == 0) ?
778 WERR_OK : WERR_REG_IO_FAILURE;
781 /***********************************************************************
782 return the tdb sequence number of the registry tdb.
783 this is an indicator for the content of the registry
784 having changed. it will change upon regdb_init, too, though.
785 ***********************************************************************/
786 int regdb_get_seqnum(void)
788 return regdb->get_seqnum(regdb);
792 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
797 WERROR werr = WERR_NOMEM;
798 TALLOC_CTX *mem_ctx = talloc_stackframe();
800 if (keyname == NULL) {
801 werr = WERR_INVALID_PARAM;
805 if (prefix == NULL) {
806 path = discard_const_p(char, keyname);
808 path = talloc_asprintf(mem_ctx, "%s\\%s", prefix, keyname);
814 path = normalize_reg_path(mem_ctx, path);
819 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
821 /* treat "not found" as ok */
822 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
827 talloc_free(mem_ctx);
832 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
834 return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
837 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
839 return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
842 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
844 return regdb_delete_key_with_prefix(db, keyname, NULL);
848 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
852 werr = regdb_delete_values(db, keyname);
853 if (!W_ERROR_IS_OK(werr)) {
854 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
855 REG_VALUE_PREFIX, keyname, win_errstr(werr)));
859 werr = regdb_delete_secdesc(db, keyname);
860 if (!W_ERROR_IS_OK(werr)) {
861 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
862 REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
866 werr = regdb_delete_subkeylist(db, keyname);
867 if (!W_ERROR_IS_OK(werr)) {
868 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
869 keyname, win_errstr(werr)));
877 /***********************************************************************
878 Add subkey strings to the registry tdb under a defined key
879 fmt is the same format as tdb_pack except this function only supports
881 ***********************************************************************/
883 static WERROR regdb_store_keys_internal2(struct db_context *db,
885 struct regsubkey_ctr *ctr)
888 uint8 *buffer = NULL;
891 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
892 char *keyname = NULL;
893 TALLOC_CTX *ctx = talloc_stackframe();
897 werr = WERR_INVALID_PARAM;
901 keyname = talloc_strdup(ctx, key);
907 keyname = normalize_reg_path(ctx, keyname);
913 /* allocate some initial memory */
915 buffer = (uint8 *)SMB_MALLOC(1024);
916 if (buffer == NULL) {
923 /* store the number of subkeys */
925 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
927 /* pack all the strings */
929 for (i=0; i<num_subkeys; i++) {
932 thistime = tdb_pack(buffer+len, buflen-len, "f",
933 regsubkey_ctr_specific_key(ctr, i));
934 if (len+thistime > buflen) {
937 * tdb_pack hasn't done anything because of the short
938 * buffer, allocate extra space.
940 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
943 DEBUG(0, ("regdb_store_keys: Failed to realloc "
944 "memory of size [%u]\n",
945 (unsigned int)(len+thistime)*2));
949 buflen = (len+thistime)*2;
950 thistime2 = tdb_pack(
951 buffer+len, buflen-len, "f",
952 regsubkey_ctr_specific_key(ctr, i));
953 if (thistime2 != thistime) {
954 DEBUG(0, ("tdb_pack failed\n"));
955 werr = WERR_CAN_NOT_COMPLETE;
962 /* finally write out the data */
966 werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
976 * Utility function to store a new empty list of
977 * subkeys of given key specified as parent and subkey name
978 * (thereby creating the key).
979 * If the parent keyname is NULL, then the "subkey" is
980 * interpreted as a base key.
981 * If the subkey list does already exist, it is not modified.
983 * Must be called from within a transaction.
985 static WERROR regdb_store_subkey_list(struct db_context *db, const char *parent,
990 struct regsubkey_ctr *subkeys = NULL;
991 TALLOC_CTX *frame = talloc_stackframe();
993 if (parent == NULL) {
994 path = talloc_strdup(frame, key);
996 path = talloc_asprintf(frame, "%s\\%s", parent, key);
1003 werr = regsubkey_ctr_init(frame, &subkeys);
1004 W_ERROR_NOT_OK_GOTO_DONE(werr);
1006 werr = regdb_fetch_keys_internal(db, path, subkeys);
1007 if (W_ERROR_IS_OK(werr)) {
1008 /* subkey list exists already - don't modify */
1012 werr = regsubkey_ctr_reinit(subkeys);
1013 W_ERROR_NOT_OK_GOTO_DONE(werr);
1015 /* create a record with 0 subkeys */
1016 werr = regdb_store_keys_internal2(db, path, subkeys);
1017 if (!W_ERROR_IS_OK(werr)) {
1018 DEBUG(0, ("regdb_store_keys: Failed to store new record for "
1019 "key [%s]: %s\n", path, win_errstr(werr)));
1028 /***********************************************************************
1029 Store the new subkey record and create any child key records that
1030 do not currently exist
1031 ***********************************************************************/
1033 struct regdb_store_keys_context {
1035 struct regsubkey_ctr *ctr;
1038 static NTSTATUS regdb_store_keys_action(struct db_context *db,
1041 struct regdb_store_keys_context *store_ctx;
1045 struct regsubkey_ctr *old_subkeys = NULL;
1046 char *oldkeyname = NULL;
1047 TALLOC_CTX *mem_ctx = talloc_stackframe();
1049 store_ctx = (struct regdb_store_keys_context *)private_data;
1052 * Re-fetch the old keys inside the transaction
1055 werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
1056 W_ERROR_NOT_OK_GOTO_DONE(werr);
1058 werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
1059 if (!W_ERROR_IS_OK(werr) &&
1060 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1066 * Make the store operation as safe as possible without transactions:
1068 * (1) For each subkey removed from ctr compared with old_subkeys:
1070 * (a) First delete the value db entry.
1072 * (b) Next delete the secdesc db record.
1074 * (c) Then delete the subkey list entry.
1076 * (2) Now write the list of subkeys of the parent key,
1077 * deleting removed entries and adding new ones.
1079 * (3) Finally create the subkey list entries for the added keys.
1081 * This way if we crash half-way in between deleting the subkeys
1082 * and storing the parent's list of subkeys, no old data can pop up
1083 * out of the blue when re-adding keys later on.
1086 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
1088 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1089 for (i=0; i<num_subkeys; i++) {
1090 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
1092 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
1094 * It's still around, don't delete
1099 path = talloc_asprintf(mem_ctx, "%s\\%s", store_ctx->key,
1106 werr = regdb_delete_key_lists(db, path);
1107 W_ERROR_NOT_OK_GOTO_DONE(werr);
1112 TALLOC_FREE(old_subkeys);
1114 /* (2) store the subkey list for the parent */
1116 werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
1117 if (!W_ERROR_IS_OK(werr)) {
1118 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
1119 "for parent [%s]: %s\n", store_ctx->key,
1124 /* (3) now create records for any subkeys that don't already exist */
1126 num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
1128 for (i=0; i<num_subkeys; i++) {
1131 subkey = regsubkey_ctr_specific_key(store_ctx->ctr, i);
1133 werr = regdb_store_subkey_list(db, store_ctx->key, subkey);
1134 W_ERROR_NOT_OK_GOTO_DONE(werr);
1140 talloc_free(mem_ctx);
1141 return werror_to_ntstatus(werr);
1144 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
1145 struct regsubkey_ctr *ctr)
1147 int num_subkeys, old_num_subkeys, i;
1148 struct regsubkey_ctr *old_subkeys = NULL;
1149 TALLOC_CTX *ctx = talloc_stackframe();
1152 struct regdb_store_keys_context store_ctx;
1154 if (!regdb_key_exists(db, key)) {
1159 * fetch a list of the old subkeys so we can determine if anything has
1163 werr = regsubkey_ctr_init(ctx, &old_subkeys);
1164 if (!W_ERROR_IS_OK(werr)) {
1165 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
1169 werr = regdb_fetch_keys_internal(db, key, old_subkeys);
1170 if (!W_ERROR_IS_OK(werr) &&
1171 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1176 num_subkeys = regsubkey_ctr_numkeys(ctr);
1177 old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1178 if ((num_subkeys && old_num_subkeys) &&
1179 (num_subkeys == old_num_subkeys)) {
1181 for (i = 0; i < num_subkeys; i++) {
1182 if (strcmp(regsubkey_ctr_specific_key(ctr, i),
1183 regsubkey_ctr_specific_key(old_subkeys, i))
1189 if (i == num_subkeys) {
1191 * Nothing changed, no point to even start a tdb
1200 TALLOC_FREE(old_subkeys);
1202 store_ctx.key = key;
1203 store_ctx.ctr = ctr;
1205 werr = regdb_trans_do(db,
1206 regdb_store_keys_action,
1209 ret = W_ERROR_IS_OK(werr);
1217 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
1219 return regdb_store_keys_internal(regdb, key, ctr);
1223 * create a subkey of a given key
1226 struct regdb_create_subkey_context {
1231 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
1235 struct regdb_create_subkey_context *create_ctx;
1236 struct regsubkey_ctr *subkeys;
1237 TALLOC_CTX *mem_ctx = talloc_stackframe();
1239 create_ctx = (struct regdb_create_subkey_context *)private_data;
1241 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1242 W_ERROR_NOT_OK_GOTO_DONE(werr);
1244 werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
1245 W_ERROR_NOT_OK_GOTO_DONE(werr);
1247 werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
1248 W_ERROR_NOT_OK_GOTO_DONE(werr);
1250 werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
1251 if (!W_ERROR_IS_OK(werr)) {
1252 DEBUG(0, (__location__ " failed to store new subkey list for "
1253 "parent key %s: %s\n", create_ctx->key,
1257 werr = regdb_store_subkey_list(db, create_ctx->key, create_ctx->subkey);
1260 talloc_free(mem_ctx);
1261 return werror_to_ntstatus(werr);
1264 static WERROR regdb_create_subkey_internal(struct db_context *db,
1269 struct regsubkey_ctr *subkeys;
1270 TALLOC_CTX *mem_ctx = talloc_stackframe();
1271 struct regdb_create_subkey_context create_ctx;
1273 if (!regdb_key_exists(db, key)) {
1274 werr = WERR_NOT_FOUND;
1278 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1279 W_ERROR_NOT_OK_GOTO_DONE(werr);
1281 werr = regdb_fetch_keys_internal(db, key, subkeys);
1282 W_ERROR_NOT_OK_GOTO_DONE(werr);
1284 if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1289 talloc_free(subkeys);
1291 create_ctx.key = key;
1292 create_ctx.subkey = subkey;
1294 werr = regdb_trans_do(db,
1295 regdb_create_subkey_action,
1299 talloc_free(mem_ctx);
1303 static WERROR regdb_create_subkey(const char *key, const char *subkey)
1305 return regdb_create_subkey_internal(regdb, key, subkey);
1312 struct regdb_create_basekey_context {
1316 static NTSTATUS regdb_create_basekey_action(struct db_context *db,
1320 struct regdb_create_basekey_context *create_ctx;
1322 create_ctx = (struct regdb_create_basekey_context *)private_data;
1324 werr = regdb_store_subkey_list(db, NULL, create_ctx->key);
1326 return werror_to_ntstatus(werr);
1329 static WERROR regdb_create_basekey(struct db_context *db, const char *key)
1332 struct regdb_create_subkey_context create_ctx;
1334 create_ctx.key = key;
1336 werr = regdb_trans_do(db,
1337 regdb_create_basekey_action,
1344 * create a subkey of a given key
1347 struct regdb_delete_subkey_context {
1354 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1358 struct regdb_delete_subkey_context *delete_ctx;
1359 struct regsubkey_ctr *subkeys;
1360 TALLOC_CTX *mem_ctx = talloc_stackframe();
1362 delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1364 werr = regdb_delete_key_lists(db, delete_ctx->path);
1365 W_ERROR_NOT_OK_GOTO_DONE(werr);
1367 if (delete_ctx->lazy) {
1371 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1372 W_ERROR_NOT_OK_GOTO_DONE(werr);
1374 werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1375 W_ERROR_NOT_OK_GOTO_DONE(werr);
1377 werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1378 W_ERROR_NOT_OK_GOTO_DONE(werr);
1380 werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1381 if (!W_ERROR_IS_OK(werr)) {
1382 DEBUG(0, (__location__ " failed to store new subkey_list for "
1383 "parent key %s: %s\n", delete_ctx->key,
1388 talloc_free(mem_ctx);
1389 return werror_to_ntstatus(werr);
1392 static WERROR regdb_delete_subkey(const char *key, const char *subkey, bool lazy)
1396 struct regdb_delete_subkey_context delete_ctx;
1397 TALLOC_CTX *mem_ctx = talloc_stackframe();
1399 if (!regdb_key_exists(regdb, key)) {
1400 werr = WERR_NOT_FOUND;
1404 path = talloc_asprintf(mem_ctx, "%s\\%s", key, subkey);
1410 if (!regdb_key_exists(regdb, path)) {
1415 delete_ctx.key = key;
1416 delete_ctx.subkey = subkey;
1417 delete_ctx.path = path;
1418 delete_ctx.lazy = lazy;
1420 werr = regdb_trans_do(regdb,
1421 regdb_delete_subkey_action,
1425 talloc_free(mem_ctx);
1429 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1430 TALLOC_CTX *mem_ctx, const char *key)
1435 path = normalize_reg_path(mem_ctx, key);
1437 return make_tdb_data(NULL, 0);
1440 data = dbwrap_fetch_bystring(db, mem_ctx, path);
1448 * Check for the existence of a key.
1450 * Existence of a key is authoritatively defined by
1451 * the existence of the record that contains the list
1454 * Return false, if the record does not match the correct
1455 * structure of an initial 4-byte counter and then a
1456 * list of the corresponding number of zero-terminated
1459 static bool regdb_key_exists(struct db_context *db, const char *key)
1461 TALLOC_CTX *mem_ctx = talloc_stackframe();
1467 uint32_t num_items, i;
1474 path = normalize_reg_path(mem_ctx, key);
1476 DEBUG(0, ("out of memory! (talloc failed)\n"));
1480 if (*path == '\0') {
1484 value = regdb_fetch_key_internal(db, mem_ctx, path);
1485 if (value.dptr == NULL) {
1489 if (value.dsize == 0) {
1490 DEBUG(10, ("regdb_key_exists: subkeylist-record for key "
1491 "[%s] is empty: Could be a deleted record in a "
1492 "clustered (ctdb) environment?\n",
1497 len = tdb_unpack(value.dptr, value.dsize, "d", &num_items);
1498 if (len == (int32_t)-1) {
1499 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1500 "[%s] is invalid: Could not parse initial 4-byte "
1501 "counter. record data length is %u.\n",
1502 path, (unsigned int)value.dsize));
1507 * Note: the tdb_unpack check above implies that len <= value.dsize
1509 buflen = value.dsize - len;
1510 buf = (const char *)value.dptr + len;
1514 for (i = 0; i < num_items; i++) {
1518 len = strnlen(buf, buflen) + 1;
1520 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record "
1521 "for key [%s] is corrupt: %u items expected, "
1522 "item number %u is not zero terminated.\n",
1523 path, num_items, i+1));
1532 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1533 "[%s] is corrupt: %u items expected and found, but "
1534 "the record contains additional %u bytes\n",
1535 path, num_items, buflen));
1539 if (i < num_items) {
1540 DEBUG(1, ("regdb_key_exists: ERROR: subkeylist-record for key "
1541 "[%s] is corrupt: %u items expected, but only %u "
1543 path, num_items, i+1));
1550 TALLOC_FREE(mem_ctx);
1555 /***********************************************************************
1556 Retrieve an array of strings containing subkeys. Memory should be
1557 released by the caller.
1558 ***********************************************************************/
1560 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1561 struct regsubkey_ctr *ctr)
1569 TALLOC_CTX *frame = talloc_stackframe();
1572 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1574 if (!regdb_key_exists(db, key)) {
1575 DEBUG(10, ("key [%s] not found\n", key));
1576 werr = WERR_NOT_FOUND;
1580 werr = regsubkey_ctr_reinit(ctr);
1581 W_ERROR_NOT_OK_GOTO_DONE(werr);
1583 werr = regsubkey_ctr_set_seqnum(ctr, db->get_seqnum(db));
1584 W_ERROR_NOT_OK_GOTO_DONE(werr);
1586 value = regdb_fetch_key_internal(db, frame, key);
1588 if (value.dsize == 0 || value.dptr == NULL) {
1589 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1595 buflen = value.dsize;
1596 len = tdb_unpack( buf, buflen, "d", &num_items);
1597 if (len == (uint32_t)-1) {
1598 werr = WERR_NOT_FOUND;
1602 for (i=0; i<num_items; i++) {
1603 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1604 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1605 if (!W_ERROR_IS_OK(werr)) {
1606 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1607 "failed: %s\n", win_errstr(werr)));
1613 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1620 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1624 werr = regdb_fetch_keys_internal(regdb, key, ctr);
1625 if (!W_ERROR_IS_OK(werr)) {
1629 return regsubkey_ctr_numkeys(ctr);
1632 /****************************************************************************
1633 Unpack a list of registry values frem the TDB
1634 ***************************************************************************/
1636 static int regdb_unpack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1643 uint32 num_values = 0;
1646 /* loop and unpack the rest of the registry values */
1648 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1650 for ( i=0; i<num_values; i++ ) {
1651 /* unpack the next regval */
1656 valuename[0] = '\0';
1657 len += tdb_unpack(buf+len, buflen-len, "fdB",
1663 regval_ctr_addvalue(values, valuename, type,
1664 (uint8_t *)data_p, size);
1665 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1667 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1673 /****************************************************************************
1674 Pack all values in all printer keys
1675 ***************************************************************************/
1677 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1681 struct regval_blob *val;
1687 num_values = regval_ctr_numvals( values );
1689 /* pack the number of values first */
1691 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1693 /* loop over all values */
1695 for ( i=0; i<num_values; i++ ) {
1696 val = regval_ctr_specific_value( values, i );
1697 len += tdb_pack(buf+len, buflen-len, "fdB",
1701 regval_data_p(val) );
1707 /***********************************************************************
1708 Retrieve an array of strings containing subkeys. Memory should be
1709 released by the caller.
1710 ***********************************************************************/
1712 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1713 struct regval_ctr *values)
1715 char *keystr = NULL;
1716 TALLOC_CTX *ctx = talloc_stackframe();
1721 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1723 if (!regdb_key_exists(db, key)) {
1727 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key);
1732 werr = regval_ctr_set_seqnum(values, db->get_seqnum(db));
1733 W_ERROR_NOT_OK_GOTO_DONE(werr);
1735 value = regdb_fetch_key_internal(db, ctx, keystr);
1738 /* all keys have zero values by default */
1742 regdb_unpack_values(values, value.dptr, value.dsize);
1743 ret = regval_ctr_numvals(values);
1750 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1752 return regdb_fetch_values_internal(regdb, key, values);
1755 static NTSTATUS regdb_store_values_internal(struct db_context *db,
1757 struct regval_ctr *values)
1759 TDB_DATA old_data, data;
1760 char *keystr = NULL;
1761 TALLOC_CTX *ctx = talloc_stackframe();
1765 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1767 if (!regdb_key_exists(db, key)) {
1768 status = NT_STATUS_NOT_FOUND;
1774 len = regdb_pack_values(values, data.dptr, data.dsize);
1776 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1777 status = NT_STATUS_UNSUCCESSFUL;
1781 data.dptr = talloc_array(ctx, uint8, len);
1784 len = regdb_pack_values(values, data.dptr, data.dsize);
1786 SMB_ASSERT( len == data.dsize );
1788 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key );
1790 status = NT_STATUS_NO_MEMORY;
1793 keystr = normalize_reg_path(ctx, keystr);
1798 old_data = dbwrap_fetch_bystring(db, ctx, keystr);
1800 if ((old_data.dptr != NULL)
1801 && (old_data.dsize == data.dsize)
1802 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1804 status = NT_STATUS_OK;
1808 status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1815 struct regdb_store_values_ctx {
1817 struct regval_ctr *values;
1820 static NTSTATUS regdb_store_values_action(struct db_context *db,
1824 struct regdb_store_values_ctx *ctx =
1825 (struct regdb_store_values_ctx *)private_data;
1827 status = regdb_store_values_internal(db, ctx->key, ctx->values);
1832 bool regdb_store_values(const char *key, struct regval_ctr *values)
1835 struct regdb_store_values_ctx ctx;
1838 ctx.values = values;
1840 werr = regdb_trans_do(regdb, regdb_store_values_action, &ctx);
1842 return W_ERROR_IS_OK(werr);
1845 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1846 struct security_descriptor **psecdesc)
1851 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1852 WERROR err = WERR_OK;
1854 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1856 if (!regdb_key_exists(regdb, key)) {
1861 tdbkey = talloc_asprintf(tmp_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1862 if (tdbkey == NULL) {
1867 tdbkey = normalize_reg_path(tmp_ctx, tdbkey);
1868 if (tdbkey == NULL) {
1873 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1874 if (data.dptr == NULL) {
1879 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1882 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1884 } else if (!NT_STATUS_IS_OK(status)) {
1885 err = WERR_REG_CORRUPT;
1889 TALLOC_FREE(tmp_ctx);
1893 struct regdb_set_secdesc_ctx {
1895 struct security_descriptor *secdesc;
1898 static NTSTATUS regdb_set_secdesc_action(struct db_context *db,
1904 struct regdb_set_secdesc_ctx *ctx =
1905 (struct regdb_set_secdesc_ctx *)private_data;
1906 TALLOC_CTX *frame = talloc_stackframe();
1908 tdbkey = talloc_asprintf(frame, "%s\\%s", REG_SECDESC_PREFIX, ctx->key);
1909 if (tdbkey == NULL) {
1913 tdbkey = normalize_reg_path(frame, tdbkey);
1914 if (tdbkey == NULL) {
1915 status = NT_STATUS_NO_MEMORY;
1919 if (ctx->secdesc == NULL) {
1920 /* assuming a delete */
1921 status = dbwrap_delete_bystring(db, tdbkey);
1925 status = marshall_sec_desc(frame, ctx->secdesc, &tdbdata.dptr,
1927 if (!NT_STATUS_IS_OK(status)) {
1931 status = dbwrap_store_bystring(db, tdbkey, tdbdata, 0);
1938 static WERROR regdb_set_secdesc(const char *key,
1939 struct security_descriptor *secdesc)
1942 struct regdb_set_secdesc_ctx ctx;
1944 if (!regdb_key_exists(regdb, key)) {
1950 ctx.secdesc = secdesc;
1952 err = regdb_trans_do(regdb, regdb_set_secdesc_action, &ctx);
1958 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1960 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1963 bool regdb_values_need_update(struct regval_ctr *values)
1965 return (regdb_get_seqnum() != regval_ctr_get_seqnum(values));
1969 * Table of function pointers for default access
1972 struct registry_ops regdb_ops = {
1973 .fetch_subkeys = regdb_fetch_keys,
1974 .fetch_values = regdb_fetch_values,
1975 .store_subkeys = regdb_store_keys,
1976 .store_values = regdb_store_values,
1977 .create_subkey = regdb_create_subkey,
1978 .delete_subkey = regdb_delete_subkey,
1979 .get_secdesc = regdb_get_secdesc,
1980 .set_secdesc = regdb_set_secdesc,
1981 .subkeys_need_update = regdb_subkeys_need_update,
1982 .values_need_update = regdb_values_need_update