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