source4/librpc/rpc/dcerpc.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    DCERPC client side interface structures
   5
   6    Copyright (C) Tim Potter 2003
   7    Copyright (C) Andrew Tridgell 2003-2005
   8
   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.
  13
  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.
  18
  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/>.
  21 */
  22
  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. */
  26
  27 #ifndef __DCERPC_H__
  28 #define __DCERPC_H__
  29
  30 #include "../lib/util/data_blob.h"
  31 #include "librpc/gen_ndr/dcerpc.h"
  32 #include "../librpc/ndr/libndr.h"
  33
  34 struct tevent_context;
  35 struct tevent_req;
  36 struct dcerpc_binding_handle;
  37 struct tstream_context;
  38
  39 enum dcerpc_transport_t {
  40         NCA_UNKNOWN, NCACN_NP, NCACN_IP_TCP, NCACN_IP_UDP, NCACN_VNS_IPC,
  41         NCACN_VNS_SPP, NCACN_AT_DSP, NCADG_AT_DDP, NCALRPC, NCACN_UNIX_STREAM,
  42         NCADG_UNIX_DGRAM, NCACN_HTTP, NCADG_IPX, NCACN_SPX, NCACN_INTERNAL };
  43
  44 /*
  45   this defines a generic security context for signed/sealed dcerpc pipes.
  46 */
  47 struct dcerpc_connection;
  48 struct gensec_settings;
  49 struct dcerpc_security {
  50         struct dcerpc_auth *auth_info;
  51         struct gensec_security *generic_state;
  52
  53         /* get the session key */
  54         NTSTATUS (*session_key)(struct dcerpc_connection *, DATA_BLOB *);
  55 };
  56
  57 /*
  58   this holds the information that is not specific to a particular rpc context_id
  59 */
  60 struct dcerpc_connection {
  61         uint32_t call_id;
  62         uint32_t srv_max_xmit_frag;
  63         uint32_t srv_max_recv_frag;
  64         uint32_t flags;
  65         struct dcerpc_security security_state;
  66         const char *binding_string;
  67         struct tevent_context *event_ctx;
  68
  69         /** Directory in which to save ndrdump-parseable files */
  70         const char *packet_log_dir;
  71
  72         bool dead;
  73         bool free_skipped;
  74
  75         struct dcerpc_transport {
  76                 enum dcerpc_transport_t transport;
  77                 void *private_data;
  78
  79                 NTSTATUS (*shutdown_pipe)(struct dcerpc_connection *, NTSTATUS status);
  80
  81                 const char *(*peer_name)(struct dcerpc_connection *);
  82
  83                 const char *(*target_hostname)(struct dcerpc_connection *);
  84
  85                 /* send a request to the server */
  86                 NTSTATUS (*send_request)(struct dcerpc_connection *, DATA_BLOB *, bool trigger_read);
  87
  88                 /* send a read request to the server */
  89                 NTSTATUS (*send_read)(struct dcerpc_connection *);
  90
  91                 /* a callback to the dcerpc code when a full fragment
  92                    has been received */
  93                 void (*recv_data)(struct dcerpc_connection *, DATA_BLOB *, NTSTATUS status);
  94         } transport;
  95
  96         /* Requests that have been sent, waiting for a reply */
  97         struct rpc_request *pending;
  98
  99         /* Sync requests waiting to be shipped */
 100         struct rpc_request *request_queue;
 101
 102         /* the next context_id to be assigned */
 103         uint32_t next_context_id;
 104 };
 105
 106 /*
 107   this encapsulates a full dcerpc client side pipe
 108 */
 109 struct dcerpc_pipe {
 110         struct dcerpc_binding_handle *binding_handle;
 111
 112         uint32_t context_id;
 113
 114         uint32_t assoc_group_id;
 115
 116         struct ndr_syntax_id syntax;
 117         struct ndr_syntax_id transfer_syntax;
 118
 119         struct dcerpc_connection *conn;
 120         struct dcerpc_binding *binding;
 121
 122         /** the last fault code from a DCERPC fault */
 123         uint32_t last_fault_code;
 124
 125         /** timeout for individual rpc requests, in seconds */
 126         uint32_t request_timeout;
 127 };
 128
 129 /* default timeout for all rpc requests, in seconds */
 130 #define DCERPC_REQUEST_TIMEOUT 60
 131
 132
 133 /* dcerpc pipe flags */
 134 #define DCERPC_DEBUG_PRINT_IN          (1<<0)
 135 #define DCERPC_DEBUG_PRINT_OUT         (1<<1)
 136 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
 137
 138 #define DCERPC_DEBUG_VALIDATE_IN       (1<<2)
 139 #define DCERPC_DEBUG_VALIDATE_OUT      (1<<3)
 140 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
 141
 142 #define DCERPC_CONNECT                 (1<<4)
 143 #define DCERPC_SIGN                    (1<<5)
 144 #define DCERPC_SEAL                    (1<<6)
 145
 146 #define DCERPC_PUSH_BIGENDIAN          (1<<7)
 147 #define DCERPC_PULL_BIGENDIAN          (1<<8)
 148
 149 #define DCERPC_SCHANNEL                (1<<9)
 150
 151 #define DCERPC_ANON_FALLBACK           (1<<10)
 152
 153 /* use a 128 bit session key */
 154 #define DCERPC_SCHANNEL_128            (1<<12)
 155
 156 /* check incoming pad bytes */
 157 #define DCERPC_DEBUG_PAD_CHECK         (1<<13)
 158
 159 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
 160 #define DCERPC_NDR_REF_ALLOC           (1<<14)
 161
 162 #define DCERPC_AUTH_OPTIONS    (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5|DCERPC_AUTH_NTLM)
 163
 164 /* select spnego auth */
 165 #define DCERPC_AUTH_SPNEGO             (1<<15)
 166
 167 /* select krb5 auth */
 168 #define DCERPC_AUTH_KRB5               (1<<16)
 169
 170 #define DCERPC_SMB2                    (1<<17)
 171
 172 /* select NTLM auth */
 173 #define DCERPC_AUTH_NTLM               (1<<18)
 174
 175 /* this triggers the DCERPC_PFC_FLAG_CONC_MPX flag in the bind request */
 176 #define DCERPC_CONCURRENT_MULTIPLEX     (1<<19)
 177
 178 /* this triggers the DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag in the bind request */
 179 #define DCERPC_HEADER_SIGNING          (1<<20)
 180
 181 /* use NDR64 transport */
 182 #define DCERPC_NDR64                   (1<<21)
 183
 184 /* specify binding interface */
 185 #define DCERPC_LOCALADDRESS            (1<<22)
 186
 187 /* this describes a binding to a particular transport/pipe */
 188 struct dcerpc_binding {
 189         enum dcerpc_transport_t transport;
 190         struct ndr_syntax_id object;
 191         const char *host;
 192         const char *target_hostname;
 193         const char *endpoint;
 194         const char **options;
 195         const char *localaddress;
 196         uint32_t flags;
 197         uint32_t assoc_group_id;
 198 };
 199
 200
 201 struct dcerpc_pipe_connect {
 202         struct dcerpc_pipe *pipe;
 203         struct dcerpc_binding *binding;
 204         const char *pipe_name;
 205         const struct ndr_interface_table *interface;
 206         struct cli_credentials *creds;
 207         struct resolve_context *resolve_ctx;
 208 };
 209
 210
 211 enum rpc_request_state {
 212         RPC_REQUEST_QUEUED,
 213         RPC_REQUEST_PENDING,
 214         RPC_REQUEST_DONE
 215 };
 216
 217 /*
 218   handle for an async dcerpc request
 219 */
 220 struct rpc_request {
 221         struct rpc_request *next, *prev;
 222         struct dcerpc_pipe *p;
 223         NTSTATUS status;
 224         uint32_t call_id;
 225         enum rpc_request_state state;
 226         DATA_BLOB payload;
 227         uint32_t flags;
 228         uint32_t fault_code;
 229
 230         /* this is used to distinguish bind and alter_context requests
 231            from normal requests */
 232         void (*recv_handler)(struct rpc_request *conn,
 233                              DATA_BLOB *blob, struct ncacn_packet *pkt);
 234
 235         const struct GUID *object;
 236         uint16_t opnum;
 237         DATA_BLOB request_data;
 238         bool ignore_timeout;
 239
 240         /* use by the ndr level async recv call */
 241         struct {
 242                 const struct ndr_interface_table *table;
 243                 uint32_t opnum;
 244                 void *struct_ptr;
 245                 TALLOC_CTX *mem_ctx;
 246         } ndr;
 247
 248         struct {
 249                 void (*callback)(struct rpc_request *);
 250                 void *private_data;
 251         } async;
 252 };
 253
 254 struct epm_tower;
 255 struct epm_floor;
 256
 257 struct smbcli_tree;
 258 struct smb2_tree;
 259 struct socket_address;
 260
 261 NTSTATUS dcerpc_pipe_connect(TALLOC_CTX *parent_ctx,
 262                              struct dcerpc_pipe **pp,
 263                              const char *binding,
 264                              const struct ndr_interface_table *table,
 265                              struct cli_credentials *credentials,
 266                              struct tevent_context *ev,
 267                              struct loadparm_context *lp_ctx);
 268 NTSTATUS dcerpc_ndr_request_recv(struct rpc_request *req);
 269 struct rpc_request *dcerpc_ndr_request_send(struct dcerpc_pipe *p,
 270                                                 const struct GUID *object,
 271                                                 const struct ndr_interface_table *table,
 272                                                 uint32_t opnum,
 273                                                 bool async,
 274                                                 TALLOC_CTX *mem_ctx,
 275                                                 void *r);
 276 const char *dcerpc_server_name(struct dcerpc_pipe *p);
 277 struct dcerpc_pipe *dcerpc_pipe_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev);
 278 NTSTATUS dcerpc_pipe_open_smb(struct dcerpc_pipe *p,
 279                               struct smbcli_tree *tree,
 280                               const char *pipe_name);
 281 NTSTATUS dcerpc_bind_auth_none(struct dcerpc_pipe *p,
 282                                const struct ndr_interface_table *table);
 283 NTSTATUS dcerpc_fetch_session_key(struct dcerpc_pipe *p,
 284                                   DATA_BLOB *session_key);
 285 struct composite_context;
 286 NTSTATUS dcerpc_secondary_connection_recv(struct composite_context *c,
 287                                           struct dcerpc_pipe **p2);
 288 NTSTATUS dcerpc_parse_binding(TALLOC_CTX *mem_ctx, const char *s, struct dcerpc_binding **b_out);
 289
 290 struct composite_context* dcerpc_pipe_connect_b_send(TALLOC_CTX *parent_ctx,
 291                                                      struct dcerpc_binding *binding,
 292                                                      const struct ndr_interface_table *table,
 293                                                      struct cli_credentials *credentials,
 294                                                      struct tevent_context *ev,
 295                                                      struct loadparm_context *lp_ctx);
 296
 297 NTSTATUS dcerpc_pipe_connect_b_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
 298                                     struct dcerpc_pipe **p);
 299
 300 NTSTATUS dcerpc_pipe_connect_b(TALLOC_CTX *parent_ctx,
 301                                struct dcerpc_pipe **pp,
 302                                struct dcerpc_binding *binding,
 303                                const struct ndr_interface_table *table,
 304                                struct cli_credentials *credentials,
 305                                struct tevent_context *ev,
 306                                struct loadparm_context *lp_ctx);
 307 const char *dcerpc_errstr(TALLOC_CTX *mem_ctx, uint32_t fault_code);
 308 NTSTATUS dcerpc_fault_to_nt_status(uint32_t fault_code);
 309
 310 NTSTATUS dcerpc_pipe_auth(TALLOC_CTX *mem_ctx,
 311                           struct dcerpc_pipe **p,
 312                           struct dcerpc_binding *binding,
 313                           const struct ndr_interface_table *table,
 314                           struct cli_credentials *credentials,
 315                           struct loadparm_context *lp_ctx);
 316 char *dcerpc_binding_string(TALLOC_CTX *mem_ctx, const struct dcerpc_binding *b);
 317 NTSTATUS dcerpc_secondary_connection(struct dcerpc_pipe *p,
 318                                      struct dcerpc_pipe **p2,
 319                                      struct dcerpc_binding *b);
 320 NTSTATUS dcerpc_bind_auth_schannel(TALLOC_CTX *tmp_ctx,
 321                                    struct dcerpc_pipe *p,
 322                                    const struct ndr_interface_table *table,
 323                                    struct cli_credentials *credentials,
 324                                    struct loadparm_context *lp_ctx,
 325                                    uint8_t auth_level);
 326 struct tevent_context *dcerpc_event_context(struct dcerpc_pipe *p);
 327 NTSTATUS dcerpc_init(struct loadparm_context *lp_ctx);
 328 struct smbcli_tree *dcerpc_smb_tree(struct dcerpc_connection *c);
 329 uint16_t dcerpc_smb_fnum(struct dcerpc_connection *c);
 330 NTSTATUS dcerpc_secondary_context(struct dcerpc_pipe *p,
 331                                   struct dcerpc_pipe **pp2,
 332                                   const struct ndr_interface_table *table);
 333 NTSTATUS dcerpc_alter_context(struct dcerpc_pipe *p,
 334                               TALLOC_CTX *mem_ctx,
 335                               const struct ndr_syntax_id *syntax,
 336                               const struct ndr_syntax_id *transfer_syntax);
 337
 338 NTSTATUS dcerpc_bind_auth(struct dcerpc_pipe *p,
 339                           const struct ndr_interface_table *table,
 340                           struct cli_credentials *credentials,
 341                           struct gensec_settings *gensec_settings,
 342                           uint8_t auth_type, uint8_t auth_level,
 343                           const char *service);
 344 struct composite_context* dcerpc_pipe_connect_send(TALLOC_CTX *parent_ctx,
 345                                                    const char *binding,
 346                                                    const struct ndr_interface_table *table,
 347                                                    struct cli_credentials *credentials,
 348                                                    struct tevent_context *ev, struct loadparm_context *lp_ctx);
 349 NTSTATUS dcerpc_pipe_connect_recv(struct composite_context *c,
 350                                   TALLOC_CTX *mem_ctx,
 351                                   struct dcerpc_pipe **pp);
 352
 353 NTSTATUS dcerpc_epm_map_binding(TALLOC_CTX *mem_ctx, struct dcerpc_binding *binding,
 354                                 const struct ndr_interface_table *table, struct tevent_context *ev,
 355                                 struct loadparm_context *lp_ctx);
 356 struct composite_context* dcerpc_secondary_auth_connection_send(struct dcerpc_pipe *p,
 357                                                                 struct dcerpc_binding *binding,
 358                                                                 const struct ndr_interface_table *table,
 359                                                                 struct cli_credentials *credentials,
 360                                                                 struct loadparm_context *lp_ctx);
 361 NTSTATUS dcerpc_secondary_auth_connection_recv(struct composite_context *c,
 362                                                TALLOC_CTX *mem_ctx,
 363                                                struct dcerpc_pipe **p);
 364
 365 struct composite_context* dcerpc_secondary_connection_send(struct dcerpc_pipe *p,
 366                                                            struct dcerpc_binding *b);
 367 void dcerpc_log_packet(const char *lockdir,
 368                        const struct ndr_interface_table *ndr,
 369                        uint32_t opnum, uint32_t flags,
 370                        const DATA_BLOB *pkt);
 371 NTSTATUS dcerpc_binding_build_tower(TALLOC_CTX *mem_ctx,
 372                                     const struct dcerpc_binding *binding,
 373                                     struct epm_tower *tower);
 374
 375 NTSTATUS dcerpc_floor_get_lhs_data(const struct epm_floor *epm_floor, struct ndr_syntax_id *syntax);
 376
 377 enum dcerpc_transport_t dcerpc_transport_by_tower(const struct epm_tower *tower);
 378 const char *derpc_transport_string_by_transport(enum dcerpc_transport_t t);
 379
 380 NTSTATUS dcerpc_ndr_request(struct dcerpc_pipe *p,
 381                             const struct GUID *object,
 382                             const struct ndr_interface_table *table,
 383                             uint32_t opnum,
 384                             TALLOC_CTX *mem_ctx,
 385                             void *r);
 386
 387 NTSTATUS dcerpc_binding_from_tower(TALLOC_CTX *mem_ctx,
 388                                    struct epm_tower *tower,
 389                                    struct dcerpc_binding **b_out);
 390
 391 NTSTATUS dcerpc_request(struct dcerpc_pipe *p,
 392                         struct GUID *object,
 393                         uint16_t opnum,
 394                         TALLOC_CTX *mem_ctx,
 395                         DATA_BLOB *stub_data_in,
 396                         DATA_BLOB *stub_data_out);
 397
 398 enum dcerpc_transport_t dcerpc_transport_by_endpoint_protocol(int prot);
 399
 400 const char *dcerpc_floor_get_rhs_data(TALLOC_CTX *mem_ctx, struct epm_floor *epm_floor);
 401
 402 struct tevent_req *dcerpc_read_ncacn_packet_send(TALLOC_CTX *mem_ctx,
 403                                                  struct tevent_context *ev,
 404                                                  struct tstream_context *stream);
 405 NTSTATUS dcerpc_read_ncacn_packet_recv(struct tevent_req *req,
 406                                        TALLOC_CTX *mem_ctx,
 407                                        struct ncacn_packet **pkt,
 408                                        DATA_BLOB *buffer);
 409
 410 struct dcerpc_binding_handle_ops {
 411         const char *name;
 412
 413         bool (*is_connected)(struct dcerpc_binding_handle *h);
 414         uint32_t (*set_timeout)(struct dcerpc_binding_handle *h,
 415                                 uint32_t timeout);
 416
 417         struct tevent_req *(*raw_call_send)(TALLOC_CTX *mem_ctx,
 418                                             struct tevent_context *ev,
 419                                             struct dcerpc_binding_handle *h,
 420                                             const struct GUID *object,
 421                                             uint32_t opnum,
 422                                             uint32_t in_flags,
 423                                             const uint8_t *in_data,
 424                                             size_t in_length);
 425         NTSTATUS (*raw_call_recv)(struct tevent_req *req,
 426                                   TALLOC_CTX *mem_ctx,
 427                                   uint8_t **out_data,
 428                                   size_t *out_length,
 429                                   uint32_t *out_flags);
 430
 431         struct tevent_req *(*disconnect_send)(TALLOC_CTX *mem_ctx,
 432                                               struct tevent_context *ev,
 433                                               struct dcerpc_binding_handle *h);
 434         NTSTATUS (*disconnect_recv)(struct tevent_req *req);
 435
 436         /* TODO: remove the following functions */
 437         bool (*push_bigendian)(struct dcerpc_binding_handle *h);
 438         bool (*ref_alloc)(struct dcerpc_binding_handle *h);
 439         bool (*use_ndr64)(struct dcerpc_binding_handle *h);
 440         void (*do_ndr_print)(struct dcerpc_binding_handle *h,
 441                              int ndr_flags,
 442                              const void *struct_ptr,
 443                              const struct ndr_interface_call *call);
 444         void (*ndr_push_failed)(struct dcerpc_binding_handle *h,
 445                                 NTSTATUS error,
 446                                 const void *struct_ptr,
 447                                 const struct ndr_interface_call *call);
 448         void (*ndr_pull_failed)(struct dcerpc_binding_handle *h,
 449                                 NTSTATUS error,
 450                                 const DATA_BLOB *blob,
 451                                 const struct ndr_interface_call *call);
 452         NTSTATUS (*ndr_validate_in)(struct dcerpc_binding_handle *h,
 453                                     TALLOC_CTX *mem_ctx,
 454                                     const DATA_BLOB *blob,
 455                                     const struct ndr_interface_call *call);
 456         NTSTATUS (*ndr_validate_out)(struct dcerpc_binding_handle *h,
 457                                      struct ndr_pull *pull_in,
 458                                      const void *struct_ptr,
 459                                      const struct ndr_interface_call *call);
 460 };
 461
 462 struct dcerpc_binding_handle *_dcerpc_binding_handle_create(TALLOC_CTX *mem_ctx,
 463                                         const struct dcerpc_binding_handle_ops *ops,
 464                                         const struct GUID *object,
 465                                         const struct ndr_interface_table *table,
 466                                         void *pstate,
 467                                         size_t psize,
 468                                         const char *type,
 469                                         const char *location);
 470 #define dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
 471                                 state, type, location) \
 472         _dcerpc_binding_handle_create(mem_ctx, ops, object, table, \
 473                                 state, sizeof(type), #type, location)
 474
 475 void *_dcerpc_binding_handle_data(struct dcerpc_binding_handle *h);
 476 #define dcerpc_binding_handle_data(_h, _type) \
 477         talloc_get_type_abort(_dcerpc_binding_handle_data(_h), _type)
 478
 479 _DEPRECATED_ void dcerpc_binding_handle_set_sync_ev(struct dcerpc_binding_handle *h,
 480                                                     struct tevent_context *ev);
 481
 482 bool dcerpc_binding_handle_is_connected(struct dcerpc_binding_handle *h);
 483
 484 uint32_t dcerpc_binding_handle_set_timeout(struct dcerpc_binding_handle *h,
 485                                            uint32_t timeout);
 486
 487 struct tevent_req *dcerpc_binding_handle_raw_call_send(TALLOC_CTX *mem_ctx,
 488                                                 struct tevent_context *ev,
 489                                                 struct dcerpc_binding_handle *h,
 490                                                 const struct GUID *object,
 491                                                 uint32_t opnum,
 492                                                 uint32_t in_flags,
 493                                                 const uint8_t *in_data,
 494                                                 size_t in_length);
 495 NTSTATUS dcerpc_binding_handle_raw_call_recv(struct tevent_req *req,
 496                                              TALLOC_CTX *mem_ctx,
 497                                              uint8_t **out_data,
 498                                              size_t *out_length,
 499                                              uint32_t *out_flags);
 500
 501 struct tevent_req *dcerpc_binding_handle_disconnect_send(TALLOC_CTX *mem_ctx,
 502                                                 struct tevent_context *ev,
 503                                                 struct dcerpc_binding_handle *h);
 504 NTSTATUS dcerpc_binding_handle_disconnect_recv(struct tevent_req *req);
 505
 506 struct tevent_req *dcerpc_binding_handle_call_send(TALLOC_CTX *mem_ctx,
 507                                         struct tevent_context *ev,
 508                                         struct dcerpc_binding_handle *h,
 509                                         const struct GUID *object,
 510                                         const struct ndr_interface_table *table,
 511                                         uint32_t opnum,
 512                                         TALLOC_CTX *r_mem,
 513                                         void *r_ptr);
 514 NTSTATUS dcerpc_binding_handle_call_recv(struct tevent_req *req);
 515 NTSTATUS dcerpc_binding_handle_call(struct dcerpc_binding_handle *h,
 516                                     const struct GUID *object,
 517                                     const struct ndr_interface_table *table,
 518                                     uint32_t opnum,
 519                                     TALLOC_CTX *r_mem,
 520                                     void *r_ptr);
 521
 522 #endif /* __DCERPC_H__ */