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 #include "lib/util/data_blob.h"
27 #include "gen_ndr/dcerpc.h"
28 #include "lib/util/attr.h"
30 #include "librpc/ndr/libndr.h"
32 struct dcerpc_binding_handle
;
34 struct ndr_interface_table
;
35 struct ndr_interface_call
;
41 struct tevent_context
;
42 struct tstream_context
;
43 struct gensec_security
;
45 enum dcerpc_transport_t
{
46 NCA_UNKNOWN
, NCACN_NP
, NCACN_IP_TCP
, NCACN_IP_UDP
, NCACN_VNS_IPC
,
47 NCACN_VNS_SPP
, NCACN_AT_DSP
, NCADG_AT_DDP
, NCALRPC
, NCACN_UNIX_STREAM
,
48 NCADG_UNIX_DGRAM
, NCACN_HTTP
, NCADG_IPX
, NCACN_SPX
, NCACN_INTERNAL
};
50 /** this describes a binding to a particular transport/pipe */
51 struct dcerpc_binding
;
53 /* dcerpc pipe flags */
54 #define DCERPC_DEBUG_PRINT_IN (1<<0)
55 #define DCERPC_DEBUG_PRINT_OUT (1<<1)
56 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
58 #define DCERPC_DEBUG_VALIDATE_IN (1<<2)
59 #define DCERPC_DEBUG_VALIDATE_OUT (1<<3)
60 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
62 #define DCERPC_CONNECT (1<<4)
63 #define DCERPC_SIGN (1<<5)
64 #define DCERPC_SEAL (1<<6)
66 #define DCERPC_PUSH_BIGENDIAN (1<<7)
67 #define DCERPC_PULL_BIGENDIAN (1<<8)
69 #define DCERPC_SCHANNEL (1<<9)
71 #define DCERPC_ANON_FALLBACK (1<<10)
73 /* use a 128 bit session key */
74 #define DCERPC_SCHANNEL_128 (1<<12)
76 /* check incoming pad bytes */
77 #define DCERPC_DEBUG_PAD_CHECK (1<<13)
79 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
80 #define DCERPC_NDR_REF_ALLOC (1<<14)
82 #define DCERPC_AUTH_OPTIONS (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5|DCERPC_AUTH_NTLM)
84 /* select spnego auth */
85 #define DCERPC_AUTH_SPNEGO (1<<15)
87 /* select krb5 auth */
88 #define DCERPC_AUTH_KRB5 (1<<16)
90 #define DCERPC_SMB2 (1<<17)
92 /* select NTLM auth */
93 #define DCERPC_AUTH_NTLM (1<<18)
95 /* this triggers the DCERPC_PFC_FLAG_CONC_MPX flag in the bind request */
96 #define DCERPC_CONCURRENT_MULTIPLEX (1<<19)
98 /* this indicates DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag was negotiated */
99 #define DCERPC_HEADER_SIGNING (1<<20)
101 /* use NDR64 transport */
102 #define DCERPC_NDR64 (1<<21)
104 /* handle upgrades or downgrades automatically */
105 #define DCERPC_SCHANNEL_AUTO (1<<23)
107 /* use aes schannel with hmac-sh256 session key */
108 #define DCERPC_SCHANNEL_AES (1<<24)
110 /* this triggers the DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag in the bind request */
111 #define DCERPC_PROPOSE_HEADER_SIGNING (1<<25)
113 #define DCERPC_PACKET (1<<26)
115 #define DCERPC_SMB1 (1<<27)
117 /* The following definitions come from ../librpc/rpc/dcerpc_error.c */
119 const char *dcerpc_errstr(TALLOC_CTX
*mem_ctx
, uint32_t fault_code
);
120 NTSTATUS
dcerpc_fault_to_nt_status(uint32_t fault_code
);
121 uint32_t dcerpc_fault_from_nt_status(NTSTATUS nt_status
);
123 /* The following definitions come from ../librpc/rpc/binding.c */
125 const char *epm_floor_string(TALLOC_CTX
*mem_ctx
, struct epm_floor
*epm_floor
);
126 char *dcerpc_floor_get_rhs_data(TALLOC_CTX
*mem_ctx
, struct epm_floor
*epm_floor
);
127 enum dcerpc_transport_t
dcerpc_transport_by_endpoint_protocol(int prot
);
128 struct dcerpc_binding
*dcerpc_binding_dup(TALLOC_CTX
*mem_ctx
,
129 const struct dcerpc_binding
*b
);
130 NTSTATUS
dcerpc_binding_build_tower(TALLOC_CTX
*mem_ctx
,
131 const struct dcerpc_binding
*binding
,
132 struct epm_tower
*tower
);
133 NTSTATUS
dcerpc_binding_from_tower(TALLOC_CTX
*mem_ctx
,
134 struct epm_tower
*tower
,
135 struct dcerpc_binding
**b_out
);
136 NTSTATUS
dcerpc_parse_binding(TALLOC_CTX
*mem_ctx
, const char *s
, struct dcerpc_binding
**b_out
);
137 char *dcerpc_binding_string(TALLOC_CTX
*mem_ctx
, const struct dcerpc_binding
*b
);
138 struct GUID
dcerpc_binding_get_object(const struct dcerpc_binding
*b
);
139 NTSTATUS
dcerpc_binding_set_object(struct dcerpc_binding
*b
,
141 enum dcerpc_transport_t
dcerpc_binding_get_transport(const struct dcerpc_binding
*b
);
142 NTSTATUS
dcerpc_binding_set_transport(struct dcerpc_binding
*b
,
143 enum dcerpc_transport_t transport
);
144 void dcerpc_binding_get_auth_info(const struct dcerpc_binding
*b
,
145 enum dcerpc_AuthType
*_auth_type
,
146 enum dcerpc_AuthLevel
*_auth_level
);
147 uint32_t dcerpc_binding_get_assoc_group_id(const struct dcerpc_binding
*b
);
148 NTSTATUS
dcerpc_binding_set_assoc_group_id(struct dcerpc_binding
*b
,
149 uint32_t assoc_group_id
);
150 struct ndr_syntax_id
dcerpc_binding_get_abstract_syntax(const struct dcerpc_binding
*b
);
151 NTSTATUS
dcerpc_binding_set_abstract_syntax(struct dcerpc_binding
*b
,
152 const struct ndr_syntax_id
*syntax
);
153 const char *dcerpc_binding_get_string_option(const struct dcerpc_binding
*b
,
155 char *dcerpc_binding_copy_string_option(TALLOC_CTX
*mem_ctx
,
156 const struct dcerpc_binding
*b
,
158 NTSTATUS
dcerpc_binding_set_string_option(struct dcerpc_binding
*b
,
161 uint32_t dcerpc_binding_get_flags(const struct dcerpc_binding
*b
);
162 NTSTATUS
dcerpc_binding_set_flags(struct dcerpc_binding
*b
,
165 NTSTATUS
dcerpc_floor_get_uuid_full(const struct epm_floor
*epm_floor
, struct ndr_syntax_id
*syntax
);
166 const char *derpc_transport_string_by_transport(enum dcerpc_transport_t t
);
167 enum dcerpc_transport_t
dcerpc_transport_by_name(const char *name
);
168 enum dcerpc_transport_t
dcerpc_transport_by_tower(const struct epm_tower
*tower
);
170 /* The following definitions come from ../librpc/rpc/binding_handle.c */
172 struct dcerpc_binding_handle_ops
{
175 bool (*is_connected
)(struct dcerpc_binding_handle
*h
);
176 uint32_t (*set_timeout
)(struct dcerpc_binding_handle
*h
,
179 void (*auth_info
)(struct dcerpc_binding_handle
*h
,
180 enum dcerpc_AuthType
*auth_type
,
181 enum dcerpc_AuthLevel
*auth_level
);
183 struct tevent_req
*(*raw_call_send
)(TALLOC_CTX
*mem_ctx
,
184 struct tevent_context
*ev
,
185 struct dcerpc_binding_handle
*h
,
186 const struct GUID
*object
,
189 const uint8_t *in_data
,
191 NTSTATUS (*raw_call_recv
)(struct tevent_req
*req
,
195 uint32_t *out_flags
);
197 struct tevent_req
*(*disconnect_send
)(TALLOC_CTX
*mem_ctx
,
198 struct tevent_context
*ev
,
199 struct dcerpc_binding_handle
*h
);
200 NTSTATUS (*disconnect_recv
)(struct tevent_req
*req
);
202 /* TODO: remove the following functions */
203 bool (*push_bigendian
)(struct dcerpc_binding_handle
*h
);
204 bool (*ref_alloc
)(struct dcerpc_binding_handle
*h
);
205 bool (*use_ndr64
)(struct dcerpc_binding_handle
*h
);
206 void (*do_ndr_print
)(struct dcerpc_binding_handle
*h
,
207 ndr_flags_type ndr_flags
,
208 const void *struct_ptr
,
209 const struct ndr_interface_call
*call
);
210 void (*ndr_push_failed
)(struct dcerpc_binding_handle
*h
,
212 const void *struct_ptr
,
213 const struct ndr_interface_call
*call
);
214 void (*ndr_pull_failed
)(struct dcerpc_binding_handle
*h
,
216 const DATA_BLOB
*blob
,
217 const struct ndr_interface_call
*call
);
218 NTSTATUS (*ndr_validate_in
)(struct dcerpc_binding_handle
*h
,
220 const DATA_BLOB
*blob
,
221 const struct ndr_interface_call
*call
);
222 NTSTATUS (*ndr_validate_out
)(struct dcerpc_binding_handle
*h
,
223 struct ndr_pull
*pull_in
,
224 const void *struct_ptr
,
225 const struct ndr_interface_call
*call
);
228 struct dcerpc_binding_handle
*_dcerpc_binding_handle_create(TALLOC_CTX
*mem_ctx
,
229 const struct dcerpc_binding_handle_ops
*ops
,
230 const struct GUID
*object
,
231 const struct ndr_interface_table
*table
,
235 const char *location
);
236 #define dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
237 state, type, location) \
238 _dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
239 state, sizeof(type), #type, location)
241 void *_dcerpc_binding_handle_data(struct dcerpc_binding_handle
*h
);
242 #define dcerpc_binding_handle_data(_h, _type) \
243 talloc_get_type_abort(_dcerpc_binding_handle_data(_h), _type)
245 _DEPRECATED_
void dcerpc_binding_handle_set_sync_ev(struct dcerpc_binding_handle
*h
,
246 struct tevent_context
*ev
);
248 bool dcerpc_binding_handle_is_connected(struct dcerpc_binding_handle
*h
);
250 uint32_t dcerpc_binding_handle_set_timeout(struct dcerpc_binding_handle
*h
,
253 void dcerpc_binding_handle_auth_info(struct dcerpc_binding_handle
*h
,
254 enum dcerpc_AuthType
*auth_type
,
255 enum dcerpc_AuthLevel
*auth_level
);
257 struct tevent_req
*dcerpc_binding_handle_raw_call_send(TALLOC_CTX
*mem_ctx
,
258 struct tevent_context
*ev
,
259 struct dcerpc_binding_handle
*h
,
260 const struct GUID
*object
,
263 const uint8_t *in_data
,
265 NTSTATUS
dcerpc_binding_handle_raw_call_recv(struct tevent_req
*req
,
269 uint32_t *out_flags
);
270 NTSTATUS
dcerpc_binding_handle_raw_call(struct dcerpc_binding_handle
*h
,
271 const struct GUID
*object
,
274 const uint8_t *in_data
,
279 uint32_t *out_flags
);
281 struct tevent_req
*dcerpc_binding_handle_disconnect_send(TALLOC_CTX
*mem_ctx
,
282 struct tevent_context
*ev
,
283 struct dcerpc_binding_handle
*h
);
284 NTSTATUS
dcerpc_binding_handle_disconnect_recv(struct tevent_req
*req
);
286 struct tevent_req
*dcerpc_binding_handle_call_send(TALLOC_CTX
*mem_ctx
,
287 struct tevent_context
*ev
,
288 struct dcerpc_binding_handle
*h
,
289 const struct GUID
*object
,
290 const struct ndr_interface_table
*table
,
294 NTSTATUS
dcerpc_binding_handle_call_recv(struct tevent_req
*req
);
295 NTSTATUS
dcerpc_binding_handle_call(struct dcerpc_binding_handle
*h
,
296 const struct GUID
*object
,
297 const struct ndr_interface_table
*table
,
303 * Extract header information from a ncacn_packet
304 * as a dcerpc_sec_vt_header2 as used by the security verification trailer.
306 * @param[in] pkt a packet
308 * @return a dcerpc_sec_vt_header2
310 struct dcerpc_sec_vt_header2
dcerpc_sec_vt_header2_from_ncacn_packet(const struct ncacn_packet
*pkt
);
314 * Test if two dcerpc_sec_vt_header2 structures are equal
315 * without consideration of reserved fields.
317 * @param v1 a pointer to a dcerpc_sec_vt_header2 structure
318 * @param v2 a pointer to a dcerpc_sec_vt_header2 structure
320 * @retval true if *v1 equals *v2
322 bool dcerpc_sec_vt_header2_equal(const struct dcerpc_sec_vt_header2
*v1
,
323 const struct dcerpc_sec_vt_header2
*v2
);
326 * Check for consistency of the security verification trailer with the PDU header.
327 * See <a href="http://msdn.microsoft.com/en-us/library/cc243559.aspx">MS-RPCE 2.2.2.13</a>.
328 * A check with an empty trailer succeeds.
330 * @param[in] vt a pointer to the security verification trailer.
331 * @param[in] bitmask1 which flags were negotiated on the connection.
332 * @param[in] pcontext the syntaxes negotiated for the presentation context.
333 * @param[in] header2 some fields from the PDU header.
335 * @retval true on success.
337 bool dcerpc_sec_verification_trailer_check(
338 const struct dcerpc_sec_verification_trailer
*vt
,
339 const uint32_t *bitmask1
,
340 const struct dcerpc_sec_vt_pcontext
*pcontext
,
341 const struct dcerpc_sec_vt_header2
*header2
);
344 * @brief check and optionally extract the Bind Time Features from
345 * the given ndr_syntax_id.
347 * <a href="http://msdn.microsoft.com/en-us/library/cc243715.aspx">MS-RPCE 3.3.1.5.3 Bind Time Feature Negotiation</a>.
349 * @param[in] s the syntax that should be checked.
351 * @param[out] features This is optional, it will be filled with the extracted
352 * features the on success, otherwise it's filled with 0.
354 * @return true if the syntax matches the 6CB71C2C-9812-4540 prefix with version 1, false otherwise.
356 * @see dcerpc_construct_bind_time_features
358 bool dcerpc_extract_bind_time_features(struct ndr_syntax_id syntax
, uint64_t *features
);
361 * @brief Construct a ndr_syntax_id used for Bind Time Features Negotiation.
363 * <a href="http://msdn.microsoft.com/en-us/library/cc243715.aspx">MS-RPCE 3.3.1.5.3 Bind Time Feature Negotiation</a>.
365 * @param[in] features The supported features.
367 * @return The ndr_syntax_id with the given features.
369 * @see dcerpc_extract_bind_time_features
371 struct ndr_syntax_id
dcerpc_construct_bind_time_features(uint64_t features
);
373 #define DCERPC_AUTH_PAD_LENGTH(stub_length) (\
374 (((stub_length) % DCERPC_AUTH_PAD_ALIGNMENT) > 0)?\
375 (DCERPC_AUTH_PAD_ALIGNMENT - (stub_length) % DCERPC_AUTH_PAD_ALIGNMENT):\
378 NTSTATUS
dcerpc_generic_session_key(DATA_BLOB
*session_key
);
380 NTSTATUS
dcerpc_ncacn_push_auth(DATA_BLOB
*blob
,
382 struct ncacn_packet
*pkt
,
383 struct dcerpc_auth
*auth_info
);
385 void dcerpc_log_packet(const char *packet_log_dir
,
386 const char *interface_name
,
387 uint32_t opnum
, ndr_flags_type flags
,
388 const DATA_BLOB
*pkt
,
392 void dcerpc_save_ndr_fuzz_seed(TALLOC_CTX
*mem_ctx
,
394 const char *dump_dir
,
395 const char *iface_name
,
396 ndr_flags_type flags
,
400 static inline void dcerpc_save_ndr_fuzz_seed(TALLOC_CTX
*mem_ctx
,
402 const char *dump_dir
,
403 const char *iface_name
,
404 ndr_flags_type flags
,
412 #endif /* __DEFAULT_LIBRPC_RPCCOMMON_H__ */