s3:libsmb: use new simplified smb_signing code for the client side
[jra/samba/.git] / source3 / include / client.h
index a89e39d160586b1433f251bd4b3af8ae4be08a45..db19f34a9dea0f0cc7e934c3f1878cb8e22d489d 100644 (file)
@@ -7,7 +7,7 @@
 
    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,
@@ -16,8 +16,7 @@
    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 _CLIENT_H
    will be a multiple of the page size on almost any system */
 #define CLI_BUFFER_SIZE (0xFFFF)
 #define CLI_SAMBA_MAX_LARGE_READX_SIZE (127*1024) /* Works for Samba servers */
+#define CLI_SAMBA_MAX_LARGE_WRITEX_SIZE (127*1024) /* Works for Samba servers */
 #define CLI_WINDOWS_MAX_LARGE_READX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
+#define CLI_WINDOWS_MAX_LARGE_WRITEX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
+#define CLI_SAMBA_MAX_POSIX_LARGE_READX_SIZE (0xFFFF00) /* 24-bit len. */
+#define CLI_SAMBA_MAX_POSIX_LARGE_WRITEX_SIZE (0xFFFF00) /* 24-bit len. */
 
 /*
  * These definitions depend on smb.h
  */
 
-typedef struct file_info
-{
-       SMB_BIG_UINT size;
-       uint16 mode;
-       uid_t uid;
-       gid_t gid;
-       /* these times are normally kept in GMT */
-       struct timespec mtime_ts;
-       struct timespec atime_ts;
-       struct timespec ctime_ts;
-       pstring name;
-       pstring dir;
-       char short_name[13*3]; /* the *3 is to cope with multi-byte */
-} file_info;
-
-struct print_job_info
-{
+struct print_job_info {
        uint16 id;
        uint16 priority;
        size_t size;
@@ -62,42 +49,139 @@ struct print_job_info
 struct cli_pipe_auth_data {
        enum pipe_auth_type auth_type; /* switch for the union below. Defined in ntdomain.h */
        enum pipe_auth_level auth_level; /* defined in ntdomain.h */
+
+       char *domain;
+       char *user_name;
+       DATA_BLOB user_session_key;
+
        union {
                struct schannel_auth_struct *schannel_auth;
                NTLMSSP_STATE *ntlmssp_state;
                struct kerberos_auth_struct *kerberos_auth;
        } a_u;
-       void (*cli_auth_data_free_func)(struct cli_pipe_auth_data *);
+};
+
+/**
+ * rpc_cli_transport defines a transport mechanism to ship rpc requests
+ * asynchronously to a server and receive replies
+ */
+
+struct rpc_cli_transport {
+
+       /**
+        * Trigger an async read from the server. May return a short read.
+        */
+       struct async_req *(*read_send)(TALLOC_CTX *mem_ctx,
+                                      struct event_context *ev,
+                                       uint8_t *data, size_t size,
+                                      void *priv);
+       /**
+        * Get the result from the read_send operation.
+        */
+       NTSTATUS (*read_recv)(struct async_req *req, ssize_t *preceived);
+
+       /**
+        * Trigger an async write to the server. May return a short write.
+        */
+       struct async_req *(*write_send)(TALLOC_CTX *mem_ctx,
+                                       struct event_context *ev,
+                                       const uint8_t *data, size_t size,
+                                       void *priv);
+       /**
+        * Get the result from the read_send operation.
+        */
+       NTSTATUS (*write_recv)(struct async_req *req, ssize_t *psent);
+
+       /**
+        * This is an optimization for the SMB transport. It models the
+        * TransactNamedPipe API call: Send and receive data in one round
+        * trip. The transport implementation is free to set this to NULL,
+        * cli_pipe.c will fall back to the explicit write/read routines.
+        */
+       struct async_req *(*trans_send)(TALLOC_CTX *mem_ctx,
+                                       struct event_context *ev,
+                                       uint8_t *data, size_t data_len,
+                                       uint32_t max_rdata_len,
+                                       void *priv);
+       /**
+        * Get the result from the trans_send operation.
+        */
+       NTSTATUS (*trans_recv)(struct async_req *req, TALLOC_CTX *mem_ctx,
+                              uint8_t **prdata, uint32_t *prdata_len);
+       void *priv;
 };
 
 struct rpc_pipe_client {
        struct rpc_pipe_client *prev, *next;
 
-       TALLOC_CTX *mem_ctx;
+       struct rpc_cli_transport *transport;
 
-       struct cli_state *cli;
+       struct ndr_syntax_id abstract_syntax;
+       struct ndr_syntax_id transfer_syntax;
 
-       int pipe_idx;
-       const char *pipe_name;
-       uint16 fnum;
+       NTSTATUS (*dispatch) (struct rpc_pipe_client *cli,
+                       TALLOC_CTX *mem_ctx,
+                       const struct ndr_interface_table *table,
+                       uint32_t opnum, void *r);
 
-       const char *domain;
-       const char *user_name;
-       struct pwd_info pwd;
+       char *desthost;
+       char *srv_name_slash;
 
        uint16 max_xmit_frag;
        uint16 max_recv_frag;
 
-       struct cli_pipe_auth_data auth;
+       struct cli_pipe_auth_data *auth;
 
        /* The following is only non-null on a netlogon pipe. */
        struct dcinfo *dc;
+
+       /* Used by internal rpc_pipe_client */
+       pipes_struct *pipes_struct;
+};
+
+/* Transport encryption state. */
+enum smb_trans_enc_type {
+               SMB_TRANS_ENC_NTLM
+#if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
+               , SMB_TRANS_ENC_GSS
+#endif
+};
+
+#if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
+struct smb_tran_enc_state_gss {
+        gss_ctx_id_t gss_ctx;
+        gss_cred_id_t creds;
+};
+#endif
+
+struct smb_trans_enc_state {
+        enum smb_trans_enc_type smb_enc_type;
+        uint16 enc_ctx_num;
+        bool enc_on;
+        union {
+                NTLMSSP_STATE *ntlmssp_state;
+#if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
+                struct smb_tran_enc_state_gss *gss_state;
+#endif
+        } s;
+};
+
+struct cli_state_seqnum {
+       struct cli_state_seqnum *prev, *next;
+       uint16_t mid;
+       uint32_t seqnum;
+       bool persistent;
 };
 
 struct cli_state {
+       /**
+        * A list of subsidiary connections for DFS.
+        */
+        struct cli_state *prev, *next;
        int port;
        int fd;
-       int smb_rw_error; /* Copy of last read or write error. */
+       /* Last read or write error. */
+       enum smb_read_errors smb_rw_error;
        uint16 cnum;
        uint16 pid;
        uint16 mid;
@@ -110,9 +194,9 @@ struct cli_state {
        fstring desthost;
 
        /* The credentials used to open the cli_state connection. */
-       fstring domain;
-       fstring user_name;
-       struct pwd_info pwd;
+       char *domain;
+       char *user_name;
+       char *password; /* Can be null to force use of zero NTLMSSP session key. */
 
        /*
         * The following strings are the
@@ -128,7 +212,7 @@ struct cli_state {
        struct nmb_name called;
        struct nmb_name calling;
        fstring full_dest_host_name;
-       struct in_addr dest_ip;
+       struct sockaddr_storage dest_ss;
 
        DATA_BLOB secblob; /* cryptkey or negTokenInit */
        uint32 sesskey;
@@ -140,41 +224,92 @@ struct cli_state {
        size_t max_xmit;
        size_t max_mux;
        char *outbuf;
+       struct cli_state_seqnum *seqnum;
        char *inbuf;
        unsigned int bufsize;
        int initialised;
        int win95;
-       BOOL is_samba;
+       bool is_samba;
        uint32 capabilities;
-       BOOL dfsroot;
+       uint32 posix_capabilities;
+       bool dfsroot;
+
+#if 0
+       TALLOC_CTX *longterm_mem_ctx;
+       TALLOC_CTX *call_mem_ctx;
+#endif
 
-       TALLOC_CTX *mem_ctx;
+       struct smb_signing_state *signing_state;
 
-       smb_sign_info sign_info;
+       struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
 
-       /* the session key for this CLI, outside 
+       /* the session key for this CLI, outside
           any per-pipe authenticaion */
        DATA_BLOB user_session_key;
 
        /* The list of pipes currently open on this connection. */
        struct rpc_pipe_client *pipe_list;
 
-       BOOL use_kerberos;
-       BOOL fallback_after_kerberos;
-       BOOL use_spnego;
+       bool use_kerberos;
+       bool fallback_after_kerberos;
+       bool use_spnego;
+       bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
 
-       BOOL use_oplocks; /* should we use oplocks? */
-       BOOL use_level_II_oplocks; /* should we use level II oplocks? */
+       bool use_oplocks; /* should we use oplocks? */
+       bool use_level_II_oplocks; /* should we use level II oplocks? */
 
        /* a oplock break request handler */
-       BOOL (*oplock_handler)(struct cli_state *cli, int fnum, unsigned char level);
+       bool (*oplock_handler)(struct cli_state *cli, int fnum, unsigned char level);
+
+       bool force_dos_errors;
+       bool case_sensitive; /* False by default. */
+
+       /**
+        * fd_event is around while we have async requests outstanding or are
+        * building a chained request.
+        *
+        * (fd_event!=NULL) &&
+        *  ((outstanding_request!=NULL)||(chain_accumulator!=NULL))
+        *
+        * should always be true, as well as the reverse: If both cli_request
+        * pointers are NULL, no fd_event is around.
+        */
+       struct fd_event *fd_event;
+       char *evt_inbuf;
+
+       /**
+        * A linked list of requests that are waiting for a reply
+        */
+       struct cli_request *outstanding_requests;
 
-       BOOL force_dos_errors;
-       BOOL case_sensitive; /* False by default. */
+       /**
+        * The place to build up the list of chained requests. In CIFS, a
+        * single cli_request corresponds to a MID and can serve more than one
+        * chained async_req.
+        */
+       struct cli_request *chain_accumulator;
+
+       /* Where (if anywhere) this is mounted under DFS. */
+       char *dfs_mountpoint;
 };
 
+typedef struct file_info {
+       struct cli_state *cli;
+       uint64_t size;
+       uint16 mode;
+       uid_t uid;
+       gid_t gid;
+       /* these times are normally kept in GMT */
+       struct timespec mtime_ts;
+       struct timespec atime_ts;
+       struct timespec ctime_ts;
+       char *name;
+       char short_name[13*3]; /* the *3 is to cope with multi-byte */
+} file_info;
+
 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
-#define CLI_FULL_CONNECTION_ANNONYMOUS_FALLBACK 0x0004
+#define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
+#define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
 
 #endif /* _CLIENT_H */