s4:rpc_server: use a variable for the max total reassembled request payload
[samba.git] / source4 / rpc_server / dcerpc_server.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    server side dcerpc defines
5
6    Copyright (C) Andrew Tridgell 2003-2005
7    Copyright (C) Stefan (metze) Metzmacher 2004-2005
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 SAMBA_DCERPC_SERVER_H
24 #define SAMBA_DCERPC_SERVER_H
25
26 #include "librpc/gen_ndr/server_id.h"
27 #include "librpc/rpc/dcerpc.h"
28 #include "librpc/ndr/libndr.h"
29
30 /* modules can use the following to determine if the interface has changed
31  * please increment the version number after each interface change
32  * with a comment and maybe update struct dcesrv_critical_sizes.
33  */
34 /* version 1 - initial version - metze */
35 #define DCERPC_MODULE_VERSION 1
36
37 struct dcesrv_connection;
38 struct dcesrv_call_state;
39 struct dcesrv_auth;
40 struct dcesrv_connection_context;
41
42 struct dcesrv_interface {
43         const char *name;
44         struct ndr_syntax_id syntax_id;
45
46         /* this function is called when the client binds to this interface  */
47         NTSTATUS (*bind)(struct dcesrv_call_state *, const struct dcesrv_interface *, uint32_t if_version);
48
49         /* this function is called when the client disconnects the endpoint */
50         void (*unbind)(struct dcesrv_connection_context *, const struct dcesrv_interface *);
51
52         /* the ndr_pull function for the chosen interface.
53          */
54         NTSTATUS (*ndr_pull)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_pull *, void **);
55         
56         /* the dispatch function for the chosen interface.
57          */
58         NTSTATUS (*dispatch)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
59
60         /* the reply function for the chosen interface.
61          */
62         NTSTATUS (*reply)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
63
64         /* the ndr_push function for the chosen interface.
65          */
66         NTSTATUS (*ndr_push)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_push *, const void *);
67
68         /* for any private use by the interface code */
69         const void *private_data;
70 };
71
72 enum dcesrv_call_list {
73         DCESRV_LIST_NONE,
74         DCESRV_LIST_CALL_LIST,
75         DCESRV_LIST_FRAGMENTED_CALL_LIST,
76         DCESRV_LIST_PENDING_CALL_LIST
77 };
78
79 struct data_blob_list_item {
80         struct data_blob_list_item *prev,*next;
81         DATA_BLOB blob;
82 };
83
84 /* the state of an ongoing dcerpc call */
85 struct dcesrv_call_state {
86         struct dcesrv_call_state *next, *prev;
87         struct dcesrv_connection *conn;
88         struct dcesrv_connection_context *context;
89         struct ncacn_packet pkt;
90
91         /*
92           which list this request is in, if any
93          */
94         enum dcesrv_call_list list;
95
96         /* the backend can mark the call
97          * with DCESRV_CALL_STATE_FLAG_ASYNC
98          * that will cause the frontend to not touch r->out
99          * and skip the reply
100          *
101          * this is only allowed to the backend when DCESRV_CALL_STATE_FLAG_MAY_ASYNC
102          * is alerady set by the frontend
103          *
104          * the backend then needs to call dcesrv_reply() when it's
105          * ready to send the reply
106          */
107 #define DCESRV_CALL_STATE_FLAG_ASYNC (1<<0)
108 #define DCESRV_CALL_STATE_FLAG_MAY_ASYNC (1<<1)
109 #define DCESRV_CALL_STATE_FLAG_MULTIPLEXED (1<<3)
110 #define DCESRV_CALL_STATE_FLAG_PROCESS_PENDING_CALL (1<<4)
111         uint32_t state_flags;
112
113         /* the time the request arrived in the server */
114         struct timeval time;
115
116         /* the backend can use this event context for async replies */
117         struct tevent_context *event_ctx;
118
119         /* the message_context that will be used for async replies */
120         struct imessaging_context *msg_ctx;
121
122         /* this is the pointer to the allocated function struct */
123         void *r;
124
125         /*
126          * that's the ndr pull context used in dcesrv_request()
127          * needed by dcesrv_reply() to carry over information
128          * for full pointer support.
129          */
130         struct ndr_pull *ndr_pull;
131
132         DATA_BLOB input;
133
134         struct data_blob_list_item *replies;
135
136         /* this is used by the boilerplate code to generate DCERPC faults */
137         uint32_t fault_code;
138
139         /* the reason why we terminate the connection after sending a response */
140         const char *terminate_reason;
141
142         /* temporary auth_info fields */
143         struct dcerpc_auth in_auth_info;
144         struct dcerpc_auth _out_auth_info;
145         struct dcerpc_auth *out_auth_info;
146 };
147
148 #define DCESRV_HANDLE_ANY 255
149
150 /* a dcerpc handle in internal format */
151 struct dcesrv_handle {
152         struct dcesrv_handle *next, *prev;
153         struct dcesrv_assoc_group *assoc_group;
154         struct policy_handle wire_handle;
155         struct dom_sid *sid;
156         const struct dcesrv_interface *iface;
157         void *data;
158 };
159
160 /* hold the authentication state information */
161 struct dcesrv_auth {
162         enum dcerpc_AuthType auth_type;
163         enum dcerpc_AuthLevel auth_level;
164         uint32_t auth_context_id;
165         struct gensec_security *gensec_security;
166         struct auth_session_info *session_info;
167         NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
168         bool client_hdr_signing;
169         bool hdr_signing;
170         bool auth_finished;
171         bool auth_invalid;
172 };
173
174 struct dcesrv_connection_context {
175         struct dcesrv_connection_context *next, *prev;
176         uint32_t context_id;
177
178         /* TODO: remove this legacy (for openchange) in master */
179         struct dcesrv_assoc_group *assoc_group;
180
181         /* the connection this is on */
182         struct dcesrv_connection *conn;
183
184         /* the ndr function table for the chosen interface */
185         const struct dcesrv_interface *iface;
186
187         /* private data for the interface implementation */
188         void *private_data;
189
190         /*
191          * the minimum required auth level for this interface
192          */
193         enum dcerpc_AuthLevel min_auth_level;
194         bool allow_connect;
195 };
196
197
198 /* the state associated with a dcerpc server connection */
199 struct dcesrv_connection {
200         /* for the broken_connections DLIST */
201         struct dcesrv_connection *prev, *next;
202
203         /* the top level context for this server */
204         struct dcesrv_context *dce_ctx;
205
206         /* the endpoint that was opened */
207         const struct dcesrv_endpoint *endpoint;
208
209         /* a list of established context_ids */
210         struct dcesrv_connection_context *contexts;
211
212         /* the state of the current incoming call fragments */
213         struct dcesrv_call_state *incoming_fragmented_call_list;
214
215         /* the state of the async pending calls */
216         struct dcesrv_call_state *pending_call_list;
217
218         /* the state of the current outgoing calls */
219         struct dcesrv_call_state *call_list;
220
221         /* the maximum size the client wants to receive */
222         uint16_t max_recv_frag;
223         uint16_t max_xmit_frag;
224
225         DATA_BLOB partial_input;
226
227         /* This can be removed in master... */
228         struct  {
229                 struct dcerpc_auth *auth_info;
230                 struct gensec_security *gensec_security;
231                 struct auth_session_info *session_info;
232                 NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
233                 bool client_hdr_signing;
234                 bool hdr_signing;
235         } _unused_auth_state;
236
237         /* the event_context that will be used for this connection */
238         struct tevent_context *event_ctx;
239
240         /* the message_context that will be used for this connection */
241         struct imessaging_context *msg_ctx;
242
243         /* the server_id that will be used for this connection */
244         struct server_id server_id;
245
246         /* the transport level session key */
247         DATA_BLOB transport_session_key;
248
249         /* is this connection pending termination?  If so, why? */
250         const char *terminate;
251
252         const char *packet_log_dir;
253
254         /* this is the default state_flags for dcesrv_call_state structs */
255         uint32_t state_flags;
256
257         struct {
258                 void *private_data;
259                 void (*report_output_data)(struct dcesrv_connection *);
260         } transport;
261
262         struct tstream_context *stream;
263         struct tevent_queue *send_queue;
264
265         const struct tsocket_address *local_address;
266         const struct tsocket_address *remote_address;
267
268         /* the current authentication state */
269         struct dcesrv_auth auth_state;
270
271         /*
272          * remember which pdu types are allowed
273          */
274         bool allow_bind;
275         bool allow_auth3;
276         bool allow_alter;
277         bool allow_request;
278
279         /* the association group the connection belongs to */
280         struct dcesrv_assoc_group *assoc_group;
281
282         /* The maximum total payload of reassembled request pdus */
283         size_t max_total_request_size;
284 };
285
286
287 struct dcesrv_endpoint_server {
288         /* this is the name of the endpoint server */
289         const char *name;
290
291         /* this function should register endpoints and some other setup stuff,
292          * it is called when the dcesrv_context gets initialized.
293          */
294         NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
295
296         /* this function can be used by other endpoint servers to
297          * ask for a dcesrv_interface implementation
298          * - iface must be reference to an already existing struct !
299          */
300         bool (*interface_by_uuid)(struct dcesrv_interface *iface, const struct GUID *, uint32_t);
301
302         /* this function can be used by other endpoint servers to
303          * ask for a dcesrv_interface implementation
304          * - iface must be reference to an already existeng struct !
305          */
306         bool (*interface_by_name)(struct dcesrv_interface *iface, const char *);
307 };
308
309
310 /* one association groups */
311 struct dcesrv_assoc_group {
312         /* the wire id */
313         uint32_t id;
314         
315         /* list of handles in this association group */
316         struct dcesrv_handle *handles;
317
318         /* parent context */
319         struct dcesrv_context *dce_ctx;
320
321         /* Remote association group ID (if proxied) */
322         uint32_t proxied_id;
323 };
324
325 /* server-wide context information for the dcerpc server */
326 struct dcesrv_context {
327         /*
328          * The euid at startup time.
329          *
330          * This is required for DCERPC_AUTH_TYPE_NCALRPC_AS_SYSTEM
331          */
332         uid_t initial_euid;
333
334         /* the list of endpoints that have registered 
335          * by the configured endpoint servers 
336          */
337         struct dcesrv_endpoint {
338                 struct dcesrv_endpoint *next, *prev;
339                 /* the type and location of the endpoint */
340                 struct dcerpc_binding *ep_description;
341                 /* the security descriptor for smb named pipes */
342                 struct security_descriptor *sd;
343                 /* the list of interfaces available on this endpoint */
344                 struct dcesrv_if_list {
345                         struct dcesrv_if_list *next, *prev;
346                         struct dcesrv_interface iface;
347                 } *interface_list;
348         } *endpoint_list;
349
350         /* loadparm context to use for this connection */
351         struct loadparm_context *lp_ctx;
352
353         struct idr_context *assoc_groups_idr;
354
355         struct dcesrv_connection *broken_connections;
356 };
357
358 /* this structure is used by modules to determine the size of some critical types */
359 struct dcesrv_critical_sizes {
360         int interface_version;
361         int sizeof_dcesrv_context;
362         int sizeof_dcesrv_endpoint;
363         int sizeof_dcesrv_endpoint_server;
364         int sizeof_dcesrv_interface;
365         int sizeof_dcesrv_if_list;
366         int sizeof_dcesrv_connection;
367         int sizeof_dcesrv_call_state;
368         int sizeof_dcesrv_auth;
369         int sizeof_dcesrv_handle;
370 };
371
372 struct model_ops;
373
374 NTSTATUS dcesrv_interface_register(struct dcesrv_context *dce_ctx,
375                                    const char *ep_name,
376                                    const struct dcesrv_interface *iface,
377                                    const struct security_descriptor *sd);
378 NTSTATUS dcerpc_register_ep_server(const void *_ep_server);
379 NTSTATUS dcesrv_init_context(TALLOC_CTX *mem_ctx, 
380                                       struct loadparm_context *lp_ctx,
381                                       const char **endpoint_servers, struct dcesrv_context **_dce_ctx);
382 NTSTATUS dcesrv_endpoint_connect(struct dcesrv_context *dce_ctx,
383                                  TALLOC_CTX *mem_ctx,
384                                  const struct dcesrv_endpoint *ep,
385                                  struct auth_session_info *session_info,
386                                  struct tevent_context *event_ctx,
387                                  struct imessaging_context *msg_ctx,
388                                  struct server_id server_id,
389                                  uint32_t state_flags,
390                                  struct dcesrv_connection **_p);
391
392 NTSTATUS dcesrv_reply(struct dcesrv_call_state *call);
393 struct dcesrv_handle *dcesrv_handle_new(struct dcesrv_connection_context *context, 
394                                         uint8_t handle_type);
395
396 struct dcesrv_handle *dcesrv_handle_fetch(
397                                           struct dcesrv_connection_context *context, 
398                                           struct policy_handle *p,
399                                           uint8_t handle_type);
400 struct socket_address *dcesrv_connection_get_my_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
401
402 struct socket_address *dcesrv_connection_get_peer_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
403 const struct tsocket_address *dcesrv_connection_get_local_address(struct dcesrv_connection *conn);
404 const struct tsocket_address *dcesrv_connection_get_remote_address(struct dcesrv_connection *conn);
405
406 NTSTATUS dcesrv_fetch_session_key(struct dcesrv_connection *p, DATA_BLOB *session_key);
407
408 /* a useful macro for generating a RPC fault in the backend code */
409 #define DCESRV_FAULT(code) do { \
410         dce_call->fault_code = code; \
411         return r->out.result; \
412 } while(0)
413
414 /* a useful macro for generating a RPC fault in the backend code */
415 #define DCESRV_FAULT_VOID(code) do { \
416         dce_call->fault_code = code; \
417         return; \
418 } while(0)
419
420 /* a useful macro for checking the validity of a dcerpc policy handle
421    and giving the right fault code if invalid */
422 #define DCESRV_CHECK_HANDLE(h) do {if (!(h)) DCESRV_FAULT(DCERPC_FAULT_CONTEXT_MISMATCH); } while (0)
423
424 /* this checks for a valid policy handle, and gives a fault if an
425    invalid handle or retval if the handle is of the
426    wrong type */
427 #define DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, retval) do { \
428         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), DCESRV_HANDLE_ANY); \
429         DCESRV_CHECK_HANDLE(h); \
430         if ((t) != DCESRV_HANDLE_ANY && (h)->wire_handle.handle_type != (t)) { \
431                 return retval; \
432         } \
433 } while (0)
434
435 /* this checks for a valid policy handle and gives a dcerpc fault 
436    if its the wrong type of handle */
437 #define DCESRV_PULL_HANDLE_FAULT(h, inhandle, t) do { \
438         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), t); \
439         DCESRV_CHECK_HANDLE(h); \
440 } while (0)
441
442 #define DCESRV_PULL_HANDLE(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, NT_STATUS_INVALID_HANDLE)
443 #define DCESRV_PULL_HANDLE_WERR(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, WERR_BADFID)
444
445 NTSTATUS dcesrv_add_ep(struct dcesrv_context *dce_ctx,
446                        struct loadparm_context *lp_ctx,
447                        struct dcesrv_endpoint *e,
448                        struct tevent_context *event_ctx,
449                        const struct model_ops *model_ops);
450
451 /**
452  * retrieve credentials from a dce_call
453  */
454 _PUBLIC_ struct cli_credentials *dcesrv_call_credentials(struct dcesrv_call_state *dce_call);
455
456 /**
457  * returns true if this is an authenticated call
458  */
459 _PUBLIC_ bool dcesrv_call_authenticated(struct dcesrv_call_state *dce_call);
460
461 /**
462  * retrieve account_name for a dce_call
463  */
464 _PUBLIC_ const char *dcesrv_call_account_name(struct dcesrv_call_state *dce_call);
465
466 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_integrity(struct dcesrv_call_state *dce_call,
467                                                           const struct dcesrv_interface *iface);
468 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_privacy(struct dcesrv_call_state *dce_call,
469                                                         const struct dcesrv_interface *iface);
470 _PUBLIC_ NTSTATUS dcesrv_interface_bind_reject_connect(struct dcesrv_call_state *dce_call,
471                                                        const struct dcesrv_interface *iface);
472 _PUBLIC_ NTSTATUS dcesrv_interface_bind_allow_connect(struct dcesrv_call_state *dce_call,
473                                                       const struct dcesrv_interface *iface);
474
475 #endif /* SAMBA_DCERPC_SERVER_H */