482e803a359f462b174009843bdd23aeacd30530
[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 /* This is a public header file that is installed as part of Samba. 
24  * If you remove any functions or change their signature, update 
25  * the so version number. */
26
27 #ifndef __DCERPC_H__
28 #define __DCERPC_H__
29
30 #include "../lib/util/data_blob.h"
31 #include "librpc/gen_ndr/dcerpc.h"
32 #include "librpc/ndr/libndr.h"
33
34 enum dcerpc_transport_t {
35         NCA_UNKNOWN, NCACN_NP, NCACN_IP_TCP, NCACN_IP_UDP, NCACN_VNS_IPC, 
36         NCACN_VNS_SPP, NCACN_AT_DSP, NCADG_AT_DDP, NCALRPC, NCACN_UNIX_STREAM, 
37         NCADG_UNIX_DGRAM, NCACN_HTTP, NCADG_IPX, NCACN_SPX };
38
39 /*
40   this defines a generic security context for signed/sealed dcerpc pipes.
41 */
42 struct dcerpc_connection;
43 struct dcerpc_security {
44         struct dcerpc_auth *auth_info;
45         struct gensec_security *generic_state;
46
47         /* get the session key */
48         NTSTATUS (*session_key)(struct dcerpc_connection *, DATA_BLOB *);
49 };
50
51 /*
52   this holds the information that is not specific to a particular rpc context_id
53 */
54 struct dcerpc_connection {
55         uint32_t call_id;
56         uint32_t srv_max_xmit_frag;
57         uint32_t srv_max_recv_frag;
58         uint32_t flags;
59         struct dcerpc_security security_state;
60         const char *binding_string;
61         struct event_context *event_ctx;
62         struct smb_iconv_convenience *iconv_convenience;
63
64         bool dead;
65         bool free_skipped;
66
67         struct dcerpc_transport {
68                 enum dcerpc_transport_t transport;
69                 void *private_data;
70
71                 NTSTATUS (*shutdown_pipe)(struct dcerpc_connection *, NTSTATUS status);
72
73                 const char *(*peer_name)(struct dcerpc_connection *);
74
75                 const char *(*target_hostname)(struct dcerpc_connection *);
76
77                 /* send a request to the server */
78                 NTSTATUS (*send_request)(struct dcerpc_connection *, DATA_BLOB *, bool trigger_read);
79
80                 /* send a read request to the server */
81                 NTSTATUS (*send_read)(struct dcerpc_connection *);
82
83                 /* a callback to the dcerpc code when a full fragment
84                    has been received */
85                 void (*recv_data)(struct dcerpc_connection *, DATA_BLOB *, NTSTATUS status);
86         } transport;
87
88         /* Requests that have been sent, waiting for a reply */
89         struct rpc_request *pending;
90
91         /* Sync requests waiting to be shipped */
92         struct rpc_request *request_queue;
93
94         /* the next context_id to be assigned */
95         uint32_t next_context_id;
96 };
97
98 /*
99   this encapsulates a full dcerpc client side pipe 
100 */
101 struct dcerpc_pipe {
102         uint32_t context_id;
103
104         uint32_t assoc_group_id;
105
106         struct ndr_syntax_id syntax;
107         struct ndr_syntax_id transfer_syntax;
108
109         struct dcerpc_connection *conn;
110         struct dcerpc_binding *binding;
111
112         /* the last fault code from a DCERPC fault */
113         uint32_t last_fault_code;
114
115         /* timeout for individual rpc requests, in seconds */
116         uint32_t request_timeout;
117 };
118
119 /* default timeout for all rpc requests, in seconds */
120 #define DCERPC_REQUEST_TIMEOUT 60
121
122
123 /* dcerpc pipe flags */
124 #define DCERPC_DEBUG_PRINT_IN          (1<<0)
125 #define DCERPC_DEBUG_PRINT_OUT         (1<<1)
126 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
127
128 #define DCERPC_DEBUG_VALIDATE_IN       (1<<2)
129 #define DCERPC_DEBUG_VALIDATE_OUT      (1<<3)
130 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
131
132 #define DCERPC_CONNECT                 (1<<4)
133 #define DCERPC_SIGN                    (1<<5)
134 #define DCERPC_SEAL                    (1<<6)
135
136 #define DCERPC_PUSH_BIGENDIAN          (1<<7)
137 #define DCERPC_PULL_BIGENDIAN          (1<<8)
138
139 #define DCERPC_SCHANNEL                (1<<9)
140
141 /* use a 128 bit session key */
142 #define DCERPC_SCHANNEL_128            (1<<12)
143
144 /* check incoming pad bytes */
145 #define DCERPC_DEBUG_PAD_CHECK         (1<<13)
146
147 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
148 #define DCERPC_NDR_REF_ALLOC           (1<<14)
149
150 #define DCERPC_AUTH_OPTIONS    (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5|DCERPC_AUTH_NTLM)
151
152 /* select spnego auth */
153 #define DCERPC_AUTH_SPNEGO             (1<<15)
154
155 /* select krb5 auth */
156 #define DCERPC_AUTH_KRB5               (1<<16)
157
158 #define DCERPC_SMB2                    (1<<17)
159
160 /* select NTLM auth */
161 #define DCERPC_AUTH_NTLM               (1<<18)
162
163 /* this triggers the DCERPC_PFC_FLAG_CONC_MPX flag in the bind request */
164 #define DCERPC_CONCURRENT_MULTIPLEX     (1<<19)
165
166 /* this triggers the DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag in the bind request */
167 #define DCERPC_HEADER_SIGNING          (1<<20)
168
169 /* this describes a binding to a particular transport/pipe */
170 struct dcerpc_binding {
171         enum dcerpc_transport_t transport;
172         struct ndr_syntax_id object;
173         const char *host;
174         const char *target_hostname;
175         const char *endpoint;
176         const char **options;
177         uint32_t flags;
178         uint32_t assoc_group_id;
179 };
180
181
182 struct dcerpc_pipe_connect {
183         struct dcerpc_pipe *pipe;
184         struct dcerpc_binding *binding;
185         const char *pipe_name;
186         const struct ndr_interface_table *interface;
187         struct cli_credentials *creds;
188         struct resolve_context *resolve_ctx;
189 };
190
191
192 enum rpc_request_state {
193         RPC_REQUEST_QUEUED,
194         RPC_REQUEST_PENDING,
195         RPC_REQUEST_DONE
196 };
197
198 /*
199   handle for an async dcerpc request
200 */
201 struct rpc_request {
202         struct rpc_request *next, *prev;
203         struct dcerpc_pipe *p;
204         NTSTATUS status;
205         uint32_t call_id;
206         enum rpc_request_state state;
207         DATA_BLOB payload;
208         uint32_t flags;
209         uint32_t fault_code;
210
211         /* this is used to distinguish bind and alter_context requests
212            from normal requests */
213         void (*recv_handler)(struct rpc_request *conn, 
214                              DATA_BLOB *blob, struct ncacn_packet *pkt);
215
216         const struct GUID *object;
217         uint16_t opnum;
218         DATA_BLOB request_data;
219         bool async_call;
220         bool ignore_timeout;
221
222         /* use by the ndr level async recv call */
223         struct {
224                 const struct ndr_interface_table *table;
225                 uint32_t opnum;
226                 void *struct_ptr;
227                 TALLOC_CTX *mem_ctx;
228         } ndr;
229
230         struct {
231                 void (*callback)(struct rpc_request *);
232                 void *private_data;
233         } async;
234 };
235
236 struct epm_tower;
237 struct epm_floor;
238
239 struct smbcli_tree;
240 struct smb2_tree;
241 struct socket_address;
242
243 NTSTATUS dcerpc_pipe_connect(TALLOC_CTX *parent_ctx, 
244                              struct dcerpc_pipe **pp, 
245                              const char *binding,
246                              const struct ndr_interface_table *table,
247                              struct cli_credentials *credentials,
248                              struct event_context *ev,
249                              struct loadparm_context *lp_ctx);
250 NTSTATUS dcerpc_ndr_request_recv(struct rpc_request *req);
251 struct rpc_request *dcerpc_ndr_request_send(struct dcerpc_pipe *p,
252                                                 const struct GUID *object,
253                                                 const struct ndr_interface_table *table,
254                                                 uint32_t opnum, 
255                                                 TALLOC_CTX *mem_ctx, 
256                                                 void *r);
257 const char *dcerpc_server_name(struct dcerpc_pipe *p);
258 struct dcerpc_pipe *dcerpc_pipe_init(TALLOC_CTX *mem_ctx, struct event_context *ev,
259                                      struct smb_iconv_convenience *ic);
260 NTSTATUS dcerpc_pipe_open_smb(struct dcerpc_pipe *p,
261                               struct smbcli_tree *tree,
262                               const char *pipe_name);
263 NTSTATUS dcerpc_bind_auth_none(struct dcerpc_pipe *p,
264                                const struct ndr_interface_table *table);
265 NTSTATUS dcerpc_fetch_session_key(struct dcerpc_pipe *p,
266                                   DATA_BLOB *session_key);
267 struct composite_context;
268 NTSTATUS dcerpc_secondary_connection_recv(struct composite_context *c,
269                                           struct dcerpc_pipe **p2);
270 NTSTATUS dcerpc_parse_binding(TALLOC_CTX *mem_ctx, const char *s, struct dcerpc_binding **b_out);
271
272 struct composite_context* dcerpc_pipe_connect_b_send(TALLOC_CTX *parent_ctx,
273                                                      struct dcerpc_binding *binding,
274                                                      const struct ndr_interface_table *table,
275                                                      struct cli_credentials *credentials,
276                                                      struct event_context *ev,
277                                                      struct loadparm_context *lp_ctx);
278
279 NTSTATUS dcerpc_pipe_connect_b_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
280                                     struct dcerpc_pipe **p);
281
282 NTSTATUS dcerpc_pipe_connect_b(TALLOC_CTX *parent_ctx,
283                                struct dcerpc_pipe **pp,
284                                struct dcerpc_binding *binding,
285                                const struct ndr_interface_table *table,
286                                struct cli_credentials *credentials,
287                                struct event_context *ev,
288                                struct loadparm_context *lp_ctx);
289 const char *dcerpc_errstr(TALLOC_CTX *mem_ctx, uint32_t fault_code);
290
291 NTSTATUS dcerpc_pipe_auth(TALLOC_CTX *mem_ctx,
292                           struct dcerpc_pipe **p, 
293                           struct dcerpc_binding *binding,
294                           const struct ndr_interface_table *table,
295                           struct cli_credentials *credentials,
296                           struct loadparm_context *lp_ctx);
297 char *dcerpc_binding_string(TALLOC_CTX *mem_ctx, const struct dcerpc_binding *b);
298 NTSTATUS dcerpc_secondary_connection(struct dcerpc_pipe *p,
299                                      struct dcerpc_pipe **p2,
300                                      struct dcerpc_binding *b);
301 NTSTATUS dcerpc_bind_auth_schannel(TALLOC_CTX *tmp_ctx, 
302                                    struct dcerpc_pipe *p,
303                                    const struct ndr_interface_table *table,
304                                    struct cli_credentials *credentials,
305                                    struct loadparm_context *lp_ctx,
306                                    uint8_t auth_level);
307 struct event_context *dcerpc_event_context(struct dcerpc_pipe *p);
308 NTSTATUS dcerpc_init(void);
309 struct smbcli_tree *dcerpc_smb_tree(struct dcerpc_connection *c);
310 uint16_t dcerpc_smb_fnum(struct dcerpc_connection *c);
311 NTSTATUS dcerpc_secondary_context(struct dcerpc_pipe *p, 
312                                   struct dcerpc_pipe **pp2,
313                                   const struct ndr_interface_table *table);
314 NTSTATUS dcerpc_alter_context(struct dcerpc_pipe *p, 
315                               TALLOC_CTX *mem_ctx,
316                               const struct ndr_syntax_id *syntax,
317                               const struct ndr_syntax_id *transfer_syntax);
318
319 NTSTATUS dcerpc_bind_auth(struct dcerpc_pipe *p,
320                           const struct ndr_interface_table *table,
321                           struct cli_credentials *credentials,
322                           struct loadparm_context *lp_ctx,
323                           uint8_t auth_type, uint8_t auth_level,
324                           const char *service);
325 struct composite_context* dcerpc_pipe_connect_send(TALLOC_CTX *parent_ctx,
326                                                    const char *binding,
327                                                    const struct ndr_interface_table *table,
328                                                    struct cli_credentials *credentials,
329                                                    struct event_context *ev, struct loadparm_context *lp_ctx);
330 NTSTATUS dcerpc_pipe_connect_recv(struct composite_context *c,
331                                   TALLOC_CTX *mem_ctx,
332                                   struct dcerpc_pipe **pp);
333
334 NTSTATUS dcerpc_epm_map_binding(TALLOC_CTX *mem_ctx, struct dcerpc_binding *binding,
335                                 const struct ndr_interface_table *table, struct event_context *ev,
336                                 struct loadparm_context *lp_ctx);
337 struct composite_context* dcerpc_secondary_auth_connection_send(struct dcerpc_pipe *p,
338                                                                 struct dcerpc_binding *binding,
339                                                                 const struct ndr_interface_table *table,
340                                                                 struct cli_credentials *credentials,
341                                                                 struct loadparm_context *lp_ctx);
342 NTSTATUS dcerpc_secondary_auth_connection_recv(struct composite_context *c, 
343                                                TALLOC_CTX *mem_ctx,
344                                                struct dcerpc_pipe **p);
345
346 struct composite_context* dcerpc_secondary_connection_send(struct dcerpc_pipe *p,
347                                                            struct dcerpc_binding *b);
348 void dcerpc_log_packet(const struct ndr_interface_table *ndr,
349                        uint32_t opnum, uint32_t flags, 
350                        DATA_BLOB *pkt);
351 NTSTATUS dcerpc_binding_build_tower(TALLOC_CTX *mem_ctx, struct dcerpc_binding *binding, struct epm_tower *tower);
352
353 NTSTATUS dcerpc_floor_get_lhs_data(struct epm_floor *epm_floor, struct ndr_syntax_id *syntax);
354
355 enum dcerpc_transport_t dcerpc_transport_by_tower(struct epm_tower *tower);
356
357 NTSTATUS dcerpc_ndr_request(struct dcerpc_pipe *p,
358                             const struct GUID *object,
359                             const struct ndr_interface_table *table,
360                             uint32_t opnum, 
361                             TALLOC_CTX *mem_ctx, 
362                             void *r);
363
364 NTSTATUS dcerpc_binding_from_tower(TALLOC_CTX *mem_ctx, 
365                                    struct epm_tower *tower, 
366                                    struct dcerpc_binding **b_out);
367
368 NTSTATUS dcerpc_request(struct dcerpc_pipe *p, 
369                         struct GUID *object,
370                         uint16_t opnum,
371                         bool async,
372                         TALLOC_CTX *mem_ctx,
373                         DATA_BLOB *stub_data_in,
374                         DATA_BLOB *stub_data_out);
375
376 typedef NTSTATUS (*dcerpc_call_fn) (struct dcerpc_pipe *, TALLOC_CTX *, void *);
377
378 enum dcerpc_transport_t dcerpc_transport_by_endpoint_protocol(int prot);
379
380 #endif /* __DCERPC_H__ */