source4/libcli/raw/libcliraw.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup
   4
   5    Copyright (C) Andrew Tridgell 2002-2004
   6    Copyright (C) James Myers 2003 <myersjj@samba.org>
   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 __LIBCLI_RAW_H__
  23 #define __LIBCLI_RAW_H__
  24
  25 #include "../libcli/smb/smb_common.h"
  26 #include "libcli/raw/request.h"
  27 #include "librpc/gen_ndr/nbt.h"
  28 #include "libcli/raw/interfaces.h"
  29
  30 struct smbcli_tree;  /* forward declare */
  31 struct smbcli_request;  /* forward declare */
  32 struct smbcli_session;  /* forward declare */
  33 struct smbcli_transport;  /* forward declare */
  34
  35 struct resolve_context;
  36 struct cli_credentials;
  37 struct gensec_settings;
  38
  39 /* default timeout for all smb requests */
  40 #define SMB_REQUEST_TIMEOUT 60
  41
  42 /* context that will be and has been negotiated between the client and server */
  43 struct smbcli_negotiate {
  44         /*
  45          * negotiated maximum transmit size - this is given to us by the server
  46          */
  47         uint32_t max_xmit;
  48
  49         /* maximum number of requests that can be multiplexed */
  50         uint16_t max_mux;
  51
  52         /* the negotiatiated protocol */
  53         enum protocol_types protocol;
  54
  55         uint8_t sec_mode;               /* security mode returned by negprot */
  56         DATA_BLOB secblob;      /* cryptkey or negTokenInit blob */
  57         uint32_t sesskey;
  58
  59         /* capabilities that the server reported */
  60         uint32_t capabilities;
  61
  62         int server_zone;
  63         time_t server_time;
  64
  65         unsigned int readbraw_supported:1;
  66         unsigned int writebraw_supported:1;
  67         unsigned int lockread_supported:1;
  68 };
  69
  70 /* this is the context for a SMB socket associated with the socket itself */
  71 struct smbcli_socket {
  72         struct socket_context *sock;
  73
  74         /* what port we ended up connected to */
  75         int port;
  76
  77         /* the hostname we connected to */
  78         const char *hostname;
  79
  80         /* the event handle for waiting for socket IO */
  81         struct {
  82                 struct tevent_context *ctx;
  83                 struct tevent_fd *fde;
  84                 struct tevent_timer *te;
  85         } event;
  86 };
  87
  88 /*
  89   this structure allows applications to control the behaviour of the
  90   client library
  91 */
  92 struct smbcli_options {
  93         unsigned int use_oplocks:1;
  94         unsigned int use_level2_oplocks:1;
  95         unsigned int use_spnego:1;
  96         unsigned int unicode:1;
  97         unsigned int ntstatus_support:1;
  98         int min_protocol;
  99         int max_protocol;
 100         uint32_t max_xmit;
 101         uint16_t max_mux;
 102         int request_timeout;
 103         enum smb_signing_setting signing;
 104         uint32_t smb2_capabilities;
 105         struct GUID client_guid;
 106         uint64_t max_credits;
 107         unsigned int only_negprot;
 108 };
 109
 110 /* this is the context for the client transport layer */
 111 struct smbcli_transport {
 112         struct tevent_context *ev; /* TODO: remove this !!! */
 113         struct smbXcli_conn *conn;
 114
 115         /* negotiated protocol information */
 116         struct smbcli_negotiate negotiate;
 117
 118         /* options to control the behaviour of the client code */
 119         struct smbcli_options options;
 120
 121         /* an idle function - if this is defined then it will be
 122            called once every period microseconds while we are waiting
 123            for a packet */
 124         struct {
 125                 void (*func)(struct smbcli_transport *, void *);
 126                 void *private_data;
 127                 unsigned int period;
 128                 struct tevent_timer *te;
 129         } idle;
 130
 131         /* the error fields from the last message */
 132         struct {
 133                 enum {ETYPE_NONE, ETYPE_SMB, ETYPE_SOCKET, ETYPE_NBT} etype;
 134                 union {
 135                         NTSTATUS nt_status;
 136                         enum {SOCKET_READ_TIMEOUT,
 137                               SOCKET_READ_EOF,
 138                               SOCKET_READ_ERROR,
 139                               SOCKET_WRITE_ERROR,
 140                               SOCKET_READ_BAD_SIG} socket_error;
 141                         unsigned int nbt_error;
 142                 } e;
 143         } error;
 144
 145         struct {
 146                 /* a oplock break request handler */
 147                 bool (*handler)(struct smbcli_transport *transport,
 148                                 uint16_t tid, uint16_t fnum, uint8_t level, void *private_data);
 149                 /* private data passed to the oplock handler */
 150                 void *private_data;
 151         } oplock;
 152         struct tevent_req *break_subreq;
 153 };
 154
 155 /* this is the context for the user */
 156
 157 /* this is the context for the session layer */
 158 struct smbcli_session {
 159         /* transport layer info */
 160         struct smbcli_transport *transport;
 161
 162         /* after a session setup the server provides us with
 163            a vuid identifying the security context */
 164         struct smbXcli_session *smbXcli;
 165         uint16_t vuid;
 166
 167         /* default pid for this session */
 168         uint32_t pid;
 169
 170         /* the flags2 for each packet - this allows
 171            the user to control these for torture testing */
 172         uint16_t flags2;
 173
 174         /* the spnego context if we use extented security */
 175         struct gensec_security *gensec;
 176
 177         struct smbcli_session_options {
 178                 unsigned int lanman_auth:1;
 179                 unsigned int ntlmv2_auth:1;
 180                 unsigned int plaintext_auth:1;
 181         } options;
 182
 183         const char *os;
 184         const char *lanman;
 185 };
 186
 187 /*
 188    smbcli_tree context: internal state for a tree connection.
 189  */
 190 struct smbcli_tree {
 191         /* session layer info */
 192         struct smbcli_session *session;
 193
 194         struct smbXcli_tcon *smbXcli;
 195         uint16_t tid;                   /* tree id, aka cnum */
 196         char *device;
 197         char *fs_type;
 198 };
 199
 200
 201 /*
 202   a client request moves between the following 4 states.
 203 */
 204 enum smbcli_request_state {SMBCLI_REQUEST_INIT, /* we are creating the request */
 205                         SMBCLI_REQUEST_RECV, /* we are waiting for a matching reply */
 206                         SMBCLI_REQUEST_DONE, /* the request is finished */
 207                         SMBCLI_REQUEST_ERROR}; /* a packet or transport level error has occurred */
 208
 209 /* the context for a single SMB request. This is passed to any request-context
 210  * functions (similar to context.h, the server version).
 211  * This will allow requests to be multi-threaded. */
 212 struct smbcli_request {
 213         /* smbXcli_req */
 214         struct tevent_req *subreqs[2];
 215
 216         /* each request is in one of 4 possible states */
 217         enum smbcli_request_state state;
 218
 219         /* a request always has a transport context, nearly always has
 220            a session context and usually has a tree context */
 221         struct smbcli_transport *transport;
 222         struct smbcli_session *session;
 223         struct smbcli_tree *tree;
 224
 225         /* the flags2 from the SMB request, in raw form (host byte
 226            order). Used to parse strings */
 227         uint16_t flags2;
 228
 229         /* the NT status for this request. Set by packet receive code
 230            or code detecting error. */
 231         NTSTATUS status;
 232
 233         /* the caller wants to do the signing check */
 234         bool sign_caller_checks;
 235
 236         /* give the caller a chance to prevent the talloc_free() in the _recv() function */
 237         bool do_not_free;
 238
 239         struct smb_request_buffer in;
 240         struct smb_request_buffer out;
 241
 242         struct smb_trans2 trans2;
 243         struct smb_nttrans nttrans;
 244
 245         /* information on what to do with a reply when it is received
 246            asyncronously. If this is not setup when a reply is received then
 247            the reply is discarded
 248
 249            The private pointer is private to the caller of the client
 250            library (the application), not private to the library
 251         */
 252         struct {
 253                 void (*fn)(struct smbcli_request *);
 254                 void *private_data;
 255         } async;
 256 };
 257
 258 /* useful way of catching wct errors with file and line number */
 259 #define SMBCLI_CHECK_MIN_WCT(req, wcount) if ((req)->in.wct < (wcount)) { \
 260       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected min %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
 261       req->status = NT_STATUS_INVALID_PARAMETER; \
 262       goto failed; \
 263 }
 264
 265 #define SMBCLI_CHECK_WCT(req, wcount) if ((req)->in.wct != (wcount)) { \
 266       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
 267       req->status = NT_STATUS_INVALID_PARAMETER; \
 268       goto failed; \
 269 }
 270
 271 NTSTATUS smb_raw_read_recv(struct smbcli_request *req, union smb_read *parms);
 272 struct smbcli_request *smb_raw_read_send(struct smbcli_tree *tree, union smb_read *parms);
 273 NTSTATUS smb_raw_trans_recv(struct smbcli_request *req,
 274                              TALLOC_CTX *mem_ctx,
 275                              struct smb_trans2 *parms);
 276 struct smbcli_request *smb_raw_trans_send(struct smbcli_tree *tree, struct smb_trans2 *parms);
 277 NTSTATUS smbcli_request_destroy(struct smbcli_request *req);
 278 struct smbcli_request *smb_raw_write_send(struct smbcli_tree *tree, union smb_write *parms);
 279 NTSTATUS smb_raw_write_recv(struct smbcli_request *req, union smb_write *parms);
 280 struct smbcli_request *smb_raw_close_send(struct smbcli_tree *tree, union smb_close *parms);
 281 NTSTATUS smb_raw_open_recv(struct smbcli_request *req, TALLOC_CTX *mem_ctx, union smb_open *parms);
 282 struct smbcli_request *smb_raw_open_send(struct smbcli_tree *tree, union smb_open *parms);
 283
 284 bool smbcli_transport_process(struct smbcli_transport *transport);
 285 const char *smbcli_errstr(struct smbcli_tree *tree);
 286 NTSTATUS smb_raw_fsinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_fsinfo *fsinfo);
 287 NTSTATUS smb_raw_setfsinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_setfsinfo *set_fsinfo);
 288 NTSTATUS smb_raw_pathinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_fileinfo *parms);
 289 NTSTATUS smb_raw_shadow_data(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, struct smb_shadow_copy *info);
 290 NTSTATUS smb_raw_fileinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_fileinfo *parms);
 291 struct smbcli_tree *smbcli_tree_init(struct smbcli_session *session, TALLOC_CTX *parent_ctx, bool primary);
 292 NTSTATUS smb_raw_tcon(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_tcon *parms);
 293 void smbcli_oplock_handler(struct smbcli_transport *transport,
 294                         bool (*handler)(struct smbcli_transport *, uint16_t, uint16_t, uint8_t, void *),
 295                         void *private_data);
 296 void smbcli_transport_idle_handler(struct smbcli_transport *transport,
 297                                    void (*idle_func)(struct smbcli_transport *, void *),
 298                                    uint64_t period,
 299                                    void *private_data);
 300 NTSTATUS smbcli_request_simple_recv(struct smbcli_request *req);
 301 bool smbcli_oplock_ack(struct smbcli_tree *tree, uint16_t fnum, uint16_t ack_level);
 302 NTSTATUS smb_raw_open(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_open *parms);
 303 NTSTATUS smb_raw_close(struct smbcli_tree *tree, union smb_close *parms);
 304 NTSTATUS smb_raw_unlink(struct smbcli_tree *tree, union smb_unlink *parms);
 305 NTSTATUS smb_raw_chkpath(struct smbcli_tree *tree, union smb_chkpath *parms);
 306 NTSTATUS smb_raw_mkdir(struct smbcli_tree *tree, union smb_mkdir *parms);
 307 NTSTATUS smb_raw_rmdir(struct smbcli_tree *tree, struct smb_rmdir *parms);
 308 NTSTATUS smb_raw_rename(struct smbcli_tree *tree, union smb_rename *parms);
 309 NTSTATUS smb_raw_seek(struct smbcli_tree *tree, union smb_seek *parms);
 310 NTSTATUS smb_raw_read(struct smbcli_tree *tree, union smb_read *parms);
 311 NTSTATUS smb_raw_write(struct smbcli_tree *tree, union smb_write *parms);
 312 NTSTATUS smb_raw_lock(struct smbcli_tree *tree, union smb_lock *parms);
 313 NTSTATUS smb_raw_setpathinfo(struct smbcli_tree *tree, union smb_setfileinfo *parms);
 314 NTSTATUS smb_raw_setfileinfo(struct smbcli_tree *tree, union smb_setfileinfo *parms);
 315
 316 struct smbcli_request *smb_raw_changenotify_send(struct smbcli_tree *tree, union smb_notify *parms);
 317 NTSTATUS smb_raw_changenotify_recv(struct smbcli_request *req, TALLOC_CTX *mem_ctx, union smb_notify *parms);
 318
 319 NTSTATUS smb_tree_disconnect(struct smbcli_tree *tree);
 320 NTSTATUS smbcli_nt_error(struct smbcli_tree *tree);
 321 NTSTATUS smb_raw_exit(struct smbcli_session *session);
 322 NTSTATUS smb_raw_pathinfo_recv(struct smbcli_request *req,
 323                                TALLOC_CTX *mem_ctx,
 324                                union smb_fileinfo *parms);
 325 struct smbcli_request *smb_raw_pathinfo_send(struct smbcli_tree *tree,
 326                                              union smb_fileinfo *parms);
 327 struct smbcli_request *smb_raw_setpathinfo_send(struct smbcli_tree *tree,
 328                                              union smb_setfileinfo *parms);
 329 struct smbcli_request *smb_raw_echo_send(struct smbcli_transport *transport,
 330                                          struct smb_echo *p);
 331 NTSTATUS smb_raw_search_first(struct smbcli_tree *tree,
 332                               TALLOC_CTX *mem_ctx,
 333                               union smb_search_first *io, void *private_data,
 334                               smbcli_search_callback callback);
 335 NTSTATUS smb_raw_flush(struct smbcli_tree *tree, union smb_flush *parms);
 336
 337 NTSTATUS smb_raw_trans(struct smbcli_tree *tree,
 338                        TALLOC_CTX *mem_ctx,
 339                        struct smb_trans2 *parms);
 340
 341 #endif /* __LIBCLI_RAW__H__ */