librpc/rpc/rpc_common.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Copyright (C) Stefan Metzmacher 2010-2011
   5    Copyright (C) Andrew Tridgell 2010-2011
   6    Copyright (C) Simo Sorce 2010
   7
   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.
  12
  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.
  17
  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/>.
  20 */
  21
  22 #ifndef __DEFAULT_LIBRPC_RPCCOMMON_H__
  23 #define __DEFAULT_LIBRPC_RPCCOMMON_H__
  24
  25 #include "gen_ndr/dcerpc.h"
  26 #include "lib/util/attr.h"
  27
  28 struct dcerpc_binding_handle;
  29 struct GUID;
  30 struct ndr_interface_table;
  31 struct ndr_interface_call;
  32 struct ndr_push;
  33 struct ndr_pull;
  34 struct ncacn_packet;
  35 struct epm_floor;
  36 struct epm_tower;
  37 struct tevent_context;
  38 struct tstream_context;
  39
  40 enum dcerpc_transport_t {
  41         NCA_UNKNOWN, NCACN_NP, NCACN_IP_TCP, NCACN_IP_UDP, NCACN_VNS_IPC,
  42         NCACN_VNS_SPP, NCACN_AT_DSP, NCADG_AT_DDP, NCALRPC, NCACN_UNIX_STREAM,
  43         NCADG_UNIX_DGRAM, NCACN_HTTP, NCADG_IPX, NCACN_SPX, NCACN_INTERNAL };
  44
  45 /** this describes a binding to a particular transport/pipe */
  46 struct dcerpc_binding;
  47
  48 /* dcerpc pipe flags */
  49 #define DCERPC_DEBUG_PRINT_IN          (1<<0)
  50 #define DCERPC_DEBUG_PRINT_OUT         (1<<1)
  51 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
  52
  53 #define DCERPC_DEBUG_VALIDATE_IN       (1<<2)
  54 #define DCERPC_DEBUG_VALIDATE_OUT      (1<<3)
  55 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
  56
  57 #define DCERPC_CONNECT                 (1<<4)
  58 #define DCERPC_SIGN                    (1<<5)
  59 #define DCERPC_SEAL                    (1<<6)
  60
  61 #define DCERPC_PUSH_BIGENDIAN          (1<<7)
  62 #define DCERPC_PULL_BIGENDIAN          (1<<8)
  63
  64 #define DCERPC_SCHANNEL                (1<<9)
  65
  66 #define DCERPC_ANON_FALLBACK           (1<<10)
  67
  68 /* use a 128 bit session key */
  69 #define DCERPC_SCHANNEL_128            (1<<12)
  70
  71 /* check incoming pad bytes */
  72 #define DCERPC_DEBUG_PAD_CHECK         (1<<13)
  73
  74 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
  75 #define DCERPC_NDR_REF_ALLOC           (1<<14)
  76
  77 #define DCERPC_AUTH_OPTIONS    (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5|DCERPC_AUTH_NTLM)
  78
  79 /* select spnego auth */
  80 #define DCERPC_AUTH_SPNEGO             (1<<15)
  81
  82 /* select krb5 auth */
  83 #define DCERPC_AUTH_KRB5               (1<<16)
  84
  85 #define DCERPC_SMB2                    (1<<17)
  86
  87 /* select NTLM auth */
  88 #define DCERPC_AUTH_NTLM               (1<<18)
  89
  90 /* this triggers the DCERPC_PFC_FLAG_CONC_MPX flag in the bind request */
  91 #define DCERPC_CONCURRENT_MULTIPLEX     (1<<19)
  92
  93 /* this indicates DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag was negotiated */
  94 #define DCERPC_HEADER_SIGNING          (1<<20)
  95
  96 /* use NDR64 transport */
  97 #define DCERPC_NDR64                   (1<<21)
  98
  99 /* handle upgrades or downgrades automatically */
 100 #define DCERPC_SCHANNEL_AUTO           (1<<23)
 101
 102 /* use aes schannel with hmac-sh256 session key */
 103 #define DCERPC_SCHANNEL_AES            (1<<24)
 104
 105 /* this triggers the DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag in the bind request */
 106 #define DCERPC_PROPOSE_HEADER_SIGNING          (1<<25)
 107
 108 /* The following definitions come from ../librpc/rpc/dcerpc_error.c  */
 109
 110 const char *dcerpc_errstr(TALLOC_CTX *mem_ctx, uint32_t fault_code);
 111 NTSTATUS dcerpc_fault_to_nt_status(uint32_t fault_code);
 112 uint32_t dcerpc_fault_from_nt_status(NTSTATUS nt_status);
 113
 114 /* The following definitions come from ../librpc/rpc/binding.c  */
 115
 116 const char *epm_floor_string(TALLOC_CTX *mem_ctx, struct epm_floor *epm_floor);
 117 char *dcerpc_floor_get_rhs_data(TALLOC_CTX *mem_ctx, struct epm_floor *epm_floor);
 118 enum dcerpc_transport_t dcerpc_transport_by_endpoint_protocol(int prot);
 119 struct dcerpc_binding *dcerpc_binding_dup(TALLOC_CTX *mem_ctx,
 120                                           const struct dcerpc_binding *b);
 121 NTSTATUS dcerpc_binding_build_tower(TALLOC_CTX *mem_ctx,
 122                                     const struct dcerpc_binding *binding,
 123                                     struct epm_tower *tower);
 124 NTSTATUS dcerpc_binding_from_tower(TALLOC_CTX *mem_ctx,
 125                                    struct epm_tower *tower,
 126                                    struct dcerpc_binding **b_out);
 127 NTSTATUS dcerpc_parse_binding(TALLOC_CTX *mem_ctx, const char *s, struct dcerpc_binding **b_out);
 128 char *dcerpc_binding_string(TALLOC_CTX *mem_ctx, const struct dcerpc_binding *b);
 129 struct GUID dcerpc_binding_get_object(const struct dcerpc_binding *b);
 130 NTSTATUS dcerpc_binding_set_object(struct dcerpc_binding *b,
 131                                    struct GUID object);
 132 enum dcerpc_transport_t dcerpc_binding_get_transport(const struct dcerpc_binding *b);
 133 NTSTATUS dcerpc_binding_set_transport(struct dcerpc_binding *b,
 134                                       enum dcerpc_transport_t transport);
 135 void dcerpc_binding_get_auth_info(const struct dcerpc_binding *b,
 136                                   enum dcerpc_AuthType *_auth_type,
 137                                   enum dcerpc_AuthLevel *_auth_level);
 138 uint32_t dcerpc_binding_get_assoc_group_id(const struct dcerpc_binding *b);
 139 NTSTATUS dcerpc_binding_set_assoc_group_id(struct dcerpc_binding *b,
 140                                            uint32_t assoc_group_id);
 141 struct ndr_syntax_id dcerpc_binding_get_abstract_syntax(const struct dcerpc_binding *b);
 142 NTSTATUS dcerpc_binding_set_abstract_syntax(struct dcerpc_binding *b,
 143                                             const struct ndr_syntax_id *syntax);
 144 const char *dcerpc_binding_get_string_option(const struct dcerpc_binding *b,
 145                                              const char *name);
 146 char *dcerpc_binding_copy_string_option(TALLOC_CTX *mem_ctx,
 147                                         const struct dcerpc_binding *b,
 148                                         const char *name);
 149 NTSTATUS dcerpc_binding_set_string_option(struct dcerpc_binding *b,
 150                                           const char *name,
 151                                           const char *value);
 152 uint32_t dcerpc_binding_get_flags(const struct dcerpc_binding *b);
 153 NTSTATUS dcerpc_binding_set_flags(struct dcerpc_binding *b,
 154                                   uint32_t additional,
 155                                   uint32_t clear);
 156 NTSTATUS dcerpc_floor_get_lhs_data(const struct epm_floor *epm_floor, struct ndr_syntax_id *syntax);
 157 const char *derpc_transport_string_by_transport(enum dcerpc_transport_t t);
 158 enum dcerpc_transport_t dcerpc_transport_by_name(const char *name);
 159 enum dcerpc_transport_t dcerpc_transport_by_tower(const struct epm_tower *tower);
 160
 161 /* The following definitions come from ../librpc/rpc/dcerpc_util.c  */
 162
 163 void dcerpc_set_frag_length(DATA_BLOB *blob, uint16_t v);
 164 uint16_t dcerpc_get_frag_length(const DATA_BLOB *blob);
 165 void dcerpc_set_auth_length(DATA_BLOB *blob, uint16_t v);
 166 uint8_t dcerpc_get_endian_flag(DATA_BLOB *blob);
 167 const char *dcerpc_default_transport_endpoint(TALLOC_CTX *mem_ctx,
 168                                               enum dcerpc_transport_t transport,
 169                                               const struct ndr_interface_table *table);
 170
 171 /**
 172 * @brief        Pull a dcerpc_auth structure, taking account of any auth
 173 *               padding in the blob. For request/response packets we pass
 174 *               the whole data blob, so auth_data_only must be set to false
 175 *               as the blob contains data+pad+auth and no just pad+auth.
 176 *
 177 * @param pkt            - The ncacn_packet strcuture
 178 * @param mem_ctx        - The mem_ctx used to allocate dcerpc_auth elements
 179 * @param pkt_trailer    - The packet trailer data, usually the trailing
 180 *                         auth_info blob, but in the request/response case
 181 *                         this is the stub_and_verifier blob.
 182 * @param auth           - A preallocated dcerpc_auth *empty* structure
 183 * @param auth_length    - The length of the auth trail, sum of auth header
 184 *                         lenght and pkt->auth_length
 185 * @param auth_data_only - Whether the pkt_trailer includes only the auth_blob
 186 *                         (+ padding) or also other data.
 187 *
 188 * @return               - A NTSTATUS error code.
 189 */
 190 NTSTATUS dcerpc_pull_auth_trailer(const struct ncacn_packet *pkt,
 191                                   TALLOC_CTX *mem_ctx,
 192                                   const DATA_BLOB *pkt_trailer,
 193                                   struct dcerpc_auth *auth,
 194                                   uint32_t *auth_length,
 195                                   bool auth_data_only);
 196 NTSTATUS dcerpc_verify_ncacn_packet_header(const struct ncacn_packet *pkt,
 197                                            enum dcerpc_pkt_type ptype,
 198                                            size_t max_auth_info,
 199                                            uint8_t required_flags,
 200                                            uint8_t optional_flags);
 201 struct tevent_req *dcerpc_read_ncacn_packet_send(TALLOC_CTX *mem_ctx,
 202                                                  struct tevent_context *ev,
 203                                                  struct tstream_context *stream);
 204 NTSTATUS dcerpc_read_ncacn_packet_recv(struct tevent_req *req,
 205                                        TALLOC_CTX *mem_ctx,
 206                                        struct ncacn_packet **pkt,
 207                                        DATA_BLOB *buffer);
 208
 209 /* The following definitions come from ../librpc/rpc/binding_handle.c  */
 210
 211 struct dcerpc_binding_handle_ops {
 212         const char *name;
 213
 214         bool (*is_connected)(struct dcerpc_binding_handle *h);
 215         uint32_t (*set_timeout)(struct dcerpc_binding_handle *h,
 216                                 uint32_t timeout);
 217
 218         void (*auth_info)(struct dcerpc_binding_handle *h,
 219                           enum dcerpc_AuthType *auth_type,
 220                           enum dcerpc_AuthLevel *auth_level);
 221
 222         struct tevent_req *(*raw_call_send)(TALLOC_CTX *mem_ctx,
 223                                             struct tevent_context *ev,
 224                                             struct dcerpc_binding_handle *h,
 225                                             const struct GUID *object,
 226                                             uint32_t opnum,
 227                                             uint32_t in_flags,
 228                                             const uint8_t *in_data,
 229                                             size_t in_length);
 230         NTSTATUS (*raw_call_recv)(struct tevent_req *req,
 231                                   TALLOC_CTX *mem_ctx,
 232                                   uint8_t **out_data,
 233                                   size_t *out_length,
 234                                   uint32_t *out_flags);
 235
 236         struct tevent_req *(*disconnect_send)(TALLOC_CTX *mem_ctx,
 237                                               struct tevent_context *ev,
 238                                               struct dcerpc_binding_handle *h);
 239         NTSTATUS (*disconnect_recv)(struct tevent_req *req);
 240
 241         /* TODO: remove the following functions */
 242         bool (*push_bigendian)(struct dcerpc_binding_handle *h);
 243         bool (*ref_alloc)(struct dcerpc_binding_handle *h);
 244         bool (*use_ndr64)(struct dcerpc_binding_handle *h);
 245         void (*do_ndr_print)(struct dcerpc_binding_handle *h,
 246                              int ndr_flags,
 247                              const void *struct_ptr,
 248                              const struct ndr_interface_call *call);
 249         void (*ndr_push_failed)(struct dcerpc_binding_handle *h,
 250                                 NTSTATUS error,
 251                                 const void *struct_ptr,
 252                                 const struct ndr_interface_call *call);
 253         void (*ndr_pull_failed)(struct dcerpc_binding_handle *h,
 254                                 NTSTATUS error,
 255                                 const DATA_BLOB *blob,
 256                                 const struct ndr_interface_call *call);
 257         NTSTATUS (*ndr_validate_in)(struct dcerpc_binding_handle *h,
 258                                     TALLOC_CTX *mem_ctx,
 259                                     const DATA_BLOB *blob,
 260                                     const struct ndr_interface_call *call);
 261         NTSTATUS (*ndr_validate_out)(struct dcerpc_binding_handle *h,
 262                                      struct ndr_pull *pull_in,
 263                                      const void *struct_ptr,
 264                                      const struct ndr_interface_call *call);
 265 };
 266
 267 struct dcerpc_binding_handle *_dcerpc_binding_handle_create(TALLOC_CTX *mem_ctx,
 268                                         const struct dcerpc_binding_handle_ops *ops,
 269                                         const struct GUID *object,
 270                                         const struct ndr_interface_table *table,
 271                                         void *pstate,
 272                                         size_t psize,
 273                                         const char *type,
 274                                         const char *location);
 275 #define dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
 276                                 state, type, location) \
 277         _dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
 278                                 state, sizeof(type), #type, location)
 279
 280 void *_dcerpc_binding_handle_data(struct dcerpc_binding_handle *h);
 281 #define dcerpc_binding_handle_data(_h, _type) \
 282         talloc_get_type_abort(_dcerpc_binding_handle_data(_h), _type)
 283
 284 _DEPRECATED_ void dcerpc_binding_handle_set_sync_ev(struct dcerpc_binding_handle *h,
 285                                                     struct tevent_context *ev);
 286
 287 bool dcerpc_binding_handle_is_connected(struct dcerpc_binding_handle *h);
 288
 289 uint32_t dcerpc_binding_handle_set_timeout(struct dcerpc_binding_handle *h,
 290                                            uint32_t timeout);
 291
 292 void dcerpc_binding_handle_auth_info(struct dcerpc_binding_handle *h,
 293                                      enum dcerpc_AuthType *auth_type,
 294                                      enum dcerpc_AuthLevel *auth_level);
 295
 296 struct tevent_req *dcerpc_binding_handle_raw_call_send(TALLOC_CTX *mem_ctx,
 297                                                 struct tevent_context *ev,
 298                                                 struct dcerpc_binding_handle *h,
 299                                                 const struct GUID *object,
 300                                                 uint32_t opnum,
 301                                                 uint32_t in_flags,
 302                                                 const uint8_t *in_data,
 303                                                 size_t in_length);
 304 NTSTATUS dcerpc_binding_handle_raw_call_recv(struct tevent_req *req,
 305                                              TALLOC_CTX *mem_ctx,
 306                                              uint8_t **out_data,
 307                                              size_t *out_length,
 308                                              uint32_t *out_flags);
 309 NTSTATUS dcerpc_binding_handle_raw_call(struct dcerpc_binding_handle *h,
 310                                         const struct GUID *object,
 311                                         uint32_t opnum,
 312                                         uint32_t in_flags,
 313                                         const uint8_t *in_data,
 314                                         size_t in_length,
 315                                         TALLOC_CTX *mem_ctx,
 316                                         uint8_t **out_data,
 317                                         size_t *out_length,
 318                                         uint32_t *out_flags);
 319
 320 struct tevent_req *dcerpc_binding_handle_disconnect_send(TALLOC_CTX *mem_ctx,
 321                                                 struct tevent_context *ev,
 322                                                 struct dcerpc_binding_handle *h);
 323 NTSTATUS dcerpc_binding_handle_disconnect_recv(struct tevent_req *req);
 324
 325 struct tevent_req *dcerpc_binding_handle_call_send(TALLOC_CTX *mem_ctx,
 326                                         struct tevent_context *ev,
 327                                         struct dcerpc_binding_handle *h,
 328                                         const struct GUID *object,
 329                                         const struct ndr_interface_table *table,
 330                                         uint32_t opnum,
 331                                         TALLOC_CTX *r_mem,
 332                                         void *r_ptr);
 333 NTSTATUS dcerpc_binding_handle_call_recv(struct tevent_req *req);
 334 NTSTATUS dcerpc_binding_handle_call(struct dcerpc_binding_handle *h,
 335                                     const struct GUID *object,
 336                                     const struct ndr_interface_table *table,
 337                                     uint32_t opnum,
 338                                     TALLOC_CTX *r_mem,
 339                                     void *r_ptr);
 340
 341 /**
 342  * Extract header information from a ncacn_packet
 343  * as a dcerpc_sec_vt_header2 as used by the security verification trailer.
 344  *
 345  * @param[in] pkt a packet
 346  *
 347  * @return a dcerpc_sec_vt_header2
 348  */
 349 struct dcerpc_sec_vt_header2 dcerpc_sec_vt_header2_from_ncacn_packet(const struct ncacn_packet *pkt);
 350
 351
 352 /**
 353  * Test if two dcerpc_sec_vt_header2 structures are equal
 354  * without consideration of reserved fields.
 355  *
 356  * @param v1 a pointer to a dcerpc_sec_vt_header2 structure
 357  * @param v2 a pointer to a dcerpc_sec_vt_header2 structure
 358  *
 359  * @retval true if *v1 equals *v2
 360  */
 361 bool dcerpc_sec_vt_header2_equal(const struct dcerpc_sec_vt_header2 *v1,
 362                                  const struct dcerpc_sec_vt_header2 *v2);
 363
 364 /**
 365  * Check for consistency of the security verification trailer with the PDU header.
 366  * See <a href="http://msdn.microsoft.com/en-us/library/cc243559.aspx">MS-RPCE 2.2.2.13</a>.
 367  * A check with an empty trailer succeeds.
 368  *
 369  * @param[in] vt a pointer to the security verification trailer.
 370  * @param[in] bitmask1 which flags were negotiated on the connection.
 371  * @param[in] pcontext the syntaxes negotiatied for the presentation context.
 372  * @param[in] header2 some fields from the PDU header.
 373  *
 374  * @retval true on success.
 375  */
 376 bool dcerpc_sec_verification_trailer_check(
 377                 const struct dcerpc_sec_verification_trailer *vt,
 378                 const uint32_t *bitmask1,
 379                 const struct dcerpc_sec_vt_pcontext *pcontext,
 380                 const struct dcerpc_sec_vt_header2 *header2);
 381
 382 /**
 383  * @brief check and optionally extract the Bind Time Features from
 384  * the given ndr_syntax_id.
 385  *
 386  * <a href="http://msdn.microsoft.com/en-us/library/cc243715.aspx">MS-RPCE 3.3.1.5.3 Bind Time Feature Negotiation</a>.
 387  *
 388  * @param[in]  s the syntax that should be checked.
 389  *
 390  * @param[out] features This is optional, it will be filled with the extracted
 391  *                      features the on success, otherwise it's filled with 0.
 392  *
 393  * @return true if the syntax matches the 6CB71C2C-9812-4540 prefix with version 1, false otherwise.
 394  *
 395  * @see dcerpc_construct_bind_time_features
 396  */
 397 bool dcerpc_extract_bind_time_features(struct ndr_syntax_id syntax, uint64_t *features);
 398
 399 /**
 400  * @brief Construct a ndr_syntax_id used for Bind Time Features Negotiation.
 401  *
 402  * <a href="http://msdn.microsoft.com/en-us/library/cc243715.aspx">MS-RPCE 3.3.1.5.3 Bind Time Feature Negotiation</a>.
 403  *
 404  * @param[in] features The supported features.
 405  *
 406  * @return The ndr_syntax_id with the given features.
 407  *
 408  * @see dcerpc_extract_bind_time_features
 409  */
 410 struct ndr_syntax_id dcerpc_construct_bind_time_features(uint64_t features);
 411
 412 #define DCERPC_AUTH_PAD_LENGTH(stub_length) (\
 413         (((stub_length) % DCERPC_AUTH_PAD_ALIGNMENT) > 0)?\
 414         (DCERPC_AUTH_PAD_ALIGNMENT - (stub_length) % DCERPC_AUTH_PAD_ALIGNMENT):\
 415         0)
 416
 417 #endif /* __DEFAULT_LIBRPC_RPCCOMMON_H__ */