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