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
  38 enum dcerpc_transport_t {
  39         NCA_UNKNOWN, NCACN_NP, NCACN_IP_TCP, NCACN_IP_UDP, NCACN_VNS_IPC,
  40         NCACN_VNS_SPP, NCACN_AT_DSP, NCADG_AT_DDP, NCALRPC, NCACN_UNIX_STREAM,
  41         NCADG_UNIX_DGRAM, NCACN_HTTP, NCADG_IPX, NCACN_SPX };
  42
  43 /*
  44   this defines a generic security context for signed/sealed dcerpc pipes.
  45 */
  46 struct dcerpc_connection;
  47 struct gensec_settings;
  48 struct dcerpc_security {
  49         struct dcerpc_auth *auth_info;
  50         struct gensec_security *generic_state;
  51
  52         /* get the session key */
  53         NTSTATUS (*session_key)(struct dcerpc_connection *, DATA_BLOB *);
  54 };
  55
  56 /*
  57   this holds the information that is not specific to a particular rpc context_id
  58 */
  59 struct dcerpc_connection {
  60         uint32_t call_id;
  61         uint32_t srv_max_xmit_frag;
  62         uint32_t srv_max_recv_frag;
  63         uint32_t flags;
  64         struct dcerpc_security security_state;
  65         const char *binding_string;
  66         struct tevent_context *event_ctx;
  67         struct smb_iconv_convenience *iconv_convenience;
  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         uint32_t context_id;
 111
 112         uint32_t assoc_group_id;
 113
 114         struct ndr_syntax_id syntax;
 115         struct ndr_syntax_id transfer_syntax;
 116
 117         struct dcerpc_connection *conn;
 118         struct dcerpc_binding *binding;
 119
 120         struct dcerpc_binding_handle *binding_handle;
 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 /* this describes a binding to a particular transport/pipe */
 185 struct dcerpc_binding {
 186         enum dcerpc_transport_t transport;
 187         struct ndr_syntax_id object;
 188         const char *host;
 189         const char *target_hostname;
 190         const char *endpoint;
 191         const char **options;
 192         uint32_t flags;
 193         uint32_t assoc_group_id;
 194 };
 195
 196
 197 struct dcerpc_pipe_connect {
 198         struct dcerpc_pipe *pipe;
 199         struct dcerpc_binding *binding;
 200         const char *pipe_name;
 201         const struct ndr_interface_table *interface;
 202         struct cli_credentials *creds;
 203         struct resolve_context *resolve_ctx;
 204 };
 205
 206
 207 enum rpc_request_state {
 208         RPC_REQUEST_QUEUED,
 209         RPC_REQUEST_PENDING,
 210         RPC_REQUEST_DONE
 211 };
 212
 213 /*
 214   handle for an async dcerpc request
 215 */
 216 struct rpc_request {
 217         struct rpc_request *next, *prev;
 218         struct dcerpc_pipe *p;
 219         NTSTATUS status;
 220         uint32_t call_id;
 221         enum rpc_request_state state;
 222         DATA_BLOB payload;
 223         uint32_t flags;
 224         uint32_t fault_code;
 225
 226         /* this is used to distinguish bind and alter_context requests
 227            from normal requests */
 228         void (*recv_handler)(struct rpc_request *conn,
 229                              DATA_BLOB *blob, struct ncacn_packet *pkt);
 230
 231         const struct GUID *object;
 232         uint16_t opnum;
 233         DATA_BLOB request_data;
 234         bool async_call;
 235         bool ignore_timeout;
 236
 237         /* use by the ndr level async recv call */
 238         struct {
 239                 const struct ndr_interface_table *table;
 240                 uint32_t opnum;
 241                 void *struct_ptr;
 242                 TALLOC_CTX *mem_ctx;
 243         } ndr;
 244
 245         struct {
 246                 void (*callback)(struct rpc_request *);
 247                 void *private_data;
 248         } async;
 249 };
 250
 251 struct epm_tower;
 252 struct epm_floor;
 253
 254 struct smbcli_tree;
 255 struct smb2_tree;
 256 struct socket_address;
 257
 258 NTSTATUS dcerpc_pipe_connect(TALLOC_CTX *parent_ctx,
 259                              struct dcerpc_pipe **pp,
 260                              const char *binding,
 261                              const struct ndr_interface_table *table,
 262                              struct cli_credentials *credentials,
 263                              struct tevent_context *ev,
 264                              struct loadparm_context *lp_ctx);
 265 NTSTATUS dcerpc_ndr_request_recv(struct rpc_request *req);
 266 struct rpc_request *dcerpc_ndr_request_send(struct dcerpc_pipe *p,
 267                                                 const struct GUID *object,
 268                                                 const struct ndr_interface_table *table,
 269                                                 uint32_t opnum,
 270                                                 bool async,
 271                                                 TALLOC_CTX *mem_ctx,
 272                                                 void *r);
 273 const char *dcerpc_server_name(struct dcerpc_pipe *p);
 274 struct dcerpc_pipe *dcerpc_pipe_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev,
 275                                      struct smb_iconv_convenience *ic);
 276 NTSTATUS dcerpc_pipe_open_smb(struct dcerpc_pipe *p,
 277                               struct smbcli_tree *tree,
 278                               const char *pipe_name);
 279 NTSTATUS dcerpc_bind_auth_none(struct dcerpc_pipe *p,
 280                                const struct ndr_interface_table *table);
 281 NTSTATUS dcerpc_fetch_session_key(struct dcerpc_pipe *p,
 282                                   DATA_BLOB *session_key);
 283 struct composite_context;
 284 NTSTATUS dcerpc_secondary_connection_recv(struct composite_context *c,
 285                                           struct dcerpc_pipe **p2);
 286 NTSTATUS dcerpc_parse_binding(TALLOC_CTX *mem_ctx, const char *s, struct dcerpc_binding **b_out);
 287
 288 struct composite_context* dcerpc_pipe_connect_b_send(TALLOC_CTX *parent_ctx,
 289                                                      struct dcerpc_binding *binding,
 290                                                      const struct ndr_interface_table *table,
 291                                                      struct cli_credentials *credentials,
 292                                                      struct tevent_context *ev,
 293                                                      struct loadparm_context *lp_ctx);
 294
 295 NTSTATUS dcerpc_pipe_connect_b_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
 296                                     struct dcerpc_pipe **p);
 297
 298 NTSTATUS dcerpc_pipe_connect_b(TALLOC_CTX *parent_ctx,
 299                                struct dcerpc_pipe **pp,
 300                                struct dcerpc_binding *binding,
 301                                const struct ndr_interface_table *table,
 302                                struct cli_credentials *credentials,
 303                                struct tevent_context *ev,
 304                                struct loadparm_context *lp_ctx);
 305 const char *dcerpc_errstr(TALLOC_CTX *mem_ctx, uint32_t fault_code);
 306
 307 NTSTATUS dcerpc_pipe_auth(TALLOC_CTX *mem_ctx,
 308                           struct dcerpc_pipe **p,
 309                           struct dcerpc_binding *binding,
 310                           const struct ndr_interface_table *table,
 311                           struct cli_credentials *credentials,
 312                           struct loadparm_context *lp_ctx);
 313 char *dcerpc_binding_string(TALLOC_CTX *mem_ctx, const struct dcerpc_binding *b);
 314 NTSTATUS dcerpc_secondary_connection(struct dcerpc_pipe *p,
 315                                      struct dcerpc_pipe **p2,
 316                                      struct dcerpc_binding *b);
 317 NTSTATUS dcerpc_bind_auth_schannel(TALLOC_CTX *tmp_ctx,
 318                                    struct dcerpc_pipe *p,
 319                                    const struct ndr_interface_table *table,
 320                                    struct cli_credentials *credentials,
 321                                    struct loadparm_context *lp_ctx,
 322                                    uint8_t auth_level);
 323 struct tevent_context *dcerpc_event_context(struct dcerpc_pipe *p);
 324 NTSTATUS dcerpc_init(struct loadparm_context *lp_ctx);
 325 struct smbcli_tree *dcerpc_smb_tree(struct dcerpc_connection *c);
 326 uint16_t dcerpc_smb_fnum(struct dcerpc_connection *c);
 327 NTSTATUS dcerpc_secondary_context(struct dcerpc_pipe *p,
 328                                   struct dcerpc_pipe **pp2,
 329                                   const struct ndr_interface_table *table);
 330 NTSTATUS dcerpc_alter_context(struct dcerpc_pipe *p,
 331                               TALLOC_CTX *mem_ctx,
 332                               const struct ndr_syntax_id *syntax,
 333                               const struct ndr_syntax_id *transfer_syntax);
 334
 335 NTSTATUS dcerpc_bind_auth(struct dcerpc_pipe *p,
 336                           const struct ndr_interface_table *table,
 337                           struct cli_credentials *credentials,
 338                           struct gensec_settings *gensec_settings,
 339                           uint8_t auth_type, uint8_t auth_level,
 340                           const char *service);
 341 struct composite_context* dcerpc_pipe_connect_send(TALLOC_CTX *parent_ctx,
 342                                                    const char *binding,
 343                                                    const struct ndr_interface_table *table,
 344                                                    struct cli_credentials *credentials,
 345                                                    struct tevent_context *ev, struct loadparm_context *lp_ctx);
 346 NTSTATUS dcerpc_pipe_connect_recv(struct composite_context *c,
 347                                   TALLOC_CTX *mem_ctx,
 348                                   struct dcerpc_pipe **pp);
 349
 350 NTSTATUS dcerpc_epm_map_binding(TALLOC_CTX *mem_ctx, struct dcerpc_binding *binding,
 351                                 const struct ndr_interface_table *table, struct tevent_context *ev,
 352                                 struct loadparm_context *lp_ctx);
 353 struct composite_context* dcerpc_secondary_auth_connection_send(struct dcerpc_pipe *p,
 354                                                                 struct dcerpc_binding *binding,
 355                                                                 const struct ndr_interface_table *table,
 356                                                                 struct cli_credentials *credentials,
 357                                                                 struct loadparm_context *lp_ctx);
 358 NTSTATUS dcerpc_secondary_auth_connection_recv(struct composite_context *c,
 359                                                TALLOC_CTX *mem_ctx,
 360                                                struct dcerpc_pipe **p);
 361
 362 struct composite_context* dcerpc_secondary_connection_send(struct dcerpc_pipe *p,
 363                                                            struct dcerpc_binding *b);
 364 void dcerpc_log_packet(const char *lockdir,
 365                                            const struct ndr_interface_table *ndr,
 366                                            uint32_t opnum, uint32_t flags,
 367                                            DATA_BLOB *pkt);
 368 NTSTATUS dcerpc_binding_build_tower(TALLOC_CTX *mem_ctx,
 369                                     const struct dcerpc_binding *binding,
 370                                     struct epm_tower *tower);
 371
 372 NTSTATUS dcerpc_floor_get_lhs_data(const struct epm_floor *epm_floor, struct ndr_syntax_id *syntax);
 373
 374 enum dcerpc_transport_t dcerpc_transport_by_tower(const struct epm_tower *tower);
 375 const char *derpc_transport_string_by_transport(enum dcerpc_transport_t t);
 376
 377 NTSTATUS dcerpc_ndr_request(struct dcerpc_pipe *p,
 378                             const struct GUID *object,
 379                             const struct ndr_interface_table *table,
 380                             uint32_t opnum,
 381                             TALLOC_CTX *mem_ctx,
 382                             void *r);
 383
 384 NTSTATUS dcerpc_binding_from_tower(TALLOC_CTX *mem_ctx,
 385                                    struct epm_tower *tower,
 386                                    struct dcerpc_binding **b_out);
 387
 388 NTSTATUS dcerpc_request(struct dcerpc_pipe *p,
 389                         struct GUID *object,
 390                         uint16_t opnum,
 391                         TALLOC_CTX *mem_ctx,
 392                         DATA_BLOB *stub_data_in,
 393                         DATA_BLOB *stub_data_out);
 394
 395 enum dcerpc_transport_t dcerpc_transport_by_endpoint_protocol(int prot);
 396
 397 const char *dcerpc_floor_get_rhs_data(TALLOC_CTX *mem_ctx, struct epm_floor *epm_floor);
 398
 399 /* TODO: this needs to be completely private */
 400 struct dcerpc_binding_handle {
 401         void *private_data;
 402 };
 403
 404 #endif /* __DCERPC_H__ */