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 2 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, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 enum dcerpc_transport_t {
  25         NCACN_NP, NCACN_IP_TCP, NCACN_IP_UDP, NCACN_VNS_IPC, NCACN_VNS_SPP,
  26         NCACN_AT_DSP, NCADG_AT_DDP, NCALRPC, NCACN_UNIX_STREAM, NCADG_UNIX_DGRAM,
  27         NCACN_HTTP, NCADG_IPX, NCACN_SPX };
  28
  29 /*
  30   this defines a generic security context for signed/sealed dcerpc pipes.
  31 */
  32 struct dcerpc_connection;
  33 struct dcerpc_security {
  34         struct dcerpc_auth *auth_info;
  35         struct gensec_security *generic_state;
  36
  37         /* get the session key */
  38         NTSTATUS (*session_key)(struct dcerpc_connection *, DATA_BLOB *);
  39 };
  40
  41 /*
  42   this holds the information that is not specific to a particular rpc context_id
  43 */
  44 struct dcerpc_connection {
  45         uint32_t call_id;
  46         uint32_t srv_max_xmit_frag;
  47         uint32_t srv_max_recv_frag;
  48         uint_t flags;
  49         struct dcerpc_security security_state;
  50         const char *binding_string;
  51         struct event_context *event_ctx;
  52
  53         struct dcerpc_transport {
  54                 enum dcerpc_transport_t transport;
  55                 void *private;
  56
  57                 NTSTATUS (*shutdown_pipe)(struct dcerpc_connection *);
  58
  59                 const char *(*peer_name)(struct dcerpc_connection *);
  60
  61                 /* send a request to the server */
  62                 NTSTATUS (*send_request)(struct dcerpc_connection *, DATA_BLOB *, BOOL trigger_read);
  63
  64                 /* send a read request to the server */
  65                 NTSTATUS (*send_read)(struct dcerpc_connection *);
  66
  67                 /* a callback to the dcerpc code when a full fragment
  68                    has been received */
  69                 void (*recv_data)(struct dcerpc_connection *, DATA_BLOB *, NTSTATUS status);
  70         } transport;
  71
  72         /* pending requests */
  73         struct rpc_request *pending;
  74
  75         /* private pointer for pending full requests */
  76         void *full_request_private;
  77
  78         /* the next context_id to be assigned */
  79         uint32_t next_context_id;
  80 };
  81
  82 /*
  83   this encapsulates a full dcerpc client side pipe
  84 */
  85 struct dcerpc_pipe {
  86         uint32_t context_id;
  87
  88         struct dcerpc_syntax_id syntax;
  89         struct dcerpc_syntax_id transfer_syntax;
  90
  91         struct dcerpc_connection *conn;
  92
  93         /* the last fault code from a DCERPC fault */
  94         uint32_t last_fault_code;
  95
  96         /* timeout for individual rpc requests, in seconds */
  97         uint_t request_timeout;
  98 };
  99
 100 /* default timeout for all rpc requests, in seconds */
 101 #define DCERPC_REQUEST_TIMEOUT 60
 102
 103
 104 /* dcerpc pipe flags */
 105 #define DCERPC_DEBUG_PRINT_IN          (1<<0)
 106 #define DCERPC_DEBUG_PRINT_OUT         (1<<1)
 107 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
 108
 109 #define DCERPC_DEBUG_VALIDATE_IN       (1<<2)
 110 #define DCERPC_DEBUG_VALIDATE_OUT      (1<<3)
 111 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
 112
 113 #define DCERPC_CONNECT                 (1<<4)
 114 #define DCERPC_SIGN                    (1<<5)
 115 #define DCERPC_SEAL                    (1<<6)
 116
 117 #define DCERPC_PUSH_BIGENDIAN          (1<<7)
 118 #define DCERPC_PULL_BIGENDIAN          (1<<8)
 119
 120 #define DCERPC_SCHANNEL                (1<<9)
 121
 122 /* use a 128 bit session key */
 123 #define DCERPC_SCHANNEL_128            (1<<12)
 124
 125 /* check incoming pad bytes */
 126 #define DCERPC_DEBUG_PAD_CHECK         (1<<13)
 127
 128 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
 129 #define DCERPC_NDR_REF_ALLOC           (1<<14)
 130
 131 #define DCERPC_AUTH_OPTIONS    (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5)
 132
 133 /* enable spnego auth */
 134 #define DCERPC_AUTH_SPNEGO             (1<<15)
 135
 136 /* enable krb5 auth */
 137 #define DCERPC_AUTH_KRB5               (1<<16)
 138
 139 /*
 140   this is used to find pointers to calls
 141 */
 142 struct dcerpc_interface_call {
 143         const char *name;
 144         size_t struct_size;
 145         NTSTATUS (*ndr_push)(struct ndr_push *, int , void *);
 146         NTSTATUS (*ndr_pull)(struct ndr_pull *, int , void *);
 147         void (*ndr_print)(struct ndr_print *, const char *, int, void *);
 148 };
 149
 150 struct dcerpc_endpoint_list {
 151         uint32_t count;
 152         const char * const *names;
 153 };
 154
 155 struct dcerpc_authservice_list {
 156         uint32_t count;
 157         const char * const *names;
 158 };
 159
 160 struct dcerpc_interface_table {
 161         const char *name;
 162         const char *uuid;
 163         uint32_t if_version;
 164         const char *helpstring;
 165         uint32_t num_calls;
 166         const struct dcerpc_interface_call *calls;
 167         const struct dcerpc_endpoint_list *endpoints;
 168         const struct dcerpc_authservice_list *authservices;
 169 };
 170
 171 struct dcerpc_interface_list {
 172         struct dcerpc_interface_list *prev, *next;
 173         const struct dcerpc_interface_table *table;
 174 };
 175
 176 /* this describes a binding to a particular transport/pipe */
 177 struct dcerpc_binding {
 178         enum dcerpc_transport_t transport;
 179         struct GUID object;
 180         uint16_t object_version;
 181         const char *host;
 182         const char *endpoint;
 183         const char *authservice;
 184         const char **options;
 185         uint32_t flags;
 186 };
 187
 188
 189 enum rpc_request_state {
 190         RPC_REQUEST_PENDING,
 191         RPC_REQUEST_DONE
 192 };
 193
 194 /*
 195   handle for an async dcerpc request
 196 */
 197 struct rpc_request {
 198         struct rpc_request *next, *prev;
 199         struct dcerpc_pipe *p;
 200         NTSTATUS status;
 201         uint32_t call_id;
 202         enum rpc_request_state state;
 203         DATA_BLOB payload;
 204         uint_t flags;
 205         uint32_t fault_code;
 206
 207         /* use by the ndr level async recv call */
 208         struct {
 209                 const struct dcerpc_interface_table *table;
 210                 uint32_t opnum;
 211                 void *struct_ptr;
 212                 TALLOC_CTX *mem_ctx;
 213         } ndr;
 214
 215         struct {
 216                 void (*callback)(struct rpc_request *);
 217                 void *private;
 218         } async;
 219 };