Refactoring: Make close_internal_rpc_pipe_hnd a talloc destructor
[samba.git] / source3 / include / ntdomain.h
index d02195b378b6a244123f1e2d76f5e4b5e9e9e272..da3dd14189391dcb2a40480b6ebe6fd35ab0a1b2 100644 (file)
@@ -4,10 +4,11 @@
    Copyright (C) Andrew Tridgell 1992-1997
    Copyright (C) Luke Kenneth Casson Leighton 1996-1997
    Copyright (C) Paul Ashton 1997
+   Copyright (C) Jeremy Allison 2000-2004
    
    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
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef _NT_DOMAIN_H /* _NT_DOMAIN_H */
 #define _NT_DOMAIN_H 
 
-/* dce/rpc support */
-#include "rpc_dce.h"
-
-/* miscellaneous structures / defines */
-#include "rpc_misc.h"
-
-#include "rpc_creds.h"
-
-#include "talloc.h"
-
 /*
  * A bunch of stuff that was put into smb.h
  * in the NTDOM branch - it didn't belong there.
  */
  
-typedef struct _prs_struct 
-{
-       BOOL io; /* parsing in or out of data stream */
+typedef struct _prs_struct {
+       bool io; /* parsing in or out of data stream */
        /* 
         * If the (incoming) data is big-endian. On output we are
         * always little-endian.
         */ 
-       BOOL bigendian_data;
+       bool bigendian_data;
        uint8 align; /* data alignment */
-       BOOL is_dynamic; /* Do we own this memory or not ? */
+       bool is_dynamic; /* Do we own this memory or not ? */
        uint32 data_offset; /* Current working offset into data. */
        uint32 buffer_size; /* Current allocated size of the buffer. */
        uint32 grow_size; /* size requested via prs_grow() calls */
        char *data_p; /* The buffer itself. */
        TALLOC_CTX *mem_ctx; /* When unmarshalling, use this.... */
+       const char *sess_key; /* If we have to do encrypt/decrypt on the fly. */
 } prs_struct;
 
 /*
@@ -83,7 +73,7 @@ typedef struct _output_data {
         * The current PDU being returned. This inclues
         * headers, data and authentication footer.
         */
-       unsigned char current_pdu[MAX_PDU_FRAG_LEN];
+       unsigned char current_pdu[RPC_MAX_PDU_FRAG_LEN];
 
        /* The amount of data in the current_pdu buffer. */
        uint32 current_pdu_len;
@@ -93,49 +83,47 @@ typedef struct _output_data {
 } output_data;
 
 typedef struct _input_data {
-    /*
-     * This is the current incoming pdu. The data here
-     * is collected via multiple writes until a complete
-     * pdu is seen, then the data is copied into the in_data
-     * structure. The maximum size of this is 0x1630 (MAX_PDU_FRAG_LEN).
-     */
-    unsigned char current_in_pdu[MAX_PDU_FRAG_LEN];
-
-    /*
-     * The amount of data needed to complete the in_pdu.
-     * If this is zero, then we are at the start of a new
-     * pdu.
-     */
-    uint32 pdu_needed_len;
-
-    /*
-     * The amount of data received so far in the in_pdu.
-     * If this is zero, then we are at the start of a new
-     * pdu.
-     */
-    uint32 pdu_received_len;
-
-    /*
-     * This is the collection of input data with all
-     * the rpc headers and auth footers removed.
-     * The maximum length of this (1Mb) is strictly enforced.
-     */
-    prs_struct data;
+       /*
+        * This is the current incoming pdu. The data here
+        * is collected via multiple writes until a complete
+        * pdu is seen, then the data is copied into the in_data
+        * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
+        */
+       unsigned char current_in_pdu[RPC_MAX_PDU_FRAG_LEN];
+
+       /*
+        * The amount of data needed to complete the in_pdu.
+        * If this is zero, then we are at the start of a new
+        * pdu.
+        */
+       uint32 pdu_needed_len;
+
+       /*
+        * The amount of data received so far in the in_pdu.
+        * If this is zero, then we are at the start of a new
+        * pdu.
+        */
+       uint32 pdu_received_len;
+
+       /*
+        * This is the collection of input data with all
+        * the rpc headers and auth footers removed.
+        * The maximum length of this (1Mb) is strictly enforced.
+        */
+       prs_struct data;
 } input_data;
 
 /*
  * Handle database - stored per pipe.
  */
 
-struct policy
-{
-    struct policy *next, *prev;
-
-    POLICY_HND pol_hnd;
+struct policy {
+       struct policy *next, *prev;
 
-    void *data_ptr;
-    void (*free_fn)(void *);
+       POLICY_HND pol_hnd;
 
+       void *data_ptr;
+       void (*free_fn)(void *);
 };
 
 struct handle_list {
@@ -145,99 +133,138 @@ struct handle_list {
 };
 
 /* Domain controller authentication protocol info */
-struct dcinfo
-{
-       DOM_CHAL clnt_chal; /* Initial challenge received from client */
-       DOM_CHAL srv_chal;  /* Initial server challenge */
-       DOM_CRED clnt_cred; /* Last client credential */
-       DOM_CRED srv_cred;  /* Last server credential */
+struct dcinfo {
+       uint32 sequence; /* "timestamp" from client. */
+       struct netr_Credential seed_chal;
+       struct netr_Credential clnt_chal; /* Client credential */
+       struct netr_Credential srv_chal;  /* Server credential */
  
-       uchar  sess_key[8]; /* Session key */
-       uchar  md4pw[16];   /* md4(machine password) */
+       unsigned char  sess_key[16]; /* Session key - 8 bytes followed by 8 zero bytes */
+       unsigned char  mach_pw[16];   /* md4(machine password) */
 
        fstring mach_acct;  /* Machine name we've authenticated. */
 
        fstring remote_machine;  /* Machine name we've authenticated. */
+       fstring domain;
+
+       bool challenge_sent;
+       bool authenticated;
+};
+
+typedef struct pipe_rpc_fns {
+
+       struct pipe_rpc_fns *next, *prev;
+       
+       /* RPC function table associated with the current rpc_bind (associated by context) */
+       
+       const struct api_struct *cmds;
+       int n_cmds;
+       uint32 context_id;
+       
+} PIPE_RPC_FNS;
+
+/*
+ * Different auth types we support.
+ * Can't keep in sync with wire values as spnego wraps different auth methods.
+ */
+
+enum pipe_auth_type { PIPE_AUTH_TYPE_NONE = 0, PIPE_AUTH_TYPE_NTLMSSP, PIPE_AUTH_TYPE_SCHANNEL,
+                       PIPE_AUTH_TYPE_SPNEGO_NTLMSSP, PIPE_AUTH_TYPE_KRB5, PIPE_AUTH_TYPE_SPNEGO_KRB5 };
+
+/* Possible auth levels - keep these in sync with the wire values. */
+enum pipe_auth_level { PIPE_AUTH_LEVEL_NONE = 0,
+                       PIPE_AUTH_LEVEL_CONNECT = 1,    /* We treat as NONE. */
+                       PIPE_AUTH_LEVEL_INTEGRITY = 5,  /* Sign. */
+                       PIPE_AUTH_LEVEL_PRIVACY = 6     /* Seal. */
+};
+
+/* auth state for krb5. */
+struct kerberos_auth_struct {
+       const char *service_principal;
+       DATA_BLOB session_key;
+};
 
-       BOOL challenge_sent;
-       BOOL got_session_key;
-       BOOL authenticated;
+/* auth state for schannel. */
+struct schannel_auth_struct {
+       unsigned char sess_key[16];
+       uint32 seq_num;
+};
 
+/* auth state for all bind types. */
+
+struct pipe_auth_data {
+       enum pipe_auth_type auth_type; /* switch for union below. */
+       enum pipe_auth_level auth_level;
+       union {
+               struct schannel_auth_struct *schannel_auth;
+               AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
+/*             struct kerberos_auth_struct *kerberos_auth; TO BE ADDED... */
+       } a_u;
+       void (*auth_data_free_func)(struct pipe_auth_data *);
 };
 
 /*
  * DCE/RPC-specific samba-internal-specific handling of data on
  * NamedPipes.
- *
  */
 
-typedef struct pipes_struct
-{
+typedef struct pipes_struct {
        struct pipes_struct *next, *prev;
 
-       connection_struct *conn;
-       uint16 vuid; /* points to the unauthenticated user that opened this pipe. */
+       char client_address[INET6_ADDRSTRLEN];
+
+       struct auth_serversupplied_info *server_info;
 
        fstring name;
        fstring pipe_srv_name;
-
+       
+       /* linked list of rpc dispatch tables associated 
+          with the open rpc contexts */
+          
+       PIPE_RPC_FNS *contexts;
+       
        RPC_HDR hdr; /* Incoming RPC header. */
        RPC_HDR_REQ hdr_req; /* Incoming request header. */
 
-       uint32 ntlmssp_chal_flags; /* Client challenge flags. */
-       BOOL ntlmssp_auth_requested; /* If the client wanted authenticated rpc. */
-       BOOL ntlmssp_auth_validated; /* If the client *got* authenticated rpc. */
-       unsigned char challenge[8];
-       unsigned char ntlmssp_hash[258];
-       uint32 ntlmssp_seq_num;
-       struct dcinfo dc; /* Keeps the creds data. */
+       struct pipe_auth_data auth;
 
-        /* Hmm. In my understanding the authentication happens
-           implicitly later, so there are no two stages for
-           schannel. */
-
-       BOOL netsec_auth_validated;
-       struct netsec_auth_struct netsec_auth;
-
-       /*
-        * Windows user info.
-        */
-       fstring user_name;
-       fstring domain;
-       fstring wks;
+       struct dcinfo *dc; /* Keeps the creds data from netlogon. */
 
        /*
-        * Unix user name and credentials.
+        * Unix user name and credentials used when a pipe is authenticated.
         */
 
-       fstring pipe_user_name;
        struct current_user pipe_user;
-
-       uint8 session_key[16];
-
        /*
         * Set to true when an RPC bind has been done on this pipe.
         */
        
-       BOOL pipe_bound;
+       bool pipe_bound;
        
        /*
         * Set to true when we should return fault PDU's for everything.
         */
        
-       BOOL fault_state;
+       bool fault_state;
 
        /*
         * Set to true when we should return fault PDU's for a bad handle.
         */
 
-       BOOL bad_handle_fault_state;
+       bool bad_handle_fault_state;
+
+       /*
+        * Set to true when the backend does not support a call.
+        */
+
+       bool rng_fault_state;
        
        /*
         * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
         */
        
-       BOOL endian;
+       bool endian;
        
        /*
         * Struct to deal with multiple pdu inputs.
@@ -251,7 +278,8 @@ typedef struct pipes_struct
 
        output_data out_data;
 
-       /* talloc context to use when allocating memory on this pipe. */
+       /* This context is used for PDU data and is freed between each pdu.
+               Don't use for pipe state storage. */
        TALLOC_CTX *mem_ctx;
 
        /* handle database to use on this pipe. */
@@ -259,16 +287,15 @@ typedef struct pipes_struct
 
 } pipes_struct;
 
-typedef struct smb_np_struct
-{
+typedef struct smb_np_struct {
        struct smb_np_struct *next, *prev;
        int pnum;
        connection_struct *conn;
        uint16 vuid; /* points to the unauthenticated user that opened this pipe. */
-       BOOL open; /* open connection */
+       bool open; /* open connection */
        uint16 device_state;
        uint16 priority;
-       fstring name;
+       char *name;
 
        /* When replying to an SMBtrans, this is the maximum amount of
            data that can be sent in the initial reply. */
@@ -291,19 +318,11 @@ typedef struct smb_np_struct
         * returns: state information representing the connection.
         *          is stored in np_state, above.
         */
-       void *   (*namedpipe_create)(char *pipe_name, 
-                                         connection_struct *conn, uint16 vuid);
-
-       /* call to perform a write / read namedpipe transaction.
-        * TransactNamedPipe is weird: it returns whether there
-        * is more data outstanding to be read, and the
-        * caller is expected to take note and follow up with
-        * read requests.
-        */
-       ssize_t  (*namedpipe_transact)(void *np_state,
-                                      char *data, int len,
-                                      char *rdata, int rlen,
-                                      BOOL *pipe_outstanding);
+       struct pipes_struct *(*namedpipe_create)(
+               const char *pipe_name,
+               const char *client_address,
+               struct auth_serversupplied_info *server_info,
+               uint16_t vuid);
 
        /* call to perform a write namedpipe operation
         */
@@ -323,40 +342,21 @@ typedef struct smb_np_struct
         */
        ssize_t  (*namedpipe_read)(void * np_state,
                                   char *data, size_t max_len,
-                                  BOOL *pipe_outstanding);
-
-       /* call to close a namedpipe.
-        * function is expected to perform all cleanups
-        * necessary, free all memory etc.
-        *
-        * returns True if cleanup was successful (not that
-        * we particularly care).
-        */
-       BOOL     (*namedpipe_close)(void * np_state);
+                                  bool *pipe_outstanding);
 
 } smb_np_struct;
 
-struct api_struct
-{  
-  const char *name;
-  uint8 opnum;
-  BOOL (*fn) (pipes_struct *);
+struct api_struct {  
+       const char *name;
+       uint8 opnum;
+       bool (*fn) (pipes_struct *);
 };
 
-typedef struct
-{  
+typedef struct {  
        uint32 rid;
        const char *name;
-
 } rid_name;
 
-struct acct_info
-{
-    fstring acct_name; /* account name */
-    fstring acct_desc; /* account name */
-    uint32 rid; /* domain-relative RID */
-};
-
 /*
  * higher order functions for use with msrpc client code
  */
@@ -368,19 +368,11 @@ struct acct_info
 
 /* end higher order functions */
 
-
-/* security descriptor structures */
-#include "rpc_secdes.h"
-
-/* different dce/rpc pipes */
-#include "rpc_lsa.h"
-#include "rpc_netlogon.h"
-#include "rpc_reg.h"
-#include "rpc_samr.h"
-#include "rpc_srvsvc.h"
-#include "rpc_wkssvc.h"
-#include "rpc_spoolss.h"
-#include "rpc_dfs.h"
-#include "rpc_ds.h"
+typedef struct {
+       uint32 size;
+       prs_struct prs;
+       uint32 struct_start;
+       uint32 string_at_end;
+} RPC_BUFFER;
 
 #endif /* _NT_DOMAIN_H */