bug-fixing against:
[samba.git] / source3 / include / rpc_lsa.h
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    SMB parameters and setup
5    Copyright (C) Andrew Tridgell 1992-1997
6    Copyright (C) Luke Kenneth Casson Leighton 1996-1997
7    Copyright (C) Paul Ashton 1997
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 2 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, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 */
23
24 #ifndef _RPC_LSA_H /* _RPC_LSA_H */
25 #define _RPC_LSA_H 
26
27 #include "rpc_misc.h"
28
29 enum SID_NAME_USE
30 {
31         SID_NAME_USER    = 1,
32         SID_NAME_DOM_GRP = 2, /* domain group */
33         SID_NAME_WKN_GRP = 5  /* well-known group */
34 };
35
36 /* ntlsa pipe */
37 #define LSA_CLOSE              0x00
38 #define LSA_QUERYINFOPOLICY    0x07
39 #define LSA_ENUMTRUSTDOM       0x0d
40 #define LSA_LOOKUPNAMES        0x0e
41 #define LSA_LOOKUPSIDS         0x0f
42 #define LSA_OPENPOLICY         0x06
43 #define LSA_OPENPOLICY2        0x2c
44 #define LSA_OPENSECRET         0x1C
45
46 /* XXXX these are here to get a compile! */
47 #define LSA_LOOKUPRIDS      0xFD
48
49 #define LSA_MAX_GROUPS 32
50 #define LSA_MAX_SIDS 32
51
52 /* DOM_QUERY - info class 3 and 5 LSA Query response */
53 typedef struct dom_query_info
54 {
55   uint16 uni_dom_max_len; /* domain name string length * 2 */
56   uint16 uni_dom_str_len; /* domain name string length * 2 */
57   uint32 buffer_dom_name; /* undocumented domain name string buffer pointer */
58   uint32 buffer_dom_sid; /* undocumented domain SID string buffer pointer */
59   UNISTR2 uni_domain_name; /* domain name (unicode string) */
60   DOM_SID2 dom_sid; /* domain SID */
61
62 } DOM_QUERY;
63
64 /* level 5 is same as level 3.  we hope. */
65 typedef DOM_QUERY DOM_QUERY_3;
66 typedef DOM_QUERY DOM_QUERY_5;
67
68 typedef struct seq_qos_info
69 {
70         uint32 len; /* 12 */
71         uint16 sec_imp_level; /* 0x02 - impersonation level */
72         uint8  sec_ctxt_mode; /* 0x01 - context tracking mode */
73         uint8  effective_only; /* 0x00 - effective only */
74         uint32 unknown;        /* 0x2000 0000 - not known */
75
76 } LSA_SEC_QOS;
77
78 typedef struct obj_attr_info
79 {
80         uint32 len;          /* 0x18 - length (in bytes) inc. the length field. */
81         uint32 ptr_root_dir; /* 0 - root directory (pointer) */
82         uint32 ptr_obj_name; /* 0 - object name (pointer) */
83         uint32 attributes;   /* 0 - attributes (undocumented) */
84         uint32 ptr_sec_desc; /* 0 - security descriptior (pointer) */
85         uint32 ptr_sec_qos;  /* security quality of service */
86         LSA_SEC_QOS *sec_qos;
87
88 } LSA_OBJ_ATTR;
89
90 /* LSA_Q_OPEN_POL - LSA Query Open Policy */
91 typedef struct lsa_q_open_pol_info
92 {
93         uint32 ptr;         /* undocumented buffer pointer */
94         uint16 system_name; /* 0x5c - system name */
95         LSA_OBJ_ATTR attr ; /* object attributes */
96
97         uint32 des_access; /* desired access attributes */
98
99 } LSA_Q_OPEN_POL;
100
101 /* LSA_R_OPEN_POL - response to LSA Open Policy */
102 typedef struct lsa_r_open_pol_info
103 {
104         POLICY_HND pol; /* policy handle */
105         uint32 status; /* return code */
106
107 } LSA_R_OPEN_POL;
108
109 /* LSA_Q_OPEN_POL2 - LSA Query Open Policy */
110 typedef struct lsa_q_open_pol2_info
111 {
112         uint32       ptr;             /* undocumented buffer pointer */
113         UNISTR2      uni_server_name; /* server name, starting with two '\'s */
114         LSA_OBJ_ATTR attr           ; /* object attributes */
115
116         uint32 des_access; /* desired access attributes */
117
118 } LSA_Q_OPEN_POL2;
119
120 /* LSA_R_OPEN_POL2 - response to LSA Open Policy */
121 typedef struct lsa_r_open_pol2_info
122 {
123         POLICY_HND pol; /* policy handle */
124         uint32 status; /* return code */
125
126 } LSA_R_OPEN_POL2;
127
128 /* LSA_Q_QUERY_INFO - LSA query info policy */
129 typedef struct lsa_query_info
130 {
131         POLICY_HND pol; /* policy handle */
132     uint16 info_class; /* info class */
133
134 } LSA_Q_QUERY_INFO;
135
136 /* LSA_R_QUERY_INFO - response to LSA query info policy */
137 typedef struct lsa_r_query_info
138 {
139     uint32 undoc_buffer; /* undocumented buffer pointer */
140     uint16 info_class; /* info class (same as info class in request) */
141     
142         union
143     {
144         DOM_QUERY_3 id3;
145                 DOM_QUERY_5 id5;
146
147     } dom;
148
149         uint32 status; /* return code */
150
151 } LSA_R_QUERY_INFO;
152
153 /* LSA_Q_ENUM_TRUST_DOM - LSA enumerate trusted domains */
154 typedef struct lsa_enum_trust_dom_info
155 {
156         POLICY_HND pol; /* policy handle */
157     uint32 enum_context; /* enumeration context handle */
158     uint32 preferred_len; /* preferred maximum length */
159
160 } LSA_Q_ENUM_TRUST_DOM;
161
162 /* LSA_R_ENUM_TRUST_DOM - response to LSA enumerate trusted domains */
163 typedef struct lsa_r_enum_trust_dom_info
164 {
165         uint32 enum_context; /* enumeration context handle */
166         uint32 num_domains; /* number of domains */
167         uint32 ptr_enum_domains; /* buffer pointer to num domains */
168
169         /* this lot is only added if ptr_enum_domains is non-NULL */
170                 uint32 num_domains2; /* number of domains */
171                 UNIHDR2 hdr_domain_name;
172                 UNISTR2 uni_domain_name;
173                 DOM_SID2 other_domain_sid;
174
175     uint32 status; /* return code */
176
177 } LSA_R_ENUM_TRUST_DOM;
178
179 /* LSA_Q_CLOSE */
180 typedef struct lsa_q_close_info
181 {
182         POLICY_HND pol; /* policy handle */
183
184 } LSA_Q_CLOSE;
185
186 /* LSA_R_CLOSE */
187 typedef struct lsa_r_close_info
188 {
189         POLICY_HND pol; /* policy handle.  should be all zeros. */
190
191         uint32 status; /* return code */
192
193 } LSA_R_CLOSE;
194
195
196 #define MAX_REF_DOMAINS 10
197
198 /* DOM_TRUST_HDR */
199 typedef struct dom_trust_hdr
200 {
201         UNIHDR hdr_dom_name; /* referenced domain unicode string headers */
202         uint32 ptr_dom_sid;
203
204 } DOM_TRUST_HDR;
205         
206 /* DOM_TRUST_INFO */
207 typedef struct dom_trust_info
208 {
209         UNISTR2  uni_dom_name; /* domain name unicode string */
210         DOM_SID2 ref_dom     ; /* referenced domain SID */
211
212 } DOM_TRUST_INFO;
213         
214 /* DOM_R_REF */
215 typedef struct dom_ref_info
216 {
217         uint32 undoc_buffer; /* undocumented buffer pointer. */
218         uint32 num_ref_doms_1; /* num referenced domains */
219         uint32 undoc_buffer2; /* undocumented domain name buffer pointer. */
220         uint32 max_entries; /* 32 - max number of entries */
221         uint32 num_ref_doms_2; /* num referenced domains */
222
223         DOM_TRUST_HDR  hdr_ref_dom[MAX_REF_DOMAINS]; /* referenced domains */
224         DOM_TRUST_INFO ref_dom    [MAX_REF_DOMAINS]; /* referenced domains */
225
226 } DOM_R_REF;
227
228 /* the domain_idx points to a SID associated with the name */
229
230 /* LSA_TRANS_NAME - translated name */
231 typedef struct lsa_trans_name_info
232 {
233         uint32 sid_name_use; /* value is 5 for a well-known group; 2 for a domain group; 1 for a user... */
234         UNIHDR hdr_name; 
235         uint32 domain_idx; /* index into DOM_R_REF array of SIDs */
236
237 } LSA_TRANS_NAME;
238
239 #define MAX_LOOKUP_SIDS 30
240
241 /* LSA_TRANS_NAME_ENUM - LSA Translated Name Enumeration container */
242 typedef struct lsa_trans_name_enum_info
243 {
244         uint32 num_entries;
245         uint32 ptr_trans_names;
246         uint32 num_entries2;
247         
248         LSA_TRANS_NAME name    [MAX_LOOKUP_SIDS]; /* translated names  */
249         UNISTR2        uni_name[MAX_LOOKUP_SIDS]; 
250
251 } LSA_TRANS_NAME_ENUM;
252
253 /* LSA_SID_ENUM - LSA SID enumeration container */
254 typedef struct lsa_sid_enum_info
255 {
256         uint32 num_entries;
257         uint32 ptr_sid_enum;
258         uint32 num_entries2;
259         
260         uint32   ptr_sid[MAX_LOOKUP_SIDS]; /* domain SID pointers to be looked up. */
261         DOM_SID2 sid    [MAX_LOOKUP_SIDS]; /* domain SIDs to be looked up. */
262
263 } LSA_SID_ENUM;
264
265 /* LSA_Q_LOOKUP_SIDS - LSA Lookup SIDs */
266 typedef struct lsa_q_lookup_sids
267 {
268         POLICY_HND          pol; /* policy handle */
269         LSA_SID_ENUM        sids;
270         LSA_TRANS_NAME_ENUM names;
271         LOOKUP_LEVEL        level;
272         uint32              mapped_count;
273
274 } LSA_Q_LOOKUP_SIDS;
275
276 /* LSA_R_LOOKUP_SIDS - response to LSA Lookup SIDs */
277 typedef struct lsa_r_lookup_sids
278 {
279         DOM_R_REF           *dom_ref; /* domain reference info */
280         LSA_TRANS_NAME_ENUM *names;
281         uint32              mapped_count;
282
283         uint32              status; /* return code */
284
285 } LSA_R_LOOKUP_SIDS;
286
287 /* DOM_NAME - XXXX not sure about this structure */
288 typedef struct dom_name_info
289 {
290     uint32 uni_str_len;
291         UNISTR str;
292
293 } DOM_NAME;
294
295
296 #define UNKNOWN_LEN 1
297
298 /* LSA_Q_LOOKUP_RIDS - LSA Lookup RIDs */
299 typedef struct lsa_q_lookup_rids
300 {
301     POLICY_HND pol; /* policy handle */
302     uint32 num_entries;
303     uint32 num_entries2;
304     uint32 buffer_dom_sid; /* undocumented domain SID buffer pointer */
305     uint32 buffer_dom_name; /* undocumented domain name buffer pointer */
306     DOM_NAME lookup_name[MAX_LOOKUP_SIDS]; /* names to be looked up */
307     uint8 undoc[UNKNOWN_LEN]; /* completely undocumented bytes of unknown length */
308
309 } LSA_Q_LOOKUP_RIDS;
310
311 /* LSA_R_LOOKUP_RIDS - response to LSA Lookup RIDs by name */
312 typedef struct lsa_r_lookup_rids
313 {
314     DOM_R_REF dom_ref; /* domain reference info */
315
316     uint32 num_entries;
317     uint32 undoc_buffer; /* undocumented buffer pointer */
318
319     uint32 num_entries2; 
320     DOM_RID2 dom_rid[MAX_LOOKUP_SIDS]; /* domain RIDs being looked up */
321
322     uint32 num_entries3; 
323
324   uint32 status; /* return code */
325
326 } LSA_R_LOOKUP_RIDS;
327
328
329 #endif /* _RPC_LSA_H */
330