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 struct ndr_interface_table;
  40 struct resolve_context;
  41
  42 /*
  43   this defines a generic security context for signed/sealed dcerpc pipes.
  44 */
  45 struct dcecli_connection;
  46 struct gensec_settings;
  47 struct cli_credentials;
  48 struct dcecli_security {
  49         enum dcerpc_AuthType auth_type;
  50         enum dcerpc_AuthLevel auth_level;
  51         uint32_t auth_context_id;
  52         struct {
  53                 struct dcerpc_auth *out;
  54                 struct dcerpc_auth *in;
  55                 TALLOC_CTX *mem;
  56         } tmp_auth_info;
  57         struct gensec_security *generic_state;
  58
  59         /* get the session key */
  60         NTSTATUS (*session_key)(struct dcecli_connection *, DATA_BLOB *);
  61
  62         bool verified_bitmask1;
  63
  64 };
  65
  66 /*
  67   this holds the information that is not specific to a particular rpc context_id
  68 */
  69 struct rpc_request;
  70 struct dcecli_connection {
  71         uint32_t call_id;
  72         uint32_t srv_max_xmit_frag;
  73         uint32_t srv_max_recv_frag;
  74         uint32_t flags;
  75         struct dcecli_security security_state;
  76         struct tevent_context *event_ctx;
  77
  78         struct tevent_immediate *io_trigger;
  79         bool io_trigger_pending;
  80
  81         /** Directory in which to save ndrdump-parseable files */
  82         const char *packet_log_dir;
  83
  84         bool dead;
  85         bool free_skipped;
  86
  87         struct dcerpc_transport {
  88                 enum dcerpc_transport_t transport;
  89                 void *private_data;
  90
  91                 struct tstream_context *stream;
  92                 /** to serialize write events */
  93                 struct tevent_queue *write_queue;
  94                 /** the current active read request if any */
  95                 struct tevent_req *read_subreq;
  96                 /** number of read requests other than the current active */
  97                 uint32_t pending_reads;
  98         } transport;
  99
 100         const char *server_name;
 101
 102         /* Requests that have been sent, waiting for a reply */
 103         struct rpc_request *pending;
 104
 105         /* Sync requests waiting to be shipped */
 106         struct rpc_request *request_queue;
 107
 108         /* the next context_id to be assigned */
 109         uint32_t next_context_id;
 110
 111         /* The maximum total payload of reassembled response pdus */
 112         size_t max_total_response_size;
 113 };
 114
 115 /*
 116   this encapsulates a full dcerpc client side pipe
 117 */
 118 struct dcerpc_pipe {
 119         struct dcerpc_binding_handle *binding_handle;
 120
 121         uint32_t context_id;
 122
 123         struct ndr_syntax_id syntax;
 124         struct ndr_syntax_id transfer_syntax;
 125
 126         struct dcecli_connection *conn;
 127         const struct dcerpc_binding *binding;
 128
 129         /** the last fault code from a DCERPC fault */
 130         uint32_t last_fault_code;
 131
 132         /** timeout for individual rpc requests, in seconds */
 133         uint32_t request_timeout;
 134
 135         /*
 136          * Set for the timeout in dcerpc_pipe_connect_b_send(), to
 137          * allow the timeout not to destory the stack during a nested
 138          * event loop caused by gensec_update()
 139          */
 140         bool inhibit_timeout_processing;
 141         bool timed_out;
 142
 143         bool verified_pcontext;
 144 };
 145
 146 /* default timeout for all rpc requests, in seconds */
 147 #define DCERPC_REQUEST_TIMEOUT 60
 148
 149 struct epm_tower;
 150 struct epm_floor;
 151
 152 struct smbcli_tree;
 153 struct smb2_tree;
 154 struct smbXcli_conn;
 155 struct smbXcli_session;
 156 struct smbXcli_tcon;
 157 struct roh_connection;
 158 struct tstream_tls_params;
 159 struct socket_address;
 160
 161 NTSTATUS dcerpc_pipe_connect(TALLOC_CTX *parent_ctx,
 162                              struct dcerpc_pipe **pp,
 163                              const char *binding,
 164                              const struct ndr_interface_table *table,
 165                              struct cli_credentials *credentials,
 166                              struct tevent_context *ev,
 167                              struct loadparm_context *lp_ctx);
 168 const char *dcerpc_server_name(struct dcerpc_pipe *p);
 169 struct dcerpc_pipe *dcerpc_pipe_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev);
 170 NTSTATUS dcerpc_pipe_open_smb(struct dcerpc_pipe *p,
 171                               struct smbcli_tree *tree,
 172                               const char *pipe_name);
 173 NTSTATUS dcerpc_pipe_open_smb2(struct dcerpc_pipe *p,
 174                                struct smb2_tree *tree,
 175                                const char *pipe_name);
 176 NTSTATUS dcerpc_bind_auth_none(struct dcerpc_pipe *p,
 177                                const struct ndr_interface_table *table);
 178 NTSTATUS dcerpc_fetch_session_key(struct dcerpc_pipe *p,
 179                                   DATA_BLOB *session_key);
 180 struct composite_context;
 181 NTSTATUS dcerpc_secondary_connection_recv(struct composite_context *c,
 182                                           struct dcerpc_pipe **p2);
 183
 184 struct composite_context* dcerpc_pipe_connect_b_send(TALLOC_CTX *parent_ctx,
 185                                                      const struct dcerpc_binding *binding,
 186                                                      const struct ndr_interface_table *table,
 187                                                      struct cli_credentials *credentials,
 188                                                      struct tevent_context *ev,
 189                                                      struct loadparm_context *lp_ctx);
 190
 191 NTSTATUS dcerpc_pipe_connect_b_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
 192                                     struct dcerpc_pipe **p);
 193
 194 NTSTATUS dcerpc_pipe_connect_b(TALLOC_CTX *parent_ctx,
 195                                struct dcerpc_pipe **pp,
 196                                const struct dcerpc_binding *binding,
 197                                const struct ndr_interface_table *table,
 198                                struct cli_credentials *credentials,
 199                                struct tevent_context *ev,
 200                                struct loadparm_context *lp_ctx);
 201
 202 NTSTATUS dcerpc_pipe_auth(TALLOC_CTX *mem_ctx,
 203                           struct dcerpc_pipe **p,
 204                           const struct dcerpc_binding *binding,
 205                           const struct ndr_interface_table *table,
 206                           struct cli_credentials *credentials,
 207                           struct loadparm_context *lp_ctx);
 208 NTSTATUS dcerpc_secondary_connection(struct dcerpc_pipe *p,
 209                                      struct dcerpc_pipe **p2,
 210                                      const struct dcerpc_binding *b);
 211 NTSTATUS dcerpc_bind_auth_schannel(TALLOC_CTX *tmp_ctx,
 212                                    struct dcerpc_pipe *p,
 213                                    const struct ndr_interface_table *table,
 214                                    struct cli_credentials *credentials,
 215                                    struct loadparm_context *lp_ctx,
 216                                    uint8_t auth_level);
 217 NTSTATUS dcerpc_init(void);
 218 struct composite_context *dcerpc_secondary_smb_send(struct dcecli_connection *c1,
 219                                                     struct dcecli_connection *c2,
 220                                                     const char *pipe_name);
 221 NTSTATUS dcerpc_secondary_smb_recv(struct composite_context *c);
 222 NTSTATUS dcerpc_secondary_context(struct dcerpc_pipe *p,
 223                                   struct dcerpc_pipe **pp2,
 224                                   const struct ndr_interface_table *table);
 225 NTSTATUS dcerpc_alter_context(struct dcerpc_pipe *p,
 226                               TALLOC_CTX *mem_ctx,
 227                               const struct ndr_syntax_id *syntax,
 228                               const struct ndr_syntax_id *transfer_syntax);
 229
 230 NTSTATUS dcerpc_bind_auth(struct dcerpc_pipe *p,
 231                           const struct ndr_interface_table *table,
 232                           struct cli_credentials *credentials,
 233                           struct gensec_settings *gensec_settings,
 234                           uint8_t auth_type, uint8_t auth_level,
 235                           const char *service);
 236 struct composite_context* dcerpc_pipe_connect_send(TALLOC_CTX *parent_ctx,
 237                                                    const char *binding,
 238                                                    const struct ndr_interface_table *table,
 239                                                    struct cli_credentials *credentials,
 240                                                    struct tevent_context *ev, struct loadparm_context *lp_ctx);
 241 NTSTATUS dcerpc_pipe_connect_recv(struct composite_context *c,
 242                                   TALLOC_CTX *mem_ctx,
 243                                   struct dcerpc_pipe **pp);
 244
 245 NTSTATUS dcerpc_epm_map_binding(TALLOC_CTX *mem_ctx, struct dcerpc_binding *binding,
 246                                 const struct ndr_interface_table *table, struct tevent_context *ev,
 247                                 struct loadparm_context *lp_ctx);
 248 struct composite_context* dcerpc_secondary_auth_connection_send(struct dcerpc_pipe *p,
 249                                                                 const struct dcerpc_binding *binding,
 250                                                                 const struct ndr_interface_table *table,
 251                                                                 struct cli_credentials *credentials,
 252                                                                 struct loadparm_context *lp_ctx);
 253 NTSTATUS dcerpc_secondary_auth_connection_recv(struct composite_context *c,
 254                                                TALLOC_CTX *mem_ctx,
 255                                                struct dcerpc_pipe **p);
 256
 257 struct composite_context* dcerpc_secondary_connection_send(struct dcerpc_pipe *p,
 258                                                            const struct dcerpc_binding *b);
 259 void dcerpc_log_packet(const char *lockdir,
 260                        const struct ndr_interface_table *ndr,
 261                        uint32_t opnum, uint32_t flags,
 262                        const DATA_BLOB *pkt);
 263
 264 #endif /* __S4_DCERPC_H__ */