2 Unix SMB/CIFS implementation.
4 server side dcerpc defines
6 Copyright (C) Andrew Tridgell 2003-2005
7 Copyright (C) Stefan (metze) Metzmacher 2004-2005
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.
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.
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/>.
23 #ifndef SAMBA_DCERPC_SERVER_H
24 #define SAMBA_DCERPC_SERVER_H
26 #include "librpc/gen_ndr/server_id.h"
27 #include "librpc/rpc/dcerpc.h"
28 #include "librpc/ndr/libndr.h"
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.
34 /* version 1 - initial version - metze */
35 #define DCERPC_MODULE_VERSION 1
37 struct dcesrv_connection;
38 struct dcesrv_call_state;
40 struct dcesrv_connection_context;
42 struct dcesrv_interface {
44 struct ndr_syntax_id syntax_id;
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);
49 /* this function is called when the client disconnects the endpoint */
50 void (*unbind)(struct dcesrv_connection_context *, const struct dcesrv_interface *);
52 /* the ndr_pull function for the chosen interface.
54 NTSTATUS (*ndr_pull)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_pull *, void **);
56 /* the dispatch function for the chosen interface.
58 NTSTATUS (*dispatch)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
60 /* the reply function for the chosen interface.
62 NTSTATUS (*reply)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
64 /* the ndr_push function for the chosen interface.
66 NTSTATUS (*ndr_push)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_push *, const void *);
68 /* for any private use by the interface code */
69 const void *private_data;
74 #define DCESRV_INTERFACE_FLAGS_HANDLES_NOT_USED 0x00000001
76 enum dcesrv_call_list {
78 DCESRV_LIST_CALL_LIST,
79 DCESRV_LIST_FRAGMENTED_CALL_LIST,
80 DCESRV_LIST_PENDING_CALL_LIST
83 struct data_blob_list_item {
84 struct data_blob_list_item *prev,*next;
88 /* the state of an ongoing dcerpc call */
89 struct dcesrv_call_state {
90 struct dcesrv_call_state *next, *prev;
91 struct dcesrv_connection *conn;
92 struct dcesrv_connection_context *context;
93 struct ncacn_packet pkt;
96 * Used during async bind/alter_context.
98 struct ncacn_packet ack_pkt;
101 which list this request is in, if any
103 enum dcesrv_call_list list;
105 /* the backend can mark the call
106 * with DCESRV_CALL_STATE_FLAG_ASYNC
107 * that will cause the frontend to not touch r->out
110 * this is only allowed to the backend when DCESRV_CALL_STATE_FLAG_MAY_ASYNC
111 * is alerady set by the frontend
113 * the backend then needs to call dcesrv_reply() when it's
114 * ready to send the reply
116 #define DCESRV_CALL_STATE_FLAG_ASYNC (1<<0)
117 #define DCESRV_CALL_STATE_FLAG_MAY_ASYNC (1<<1)
118 #define DCESRV_CALL_STATE_FLAG_MULTIPLEXED (1<<3)
119 #define DCESRV_CALL_STATE_FLAG_PROCESS_PENDING_CALL (1<<4)
120 uint32_t state_flags;
122 /* the time the request arrived in the server */
125 /* the backend can use this event context for async replies */
126 struct tevent_context *event_ctx;
128 /* the message_context that will be used for async replies */
129 struct imessaging_context *msg_ctx;
131 /* this is the pointer to the allocated function struct */
135 * that's the ndr pull context used in dcesrv_request()
136 * needed by dcesrv_reply() to carry over information
137 * for full pointer support.
139 struct ndr_pull *ndr_pull;
143 struct data_blob_list_item *replies;
145 /* this is used by the boilerplate code to generate DCERPC faults */
148 /* the reason why we terminate the connection after sending a response */
149 const char *terminate_reason;
151 /* temporary auth_info fields */
152 struct dcerpc_auth in_auth_info;
153 struct dcerpc_auth _out_auth_info;
154 struct dcerpc_auth *out_auth_info;
160 * The various handles that are used in the RPC servers should be
161 * created and fetch using the dcesrv_handle_* functions.
164 * dcesrv_handle_new(struct dcesrv_connection \*, uint8 handle_type)
165 * to obtain a new handle of the specified type. Handle types are
166 * unique within each pipe.
168 * The handle can later be fetched again using:
170 * struct dcesrv_handle *dcesrv_handle_fetch(
171 * struct dcesrv_connection *dce_conn,
172 * struct policy_handle *p,
177 * dcesrv_handle_destroy(struct dcesrv_handle *).
179 * User data should be stored in the 'data' member of the dcesrv_handle
183 #define DCESRV_HANDLE_ANY 255
185 /* a dcerpc handle in internal format */
186 struct dcesrv_handle {
187 struct dcesrv_handle *next, *prev;
188 struct dcesrv_assoc_group *assoc_group;
189 struct policy_handle wire_handle;
191 const struct dcesrv_interface *iface;
195 /* hold the authentication state information */
197 enum dcerpc_AuthType auth_type;
198 enum dcerpc_AuthLevel auth_level;
199 uint32_t auth_context_id;
200 struct gensec_security *gensec_security;
201 struct auth_session_info *session_info;
202 NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
203 bool client_hdr_signing;
209 struct dcesrv_connection_context {
210 struct dcesrv_connection_context *next, *prev;
213 /* the connection this is on */
214 struct dcesrv_connection *conn;
216 /* the ndr function table for the chosen interface */
217 const struct dcesrv_interface *iface;
219 /* private data for the interface implementation */
223 * the minimum required auth level for this interface
225 enum dcerpc_AuthLevel min_auth_level;
228 /* the negotiated transfer syntax */
229 struct ndr_syntax_id transfer_syntax;
233 /* the state associated with a dcerpc server connection */
234 struct dcesrv_connection {
235 /* for the broken_connections DLIST */
236 struct dcesrv_connection *prev, *next;
238 /* the top level context for this server */
239 struct dcesrv_context *dce_ctx;
241 /* the endpoint that was opened */
242 const struct dcesrv_endpoint *endpoint;
244 /* a list of established context_ids */
245 struct dcesrv_connection_context *contexts;
247 /* the state of the current incoming call fragments */
248 struct dcesrv_call_state *incoming_fragmented_call_list;
250 /* the state of the async pending calls */
251 struct dcesrv_call_state *pending_call_list;
253 /* the state of the current outgoing calls */
254 struct dcesrv_call_state *call_list;
256 /* the maximum size the client wants to receive */
257 uint16_t max_recv_frag;
258 uint16_t max_xmit_frag;
260 DATA_BLOB partial_input;
262 /* the event_context that will be used for this connection */
263 struct tevent_context *event_ctx;
265 /* the message_context that will be used for this connection */
266 struct imessaging_context *msg_ctx;
268 /* the server_id that will be used for this connection */
269 struct server_id server_id;
271 /* is this connection pending termination? If so, why? */
272 const char *terminate;
274 const char *packet_log_dir;
276 /* this is the default state_flags for dcesrv_call_state structs */
277 uint32_t state_flags;
281 void (*report_output_data)(struct dcesrv_connection *);
284 struct tstream_context *stream;
285 struct tevent_queue *send_queue;
287 const struct tsocket_address *local_address;
288 const struct tsocket_address *remote_address;
290 /* the current authentication state */
291 struct dcesrv_auth auth_state;
294 * remember which pdu types are allowed
301 /* the association group the connection belongs to */
302 struct dcesrv_assoc_group *assoc_group;
304 /* The maximum total payload of reassembled request pdus */
305 size_t max_total_request_size;
308 * Our preferred transfer syntax.
310 const struct ndr_syntax_id *preferred_transfer;
312 /* the negotiated bind time features */
313 uint16_t bind_time_features;
316 * This is used to block the connection during
317 * pending authentication.
319 struct tevent_req *(*wait_send)(TALLOC_CTX *mem_ctx,
320 struct tevent_context *ev,
322 NTSTATUS (*wait_recv)(struct tevent_req *req);
327 struct dcesrv_endpoint_server {
328 /* this is the name of the endpoint server */
331 /* this function should register endpoints and some other setup stuff,
332 * it is called when the dcesrv_context gets initialized.
334 NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
336 /* this function can be used by other endpoint servers to
337 * ask for a dcesrv_interface implementation
338 * - iface must be reference to an already existing struct !
340 bool (*interface_by_uuid)(struct dcesrv_interface *iface, const struct GUID *, uint32_t);
342 /* this function can be used by other endpoint servers to
343 * ask for a dcesrv_interface implementation
344 * - iface must be reference to an already existeng struct !
346 bool (*interface_by_name)(struct dcesrv_interface *iface, const char *);
350 /* one association groups */
351 struct dcesrv_assoc_group {
355 /* list of handles in this association group */
356 struct dcesrv_handle *handles;
359 struct dcesrv_context *dce_ctx;
361 /* Remote association group ID (if proxied) */
365 /* server-wide context information for the dcerpc server */
366 struct dcesrv_context {
368 * The euid at startup time.
370 * This is required for DCERPC_AUTH_TYPE_NCALRPC_AS_SYSTEM
374 /* the list of endpoints that have registered
375 * by the configured endpoint servers
377 struct dcesrv_endpoint {
378 struct dcesrv_endpoint *next, *prev;
379 /* the type and location of the endpoint */
380 struct dcerpc_binding *ep_description;
381 /* the security descriptor for smb named pipes */
382 struct security_descriptor *sd;
383 /* the list of interfaces available on this endpoint */
384 struct dcesrv_if_list {
385 struct dcesrv_if_list *next, *prev;
386 struct dcesrv_interface iface;
390 * Should this service be run in a single process (so far only
391 * NETLOGON is not run in a single process)
393 bool use_single_process;
396 /* loadparm context to use for this connection */
397 struct loadparm_context *lp_ctx;
399 struct idr_context *assoc_groups_idr;
401 struct dcesrv_connection *broken_connections;
404 /* this structure is used by modules to determine the size of some critical types */
405 struct dcesrv_critical_sizes {
406 int interface_version;
407 int sizeof_dcesrv_context;
408 int sizeof_dcesrv_endpoint;
409 int sizeof_dcesrv_endpoint_server;
410 int sizeof_dcesrv_interface;
411 int sizeof_dcesrv_if_list;
412 int sizeof_dcesrv_connection;
413 int sizeof_dcesrv_call_state;
414 int sizeof_dcesrv_auth;
415 int sizeof_dcesrv_handle;
420 NTSTATUS dcesrv_interface_register(struct dcesrv_context *dce_ctx,
422 const struct dcesrv_interface *iface,
423 const struct security_descriptor *sd);
424 NTSTATUS dcerpc_register_ep_server(const struct dcesrv_endpoint_server *ep_server);
425 NTSTATUS dcesrv_init_context(TALLOC_CTX *mem_ctx,
426 struct loadparm_context *lp_ctx,
427 const char **endpoint_servers, struct dcesrv_context **_dce_ctx);
428 NTSTATUS dcesrv_endpoint_connect(struct dcesrv_context *dce_ctx,
430 const struct dcesrv_endpoint *ep,
431 struct auth_session_info *session_info,
432 struct tevent_context *event_ctx,
433 struct imessaging_context *msg_ctx,
434 struct server_id server_id,
435 uint32_t state_flags,
436 struct dcesrv_connection **_p);
438 NTSTATUS dcesrv_reply(struct dcesrv_call_state *call);
439 struct dcesrv_handle *dcesrv_handle_new(struct dcesrv_connection_context *context,
440 uint8_t handle_type);
442 struct dcesrv_handle *dcesrv_handle_fetch(
443 struct dcesrv_connection_context *context,
444 struct policy_handle *p,
445 uint8_t handle_type);
447 const struct tsocket_address *dcesrv_connection_get_local_address(struct dcesrv_connection *conn);
448 const struct tsocket_address *dcesrv_connection_get_remote_address(struct dcesrv_connection *conn);
450 NTSTATUS dcesrv_fetch_session_key(struct dcesrv_connection *p, DATA_BLOB *session_key);
452 /* a useful macro for generating a RPC fault in the backend code */
453 #define DCESRV_FAULT(code) do { \
454 dce_call->fault_code = code; \
455 return r->out.result; \
458 /* a useful macro for generating a RPC fault in the backend code */
459 #define DCESRV_FAULT_VOID(code) do { \
460 dce_call->fault_code = code; \
464 /* a useful macro for checking the validity of a dcerpc policy handle
465 and giving the right fault code if invalid */
466 #define DCESRV_CHECK_HANDLE(h) do {if (!(h)) DCESRV_FAULT(DCERPC_FAULT_CONTEXT_MISMATCH); } while (0)
468 /* this checks for a valid policy handle, and gives a fault if an
469 invalid handle or retval if the handle is of the
471 #define DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, retval) do { \
472 (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), DCESRV_HANDLE_ANY); \
473 DCESRV_CHECK_HANDLE(h); \
474 if ((t) != DCESRV_HANDLE_ANY && (h)->wire_handle.handle_type != (t)) { \
479 /* this checks for a valid policy handle and gives a dcerpc fault
480 if its the wrong type of handle */
481 #define DCESRV_PULL_HANDLE_FAULT(h, inhandle, t) do { \
482 (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), t); \
483 DCESRV_CHECK_HANDLE(h); \
486 #define DCESRV_PULL_HANDLE(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, NT_STATUS_INVALID_HANDLE)
487 #define DCESRV_PULL_HANDLE_WERR(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, WERR_INVALID_HANDLE)
489 NTSTATUS dcesrv_add_ep(struct dcesrv_context *dce_ctx,
490 struct loadparm_context *lp_ctx,
491 struct dcesrv_endpoint *e,
492 struct tevent_context *event_ctx,
493 const struct model_ops *model_ops,
494 void *process_context);
497 * retrieve credentials from a dce_call
499 _PUBLIC_ struct cli_credentials *dcesrv_call_credentials(struct dcesrv_call_state *dce_call);
502 * returns true if this is an authenticated call
504 _PUBLIC_ bool dcesrv_call_authenticated(struct dcesrv_call_state *dce_call);
507 * retrieve account_name for a dce_call
509 _PUBLIC_ const char *dcesrv_call_account_name(struct dcesrv_call_state *dce_call);
512 * retrieve session_info from a dce_call
514 _PUBLIC_ struct auth_session_info *dcesrv_call_session_info(struct dcesrv_call_state *dce_call);
516 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_integrity(struct dcesrv_call_state *dce_call,
517 const struct dcesrv_interface *iface);
518 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_privacy(struct dcesrv_call_state *dce_call,
519 const struct dcesrv_interface *iface);
520 _PUBLIC_ NTSTATUS dcesrv_interface_bind_reject_connect(struct dcesrv_call_state *dce_call,
521 const struct dcesrv_interface *iface);
522 _PUBLIC_ NTSTATUS dcesrv_interface_bind_allow_connect(struct dcesrv_call_state *dce_call,
523 const struct dcesrv_interface *iface);
525 #endif /* SAMBA_DCERPC_SERVER_H */