2 * Unix SMB/CIFS implementation.
3 * Virtual Windows Registry Layer
4 * Copyright (C) Gerald Carter 2002-2005
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 /* Implementation of internal registry database functions. */
25 #define DBGC_CLASS DBGC_REGISTRY
27 static struct db_context *regdb = NULL;
28 static int regdb_refcount;
30 static bool regdb_key_exists(const char *key);
31 static bool regdb_key_is_base_key(const char *key);
33 /* List the deepest path into the registry. All part components will be created.*/
35 /* If you want to have a part of the path controlled by the tdb and part by
36 a virtual registry db (e.g. printing), then you have to list the deepest path.
37 For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
38 allows the reg_db backend to handle everything up to
39 "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
40 the reg_printing backend onto the last component of the path (see
41 KEY_PRINTING_2K in include/rpc_reg.h) --jerry */
43 static const char *builtin_registry_paths[] = {
53 KEY_SAMBA_GROUP_POLICY,
54 KEY_GP_MACHINE_POLICY,
55 KEY_GP_MACHINE_WIN_POLICY,
58 KEY_GP_USER_WIN_POLICY,
59 KEY_WINLOGON_GPEXT_PATH,
60 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
62 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
71 struct builtin_regkey_value {
73 const char *valuename;
81 static struct builtin_regkey_value builtin_registry_values[] = {
83 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
85 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
87 "DisplayName", REG_SZ, { "Event Log" } },
89 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
90 { NULL, NULL, 0, { NULL } }
94 * Initialize a key in the registry:
95 * create each component key of the specified path.
97 static WERROR init_registry_key_internal(const char *add_path)
100 TALLOC_CTX *frame = talloc_stackframe();
103 char *remaining = NULL;
106 REGSUBKEY_CTR *subkeys;
109 DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path));
111 path = talloc_strdup(frame, add_path);
112 base = talloc_strdup(frame, "");
113 if (!path || !base) {
119 while (next_token_talloc(frame, &p, &keyname, "\\")) {
121 /* build up the registry path from the components */
124 base = talloc_asprintf(frame, "%s\\", base);
130 base = talloc_asprintf_append(base, "%s", keyname);
136 /* get the immediate subkeyname (if we have one ) */
138 subkeyname = talloc_strdup(frame, "");
144 remaining = talloc_strdup(frame, p);
151 if (!next_token_talloc(frame, &p2,
154 subkeyname = talloc_strdup(frame,p2);
162 DEBUG(10,("init_registry_key: Storing key [%s] with "
163 "subkey [%s]\n", base,
164 *subkeyname ? subkeyname : "NULL"));
166 /* we don't really care if the lookup succeeds or not
167 * since we are about to update the record.
168 * We just want any subkeys already present */
170 if (!(subkeys = TALLOC_ZERO_P(frame, REGSUBKEY_CTR))) {
171 DEBUG(0,("talloc() failure!\n"));
176 regdb_fetch_keys(base, subkeys);
178 werr = regsubkey_ctr_addkey(subkeys, subkeyname);
179 if (!W_ERROR_IS_OK(werr)) {
183 if (!regdb_store_keys( base, subkeys)) {
184 werr = WERR_CAN_NOT_COMPLETE;
197 * Initialize a key in the registry:
198 * create each component key of the specified path,
199 * wrapped in one db transaction.
201 WERROR init_registry_key(const char *add_path)
205 if (regdb_key_exists(add_path)) {
209 if (regdb->transaction_start(regdb) != 0) {
210 DEBUG(0, ("init_registry_key: transaction_start failed\n"));
211 return WERR_REG_IO_FAILURE;
214 werr = init_registry_key_internal(add_path);
215 if (!W_ERROR_IS_OK(werr)) {
219 if (regdb->transaction_commit(regdb) != 0) {
220 DEBUG(0, ("init_registry_key: Could not commit transaction\n"));
221 return WERR_REG_IO_FAILURE;
227 if (regdb->transaction_cancel(regdb) != 0) {
228 smb_panic("init_registry_key: transaction_cancel failed\n");
234 /***********************************************************************
235 Open the registry data in the tdb
236 ***********************************************************************/
238 WERROR init_registry_data(void)
241 TALLOC_CTX *frame = talloc_stackframe();
247 * First, check for the existence of the needed keys and values.
248 * If all do already exist, we can save the writes.
250 for (i=0; builtin_registry_paths[i] != NULL; i++) {
251 if (!regdb_key_exists(builtin_registry_paths[i])) {
256 for (i=0; builtin_registry_values[i].path != NULL; i++) {
257 values = TALLOC_ZERO_P(frame, REGVAL_CTR);
258 if (values == NULL) {
263 regdb_fetch_values(builtin_registry_values[i].path, values);
264 if (!regval_ctr_key_exists(values,
265 builtin_registry_values[i].valuename))
280 * There are potentially quite a few store operations which are all
281 * indiviually wrapped in tdb transactions. Wrapping them in a single
282 * transaction gives just a single transaction_commit() to actually do
283 * its fsync()s. See tdb/common/transaction.c for info about nested
284 * transaction behaviour.
287 if (regdb->transaction_start(regdb) != 0) {
288 DEBUG(0, ("init_registry_data: tdb_transaction_start "
290 werr = WERR_REG_IO_FAILURE;
294 /* loop over all of the predefined paths and add each component */
296 for (i=0; builtin_registry_paths[i] != NULL; i++) {
297 if (regdb_key_exists(builtin_registry_paths[i])) {
300 werr = init_registry_key_internal(builtin_registry_paths[i]);
301 if (!W_ERROR_IS_OK(werr)) {
306 /* loop over all of the predefined values and add each component */
308 for (i=0; builtin_registry_values[i].path != NULL; i++) {
310 values = TALLOC_ZERO_P(frame, REGVAL_CTR);
311 if (values == NULL) {
316 regdb_fetch_values(builtin_registry_values[i].path, values);
318 /* preserve existing values across restarts. Only add new ones */
320 if (!regval_ctr_key_exists(values,
321 builtin_registry_values[i].valuename))
323 switch(builtin_registry_values[i].type) {
325 regval_ctr_addvalue(values,
326 builtin_registry_values[i].valuename,
328 (char*)&builtin_registry_values[i].data.dw_value,
334 builtin_registry_values[i].data.string,
336 regval_ctr_addvalue(values,
337 builtin_registry_values[i].valuename,
340 data.uni_str_len*sizeof(uint16));
344 DEBUG(0, ("init_registry_data: invalid value "
345 "type in builtin_registry_values "
347 builtin_registry_values[i].type));
349 regdb_store_values(builtin_registry_values[i].path,
355 if (regdb->transaction_commit(regdb) != 0) {
356 DEBUG(0, ("init_registry_data: Could not commit "
358 werr = WERR_REG_IO_FAILURE;
366 if (regdb->transaction_cancel(regdb) != 0) {
367 smb_panic("init_registry_data: tdb_transaction_cancel "
376 /***********************************************************************
377 Open the registry database
378 ***********************************************************************/
380 WERROR regdb_init(void)
382 const char *vstring = "INFO/version";
387 DEBUG(10, ("regdb_init: incrementing refcount (%d)\n",
393 regdb = db_open(NULL, state_path("registry.tdb"), 0,
394 REG_TDB_FLAGS, O_RDWR, 0600);
396 regdb = db_open(NULL, state_path("registry.tdb"), 0,
397 REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
399 werr = ntstatus_to_werror(map_nt_error_from_unix(errno));
400 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
401 state_path("registry.tdb"), strerror(errno) ));
405 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
410 vers_id = dbwrap_fetch_int32(regdb, vstring);
412 if ( vers_id != REGVER_V1 ) {
414 /* any upgrade code here if needed */
415 DEBUG(10, ("regdb_init: got %s = %d != %d\n", vstring,
416 vers_id, REGVER_V1));
417 status = dbwrap_trans_store_int32(regdb, vstring, REGVER_V1);
418 if (!NT_STATUS_IS_OK(status)) {
419 DEBUG(1, ("regdb_init: error storing %s = %d: %s\n",
420 vstring, REGVER_V1, nt_errstr(status)));
421 return ntstatus_to_werror(status);
423 DEBUG(10, ("regdb_init: stored %s = %d\n",
424 vstring, REGVER_V1));
431 /***********************************************************************
432 Open the registry. Must already have been initialized by regdb_init()
433 ***********************************************************************/
435 WERROR regdb_open( void )
437 WERROR result = WERR_OK;
440 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount));
447 regdb = db_open(NULL, state_path("registry.tdb"), 0,
448 REG_TDB_FLAGS, O_RDWR, 0600);
450 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
451 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
452 state_path("registry.tdb"), strerror(errno) ));
458 DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount));
463 /***********************************************************************
464 ***********************************************************************/
466 int regdb_close( void )
468 if (regdb_refcount == 0) {
474 DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount));
476 if ( regdb_refcount > 0 )
479 SMB_ASSERT( regdb_refcount >= 0 );
485 WERROR regdb_transaction_start(void)
487 return (regdb->transaction_start(regdb) == 0) ?
488 WERR_OK : WERR_REG_IO_FAILURE;
491 WERROR regdb_transaction_commit(void)
493 return (regdb->transaction_commit(regdb) == 0) ?
494 WERR_OK : WERR_REG_IO_FAILURE;
497 WERROR regdb_transaction_cancel(void)
499 return (regdb->transaction_cancel(regdb) == 0) ?
500 WERR_OK : WERR_REG_IO_FAILURE;
503 /***********************************************************************
504 return the tdb sequence number of the registry tdb.
505 this is an indicator for the content of the registry
506 having changed. it will change upon regdb_init, too, though.
507 ***********************************************************************/
508 int regdb_get_seqnum(void)
510 return regdb->get_seqnum(regdb);
513 /***********************************************************************
514 Add subkey strings to the registry tdb under a defined key
515 fmt is the same format as tdb_pack except this function only supports
517 ***********************************************************************/
519 static bool regdb_store_keys_internal(const char *key, REGSUBKEY_CTR *ctr)
522 uint8 *buffer = NULL;
526 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
527 char *keyname = NULL;
528 TALLOC_CTX *ctx = talloc_stackframe();
535 keyname = talloc_strdup(ctx, key);
539 keyname = normalize_reg_path(ctx, keyname);
541 /* allocate some initial memory */
543 buffer = (uint8 *)SMB_MALLOC(1024);
544 if (buffer == NULL) {
550 /* store the number of subkeys */
552 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
554 /* pack all the strings */
556 for (i=0; i<num_subkeys; i++) {
559 thistime = tdb_pack(buffer+len, buflen-len, "f",
560 regsubkey_ctr_specific_key(ctr, i));
561 if (len+thistime > buflen) {
564 * tdb_pack hasn't done anything because of the short
565 * buffer, allocate extra space.
567 buffer = SMB_REALLOC_ARRAY(buffer, uint8_t,
570 DEBUG(0, ("regdb_store_keys: Failed to realloc "
571 "memory of size [%u]\n",
572 (unsigned int)(len+thistime)*2));
576 buflen = (len+thistime)*2;
577 thistime2 = tdb_pack(
578 buffer+len, buflen-len, "f",
579 regsubkey_ctr_specific_key(ctr, i));
580 if (thistime2 != thistime) {
581 DEBUG(0, ("tdb_pack failed\n"));
589 /* finally write out the data */
593 status = dbwrap_store_bystring(regdb, keyname, dbuf, TDB_REPLACE);
594 if (!NT_STATUS_IS_OK(status)) {
600 * Delete a sorted subkey cache for regdb_key_exists, will be
601 * recreated automatically
603 keyname = talloc_asprintf(ctx, "%s/%s", REG_SORTED_SUBKEYS_PREFIX,
605 if (keyname != NULL) {
606 dbwrap_delete_bystring(regdb, keyname);
615 /***********************************************************************
616 Store the new subkey record and create any child key records that
617 do not currently exist
618 ***********************************************************************/
620 bool regdb_store_keys(const char *key, REGSUBKEY_CTR *ctr)
624 REGSUBKEY_CTR *subkeys = NULL, *old_subkeys = NULL;
625 char *oldkeyname = NULL;
626 TALLOC_CTX *ctx = talloc_stackframe();
629 if (!regdb_key_is_base_key(key) && !regdb_key_exists(key)) {
634 * fetch a list of the old subkeys so we can determine if anything has
638 if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
639 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
643 regdb_fetch_keys(key, old_subkeys);
645 if ((ctr->num_subkeys && old_subkeys->num_subkeys) &&
646 (ctr->num_subkeys == old_subkeys->num_subkeys)) {
648 for (i = 0; i<ctr->num_subkeys; i++) {
649 if (strcmp(ctr->subkeys[i],
650 old_subkeys->subkeys[i]) != 0) {
654 if (i == ctr->num_subkeys) {
656 * Nothing changed, no point to even start a tdb
659 TALLOC_FREE(old_subkeys);
664 TALLOC_FREE(old_subkeys);
666 if (regdb->transaction_start(regdb) != 0) {
667 DEBUG(0, ("regdb_store_keys: transaction_start failed\n"));
672 * Re-fetch the old keys inside the transaction
675 if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
676 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
680 regdb_fetch_keys(key, old_subkeys);
683 * Make the store operation as safe as possible without transactions:
685 * (1) For each subkey removed from ctr compared with old_subkeys:
687 * (a) First delete the value db entry.
689 * (b) Next delete the secdesc db record.
691 * (c) Then delete the subkey list entry.
693 * (2) Now write the list of subkeys of the parent key,
694 * deleting removed entries and adding new ones.
696 * (3) Finally create the subkey list entries for the added keys.
698 * This way if we crash half-way in between deleting the subkeys
699 * and storing the parent's list of subkeys, no old data can pop up
700 * out of the blue when re-adding keys later on.
703 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
705 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
706 for (i=0; i<num_subkeys; i++) {
707 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
709 if (regsubkey_ctr_key_exists(ctr, oldkeyname)) {
711 * It's still around, don't delete
717 /* (a) Delete the value list for this key */
719 path = talloc_asprintf(ctx, "%s/%s/%s",
726 path = normalize_reg_path(ctx, path);
730 /* Ignore errors here, we might have no values around */
731 dbwrap_delete_bystring(regdb, path);
734 /* (b) Delete the secdesc for this key */
736 path = talloc_asprintf(ctx, "%s/%s/%s",
743 path = normalize_reg_path(ctx, path);
747 status = dbwrap_delete_bystring(regdb, path);
748 /* Don't fail if there are no values around. */
749 if (!NT_STATUS_IS_OK(status) &&
750 !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
752 DEBUG(1, ("Deleting %s failed: %s\n", path,
758 /* (c) Delete the list of subkeys of this key */
760 path = talloc_asprintf(ctx, "%s/%s", key, oldkeyname);
764 path = normalize_reg_path(ctx, path);
768 status = dbwrap_delete_bystring(regdb, path);
769 /* Don't fail if the subkey record was not found. */
770 if (!NT_STATUS_IS_OK(status) &&
771 !NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND))
773 DEBUG(1, ("Deleting %s failed: %s\n", path,
780 TALLOC_FREE(old_subkeys);
782 /* (2) store the subkey list for the parent */
784 if (!regdb_store_keys_internal(key, ctr) ) {
785 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
786 "for parent [%s]\n", key));
790 /* (3) now create records for any subkeys that don't already exist */
792 num_subkeys = regsubkey_ctr_numkeys(ctr);
794 if (num_subkeys == 0) {
795 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
796 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
800 if (!regdb_store_keys_internal(key, subkeys)) {
801 DEBUG(0,("regdb_store_keys: Failed to store "
802 "new record for key [%s]\n", key));
805 TALLOC_FREE(subkeys);
809 for (i=0; i<num_subkeys; i++) {
810 path = talloc_asprintf(ctx, "%s/%s",
812 regsubkey_ctr_specific_key(ctr, i));
816 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
817 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
821 if (regdb_fetch_keys( path, subkeys ) == -1) {
822 /* create a record with 0 subkeys */
823 if (!regdb_store_keys_internal(path, subkeys)) {
824 DEBUG(0,("regdb_store_keys: Failed to store "
825 "new record for key [%s]\n", path));
830 TALLOC_FREE(subkeys);
834 if (regdb->transaction_commit(regdb) != 0) {
835 DEBUG(0, ("regdb_store_keys: Could not commit transaction\n"));
843 if (regdb->transaction_cancel(regdb) != 0) {
844 smb_panic("regdb_store_keys: transaction_cancel failed\n");
854 static TDB_DATA regdb_fetch_key_internal(TALLOC_CTX *mem_ctx, const char *key)
859 path = normalize_reg_path(mem_ctx, key);
861 return make_tdb_data(NULL, 0);
864 data = dbwrap_fetch_bystring(regdb, mem_ctx, path);
872 * check whether a given key name represents a base key,
873 * i.e one without a subkey separator ('/' or '\').
875 static bool regdb_key_is_base_key(const char *key)
877 TALLOC_CTX *mem_ctx = talloc_stackframe();
885 path = normalize_reg_path(mem_ctx, key);
887 DEBUG(0, ("out of memory! (talloc failed)\n"));
895 ret = (strrchr(path, '/') == NULL);
898 TALLOC_FREE(mem_ctx);
903 * regdb_key_exists() is a very frequent operation. It can be quite
904 * time-consuming to fully fetch the parent's subkey list, talloc_strdup all
905 * subkeys and then compare the keyname linearly to all the parent's subkeys.
907 * The following code tries to make this operation as efficient as possible:
908 * Per registry key we create a list of subkeys that is very efficient to
909 * search for existence of a subkey. Its format is:
911 * 4 bytes num_subkeys
912 * 4*num_subkey bytes offset into the string array
913 * then follows a sorted list of subkeys in uppercase
915 * This record is created by create_sorted_subkeys() on demand if it does not
916 * exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
917 * list, the parsing code and the binary search can be found in
918 * parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
919 * the potentially large subkey record.
921 * The sorted subkey record is deleted in regdb_store_keys_internal and
922 * recreated on demand.
925 static int cmp_keynames(const void *p1, const void *p2)
927 return StrCaseCmp(*((char **)p1), *((char **)p2));
930 static bool create_sorted_subkeys(const char *key, const char *sorted_keyname)
932 char **sorted_subkeys;
941 if (regdb->transaction_start(regdb) != 0) {
942 DEBUG(0, ("create_sorted_subkeys: transaction_start "
947 ctr = talloc(talloc_tos(), REGSUBKEY_CTR);
952 res = regdb_fetch_keys(key, ctr);
957 sorted_subkeys = talloc_array(ctr, char *, ctr->num_subkeys);
958 if (sorted_subkeys == NULL) {
962 len = 4 + 4*ctr->num_subkeys;
964 for (i = 0; i<ctr->num_subkeys; i++) {
965 sorted_subkeys[i] = talloc_strdup_upper(sorted_subkeys,
967 if (sorted_subkeys[i] == NULL) {
970 len += strlen(sorted_subkeys[i])+1;
973 qsort(sorted_subkeys, ctr->num_subkeys, sizeof(char *), cmp_keynames);
975 buf = talloc_array(ctr, char, len);
979 p = buf + 4 + 4*ctr->num_subkeys;
981 SIVAL(buf, 0, ctr->num_subkeys);
983 for (i=0; i<ctr->num_subkeys; i++) {
984 ptrdiff_t offset = p - buf;
985 SIVAL(buf, 4 + 4*i, offset);
986 strlcpy(p, sorted_subkeys[i], len-offset);
987 p += strlen(sorted_subkeys[i]) + 1;
990 status = dbwrap_store_bystring(
991 regdb, sorted_keyname, make_tdb_data((uint8_t *)buf, len),
993 if (!NT_STATUS_IS_OK(status)) {
995 * Don't use a "goto fail;" here, this would commit the broken
996 * transaction. See below for an explanation.
998 if (regdb->transaction_cancel(regdb) == -1) {
999 DEBUG(0, ("create_sorted_subkeys: transaction_cancel "
1009 * We only get here via the "goto fail" when we did not write anything
1010 * yet. Using transaction_commit even in a failure case is necessary
1011 * because this (disposable) call might be nested in other
1012 * transactions. Doing a cancel here would destroy the possibility of
1013 * a transaction_commit for transactions that we might be wrapped in.
1015 if (regdb->transaction_commit(regdb) == -1) {
1016 DEBUG(0, ("create_sorted_subkeys: transaction_start "
1025 struct scan_subkey_state {
1031 static int parent_subkey_scanner(TDB_DATA key, TDB_DATA data,
1034 struct scan_subkey_state *state =
1035 (struct scan_subkey_state *)private_data;
1036 uint32_t num_subkeys;
1039 if (data.dsize < sizeof(uint32_t)) {
1043 state->scanned = true;
1044 state->found = false;
1046 tdb_unpack(data.dptr, data.dsize, "d", &num_subkeys);
1052 uint32_t idx = (l+u)/2;
1053 char *s = (char *)data.dptr + IVAL(data.dptr, 4 + 4*idx);
1054 int comparison = strcmp(state->name, s);
1056 if (comparison < 0) {
1058 } else if (comparison > 0) {
1061 state->found = true;
1068 static bool scan_parent_subkeys(const char *parent, const char *name)
1072 struct scan_subkey_state state = { 0, };
1073 bool result = false;
1078 path = normalize_reg_path(talloc_tos(), parent);
1083 key = talloc_asprintf(talloc_tos(), "%s/%s",
1084 REG_SORTED_SUBKEYS_PREFIX, path);
1089 state.name = talloc_strdup_upper(talloc_tos(), name);
1090 if (state.name == NULL) {
1093 state.scanned = false;
1095 res = regdb->parse_record(regdb, string_term_tdb_data(key),
1096 parent_subkey_scanner, &state);
1098 if (state.scanned) {
1099 result = state.found;
1101 if (!create_sorted_subkeys(path, key)) {
1104 res = regdb->parse_record(regdb, string_term_tdb_data(key),
1105 parent_subkey_scanner, &state);
1106 if ((res == 0) && (state.scanned)) {
1107 result = state.found;
1113 TALLOC_FREE(state.name);
1118 * Check for the existence of a key.
1120 * Existence of a key is authoritatively defined by its
1121 * existence in the list of subkeys of its parent key.
1122 * The exeption of this are keys without a parent key,
1123 * i.e. the "base" keys (HKLM, HKCU, ...).
1125 static bool regdb_key_exists(const char *key)
1127 TALLOC_CTX *mem_ctx = talloc_stackframe();
1136 path = normalize_reg_path(mem_ctx, key);
1138 DEBUG(0, ("out of memory! (talloc failed)\n"));
1142 if (*path == '\0') {
1146 p = strrchr(path, '/');
1148 /* this is a base key */
1149 value = regdb_fetch_key_internal(mem_ctx, path);
1150 ret = (value.dptr != NULL);
1153 ret = scan_parent_subkeys(path, p+1);
1157 TALLOC_FREE(mem_ctx);
1162 /***********************************************************************
1163 Retrieve an array of strings containing subkeys. Memory should be
1164 released by the caller.
1165 ***********************************************************************/
1167 int regdb_fetch_keys(const char *key, REGSUBKEY_CTR *ctr)
1175 TALLOC_CTX *frame = talloc_stackframe();
1178 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
1180 if (!regdb_key_exists(key)) {
1184 ctr->seqnum = regdb_get_seqnum();
1186 value = regdb_fetch_key_internal(frame, key);
1188 if (value.dptr == NULL) {
1189 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1196 buflen = value.dsize;
1197 len = tdb_unpack( buf, buflen, "d", &num_items);
1200 * The following code breaks the abstraction that reg_objects.c sets
1201 * up with regsubkey_ctr_addkey(). But if we use that with the current
1202 * data structure of ctr->subkeys being an unsorted array, we end up
1203 * with an O(n^2) algorithm for retrieving keys from the tdb
1204 * file. This is pretty pointless, as we have to trust the data
1205 * structure on disk not to have duplicates anyway. The alternative to
1206 * breaking this abstraction would be to set up a more sophisticated
1207 * data structure in REGSUBKEY_CTR.
1209 * This makes "net conf list" for a registry with >1000 shares
1210 * actually usable :-)
1213 ctr->subkeys = talloc_array(ctr, char *, num_items);
1214 if (ctr->subkeys == NULL) {
1215 DEBUG(5, ("regdb_fetch_keys: could not allocate subkeys\n"));
1218 ctr->num_subkeys = num_items;
1220 for (i=0; i<num_items; i++) {
1221 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
1222 ctr->subkeys[i] = talloc_strdup(ctr->subkeys, subkeyname);
1223 if (ctr->subkeys[i] == NULL) {
1224 DEBUG(5, ("regdb_fetch_keys: could not allocate "
1226 TALLOC_FREE(ctr->subkeys);
1227 ctr->num_subkeys = 0;
1232 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
1240 /****************************************************************************
1241 Unpack a list of registry values frem the TDB
1242 ***************************************************************************/
1244 static int regdb_unpack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1251 uint32 num_values = 0;
1254 /* loop and unpack the rest of the registry values */
1256 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
1258 for ( i=0; i<num_values; i++ ) {
1259 /* unpack the next regval */
1264 valuename[0] = '\0';
1265 len += tdb_unpack(buf+len, buflen-len, "fdB",
1271 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1273 if (*valuename && size && data_p) {
1274 regval_ctr_addvalue(values, valuename, type,
1275 (const char *)data_p, size);
1277 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
1279 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
1285 /****************************************************************************
1286 Pack all values in all printer keys
1287 ***************************************************************************/
1289 static int regdb_pack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
1293 REGISTRY_VALUE *val;
1299 num_values = regval_ctr_numvals( values );
1301 /* pack the number of values first */
1303 len += tdb_pack( buf+len, buflen-len, "d", num_values );
1305 /* loop over all values */
1307 for ( i=0; i<num_values; i++ ) {
1308 val = regval_ctr_specific_value( values, i );
1309 len += tdb_pack(buf+len, buflen-len, "fdB",
1313 regval_data_p(val) );
1319 /***********************************************************************
1320 Retrieve an array of strings containing subkeys. Memory should be
1321 released by the caller.
1322 ***********************************************************************/
1324 int regdb_fetch_values( const char* key, REGVAL_CTR *values )
1326 char *keystr = NULL;
1327 TALLOC_CTX *ctx = talloc_stackframe();
1331 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
1333 if (!regdb_key_exists(key)) {
1337 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
1342 values->seqnum = regdb_get_seqnum();
1344 value = regdb_fetch_key_internal(ctx, keystr);
1347 /* all keys have zero values by default */
1351 regdb_unpack_values(values, value.dptr, value.dsize);
1352 ret = regval_ctr_numvals(values);
1359 bool regdb_store_values( const char *key, REGVAL_CTR *values )
1361 TDB_DATA old_data, data;
1362 char *keystr = NULL;
1363 TALLOC_CTX *ctx = talloc_stackframe();
1366 bool result = false;
1368 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
1370 if (!regdb_key_exists(key)) {
1376 len = regdb_pack_values(values, data.dptr, data.dsize);
1378 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1382 data.dptr = TALLOC_ARRAY(ctx, uint8, len);
1385 len = regdb_pack_values(values, data.dptr, data.dsize);
1387 SMB_ASSERT( len == data.dsize );
1389 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
1393 keystr = normalize_reg_path(ctx, keystr);
1398 old_data = dbwrap_fetch_bystring(regdb, ctx, keystr);
1400 if ((old_data.dptr != NULL)
1401 && (old_data.dsize == data.dsize)
1402 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
1408 status = dbwrap_trans_store_bystring(regdb, keystr, data, TDB_REPLACE);
1410 result = NT_STATUS_IS_OK(status);
1417 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
1418 struct security_descriptor **psecdesc)
1423 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1424 WERROR err = WERR_OK;
1426 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
1428 if (!regdb_key_exists(key)) {
1433 tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1434 if (tdbkey == NULL) {
1438 normalize_dbkey(tdbkey);
1440 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
1441 if (data.dptr == NULL) {
1446 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
1449 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
1451 } else if (!NT_STATUS_IS_OK(status)) {
1452 err = WERR_REG_CORRUPT;
1456 TALLOC_FREE(tmp_ctx);
1460 static WERROR regdb_set_secdesc(const char *key,
1461 struct security_descriptor *secdesc)
1463 TALLOC_CTX *mem_ctx = talloc_stackframe();
1466 WERROR err = WERR_NOMEM;
1469 if (!regdb_key_exists(key)) {
1474 tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
1475 if (tdbkey == NULL) {
1478 normalize_dbkey(tdbkey);
1480 if (secdesc == NULL) {
1481 /* assuming a delete */
1482 status = dbwrap_trans_delete_bystring(regdb, tdbkey);
1483 if (NT_STATUS_IS_OK(status)) {
1486 err = ntstatus_to_werror(status);
1491 err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
1494 if (!W_ERROR_IS_OK(err)) {
1498 status = dbwrap_trans_store_bystring(regdb, tdbkey, tdbdata, 0);
1499 if (!NT_STATUS_IS_OK(status)) {
1500 err = ntstatus_to_werror(status);
1505 TALLOC_FREE(mem_ctx);
1509 bool regdb_subkeys_need_update(REGSUBKEY_CTR *subkeys)
1511 return (regdb_get_seqnum() != subkeys->seqnum);
1514 bool regdb_values_need_update(REGVAL_CTR *values)
1516 return (regdb_get_seqnum() != values->seqnum);
1520 * Table of function pointers for default access
1523 REGISTRY_OPS regdb_ops = {
1524 .fetch_subkeys = regdb_fetch_keys,
1525 .fetch_values = regdb_fetch_values,
1526 .store_subkeys = regdb_store_keys,
1527 .store_values = regdb_store_values,
1528 .get_secdesc = regdb_get_secdesc,
1529 .set_secdesc = regdb_set_secdesc,
1530 .subkeys_need_update = regdb_subkeys_need_update,
1531 .values_need_update = regdb_values_need_update