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 2 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, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #ifndef SAMBA_DCERPC_SERVER_H
25 #define SAMBA_DCERPC_SERVER_H
27 /* modules can use the following to determine if the interface has changed
28 * please increment the version number after each interface change
29 * with a comment and maybe update struct dcesrv_critical_sizes.
31 /* version 1 - initial version - metze */
32 #define DCERPC_MODULE_VERSION 1
34 struct dcesrv_connection;
35 struct dcesrv_call_state;
38 struct dcesrv_interface {
43 /* this function is called when the client binds to this interface */
44 NTSTATUS (*bind)(struct dcesrv_call_state *, const struct dcesrv_interface *);
46 /* this function is called when the client disconnects the endpoint */
47 void (*unbind)(struct dcesrv_connection_context *, const struct dcesrv_interface *);
49 /* the ndr_pull function for the chosen interface.
51 NTSTATUS (*ndr_pull)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_pull *, void **);
53 /* the dispatch function for the chosen interface.
55 NTSTATUS (*dispatch)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
57 /* the reply function for the chosen interface.
59 NTSTATUS (*reply)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
61 /* the ndr_push function for the chosen interface.
63 NTSTATUS (*ndr_push)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_push *, const void *);
65 /* for any private use by the interface code */
69 /* the state of an ongoing dcerpc call */
70 struct dcesrv_call_state {
71 struct dcesrv_call_state *next, *prev;
72 struct dcesrv_connection *conn;
73 struct dcesrv_connection_context *context;
74 struct ncacn_packet pkt;
76 /* the backend can mark the call
77 * with DCESRV_CALL_STATE_FLAG_ASYNC
78 * that will cause the frontend to not touch r->out
81 * this is only allowed to the backend when DCESRV_CALL_STATE_FLAG_MAY_ASYNC
82 * is alerady set by the frontend
84 * the backend then needs to call dcesrv_reply() when it's
85 * ready to send the reply
87 #define DCESRV_CALL_STATE_FLAG_ASYNC (1<<0)
88 #define DCESRV_CALL_STATE_FLAG_MAY_ASYNC (1<<1)
91 /* the time the request arrived in the server */
94 /* the backend can use this event context for async replies */
95 struct event_context *event_ctx;
97 /* this is the pointer to the allocated function struct */
100 /* that's the ndr push context used in dcesrv_request */
101 struct ndr_pull *ndr_pull;
105 struct dcesrv_call_reply {
106 struct dcesrv_call_reply *next, *prev;
110 /* this is used by the boilerplate code to generate DCERPC faults */
114 #define DCESRV_HANDLE_ANY 255
116 /* a dcerpc handle in internal format */
117 struct dcesrv_handle {
118 struct dcesrv_handle *next, *prev;
119 struct dcesrv_connection_context *context;
120 struct policy_handle wire_handle;
124 /* hold the authentication state information */
126 struct dcerpc_auth *auth_info;
127 struct gensec_security *gensec_security;
128 struct auth_session_info *session_info;
129 NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
132 struct dcesrv_connection_context {
133 struct dcesrv_connection_context *next, *prev;
136 /* the connection this is on */
137 struct dcesrv_connection *conn;
139 /* the ndr function table for the chosen interface */
140 const struct dcesrv_interface *iface;
142 /* private data for the interface implementation */
145 /* current rpc handles - this is really the wrong scope for
146 them, but it will do for now */
147 struct dcesrv_handle *handles;
151 /* the state associated with a dcerpc server connection */
152 struct dcesrv_connection {
153 /* the top level context for this server */
154 struct dcesrv_context *dce_ctx;
156 /* the endpoint that was opened */
157 const struct dcesrv_endpoint *endpoint;
159 /* a list of established context_ids */
160 struct dcesrv_connection_context *contexts;
162 /* the state of the current calls */
163 struct dcesrv_call_state *call_list;
165 /* the state of the async pending calls */
166 struct dcesrv_call_state *pending_call_list;
168 /* the maximum size the client wants to receive */
169 uint32_t cli_max_recv_frag;
171 DATA_BLOB partial_input;
173 /* the current authentication state */
174 struct dcesrv_auth auth_state;
176 struct stream_connection *srv_conn;
178 /* the transport level session key */
179 DATA_BLOB transport_session_key;
185 struct dcesrv_endpoint_server {
186 /* this is the name of the endpoint server */
189 /* this function should register endpoints and some other setup stuff,
190 * it is called when the dcesrv_context gets initialized.
192 NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
194 /* this function can be used by other endpoint servers to
195 * ask for a dcesrv_interface implementation
196 * - iface must be reference to an already existing struct !
198 BOOL (*interface_by_uuid)(struct dcesrv_interface *iface, const char *, uint32_t);
200 /* this function can be used by other endpoint servers to
201 * ask for a dcesrv_interface implementation
202 * - iface must be reference to an already existeng struct !
204 BOOL (*interface_by_name)(struct dcesrv_interface *iface, const char *);
208 /* server-wide context information for the dcerpc server */
209 struct dcesrv_context {
210 /* the list of endpoints that have registered
211 * by the configured endpoint servers
213 struct dcesrv_endpoint {
214 struct dcesrv_endpoint *next, *prev;
215 /* the type and location of the endpoint */
216 struct dcerpc_binding *ep_description;
217 /* the security descriptor for smb named pipes */
218 struct security_descriptor *sd;
219 /* the list of interfaces available on this endpoint */
220 struct dcesrv_if_list {
221 struct dcesrv_if_list *next, *prev;
222 struct dcesrv_interface iface;
226 /* this is the default state_flags for dcesrv_call_state structs */
227 uint32_t state_flags;
230 /* this structure is used by modules to determine the size of some critical types */
231 struct dcesrv_critical_sizes {
232 int interface_version;
233 int sizeof_dcesrv_context;
234 int sizeof_dcesrv_endpoint;
235 int sizeof_dcesrv_endpoint_server;
236 int sizeof_dcesrv_interface;
237 int sizeof_dcesrv_if_list;
238 int sizeof_dcesrv_connection;
239 int sizeof_dcesrv_call_state;
240 int sizeof_dcesrv_auth;
241 int sizeof_dcesrv_handle;
244 #endif /* SAMBA_DCERPC_SERVER_H */