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