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 #define CLI_BUFFER_SIZE (0xFFFF)
  26
  27 /*
  28  * These definitions depend on smb.h
  29  */
  30
  31 struct print_job_info {
  32         uint16 id;
  33         uint16 priority;
  34         size_t size;
  35         fstring user;
  36         fstring name;
  37         time_t t;
  38 };
  39
  40 struct cli_state {
  41         /**
  42          * A list of subsidiary connections for DFS.
  43          */
  44         struct cli_state *prev, *next;
  45         int rap_error;
  46         NTSTATUS raw_status; /* maybe via NT_STATUS_DOS() */
  47
  48         /* The credentials used to open the cli_state connection. */
  49         char *domain;
  50         char *user_name;
  51         char *password; /* Can be null to force use of zero NTLMSSP session key. */
  52
  53         /*
  54          * The following strings are the
  55          * ones returned by the server if
  56          * the protocol > NT1.
  57          */
  58         char *server_type;
  59         char *server_os;
  60         char *server_domain;
  61
  62         char *share;
  63         char *dev;
  64
  65         int timeout; /* in milliseconds. */
  66         int initialised;
  67         int win95;
  68         bool is_guestlogin;
  69         /* What the server offered. */
  70         uint32_t server_posix_capabilities;
  71         /* What the client requested. */
  72         uint32_t requested_posix_capabilities;
  73         bool dfsroot;
  74
  75         struct smb_signing_state *signing_state;
  76
  77         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
  78
  79         /* the session key for this CLI, outside
  80            any per-pipe authenticaion */
  81         DATA_BLOB user_session_key;
  82
  83         /* The list of pipes currently open on this connection. */
  84         struct rpc_pipe_client *pipe_list;
  85
  86         bool use_kerberos;
  87         bool fallback_after_kerberos;
  88         bool use_ccache;
  89         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
  90
  91         bool use_oplocks; /* should we use oplocks? */
  92
  93         bool case_sensitive; /* False by default. */
  94
  95         /* Where (if anywhere) this is mounted under DFS. */
  96         char *dfs_mountpoint;
  97
  98         struct {
  99                 int fd;
 100                 struct sockaddr_storage local_ss;
 101                 struct sockaddr_storage remote_ss;
 102                 const char *remote_name;
 103                 const char *remote_realm;
 104                 struct tevent_req *read_smb_req;
 105                 struct tevent_queue *outgoing;
 106                 struct tevent_req **pending;
 107                 /*
 108                  * The incoming dispatch function should return:
 109                  * - NT_STATUS_RETRY, if more incoming PDUs are expected.
 110                  * - NT_STATUS_OK, if no more processing is desired, e.g.
 111                  *                 the dispatch function called
 112                  *                 tevent_req_done().
 113                  * - All other return values disconnect the connection.
 114                  */
 115                 NTSTATUS (*dispatch_incoming)(struct cli_state *cli,
 116                                               TALLOC_CTX *frame,
 117                                               uint8_t *inbuf);
 118
 119                 enum protocol_types protocol;
 120
 121                 struct {
 122                         struct {
 123                                 uint32_t capabilities;
 124                                 uint32_t max_xmit;
 125                         } client;
 126
 127                         struct {
 128                                 uint32_t capabilities;
 129                                 uint32_t max_xmit;
 130                                 uint16_t max_mux;
 131                                 uint16_t security_mode;
 132                                 bool readbraw;
 133                                 bool writebraw;
 134                                 bool lockread;
 135                                 bool writeunlock;
 136                                 uint32_t session_key;
 137                                 struct GUID guid;
 138                                 DATA_BLOB gss_blob;
 139                                 uint8_t challenge[8];
 140                                 const char *workgroup;
 141                                 const char *name;
 142                                 int time_zone;
 143                                 time_t system_time;
 144                         } server;
 145
 146                         uint32_t capabilities;
 147                         uint32_t max_xmit;
 148
 149                         uint16_t mid;
 150                 } smb1;
 151         } conn;
 152
 153         struct {
 154                 uint16_t pid;
 155                 uint16_t vc_num;
 156                 uint16_t tid;
 157                 uint16_t uid;
 158         } smb1;
 159
 160         struct {
 161                 uint64_t mid;
 162                 uint32_t pid;
 163                 uint32_t tid;
 164                 uint64_t uid;
 165
 166                 /* SMB2 negprot */
 167                 uint16_t security_mode;
 168                 uint16_t dialect_revision;
 169                 struct GUID server_guid;
 170                 uint32_t server_capabilities;
 171                 uint32_t max_transact_size;
 172                 uint32_t max_read_size;
 173                 uint32_t max_write_size;
 174                 struct timespec system_time;
 175                 struct timespec server_start_time;
 176                 DATA_BLOB gss_blob;
 177
 178                 /* SMB2 tcon */
 179                 uint8_t share_type;
 180                 uint32_t share_flags;
 181                 uint32_t share_capabilities;
 182                 uint32_t maximal_access;
 183         } smb2;
 184 };
 185
 186 struct file_info {
 187         uint64_t size;
 188         uint16 mode;
 189         uid_t uid;
 190         gid_t gid;
 191         /* these times are normally kept in GMT */
 192         struct timespec mtime_ts;
 193         struct timespec atime_ts;
 194         struct timespec ctime_ts;
 195         char *name;
 196         char *short_name;
 197 };
 198
 199 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
 200 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
 201 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
 202 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
 203 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
 204 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
 205 #define CLI_FULL_CONNECTION_USE_CCACHE 0x0040
 206 #define CLI_FULL_CONNECTION_FORCE_DOS_ERRORS 0x0080
 207 #define CLI_FULL_CONNECTION_FORCE_ASCII 0x0100
 208
 209 #endif /* _CLIENT_H */