2 * Unix SMB/CIFS implementation.
3 * RPC Pipe client / server routines
4 * Copyright (C) Andrew Tridgell 1992-1997,
5 * Copyright (C) Luke Kenneth Casson Leighton 1996-1997,
6 * Copyright (C) Paul Ashton 1997.
7 * Copyright (C) Hewlett-Packard Company 1999.
8 * Copyright (C) Jeremy Allison 2001.
9 * Copyright (C) Gerald Carter 2002.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 /* Implementation of registry functions. */
31 #define DBGC_CLASS DBGC_RPC_SRV
33 #define KEY_HKLM "HKLM"
36 #define OUR_HANDLE(hnd) (((hnd)==NULL)?"NULL":(IVAL((hnd)->data5,4)==(uint32)sys_getpid()?"OURS":"OTHER")), \
37 ((unsigned int)IVAL((hnd)->data5,4)),((unsigned int)sys_getpid())
39 /* structure to store the registry handles */
41 typedef struct _RegistryKey {
42 struct _RegistryKey *prev, *next;
44 fstring name; /* name of registry key */
49 static Registry_Key *regkeys_list;
50 static TDB_CONTEXT *tdb_reg;
52 /***********************************************************************
53 Add subkey strings to the registry tdb under a defined key
54 fmt is the same format as tdb_pack except this function only supports
56 ***********************************************************************/
58 static BOOL store_reg_keys( TDB_CONTEXT *tdb, char *keyname, char **subkeys, uint32 num_subkeys )
61 void *buffer, *tmpbuf;
69 /* allocate some initial memory */
71 buffer = malloc(sizeof(pstring));
72 buflen = sizeof(pstring);
75 /* store the number of subkeys */
77 len += tdb_pack(buffer+len, buflen-len, "d", num_subkeys);
79 /* pack all the strings */
81 for (i=0; i<num_subkeys; i++) {
82 len += tdb_pack(buffer+len, buflen-len, "f", subkeys[i]);
84 /* allocate some extra space */
85 if ((tmpbuf = Realloc( buffer, len*2 )) == NULL) {
86 DEBUG(0,("store_reg_keys: Failed to realloc memory of size [%d]\n", len*2));
93 len = tdb_pack(buffer+len, buflen-len, "f", subkeys[i]);
97 /* finally write out the data */
100 kbuf.dsize = strlen(keyname)+1;
103 if ( tdb_store( tdb, kbuf, dbuf, TDB_REPLACE ) == -1) {
113 /***********************************************************************
114 Retrieve an array of strings containing subkeys. Memory should be
115 released by the caller. The subkeys are stored in a catenated string
116 of null terminated character strings
117 ***********************************************************************/
119 static int fetch_reg_keys( TDB_CONTEXT *tdb, char* key, char **subkeys )
130 pstrcpy( path, key );
132 /* convert to key format */
133 pstring_sub( path, "\\", "/" );
135 dbuf = tdb_fetch_by_string( tdb, path );
141 DEBUG(5,("fetch_reg_keys: Failed to fetch any subkeys for [%s]\n", key));
145 len = tdb_unpack( buf, buflen, "d", &num_items);
147 if ( (*subkeys = (char*)malloc(sizeof(fstring)*num_items)) == NULL ) {
148 DEBUG(0,("fetch_reg_keys: Failed to malloc memory for subkey array containing [%d] items!\n",
156 for (i=0; i<num_items; i++) {
157 len += tdb_unpack( buf+len, buflen-len, "f", s );
162 SAFE_FREE(dbuf.dptr);
166 /***********************************************************************
167 count the number of subkeys dtored in the registry
168 ***********************************************************************/
170 static int fetch_reg_keys_count( TDB_CONTEXT *tdb, char* key )
179 pstrcpy( path, key );
181 /* convert to key format */
182 pstring_sub( path, "\\", "/" );
184 dbuf = tdb_fetch_by_string( tdb, path );
190 DEBUG(5,("fetch_reg_keys: Failed to fetch any subkeys for [%s]\n", key));
194 len = tdb_unpack( buf, buflen, "d", &num_items);
201 /***********************************************************************
202 retreive a specific subkey specified by index. The subkey parameter
203 is assumed to be an fstring.
204 ***********************************************************************/
206 static BOOL fetch_reg_keys_specific( TDB_CONTEXT *tdb, char* key, char* subkey, uint32 index )
209 char *subkeys = NULL;
212 num_subkeys = fetch_reg_keys( tdb_reg, key, &subkeys );
213 if ( num_subkeys == -1 )
217 for ( i=0; i<num_subkeys; i++ ) {
218 /* copy the key if the index matches */
220 fstrcpy( subkey, s );
224 /* go onto the next string */
234 /***********************************************************************
235 Open the registry database
236 ***********************************************************************/
238 static BOOL init_registry_data( TDB_CONTEXT* tdb_reg )
243 /* HKEY_LOCAL_MACHINE */
245 pstrcpy( keyname, KEY_HKLM );
246 subkeys[0] = "SYSTEM";
247 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 1 ))
250 pstrcpy( keyname, KEY_HKLM );
251 pstrcat( keyname, "/SYSTEM" );
252 subkeys[0] = "CurrentControlSet";
253 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 1 ))
256 pstrcpy( keyname, KEY_HKLM );
257 pstrcat( keyname, "/SYSTEM/CurrentControlSet" );
258 subkeys[0] = "Control";
259 subkeys[1] = "services";
260 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 2 ))
263 pstrcpy( keyname, KEY_HKLM );
264 pstrcat( keyname, "/SYSTEM/CurrentControlSet/Control" );
265 subkeys[0] = "Print";
266 subkeys[1] = "ProduceOptions";
267 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 2 ))
270 pstrcpy( keyname, KEY_HKLM );
271 pstrcat( keyname, "/SYSTEM/CurrentControlSet/Control/Print" );
272 subkeys[0] = "Environments";
273 subkeys[1] = "Forms";
274 subkeys[2] = "Printers";
275 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 3 ))
278 pstrcpy( keyname, KEY_HKLM );
279 pstrcat( keyname, "/SYSTEM/CurrentControlSet/Control/ProductOptions" );
280 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 0 ))
283 pstrcpy( keyname, KEY_HKLM );
284 pstrcat( keyname, "/SYSTEM/CurrentControlSet/services" );
285 subkeys[0] = "Netlogon";
286 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 1 ))
289 pstrcpy( keyname, KEY_HKLM );
290 pstrcat( keyname, "/SYSTEM/CurrentControlSet/services/Netlogon" );
291 subkeys[0] = "parameters";
292 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 1 ))
295 pstrcpy( keyname, KEY_HKLM );
296 pstrcat( keyname, "/SYSTEM/CurrentControlSet/services/Netlogon/parameters" );
297 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 0 ))
303 pstrcpy( keyname, KEY_HKU );
304 if ( !store_reg_keys( tdb_reg, keyname, subkeys, 0 ) )
310 /***********************************************************************
311 Open the registry database
312 ***********************************************************************/
314 BOOL init_registry( void )
316 static pid_t local_pid;
319 if (tdb_reg && local_pid == sys_getpid())
323 * try to open first without creating so we can determine
324 * if we need to init the data in the registry
327 tdb_reg = tdb_open_log(lock_path("registry.tdb"), 0, TDB_DEFAULT, O_RDWR, 0600);
330 tdb_reg = tdb_open_log(lock_path("registry.tdb"), 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0600);
332 DEBUG(0,("init_registry: Failed to open registry %s (%s)\n",
333 lock_path("registry.tdb"), strerror(errno) ));
337 DEBUG(10,("init_registry: Successfully created registry tdb\n"));
339 /* create the registry here */
340 if ( !init_registry_data( tdb_reg ) ) {
341 DEBUG(0,("init_registry: Failed to initiailize data in registry!\n"));
346 local_pid = sys_getpid();
351 /******************************************************************
352 Find a registry key handle and return a Registry_Key
353 *****************************************************************/
355 static Registry_Key *find_regkey_index_by_hnd(pipes_struct *p, POLICY_HND *hnd)
357 Registry_Key *regkey = NULL;
359 if(!find_policy_by_hnd(p,hnd,(void **)®key)) {
360 DEBUG(2,("find_regkey_index_by_hnd: Registry Key not found: "));
368 /******************************************************************
369 free() function for Registry_Key
370 *****************************************************************/
372 static void free_reg_info(void *ptr)
374 Registry_Key *info = (Registry_Key*)ptr;
376 DLIST_REMOVE(regkeys_list, info);
381 /*******************************************************************
382 Function for open a new registry handle and creating a handle
383 Note that P should be valid & hnd should already have space
384 *******************************************************************/
386 static BOOL open_registry_key(pipes_struct *p, POLICY_HND *hnd, char *name,
387 uint32 access_granted)
389 Registry_Key *regkey = NULL;
391 DEBUG(7,("open_registry_key: name = [%s]\n", name));
393 /* All registry keys **must** have a name of non-zero length */
395 if (!name || !*name )
398 if ((regkey=(Registry_Key*)malloc(sizeof(Registry_Key))) == NULL)
401 ZERO_STRUCTP( regkey );
403 DLIST_ADD( regkeys_list, regkey );
405 /* copy the name and obtain a handle */
407 fstrcpy( regkey->name, name );
409 DEBUG(7,("open_registry_key: exit\n"));
411 return create_policy_hnd( p, hnd, free_reg_info, regkey );
414 /*******************************************************************
415 Function for open a new registry handle and creating a handle
416 Note that P should be valid & hnd should already have space
417 *******************************************************************/
419 static BOOL close_registry_key(pipes_struct *p, POLICY_HND *hnd)
421 Registry_Key *regkey = find_regkey_index_by_hnd(p, hnd);
424 DEBUG(2,("close_registry_key: Invalid handle (%s:%u:%u)\n", OUR_HANDLE(hnd)));
428 close_policy_hnd(p, hnd);
433 /********************************************************************
434 retrieve information about the subkeys
435 *******************************************************************/
437 static BOOL get_subkey_information( Registry_Key *key, uint32 *maxnum, uint32 *maxlen )
441 char *subkeys = NULL;
448 num_subkeys = fetch_reg_keys( tdb_reg, key->name, &subkeys );
449 if ( num_subkeys == -1 )
452 /* find the longest string */
456 for ( i=0; i<num_subkeys; i++ ) {
458 max_len = MAX(max_len, len);
462 *maxnum = num_subkeys;
470 /********************************************************************
471 retrieve information about the values. We don't store values
472 here. The registry tdb is intended to be a frontend to oether
473 Samba tdb's (such as ntdrivers.tdb).
474 *******************************************************************/
476 static BOOL get_value_information( Registry_Key *key, uint32 *maxnum,
477 uint32 *maxlen, uint32 *maxsize )
482 /* Hard coded key names first */
484 if ( !strcmp(key->name, KEY_HKLM) || !strcmp(key->name, KEY_HKU) )
493 * FIXME!!! Need to add routines to look up values in other
500 /********************************************************************
502 ********************************************************************/
504 NTSTATUS _reg_close(pipes_struct *p, REG_Q_CLOSE *q_u, REG_R_CLOSE *r_u)
506 /* set up the REG unknown_1 response */
507 ZERO_STRUCT(r_u->pol);
509 /* close the policy handle */
510 if (!close_registry_key(p, &q_u->pol))
511 return NT_STATUS_OBJECT_NAME_INVALID;
516 /*******************************************************************
518 ********************************************************************/
520 NTSTATUS _reg_open_hklm(pipes_struct *p, REG_Q_OPEN_HKLM *q_u, REG_R_OPEN_HKLM *r_u)
522 if (!open_registry_key(p, &r_u->pol, KEY_HKLM, 0x0))
523 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
528 /*******************************************************************
530 ********************************************************************/
532 NTSTATUS _reg_open_hku(pipes_struct *p, REG_Q_OPEN_HKU *q_u, REG_R_OPEN_HKU *r_u)
534 if (!open_registry_key(p, &r_u->pol, KEY_HKU, 0x0))
535 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
540 /*******************************************************************
542 ********************************************************************/
544 NTSTATUS _reg_open_entry(pipes_struct *p, REG_Q_OPEN_ENTRY *q_u, REG_R_OPEN_ENTRY *r_u)
550 Registry_Key *key = find_regkey_index_by_hnd(p, &q_u->pol);
552 DEBUG(5,("reg_open_entry: Enter\n"));
555 return NT_STATUS_INVALID_HANDLE;
557 rpcstr_pull(name,q_u->uni_name.buffer,sizeof(name),q_u->uni_name.uni_str_len*2,0);
559 /* store the full path in the regkey_list */
561 pstrcpy( path, key->name );
562 pstrcat( path, "\\" );
563 pstrcat( path, name );
565 DEBUG(5,("reg_open_entry: %s\n", path));
567 /* do a check on the name, here */
569 if ( (num_subkeys=fetch_reg_keys_count( tdb_reg, path )) == -1 )
570 return NT_STATUS_ACCESS_DENIED;
572 if (!open_registry_key(p, &pol, path, 0x0))
573 return NT_STATUS_TOO_MANY_SECRETS;
575 init_reg_r_open_entry(r_u, &pol, NT_STATUS_OK);
577 DEBUG(5,("reg_open_entry: Exitn"));
582 /*******************************************************************
584 ********************************************************************/
586 NTSTATUS _reg_info(pipes_struct *p, REG_Q_INFO *q_u, REG_R_INFO *r_u)
588 NTSTATUS status = NT_STATUS_OK;
590 uint32 type = 0x1; /* key type: REG_SZ */
591 UNISTR2 *uni_key = NULL;
594 Registry_Key *key = find_regkey_index_by_hnd( p, &q_u->pol );
596 DEBUG(5,("_reg_info: Enter\n"));
599 return NT_STATUS_INVALID_HANDLE;
601 DEBUG(7,("_reg_info: policy key name = [%s]\n", key->name));
603 rpcstr_pull(name, q_u->uni_type.buffer, sizeof(name), q_u->uni_type.uni_str_len*2, 0);
605 DEBUG(5,("reg_info: checking subkey: %s\n", name));
607 uni_key = (UNISTR2 *)talloc_zero(p->mem_ctx, sizeof(UNISTR2));
608 buf = (BUFFER2 *)talloc_zero(p->mem_ctx, sizeof(BUFFER2));
610 if (!uni_key || !buf)
611 return NT_STATUS_NO_MEMORY;
613 if ( strequal(name, "RefusePasswordChange") ) {
615 status = NT_STATUS_NO_SUCH_FILE;
616 init_unistr2(uni_key, "", 0);
617 init_buffer2(buf, (uint8*) uni_key->buffer, uni_key->uni_str_len*2);
624 switch (lp_server_role()) {
625 case ROLE_DOMAIN_PDC:
626 case ROLE_DOMAIN_BDC:
629 case ROLE_STANDALONE:
632 case ROLE_DOMAIN_MEMBER:
637 /* This makes the server look like a member server to clients */
638 /* which tells clients that we have our own local user and */
639 /* group databases and helps with ACL support. */
641 init_unistr2(uni_key, value, strlen(value)+1);
642 init_buffer2(buf, (uint8*)uni_key->buffer, uni_key->uni_str_len*2);
645 init_reg_r_info(q_u->ptr_buf, r_u, buf, type, status);
647 DEBUG(5,("reg_open_entry: Exit\n"));
653 /*****************************************************************************
654 Implementation of REG_QUERY_KEY
655 ****************************************************************************/
657 NTSTATUS _reg_query_key(pipes_struct *p, REG_Q_QUERY_KEY *q_u, REG_R_QUERY_KEY *r_u)
659 NTSTATUS status = NT_STATUS_OK;
660 Registry_Key *regkey = find_regkey_index_by_hnd( p, &q_u->pol );
662 DEBUG(5,("_reg_query_key: Enter\n"));
665 return NT_STATUS_INVALID_HANDLE;
667 if ( !get_subkey_information( regkey, &r_u->num_subkeys, &r_u->max_subkeylen ) )
668 return NT_STATUS_ACCESS_DENIED;
670 if ( !get_value_information( regkey, &r_u->num_values, &r_u->max_valnamelen, &r_u->max_valbufsize ) )
671 return NT_STATUS_ACCESS_DENIED;
673 r_u->sec_desc = 0x0; /* size for key's sec_desc */
675 /* Win9x set this to 0x0 since it does not keep timestamps.
676 Doing the same here for simplicity --jerry */
678 ZERO_STRUCT(r_u->mod_time);
680 DEBUG(5,("_reg_query_key: Exit\n"));
686 /*****************************************************************************
687 Implementation of REG_UNKNOWN_1A
688 ****************************************************************************/
690 NTSTATUS _reg_unknown_1a(pipes_struct *p, REG_Q_UNKNOWN_1A *q_u, REG_R_UNKNOWN_1A *r_u)
692 NTSTATUS status = NT_STATUS_OK;
693 Registry_Key *regkey = find_regkey_index_by_hnd( p, &q_u->pol );
695 DEBUG(5,("_reg_unknown_1a: Enter\n"));
698 return NT_STATUS_INVALID_HANDLE;
700 r_u->unknown = 0x00000005; /* seems to be consistent...no idea what it means */
702 DEBUG(5,("_reg_unknown_1a: Exit\n"));
708 /*****************************************************************************
709 Implementation of REG_ENUM_KEY
710 ****************************************************************************/
712 NTSTATUS _reg_enum_key(pipes_struct *p, REG_Q_ENUM_KEY *q_u, REG_R_ENUM_KEY *r_u)
714 NTSTATUS status = NT_STATUS_OK;
715 Registry_Key *regkey = find_regkey_index_by_hnd( p, &q_u->pol );
719 DEBUG(5,("_reg_enum_key: Enter\n"));
722 return NT_STATUS_INVALID_HANDLE;
724 DEBUG(8,("_reg_enum_key: enumerating key [%s]\n", regkey->name));
726 if ( !fetch_reg_keys_specific( tdb_reg, regkey->name, subkey, q_u->key_index ) )
728 status = werror_to_ntstatus( WERR_NO_MORE_ITEMS );
732 DEBUG(10,("_reg_enum_key: retrieved subkey named [%s]\n", subkey));
734 /* subkey has the string name now */
736 init_reg_r_enum_key( r_u, subkey, q_u->unknown_1, q_u->unknown_2 );
738 DEBUG(5,("_reg_enum_key: Exit\n"));
745 /*******************************************************************
747 ********************************************************************/
749 #define SHUTDOWN_R_STRING "-r"
750 #define SHUTDOWN_F_STRING "-f"
753 NTSTATUS _reg_shutdown(pipes_struct *p, REG_Q_SHUTDOWN *q_u, REG_R_SHUTDOWN *r_u)
755 NTSTATUS status = NT_STATUS_OK;
756 pstring shutdown_script;
757 UNISTR2 unimsg = q_u->uni_msg;
765 rpcstr_pull (message, unimsg.buffer, sizeof(message), unimsg.uni_str_len*2,0);
767 alpha_strcpy (chkmsg, message, NULL, sizeof(message));
769 snprintf(timeout, sizeof(timeout), "%d", q_u->timeout);
771 snprintf(r, sizeof(r), (q_u->flags & REG_REBOOT_ON_SHUTDOWN)?SHUTDOWN_R_STRING:"");
773 snprintf(f, sizeof(f), (q_u->flags & REG_FORCE_SHUTDOWN)?SHUTDOWN_F_STRING:"");
775 pstrcpy(shutdown_script, lp_shutdown_script());
777 if(*shutdown_script) {
779 all_string_sub(shutdown_script, "%m", chkmsg, sizeof(shutdown_script));
780 all_string_sub(shutdown_script, "%t", timeout, sizeof(shutdown_script));
781 all_string_sub(shutdown_script, "%r", r, sizeof(shutdown_script));
782 all_string_sub(shutdown_script, "%f", f, sizeof(shutdown_script));
783 shutdown_ret = smbrun(shutdown_script,NULL);
784 DEBUG(3,("_reg_shutdown: Running the command `%s' gave %d\n",shutdown_script,shutdown_ret));
790 /*******************************************************************
792 ********************************************************************/
794 NTSTATUS _reg_abort_shutdown(pipes_struct *p, REG_Q_ABORT_SHUTDOWN *q_u, REG_R_ABORT_SHUTDOWN *r_u)
796 NTSTATUS status = NT_STATUS_OK;
797 pstring abort_shutdown_script;
799 pstrcpy(abort_shutdown_script, lp_abort_shutdown_script());
801 if(*abort_shutdown_script) {
802 int abort_shutdown_ret;
803 abort_shutdown_ret = smbrun(abort_shutdown_script,NULL);
804 DEBUG(3,("_reg_abort_shutdown: Running the command `%s' gave %d\n",abort_shutdown_script,abort_shutdown_ret));