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/rpc/rpc_common.h"
27 #include "librpc/ndr/libndr.h"
29 /* modules can use the following to determine if the interface has changed
30 * please increment the version number after each interface change
31 * with a comment and maybe update struct dcesrv_critical_sizes.
33 /* version 1 - initial version - metze */
34 #define DCERPC_MODULE_VERSION 1
36 struct dcesrv_connection;
37 struct dcesrv_call_state;
39 struct dcesrv_connection_context;
40 struct dcesrv_iface_state;
41 struct cli_credentials;
43 struct dcesrv_interface {
45 struct ndr_syntax_id syntax_id;
47 /* this function is called when the client binds to this interface */
48 NTSTATUS (*bind)(struct dcesrv_connection_context *, const struct dcesrv_interface *);
50 /* this function is called when the client disconnects the endpoint */
51 void (*unbind)(struct dcesrv_connection_context *, const struct dcesrv_interface *);
53 /* the ndr_pull function for the chosen interface.
55 NTSTATUS (*ndr_pull)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_pull *, void **);
57 /* the dispatch function for the chosen interface.
59 NTSTATUS (*dispatch)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
61 /* the reply function for the chosen interface.
63 NTSTATUS (*reply)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
65 /* the ndr_push function for the chosen interface.
67 NTSTATUS (*ndr_push)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_push *, const void *);
69 /* for any private use by the interface code */
70 const void *private_data;
75 #define DCESRV_INTERFACE_FLAGS_HANDLES_NOT_USED 0x00000001
77 enum dcesrv_call_list {
79 DCESRV_LIST_CALL_LIST,
80 DCESRV_LIST_FRAGMENTED_CALL_LIST,
81 DCESRV_LIST_PENDING_CALL_LIST
84 struct data_blob_list_item {
85 struct data_blob_list_item *prev,*next;
89 /* the state of an ongoing dcerpc call */
90 struct dcesrv_call_state {
91 struct dcesrv_call_state *next, *prev;
92 struct dcesrv_auth *auth_state;
93 struct dcesrv_connection *conn;
94 struct dcesrv_connection_context *context;
95 struct ncacn_packet pkt;
98 * Used during async bind/alter_context.
100 struct ncacn_packet ack_pkt;
103 which list this request is in, if any
105 enum dcesrv_call_list list;
107 /* the backend can mark the call
108 * with DCESRV_CALL_STATE_FLAG_ASYNC
109 * that will cause the frontend to not touch r->out
112 * this is only allowed to the backend when DCESRV_CALL_STATE_FLAG_MAY_ASYNC
113 * is alerady set by the frontend
115 * the backend then needs to call dcesrv_reply() when it's
116 * ready to send the reply
118 #define DCESRV_CALL_STATE_FLAG_ASYNC (1<<0)
119 #define DCESRV_CALL_STATE_FLAG_MAY_ASYNC (1<<1)
120 #define DCESRV_CALL_STATE_FLAG_MULTIPLEXED (1<<3)
121 #define DCESRV_CALL_STATE_FLAG_PROCESS_PENDING_CALL (1<<4)
122 uint32_t state_flags;
124 /* the time the request arrived in the server */
127 /* the backend can use this event context for async replies */
128 struct tevent_context *event_ctx;
130 /* this is the pointer to the allocated function struct */
134 * that's the ndr pull context used in dcesrv_request()
135 * needed by dcesrv_reply() to carry over information
136 * for full pointer support.
138 struct ndr_pull *ndr_pull;
142 struct data_blob_list_item *replies;
144 /* this is used by the boilerplate code to generate DCERPC faults */
147 /* the reason why we terminate the connection after sending a response */
148 const char *terminate_reason;
150 /* temporary auth_info fields */
151 struct dcerpc_auth in_auth_info;
152 struct dcerpc_auth _out_auth_info;
153 struct dcerpc_auth *out_auth_info;
159 * The various handles that are used in the RPC servers should be
160 * created and fetch using the dcesrv_handle_* functions.
163 * dcesrv_handle_create(struct dcesrv_call_state \*, uint8 handle_type)
164 * to obtain a new handle of the specified type. Handle types are
165 * unique within each pipe.
167 * The handle can later be fetched again using:
169 * struct dcesrv_handle *dcesrv_handle_lookup(
170 * struct dcesrv_call_state *dce_call,
171 * struct policy_handle *p,
176 * TALLOC_FREE(struct dcesrv_handle *).
178 * User data should be stored in the 'data' member of the dcesrv_handle
182 #define DCESRV_HANDLE_ANY 255
184 /* a dcerpc handle in internal format */
185 struct dcesrv_handle {
186 struct dcesrv_handle *next, *prev;
187 struct dcesrv_assoc_group *assoc_group;
188 struct policy_handle wire_handle;
190 enum dcerpc_AuthLevel min_auth_level;
191 const struct dcesrv_interface *iface;
195 /* hold the authentication state information */
197 struct dcesrv_auth *prev, *next;
198 enum dcerpc_AuthType auth_type;
199 enum dcerpc_AuthLevel auth_level;
200 uint32_t auth_context_id;
201 struct gensec_security *gensec_security;
202 struct auth_session_info *session_info;
203 NTSTATUS (*session_key_fn)(struct dcesrv_auth *, DATA_BLOB *session_key);
210 struct dcesrv_connection_context {
211 struct dcesrv_connection_context *next, *prev;
214 /* the connection this is on */
215 struct dcesrv_connection *conn;
217 /* the ndr function table for the chosen interface */
218 const struct dcesrv_interface *iface;
221 * the minimum required auth level for this interface
223 enum dcerpc_AuthLevel min_auth_level;
226 /* the negotiated transfer syntax */
227 struct ndr_syntax_id transfer_syntax;
231 /* the state associated with a dcerpc server connection */
232 struct dcesrv_connection {
233 /* for the broken_connections DLIST */
234 struct dcesrv_connection *prev, *next;
236 /* the top level context for this server */
237 struct dcesrv_context *dce_ctx;
239 /* the endpoint that was opened */
240 const struct dcesrv_endpoint *endpoint;
242 /* a list of established context_ids */
243 struct dcesrv_connection_context *contexts;
245 /* the state of the current incoming call fragments */
246 struct dcesrv_call_state *incoming_fragmented_call_list;
248 /* the state of the async pending calls */
249 struct dcesrv_call_state *pending_call_list;
251 /* the state of the current outgoing calls */
252 struct dcesrv_call_state *call_list;
254 /* the maximum size the client wants to receive */
255 uint16_t max_recv_frag;
256 uint16_t max_xmit_frag;
258 DATA_BLOB partial_input;
260 /* the event_context that will be used for this connection */
261 struct tevent_context *event_ctx;
263 /* is this connection pending termination? If so, why? */
264 const char *terminate;
266 const char *packet_log_dir;
268 /* this is the default state_flags for dcesrv_call_state structs */
269 uint32_t state_flags;
273 void (*report_output_data)(struct dcesrv_connection *);
276 struct tstream_context *stream;
277 struct tevent_queue *send_queue;
279 const struct tsocket_address *local_address;
280 const struct tsocket_address *remote_address;
282 /* the current authentication state */
283 struct dcesrv_auth *default_auth_state;
284 size_t max_auth_states;
285 struct dcesrv_auth *auth_states;
286 bool got_explicit_auth_level_connect;
287 struct dcesrv_auth *default_auth_level_connect;
288 bool client_hdr_signing;
289 bool support_hdr_signing;
290 bool negotiated_hdr_signing;
293 * remember which pdu types are allowed
298 /* the association group the connection belongs to */
299 struct dcesrv_assoc_group *assoc_group;
301 /* The maximum total payload of reassembled request pdus */
302 size_t max_total_request_size;
305 * Our preferred transfer syntax.
307 const struct ndr_syntax_id *preferred_transfer;
310 * This is used to block the connection during
311 * pending authentication.
313 struct tevent_req *(*wait_send)(TALLOC_CTX *mem_ctx,
314 struct tevent_context *ev,
316 NTSTATUS (*wait_recv)(struct tevent_req *req);
321 struct dcesrv_endpoint_server {
322 /* this is the name of the endpoint server */
325 /* this function should register endpoints and some other setup stuff,
326 * it is called when the dcesrv_context gets initialized.
328 NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
330 /* this function can be used by other endpoint servers to
331 * ask for a dcesrv_interface implementation
332 * - iface must be reference to an already existing struct !
334 bool (*interface_by_uuid)(struct dcesrv_interface *iface, const struct GUID *, uint32_t);
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 existeng struct !
340 bool (*interface_by_name)(struct dcesrv_interface *iface, const char *);
344 /* one association groups */
345 struct dcesrv_assoc_group {
349 /* The transport this is valid on */
350 enum dcerpc_transport_t transport;
352 /* list of handles in this association group */
353 struct dcesrv_handle *handles;
356 * list of iface states per assoc/conn
358 struct dcesrv_iface_state *iface_states;
361 struct dcesrv_context *dce_ctx;
363 /* the negotiated bind time features */
364 uint16_t bind_time_features;
367 struct dcesrv_context_callbacks {
369 void (*successful_authz)(struct dcesrv_call_state *);
372 NTSTATUS (*gensec_prepare)(TALLOC_CTX *mem_ctx,
373 struct dcesrv_call_state *call,
374 struct gensec_security **out);
377 NTSTATUS (*find)(struct dcesrv_call_state *);
381 /* server-wide context information for the dcerpc server */
382 struct dcesrv_context {
384 * The euid at startup time.
386 * This is required for DCERPC_AUTH_TYPE_NCALRPC_AS_SYSTEM
390 /* the list of endpoints that have registered
391 * by the configured endpoint servers
393 struct dcesrv_endpoint {
394 struct dcesrv_endpoint *next, *prev;
395 /* the type and location of the endpoint */
396 struct dcerpc_binding *ep_description;
397 /* the secondary endpoint description for the BIND_ACK */
398 struct dcerpc_binding *ep_2nd_description;
399 /* the security descriptor for smb named pipes */
400 struct security_descriptor *sd;
401 /* the list of interfaces available on this endpoint */
402 struct dcesrv_if_list {
403 struct dcesrv_if_list *next, *prev;
404 struct dcesrv_interface iface;
408 * Should this service be run in a single process (so far only
409 * NETLOGON is not run in a single process)
411 bool use_single_process;
414 /* loadparm context to use for this connection */
415 struct loadparm_context *lp_ctx;
417 struct idr_context *assoc_groups_idr;
419 struct dcesrv_connection *broken_connections;
421 struct dcesrv_context_callbacks callbacks;
424 /* this structure is used by modules to determine the size of some critical types */
425 struct dcesrv_critical_sizes {
426 int interface_version;
427 int sizeof_dcesrv_context;
428 int sizeof_dcesrv_endpoint;
429 int sizeof_dcesrv_endpoint_server;
430 int sizeof_dcesrv_interface;
431 int sizeof_dcesrv_if_list;
432 int sizeof_dcesrv_connection;
433 int sizeof_dcesrv_call_state;
434 int sizeof_dcesrv_auth;
435 int sizeof_dcesrv_handle;
440 NTSTATUS dcesrv_interface_register(struct dcesrv_context *dce_ctx,
442 const char *ncacn_np_secondary_endpoint,
443 const struct dcesrv_interface *iface,
444 const struct security_descriptor *sd);
445 NTSTATUS dcerpc_register_ep_server(const struct dcesrv_endpoint_server *ep_server);
446 NTSTATUS dcesrv_init_context(TALLOC_CTX *mem_ctx,
447 struct loadparm_context *lp_ctx,
448 const char **endpoint_servers,
449 struct dcesrv_context_callbacks *cb,
450 struct dcesrv_context **_dce_ctx);
452 NTSTATUS dcesrv_reply(struct dcesrv_call_state *call);
453 struct dcesrv_handle *dcesrv_handle_create(struct dcesrv_call_state *call,
454 uint8_t handle_type);
456 struct dcesrv_handle *dcesrv_handle_lookup(struct dcesrv_call_state *call,
457 const struct policy_handle *p,
458 uint8_t handle_type);
460 const struct tsocket_address *dcesrv_connection_get_local_address(struct dcesrv_connection *conn);
461 const struct tsocket_address *dcesrv_connection_get_remote_address(struct dcesrv_connection *conn);
464 * Fetch the authentication session key if available.
466 * This is the key generated by a gensec authentication.
468 NTSTATUS dcesrv_auth_session_key(struct dcesrv_call_state *call,
469 DATA_BLOB *session_key);
472 * Fetch the transport session key if available.
473 * Typically this is the SMB session key
474 * or a fixed key for local transports.
476 * The key is always truncated to 16 bytes.
478 NTSTATUS dcesrv_transport_session_key(struct dcesrv_call_state *call,
479 DATA_BLOB *session_key);
481 /* a useful macro for generating a RPC fault in the backend code */
482 #define DCESRV_FAULT(code) do { \
483 dce_call->fault_code = code; \
484 return r->out.result; \
487 /* a useful macro for generating a RPC fault in the backend code */
488 #define DCESRV_FAULT_VOID(code) do { \
489 dce_call->fault_code = code; \
493 /* a useful macro for checking the validity of a dcerpc policy handle
494 and giving the right fault code if invalid */
495 #define DCESRV_CHECK_HANDLE(h) do {if (!(h)) DCESRV_FAULT(DCERPC_FAULT_CONTEXT_MISMATCH); } while (0)
497 /* this checks for a valid policy handle, and gives a fault if an
498 invalid handle or retval if the handle is of the
500 #define DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, retval) do { \
501 (h) = dcesrv_handle_lookup(dce_call, (inhandle), DCESRV_HANDLE_ANY); \
502 DCESRV_CHECK_HANDLE(h); \
503 if ((t) != DCESRV_HANDLE_ANY && (h)->wire_handle.handle_type != (t)) { \
508 /* this checks for a valid policy handle and gives a dcerpc fault
509 if its the wrong type of handle */
510 #define DCESRV_PULL_HANDLE_FAULT(h, inhandle, t) do { \
511 (h) = dcesrv_handle_lookup(dce_call, (inhandle), t); \
512 DCESRV_CHECK_HANDLE(h); \
515 #define DCESRV_PULL_HANDLE(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, NT_STATUS_INVALID_HANDLE)
516 #define DCESRV_PULL_HANDLE_WERR(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, WERR_INVALID_HANDLE)
518 NTSTATUS dcesrv_add_ep(struct dcesrv_context *dce_ctx,
519 struct loadparm_context *lp_ctx,
520 struct dcesrv_endpoint *e,
521 struct tevent_context *event_ctx,
522 const struct model_ops *model_ops,
523 void *process_context);
526 * retrieve credentials from a dce_call
528 _PUBLIC_ struct cli_credentials *dcesrv_call_credentials(struct dcesrv_call_state *dce_call);
531 * returns true if this is an authenticated call
533 _PUBLIC_ bool dcesrv_call_authenticated(struct dcesrv_call_state *dce_call);
536 * retrieve account_name for a dce_call
538 _PUBLIC_ const char *dcesrv_call_account_name(struct dcesrv_call_state *dce_call);
541 * retrieve session_info from a dce_call
543 _PUBLIC_ struct auth_session_info *dcesrv_call_session_info(struct dcesrv_call_state *dce_call);
546 * retrieve auth type/level from a dce_call
548 _PUBLIC_ void dcesrv_call_auth_info(struct dcesrv_call_state *dce_call,
549 enum dcerpc_AuthType *auth_type,
550 enum dcerpc_AuthLevel *auth_level);
552 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_integrity(struct dcesrv_connection_context *context,
553 const struct dcesrv_interface *iface);
554 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_privacy(struct dcesrv_connection_context *context,
555 const struct dcesrv_interface *iface);
556 _PUBLIC_ NTSTATUS dcesrv_interface_bind_reject_connect(struct dcesrv_connection_context *context,
557 const struct dcesrv_interface *iface);
558 _PUBLIC_ NTSTATUS dcesrv_interface_bind_allow_connect(struct dcesrv_connection_context *context,
559 const struct dcesrv_interface *iface);
561 _PUBLIC_ NTSTATUS _dcesrv_iface_state_store_assoc(
562 struct dcesrv_call_state *call,
565 const char *location);
566 #define dcesrv_iface_state_store_assoc(call, magic, ptr) \
567 _dcesrv_iface_state_store_assoc((call), (magic), (ptr), \
569 _PUBLIC_ void *_dcesrv_iface_state_find_assoc(
570 struct dcesrv_call_state *call,
572 #define dcesrv_iface_state_find_assoc(call, magic, _type) \
574 _dcesrv_iface_state_find_assoc((call), (magic)), \
577 _PUBLIC_ NTSTATUS _dcesrv_iface_state_store_conn(
578 struct dcesrv_call_state *call,
581 const char *location);
582 #define dcesrv_iface_state_store_conn(call, magic, ptr) \
583 _dcesrv_iface_state_store_conn((call), (magic), (ptr), \
585 _PUBLIC_ void *_dcesrv_iface_state_find_conn(
586 struct dcesrv_call_state *call,
588 #define dcesrv_iface_state_find_conn(call, magic, _type) \
590 _dcesrv_iface_state_find_conn((call), (magic)), \
593 _PUBLIC_ struct imessaging_context *dcesrv_imessaging_context(
594 struct dcesrv_connection *conn);
595 _PUBLIC_ struct server_id dcesrv_server_id(struct dcesrv_connection *conn);
597 #endif /* SAMBA_DCERPC_SERVER_H */