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 /* the state of an ongoing dcerpc call */
80 struct dcesrv_call_state
{
81 struct dcesrv_call_state
*next
, *prev
;
82 struct dcesrv_connection
*conn
;
83 struct dcesrv_connection_context
*context
;
84 struct ncacn_packet pkt
;
87 which list this request is in, if any
89 enum dcesrv_call_list list
;
91 /* the backend can mark the call
92 * with DCESRV_CALL_STATE_FLAG_ASYNC
93 * that will cause the frontend to not touch r->out
96 * this is only allowed to the backend when DCESRV_CALL_STATE_FLAG_MAY_ASYNC
97 * is alerady set by the frontend
99 * the backend then needs to call dcesrv_reply() when it's
100 * ready to send the reply
102 #define DCESRV_CALL_STATE_FLAG_ASYNC (1<<0)
103 #define DCESRV_CALL_STATE_FLAG_MAY_ASYNC (1<<1)
104 #define DCESRV_CALL_STATE_FLAG_MULTIPLEXED (1<<3)
105 uint32_t state_flags
;
107 /* the time the request arrived in the server */
110 /* the backend can use this event context for async replies */
111 struct tevent_context
*event_ctx
;
113 /* the message_context that will be used for async replies */
114 struct imessaging_context
*msg_ctx
;
116 /* this is the pointer to the allocated function struct */
120 * that's the ndr pull context used in dcesrv_request()
121 * needed by dcesrv_reply() to carry over information
122 * for full pointer support.
124 struct ndr_pull
*ndr_pull
;
128 struct data_blob_list_item
*replies
;
130 /* this is used by the boilerplate code to generate DCERPC faults */
134 #define DCESRV_HANDLE_ANY 255
136 /* a dcerpc handle in internal format */
137 struct dcesrv_handle
{
138 struct dcesrv_handle
*next
, *prev
;
139 struct dcesrv_assoc_group
*assoc_group
;
140 struct policy_handle wire_handle
;
142 const struct dcesrv_interface
*iface
;
146 /* hold the authentication state information */
148 struct dcerpc_auth
*auth_info
;
149 struct gensec_security
*gensec_security
;
150 struct auth_session_info
*session_info
;
151 NTSTATUS (*session_key
)(struct dcesrv_connection
*, DATA_BLOB
*session_key
);
152 bool client_hdr_signing
;
156 struct dcesrv_connection_context
{
157 struct dcesrv_connection_context
*next
, *prev
;
160 struct dcesrv_assoc_group
*assoc_group
;
162 /* the connection this is on */
163 struct dcesrv_connection
*conn
;
165 /* the ndr function table for the chosen interface */
166 const struct dcesrv_interface
*iface
;
168 /* private data for the interface implementation */
173 /* the state associated with a dcerpc server connection */
174 struct dcesrv_connection
{
175 /* for the broken_connections DLIST */
176 struct dcesrv_connection
*prev
, *next
;
178 /* the top level context for this server */
179 struct dcesrv_context
*dce_ctx
;
181 /* the endpoint that was opened */
182 const struct dcesrv_endpoint
*endpoint
;
184 /* a list of established context_ids */
185 struct dcesrv_connection_context
*contexts
;
187 /* the state of the current incoming call fragments */
188 struct dcesrv_call_state
*incoming_fragmented_call_list
;
190 /* the state of the async pending calls */
191 struct dcesrv_call_state
*pending_call_list
;
193 /* the state of the current outgoing calls */
194 struct dcesrv_call_state
*call_list
;
196 /* the maximum size the client wants to receive */
197 uint32_t cli_max_recv_frag
;
199 DATA_BLOB partial_input
;
201 /* the current authentication state */
202 struct dcesrv_auth auth_state
;
204 /* the event_context that will be used for this connection */
205 struct tevent_context
*event_ctx
;
207 /* the message_context that will be used for this connection */
208 struct imessaging_context
*msg_ctx
;
210 /* the server_id that will be used for this connection */
211 struct server_id server_id
;
213 /* the transport level session key */
214 DATA_BLOB transport_session_key
;
216 /* is this connection pending termination? If so, why? */
217 const char *terminate
;
219 const char *packet_log_dir
;
221 /* this is the default state_flags for dcesrv_call_state structs */
222 uint32_t state_flags
;
226 void (*report_output_data
)(struct dcesrv_connection
*);
229 struct tstream_context
*stream
;
230 struct tevent_queue
*send_queue
;
232 const struct tsocket_address
*local_address
;
233 const struct tsocket_address
*remote_address
;
237 struct dcesrv_endpoint_server
{
238 /* this is the name of the endpoint server */
241 /* this function should register endpoints and some other setup stuff,
242 * it is called when the dcesrv_context gets initialized.
244 NTSTATUS (*init_server
)(struct dcesrv_context
*, const struct dcesrv_endpoint_server
*);
246 /* this function can be used by other endpoint servers to
247 * ask for a dcesrv_interface implementation
248 * - iface must be reference to an already existing struct !
250 bool (*interface_by_uuid
)(struct dcesrv_interface
*iface
, const struct GUID
*, uint32_t);
252 /* this function can be used by other endpoint servers to
253 * ask for a dcesrv_interface implementation
254 * - iface must be reference to an already existeng struct !
256 bool (*interface_by_name
)(struct dcesrv_interface
*iface
, const char *);
260 /* one association groups */
261 struct dcesrv_assoc_group
{
265 /* list of handles in this association group */
266 struct dcesrv_handle
*handles
;
269 struct dcesrv_context
*dce_ctx
;
271 /* Remote association group ID (if proxied) */
275 /* server-wide context information for the dcerpc server */
276 struct dcesrv_context
{
278 * The euid at startup time.
280 * This is required for DCERPC_AUTH_TYPE_NCALRPC_AS_SYSTEM
284 /* the list of endpoints that have registered
285 * by the configured endpoint servers
287 struct dcesrv_endpoint
{
288 struct dcesrv_endpoint
*next
, *prev
;
289 /* the type and location of the endpoint */
290 struct dcerpc_binding
*ep_description
;
291 /* the security descriptor for smb named pipes */
292 struct security_descriptor
*sd
;
293 /* the list of interfaces available on this endpoint */
294 struct dcesrv_if_list
{
295 struct dcesrv_if_list
*next
, *prev
;
296 struct dcesrv_interface iface
;
300 /* loadparm context to use for this connection */
301 struct loadparm_context
*lp_ctx
;
303 struct idr_context
*assoc_groups_idr
;
305 struct dcesrv_connection
*broken_connections
;
308 /* this structure is used by modules to determine the size of some critical types */
309 struct dcesrv_critical_sizes
{
310 int interface_version
;
311 int sizeof_dcesrv_context
;
312 int sizeof_dcesrv_endpoint
;
313 int sizeof_dcesrv_endpoint_server
;
314 int sizeof_dcesrv_interface
;
315 int sizeof_dcesrv_if_list
;
316 int sizeof_dcesrv_connection
;
317 int sizeof_dcesrv_call_state
;
318 int sizeof_dcesrv_auth
;
319 int sizeof_dcesrv_handle
;
324 NTSTATUS
dcesrv_interface_register(struct dcesrv_context
*dce_ctx
,
326 const struct dcesrv_interface
*iface
,
327 const struct security_descriptor
*sd
);
328 NTSTATUS
dcerpc_register_ep_server(const void *_ep_server
);
329 NTSTATUS
dcesrv_init_context(TALLOC_CTX
*mem_ctx
,
330 struct loadparm_context
*lp_ctx
,
331 const char **endpoint_servers
, struct dcesrv_context
**_dce_ctx
);
332 NTSTATUS
dcesrv_endpoint_connect(struct dcesrv_context
*dce_ctx
,
334 const struct dcesrv_endpoint
*ep
,
335 struct auth_session_info
*session_info
,
336 struct tevent_context
*event_ctx
,
337 struct imessaging_context
*msg_ctx
,
338 struct server_id server_id
,
339 uint32_t state_flags
,
340 struct dcesrv_connection
**_p
);
342 NTSTATUS
dcesrv_reply(struct dcesrv_call_state
*call
);
343 struct dcesrv_handle
*dcesrv_handle_new(struct dcesrv_connection_context
*context
,
344 uint8_t handle_type
);
346 struct dcesrv_handle
*dcesrv_handle_fetch(
347 struct dcesrv_connection_context
*context
,
348 struct policy_handle
*p
,
349 uint8_t handle_type
);
350 struct socket_address
*dcesrv_connection_get_my_addr(struct dcesrv_connection
*conn
, TALLOC_CTX
*mem_ctx
);
352 struct socket_address
*dcesrv_connection_get_peer_addr(struct dcesrv_connection
*conn
, TALLOC_CTX
*mem_ctx
);
353 const struct tsocket_address
*dcesrv_connection_get_local_address(struct dcesrv_connection
*conn
);
354 const struct tsocket_address
*dcesrv_connection_get_remote_address(struct dcesrv_connection
*conn
);
356 NTSTATUS
dcesrv_fetch_session_key(struct dcesrv_connection
*p
, DATA_BLOB
*session_key
);
358 /* a useful macro for generating a RPC fault in the backend code */
359 #define DCESRV_FAULT(code) do { \
360 dce_call->fault_code = code; \
361 return r->out.result; \
364 /* a useful macro for generating a RPC fault in the backend code */
365 #define DCESRV_FAULT_VOID(code) do { \
366 dce_call->fault_code = code; \
370 /* a useful macro for checking the validity of a dcerpc policy handle
371 and giving the right fault code if invalid */
372 #define DCESRV_CHECK_HANDLE(h) do {if (!(h)) DCESRV_FAULT(DCERPC_FAULT_CONTEXT_MISMATCH); } while (0)
374 /* this checks for a valid policy handle, and gives a fault if an
375 invalid handle or retval if the handle is of the
377 #define DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, retval) do { \
378 (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), DCESRV_HANDLE_ANY); \
379 DCESRV_CHECK_HANDLE(h); \
380 if ((t) != DCESRV_HANDLE_ANY && (h)->wire_handle.handle_type != (t)) { \
385 /* this checks for a valid policy handle and gives a dcerpc fault
386 if its the wrong type of handle */
387 #define DCESRV_PULL_HANDLE_FAULT(h, inhandle, t) do { \
388 (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), t); \
389 DCESRV_CHECK_HANDLE(h); \
392 #define DCESRV_PULL_HANDLE(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, NT_STATUS_INVALID_HANDLE)
393 #define DCESRV_PULL_HANDLE_WERR(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, WERR_BADFID)
395 NTSTATUS
dcesrv_add_ep(struct dcesrv_context
*dce_ctx
,
396 struct loadparm_context
*lp_ctx
,
397 struct dcesrv_endpoint
*e
,
398 struct tevent_context
*event_ctx
,
399 const struct model_ops
*model_ops
);
402 * retrieve credentials from a dce_call
404 _PUBLIC_
struct cli_credentials
*dcesrv_call_credentials(struct dcesrv_call_state
*dce_call
);
407 * returns true if this is an authenticated call
409 _PUBLIC_
bool dcesrv_call_authenticated(struct dcesrv_call_state
*dce_call
);
412 * retrieve account_name for a dce_call
414 _PUBLIC_
const char *dcesrv_call_account_name(struct dcesrv_call_state
*dce_call
);
417 #endif /* SAMBA_DCERPC_SERVER_H */