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 char *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,
210 char *subkeys = NULL;
213 num_subkeys = fetch_reg_keys( tdb_reg, key, &subkeys );
214 if ( num_subkeys == -1 )
218 for ( i=0; i<num_subkeys; i++ ) {
219 /* copy the key if the index matches */
220 if ( i == key_index ) {
221 fstrcpy( subkey, s );
225 /* go onto the next string */
235 /***********************************************************************
236 Open the registry database
237 ***********************************************************************/
239 static BOOL init_registry_data( TDB_CONTEXT* registry_tdb )
244 /* HKEY_LOCAL_MACHINE */
246 pstrcpy( keyname, KEY_HKLM );
247 subkeys[0] = "SYSTEM";
248 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 1 ))
251 pstrcpy( keyname, KEY_HKLM );
252 pstrcat( keyname, "/SYSTEM" );
253 subkeys[0] = "CurrentControlSet";
254 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 1 ))
257 pstrcpy( keyname, KEY_HKLM );
258 pstrcat( keyname, "/SYSTEM/CurrentControlSet" );
259 subkeys[0] = "Control";
260 subkeys[1] = "services";
261 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 2 ))
264 pstrcpy( keyname, KEY_HKLM );
265 pstrcat( keyname, "/SYSTEM/CurrentControlSet/Control" );
266 subkeys[0] = "Print";
267 subkeys[1] = "ProduceOptions";
268 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 2 ))
271 pstrcpy( keyname, KEY_HKLM );
272 pstrcat( keyname, "/SYSTEM/CurrentControlSet/Control/Print" );
273 subkeys[0] = "Environments";
274 subkeys[1] = "Forms";
275 subkeys[2] = "Printers";
276 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 3 ))
279 pstrcpy( keyname, KEY_HKLM );
280 pstrcat( keyname, "/SYSTEM/CurrentControlSet/Control/ProductOptions" );
281 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 0 ))
284 pstrcpy( keyname, KEY_HKLM );
285 pstrcat( keyname, "/SYSTEM/CurrentControlSet/services" );
286 subkeys[0] = "Netlogon";
287 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 1 ))
290 pstrcpy( keyname, KEY_HKLM );
291 pstrcat( keyname, "/SYSTEM/CurrentControlSet/services/Netlogon" );
292 subkeys[0] = "parameters";
293 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 1 ))
296 pstrcpy( keyname, KEY_HKLM );
297 pstrcat( keyname, "/SYSTEM/CurrentControlSet/services/Netlogon/parameters" );
298 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 0 ))
304 pstrcpy( keyname, KEY_HKU );
305 if ( !store_reg_keys( registry_tdb, keyname, subkeys, 0 ) )
311 /***********************************************************************
312 Open the registry database
313 ***********************************************************************/
315 BOOL init_registry( void )
317 static pid_t local_pid;
320 if (tdb_reg && local_pid == sys_getpid())
324 * try to open first without creating so we can determine
325 * if we need to init the data in the registry
328 tdb_reg = tdb_open_log(lock_path("registry.tdb"), 0, TDB_DEFAULT, O_RDWR, 0600);
331 tdb_reg = tdb_open_log(lock_path("registry.tdb"), 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0600);
333 DEBUG(0,("init_registry: Failed to open registry %s (%s)\n",
334 lock_path("registry.tdb"), strerror(errno) ));
338 DEBUG(10,("init_registry: Successfully created registry tdb\n"));
340 /* create the registry here */
341 if ( !init_registry_data( tdb_reg ) ) {
342 DEBUG(0,("init_registry: Failed to initiailize data in registry!\n"));
347 local_pid = sys_getpid();
352 /******************************************************************
353 Find a registry key handle and return a Registry_Key
354 *****************************************************************/
356 static Registry_Key *find_regkey_index_by_hnd(pipes_struct *p, POLICY_HND *hnd)
358 Registry_Key *regkey = NULL;
360 if(!find_policy_by_hnd(p,hnd,(void **)®key)) {
361 DEBUG(2,("find_regkey_index_by_hnd: Registry Key not found: "));
369 /******************************************************************
370 free() function for Registry_Key
371 *****************************************************************/
373 static void free_reg_info(void *ptr)
375 Registry_Key *info = (Registry_Key*)ptr;
377 DLIST_REMOVE(regkeys_list, info);
382 /*******************************************************************
383 Function for open a new registry handle and creating a handle
384 Note that P should be valid & hnd should already have space
385 *******************************************************************/
387 static BOOL open_registry_key(pipes_struct *p, POLICY_HND *hnd, char *name,
388 uint32 access_granted)
390 Registry_Key *regkey = NULL;
392 DEBUG(7,("open_registry_key: name = [%s]\n", name));
394 /* All registry keys **must** have a name of non-zero length */
396 if (!name || !*name )
399 if ((regkey=(Registry_Key*)malloc(sizeof(Registry_Key))) == NULL)
402 ZERO_STRUCTP( regkey );
404 DLIST_ADD( regkeys_list, regkey );
406 /* copy the name and obtain a handle */
408 fstrcpy( regkey->name, name );
410 DEBUG(7,("open_registry_key: exit\n"));
412 return create_policy_hnd( p, hnd, free_reg_info, regkey );
415 /*******************************************************************
416 Function for open a new registry handle and creating a handle
417 Note that P should be valid & hnd should already have space
418 *******************************************************************/
420 static BOOL close_registry_key(pipes_struct *p, POLICY_HND *hnd)
422 Registry_Key *regkey = find_regkey_index_by_hnd(p, hnd);
425 DEBUG(2,("close_registry_key: Invalid handle (%s:%u:%u)\n", OUR_HANDLE(hnd)));
429 close_policy_hnd(p, hnd);
434 /********************************************************************
435 retrieve information about the subkeys
436 *******************************************************************/
438 static BOOL get_subkey_information( Registry_Key *key, uint32 *maxnum, uint32 *maxlen )
442 char *subkeys = NULL;
449 num_subkeys = fetch_reg_keys( tdb_reg, key->name, &subkeys );
450 if ( num_subkeys == -1 )
453 /* find the longest string */
457 for ( i=0; i<num_subkeys; i++ ) {
459 max_len = MAX(max_len, len);
463 *maxnum = num_subkeys;
471 /********************************************************************
472 retrieve information about the values. We don't store values
473 here. The registry tdb is intended to be a frontend to oether
474 Samba tdb's (such as ntdrivers.tdb).
475 *******************************************************************/
477 static BOOL get_value_information( Registry_Key *key, uint32 *maxnum,
478 uint32 *maxlen, uint32 *maxsize )
483 /* Hard coded key names first */
484 /* nothing has valuies right now */
493 * FIXME!!! Need to add routines to look up values in other
501 /********************************************************************
503 ********************************************************************/
505 NTSTATUS _reg_close(pipes_struct *p, REG_Q_CLOSE *q_u, REG_R_CLOSE *r_u)
507 /* set up the REG unknown_1 response */
508 ZERO_STRUCT(r_u->pol);
510 /* close the policy handle */
511 if (!close_registry_key(p, &q_u->pol))
512 return NT_STATUS_OBJECT_NAME_INVALID;
517 /*******************************************************************
519 ********************************************************************/
521 NTSTATUS _reg_open_hklm(pipes_struct *p, REG_Q_OPEN_HKLM *q_u, REG_R_OPEN_HKLM *r_u)
523 if (!open_registry_key(p, &r_u->pol, KEY_HKLM, 0x0))
524 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
529 /*******************************************************************
531 ********************************************************************/
533 NTSTATUS _reg_open_hku(pipes_struct *p, REG_Q_OPEN_HKU *q_u, REG_R_OPEN_HKU *r_u)
535 if (!open_registry_key(p, &r_u->pol, KEY_HKU, 0x0))
536 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
541 /*******************************************************************
543 ********************************************************************/
545 NTSTATUS _reg_open_entry(pipes_struct *p, REG_Q_OPEN_ENTRY *q_u, REG_R_OPEN_ENTRY *r_u)
551 Registry_Key *key = find_regkey_index_by_hnd(p, &q_u->pol);
553 DEBUG(5,("reg_open_entry: Enter\n"));
556 return NT_STATUS_INVALID_HANDLE;
558 rpcstr_pull(name,q_u->uni_name.buffer,sizeof(name),q_u->uni_name.uni_str_len*2,0);
560 /* store the full path in the regkey_list */
562 pstrcpy( path, key->name );
563 pstrcat( path, "\\" );
564 pstrcat( path, name );
566 DEBUG(5,("reg_open_entry: %s\n", path));
568 /* do a check on the name, here */
570 if ( (num_subkeys=fetch_reg_keys_count( tdb_reg, path )) == -1 )
571 return NT_STATUS_ACCESS_DENIED;
573 if (!open_registry_key(p, &pol, path, 0x0))
574 return NT_STATUS_TOO_MANY_SECRETS;
576 init_reg_r_open_entry(r_u, &pol, NT_STATUS_OK);
578 DEBUG(5,("reg_open_entry: Exitn"));
583 /*******************************************************************
585 ********************************************************************/
587 NTSTATUS _reg_info(pipes_struct *p, REG_Q_INFO *q_u, REG_R_INFO *r_u)
589 NTSTATUS status = NT_STATUS_OK;
591 uint32 type = 0x1; /* key type: REG_SZ */
592 UNISTR2 *uni_key = NULL;
595 Registry_Key *key = find_regkey_index_by_hnd( p, &q_u->pol );
597 DEBUG(5,("_reg_info: Enter\n"));
600 return NT_STATUS_INVALID_HANDLE;
602 DEBUG(7,("_reg_info: policy key name = [%s]\n", key->name));
604 rpcstr_pull(name, q_u->uni_type.buffer, sizeof(name), q_u->uni_type.uni_str_len*2, 0);
606 DEBUG(5,("reg_info: checking subkey: %s\n", name));
608 uni_key = (UNISTR2 *)talloc_zero(p->mem_ctx, sizeof(UNISTR2));
609 buf = (BUFFER2 *)talloc_zero(p->mem_ctx, sizeof(BUFFER2));
611 if (!uni_key || !buf)
612 return NT_STATUS_NO_MEMORY;
614 if ( strequal(name, "RefusePasswordChange") ) {
616 status = NT_STATUS_NO_SUCH_FILE;
617 init_unistr2(uni_key, "", 0);
618 init_buffer2(buf, (uint8*) uni_key->buffer, uni_key->uni_str_len*2);
625 switch (lp_server_role()) {
626 case ROLE_DOMAIN_PDC:
627 case ROLE_DOMAIN_BDC:
630 case ROLE_STANDALONE:
633 case ROLE_DOMAIN_MEMBER:
638 /* This makes the server look like a member server to clients */
639 /* which tells clients that we have our own local user and */
640 /* group databases and helps with ACL support. */
642 init_unistr2(uni_key, value, strlen(value)+1);
643 init_buffer2(buf, (uint8*)uni_key->buffer, uni_key->uni_str_len*2);
646 init_reg_r_info(q_u->ptr_buf, r_u, buf, type, status);
648 DEBUG(5,("reg_open_entry: Exit\n"));
654 /*****************************************************************************
655 Implementation of REG_QUERY_KEY
656 ****************************************************************************/
658 NTSTATUS _reg_query_key(pipes_struct *p, REG_Q_QUERY_KEY *q_u, REG_R_QUERY_KEY *r_u)
660 NTSTATUS status = NT_STATUS_OK;
661 Registry_Key *regkey = find_regkey_index_by_hnd( p, &q_u->pol );
663 DEBUG(5,("_reg_query_key: Enter\n"));
666 return NT_STATUS_INVALID_HANDLE;
668 if ( !get_subkey_information( regkey, &r_u->num_subkeys, &r_u->max_subkeylen ) )
669 return NT_STATUS_ACCESS_DENIED;
671 if ( !get_value_information( regkey, &r_u->num_values, &r_u->max_valnamelen, &r_u->max_valbufsize ) )
672 return NT_STATUS_ACCESS_DENIED;
674 r_u->sec_desc = 0x00000078; /* size for key's sec_desc */
676 /* Win9x set this to 0x0 since it does not keep timestamps.
677 Doing the same here for simplicity --jerry */
679 ZERO_STRUCT(r_u->mod_time);
681 DEBUG(5,("_reg_query_key: Exit\n"));
687 /*****************************************************************************
688 Implementation of REG_UNKNOWN_1A
689 ****************************************************************************/
691 NTSTATUS _reg_unknown_1a(pipes_struct *p, REG_Q_UNKNOWN_1A *q_u, REG_R_UNKNOWN_1A *r_u)
693 NTSTATUS status = NT_STATUS_OK;
694 Registry_Key *regkey = find_regkey_index_by_hnd( p, &q_u->pol );
696 DEBUG(5,("_reg_unknown_1a: Enter\n"));
699 return NT_STATUS_INVALID_HANDLE;
701 r_u->unknown = 0x00000005; /* seems to be consistent...no idea what it means */
703 DEBUG(5,("_reg_unknown_1a: Exit\n"));
709 /*****************************************************************************
710 Implementation of REG_ENUM_KEY
711 ****************************************************************************/
713 NTSTATUS _reg_enum_key(pipes_struct *p, REG_Q_ENUM_KEY *q_u, REG_R_ENUM_KEY *r_u)
715 NTSTATUS status = NT_STATUS_OK;
716 Registry_Key *regkey = find_regkey_index_by_hnd( p, &q_u->pol );
720 DEBUG(5,("_reg_enum_key: Enter\n"));
723 return NT_STATUS_INVALID_HANDLE;
725 DEBUG(8,("_reg_enum_key: enumerating key [%s]\n", regkey->name));
727 if ( !fetch_reg_keys_specific( tdb_reg, regkey->name, subkey, q_u->key_index ) )
729 status = werror_to_ntstatus( WERR_NO_MORE_ITEMS );
733 DEBUG(10,("_reg_enum_key: retrieved subkey named [%s]\n", subkey));
735 /* subkey has the string name now */
737 init_reg_r_enum_key( r_u, subkey, q_u->unknown_1, q_u->unknown_2 );
739 DEBUG(5,("_reg_enum_key: Exit\n"));
746 /*******************************************************************
748 ********************************************************************/
750 #define SHUTDOWN_R_STRING "-r"
751 #define SHUTDOWN_F_STRING "-f"
754 NTSTATUS _reg_shutdown(pipes_struct *p, REG_Q_SHUTDOWN *q_u, REG_R_SHUTDOWN *r_u)
756 NTSTATUS status = NT_STATUS_OK;
757 pstring shutdown_script;
758 UNISTR2 unimsg = q_u->uni_msg;
766 rpcstr_pull (message, unimsg.buffer, sizeof(message), unimsg.uni_str_len*2,0);
768 alpha_strcpy (chkmsg, message, NULL, sizeof(message));
770 snprintf(timeout, sizeof(timeout), "%d", q_u->timeout);
772 snprintf(r, sizeof(r), (q_u->flags & REG_REBOOT_ON_SHUTDOWN)?SHUTDOWN_R_STRING:"");
774 snprintf(f, sizeof(f), (q_u->flags & REG_FORCE_SHUTDOWN)?SHUTDOWN_F_STRING:"");
776 pstrcpy(shutdown_script, lp_shutdown_script());
778 if(*shutdown_script) {
780 all_string_sub(shutdown_script, "%m", chkmsg, sizeof(shutdown_script));
781 all_string_sub(shutdown_script, "%t", timeout, sizeof(shutdown_script));
782 all_string_sub(shutdown_script, "%r", r, sizeof(shutdown_script));
783 all_string_sub(shutdown_script, "%f", f, sizeof(shutdown_script));
784 shutdown_ret = smbrun(shutdown_script,NULL);
785 DEBUG(3,("_reg_shutdown: Running the command `%s' gave %d\n",shutdown_script,shutdown_ret));
791 /*******************************************************************
793 ********************************************************************/
795 NTSTATUS _reg_abort_shutdown(pipes_struct *p, REG_Q_ABORT_SHUTDOWN *q_u, REG_R_ABORT_SHUTDOWN *r_u)
797 NTSTATUS status = NT_STATUS_OK;
798 pstring abort_shutdown_script;
800 pstrcpy(abort_shutdown_script, lp_abort_shutdown_script());
802 if(*abort_shutdown_script) {
803 int abort_shutdown_ret;
804 abort_shutdown_ret = smbrun(abort_shutdown_script,NULL);
805 DEBUG(3,("_reg_abort_shutdown: Running the command `%s' gave %d\n",abort_shutdown_script,abort_shutdown_ret));