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 /* List the deepest path into the registry. All part components will be created.*/
32 /* If you want to have a part of the path controlled by the tdb and part by
33 a virtual registry db (e.g. printing), then you have to list the deepest path.
34 For example,"HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion/Print"
35 allows the reg_db backend to handle everything up to
36 "HKLM/SOFTWARE/Microsoft/Windows NT/CurrentVersion" and then we'll hook
37 the reg_printing backend onto the last component of the path (see
38 KEY_PRINTING_2K in include/rpc_reg.h) --jerry */
40 static const char *builtin_registry_paths[] = {
49 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
51 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
60 struct builtin_regkey_value {
62 const char *valuename;
70 static struct builtin_regkey_value builtin_registry_values[] = {
72 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
74 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
76 "DisplayName", REG_SZ, { "Event Log" } },
78 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
79 { NULL, NULL, 0, { NULL } }
82 /***********************************************************************
83 Open the registry data in the tdb
84 ***********************************************************************/
86 static bool init_registry_data(void)
90 char *remaining = NULL;
91 TALLOC_CTX *frame = NULL;
94 REGSUBKEY_CTR *subkeys;
101 * There are potentially quite a few store operations which are all
102 * indiviually wrapped in tdb transactions. Wrapping them in a single
103 * transaction gives just a single transaction_commit() to actually do
104 * its fsync()s. See tdb/common/transaction.c for info about nested
105 * transaction behaviour.
108 if (regdb->transaction_start(regdb) == -1) {
109 DEBUG(0, ("init_registry_data: tdb_transaction_start "
114 /* loop over all of the predefined paths and add each component */
116 for (i=0; builtin_registry_paths[i] != NULL; i++) {
118 frame = talloc_stackframe();
120 DEBUG(6, ("init_registry_data: Adding [%s]\n",
121 builtin_registry_paths[i]));
123 path = talloc_strdup(frame, builtin_registry_paths[i]);
124 base = talloc_strdup(frame, "");
125 if (!path || !base) {
130 while (next_token_talloc(frame, &p, &keyname, "\\")) {
132 /* build up the registry path from the components */
135 base = talloc_asprintf(frame, "%s\\", base);
140 base = talloc_asprintf_append(base, "%s", keyname);
145 /* get the immediate subkeyname (if we have one ) */
147 subkeyname = talloc_strdup(frame, "");
152 remaining = talloc_strdup(frame, p);
158 if (!next_token_talloc(frame, &p2,
161 subkeyname = talloc_strdup(frame,p2);
168 DEBUG(10,("init_registry_data: Storing key [%s] with "
169 "subkey [%s]\n", base,
170 *subkeyname ? subkeyname : "NULL"));
172 /* we don't really care if the lookup succeeds or not
173 * since we are about to update the record.
174 * We just want any subkeys already present */
176 if (!(subkeys = TALLOC_ZERO_P(frame, REGSUBKEY_CTR))) {
177 DEBUG(0,("talloc() failure!\n"));
181 regdb_fetch_keys(base, subkeys);
183 regsubkey_ctr_addkey( subkeys, subkeyname);
185 if (!regdb_store_keys( base, subkeys)) {
193 /* loop over all of the predefined values and add each component */
195 frame = talloc_stackframe();
197 for (i=0; builtin_registry_values[i].path != NULL; i++) {
199 values = TALLOC_ZERO_P(frame, REGVAL_CTR);
200 if (values == NULL) {
204 regdb_fetch_values(builtin_registry_values[i].path, values);
206 /* preserve existing values across restarts. Only add new ones */
208 if (!regval_ctr_key_exists(values,
209 builtin_registry_values[i].valuename))
211 switch(builtin_registry_values[i].type) {
213 regval_ctr_addvalue(values,
214 builtin_registry_values[i].valuename,
216 (char*)&builtin_registry_values[i].data.dw_value,
222 builtin_registry_values[i].data.string,
224 regval_ctr_addvalue(values,
225 builtin_registry_values[i].valuename,
228 data.uni_str_len*sizeof(uint16));
232 DEBUG(0, ("init_registry_data: invalid value "
233 "type in builtin_registry_values "
235 builtin_registry_values[i].type));
237 regdb_store_values(builtin_registry_values[i].path,
245 if (regdb->transaction_commit(regdb) == -1) {
246 DEBUG(0, ("init_registry_data: Could not commit "
257 if (regdb->transaction_cancel(regdb) == -1) {
258 smb_panic("init_registry_data: tdb_transaction_cancel "
265 /***********************************************************************
266 Open the registry database
267 ***********************************************************************/
269 bool regdb_init( void )
271 const char *vstring = "INFO/version";
275 DEBUG(10,("regdb_init: incrementing refcount (%d)\n", regdb_refcount));
280 if ( !(regdb = db_open(NULL, state_path("registry.tdb"), 0, REG_TDB_FLAGS, O_RDWR, 0600)) )
282 regdb = db_open(NULL, state_path("registry.tdb"), 0, REG_TDB_FLAGS, O_RDWR|O_CREAT, 0600);
284 DEBUG(0,("regdb_init: Failed to open registry %s (%s)\n",
285 state_path("registry.tdb"), strerror(errno) ));
289 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
294 vers_id = dbwrap_fetch_int32(regdb, vstring);
296 if ( vers_id != REGVER_V1 ) {
297 /* any upgrade code here if needed */
298 DEBUG(10, ("regdb_init: got INFO/version = %d != %d\n",
299 vers_id, REGVER_V1));
302 /* always setup the necessary keys and values */
304 if ( !init_registry_data() ) {
305 DEBUG(0,("regdb_init: Failed to initialize data in registry!\n"));
312 /***********************************************************************
313 Open the registry. Must already have been initialized by regdb_init()
314 ***********************************************************************/
316 WERROR regdb_open( void )
318 WERROR result = WERR_OK;
321 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", regdb_refcount));
328 regdb = db_open(NULL, state_path("registry.tdb"), 0, REG_TDB_FLAGS, O_RDWR, 0600);
330 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
331 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
332 state_path("registry.tdb"), strerror(errno) ));
338 DEBUG(10,("regdb_open: refcount reset (%d)\n", regdb_refcount));
343 /***********************************************************************
344 ***********************************************************************/
346 int regdb_close( void )
348 if (regdb_refcount == 0) {
354 DEBUG(10,("regdb_close: decrementing refcount (%d)\n", regdb_refcount));
356 if ( regdb_refcount > 0 )
359 SMB_ASSERT( regdb_refcount >= 0 );
365 /***********************************************************************
366 return the tdb sequence number of the registry tdb.
367 this is an indicator for the content of the registry
368 having changed. it will change upon regdb_init, too, though.
369 ***********************************************************************/
370 int regdb_get_seqnum(void)
372 return regdb->get_seqnum(regdb);
375 /***********************************************************************
376 Add subkey strings to the registry tdb under a defined key
377 fmt is the same format as tdb_pack except this function only supports
379 ***********************************************************************/
381 static bool regdb_store_keys_internal(const char *key, REGSUBKEY_CTR *ctr)
384 uint8 *buffer = NULL;
388 uint32 num_subkeys = regsubkey_ctr_numkeys(ctr);
389 char *keyname = NULL;
390 TALLOC_CTX *ctx = talloc_stackframe();
397 keyname = talloc_strdup(ctx, key);
401 keyname = normalize_reg_path(ctx, keyname);
403 /* allocate some initial memory */
405 buffer = (uint8 *)SMB_MALLOC(1024);
406 if (buffer == NULL) {
412 /* store the number of subkeys */
414 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
416 /* pack all the strings */
418 for (i=0; i<num_subkeys; i++) {
419 len += tdb_pack(buffer+len, buflen-len, "f",
420 regsubkey_ctr_specific_key(ctr, i));
422 /* allocate some extra space */
423 buffer = (uint8 *)SMB_REALLOC(buffer, len*2);
425 DEBUG(0, ("regdb_store_keys: Failed to realloc "
426 "memory of size [%d]\n", len*2));
431 len = tdb_pack(buffer+len, buflen-len, "f",
432 regsubkey_ctr_specific_key(ctr, i));
436 /* finally write out the data */
440 status = dbwrap_store_bystring(regdb, keyname, dbuf, TDB_REPLACE);
441 if (!NT_STATUS_IS_OK(status)) {
452 /***********************************************************************
453 Store the new subkey record and create any child key records that
454 do not currently exist
455 ***********************************************************************/
457 bool regdb_store_keys(const char *key, REGSUBKEY_CTR *ctr)
461 REGSUBKEY_CTR *subkeys = NULL, *old_subkeys = NULL;
462 char *oldkeyname = NULL;
463 TALLOC_CTX *ctx = talloc_stackframe();
467 * fetch a list of the old subkeys so we can determine if anything has
471 if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
472 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
476 regdb_fetch_keys(key, old_subkeys);
478 if ((ctr->num_subkeys && old_subkeys->num_subkeys) &&
479 (ctr->num_subkeys == old_subkeys->num_subkeys)) {
481 for (i = 0; i<ctr->num_subkeys; i++) {
482 if (strcmp(ctr->subkeys[i],
483 old_subkeys->subkeys[i]) != 0) {
487 if (i == ctr->num_subkeys) {
489 * Nothing changed, no point to even start a tdb
492 TALLOC_FREE(old_subkeys);
497 TALLOC_FREE(old_subkeys);
499 if (regdb->transaction_start(regdb) == -1) {
500 DEBUG(0, ("regdb_store_keys: transaction_start failed\n"));
505 * Re-fetch the old keys inside the transaction
508 if (!(old_subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR))) {
509 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
513 regdb_fetch_keys(key, old_subkeys);
515 /* store the subkey list for the parent */
517 if (!regdb_store_keys_internal(key, ctr) ) {
518 DEBUG(0,("regdb_store_keys: Failed to store new subkey list "
519 "for parent [%s]\n", key));
523 /* now delete removed keys */
525 num_subkeys = regsubkey_ctr_numkeys(old_subkeys);
526 for (i=0; i<num_subkeys; i++) {
527 oldkeyname = regsubkey_ctr_specific_key(old_subkeys, i);
529 if (regsubkey_ctr_key_exists(ctr, oldkeyname)) {
531 * It's still around, don't delete
537 path = talloc_asprintf(ctx, "%s/%s", key, oldkeyname);
541 path = normalize_reg_path(ctx, path);
545 status = dbwrap_delete_bystring(regdb, path);
546 if (!NT_STATUS_IS_OK(status)) {
547 DEBUG(1, ("Deleting %s failed\n", path));
552 path = talloc_asprintf(ctx, "%s/%s/%s",
559 path = normalize_reg_path(ctx, path);
565 * Ignore errors here, we might have no values around
567 dbwrap_delete_bystring(regdb, path);
571 TALLOC_FREE(old_subkeys);
573 /* now create records for any subkeys that don't already exist */
575 num_subkeys = regsubkey_ctr_numkeys(ctr);
577 if (num_subkeys == 0) {
578 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
579 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
583 if (!regdb_store_keys_internal(key, subkeys)) {
584 DEBUG(0,("regdb_store_keys: Failed to store "
585 "new record for key [%s]\n", key));
588 TALLOC_FREE(subkeys);
592 for (i=0; i<num_subkeys; i++) {
593 path = talloc_asprintf(ctx, "%s/%s",
595 regsubkey_ctr_specific_key(ctr, i));
599 if (!(subkeys = TALLOC_ZERO_P(ctx, REGSUBKEY_CTR)) ) {
600 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
604 if (regdb_fetch_keys( path, subkeys ) == -1) {
605 /* create a record with 0 subkeys */
606 if (!regdb_store_keys_internal(path, subkeys)) {
607 DEBUG(0,("regdb_store_keys: Failed to store "
608 "new record for key [%s]\n", path));
613 TALLOC_FREE(subkeys);
617 if (regdb->transaction_commit(regdb) == -1) {
618 DEBUG(0, ("regdb_store_keys: Could not commit transaction\n"));
626 if (regdb->transaction_cancel(regdb) == -1) {
627 smb_panic("regdb_store_keys: transaction_cancel failed\n");
637 /***********************************************************************
638 Retrieve an array of strings containing subkeys. Memory should be
639 released by the caller.
640 ***********************************************************************/
642 int regdb_fetch_keys(const char *key, REGSUBKEY_CTR *ctr)
651 TALLOC_CTX *frame = talloc_stackframe();
652 struct db_record *rec;
654 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
656 path = talloc_strdup(frame, key);
661 /* convert to key format */
662 path = talloc_string_sub(frame, path, "\\", "/");
668 rec = regdb->fetch_locked(regdb, frame, string_term_tdb_data(path));
674 ctr->seqnum = regdb_get_seqnum();
676 buf = rec->value.dptr;
677 buflen = rec->value.dsize;
680 DEBUG(5,("regdb_fetch_keys: tdb lookup failed to locate key [%s]\n", key));
684 len = tdb_unpack( buf, buflen, "d", &num_items);
686 for (i=0; i<num_items; i++) {
687 len += tdb_unpack(buf+len, buflen-len, "f", subkeyname);
688 regsubkey_ctr_addkey(ctr, subkeyname);
691 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
699 /****************************************************************************
700 Unpack a list of registry values frem the TDB
701 ***************************************************************************/
703 static int regdb_unpack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
710 uint32 num_values = 0;
713 /* loop and unpack the rest of the registry values */
715 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
717 for ( i=0; i<num_values; i++ ) {
718 /* unpack the next regval */
724 len += tdb_unpack(buf+len, buflen-len, "fdB",
730 /* add the new value. Paranoid protective code -- make sure data_p is valid */
732 if (*valuename && size && data_p) {
733 regval_ctr_addvalue(values, valuename, type,
734 (const char *)data_p, size);
736 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
738 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
744 /****************************************************************************
745 Pack all values in all printer keys
746 ***************************************************************************/
748 static int regdb_pack_values(REGVAL_CTR *values, uint8 *buf, int buflen)
758 num_values = regval_ctr_numvals( values );
760 /* pack the number of values first */
762 len += tdb_pack( buf+len, buflen-len, "d", num_values );
764 /* loop over all values */
766 for ( i=0; i<num_values; i++ ) {
767 val = regval_ctr_specific_value( values, i );
768 len += tdb_pack(buf+len, buflen-len, "fdB",
772 regval_data_p(val) );
778 /***********************************************************************
779 Retrieve an array of strings containing subkeys. Memory should be
780 released by the caller.
781 ***********************************************************************/
783 int regdb_fetch_values( const char* key, REGVAL_CTR *values )
786 TALLOC_CTX *ctx = talloc_stackframe();
787 struct db_record *rec;
790 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
792 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key);
796 keystr = normalize_reg_path(ctx, keystr);
801 rec = regdb->fetch_locked(regdb, ctx, string_term_tdb_data(keystr));
806 values->seqnum = regdb_get_seqnum();
808 if (!rec->value.dptr) {
809 /* all keys have zero values by default */
813 regdb_unpack_values(values, rec->value.dptr, rec->value.dsize);
814 ret = regval_ctr_numvals(values);
821 bool regdb_store_values( const char *key, REGVAL_CTR *values )
823 TDB_DATA old_data, data;
825 TALLOC_CTX *ctx = talloc_stackframe();
829 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
833 len = regdb_pack_values(values, data.dptr, data.dsize);
835 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
839 data.dptr = TALLOC_ARRAY(ctx, uint8, len);
842 len = regdb_pack_values(values, data.dptr, data.dsize);
844 SMB_ASSERT( len == data.dsize );
846 keystr = talloc_asprintf(ctx, "%s/%s", REG_VALUE_PREFIX, key );
850 keystr = normalize_reg_path(ctx, keystr);
855 old_data = dbwrap_fetch_bystring(regdb, ctx, keystr);
857 if ((old_data.dptr != NULL)
858 && (old_data.dsize == data.dsize)
859 && (memcmp(old_data.dptr, data.dptr, data.dsize) == 0))
865 ret = dbwrap_trans_store(regdb, string_term_tdb_data(keystr), data,
867 result = (ret != -1);
874 static WERROR regdb_get_secdesc(TALLOC_CTX *mem_ctx, const char *key,
875 struct security_descriptor **psecdesc)
880 TALLOC_CTX *tmp_ctx = talloc_stackframe();
881 WERROR err = WERR_OK;
883 DEBUG(10, ("regdb_get_secdesc: Getting secdesc of key [%s]\n", key));
885 tdbkey = talloc_asprintf(tmp_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
886 if (tdbkey == NULL) {
890 normalize_dbkey(tdbkey);
892 data = dbwrap_fetch_bystring(regdb, tmp_ctx, tdbkey);
893 if (data.dptr == NULL) {
898 status = unmarshall_sec_desc(mem_ctx, (uint8 *)data.dptr, data.dsize,
901 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_MEMORY)) {
903 } else if (!NT_STATUS_IS_OK(status)) {
904 err = WERR_REG_CORRUPT;
908 TALLOC_FREE(tmp_ctx);
912 static WERROR regdb_set_secdesc(const char *key,
913 struct security_descriptor *secdesc)
915 TALLOC_CTX *mem_ctx = talloc_stackframe();
917 WERROR err = WERR_NOMEM;
921 tdbkey = talloc_asprintf(mem_ctx, "%s/%s", REG_SECDESC_PREFIX, key);
922 if (tdbkey == NULL) {
925 normalize_dbkey(tdbkey);
927 if (secdesc == NULL) {
928 /* assuming a delete */
929 tdb_ret = dbwrap_trans_delete(regdb,
930 string_term_tdb_data(tdbkey));
932 err = ntstatus_to_werror(map_nt_error_from_unix(errno));
939 err = ntstatus_to_werror(marshall_sec_desc(mem_ctx, secdesc,
942 if (!W_ERROR_IS_OK(err)) {
946 tdb_ret = dbwrap_trans_store(regdb, string_term_tdb_data(tdbkey),
949 err = ntstatus_to_werror(map_nt_error_from_unix(errno));
954 TALLOC_FREE(mem_ctx);
958 bool regdb_subkeys_need_update(REGSUBKEY_CTR *subkeys)
960 return (regdb_get_seqnum() != subkeys->seqnum);
963 bool regdb_values_need_update(REGVAL_CTR *values)
965 return (regdb_get_seqnum() != values->seqnum);
969 * Table of function pointers for default access
972 REGISTRY_OPS regdb_ops = {
973 .fetch_subkeys = regdb_fetch_keys,
974 .fetch_values = regdb_fetch_values,
975 .store_subkeys = regdb_store_keys,
976 .store_values = regdb_store_values,
977 .get_secdesc = regdb_get_secdesc,
978 .set_secdesc = regdb_set_secdesc,
979 .subkeys_need_update = regdb_subkeys_need_update,
980 .values_need_update = regdb_values_need_update