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/server_id.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 *, uint32_t if_version);
  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_data;
  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         uint32_t state_flags;
 105
 106         /* the time the request arrived in the server */
 107         struct timeval time;
 108
 109         /* the backend can use this event context for async replies */
 110         struct tevent_context *event_ctx;
 111
 112         /* the message_context that will be used for async replies */
 113         struct imessaging_context *msg_ctx;
 114
 115         /* this is the pointer to the allocated function struct */
 116         void *r;
 117
 118         /*
 119          * that's the ndr pull context used in dcesrv_request()
 120          * needed by dcesrv_reply() to carry over information
 121          * for full pointer support.
 122          */
 123         struct ndr_pull *ndr_pull;
 124
 125         DATA_BLOB input;
 126
 127         struct data_blob_list_item *replies;
 128
 129         /* this is used by the boilerplate code to generate DCERPC faults */
 130         uint32_t fault_code;
 131 };
 132
 133 #define DCESRV_HANDLE_ANY 255
 134
 135 /* a dcerpc handle in internal format */
 136 struct dcesrv_handle {
 137         struct dcesrv_handle *next, *prev;
 138         struct dcesrv_assoc_group *assoc_group;
 139         struct policy_handle wire_handle;
 140         struct dom_sid *sid;
 141         const struct dcesrv_interface *iface;
 142         void *data;
 143 };
 144
 145 /* hold the authentication state information */
 146 struct dcesrv_auth {
 147         struct dcerpc_auth *auth_info;
 148         struct gensec_security *gensec_security;
 149         struct auth_session_info *session_info;
 150         NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
 151         bool client_hdr_signing;
 152         bool hdr_signing;
 153 };
 154
 155 struct dcesrv_connection_context {
 156         struct dcesrv_connection_context *next, *prev;
 157         uint32_t context_id;
 158
 159         struct dcesrv_assoc_group *assoc_group;
 160
 161         /* the connection this is on */
 162         struct dcesrv_connection *conn;
 163
 164         /* the ndr function table for the chosen interface */
 165         const struct dcesrv_interface *iface;
 166
 167         /* private data for the interface implementation */
 168         void *private_data;
 169 };
 170
 171
 172 /* the state associated with a dcerpc server connection */
 173 struct dcesrv_connection {
 174         /* for the broken_connections DLIST */
 175         struct dcesrv_connection *prev, *next;
 176
 177         /* the top level context for this server */
 178         struct dcesrv_context *dce_ctx;
 179
 180         /* the endpoint that was opened */
 181         const struct dcesrv_endpoint *endpoint;
 182
 183         /* a list of established context_ids */
 184         struct dcesrv_connection_context *contexts;
 185
 186         /* the state of the current incoming call fragments */
 187         struct dcesrv_call_state *incoming_fragmented_call_list;
 188
 189         /* the state of the async pending calls */
 190         struct dcesrv_call_state *pending_call_list;
 191
 192         /* the state of the current outgoing calls */
 193         struct dcesrv_call_state *call_list;
 194
 195         /* the maximum size the client wants to receive */
 196         uint32_t cli_max_recv_frag;
 197
 198         DATA_BLOB partial_input;
 199
 200         /* the current authentication state */
 201         struct dcesrv_auth auth_state;
 202
 203         /* the event_context that will be used for this connection */
 204         struct tevent_context *event_ctx;
 205
 206         /* the message_context that will be used for this connection */
 207         struct imessaging_context *msg_ctx;
 208
 209         /* the server_id that will be used for this connection */
 210         struct server_id server_id;
 211
 212         /* the transport level session key */
 213         DATA_BLOB transport_session_key;
 214
 215         /* is this connection pending termination?  If so, why? */
 216         const char *terminate;
 217
 218         const char *packet_log_dir;
 219
 220         /* this is the default state_flags for dcesrv_call_state structs */
 221         uint32_t state_flags;
 222
 223         struct {
 224                 void *private_data;
 225                 void (*report_output_data)(struct dcesrv_connection *);
 226         } transport;
 227
 228         struct tstream_context *stream;
 229         struct tevent_queue *send_queue;
 230
 231         const struct tsocket_address *local_address;
 232         const struct tsocket_address *remote_address;
 233 };
 234
 235
 236 struct dcesrv_endpoint_server {
 237         /* this is the name of the endpoint server */
 238         const char *name;
 239
 240         /* this function should register endpoints and some other setup stuff,
 241          * it is called when the dcesrv_context gets initialized.
 242          */
 243         NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
 244
 245         /* this function can be used by other endpoint servers to
 246          * ask for a dcesrv_interface implementation
 247          * - iface must be reference to an already existing struct !
 248          */
 249         bool (*interface_by_uuid)(struct dcesrv_interface *iface, const struct GUID *, uint32_t);
 250
 251         /* this function can be used by other endpoint servers to
 252          * ask for a dcesrv_interface implementation
 253          * - iface must be reference to an already existeng struct !
 254          */
 255         bool (*interface_by_name)(struct dcesrv_interface *iface, const char *);
 256 };
 257
 258
 259 /* one association groups */
 260 struct dcesrv_assoc_group {
 261         /* the wire id */
 262         uint32_t id;
 263
 264         /* list of handles in this association group */
 265         struct dcesrv_handle *handles;
 266
 267         /* parent context */
 268         struct dcesrv_context *dce_ctx;
 269
 270         /* Remote association group ID (if proxied) */
 271         uint32_t proxied_id;
 272 };
 273
 274 /* server-wide context information for the dcerpc server */
 275 struct dcesrv_context {
 276         /* the list of endpoints that have registered
 277          * by the configured endpoint servers
 278          */
 279         struct dcesrv_endpoint {
 280                 struct dcesrv_endpoint *next, *prev;
 281                 /* the type and location of the endpoint */
 282                 struct dcerpc_binding *ep_description;
 283                 /* the security descriptor for smb named pipes */
 284                 struct security_descriptor *sd;
 285                 /* the list of interfaces available on this endpoint */
 286                 struct dcesrv_if_list {
 287                         struct dcesrv_if_list *next, *prev;
 288                         struct dcesrv_interface iface;
 289                 } *interface_list;
 290         } *endpoint_list;
 291
 292         /* loadparm context to use for this connection */
 293         struct loadparm_context *lp_ctx;
 294
 295         struct idr_context *assoc_groups_idr;
 296
 297         struct dcesrv_connection *broken_connections;
 298 };
 299
 300 /* this structure is used by modules to determine the size of some critical types */
 301 struct dcesrv_critical_sizes {
 302         int interface_version;
 303         int sizeof_dcesrv_context;
 304         int sizeof_dcesrv_endpoint;
 305         int sizeof_dcesrv_endpoint_server;
 306         int sizeof_dcesrv_interface;
 307         int sizeof_dcesrv_if_list;
 308         int sizeof_dcesrv_connection;
 309         int sizeof_dcesrv_call_state;
 310         int sizeof_dcesrv_auth;
 311         int sizeof_dcesrv_handle;
 312 };
 313
 314 struct model_ops;
 315
 316 NTSTATUS dcesrv_interface_register(struct dcesrv_context *dce_ctx,
 317                                    const char *ep_name,
 318                                    const struct dcesrv_interface *iface,
 319                                    const struct security_descriptor *sd);
 320 NTSTATUS dcerpc_register_ep_server(const void *_ep_server);
 321 NTSTATUS dcesrv_init_context(TALLOC_CTX *mem_ctx,
 322                                       struct loadparm_context *lp_ctx,
 323                                       const char **endpoint_servers, struct dcesrv_context **_dce_ctx);
 324 NTSTATUS dcesrv_endpoint_connect(struct dcesrv_context *dce_ctx,
 325                                  TALLOC_CTX *mem_ctx,
 326                                  const struct dcesrv_endpoint *ep,
 327                                  struct auth_session_info *session_info,
 328                                  struct tevent_context *event_ctx,
 329                                  struct imessaging_context *msg_ctx,
 330                                  struct server_id server_id,
 331                                  uint32_t state_flags,
 332                                  struct dcesrv_connection **_p);
 333
 334 NTSTATUS dcesrv_reply(struct dcesrv_call_state *call);
 335 struct dcesrv_handle *dcesrv_handle_new(struct dcesrv_connection_context *context,
 336                                         uint8_t handle_type);
 337
 338 struct dcesrv_handle *dcesrv_handle_fetch(
 339                                           struct dcesrv_connection_context *context,
 340                                           struct policy_handle *p,
 341                                           uint8_t handle_type);
 342 struct socket_address *dcesrv_connection_get_my_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
 343
 344 struct socket_address *dcesrv_connection_get_peer_addr(struct dcesrv_connection *conn, TALLOC_CTX *mem_ctx);
 345 const struct tsocket_address *dcesrv_connection_get_local_address(struct dcesrv_connection *conn);
 346 const struct tsocket_address *dcesrv_connection_get_remote_address(struct dcesrv_connection *conn);
 347
 348 NTSTATUS dcesrv_fetch_session_key(struct dcesrv_connection *p, DATA_BLOB *session_key);
 349
 350 /* a useful macro for generating a RPC fault in the backend code */
 351 #define DCESRV_FAULT(code) do { \
 352         dce_call->fault_code = code; \
 353         return r->out.result; \
 354 } while(0)
 355
 356 /* a useful macro for generating a RPC fault in the backend code */
 357 #define DCESRV_FAULT_VOID(code) do { \
 358         dce_call->fault_code = code; \
 359         return; \
 360 } while(0)
 361
 362 /* a useful macro for checking the validity of a dcerpc policy handle
 363    and giving the right fault code if invalid */
 364 #define DCESRV_CHECK_HANDLE(h) do {if (!(h)) DCESRV_FAULT(DCERPC_FAULT_CONTEXT_MISMATCH); } while (0)
 365
 366 /* this checks for a valid policy handle, and gives a fault if an
 367    invalid handle or retval if the handle is of the
 368    wrong type */
 369 #define DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, retval) do { \
 370         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), DCESRV_HANDLE_ANY); \
 371         DCESRV_CHECK_HANDLE(h); \
 372         if ((t) != DCESRV_HANDLE_ANY && (h)->wire_handle.handle_type != (t)) { \
 373                 return retval; \
 374         } \
 375 } while (0)
 376
 377 /* this checks for a valid policy handle and gives a dcerpc fault
 378    if its the wrong type of handle */
 379 #define DCESRV_PULL_HANDLE_FAULT(h, inhandle, t) do { \
 380         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), t); \
 381         DCESRV_CHECK_HANDLE(h); \
 382 } while (0)
 383
 384 #define DCESRV_PULL_HANDLE(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, NT_STATUS_INVALID_HANDLE)
 385 #define DCESRV_PULL_HANDLE_WERR(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, WERR_BADFID)
 386
 387 NTSTATUS dcesrv_add_ep(struct dcesrv_context *dce_ctx,
 388                        struct loadparm_context *lp_ctx,
 389                        struct dcesrv_endpoint *e,
 390                        struct tevent_context *event_ctx,
 391                        const struct model_ops *model_ops);
 392
 393 /**
 394  * retrieve credentials from a dce_call
 395  */
 396 _PUBLIC_ struct cli_credentials *dcesrv_call_credentials(struct dcesrv_call_state *dce_call);
 397
 398 /**
 399  * returns true if this is an authenticated call
 400  */
 401 _PUBLIC_ bool dcesrv_call_authenticated(struct dcesrv_call_state *dce_call);
 402
 403 /**
 404  * retrieve account_name for a dce_call
 405  */
 406 _PUBLIC_ const char *dcesrv_call_account_name(struct dcesrv_call_state *dce_call);
 407
 408
 409 #endif /* SAMBA_DCERPC_SERVER_H */