source4/rpc_server/dcerpc_server.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    server side dcerpc defines
   5
   6    Copyright (C) Andrew Tridgell 2003-2005
   7    Copyright (C) Stefan (metze) Metzmacher 2004-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 #ifndef SAMBA_DCERPC_SERVER_H
  24 #define SAMBA_DCERPC_SERVER_H
  25
  26 #include "librpc/gen_ndr/misc.h"
  27 #include "librpc/rpc/dcerpc.h"
  28 #include "librpc/ndr/libndr.h"
  29
  30 /* modules can use the following to determine if the interface has changed
  31  * please increment the version number after each interface change
  32  * with a comment and maybe update struct dcesrv_critical_sizes.
  33  */
  34 /* version 1 - initial version - metze */
  35 #define DCERPC_MODULE_VERSION 1
  36
  37 struct dcesrv_connection;
  38 struct dcesrv_call_state;
  39 struct dcesrv_auth;
  40 struct dcesrv_connection_context;
  41
  42 struct dcesrv_interface {
  43         const char *name;
  44         struct ndr_syntax_id syntax_id;
  45
  46         /* this function is called when the client binds to this interface  */
  47         NTSTATUS (*bind)(struct dcesrv_call_state *, const struct dcesrv_interface *);
  48
  49         /* this function is called when the client disconnects the endpoint */
  50         void (*unbind)(struct dcesrv_connection_context *, const struct dcesrv_interface *);
  51
  52         /* the ndr_pull function for the chosen interface.
  53          */
  54         NTSTATUS (*ndr_pull)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_pull *, void **);
  55
  56         /* the dispatch function for the chosen interface.
  57          */
  58         NTSTATUS (*dispatch)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
  59
  60         /* the reply function for the chosen interface.
  61          */
  62         NTSTATUS (*reply)(struct dcesrv_call_state *, TALLOC_CTX *, void *);
  63
  64         /* the ndr_push function for the chosen interface.
  65          */
  66         NTSTATUS (*ndr_push)(struct dcesrv_call_state *, TALLOC_CTX *, struct ndr_push *, const void *);
  67
  68         /* for any private use by the interface code */
  69         const void *private;
  70 };
  71
  72 enum dcesrv_call_list {
  73         DCESRV_LIST_NONE,
  74         DCESRV_LIST_CALL_LIST,
  75         DCESRV_LIST_FRAGMENTED_CALL_LIST,
  76         DCESRV_LIST_PENDING_CALL_LIST
  77 };
  78
  79 /* the state of an ongoing dcerpc call */
  80 struct dcesrv_call_state {
  81         struct dcesrv_call_state *next, *prev;
  82         struct dcesrv_connection *conn;
  83         struct dcesrv_connection_context *context;
  84         struct ncacn_packet pkt;
  85
  86         /*
  87           which list this request is in, if any
  88          */
  89         enum dcesrv_call_list list;
  90
  91         /* the backend can mark the call
  92          * with DCESRV_CALL_STATE_FLAG_ASYNC
  93          * that will cause the frontend to not touch r->out
  94          * and skip the reply
  95          *
  96          * this is only allowed to the backend when DCESRV_CALL_STATE_FLAG_MAY_ASYNC
  97          * is alerady set by the frontend
  98          *
  99          * the backend then needs to call dcesrv_reply() when it's
 100          * ready to send the reply
 101          */
 102 #define DCESRV_CALL_STATE_FLAG_ASYNC (1<<0)
 103 #define DCESRV_CALL_STATE_FLAG_MAY_ASYNC (1<<1)
 104 #define DCESRV_CALL_STATE_FLAG_HEADER_SIGNING (1<<2)
 105         uint32_t state_flags;
 106
 107         /* the time the request arrived in the server */
 108         struct timeval time;
 109
 110         /* the backend can use this event context for async replies */
 111         struct event_context *event_ctx;
 112
 113         /* the message_context that will be used for async replies */
 114         struct messaging_context *msg_ctx;
 115
 116         /* this is the pointer to the allocated function struct */
 117         void *r;
 118
 119         /*
 120          * that's the ndr pull context used in dcesrv_request()
 121          * needed by dcesrv_reply() to carry over information
 122          * for full pointer support.
 123          */
 124         struct ndr_pull *ndr_pull;
 125
 126         DATA_BLOB input;
 127
 128         struct data_blob_list_item *replies;
 129
 130         /* this is used by the boilerplate code to generate DCERPC faults */
 131         uint32_t fault_code;
 132 };
 133
 134 #define DCESRV_HANDLE_ANY 255
 135
 136 /* a dcerpc handle in internal format */
 137 struct dcesrv_handle {
 138         struct dcesrv_handle *next, *prev;
 139         struct dcesrv_connection_context *context;
 140         struct policy_handle wire_handle;
 141         void *data;
 142 };
 143
 144 /* hold the authentication state information */
 145 struct dcesrv_auth {
 146         struct dcerpc_auth *auth_info;
 147         struct gensec_security *gensec_security;
 148         struct auth_session_info *session_info;
 149         NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
 150 };
 151
 152 struct dcesrv_connection_context {
 153         struct dcesrv_connection_context *next, *prev;
 154         uint32_t context_id;
 155
 156         /* the connection this is on */
 157         struct dcesrv_connection *conn;
 158
 159         /* the ndr function table for the chosen interface */
 160         const struct dcesrv_interface *iface;
 161
 162         /* private data for the interface implementation */
 163         void *private;
 164
 165         /* current rpc handles - this is really the wrong scope for
 166            them, but it will do for now */
 167         struct dcesrv_handle *handles;
 168 };
 169
 170
 171 /* the state associated with a dcerpc server connection */
 172 struct dcesrv_connection {
 173         /* the top level context for this server */
 174         struct dcesrv_context *dce_ctx;
 175
 176         /* the endpoint that was opened */
 177         const struct dcesrv_endpoint *endpoint;
 178
 179         /* a list of established context_ids */
 180         struct dcesrv_connection_context *contexts;
 181
 182         /* the state of the current incoming call fragments */
 183         struct dcesrv_call_state *incoming_fragmented_call_list;
 184
 185         /* the state of the async pending calls */
 186         struct dcesrv_call_state *pending_call_list;
 187
 188         /* the state of the current outgoing calls */
 189         struct dcesrv_call_state *call_list;
 190
 191         /* the maximum size the client wants to receive */
 192         uint32_t cli_max_recv_frag;
 193
 194         DATA_BLOB partial_input;
 195
 196         /* the current authentication state */
 197         struct dcesrv_auth auth_state;
 198
 199         /* the event_context that will be used for this connection */
 200         struct event_context *event_ctx;
 201
 202         /* the message_context that will be used for this connection */
 203         struct messaging_context *msg_ctx;
 204
 205         /* the server_id that will be used for this connection */
 206         struct server_id server_id;
 207
 208         /* the transport level session key */
 209         DATA_BLOB transport_session_key;
 210
 211         bool processing;
 212
 213         /* this is the default state_flags for dcesrv_call_state structs */
 214         uint32_t state_flags;
 215
 216         struct {
 217                 void *private_data;
 218                 void (*report_output_data)(struct dcesrv_connection *);
 219                 struct socket_address *(*get_my_addr)(struct dcesrv_connection *, TALLOC_CTX *mem_ctx);
 220                 struct socket_address *(*get_peer_addr)(struct dcesrv_connection *, TALLOC_CTX *mem_ctx);
 221         } transport;
 222 };
 223
 224
 225 struct dcesrv_endpoint_server {
 226         /* this is the name of the endpoint server */
 227         const char *name;
 228
 229         /* this function should register endpoints and some other setup stuff,
 230          * it is called when the dcesrv_context gets initialized.
 231          */
 232         NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
 233
 234         /* this function can be used by other endpoint servers to
 235          * ask for a dcesrv_interface implementation
 236          * - iface must be reference to an already existing struct !
 237          */
 238         bool (*interface_by_uuid)(struct dcesrv_interface *iface, const struct GUID *, uint32_t);
 239
 240         /* this function can be used by other endpoint servers to
 241          * ask for a dcesrv_interface implementation
 242          * - iface must be reference to an already existeng struct !
 243          */
 244         bool (*interface_by_name)(struct dcesrv_interface *iface, const char *);
 245 };
 246
 247
 248 /* server-wide context information for the dcerpc server */
 249 struct dcesrv_context {
 250         /* the list of endpoints that have registered
 251          * by the configured endpoint servers
 252          */
 253         struct dcesrv_endpoint {
 254                 struct dcesrv_endpoint *next, *prev;
 255                 /* the type and location of the endpoint */
 256                 struct dcerpc_binding *ep_description;
 257                 /* the security descriptor for smb named pipes */
 258                 struct security_descriptor *sd;
 259                 /* the list of interfaces available on this endpoint */
 260                 struct dcesrv_if_list {
 261                         struct dcesrv_if_list *next, *prev;
 262                         struct dcesrv_interface iface;
 263                 } *interface_list;
 264         } *endpoint_list;
 265
 266         /* loadparm context to use for this connection */
 267         struct loadparm_context *lp_ctx;
 268 };
 269
 270 /* this structure is used by modules to determine the size of some critical types */
 271 struct dcesrv_critical_sizes {
 272         int interface_version;
 273         int sizeof_dcesrv_context;
 274         int sizeof_dcesrv_endpoint;
 275         int sizeof_dcesrv_endpoint_server;
 276         int sizeof_dcesrv_interface;
 277         int sizeof_dcesrv_if_list;
 278         int sizeof_dcesrv_connection;
 279         int sizeof_dcesrv_call_state;
 280         int sizeof_dcesrv_auth;
 281         int sizeof_dcesrv_handle;
 282 };
 283
 284 struct model_ops;
 285
 286 NTSTATUS dcesrv_interface_register(struct dcesrv_context *dce_ctx,
 287                                    const char *ep_name,
 288                                    const struct dcesrv_interface *iface,
 289                                    const struct security_descriptor *sd);
 290 NTSTATUS dcerpc_register_ep_server(const void *_ep_server);
 291 NTSTATUS dcesrv_init_context(TALLOC_CTX *mem_ctx,
 292                                       struct loadparm_context *lp_ctx,
 293                                       const char **endpoint_servers, struct dcesrv_context **_dce_ctx);
 294 NTSTATUS dcesrv_init_ipc_context(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx,
 295                                           struct dcesrv_context **_dce_ctx);
 296 NTSTATUS dcesrv_endpoint_search_connect(struct dcesrv_context *dce_ctx,
 297                                         TALLOC_CTX *mem_ctx,
 298                                         const struct dcerpc_binding *ep_description,
 299                                         struct auth_session_info *session_info,
 300                                         struct event_context *event_ctx,
 301                                         struct messaging_context *msg_ctx,
 302                                         struct server_id server_id,
 303                                         uint32_t state_flags,
 304                                         struct dcesrv_connection **dce_conn_p);
 305 NTSTATUS dcesrv_output(struct dcesrv_connection *dce_conn,
 306                        void *private_data,
 307                        NTSTATUS (*write_fn)(void *private_data, DATA_BLOB *output, size_t *nwritten));
 308 NTSTATUS dcesrv_input(struct dcesrv_connection *dce_conn, const DATA_BLOB *data);
 309 NTSTATUS dcesrv_endpoint_connect(struct dcesrv_context *dce_ctx,
 310                                  TALLOC_CTX *mem_ctx,
 311                                  const struct dcesrv_endpoint *ep,
 312                                  struct auth_session_info *session_info,
 313                                  struct event_context *event_ctx,
 314                                  struct messaging_context *msg_ctx,
 315                                  struct server_id server_id,
 316                                  uint32_t state_flags,
 317                                  struct dcesrv_connection **_p);
 318
 319 NTSTATUS dcesrv_reply(struct dcesrv_call_state *call);
 320 struct dcesrv_handle *dcesrv_handle_new(struct dcesrv_connection_context *context,
 321                                         uint8_t handle_type);
 322
 323 struct dcesrv_handle *dcesrv_handle_fetch(
 324                                           struct dcesrv_connection_context *context,
 325                                           struct policy_handle *p,
 326                                           uint8_t handle_type);
 327 struct socket_address *dcesrv_connection_get_my_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
 328
 329 struct socket_address *dcesrv_connection_get_peer_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
 330
 331 NTSTATUS dcesrv_fetch_session_key(struct dcesrv_connection *p, DATA_BLOB *session_key);
 332
 333 /* a useful macro for generating a RPC fault in the backend code */
 334 #define DCESRV_FAULT(code) do { \
 335         dce_call->fault_code = code; \
 336         return r->out.result; \
 337 } while(0)
 338
 339 /* a useful macro for generating a RPC fault in the backend code */
 340 #define DCESRV_FAULT_VOID(code) do { \
 341         dce_call->fault_code = code; \
 342         return; \
 343 } while(0)
 344
 345 /* a useful macro for checking the validity of a dcerpc policy handle
 346    and giving the right fault code if invalid */
 347 #define DCESRV_CHECK_HANDLE(h) do {if (!(h)) DCESRV_FAULT(DCERPC_FAULT_CONTEXT_MISMATCH); } while (0)
 348
 349 /* this checks for a valid policy handle, and gives a fault if an
 350    invalid handle or retval if the handle is of the
 351    wrong type */
 352 #define DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, retval) do { \
 353         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), DCESRV_HANDLE_ANY); \
 354         DCESRV_CHECK_HANDLE(h); \
 355         if ((t) != DCESRV_HANDLE_ANY && (h)->wire_handle.handle_type != (t)) { \
 356                 return retval; \
 357         } \
 358 } while (0)
 359
 360 /* this checks for a valid policy handle and gives a dcerpc fault
 361    if its the wrong type of handle */
 362 #define DCESRV_PULL_HANDLE_FAULT(h, inhandle, t) do { \
 363         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), t); \
 364         DCESRV_CHECK_HANDLE(h); \
 365 } while (0)
 366
 367 #define DCESRV_PULL_HANDLE(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, NT_STATUS_INVALID_HANDLE)
 368 #define DCESRV_PULL_HANDLE_WERR(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, WERR_BADFID)
 369
 370
 371
 372 #endif /* SAMBA_DCERPC_SERVER_H */