r23792: convert Samba4 to GPLv3
[ira/wip.git] / source4 / librpc / rpc / dcerpc.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    DCERPC client side interface structures
5
6    Copyright (C) Tim Potter 2003
7    Copyright (C) Andrew Tridgell 2003-2005
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 3 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, see <http://www.gnu.org/licenses/>.
21 */
22
23 #ifndef __DCERPC_H__
24 #define __DCERPC_H__
25
26 #include "core.h"
27 #include "librpc/gen_ndr/dcerpc.h"
28 #include "librpc/ndr/libndr.h"
29
30 enum dcerpc_transport_t {
31         NCACN_NP, NCACN_IP_TCP, NCACN_IP_UDP, NCACN_VNS_IPC, NCACN_VNS_SPP, 
32         NCACN_AT_DSP, NCADG_AT_DDP, NCALRPC, NCACN_UNIX_STREAM, NCADG_UNIX_DGRAM,
33         NCACN_HTTP, NCADG_IPX, NCACN_SPX };
34
35 /*
36   this defines a generic security context for signed/sealed dcerpc pipes.
37 */
38 struct dcerpc_connection;
39 struct dcerpc_security {
40         struct dcerpc_auth *auth_info;
41         struct gensec_security *generic_state;
42
43         /* get the session key */
44         NTSTATUS (*session_key)(struct dcerpc_connection *, DATA_BLOB *);
45 };
46
47 /*
48   this holds the information that is not specific to a particular rpc context_id
49 */
50 struct dcerpc_connection {
51         uint32_t call_id;
52         uint32_t srv_max_xmit_frag;
53         uint32_t srv_max_recv_frag;
54         uint32_t flags;
55         struct dcerpc_security security_state;
56         const char *binding_string;
57         struct event_context *event_ctx;
58
59         bool dead;
60         bool free_skipped;
61
62         struct dcerpc_transport {
63                 enum dcerpc_transport_t transport;
64                 void *private_data;
65
66                 NTSTATUS (*shutdown_pipe)(struct dcerpc_connection *, NTSTATUS status);
67
68                 const char *(*peer_name)(struct dcerpc_connection *);
69
70                 const char *(*target_hostname)(struct dcerpc_connection *);
71
72                 /* send a request to the server */
73                 NTSTATUS (*send_request)(struct dcerpc_connection *, DATA_BLOB *, BOOL trigger_read);
74
75                 /* send a read request to the server */
76                 NTSTATUS (*send_read)(struct dcerpc_connection *);
77
78                 /* a callback to the dcerpc code when a full fragment
79                    has been received */
80                 void (*recv_data)(struct dcerpc_connection *, DATA_BLOB *, NTSTATUS status);
81         } transport;
82
83         /* Requests that have been sent, waiting for a reply */
84         struct rpc_request *pending;
85
86         /* Sync requests waiting to be shipped */
87         struct rpc_request *request_queue;
88
89         /* the next context_id to be assigned */
90         uint32_t next_context_id;
91 };
92
93 /*
94   this encapsulates a full dcerpc client side pipe 
95 */
96 struct dcerpc_pipe {
97         uint32_t context_id;
98
99         uint32_t assoc_group_id;
100
101         struct dcerpc_syntax_id syntax;
102         struct dcerpc_syntax_id transfer_syntax;
103
104         struct dcerpc_connection *conn;
105         struct dcerpc_binding *binding;
106
107         /* the last fault code from a DCERPC fault */
108         uint32_t last_fault_code;
109
110         /* timeout for individual rpc requests, in seconds */
111         uint32_t request_timeout;
112 };
113
114 /* default timeout for all rpc requests, in seconds */
115 #define DCERPC_REQUEST_TIMEOUT 60
116
117
118 /* dcerpc pipe flags */
119 #define DCERPC_DEBUG_PRINT_IN          (1<<0)
120 #define DCERPC_DEBUG_PRINT_OUT         (1<<1)
121 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
122
123 #define DCERPC_DEBUG_VALIDATE_IN       (1<<2)
124 #define DCERPC_DEBUG_VALIDATE_OUT      (1<<3)
125 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
126
127 #define DCERPC_CONNECT                 (1<<4)
128 #define DCERPC_SIGN                    (1<<5)
129 #define DCERPC_SEAL                    (1<<6)
130
131 #define DCERPC_PUSH_BIGENDIAN          (1<<7)
132 #define DCERPC_PULL_BIGENDIAN          (1<<8)
133
134 #define DCERPC_SCHANNEL                (1<<9)
135
136 /* use a 128 bit session key */
137 #define DCERPC_SCHANNEL_128            (1<<12)
138
139 /* check incoming pad bytes */
140 #define DCERPC_DEBUG_PAD_CHECK         (1<<13)
141
142 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
143 #define DCERPC_NDR_REF_ALLOC           (1<<14)
144
145 #define DCERPC_AUTH_OPTIONS    (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5|DCERPC_AUTH_NTLM)
146
147 /* select spnego auth */
148 #define DCERPC_AUTH_SPNEGO             (1<<15)
149
150 /* select krb5 auth */
151 #define DCERPC_AUTH_KRB5               (1<<16)
152
153 #define DCERPC_SMB2                    (1<<17)
154
155 /* select NTLM auth */
156 #define DCERPC_AUTH_NTLM               (1<<18)
157
158 /* this triggers the DCERPC_PFC_FLAG_CONC_MPX flag in the bind request */
159 #define DCERPC_CONCURRENT_MULTIPLEX     (1<<19)
160
161 /*
162   this is used to find pointers to calls
163 */
164 struct dcerpc_interface_call {
165         const char *name;
166         size_t struct_size;
167         ndr_push_flags_fn_t ndr_push;
168         ndr_pull_flags_fn_t ndr_pull;
169         ndr_print_function_t ndr_print;
170         BOOL async;
171 };
172
173 struct dcerpc_endpoint_list {
174         uint32_t count;
175         const char * const *names;
176 };
177
178 struct dcerpc_authservice_list {
179         uint32_t count;
180         const char * const *names;
181 };
182
183 struct dcerpc_interface_table {
184         const char *name;
185         struct dcerpc_syntax_id syntax_id;
186         const char *helpstring;
187         uint32_t num_calls;
188         const struct dcerpc_interface_call *calls;
189         const struct dcerpc_endpoint_list *endpoints;
190         const struct dcerpc_authservice_list *authservices;
191 };
192
193 struct dcerpc_interface_list {
194         struct dcerpc_interface_list *prev, *next;
195         const struct dcerpc_interface_table *table;
196 };
197
198 /* this describes a binding to a particular transport/pipe */
199 struct dcerpc_binding {
200         enum dcerpc_transport_t transport;
201         struct dcerpc_syntax_id object;
202         const char *host;
203         const char *target_hostname;
204         const char *endpoint;
205         const char **options;
206         uint32_t flags;
207         uint32_t assoc_group_id;
208 };
209
210
211 struct dcerpc_pipe_connect {
212         struct dcerpc_pipe *pipe;
213         struct dcerpc_binding *binding;
214         const char *pipe_name;
215         const struct dcerpc_interface_table *interface;
216         struct cli_credentials *creds;
217 };
218
219
220 enum rpc_request_state {
221         RPC_REQUEST_QUEUED,
222         RPC_REQUEST_PENDING,
223         RPC_REQUEST_DONE
224 };
225
226 /*
227   handle for an async dcerpc request
228 */
229 struct rpc_request {
230         struct rpc_request *next, *prev;
231         struct dcerpc_pipe *p;
232         NTSTATUS status;
233         uint32_t call_id;
234         enum rpc_request_state state;
235         DATA_BLOB payload;
236         uint32_t flags;
237         uint32_t fault_code;
238
239         /* this is used to distinguish bind and alter_context requests
240            from normal requests */
241         void (*recv_handler)(struct rpc_request *conn, 
242                              DATA_BLOB *blob, struct ncacn_packet *pkt);
243
244         const struct GUID *object;
245         uint16_t opnum;
246         DATA_BLOB request_data;
247         BOOL async_call;
248         BOOL ignore_timeout;
249
250         /* use by the ndr level async recv call */
251         struct {
252                 const struct dcerpc_interface_table *table;
253                 uint32_t opnum;
254                 void *struct_ptr;
255                 TALLOC_CTX *mem_ctx;
256         } ndr;
257
258         struct {
259                 void (*callback)(struct rpc_request *);
260                 void *private_data;
261         } async;
262 };
263
264 struct epm_tower;
265 struct epm_floor;
266
267 struct smbcli_tree;
268 struct smb2_tree;
269 struct socket_address;
270
271 #include "librpc/rpc/dcerpc_proto.h"
272
273 #endif /* __DCERPC_H__ */