* small formatting fixes
[Samba.git] / source / include / rpc_misc.h
blobe47853c2a22a905fee9159ca6b8164b06c6a54a7
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
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.
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.
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.
23 #include "ntdomain.h"
24 #include "rpc_dce.h"
26 #ifndef _RPC_MISC_H /* _RPC_MISC_H */
27 #define _RPC_MISC_H
31 /* well-known RIDs - Relative IDs */
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)
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)
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)
49 /* is the following the right number? I bet it is --simo
50 #define DOMAIN_GROUP_RID_POLICY_ADMINS (0x00000208L)
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)
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)
64 #define BUILTIN_ALIAS_RID_REPLICATOR (0x00000228L)
65 #define BUILTIN_ALIAS_RID_RAS_SERVERS (0x00000229L)
68 * Masks for mappings between unix uid and gid types and
69 * NT RIDS.
73 #define BASE_RID (0x000003E8L)
75 /* Take the bottom bit. */
76 #define RID_TYPE_MASK 1
77 #define RID_MULTIPLIER 2
79 /* The two common types. */
80 #define USER_RID_TYPE 0
81 #define GROUP_RID_TYPE 1
83 /* ENUM_HND */
84 typedef struct enum_hnd_info
86 uint32 ptr_hnd; /* pointer to enumeration handle */
87 uint32 handle; /* enumeration handle */
89 } ENUM_HND;
91 /* LOOKUP_LEVEL - switch value */
92 typedef struct lookup_level_info
94 uint16 value;
96 } LOOKUP_LEVEL;
98 /* DOM_SID2 - security id */
99 typedef struct sid_info_2
101 uint32 num_auths; /* length, bytes, including length of len :-) */
103 DOM_SID sid;
105 } DOM_SID2;
107 /* STRHDR - string header */
108 typedef struct header_info
110 uint16 str_str_len;
111 uint16 str_max_len;
112 uint32 buffer; /* non-zero */
114 } STRHDR;
116 /* UNIHDR - unicode string header */
117 typedef struct unihdr_info
119 uint16 uni_str_len;
120 uint16 uni_max_len;
121 uint32 buffer; /* usually has a value of 4 */
123 } UNIHDR;
125 /* UNIHDR2 - unicode string header and undocumented buffer */
126 typedef struct unihdr2_info
128 UNIHDR unihdr;
129 uint32 buffer; /* 32 bit buffer pointer */
131 } UNIHDR2;
133 /* clueless as to what maximum length should be */
134 #define MAX_UNISTRLEN 256
135 #define MAX_STRINGLEN 256
136 #define MAX_BUFFERLEN 512
138 /* UNISTR - unicode string size and buffer */
139 typedef struct unistr_info
141 /* unicode characters. ***MUST*** be little-endian. ***MUST*** be null-terminated */
142 uint16 *buffer;
143 } UNISTR;
145 /* BUFHDR - buffer header */
146 typedef struct bufhdr_info
148 uint32 buf_max_len;
149 uint32 buf_len;
151 } BUFHDR;
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
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;
164 } BUFFER2;
166 /* BUFFER3 */
167 typedef struct buffer3_info
169 uint32 buf_max_len;
170 uint8 *buffer; /* Data */
171 uint32 buf_len;
173 } BUFFER3;
175 /* BUFFER5 */
176 typedef struct buffer5_info
178 uint32 buf_len;
179 uint16 *buffer; /* data */
180 } BUFFER5;
182 /* UNISTR2 - unicode string size (in uint16 unicode chars) and buffer */
183 typedef struct unistr2_info
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;
193 } UNISTR2;
195 /* STRING2 - string size (in uint8 chars) and buffer */
196 typedef struct string2_info
198 uint32 str_max_len;
199 uint32 undoc;
200 uint32 str_str_len;
201 uint8 *buffer; /* uint8 characters. **NOT** necessarily null-terminated */
203 } STRING2;
205 /* UNISTR3 - XXXX not sure about this structure */
206 typedef struct unistr3_info
208 uint32 uni_str_len;
209 UNISTR str;
211 } UNISTR3;
214 /* DOM_RID2 - domain RID structure for ntlsa pipe */
215 typedef struct domrid2_info
217 uint8 type; /* value is SID_NAME_USE enum */
218 uint32 rid;
219 uint32 rid_idx; /* referenced domain index */
221 } DOM_RID2;
223 /* DOM_RID3 - domain RID structure for samr pipe */
224 typedef struct domrid3_info
226 uint32 rid; /* domain-relative (to a SID) id */
227 uint32 type1; /* value is 0x1 */
228 uint32 ptr_type; /* undocumented pointer */
229 uint32 type2; /* value is 0x1 */
230 uint32 unk; /* value is 0x2 */
232 } DOM_RID3;
234 /* DOM_RID4 - rid + user attributes */
235 typedef struct domrid4_info
237 uint32 unknown;
238 uint16 attr;
239 uint32 rid; /* user RID */
241 } DOM_RID4;
243 /* DOM_CLNT_SRV - client / server names */
244 typedef struct clnt_srv_info
246 uint32 undoc_buffer; /* undocumented 32 bit buffer pointer */
247 UNISTR2 uni_logon_srv; /* logon server name */
248 uint32 undoc_buffer2; /* undocumented 32 bit buffer pointer */
249 UNISTR2 uni_comp_name; /* client machine name */
251 } DOM_CLNT_SRV;
253 /* DOM_LOG_INFO - login info */
254 typedef struct log_info
256 uint32 undoc_buffer; /* undocumented 32 bit buffer pointer */
257 UNISTR2 uni_logon_srv; /* logon server name */
258 UNISTR2 uni_acct_name; /* account name */
259 uint16 sec_chan; /* secure channel type */
260 UNISTR2 uni_comp_name; /* client machine name */
262 } DOM_LOG_INFO;
264 /* DOM_CHAL - challenge info */
265 typedef struct chal_info
267 uchar data[8]; /* credentials */
268 } DOM_CHAL;
270 /* DOM_CREDs - timestamped client or server credentials */
271 typedef struct cred_info
273 DOM_CHAL challenge; /* credentials */
274 UTIME timestamp; /* credential time-stamp */
275 } DOM_CRED;
277 /* DOM_CLNT_INFO - client info */
278 typedef struct clnt_info
280 DOM_LOG_INFO login;
281 DOM_CRED cred;
283 } DOM_CLNT_INFO;
285 /* DOM_CLNT_INFO2 - client info */
286 typedef struct clnt_info2
288 DOM_CLNT_SRV login;
289 uint32 ptr_cred;
290 DOM_CRED cred;
292 } DOM_CLNT_INFO2;
294 /* DOM_LOGON_ID - logon id */
295 typedef struct logon_info
297 uint32 low;
298 uint32 high;
300 } DOM_LOGON_ID;
302 /* OWF INFO */
303 typedef struct owf_info
305 uint8 data[16];
307 } OWF_INFO;
310 /* DOM_GID - group id + user attributes */
311 typedef struct gid_info
313 uint32 g_rid; /* a group RID */
314 uint32 attr;
316 } DOM_GID;
318 /* POLICY_HND */
319 typedef struct lsa_policy_info
321 uint32 data1;
322 uint32 data2;
323 uint16 data3;
324 uint16 data4;
325 uint8 data5[8];
327 #ifdef __INSURE__
329 /* To prevent the leakage of policy handles mallocate a bit of
330 memory when a policy handle is created and free it when the
331 handle is closed. This should cause Insure to flag an error
332 when policy handles are overwritten or fall out of scope without
333 being freed. */
335 char *marker;
336 #endif
338 } POLICY_HND;
341 * A client connection's state, pipe name,
342 * user credentials, etc...
344 typedef struct _cli_auth_fns cli_auth_fns;
345 struct user_creds;
346 struct cli_connection {
348 char *srv_name;
349 char *pipe_name;
350 struct user_creds usr_creds;
352 struct cli_state *pCli_state;
354 cli_auth_fns *auth;
356 void *auth_info;
357 void *auth_creds;
362 * Associate a POLICY_HND with a cli_connection
364 typedef struct rpc_hnd_node {
366 POLICY_HND hnd;
367 struct cli_connection *cli;
369 } RPC_HND_NODE;
371 typedef struct uint64_s
373 uint32 low;
374 uint32 high;
375 } UINT64_S;
377 /* BUFHDR2 - another buffer header, with info level */
378 typedef struct bufhdr2_info
380 uint32 info_level;
381 uint32 length; /* uint8 chars */
382 uint32 buffer;
385 BUFHDR2;
387 /* BUFFER4 - simple length and buffer */
388 typedef struct buffer4_info
390 uint32 buf_len;
391 uint8 buffer[MAX_BUFFERLEN];
394 BUFFER4;
397 #endif /* _RPC_MISC_H */