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         uint64_t flags;
  72 };
  73
  74 #define DCESRV_INTERFACE_FLAGS_HANDLES_NOT_USED 0x00000001
  75
  76 enum dcesrv_call_list {
  77         DCESRV_LIST_NONE,
  78         DCESRV_LIST_CALL_LIST,
  79         DCESRV_LIST_FRAGMENTED_CALL_LIST,
  80         DCESRV_LIST_PENDING_CALL_LIST
  81 };
  82
  83 struct data_blob_list_item {
  84         struct data_blob_list_item *prev,*next;
  85         DATA_BLOB blob;
  86 };
  87
  88 /* the state of an ongoing dcerpc call */
  89 struct dcesrv_call_state {
  90         struct dcesrv_call_state *next, *prev;
  91         struct dcesrv_connection *conn;
  92         struct dcesrv_connection_context *context;
  93         struct ncacn_packet pkt;
  94
  95         /*
  96          * Used during async bind/alter_context.
  97          */
  98         struct ncacn_packet ack_pkt;
  99
 100         /*
 101           which list this request is in, if any
 102          */
 103         enum dcesrv_call_list list;
 104
 105         /* the backend can mark the call
 106          * with DCESRV_CALL_STATE_FLAG_ASYNC
 107          * that will cause the frontend to not touch r->out
 108          * and skip the reply
 109          *
 110          * this is only allowed to the backend when DCESRV_CALL_STATE_FLAG_MAY_ASYNC
 111          * is alerady set by the frontend
 112          *
 113          * the backend then needs to call dcesrv_reply() when it's
 114          * ready to send the reply
 115          */
 116 #define DCESRV_CALL_STATE_FLAG_ASYNC (1<<0)
 117 #define DCESRV_CALL_STATE_FLAG_MAY_ASYNC (1<<1)
 118 #define DCESRV_CALL_STATE_FLAG_MULTIPLEXED (1<<3)
 119 #define DCESRV_CALL_STATE_FLAG_PROCESS_PENDING_CALL (1<<4)
 120         uint32_t state_flags;
 121
 122         /* the time the request arrived in the server */
 123         struct timeval time;
 124
 125         /* the backend can use this event context for async replies */
 126         struct tevent_context *event_ctx;
 127
 128         /* the message_context that will be used for async replies */
 129         struct imessaging_context *msg_ctx;
 130
 131         /* this is the pointer to the allocated function struct */
 132         void *r;
 133
 134         /*
 135          * that's the ndr pull context used in dcesrv_request()
 136          * needed by dcesrv_reply() to carry over information
 137          * for full pointer support.
 138          */
 139         struct ndr_pull *ndr_pull;
 140
 141         DATA_BLOB input;
 142
 143         struct data_blob_list_item *replies;
 144
 145         /* this is used by the boilerplate code to generate DCERPC faults */
 146         uint32_t fault_code;
 147
 148         /* the reason why we terminate the connection after sending a response */
 149         const char *terminate_reason;
 150
 151         /* temporary auth_info fields */
 152         struct dcerpc_auth in_auth_info;
 153         struct dcerpc_auth _out_auth_info;
 154         struct dcerpc_auth *out_auth_info;
 155 };
 156
 157 #define DCESRV_HANDLE_ANY 255
 158
 159 /* a dcerpc handle in internal format */
 160 struct dcesrv_handle {
 161         struct dcesrv_handle *next, *prev;
 162         struct dcesrv_assoc_group *assoc_group;
 163         struct policy_handle wire_handle;
 164         struct dom_sid *sid;
 165         const struct dcesrv_interface *iface;
 166         void *data;
 167 };
 168
 169 /* hold the authentication state information */
 170 struct dcesrv_auth {
 171         enum dcerpc_AuthType auth_type;
 172         enum dcerpc_AuthLevel auth_level;
 173         uint32_t auth_context_id;
 174         struct gensec_security *gensec_security;
 175         struct auth_session_info *session_info;
 176         NTSTATUS (*session_key)(struct dcesrv_connection *, DATA_BLOB *session_key);
 177         bool client_hdr_signing;
 178         bool hdr_signing;
 179         bool auth_finished;
 180         bool auth_invalid;
 181 };
 182
 183 struct dcesrv_connection_context {
 184         struct dcesrv_connection_context *next, *prev;
 185         uint16_t context_id;
 186
 187         /* the connection this is on */
 188         struct dcesrv_connection *conn;
 189
 190         /* the ndr function table for the chosen interface */
 191         const struct dcesrv_interface *iface;
 192
 193         /* private data for the interface implementation */
 194         void *private_data;
 195
 196         /*
 197          * the minimum required auth level for this interface
 198          */
 199         enum dcerpc_AuthLevel min_auth_level;
 200         bool allow_connect;
 201
 202         /* the negotiated transfer syntax */
 203         struct ndr_syntax_id transfer_syntax;
 204 };
 205
 206
 207 /* the state associated with a dcerpc server connection */
 208 struct dcesrv_connection {
 209         /* for the broken_connections DLIST */
 210         struct dcesrv_connection *prev, *next;
 211
 212         /* the top level context for this server */
 213         struct dcesrv_context *dce_ctx;
 214
 215         /* the endpoint that was opened */
 216         const struct dcesrv_endpoint *endpoint;
 217
 218         /* a list of established context_ids */
 219         struct dcesrv_connection_context *contexts;
 220
 221         /* the state of the current incoming call fragments */
 222         struct dcesrv_call_state *incoming_fragmented_call_list;
 223
 224         /* the state of the async pending calls */
 225         struct dcesrv_call_state *pending_call_list;
 226
 227         /* the state of the current outgoing calls */
 228         struct dcesrv_call_state *call_list;
 229
 230         /* the maximum size the client wants to receive */
 231         uint16_t max_recv_frag;
 232         uint16_t max_xmit_frag;
 233
 234         DATA_BLOB partial_input;
 235
 236         /* the event_context that will be used for this connection */
 237         struct tevent_context *event_ctx;
 238
 239         /* the message_context that will be used for this connection */
 240         struct imessaging_context *msg_ctx;
 241
 242         /* the server_id that will be used for this connection */
 243         struct server_id server_id;
 244
 245         /* the transport level session key */
 246         DATA_BLOB transport_session_key;
 247
 248         /* is this connection pending termination?  If so, why? */
 249         const char *terminate;
 250
 251         const char *packet_log_dir;
 252
 253         /* this is the default state_flags for dcesrv_call_state structs */
 254         uint32_t state_flags;
 255
 256         struct {
 257                 void *private_data;
 258                 void (*report_output_data)(struct dcesrv_connection *);
 259         } transport;
 260
 261         struct tstream_context *stream;
 262         struct tevent_queue *send_queue;
 263
 264         const struct tsocket_address *local_address;
 265         const struct tsocket_address *remote_address;
 266
 267         /* the current authentication state */
 268         struct dcesrv_auth auth_state;
 269
 270         /*
 271          * remember which pdu types are allowed
 272          */
 273         bool allow_bind;
 274         bool allow_auth3;
 275         bool allow_alter;
 276         bool allow_request;
 277
 278         /* the association group the connection belongs to */
 279         struct dcesrv_assoc_group *assoc_group;
 280
 281         /* The maximum total payload of reassembled request pdus */
 282         size_t max_total_request_size;
 283
 284         /*
 285          * Our preferred transfer syntax.
 286          */
 287         const struct ndr_syntax_id *preferred_transfer;
 288
 289         /* the negotiated bind time features */
 290         uint16_t bind_time_features;
 291 };
 292
 293
 294 struct dcesrv_endpoint_server {
 295         /* this is the name of the endpoint server */
 296         const char *name;
 297
 298         /* this function should register endpoints and some other setup stuff,
 299          * it is called when the dcesrv_context gets initialized.
 300          */
 301         NTSTATUS (*init_server)(struct dcesrv_context *, const struct dcesrv_endpoint_server *);
 302
 303         /* this function can be used by other endpoint servers to
 304          * ask for a dcesrv_interface implementation
 305          * - iface must be reference to an already existing struct !
 306          */
 307         bool (*interface_by_uuid)(struct dcesrv_interface *iface, const struct GUID *, uint32_t);
 308
 309         /* this function can be used by other endpoint servers to
 310          * ask for a dcesrv_interface implementation
 311          * - iface must be reference to an already existeng struct !
 312          */
 313         bool (*interface_by_name)(struct dcesrv_interface *iface, const char *);
 314 };
 315
 316
 317 /* one association groups */
 318 struct dcesrv_assoc_group {
 319         /* the wire id */
 320         uint32_t id;
 321
 322         /* list of handles in this association group */
 323         struct dcesrv_handle *handles;
 324
 325         /* parent context */
 326         struct dcesrv_context *dce_ctx;
 327
 328         /* Remote association group ID (if proxied) */
 329         uint32_t proxied_id;
 330 };
 331
 332 /* server-wide context information for the dcerpc server */
 333 struct dcesrv_context {
 334         /*
 335          * The euid at startup time.
 336          *
 337          * This is required for DCERPC_AUTH_TYPE_NCALRPC_AS_SYSTEM
 338          */
 339         uid_t initial_euid;
 340
 341         /* the list of endpoints that have registered
 342          * by the configured endpoint servers
 343          */
 344         struct dcesrv_endpoint {
 345                 struct dcesrv_endpoint *next, *prev;
 346                 /* the type and location of the endpoint */
 347                 struct dcerpc_binding *ep_description;
 348                 /* the security descriptor for smb named pipes */
 349                 struct security_descriptor *sd;
 350                 /* the list of interfaces available on this endpoint */
 351                 struct dcesrv_if_list {
 352                         struct dcesrv_if_list *next, *prev;
 353                         struct dcesrv_interface iface;
 354                 } *interface_list;
 355
 356                 /*
 357                  * Should this service be run in a single process (so far only
 358                  * NETLOGON is not run in a single process)
 359                  */
 360                 bool use_single_process;
 361         } *endpoint_list;
 362
 363         /* loadparm context to use for this connection */
 364         struct loadparm_context *lp_ctx;
 365
 366         struct idr_context *assoc_groups_idr;
 367
 368         struct dcesrv_connection *broken_connections;
 369 };
 370
 371 /* this structure is used by modules to determine the size of some critical types */
 372 struct dcesrv_critical_sizes {
 373         int interface_version;
 374         int sizeof_dcesrv_context;
 375         int sizeof_dcesrv_endpoint;
 376         int sizeof_dcesrv_endpoint_server;
 377         int sizeof_dcesrv_interface;
 378         int sizeof_dcesrv_if_list;
 379         int sizeof_dcesrv_connection;
 380         int sizeof_dcesrv_call_state;
 381         int sizeof_dcesrv_auth;
 382         int sizeof_dcesrv_handle;
 383 };
 384
 385 struct model_ops;
 386
 387 NTSTATUS dcesrv_interface_register(struct dcesrv_context *dce_ctx,
 388                                    const char *ep_name,
 389                                    const struct dcesrv_interface *iface,
 390                                    const struct security_descriptor *sd);
 391 NTSTATUS dcerpc_register_ep_server(const struct dcesrv_endpoint_server *ep_server);
 392 NTSTATUS dcesrv_init_context(TALLOC_CTX *mem_ctx,
 393                                       struct loadparm_context *lp_ctx,
 394                                       const char **endpoint_servers, struct dcesrv_context **_dce_ctx);
 395 NTSTATUS dcesrv_endpoint_connect(struct dcesrv_context *dce_ctx,
 396                                  TALLOC_CTX *mem_ctx,
 397                                  const struct dcesrv_endpoint *ep,
 398                                  struct auth_session_info *session_info,
 399                                  struct tevent_context *event_ctx,
 400                                  struct imessaging_context *msg_ctx,
 401                                  struct server_id server_id,
 402                                  uint32_t state_flags,
 403                                  struct dcesrv_connection **_p);
 404
 405 NTSTATUS dcesrv_reply(struct dcesrv_call_state *call);
 406 struct dcesrv_handle *dcesrv_handle_new(struct dcesrv_connection_context *context,
 407                                         uint8_t handle_type);
 408
 409 struct dcesrv_handle *dcesrv_handle_fetch(
 410                                           struct dcesrv_connection_context *context,
 411                                           struct policy_handle *p,
 412                                           uint8_t handle_type);
 413
 414 const struct tsocket_address *dcesrv_connection_get_local_address(struct dcesrv_connection *conn);
 415 const struct tsocket_address *dcesrv_connection_get_remote_address(struct dcesrv_connection *conn);
 416
 417 NTSTATUS dcesrv_fetch_session_key(struct dcesrv_connection *p, DATA_BLOB *session_key);
 418
 419 /* a useful macro for generating a RPC fault in the backend code */
 420 #define DCESRV_FAULT(code) do { \
 421         dce_call->fault_code = code; \
 422         return r->out.result; \
 423 } while(0)
 424
 425 /* a useful macro for generating a RPC fault in the backend code */
 426 #define DCESRV_FAULT_VOID(code) do { \
 427         dce_call->fault_code = code; \
 428         return; \
 429 } while(0)
 430
 431 /* a useful macro for checking the validity of a dcerpc policy handle
 432    and giving the right fault code if invalid */
 433 #define DCESRV_CHECK_HANDLE(h) do {if (!(h)) DCESRV_FAULT(DCERPC_FAULT_CONTEXT_MISMATCH); } while (0)
 434
 435 /* this checks for a valid policy handle, and gives a fault if an
 436    invalid handle or retval if the handle is of the
 437    wrong type */
 438 #define DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, retval) do { \
 439         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), DCESRV_HANDLE_ANY); \
 440         DCESRV_CHECK_HANDLE(h); \
 441         if ((t) != DCESRV_HANDLE_ANY && (h)->wire_handle.handle_type != (t)) { \
 442                 return retval; \
 443         } \
 444 } while (0)
 445
 446 /* this checks for a valid policy handle and gives a dcerpc fault
 447    if its the wrong type of handle */
 448 #define DCESRV_PULL_HANDLE_FAULT(h, inhandle, t) do { \
 449         (h) = dcesrv_handle_fetch(dce_call->context, (inhandle), t); \
 450         DCESRV_CHECK_HANDLE(h); \
 451 } while (0)
 452
 453 #define DCESRV_PULL_HANDLE(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, NT_STATUS_INVALID_HANDLE)
 454 #define DCESRV_PULL_HANDLE_WERR(h, inhandle, t) DCESRV_PULL_HANDLE_RETVAL(h, inhandle, t, WERR_INVALID_HANDLE)
 455
 456 NTSTATUS dcesrv_add_ep(struct dcesrv_context *dce_ctx,
 457                        struct loadparm_context *lp_ctx,
 458                        struct dcesrv_endpoint *e,
 459                        struct tevent_context *event_ctx,
 460                        const struct model_ops *model_ops);
 461
 462 /**
 463  * retrieve credentials from a dce_call
 464  */
 465 _PUBLIC_ struct cli_credentials *dcesrv_call_credentials(struct dcesrv_call_state *dce_call);
 466
 467 /**
 468  * returns true if this is an authenticated call
 469  */
 470 _PUBLIC_ bool dcesrv_call_authenticated(struct dcesrv_call_state *dce_call);
 471
 472 /**
 473  * retrieve account_name for a dce_call
 474  */
 475 _PUBLIC_ const char *dcesrv_call_account_name(struct dcesrv_call_state *dce_call);
 476
 477 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_integrity(struct dcesrv_call_state *dce_call,
 478                                                           const struct dcesrv_interface *iface);
 479 _PUBLIC_ NTSTATUS dcesrv_interface_bind_require_privacy(struct dcesrv_call_state *dce_call,
 480                                                         const struct dcesrv_interface *iface);
 481 _PUBLIC_ NTSTATUS dcesrv_interface_bind_reject_connect(struct dcesrv_call_state *dce_call,
 482                                                        const struct dcesrv_interface *iface);
 483 _PUBLIC_ NTSTATUS dcesrv_interface_bind_allow_connect(struct dcesrv_call_state *dce_call,
 484                                                       const struct dcesrv_interface *iface);
 485
 486 #endif /* SAMBA_DCERPC_SERVER_H */