source4/libcli/smb2/request.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    SMB2 client request handling
   5
   6    Copyright (C) Andrew Tridgell 2005
   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 "includes.h"
  24 #include "libcli/raw/libcliraw.h"
  25 #include "libcli/smb2/smb2.h"
  26 #include "include/dlinklist.h"
  27 #include "lib/events/events.h"
  28
  29 /*
  30   initialise a smb2 request
  31 */
  32 struct smb2_request *smb2_request_init(struct smb2_transport *transport,
  33                                        uint16_t opcode, uint32_t body_size)
  34 {
  35         struct smb2_request *req;
  36
  37         req = talloc(transport, struct smb2_request);
  38         if (req == NULL) return NULL;
  39
  40         req->state     = SMB2_REQUEST_INIT;
  41         req->transport = transport;
  42         req->seqnum    = transport->seqnum++;
  43         req->status    = NT_STATUS_OK;
  44         req->async.fn  = NULL;
  45         req->next = req->prev = NULL;
  46
  47         ZERO_STRUCT(req->in);
  48
  49         req->out.allocated = SMB2_HDR_BODY+NBT_HDR_SIZE+body_size;
  50         req->out.buffer    = talloc_size(req, req->out.allocated);
  51         if (req->out.buffer == NULL) {
  52                 talloc_free(req);
  53                 return NULL;
  54         }
  55
  56         req->out.size      = SMB2_HDR_BODY+NBT_HDR_SIZE + body_size;
  57         req->out.hdr       = req->out.buffer + NBT_HDR_SIZE;
  58         req->out.body      = req->out.hdr + SMB2_HDR_BODY;
  59         req->out.body_size = body_size;
  60         req->out.ptr       = req->out.body;
  61
  62         SIVAL(req->out.hdr, 0,                SMB2_MAGIC);
  63         SSVAL(req->out.hdr, SMB2_HDR_LENGTH,  SMB2_HDR_BODY);
  64         SSVAL(req->out.hdr, SMB2_HDR_PAD1,    0);
  65         SIVAL(req->out.hdr, SMB2_HDR_STATUS,  0);
  66         SSVAL(req->out.hdr, SMB2_HDR_OPCODE,  opcode);
  67         SSVAL(req->out.hdr, SMB2_HDR_PAD2,    0);
  68         SIVAL(req->out.hdr, SMB2_HDR_FLAGS,   0);
  69         SIVAL(req->out.hdr, SMB2_HDR_UNKNOWN, 0);
  70         SBVAL(req->out.hdr, SMB2_HDR_SEQNUM,  req->seqnum);
  71         SIVAL(req->out.hdr, SMB2_HDR_PID,     0);
  72         SIVAL(req->out.hdr, SMB2_HDR_TID,     0);
  73         SBVAL(req->out.hdr, SMB2_HDR_UID,     0);
  74         memset(req->out.hdr+SMB2_HDR_SIG, 0, 16);
  75
  76         return req;
  77 }
  78
  79 /*
  80     initialise a smb2 request for tree operations
  81 */
  82 struct smb2_request *smb2_request_init_tree(struct smb2_tree *tree,
  83                                             uint16_t opcode, uint32_t body_size)
  84 {
  85         struct smb2_request *req = smb2_request_init(tree->session->transport, opcode,
  86                                                      body_size);
  87         if (req == NULL) return NULL;
  88
  89         SBVAL(req->out.hdr,  SMB2_HDR_UID, tree->session->uid);
  90         SIVAL(req->out.hdr,  SMB2_HDR_TID, tree->tid);
  91
  92         return req;
  93 }
  94
  95 /* destroy a request structure and return final status */
  96 NTSTATUS smb2_request_destroy(struct smb2_request *req)
  97 {
  98         NTSTATUS status;
  99
 100         /* this is the error code we give the application for when a
 101            _send() call fails completely */
 102         if (!req) return NT_STATUS_UNSUCCESSFUL;
 103
 104         if (req->transport) {
 105                 /* remove it from the list of pending requests (a null op if
 106                    its not in the list) */
 107                 DLIST_REMOVE(req->transport->pending_recv, req);
 108         }
 109
 110         if (req->state == SMBCLI_REQUEST_ERROR &&
 111             NT_STATUS_IS_OK(req->status)) {
 112                 req->status = NT_STATUS_INTERNAL_ERROR;
 113         }
 114
 115         status = req->status;
 116         talloc_free(req);
 117         return status;
 118 }
 119
 120 /*
 121   receive a response to a packet
 122 */
 123 BOOL smb2_request_receive(struct smb2_request *req)
 124 {
 125         /* req can be NULL when a send has failed. This eliminates lots of NULL
 126            checks in each module */
 127         if (!req) return False;
 128
 129         /* keep receiving packets until this one is replied to */
 130         while (req->state <= SMB2_REQUEST_RECV) {
 131                 if (event_loop_once(req->transport->socket->event.ctx) != 0) {
 132                         return False;
 133                 }
 134         }
 135
 136         return req->state == SMB2_REQUEST_DONE;
 137 }
 138
 139 /* Return true if the last packet was in error */
 140 BOOL smb2_request_is_error(struct smb2_request *req)
 141 {
 142         return NT_STATUS_IS_ERR(req->status);
 143 }
 144
 145 /*
 146   check if a range in the reply body is out of bounds
 147 */
 148 BOOL smb2_oob_in(struct smb2_request *req, const uint8_t *ptr, uint_t size)
 149 {
 150         /* be careful with wraparound! */
 151         if (ptr < req->in.body ||
 152             ptr >= req->in.body + req->in.body_size ||
 153             size > req->in.body_size ||
 154             ptr + size > req->in.body + req->in.body_size) {
 155                 return True;
 156         }
 157         return False;
 158 }
 159
 160 /*
 161   check if a range in the outgoing body is out of bounds
 162 */
 163 BOOL smb2_oob_out(struct smb2_request *req, const uint8_t *ptr, uint_t size)
 164 {
 165         /* be careful with wraparound! */
 166         if (ptr < req->out.body ||
 167             ptr >= req->out.body + req->out.body_size ||
 168             size > req->out.body_size ||
 169             ptr + size > req->out.body + req->out.body_size) {
 170                 return True;
 171         }
 172         return False;
 173 }
 174
 175 /*
 176   pull a data blob from the body of a reply
 177 */
 178 DATA_BLOB smb2_pull_blob(struct smb2_request *req, uint8_t *ptr, uint_t size)
 179 {
 180         if (smb2_oob_in(req, ptr, size)) {
 181                 return data_blob(NULL, 0);
 182         }
 183         return data_blob_talloc(req, ptr, size);
 184 }
 185
 186 /*
 187   pull a ofs/length/blob triple into a data blob
 188   the ptr points to the start of the offset/length pair
 189 */
 190 NTSTATUS smb2_pull_ofs_blob(struct smb2_request *req, uint8_t *ptr, DATA_BLOB *blob)
 191 {
 192         uint16_t ofs, size;
 193         if (smb2_oob_in(req, ptr, 4)) {
 194                 return NT_STATUS_BUFFER_TOO_SMALL;
 195         }
 196         ofs  = SVAL(ptr, 0);
 197         size = SVAL(ptr, 2);
 198         if (smb2_oob_in(req, req->in.hdr + ofs, size)) {
 199                 return NT_STATUS_BUFFER_TOO_SMALL;
 200         }
 201         *blob = data_blob_talloc(req, req->in.hdr+ofs, size);
 202         NT_STATUS_HAVE_NO_MEMORY(blob->data);
 203         return NT_STATUS_OK;
 204 }
 205
 206 /*
 207   push a ofs/length/blob triple into a data blob
 208   the ptr points to the start of the offset/length pair
 209
 210   NOTE: assumes blob goes immediately after the offset/length pair. Needs
 211         to be generalised
 212 */
 213 NTSTATUS smb2_push_ofs_blob(struct smb2_request *req, uint8_t *ptr, DATA_BLOB blob)
 214 {
 215         if (smb2_oob_out(req, ptr, 4+blob.length)) {
 216                 return NT_STATUS_BUFFER_TOO_SMALL;
 217         }
 218         SSVAL(ptr, 0, 4 + (ptr - req->out.hdr));
 219         SSVAL(ptr, 2, blob.length);
 220         memcpy(ptr+4, blob.data, blob.length);
 221         return NT_STATUS_OK;
 222 }
 223
 224 /*
 225   pull a string in a ofs/length/blob format
 226 */
 227 NTSTATUS smb2_pull_ofs_string(struct smb2_request *req, uint8_t *ptr,
 228                               const char **str)
 229 {
 230         DATA_BLOB blob;
 231         NTSTATUS status;
 232         ssize_t size;
 233         void *vstr;
 234         status = smb2_pull_ofs_blob(req, ptr, &blob);
 235         NT_STATUS_NOT_OK_RETURN(status);
 236         size = convert_string_talloc(req, CH_UTF16, CH_UNIX,
 237                                      blob.data, blob.length, &vstr);
 238         data_blob_free(&blob);
 239         (*str) = vstr;
 240         if (size == -1) {
 241                 return NT_STATUS_ILLEGAL_CHARACTER;
 242         }
 243         return NT_STATUS_OK;
 244 }
 245
 246 /*
 247   create a UTF16 string in a blob from a char*
 248 */
 249 NTSTATUS smb2_string_blob(TALLOC_CTX *mem_ctx, const char *str, DATA_BLOB *blob)
 250 {
 251         ssize_t size;
 252         size = convert_string_talloc(mem_ctx, CH_UNIX, CH_UTF16,
 253                                      str, strlen(str), (void **)&blob->data);
 254         if (size == -1) {
 255                 return NT_STATUS_ILLEGAL_CHARACTER;
 256         }
 257         blob->length = size;
 258         return NT_STATUS_OK;
 259 }