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 __S4_DCERPC_H__
  28 #define __S4_DCERPC_H__
  29
  30 #include "../lib/util/data_blob.h"
  31 #include "librpc/gen_ndr/dcerpc.h"
  32 #include "../librpc/ndr/libndr.h"
  33 #include "../librpc/rpc/rpc_common.h"
  34
  35 struct tevent_context;
  36 struct tevent_req;
  37 struct dcerpc_binding_handle;
  38 struct tstream_context;
  39
  40 /*
  41   this defines a generic security context for signed/sealed dcerpc pipes.
  42 */
  43 struct dcecli_connection;
  44 struct gensec_settings;
  45 struct dcecli_security {
  46         struct dcerpc_auth *auth_info;
  47         struct gensec_security *generic_state;
  48
  49         /* get the session key */
  50         NTSTATUS (*session_key)(struct dcecli_connection *, DATA_BLOB *);
  51 };
  52
  53 /*
  54   this holds the information that is not specific to a particular rpc context_id
  55 */
  56 struct dcecli_connection {
  57         uint32_t call_id;
  58         uint32_t srv_max_xmit_frag;
  59         uint32_t srv_max_recv_frag;
  60         uint32_t flags;
  61         struct dcecli_security security_state;
  62         const char *binding_string;
  63         struct tevent_context *event_ctx;
  64
  65         /** Directory in which to save ndrdump-parseable files */
  66         const char *packet_log_dir;
  67
  68         bool dead;
  69         bool free_skipped;
  70
  71         struct dcerpc_transport {
  72                 enum dcerpc_transport_t transport;
  73                 void *private_data;
  74
  75                 NTSTATUS (*shutdown_pipe)(struct dcecli_connection *, NTSTATUS status);
  76
  77                 const char *(*peer_name)(struct dcecli_connection *);
  78
  79                 const char *(*target_hostname)(struct dcecli_connection *);
  80
  81                 /* send a request to the server */
  82                 NTSTATUS (*send_request)(struct dcecli_connection *, DATA_BLOB *, bool trigger_read);
  83
  84                 /* send a read request to the server */
  85                 NTSTATUS (*send_read)(struct dcecli_connection *);
  86
  87                 /* a callback to the dcerpc code when a full fragment
  88                    has been received */
  89                 void (*recv_data)(struct dcecli_connection *, DATA_BLOB *, NTSTATUS status);
  90         } transport;
  91
  92         /* Requests that have been sent, waiting for a reply */
  93         struct rpc_request *pending;
  94
  95         /* Sync requests waiting to be shipped */
  96         struct rpc_request *request_queue;
  97
  98         /* the next context_id to be assigned */
  99         uint32_t next_context_id;
 100 };
 101
 102 /*
 103   this encapsulates a full dcerpc client side pipe
 104 */
 105 struct dcerpc_pipe {
 106         struct dcerpc_binding_handle *binding_handle;
 107
 108         uint32_t context_id;
 109
 110         uint32_t assoc_group_id;
 111
 112         struct ndr_syntax_id syntax;
 113         struct ndr_syntax_id transfer_syntax;
 114
 115         struct dcecli_connection *conn;
 116         struct dcerpc_binding *binding;
 117
 118         /** the last fault code from a DCERPC fault */
 119         uint32_t last_fault_code;
 120
 121         /** timeout for individual rpc requests, in seconds */
 122         uint32_t request_timeout;
 123 };
 124
 125 /* default timeout for all rpc requests, in seconds */
 126 #define DCERPC_REQUEST_TIMEOUT 60
 127
 128
 129 /* dcerpc pipe flags */
 130 #define DCERPC_DEBUG_PRINT_IN          (1<<0)
 131 #define DCERPC_DEBUG_PRINT_OUT         (1<<1)
 132 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
 133
 134 #define DCERPC_DEBUG_VALIDATE_IN       (1<<2)
 135 #define DCERPC_DEBUG_VALIDATE_OUT      (1<<3)
 136 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
 137
 138 #define DCERPC_CONNECT                 (1<<4)
 139 #define DCERPC_SIGN                    (1<<5)
 140 #define DCERPC_SEAL                    (1<<6)
 141
 142 #define DCERPC_PUSH_BIGENDIAN          (1<<7)
 143 #define DCERPC_PULL_BIGENDIAN          (1<<8)
 144
 145 #define DCERPC_SCHANNEL                (1<<9)
 146
 147 #define DCERPC_ANON_FALLBACK           (1<<10)
 148
 149 /* use a 128 bit session key */
 150 #define DCERPC_SCHANNEL_128            (1<<12)
 151
 152 /* check incoming pad bytes */
 153 #define DCERPC_DEBUG_PAD_CHECK         (1<<13)
 154
 155 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
 156 #define DCERPC_NDR_REF_ALLOC           (1<<14)
 157
 158 #define DCERPC_AUTH_OPTIONS    (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5|DCERPC_AUTH_NTLM)
 159
 160 /* select spnego auth */
 161 #define DCERPC_AUTH_SPNEGO             (1<<15)
 162
 163 /* select krb5 auth */
 164 #define DCERPC_AUTH_KRB5               (1<<16)
 165
 166 #define DCERPC_SMB2                    (1<<17)
 167
 168 /* select NTLM auth */
 169 #define DCERPC_AUTH_NTLM               (1<<18)
 170
 171 /* this triggers the DCERPC_PFC_FLAG_CONC_MPX flag in the bind request */
 172 #define DCERPC_CONCURRENT_MULTIPLEX     (1<<19)
 173
 174 /* this triggers the DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag in the bind request */
 175 #define DCERPC_HEADER_SIGNING          (1<<20)
 176
 177 /* use NDR64 transport */
 178 #define DCERPC_NDR64                   (1<<21)
 179
 180 /* specify binding interface */
 181 #define DCERPC_LOCALADDRESS            (1<<22)
 182
 183 struct dcerpc_pipe_connect {
 184         struct dcerpc_pipe *pipe;
 185         struct dcerpc_binding *binding;
 186         const char *pipe_name;
 187         const struct ndr_interface_table *interface;
 188         struct cli_credentials *creds;
 189         struct resolve_context *resolve_ctx;
 190 };
 191
 192
 193 enum rpc_request_state {
 194         RPC_REQUEST_QUEUED,
 195         RPC_REQUEST_PENDING,
 196         RPC_REQUEST_DONE
 197 };
 198
 199 /*
 200   handle for an async dcerpc request
 201 */
 202 struct rpc_request {
 203         struct rpc_request *next, *prev;
 204         struct dcerpc_pipe *p;
 205         NTSTATUS status;
 206         uint32_t call_id;
 207         enum rpc_request_state state;
 208         DATA_BLOB payload;
 209         uint32_t flags;
 210         uint32_t fault_code;
 211
 212         /* this is used to distinguish bind and alter_context requests
 213            from normal requests */
 214         void (*recv_handler)(struct rpc_request *conn,
 215                              DATA_BLOB *blob, struct ncacn_packet *pkt);
 216
 217         const struct GUID *object;
 218         uint16_t opnum;
 219         DATA_BLOB request_data;
 220         bool ignore_timeout;
 221
 222         /* use by the ndr level async recv call */
 223         struct {
 224                 const struct ndr_interface_table *table;
 225                 uint32_t opnum;
 226                 void *struct_ptr;
 227                 TALLOC_CTX *mem_ctx;
 228         } ndr;
 229
 230         struct {
 231                 void (*callback)(struct rpc_request *);
 232                 void *private_data;
 233         } async;
 234 };
 235
 236 struct epm_tower;
 237 struct epm_floor;
 238
 239 struct smbcli_tree;
 240 struct smb2_tree;
 241 struct socket_address;
 242
 243 NTSTATUS dcerpc_pipe_connect(TALLOC_CTX *parent_ctx,
 244                              struct dcerpc_pipe **pp,
 245                              const char *binding,
 246                              const struct ndr_interface_table *table,
 247                              struct cli_credentials *credentials,
 248                              struct tevent_context *ev,
 249                              struct loadparm_context *lp_ctx);
 250 const char *dcerpc_server_name(struct dcerpc_pipe *p);
 251 struct dcerpc_pipe *dcerpc_pipe_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev);
 252 NTSTATUS dcerpc_pipe_open_smb(struct dcerpc_pipe *p,
 253                               struct smbcli_tree *tree,
 254                               const char *pipe_name);
 255 NTSTATUS dcerpc_bind_auth_none(struct dcerpc_pipe *p,
 256                                const struct ndr_interface_table *table);
 257 NTSTATUS dcerpc_fetch_session_key(struct dcerpc_pipe *p,
 258                                   DATA_BLOB *session_key);
 259 struct composite_context;
 260 NTSTATUS dcerpc_secondary_connection_recv(struct composite_context *c,
 261                                           struct dcerpc_pipe **p2);
 262 NTSTATUS dcerpc_parse_binding(TALLOC_CTX *mem_ctx, const char *s, struct dcerpc_binding **b_out);
 263
 264 struct composite_context* dcerpc_pipe_connect_b_send(TALLOC_CTX *parent_ctx,
 265                                                      struct dcerpc_binding *binding,
 266                                                      const struct ndr_interface_table *table,
 267                                                      struct cli_credentials *credentials,
 268                                                      struct tevent_context *ev,
 269                                                      struct loadparm_context *lp_ctx);
 270
 271 NTSTATUS dcerpc_pipe_connect_b_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
 272                                     struct dcerpc_pipe **p);
 273
 274 NTSTATUS dcerpc_pipe_connect_b(TALLOC_CTX *parent_ctx,
 275                                struct dcerpc_pipe **pp,
 276                                struct dcerpc_binding *binding,
 277                                const struct ndr_interface_table *table,
 278                                struct cli_credentials *credentials,
 279                                struct tevent_context *ev,
 280                                struct loadparm_context *lp_ctx);
 281
 282 NTSTATUS dcerpc_pipe_auth(TALLOC_CTX *mem_ctx,
 283                           struct dcerpc_pipe **p,
 284                           struct dcerpc_binding *binding,
 285                           const struct ndr_interface_table *table,
 286                           struct cli_credentials *credentials,
 287                           struct loadparm_context *lp_ctx);
 288 char *dcerpc_binding_string(TALLOC_CTX *mem_ctx, const struct dcerpc_binding *b);
 289 NTSTATUS dcerpc_secondary_connection(struct dcerpc_pipe *p,
 290                                      struct dcerpc_pipe **p2,
 291                                      struct dcerpc_binding *b);
 292 NTSTATUS dcerpc_bind_auth_schannel(TALLOC_CTX *tmp_ctx,
 293                                    struct dcerpc_pipe *p,
 294                                    const struct ndr_interface_table *table,
 295                                    struct cli_credentials *credentials,
 296                                    struct loadparm_context *lp_ctx,
 297                                    uint8_t auth_level);
 298 struct tevent_context *dcerpc_event_context(struct dcerpc_pipe *p);
 299 NTSTATUS dcerpc_init(struct loadparm_context *lp_ctx);
 300 struct smbcli_tree *dcerpc_smb_tree(struct dcecli_connection *c);
 301 uint16_t dcerpc_smb_fnum(struct dcecli_connection *c);
 302 NTSTATUS dcerpc_secondary_context(struct dcerpc_pipe *p,
 303                                   struct dcerpc_pipe **pp2,
 304                                   const struct ndr_interface_table *table);
 305 NTSTATUS dcerpc_alter_context(struct dcerpc_pipe *p,
 306                               TALLOC_CTX *mem_ctx,
 307                               const struct ndr_syntax_id *syntax,
 308                               const struct ndr_syntax_id *transfer_syntax);
 309
 310 NTSTATUS dcerpc_bind_auth(struct dcerpc_pipe *p,
 311                           const struct ndr_interface_table *table,
 312                           struct cli_credentials *credentials,
 313                           struct gensec_settings *gensec_settings,
 314                           uint8_t auth_type, uint8_t auth_level,
 315                           const char *service);
 316 struct composite_context* dcerpc_pipe_connect_send(TALLOC_CTX *parent_ctx,
 317                                                    const char *binding,
 318                                                    const struct ndr_interface_table *table,
 319                                                    struct cli_credentials *credentials,
 320                                                    struct tevent_context *ev, struct loadparm_context *lp_ctx);
 321 NTSTATUS dcerpc_pipe_connect_recv(struct composite_context *c,
 322                                   TALLOC_CTX *mem_ctx,
 323                                   struct dcerpc_pipe **pp);
 324
 325 NTSTATUS dcerpc_epm_map_binding(TALLOC_CTX *mem_ctx, struct dcerpc_binding *binding,
 326                                 const struct ndr_interface_table *table, struct tevent_context *ev,
 327                                 struct loadparm_context *lp_ctx);
 328 struct composite_context* dcerpc_secondary_auth_connection_send(struct dcerpc_pipe *p,
 329                                                                 struct dcerpc_binding *binding,
 330                                                                 const struct ndr_interface_table *table,
 331                                                                 struct cli_credentials *credentials,
 332                                                                 struct loadparm_context *lp_ctx);
 333 NTSTATUS dcerpc_secondary_auth_connection_recv(struct composite_context *c,
 334                                                TALLOC_CTX *mem_ctx,
 335                                                struct dcerpc_pipe **p);
 336
 337 struct composite_context* dcerpc_secondary_connection_send(struct dcerpc_pipe *p,
 338                                                            struct dcerpc_binding *b);
 339 void dcerpc_log_packet(const char *lockdir,
 340                        const struct ndr_interface_table *ndr,
 341                        uint32_t opnum, uint32_t flags,
 342                        const DATA_BLOB *pkt);
 343 NTSTATUS dcerpc_binding_build_tower(TALLOC_CTX *mem_ctx,
 344                                     const struct dcerpc_binding *binding,
 345                                     struct epm_tower *tower);
 346
 347 NTSTATUS dcerpc_floor_get_lhs_data(const struct epm_floor *epm_floor, struct ndr_syntax_id *syntax);
 348
 349 enum dcerpc_transport_t dcerpc_transport_by_tower(const struct epm_tower *tower);
 350 const char *derpc_transport_string_by_transport(enum dcerpc_transport_t t);
 351
 352 NTSTATUS dcerpc_binding_from_tower(TALLOC_CTX *mem_ctx,
 353                                    struct epm_tower *tower,
 354                                    struct dcerpc_binding **b_out);
 355
 356 NTSTATUS dcerpc_request(struct dcerpc_pipe *p,
 357                         struct GUID *object,
 358                         uint16_t opnum,
 359                         TALLOC_CTX *mem_ctx,
 360                         DATA_BLOB *stub_data_in,
 361                         DATA_BLOB *stub_data_out);
 362
 363 enum dcerpc_transport_t dcerpc_transport_by_endpoint_protocol(int prot);
 364
 365 const char *dcerpc_floor_get_rhs_data(TALLOC_CTX *mem_ctx, struct epm_floor *epm_floor);
 366
 367 #endif /* __S4_DCERPC_H__ */