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 2 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, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 /* Implementation of internal registry database functions. */
26 #define DBGC_CLASS DBGC_RPC_SRV
28 static TDB_CONTEXT *tdb_reg;
29 static int tdb_refcount;
31 #define VALUE_PREFIX "SAMBA_REGVAL"
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[] = {
49 "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Perflib",
50 "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Perflib\\009",
51 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print\\Monitors",
52 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\ProductOptions",
53 "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Terminal Server\\DefaultUserConfiguration",
54 "HKLM\\SYSTEM\\CurrentControlSet\\Services\\TcpIp\\Parameters",
55 "HKLM\\SYSTEM\\CurrentControlSet\\Services\\Netlogon\\Parameters",
62 struct builtin_regkey_value {
64 const char *valuename;
72 static struct builtin_regkey_value builtin_registry_values[] = {
74 SAMBA_PRINTER_PORT_NAME, REG_SZ, { "" } },
76 "DefaultSpoolDirectory", REG_SZ, { "C:\\Windows\\System32\\Spool\\Printers" } },
78 "DisplayName", REG_SZ, { "Event Log" } },
80 "ErrorControl", REG_DWORD, { (char*)0x00000001 } },
81 { NULL, NULL, 0, { NULL } }
84 #define REGVER_V1 1 /* first db version with write support */
86 /***********************************************************************
87 Open the registry data in the tdb
88 ***********************************************************************/
90 static BOOL init_registry_data( void )
92 pstring path, base, remaining;
93 fstring keyname, subkeyname;
94 REGSUBKEY_CTR *subkeys;
100 /* loop over all of the predefined paths and add each component */
102 for ( i=0; builtin_registry_paths[i] != NULL; i++ ) {
104 DEBUG(6,("init_registry_data: Adding [%s]\n", builtin_registry_paths[i]));
106 pstrcpy( path, builtin_registry_paths[i] );
110 while ( next_token(&p, keyname, "\\", sizeof(keyname)) ) {
112 /* build up the registry path from the components */
115 pstrcat( base, "\\" );
116 pstrcat( base, keyname );
118 /* get the immediate subkeyname (if we have one ) */
122 pstrcpy( remaining, p );
125 if ( !next_token(&p2, subkeyname, "\\", sizeof(subkeyname)) )
126 fstrcpy( subkeyname, p2 );
129 DEBUG(10,("init_registry_data: Storing key [%s] with subkey [%s]\n",
130 base, *subkeyname ? subkeyname : "NULL"));
132 /* we don't really care if the lookup succeeds or not since
133 we are about to update the record. We just want any
134 subkeys already present */
136 if ( !(subkeys = TALLOC_ZERO_P( NULL, REGSUBKEY_CTR )) ) {
137 DEBUG(0,("talloc() failure!\n"));
141 regdb_fetch_keys( base, subkeys );
143 regsubkey_ctr_addkey( subkeys, subkeyname );
144 if ( !regdb_store_keys( base, subkeys ))
147 TALLOC_FREE( subkeys );
151 /* loop over all of the predefined values and add each component */
153 for ( i=0; builtin_registry_values[i].path != NULL; i++ ) {
154 if ( !(values = TALLOC_ZERO_P( NULL, REGVAL_CTR )) ) {
155 DEBUG(0,("talloc() failure!\n"));
159 regdb_fetch_values( builtin_registry_values[i].path, values );
161 /* preserve existing values across restarts. Only add new ones */
163 if ( !regval_ctr_key_exists( values, builtin_registry_values[i].valuename ) )
165 switch( builtin_registry_values[i].type ) {
167 regval_ctr_addvalue( values,
168 builtin_registry_values[i].valuename,
170 (char*)&builtin_registry_values[i].data.dw_value,
175 init_unistr2( &data, builtin_registry_values[i].data.string, UNI_STR_TERMINATE);
176 regval_ctr_addvalue( values,
177 builtin_registry_values[i].valuename,
180 data.uni_str_len*sizeof(uint16) );
184 DEBUG(0,("init_registry_data: invalid value type in builtin_registry_values [%d]\n",
185 builtin_registry_values[i].type));
187 regdb_store_values( builtin_registry_values[i].path, values );
190 TALLOC_FREE( values );
196 /***********************************************************************
197 Open the registry database
198 ***********************************************************************/
200 BOOL regdb_init( void )
202 const char *vstring = "INFO/version";
208 if ( !(tdb_reg = tdb_open_log(lock_path("registry.tdb"), 0, TDB_DEFAULT, O_RDWR, 0600)) )
210 tdb_reg = tdb_open_log(lock_path("registry.tdb"), 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0600);
212 DEBUG(0,("regdb_init: Failed to open registry %s (%s)\n",
213 lock_path("registry.tdb"), strerror(errno) ));
217 DEBUG(10,("regdb_init: Successfully created registry tdb\n"));
223 vers_id = tdb_fetch_int32(tdb_reg, vstring);
225 if ( vers_id != REGVER_V1 ) {
226 /* any upgrade code here if needed */
229 /* always setup the necessary keys and values */
231 if ( !init_registry_data() ) {
232 DEBUG(0,("init_registry: Failed to initiailize data in registry!\n"));
239 /***********************************************************************
240 Open the registry. Must already have been initialized by regdb_init()
241 ***********************************************************************/
243 WERROR regdb_open( void )
245 WERROR result = WERR_OK;
248 DEBUG(10,("regdb_open: incrementing refcount (%d)\n", tdb_refcount));
255 tdb_reg = tdb_open_log(lock_path("registry.tdb"), 0, TDB_DEFAULT, O_RDWR, 0600);
257 result = ntstatus_to_werror( map_nt_error_from_unix( errno ) );
258 DEBUG(0,("regdb_open: Failed to open %s! (%s)\n",
259 lock_path("registry.tdb"), strerror(errno) ));
265 DEBUG(10,("regdb_open: refcount reset (%d)\n", tdb_refcount));
270 /***********************************************************************
271 ***********************************************************************/
273 int regdb_close( void )
279 DEBUG(10,("regdb_close: decrementing refcount (%d)\n", tdb_refcount));
281 if ( tdb_refcount > 0 )
284 SMB_ASSERT( tdb_refcount >= 0 );
286 ret = tdb_close( tdb_reg );
292 /***********************************************************************
293 Add subkey strings to the registry tdb under a defined key
294 fmt is the same format as tdb_pack except this function only supports
296 ***********************************************************************/
298 static BOOL regdb_store_keys_internal( const char *key, REGSUBKEY_CTR *ctr )
305 uint32 num_subkeys = regsubkey_ctr_numkeys( ctr );
311 pstrcpy( keyname, key );
312 normalize_reg_path( keyname );
314 /* allocate some initial memory */
316 buffer = SMB_MALLOC(sizeof(pstring));
317 buflen = sizeof(pstring);
320 /* store the number of subkeys */
322 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys );
324 /* pack all the strings */
326 for (i=0; i<num_subkeys; i++) {
327 len += tdb_pack( buffer+len, buflen-len, "f", regsubkey_ctr_specific_key(ctr, i) );
328 if ( len > buflen ) {
329 /* allocate some extra space */
330 if ((buffer = SMB_REALLOC( buffer, len*2 )) == NULL) {
331 DEBUG(0,("regdb_store_keys: Failed to realloc memory of size [%d]\n", len*2));
337 len = tdb_pack( buffer+len, buflen-len, "f", regsubkey_ctr_specific_key(ctr, i) );
341 /* finally write out the data */
344 kbuf.dsize = strlen(keyname)+1;
347 if ( tdb_store( tdb_reg, kbuf, dbuf, TDB_REPLACE ) == -1) {
358 /***********************************************************************
359 Store the new subkey record and create any child key records that
360 do not currently exist
361 ***********************************************************************/
363 BOOL regdb_store_keys( const char *key, REGSUBKEY_CTR *ctr )
367 REGSUBKEY_CTR *subkeys, *old_subkeys;
370 /* fetch a list of the old subkeys so we can determine if any were deleted */
372 if ( !(old_subkeys = TALLOC_ZERO_P( ctr, REGSUBKEY_CTR )) ) {
373 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
377 regdb_fetch_keys( key, old_subkeys );
379 /* store the subkey list for the parent */
381 if ( !regdb_store_keys_internal( key, ctr ) ) {
382 DEBUG(0,("regdb_store_keys: Failed to store new subkey list for parent [%s}\n", key ));
386 /* now delete removed keys */
388 num_subkeys = regsubkey_ctr_numkeys( old_subkeys );
389 for ( i=0; i<num_subkeys; i++ ) {
390 oldkeyname = regsubkey_ctr_specific_key( old_subkeys, i );
391 if ( !regsubkey_ctr_key_exists( ctr, oldkeyname ) ) {
392 pstr_sprintf( path, "%s%c%s", key, '/', oldkeyname );
393 normalize_reg_path( path );
394 tdb_delete_bystring( tdb_reg, path );
398 TALLOC_FREE( old_subkeys );
400 /* now create records for any subkeys that don't already exist */
402 num_subkeys = regsubkey_ctr_numkeys( ctr );
403 for ( i=0; i<num_subkeys; i++ ) {
404 pstr_sprintf( path, "%s%c%s", key, '/', regsubkey_ctr_specific_key( ctr, i ) );
406 if ( !(subkeys = TALLOC_ZERO_P( ctr, REGSUBKEY_CTR )) ) {
407 DEBUG(0,("regdb_store_keys: talloc() failure!\n"));
411 if ( regdb_fetch_keys( path, subkeys ) == -1 ) {
412 /* create a record with 0 subkeys */
413 if ( !regdb_store_keys_internal( path, subkeys ) ) {
414 DEBUG(0,("regdb_store_keys: Failed to store new record for key [%s}\n", path ));
415 TALLOC_FREE( subkeys );
420 TALLOC_FREE( subkeys );
427 /***********************************************************************
428 Retrieve an array of strings containing subkeys. Memory should be
429 released by the caller.
430 ***********************************************************************/
432 int regdb_fetch_keys( const char* key, REGSUBKEY_CTR *ctr )
442 DEBUG(11,("regdb_fetch_keys: Enter key => [%s]\n", key ? key : "NULL"));
444 pstrcpy( path, key );
446 /* convert to key format */
447 pstring_sub( path, "\\", "/" );
450 dbuf = tdb_fetch_bystring( tdb_reg, path );
456 DEBUG(5,("regdb_fetch_keys: tdb lookup failed to locate key [%s]\n", key));
460 len = tdb_unpack( buf, buflen, "d", &num_items);
462 for (i=0; i<num_items; i++) {
463 len += tdb_unpack( buf+len, buflen-len, "f", subkeyname );
464 regsubkey_ctr_addkey( ctr, subkeyname );
467 SAFE_FREE( dbuf.dptr );
469 DEBUG(11,("regdb_fetch_keys: Exit [%d] items\n", num_items));
474 /****************************************************************************
475 Unpack a list of registry values frem the TDB
476 ***************************************************************************/
478 static int regdb_unpack_values(REGVAL_CTR *values, char *buf, int buflen)
485 uint32 num_values = 0;
490 /* loop and unpack the rest of the registry values */
492 len += tdb_unpack(buf+len, buflen-len, "d", &num_values);
494 for ( i=0; i<num_values; i++ ) {
495 /* unpack the next regval */
500 len += tdb_unpack(buf+len, buflen-len, "fdB",
506 /* add the new value. Paranoid protective code -- make sure data_p is valid */
508 if ( size && data_p ) {
509 regval_ctr_addvalue( values, valuename, type, (const char *)data_p, size );
510 SAFE_FREE(data_p); /* 'B' option to tdb_unpack does a malloc() */
513 DEBUG(8,("specific: [%s], len: %d\n", valuename, size));
519 /****************************************************************************
520 Pack all values in all printer keys
521 ***************************************************************************/
523 static int regdb_pack_values(REGVAL_CTR *values, char *buf, int buflen)
528 int num_values = regval_ctr_numvals( values );
533 /* pack the number of values first */
535 len += tdb_pack( buf+len, buflen-len, "d", num_values );
537 /* loop over all values */
539 for ( i=0; i<num_values; i++ ) {
540 val = regval_ctr_specific_value( values, i );
541 len += tdb_pack(buf+len, buflen-len, "fdB",
545 regval_data_p(val) );
551 /***********************************************************************
552 Retrieve an array of strings containing subkeys. Memory should be
553 released by the caller.
554 ***********************************************************************/
556 int regdb_fetch_values( const char* key, REGVAL_CTR *values )
561 DEBUG(10,("regdb_fetch_values: Looking for value of key [%s] \n", key));
563 pstr_sprintf( keystr, "%s/%s", VALUE_PREFIX, key );
564 normalize_reg_path( keystr );
566 data = tdb_fetch_bystring( tdb_reg, keystr );
569 /* all keys have zero values by default */
573 regdb_unpack_values( values, data.dptr, data.dsize );
575 SAFE_FREE( data.dptr );
577 return regval_ctr_numvals(values);
580 /***********************************************************************
581 Stub function since we do not currently support storing registry
582 values in the registry.tdb
583 ***********************************************************************/
585 BOOL regdb_store_values( const char *key, REGVAL_CTR *values )
591 DEBUG(10,("regdb_store_values: Looking for value of key [%s] \n", key));
595 len = regdb_pack_values( values, data.dptr, data.dsize );
597 DEBUG(0,("regdb_store_values: unable to pack values. len <= 0\n"));
601 data.dptr = SMB_MALLOC_ARRAY( char, len );
604 len = regdb_pack_values( values, data.dptr, data.dsize );
606 SMB_ASSERT( len == data.dsize );
608 pstr_sprintf( keystr, "%s/%s", VALUE_PREFIX, key );
609 normalize_reg_path( keystr );
611 ret = tdb_store_bystring(tdb_reg, keystr, data, TDB_REPLACE);
613 SAFE_FREE( data.dptr );
620 * Table of function pointers for default access
623 REGISTRY_OPS regdb_ops = {