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