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