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