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