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