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