merge of working dsrolegetprimdominfo() client code from APP_HEAD
[kai/samba.git] / source3 / include / rpc_dce.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 #ifndef _DCE_RPC_H /* _DCE_RPC_H */
24 #define _DCE_RPC_H 
25
26 #include "rpc_misc.h"  /* this only pulls in STRHDR */
27
28
29 /* DCE/RPC packet types */
30
31 enum RPC_PKT_TYPE
32 {
33         RPC_REQUEST = 0x00,
34         RPC_RESPONSE = 0x02,
35         RPC_FAULT    = 0x03,
36         RPC_BIND     = 0x0B,
37         RPC_BINDACK  = 0x0C,
38         RPC_BINDNACK = 0x0D,
39         RPC_ALTCONT  = 0x0E,
40         RPC_ALTCONTRESP = 0x0F,
41         RPC_BINDRESP = 0x10 /* not the real name!  this is undocumented! */
42 };
43
44 /* DCE/RPC flags */
45 #define RPC_FLG_FIRST 0x01
46 #define RPC_FLG_LAST  0x02
47 #define RPC_FLG_NOCALL 0x20
48
49 /* NTLMSSP message types */
50 enum NTLM_MESSAGE_TYPE
51 {
52         NTLMSSP_NEGOTIATE = 1,
53         NTLMSSP_CHALLENGE = 2,
54         NTLMSSP_AUTH      = 3,
55         NTLMSSP_UNKNOWN   = 4
56 };
57
58 /* NTLMSSP negotiation flags */
59 #define NTLMSSP_NEGOTIATE_UNICODE          0x00000001
60 #define NTLMSSP_NEGOTIATE_OEM              0x00000002
61 #define NTLMSSP_REQUEST_TARGET             0x00000004
62 #define NTLMSSP_NEGOTIATE_SIGN             0x00000010 /* Message integrity */
63 #define NTLMSSP_NEGOTIATE_SEAL             0x00000020 /* Message confidentiality */
64 #define NTLMSSP_NEGOTIATE_DATAGRAM_STYLE   0x00000040
65 #define NTLMSSP_NEGOTIATE_LM_KEY           0x00000080
66 #define NTLMSSP_NEGOTIATE_NETWARE          0x00000100
67 #define NTLMSSP_NEGOTIATE_NTLM             0x00000200
68 #define NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED  0x00001000
69 #define NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED 0x00002000
70 #define NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL  0x00004000
71 #define NTLMSSP_NEGOTIATE_ALWAYS_SIGN      0x00008000
72 #define NTLMSSP_CHAL_INIT_RESPONSE         0x00010000
73 #define NTLMSSP_CHAL_ACCEPT_RESPONSE       0x00020000
74 #define NTLMSSP_CHAL_NON_NT_SESSION_KEY    0x00040000
75 #define NTLMSSP_NEGOTIATE_NTLM2            0x00080000
76 #define NTLMSSP_CHAL_TARGET_INFO           0x00800000
77 #define NTLMSSP_NEGOTIATE_128              0x20000000 /* 128-bit encryption */
78 #define NTLMSSP_NEGOTIATE_KEY_EXCH         0x40000000
79 #define NTLMSSP_NEGOTIATE_080000000        0x80000000
80
81 #define SMBD_NTLMSSP_NEG_FLAGS 0x000082b1 /* ALWAYS_SIGN|NEG_NTLM|NEG_LM|NEG_SEAL|NEG_SIGN|NEG_UNICODE */
82
83 /* NTLMSSP signature version */
84 #define NTLMSSP_SIGN_VERSION 0x01
85
86 /* NTLMSSP auth type and level. */
87 #define NTLMSSP_AUTH_TYPE 0xa
88 #define NTLMSSP_AUTH_LEVEL 0x6
89
90 /* Maximum PDU fragment size. */
91 #define MAX_PDU_FRAG_LEN 0x1630
92 /* #define MAX_PDU_FRAG_LEN 0x10b8              this is what w2k sets */
93
94 /*
95  * Actual structure of a DCE UUID
96  */
97
98 typedef struct rpc_uuid
99 {
100   uint32 time_low;
101   uint16 time_mid;
102   uint16 time_hi_and_version;
103   uint8 remaining[8];
104 } RPC_UUID;
105
106 #define RPC_UUID_LEN 16
107
108 /* RPC_IFACE */
109 typedef struct rpc_iface_info
110 {
111   RPC_UUID uuid;    /* 16 bytes of rpc interface identification */
112   uint32 version;    /* the interface version number */
113
114 } RPC_IFACE;
115
116 #define RPC_IFACE_LEN (RPC_UUID_LEN + 4)
117
118 struct pipe_id_info
119 {
120         /* the names appear not to matter: the syntaxes _do_ matter */
121
122         char *client_pipe;
123         RPC_IFACE abstr_syntax; /* this one is the abstract syntax id */
124
125         char *server_pipe;  /* this one is the secondary syntax name */
126         RPC_IFACE trans_syntax; /* this one is the primary syntax id */
127 };
128
129 /* RPC_HDR - dce rpc header */
130 typedef struct rpc_hdr_info
131 {
132   uint8  major; /* 5 - RPC major version */
133   uint8  minor; /* 0 - RPC minor version */
134   uint8  pkt_type; /* RPC_PKT_TYPE - RPC response packet */
135   uint8  flags; /* DCE/RPC flags */
136   uint8  pack_type[4]; /* 0x1000 0000 - little-endian packed data representation */
137   uint16 frag_len; /* fragment length - data size (bytes) inc header and tail. */
138   uint16 auth_len; /* 0 - authentication length  */
139   uint32 call_id; /* call identifier.  matches 12th uint32 of incoming RPC data. */
140
141 } RPC_HDR;
142
143 #define RPC_HEADER_LEN 16
144
145 /* RPC_HDR_REQ - ms request rpc header */
146 typedef struct rpc_hdr_req_info
147 {
148   uint32 alloc_hint;   /* allocation hint - data size (bytes) minus header and tail. */
149   uint16 context_id;   /* 0 - presentation context identifier */
150   uint16  opnum;        /* opnum */
151
152 } RPC_HDR_REQ;
153
154 #define RPC_HDR_REQ_LEN 8
155
156 /* RPC_HDR_RESP - ms response rpc header */
157 typedef struct rpc_hdr_resp_info
158 {
159   uint32 alloc_hint;   /* allocation hint - data size (bytes) minus header and tail. */
160   uint16 context_id;   /* 0 - presentation context identifier */
161   uint8  cancel_count; /* 0 - cancel count */
162   uint8  reserved;     /* 0 - reserved. */
163
164 } RPC_HDR_RESP;
165
166 #define RPC_HDR_RESP_LEN 8
167
168 /* RPC_HDR_FAULT - fault rpc header */
169 typedef struct rpc_hdr_fault_info
170 {
171   NTSTATUS status;
172   uint32 reserved; /* 0x0000 0000 */
173 } RPC_HDR_FAULT;
174
175 #define RPC_HDR_FAULT_LEN 8
176
177 /* this seems to be the same string name depending on the name of the pipe,
178  * but is more likely to be linked to the interface name
179  * "srvsvc", "\\PIPE\\ntsvcs"
180  * "samr", "\\PIPE\\lsass"
181  * "wkssvc", "\\PIPE\\wksvcs"
182  * "NETLOGON", "\\PIPE\\NETLOGON"
183  */
184 /* RPC_ADDR_STR */
185 typedef struct rpc_addr_info
186 {
187   uint16 len;   /* length of the string including null terminator */
188   fstring str; /* the string above in single byte, null terminated form */
189
190 } RPC_ADDR_STR;
191
192 /* RPC_HDR_BBA */
193 typedef struct rpc_hdr_bba_info
194 {
195   uint16 max_tsize;       /* maximum transmission fragment size (0x1630) */
196   uint16 max_rsize;       /* max receive fragment size (0x1630) */
197   uint32 assoc_gid;       /* associated group id (0x0) */
198
199 } RPC_HDR_BBA;
200
201 #define RPC_HDR_BBA_LEN 8
202
203 /* RPC_HDR_AUTHA */
204 typedef struct rpc_hdr_autha_info
205 {
206         uint16 max_tsize;       /* maximum transmission fragment size (0x1630) */
207         uint16 max_rsize;       /* max receive fragment size (0x1630) */
208
209         uint8 auth_type; /* 0x0a */
210         uint8 auth_level; /* 0x06 */
211         uint8 stub_type_len; /* don't know */
212         uint8 padding; /* padding */
213
214         uint32 unknown; /* 0x0014a0c0 */
215
216 } RPC_HDR_AUTHA;
217
218 #define RPC_HDR_AUTHA_LEN 12
219
220 /* RPC_HDR_AUTH */
221 typedef struct rpc_hdr_auth_info
222 {
223         uint8 auth_type; /* 0x0a */
224         uint8 auth_level; /* 0x06 */
225         uint8 stub_type_len; /* don't know */
226         uint8 padding; /* padding */
227
228         uint32 unknown; /* pointer */
229
230 } RPC_HDR_AUTH;
231
232 #define RPC_HDR_AUTH_LEN 8
233
234 /* RPC_BIND_REQ - ms req bind */
235 typedef struct rpc_bind_req_info
236 {
237   RPC_HDR_BBA bba;
238
239   uint32 num_elements;    /* the number of elements (0x1) */
240   uint16 context_id;      /* presentation context identifier (0x0) */
241   uint8 num_syntaxes;     /* the number of syntaxes (has always been 1?)(0x1) */
242
243   RPC_IFACE abstract;     /* num and vers. of interface client is using */
244   RPC_IFACE transfer;     /* num and vers. of interface to use for replies */
245   
246 } RPC_HDR_RB;
247
248 /* 
249  * The following length is 8 bytes RPC_HDR_BBA_LEN, 8 bytes internals 
250  * (with 3 bytes padding), + 2 x RPC_IFACE_LEN bytes for RPC_IFACE structs.
251  */
252
253 #define RPC_HDR_RB_LEN (RPC_HDR_BBA_LEN + 8 + (2*RPC_IFACE_LEN))
254
255 /* RPC_RESULTS - can only cope with one reason, right now... */
256 typedef struct rpc_results_info
257 {
258 /* uint8[] # 4-byte alignment padding, against SMB header */
259
260   uint8 num_results; /* the number of results (0x01) */
261
262 /* uint8[] # 4-byte alignment padding, against SMB header */
263
264   uint16 result; /* result (0x00 = accept) */
265   uint16 reason; /* reason (0x00 = no reason specified) */
266
267 } RPC_RESULTS;
268
269 /* RPC_HDR_BA */
270 typedef struct rpc_hdr_ba_info
271 {
272   RPC_HDR_BBA bba;
273
274   RPC_ADDR_STR addr    ;  /* the secondary address string, as described earlier */
275   RPC_RESULTS  res     ; /* results and reasons */
276   RPC_IFACE    transfer; /* the transfer syntax from the request */
277
278 } RPC_HDR_BA;
279
280 /* RPC_AUTH_VERIFIER */
281 typedef struct rpc_auth_verif_info
282 {
283         fstring signature; /* "NTLMSSP" */
284         uint32  msg_type; /* NTLMSSP_MESSAGE_TYPE (1,2,3) */
285
286 } RPC_AUTH_VERIFIER;
287
288 /* this is TEMPORARILY coded up as a specific structure */
289 /* this structure comes after the bind request */
290 /* RPC_AUTH_NTLMSSP_NEG */
291 typedef struct rpc_auth_ntlmssp_neg_info
292 {
293         uint32  neg_flgs; /* 0x0000 b2b3 */
294
295         STRHDR hdr_myname; /* offset is against START of this structure */
296         STRHDR hdr_domain; /* offset is against START of this structure */
297
298         fstring myname; /* calling workstation's name */
299         fstring domain; /* calling workstations's domain */
300
301 } RPC_AUTH_NTLMSSP_NEG;
302
303 /* this is TEMPORARILY coded up as a specific structure */
304 /* this structure comes after the bind acknowledgement */
305 /* RPC_AUTH_NTLMSSP_CHAL */
306 typedef struct rpc_auth_ntlmssp_chal_info
307 {
308         uint32 unknown_1; /* 0x0000 0000 */
309         uint32 unknown_2; /* 0x0000 0028 */
310         uint32 neg_flags; /* 0x0000 82b1 */
311
312         uint8 challenge[8]; /* ntlm challenge */
313         uint8 reserved [8]; /* zeros */
314
315 } RPC_AUTH_NTLMSSP_CHAL;
316
317
318 /* RPC_AUTH_NTLMSSP_RESP */
319 typedef struct rpc_auth_ntlmssp_resp_info
320 {
321         STRHDR hdr_lm_resp; /* 24 byte response */
322         STRHDR hdr_nt_resp; /* 24 byte response */
323         STRHDR hdr_domain;
324         STRHDR hdr_usr;
325         STRHDR hdr_wks;
326         STRHDR hdr_sess_key; /* NULL unless negotiated */
327         uint32 neg_flags; /* 0x0000 82b1 */
328
329         fstring sess_key;
330         fstring wks;
331         fstring user;
332         fstring domain;
333         fstring nt_resp;
334         fstring lm_resp;
335
336 } RPC_AUTH_NTLMSSP_RESP;
337
338 /* attached to the end of encrypted rpc requests and responses */
339 /* RPC_AUTH_NTLMSSP_CHK */
340 typedef struct rpc_auth_ntlmssp_chk_info
341 {
342         uint32 ver; /* 0x0000 0001 */
343         uint32 reserved;
344         uint32 crc32; /* checksum using 0xEDB8 8320 as a polynomial */
345         uint32 seq_num;
346
347 } RPC_AUTH_NTLMSSP_CHK;
348
349 #define RPC_AUTH_NTLMSSP_CHK_LEN 16
350
351
352 #endif /* _DCE_RPC_H */