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;
46 const char *object_string;
48 const char *target_hostname;
49 const char *target_principal;
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 indicates DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag was negotiated */
102 #define DCERPC_HEADER_SIGNING (1<<20)
104 /* use NDR64 transport */
105 #define DCERPC_NDR64 (1<<21)
107 /* handle upgrades or downgrades automatically */
108 #define DCERPC_SCHANNEL_AUTO (1<<23)
110 /* use aes schannel with hmac-sh256 session key */
111 #define DCERPC_SCHANNEL_AES (1<<24)
113 /* this triggers the DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag in the bind request */
114 #define DCERPC_PROPOSE_HEADER_SIGNING (1<<25)
116 /* The following definitions come from ../librpc/rpc/dcerpc_error.c */
118 const char *dcerpc_errstr(TALLOC_CTX *mem_ctx, uint32_t fault_code);
119 NTSTATUS dcerpc_fault_to_nt_status(uint32_t fault_code);
121 /* The following definitions come from ../librpc/rpc/binding.c */
123 const char *epm_floor_string(TALLOC_CTX *mem_ctx, struct epm_floor *epm_floor);
124 char *dcerpc_floor_get_rhs_data(TALLOC_CTX *mem_ctx, struct epm_floor *epm_floor);
125 enum dcerpc_transport_t dcerpc_transport_by_endpoint_protocol(int prot);
126 struct dcerpc_binding *dcerpc_binding_dup(TALLOC_CTX *mem_ctx,
127 const struct dcerpc_binding *b);
128 NTSTATUS dcerpc_binding_build_tower(TALLOC_CTX *mem_ctx,
129 const struct dcerpc_binding *binding,
130 struct epm_tower *tower);
131 NTSTATUS dcerpc_binding_from_tower(TALLOC_CTX *mem_ctx,
132 struct epm_tower *tower,
133 struct dcerpc_binding **b_out);
134 NTSTATUS dcerpc_parse_binding(TALLOC_CTX *mem_ctx, const char *s, struct dcerpc_binding **b_out);
135 char *dcerpc_binding_string(TALLOC_CTX *mem_ctx, const struct dcerpc_binding *b);
136 struct GUID dcerpc_binding_get_object(const struct dcerpc_binding *b);
137 NTSTATUS dcerpc_binding_set_object(struct dcerpc_binding *b,
139 enum dcerpc_transport_t dcerpc_binding_get_transport(const struct dcerpc_binding *b);
140 NTSTATUS dcerpc_binding_set_transport(struct dcerpc_binding *b,
141 enum dcerpc_transport_t transport);
142 void dcerpc_binding_get_auth_info(const struct dcerpc_binding *b,
143 enum dcerpc_AuthType *_auth_type,
144 enum dcerpc_AuthLevel *_auth_level);
145 const char *dcerpc_binding_get_string_option(const struct dcerpc_binding *b,
147 char *dcerpc_binding_copy_string_option(TALLOC_CTX *mem_ctx,
148 const struct dcerpc_binding *b,
150 NTSTATUS dcerpc_binding_set_string_option(struct dcerpc_binding *b,
153 uint32_t dcerpc_binding_get_flags(const struct dcerpc_binding *b);
154 NTSTATUS dcerpc_binding_set_flags(struct dcerpc_binding *b,
157 NTSTATUS dcerpc_floor_get_lhs_data(const struct epm_floor *epm_floor, struct ndr_syntax_id *syntax);
158 const char *derpc_transport_string_by_transport(enum dcerpc_transport_t t);
159 enum dcerpc_transport_t dcerpc_transport_by_name(const char *name);
160 enum dcerpc_transport_t dcerpc_transport_by_tower(const struct epm_tower *tower);
162 /* The following definitions come from ../librpc/rpc/dcerpc_util.c */
164 void dcerpc_set_frag_length(DATA_BLOB *blob, uint16_t v);
165 uint16_t dcerpc_get_frag_length(const DATA_BLOB *blob);
166 void dcerpc_set_auth_length(DATA_BLOB *blob, uint16_t v);
167 uint8_t dcerpc_get_endian_flag(DATA_BLOB *blob);
168 const char *dcerpc_default_transport_endpoint(TALLOC_CTX *mem_ctx,
169 enum dcerpc_transport_t transport,
170 const struct ndr_interface_table *table);
173 * @brief Pull a dcerpc_auth structure, taking account of any auth
174 * padding in the blob. For request/response packets we pass
175 * the whole data blob, so auth_data_only must be set to false
176 * as the blob contains data+pad+auth and no just pad+auth.
178 * @param pkt - The ncacn_packet strcuture
179 * @param mem_ctx - The mem_ctx used to allocate dcerpc_auth elements
180 * @param pkt_trailer - The packet trailer data, usually the trailing
181 * auth_info blob, but in the request/response case
182 * this is the stub_and_verifier blob.
183 * @param auth - A preallocated dcerpc_auth *empty* structure
184 * @param auth_length - The length of the auth trail, sum of auth header
185 * lenght and pkt->auth_length
186 * @param auth_data_only - Whether the pkt_trailer includes only the auth_blob
187 * (+ padding) or also other data.
189 * @return - A NTSTATUS error code.
191 NTSTATUS dcerpc_pull_auth_trailer(struct ncacn_packet *pkt,
193 DATA_BLOB *pkt_trailer,
194 struct dcerpc_auth *auth,
195 uint32_t *auth_length,
196 bool auth_data_only);
197 struct tevent_req *dcerpc_read_ncacn_packet_send(TALLOC_CTX *mem_ctx,
198 struct tevent_context *ev,
199 struct tstream_context *stream);
200 NTSTATUS dcerpc_read_ncacn_packet_recv(struct tevent_req *req,
202 struct ncacn_packet **pkt,
205 /* The following definitions come from ../librpc/rpc/binding_handle.c */
207 struct dcerpc_binding_handle_ops {
210 bool (*is_connected)(struct dcerpc_binding_handle *h);
211 uint32_t (*set_timeout)(struct dcerpc_binding_handle *h,
214 void (*auth_info)(struct dcerpc_binding_handle *h,
215 enum dcerpc_AuthType *auth_type,
216 enum dcerpc_AuthLevel *auth_level);
218 struct tevent_req *(*raw_call_send)(TALLOC_CTX *mem_ctx,
219 struct tevent_context *ev,
220 struct dcerpc_binding_handle *h,
221 const struct GUID *object,
224 const uint8_t *in_data,
226 NTSTATUS (*raw_call_recv)(struct tevent_req *req,
230 uint32_t *out_flags);
232 struct tevent_req *(*disconnect_send)(TALLOC_CTX *mem_ctx,
233 struct tevent_context *ev,
234 struct dcerpc_binding_handle *h);
235 NTSTATUS (*disconnect_recv)(struct tevent_req *req);
237 /* TODO: remove the following functions */
238 bool (*push_bigendian)(struct dcerpc_binding_handle *h);
239 bool (*ref_alloc)(struct dcerpc_binding_handle *h);
240 bool (*use_ndr64)(struct dcerpc_binding_handle *h);
241 void (*do_ndr_print)(struct dcerpc_binding_handle *h,
243 const void *struct_ptr,
244 const struct ndr_interface_call *call);
245 void (*ndr_push_failed)(struct dcerpc_binding_handle *h,
247 const void *struct_ptr,
248 const struct ndr_interface_call *call);
249 void (*ndr_pull_failed)(struct dcerpc_binding_handle *h,
251 const DATA_BLOB *blob,
252 const struct ndr_interface_call *call);
253 NTSTATUS (*ndr_validate_in)(struct dcerpc_binding_handle *h,
255 const DATA_BLOB *blob,
256 const struct ndr_interface_call *call);
257 NTSTATUS (*ndr_validate_out)(struct dcerpc_binding_handle *h,
258 struct ndr_pull *pull_in,
259 const void *struct_ptr,
260 const struct ndr_interface_call *call);
263 struct dcerpc_binding_handle *_dcerpc_binding_handle_create(TALLOC_CTX *mem_ctx,
264 const struct dcerpc_binding_handle_ops *ops,
265 const struct GUID *object,
266 const struct ndr_interface_table *table,
270 const char *location);
271 #define dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
272 state, type, location) \
273 _dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
274 state, sizeof(type), #type, location)
276 void *_dcerpc_binding_handle_data(struct dcerpc_binding_handle *h);
277 #define dcerpc_binding_handle_data(_h, _type) \
278 talloc_get_type_abort(_dcerpc_binding_handle_data(_h), _type)
280 _DEPRECATED_ void dcerpc_binding_handle_set_sync_ev(struct dcerpc_binding_handle *h,
281 struct tevent_context *ev);
283 bool dcerpc_binding_handle_is_connected(struct dcerpc_binding_handle *h);
285 uint32_t dcerpc_binding_handle_set_timeout(struct dcerpc_binding_handle *h,
288 void dcerpc_binding_handle_auth_info(struct dcerpc_binding_handle *h,
289 enum dcerpc_AuthType *auth_type,
290 enum dcerpc_AuthLevel *auth_level);
292 struct tevent_req *dcerpc_binding_handle_raw_call_send(TALLOC_CTX *mem_ctx,
293 struct tevent_context *ev,
294 struct dcerpc_binding_handle *h,
295 const struct GUID *object,
298 const uint8_t *in_data,
300 NTSTATUS dcerpc_binding_handle_raw_call_recv(struct tevent_req *req,
304 uint32_t *out_flags);
305 NTSTATUS dcerpc_binding_handle_raw_call(struct dcerpc_binding_handle *h,
306 const struct GUID *object,
309 const uint8_t *in_data,
314 uint32_t *out_flags);
316 struct tevent_req *dcerpc_binding_handle_disconnect_send(TALLOC_CTX *mem_ctx,
317 struct tevent_context *ev,
318 struct dcerpc_binding_handle *h);
319 NTSTATUS dcerpc_binding_handle_disconnect_recv(struct tevent_req *req);
321 struct tevent_req *dcerpc_binding_handle_call_send(TALLOC_CTX *mem_ctx,
322 struct tevent_context *ev,
323 struct dcerpc_binding_handle *h,
324 const struct GUID *object,
325 const struct ndr_interface_table *table,
329 NTSTATUS dcerpc_binding_handle_call_recv(struct tevent_req *req);
330 NTSTATUS dcerpc_binding_handle_call(struct dcerpc_binding_handle *h,
331 const struct GUID *object,
332 const struct ndr_interface_table *table,
338 * Extract header information from a ncacn_packet
339 * as a dcerpc_sec_vt_header2 as used by the security verification trailer.
341 * @param[in] pkt a packet
343 * @return a dcerpc_sec_vt_header2
345 struct dcerpc_sec_vt_header2 dcerpc_sec_vt_header2_from_ncacn_packet(const struct ncacn_packet *pkt);
349 * Test if two dcerpc_sec_vt_header2 structures are equal
350 * without consideration of reserved fields.
352 * @param v1 a pointer to a dcerpc_sec_vt_header2 structure
353 * @param v2 a pointer to a dcerpc_sec_vt_header2 structure
355 * @retval true if *v1 equals *v2
357 bool dcerpc_sec_vt_header2_equal(const struct dcerpc_sec_vt_header2 *v1,
358 const struct dcerpc_sec_vt_header2 *v2);
361 * Check for consistency of the security verification trailer with the PDU header.
362 * See <a href="http://msdn.microsoft.com/en-us/library/cc243559.aspx">MS-RPCE 2.2.2.13</a>.
363 * A check with an empty trailer succeeds.
365 * @param[in] vt a pointer to the security verification trailer.
366 * @param[in] bitmask1 which flags were negotiated on the connection.
367 * @param[in] pcontext the syntaxes negotiatied for the presentation context.
368 * @param[in] header2 some fields from the PDU header.
370 * @retval true on success.
372 bool dcerpc_sec_verification_trailer_check(
373 const struct dcerpc_sec_verification_trailer *vt,
374 const uint32_t *bitmask1,
375 const struct dcerpc_sec_vt_pcontext *pcontext,
376 const struct dcerpc_sec_vt_header2 *header2);
378 #endif /* __DEFAULT_LIBRPC_RPCCOMMON_H__ */