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;
72 enum dcesrv_call_list {
74 DCESRV_LIST_CALL_LIST,
75 DCESRV_LIST_FRAGMENTED_CALL_LIST,
76 DCESRV_LIST_PENDING_CALL_LIST
79 struct data_blob_list_item {
80 struct data_blob_list_item *prev,*next;
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;
92 which list this request is in, if any
94 enum dcesrv_call_list list;
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
101 * this is only allowed to the backend when DCESRV_CALL_STATE_FLAG_MAY_ASYNC
102 * is alerady set by the frontend
104 * the backend then needs to call dcesrv_reply() when it's
105 * ready to send the reply
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;
113 /* the time the request arrived in the server */
116 /* the backend can use this event context for async replies */
117 struct tevent_context *event_ctx;
119 /* the message_context that will be used for async replies */
120 struct imessaging_context *msg_ctx;
122 /* this is the pointer to the allocated function struct */
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.
130 struct ndr_pull *ndr_pull;
134 struct data_blob_list_item *replies;
136 /* this is used by the boilerplate code to generate DCERPC faults */
139 /* the reason why we terminate the connection after sending a response */
140 const char *terminate_reason;
143 #define DCESRV_HANDLE_ANY 255
145 /* a dcerpc handle in internal format */
146 struct dcesrv_handle {
147 struct dcesrv_handle *next, *prev;
148 struct dcesrv_assoc_group *assoc_group;
149 struct policy_handle wire_handle;
151 const struct dcesrv_interface *iface;
155 /* hold the authentication state information */
157 enum dcerpc_AuthType auth_type;
158 enum dcerpc_AuthLevel auth_level;
159 uint32_t auth_context_id;
160 struct dcerpc_auth *auth_info;
161 struct gensec_security *gensec_security;
162 struct auth_session_info *session_info;
163 NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
164 bool client_hdr_signing;
168 struct dcesrv_connection_context {
169 struct dcesrv_connection_context *next, *prev;
172 struct dcesrv_assoc_group *assoc_group;
174 /* the connection this is on */
175 struct dcesrv_connection *conn;
177 /* the ndr function table for the chosen interface */
178 const struct dcesrv_interface *iface;
180 /* private data for the interface implementation */
184 * the minimum required auth level for this interface
186 enum dcerpc_AuthLevel min_auth_level;
191 /* the state associated with a dcerpc server connection */
192 struct dcesrv_connection {
193 /* for the broken_connections DLIST */
194 struct dcesrv_connection *prev, *next;
196 /* the top level context for this server */
197 struct dcesrv_context *dce_ctx;
199 /* the endpoint that was opened */
200 const struct dcesrv_endpoint *endpoint;
202 /* a list of established context_ids */
203 struct dcesrv_connection_context *contexts;
205 /* the state of the current incoming call fragments */
206 struct dcesrv_call_state *incoming_fragmented_call_list;
208 /* the state of the async pending calls */
209 struct dcesrv_call_state *pending_call_list;
211 /* the state of the current outgoing calls */
212 struct dcesrv_call_state *call_list;
214 /* the maximum size the client wants to receive */
215 uint16_t max_recv_frag;
216 uint16_t max_xmit_frag;
218 DATA_BLOB partial_input;
220 /* This can be removed in master... */
222 struct dcerpc_auth *auth_info;
223 struct gensec_security *gensec_security;
224 struct auth_session_info *session_info;
225 NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
226 bool client_hdr_signing;
228 } _unused_auth_state;
230 /* the event_context that will be used for this connection */
231 struct tevent_context *event_ctx;
233 /* the message_context that will be used for this connection */
234 struct imessaging_context *msg_ctx;
236 /* the server_id that will be used for this connection */
237 struct server_id server_id;
239 /* the transport level session key */
240 DATA_BLOB transport_session_key;
242 /* is this connection pending termination? If so, why? */
243 const char *terminate;
245 const char *packet_log_dir;
247 /* this is the default state_flags for dcesrv_call_state structs */
248 uint32_t state_flags;
252 void (*report_output_data)(struct dcesrv_connection *);
255 struct tstream_context *stream;
256 struct tevent_queue *send_queue;
258 const struct tsocket_address *local_address;
259 const struct tsocket_address *remote_address;
261 /* the current authentication state */
262 struct dcesrv_auth auth_state;
266 struct dcesrv_endpoint_server {
267 /* this is the name of the endpoint server */
270 /* this function should register endpoints and some other setup stuff,
271 * it is called when the dcesrv_context gets initialized.
273 NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
275 /* this function can be used by other endpoint servers to
276 * ask for a dcesrv_interface implementation
277 * - iface must be reference to an already existing struct !
279 bool (*interface_by_uuid)(struct dcesrv_interface *iface, const struct GUID *, uint32_t);
281 /* this function can be used by other endpoint servers to
282 * ask for a dcesrv_interface implementation
283 * - iface must be reference to an already existeng struct !
285 bool (*interface_by_name)(struct dcesrv_interface *iface, const char *);
289 /* one association groups */
290 struct dcesrv_assoc_group {
294 /* list of handles in this association group */
295 struct dcesrv_handle *handles;
298 struct dcesrv_context *dce_ctx;
300 /* Remote association group ID (if proxied) */
304 /* server-wide context information for the dcerpc server */
305 struct dcesrv_context {
307 * The euid at startup time.
309 * This is required for DCERPC_AUTH_TYPE_NCALRPC_AS_SYSTEM
313 /* the list of endpoints that have registered
314 * by the configured endpoint servers
316 struct dcesrv_endpoint {
317 struct dcesrv_endpoint *next, *prev;
318 /* the type and location of the endpoint */
319 struct dcerpc_binding *ep_description;
320 /* the security descriptor for smb named pipes */
321 struct security_descriptor *sd;
322 /* the list of interfaces available on this endpoint */
323 struct dcesrv_if_list {
324 struct dcesrv_if_list *next, *prev;
325 struct dcesrv_interface iface;
329 /* loadparm context to use for this connection */
330 struct loadparm_context *lp_ctx;
332 struct idr_context *assoc_groups_idr;
334 struct dcesrv_connection *broken_connections;
337 /* this structure is used by modules to determine the size of some critical types */
338 struct dcesrv_critical_sizes {
339 int interface_version;
340 int sizeof_dcesrv_context;
341 int sizeof_dcesrv_endpoint;
342 int sizeof_dcesrv_endpoint_server;
343 int sizeof_dcesrv_interface;
344 int sizeof_dcesrv_if_list;
345 int sizeof_dcesrv_connection;
346 int sizeof_dcesrv_call_state;
347 int sizeof_dcesrv_auth;
348 int sizeof_dcesrv_handle;
353 NTSTATUS dcesrv_interface_register(struct dcesrv_context *dce_ctx,
355 const struct dcesrv_interface *iface,
356 const struct security_descriptor *sd);
357 NTSTATUS dcerpc_register_ep_server(const void *_ep_server);
358 NTSTATUS dcesrv_init_context(TALLOC_CTX *mem_ctx,
359 struct loadparm_context *lp_ctx,
360 const char **endpoint_servers, struct dcesrv_context **_dce_ctx);
361 NTSTATUS dcesrv_endpoint_connect(struct dcesrv_context *dce_ctx,
363 const struct dcesrv_endpoint *ep,
364 struct auth_session_info *session_info,
365 struct tevent_context *event_ctx,
366 struct imessaging_context *msg_ctx,
367 struct server_id server_id,
368 uint32_t state_flags,
369 struct dcesrv_connection **_p);
371 NTSTATUS dcesrv_reply(struct dcesrv_call_state *call);
372 struct dcesrv_handle *dcesrv_handle_new(struct dcesrv_connection_context *context,
373 uint8_t handle_type);
375 struct dcesrv_handle *dcesrv_handle_fetch(
376 struct dcesrv_connection_context *context,
377 struct policy_handle *p,
378 uint8_t handle_type);
379 struct socket_address *dcesrv_connection_get_my_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
381 struct socket_address *dcesrv_connection_get_peer_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
382 const struct tsocket_address *dcesrv_connection_get_local_address(struct dcesrv_connection *conn);
383 const struct tsocket_address *dcesrv_connection_get_remote_address(struct dcesrv_connection *conn);
385 NTSTATUS dcesrv_fetch_session_key(struct dcesrv_connection *p, DATA_BLOB *session_key);
387 /* a useful macro for generating a RPC fault in the backend code */
388 #define DCESRV_FAULT(code) do { \
389 dce_call->fault_code = code; \
390 return r->out.result; \
393 /* a useful macro for generating a RPC fault in the backend code */
394 #define DCESRV_FAULT_VOID(code) do { \
395 dce_call->fault_code = code; \
399 /* a useful macro for checking the validity of a dcerpc policy handle
400 and giving the right fault code if invalid */
401 #define DCESRV_CHECK_HANDLE(h) do {if (!(h)) DCESRV_FAULT(DCERPC_FAULT_CONTEXT_MISMATCH); } while (0)
403 /* this checks for a valid policy handle, and gives a fault if an
404 invalid handle or retval if the handle is of the
406 #define DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, retval) do { \
407 (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), DCESRV_HANDLE_ANY); \
408 DCESRV_CHECK_HANDLE(h); \
409 if ((t) != DCESRV_HANDLE_ANY && (h)->wire_handle.handle_type != (t)) { \
414 /* this checks for a valid policy handle and gives a dcerpc fault
415 if its the wrong type of handle */
416 #define DCESRV_PULL_HANDLE_FAULT(h, inhandle, t) do { \
417 (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), t); \
418 DCESRV_CHECK_HANDLE(h); \
421 #define DCESRV_PULL_HANDLE(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, NT_STATUS_INVALID_HANDLE)
422 #define DCESRV_PULL_HANDLE_WERR(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, WERR_BADFID)
424 NTSTATUS dcesrv_add_ep(struct dcesrv_context *dce_ctx,
425 struct loadparm_context *lp_ctx,
426 struct dcesrv_endpoint *e,
427 struct tevent_context *event_ctx,
428 const struct model_ops *model_ops);
431 * retrieve credentials from a dce_call
433 _PUBLIC_ struct cli_credentials *dcesrv_call_credentials(struct dcesrv_call_state *dce_call);
436 * returns true if this is an authenticated call
438 _PUBLIC_ bool dcesrv_call_authenticated(struct dcesrv_call_state *dce_call);
441 * retrieve account_name for a dce_call
443 _PUBLIC_ const char *dcesrv_call_account_name(struct dcesrv_call_state *dce_call);
445 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_integrity(struct dcesrv_call_state *dce_call,
446 const struct dcesrv_interface *iface);
447 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_privacy(struct dcesrv_call_state *dce_call,
448 const struct dcesrv_interface *iface);
449 _PUBLIC_ NTSTATUS dcesrv_interface_bind_reject_connect(struct dcesrv_call_state *dce_call,
450 const struct dcesrv_interface *iface);
451 _PUBLIC_ NTSTATUS dcesrv_interface_bind_allow_connect(struct dcesrv_call_state *dce_call,
452 const struct dcesrv_interface *iface);
454 #endif /* SAMBA_DCERPC_SERVER_H */