source3/include/client.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup
   4    Copyright (C) Andrew Tridgell 1992-1998
   5    Copyright (C) Luke Kenneth Casson Leighton 1996-1998
   6    Copyright (C) Jeremy Allison 1998
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #ifndef _CLIENT_H
  23 #define _CLIENT_H
  24
  25 /* the client asks for a smaller buffer to save ram and also to get more
  26    overlap on the wire. This size gives us a nice read/write size, which
  27    will be a multiple of the page size on almost any system */
  28 #define CLI_BUFFER_SIZE (0xFFFF)
  29 #define CLI_SAMBA_MAX_LARGE_READX_SIZE (127*1024) /* Works for Samba servers */
  30 #define CLI_SAMBA_MAX_LARGE_WRITEX_SIZE (127*1024) /* Works for Samba servers */
  31 #define CLI_WINDOWS_MAX_LARGE_READX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
  32 #define CLI_WINDOWS_MAX_LARGE_WRITEX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
  33 #define CLI_SAMBA_MAX_POSIX_LARGE_READX_SIZE (0xFFFF00) /* 24-bit len. */
  34 #define CLI_SAMBA_MAX_POSIX_LARGE_WRITEX_SIZE (0xFFFF00) /* 24-bit len. */
  35
  36 /*
  37  * These definitions depend on smb.h
  38  */
  39
  40 struct print_job_info {
  41         uint16 id;
  42         uint16 priority;
  43         size_t size;
  44         fstring user;
  45         fstring name;
  46         time_t t;
  47 };
  48
  49 struct cli_state {
  50         /**
  51          * A list of subsidiary connections for DFS.
  52          */
  53         struct cli_state *prev, *next;
  54         enum protocol_types protocol;
  55         int sec_mode;
  56         int rap_error;
  57         NTSTATUS raw_status; /* maybe via NT_STATUS_DOS() */
  58
  59         /* The credentials used to open the cli_state connection. */
  60         char *domain;
  61         char *user_name;
  62         char *password; /* Can be null to force use of zero NTLMSSP session key. */
  63
  64         /*
  65          * The following strings are the
  66          * ones returned by the server if
  67          * the protocol > NT1.
  68          */
  69         char *server_type;
  70         char *server_os;
  71         char *server_domain;
  72
  73         char *share;
  74         char *dev;
  75
  76         DATA_BLOB secblob; /* cryptkey or negTokenInit */
  77         uint32 sesskey;
  78         int serverzone;
  79         uint32 servertime;
  80         int readbraw_supported;
  81         int writebraw_supported;
  82         int timeout; /* in milliseconds. */
  83         size_t max_xmit;
  84         size_t max_mux;
  85         int initialised;
  86         int win95;
  87         bool is_samba;
  88         bool is_guestlogin;
  89         uint32 capabilities;
  90         /* What the server offered. */
  91         uint32_t server_posix_capabilities;
  92         /* What the client requested. */
  93         uint32_t requested_posix_capabilities;
  94         bool dfsroot;
  95
  96         struct smb_signing_state *signing_state;
  97
  98         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
  99
 100         /* the session key for this CLI, outside
 101            any per-pipe authenticaion */
 102         DATA_BLOB user_session_key;
 103
 104         /* The list of pipes currently open on this connection. */
 105         struct rpc_pipe_client *pipe_list;
 106
 107         bool use_kerberos;
 108         bool fallback_after_kerberos;
 109         bool use_spnego;
 110         bool use_ccache;
 111         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
 112
 113         bool use_oplocks; /* should we use oplocks? */
 114         bool use_level_II_oplocks; /* should we use level II oplocks? */
 115
 116         bool force_dos_errors;
 117         bool force_ascii;
 118         bool case_sensitive; /* False by default. */
 119
 120         /* Where (if anywhere) this is mounted under DFS. */
 121         char *dfs_mountpoint;
 122
 123         struct {
 124                 int fd;
 125                 struct sockaddr_storage local_ss;
 126                 struct sockaddr_storage remote_ss;
 127                 const char *remote_name;
 128                 const char *remote_realm;
 129                 struct tevent_req *read_smb_req;
 130                 struct tevent_queue *outgoing;
 131                 struct tevent_req **pending;
 132                 /*
 133                  * The incoming dispatch function should return:
 134                  * - NT_STATUS_RETRY, if more incoming PDUs are expected.
 135                  * - NT_STATUS_OK, if no more processing is desired, e.g.
 136                  *                 the dispatch function called
 137                  *                 tevent_req_done().
 138                  * - All other return values disconnect the connection.
 139                  */
 140                 NTSTATUS (*dispatch_incoming)(struct cli_state *cli,
 141                                               TALLOC_CTX *frame,
 142                                               uint8_t *inbuf);
 143         } conn;
 144
 145         struct {
 146                 uint16_t mid;
 147                 uint16_t pid;
 148                 uint16_t vc_num;
 149                 uint16_t tid;
 150                 uint16_t uid;
 151         } smb1;
 152
 153         struct {
 154                 uint64_t mid;
 155                 uint32_t pid;
 156                 uint32_t tid;
 157                 uint64_t uid;
 158
 159                 /* SMB2 negprot */
 160                 uint16_t security_mode;
 161                 uint16_t dialect_revision;
 162                 struct GUID server_guid;
 163                 uint16_t server_capabilities;
 164                 uint32_t max_transact_size;
 165                 uint32_t max_read_size;
 166                 uint32_t max_write_size;
 167                 struct timespec system_time;
 168                 struct timespec server_start_time;
 169
 170                 /* SMB2 tcon */
 171                 uint8_t share_type;
 172                 uint32_t share_flags;
 173                 uint32_t maximal_access;
 174         } smb2;
 175 };
 176
 177 struct file_info {
 178         uint64_t size;
 179         uint16 mode;
 180         uid_t uid;
 181         gid_t gid;
 182         /* these times are normally kept in GMT */
 183         struct timespec mtime_ts;
 184         struct timespec atime_ts;
 185         struct timespec ctime_ts;
 186         char *name;
 187         char *short_name;
 188 };
 189
 190 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
 191 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
 192 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
 193 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
 194 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
 195 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
 196 #define CLI_FULL_CONNECTION_USE_CCACHE 0x0040
 197 #define CLI_FULL_CONNECTION_FORCE_DOS_ERRORS 0x0080
 198 #define CLI_FULL_CONNECTION_FORCE_ASCII 0x0100
 199
 200 #endif /* _CLIENT_H */