r4627: - simplified the dcerpc auth code using a common function
[samba.git] / source4 / librpc / rpc / dcerpc.h
index 5d258820418f2a7417f90e8ccc31ddf50ab61922..289e17fb81b6f21b8f25d7d7e3c913630610415e 100644 (file)
@@ -1,9 +1,10 @@
 /* 
    Unix SMB/CIFS implementation.
-   DCERPC interface structures
+
+   DCERPC client side interface structures
 
    Copyright (C) Tim Potter 2003
-   Copyright (C) Andrew Tridgell 2003
+   Copyright (C) Andrew Tridgell 2003-2005
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
-/*
-  see http://www.opengroup.org/onlinepubs/9629399/chap12.htm for details
-  of these structures
+enum dcerpc_transport_t {
+       NCACN_NP, NCACN_IP_TCP, NCACN_IP_UDP, NCACN_VNS_IPC, NCACN_VNS_SPP, 
+       NCACN_AT_DSP, NCADG_AT_DDP, NCALRPC, NCACN_UNIX_STREAM, NCADG_UNIX_DGRAM,
+       NCACN_HTTP, NCADG_IPX, NCACN_SPX };
 
-  note that the structure definitions here don't include some of the
-  fields that are wire-artifacts. Those are put on the wire by the
-  marshalling/unmarshalling routines in decrpc.c
+/*
+  this defines a generic security context for signed/sealed dcerpc pipes.
 */
