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