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 2 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, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22
  23 #include "request.h"
  24
  25 struct smbcli_tree;  /* forward declare */
  26 struct smbcli_request;  /* forward declare */
  27 struct smbcli_session;  /* forward declare */
  28 struct smbcli_transport;  /* forward declare */
  29
  30 /* context that will be and has been negotiated between the client and server */
  31 struct smbcli_negotiate {
  32         /*
  33          * negotiated maximum transmit size - this is given to us by the server
  34          */
  35         uint32_t max_xmit;
  36
  37         /* maximum number of requests that can be multiplexed */
  38         uint16_t max_mux;
  39
  40         /* the negotiatiated protocol */
  41         enum protocol_types protocol;
  42
  43         uint8_t sec_mode;               /* security mode returned by negprot */
  44         uint8_t key_len;
  45         DATA_BLOB server_guid;      /* server_guid */
  46         DATA_BLOB secblob;      /* cryptkey or negTokenInit blob */
  47         uint32_t sesskey;
  48
  49         struct smb_signing_context sign_info;
  50
  51         /* capabilities that the server reported */
  52         uint32_t capabilities;
  53
  54         int server_zone;
  55         time_t server_time;
  56         uint_t readbraw_supported:1;
  57         uint_t writebraw_supported:1;
  58
  59         char *server_domain;
  60 };
  61
  62 /* this is the context for a SMB socket associated with the socket itself */
  63 struct smbcli_socket {
  64         struct socket_context *sock;
  65
  66         /* what port we ended up connected to */
  67         int port;
  68
  69         /* the hostname we connected to */
  70         const char *hostname;
  71
  72         /* the event handle for waiting for socket IO */
  73         struct {
  74                 struct event_context *ctx;
  75                 struct fd_event *fde;
  76                 struct timed_event *te;
  77         } event;
  78 };
  79
  80 /*
  81   this structure allows applications to control the behaviour of the
  82   client library
  83 */
  84 struct smbcli_options {
  85         uint_t use_oplocks:1;
  86         uint_t use_level2_oplocks:1;
  87         uint_t use_spnego:1;
  88         uint32_t max_xmit;
  89         uint16_t max_mux;
  90 };
  91
  92 /* this is the context for the client transport layer */
  93 struct smbcli_transport {
  94         /* socket level info */
  95         struct smbcli_socket *socket;
  96
  97         /* the next mid to be allocated - needed for signing and
  98            request matching */
  99         uint16_t next_mid;
 100
 101         /* negotiated protocol information */
 102         struct smbcli_negotiate negotiate;
 103
 104         /* options to control the behaviour of the client code */
 105         struct smbcli_options options;
 106
 107         /* is a readbraw pending? we need to handle that case
 108            specially on receiving packets */
 109         uint_t readbraw_pending:1;
 110
 111         /* an idle function - if this is defined then it will be
 112            called once every period microseconds while we are waiting
 113            for a packet */
 114         struct {
 115                 void (*func)(struct smbcli_transport *, void *);
 116                 void *private;
 117                 uint_t period;
 118         } idle;
 119
 120         /* the error fields from the last message */
 121         struct {
 122                 enum {ETYPE_NONE, ETYPE_DOS, ETYPE_NT, ETYPE_SOCKET, ETYPE_NBT} etype;
 123                 union {
 124                         struct {
 125                                 uint8_t eclass;
 126                                 uint16_t ecode;
 127                         } dos;
 128                         NTSTATUS nt_status;
 129                         enum {SOCKET_READ_TIMEOUT,
 130                               SOCKET_READ_EOF,
 131                               SOCKET_READ_ERROR,
 132                               SOCKET_WRITE_ERROR,
 133                               SOCKET_READ_BAD_SIG} socket_error;
 134                         uint_t nbt_error;
 135                 } e;
 136         } error;
 137
 138         struct {
 139                 /* a oplock break request handler */
 140                 BOOL (*handler)(struct smbcli_transport *transport,
 141                                 uint16_t tid, uint16_t fnum, uint8_t level, void *private);
 142                 /* private data passed to the oplock handler */
 143                 void *private;
 144         } oplock;
 145
 146         /* a list of async requests that are pending for send on this connection */
 147         struct smbcli_request *pending_send;
 148
 149         /* a list of async requests that are pending for receive on this connection */
 150         struct smbcli_request *pending_recv;
 151
 152         /* remember the called name - some sub-protocols require us to
 153            know the server name */
 154         struct nmb_name called;
 155
 156         /* a buffer for partially received SMB packets. */
 157         struct {
 158                 uint8_t header[NBT_HDR_SIZE];
 159                 size_t req_size;
 160                 size_t received;
 161                 uint8_t *buffer;
 162         } recv_buffer;
 163 };
 164
 165 /* this is the context for the user */
 166
 167 /* this is the context for the session layer */
 168 struct smbcli_session {
 169         /* transport layer info */
 170         struct smbcli_transport *transport;
 171
 172         /* after a session setup the server provides us with
 173            a vuid identifying the security context */
 174         uint16_t vuid;
 175
 176         /* default pid for this session */
 177         uint32_t pid;
 178
 179         /* the flags2 for each packet - this allows
 180            the user to control these for torture testing */
 181         uint16_t flags2;
 182
 183         DATA_BLOB user_session_key;
 184
 185         /* the spnego context if we use extented security */
 186         struct gensec_security *gensec;
 187 };
 188
 189 /*
 190    smbcli_tree context: internal state for a tree connection.
 191  */
 192 struct smbcli_tree {
 193         /* session layer info */
 194         struct smbcli_session *session;
 195
 196         uint16_t tid;                   /* tree id, aka cnum */
 197         char *device;
 198         char *fs_type;
 199 };
 200
 201
 202 /*
 203   a client request moves between the following 4 states.
 204 */
 205 enum smbcli_request_state {SMBCLI_REQUEST_INIT, /* we are creating the request */
 206                         SMBCLI_REQUEST_SEND, /* the request is in the outgoing socket Q */
 207                         SMBCLI_REQUEST_RECV, /* we are waiting for a matching reply */
 208                         SMBCLI_REQUEST_DONE, /* the request is finished */
 209                         SMBCLI_REQUEST_ERROR}; /* a packet or transport level error has occurred */
 210
 211 /* the context for a single SMB request. This is passed to any request-context
 212  * functions (similar to context.h, the server version).
 213  * This will allow requests to be multi-threaded. */
 214 struct smbcli_request {
 215         /* allow a request to be part of a list of requests */
 216         struct smbcli_request *next, *prev;
 217
 218         /* each request is in one of 4 possible states */
 219         enum smbcli_request_state state;
 220
 221         /* a request always has a transport context, nearly always has
 222            a session context and usually has a tree context */
 223         struct smbcli_transport *transport;
 224         struct smbcli_session *session;
 225         struct smbcli_tree *tree;
 226
 227         /* the flags2 from the SMB request, in raw form (host byte
 228            order). Used to parse strings */
 229         uint16_t flags2;
 230
 231         /* the NT status for this request. Set by packet receive code
 232            or code detecting error. */
 233         NTSTATUS status;
 234
 235         /* the sequence number of this packet - used for signing */
 236         uint_t seq_num;
 237
 238         /* set if this is a one-way request, meaning we are not
 239            expecting a reply from the server. */
 240         uint_t one_way_request:1;
 241
 242         /* set this when the request should only increment the signing
 243            counter by one */
 244         uint_t sign_single_increment:1;
 245
 246         /* the mid of this packet - used to match replies */
 247         uint16_t mid;
 248
 249         struct request_buffer in;
 250         struct request_buffer out;
 251
 252         /* information on what to do with a reply when it is received
 253            asyncronously. If this is not setup when a reply is received then
 254            the reply is discarded
 255
 256            The private pointer is private to the caller of the client
 257            library (the application), not private to the library
 258         */
 259         struct {
 260                 void (*fn)(struct smbcli_request *);
 261                 void *private;
 262         } async;
 263 };
 264
 265 /* useful way of catching wct errors with file and line number */
 266 #define SMBCLI_CHECK_MIN_WCT(req, wcount) if ((req)->in.wct < (wcount)) { \
 267       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected min %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
 268       req->status = NT_STATUS_INVALID_PARAMETER; \
 269       goto failed; \
 270 }
 271
 272 #define SMBCLI_CHECK_WCT(req, wcount) if ((req)->in.wct != (wcount)) { \
 273       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
 274       req->status = NT_STATUS_INVALID_PARAMETER; \
 275       goto failed; \
 276 }