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