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