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