r7908: * change REGISTRY_HOOK api to use const (fix compiler warning
[tprouty/samba.git] / source / include / rpc_reg.h
1 /* 
2    Unix SMB/CIFS implementation.
3    SMB parameters and setup
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) Jeremy Cooper                        2004.
8    Copyright (C) Gerald Carter                   2002-2005.
9    
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 2 of the License, or
13    (at your option) any later version.
14    
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19    
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 */
24
25 #ifndef _RPC_REG_H /* _RPC_REG_H */
26 #define _RPC_REG_H 
27
28 #include "reg_objects.h"
29
30 /* RPC opnum */
31
32 #define REG_OPEN_HKCR           0x00
33 #define REG_OPEN_HKLM           0x02
34 #define REG_OPEN_HKPD           0x03
35 #define REG_OPEN_HKU            0x04
36 #define REG_CLOSE               0x05
37 #define REG_CREATE_KEY          0x06
38 #define REG_DELETE_KEY          0x07
39 #define REG_DELETE_VALUE        0x08
40 #define REG_ENUM_KEY            0x09
41 #define REG_ENUM_VALUE          0x0a
42 #define REG_FLUSH_KEY           0x0b
43 #define REG_GET_KEY_SEC         0x0c
44 #define REG_OPEN_ENTRY          0x0f
45 #define REG_QUERY_KEY           0x10
46 #define REG_QUERY_VALUE         0x11
47 #define REG_RESTORE_KEY         0x13
48 #define REG_SAVE_KEY            0x14
49 #define REG_SET_KEY_SEC         0x15
50 #define REG_SET_VALUE           0x16
51 #define REG_SHUTDOWN            0x18
52 #define REG_ABORT_SHUTDOWN      0x19
53 #define REG_GETVERSION          0x1a
54 #define REG_SHUTDOWN_EX         0x1e
55
56
57 #define HKEY_CLASSES_ROOT       0x80000000
58 #define HKEY_CURRENT_USER       0x80000001
59 #define HKEY_LOCAL_MACHINE      0x80000002
60 #define HKEY_USERS              0x80000003
61 #define HKEY_PERFORMANCE_DATA   0x80000004
62
63 #define KEY_HKLM                "HKLM"
64 #define KEY_HKU                 "HKU"
65 #define KEY_HKCR                "HKCR"
66 #define KEY_PRINTING            "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print"
67 #define KEY_PRINTING_2K         "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Print"
68 #define KEY_PRINTING_PORTS      "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Ports"
69 #define KEY_EVENTLOG            "HKLM\\SYSTEM\\CurrentControlSet\\Services\\Eventlog"
70 #define KEY_SHARES              "HKLM\\SYSTEM\\CurrentControlSet\\Services\\LanmanServer\\Shares"
71 #define KEY_TREE_ROOT           ""
72
73 /* Registry data types */
74
75 #define REG_NONE                       0
76 #define REG_SZ                         1
77 #define REG_EXPAND_SZ                  2
78 #define REG_BINARY                     3
79 #define REG_DWORD                      4
80 #define REG_DWORD_LE                   4        /* DWORD, little endian */
81 #define REG_DWORD_BE                   5        /* DWORD, big endian */
82 #define REG_LINK                       6
83 #define REG_MULTI_SZ                   7
84 #define REG_RESOURCE_LIST              8
85 #define REG_FULL_RESOURCE_DESCRIPTOR   9
86 #define REG_RESOURCE_REQUIREMENTS_LIST 10
87
88 /* 
89  * container for function pointers to enumeration routines
90  * for vitural registry view 
91  */ 
92  
93 typedef struct {
94         /* functions for enumerating subkeys and values */      
95         int     (*fetch_subkeys)( const char *key, REGSUBKEY_CTR *subkeys);
96         int     (*fetch_values) ( const char *key, REGVAL_CTR *val );
97         BOOL    (*store_subkeys)( const char *key, REGSUBKEY_CTR *subkeys );
98         BOOL    (*store_values)( const char *key, REGVAL_CTR *val );
99         BOOL    (*reg_access_check)( const char *keyname, uint32 requested, uint32 *granted, NT_USER_TOKEN *token );
100 } REGISTRY_OPS;
101
102 typedef struct {
103         const char      *keyname;       /* full path to name of key */
104         REGISTRY_OPS    *ops;           /* registry function hooks */
105 } REGISTRY_HOOK;
106
107
108 /* structure to store the registry handles */
109
110 typedef struct _RegistryKey {
111         struct _RegistryKey *prev, *next;
112
113         pstring         name;           /* full name of registry key */
114         uint32          access_granted;
115         REGISTRY_HOOK   *hook;  
116 } REGISTRY_KEY;
117
118 /*
119  * RPC REGISTRY STRUCTURES
120  */
121
122 /***********************************************/
123
124 typedef struct {
125         uint16 *server;
126         uint32 access;     
127 } REG_Q_OPEN_HIVE;
128
129 typedef struct {
130         POLICY_HND pol;
131         WERROR status; 
132 } REG_R_OPEN_HIVE;
133
134
135 /***********************************************/
136
137 typedef struct {
138         POLICY_HND pol;
139 } REG_Q_FLUSH_KEY;
140
141 typedef struct {
142         WERROR status; 
143 } REG_R_FLUSH_KEY;
144
145
146 /***********************************************/
147
148 typedef struct {
149         POLICY_HND handle;
150         uint32 sec_info;
151         uint32 ptr; 
152         BUFHDR hdr_sec;
153         SEC_DESC_BUF *data;
154 } REG_Q_SET_KEY_SEC;
155
156 typedef struct {
157         WERROR status;
158 } REG_R_SET_KEY_SEC;
159
160
161 /***********************************************/
162
163 typedef struct {
164         POLICY_HND handle;
165         uint32 sec_info;
166         uint32 ptr; 
167         BUFHDR hdr_sec; 
168         SEC_DESC_BUF *data; 
169 } REG_Q_GET_KEY_SEC;
170
171 typedef struct {
172         uint32 sec_info; 
173         uint32 ptr; 
174         BUFHDR hdr_sec; 
175         SEC_DESC_BUF *data;
176         WERROR status;
177 } REG_R_GET_KEY_SEC;
178
179 /***********************************************/
180
181 typedef struct {
182         POLICY_HND handle;   
183         UNISTR4 name;           
184         uint32 type;  
185         RPC_DATA_BLOB value; 
186         uint32 size;
187 } REG_Q_SET_VALUE;
188
189 typedef struct { 
190         WERROR status;
191 } REG_R_SET_VALUE;
192
193 /***********************************************/
194
195 typedef struct {
196         POLICY_HND pol;
197         uint32 val_index;
198         UNISTR4 name;
199         uint32 *type;  
200         REGVAL_BUFFER *value; /* value, in byte buffer */
201         uint32 *buffer_len; 
202         uint32 *name_len; 
203 } REG_Q_ENUM_VALUE;
204
205 typedef struct { 
206         UNISTR4 name;
207         uint32 *type;
208         REGVAL_BUFFER *value;
209         uint32 *buffer_len1;
210         uint32 *buffer_len2;
211         WERROR status;
212 } REG_R_ENUM_VALUE;
213
214 /***********************************************/
215
216 typedef struct {
217         POLICY_HND handle;
218         UNISTR4 name;
219         UNISTR4 key_class;
220         uint32 reserved;
221         uint32 access;
222         uint32 *sec_info;
223         uint32 ptr2;
224         BUFHDR hdr_sec;
225         uint32 ptr3;
226         SEC_DESC_BUF *data;
227         uint32 unknown_2; /* 0x0000 0000 */
228 } REG_Q_CREATE_KEY;
229
230 typedef struct {
231         POLICY_HND handle;
232         uint32 unknown;
233         WERROR status; 
234 } REG_R_CREATE_KEY;
235
236 /***********************************************/
237
238 typedef struct {
239         POLICY_HND handle;
240         UNISTR4 name;
241 } REG_Q_DELETE_KEY;
242
243 typedef struct {
244         WERROR status; 
245 } REG_R_DELETE_KEY;
246
247 /***********************************************/
248
249 typedef struct {
250         POLICY_HND handle;
251         UNISTR4 name;
252 } REG_Q_DELETE_VALUE;
253
254 typedef struct {
255         WERROR status;
256 } REG_R_DELETE_VALUE;
257
258 /***********************************************/
259
260 typedef struct {
261         POLICY_HND pol;
262         UNISTR4 key_class;
263 } REG_Q_QUERY_KEY;
264
265 typedef struct {
266         UNISTR4 key_class;
267         uint32 num_subkeys;
268         uint32 max_subkeylen;
269         uint32 reserved;        /* 0x0000 0000 - according to MSDN (max_subkeysize?) */
270         uint32 num_values;
271         uint32 max_valnamelen;
272         uint32 max_valbufsize; 
273         uint32 sec_desc;        /* 0x0000 0078 */
274         NTTIME mod_time;        /* modified time */
275         WERROR status;         
276 } REG_R_QUERY_KEY;
277
278
279 /***********************************************/
280
281 typedef struct {
282         POLICY_HND pol;
283 } REG_Q_GETVERSION;
284
285 typedef struct {
286         uint32 win_version;
287         WERROR status;
288 } REG_R_GETVERSION;
289
290
291 /***********************************************/
292
293 typedef struct {
294         POLICY_HND pol; 
295         UNISTR4 filename;
296         uint32 flags;
297 } REG_Q_RESTORE_KEY;
298
299 typedef struct {
300         WERROR status;         /* return status */
301 } REG_R_RESTORE_KEY;
302
303
304 /***********************************************/
305
306
307 /* I have no idea if this is correct since I 
308    have not seen the full structure on the wire 
309    as of yet */
310    
311 typedef struct {
312         uint32 max_len;
313         uint32 len;
314         SEC_DESC *secdesc;
315 } REG_SEC_DESC_BUF;
316
317 typedef struct {
318         uint32 size;            /* size in bytes of security descriptor */
319         REG_SEC_DESC_BUF secdesc;
320         uint8  inherit;         /* see MSDN for a description */
321 } SECURITY_ATTRIBUTE;
322
323 typedef struct {
324         POLICY_HND pol; 
325         UNISTR4 filename;
326         SECURITY_ATTRIBUTE *sec_attr;
327 } REG_Q_SAVE_KEY;
328
329 typedef struct {
330         WERROR status;         /* return status */
331 } REG_R_SAVE_KEY;
332
333
334 /***********************************************/
335
336 typedef struct {
337         POLICY_HND pol; /* policy handle */
338 } REG_Q_CLOSE;
339
340 typedef struct {
341         POLICY_HND pol; 
342         WERROR status; 
343 } REG_R_CLOSE;
344
345
346 /***********************************************/
347
348 typedef struct {
349         POLICY_HND pol; 
350         uint32 key_index;       
351         uint16 key_name_len;   
352         uint16 unknown_1;       /* 0x0414 */
353         uint32 ptr1;          
354         uint32 unknown_2;       /* 0x0000 020A */
355         uint8  pad1[8];        
356         uint32 ptr2;           
357         uint8  pad2[8];        
358         uint32 ptr3;           
359         NTTIME time;           
360 } REG_Q_ENUM_KEY;
361
362 typedef struct { 
363         UNISTR4 keyname;
364         UNISTR4 *classname;
365         NTTIME *time;            
366         WERROR status;         /* return status */
367 } REG_R_ENUM_KEY;
368
369
370 /***********************************************/
371
372 typedef struct {
373         POLICY_HND pol;         /* policy handle */
374         UNISTR4  name;
375
376         uint32 ptr_reserved;    /* pointer */
377   
378         uint32 ptr_buf;         /* the next three fields follow if ptr_buf != 0 */
379         uint32 ptr_bufsize;
380         uint32 bufsize;
381         uint32 buf_unk;
382
383         uint32 unk1;
384         uint32 ptr_buflen;
385         uint32 buflen;
386   
387         uint32 ptr_buflen2;
388         uint32 buflen2;
389
390 } REG_Q_QUERY_VALUE;
391
392 typedef struct { 
393         uint32 *type;
394         REGVAL_BUFFER *value;   /* key value */
395         uint32 *buf_max_len;
396         uint32 *buf_len;
397         WERROR status;  /* return status */
398 } REG_R_QUERY_VALUE;
399
400
401 /***********************************************/
402
403 typedef struct {
404         POLICY_HND pol;
405         UNISTR4 name; 
406         uint32 unknown_0;       /* 32 bit unknown - 0x0000 0000 */
407         uint32 access; 
408 } REG_Q_OPEN_ENTRY;
409
410 typedef struct {
411         POLICY_HND handle;
412         WERROR status;
413 } REG_R_OPEN_ENTRY;
414
415 /***********************************************/
416  
417 typedef struct {
418         uint16 *server;
419         UNISTR4 *message;       
420         uint32 timeout;         /* in seconds */
421         uint8 force;            /* boolean: force shutdown */
422         uint8 reboot;           /* boolean: reboot on shutdown */               
423 } REG_Q_SHUTDOWN;
424
425 typedef struct {
426         WERROR status;          /* return status */
427 } REG_R_SHUTDOWN;
428
429 /***********************************************/
430  
431 typedef struct {
432         uint16 *server;
433         UNISTR4 *message;       
434         uint32 timeout;         /* in seconds */
435         uint8 force;            /* boolean: force shutdown */
436         uint8 reboot;           /* boolean: reboot on shutdown */
437         uint32 reason;          /* reason - must be defined code */
438 } REG_Q_SHUTDOWN_EX;
439
440 typedef struct {
441         WERROR status;
442 } REG_R_SHUTDOWN_EX;
443
444 /***********************************************/
445
446 typedef struct {
447         uint16 *server;
448 } REG_Q_ABORT_SHUTDOWN;
449
450 typedef struct { 
451         WERROR status; 
452 } REG_R_ABORT_SHUTDOWN;
453
454
455 #endif /* _RPC_REG_H */
456