Merge branch 'master' of ssh://git.samba.org/data/git/samba
[jra/samba/.git] / source3 / include / ntdomain.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    Copyright (C) Jeremy Allison 2000-2004
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 3 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, see <http://www.gnu.org/licenses/>.
21 */
22
23 #ifndef _NT_DOMAIN_H /* _NT_DOMAIN_H */
24 #define _NT_DOMAIN_H 
25
26 /*
27  * A bunch of stuff that was put into smb.h
28  * in the NTDOM branch - it didn't belong there.
29  */
30
31 typedef struct _prs_struct {
32         bool io; /* parsing in or out of data stream */
33         /* 
34          * If the (incoming) data is big-endian. On output we are
35          * always little-endian.
36          */ 
37         bool bigendian_data;
38         uint8 align; /* data alignment */
39         bool is_dynamic; /* Do we own this memory or not ? */
40         uint32 data_offset; /* Current working offset into data. */
41         uint32 buffer_size; /* Current allocated size of the buffer. */
42         uint32 grow_size; /* size requested via prs_grow() calls */
43         char *data_p; /* The buffer itself. */
44         TALLOC_CTX *mem_ctx; /* When unmarshalling, use this.... */
45         const char *sess_key; /* If we have to do encrypt/decrypt on the fly. */
46 } prs_struct;
47
48 /*
49  * Defines for io member of prs_struct.
50  */
51
52 #define MARSHALL 0
53 #define UNMARSHALL 1
54
55 #define MARSHALLING(ps) (!(ps)->io)
56 #define UNMARSHALLING(ps) ((ps)->io)
57
58 #define RPC_BIG_ENDIAN          1
59 #define RPC_LITTLE_ENDIAN       0
60
61 #define RPC_PARSE_ALIGN 4
62
63 typedef struct _output_data {
64         /*
65          * Raw RPC output data. This does not include RPC headers or footers.
66          */
67         prs_struct rdata;
68
69         /* The amount of data sent from the current rdata struct. */
70         uint32 data_sent_length;
71
72         /*
73          * The current PDU being returned. This inclues
74          * headers, data and authentication footer.
75          */
76         unsigned char current_pdu[RPC_MAX_PDU_FRAG_LEN];
77
78         /* The amount of data in the current_pdu buffer. */
79         uint32 current_pdu_len;
80
81         /* The amount of data sent from the current PDU. */
82         uint32 current_pdu_sent;
83 } output_data;
84
85 typedef struct _input_data {
86         /*
87          * This is the current incoming pdu. The data here
88          * is collected via multiple writes until a complete
89          * pdu is seen, then the data is copied into the in_data
90          * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
91          */
92         unsigned char current_in_pdu[RPC_MAX_PDU_FRAG_LEN];
93
94         /*
95          * The amount of data needed to complete the in_pdu.
96          * If this is zero, then we are at the start of a new
97          * pdu.
98          */
99         uint32 pdu_needed_len;
100
101         /*
102          * The amount of data received so far in the in_pdu.
103          * If this is zero, then we are at the start of a new
104          * pdu.
105          */
106         uint32 pdu_received_len;
107
108         /*
109          * This is the collection of input data with all
110          * the rpc headers and auth footers removed.
111          * The maximum length of this (1Mb) is strictly enforced.
112          */
113         prs_struct data;
114 } input_data;
115
116 /*
117  * Handle database - stored per pipe.
118  */
119
120 struct policy {
121         struct policy *next, *prev;
122
123         POLICY_HND pol_hnd;
124
125         void *data_ptr;
126 };
127
128 struct handle_list {
129         struct policy *Policy;  /* List of policies. */
130         size_t count;                   /* Current number of handles. */
131         size_t pipe_ref_count;  /* Number of pipe handles referring to this list. */
132 };
133
134 /* Domain controller authentication protocol info */
135 struct dcinfo {
136         uint32 sequence; /* "timestamp" from client. */
137         struct netr_Credential seed_chal;
138         struct netr_Credential clnt_chal; /* Client credential */
139         struct netr_Credential srv_chal;  /* Server credential */
140
141         unsigned char  sess_key[16]; /* Session key - 8 bytes followed by 8 zero bytes */
142         unsigned char  mach_pw[16];   /* md4(machine password) */
143
144         fstring mach_acct;  /* Machine name we've authenticated. */
145
146         fstring remote_machine;  /* Machine name we've authenticated. */
147         fstring domain;
148
149         bool challenge_sent;
150         bool authenticated;
151 };
152
153 typedef struct pipe_rpc_fns {
154
155         struct pipe_rpc_fns *next, *prev;
156
157         /* RPC function table associated with the current rpc_bind (associated by context) */
158
159         const struct api_struct *cmds;
160         int n_cmds;
161         uint32 context_id;
162
163 } PIPE_RPC_FNS;
164
165 /*
166  * Different auth types we support.
167  * Can't keep in sync with wire values as spnego wraps different auth methods.
168  */
169
170 enum pipe_auth_type { PIPE_AUTH_TYPE_NONE = 0, PIPE_AUTH_TYPE_NTLMSSP, PIPE_AUTH_TYPE_SCHANNEL,
171                         PIPE_AUTH_TYPE_SPNEGO_NTLMSSP, PIPE_AUTH_TYPE_KRB5, PIPE_AUTH_TYPE_SPNEGO_KRB5 };
172
173 /* Possible auth levels - keep these in sync with the wire values. */
174 enum pipe_auth_level { PIPE_AUTH_LEVEL_NONE = 0,
175                         PIPE_AUTH_LEVEL_CONNECT = 1,    /* We treat as NONE. */
176                         PIPE_AUTH_LEVEL_INTEGRITY = 5,  /* Sign. */
177                         PIPE_AUTH_LEVEL_PRIVACY = 6     /* Seal. */
178 };
179
180 /* auth state for krb5. */
181 struct kerberos_auth_struct {
182         const char *service_principal;
183         DATA_BLOB session_key;
184 };
185
186 /* auth state for schannel. */
187 struct schannel_auth_struct {
188         unsigned char sess_key[16];
189         uint32 seq_num;
190 };
191
192 /* auth state for all bind types. */
193
194 struct pipe_auth_data {
195         enum pipe_auth_type auth_type; /* switch for union below. */
196         enum pipe_auth_level auth_level;
197         union {
198                 struct schannel_auth_struct *schannel_auth;
199                 AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
200 /*              struct kerberos_auth_struct *kerberos_auth; TO BE ADDED... */
201         } a_u;
202         void (*auth_data_free_func)(struct pipe_auth_data *);
203 };
204
205 /*
206  * DCE/RPC-specific samba-internal-specific handling of data on
207  * NamedPipes.
208  */
209
210 typedef struct pipes_struct {
211         struct pipes_struct *next, *prev;
212
213         char client_address[INET6_ADDRSTRLEN];
214
215         struct auth_serversupplied_info *server_info;
216
217         struct ndr_syntax_id syntax;
218
219         /* linked list of rpc dispatch tables associated 
220            with the open rpc contexts */
221
222         PIPE_RPC_FNS *contexts;
223
224         RPC_HDR hdr; /* Incoming RPC header. */
225         RPC_HDR_REQ hdr_req; /* Incoming request header. */
226
227         struct pipe_auth_data auth;
228
229         struct dcinfo *dc; /* Keeps the creds data from netlogon. */
230
231         /*
232          * Set to true when an RPC bind has been done on this pipe.
233          */
234
235         bool pipe_bound;
236
237         /*
238          * Set to true when we should return fault PDU's for everything.
239          */
240
241         bool fault_state;
242
243         /*
244          * Set to true when we should return fault PDU's for a bad handle.
245          */
246
247         bool bad_handle_fault_state;
248
249         /*
250          * Set to true when the backend does not support a call.
251          */
252
253         bool rng_fault_state;
254
255         /*
256          * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
257          */
258
259         bool endian;
260
261         /*
262          * Struct to deal with multiple pdu inputs.
263          */
264
265         input_data in_data;
266
267         /*
268          * Struct to deal with multiple pdu outputs.
269          */
270
271         output_data out_data;
272
273         /* This context is used for PDU data and is freed between each pdu.
274                 Don't use for pipe state storage. */
275         TALLOC_CTX *mem_ctx;
276
277         /* handle database to use on this pipe. */
278         struct handle_list *pipe_handles;
279
280 } pipes_struct;
281
282 struct api_struct {  
283         const char *name;
284         uint8 opnum;
285         bool (*fn) (pipes_struct *);
286 };
287
288 /*
289  * higher order functions for use with msrpc client code
290  */
291
292 #define PRINT_INFO_FN(fn)\
293         void (*fn)(const char*, uint32, uint32, void  *const *const)
294 #define JOB_INFO_FN(fn)\
295         void (*fn)(const char*, const char*, uint32, uint32, void *const *const)
296
297 /* end higher order functions */
298
299 typedef struct {
300         uint32 size;
301         prs_struct prs;
302         uint32 struct_start;
303         uint32 string_at_end;
304 } RPC_BUFFER;
305
306 #endif /* _NT_DOMAIN_H */