source/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_pipe_auth_data {
  50         enum pipe_auth_type auth_type; /* switch for the union below. Defined in ntdomain.h */
  51         enum pipe_auth_level auth_level; /* defined in ntdomain.h */
  52         union {
  53                 struct schannel_auth_struct *schannel_auth;
  54                 NTLMSSP_STATE *ntlmssp_state;
  55                 struct kerberos_auth_struct *kerberos_auth;
  56         } a_u;
  57         void (*cli_auth_data_free_func)(struct cli_pipe_auth_data *);
  58 };
  59
  60 struct rpc_pipe_client {
  61         struct rpc_pipe_client *prev, *next;
  62
  63         struct cli_state *cli;
  64
  65         int pipe_idx;
  66         const char *pipe_name;
  67         uint16 fnum;
  68
  69         const char *desthost;
  70         const char *srv_name_slash;
  71
  72         const char *domain;
  73         const char *user_name;
  74         struct pwd_info pwd;
  75
  76         uint16 max_xmit_frag;
  77         uint16 max_recv_frag;
  78
  79         struct cli_pipe_auth_data auth;
  80
  81         /* The following is only non-null on a netlogon pipe. */
  82         struct dcinfo *dc;
  83 };
  84
  85 /* Transport encryption state. */
  86 enum smb_trans_enc_type {
  87                 SMB_TRANS_ENC_NTLM
  88 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
  89                 , SMB_TRANS_ENC_GSS
  90 #endif
  91 };
  92
  93 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
  94 struct smb_tran_enc_state_gss {
  95         gss_ctx_id_t gss_ctx;
  96         gss_cred_id_t creds;
  97 };
  98 #endif
  99
 100 struct smb_trans_enc_state {
 101         enum smb_trans_enc_type smb_enc_type;
 102         uint16 enc_ctx_num;
 103         bool enc_on;
 104         union {
 105                 NTLMSSP_STATE *ntlmssp_state;
 106 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
 107                 struct smb_tran_enc_state_gss *gss_state;
 108 #endif
 109         } s;
 110 };
 111
 112 struct cli_state {
 113         int port;
 114         int fd;
 115         /* Last read or write error. */
 116         enum smb_read_errors smb_rw_error;
 117         uint16 cnum;
 118         uint16 pid;
 119         uint16 mid;
 120         uint16 vuid;
 121         int protocol;
 122         int sec_mode;
 123         int rap_error;
 124         int privileges;
 125
 126         fstring desthost;
 127
 128         /* The credentials used to open the cli_state connection. */
 129         fstring domain;
 130         fstring user_name;
 131         struct pwd_info pwd;
 132
 133         /*
 134          * The following strings are the
 135          * ones returned by the server if
 136          * the protocol > NT1.
 137          */
 138         fstring server_type;
 139         fstring server_os;
 140         fstring server_domain;
 141
 142         fstring share;
 143         fstring dev;
 144         struct nmb_name called;
 145         struct nmb_name calling;
 146         fstring full_dest_host_name;
 147         struct sockaddr_storage dest_ss;
 148
 149         DATA_BLOB secblob; /* cryptkey or negTokenInit */
 150         uint32 sesskey;
 151         int serverzone;
 152         uint32 servertime;
 153         int readbraw_supported;
 154         int writebraw_supported;
 155         int timeout; /* in milliseconds. */
 156         size_t max_xmit;
 157         size_t max_mux;
 158         char *outbuf;
 159         char *inbuf;
 160         unsigned int bufsize;
 161         int initialised;
 162         int win95;
 163         bool is_samba;
 164         uint32 capabilities;
 165         uint32 posix_capabilities;
 166         bool dfsroot;
 167
 168 #if 0
 169         TALLOC_CTX *longterm_mem_ctx;
 170         TALLOC_CTX *call_mem_ctx;
 171 #endif
 172
 173         smb_sign_info sign_info;
 174
 175         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
 176
 177         /* the session key for this CLI, outside
 178            any per-pipe authenticaion */
 179         DATA_BLOB user_session_key;
 180
 181         /* The list of pipes currently open on this connection. */
 182         struct rpc_pipe_client *pipe_list;
 183
 184         bool use_kerberos;
 185         bool fallback_after_kerberos;
 186         bool use_spnego;
 187
 188         bool use_oplocks; /* should we use oplocks? */
 189         bool use_level_II_oplocks; /* should we use level II oplocks? */
 190
 191         /* a oplock break request handler */
 192         bool (*oplock_handler)(struct cli_state *cli, int fnum, unsigned char level);
 193
 194         bool force_dos_errors;
 195         bool case_sensitive; /* False by default. */
 196
 197         struct event_context *event_ctx;
 198         struct fd_event *fd_event;
 199         char *evt_inbuf;
 200
 201         struct cli_request *outstanding_requests;
 202 };
 203
 204 struct cli_request {
 205         struct cli_request *prev, *next;
 206         struct async_req *async;
 207
 208         struct cli_state *cli;
 209
 210         struct smb_trans_enc_state *enc_state;
 211
 212         uint16_t mid;
 213
 214         char *outbuf;
 215         size_t sent;
 216         char *inbuf;
 217
 218         union {
 219                 struct {
 220                         off_t ofs;
 221                         size_t size;
 222                         ssize_t received;
 223                         uint8_t *rcvbuf;
 224                 } read;
 225         } data;
 226 };
 227
 228 typedef struct file_info {
 229         struct cli_state *cli;
 230         SMB_BIG_UINT size;
 231         uint16 mode;
 232         uid_t uid;
 233         gid_t gid;
 234         /* these times are normally kept in GMT */
 235         struct timespec mtime_ts;
 236         struct timespec atime_ts;
 237         struct timespec ctime_ts;
 238         char *name;
 239         char short_name[13*3]; /* the *3 is to cope with multi-byte */
 240 } file_info;
 241
 242 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
 243 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
 244 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
 245 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
 246
 247 #endif /* _CLIENT_H */