2 Unix SMB/CIFS implementation.
4 Copyright (C) Stefan Metzmacher 2010-2011
5 Copyright (C) Andrew Tridgell 2010-2011
6 Copyright (C) Simo Sorce 2010
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #ifndef __DEFAULT_LIBRPC_RPCCOMMON_H__
23 #define __DEFAULT_LIBRPC_RPCCOMMON_H__
25 struct dcerpc_binding_handle
;
27 struct ndr_interface_table
;
28 struct ndr_interface_call
;
34 struct tevent_context
;
35 struct tstream_context
;
37 enum dcerpc_transport_t
{
38 NCA_UNKNOWN
, NCACN_NP
, NCACN_IP_TCP
, NCACN_IP_UDP
, NCACN_VNS_IPC
,
39 NCACN_VNS_SPP
, NCACN_AT_DSP
, NCADG_AT_DDP
, NCALRPC
, NCACN_UNIX_STREAM
,
40 NCADG_UNIX_DGRAM
, NCACN_HTTP
, NCADG_IPX
, NCACN_SPX
, NCACN_INTERNAL
};
42 /** this describes a binding to a particular transport/pipe */
43 struct dcerpc_binding
{
44 enum dcerpc_transport_t transport
;
45 struct ndr_syntax_id object
;
47 const char *target_hostname
;
48 const char *target_principal
;
51 const char *localaddress
;
53 uint32_t assoc_group_id
;
56 /* dcerpc pipe flags */
57 #define DCERPC_DEBUG_PRINT_IN (1<<0)
58 #define DCERPC_DEBUG_PRINT_OUT (1<<1)
59 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
61 #define DCERPC_DEBUG_VALIDATE_IN (1<<2)
62 #define DCERPC_DEBUG_VALIDATE_OUT (1<<3)
63 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
65 #define DCERPC_CONNECT (1<<4)
66 #define DCERPC_SIGN (1<<5)
67 #define DCERPC_SEAL (1<<6)
69 #define DCERPC_PUSH_BIGENDIAN (1<<7)
70 #define DCERPC_PULL_BIGENDIAN (1<<8)
72 #define DCERPC_SCHANNEL (1<<9)
74 #define DCERPC_ANON_FALLBACK (1<<10)
76 /* use a 128 bit session key */
77 #define DCERPC_SCHANNEL_128 (1<<12)
79 /* check incoming pad bytes */
80 #define DCERPC_DEBUG_PAD_CHECK (1<<13)
82 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
83 #define DCERPC_NDR_REF_ALLOC (1<<14)
85 #define DCERPC_AUTH_OPTIONS (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5|DCERPC_AUTH_NTLM)
87 /* select spnego auth */
88 #define DCERPC_AUTH_SPNEGO (1<<15)
90 /* select krb5 auth */
91 #define DCERPC_AUTH_KRB5 (1<<16)
93 #define DCERPC_SMB2 (1<<17)
95 /* select NTLM auth */
96 #define DCERPC_AUTH_NTLM (1<<18)
98 /* this triggers the DCERPC_PFC_FLAG_CONC_MPX flag in the bind request */
99 #define DCERPC_CONCURRENT_MULTIPLEX (1<<19)
101 /* this triggers the DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag in the bind request */
102 #define DCERPC_HEADER_SIGNING (1<<20)
104 /* use NDR64 transport */
105 #define DCERPC_NDR64 (1<<21)
107 /* specify binding interface */
108 #define DCERPC_LOCALADDRESS (1<<22)
110 /* The following definitions come from ../librpc/rpc/dcerpc_error.c */
112 const char *dcerpc_errstr(TALLOC_CTX
*mem_ctx
, uint32_t fault_code
);
113 NTSTATUS
dcerpc_fault_to_nt_status(uint32_t fault_code
);
115 /* The following definitions come from ../librpc/rpc/binding.c */
117 const char *epm_floor_string(TALLOC_CTX
*mem_ctx
, struct epm_floor
*epm_floor
);
118 const char *dcerpc_floor_get_rhs_data(TALLOC_CTX
*mem_ctx
, struct epm_floor
*epm_floor
);
119 enum dcerpc_transport_t
dcerpc_transport_by_endpoint_protocol(int prot
);
120 NTSTATUS
dcerpc_binding_build_tower(TALLOC_CTX
*mem_ctx
,
121 const struct dcerpc_binding
*binding
,
122 struct epm_tower
*tower
);
123 NTSTATUS
dcerpc_binding_from_tower(TALLOC_CTX
*mem_ctx
,
124 struct epm_tower
*tower
,
125 struct dcerpc_binding
**b_out
);
126 NTSTATUS
dcerpc_parse_binding(TALLOC_CTX
*mem_ctx
, const char *s
, struct dcerpc_binding
**b_out
);
127 char *dcerpc_binding_string(TALLOC_CTX
*mem_ctx
, const struct dcerpc_binding
*b
);
128 NTSTATUS
dcerpc_floor_get_lhs_data(const struct epm_floor
*epm_floor
, struct ndr_syntax_id
*syntax
);
129 const char *derpc_transport_string_by_transport(enum dcerpc_transport_t t
);
130 enum dcerpc_transport_t
dcerpc_transport_by_tower(const struct epm_tower
*tower
);
132 /* The following definitions come from ../librpc/rpc/dcerpc_util.c */
134 void dcerpc_set_frag_length(DATA_BLOB
*blob
, uint16_t v
);
135 uint16_t dcerpc_get_frag_length(const DATA_BLOB
*blob
);
136 void dcerpc_set_auth_length(DATA_BLOB
*blob
, uint16_t v
);
137 uint8_t dcerpc_get_endian_flag(DATA_BLOB
*blob
);
140 * @brief Pull a dcerpc_auth structure, taking account of any auth
141 * padding in the blob. For request/response packets we pass
142 * the whole data blob, so auth_data_only must be set to false
143 * as the blob contains data+pad+auth and no just pad+auth.
145 * @param pkt - The ncacn_packet strcuture
146 * @param mem_ctx - The mem_ctx used to allocate dcerpc_auth elements
147 * @param pkt_trailer - The packet trailer data, usually the trailing
148 * auth_info blob, but in the request/response case
149 * this is the stub_and_verifier blob.
150 * @param auth - A preallocated dcerpc_auth *empty* structure
151 * @param auth_length - The length of the auth trail, sum of auth header
152 * lenght and pkt->auth_length
153 * @param auth_data_only - Whether the pkt_trailer includes only the auth_blob
154 * (+ padding) or also other data.
156 * @return - A NTSTATUS error code.
158 NTSTATUS
dcerpc_pull_auth_trailer(struct ncacn_packet
*pkt
,
160 DATA_BLOB
*pkt_trailer
,
161 struct dcerpc_auth
*auth
,
162 uint32_t *auth_length
,
163 bool auth_data_only
);
164 struct tevent_req
*dcerpc_read_ncacn_packet_send(TALLOC_CTX
*mem_ctx
,
165 struct tevent_context
*ev
,
166 struct tstream_context
*stream
);
167 NTSTATUS
dcerpc_read_ncacn_packet_recv(struct tevent_req
*req
,
169 struct ncacn_packet
**pkt
,
172 /* The following definitions come from ../librpc/rpc/binding_handle.c */
174 struct dcerpc_binding_handle_ops
{
177 bool (*is_connected
)(struct dcerpc_binding_handle
*h
);
178 uint32_t (*set_timeout
)(struct dcerpc_binding_handle
*h
,
181 struct tevent_req
*(*raw_call_send
)(TALLOC_CTX
*mem_ctx
,
182 struct tevent_context
*ev
,
183 struct dcerpc_binding_handle
*h
,
184 const struct GUID
*object
,
187 const uint8_t *in_data
,
189 NTSTATUS (*raw_call_recv
)(struct tevent_req
*req
,
193 uint32_t *out_flags
);
195 struct tevent_req
*(*disconnect_send
)(TALLOC_CTX
*mem_ctx
,
196 struct tevent_context
*ev
,
197 struct dcerpc_binding_handle
*h
);
198 NTSTATUS (*disconnect_recv
)(struct tevent_req
*req
);
200 /* TODO: remove the following functions */
201 bool (*push_bigendian
)(struct dcerpc_binding_handle
*h
);
202 bool (*ref_alloc
)(struct dcerpc_binding_handle
*h
);
203 bool (*use_ndr64
)(struct dcerpc_binding_handle
*h
);
204 void (*do_ndr_print
)(struct dcerpc_binding_handle
*h
,
206 const void *struct_ptr
,
207 const struct ndr_interface_call
*call
);
208 void (*ndr_push_failed
)(struct dcerpc_binding_handle
*h
,
210 const void *struct_ptr
,
211 const struct ndr_interface_call
*call
);
212 void (*ndr_pull_failed
)(struct dcerpc_binding_handle
*h
,
214 const DATA_BLOB
*blob
,
215 const struct ndr_interface_call
*call
);
216 NTSTATUS (*ndr_validate_in
)(struct dcerpc_binding_handle
*h
,
218 const DATA_BLOB
*blob
,
219 const struct ndr_interface_call
*call
);
220 NTSTATUS (*ndr_validate_out
)(struct dcerpc_binding_handle
*h
,
221 struct ndr_pull
*pull_in
,
222 const void *struct_ptr
,
223 const struct ndr_interface_call
*call
);
226 struct dcerpc_binding_handle
*_dcerpc_binding_handle_create(TALLOC_CTX
*mem_ctx
,
227 const struct dcerpc_binding_handle_ops
*ops
,
228 const struct GUID
*object
,
229 const struct ndr_interface_table
*table
,
233 const char *location
);
234 #define dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
235 state, type, location) \
236 _dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
237 state, sizeof(type), #type, location)
239 void *_dcerpc_binding_handle_data(struct dcerpc_binding_handle
*h
);
240 #define dcerpc_binding_handle_data(_h, _type) \
241 talloc_get_type_abort(_dcerpc_binding_handle_data(_h), _type)
243 _DEPRECATED_
void dcerpc_binding_handle_set_sync_ev(struct dcerpc_binding_handle
*h
,
244 struct tevent_context
*ev
);
246 bool dcerpc_binding_handle_is_connected(struct dcerpc_binding_handle
*h
);
248 uint32_t dcerpc_binding_handle_set_timeout(struct dcerpc_binding_handle
*h
,
251 struct tevent_req
*dcerpc_binding_handle_raw_call_send(TALLOC_CTX
*mem_ctx
,
252 struct tevent_context
*ev
,
253 struct dcerpc_binding_handle
*h
,
254 const struct GUID
*object
,
257 const uint8_t *in_data
,
259 NTSTATUS
dcerpc_binding_handle_raw_call_recv(struct tevent_req
*req
,
263 uint32_t *out_flags
);
264 NTSTATUS
dcerpc_binding_handle_raw_call(struct dcerpc_binding_handle
*h
,
265 const struct GUID
*object
,
268 const uint8_t *in_data
,
273 uint32_t *out_flags
);
275 struct tevent_req
*dcerpc_binding_handle_disconnect_send(TALLOC_CTX
*mem_ctx
,
276 struct tevent_context
*ev
,
277 struct dcerpc_binding_handle
*h
);
278 NTSTATUS
dcerpc_binding_handle_disconnect_recv(struct tevent_req
*req
);
280 struct tevent_req
*dcerpc_binding_handle_call_send(TALLOC_CTX
*mem_ctx
,
281 struct tevent_context
*ev
,
282 struct dcerpc_binding_handle
*h
,
283 const struct GUID
*object
,
284 const struct ndr_interface_table
*table
,
288 NTSTATUS
dcerpc_binding_handle_call_recv(struct tevent_req
*req
);
289 NTSTATUS
dcerpc_binding_handle_call(struct dcerpc_binding_handle
*h
,
290 const struct GUID
*object
,
291 const struct ndr_interface_table
*table
,
296 #endif /* __DEFAULT_LIBRPC_RPCCOMMON_H__ */