2 Unix SMB/CIFS implementation.
4 DCERPC client side interface structures
6 Copyright (C) Tim Potter 2003
7 Copyright (C) Andrew Tridgell 2003-2005
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.
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.
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/>.
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. */
30 #include "lib/util/data_blob.h"
31 #include "librpc/gen_ndr/dcerpc.h"
32 #include "librpc/ndr/libndr.h"
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 };
40 this defines a generic security context for signed/sealed dcerpc pipes.
42 struct dcerpc_connection;
43 struct dcerpc_security {
44 struct dcerpc_auth *auth_info;
45 struct gensec_security *generic_state;
47 /* get the session key */
48 NTSTATUS (*session_key)(struct dcerpc_connection *, DATA_BLOB *);
52 this holds the information that is not specific to a particular rpc context_id
54 struct dcerpc_connection {
56 uint32_t srv_max_xmit_frag;
57 uint32_t srv_max_recv_frag;
59 struct dcerpc_security security_state;
60 const char *binding_string;
61 struct event_context *event_ctx;
62 struct smb_iconv_convenience *iconv_convenience;
67 struct dcerpc_transport {
68 enum dcerpc_transport_t transport;
71 NTSTATUS (*shutdown_pipe)(struct dcerpc_connection *, NTSTATUS status);
73 const char *(*peer_name)(struct dcerpc_connection *);
75 const char *(*target_hostname)(struct dcerpc_connection *);
77 /* send a request to the server */
78 NTSTATUS (*send_request)(struct dcerpc_connection *, DATA_BLOB *, bool trigger_read);
80 /* send a read request to the server */
81 NTSTATUS (*send_read)(struct dcerpc_connection *);
83 /* a callback to the dcerpc code when a full fragment
85 void (*recv_data)(struct dcerpc_connection *, DATA_BLOB *, NTSTATUS status);
88 /* Requests that have been sent, waiting for a reply */
89 struct rpc_request *pending;
91 /* Sync requests waiting to be shipped */
92 struct rpc_request *request_queue;
94 /* the next context_id to be assigned */
95 uint32_t next_context_id;
99 this encapsulates a full dcerpc client side pipe
104 uint32_t assoc_group_id;
106 struct ndr_syntax_id syntax;
107 struct ndr_syntax_id transfer_syntax;
109 struct dcerpc_connection *conn;
110 struct dcerpc_binding *binding;
112 /* the last fault code from a DCERPC fault */
113 uint32_t last_fault_code;
115 /* timeout for individual rpc requests, in seconds */
116 uint32_t request_timeout;
119 /* default timeout for all rpc requests, in seconds */
120 #define DCERPC_REQUEST_TIMEOUT 60
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)
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)
132 #define DCERPC_CONNECT (1<<4)
133 #define DCERPC_SIGN (1<<5)
134 #define DCERPC_SEAL (1<<6)
136 #define DCERPC_PUSH_BIGENDIAN (1<<7)
137 #define DCERPC_PULL_BIGENDIAN (1<<8)
139 #define DCERPC_SCHANNEL (1<<9)
141 /* use a 128 bit session key */
142 #define DCERPC_SCHANNEL_128 (1<<12)
144 /* check incoming pad bytes */
145 #define DCERPC_DEBUG_PAD_CHECK (1<<13)
147 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
148 #define DCERPC_NDR_REF_ALLOC (1<<14)
150 #define DCERPC_AUTH_OPTIONS (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5|DCERPC_AUTH_NTLM)
152 /* select spnego auth */
153 #define DCERPC_AUTH_SPNEGO (1<<15)
155 /* select krb5 auth */
156 #define DCERPC_AUTH_KRB5 (1<<16)
158 #define DCERPC_SMB2 (1<<17)
160 /* select NTLM auth */
161 #define DCERPC_AUTH_NTLM (1<<18)
163 /* this triggers the DCERPC_PFC_FLAG_CONC_MPX flag in the bind request */
164 #define DCERPC_CONCURRENT_MULTIPLEX (1<<19)
166 /* this describes a binding to a particular transport/pipe */
167 struct dcerpc_binding {
168 enum dcerpc_transport_t transport;
169 struct ndr_syntax_id object;
171 const char *target_hostname;
172 const char *endpoint;
173 const char **options;
175 uint32_t assoc_group_id;
179 struct dcerpc_pipe_connect {
180 struct dcerpc_pipe *pipe;
181 struct dcerpc_binding *binding;
182 const char *pipe_name;
183 const struct ndr_interface_table *interface;
184 struct cli_credentials *creds;
185 struct resolve_context *resolve_ctx;
189 enum rpc_request_state {
196 handle for an async dcerpc request
199 struct rpc_request *next, *prev;
200 struct dcerpc_pipe *p;
203 enum rpc_request_state state;
208 /* this is used to distinguish bind and alter_context requests
209 from normal requests */
210 void (*recv_handler)(struct rpc_request *conn,
211 DATA_BLOB *blob, struct ncacn_packet *pkt);
213 const struct GUID *object;
215 DATA_BLOB request_data;
219 /* use by the ndr level async recv call */
221 const struct ndr_interface_table *table;
228 void (*callback)(struct rpc_request *);
238 struct socket_address;
240 NTSTATUS dcerpc_pipe_connect(TALLOC_CTX *parent_ctx,
241 struct dcerpc_pipe **pp,
243 const struct ndr_interface_table *table,
244 struct cli_credentials *credentials,
245 struct event_context *ev,
246 struct loadparm_context *lp_ctx);
247 NTSTATUS dcerpc_ndr_request_recv(struct rpc_request *req);
248 struct rpc_request *dcerpc_ndr_request_send(struct dcerpc_pipe *p,
249 const struct GUID *object,
250 const struct ndr_interface_table *table,
254 const char *dcerpc_server_name(struct dcerpc_pipe *p);
255 struct dcerpc_pipe *dcerpc_pipe_init(TALLOC_CTX *mem_ctx, struct event_context *ev,
256 struct smb_iconv_convenience *ic);
257 NTSTATUS dcerpc_pipe_open_smb(struct dcerpc_pipe *p,
258 struct smbcli_tree *tree,
259 const char *pipe_name);
260 NTSTATUS dcerpc_bind_auth_none(struct dcerpc_pipe *p,
261 const struct ndr_interface_table *table);
262 NTSTATUS dcerpc_fetch_session_key(struct dcerpc_pipe *p,
263 DATA_BLOB *session_key);
264 struct composite_context;
265 NTSTATUS dcerpc_secondary_connection_recv(struct composite_context *c,
266 struct dcerpc_pipe **p2);
267 NTSTATUS dcerpc_parse_binding(TALLOC_CTX *mem_ctx, const char *s, struct dcerpc_binding **b_out);
269 struct composite_context* dcerpc_pipe_connect_b_send(TALLOC_CTX *parent_ctx,
270 struct dcerpc_binding *binding,
271 const struct ndr_interface_table *table,
272 struct cli_credentials *credentials,
273 struct event_context *ev,
274 struct loadparm_context *lp_ctx);
276 NTSTATUS dcerpc_pipe_connect_b_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
277 struct dcerpc_pipe **p);
279 NTSTATUS dcerpc_pipe_connect_b(TALLOC_CTX *parent_ctx,
280 struct dcerpc_pipe **pp,
281 struct dcerpc_binding *binding,
282 const struct ndr_interface_table *table,
283 struct cli_credentials *credentials,
284 struct event_context *ev,
285 struct loadparm_context *lp_ctx);
286 const char *dcerpc_errstr(TALLOC_CTX *mem_ctx, uint32_t fault_code);
288 NTSTATUS dcerpc_pipe_auth(TALLOC_CTX *mem_ctx,
289 struct dcerpc_pipe **p,
290 struct dcerpc_binding *binding,
291 const struct ndr_interface_table *table,
292 struct cli_credentials *credentials,
293 struct loadparm_context *lp_ctx);
294 char *dcerpc_binding_string(TALLOC_CTX *mem_ctx, const struct dcerpc_binding *b);
295 NTSTATUS dcerpc_secondary_connection(struct dcerpc_pipe *p,
296 struct dcerpc_pipe **p2,
297 struct dcerpc_binding *b);
298 NTSTATUS dcerpc_bind_auth_schannel(TALLOC_CTX *tmp_ctx,
299 struct dcerpc_pipe *p,
300 const struct ndr_interface_table *table,
301 struct cli_credentials *credentials,
302 struct loadparm_context *lp_ctx,
304 struct event_context *dcerpc_event_context(struct dcerpc_pipe *p);
305 NTSTATUS dcerpc_init(void);
306 struct smbcli_tree *dcerpc_smb_tree(struct dcerpc_connection *c);
307 uint16_t dcerpc_smb_fnum(struct dcerpc_connection *c);
308 NTSTATUS dcerpc_secondary_context(struct dcerpc_pipe *p,
309 struct dcerpc_pipe **pp2,
310 const struct ndr_interface_table *table);
311 NTSTATUS dcerpc_alter_context(struct dcerpc_pipe *p,
313 const struct ndr_syntax_id *syntax,
314 const struct ndr_syntax_id *transfer_syntax);
316 NTSTATUS dcerpc_bind_auth(struct dcerpc_pipe *p,
317 const struct ndr_interface_table *table,
318 struct cli_credentials *credentials,
319 struct loadparm_context *lp_ctx,
320 uint8_t auth_type, uint8_t auth_level,
321 const char *service);
322 struct composite_context* dcerpc_pipe_connect_send(TALLOC_CTX *parent_ctx,
324 const struct ndr_interface_table *table,
325 struct cli_credentials *credentials,
326 struct event_context *ev, struct loadparm_context *lp_ctx);
327 NTSTATUS dcerpc_pipe_connect_recv(struct composite_context *c,
329 struct dcerpc_pipe **pp);
331 NTSTATUS dcerpc_epm_map_binding(TALLOC_CTX *mem_ctx, struct dcerpc_binding *binding,
332 const struct ndr_interface_table *table, struct event_context *ev,
333 struct loadparm_context *lp_ctx);
334 struct composite_context* dcerpc_secondary_auth_connection_send(struct dcerpc_pipe *p,
335 struct dcerpc_binding *binding,
336 const struct ndr_interface_table *table,
337 struct cli_credentials *credentials,
338 struct loadparm_context *lp_ctx);
339 NTSTATUS dcerpc_secondary_auth_connection_recv(struct composite_context *c,
341 struct dcerpc_pipe **p);
343 struct composite_context* dcerpc_secondary_connection_send(struct dcerpc_pipe *p,
344 struct dcerpc_binding *b);
345 void dcerpc_log_packet(const struct ndr_interface_table *ndr,
346 uint32_t opnum, uint32_t flags,
348 NTSTATUS dcerpc_binding_build_tower(TALLOC_CTX *mem_ctx, struct dcerpc_binding *binding, struct epm_tower *tower);
350 NTSTATUS dcerpc_floor_get_lhs_data(struct epm_floor *epm_floor, struct ndr_syntax_id *syntax);
352 enum dcerpc_transport_t dcerpc_transport_by_tower(struct epm_tower *tower);
354 NTSTATUS dcerpc_ndr_request(struct dcerpc_pipe *p,
355 const struct GUID *object,
356 const struct ndr_interface_table *table,
361 NTSTATUS dcerpc_binding_from_tower(TALLOC_CTX *mem_ctx,
362 struct epm_tower *tower,
363 struct dcerpc_binding **b_out);
366 #endif /* __DCERPC_H__ */