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 };
 108
 109 /* this is the context for the client transport layer */
 110 struct smbcli_transport {
 111         struct tevent_context *ev; /* TODO: remove this !!! */
 112         struct smbXcli_conn *conn;
 113
 114         /* negotiated protocol information */
 115         struct smbcli_negotiate negotiate;
 116
 117         /* options to control the behaviour of the client code */
 118         struct smbcli_options options;
 119
 120         /* an idle function - if this is defined then it will be
 121            called once every period microseconds while we are waiting
 122            for a packet */
 123         struct {
 124                 void (*func)(struct smbcli_transport *, void *);
 125                 void *private_data;
 126                 unsigned int period;
 127                 struct tevent_timer *te;
 128         } idle;
 129
 130         /* the error fields from the last message */
 131         struct {
 132                 enum {ETYPE_NONE, ETYPE_SMB, ETYPE_SOCKET, ETYPE_NBT} etype;
 133                 union {
 134                         NTSTATUS nt_status;
 135                         enum {SOCKET_READ_TIMEOUT,
 136                               SOCKET_READ_EOF,
 137                               SOCKET_READ_ERROR,
 138                               SOCKET_WRITE_ERROR,
 139                               SOCKET_READ_BAD_SIG} socket_error;
 140                         unsigned int nbt_error;
 141                 } e;
 142         } error;
 143
 144         struct {
 145                 /* a oplock break request handler */
 146                 bool (*handler)(struct smbcli_transport *transport,
 147                                 uint16_t tid, uint16_t fnum, uint8_t level, void *private_data);
 148                 /* private data passed to the oplock handler */
 149                 void *private_data;
 150         } oplock;
 151         struct tevent_req *break_subreq;
 152 };
 153
 154 /* this is the context for the user */
 155
 156 /* this is the context for the session layer */
 157 struct smbcli_session {
 158         /* transport layer info */
 159         struct smbcli_transport *transport;
 160
 161         /* after a session setup the server provides us with
 162            a vuid identifying the security context */
 163         struct smbXcli_session *smbXcli;
 164         uint16_t vuid;
 165
 166         /* default pid for this session */
 167         uint32_t pid;
 168
 169         /* the flags2 for each packet - this allows
 170            the user to control these for torture testing */
 171         uint16_t flags2;
 172
 173         /* the spnego context if we use extented security */
 174         struct gensec_security *gensec;
 175
 176         struct smbcli_session_options {
 177                 unsigned int lanman_auth:1;
 178                 unsigned int ntlmv2_auth:1;
 179                 unsigned int plaintext_auth:1;
 180         } options;
 181
 182         const char *os;
 183         const char *lanman;
 184 };
 185
 186 /*
 187    smbcli_tree context: internal state for a tree connection.
 188  */
 189 struct smbcli_tree {
 190         /* session layer info */
 191         struct smbcli_session *session;
 192
 193         struct smbXcli_tcon *smbXcli;
 194         uint16_t tid;                   /* tree id, aka cnum */
 195         char *device;
 196         char *fs_type;
 197 };
 198
 199
 200 /*
 201   a client request moves between the following 4 states.
 202 */
 203 enum smbcli_request_state {SMBCLI_REQUEST_INIT, /* we are creating the request */
 204                         SMBCLI_REQUEST_RECV, /* we are waiting for a matching reply */
 205                         SMBCLI_REQUEST_DONE, /* the request is finished */
 206                         SMBCLI_REQUEST_ERROR}; /* a packet or transport level error has occurred */
 207
 208 /* the context for a single SMB request. This is passed to any request-context
 209  * functions (similar to context.h, the server version).
 210  * This will allow requests to be multi-threaded. */
 211 struct smbcli_request {
 212         /* smbXcli_req */
 213         struct tevent_req *subreqs[2];
 214
 215         /* each request is in one of 4 possible states */
 216         enum smbcli_request_state state;
 217
 218         /* a request always has a transport context, nearly always has
 219            a session context and usually has a tree context */
 220         struct smbcli_transport *transport;
 221         struct smbcli_session *session;
 222         struct smbcli_tree *tree;
 223
 224         /* the flags2 from the SMB request, in raw form (host byte
 225            order). Used to parse strings */
 226         uint16_t flags2;
 227
 228         /* the NT status for this request. Set by packet receive code
 229            or code detecting error. */
 230         NTSTATUS status;
 231
 232         /* the caller wants to do the signing check */
 233         bool sign_caller_checks;
 234
 235         /* give the caller a chance to prevent the talloc_free() in the _recv() function */
 236         bool do_not_free;
 237
 238         struct smb_request_buffer in;
 239         struct smb_request_buffer out;
 240
 241         struct smb_trans2 trans2;
 242         struct smb_nttrans nttrans;
 243
 244         /* information on what to do with a reply when it is received
 245            asyncronously. If this is not setup when a reply is received then
 246            the reply is discarded
 247
 248            The private pointer is private to the caller of the client
 249            library (the application), not private to the library
 250         */
 251         struct {
 252                 void (*fn)(struct smbcli_request *);
 253                 void *private_data;
 254         } async;
 255 };
 256
 257 /* useful way of catching wct errors with file and line number */
 258 #define SMBCLI_CHECK_MIN_WCT(req, wcount) if ((req)->in.wct < (wcount)) { \
 259       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected min %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
 260       req->status = NT_STATUS_INVALID_PARAMETER; \
 261       goto failed; \
 262 }
 263
 264 #define SMBCLI_CHECK_WCT(req, wcount) if ((req)->in.wct != (wcount)) { \
 265       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
 266       req->status = NT_STATUS_INVALID_PARAMETER; \
 267       goto failed; \
 268 }
 269
 270 NTSTATUS smb_raw_read_recv(struct smbcli_request *req, union smb_read *parms);
 271 struct smbcli_request *smb_raw_read_send(struct smbcli_tree *tree, union smb_read *parms);
 272 NTSTATUS smb_raw_trans_recv(struct smbcli_request *req,
 273                              TALLOC_CTX *mem_ctx,
 274                              struct smb_trans2 *parms);
 275 struct smbcli_request *smb_raw_trans_send(struct smbcli_tree *tree, struct smb_trans2 *parms);
 276 NTSTATUS smbcli_request_destroy(struct smbcli_request *req);
 277 struct smbcli_request *smb_raw_write_send(struct smbcli_tree *tree, union smb_write *parms);
 278 NTSTATUS smb_raw_write_recv(struct smbcli_request *req, union smb_write *parms);
 279 struct smbcli_request *smb_raw_close_send(struct smbcli_tree *tree, union smb_close *parms);
 280 NTSTATUS smb_raw_open_recv(struct smbcli_request *req, TALLOC_CTX *mem_ctx, union smb_open *parms);
 281 struct smbcli_request *smb_raw_open_send(struct smbcli_tree *tree, union smb_open *parms);
 282
 283 bool smbcli_transport_process(struct smbcli_transport *transport);
 284 const char *smbcli_errstr(struct smbcli_tree *tree);
 285 NTSTATUS smb_raw_fsinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_fsinfo *fsinfo);
 286 NTSTATUS smb_raw_setfsinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_setfsinfo *set_fsinfo);
 287 NTSTATUS smb_raw_pathinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_fileinfo *parms);
 288 NTSTATUS smb_raw_shadow_data(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, struct smb_shadow_copy *info);
 289 NTSTATUS smb_raw_fileinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_fileinfo *parms);
 290 struct smbcli_tree *smbcli_tree_init(struct smbcli_session *session, TALLOC_CTX *parent_ctx, bool primary);
 291 NTSTATUS smb_raw_tcon(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_tcon *parms);
 292 void smbcli_oplock_handler(struct smbcli_transport *transport,
 293                         bool (*handler)(struct smbcli_transport *, uint16_t, uint16_t, uint8_t, void *),
 294                         void *private_data);
 295 void smbcli_transport_idle_handler(struct smbcli_transport *transport,
 296                                    void (*idle_func)(struct smbcli_transport *, void *),
 297                                    uint64_t period,
 298                                    void *private_data);
 299 NTSTATUS smbcli_request_simple_recv(struct smbcli_request *req);
 300 bool smbcli_oplock_ack(struct smbcli_tree *tree, uint16_t fnum, uint16_t ack_level);
 301 NTSTATUS smb_raw_open(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_open *parms);
 302 NTSTATUS smb_raw_close(struct smbcli_tree *tree, union smb_close *parms);
 303 NTSTATUS smb_raw_unlink(struct smbcli_tree *tree, union smb_unlink *parms);
 304 NTSTATUS smb_raw_chkpath(struct smbcli_tree *tree, union smb_chkpath *parms);
 305 NTSTATUS smb_raw_mkdir(struct smbcli_tree *tree, union smb_mkdir *parms);
 306 NTSTATUS smb_raw_rmdir(struct smbcli_tree *tree, struct smb_rmdir *parms);
 307 NTSTATUS smb_raw_rename(struct smbcli_tree *tree, union smb_rename *parms);
 308 NTSTATUS smb_raw_seek(struct smbcli_tree *tree, union smb_seek *parms);
 309 NTSTATUS smb_raw_read(struct smbcli_tree *tree, union smb_read *parms);
 310 NTSTATUS smb_raw_write(struct smbcli_tree *tree, union smb_write *parms);
 311 NTSTATUS smb_raw_lock(struct smbcli_tree *tree, union smb_lock *parms);
 312 NTSTATUS smb_raw_setpathinfo(struct smbcli_tree *tree, union smb_setfileinfo *parms);
 313 NTSTATUS smb_raw_setfileinfo(struct smbcli_tree *tree, union smb_setfileinfo *parms);
 314
 315 struct smbcli_request *smb_raw_changenotify_send(struct smbcli_tree *tree, union smb_notify *parms);
 316 NTSTATUS smb_raw_changenotify_recv(struct smbcli_request *req, TALLOC_CTX *mem_ctx, union smb_notify *parms);
 317
 318 NTSTATUS smb_tree_disconnect(struct smbcli_tree *tree);
 319 NTSTATUS smbcli_nt_error(struct smbcli_tree *tree);
 320 NTSTATUS smb_raw_exit(struct smbcli_session *session);
 321 NTSTATUS smb_raw_pathinfo_recv(struct smbcli_request *req,
 322                                TALLOC_CTX *mem_ctx,
 323                                union smb_fileinfo *parms);
 324 struct smbcli_request *smb_raw_pathinfo_send(struct smbcli_tree *tree,
 325                                              union smb_fileinfo *parms);
 326 struct smbcli_request *smb_raw_setpathinfo_send(struct smbcli_tree *tree,
 327                                              union smb_setfileinfo *parms);
 328 struct smbcli_request *smb_raw_echo_send(struct smbcli_transport *transport,
 329                                          struct smb_echo *p);
 330 NTSTATUS smb_raw_search_first(struct smbcli_tree *tree,
 331                               TALLOC_CTX *mem_ctx,
 332                               union smb_search_first *io, void *private_data,
 333                               smbcli_search_callback callback);
 334 NTSTATUS smb_raw_flush(struct smbcli_tree *tree, union smb_flush *parms);
 335
 336 NTSTATUS smb_raw_trans(struct smbcli_tree *tree,
 337                        TALLOC_CTX *mem_ctx,
 338                        struct smb_trans2 *parms);
 339
 340 #endif /* __LIBCLI_RAW__H__ */