r23784: use the GPLv3 boilerplate as recommended by the FSF and the license text
[tprouty/samba.git] / source / include / rpc_misc.h
1 /* 
2    Unix SMB/CIFS implementation.
3
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) Gerald (Jerry) Carter          2005
8    
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13    
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 */
22
23 #ifndef _RPC_MISC_H /* _RPC_MISC_H */
24 #define _RPC_MISC_H 
25
26 #define SMB_RPC_INTERFACE_VERSION 1
27 #define PRS_POINTER_CAST BOOL (*)(const char*, prs_struct*, int, void*)
28
29 enum unistr2_term_codes { UNI_FLAGS_NONE = 0, UNI_STR_TERMINATE = 1, UNI_MAXLEN_TERMINATE = 2, UNI_BROKEN_NON_NULL = 3, UNI_STR_DBLTERMINATE = 4 };
30
31
32
33 /********************************************************************** 
34  * well-known RIDs - Relative IDs
35  **********************************************************************/
36
37 /* RIDs - Well-known users ... */
38 #define DOMAIN_USER_RID_ADMIN          (0x000001F4L)
39 #define DOMAIN_USER_RID_GUEST          (0x000001F5L)
40 #define DOMAIN_USER_RID_KRBTGT         (0x000001F6L)
41
42 /* RIDs - well-known groups ... */
43 #define DOMAIN_GROUP_RID_ADMINS        (0x00000200L)
44 #define DOMAIN_GROUP_RID_USERS         (0x00000201L)
45 #define DOMAIN_GROUP_RID_GUESTS        (0x00000202L)
46 #define DOMAIN_GROUP_RID_COMPUTERS     (0x00000203L)
47
48 #define DOMAIN_GROUP_RID_CONTROLLERS   (0x00000204L)
49 #define DOMAIN_GROUP_RID_CERT_ADMINS   (0x00000205L)
50 #define DOMAIN_GROUP_RID_SCHEMA_ADMINS (0x00000206L)
51 #define DOMAIN_GROUP_RID_ENTERPRISE_ADMINS (0x00000207L)
52
53 /* is the following the right number? I bet it is  --simo
54 #define DOMAIN_GROUP_RID_POLICY_ADMINS (0x00000208L)
55 */
56
57 /* RIDs - well-known aliases ... */
58 #define BUILTIN_ALIAS_RID_ADMINS        (0x00000220L)
59 #define BUILTIN_ALIAS_RID_USERS         (0x00000221L)
60 #define BUILTIN_ALIAS_RID_GUESTS        (0x00000222L)
61 #define BUILTIN_ALIAS_RID_POWER_USERS   (0x00000223L)
62
63 #define BUILTIN_ALIAS_RID_ACCOUNT_OPS   (0x00000224L)
64 #define BUILTIN_ALIAS_RID_SYSTEM_OPS    (0x00000225L)
65 #define BUILTIN_ALIAS_RID_PRINT_OPS     (0x00000226L)
66 #define BUILTIN_ALIAS_RID_BACKUP_OPS    (0x00000227L)
67
68 #define BUILTIN_ALIAS_RID_REPLICATOR    (0x00000228L)
69 #define BUILTIN_ALIAS_RID_RAS_SERVERS   (0x00000229L)
70 #define BUILTIN_ALIAS_RID_PRE_2K_ACCESS (0x0000022aL)
71
72
73 /********************************************************************** 
74  * Masks for mappings between unix uid and gid types and
75  * NT RIDS.
76  **********************************************************************/
77
78 #define BASE_RID (0x000003E8L)
79
80 /* Take the bottom bit. */
81 #define RID_TYPE_MASK           1
82 #define RID_MULTIPLIER          2
83
84 /* The two common types. */
85 #define USER_RID_TYPE           0
86 #define GROUP_RID_TYPE          1
87
88
89
90 /********************************************************************** 
91  * RPC policy handle used pretty much everywhere
92  **********************************************************************/
93  
94 typedef struct policy_handle POLICY_HND;
95
96 #define OUR_HANDLE(hnd) (((hnd)==NULL) ? "NULL" :\
97         ( IVAL((hnd)->uuid.node,2) == (uint32)sys_getpid() ? "OURS" : \
98                 "OTHER")), ((unsigned int)IVAL((hnd)->uuid.node,2)),\
99                 ((unsigned int)sys_getpid() )
100
101
102 /********************************************************************** 
103  * Buffer Headers -- use by SEC_DESC_BUF in winreg and netlogon code
104  **********************************************************************/
105  
106 /* TODO: replace this with an encompassing buffer structure */
107 typedef struct {
108         uint32 buf_max_len;
109         uint32 buf_len;
110 } BUFHDR;
111
112 /* this is a BUFHDR + a pointer to a buffer */
113 typedef struct {
114         uint32 info_level;
115         uint32 length;          /* uint8 chars */
116         uint32 buffer;
117 } BUFHDR2;
118
119 /* generic buffer ?  wrapped around void*? */
120 typedef struct {
121         uint32 size;
122         uint32 buffer;
123 } BUFHDR4;
124
125
126 /********************************************************************** 
127  * Buffers 
128  **********************************************************************/
129
130 /* buffer used by \winreg\ calls to fill in arbitrary REG_XXX values.
131    It *may* look like a UNISTR2 but it is *not*.  This is not a goof
132    by the winreg developers.  It is a generic buffer.  buffer length
133    is stored in bytes (not # of uint16's) */
134
135 typedef struct {
136         uint32 buf_max_len;
137         uint32 offset;
138         uint32 buf_len;
139         uint16 *buffer;
140 } REGVAL_BUFFER;
141
142 /* generic rpc version of the DATA_BLOB.  Just a length and uint8 array */
143
144 typedef struct {
145         uint32 buf_len;
146         uint8 *buffer;
147 } RPC_DATA_BLOB;
148
149 /********************************************************************** 
150  * Buffers use by spoolss (i might be able to replace it with
151  * an RPC_DATA_BLOB)
152  **********************************************************************/
153
154 typedef struct {
155         uint32 buf_len;
156         uint16 *buffer; /* data */
157 } BUFFER5;
158
159
160 /********************************************************************** 
161  * Unicode and basic string headers 
162  **********************************************************************/
163  
164 typedef struct {
165         uint16 str_str_len;
166         uint16 str_max_len;
167         uint32 buffer; /* non-zero */
168 } STRHDR;
169
170 typedef struct {
171         uint16 uni_str_len;
172         uint16 uni_max_len;
173         uint32 buffer; 
174 } UNIHDR;
175
176 /********************************************************************** 
177  * UNICODE string variations
178  **********************************************************************/
179
180
181 typedef struct {                /* UNISTR - unicode string size and buffer */
182         uint16 *buffer;         /* unicode characters. ***MUST*** be 
183                                    little-endian. ***MUST*** be null-terminated */
184 } UNISTR;
185
186 typedef struct {                /* UNISTR2 - unicode string size (in 
187                                    uint16 unicode chars) and buffer */
188         uint32 uni_max_len;
189         uint32 offset;
190         uint32 uni_str_len;
191         uint16 *buffer;         /* unicode characters. ***MUST*** be little-endian. 
192                                   **must** be null-terminated and the uni_str_len 
193                                   should include the NULL character */
194 } UNISTR2;
195
196 /* i think this is the same as a BUFFER5 used in the spoolss code --jerry */
197 /* not sure about how the termination matches between the uint16 buffers thought */
198
199 typedef struct {                /* UNISTR3 - XXXX not sure about this structure */
200         uint32 uni_str_len;
201         UNISTR str;
202 } UNISTR3;
203
204 typedef struct {                /* Buffer wrapped around a UNISTR2 */
205         uint16 length;          /* number of bytes not counting NULL terminatation */
206         uint16 size;            /* number of bytes including NULL terminatation */
207         UNISTR2 *string;
208 } UNISTR4;
209
210 typedef struct {
211         uint32 count;
212         UNISTR4 *strings;
213 } UNISTR4_ARRAY;
214
215
216 /********************************************************************** 
217  * String variations
218  **********************************************************************/
219
220 typedef struct {                /* STRING2 - string size (in uint8 chars) and buffer */
221         uint32 str_max_len;
222         uint32 offset;
223         uint32 str_str_len;
224         uint8  *buffer;         /* uint8 characters. **NOT** necessarily null-terminated */
225 } STRING2;
226
227
228
229
230 /********************************************************************** 
231  * Domain SID structures
232  **********************************************************************/
233
234 typedef struct {
235         uint32 num_auths; /* length, bytes, including length of len :-) */
236         DOM_SID sid;
237 } DOM_SID2;
238
239
240 /********************************************************************** 
241  * Domain SID structures
242  **********************************************************************/
243
244 /* DOM_RID - domain RID structure for ntlsa pipe */
245 typedef struct {
246         uint16 type; /* value is SID_NAME_USE enum */
247         uint32 rid;
248         uint32 rid_idx; /* referenced domain index */
249 } DOM_RID;
250
251 /* DOM_RID2 - second domain RID structure for ntlsa pipe */
252 typedef struct {
253         uint16 type; /* value is SID_NAME_USE enum */
254         uint32 rid;
255         uint32 rid_idx; /* referenced domain index */
256         uint32 unknown;
257 } DOM_RID2;
258
259 typedef struct {                /* DOM_RID3 - domain RID structure for samr pipe */
260         uint32 rid;        /* domain-relative (to a SID) id */
261         uint32 type1;      /* value is 0x1 */
262         uint32 ptr_type;   /* undocumented pointer */
263         uint32 type2;      /* value is 0x1 */
264         uint32 unk; /* value is 0x2 */
265 } DOM_RID3;
266
267 /* DOM_RID4 - rid + user attributes */
268 typedef struct domrid4_info
269 {
270         uint32 unknown;
271         uint16 attr;
272         uint32 rid;  /* user RID */
273 } DOM_RID4;
274
275 /* DOM_GID - group id + user attributes */
276 typedef struct {
277         uint32 g_rid;  /* a group RID */
278         uint32 attr;
279 } DOM_GID;
280
281 /********************************************************************** 
282  * ????
283  **********************************************************************/
284
285 /* DOM_CLNT_SRV - client / server names */
286 typedef struct clnt_srv_info {
287         uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
288         UNISTR2 uni_logon_srv; /* logon server name */
289         uint32  undoc_buffer2; /* undocumented 32 bit buffer pointer */
290         UNISTR2 uni_comp_name; /* client machine name */
291 } DOM_CLNT_SRV;
292
293 /* DOM_LOG_INFO - login info */
294 typedef struct log_info {
295         uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
296         UNISTR2 uni_logon_srv; /* logon server name */
297         UNISTR2 uni_acct_name; /* account name */
298         uint16  sec_chan;      /* secure channel type */
299         UNISTR2 uni_comp_name; /* client machine name */
300 } DOM_LOG_INFO;
301
302 /* DOM_CHAL - challenge info */
303 typedef struct chal_info {
304         unsigned char data[8]; /* credentials */
305 } DOM_CHAL;
306  
307 /* DOM_CREDs - timestamped client or server credentials */
308 typedef struct cred_info {
309         DOM_CHAL challenge; /* credentials */
310         UTIME timestamp;    /* credential time-stamp */
311 } DOM_CRED;
312
313 /* DOM_CLNT_INFO - client info */
314 typedef struct clnt_info {
315         DOM_LOG_INFO login;
316         DOM_CRED     cred;
317 } DOM_CLNT_INFO;
318
319 /* DOM_CLNT_INFO2 - client info */
320 typedef struct clnt_info2 {
321         DOM_CLNT_SRV login;
322         uint32        ptr_cred;
323         DOM_CRED      cred;
324 } DOM_CLNT_INFO2;
325
326 /* DOM_LOGON_ID - logon id */
327 typedef struct logon_info {
328         uint32 low;
329         uint32 high;
330 } DOM_LOGON_ID;
331
332 /* OWF INFO */
333 typedef struct owf_info {
334         uint8 data[16];
335 } OWF_INFO;
336
337
338 #endif /* _RPC_MISC_H */