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 #include "../librpc/ndr/libndr.h"
  26
  27 /* the client asks for a smaller buffer to save ram and also to get more
  28    overlap on the wire. This size gives us a nice read/write size, which
  29    will be a multiple of the page size on almost any system */
  30 #define CLI_BUFFER_SIZE (0xFFFF)
  31 #define CLI_SAMBA_MAX_LARGE_READX_SIZE (127*1024) /* Works for Samba servers */
  32 #define CLI_SAMBA_MAX_LARGE_WRITEX_SIZE (127*1024) /* Works for Samba servers */
  33 #define CLI_WINDOWS_MAX_LARGE_READX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
  34 #define CLI_WINDOWS_MAX_LARGE_WRITEX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
  35 #define CLI_SAMBA_MAX_POSIX_LARGE_READX_SIZE (0xFFFF00) /* 24-bit len. */
  36 #define CLI_SAMBA_MAX_POSIX_LARGE_WRITEX_SIZE (0xFFFF00) /* 24-bit len. */
  37
  38 /*
  39  * These definitions depend on smb.h
  40  */
  41
  42 struct print_job_info {
  43         uint16 id;
  44         uint16 priority;
  45         size_t size;
  46         fstring user;
  47         fstring name;
  48         time_t t;
  49 };
  50
  51 /**
  52  * rpc_cli_transport defines a transport mechanism to ship rpc requests
  53  * asynchronously to a server and receive replies
  54  */
  55
  56 struct rpc_cli_transport {
  57
  58         enum dcerpc_transport_t transport;
  59
  60         /**
  61          * Trigger an async read from the server. May return a short read.
  62          */
  63         struct tevent_req *(*read_send)(TALLOC_CTX *mem_ctx,
  64                                         struct event_context *ev,
  65                                         uint8_t *data, size_t size,
  66                                         void *priv);
  67         /**
  68          * Get the result from the read_send operation.
  69          */
  70         NTSTATUS (*read_recv)(struct tevent_req *req, ssize_t *preceived);
  71
  72         /**
  73          * Trigger an async write to the server. May return a short write.
  74          */
  75         struct tevent_req *(*write_send)(TALLOC_CTX *mem_ctx,
  76                                          struct event_context *ev,
  77                                          const uint8_t *data, size_t size,
  78                                          void *priv);
  79         /**
  80          * Get the result from the read_send operation.
  81          */
  82         NTSTATUS (*write_recv)(struct tevent_req *req, ssize_t *psent);
  83
  84         /**
  85          * This is an optimization for the SMB transport. It models the
  86          * TransactNamedPipe API call: Send and receive data in one round
  87          * trip. The transport implementation is free to set this to NULL,
  88          * cli_pipe.c will fall back to the explicit write/read routines.
  89          */
  90         struct tevent_req *(*trans_send)(TALLOC_CTX *mem_ctx,
  91                                          struct event_context *ev,
  92                                          uint8_t *data, size_t data_len,
  93                                          uint32_t max_rdata_len,
  94                                          void *priv);
  95         /**
  96          * Get the result from the trans_send operation.
  97          */
  98         NTSTATUS (*trans_recv)(struct tevent_req *req, TALLOC_CTX *mem_ctx,
  99                                uint8_t **prdata, uint32_t *prdata_len);
 100
 101         bool (*is_connected)(void *priv);
 102         unsigned int (*set_timeout)(void *priv, unsigned int timeout);
 103
 104         void *priv;
 105 };
 106
 107 struct rpc_pipe_client {
 108         struct rpc_pipe_client *prev, *next;
 109
 110         struct rpc_cli_transport *transport;
 111
 112         struct ndr_syntax_id abstract_syntax;
 113         struct ndr_syntax_id transfer_syntax;
 114
 115         NTSTATUS (*dispatch) (struct rpc_pipe_client *cli,
 116                         TALLOC_CTX *mem_ctx,
 117                         const struct ndr_interface_table *table,
 118                         uint32_t opnum, void *r);
 119
 120         struct tevent_req *(*dispatch_send)(
 121                 TALLOC_CTX *mem_ctx,
 122                 struct tevent_context *ev,
 123                 struct rpc_pipe_client *cli,
 124                 const struct ndr_interface_table *table,
 125                 uint32_t opnum,
 126                 void *r);
 127         NTSTATUS (*dispatch_recv)(struct tevent_req *req,
 128                                   TALLOC_CTX *mem_ctx);
 129
 130
 131         char *desthost;
 132         char *srv_name_slash;
 133
 134         uint16 max_xmit_frag;
 135         uint16 max_recv_frag;
 136
 137         struct pipe_auth_data *auth;
 138
 139         /* The following is only non-null on a netlogon client pipe. */
 140         struct netlogon_creds_CredentialState *dc;
 141
 142         /* Used by internal rpc_pipe_client */
 143         struct pipes_struct *pipes_struct;
 144 };
 145
 146 /* Transport encryption state. */
 147 enum smb_trans_enc_type {
 148                 SMB_TRANS_ENC_NTLM
 149 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
 150                 , SMB_TRANS_ENC_GSS
 151 #endif
 152 };
 153
 154 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
 155 struct smb_tran_enc_state_gss {
 156         gss_ctx_id_t gss_ctx;
 157         gss_cred_id_t creds;
 158 };
 159 #endif
 160
 161 struct smb_trans_enc_state {
 162         enum smb_trans_enc_type smb_enc_type;
 163         uint16 enc_ctx_num;
 164         bool enc_on;
 165         union {
 166                 struct ntlmssp_state *ntlmssp_state;
 167 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
 168                 struct smb_tran_enc_state_gss *gss_state;
 169 #endif
 170         } s;
 171 };
 172
 173 struct cli_state_seqnum {
 174         struct cli_state_seqnum *prev, *next;
 175         uint16_t mid;
 176         uint32_t seqnum;
 177         bool persistent;
 178 };
 179
 180 struct cli_state {
 181         /**
 182          * A list of subsidiary connections for DFS.
 183          */
 184         struct cli_state *prev, *next;
 185         int port;
 186         int fd;
 187         /* Last read or write error. */
 188         enum smb_read_errors smb_rw_error;
 189         uint16 cnum;
 190         uint16 pid;
 191         uint16 mid;
 192         uint16 vuid;
 193         int protocol;
 194         int sec_mode;
 195         int rap_error;
 196         int privileges;
 197
 198         fstring desthost;
 199
 200         /* The credentials used to open the cli_state connection. */
 201         char *domain;
 202         char *user_name;
 203         char *password; /* Can be null to force use of zero NTLMSSP session key. */
 204
 205         /*
 206          * The following strings are the
 207          * ones returned by the server if
 208          * the protocol > NT1.
 209          */
 210         fstring server_type;
 211         fstring server_os;
 212         fstring server_domain;
 213
 214         fstring share;
 215         fstring dev;
 216         struct nmb_name called;
 217         struct nmb_name calling;
 218         struct sockaddr_storage dest_ss;
 219
 220         DATA_BLOB secblob; /* cryptkey or negTokenInit */
 221         uint32 sesskey;
 222         int serverzone;
 223         uint32 servertime;
 224         int readbraw_supported;
 225         int writebraw_supported;
 226         int timeout; /* in milliseconds. */
 227         size_t max_xmit;
 228         size_t max_mux;
 229         char *outbuf;
 230         struct cli_state_seqnum *seqnum;
 231         char *inbuf;
 232         unsigned int bufsize;
 233         int initialised;
 234         int win95;
 235         bool is_samba;
 236         uint32 capabilities;
 237         /* What the server offered. */
 238         uint32_t server_posix_capabilities;
 239         /* What the client requested. */
 240         uint32_t requested_posix_capabilities;
 241         bool dfsroot;
 242
 243         struct smb_signing_state *signing_state;
 244
 245         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
 246
 247         /* the session key for this CLI, outside
 248            any per-pipe authenticaion */
 249         DATA_BLOB user_session_key;
 250
 251         /* The list of pipes currently open on this connection. */
 252         struct rpc_pipe_client *pipe_list;
 253
 254         bool use_kerberos;
 255         bool fallback_after_kerberos;
 256         bool use_spnego;
 257         bool use_ccache;
 258         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
 259
 260         bool use_oplocks; /* should we use oplocks? */
 261         bool use_level_II_oplocks; /* should we use level II oplocks? */
 262
 263         /* a oplock break request handler */
 264         NTSTATUS (*oplock_handler)(struct cli_state *cli, uint16_t fnum, unsigned char level);
 265
 266         bool force_dos_errors;
 267         bool case_sensitive; /* False by default. */
 268
 269         /* Where (if anywhere) this is mounted under DFS. */
 270         char *dfs_mountpoint;
 271
 272         struct tevent_queue *outgoing;
 273         struct tevent_req **pending;
 274 };
 275
 276 struct file_info {
 277         struct cli_state *cli;
 278         uint64_t size;
 279         uint16 mode;
 280         uid_t uid;
 281         gid_t gid;
 282         /* these times are normally kept in GMT */
 283         struct timespec mtime_ts;
 284         struct timespec atime_ts;
 285         struct timespec ctime_ts;
 286         char *name;
 287         char short_name[13*3]; /* the *3 is to cope with multi-byte */
 288 };
 289
 290 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
 291 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
 292 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
 293 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
 294 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
 295 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
 296 #define CLI_FULL_CONNECTION_USE_CCACHE 0x0040
 297
 298 #endif /* _CLIENT_H */