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 /**
  65  * rpc_cli_transport defines a transport mechanism to ship rpc requests
  66  * asynchronously to a server and receive replies
  67  */
  68
  69 struct rpc_cli_transport {
  70
  71         enum dcerpc_transport_t transport;
  72
  73         /**
  74          * Trigger an async read from the server. May return a short read.
  75          */
  76         struct async_req *(*read_send)(TALLOC_CTX *mem_ctx,
  77                                        struct event_context *ev,
  78                                        uint8_t *data, size_t size,
  79                                        void *priv);
  80         /**
  81          * Get the result from the read_send operation.
  82          */
  83         NTSTATUS (*read_recv)(struct async_req *req, ssize_t *preceived);
  84
  85         /**
  86          * Trigger an async write to the server. May return a short write.
  87          */
  88         struct async_req *(*write_send)(TALLOC_CTX *mem_ctx,
  89                                         struct event_context *ev,
  90                                         const uint8_t *data, size_t size,
  91                                         void *priv);
  92         /**
  93          * Get the result from the read_send operation.
  94          */
  95         NTSTATUS (*write_recv)(struct async_req *req, ssize_t *psent);
  96
  97         /**
  98          * This is an optimization for the SMB transport. It models the
  99          * TransactNamedPipe API call: Send and receive data in one round
 100          * trip. The transport implementation is free to set this to NULL,
 101          * cli_pipe.c will fall back to the explicit write/read routines.
 102          */
 103         struct async_req *(*trans_send)(TALLOC_CTX *mem_ctx,
 104                                         struct event_context *ev,
 105                                         uint8_t *data, size_t data_len,
 106                                         uint32_t max_rdata_len,
 107                                         void *priv);
 108         /**
 109          * Get the result from the trans_send operation.
 110          */
 111         NTSTATUS (*trans_recv)(struct async_req *req, TALLOC_CTX *mem_ctx,
 112                                uint8_t **prdata, uint32_t *prdata_len);
 113         void *priv;
 114 };
 115
 116 struct rpc_pipe_client {
 117         struct rpc_pipe_client *prev, *next;
 118
 119         struct rpc_cli_transport *transport;
 120
 121         struct ndr_syntax_id abstract_syntax;
 122         struct ndr_syntax_id transfer_syntax;
 123
 124         NTSTATUS (*dispatch) (struct rpc_pipe_client *cli,
 125                         TALLOC_CTX *mem_ctx,
 126                         const struct ndr_interface_table *table,
 127                         uint32_t opnum, void *r);
 128
 129         char *desthost;
 130         char *srv_name_slash;
 131
 132         uint16 max_xmit_frag;
 133         uint16 max_recv_frag;
 134
 135         struct cli_pipe_auth_data *auth;
 136
 137         /* The following is only non-null on a netlogon pipe. */
 138         struct dcinfo *dc;
 139
 140         /* Used by internal rpc_pipe_client */
 141         pipes_struct *pipes_struct;
 142 };
 143
 144 /* Transport encryption state. */
 145 enum smb_trans_enc_type {
 146                 SMB_TRANS_ENC_NTLM
 147 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
 148                 , SMB_TRANS_ENC_GSS
 149 #endif
 150 };
 151
 152 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
 153 struct smb_tran_enc_state_gss {
 154         gss_ctx_id_t gss_ctx;
 155         gss_cred_id_t creds;
 156 };
 157 #endif
 158
 159 struct smb_trans_enc_state {
 160         enum smb_trans_enc_type smb_enc_type;
 161         uint16 enc_ctx_num;
 162         bool enc_on;
 163         union {
 164                 NTLMSSP_STATE *ntlmssp_state;
 165 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
 166                 struct smb_tran_enc_state_gss *gss_state;
 167 #endif
 168         } s;
 169 };
 170
 171 struct cli_state {
 172         /**
 173          * A list of subsidiary connections for DFS.
 174          */
 175         struct cli_state *prev, *next;
 176         int port;
 177         int fd;
 178         /* Last read or write error. */
 179         enum smb_read_errors smb_rw_error;
 180         uint16 cnum;
 181         uint16 pid;
 182         uint16 mid;
 183         uint16 vuid;
 184         int protocol;
 185         int sec_mode;
 186         int rap_error;
 187         int privileges;
 188
 189         fstring desthost;
 190
 191         /* The credentials used to open the cli_state connection. */
 192         char *domain;
 193         char *user_name;
 194         char *password; /* Can be null to force use of zero NTLMSSP session key. */
 195
 196         /*
 197          * The following strings are the
 198          * ones returned by the server if
 199          * the protocol > NT1.
 200          */
 201         fstring server_type;
 202         fstring server_os;
 203         fstring server_domain;
 204
 205         fstring share;
 206         fstring dev;
 207         struct nmb_name called;
 208         struct nmb_name calling;
 209         fstring full_dest_host_name;
 210         struct sockaddr_storage dest_ss;
 211
 212         DATA_BLOB secblob; /* cryptkey or negTokenInit */
 213         uint32 sesskey;
 214         int serverzone;
 215         uint32 servertime;
 216         int readbraw_supported;
 217         int writebraw_supported;
 218         int timeout; /* in milliseconds. */
 219         size_t max_xmit;
 220         size_t max_mux;
 221         char *outbuf;
 222         char *inbuf;
 223         unsigned int bufsize;
 224         int initialised;
 225         int win95;
 226         bool is_samba;
 227         uint32 capabilities;
 228         uint32 posix_capabilities;
 229         bool dfsroot;
 230
 231 #if 0
 232         TALLOC_CTX *longterm_mem_ctx;
 233         TALLOC_CTX *call_mem_ctx;
 234 #endif
 235
 236         smb_sign_info sign_info;
 237
 238         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
 239
 240         /* the session key for this CLI, outside
 241            any per-pipe authenticaion */
 242         DATA_BLOB user_session_key;
 243
 244         /* The list of pipes currently open on this connection. */
 245         struct rpc_pipe_client *pipe_list;
 246
 247         bool use_kerberos;
 248         bool fallback_after_kerberos;
 249         bool use_spnego;
 250         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
 251
 252         bool use_oplocks; /* should we use oplocks? */
 253         bool use_level_II_oplocks; /* should we use level II oplocks? */
 254
 255         /* a oplock break request handler */
 256         bool (*oplock_handler)(struct cli_state *cli, int fnum, unsigned char level);
 257
 258         bool force_dos_errors;
 259         bool case_sensitive; /* False by default. */
 260
 261         /**
 262          * fd_event is around while we have async requests outstanding or are
 263          * building a chained request.
 264          *
 265          * (fd_event!=NULL) &&
 266          *  ((outstanding_request!=NULL)||(chain_accumulator!=NULL))
 267          *
 268          * should always be true, as well as the reverse: If both cli_request
 269          * pointers are NULL, no fd_event is around.
 270          */
 271         struct fd_event *fd_event;
 272         char *evt_inbuf;
 273
 274         /**
 275          * A linked list of requests that are waiting for a reply
 276          */
 277         struct cli_request *outstanding_requests;
 278
 279         /**
 280          * The place to build up the list of chained requests. In CIFS, a
 281          * single cli_request corresponds to a MID and can serve more than one
 282          * chained async_req.
 283          */
 284         struct cli_request *chain_accumulator;
 285
 286         /* Where (if anywhere) this is mounted under DFS. */
 287         char *dfs_mountpoint;
 288 };
 289
 290 typedef struct file_info {
 291         struct cli_state *cli;
 292         uint64_t size;
 293         uint16 mode;
 294         uid_t uid;
 295         gid_t gid;
 296         /* these times are normally kept in GMT */
 297         struct timespec mtime_ts;
 298         struct timespec atime_ts;
 299         struct timespec ctime_ts;
 300         char *name;
 301         char short_name[13*3]; /* the *3 is to cope with multi-byte */
 302 } file_info;
 303
 304 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
 305 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
 306 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
 307 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
 308
 309 #endif /* _CLIENT_H */