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, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22
  23 #ifndef _CLIENT_H
  24 #define _CLIENT_H
  25
  26 /* the client asks for a smaller buffer to save ram and also to get more
  27    overlap on the wire. This size gives us a nice read/write size, which
  28    will be a multiple of the page size on almost any system */
  29 #define CLI_BUFFER_SIZE (0xFFFF)
  30 #define CLI_SAMBA_MAX_LARGE_READX_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_SAMBA_MAX_POSIX_LARGE_READX_SIZE (0xFFFF00) /* 24-bit len. */
  33
  34 /*
  35  * These definitions depend on smb.h
  36  */
  37
  38 struct print_job_info {
  39         uint16 id;
  40         uint16 priority;
  41         size_t size;
  42         fstring user;
  43         fstring name;
  44         time_t t;
  45 };
  46
  47 struct cli_pipe_auth_data {
  48         enum pipe_auth_type auth_type; /* switch for the union below. Defined in ntdomain.h */
  49         enum pipe_auth_level auth_level; /* defined in ntdomain.h */
  50         union {
  51                 struct schannel_auth_struct *schannel_auth;
  52                 NTLMSSP_STATE *ntlmssp_state;
  53                 struct kerberos_auth_struct *kerberos_auth;
  54         } a_u;
  55         void (*cli_auth_data_free_func)(struct cli_pipe_auth_data *);
  56 };
  57
  58 struct rpc_pipe_client {
  59         struct rpc_pipe_client *prev, *next;
  60
  61         TALLOC_CTX *mem_ctx;
  62
  63         struct cli_state *cli;
  64
  65         int pipe_idx;
  66         const char *pipe_name;
  67         uint16 fnum;
  68
  69         const char *domain;
  70         const char *user_name;
  71         struct pwd_info pwd;
  72
  73         uint16 max_xmit_frag;
  74         uint16 max_recv_frag;
  75
  76         struct cli_pipe_auth_data auth;
  77
  78         /* The following is only non-null on a netlogon pipe. */
  79         struct dcinfo *dc;
  80 };
  81
  82 /* Transport encryption state. */
  83 enum smb_trans_enc_type { SMB_TRANS_ENC_NTLM, SMB_TRANS_ENC_GSS };
  84
  85 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
  86 struct smb_tran_enc_state_gss {
  87         gss_ctx_id_t gss_ctx;
  88         gss_cred_id_t creds;
  89 };
  90 #endif
  91
  92 struct smb_trans_enc_state {
  93         enum smb_trans_enc_type smb_enc_type;
  94         uint16 enc_ctx_num;
  95         BOOL enc_on;
  96         union {
  97                 NTLMSSP_STATE *ntlmssp_state;
  98 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
  99                 struct smb_tran_enc_state_gss *gss_state;
 100 #endif
 101         } s;
 102 };
 103
 104 struct cli_state {
 105         int port;
 106         int fd;
 107         int smb_rw_error; /* Copy of last read or write error. */
 108         uint16 cnum;
 109         uint16 pid;
 110         uint16 mid;
 111         uint16 vuid;
 112         int protocol;
 113         int sec_mode;
 114         int rap_error;
 115         int privileges;
 116
 117         fstring desthost;
 118
 119         /* The credentials used to open the cli_state connection. */
 120         fstring domain;
 121         fstring user_name;
 122         struct pwd_info pwd;
 123
 124         /*
 125          * The following strings are the
 126          * ones returned by the server if
 127          * the protocol > NT1.
 128          */
 129         fstring server_type;
 130         fstring server_os;
 131         fstring server_domain;
 132
 133         fstring share;
 134         fstring dev;
 135         struct nmb_name called;
 136         struct nmb_name calling;
 137         fstring full_dest_host_name;
 138         struct in_addr dest_ip;
 139
 140         DATA_BLOB secblob; /* cryptkey or negTokenInit */
 141         uint32 sesskey;
 142         int serverzone;
 143         uint32 servertime;
 144         int readbraw_supported;
 145         int writebraw_supported;
 146         int timeout; /* in milliseconds. */
 147         size_t max_xmit;
 148         size_t max_mux;
 149         char *outbuf;
 150         char *inbuf;
 151         unsigned int bufsize;
 152         int initialised;
 153         int win95;
 154         BOOL is_samba;
 155         uint32 capabilities;
 156         uint32 posix_capabilities;
 157         BOOL dfsroot;
 158
 159         TALLOC_CTX *mem_ctx;
 160
 161         smb_sign_info sign_info;
 162
 163         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
 164
 165         /* the session key for this CLI, outside
 166            any per-pipe authenticaion */
 167         DATA_BLOB user_session_key;
 168
 169         /* The list of pipes currently open on this connection. */
 170         struct rpc_pipe_client *pipe_list;
 171
 172         BOOL use_kerberos;
 173         BOOL fallback_after_kerberos;
 174         BOOL use_spnego;
 175
 176         BOOL use_oplocks; /* should we use oplocks? */
 177         BOOL use_level_II_oplocks; /* should we use level II oplocks? */
 178
 179         /* a oplock break request handler */
 180         BOOL (*oplock_handler)(struct cli_state *cli, int fnum, unsigned char level);
 181
 182         BOOL force_dos_errors;
 183         BOOL case_sensitive; /* False by default. */
 184 };
 185
 186 typedef struct file_info {
 187         struct cli_state *cli;
 188         SMB_BIG_UINT size;
 189         uint16 mode;
 190         uid_t uid;
 191         gid_t gid;
 192         /* these times are normally kept in GMT */
 193         struct timespec mtime_ts;
 194         struct timespec atime_ts;
 195         struct timespec ctime_ts;
 196         pstring name;
 197         pstring dir;
 198         char short_name[13*3]; /* the *3 is to cope with multi-byte */
 199 } file_info;
 200
 201 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
 202 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
 203 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
 204
 205 #endif /* _CLIENT_H */