-
-struct dcerpc_pipe {
-       TALLOC_CTX *mem_ctx;
-       int reference_count;
-       uint32 call_id;
-       uint32 srv_max_xmit_frag;
-       uint32 srv_max_recv_frag;
-       unsigned flags;
-       struct ntlmssp_state *ntlmssp_state;
+struct dcerpc_connection;
+struct dcerpc_security {
        struct dcerpc_auth *auth_info;
+       struct gensec_security *generic_state;
+
+       /* get the session key */
+       NTSTATUS (*session_key)(struct dcerpc_connection *, DATA_BLOB *);
+};
+
+/*
+  this holds the information that is not specific to a particular rpc context_id
+*/
+struct dcerpc_connection {
+       uint32_t call_id;
+       uint32_t srv_max_xmit_frag;
+       uint32_t srv_max_recv_frag;
+       uint_t flags;
+       struct dcerpc_security security_state;
+       const char *binding_string;
 
        struct dcerpc_transport {
+               enum dcerpc_transport_t transport;
                void *private;
-               NTSTATUS (*full_request)(struct dcerpc_pipe *, 
-                                        TALLOC_CTX *, DATA_BLOB *, DATA_BLOB *);
-               NTSTATUS (*secondary_request)(struct dcerpc_pipe *, TALLOC_CTX *, DATA_BLOB *);
-               NTSTATUS (*initial_request)(struct dcerpc_pipe *, TALLOC_CTX *, DATA_BLOB *);
-               NTSTATUS (*shutdown_pipe)(struct dcerpc_pipe *);
-               const char *(*peer_name)(struct dcerpc_pipe *);
+
+               NTSTATUS (*shutdown_pipe)(struct dcerpc_connection *);
+
+               const char *(*peer_name)(struct dcerpc_connection *);
+
+               /* send a request to the server */
+               NTSTATUS (*send_request)(struct dcerpc_connection *, DATA_BLOB *, BOOL trigger_read);
+
+               /* send a read request to the server */
+               NTSTATUS (*send_read)(struct dcerpc_connection *);
+
+               /* get an event context for the connection */
+               struct event_context *(*event_context)(struct dcerpc_connection *);
+
+               /* a callback to the dcerpc code when a full fragment
+                  has been received */
+               void (*recv_data)(struct dcerpc_connection *, DATA_BLOB *, NTSTATUS status);
        } transport;
 
+       /* pending requests */
+       struct rpc_request *pending;
+
+       /* private pointer for pending full requests */
+       void *full_request_private;
+
+       /* the next context_id to be assigned */
+       uint32_t next_context_id;
+};
+
+/*
+  this encapsulates a full dcerpc client side pipe 
+*/
+struct dcerpc_pipe {
+       uint32_t context_id;
+
+       struct dcerpc_syntax_id syntax;
+       struct dcerpc_syntax_id transfer_syntax;
+
+       struct dcerpc_connection *conn;
+
        /* the last fault code from a DCERPC fault */
-       uint32 last_fault_code;
+       uint32_t last_fault_code;
 };
 
+
 /* dcerpc pipe flags */
-#define DCERPC_DEBUG_PRINT_IN  (1<<0)
-#define DCERPC_DEBUG_PRINT_OUT (1<<1)
+#define DCERPC_DEBUG_PRINT_IN          (1<<0)
+#define DCERPC_DEBUG_PRINT_OUT         (1<<1)
 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
 
-#define DCERPC_DEBUG_VALIDATE_IN  4
-#define DCERPC_DEBUG_VALIDATE_OUT 8
+#define DCERPC_DEBUG_VALIDATE_IN       (1<<2)
+#define DCERPC_DEBUG_VALIDATE_OUT      (1<<3)
 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
 
-#define DCERPC_SIGN            16
-#define DCERPC_SEAL            32
+#define DCERPC_CONNECT                 (1<<4)
+#define DCERPC_SIGN                    (1<<5)
+#define DCERPC_SEAL                    (1<<6)
+
+#define DCERPC_PUSH_BIGENDIAN          (1<<7)
+#define DCERPC_PULL_BIGENDIAN          (1<<8)
+
+#define DCERPC_SCHANNEL_BDC            (1<<9)
+#define DCERPC_SCHANNEL_WORKSTATION    (1<<10)
+#define DCERPC_SCHANNEL_DOMAIN         (1<<11)
+#define DCERPC_SCHANNEL_ANY            (DCERPC_SCHANNEL_BDC| \
+                                       DCERPC_SCHANNEL_DOMAIN| \
+                                       DCERPC_SCHANNEL_WORKSTATION)
+
+#define DCERPC_AUTH_OPTIONS    (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL_ANY)
+
+/* use a 128 bit session key */
+#define DCERPC_SCHANNEL_128            (1<<12)
+
+/* check incoming pad bytes */
+#define DCERPC_DEBUG_PAD_CHECK         (1<<13)
+
+/* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
+#define DCERPC_NDR_REF_ALLOC           (1<<14)
 
-#define DCERPC_PUSH_BIGENDIAN   64
-#define DCERPC_PULL_BIGENDIAN  128
+/* enable spnego auth */
+#define DCERPC_AUTH_SPNEGO             (1<<15)
 
 /*
   this is used to find pointers to calls
@@ -80,26 +146,65 @@ struct dcerpc_interface_call {
 };
 
 struct dcerpc_endpoint_list {
-       uint32 count;
-       const char **names;
+       uint32_t count;
+       const char * const *names;
 };
 
 struct dcerpc_interface_table {
        const char *name;
        const char *uuid;
-       uint32 if_version;
-       uint32 num_calls;
+       uint32_t if_version;
+       const char *helpstring;
+       uint32_t num_calls;
        const struct dcerpc_interface_call *calls;
        const struct dcerpc_endpoint_list *endpoints;
 };
 
-
-enum dcerpc_transport_t {NCACN_NP, NCACN_IP_TCP};
+struct dcerpc_interface_list {
+       struct dcerpc_interface_list *prev, *next;
+       const struct dcerpc_interface_table *table;
+};
 
 /* this describes a binding to a particular transport/pipe */
 struct dcerpc_binding {
        enum dcerpc_transport_t transport;
+       struct GUID object;
+       int object_version;
        const char *host;
+       const char *endpoint;
        const char **options;
-       uint32 flags;
+       uint32_t flags;
+};
+
+
+enum rpc_request_state {
+       RPC_REQUEST_PENDING,
+       RPC_REQUEST_DONE
+};
+
+/*
+  handle for an async dcerpc request
+*/
+struct rpc_request {
+       struct rpc_request *next, *prev;
+       struct dcerpc_pipe *p;
+       NTSTATUS status;
+       uint32_t call_id;
+       enum rpc_request_state state;
+       DATA_BLOB payload;
+       uint_t flags;
+       uint32_t fault_code;
+
+       /* use by the ndr level async recv call */
+       struct {
+               const struct dcerpc_interface_table *table;
+               uint32_t opnum;
+               void *struct_ptr;
+               TALLOC_CTX *mem_ctx;
+       } ndr;
+
+       struct {
+               void (*callback)(struct rpc_request *);
+               void *private;
+       } async;
 };