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 #include "reg_util_internal.h"
27 #include "reg_backend_db.h"
30 #define DBGC_CLASS DBGC_REGISTRY
32 static struct db_context *regdb = NULL;
33 static int regdb_refcount;
35 static bool regdb_key_exists(struct db_context *db, const char *key);
36 static bool regdb_key_is_base_key(const char *key);
37 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
38 struct regsubkey_ctr *ctr);
39 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
40 struct regsubkey_ctr *ctr);
41 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
42 struct regval_ctr *values);
43 static bool regdb_store_values_internal(struct db_context *db, const char *key,
44 struct regval_ctr *values);
46 /* List the deepest path into the registry. All part components will be created.*/
48 /* If you want to have a part of the path controlled by the tdb and part by
49 a virtual registry db (e.g. printing), then you have to list the deepest path.
50 For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
51 allows the reg_db backend to handle everything up to
52 "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
53 the reg_printing backend onto the last component of the path (see
54 KEY_PRINTING_2K in include/rpc_reg.h) --jerry */
56 static const char *builtin_registry_paths[] = {
66 KEY_SAMBA_GROUP_POLICY,
67 KEY_GP_MACHINE_POLICY,
68 KEY_GP_MACHINE_WIN_POLICY,
71 KEY_GP_USER_WIN_POLICY,
72 "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Winlogon\\GPExtensions",
73 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
75 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
84 struct builtin_regkey_value {
86 const char *valuename;
94 static struct builtin_regkey_value builtin_registry_values[] = {
96 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
98 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
100 "DisplayName", REG_SZ, { "Event Log" } },
102 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
103 { NULL, NULL, 0, { NULL } }
107 * Initialize a key in the registry:
108 * create each component key of the specified path.
110 static WERROR init_registry_key_internal(struct db_context *db,
111 const char *add_path)
114 TALLOC_CTX *frame = talloc_stackframe();
117 char *remaining = NULL;
120 struct regsubkey_ctr *subkeys;
123 DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path));
125 path = talloc_strdup(frame, add_path);
126 base = talloc_strdup(frame, "");
127 if (!path || !base) {
133 while (next_token_talloc(frame, &p, &keyname, "\\")) {
135 /* build up the registry path from the components */
138 base = talloc_asprintf(frame, "%s\\", base);
144 base = talloc_asprintf_append(base, "%s", keyname);
150 /* get the immediate subkeyname (if we have one ) */
152 subkeyname = talloc_strdup(frame, "");
158 remaining = talloc_strdup(frame, p);
165 if (!next_token_talloc(frame, &p2,
168 subkeyname = talloc_strdup(frame,p2);
176 DEBUG(10,("init_registry_key: Storing key [%s] with "
177 "subkey [%s]\n", base,
178 *subkeyname ? subkeyname : "NULL"));
180 /* we don't really care if the lookup succeeds or not
181 * since we are about to update the record.
182 * We just want any subkeys already present */
184 werr = regsubkey_ctr_init(frame, &subkeys);
185 if (!W_ERROR_IS_OK(werr)) {
186 DEBUG(0,("talloc() failure!\n"));
190 werr = regdb_fetch_keys_internal(db, base, subkeys);
191 if (!W_ERROR_IS_OK(werr) &&
192 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
198 werr = regsubkey_ctr_addkey(subkeys, subkeyname);
199 if (!W_ERROR_IS_OK(werr)) {
203 if (!regdb_store_keys_internal(db, base, subkeys)) {
204 werr = WERR_CAN_NOT_COMPLETE;
216 struct init_registry_key_context {
217 const char *add_path;
220 static NTSTATUS init_registry_key_action(struct db_context *db,
223 struct init_registry_key_context *init_ctx =
224 (struct init_registry_key_context *)private_data;
226 return werror_to_ntstatus(init_registry_key_internal(
227 db, init_ctx->add_path));
231 * Initialize a key in the registry:
232 * create each component key of the specified path,
233 * wrapped in one db transaction.
235 WERROR init_registry_key(const char *add_path)
237 struct init_registry_key_context init_ctx;
239 if (regdb_key_exists(regdb, add_path)) {
243 init_ctx.add_path = add_path;
245 return ntstatus_to_werror(dbwrap_trans_do(regdb,
246 init_registry_key_action,
250 /***********************************************************************
251 Open the registry data in the tdb
252 ***********************************************************************/
254 static void regdb_ctr_add_value(struct regval_ctr *ctr,
255 struct builtin_regkey_value *value)
257 switch(value->type) {
259 regval_ctr_addvalue(ctr, value->valuename, REG_DWORD,
260 (uint8_t *)&value->data.dw_value,
265 regval_ctr_addvalue_sz(ctr, value->valuename,
270 DEBUG(0, ("regdb_ctr_add_value: invalid value type in "
271 "registry values [%d]\n", value->type));
275 static NTSTATUS init_registry_data_action(struct db_context *db,
279 TALLOC_CTX *frame = talloc_stackframe();
280 struct regval_ctr *values;
283 /* loop over all of the predefined paths and add each component */
285 for (i=0; builtin_registry_paths[i] != NULL; i++) {
286 if (regdb_key_exists(db, builtin_registry_paths[i])) {
289 status = werror_to_ntstatus(init_registry_key_internal(db,
290 builtin_registry_paths[i]));
291 if (!NT_STATUS_IS_OK(status)) {
296 /* loop over all of the predefined values and add each component */
298 for (i=0; builtin_registry_values[i].path != NULL; i++) {
301 werr = regval_ctr_init(frame, &values);
302 if (!W_ERROR_IS_OK(werr)) {
303 status = werror_to_ntstatus(werr);
307 regdb_fetch_values_internal(db,
308 builtin_registry_values[i].path,
311 /* preserve existing values across restarts. Only add new ones */
313 if (!regval_ctr_key_exists(values,
314 builtin_registry_values[i].valuename))
316 regdb_ctr_add_value(values,
317 &builtin_registry_values[i]);
318 regdb_store_values_internal(db,
319 builtin_registry_values[i].path,
325 status = NT_STATUS_OK;
333 WERROR init_registry_data(void)
336 TALLOC_CTX *frame = talloc_stackframe();
337 struct regval_ctr *values;
341 * First, check for the existence of the needed keys and values.
342 * If all do already exist, we can save the writes.
344 for (i=0; builtin_registry_paths[i] != NULL; i++) {
345 if (!regdb_key_exists(regdb, builtin_registry_paths[i])) {
350 for (i=0; builtin_registry_values[i].path != NULL; i++) {
351 werr = regval_ctr_init(frame, &values);
352 W_ERROR_NOT_OK_GOTO_DONE(werr);
354 regdb_fetch_values_internal(regdb,
355 builtin_registry_values[i].path,
357 if (!regval_ctr_key_exists(values,
358 builtin_registry_values[i].valuename))
373 * There are potentially quite a few store operations which are all
374 * indiviually wrapped in tdb transactions. Wrapping them in a single
375 * transaction gives just a single transaction_commit() to actually do
376 * its fsync()s. See tdb/common/transaction.c for info about nested
377 * transaction behaviour.
380 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
381 init_registry_data_action,
389 /***********************************************************************
390 Open the registry database
391 ***********************************************************************/
393 WERROR regdb_init(void)
395 const char *vstring = "INFO/version";
400 DEBUG(10, ("regdb_init: incrementing refcount (%d)\n",
406 regdb = db_open(NULL, state_path("registry.tdb"), 0,
407 REG_TDB_FLAGS, O_RDWR, 0600);
409 regdb = db_open(NULL, state_path("registry.tdb"), 0,
410 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
412 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
413 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
414 state_path("registry.tdb"), strerror(errno) ));
418 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
423 vers_id = dbwrap_fetch_int32(regdb, vstring);
425 if ( vers_id != REGVER_V1 ) {
427 /* any upgrade code here if needed */
428 DEBUG(10, ("regdb_init: got %s = %d != %d\n", vstring,
429 vers_id, REGVER_V1));
430 status = dbwrap_trans_store_int32(regdb, vstring, REGVER_V1);
431 if (!NT_STATUS_IS_OK(status)) {
432 DEBUG(1, ("regdb_init: error storing %s = %d: %s\n",
433 vstring, REGVER_V1, nt_errstr(status)));
434 return ntstatus_to_werror(status);
436 DEBUG(10, ("regdb_init: stored %s = %d\n",
437 vstring, REGVER_V1));
444 /***********************************************************************
445 Open the registry. Must already have been initialized by regdb_init()
446 ***********************************************************************/
448 WERROR regdb_open( void )
450 WERROR result = WERR_OK;
453 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount));
460 regdb = db_open(NULL, state_path("registry.tdb"), 0,
461 REG_TDB_FLAGS, O_RDWR, 0600);
463 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
464 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
465 state_path("registry.tdb"), strerror(errno) ));
471 DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount));
476 /***********************************************************************
477 ***********************************************************************/
479 int regdb_close( void )
481 if (regdb_refcount == 0) {
487 DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount));
489 if ( regdb_refcount > 0 )
492 SMB_ASSERT( regdb_refcount >= 0 );
498 WERROR regdb_transaction_start(void)
500 return (regdb->transaction_start(regdb) == 0) ?
501 WERR_OK : WERR_REG_IO_FAILURE;
504 WERROR regdb_transaction_commit(void)
506 return (regdb->transaction_commit(regdb) == 0) ?
507 WERR_OK : WERR_REG_IO_FAILURE;
510 WERROR regdb_transaction_cancel(void)
512 return (regdb->transaction_cancel(regdb) == 0) ?
513 WERR_OK : WERR_REG_IO_FAILURE;
516 /***********************************************************************
517 return the tdb sequence number of the registry tdb.
518 this is an indicator for the content of the registry
519 having changed. it will change upon regdb_init, too, though.
520 ***********************************************************************/
521 int regdb_get_seqnum(void)
523 return regdb->get_seqnum(regdb);
527 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
532 WERROR werr = WERR_NOMEM;
533 TALLOC_CTX *mem_ctx = talloc_stackframe();
535 if (keyname == NULL) {
536 werr = WERR_INVALID_PARAM;
540 if (prefix == NULL) {
541 path = discard_const_p(char, keyname);
543 path = talloc_asprintf(mem_ctx, "%s/%s", prefix, keyname);
549 path = normalize_reg_path(mem_ctx, path);
554 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
556 /* treat "not" found" as ok */
557 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
562 talloc_free(mem_ctx);
567 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
569 return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
572 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
574 return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
577 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
579 return regdb_delete_key_with_prefix(db, keyname, NULL);
582 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
586 werr = regdb_delete_values(db, keyname);
587 if (!W_ERROR_IS_OK(werr)) {
588 DEBUG(1, (__location__ " Deleting %s/%s failed: %s\n",
589 REG_VALUE_PREFIX, keyname, win_errstr(werr)));
593 werr = regdb_delete_secdesc(db, keyname);
594 if (!W_ERROR_IS_OK(werr)) {
595 DEBUG(1, (__location__ " Deleting %s/%s failed: %s\n",
596 REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
600 werr = regdb_delete_subkeylist(db, keyname);
601 if (!W_ERROR_IS_OK(werr)) {
602 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
603 keyname, win_errstr(werr)));
611 /***********************************************************************
612 Add subkey strings to the registry tdb under a defined key
613 fmt is the same format as tdb_pack except this function only supports
615 ***********************************************************************/
617 static WERROR regdb_store_keys_internal2(struct db_context *db,
619 struct regsubkey_ctr *ctr)
622 uint8 *buffer = NULL;
625 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
626 char *keyname = NULL;
627 TALLOC_CTX *ctx = talloc_stackframe();
631 werr = WERR_INVALID_PARAM;
635 keyname = talloc_strdup(ctx, key);
641 keyname = normalize_reg_path(ctx, keyname);
647 /* allocate some initial memory */
649 buffer = (uint8 *)SMB_MALLOC(1024);
650 if (buffer == NULL) {
657 /* store the number of subkeys */
659 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
661 /* pack all the strings */
663 for (i=0; i<num_subkeys; i++) {
666 thistime = tdb_pack(buffer+len, buflen-len, "f",
667 regsubkey_ctr_specific_key(ctr, i));
668 if (len+thistime > buflen) {
671 * tdb_pack hasn't done anything because of the short
672 * buffer, allocate extra space.
674 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
677 DEBUG(0, ("regdb_store_keys: Failed to realloc "
678 "memory of size [%u]\n",
679 (unsigned int)(len+thistime)*2));
683 buflen = (len+thistime)*2;
684 thistime2 = tdb_pack(
685 buffer+len, buflen-len, "f",
686 regsubkey_ctr_specific_key(ctr, i));
687 if (thistime2 != thistime) {
688 DEBUG(0, ("tdb_pack failed\n"));
689 werr = WERR_CAN_NOT_COMPLETE;
696 /* finally write out the data */
700 werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
702 W_ERROR_NOT_OK_GOTO_DONE(werr);
705 * Delete a sorted subkey cache for regdb_key_exists, will be
706 * recreated automatically
708 keyname = talloc_asprintf(ctx, "%s/%s", REG_SORTED_SUBKEYS_PREFIX,
710 if (keyname == NULL) {
715 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, keyname));
717 /* don't treat WERR_NOT_FOUND as an error here */
718 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
728 /***********************************************************************
729 Store the new subkey record and create any child key records that
730 do not currently exist
731 ***********************************************************************/
733 struct regdb_store_keys_context {
735 struct regsubkey_ctr *ctr;
738 static NTSTATUS regdb_store_keys_action(struct db_context *db,
741 struct regdb_store_keys_context *store_ctx;
745 struct regsubkey_ctr *subkeys = NULL, *old_subkeys = NULL;
746 char *oldkeyname = NULL;
747 TALLOC_CTX *mem_ctx = talloc_stackframe();
749 store_ctx = (struct regdb_store_keys_context *)private_data;
752 * Re-fetch the old keys inside the transaction
755 werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
756 W_ERROR_NOT_OK_GOTO_DONE(werr);
758 werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
759 if (!W_ERROR_IS_OK(werr) &&
760 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
766 * Make the store operation as safe as possible without transactions:
768 * (1) For each subkey removed from ctr compared with old_subkeys:
770 * (a) First delete the value db entry.
772 * (b) Next delete the secdesc db record.
774 * (c) Then delete the subkey list entry.
776 * (2) Now write the list of subkeys of the parent key,
777 * deleting removed entries and adding new ones.
779 * (3) Finally create the subkey list entries for the added keys.
781 * This way if we crash half-way in between deleting the subkeys
782 * and storing the parent's list of subkeys, no old data can pop up
783 * out of the blue when re-adding keys later on.
786 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
788 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
789 for (i=0; i<num_subkeys; i++) {
790 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
792 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
794 * It's still around, don't delete
799 path = talloc_asprintf(mem_ctx, "%s/%s", store_ctx->key,
806 werr = regdb_delete_key_lists(db, path);
807 W_ERROR_NOT_OK_GOTO_DONE(werr);
812 TALLOC_FREE(old_subkeys);
814 /* (2) store the subkey list for the parent */
816 werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
817 if (!W_ERROR_IS_OK(werr)) {
818 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
819 "for parent [%s]: %s\n", store_ctx->key,
824 /* (3) now create records for any subkeys that don't already exist */
826 num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
828 if (num_subkeys == 0) {
829 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
830 W_ERROR_NOT_OK_GOTO_DONE(werr);
832 werr = regdb_store_keys_internal2(db, store_ctx->key, subkeys);
833 if (!W_ERROR_IS_OK(werr)) {
834 DEBUG(0,("regdb_store_keys: Failed to store "
835 "new record for key [%s]: %s\n",
836 store_ctx->key, win_errstr(werr)));
839 TALLOC_FREE(subkeys);
842 for (i=0; i<num_subkeys; i++) {
843 path = talloc_asprintf(mem_ctx, "%s/%s", store_ctx->key,
844 regsubkey_ctr_specific_key(store_ctx->ctr, i));
849 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
850 W_ERROR_NOT_OK_GOTO_DONE(werr);
852 werr = regdb_fetch_keys_internal(db, path, subkeys);
853 if (!W_ERROR_IS_OK(werr)) {
854 /* create a record with 0 subkeys */
855 werr = regdb_store_keys_internal2(db, path, subkeys);
856 if (!W_ERROR_IS_OK(werr)) {
857 DEBUG(0,("regdb_store_keys: Failed to store "
858 "new record for key [%s]: %s\n", path,
864 TALLOC_FREE(subkeys);
871 talloc_free(mem_ctx);
872 return werror_to_ntstatus(werr);
875 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
876 struct regsubkey_ctr *ctr)
878 int num_subkeys, old_num_subkeys, i;
879 struct regsubkey_ctr *old_subkeys = NULL;
880 TALLOC_CTX *ctx = talloc_stackframe();
883 struct regdb_store_keys_context store_ctx;
885 if (!regdb_key_is_base_key(key) && !regdb_key_exists(db, key)) {
890 * fetch a list of the old subkeys so we can determine if anything has
894 werr = regsubkey_ctr_init(ctx, &old_subkeys);
895 if (!W_ERROR_IS_OK(werr)) {
896 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
900 werr = regdb_fetch_keys_internal(db, key, old_subkeys);
901 if (!W_ERROR_IS_OK(werr) &&
902 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
907 num_subkeys = regsubkey_ctr_numkeys(ctr);
908 old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
909 if ((num_subkeys && old_num_subkeys) &&
910 (num_subkeys == old_num_subkeys)) {
912 for (i = 0; i < num_subkeys; i++) {
913 if (strcmp(regsubkey_ctr_specific_key(ctr, i),
914 regsubkey_ctr_specific_key(old_subkeys, i))
920 if (i == num_subkeys) {
922 * Nothing changed, no point to even start a tdb
931 TALLOC_FREE(old_subkeys);
936 werr = ntstatus_to_werror(dbwrap_trans_do(db,
937 regdb_store_keys_action,
940 ret = W_ERROR_IS_OK(werr);
948 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
950 return regdb_store_keys_internal(regdb, key, ctr);
954 * create a subkey of a given key
957 struct regdb_create_subkey_context {
962 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
966 struct regdb_create_subkey_context *create_ctx;
967 struct regsubkey_ctr *subkeys;
968 TALLOC_CTX *mem_ctx = talloc_stackframe();
970 create_ctx = (struct regdb_create_subkey_context *)private_data;
972 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
973 W_ERROR_NOT_OK_GOTO_DONE(werr);
975 werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
976 W_ERROR_NOT_OK_GOTO_DONE(werr);
978 werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
979 W_ERROR_NOT_OK_GOTO_DONE(werr);
981 werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
982 if (!W_ERROR_IS_OK(werr)) {
983 DEBUG(0, (__location__ " failed to store new subkey list for "
984 "parent key %s: %s\n", create_ctx->key,
989 talloc_free(mem_ctx);
990 return werror_to_ntstatus(werr);
993 static WERROR regdb_create_subkey(const char *key, const char *subkey)
996 struct regsubkey_ctr *subkeys;
997 TALLOC_CTX *mem_ctx = talloc_stackframe();
998 struct regdb_create_subkey_context create_ctx;
1000 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
1001 werr = WERR_NOT_FOUND;
1005 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1006 W_ERROR_NOT_OK_GOTO_DONE(werr);
1008 werr = regdb_fetch_keys_internal(regdb, key, subkeys);
1009 W_ERROR_NOT_OK_GOTO_DONE(werr);
1011 if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1016 talloc_free(subkeys);
1018 create_ctx.key = key;
1019 create_ctx.subkey = subkey;
1021 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1022 regdb_create_subkey_action,
1026 talloc_free(mem_ctx);
1031 * create a subkey of a given key
1034 struct regdb_delete_subkey_context {
1040 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1044 struct regdb_delete_subkey_context *delete_ctx;
1045 struct regsubkey_ctr *subkeys;
1046 TALLOC_CTX *mem_ctx = talloc_stackframe();
1048 delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1050 werr = regdb_delete_key_lists(db, delete_ctx->path);
1051 W_ERROR_NOT_OK_GOTO_DONE(werr);
1053 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1054 W_ERROR_NOT_OK_GOTO_DONE(werr);
1056 werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1057 W_ERROR_NOT_OK_GOTO_DONE(werr);
1059 werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1060 W_ERROR_NOT_OK_GOTO_DONE(werr);
1062 werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1063 if (!W_ERROR_IS_OK(werr)) {
1064 DEBUG(0, (__location__ " failed to store new subkey_list for "
1065 "parent key %s: %s\n", delete_ctx->key,
1070 talloc_free(mem_ctx);
1071 return werror_to_ntstatus(werr);
1074 static WERROR regdb_delete_subkey(const char *key, const char *subkey)
1078 struct regdb_delete_subkey_context delete_ctx;
1079 TALLOC_CTX *mem_ctx = talloc_stackframe();
1081 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
1082 werr = WERR_NOT_FOUND;
1086 path = talloc_asprintf(mem_ctx, "%s/%s", key, subkey);
1092 if (!regdb_key_exists(regdb, path)) {
1097 delete_ctx.key = key;
1098 delete_ctx.subkey = subkey;
1099 delete_ctx.path = path;
1101 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1102 regdb_delete_subkey_action,
1106 talloc_free(mem_ctx);
1110 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1111 TALLOC_CTX *mem_ctx, const char *key)
1116 path = normalize_reg_path(mem_ctx, key);
1118 return make_tdb_data(NULL, 0);
1121 data = dbwrap_fetch_bystring(db, mem_ctx, path);
1129 * check whether a given key name represents a base key,
1130 * i.e one without a subkey separator ('/' or '\').
1132 static bool regdb_key_is_base_key(const char *key)
1134 TALLOC_CTX *mem_ctx = talloc_stackframe();
1142 path = normalize_reg_path(mem_ctx, key);
1144 DEBUG(0, ("out of memory! (talloc failed)\n"));
1148 if (*path == '\0') {
1152 ret = (strrchr(path, '/') == NULL);
1155 TALLOC_FREE(mem_ctx);
1160 * regdb_key_exists() is a very frequent operation. It can be quite
1161 * time-consuming to fully fetch the parent's subkey list, talloc_strdup all
1162 * subkeys and then compare the keyname linearly to all the parent's subkeys.
1164 * The following code tries to make this operation as efficient as possible:
1165 * Per registry key we create a list of subkeys that is very efficient to
1166 * search for existence of a subkey. Its format is:
1168 * 4 bytes num_subkeys
1169 * 4*num_subkey bytes offset into the string array
1170 * then follows a sorted list of subkeys in uppercase
1172 * This record is created by create_sorted_subkeys() on demand if it does not
1173 * exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
1174 * list, the parsing code and the binary search can be found in
1175 * parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
1176 * the potentially large subkey record.
1178 * The sorted subkey record is deleted in regdb_store_keys_internal2 and
1179 * recreated on demand.
1182 static int cmp_keynames(char **p1, char **p2)
1184 return StrCaseCmp(*p1, *p2);
1187 struct create_sorted_subkeys_context {
1189 const char *sorted_keyname;
1192 static NTSTATUS create_sorted_subkeys_action(struct db_context *db,
1195 char **sorted_subkeys;
1196 struct regsubkey_ctr *ctr;
1203 struct create_sorted_subkeys_context *sorted_ctx;
1205 sorted_ctx = (struct create_sorted_subkeys_context *)private_data;
1208 * In this function, we only treat failing of the actual write to
1209 * the db as a real error. All preliminary errors, at a stage when
1210 * nothing has been written to the DB yet are treated as success
1211 * to be committed (as an empty transaction).
1213 * The reason is that this (disposable) call might be nested in other
1214 * transactions. Doing a cancel here would destroy the possibility of
1215 * a transaction_commit for transactions that we might be wrapped in.
1218 status = werror_to_ntstatus(regsubkey_ctr_init(talloc_tos(), &ctr));
1219 if (!NT_STATUS_IS_OK(status)) {
1220 /* don't treat this as an error */
1221 status = NT_STATUS_OK;
1225 status = werror_to_ntstatus(regdb_fetch_keys_internal(db,
1228 if (!NT_STATUS_IS_OK(status)) {
1229 /* don't treat this as an error */
1230 status = NT_STATUS_OK;
1234 num_subkeys = regsubkey_ctr_numkeys(ctr);
1235 sorted_subkeys = talloc_array(ctr, char *, num_subkeys);
1236 if (sorted_subkeys == NULL) {
1237 /* don't treat this as an error */
1241 len = 4 + 4*num_subkeys;
1243 for (i = 0; i < num_subkeys; i++) {
1244 sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
1245 regsubkey_ctr_specific_key(ctr, i));
1246 if (sorted_subkeys[i] == NULL) {
1247 /* don't treat this as an error */
1250 len += strlen(sorted_subkeys[i])+1;
1253 TYPESAFE_QSORT(sorted_subkeys, num_subkeys, cmp_keynames);
1255 buf = talloc_array(ctr, char, len);
1257 /* don't treat this as an error */
1260 p = buf + 4 + 4*num_subkeys;
1262 SIVAL(buf, 0, num_subkeys);
1264 for (i=0; i < num_subkeys; i++) {
1265 ptrdiff_t offset = p - buf;
1266 SIVAL(buf, 4 + 4*i, offset);
1267 strlcpy(p, sorted_subkeys[i], len-offset);
1268 p += strlen(sorted_subkeys[i]) + 1;
1271 status = dbwrap_store_bystring(
1272 db, sorted_ctx->sorted_keyname, make_tdb_data((uint8_t *)buf,
1281 static bool create_sorted_subkeys(const char *key, const char *sorted_keyname)
1284 struct create_sorted_subkeys_context sorted_ctx;
1286 sorted_ctx.key = key;
1287 sorted_ctx.sorted_keyname = sorted_keyname;
1289 status = dbwrap_trans_do(regdb,
1290 create_sorted_subkeys_action,
1293 return NT_STATUS_IS_OK(status);
1296 struct scan_subkey_state {
1302 static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
1305 struct scan_subkey_state *state =
1306 (struct scan_subkey_state *)private_data;
1307 uint32_t num_subkeys;
1310 if (data.dsize < sizeof(uint32_t)) {
1314 state->scanned = true;
1315 state->found = false;
1317 tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
1323 uint32_t idx = (l+u)/2;
1324 char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
1325 int comparison = strcmp(state->name, s);
1327 if (comparison < 0) {
1329 } else if (comparison > 0) {
1332 state->found = true;
1339 static bool scan_parent_subkeys(struct db_context *db, const char *parent,
1344 struct scan_subkey_state state = { 0, };
1345 bool result = false;
1350 path = normalize_reg_path(talloc_tos(), parent);
1355 key = talloc_asprintf(talloc_tos(), "%s/%s",
1356 REG_SORTED_SUBKEYS_PREFIX, path);
1361 state.name = talloc_strdup_upper(talloc_tos(), name);
1362 if (state.name == NULL) {
1365 state.scanned = false;
1367 res = db->parse_record(db, string_term_tdb_data(key),
1368 parent_subkey_scanner, &state);
1370 if (state.scanned) {
1371 result = state.found;
1373 res = db->transaction_start(db);
1375 DEBUG(0, ("error starting transacion\n"));
1379 if (!create_sorted_subkeys(path, key)) {
1380 res = db->transaction_cancel(db);
1382 smb_panic("Failed to cancel transaction.");
1387 res = db->parse_record(db, string_term_tdb_data(key),
1388 parent_subkey_scanner, &state);
1389 if ((res == 0) && (state.scanned)) {
1390 result = state.found;
1393 res = db->transaction_commit(db);
1395 DEBUG(0, ("error committing transaction\n"));
1402 TALLOC_FREE(state.name);
1407 * Check for the existence of a key.
1409 * Existence of a key is authoritatively defined by its
1410 * existence in the list of subkeys of its parent key.
1411 * The exeption of this are keys without a parent key,
1412 * i.e. the "base" keys (HKLM, HKCU, ...).
1414 static bool regdb_key_exists(struct db_context *db, const char *key)
1416 TALLOC_CTX *mem_ctx = talloc_stackframe();
1425 path = normalize_reg_path(mem_ctx, key);
1427 DEBUG(0, ("out of memory! (talloc failed)\n"));
1431 if (*path == '\0') {
1435 p = strrchr(path, '/');
1437 /* this is a base key */
1438 value = regdb_fetch_key_internal(db, mem_ctx, path);
1439 ret = (value.dptr != NULL);
1442 ret = scan_parent_subkeys(db, path, p+1);
1446 TALLOC_FREE(mem_ctx);
1451 /***********************************************************************
1452 Retrieve an array of strings containing subkeys. Memory should be
1453 released by the caller.
1454 ***********************************************************************/
1456 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1457 struct regsubkey_ctr *ctr)
1465 TALLOC_CTX *frame = talloc_stackframe();
1468 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1470 frame = talloc_stackframe();
1472 if (!regdb_key_exists(db, key)) {
1473 DEBUG(10, ("key [%s] not found\n", key));
1474 werr = WERR_NOT_FOUND;
1478 werr = regsubkey_ctr_set_seqnum(ctr, db->get_seqnum(db));
1479 W_ERROR_NOT_OK_GOTO_DONE(werr);
1481 value = regdb_fetch_key_internal(db, frame, key);
1483 if (value.dsize == 0 || value.dptr == NULL) {
1484 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1490 buflen = value.dsize;
1491 len = tdb_unpack( buf, buflen, "d", &num_items);
1492 if (len == (uint32_t)-1) {
1493 werr = WERR_NOT_FOUND;
1497 werr = regsubkey_ctr_reinit(ctr);
1498 W_ERROR_NOT_OK_GOTO_DONE(werr);
1500 for (i=0; i<num_items; i++) {
1501 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1502 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1503 if (!W_ERROR_IS_OK(werr)) {
1504 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1505 "failed: %s\n", win_errstr(werr)));
1511 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1518 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1522 werr = regdb_fetch_keys_internal(regdb, key, ctr);
1523 if (!W_ERROR_IS_OK(werr)) {
1527 return regsubkey_ctr_numkeys(ctr);
1530 /****************************************************************************
1531 Unpack a list of registry values frem the TDB
1532 ***************************************************************************/
1534 static int regdb_unpack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1541 uint32 num_values = 0;
1544 /* loop and unpack the rest of the registry values */
1546 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1548 for ( i=0; i<num_values; i++ ) {
1549 /* unpack the next regval */
1554 valuename[0] = '\0';
1555 len += tdb_unpack(buf+len, buflen-len, "fdB",
1561 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1563 if (size && data_p) {
1564 regval_ctr_addvalue(values, valuename, type,
1565 (uint8_t *)data_p, size);
1567 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1569 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1575 /****************************************************************************
1576 Pack all values in all printer keys
1577 ***************************************************************************/
1579 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1583 struct regval_blob *val;
1589 num_values = regval_ctr_numvals( values );
1591 /* pack the number of values first */
1593 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1595 /* loop over all values */
1597 for ( i=0; i<num_values; i++ ) {
1598 val = regval_ctr_specific_value( values, i );
1599 len += tdb_pack(buf+len, buflen-len, "fdB",
1603 regval_data_p(val) );
1609 /***********************************************************************
1610 Retrieve an array of strings containing subkeys. Memory should be
1611 released by the caller.
1612 ***********************************************************************/
1614 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1615 struct regval_ctr *values)
1617 char *keystr = NULL;
1618 TALLOC_CTX *ctx = talloc_stackframe();
1623 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1625 if (!regdb_key_exists(db, key)) {
1629 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
1634 werr = regval_ctr_set_seqnum(values, db->get_seqnum(db));
1635 W_ERROR_NOT_OK_GOTO_DONE(werr);
1637 value = regdb_fetch_key_internal(db, ctx, keystr);
1640 /* all keys have zero values by default */
1644 regdb_unpack_values(values, value.dptr, value.dsize);
1645 ret = regval_ctr_numvals(values);
1652 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1654 return regdb_fetch_values_internal(regdb, key, values);
1657 static bool regdb_store_values_internal(struct db_context *db, const char *key,
1658 struct regval_ctr *values)
1660 TDB_DATA old_data, data;
1661 char *keystr = NULL;
1662 TALLOC_CTX *ctx = talloc_stackframe();
1665 bool result = false;
1667 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1669 if (!regdb_key_exists(db, key)) {
1675 len = regdb_pack_values(values, data.dptr, data.dsize);
1677 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1681 data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1684 len = regdb_pack_values(values, data.dptr, data.dsize);
1686 SMB_ASSERT( len == data.dsize );
1688 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
1692 keystr = normalize_reg_path(ctx, keystr);
1697 old_data = dbwrap_fetch_bystring(db, ctx, keystr);
1699 if ((old_data.dptr != NULL)
1700 && (old_data.dsize == data.dsize)
1701 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1707 status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1709 result = NT_STATUS_IS_OK(status);
1716 bool regdb_store_values(const char *key, struct regval_ctr *values)
1718 return regdb_store_values_internal(regdb, key, values);
1721 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1722 struct security_descriptor **psecdesc)
1727 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1728 WERROR err = WERR_OK;
1730 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1732 if (!regdb_key_exists(regdb, key)) {
1737 tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1738 if (tdbkey == NULL) {
1742 normalize_dbkey(tdbkey);
1744 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1745 if (data.dptr == NULL) {
1750 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1753 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1755 } else if (!NT_STATUS_IS_OK(status)) {
1756 err = WERR_REG_CORRUPT;
1760 TALLOC_FREE(tmp_ctx);
1764 static WERROR regdb_set_secdesc(const char *key,
1765 struct security_descriptor *secdesc)
1767 TALLOC_CTX *mem_ctx = talloc_stackframe();
1769 WERROR err = WERR_NOMEM;
1772 if (!regdb_key_exists(regdb, key)) {
1777 tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1778 if (tdbkey == NULL) {
1781 normalize_dbkey(tdbkey);
1783 if (secdesc == NULL) {
1784 /* assuming a delete */
1785 err = ntstatus_to_werror(dbwrap_trans_delete_bystring(regdb,
1790 err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1793 W_ERROR_NOT_OK_GOTO_DONE(err);
1795 err = ntstatus_to_werror(dbwrap_trans_store_bystring(regdb, tdbkey,
1799 TALLOC_FREE(mem_ctx);
1803 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1805 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1808 bool regdb_values_need_update(struct regval_ctr *values)
1810 return (regdb_get_seqnum() != regval_ctr_get_seqnum(values));
1814 * Table of function pointers for default access
1817 struct registry_ops regdb_ops = {
1818 .fetch_subkeys = regdb_fetch_keys,
1819 .fetch_values = regdb_fetch_values,
1820 .store_subkeys = regdb_store_keys,
1821 .store_values = regdb_store_values,
1822 .create_subkey = regdb_create_subkey,
1823 .delete_subkey = regdb_delete_subkey,
1824 .get_secdesc = regdb_get_secdesc,
1825 .set_secdesc = regdb_set_secdesc,
1826 .subkeys_need_update = regdb_subkeys_need_update,
1827 .values_need_update = regdb_values_need_update