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(struct db_context
*db
, const char *key
);
31 static bool regdb_key_is_base_key(const char *key
);
32 static int regdb_fetch_keys_internal(struct db_context
*db
, const char *key
,
33 struct regsubkey_ctr
*ctr
);
34 static bool regdb_store_keys_internal(struct db_context
*db
, const char *key
,
35 struct regsubkey_ctr
*ctr
);
37 /* List the deepest path into the registry. All part components will be created.*/
39 /* If you want to have a part of the path controlled by the tdb and part by
40 a virtual registry db (e.g. printing), then you have to list the deepest path.
41 For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
42 allows the reg_db backend to handle everything up to
43 "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
44 the reg_printing backend onto the last component of the path (see
45 KEY_PRINTING_2K in include/rpc_reg.h) --jerry */
47 static const char *builtin_registry_paths
[] = {
57 KEY_SAMBA_GROUP_POLICY
,
58 KEY_GP_MACHINE_POLICY
,
59 KEY_GP_MACHINE_WIN_POLICY
,
62 KEY_GP_USER_WIN_POLICY
,
63 KEY_WINLOGON_GPEXT_PATH
,
64 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
66 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
75 struct builtin_regkey_value
{
77 const char *valuename
;
85 static struct builtin_regkey_value builtin_registry_values
[] = {
87 SAMBA_PRINTER_PORT_NAME
, REG_SZ
, { "" } },
89 "DefaultSpoolDirectory", REG_SZ
, { "C:\\Windows\\System32\\Spool\\Printers" } },
91 "DisplayName", REG_SZ
, { "Event Log" } },
93 "ErrorControl", REG_DWORD
, { (char*)0x00000001 } },
94 { NULL
, NULL
, 0, { NULL
} }
98 * Initialize a key in the registry:
99 * create each component key of the specified path.
101 static WERROR
init_registry_key_internal(const char *add_path
)
104 TALLOC_CTX
*frame
= talloc_stackframe();
107 char *remaining
= NULL
;
110 struct regsubkey_ctr
*subkeys
;
113 DEBUG(6, ("init_registry_key: Adding [%s]\n", add_path
));
115 path
= talloc_strdup(frame
, add_path
);
116 base
= talloc_strdup(frame
, "");
117 if (!path
|| !base
) {
123 while (next_token_talloc(frame
, &p
, &keyname
, "\\")) {
125 /* build up the registry path from the components */
128 base
= talloc_asprintf(frame
, "%s\\", base
);
134 base
= talloc_asprintf_append(base
, "%s", keyname
);
140 /* get the immediate subkeyname (if we have one ) */
142 subkeyname
= talloc_strdup(frame
, "");
148 remaining
= talloc_strdup(frame
, p
);
155 if (!next_token_talloc(frame
, &p2
,
158 subkeyname
= talloc_strdup(frame
,p2
);
166 DEBUG(10,("init_registry_key: Storing key [%s] with "
167 "subkey [%s]\n", base
,
168 *subkeyname
? subkeyname
: "NULL"));
170 /* we don't really care if the lookup succeeds or not
171 * since we are about to update the record.
172 * We just want any subkeys already present */
174 werr
= regsubkey_ctr_init(frame
, &subkeys
);
175 if (!W_ERROR_IS_OK(werr
)) {
176 DEBUG(0,("talloc() failure!\n"));
180 regdb_fetch_keys_internal(regdb
, base
, subkeys
);
182 werr
= regsubkey_ctr_addkey(subkeys
, subkeyname
);
183 if (!W_ERROR_IS_OK(werr
)) {
187 if (!regdb_store_keys_internal(regdb
, base
, subkeys
)) {
188 werr
= WERR_CAN_NOT_COMPLETE
;
201 * Initialize a key in the registry:
202 * create each component key of the specified path,
203 * wrapped in one db transaction.
205 WERROR
init_registry_key(const char *add_path
)
209 if (regdb_key_exists(regdb
, add_path
)) {
213 if (regdb
->transaction_start(regdb
) != 0) {
214 DEBUG(0, ("init_registry_key: transaction_start failed\n"));
215 return WERR_REG_IO_FAILURE
;
218 werr
= init_registry_key_internal(add_path
);
219 if (!W_ERROR_IS_OK(werr
)) {
223 if (regdb
->transaction_commit(regdb
) != 0) {
224 DEBUG(0, ("init_registry_key: Could not commit transaction\n"));
225 return WERR_REG_IO_FAILURE
;
231 if (regdb
->transaction_cancel(regdb
) != 0) {
232 smb_panic("init_registry_key: transaction_cancel failed\n");
238 /***********************************************************************
239 Open the registry data in the tdb
240 ***********************************************************************/
242 WERROR
init_registry_data(void)
245 TALLOC_CTX
*frame
= talloc_stackframe();
246 struct regval_ctr
*values
;
251 * First, check for the existence of the needed keys and values.
252 * If all do already exist, we can save the writes.
254 for (i
=0; builtin_registry_paths
[i
] != NULL
; i
++) {
255 if (!regdb_key_exists(regdb
, builtin_registry_paths
[i
])) {
260 for (i
=0; builtin_registry_values
[i
].path
!= NULL
; i
++) {
261 values
= TALLOC_ZERO_P(frame
, struct regval_ctr
);
262 if (values
== NULL
) {
267 regdb_fetch_values(builtin_registry_values
[i
].path
, values
);
268 if (!regval_ctr_key_exists(values
,
269 builtin_registry_values
[i
].valuename
))
284 * There are potentially quite a few store operations which are all
285 * indiviually wrapped in tdb transactions. Wrapping them in a single
286 * transaction gives just a single transaction_commit() to actually do
287 * its fsync()s. See tdb/common/transaction.c for info about nested
288 * transaction behaviour.
291 if (regdb
->transaction_start(regdb
) != 0) {
292 DEBUG(0, ("init_registry_data: tdb_transaction_start "
294 werr
= WERR_REG_IO_FAILURE
;
298 /* loop over all of the predefined paths and add each component */
300 for (i
=0; builtin_registry_paths
[i
] != NULL
; i
++) {
301 if (regdb_key_exists(regdb
, builtin_registry_paths
[i
])) {
304 werr
= init_registry_key_internal(builtin_registry_paths
[i
]);
305 if (!W_ERROR_IS_OK(werr
)) {
310 /* loop over all of the predefined values and add each component */
312 for (i
=0; builtin_registry_values
[i
].path
!= NULL
; i
++) {
314 values
= TALLOC_ZERO_P(frame
, struct regval_ctr
);
315 if (values
== NULL
) {
320 regdb_fetch_values(builtin_registry_values
[i
].path
, values
);
322 /* preserve existing values across restarts. Only add new ones */
324 if (!regval_ctr_key_exists(values
,
325 builtin_registry_values
[i
].valuename
))
327 switch(builtin_registry_values
[i
].type
) {
329 regval_ctr_addvalue(values
,
330 builtin_registry_values
[i
].valuename
,
332 (char*)&builtin_registry_values
[i
].data
.dw_value
,
338 builtin_registry_values
[i
].data
.string
,
340 regval_ctr_addvalue(values
,
341 builtin_registry_values
[i
].valuename
,
344 data
.uni_str_len
*sizeof(uint16
));
348 DEBUG(0, ("init_registry_data: invalid value "
349 "type in builtin_registry_values "
351 builtin_registry_values
[i
].type
));
353 regdb_store_values(builtin_registry_values
[i
].path
,
359 if (regdb
->transaction_commit(regdb
) != 0) {
360 DEBUG(0, ("init_registry_data: Could not commit "
362 werr
= WERR_REG_IO_FAILURE
;
370 if (regdb
->transaction_cancel(regdb
) != 0) {
371 smb_panic("init_registry_data: tdb_transaction_cancel "
380 /***********************************************************************
381 Open the registry database
382 ***********************************************************************/
384 WERROR
regdb_init(void)
386 const char *vstring
= "INFO/version";
391 DEBUG(10, ("regdb_init: incrementing refcount (%d)\n",
397 regdb
= db_open(NULL
, state_path("registry.tdb"), 0,
398 REG_TDB_FLAGS
, O_RDWR
, 0600);
400 regdb
= db_open(NULL
, state_path("registry.tdb"), 0,
401 REG_TDB_FLAGS
, O_RDWR
|O_CREAT
, 0600);
403 werr
= ntstatus_to_werror(map_nt_error_from_unix(errno
));
404 DEBUG(1,("regdb_init: Failed to open registry %s (%s)\n",
405 state_path("registry.tdb"), strerror(errno
) ));
409 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
414 vers_id
= dbwrap_fetch_int32(regdb
, vstring
);
416 if ( vers_id
!= REGVER_V1
) {
418 /* any upgrade code here if needed */
419 DEBUG(10, ("regdb_init: got %s = %d != %d\n", vstring
,
420 vers_id
, REGVER_V1
));
421 status
= dbwrap_trans_store_int32(regdb
, vstring
, REGVER_V1
);
422 if (!NT_STATUS_IS_OK(status
)) {
423 DEBUG(1, ("regdb_init: error storing %s = %d: %s\n",
424 vstring
, REGVER_V1
, nt_errstr(status
)));
425 return ntstatus_to_werror(status
);
427 DEBUG(10, ("regdb_init: stored %s = %d\n",
428 vstring
, REGVER_V1
));
435 /***********************************************************************
436 Open the registry. Must already have been initialized by regdb_init()
437 ***********************************************************************/
439 WERROR
regdb_open( void )
441 WERROR result
= WERR_OK
;
444 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount
));
451 regdb
= db_open(NULL
, state_path("registry.tdb"), 0,
452 REG_TDB_FLAGS
, O_RDWR
, 0600);
454 result
= ntstatus_to_werror( map_nt_error_from_unix( errno
) );
455 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
456 state_path("registry.tdb"), strerror(errno
) ));
462 DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount
));
467 /***********************************************************************
468 ***********************************************************************/
470 int regdb_close( void )
472 if (regdb_refcount
== 0) {
478 DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount
));
480 if ( regdb_refcount
> 0 )
483 SMB_ASSERT( regdb_refcount
>= 0 );
489 WERROR
regdb_transaction_start(void)
491 return (regdb
->transaction_start(regdb
) == 0) ?
492 WERR_OK
: WERR_REG_IO_FAILURE
;
495 WERROR
regdb_transaction_commit(void)
497 return (regdb
->transaction_commit(regdb
) == 0) ?
498 WERR_OK
: WERR_REG_IO_FAILURE
;
501 WERROR
regdb_transaction_cancel(void)
503 return (regdb
->transaction_cancel(regdb
) == 0) ?
504 WERR_OK
: WERR_REG_IO_FAILURE
;
507 /***********************************************************************
508 return the tdb sequence number of the registry tdb.
509 this is an indicator for the content of the registry
510 having changed. it will change upon regdb_init, too, though.
511 ***********************************************************************/
512 int regdb_get_seqnum(void)
514 return regdb
->get_seqnum(regdb
);
518 static WERROR
regdb_delete_key_with_prefix(struct db_context
*db
,
523 WERROR werr
= WERR_NOMEM
;
524 TALLOC_CTX
*mem_ctx
= talloc_stackframe();
526 if (keyname
== NULL
) {
527 werr
= WERR_INVALID_PARAM
;
531 if (prefix
== NULL
) {
532 path
= discard_const_p(char, keyname
);
534 path
= talloc_asprintf(mem_ctx
, "%s/%s", prefix
, keyname
);
540 path
= normalize_reg_path(mem_ctx
, path
);
545 werr
= ntstatus_to_werror(dbwrap_delete_bystring(db
, path
));
547 /* treat "not" found" as ok */
548 if (W_ERROR_EQUAL(werr
, WERR_NOT_FOUND
)) {
553 talloc_free(mem_ctx
);
558 static WERROR
regdb_delete_values(struct db_context
*db
, const char *keyname
)
560 return regdb_delete_key_with_prefix(db
, keyname
, REG_VALUE_PREFIX
);
563 static WERROR
regdb_delete_secdesc(struct db_context
*db
, const char *keyname
)
565 return regdb_delete_key_with_prefix(db
, keyname
, REG_SECDESC_PREFIX
);
568 static WERROR
regdb_delete_subkeylist(struct db_context
*db
, const char *keyname
)
570 return regdb_delete_key_with_prefix(db
, keyname
, NULL
);
573 static WERROR
regdb_delete_key_lists(struct db_context
*db
, const char *keyname
)
577 werr
= regdb_delete_values(db
, keyname
);
578 if (!W_ERROR_IS_OK(werr
)) {
579 DEBUG(1, (__location__
" Deleting %s/%s failed: %s\n",
580 REG_VALUE_PREFIX
, keyname
, win_errstr(werr
)));
584 werr
= regdb_delete_secdesc(db
, keyname
);
585 if (!W_ERROR_IS_OK(werr
)) {
586 DEBUG(1, (__location__
" Deleting %s/%s failed: %s\n",
587 REG_SECDESC_PREFIX
, keyname
, win_errstr(werr
)));
591 werr
= regdb_delete_subkeylist(db
, keyname
);
592 if (!W_ERROR_IS_OK(werr
)) {
593 DEBUG(1, (__location__
" Deleting %s failed: %s\n",
594 keyname
, win_errstr(werr
)));
602 /***********************************************************************
603 Add subkey strings to the registry tdb under a defined key
604 fmt is the same format as tdb_pack except this function only supports
606 ***********************************************************************/
608 static bool regdb_store_keys_internal2(struct db_context
*db
,
610 struct regsubkey_ctr
*ctr
)
613 uint8
*buffer
= NULL
;
617 uint32 num_subkeys
= regsubkey_ctr_numkeys(ctr
);
618 char *keyname
= NULL
;
619 TALLOC_CTX
*ctx
= talloc_stackframe();
626 keyname
= talloc_strdup(ctx
, key
);
630 keyname
= normalize_reg_path(ctx
, keyname
);
632 /* allocate some initial memory */
634 buffer
= (uint8
*)SMB_MALLOC(1024);
635 if (buffer
== NULL
) {
641 /* store the number of subkeys */
643 len
+= tdb_pack(buffer
+len
, buflen
-len
, "d", num_subkeys
);
645 /* pack all the strings */
647 for (i
=0; i
<num_subkeys
; i
++) {
650 thistime
= tdb_pack(buffer
+len
, buflen
-len
, "f",
651 regsubkey_ctr_specific_key(ctr
, i
));
652 if (len
+thistime
> buflen
) {
655 * tdb_pack hasn't done anything because of the short
656 * buffer, allocate extra space.
658 buffer
= SMB_REALLOC_ARRAY(buffer
, uint8_t,
661 DEBUG(0, ("regdb_store_keys: Failed to realloc "
662 "memory of size [%u]\n",
663 (unsigned int)(len
+thistime
)*2));
667 buflen
= (len
+thistime
)*2;
668 thistime2
= tdb_pack(
669 buffer
+len
, buflen
-len
, "f",
670 regsubkey_ctr_specific_key(ctr
, i
));
671 if (thistime2
!= thistime
) {
672 DEBUG(0, ("tdb_pack failed\n"));
680 /* finally write out the data */
684 status
= dbwrap_store_bystring(db
, keyname
, dbuf
, TDB_REPLACE
);
685 if (!NT_STATUS_IS_OK(status
)) {
691 * Delete a sorted subkey cache for regdb_key_exists, will be
692 * recreated automatically
694 keyname
= talloc_asprintf(ctx
, "%s/%s", REG_SORTED_SUBKEYS_PREFIX
,
696 if (keyname
!= NULL
) {
697 dbwrap_delete_bystring(db
, keyname
);
706 /***********************************************************************
707 Store the new subkey record and create any child key records that
708 do not currently exist
709 ***********************************************************************/
711 static bool regdb_store_keys_internal(struct db_context
*db
, const char *key
,
712 struct regsubkey_ctr
*ctr
)
714 int num_subkeys
, old_num_subkeys
, i
;
716 struct regsubkey_ctr
*subkeys
= NULL
, *old_subkeys
= NULL
;
717 char *oldkeyname
= NULL
;
718 TALLOC_CTX
*ctx
= talloc_stackframe();
721 if (!regdb_key_is_base_key(key
) && !regdb_key_exists(db
, key
)) {
726 * fetch a list of the old subkeys so we can determine if anything has
730 werr
= regsubkey_ctr_init(ctx
, &old_subkeys
);
731 if (!W_ERROR_IS_OK(werr
)) {
732 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
736 regdb_fetch_keys_internal(db
, key
, old_subkeys
);
738 num_subkeys
= regsubkey_ctr_numkeys(ctr
);
739 old_num_subkeys
= regsubkey_ctr_numkeys(old_subkeys
);
740 if ((num_subkeys
&& old_num_subkeys
) &&
741 (num_subkeys
== old_num_subkeys
)) {
743 for (i
= 0; i
< num_subkeys
; i
++) {
744 if (strcmp(regsubkey_ctr_specific_key(ctr
, i
),
745 regsubkey_ctr_specific_key(old_subkeys
, i
))
751 if (i
== num_subkeys
) {
753 * Nothing changed, no point to even start a tdb
756 TALLOC_FREE(old_subkeys
);
761 TALLOC_FREE(old_subkeys
);
763 if (db
->transaction_start(db
) != 0) {
764 DEBUG(0, ("regdb_store_keys: transaction_start failed\n"));
769 * Re-fetch the old keys inside the transaction
772 werr
= regsubkey_ctr_init(ctx
, &old_subkeys
);
773 if (!W_ERROR_IS_OK(werr
)) {
774 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
778 regdb_fetch_keys_internal(db
, key
, old_subkeys
);
781 * Make the store operation as safe as possible without transactions:
783 * (1) For each subkey removed from ctr compared with old_subkeys:
785 * (a) First delete the value db entry.
787 * (b) Next delete the secdesc db record.
789 * (c) Then delete the subkey list entry.
791 * (2) Now write the list of subkeys of the parent key,
792 * deleting removed entries and adding new ones.
794 * (3) Finally create the subkey list entries for the added keys.
796 * This way if we crash half-way in between deleting the subkeys
797 * and storing the parent's list of subkeys, no old data can pop up
798 * out of the blue when re-adding keys later on.
801 /* (1) delete removed keys' lists (values/secdesc/subkeys) */
803 num_subkeys
= regsubkey_ctr_numkeys(old_subkeys
);
804 for (i
=0; i
<num_subkeys
; i
++) {
805 oldkeyname
= regsubkey_ctr_specific_key(old_subkeys
, i
);
807 if (regsubkey_ctr_key_exists(ctr
, oldkeyname
)) {
809 * It's still around, don't delete
815 path
= talloc_asprintf(ctx
, "%s/%s", key
, oldkeyname
);
820 werr
= regdb_delete_key_lists(db
, path
);
821 W_ERROR_NOT_OK_GOTO(werr
, cancel
);
826 TALLOC_FREE(old_subkeys
);
828 /* (2) store the subkey list for the parent */
830 if (!regdb_store_keys_internal2(db
, key
, ctr
)) {
831 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
832 "for parent [%s]\n", key
));
836 /* (3) now create records for any subkeys that don't already exist */
838 num_subkeys
= regsubkey_ctr_numkeys(ctr
);
840 if (num_subkeys
== 0) {
841 werr
= regsubkey_ctr_init(ctx
, &subkeys
);
842 if (!W_ERROR_IS_OK(werr
)) {
843 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
847 if (!regdb_store_keys_internal2(db
, key
, subkeys
)) {
848 DEBUG(0,("regdb_store_keys: Failed to store "
849 "new record for key [%s]\n", key
));
852 TALLOC_FREE(subkeys
);
856 for (i
=0; i
<num_subkeys
; i
++) {
857 path
= talloc_asprintf(ctx
, "%s/%s",
859 regsubkey_ctr_specific_key(ctr
, i
));
863 werr
= regsubkey_ctr_init(ctx
, &subkeys
);
864 if (!W_ERROR_IS_OK(werr
)) {
865 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
869 if (regdb_fetch_keys_internal(db
, path
, subkeys
) == -1) {
870 /* create a record with 0 subkeys */
871 if (!regdb_store_keys_internal2(db
, path
, subkeys
)) {
872 DEBUG(0,("regdb_store_keys: Failed to store "
873 "new record for key [%s]\n", path
));
878 TALLOC_FREE(subkeys
);
882 if (db
->transaction_commit(db
) != 0) {
883 DEBUG(0, ("regdb_store_keys: Could not commit transaction\n"));
891 if (db
->transaction_cancel(db
) != 0) {
892 smb_panic("regdb_store_keys: transaction_cancel failed\n");
901 bool regdb_store_keys(const char *key
, struct regsubkey_ctr
*ctr
)
903 return regdb_store_keys_internal(regdb
, key
, ctr
);
906 static WERROR
regdb_create_subkey(const char *key
, const char *subkey
)
909 struct regsubkey_ctr
*subkeys
;
910 TALLOC_CTX
*mem_ctx
= talloc_stackframe();
912 if (!regdb_key_is_base_key(key
) && !regdb_key_exists(regdb
, key
)) {
913 werr
= WERR_NOT_FOUND
;
917 werr
= regsubkey_ctr_init(mem_ctx
, &subkeys
);
918 W_ERROR_NOT_OK_GOTO_DONE(werr
);
920 if (regdb_fetch_keys_internal(regdb
, key
, subkeys
) < 0) {
921 werr
= WERR_REG_IO_FAILURE
;
925 if (regsubkey_ctr_key_exists(subkeys
, subkey
)) {
930 talloc_free(subkeys
);
932 werr
= regdb_transaction_start();
933 W_ERROR_NOT_OK_GOTO_DONE(werr
);
935 werr
= regsubkey_ctr_init(mem_ctx
, &subkeys
);
936 W_ERROR_NOT_OK_GOTO(werr
, cancel
);
938 if (regdb_fetch_keys_internal(regdb
, key
, subkeys
) < 0) {
939 werr
= WERR_REG_IO_FAILURE
;
943 werr
= regsubkey_ctr_addkey(subkeys
, subkey
);
944 W_ERROR_NOT_OK_GOTO(werr
, cancel
);
946 if (!regdb_store_keys_internal2(regdb
, key
, subkeys
)) {
947 DEBUG(0, (__location__
" failed to store new subkey list for "
948 "parent key %s\n", key
));
949 werr
= WERR_REG_IO_FAILURE
;
953 werr
= regdb_transaction_commit();
954 if (!W_ERROR_IS_OK(werr
)) {
955 DEBUG(0, (__location__
" failed to commit transaction: %s\n",
962 werr
= regdb_transaction_cancel();
963 if (!W_ERROR_IS_OK(werr
)) {
964 DEBUG(0, (__location__
" failed to cancel transaction: %s\n",
969 talloc_free(mem_ctx
);
973 static WERROR
regdb_delete_subkey(const char *key
, const char *subkey
)
976 struct regsubkey_ctr
*subkeys
;
978 TALLOC_CTX
*mem_ctx
= talloc_stackframe();
980 if (!regdb_key_is_base_key(key
) && !regdb_key_exists(regdb
, key
)) {
981 werr
= WERR_NOT_FOUND
;
985 path
= talloc_asprintf(mem_ctx
, "%s/%s", key
, subkey
);
991 if (!regdb_key_exists(regdb
, path
)) {
996 werr
= regdb_transaction_start();
997 W_ERROR_NOT_OK_GOTO_DONE(werr
);
999 werr
= regdb_delete_key_lists(regdb
, path
);
1000 W_ERROR_NOT_OK_GOTO(werr
, cancel
);
1002 werr
= regsubkey_ctr_init(mem_ctx
, &subkeys
);
1003 W_ERROR_NOT_OK_GOTO(werr
, cancel
);
1005 if (regdb_fetch_keys_internal(regdb
, key
, subkeys
) < 0) {
1006 werr
= WERR_REG_IO_FAILURE
;
1010 werr
= regsubkey_ctr_delkey(subkeys
, subkey
);
1011 W_ERROR_NOT_OK_GOTO(werr
, cancel
);
1013 if (!regdb_store_keys_internal2(regdb
, key
, subkeys
)) {
1014 DEBUG(0, (__location__
" failed to store new subkey_list for "
1015 "parent key %s\n", key
));
1016 werr
= WERR_REG_IO_FAILURE
;
1020 werr
= regdb_transaction_commit();
1021 if (!W_ERROR_IS_OK(werr
)) {
1022 DEBUG(0, (__location__
" failed to commit transaction: %s\n",
1029 werr2
= regdb_transaction_cancel();
1030 if (!W_ERROR_IS_OK(werr2
)) {
1031 DEBUG(0, (__location__
" failed to cancel transaction: %s\n",
1032 win_errstr(werr2
)));
1036 talloc_free(mem_ctx
);
1040 static TDB_DATA
regdb_fetch_key_internal(struct db_context
*db
,
1041 TALLOC_CTX
*mem_ctx
, const char *key
)
1046 path
= normalize_reg_path(mem_ctx
, key
);
1048 return make_tdb_data(NULL
, 0);
1051 data
= dbwrap_fetch_bystring(db
, mem_ctx
, path
);
1059 * check whether a given key name represents a base key,
1060 * i.e one without a subkey separator ('/' or '\').
1062 static bool regdb_key_is_base_key(const char *key
)
1064 TALLOC_CTX
*mem_ctx
= talloc_stackframe();
1072 path
= normalize_reg_path(mem_ctx
, key
);
1074 DEBUG(0, ("out of memory! (talloc failed)\n"));
1078 if (*path
== '\0') {
1082 ret
= (strrchr(path
, '/') == NULL
);
1085 TALLOC_FREE(mem_ctx
);
1090 * regdb_key_exists() is a very frequent operation. It can be quite
1091 * time-consuming to fully fetch the parent's subkey list, talloc_strdup all
1092 * subkeys and then compare the keyname linearly to all the parent's subkeys.
1094 * The following code tries to make this operation as efficient as possible:
1095 * Per registry key we create a list of subkeys that is very efficient to
1096 * search for existence of a subkey. Its format is:
1098 * 4 bytes num_subkeys
1099 * 4*num_subkey bytes offset into the string array
1100 * then follows a sorted list of subkeys in uppercase
1102 * This record is created by create_sorted_subkeys() on demand if it does not
1103 * exist. scan_parent_subkeys() uses regdb->parse_record to search the sorted
1104 * list, the parsing code and the binary search can be found in
1105 * parent_subkey_scanner. The code uses parse_record() to avoid a memcpy of
1106 * the potentially large subkey record.
1108 * The sorted subkey record is deleted in regdb_store_keys_internal2 and
1109 * recreated on demand.
1112 static int cmp_keynames(const void *p1
, const void *p2
)
1114 return StrCaseCmp(*((char **)p1
), *((char **)p2
));
1117 static bool create_sorted_subkeys(const char *key
, const char *sorted_keyname
)
1119 char **sorted_subkeys
;
1120 struct regsubkey_ctr
*ctr
;
1121 bool result
= false;
1130 if (regdb
->transaction_start(regdb
) != 0) {
1131 DEBUG(0, ("create_sorted_subkeys: transaction_start "
1136 werr
= regsubkey_ctr_init(talloc_tos(), &ctr
);
1137 if (!W_ERROR_IS_OK(werr
)) {
1141 res
= regdb_fetch_keys_internal(regdb
, key
, ctr
);
1146 num_subkeys
= regsubkey_ctr_numkeys(ctr
);
1147 sorted_subkeys
= talloc_array(ctr
, char *, num_subkeys
);
1148 if (sorted_subkeys
== NULL
) {
1152 len
= 4 + 4*num_subkeys
;
1154 for (i
= 0; i
< num_subkeys
; i
++) {
1155 sorted_subkeys
[i
] = talloc_strdup_upper(sorted_subkeys
,
1156 regsubkey_ctr_specific_key(ctr
, i
));
1157 if (sorted_subkeys
[i
] == NULL
) {
1160 len
+= strlen(sorted_subkeys
[i
])+1;
1163 qsort(sorted_subkeys
, num_subkeys
, sizeof(char *), cmp_keynames
);
1165 buf
= talloc_array(ctr
, char, len
);
1169 p
= buf
+ 4 + 4*num_subkeys
;
1171 SIVAL(buf
, 0, num_subkeys
);
1173 for (i
=0; i
< num_subkeys
; i
++) {
1174 ptrdiff_t offset
= p
- buf
;
1175 SIVAL(buf
, 4 + 4*i
, offset
);
1176 strlcpy(p
, sorted_subkeys
[i
], len
-offset
);
1177 p
+= strlen(sorted_subkeys
[i
]) + 1;
1180 status
= dbwrap_store_bystring(
1181 regdb
, sorted_keyname
, make_tdb_data((uint8_t *)buf
, len
),
1183 if (!NT_STATUS_IS_OK(status
)) {
1185 * Don't use a "goto fail;" here, this would commit the broken
1186 * transaction. See below for an explanation.
1188 if (regdb
->transaction_cancel(regdb
) == -1) {
1189 DEBUG(0, ("create_sorted_subkeys: transaction_cancel "
1199 * We only get here via the "goto fail" when we did not write anything
1200 * yet. Using transaction_commit even in a failure case is necessary
1201 * because this (disposable) call might be nested in other
1202 * transactions. Doing a cancel here would destroy the possibility of
1203 * a transaction_commit for transactions that we might be wrapped in.
1205 if (regdb
->transaction_commit(regdb
) == -1) {
1206 DEBUG(0, ("create_sorted_subkeys: transaction_start "
1215 struct scan_subkey_state
{
1221 static int parent_subkey_scanner(TDB_DATA key
, TDB_DATA data
,
1224 struct scan_subkey_state
*state
=
1225 (struct scan_subkey_state
*)private_data
;
1226 uint32_t num_subkeys
;
1229 if (data
.dsize
< sizeof(uint32_t)) {
1233 state
->scanned
= true;
1234 state
->found
= false;
1236 tdb_unpack(data
.dptr
, data
.dsize
, "d", &num_subkeys
);
1242 uint32_t idx
= (l
+u
)/2;
1243 char *s
= (char *)data
.dptr
+ IVAL(data
.dptr
, 4 + 4*idx
);
1244 int comparison
= strcmp(state
->name
, s
);
1246 if (comparison
< 0) {
1248 } else if (comparison
> 0) {
1251 state
->found
= true;
1258 static bool scan_parent_subkeys(struct db_context
*db
, const char *parent
,
1263 struct scan_subkey_state state
= { 0, };
1264 bool result
= false;
1269 path
= normalize_reg_path(talloc_tos(), parent
);
1274 key
= talloc_asprintf(talloc_tos(), "%s/%s",
1275 REG_SORTED_SUBKEYS_PREFIX
, path
);
1280 state
.name
= talloc_strdup_upper(talloc_tos(), name
);
1281 if (state
.name
== NULL
) {
1284 state
.scanned
= false;
1286 res
= db
->parse_record(db
, string_term_tdb_data(key
),
1287 parent_subkey_scanner
, &state
);
1289 if (state
.scanned
) {
1290 result
= state
.found
;
1292 if (!create_sorted_subkeys(path
, key
)) {
1295 res
= db
->parse_record(db
, string_term_tdb_data(key
),
1296 parent_subkey_scanner
, &state
);
1297 if ((res
== 0) && (state
.scanned
)) {
1298 result
= state
.found
;
1304 TALLOC_FREE(state
.name
);
1309 * Check for the existence of a key.
1311 * Existence of a key is authoritatively defined by its
1312 * existence in the list of subkeys of its parent key.
1313 * The exeption of this are keys without a parent key,
1314 * i.e. the "base" keys (HKLM, HKCU, ...).
1316 static bool regdb_key_exists(struct db_context
*db
, const char *key
)
1318 TALLOC_CTX
*mem_ctx
= talloc_stackframe();
1327 path
= normalize_reg_path(mem_ctx
, key
);
1329 DEBUG(0, ("out of memory! (talloc failed)\n"));
1333 if (*path
== '\0') {
1337 p
= strrchr(path
, '/');
1339 /* this is a base key */
1340 value
= regdb_fetch_key_internal(db
, mem_ctx
, path
);
1341 ret
= (value
.dptr
!= NULL
);
1344 ret
= scan_parent_subkeys(db
, path
, p
+1);
1348 TALLOC_FREE(mem_ctx
);
1353 /***********************************************************************
1354 Retrieve an array of strings containing subkeys. Memory should be
1355 released by the caller.
1356 ***********************************************************************/
1358 static int regdb_fetch_keys_internal(struct db_context
*db
, const char *key
,
1359 struct regsubkey_ctr
*ctr
)
1368 TALLOC_CTX
*frame
= talloc_stackframe();
1371 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key
? key
: "NULL"));
1373 if (!regdb_key_exists(db
, key
)) {
1377 werr
= regsubkey_ctr_set_seqnum(ctr
, db
->get_seqnum(db
));
1378 if (!W_ERROR_IS_OK(werr
)) {
1382 value
= regdb_fetch_key_internal(db
, frame
, key
);
1384 if (value
.dptr
== NULL
) {
1385 DEBUG(10, ("regdb_fetch_keys: no subkeys found for key [%s]\n",
1392 buflen
= value
.dsize
;
1393 len
= tdb_unpack( buf
, buflen
, "d", &num_items
);
1395 for (i
=0; i
<num_items
; i
++) {
1396 len
+= tdb_unpack(buf
+len
, buflen
-len
, "f", subkeyname
);
1397 werr
= regsubkey_ctr_addkey(ctr
, subkeyname
);
1398 if (!W_ERROR_IS_OK(werr
)) {
1399 DEBUG(5, ("regdb_fetch_keys: regsubkey_ctr_addkey "
1400 "failed: %s\n", win_errstr(werr
)));
1405 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items
));
1413 int regdb_fetch_keys(const char *key
, struct regsubkey_ctr
*ctr
)
1415 return regdb_fetch_keys_internal(regdb
, key
, ctr
);
1418 /****************************************************************************
1419 Unpack a list of registry values frem the TDB
1420 ***************************************************************************/
1422 static int regdb_unpack_values(struct regval_ctr
*values
, uint8
*buf
, int buflen
)
1429 uint32 num_values
= 0;
1432 /* loop and unpack the rest of the registry values */
1434 len
+= tdb_unpack(buf
+len
, buflen
-len
, "d", &num_values
);
1436 for ( i
=0; i
<num_values
; i
++ ) {
1437 /* unpack the next regval */
1442 valuename
[0] = '\0';
1443 len
+= tdb_unpack(buf
+len
, buflen
-len
, "fdB",
1449 /* add the new value. Paranoid protective code -- make sure data_p is valid */
1451 if (*valuename
&& size
&& data_p
) {
1452 regval_ctr_addvalue(values
, valuename
, type
,
1453 (const char *)data_p
, size
);
1455 SAFE_FREE(data_p
); /* 'B' option to tdb_unpack does a malloc() */
1457 DEBUG(8,("specific: [%s], len: %d\n", valuename
, size
));
1463 /****************************************************************************
1464 Pack all values in all printer keys
1465 ***************************************************************************/
1467 static int regdb_pack_values(struct regval_ctr
*values
, uint8
*buf
, int buflen
)
1471 struct regval_blob
*val
;
1477 num_values
= regval_ctr_numvals( values
);
1479 /* pack the number of values first */
1481 len
+= tdb_pack( buf
+len
, buflen
-len
, "d", num_values
);
1483 /* loop over all values */
1485 for ( i
=0; i
<num_values
; i
++ ) {
1486 val
= regval_ctr_specific_value( values
, i
);
1487 len
+= tdb_pack(buf
+len
, buflen
-len
, "fdB",
1491 regval_data_p(val
) );
1497 /***********************************************************************
1498 Retrieve an array of strings containing subkeys. Memory should be
1499 released by the caller.
1500 ***********************************************************************/
1502 int regdb_fetch_values(const char* key
, struct regval_ctr
*values
)
1504 char *keystr
= NULL
;
1505 TALLOC_CTX
*ctx
= talloc_stackframe();
1509 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key
));
1511 if (!regdb_key_exists(regdb
, key
)) {
1515 keystr
= talloc_asprintf(ctx
, "%s/%s", REG_VALUE_PREFIX
, key
);
1520 values
->seqnum
= regdb_get_seqnum();
1522 value
= regdb_fetch_key_internal(regdb
, ctx
, keystr
);
1525 /* all keys have zero values by default */
1529 regdb_unpack_values(values
, value
.dptr
, value
.dsize
);
1530 ret
= regval_ctr_numvals(values
);
1537 bool regdb_store_values(const char *key
, struct regval_ctr
*values
)
1539 TDB_DATA old_data
, data
;
1540 char *keystr
= NULL
;
1541 TALLOC_CTX
*ctx
= talloc_stackframe();
1544 bool result
= false;
1546 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key
));
1548 if (!regdb_key_exists(regdb
, key
)) {
1554 len
= regdb_pack_values(values
, data
.dptr
, data
.dsize
);
1556 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
1560 data
.dptr
= TALLOC_ARRAY(ctx
, uint8
, len
);
1563 len
= regdb_pack_values(values
, data
.dptr
, data
.dsize
);
1565 SMB_ASSERT( len
== data
.dsize
);
1567 keystr
= talloc_asprintf(ctx
, "%s/%s", REG_VALUE_PREFIX
, key
);
1571 keystr
= normalize_reg_path(ctx
, keystr
);
1576 old_data
= dbwrap_fetch_bystring(regdb
, ctx
, keystr
);
1578 if ((old_data
.dptr
!= NULL
)
1579 && (old_data
.dsize
== data
.dsize
)
1580 && (memcmp(old_data
.dptr
, data
.dptr
, data
.dsize
) == 0))
1586 status
= dbwrap_trans_store_bystring(regdb
, keystr
, data
, TDB_REPLACE
);
1588 result
= NT_STATUS_IS_OK(status
);
1595 static WERROR
regdb_get_secdesc(TALLOC_CTX
*mem_ctx
, const char *key
,
1596 struct security_descriptor
**psecdesc
)
1601 TALLOC_CTX
*tmp_ctx
= talloc_stackframe();
1602 WERROR err
= WERR_OK
;
1604 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key
));
1606 if (!regdb_key_exists(regdb
, key
)) {
1611 tdbkey
= talloc_asprintf(tmp_ctx
, "%s/%s", REG_SECDESC_PREFIX
, key
);
1612 if (tdbkey
== NULL
) {
1616 normalize_dbkey(tdbkey
);
1618 data
= dbwrap_fetch_bystring(regdb
, tmp_ctx
, tdbkey
);
1619 if (data
.dptr
== NULL
) {
1624 status
= unmarshall_sec_desc(mem_ctx
, (uint8
*)data
.dptr
, data
.dsize
,
1627 if (NT_STATUS_EQUAL(status
, NT_STATUS_NO_MEMORY
)) {
1629 } else if (!NT_STATUS_IS_OK(status
)) {
1630 err
= WERR_REG_CORRUPT
;
1634 TALLOC_FREE(tmp_ctx
);
1638 static WERROR
regdb_set_secdesc(const char *key
,
1639 struct security_descriptor
*secdesc
)
1641 TALLOC_CTX
*mem_ctx
= talloc_stackframe();
1643 WERROR err
= WERR_NOMEM
;
1646 if (!regdb_key_exists(regdb
, key
)) {
1651 tdbkey
= talloc_asprintf(mem_ctx
, "%s/%s", REG_SECDESC_PREFIX
, key
);
1652 if (tdbkey
== NULL
) {
1655 normalize_dbkey(tdbkey
);
1657 if (secdesc
== NULL
) {
1658 /* assuming a delete */
1659 err
= ntstatus_to_werror(dbwrap_trans_delete_bystring(regdb
,
1664 err
= ntstatus_to_werror(marshall_sec_desc(mem_ctx
, secdesc
,
1667 W_ERROR_NOT_OK_GOTO_DONE(err
);
1669 err
= ntstatus_to_werror(dbwrap_trans_store_bystring(regdb
, tdbkey
,
1673 TALLOC_FREE(mem_ctx
);
1677 bool regdb_subkeys_need_update(struct regsubkey_ctr
*subkeys
)
1679 return (regdb_get_seqnum() != regsubkey_ctr_get_seqnum(subkeys
));
1682 bool regdb_values_need_update(struct regval_ctr
*values
)
1684 return (regdb_get_seqnum() != values
->seqnum
);
1688 * Table of function pointers for default access
1691 struct registry_ops regdb_ops
= {
1692 .fetch_subkeys
= regdb_fetch_keys
,
1693 .fetch_values
= regdb_fetch_values
,
1694 .store_subkeys
= regdb_store_keys
,
1695 .store_values
= regdb_store_values
,
1696 .create_subkey
= regdb_create_subkey
,
1697 .delete_subkey
= regdb_delete_subkey
,
1698 .get_secdesc
= regdb_get_secdesc
,
1699 .set_secdesc
= regdb_set_secdesc
,
1700 .subkeys_need_update
= regdb_subkeys_need_update
,
1701 .values_need_update
= regdb_values_need_update