Use NTSTATUS as return value for smb_register_*() functions and init_module()
[samba.git] / source / include / rpc_misc.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    
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #include "ntdomain.h"
24 #include "rpc_dce.h"
25
26 #ifndef _RPC_MISC_H /* _RPC_MISC_H */
27 #define _RPC_MISC_H 
28
29 #define SMB_RPC_INTERFACE_VERSION 1
30
31 /* well-known RIDs - Relative IDs */
32
33 /* RIDs - Well-known users ... */
34 #define DOMAIN_USER_RID_ADMIN          (0x000001F4L)
35 #define DOMAIN_USER_RID_GUEST          (0x000001F5L)
36 #define DOMAIN_USER_RID_KRBTGT         (0x000001F6L)
37
38 /* RIDs - well-known groups ... */
39 #define DOMAIN_GROUP_RID_ADMINS        (0x00000200L)
40 #define DOMAIN_GROUP_RID_USERS         (0x00000201L)
41 #define DOMAIN_GROUP_RID_GUESTS        (0x00000202L)
42 #define DOMAIN_GROUP_RID_COMPUTERS     (0x00000203L)
43
44 #define DOMAIN_GROUP_RID_CONTROLLERS   (0x00000204L)
45 #define DOMAIN_GROUP_RID_CERT_ADMINS   (0x00000205L)
46 #define DOMAIN_GROUP_RID_SCHEMA_ADMINS (0x00000206L)
47 #define DOMAIN_GROUP_RID_ENTERPRISE_ADMINS (0x00000207L)
48
49 /* is the following the right number? I bet it is  --simo
50 #define DOMAIN_GROUP_RID_POLICY_ADMINS (0x00000208L)
51 */
52
53 /* RIDs - well-known aliases ... */
54 #define BUILTIN_ALIAS_RID_ADMINS        (0x00000220L)
55 #define BUILTIN_ALIAS_RID_USERS         (0x00000221L)
56 #define BUILTIN_ALIAS_RID_GUESTS        (0x00000222L)
57 #define BUILTIN_ALIAS_RID_POWER_USERS   (0x00000223L)
58
59 #define BUILTIN_ALIAS_RID_ACCOUNT_OPS   (0x00000224L)
60 #define BUILTIN_ALIAS_RID_SYSTEM_OPS    (0x00000225L)
61 #define BUILTIN_ALIAS_RID_PRINT_OPS     (0x00000226L)
62 #define BUILTIN_ALIAS_RID_BACKUP_OPS    (0x00000227L)
63
64 #define BUILTIN_ALIAS_RID_REPLICATOR    (0x00000228L)
65 #define BUILTIN_ALIAS_RID_RAS_SERVERS   (0x00000229L)
66
67 /*
68  * Masks for mappings between unix uid and gid types and
69  * NT RIDS.
70  */
71
72
73 #define BASE_RID (0x000003E8L)
74
75 /* Take the bottom bit. */
76 #define RID_TYPE_MASK 1
77 #define RID_MULTIPLIER 2
78
79 /* The two common types. */
80 #define USER_RID_TYPE 0
81 #define GROUP_RID_TYPE 1
82
83 /* ENUM_HND */
84 typedef struct enum_hnd_info
85 {
86         uint32 ptr_hnd;          /* pointer to enumeration handle */
87         uint32 handle;           /* enumeration handle */
88
89 } ENUM_HND;
90
91 /* LOOKUP_LEVEL - switch value */
92 typedef struct lookup_level_info
93 {
94   uint16 value;
95
96 } LOOKUP_LEVEL;
97
98 /* DOM_SID2 - security id */
99 typedef struct sid_info_2
100 {
101         uint32 num_auths; /* length, bytes, including length of len :-) */
102
103         DOM_SID sid;
104
105 } DOM_SID2;
106
107 /* STRHDR - string header */
108 typedef struct header_info
109 {
110   uint16 str_str_len;
111   uint16 str_max_len;
112   uint32 buffer; /* non-zero */
113
114 } STRHDR;
115
116 /* UNIHDR - unicode string header */
117 typedef struct unihdr_info
118 {
119   uint16 uni_str_len;
120   uint16 uni_max_len;
121   uint32 buffer; /* usually has a value of 4 */
122
123 } UNIHDR;
124
125 /* UNIHDR2 - unicode string header and undocumented buffer */
126 typedef struct unihdr2_info
127 {
128   UNIHDR unihdr;
129   uint32 buffer; /* 32 bit buffer pointer */
130
131 } UNIHDR2;
132
133 /* clueless as to what maximum length should be */
134 #define MAX_UNISTRLEN 256
135 #define MAX_STRINGLEN 256
136 #define MAX_BUFFERLEN 512
137
138 /* UNISTR - unicode string size and buffer */
139 typedef struct unistr_info
140 {
141   /* unicode characters. ***MUST*** be little-endian. ***MUST*** be null-terminated */
142   uint16 *buffer;
143 } UNISTR;
144
145 /* BUFHDR - buffer header */
146 typedef struct bufhdr_info
147 {
148   uint32 buf_max_len;
149   uint32 buf_len;
150
151 } BUFHDR;
152
153 /* BUFFER2 - unicode string, size (in uint8 ascii chars) and buffer */
154 /* pathetic.  some stupid team of \PIPE\winreg writers got the concept */
155 /* of a unicode string different from the other \PIPE\ writers */
156 typedef struct buffer2_info
157 {
158   uint32 buf_max_len;
159   uint32 undoc;
160   uint32 buf_len;
161   /* unicode characters. ***MUST*** be little-endian. **NOT** necessarily null-terminated */
162   uint16 *buffer;
163
164 } BUFFER2;
165
166 /* BUFFER3 */
167 typedef struct buffer3_info
168 {
169   uint32 buf_max_len;
170   uint8  *buffer; /* Data */
171   uint32 buf_len;
172
173 } BUFFER3;
174
175 /* BUFFER5 */
176 typedef struct buffer5_info
177 {
178   uint32 buf_len;
179   uint16 *buffer; /* data */
180 } BUFFER5;
181
182 /* UNISTR2 - unicode string size (in uint16 unicode chars) and buffer */
183 typedef struct unistr2_info
184 {
185   uint32 uni_max_len;
186   uint32 undoc;
187   uint32 uni_str_len;
188   /* unicode characters. ***MUST*** be little-endian. 
189      **must** be null-terminated and the uni_str_len should include
190      the NULL character */
191   uint16 *buffer;
192
193 } UNISTR2;
194
195 /* STRING2 - string size (in uint8 chars) and buffer */
196 typedef struct string2_info
197 {
198   uint32 str_max_len;
199   uint32 undoc;
200   uint32 str_str_len;
201   uint8  *buffer; /* uint8 characters. **NOT** necessarily null-terminated */
202
203 } STRING2;
204
205 /* UNISTR3 - XXXX not sure about this structure */
206 typedef struct unistr3_info
207 {
208         uint32 uni_str_len;
209         UNISTR str;
210
211 } UNISTR3;
212
213 /* an element in a unicode string array */
214 typedef struct
215 {
216         uint16 length;
217         uint16 size;
218         uint32 ref_id;
219         UNISTR2 string;
220 } UNISTR2_ARRAY_EL;
221
222 /* an array of unicode strings */
223 typedef struct 
224 {
225         uint32 ref_id;
226         uint32 count;
227         UNISTR2_ARRAY_EL *strings;
228 } UNISTR2_ARRAY;
229
230
231 /* an element in a sid array */
232 typedef struct
233 {
234         uint32 ref_id;
235         DOM_SID2 sid;
236 } SID_ARRAY_EL;
237
238 /* an array of sids */
239 typedef struct 
240 {
241         uint32 ref_id;
242         uint32 count;
243         SID_ARRAY_EL *sids;
244 } SID_ARRAY;
245
246 /* DOM_RID2 - domain RID structure for ntlsa pipe */
247 typedef struct domrid2_info
248 {
249         uint8 type; /* value is SID_NAME_USE enum */
250         uint32 rid;
251         uint32 rid_idx; /* referenced domain index */
252
253 } DOM_RID2;
254
255 /* DOM_RID3 - domain RID structure for samr pipe */
256 typedef struct domrid3_info
257 {
258         uint32 rid;        /* domain-relative (to a SID) id */
259         uint32 type1;      /* value is 0x1 */
260         uint32 ptr_type;   /* undocumented pointer */
261         uint32 type2;      /* value is 0x1 */
262         uint32 unk; /* value is 0x2 */
263
264 } DOM_RID3;
265
266 /* DOM_RID4 - rid + user attributes */
267 typedef struct domrid4_info
268 {
269   uint32 unknown;
270   uint16 attr;
271   uint32 rid;  /* user RID */
272
273 } DOM_RID4;
274
275 /* DOM_CLNT_SRV - client / server names */
276 typedef struct clnt_srv_info
277 {
278   uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
279   UNISTR2 uni_logon_srv; /* logon server name */
280   uint32  undoc_buffer2; /* undocumented 32 bit buffer pointer */
281   UNISTR2 uni_comp_name; /* client machine name */
282
283 } DOM_CLNT_SRV;
284
285 /* DOM_LOG_INFO - login info */
286 typedef struct log_info
287 {
288   uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
289   UNISTR2 uni_logon_srv; /* logon server name */
290   UNISTR2 uni_acct_name; /* account name */
291   uint16  sec_chan;      /* secure channel type */
292   UNISTR2 uni_comp_name; /* client machine name */
293
294 } DOM_LOG_INFO;
295
296 /* DOM_CHAL - challenge info */
297 typedef struct chal_info
298 {
299     uchar data[8]; /* credentials */
300 } DOM_CHAL;
301  
302 /* DOM_CREDs - timestamped client or server credentials */
303 typedef struct cred_info
304 {
305     DOM_CHAL challenge; /* credentials */
306     UTIME timestamp;    /* credential time-stamp */
307 } DOM_CRED;
308
309 /* DOM_CLNT_INFO - client info */
310 typedef struct clnt_info
311 {
312   DOM_LOG_INFO login;
313   DOM_CRED     cred;
314
315 } DOM_CLNT_INFO;
316
317 /* DOM_CLNT_INFO2 - client info */
318 typedef struct clnt_info2
319 {
320   DOM_CLNT_SRV login;
321   uint32        ptr_cred;
322   DOM_CRED      cred;
323
324 } DOM_CLNT_INFO2;
325
326 /* DOM_LOGON_ID - logon id */
327 typedef struct logon_info
328 {
329   uint32 low;
330   uint32 high;
331
332 } DOM_LOGON_ID;
333
334 /* OWF INFO */
335 typedef struct owf_info
336 {
337   uint8 data[16];
338
339 } OWF_INFO;
340
341
342 /* DOM_GID - group id + user attributes */
343 typedef struct gid_info
344 {
345   uint32 g_rid;  /* a group RID */
346   uint32 attr;
347
348 } DOM_GID;
349
350 /* POLICY_HND */
351 typedef struct lsa_policy_info
352 {
353         uint32 data1;
354         uint32 data2;
355         uint16 data3;
356         uint16 data4;
357         uint8 data5[8];
358
359 #ifdef __INSURE__
360
361         /* To prevent the leakage of policy handles mallocate a bit of
362            memory when a policy handle is created and free it when the
363            handle is closed.  This should cause Insure to flag an error
364            when policy handles are overwritten or fall out of scope without
365            being freed. */
366
367         char *marker;
368 #endif
369
370 } POLICY_HND;
371
372 /*
373  * A client connection's state, pipe name, 
374  * user credentials, etc...
375  */
376 typedef struct _cli_auth_fns cli_auth_fns;
377 struct user_creds;
378 struct cli_connection {
379
380         char                    *srv_name;
381         char                    *pipe_name;
382         struct user_creds       usr_creds;
383
384         struct cli_state        *pCli_state;
385
386         cli_auth_fns            *auth;
387
388         void                    *auth_info;
389         void                    *auth_creds;
390 };
391
392
393 /* 
394  * Associate a POLICY_HND with a cli_connection
395  */
396 typedef struct rpc_hnd_node {
397
398         POLICY_HND              hnd;
399         struct cli_connection   *cli;
400
401 } RPC_HND_NODE;
402
403 typedef struct uint64_s
404 {
405         uint32 low;
406         uint32 high;
407 } UINT64_S;
408
409 /* BUFHDR2 - another buffer header, with info level */
410 typedef struct bufhdr2_info
411 {
412         uint32 info_level;
413         uint32 length;          /* uint8 chars */
414         uint32 buffer;
415
416 }
417 BUFHDR2;
418
419 /* BUFFER4 - simple length and buffer */
420 typedef struct buffer4_info
421 {
422         uint32 buf_len;
423         uint8 buffer[MAX_BUFFERLEN];
424
425 }
426 BUFFER4;
427
428
429 #endif /* _RPC_MISC_H */