b7ae113c2b25b10a2d84136b713e3428670cfe20
[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 };
172
173 struct dcesrv_connection_context {
174         struct dcesrv_connection_context *next, *prev;
175         uint32_t context_id;
176
177         struct dcesrv_assoc_group *assoc_group;
178
179         /* the connection this is on */
180         struct dcesrv_connection *conn;
181
182         /* the ndr function table for the chosen interface */
183         const struct dcesrv_interface *iface;
184
185         /* private data for the interface implementation */
186         void *private_data;
187
188         /*
189          * the minimum required auth level for this interface
190          */
191         enum dcerpc_AuthLevel min_auth_level;
192         bool allow_connect;
193 };
194
195
196 /* the state associated with a dcerpc server connection */
197 struct dcesrv_connection {
198         /* for the broken_connections DLIST */
199         struct dcesrv_connection *prev, *next;
200
201         /* the top level context for this server */
202         struct dcesrv_context *dce_ctx;
203
204         /* the endpoint that was opened */
205         const struct dcesrv_endpoint *endpoint;
206
207         /* a list of established context_ids */
208         struct dcesrv_connection_context *contexts;
209
210         /* the state of the current incoming call fragments */
211         struct dcesrv_call_state *incoming_fragmented_call_list;
212
213         /* the state of the async pending calls */
214         struct dcesrv_call_state *pending_call_list;
215
216         /* the state of the current outgoing calls */
217         struct dcesrv_call_state *call_list;
218
219         /* the maximum size the client wants to receive */
220         uint16_t max_recv_frag;
221         uint16_t max_xmit_frag;
222
223         DATA_BLOB partial_input;
224
225         /* This can be removed in master... */
226         struct  {
227                 struct dcerpc_auth *auth_info;
228                 struct gensec_security *gensec_security;
229                 struct auth_session_info *session_info;
230                 NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
231                 bool client_hdr_signing;
232                 bool hdr_signing;
233         } _unused_auth_state;
234
235         /* the event_context that will be used for this connection */
236         struct tevent_context *event_ctx;
237
238         /* the message_context that will be used for this connection */
239         struct imessaging_context *msg_ctx;
240
241         /* the server_id that will be used for this connection */
242         struct server_id server_id;
243
244         /* the transport level session key */
245         DATA_BLOB transport_session_key;
246
247         /* is this connection pending termination?  If so, why? */
248         const char *terminate;
249
250         const char *packet_log_dir;
251
252         /* this is the default state_flags for dcesrv_call_state structs */
253         uint32_t state_flags;
254
255         struct {
256                 void *private_data;
257                 void (*report_output_data)(struct dcesrv_connection *);
258         } transport;
259
260         struct tstream_context *stream;
261         struct tevent_queue *send_queue;
262
263         const struct tsocket_address *local_address;
264         const struct tsocket_address *remote_address;
265
266         /* the current authentication state */
267         struct dcesrv_auth auth_state;
268
269         /*
270          * remember which pdu types are allowed
271          */
272         bool allow_bind;
273         bool allow_auth3;
274         bool allow_alter;
275         bool allow_request;
276 };
277
278
279 struct dcesrv_endpoint_server {
280         /* this is the name of the endpoint server */
281         const char *name;
282
283         /* this function should register endpoints and some other setup stuff,
284          * it is called when the dcesrv_context gets initialized.
285          */
286         NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
287
288         /* this function can be used by other endpoint servers to
289          * ask for a dcesrv_interface implementation
290          * - iface must be reference to an already existing struct !
291          */
292         bool (*interface_by_uuid)(struct dcesrv_interface *iface, const struct GUID *, uint32_t);
293
294         /* this function can be used by other endpoint servers to
295          * ask for a dcesrv_interface implementation
296          * - iface must be reference to an already existeng struct !
297          */
298         bool (*interface_by_name)(struct dcesrv_interface *iface, const char *);
299 };
300
301
302 /* one association groups */
303 struct dcesrv_assoc_group {
304         /* the wire id */
305         uint32_t id;
306         
307         /* list of handles in this association group */
308         struct dcesrv_handle *handles;
309
310         /* parent context */
311         struct dcesrv_context *dce_ctx;
312
313         /* Remote association group ID (if proxied) */
314         uint32_t proxied_id;
315 };
316
317 /* server-wide context information for the dcerpc server */
318 struct dcesrv_context {
319         /*
320          * The euid at startup time.
321          *
322          * This is required for DCERPC_AUTH_TYPE_NCALRPC_AS_SYSTEM
323          */
324         uid_t initial_euid;
325
326         /* the list of endpoints that have registered 
327          * by the configured endpoint servers 
328          */
329         struct dcesrv_endpoint {
330                 struct dcesrv_endpoint *next, *prev;
331                 /* the type and location of the endpoint */
332                 struct dcerpc_binding *ep_description;
333                 /* the security descriptor for smb named pipes */
334                 struct security_descriptor *sd;
335                 /* the list of interfaces available on this endpoint */
336                 struct dcesrv_if_list {
337                         struct dcesrv_if_list *next, *prev;
338                         struct dcesrv_interface iface;
339                 } *interface_list;
340         } *endpoint_list;
341
342         /* loadparm context to use for this connection */
343         struct loadparm_context *lp_ctx;
344
345         struct idr_context *assoc_groups_idr;
346
347         struct dcesrv_connection *broken_connections;
348 };
349
350 /* this structure is used by modules to determine the size of some critical types */
351 struct dcesrv_critical_sizes {
352         int interface_version;
353         int sizeof_dcesrv_context;
354         int sizeof_dcesrv_endpoint;
355         int sizeof_dcesrv_endpoint_server;
356         int sizeof_dcesrv_interface;
357         int sizeof_dcesrv_if_list;
358         int sizeof_dcesrv_connection;
359         int sizeof_dcesrv_call_state;
360         int sizeof_dcesrv_auth;
361         int sizeof_dcesrv_handle;
362 };
363
364 struct model_ops;
365
366 NTSTATUS dcesrv_interface_register(struct dcesrv_context *dce_ctx,
367                                    const char *ep_name,
368                                    const struct dcesrv_interface *iface,
369                                    const struct security_descriptor *sd);
370 NTSTATUS dcerpc_register_ep_server(const void *_ep_server);
371 NTSTATUS dcesrv_init_context(TALLOC_CTX *mem_ctx, 
372                                       struct loadparm_context *lp_ctx,
373                                       const char **endpoint_servers, struct dcesrv_context **_dce_ctx);
374 NTSTATUS dcesrv_endpoint_connect(struct dcesrv_context *dce_ctx,
375                                  TALLOC_CTX *mem_ctx,
376                                  const struct dcesrv_endpoint *ep,
377                                  struct auth_session_info *session_info,
378                                  struct tevent_context *event_ctx,
379                                  struct imessaging_context *msg_ctx,
380                                  struct server_id server_id,
381                                  uint32_t state_flags,
382                                  struct dcesrv_connection **_p);
383
384 NTSTATUS dcesrv_reply(struct dcesrv_call_state *call);
385 struct dcesrv_handle *dcesrv_handle_new(struct dcesrv_connection_context *context, 
386                                         uint8_t handle_type);
387
388 struct dcesrv_handle *dcesrv_handle_fetch(
389                                           struct dcesrv_connection_context *context, 
390                                           struct policy_handle *p,
391                                           uint8_t handle_type);
392 struct socket_address *dcesrv_connection_get_my_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
393
394 struct socket_address *dcesrv_connection_get_peer_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
395 const struct tsocket_address *dcesrv_connection_get_local_address(struct dcesrv_connection *conn);
396 const struct tsocket_address *dcesrv_connection_get_remote_address(struct dcesrv_connection *conn);
397
398 NTSTATUS dcesrv_fetch_session_key(struct dcesrv_connection *p, DATA_BLOB *session_key);
399
400 /* a useful macro for generating a RPC fault in the backend code */
401 #define DCESRV_FAULT(code) do { \
402         dce_call->fault_code = code; \
403         return r->out.result; \
404 } while(0)
405
406 /* a useful macro for generating a RPC fault in the backend code */
407 #define DCESRV_FAULT_VOID(code) do { \
408         dce_call->fault_code = code; \
409         return; \
410 } while(0)
411
412 /* a useful macro for checking the validity of a dcerpc policy handle
413    and giving the right fault code if invalid */
414 #define DCESRV_CHECK_HANDLE(h) do {if (!(h)) DCESRV_FAULT(DCERPC_FAULT_CONTEXT_MISMATCH); } while (0)
415
416 /* this checks for a valid policy handle, and gives a fault if an
417    invalid handle or retval if the handle is of the
418    wrong type */
419 #define DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, retval) do { \
420         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), DCESRV_HANDLE_ANY); \
421         DCESRV_CHECK_HANDLE(h); \
422         if ((t) != DCESRV_HANDLE_ANY && (h)->wire_handle.handle_type != (t)) { \
423                 return retval; \
424         } \
425 } while (0)
426
427 /* this checks for a valid policy handle and gives a dcerpc fault 
428    if its the wrong type of handle */
429 #define DCESRV_PULL_HANDLE_FAULT(h, inhandle, t) do { \
430         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), t); \
431         DCESRV_CHECK_HANDLE(h); \
432 } while (0)
433
434 #define DCESRV_PULL_HANDLE(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, NT_STATUS_INVALID_HANDLE)
435 #define DCESRV_PULL_HANDLE_WERR(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, WERR_BADFID)
436
437 NTSTATUS dcesrv_add_ep(struct dcesrv_context *dce_ctx,
438                        struct loadparm_context *lp_ctx,
439                        struct dcesrv_endpoint *e,
440                        struct tevent_context *event_ctx,
441                        const struct model_ops *model_ops);
442
443 /**
444  * retrieve credentials from a dce_call
445  */
446 _PUBLIC_ struct cli_credentials *dcesrv_call_credentials(struct dcesrv_call_state *dce_call);
447
448 /**
449  * returns true if this is an authenticated call
450  */
451 _PUBLIC_ bool dcesrv_call_authenticated(struct dcesrv_call_state *dce_call);
452
453 /**
454  * retrieve account_name for a dce_call
455  */
456 _PUBLIC_ const char *dcesrv_call_account_name(struct dcesrv_call_state *dce_call);
457
458 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_integrity(struct dcesrv_call_state *dce_call,
459                                                           const struct dcesrv_interface *iface);
460 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_privacy(struct dcesrv_call_state *dce_call,
461                                                         const struct dcesrv_interface *iface);
462 _PUBLIC_ NTSTATUS dcesrv_interface_bind_reject_connect(struct dcesrv_call_state *dce_call,
463                                                        const struct dcesrv_interface *iface);
464 _PUBLIC_ NTSTATUS dcesrv_interface_bind_allow_connect(struct dcesrv_call_state *dce_call,
465                                                       const struct dcesrv_interface *iface);
466
467 #endif /* SAMBA_DCERPC_SERVER_H */