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