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