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