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;
37 struct dcesrv_connection_context;
39 struct dcesrv_interface {
44 /* this function is called when the client binds to this interface */
45 NTSTATUS (*bind)(struct dcesrv_call_state *, const struct dcesrv_interface *);
47 /* this function is called when the client disconnects the endpoint */
48 void (*unbind)(struct dcesrv_connection_context *, const struct dcesrv_interface *);
50 /* the ndr_pull function for the chosen interface.
52 NTSTATUS (*ndr_pull)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_pull *, void **);
54 /* the dispatch function for the chosen interface.
56 NTSTATUS (*dispatch)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
58 /* the reply function for the chosen interface.
60 NTSTATUS (*reply)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
62 /* the ndr_push function for the chosen interface.
64 NTSTATUS (*ndr_push)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_push *, const void *);
66 /* for any private use by the interface code */
70 /* the state of an ongoing dcerpc call */
71 struct dcesrv_call_state {
72 struct dcesrv_call_state *next, *prev;
73 struct dcesrv_connection *conn;
74 struct dcesrv_connection_context *context;
75 struct ncacn_packet pkt;
77 /* the backend can mark the call
78 * with DCESRV_CALL_STATE_FLAG_ASYNC
79 * that will cause the frontend to not touch r->out
82 * this is only allowed to the backend when DCESRV_CALL_STATE_FLAG_MAY_ASYNC
83 * is alerady set by the frontend
85 * the backend then needs to call dcesrv_reply() when it's
86 * ready to send the reply
88 #define DCESRV_CALL_STATE_FLAG_ASYNC (1<<0)
89 #define DCESRV_CALL_STATE_FLAG_MAY_ASYNC (1<<1)
92 /* the time the request arrived in the server */
95 /* the backend can use this event context for async replies */
96 struct event_context *event_ctx;
98 /* this is the pointer to the allocated function struct */
101 /* that's the ndr push context used in dcesrv_request */
102 struct ndr_pull *ndr_pull;
106 struct data_blob_list_item *replies;
108 /* this is used by the boilerplate code to generate DCERPC faults */
112 #define DCESRV_HANDLE_ANY 255
114 /* a dcerpc handle in internal format */
115 struct dcesrv_handle {
116 struct dcesrv_handle *next, *prev;
117 struct dcesrv_connection_context *context;
118 struct policy_handle wire_handle;
122 /* hold the authentication state information */
124 struct dcerpc_auth *auth_info;
125 struct gensec_security *gensec_security;
126 struct auth_session_info *session_info;
127 NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
130 struct dcesrv_connection_context {
131 struct dcesrv_connection_context *next, *prev;
134 /* the connection this is on */
135 struct dcesrv_connection *conn;
137 /* the ndr function table for the chosen interface */
138 const struct dcesrv_interface *iface;
140 /* private data for the interface implementation */
143 /* current rpc handles - this is really the wrong scope for
144 them, but it will do for now */
145 struct dcesrv_handle *handles;
149 /* the state associated with a dcerpc server connection */
150 struct dcesrv_connection {
151 /* the top level context for this server */
152 struct dcesrv_context *dce_ctx;
154 /* the endpoint that was opened */
155 const struct dcesrv_endpoint *endpoint;
157 /* a list of established context_ids */
158 struct dcesrv_connection_context *contexts;
160 /* the state of the current calls */
161 struct dcesrv_call_state *call_list;
163 /* the state of the async pending calls */
164 struct dcesrv_call_state *pending_call_list;
166 /* the maximum size the client wants to receive */
167 uint32_t cli_max_recv_frag;
169 DATA_BLOB partial_input;
171 /* the current authentication state */
172 struct dcesrv_auth auth_state;
174 struct stream_connection *srv_conn;
176 /* the transport level session key */
177 DATA_BLOB transport_session_key;
181 /* this is the default state_flags for dcesrv_call_state structs */
182 uint32_t state_flags;
187 struct dcesrv_endpoint_server {
188 /* this is the name of the endpoint server */
191 /* this function should register endpoints and some other setup stuff,
192 * it is called when the dcesrv_context gets initialized.
194 NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
196 /* this function can be used by other endpoint servers to
197 * ask for a dcesrv_interface implementation
198 * - iface must be reference to an already existing struct !
200 BOOL (*interface_by_uuid)(struct dcesrv_interface *iface, const struct GUID *, uint32_t);
202 /* this function can be used by other endpoint servers to
203 * ask for a dcesrv_interface implementation
204 * - iface must be reference to an already existeng struct !
206 BOOL (*interface_by_name)(struct dcesrv_interface *iface, const char *);
210 /* server-wide context information for the dcerpc server */
211 struct dcesrv_context {
212 /* the list of endpoints that have registered
213 * by the configured endpoint servers
215 struct dcesrv_endpoint {
216 struct dcesrv_endpoint *next, *prev;
217 /* the type and location of the endpoint */
218 struct dcerpc_binding *ep_description;
219 /* the security descriptor for smb named pipes */
220 struct security_descriptor *sd;
221 /* the list of interfaces available on this endpoint */
222 struct dcesrv_if_list {
223 struct dcesrv_if_list *next, *prev;
224 struct dcesrv_interface iface;
229 /* this structure is used by modules to determine the size of some critical types */
230 struct dcesrv_critical_sizes {
231 int interface_version;
232 int sizeof_dcesrv_context;
233 int sizeof_dcesrv_endpoint;
234 int sizeof_dcesrv_endpoint_server;
235 int sizeof_dcesrv_interface;
236 int sizeof_dcesrv_if_list;
237 int sizeof_dcesrv_connection;
238 int sizeof_dcesrv_call_state;
239 int sizeof_dcesrv_auth;
240 int sizeof_dcesrv_handle;
243 #include "rpc_server/dcerpc_server_proto.h"
245 #endif /* SAMBA_DCERPC_SERVER_H */