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