2 * Unix SMB/CIFS implementation.
3 * Virtual Windows Registry Layer
4 * Copyright (C) Gerald Carter 2002-2005
5 * Copyright (C) Michael Adam 2007-2009
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 /* Implementation of internal registry database functions. */
26 #define DBGC_CLASS DBGC_REGISTRY
28 static struct db_context *regdb = NULL;
29 static int regdb_refcount;
31 static bool regdb_key_exists(struct db_context *db, const char *key);
32 static bool regdb_key_is_base_key(const char *key);
33 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
34 struct regsubkey_ctr *ctr);
35 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
36 struct regsubkey_ctr *ctr);
37 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
38 struct regval_ctr *values);
39 static bool regdb_store_values_internal(struct db_context *db, const char *key,
40 struct regval_ctr *values);
42 /* List the deepest path into the registry. All part components will be created.*/
44 /* If you want to have a part of the path controlled by the tdb and part by
45 a virtual registry db (e.g. printing), then you have to list the deepest path.
46 For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
47 allows the reg_db backend to handle everything up to
48 "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
49 the reg_printing backend onto the last component of the path (see
50 KEY_PRINTING_2K in include/rpc_reg.h) --jerry */
52 static const char *builtin_registry_paths[] = {
62 KEY_SAMBA_GROUP_POLICY,
63 KEY_GP_MACHINE_POLICY,
64 KEY_GP_MACHINE_WIN_POLICY,
67 KEY_GP_USER_WIN_POLICY,
68 KEY_WINLOGON_GPEXT_PATH,
69 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
71 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
80 struct builtin_regkey_value {
82 const char *valuename;
90 static struct builtin_regkey_value builtin_registry_values[] = {
92 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
94 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
96 "DisplayName", REG_SZ, { "Event Log" } },
98 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
99 { NULL, NULL, 0, { NULL } }
103 * Initialize a key in the registry:
104 * create each component key of the specified path.
106 static WERROR init_registry_key_internal(struct db_context *db,
107 const char *add_path)
110 TALLOC_CTX *frame = talloc_stackframe();
113 char *remaining = NULL;
116 struct regsubkey_ctr *subkeys;
119 DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path));
121 path = talloc_strdup(frame, add_path);
122 base = talloc_strdup(frame, "");
123 if (!path || !base) {
129 while (next_token_talloc(frame, &p, &keyname, "\\")) {
131 /* build up the registry path from the components */
134 base = talloc_asprintf(frame, "%s\\", base);
140 base = talloc_asprintf_append(base, "%s", keyname);
146 /* get the immediate subkeyname (if we have one ) */
148 subkeyname = talloc_strdup(frame, "");
154 remaining = talloc_strdup(frame, p);
161 if (!next_token_talloc(frame, &p2,
164 subkeyname = talloc_strdup(frame,p2);
172 DEBUG(10,("init_registry_key: Storing key [%s] with "
173 "subkey [%s]\n", base,
174 *subkeyname ? subkeyname : "NULL"));
176 /* we don't really care if the lookup succeeds or not
177 * since we are about to update the record.
178 * We just want any subkeys already present */
180 werr = regsubkey_ctr_init(frame, &subkeys);
181 if (!W_ERROR_IS_OK(werr)) {
182 DEBUG(0,("talloc() failure!\n"));
186 werr = regdb_fetch_keys_internal(db, base, subkeys);
187 if (!W_ERROR_IS_OK(werr) &&
188 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
194 werr = regsubkey_ctr_addkey(subkeys, subkeyname);
195 if (!W_ERROR_IS_OK(werr)) {
199 if (!regdb_store_keys_internal(db, base, subkeys)) {
200 werr = WERR_CAN_NOT_COMPLETE;
212 struct init_registry_key_context {
213 const char *add_path;
216 static NTSTATUS init_registry_key_action(struct db_context *db,
219 struct init_registry_key_context *init_ctx =
220 (struct init_registry_key_context *)private_data;
222 return werror_to_ntstatus(init_registry_key_internal(
223 db, init_ctx->add_path));
227 * Initialize a key in the registry:
228 * create each component key of the specified path,
229 * wrapped in one db transaction.
231 WERROR init_registry_key(const char *add_path)
233 struct init_registry_key_context init_ctx;
235 if (regdb_key_exists(regdb, add_path)) {
239 init_ctx.add_path = add_path;
241 return ntstatus_to_werror(dbwrap_trans_do(regdb,
242 init_registry_key_action,
246 /***********************************************************************
247 Open the registry data in the tdb
248 ***********************************************************************/
250 static void regdb_ctr_add_value(struct regval_ctr *ctr,
251 struct builtin_regkey_value *value)
253 switch(value->type) {
255 regval_ctr_addvalue(ctr, value->valuename, REG_DWORD,
256 (char*)&value->data.dw_value,
261 regval_ctr_addvalue_sz(ctr, value->valuename,
266 DEBUG(0, ("regdb_ctr_add_value: invalid value type in "
267 "registry values [%d]\n", value->type));
271 static NTSTATUS init_registry_data_action(struct db_context *db,
275 TALLOC_CTX *frame = talloc_stackframe();
276 struct regval_ctr *values;
279 /* loop over all of the predefined paths and add each component */
281 for (i=0; builtin_registry_paths[i] != NULL; i++) {
282 if (regdb_key_exists(db, builtin_registry_paths[i])) {
285 status = werror_to_ntstatus(init_registry_key_internal(db,
286 builtin_registry_paths[i]));
287 if (!NT_STATUS_IS_OK(status)) {
292 /* loop over all of the predefined values and add each component */
294 for (i=0; builtin_registry_values[i].path != NULL; i++) {
296 values = TALLOC_ZERO_P(frame, struct regval_ctr);
297 if (values == NULL) {
298 status = NT_STATUS_NO_MEMORY;
302 regdb_fetch_values_internal(db,
303 builtin_registry_values[i].path,
306 /* preserve existing values across restarts. Only add new ones */
308 if (!regval_ctr_key_exists(values,
309 builtin_registry_values[i].valuename))
311 regdb_ctr_add_value(values,
312 &builtin_registry_values[i]);
313 regdb_store_values_internal(db,
314 builtin_registry_values[i].path,
320 status = NT_STATUS_OK;
328 WERROR init_registry_data(void)
331 TALLOC_CTX *frame = talloc_stackframe();
332 struct regval_ctr *values;
336 * First, check for the existence of the needed keys and values.
337 * If all do already exist, we can save the writes.
339 for (i=0; builtin_registry_paths[i] != NULL; i++) {
340 if (!regdb_key_exists(regdb, builtin_registry_paths[i])) {
345 for (i=0; builtin_registry_values[i].path != NULL; i++) {
346 values = TALLOC_ZERO_P(frame, struct regval_ctr);
347 if (values == NULL) {
352 regdb_fetch_values_internal(regdb,
353 builtin_registry_values[i].path,
355 if (!regval_ctr_key_exists(values,
356 builtin_registry_values[i].valuename))
371 * There are potentially quite a few store operations which are all
372 * indiviually wrapped in tdb transactions. Wrapping them in a single
373 * transaction gives just a single transaction_commit() to actually do
374 * its fsync()s. See tdb/common/transaction.c for info about nested
375 * transaction behaviour.
378 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
379 init_registry_data_action,
387 /***********************************************************************
388 Open the registry database
389 ***********************************************************************/
391 WERROR regdb_init(void)
393 const char *vstring = "INFO/version";
398 DEBUG(10, ("regdb_init: incrementing refcount (%d)\n",
404 regdb = db_open(NULL, state_path("registry.tdb"), 0,
405 REG_TDB_FLAGS, O_RDWR, 0600);
407 regdb = db_open(NULL, state_path("registry.tdb"), 0,
408 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
410 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
411 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
412 state_path("registry.tdb"), strerror(errno) ));
416 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
421 vers_id = dbwrap_fetch_int32(regdb, vstring);
423 if ( vers_id != REGVER_V1 ) {
425 /* any upgrade code here if needed */
426 DEBUG(10, ("regdb_init: got %s = %d != %d\n", vstring,
427 vers_id, REGVER_V1));
428 status = dbwrap_trans_store_int32(regdb, vstring, REGVER_V1);
429 if (!NT_STATUS_IS_OK(status)) {
430 DEBUG(1, ("regdb_init: error storing %s = %d: %s\n",
431 vstring, REGVER_V1, nt_errstr(status)));
432 return ntstatus_to_werror(status);
434 DEBUG(10, ("regdb_init: stored %s = %d\n",
435 vstring, REGVER_V1));
442 /***********************************************************************
443 Open the registry. Must already have been initialized by regdb_init()
444 ***********************************************************************/
446 WERROR regdb_open( void )
448 WERROR result = WERR_OK;
451 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount));
458 regdb = db_open(NULL, state_path("registry.tdb"), 0,
459 REG_TDB_FLAGS, O_RDWR, 0600);
461 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
462 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
463 state_path("registry.tdb"), strerror(errno) ));
469 DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount));
474 /***********************************************************************
475 ***********************************************************************/
477 int regdb_close( void )
479 if (regdb_refcount == 0) {
485 DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount));
487 if ( regdb_refcount > 0 )
490 SMB_ASSERT( regdb_refcount >= 0 );
496 WERROR regdb_transaction_start(void)
498 return (regdb->transaction_start(regdb) == 0) ?
499 WERR_OK : WERR_REG_IO_FAILURE;
502 WERROR regdb_transaction_commit(void)
504 return (regdb->transaction_commit(regdb) == 0) ?
505 WERR_OK : WERR_REG_IO_FAILURE;
508 WERROR regdb_transaction_cancel(void)
510 return (regdb->transaction_cancel(regdb) == 0) ?
511 WERR_OK : WERR_REG_IO_FAILURE;
514 /***********************************************************************
515 return the tdb sequence number of the registry tdb.
516 this is an indicator for the content of the registry
517 having changed. it will change upon regdb_init, too, though.
518 ***********************************************************************/
519 int regdb_get_seqnum(void)
521 return regdb->get_seqnum(regdb);
525 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
530 WERROR werr = WERR_NOMEM;
531 TALLOC_CTX *mem_ctx = talloc_stackframe();
533 if (keyname == NULL) {
534 werr = WERR_INVALID_PARAM;
538 if (prefix == NULL) {
539 path = discard_const_p(char, keyname);
541 path = talloc_asprintf(mem_ctx, "%s/%s", prefix, keyname);
547 path = normalize_reg_path(mem_ctx, path);
552 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
554 /* treat "not" found" as ok */
555 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
560 talloc_free(mem_ctx);
565 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
567 return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
570 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
572 return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
575 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
577 return regdb_delete_key_with_prefix(db, keyname, NULL);
580 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
584 werr = regdb_delete_values(db, keyname);
585 if (!W_ERROR_IS_OK(werr)) {
586 DEBUG(1, (__location__ " Deleting %s/%s failed: %s\n",
587 REG_VALUE_PREFIX, keyname, win_errstr(werr)));
591 werr = regdb_delete_secdesc(db, keyname);
592 if (!W_ERROR_IS_OK(werr)) {
593 DEBUG(1, (__location__ " Deleting %s/%s failed: %s\n",
594 REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
598 werr = regdb_delete_subkeylist(db, keyname);
599 if (!W_ERROR_IS_OK(werr)) {
600 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
601 keyname, win_errstr(werr)));
609 /***********************************************************************
610 Add subkey strings to the registry tdb under a defined key
611 fmt is the same format as tdb_pack except this function only supports
613 ***********************************************************************/
615 static WERROR regdb_store_keys_internal2(struct db_context *db,
617 struct regsubkey_ctr *ctr)
620 uint8 *buffer = NULL;
623 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
624 char *keyname = NULL;
625 TALLOC_CTX *ctx = talloc_stackframe();
629 werr = WERR_INVALID_PARAM;
633 keyname = talloc_strdup(ctx, key);
639 keyname = normalize_reg_path(ctx, keyname);
645 /* allocate some initial memory */
647 buffer = (uint8 *)SMB_MALLOC(1024);
648 if (buffer == NULL) {
655 /* store the number of subkeys */
657 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
659 /* pack all the strings */
661 for (i=0; i<num_subkeys; i++) {
664 thistime = tdb_pack(buffer+len, buflen-len, "f",
665 regsubkey_ctr_specific_key(ctr, i));
666 if (len+thistime > buflen) {
669 * tdb_pack hasn't done anything because of the short
670 * buffer, allocate extra space.
672 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
675 DEBUG(0, ("regdb_store_keys: Failed to realloc "
676 "memory of size [%u]\n",
677 (unsigned int)(len+thistime)*2));
681 buflen = (len+thistime)*2;
682 thistime2 = tdb_pack(
683 buffer+len, buflen-len, "f",
684 regsubkey_ctr_specific_key(ctr, i));
685 if (thistime2 != thistime) {
686 DEBUG(0, ("tdb_pack failed\n"));
687 werr = WERR_CAN_NOT_COMPLETE;
694 /* finally write out the data */
698 werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
700 W_ERROR_NOT_OK_GOTO_DONE(werr);
703 * Delete a sorted subkey cache for regdb_key_exists, will be
704 * recreated automatically
706 keyname = talloc_asprintf(ctx, "%s/%s", REG_SORTED_SUBKEYS_PREFIX,
708 if (keyname == NULL) {
713 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, keyname));
715 /* don't treat WERR_NOT_FOUND as an error here */
716 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
726 /***********************************************************************
727 Store the new subkey record and create any child key records that
728 do not currently exist
729 ***********************************************************************/
731 struct regdb_store_keys_context {
733 struct regsubkey_ctr *ctr;
736 static NTSTATUS regdb_store_keys_action(struct db_context *db,
739 struct regdb_store_keys_context *store_ctx;
743 struct regsubkey_ctr *subkeys = NULL, *old_subkeys = NULL;
744 char *oldkeyname = NULL;
745 TALLOC_CTX *mem_ctx = talloc_stackframe();
747 store_ctx = (struct regdb_store_keys_context *)private_data;
750 * Re-fetch the old keys inside the transaction
753 werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
754 W_ERROR_NOT_OK_GOTO_DONE(werr);
756 werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
757 if (!W_ERROR_IS_OK(werr) &&
758 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
764 * Make the store operation as safe as possible without transactions:
766 * (1) For each subkey removed from ctr compared with old_subkeys:
768 * (a) First delete the value db entry.
770 * (b) Next delete the secdesc db record.
772 * (c) Then delete the subkey list entry.
774 * (2) Now write the list of subkeys of the parent key,
775 * deleting removed entries and adding new ones.
777 * (3) Finally create the subkey list entries for the added keys.
779 * This way if we crash half-way in between deleting the subkeys
780 * and storing the parent's list of subkeys, no old data can pop up
781 * out of the blue when re-adding keys later on.
784 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
786 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
787 for (i=0; i<num_subkeys; i++) {
788 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
790 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
792 * It's still around, don't delete
797 path = talloc_asprintf(mem_ctx, "%s/%s", store_ctx->key,
804 werr = regdb_delete_key_lists(db, path);
805 W_ERROR_NOT_OK_GOTO_DONE(werr);
810 TALLOC_FREE(old_subkeys);
812 /* (2) store the subkey list for the parent */
814 werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
815 if (!W_ERROR_IS_OK(werr)) {
816 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
817 "for parent [%s]: %s\n", store_ctx->key,
822 /* (3) now create records for any subkeys that don't already exist */
824 num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
826 if (num_subkeys == 0) {
827 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
828 W_ERROR_NOT_OK_GOTO_DONE(werr);
830 werr = regdb_store_keys_internal2(db, store_ctx->key, subkeys);
831 if (!W_ERROR_IS_OK(werr)) {
832 DEBUG(0,("regdb_store_keys: Failed to store "
833 "new record for key [%s]: %s\n",
834 store_ctx->key, win_errstr(werr)));
837 TALLOC_FREE(subkeys);
840 for (i=0; i<num_subkeys; i++) {
841 path = talloc_asprintf(mem_ctx, "%s/%s", store_ctx->key,
842 regsubkey_ctr_specific_key(store_ctx->ctr, i));
847 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
848 W_ERROR_NOT_OK_GOTO_DONE(werr);
850 werr = regdb_fetch_keys_internal(db, path, subkeys);
851 if (!W_ERROR_IS_OK(werr)) {
852 /* create a record with 0 subkeys */
853 werr = regdb_store_keys_internal2(db, path, subkeys);
854 if (!W_ERROR_IS_OK(werr)) {
855 DEBUG(0,("regdb_store_keys: Failed to store "
856 "new record for key [%s]: %s\n", path,
862 TALLOC_FREE(subkeys);
869 talloc_free(mem_ctx);
870 return werror_to_ntstatus(werr);
873 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
874 struct regsubkey_ctr *ctr)
876 int num_subkeys, old_num_subkeys, i;
877 struct regsubkey_ctr *old_subkeys = NULL;
878 TALLOC_CTX *ctx = talloc_stackframe();
881 struct regdb_store_keys_context store_ctx;
883 if (!regdb_key_is_base_key(key) && !regdb_key_exists(db, key)) {
888 * fetch a list of the old subkeys so we can determine if anything has
892 werr = regsubkey_ctr_init(ctx, &old_subkeys);
893 if (!W_ERROR_IS_OK(werr)) {
894 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
898 werr = regdb_fetch_keys_internal(db, key, old_subkeys);
899 if (!W_ERROR_IS_OK(werr) &&
900 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
905 num_subkeys = regsubkey_ctr_numkeys(ctr);
906 old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
907 if ((num_subkeys && old_num_subkeys) &&
908 (num_subkeys == old_num_subkeys)) {
910 for (i = 0; i < num_subkeys; i++) {
911 if (strcmp(regsubkey_ctr_specific_key(ctr, i),
912 regsubkey_ctr_specific_key(old_subkeys, i))
918 if (i == num_subkeys) {
920 * Nothing changed, no point to even start a tdb
929 TALLOC_FREE(old_subkeys);
934 werr = ntstatus_to_werror(dbwrap_trans_do(db,
935 regdb_store_keys_action,
938 ret = W_ERROR_IS_OK(werr);
946 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
948 return regdb_store_keys_internal(regdb, key, ctr);
952 * create a subkey of a given key
955 struct regdb_create_subkey_context {
960 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
964 struct regdb_create_subkey_context *create_ctx;
965 struct regsubkey_ctr *subkeys;
966 TALLOC_CTX *mem_ctx = talloc_stackframe();
968 create_ctx = (struct regdb_create_subkey_context *)private_data;
970 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
971 W_ERROR_NOT_OK_GOTO_DONE(werr);
973 werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
974 W_ERROR_NOT_OK_GOTO_DONE(werr);
976 werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
977 W_ERROR_NOT_OK_GOTO_DONE(werr);
979 werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
980 if (!W_ERROR_IS_OK(werr)) {
981 DEBUG(0, (__location__ " failed to store new subkey list for "
982 "parent key %s: %s\n", create_ctx->key,
987 talloc_free(mem_ctx);
988 return werror_to_ntstatus(werr);
991 static WERROR regdb_create_subkey(const char *key, const char *subkey)
994 struct regsubkey_ctr *subkeys;
995 TALLOC_CTX *mem_ctx = talloc_stackframe();
996 struct regdb_create_subkey_context create_ctx;
998 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
999 werr = WERR_NOT_FOUND;
1003 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1004 W_ERROR_NOT_OK_GOTO_DONE(werr);
1006 werr = regdb_fetch_keys_internal(regdb, key, subkeys);
1007 W_ERROR_NOT_OK_GOTO_DONE(werr);
1009 if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1014 talloc_free(subkeys);
1016 create_ctx.key = key;
1017 create_ctx.subkey = subkey;
1019 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1020 regdb_create_subkey_action,
1024 talloc_free(mem_ctx);
1029 * create a subkey of a given key
1032 struct regdb_delete_subkey_context {
1038 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1042 struct regdb_delete_subkey_context *delete_ctx;
1043 struct regsubkey_ctr *subkeys;
1044 TALLOC_CTX *mem_ctx = talloc_stackframe();
1046 delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1048 werr = regdb_delete_key_lists(db, delete_ctx->path);
1049 W_ERROR_NOT_OK_GOTO_DONE(werr);
1051 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1052 W_ERROR_NOT_OK_GOTO_DONE(werr);
1054 werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1055 W_ERROR_NOT_OK_GOTO_DONE(werr);
1057 werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1058 W_ERROR_NOT_OK_GOTO_DONE(werr);
1060 werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1061 if (!W_ERROR_IS_OK(werr)) {
1062 DEBUG(0, (__location__ " failed to store new subkey_list for "
1063 "parent key %s: %s\n", delete_ctx->key,
1068 talloc_free(mem_ctx);
1069 return werror_to_ntstatus(werr);
1072 static WERROR regdb_delete_subkey(const char *key, const char *subkey)
1076 struct regdb_delete_subkey_context delete_ctx;
1077 TALLOC_CTX *mem_ctx = talloc_stackframe();
1079 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
1080 werr = WERR_NOT_FOUND;
1084 path = talloc_asprintf(mem_ctx, "%s/%s", key, subkey);
1090 if (!regdb_key_exists(regdb, path)) {
1095 delete_ctx.key = key;
1096 delete_ctx.subkey = subkey;
1097 delete_ctx.path = path;
1099 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1100 regdb_delete_subkey_action,
1104 talloc_free(mem_ctx);
1108 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1109 TALLOC_CTX *mem_ctx, const char *key)
1114 path = normalize_reg_path(mem_ctx, key);
1116 return make_tdb_data(NULL, 0);
1119 data = dbwrap_fetch_bystring(db, mem_ctx, path);
1127 * check whether a given key name represents a base key,
1128 * i.e one without a subkey separator ('/' or '\').
1130 static bool regdb_key_is_base_key(const char *key)
1132 TALLOC_CTX *mem_ctx = talloc_stackframe();
1140 path = normalize_reg_path(mem_ctx, key);
1142 DEBUG(0, ("out of memory! (talloc failed)\n"));
1146 if (*path == '\0') {
1150 ret = (strrchr(path, '/') == NULL);
1153 TALLOC_FREE(mem_ctx);
1158 * regdb_key_exists() is a very frequent operation. It can be quite
1159 * time-consuming to fully fetch the parent's subkey list, talloc_strdup all
1160 * subkeys and then compare the keyname linearly to all the parent's subkeys.
1162 * The following code tries to make this operation as efficient as possible:
1163 * Per registry key we create a list of subkeys that is very efficient to
1164 * search for existence of a subkey. Its format is:
1166 * 4 bytes num_subkeys
1167 * 4*num_subkey bytes offset into the string array
1168 * then follows a sorted list of subkeys in uppercase
1170 * This record is created by create_sorted_subkeys() on demand if it does not
1171 * exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
1172 * list, the parsing code and the binary search can be found in
1173 * parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
1174 * the potentially large subkey record.
1176 * The sorted subkey record is deleted in regdb_store_keys_internal2 and
1177 * recreated on demand.
1180 static int cmp_keynames(const void *p1, const void *p2)
1182 return StrCaseCmp(*((char **)p1), *((char **)p2));
1185 struct create_sorted_subkeys_context {
1187 const char *sorted_keyname;
1190 static NTSTATUS create_sorted_subkeys_action(struct db_context *db,
1193 char **sorted_subkeys;
1194 struct regsubkey_ctr *ctr;
1201 struct create_sorted_subkeys_context *sorted_ctx;
1203 sorted_ctx = (struct create_sorted_subkeys_context *)private_data;
1206 * In this function, we only treat failing of the actual write to
1207 * the db as a real error. All preliminary errors, at a stage when
1208 * nothing has been written to the DB yet are treated as success
1209 * to be committed (as an empty transaction).
1211 * The reason is that this (disposable) call might be nested in other
1212 * transactions. Doing a cancel here would destroy the possibility of
1213 * a transaction_commit for transactions that we might be wrapped in.
1216 status = werror_to_ntstatus(regsubkey_ctr_init(talloc_tos(), &ctr));
1217 if (!NT_STATUS_IS_OK(status)) {
1218 /* don't treat this as an error */
1219 status = NT_STATUS_OK;
1223 status = werror_to_ntstatus(regdb_fetch_keys_internal(db,
1226 if (!NT_STATUS_IS_OK(status)) {
1227 /* don't treat this as an error */
1228 status = NT_STATUS_OK;
1232 num_subkeys = regsubkey_ctr_numkeys(ctr);
1233 sorted_subkeys = talloc_array(ctr, char *, num_subkeys);
1234 if (sorted_subkeys == NULL) {
1235 /* don't treat this as an error */
1239 len = 4 + 4*num_subkeys;
1241 for (i = 0; i < num_subkeys; i++) {
1242 sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
1243 regsubkey_ctr_specific_key(ctr, i));
1244 if (sorted_subkeys[i] == NULL) {
1245 /* don't treat this as an error */
1248 len += strlen(sorted_subkeys[i])+1;
1251 qsort(sorted_subkeys, num_subkeys, sizeof(char *), cmp_keynames);
1253 buf = talloc_array(ctr, char, len);
1255 /* don't treat this as an error */
1258 p = buf + 4 + 4*num_subkeys;
1260 SIVAL(buf, 0, num_subkeys);
1262 for (i=0; i < num_subkeys; i++) {
1263 ptrdiff_t offset = p - buf;
1264 SIVAL(buf, 4 + 4*i, offset);
1265 strlcpy(p, sorted_subkeys[i], len-offset);
1266 p += strlen(sorted_subkeys[i]) + 1;
1269 status = dbwrap_store_bystring(
1270 db, sorted_ctx->sorted_keyname, make_tdb_data((uint8_t *)buf,
1279 static bool create_sorted_subkeys(const char *key, const char *sorted_keyname)
1282 struct create_sorted_subkeys_context sorted_ctx;
1284 sorted_ctx.key = key;
1285 sorted_ctx.sorted_keyname = sorted_keyname;
1287 status = dbwrap_trans_do(regdb,
1288 create_sorted_subkeys_action,
1291 return NT_STATUS_IS_OK(status);
1294 struct scan_subkey_state {
1300 static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
1303 struct scan_subkey_state *state =
1304 (struct scan_subkey_state *)private_data;
1305 uint32_t num_subkeys;
1308 if (data.dsize < sizeof(uint32_t)) {
1312 state->scanned = true;
1313 state->found = false;
1315 tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
1321 uint32_t idx = (l+u)/2;
1322 char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
1323 int comparison = strcmp(state->name, s);
1325 if (comparison < 0) {
1327 } else if (comparison > 0) {
1330 state->found = true;
1337 static bool scan_parent_subkeys(struct db_context *db, const char *parent,
1342 struct scan_subkey_state state = { 0, };
1343 bool result = false;
1348 path = normalize_reg_path(talloc_tos(), parent);
1353 key = talloc_asprintf(talloc_tos(), "%s/%s",
1354 REG_SORTED_SUBKEYS_PREFIX, path);
1359 state.name = talloc_strdup_upper(talloc_tos(), name);
1360 if (state.name == NULL) {
1363 state.scanned = false;
1365 res = db->parse_record(db, string_term_tdb_data(key),
1366 parent_subkey_scanner, &state);
1368 if (state.scanned) {
1369 result = state.found;
1371 if (!create_sorted_subkeys(path, key)) {
1374 res = db->parse_record(db, string_term_tdb_data(key),
1375 parent_subkey_scanner, &state);
1376 if ((res == 0) && (state.scanned)) {
1377 result = state.found;
1383 TALLOC_FREE(state.name);
1388 * Check for the existence of a key.
1390 * Existence of a key is authoritatively defined by its
1391 * existence in the list of subkeys of its parent key.
1392 * The exeption of this are keys without a parent key,
1393 * i.e. the "base" keys (HKLM, HKCU, ...).
1395 static bool regdb_key_exists(struct db_context *db, const char *key)
1397 TALLOC_CTX *mem_ctx = talloc_stackframe();
1406 path = normalize_reg_path(mem_ctx, key);
1408 DEBUG(0, ("out of memory! (talloc failed)\n"));
1412 if (*path == '\0') {
1416 p = strrchr(path, '/');
1418 /* this is a base key */
1419 value = regdb_fetch_key_internal(db, mem_ctx, path);
1420 ret = (value.dptr != NULL);
1423 ret = scan_parent_subkeys(db, path, p+1);
1427 TALLOC_FREE(mem_ctx);
1432 /***********************************************************************
1433 Retrieve an array of strings containing subkeys. Memory should be
1434 released by the caller.
1435 ***********************************************************************/
1437 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1438 struct regsubkey_ctr *ctr)
1446 TALLOC_CTX *frame = talloc_stackframe();
1449 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1451 frame = talloc_stackframe();
1453 if (!regdb_key_exists(db, key)) {
1454 DEBUG(10, ("key [%s] not found\n", key));
1455 werr = WERR_NOT_FOUND;
1459 werr = regsubkey_ctr_set_seqnum(ctr, db->get_seqnum(db));
1460 W_ERROR_NOT_OK_GOTO_DONE(werr);
1462 value = regdb_fetch_key_internal(db, frame, key);
1464 if (value.dptr == NULL) {
1465 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1471 buflen = value.dsize;
1472 len = tdb_unpack( buf, buflen, "d", &num_items);
1474 werr = regsubkey_ctr_reinit(ctr);
1475 W_ERROR_NOT_OK_GOTO_DONE(werr);
1477 for (i=0; i<num_items; i++) {
1478 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1479 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1480 if (!W_ERROR_IS_OK(werr)) {
1481 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1482 "failed: %s\n", win_errstr(werr)));
1488 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1495 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1499 werr = regdb_fetch_keys_internal(regdb, key, ctr);
1500 if (!W_ERROR_IS_OK(werr)) {
1504 return regsubkey_ctr_numkeys(ctr);
1507 /****************************************************************************
1508 Unpack a list of registry values frem the TDB
1509 ***************************************************************************/
1511 static int regdb_unpack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1518 uint32 num_values = 0;
1521 /* loop and unpack the rest of the registry values */
1523 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1525 for ( i=0; i<num_values; i++ ) {
1526 /* unpack the next regval */
1531 valuename[0] = '\0';
1532 len += tdb_unpack(buf+len, buflen-len, "fdB",
1538 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1540 if (*valuename && size && data_p) {
1541 regval_ctr_addvalue(values, valuename, type,
1542 (const char *)data_p, size);
1544 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1546 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1552 /****************************************************************************
1553 Pack all values in all printer keys
1554 ***************************************************************************/
1556 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1560 struct regval_blob *val;
1566 num_values = regval_ctr_numvals( values );
1568 /* pack the number of values first */
1570 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1572 /* loop over all values */
1574 for ( i=0; i<num_values; i++ ) {
1575 val = regval_ctr_specific_value( values, i );
1576 len += tdb_pack(buf+len, buflen-len, "fdB",
1580 regval_data_p(val) );
1586 /***********************************************************************
1587 Retrieve an array of strings containing subkeys. Memory should be
1588 released by the caller.
1589 ***********************************************************************/
1591 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1592 struct regval_ctr *values)
1594 char *keystr = NULL;
1595 TALLOC_CTX *ctx = talloc_stackframe();
1599 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1601 if (!regdb_key_exists(db, key)) {
1605 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
1610 values->seqnum = db->get_seqnum(db);
1612 value = regdb_fetch_key_internal(db, ctx, keystr);
1615 /* all keys have zero values by default */
1619 regdb_unpack_values(values, value.dptr, value.dsize);
1620 ret = regval_ctr_numvals(values);
1627 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1629 return regdb_fetch_values_internal(regdb, key, values);
1632 static bool regdb_store_values_internal(struct db_context *db, const char *key,
1633 struct regval_ctr *values)
1635 TDB_DATA old_data, data;
1636 char *keystr = NULL;
1637 TALLOC_CTX *ctx = talloc_stackframe();
1640 bool result = false;
1642 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1644 if (!regdb_key_exists(db, key)) {
1650 len = regdb_pack_values(values, data.dptr, data.dsize);
1652 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1656 data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1659 len = regdb_pack_values(values, data.dptr, data.dsize);
1661 SMB_ASSERT( len == data.dsize );
1663 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
1667 keystr = normalize_reg_path(ctx, keystr);
1672 old_data = dbwrap_fetch_bystring(db, ctx, keystr);
1674 if ((old_data.dptr != NULL)
1675 && (old_data.dsize == data.dsize)
1676 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1682 status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1684 result = NT_STATUS_IS_OK(status);
1691 bool regdb_store_values(const char *key, struct regval_ctr *values)
1693 return regdb_store_values_internal(regdb, key, values);
1696 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1697 struct security_descriptor **psecdesc)
1702 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1703 WERROR err = WERR_OK;
1705 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1707 if (!regdb_key_exists(regdb, key)) {
1712 tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1713 if (tdbkey == NULL) {
1717 normalize_dbkey(tdbkey);
1719 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1720 if (data.dptr == NULL) {
1725 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1728 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1730 } else if (!NT_STATUS_IS_OK(status)) {
1731 err = WERR_REG_CORRUPT;
1735 TALLOC_FREE(tmp_ctx);
1739 static WERROR regdb_set_secdesc(const char *key,
1740 struct security_descriptor *secdesc)
1742 TALLOC_CTX *mem_ctx = talloc_stackframe();
1744 WERROR err = WERR_NOMEM;
1747 if (!regdb_key_exists(regdb, key)) {
1752 tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1753 if (tdbkey == NULL) {
1756 normalize_dbkey(tdbkey);
1758 if (secdesc == NULL) {
1759 /* assuming a delete */
1760 err = ntstatus_to_werror(dbwrap_trans_delete_bystring(regdb,
1765 err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1768 W_ERROR_NOT_OK_GOTO_DONE(err);
1770 err = ntstatus_to_werror(dbwrap_trans_store_bystring(regdb, tdbkey,
1774 TALLOC_FREE(mem_ctx);
1778 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1780 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1783 bool regdb_values_need_update(struct regval_ctr *values)
1785 return (regdb_get_seqnum() != values->seqnum);
1789 * Table of function pointers for default access
1792 struct registry_ops regdb_ops = {
1793 .fetch_subkeys = regdb_fetch_keys,
1794 .fetch_values = regdb_fetch_values,
1795 .store_subkeys = regdb_store_keys,
1796 .store_values = regdb_store_values,
1797 .create_subkey = regdb_create_subkey,
1798 .delete_subkey = regdb_delete_subkey,
1799 .get_secdesc = regdb_get_secdesc,
1800 .set_secdesc = regdb_set_secdesc,
1801 .subkeys_need_update = regdb_subkeys_need_update,
1802 .values_need_update = regdb_values_need_update