411bf400bf311935477f8191cf8147dec1e288b6
[samba.git] / source4 / rpc_server / dcerpc_server.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    server side dcerpc defines
5
6    Copyright (C) Andrew Tridgell 2003
7    Copyright (C) Stefan (metze) Metzmacher 2004
8    
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.
13    
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.
18    
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.
22 */
23
24 /* modules can use the following to determine if the interface has changed
25  * please increment the version number after each interface change
26  * with a comment and maybe update struct dcesrv_critical_sizes.
27  */
28 /* version 1 - initial version - metze */
29 #define DCERPC_MODULE_VERSION 1
30
31 enum endpoint_type {ENDPOINT_SMB, ENDPOINT_TCP};
32
33 /* a description of a single dcerpc endpoint. Not as flexible as a full epm tower,
34    but much easier to work with */
35 struct dcesrv_ep_description {
36         enum endpoint_type type;
37         union {
38                 const char *smb_pipe;
39                 uint32 tcp_port;
40         } info;
41 };
42
43 struct dcesrv_connection;
44 struct dcesrv_call_state;
45
46 /* the dispatch functions for an interface take this form */
47 typedef NTSTATUS (*dcesrv_dispatch_fn_t)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
48
49 struct dcesrv_interface {
50         /* the ndr function table for the chosen interface */
51         const struct dcerpc_interface_table *ndr;
52
53         /* this function is called when the client binds to this interface  */
54         NTSTATUS (*bind)(struct dcesrv_call_state *, const struct dcesrv_interface *);
55
56         /* this function is called when the client disconnects the endpoint */
57         void (*unbind)(struct dcesrv_connection *, const struct dcesrv_interface *);
58
59         /* the dispatch function for the chosen interface.
60          */
61         dcesrv_dispatch_fn_t dispatch;
62 }; 
63
64 /* the state of an ongoing dcerpc call */
65 struct dcesrv_call_state {
66         struct dcesrv_call_state *next, *prev;
67         struct dcesrv_connection *conn;
68         TALLOC_CTX *mem_ctx;
69         struct dcerpc_packet pkt;
70
71         DATA_BLOB input;
72
73         struct dcesrv_call_reply {
74                 struct dcesrv_call_reply *next, *prev;
75                 DATA_BLOB data;
76         } *replies;
77 };
78
79
80 /* a dcerpc handle in internal format */
81 struct dcesrv_handle {
82         struct dcesrv_handle *next, *prev;
83         struct policy_handle wire_handle;
84         TALLOC_CTX *mem_ctx;
85         void *data;
86 };
87
88 /* hold the authentication state information */
89 struct dcesrv_auth {
90         struct auth_ntlmssp_state *ntlmssp_state;
91         struct dcerpc_auth *auth_info;
92 };
93
94
95 /* the state associated with a dcerpc server connection */
96 struct dcesrv_connection {
97         /* the top level context for this server */
98         struct dcesrv_context *dce_ctx;
99
100         TALLOC_CTX *mem_ctx;
101
102         /* the endpoint that was opened */
103         const struct dcesrv_endpoint *endpoint;
104
105         /* the ndr function table for the chosen interface */
106         const struct dcesrv_interface *iface;
107
108         /* the state of the current calls */
109         struct dcesrv_call_state *call_list;
110
111         /* the maximum size the client wants to receive */
112         uint32 cli_max_recv_frag;
113
114         /* private data for the interface implementation */
115         void *private;
116
117         /* current rpc handles - this is really the wrong scope for
118            them, but it will do for now */
119         struct dcesrv_handle *handles;
120
121         DATA_BLOB partial_input;
122
123         /* the current authentication state */
124         struct dcesrv_auth auth_state;
125 };
126
127
128 struct dcesrv_endpoint_server {
129         /* this is the name of the endpoint server */
130         const char *name;
131
132         /* this function should register endpoints and some other setup stuff,
133          * it is called when the dcesrv_context gets initialized.
134          */
135         NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
136
137         /* this function can be used by other endpoint servers to
138          * ask for a dcesrv_interface implementation
139          * - iface must be referenz to an allready existent struct !
140          */
141         BOOL (*interface_by_uuid)(struct dcesrv_interface *iface, const char *, uint32);
142
143         /* this function can be used by other endpoint servers to
144          * ask for a dcesrv_interface implementation
145          * - iface must be referenz to an allready existent struct !
146          */
147         BOOL (*interface_by_name)(struct dcesrv_interface *iface, const char *);
148 };
149
150
151 /* server-wide context information for the dcerpc server */
152 struct dcesrv_context {
153         TALLOC_CTX *mem_ctx;
154
155         /* the list of endpoints that have registered 
156          * by the configured endpoint servers 
157          */
158         struct dcesrv_endpoint {
159                 struct dcesrv_endpoint *next, *prev;
160                 /* the type and location of the endpoint */
161                 struct dcesrv_ep_description ep_description;
162                 /* the security descriptor for smb named pipes */
163                 struct security_descriptor *sd;
164                 /* the list of interfaces available on this endpoint */
165                 struct dcesrv_if_list {
166                         struct dcesrv_if_list *next, *prev;
167                         struct dcesrv_interface iface;
168                 } *interface_list;
169         } *endpoint_list;
170 };
171
172 /* this structure is used by modules to determine the size of some critical types */
173 struct dcesrv_critical_sizes {
174         int interface_version;
175         int sizeof_dcesrv_context;
176         int sizeof_dcesrv_endpoint;
177         int sizeof_dcesrv_endpoint_server;
178         int sizeof_dcesrv_ep_description;
179         int sizeof_dcesrv_interface;
180         int sizeof_dcesrv_if_list;
181         int sizeof_dcesrv_connection;
182         int sizeof_dcesrv_call_state;
183         int sizeof_dcesrv_auth;
184         int sizeof_dcesrv_handle;
185 };