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_state_seqnum {
  50         struct cli_state_seqnum *prev, *next;
  51         uint16_t mid;
  52         uint32_t seqnum;
  53         bool persistent;
  54 };
  55
  56 struct cli_state {
  57         /**
  58          * A list of subsidiary connections for DFS.
  59          */
  60         struct cli_state *prev, *next;
  61         int port;
  62         int fd;
  63         /* Last read or write error. */
  64         enum smb_read_errors smb_rw_error;
  65         uint16 cnum;
  66         uint16 pid;
  67         uint16 mid;
  68         uint16 vuid;
  69         int protocol;
  70         int sec_mode;
  71         int rap_error;
  72         int privileges;
  73
  74         char *desthost;
  75
  76         /* The credentials used to open the cli_state connection. */
  77         char *domain;
  78         char *user_name;
  79         char *password; /* Can be null to force use of zero NTLMSSP session key. */
  80
  81         /*
  82          * The following strings are the
  83          * ones returned by the server if
  84          * the protocol > NT1.
  85          */
  86         char *server_type;
  87         char *server_os;
  88         char *server_domain;
  89
  90         char *share;
  91         char *dev;
  92         struct nmb_name called;
  93         struct nmb_name calling;
  94         struct sockaddr_storage dest_ss;
  95
  96         DATA_BLOB secblob; /* cryptkey or negTokenInit */
  97         uint32 sesskey;
  98         int serverzone;
  99         uint32 servertime;
 100         int readbraw_supported;
 101         int writebraw_supported;
 102         int timeout; /* in milliseconds. */
 103         size_t max_xmit;
 104         size_t max_mux;
 105         char *outbuf;
 106         struct cli_state_seqnum *seqnum;
 107         char *inbuf;
 108         unsigned int bufsize;
 109         int initialised;
 110         int win95;
 111         bool is_samba;
 112         uint32 capabilities;
 113         /* What the server offered. */
 114         uint32_t server_posix_capabilities;
 115         /* What the client requested. */
 116         uint32_t requested_posix_capabilities;
 117         bool dfsroot;
 118
 119         struct smb_signing_state *signing_state;
 120
 121         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
 122
 123         /* the session key for this CLI, outside
 124            any per-pipe authenticaion */
 125         DATA_BLOB user_session_key;
 126
 127         /* The list of pipes currently open on this connection. */
 128         struct rpc_pipe_client *pipe_list;
 129
 130         bool use_kerberos;
 131         bool fallback_after_kerberos;
 132         bool use_spnego;
 133         bool use_ccache;
 134         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
 135
 136         bool use_oplocks; /* should we use oplocks? */
 137         bool use_level_II_oplocks; /* should we use level II oplocks? */
 138
 139         /* a oplock break request handler */
 140         NTSTATUS (*oplock_handler)(struct cli_state *cli, uint16_t fnum, unsigned char level);
 141
 142         bool force_dos_errors;
 143         bool case_sensitive; /* False by default. */
 144
 145         /* Where (if anywhere) this is mounted under DFS. */
 146         char *dfs_mountpoint;
 147
 148         struct tevent_queue *outgoing;
 149         struct tevent_req **pending;
 150 };
 151
 152 struct file_info {
 153         uint64_t size;
 154         uint16 mode;
 155         uid_t uid;
 156         gid_t gid;
 157         /* these times are normally kept in GMT */
 158         struct timespec mtime_ts;
 159         struct timespec atime_ts;
 160         struct timespec ctime_ts;
 161         char *name;
 162         char short_name[13*3]; /* the *3 is to cope with multi-byte */
 163 };
 164
 165 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
 166 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
 167 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
 168 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
 169 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
 170 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
 171 #define CLI_FULL_CONNECTION_USE_CCACHE 0x0040
 172
 173 #endif /* _CLIENT_H */