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