2 Unix SMB/CIFS implementation.
4 server side dcerpc defines
6 Copyright (C) Andrew Tridgell 2003
7 Copyright (C) Stefan (metze) Metzmacher 2004
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 enum endpoint_type {ENDPOINT_SMB, ENDPOINT_TCP};
36 /* a description of a single dcerpc endpoint. Not as flexible as a full epm tower,
37 but much easier to work with */
38 struct dcesrv_ep_description {
39 enum endpoint_type type;
46 struct dcesrv_connection;
47 struct dcesrv_call_state;
50 /* the dispatch functions for an interface take this form */
51 typedef NTSTATUS (*dcesrv_dispatch_fn_t)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
53 struct dcesrv_interface {
54 /* the ndr function table for the chosen interface */
55 const struct dcerpc_interface_table *ndr;
57 /* this function is called when the client binds to this interface */
58 NTSTATUS (*bind)(struct dcesrv_call_state *, const struct dcesrv_interface *);
60 /* this function is called when the client disconnects the endpoint */
61 void (*unbind)(struct dcesrv_connection *, const struct dcesrv_interface *);
63 /* the dispatch function for the chosen interface.
65 dcesrv_dispatch_fn_t dispatch;
68 /* the state of an ongoing dcerpc call */
69 struct dcesrv_call_state {
70 struct dcesrv_call_state *next, *prev;
71 struct dcesrv_connection *conn;
73 struct dcerpc_packet pkt;
77 struct dcesrv_call_reply {
78 struct dcesrv_call_reply *next, *prev;
82 /* this is used by the boilerplate code to generate DCERPC faults */
86 #define DCESRV_HANDLE_ANY 255
88 /* a dcerpc handle in internal format */
89 struct dcesrv_handle {
90 struct dcesrv_handle *next, *prev;
91 struct policy_handle wire_handle;
94 void (*destroy)(struct dcesrv_connection *, struct dcesrv_handle *);
97 struct dcesrv_cyrpto_ops {
100 NTSTATUS (*start)(struct dcesrv_auth *auth);
101 NTSTATUS (*update)(struct dcesrv_auth *auth, TALLOC_CTX *out_mem_ctx,
102 const DATA_BLOB in, DATA_BLOB *out);
103 NTSTATUS (*seal)(struct dcesrv_auth *auth, TALLOC_CTX *sig_mem_ctx,
104 uint8_t *data, size_t length, DATA_BLOB *sig);
105 NTSTATUS (*sign)(struct dcesrv_auth *auth, TALLOC_CTX *sig_mem_ctx,
106 const uint8_t *data, size_t length, DATA_BLOB *sig);
107 NTSTATUS (*check_sig)(struct dcesrv_auth *auth, TALLOC_CTX *sig_mem_ctx,
108 const uint8_t *data, size_t length, const DATA_BLOB *sig);
109 NTSTATUS (*unseal)(struct dcesrv_auth *auth, TALLOC_CTX *sig_mem_ctx,
110 uint8_t *data, size_t length, DATA_BLOB *sig);
111 void (*end)(struct dcesrv_auth *auth);
114 /* hold the authentication state information */
116 struct dcerpc_auth *auth_info;
119 const struct dcesrv_cyrpto_ops *ops;
124 /* the state associated with a dcerpc server connection */
125 struct dcesrv_connection {
126 /* the top level context for this server */
127 struct dcesrv_context *dce_ctx;
131 /* the endpoint that was opened */
132 const struct dcesrv_endpoint *endpoint;
134 /* the ndr function table for the chosen interface */
135 const struct dcesrv_interface *iface;
137 /* the state of the current calls */
138 struct dcesrv_call_state *call_list;
140 /* the maximum size the client wants to receive */
141 uint32_t cli_max_recv_frag;
143 /* private data for the interface implementation */
146 /* current rpc handles - this is really the wrong scope for
147 them, but it will do for now */
148 struct dcesrv_handle *handles;
150 DATA_BLOB partial_input;
152 /* the current authentication state */
153 struct dcesrv_auth auth_state;
155 /* the transport level session key, if any */
156 DATA_BLOB session_key;
160 struct dcesrv_endpoint_server {
161 /* this is the name of the endpoint server */
164 /* this function should register endpoints and some other setup stuff,
165 * it is called when the dcesrv_context gets initialized.
167 NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
169 /* this function can be used by other endpoint servers to
170 * ask for a dcesrv_interface implementation
171 * - iface must be referenz to an allready existent struct !
173 BOOL (*interface_by_uuid)(struct dcesrv_interface *iface, const char *, uint32_t);
175 /* this function can be used by other endpoint servers to
176 * ask for a dcesrv_interface implementation
177 * - iface must be referenz to an allready existent struct !
179 BOOL (*interface_by_name)(struct dcesrv_interface *iface, const char *);
183 /* server-wide context information for the dcerpc server */
184 struct dcesrv_context {
187 /* the list of endpoints that have registered
188 * by the configured endpoint servers
190 struct dcesrv_endpoint {
191 struct dcesrv_endpoint *next, *prev;
192 /* the type and location of the endpoint */
193 struct dcesrv_ep_description ep_description;
194 /* the security descriptor for smb named pipes */
195 struct security_descriptor *sd;
196 /* the list of interfaces available on this endpoint */
197 struct dcesrv_if_list {
198 struct dcesrv_if_list *next, *prev;
199 struct dcesrv_interface iface;
204 /* this structure is used by modules to determine the size of some critical types */
205 struct dcesrv_critical_sizes {
206 int interface_version;
207 int sizeof_dcesrv_context;
208 int sizeof_dcesrv_endpoint;
209 int sizeof_dcesrv_endpoint_server;
210 int sizeof_dcesrv_ep_description;
211 int sizeof_dcesrv_interface;
212 int sizeof_dcesrv_if_list;
213 int sizeof_dcesrv_connection;
214 int sizeof_dcesrv_call_state;
215 int sizeof_dcesrv_auth;
216 int sizeof_dcesrv_handle;
219 #endif /* SAMBA_DCERPC_SERVER_H */