f90478296c2274fcf0fc75c02f493561a9209e35
[ira/wip.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 fragment being returned. This inclues
74          * headers, data and authentication footer.
75          */
76         prs_struct frag;
77
78         /* The amount of data sent from the current PDU. */
79         uint32 current_pdu_sent;
80 } output_data;
81
82 typedef struct _input_data {
83         /*
84          * This is the current incoming pdu. The data here
85          * is collected via multiple writes until a complete
86          * pdu is seen, then the data is copied into the in_data
87          * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
88          */
89         uint8_t *current_in_pdu;
90
91         /*
92          * The amount of data needed to complete the in_pdu.
93          * If this is zero, then we are at the start of a new
94          * pdu.
95          */
96         uint32 pdu_needed_len;
97
98         /*
99          * The amount of data received so far in the in_pdu.
100          * If this is zero, then we are at the start of a new
101          * pdu.
102          */
103         uint32 pdu_received_len;
104
105         /*
106          * This is the collection of input data with all
107          * the rpc headers and auth footers removed.
108          * The maximum length of this (1Mb) is strictly enforced.
109          */
110         prs_struct data;
111 } input_data;
112
113 struct handle_list;
114
115 typedef struct pipe_rpc_fns {
116
117         struct pipe_rpc_fns *next, *prev;
118
119         /* RPC function table associated with the current rpc_bind (associated by context) */
120
121         const struct api_struct *cmds;
122         int n_cmds;
123         uint32 context_id;
124
125 } PIPE_RPC_FNS;
126
127 /*
128  * Different auth types we support.
129  * Can't keep in sync with wire values as spnego wraps different auth methods.
130  */
131
132 enum pipe_auth_type { PIPE_AUTH_TYPE_NONE = 0, PIPE_AUTH_TYPE_NTLMSSP, PIPE_AUTH_TYPE_SCHANNEL,
133                         PIPE_AUTH_TYPE_SPNEGO_NTLMSSP, PIPE_AUTH_TYPE_KRB5, PIPE_AUTH_TYPE_SPNEGO_KRB5 };
134
135 /* auth state for krb5. */
136 struct kerberos_auth_struct {
137         const char *service_principal;
138         DATA_BLOB session_key;
139 };
140
141 /* auth state for schannel. */
142 struct schannel_auth_struct {
143         unsigned char sess_key[16];
144         uint32 seq_num;
145 };
146
147 /* auth state for all bind types. */
148
149 struct pipe_auth_data {
150         enum pipe_auth_type auth_type; /* switch for union below. */
151         enum dcerpc_AuthLevel auth_level;
152         union {
153                 struct schannel_state *schannel_auth;
154                 AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
155 /*              struct kerberos_auth_struct *kerberos_auth; TO BE ADDED... */
156         } a_u;
157         void (*auth_data_free_func)(struct pipe_auth_data *);
158 };
159
160 /*
161  * DCE/RPC-specific samba-internal-specific handling of data on
162  * NamedPipes.
163  */
164
165 typedef struct pipes_struct {
166         struct pipes_struct *next, *prev;
167
168         char client_address[INET6_ADDRSTRLEN];
169
170         struct auth_serversupplied_info *server_info;
171
172         struct ndr_syntax_id syntax;
173
174         /* linked list of rpc dispatch tables associated 
175            with the open rpc contexts */
176
177         PIPE_RPC_FNS *contexts;
178
179         RPC_HDR hdr; /* Incoming RPC header. */
180         RPC_HDR_REQ hdr_req; /* Incoming request header. */
181
182         struct pipe_auth_data auth;
183
184         /*
185          * Set to true when an RPC bind has been done on this pipe.
186          */
187
188         bool pipe_bound;
189
190         /*
191          * Set to true when we should return fault PDU's for everything.
192          */
193
194         bool fault_state;
195
196         /*
197          * Set to true when we should return fault PDU's for a bad handle.
198          */
199
200         bool bad_handle_fault_state;
201
202         /*
203          * Set to true when the backend does not support a call.
204          */
205
206         bool rng_fault_state;
207
208         /*
209          * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
210          */
211
212         bool endian;
213
214         /*
215          * Struct to deal with multiple pdu inputs.
216          */
217
218         input_data in_data;
219
220         /*
221          * Struct to deal with multiple pdu outputs.
222          */
223
224         output_data out_data;
225
226         /* This context is used for PDU data and is freed between each pdu.
227                 Don't use for pipe state storage. */
228         TALLOC_CTX *mem_ctx;
229
230         /* handle database to use on this pipe. */
231         struct handle_list *pipe_handles;
232
233         /* private data for the interface implementation */
234         void *private_data;
235
236 } pipes_struct;
237
238 struct api_struct {  
239         const char *name;
240         uint8 opnum;
241         bool (*fn) (pipes_struct *);
242 };
243
244 /*
245  * higher order functions for use with msrpc client code
246  */
247
248 #define PRINT_INFO_FN(fn)\
249         void (*fn)(const char*, uint32, uint32, void  *const *const)
250 #define JOB_INFO_FN(fn)\
251         void (*fn)(const char*, const char*, uint32, uint32, void *const *const)
252
253 /* end higher order functions */
254
255 #endif /* _NT_DOMAIN_H */