s3:registry: update the seqnum in the subkey cache at the end of regval_store_keys
[Samba.git] / source3 / registry / reg_backend_db.c
blobe0fe7c121151b23f70293f155de2c6ba788b4aa5
1 /*
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. */
23 #include "includes.h"
24 #include "system/filesys.h"
25 #include "registry.h"
26 #include "reg_db.h"
27 #include "reg_util_internal.h"
28 #include "reg_backend_db.h"
29 #include "reg_objects.h"
30 #include "nt_printing.h"
31 #include "util_tdb.h"
32 #include "dbwrap.h"
34 #undef DBGC_CLASS
35 #define DBGC_CLASS DBGC_REGISTRY
37 static struct db_context *regdb = NULL;
38 static int regdb_refcount;
40 static bool regdb_key_exists(struct db_context *db, const char *key);
41 static bool regdb_key_is_base_key(const char *key);
42 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
43 struct regsubkey_ctr *ctr);
44 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
45 struct regsubkey_ctr *ctr);
46 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
47 struct regval_ctr *values);
48 static bool regdb_store_values_internal(struct db_context *db, const char *key,
49 struct regval_ctr *values);
51 static NTSTATUS create_sorted_subkeys(const char *key);
53 /* List the deepest path into the registry. All part components will be created.*/
55 /* If you want to have a part of the path controlled by the tdb and part by
56 a virtual registry db (e.g. printing), then you have to list the deepest path.
57 For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
58 allows the reg_db backend to handle everything up to
59 "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
60 the reg_printing backend onto the last component of the path (see
61 KEY_PRINTING_2K in include/rpc_reg.h) --jerry */
63 static const char *builtin_registry_paths[] = {
64 KEY_PRINTING_2K,
65 KEY_PRINTING_PORTS,
66 KEY_PRINTING,
67 KEY_PRINTING "\\Forms",
68 KEY_PRINTING "\\Printers",
69 KEY_PRINTING "\\Environments\\Windows NT x86\\Print Processors\\winprint",
70 KEY_SHARES,
71 KEY_EVENTLOG,
72 KEY_SMBCONF,
73 KEY_PERFLIB,
74 KEY_PERFLIB_009,
75 KEY_GROUP_POLICY,
76 KEY_SAMBA_GROUP_POLICY,
77 KEY_GP_MACHINE_POLICY,
78 KEY_GP_MACHINE_WIN_POLICY,
79 KEY_HKCU,
80 KEY_GP_USER_POLICY,
81 KEY_GP_USER_WIN_POLICY,
82 "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Winlogon\\GPExtensions",
83 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
84 KEY_PROD_OPTIONS,
85 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
86 KEY_TCPIP_PARAMS,
87 KEY_NETLOGON_PARAMS,
88 KEY_HKU,
89 KEY_HKCR,
90 KEY_HKPD,
91 KEY_HKPT,
92 NULL };
94 struct builtin_regkey_value {
95 const char *path;
96 const char *valuename;
97 uint32 type;
98 union {
99 const char *string;
100 uint32 dw_value;
101 } data;
104 static struct builtin_regkey_value builtin_registry_values[] = {
105 { KEY_PRINTING_PORTS,
106 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
107 { KEY_PRINTING_2K,
108 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
109 { KEY_EVENTLOG,
110 "DisplayName", REG_SZ, { "Event Log" } },
111 { KEY_EVENTLOG,
112 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
113 { NULL, NULL, 0, { NULL } }
117 * Initialize a key in the registry:
118 * create each component key of the specified path.
120 static WERROR init_registry_key_internal(struct db_context *db,
121 const char *add_path)
123 WERROR werr;
124 TALLOC_CTX *frame = talloc_stackframe();
125 char *path = NULL;
126 char *base = NULL;
127 char *remaining = NULL;
128 char *keyname;
129 char *subkeyname;
130 struct regsubkey_ctr *subkeys;
131 const char *p, *p2;
133 DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path));
135 path = talloc_strdup(frame, add_path);
136 base = talloc_strdup(frame, "");
137 if (!path || !base) {
138 werr = WERR_NOMEM;
139 goto fail;
141 p = path;
143 while (next_token_talloc(frame, &p, &keyname, "\\")) {
145 /* build up the registry path from the components */
147 if (*base) {
148 base = talloc_asprintf(frame, "%s\\", base);
149 if (!base) {
150 werr = WERR_NOMEM;
151 goto fail;
154 base = talloc_asprintf_append(base, "%s", keyname);
155 if (!base) {
156 werr = WERR_NOMEM;
157 goto fail;
160 /* get the immediate subkeyname (if we have one ) */
162 subkeyname = talloc_strdup(frame, "");
163 if (!subkeyname) {
164 werr = WERR_NOMEM;
165 goto fail;
167 if (*p) {
168 remaining = talloc_strdup(frame, p);
169 if (!remaining) {
170 werr = WERR_NOMEM;
171 goto fail;
173 p2 = remaining;
175 if (!next_token_talloc(frame, &p2,
176 &subkeyname, "\\"))
178 subkeyname = talloc_strdup(frame,p2);
179 if (!subkeyname) {
180 werr = WERR_NOMEM;
181 goto fail;
186 DEBUG(10,("init_registry_key: Storing key [%s] with "
187 "subkey [%s]\n", base,
188 *subkeyname ? subkeyname : "NULL"));
190 /* we don't really care if the lookup succeeds or not
191 * since we are about to update the record.
192 * We just want any subkeys already present */
194 werr = regsubkey_ctr_init(frame, &subkeys);
195 if (!W_ERROR_IS_OK(werr)) {
196 DEBUG(0,("talloc() failure!\n"));
197 goto fail;
200 werr = regdb_fetch_keys_internal(db, base, subkeys);
201 if (!W_ERROR_IS_OK(werr) &&
202 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
204 goto fail;
207 if (*subkeyname) {
208 werr = regsubkey_ctr_addkey(subkeys, subkeyname);
209 if (!W_ERROR_IS_OK(werr)) {
210 goto fail;
213 if (!regdb_store_keys_internal(db, base, subkeys)) {
214 werr = WERR_CAN_NOT_COMPLETE;
215 goto fail;
219 werr = WERR_OK;
221 fail:
222 TALLOC_FREE(frame);
223 return werr;
226 struct init_registry_key_context {
227 const char *add_path;
230 static NTSTATUS init_registry_key_action(struct db_context *db,
231 void *private_data)
233 struct init_registry_key_context *init_ctx =
234 (struct init_registry_key_context *)private_data;
236 return werror_to_ntstatus(init_registry_key_internal(
237 db, init_ctx->add_path));
241 * Initialize a key in the registry:
242 * create each component key of the specified path,
243 * wrapped in one db transaction.
245 WERROR init_registry_key(const char *add_path)
247 struct init_registry_key_context init_ctx;
249 if (regdb_key_exists(regdb, add_path)) {
250 return WERR_OK;
253 init_ctx.add_path = add_path;
255 return ntstatus_to_werror(dbwrap_trans_do(regdb,
256 init_registry_key_action,
257 &init_ctx));
260 /***********************************************************************
261 Open the registry data in the tdb
262 ***********************************************************************/
264 static void regdb_ctr_add_value(struct regval_ctr *ctr,
265 struct builtin_regkey_value *value)
267 switch(value->type) {
268 case REG_DWORD:
269 regval_ctr_addvalue(ctr, value->valuename, REG_DWORD,
270 (uint8_t *)&value->data.dw_value,
271 sizeof(uint32));
272 break;
274 case REG_SZ:
275 regval_ctr_addvalue_sz(ctr, value->valuename,
276 value->data.string);
277 break;
279 default:
280 DEBUG(0, ("regdb_ctr_add_value: invalid value type in "
281 "registry values [%d]\n", value->type));
285 static NTSTATUS init_registry_data_action(struct db_context *db,
286 void *private_data)
288 NTSTATUS status;
289 TALLOC_CTX *frame = talloc_stackframe();
290 struct regval_ctr *values;
291 int i;
293 /* loop over all of the predefined paths and add each component */
295 for (i=0; builtin_registry_paths[i] != NULL; i++) {
296 if (regdb_key_exists(db, builtin_registry_paths[i])) {
297 continue;
299 status = werror_to_ntstatus(init_registry_key_internal(db,
300 builtin_registry_paths[i]));
301 if (!NT_STATUS_IS_OK(status)) {
302 goto done;
306 /* loop over all of the predefined values and add each component */
308 for (i=0; builtin_registry_values[i].path != NULL; i++) {
309 WERROR werr;
311 werr = regval_ctr_init(frame, &values);
312 if (!W_ERROR_IS_OK(werr)) {
313 status = werror_to_ntstatus(werr);
314 goto done;
317 regdb_fetch_values_internal(db,
318 builtin_registry_values[i].path,
319 values);
321 /* preserve existing values across restarts. Only add new ones */
323 if (!regval_ctr_value_exists(values,
324 builtin_registry_values[i].valuename))
326 regdb_ctr_add_value(values,
327 &builtin_registry_values[i]);
328 regdb_store_values_internal(db,
329 builtin_registry_values[i].path,
330 values);
332 TALLOC_FREE(values);
335 status = NT_STATUS_OK;
337 done:
339 TALLOC_FREE(frame);
340 return status;
343 WERROR init_registry_data(void)
345 WERROR werr;
346 TALLOC_CTX *frame = talloc_stackframe();
347 struct regval_ctr *values;
348 int i;
351 * First, check for the existence of the needed keys and values.
352 * If all do already exist, we can save the writes.
354 for (i=0; builtin_registry_paths[i] != NULL; i++) {
355 if (!regdb_key_exists(regdb, builtin_registry_paths[i])) {
356 goto do_init;
360 for (i=0; builtin_registry_values[i].path != NULL; i++) {
361 werr = regval_ctr_init(frame, &values);
362 W_ERROR_NOT_OK_GOTO_DONE(werr);
364 regdb_fetch_values_internal(regdb,
365 builtin_registry_values[i].path,
366 values);
367 if (!regval_ctr_value_exists(values,
368 builtin_registry_values[i].valuename))
370 TALLOC_FREE(values);
371 goto do_init;
374 TALLOC_FREE(values);
377 werr = WERR_OK;
378 goto done;
380 do_init:
383 * There are potentially quite a few store operations which are all
384 * indiviually wrapped in tdb transactions. Wrapping them in a single
385 * transaction gives just a single transaction_commit() to actually do
386 * its fsync()s. See tdb/common/transaction.c for info about nested
387 * transaction behaviour.
390 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
391 init_registry_data_action,
392 NULL));
394 done:
395 TALLOC_FREE(frame);
396 return werr;
399 static int regdb_normalize_keynames_fn(struct db_record *rec,
400 void *private_data)
402 TALLOC_CTX *mem_ctx = talloc_tos();
403 const char *keyname;
404 NTSTATUS status;
406 if (rec->key.dptr == NULL || rec->key.dsize == 0) {
407 return 0;
410 keyname = strchr((const char *) rec->key.dptr, '/');
411 if (keyname) {
412 struct db_record new_rec;
414 keyname = talloc_string_sub(mem_ctx,
415 (const char *) rec->key.dptr,
416 "/",
417 "\\");
419 DEBUG(2, ("regdb_normalize_keynames_fn: Convert %s to %s\n",
420 (const char *) rec->key.dptr,
421 keyname));
423 new_rec.value = rec->value;
424 new_rec.key = string_term_tdb_data(keyname);
425 new_rec.private_data = rec->private_data;
427 /* Delete the original record and store the normalized key */
428 status = rec->delete_rec(rec);
429 if (!NT_STATUS_IS_OK(status)) {
430 DEBUG(0,("regdb_normalize_keynames_fn: "
431 "tdb_delete for [%s] failed!\n",
432 rec->key.dptr));
433 return 1;
436 status = rec->store(&new_rec, new_rec.value, TDB_REPLACE);
437 if (!NT_STATUS_IS_OK(status)) {
438 DEBUG(0,("regdb_normalize_keynames_fn: "
439 "failed to store new record for [%s]!\n",
440 keyname));
441 return 1;
445 return 0;
448 static WERROR regdb_store_regdb_version(uint32_t version)
450 NTSTATUS status;
451 const char *version_keyname = "INFO/version";
453 if (!regdb) {
454 return WERR_CAN_NOT_COMPLETE;
457 status = dbwrap_trans_store_int32(regdb, version_keyname, version);
458 if (!NT_STATUS_IS_OK(status)) {
459 DEBUG(1, ("regdb_store_regdb_version: error storing %s = %d: %s\n",
460 version_keyname, version, nt_errstr(status)));
461 return ntstatus_to_werror(status);
462 } else {
463 DEBUG(10, ("regdb_store_regdb_version: stored %s = %d\n",
464 version_keyname, version));
465 return WERR_OK;
469 static WERROR regdb_upgrade_v1_to_v2(void)
471 TALLOC_CTX *mem_ctx;
472 int rc;
473 WERROR werr;
475 mem_ctx = talloc_stackframe();
476 if (mem_ctx == NULL) {
477 return WERR_NOMEM;
480 rc = regdb->traverse(regdb, regdb_normalize_keynames_fn, mem_ctx);
482 talloc_destroy(mem_ctx);
484 if (rc == -1) {
485 return WERR_REG_IO_FAILURE;
488 werr = regdb_store_regdb_version(REGVER_V2);
489 return werr;
492 /***********************************************************************
493 Open the registry database
494 ***********************************************************************/
496 WERROR regdb_init(void)
498 const char *vstring = "INFO/version";
499 uint32 vers_id, expected_version;
500 WERROR werr;
502 if (regdb) {
503 DEBUG(10, ("regdb_init: incrementing refcount (%d->%d)\n",
504 regdb_refcount, regdb_refcount+1));
505 regdb_refcount++;
506 return WERR_OK;
509 regdb = db_open(NULL, state_path("registry.tdb"), 0,
510 REG_TDB_FLAGS, O_RDWR, 0600);
511 if (!regdb) {
512 regdb = db_open(NULL, state_path("registry.tdb"), 0,
513 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
514 if (!regdb) {
515 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
516 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
517 state_path("registry.tdb"), strerror(errno) ));
518 return werr;
521 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
524 regdb_refcount = 1;
525 DEBUG(10, ("regdb_init: registry db openend. refcount reset (%d)\n",
526 regdb_refcount));
528 expected_version = REGVER_V2;
530 vers_id = dbwrap_fetch_int32(regdb, vstring);
531 if (vers_id == -1) {
532 DEBUG(10, ("regdb_init: registry version uninitialized "
533 "(got %d), initializing to version %d\n",
534 vers_id, expected_version));
536 werr = regdb_store_regdb_version(expected_version);
537 return werr;
540 if (vers_id > expected_version || vers_id == 0) {
541 DEBUG(1, ("regdb_init: unknown registry version %d "
542 "(code version = %d), refusing initialization\n",
543 vers_id, expected_version));
544 return WERR_CAN_NOT_COMPLETE;
547 if (vers_id == REGVER_V1) {
548 DEBUG(10, ("regdb_init: got registry db version %d, upgrading "
549 "to version %d\n", REGVER_V1, REGVER_V2));
551 if (regdb->transaction_start(regdb) != 0) {
552 return WERR_REG_IO_FAILURE;
555 werr = regdb_upgrade_v1_to_v2();
556 if (!W_ERROR_IS_OK(werr)) {
557 regdb->transaction_cancel(regdb);
558 return werr;
561 if (regdb->transaction_commit(regdb) != 0) {
562 return WERR_REG_IO_FAILURE;
565 vers_id = REGVER_V2;
568 /* future upgrade code should go here */
570 return WERR_OK;
573 /***********************************************************************
574 Open the registry. Must already have been initialized by regdb_init()
575 ***********************************************************************/
577 WERROR regdb_open( void )
579 WERROR result = WERR_OK;
581 if ( regdb ) {
582 DEBUG(10, ("regdb_open: incrementing refcount (%d->%d)\n",
583 regdb_refcount, regdb_refcount+1));
584 regdb_refcount++;
585 return WERR_OK;
588 become_root();
590 regdb = db_open(NULL, state_path("registry.tdb"), 0,
591 REG_TDB_FLAGS, O_RDWR, 0600);
592 if ( !regdb ) {
593 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
594 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
595 state_path("registry.tdb"), strerror(errno) ));
598 unbecome_root();
600 regdb_refcount = 1;
601 DEBUG(10, ("regdb_open: registry db opened. refcount reset (%d)\n",
602 regdb_refcount));
604 return result;
607 /***********************************************************************
608 ***********************************************************************/
610 int regdb_close( void )
612 if (regdb_refcount == 0) {
613 return 0;
616 regdb_refcount--;
618 DEBUG(10, ("regdb_close: decrementing refcount (%d->%d)\n",
619 regdb_refcount+1, regdb_refcount));
621 if ( regdb_refcount > 0 )
622 return 0;
624 SMB_ASSERT( regdb_refcount >= 0 );
626 TALLOC_FREE(regdb);
627 return 0;
630 WERROR regdb_transaction_start(void)
632 return (regdb->transaction_start(regdb) == 0) ?
633 WERR_OK : WERR_REG_IO_FAILURE;
636 WERROR regdb_transaction_commit(void)
638 return (regdb->transaction_commit(regdb) == 0) ?
639 WERR_OK : WERR_REG_IO_FAILURE;
642 WERROR regdb_transaction_cancel(void)
644 return (regdb->transaction_cancel(regdb) == 0) ?
645 WERR_OK : WERR_REG_IO_FAILURE;
648 /***********************************************************************
649 return the tdb sequence number of the registry tdb.
650 this is an indicator for the content of the registry
651 having changed. it will change upon regdb_init, too, though.
652 ***********************************************************************/
653 int regdb_get_seqnum(void)
655 return regdb->get_seqnum(regdb);
659 static WERROR regdb_delete_key_with_prefix(struct db_context *db,
660 const char *keyname,
661 const char *prefix)
663 char *path;
664 WERROR werr = WERR_NOMEM;
665 TALLOC_CTX *mem_ctx = talloc_stackframe();
667 if (keyname == NULL) {
668 werr = WERR_INVALID_PARAM;
669 goto done;
672 if (prefix == NULL) {
673 path = discard_const_p(char, keyname);
674 } else {
675 path = talloc_asprintf(mem_ctx, "%s\\%s", prefix, keyname);
676 if (path == NULL) {
677 goto done;
681 path = normalize_reg_path(mem_ctx, path);
682 if (path == NULL) {
683 goto done;
686 werr = ntstatus_to_werror(dbwrap_delete_bystring(db, path));
688 /* treat "not" found" as ok */
689 if (W_ERROR_EQUAL(werr, WERR_NOT_FOUND)) {
690 werr = WERR_OK;
693 done:
694 talloc_free(mem_ctx);
695 return werr;
699 static WERROR regdb_delete_values(struct db_context *db, const char *keyname)
701 return regdb_delete_key_with_prefix(db, keyname, REG_VALUE_PREFIX);
704 static WERROR regdb_delete_secdesc(struct db_context *db, const char *keyname)
706 return regdb_delete_key_with_prefix(db, keyname, REG_SECDESC_PREFIX);
709 static WERROR regdb_delete_subkeylist(struct db_context *db, const char *keyname)
711 return regdb_delete_key_with_prefix(db, keyname, NULL);
714 static WERROR regdb_delete_key_lists(struct db_context *db, const char *keyname)
716 WERROR werr;
718 werr = regdb_delete_values(db, keyname);
719 if (!W_ERROR_IS_OK(werr)) {
720 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
721 REG_VALUE_PREFIX, keyname, win_errstr(werr)));
722 goto done;
725 werr = regdb_delete_secdesc(db, keyname);
726 if (!W_ERROR_IS_OK(werr)) {
727 DEBUG(1, (__location__ " Deleting %s\\%s failed: %s\n",
728 REG_SECDESC_PREFIX, keyname, win_errstr(werr)));
729 goto done;
732 werr = regdb_delete_subkeylist(db, keyname);
733 if (!W_ERROR_IS_OK(werr)) {
734 DEBUG(1, (__location__ " Deleting %s failed: %s\n",
735 keyname, win_errstr(werr)));
736 goto done;
739 done:
740 return werr;
743 /***********************************************************************
744 Add subkey strings to the registry tdb under a defined key
745 fmt is the same format as tdb_pack except this function only supports
746 fstrings
747 ***********************************************************************/
749 static WERROR regdb_store_keys_internal2(struct db_context *db,
750 const char *key,
751 struct regsubkey_ctr *ctr)
753 TDB_DATA dbuf;
754 uint8 *buffer = NULL;
755 int i = 0;
756 uint32 len, buflen;
757 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
758 char *keyname = NULL;
759 TALLOC_CTX *ctx = talloc_stackframe();
760 WERROR werr;
762 if (!key) {
763 werr = WERR_INVALID_PARAM;
764 goto done;
767 keyname = talloc_strdup(ctx, key);
768 if (!keyname) {
769 werr = WERR_NOMEM;
770 goto done;
773 keyname = normalize_reg_path(ctx, keyname);
774 if (!keyname) {
775 werr = WERR_NOMEM;
776 goto done;
779 /* allocate some initial memory */
781 buffer = (uint8 *)SMB_MALLOC(1024);
782 if (buffer == NULL) {
783 werr = WERR_NOMEM;
784 goto done;
786 buflen = 1024;
787 len = 0;
789 /* store the number of subkeys */
791 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
793 /* pack all the strings */
795 for (i=0; i<num_subkeys; i++) {
796 size_t thistime;
798 thistime = tdb_pack(buffer+len, buflen-len, "f",
799 regsubkey_ctr_specific_key(ctr, i));
800 if (len+thistime > buflen) {
801 size_t thistime2;
803 * tdb_pack hasn't done anything because of the short
804 * buffer, allocate extra space.
806 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
807 (len+thistime)*2);
808 if(buffer == NULL) {
809 DEBUG(0, ("regdb_store_keys: Failed to realloc "
810 "memory of size [%u]\n",
811 (unsigned int)(len+thistime)*2));
812 werr = WERR_NOMEM;
813 goto done;
815 buflen = (len+thistime)*2;
816 thistime2 = tdb_pack(
817 buffer+len, buflen-len, "f",
818 regsubkey_ctr_specific_key(ctr, i));
819 if (thistime2 != thistime) {
820 DEBUG(0, ("tdb_pack failed\n"));
821 werr = WERR_CAN_NOT_COMPLETE;
822 goto done;
825 len += thistime;
828 /* finally write out the data */
830 dbuf.dptr = buffer;
831 dbuf.dsize = len;
832 werr = ntstatus_to_werror(dbwrap_store_bystring(db, keyname, dbuf,
833 TDB_REPLACE));
834 W_ERROR_NOT_OK_GOTO_DONE(werr);
837 * recreate the sorted subkey cache for regdb_key_exists()
839 werr = ntstatus_to_werror(create_sorted_subkeys(keyname));
841 done:
842 TALLOC_FREE(ctx);
843 SAFE_FREE(buffer);
844 return werr;
847 /***********************************************************************
848 Store the new subkey record and create any child key records that
849 do not currently exist
850 ***********************************************************************/
852 struct regdb_store_keys_context {
853 const char *key;
854 struct regsubkey_ctr *ctr;
857 static NTSTATUS regdb_store_keys_action(struct db_context *db,
858 void *private_data)
860 struct regdb_store_keys_context *store_ctx;
861 WERROR werr;
862 int num_subkeys, i;
863 char *path = NULL;
864 struct regsubkey_ctr *subkeys = NULL, *old_subkeys = NULL;
865 char *oldkeyname = NULL;
866 TALLOC_CTX *mem_ctx = talloc_stackframe();
868 store_ctx = (struct regdb_store_keys_context *)private_data;
871 * Re-fetch the old keys inside the transaction
874 werr = regsubkey_ctr_init(mem_ctx, &old_subkeys);
875 W_ERROR_NOT_OK_GOTO_DONE(werr);
877 werr = regdb_fetch_keys_internal(db, store_ctx->key, old_subkeys);
878 if (!W_ERROR_IS_OK(werr) &&
879 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
881 goto done;
885 * Make the store operation as safe as possible without transactions:
887 * (1) For each subkey removed from ctr compared with old_subkeys:
889 * (a) First delete the value db entry.
891 * (b) Next delete the secdesc db record.
893 * (c) Then delete the subkey list entry.
895 * (2) Now write the list of subkeys of the parent key,
896 * deleting removed entries and adding new ones.
898 * (3) Finally create the subkey list entries for the added keys.
900 * This way if we crash half-way in between deleting the subkeys
901 * and storing the parent's list of subkeys, no old data can pop up
902 * out of the blue when re-adding keys later on.
905 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
907 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
908 for (i=0; i<num_subkeys; i++) {
909 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
911 if (regsubkey_ctr_key_exists(store_ctx->ctr, oldkeyname)) {
913 * It's still around, don't delete
915 continue;
918 path = talloc_asprintf(mem_ctx, "%s\\%s", store_ctx->key,
919 oldkeyname);
920 if (!path) {
921 werr = WERR_NOMEM;
922 goto done;
925 werr = regdb_delete_key_lists(db, path);
926 W_ERROR_NOT_OK_GOTO_DONE(werr);
928 TALLOC_FREE(path);
931 TALLOC_FREE(old_subkeys);
933 /* (2) store the subkey list for the parent */
935 werr = regdb_store_keys_internal2(db, store_ctx->key, store_ctx->ctr);
936 if (!W_ERROR_IS_OK(werr)) {
937 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
938 "for parent [%s]: %s\n", store_ctx->key,
939 win_errstr(werr)));
940 goto done;
943 /* (3) now create records for any subkeys that don't already exist */
945 num_subkeys = regsubkey_ctr_numkeys(store_ctx->ctr);
947 if (num_subkeys == 0) {
948 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
949 W_ERROR_NOT_OK_GOTO_DONE(werr);
951 werr = regdb_store_keys_internal2(db, store_ctx->key, subkeys);
952 if (!W_ERROR_IS_OK(werr)) {
953 DEBUG(0,("regdb_store_keys: Failed to store "
954 "new record for key [%s]: %s\n",
955 store_ctx->key, win_errstr(werr)));
956 goto done;
958 TALLOC_FREE(subkeys);
961 for (i=0; i<num_subkeys; i++) {
962 path = talloc_asprintf(mem_ctx, "%s\\%s", store_ctx->key,
963 regsubkey_ctr_specific_key(store_ctx->ctr, i));
964 if (!path) {
965 werr = WERR_NOMEM;
966 goto done;
968 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
969 W_ERROR_NOT_OK_GOTO_DONE(werr);
971 werr = regdb_fetch_keys_internal(db, path, subkeys);
972 if (!W_ERROR_IS_OK(werr)) {
973 /* create a record with 0 subkeys */
974 werr = regdb_store_keys_internal2(db, path, subkeys);
975 if (!W_ERROR_IS_OK(werr)) {
976 DEBUG(0,("regdb_store_keys: Failed to store "
977 "new record for key [%s]: %s\n", path,
978 win_errstr(werr)));
979 goto done;
983 TALLOC_FREE(subkeys);
984 TALLOC_FREE(path);
988 * Update the seqnum in the container to possibly
989 * prevent next read from going to disk
991 werr = regsubkey_ctr_set_seqnum(store_ctx->ctr, db->get_seqnum(db));
993 done:
994 talloc_free(mem_ctx);
995 return werror_to_ntstatus(werr);
998 static bool regdb_store_keys_internal(struct db_context *db, const char *key,
999 struct regsubkey_ctr *ctr)
1001 int num_subkeys, old_num_subkeys, i;
1002 struct regsubkey_ctr *old_subkeys = NULL;
1003 TALLOC_CTX *ctx = talloc_stackframe();
1004 WERROR werr;
1005 bool ret = false;
1006 struct regdb_store_keys_context store_ctx;
1008 if (!regdb_key_is_base_key(key) && !regdb_key_exists(db, key)) {
1009 goto done;
1013 * fetch a list of the old subkeys so we can determine if anything has
1014 * changed
1017 werr = regsubkey_ctr_init(ctx, &old_subkeys);
1018 if (!W_ERROR_IS_OK(werr)) {
1019 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
1020 goto done;
1023 werr = regdb_fetch_keys_internal(db, key, old_subkeys);
1024 if (!W_ERROR_IS_OK(werr) &&
1025 !W_ERROR_EQUAL(werr, WERR_NOT_FOUND))
1027 goto done;
1030 num_subkeys = regsubkey_ctr_numkeys(ctr);
1031 old_num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
1032 if ((num_subkeys && old_num_subkeys) &&
1033 (num_subkeys == old_num_subkeys)) {
1035 for (i = 0; i < num_subkeys; i++) {
1036 if (strcmp(regsubkey_ctr_specific_key(ctr, i),
1037 regsubkey_ctr_specific_key(old_subkeys, i))
1038 != 0)
1040 break;
1043 if (i == num_subkeys) {
1045 * Nothing changed, no point to even start a tdb
1046 * transaction
1049 ret = true;
1050 goto done;
1054 TALLOC_FREE(old_subkeys);
1056 store_ctx.key = key;
1057 store_ctx.ctr = ctr;
1059 werr = ntstatus_to_werror(dbwrap_trans_do(db,
1060 regdb_store_keys_action,
1061 &store_ctx));
1063 ret = W_ERROR_IS_OK(werr);
1065 done:
1066 TALLOC_FREE(ctx);
1068 return ret;
1071 bool regdb_store_keys(const char *key, struct regsubkey_ctr *ctr)
1073 return regdb_store_keys_internal(regdb, key, ctr);
1077 * create a subkey of a given key
1080 struct regdb_create_subkey_context {
1081 const char *key;
1082 const char *subkey;
1085 static NTSTATUS regdb_create_subkey_action(struct db_context *db,
1086 void *private_data)
1088 WERROR werr;
1089 struct regdb_create_subkey_context *create_ctx;
1090 struct regsubkey_ctr *subkeys;
1091 TALLOC_CTX *mem_ctx = talloc_stackframe();
1093 create_ctx = (struct regdb_create_subkey_context *)private_data;
1095 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1096 W_ERROR_NOT_OK_GOTO_DONE(werr);
1098 werr = regdb_fetch_keys_internal(db, create_ctx->key, subkeys);
1099 W_ERROR_NOT_OK_GOTO_DONE(werr);
1101 werr = regsubkey_ctr_addkey(subkeys, create_ctx->subkey);
1102 W_ERROR_NOT_OK_GOTO_DONE(werr);
1104 werr = regdb_store_keys_internal2(db, create_ctx->key, subkeys);
1105 if (!W_ERROR_IS_OK(werr)) {
1106 DEBUG(0, (__location__ " failed to store new subkey list for "
1107 "parent key %s: %s\n", create_ctx->key,
1108 win_errstr(werr)));
1111 done:
1112 talloc_free(mem_ctx);
1113 return werror_to_ntstatus(werr);
1116 static WERROR regdb_create_subkey(const char *key, const char *subkey)
1118 WERROR werr;
1119 struct regsubkey_ctr *subkeys;
1120 TALLOC_CTX *mem_ctx = talloc_stackframe();
1121 struct regdb_create_subkey_context create_ctx;
1123 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
1124 werr = WERR_NOT_FOUND;
1125 goto done;
1128 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1129 W_ERROR_NOT_OK_GOTO_DONE(werr);
1131 werr = regdb_fetch_keys_internal(regdb, key, subkeys);
1132 W_ERROR_NOT_OK_GOTO_DONE(werr);
1134 if (regsubkey_ctr_key_exists(subkeys, subkey)) {
1135 werr = WERR_OK;
1136 goto done;
1139 talloc_free(subkeys);
1141 create_ctx.key = key;
1142 create_ctx.subkey = subkey;
1144 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1145 regdb_create_subkey_action,
1146 &create_ctx));
1148 done:
1149 talloc_free(mem_ctx);
1150 return werr;
1154 * create a subkey of a given key
1157 struct regdb_delete_subkey_context {
1158 const char *key;
1159 const char *subkey;
1160 const char *path;
1163 static NTSTATUS regdb_delete_subkey_action(struct db_context *db,
1164 void *private_data)
1166 WERROR werr;
1167 struct regdb_delete_subkey_context *delete_ctx;
1168 struct regsubkey_ctr *subkeys;
1169 TALLOC_CTX *mem_ctx = talloc_stackframe();
1171 delete_ctx = (struct regdb_delete_subkey_context *)private_data;
1173 werr = regdb_delete_key_lists(db, delete_ctx->path);
1174 W_ERROR_NOT_OK_GOTO_DONE(werr);
1176 werr = regsubkey_ctr_init(mem_ctx, &subkeys);
1177 W_ERROR_NOT_OK_GOTO_DONE(werr);
1179 werr = regdb_fetch_keys_internal(db, delete_ctx->key, subkeys);
1180 W_ERROR_NOT_OK_GOTO_DONE(werr);
1182 werr = regsubkey_ctr_delkey(subkeys, delete_ctx->subkey);
1183 W_ERROR_NOT_OK_GOTO_DONE(werr);
1185 werr = regdb_store_keys_internal2(db, delete_ctx->key, subkeys);
1186 if (!W_ERROR_IS_OK(werr)) {
1187 DEBUG(0, (__location__ " failed to store new subkey_list for "
1188 "parent key %s: %s\n", delete_ctx->key,
1189 win_errstr(werr)));
1192 done:
1193 talloc_free(mem_ctx);
1194 return werror_to_ntstatus(werr);
1197 static WERROR regdb_delete_subkey(const char *key, const char *subkey)
1199 WERROR werr;
1200 char *path;
1201 struct regdb_delete_subkey_context delete_ctx;
1202 TALLOC_CTX *mem_ctx = talloc_stackframe();
1204 if (!regdb_key_is_base_key(key) && !regdb_key_exists(regdb, key)) {
1205 werr = WERR_NOT_FOUND;
1206 goto done;
1209 path = talloc_asprintf(mem_ctx, "%s\\%s", key, subkey);
1210 if (path == NULL) {
1211 werr = WERR_NOMEM;
1212 goto done;
1215 if (!regdb_key_exists(regdb, path)) {
1216 werr = WERR_OK;
1217 goto done;
1220 delete_ctx.key = key;
1221 delete_ctx.subkey = subkey;
1222 delete_ctx.path = path;
1224 werr = ntstatus_to_werror(dbwrap_trans_do(regdb,
1225 regdb_delete_subkey_action,
1226 &delete_ctx));
1228 done:
1229 talloc_free(mem_ctx);
1230 return werr;
1233 static TDB_DATA regdb_fetch_key_internal(struct db_context *db,
1234 TALLOC_CTX *mem_ctx, const char *key)
1236 char *path = NULL;
1237 TDB_DATA data;
1239 path = normalize_reg_path(mem_ctx, key);
1240 if (!path) {
1241 return make_tdb_data(NULL, 0);
1244 data = dbwrap_fetch_bystring(db, mem_ctx, path);
1246 TALLOC_FREE(path);
1247 return data;
1252 * check whether a given key name represents a base key,
1253 * i.e one without a subkey separator ('\').
1255 static bool regdb_key_is_base_key(const char *key)
1257 TALLOC_CTX *mem_ctx = talloc_stackframe();
1258 bool ret = false;
1259 char *path;
1261 if (key == NULL) {
1262 goto done;
1265 path = normalize_reg_path(mem_ctx, key);
1266 if (path == NULL) {
1267 DEBUG(0, ("out of memory! (talloc failed)\n"));
1268 goto done;
1271 if (*path == '\0') {
1272 goto done;
1275 ret = (strrchr(path, '\\') == NULL);
1277 done:
1278 TALLOC_FREE(mem_ctx);
1279 return ret;
1283 * regdb_key_exists() is a very frequent operation. It can be quite
1284 * time-consuming to fully fetch the parent's subkey list, talloc_strdup all
1285 * subkeys and then compare the keyname linearly to all the parent's subkeys.
1287 * The following code tries to make this operation as efficient as possible:
1288 * Per registry key we create a list of subkeys that is very efficient to
1289 * search for existence of a subkey. Its format is:
1291 * 4 bytes num_subkeys
1292 * 4*num_subkey bytes offset into the string array
1293 * then follows a sorted list of subkeys in uppercase
1295 * This record is created by create_sorted_subkeys() on demand if it does not
1296 * exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
1297 * list, the parsing code and the binary search can be found in
1298 * parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
1299 * the potentially large subkey record.
1301 * The sorted subkey record is deleted in regdb_store_keys_internal2 and
1302 * recreated on demand.
1305 static int cmp_keynames(char **p1, char **p2)
1307 return StrCaseCmp(*p1, *p2);
1310 struct create_sorted_subkeys_context {
1311 const char *key;
1312 const char *sorted_keyname;
1315 static NTSTATUS create_sorted_subkeys_action(struct db_context *db,
1316 void *private_data)
1318 char **sorted_subkeys;
1319 struct regsubkey_ctr *ctr;
1320 NTSTATUS status;
1321 char *buf;
1322 char *p;
1323 int i;
1324 size_t len;
1325 int num_subkeys;
1326 struct create_sorted_subkeys_context *sorted_ctx;
1328 sorted_ctx = (struct create_sorted_subkeys_context *)private_data;
1331 * In this function, we only treat failing of the actual write to
1332 * the db as a real error. All preliminary errors, at a stage when
1333 * nothing has been written to the DB yet are treated as success
1334 * to be committed (as an empty transaction).
1336 * The reason is that this (disposable) call might be nested in other
1337 * transactions. Doing a cancel here would destroy the possibility of
1338 * a transaction_commit for transactions that we might be wrapped in.
1341 status = werror_to_ntstatus(regsubkey_ctr_init(talloc_tos(), &ctr));
1342 if (!NT_STATUS_IS_OK(status)) {
1343 /* don't treat this as an error */
1344 status = NT_STATUS_OK;
1345 goto done;
1348 status = werror_to_ntstatus(regdb_fetch_keys_internal(db,
1349 sorted_ctx->key,
1350 ctr));
1351 if (!NT_STATUS_IS_OK(status)) {
1352 /* don't treat this as an error */
1353 status = NT_STATUS_OK;
1354 goto done;
1357 num_subkeys = regsubkey_ctr_numkeys(ctr);
1358 sorted_subkeys = talloc_array(ctr, char *, num_subkeys);
1359 if (sorted_subkeys == NULL) {
1360 /* don't treat this as an error */
1361 goto done;
1364 len = 4 + 4*num_subkeys;
1366 for (i = 0; i < num_subkeys; i++) {
1367 sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
1368 regsubkey_ctr_specific_key(ctr, i));
1369 if (sorted_subkeys[i] == NULL) {
1370 /* don't treat this as an error */
1371 goto done;
1373 len += strlen(sorted_subkeys[i])+1;
1376 TYPESAFE_QSORT(sorted_subkeys, num_subkeys, cmp_keynames);
1378 buf = talloc_array(ctr, char, len);
1379 if (buf == NULL) {
1380 /* don't treat this as an error */
1381 goto done;
1383 p = buf + 4 + 4*num_subkeys;
1385 SIVAL(buf, 0, num_subkeys);
1387 for (i=0; i < num_subkeys; i++) {
1388 ptrdiff_t offset = p - buf;
1389 SIVAL(buf, 4 + 4*i, offset);
1390 strlcpy(p, sorted_subkeys[i], len-offset);
1391 p += strlen(sorted_subkeys[i]) + 1;
1394 status = dbwrap_store_bystring(
1395 db, sorted_ctx->sorted_keyname, make_tdb_data((uint8_t *)buf,
1396 len),
1397 TDB_REPLACE);
1399 done:
1400 talloc_free(ctr);
1401 return status;
1404 static NTSTATUS create_sorted_subkeys_internal(const char *key,
1405 const char *sorted_keyname)
1407 NTSTATUS status;
1408 struct create_sorted_subkeys_context sorted_ctx;
1410 sorted_ctx.key = key;
1411 sorted_ctx.sorted_keyname = sorted_keyname;
1413 status = dbwrap_trans_do(regdb,
1414 create_sorted_subkeys_action,
1415 &sorted_ctx);
1417 return status;
1420 static NTSTATUS create_sorted_subkeys(const char *key)
1422 char *sorted_subkeys_keyname;
1423 NTSTATUS status;
1425 sorted_subkeys_keyname = talloc_asprintf(talloc_tos(), "%s\\%s",
1426 REG_SORTED_SUBKEYS_PREFIX,
1427 key);
1428 if (sorted_subkeys_keyname == NULL) {
1429 status = NT_STATUS_NO_MEMORY;
1430 goto done;
1433 status = create_sorted_subkeys_internal(key, sorted_subkeys_keyname);
1435 done:
1436 return status;
1439 struct scan_subkey_state {
1440 char *name;
1441 bool scanned;
1442 bool found;
1445 static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
1446 void *private_data)
1448 struct scan_subkey_state *state =
1449 (struct scan_subkey_state *)private_data;
1450 uint32_t num_subkeys;
1451 uint32_t l, u;
1453 if (data.dsize < sizeof(uint32_t)) {
1454 return -1;
1457 state->scanned = true;
1458 state->found = false;
1460 tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
1462 l = 0;
1463 u = num_subkeys;
1465 while (l < u) {
1466 uint32_t idx = (l+u)/2;
1467 char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
1468 int comparison = strcmp(state->name, s);
1470 if (comparison < 0) {
1471 u = idx;
1472 } else if (comparison > 0) {
1473 l = idx + 1;
1474 } else {
1475 state->found = true;
1476 return 0;
1479 return 0;
1482 static bool scan_parent_subkeys(struct db_context *db, const char *parent,
1483 const char *name)
1485 char *path = NULL;
1486 char *key = NULL;
1487 struct scan_subkey_state state = { 0, };
1488 bool result = false;
1489 int res;
1491 state.name = NULL;
1493 path = normalize_reg_path(talloc_tos(), parent);
1494 if (path == NULL) {
1495 goto fail;
1498 key = talloc_asprintf(talloc_tos(), "%s\\%s",
1499 REG_SORTED_SUBKEYS_PREFIX, path);
1500 if (key == NULL) {
1501 goto fail;
1504 state.name = talloc_strdup_upper(talloc_tos(), name);
1505 if (state.name == NULL) {
1506 goto fail;
1508 state.scanned = false;
1510 res = db->parse_record(db, string_term_tdb_data(key),
1511 parent_subkey_scanner, &state);
1513 if (state.scanned) {
1514 result = state.found;
1515 } else {
1516 NTSTATUS status;
1518 res = db->transaction_start(db);
1519 if (res != 0) {
1520 DEBUG(0, ("error starting transaction\n"));
1521 goto fail;
1524 DEBUG(2, (__location__ " WARNING: recreating the sorted "
1525 "subkeys cache for key '%s' from scan_parent_subkeys "
1526 "this should not happen (too frequently)...\n",
1527 path));
1529 status = create_sorted_subkeys_internal(path, key);
1530 if (!NT_STATUS_IS_OK(status)) {
1531 res = db->transaction_cancel(db);
1532 if (res != 0) {
1533 smb_panic("Failed to cancel transaction.");
1535 goto fail;
1538 res = db->parse_record(db, string_term_tdb_data(key),
1539 parent_subkey_scanner, &state);
1540 if ((res == 0) && (state.scanned)) {
1541 result = state.found;
1544 res = db->transaction_commit(db);
1545 if (res != 0) {
1546 DEBUG(0, ("error committing transaction\n"));
1547 result = false;
1551 fail:
1552 TALLOC_FREE(path);
1553 TALLOC_FREE(state.name);
1554 return result;
1558 * Check for the existence of a key.
1560 * Existence of a key is authoritatively defined by its
1561 * existence in the list of subkeys of its parent key.
1562 * The exeption of this are keys without a parent key,
1563 * i.e. the "base" keys (HKLM, HKCU, ...).
1565 static bool regdb_key_exists(struct db_context *db, const char *key)
1567 TALLOC_CTX *mem_ctx = talloc_stackframe();
1568 TDB_DATA value;
1569 bool ret = false;
1570 char *path, *p;
1572 if (key == NULL) {
1573 goto done;
1576 path = normalize_reg_path(mem_ctx, key);
1577 if (path == NULL) {
1578 DEBUG(0, ("out of memory! (talloc failed)\n"));
1579 goto done;
1582 if (*path == '\0') {
1583 goto done;
1586 p = strrchr(path, '\\');
1587 if (p == NULL) {
1588 /* this is a base key */
1589 value = regdb_fetch_key_internal(db, mem_ctx, path);
1590 ret = (value.dptr != NULL);
1591 } else {
1592 *p = '\0';
1593 ret = scan_parent_subkeys(db, path, p+1);
1596 done:
1597 TALLOC_FREE(mem_ctx);
1598 return ret;
1602 /***********************************************************************
1603 Retrieve an array of strings containing subkeys. Memory should be
1604 released by the caller.
1605 ***********************************************************************/
1607 static WERROR regdb_fetch_keys_internal(struct db_context *db, const char *key,
1608 struct regsubkey_ctr *ctr)
1610 WERROR werr;
1611 uint32_t num_items;
1612 uint8 *buf;
1613 uint32 buflen, len;
1614 int i;
1615 fstring subkeyname;
1616 TALLOC_CTX *frame = talloc_stackframe();
1617 TDB_DATA value;
1619 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1621 if (!regdb_key_exists(db, key)) {
1622 DEBUG(10, ("key [%s] not found\n", key));
1623 werr = WERR_NOT_FOUND;
1624 goto done;
1627 werr = regsubkey_ctr_set_seqnum(ctr, db->get_seqnum(db));
1628 W_ERROR_NOT_OK_GOTO_DONE(werr);
1630 value = regdb_fetch_key_internal(db, frame, key);
1632 if (value.dsize == 0 || value.dptr == NULL) {
1633 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1634 key));
1635 goto done;
1638 buf = value.dptr;
1639 buflen = value.dsize;
1640 len = tdb_unpack( buf, buflen, "d", &num_items);
1641 if (len == (uint32_t)-1) {
1642 werr = WERR_NOT_FOUND;
1643 goto done;
1646 werr = regsubkey_ctr_reinit(ctr);
1647 W_ERROR_NOT_OK_GOTO_DONE(werr);
1649 for (i=0; i<num_items; i++) {
1650 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1651 werr = regsubkey_ctr_addkey(ctr, subkeyname);
1652 if (!W_ERROR_IS_OK(werr)) {
1653 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1654 "failed: %s\n", win_errstr(werr)));
1655 num_items = 0;
1656 goto done;
1660 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1662 done:
1663 TALLOC_FREE(frame);
1664 return werr;
1667 int regdb_fetch_keys(const char *key, struct regsubkey_ctr *ctr)
1669 WERROR werr;
1671 werr = regdb_fetch_keys_internal(regdb, key, ctr);
1672 if (!W_ERROR_IS_OK(werr)) {
1673 return -1;
1676 return regsubkey_ctr_numkeys(ctr);
1679 /****************************************************************************
1680 Unpack a list of registry values frem the TDB
1681 ***************************************************************************/
1683 static int regdb_unpack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1685 int len = 0;
1686 uint32 type;
1687 fstring valuename;
1688 uint32 size;
1689 uint8 *data_p;
1690 uint32 num_values = 0;
1691 int i;
1693 /* loop and unpack the rest of the registry values */
1695 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1697 for ( i=0; i<num_values; i++ ) {
1698 /* unpack the next regval */
1700 type = REG_NONE;
1701 size = 0;
1702 data_p = NULL;
1703 valuename[0] = '\0';
1704 len += tdb_unpack(buf+len, buflen-len, "fdB",
1705 valuename,
1706 &type,
1707 &size,
1708 &data_p);
1710 regval_ctr_addvalue(values, valuename, type,
1711 (uint8_t *)data_p, size);
1712 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1714 DEBUG(10, ("regdb_unpack_values: value[%d]: name[%s] len[%d]\n",
1715 i, valuename, size));
1718 return len;
1721 /****************************************************************************
1722 Pack all values in all printer keys
1723 ***************************************************************************/
1725 static int regdb_pack_values(struct regval_ctr *values, uint8 *buf, int buflen)
1727 int len = 0;
1728 int i;
1729 struct regval_blob *val;
1730 int num_values;
1732 if ( !values )
1733 return 0;
1735 num_values = regval_ctr_numvals( values );
1737 /* pack the number of values first */
1739 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1741 /* loop over all values */
1743 for ( i=0; i<num_values; i++ ) {
1744 val = regval_ctr_specific_value( values, i );
1745 len += tdb_pack(buf+len, buflen-len, "fdB",
1746 regval_name(val),
1747 regval_type(val),
1748 regval_size(val),
1749 regval_data_p(val) );
1752 return len;
1755 /***********************************************************************
1756 Retrieve an array of strings containing subkeys. Memory should be
1757 released by the caller.
1758 ***********************************************************************/
1760 static int regdb_fetch_values_internal(struct db_context *db, const char* key,
1761 struct regval_ctr *values)
1763 char *keystr = NULL;
1764 TALLOC_CTX *ctx = talloc_stackframe();
1765 int ret = 0;
1766 TDB_DATA value;
1767 WERROR werr;
1769 DEBUG(10,("regdb_fetch_values: Looking for values of key [%s]\n", key));
1771 if (!regdb_key_exists(db, key)) {
1772 goto done;
1775 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key);
1776 if (!keystr) {
1777 goto done;
1780 werr = regval_ctr_set_seqnum(values, db->get_seqnum(db));
1781 W_ERROR_NOT_OK_GOTO_DONE(werr);
1783 value = regdb_fetch_key_internal(db, ctx, keystr);
1785 if (!value.dptr) {
1786 /* all keys have zero values by default */
1787 goto done;
1790 regdb_unpack_values(values, value.dptr, value.dsize);
1791 ret = regval_ctr_numvals(values);
1793 done:
1794 TALLOC_FREE(ctx);
1795 return ret;
1798 int regdb_fetch_values(const char* key, struct regval_ctr *values)
1800 return regdb_fetch_values_internal(regdb, key, values);
1803 static bool regdb_store_values_internal(struct db_context *db, const char *key,
1804 struct regval_ctr *values)
1806 TDB_DATA old_data, data;
1807 char *keystr = NULL;
1808 TALLOC_CTX *ctx = talloc_stackframe();
1809 int len;
1810 NTSTATUS status;
1811 bool result = false;
1812 WERROR werr;
1814 DEBUG(10,("regdb_store_values: Looking for values of key [%s]\n", key));
1816 if (!regdb_key_exists(db, key)) {
1817 goto done;
1820 ZERO_STRUCT(data);
1822 len = regdb_pack_values(values, data.dptr, data.dsize);
1823 if (len <= 0) {
1824 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1825 goto done;
1828 data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1829 data.dsize = len;
1831 len = regdb_pack_values(values, data.dptr, data.dsize);
1833 SMB_ASSERT( len == data.dsize );
1835 keystr = talloc_asprintf(ctx, "%s\\%s", REG_VALUE_PREFIX, key );
1836 if (!keystr) {
1837 goto done;
1839 keystr = normalize_reg_path(ctx, keystr);
1840 if (!keystr) {
1841 goto done;
1844 old_data = dbwrap_fetch_bystring(db, ctx, keystr);
1846 if ((old_data.dptr != NULL)
1847 && (old_data.dsize == data.dsize)
1848 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1850 result = true;
1851 goto done;
1854 status = dbwrap_trans_store_bystring(db, keystr, data, TDB_REPLACE);
1855 if (!NT_STATUS_IS_OK(status)) {
1856 DEBUG(0, ("regdb_store_values_internal: error storing: %s\n", nt_errstr(status)));
1857 goto done;
1861 * update the seqnum in the cache to prevent the next read
1862 * from going to disk
1864 werr = regval_ctr_set_seqnum(values, db->get_seqnum(db));
1865 result = W_ERROR_IS_OK(status);
1867 done:
1868 TALLOC_FREE(ctx);
1869 return result;
1872 bool regdb_store_values(const char *key, struct regval_ctr *values)
1874 return regdb_store_values_internal(regdb, key, values);
1877 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1878 struct security_descriptor **psecdesc)
1880 char *tdbkey;
1881 TDB_DATA data;
1882 NTSTATUS status;
1883 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1884 WERROR err = WERR_OK;
1886 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1888 if (!regdb_key_exists(regdb, key)) {
1889 err = WERR_BADFILE;
1890 goto done;
1893 tdbkey = talloc_asprintf(tmp_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1894 if (tdbkey == NULL) {
1895 err = WERR_NOMEM;
1896 goto done;
1899 tdbkey = normalize_reg_path(tmp_ctx, tdbkey);
1900 if (tdbkey == NULL) {
1901 err = WERR_NOMEM;
1902 goto done;
1905 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1906 if (data.dptr == NULL) {
1907 err = WERR_BADFILE;
1908 goto done;
1911 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1912 psecdesc);
1914 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1915 err = WERR_NOMEM;
1916 } else if (!NT_STATUS_IS_OK(status)) {
1917 err = WERR_REG_CORRUPT;
1920 done:
1921 TALLOC_FREE(tmp_ctx);
1922 return err;
1925 static WERROR regdb_set_secdesc(const char *key,
1926 struct security_descriptor *secdesc)
1928 TALLOC_CTX *mem_ctx = talloc_stackframe();
1929 char *tdbkey;
1930 WERROR err = WERR_NOMEM;
1931 TDB_DATA tdbdata;
1933 if (!regdb_key_exists(regdb, key)) {
1934 err = WERR_BADFILE;
1935 goto done;
1938 tdbkey = talloc_asprintf(mem_ctx, "%s\\%s", REG_SECDESC_PREFIX, key);
1939 if (tdbkey == NULL) {
1940 goto done;
1943 tdbkey = normalize_reg_path(mem_ctx, tdbkey);
1944 if (tdbkey == NULL) {
1945 err = WERR_NOMEM;
1946 goto done;
1949 if (secdesc == NULL) {
1950 /* assuming a delete */
1951 err = ntstatus_to_werror(dbwrap_trans_delete_bystring(regdb,
1952 tdbkey));
1953 goto done;
1956 err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1957 &tdbdata.dptr,
1958 &tdbdata.dsize));
1959 W_ERROR_NOT_OK_GOTO_DONE(err);
1961 err = ntstatus_to_werror(dbwrap_trans_store_bystring(regdb, tdbkey,
1962 tdbdata, 0));
1964 done:
1965 TALLOC_FREE(mem_ctx);
1966 return err;
1969 bool regdb_subkeys_need_update(struct regsubkey_ctr *subkeys)
1971 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys));
1974 bool regdb_values_need_update(struct regval_ctr *values)
1976 return (regdb_get_seqnum() != regval_ctr_get_seqnum(values));
1980 * Table of function pointers for default access
1983 struct registry_ops regdb_ops = {
1984 .fetch_subkeys = regdb_fetch_keys,
1985 .fetch_values = regdb_fetch_values,
1986 .store_subkeys = regdb_store_keys,
1987 .store_values = regdb_store_values,
1988 .create_subkey = regdb_create_subkey,
1989 .delete_subkey = regdb_delete_subkey,
1990 .get_secdesc = regdb_get_secdesc,
1991 .set_secdesc = regdb_set_secdesc,
1992 .subkeys_need_update = regdb_subkeys_need_update,
1993 .values_need_update = regdb_values_need_update