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