fs/cifs/smb2misc.c

   1 /*
   2  *   fs/cifs/smb2misc.c
   3  *
   4  *   Copyright (C) International Business Machines  Corp., 2002,2011
   5  *                 Etersoft, 2012
   6  *   Author(s): Steve French (sfrench@us.ibm.com)
   7  *              Pavel Shilovsky (pshilovsky@samba.org) 2012
   8  *
   9  *   This library is free software; you can redistribute it and/or modify
  10  *   it under the terms of the GNU Lesser General Public License as published
  11  *   by the Free Software Foundation; either version 2.1 of the License, or
  12  *   (at your option) any later version.
  13  *
  14  *   This library is distributed in the hope that it will be useful,
  15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  17  *   the GNU Lesser General Public License for more details.
  18  *
  19  *   You should have received a copy of the GNU Lesser General Public License
  20  *   along with this library; if not, write to the Free Software
  21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22  */
  23 #include <linux/ctype.h>
  24 #include "smb2pdu.h"
  25 #include "cifsglob.h"
  26 #include "cifsproto.h"
  27 #include "smb2proto.h"
  28 #include "cifs_debug.h"
  29 #include "cifs_unicode.h"
  30 #include "smb2status.h"
  31
  32 static int
  33 check_smb2_hdr(struct smb2_hdr *hdr, __u64 mid)
  34 {
  35         /*
  36          * Make sure that this really is an SMB, that it is a response,
  37          * and that the message ids match.
  38          */
  39         if ((*(__le32 *)hdr->ProtocolId == SMB2_PROTO_NUMBER) &&
  40             (mid == hdr->MessageId)) {
  41                 if (hdr->Flags & SMB2_FLAGS_SERVER_TO_REDIR)
  42                         return 0;
  43                 else {
  44                         /* only one valid case where server sends us request */
  45                         if (hdr->Command == SMB2_OPLOCK_BREAK)
  46                                 return 0;
  47                         else
  48                                 cERROR(1, "Received Request not response");
  49                 }
  50         } else { /* bad signature or mid */
  51                 if (*(__le32 *)hdr->ProtocolId != SMB2_PROTO_NUMBER)
  52                         cERROR(1, "Bad protocol string signature header %x",
  53                                   *(unsigned int *) hdr->ProtocolId);
  54                 if (mid != hdr->MessageId)
  55                         cERROR(1, "Mids do not match: %llu and %llu", mid,
  56                                   hdr->MessageId);
  57         }
  58         cERROR(1, "Bad SMB detected. The Mid=%llu", hdr->MessageId);
  59         return 1;
  60 }
  61
  62 /*
  63  *  The following table defines the expected "StructureSize" of SMB2 responses
  64  *  in order by SMB2 command.  This is similar to "wct" in SMB/CIFS responses.
  65  *
  66  *  Note that commands are defined in smb2pdu.h in le16 but the array below is
  67  *  indexed by command in host byte order
  68  */
  69 static const __le16 smb2_rsp_struct_sizes[NUMBER_OF_SMB2_COMMANDS] = {
  70         /* SMB2_NEGOTIATE */ __constant_cpu_to_le16(65),
  71         /* SMB2_SESSION_SETUP */ __constant_cpu_to_le16(9),
  72         /* SMB2_LOGOFF */ __constant_cpu_to_le16(4),
  73         /* SMB2_TREE_CONNECT */ __constant_cpu_to_le16(16),
  74         /* SMB2_TREE_DISCONNECT */ __constant_cpu_to_le16(4),
  75         /* SMB2_CREATE */ __constant_cpu_to_le16(89),
  76         /* SMB2_CLOSE */ __constant_cpu_to_le16(60),
  77         /* SMB2_FLUSH */ __constant_cpu_to_le16(4),
  78         /* SMB2_READ */ __constant_cpu_to_le16(17),
  79         /* SMB2_WRITE */ __constant_cpu_to_le16(17),
  80         /* SMB2_LOCK */ __constant_cpu_to_le16(4),
  81         /* SMB2_IOCTL */ __constant_cpu_to_le16(49),
  82         /* BB CHECK this ... not listed in documentation */
  83         /* SMB2_CANCEL */ __constant_cpu_to_le16(0),
  84         /* SMB2_ECHO */ __constant_cpu_to_le16(4),
  85         /* SMB2_QUERY_DIRECTORY */ __constant_cpu_to_le16(9),
  86         /* SMB2_CHANGE_NOTIFY */ __constant_cpu_to_le16(9),
  87         /* SMB2_QUERY_INFO */ __constant_cpu_to_le16(9),
  88         /* SMB2_SET_INFO */ __constant_cpu_to_le16(2),
  89         /* BB FIXME can also be 44 for lease break */
  90         /* SMB2_OPLOCK_BREAK */ __constant_cpu_to_le16(24)
  91 };
  92
  93 int
  94 smb2_check_message(char *buf, unsigned int length)
  95 {
  96         struct smb2_hdr *hdr = (struct smb2_hdr *)buf;
  97         struct smb2_pdu *pdu = (struct smb2_pdu *)hdr;
  98         __u64 mid = hdr->MessageId;
  99         __u32 len = get_rfc1002_length(buf);
 100         __u32 clc_len;  /* calculated length */
 101         int command;
 102
 103         /* BB disable following printk later */
 104         cFYI(1, "%s length: 0x%x, smb_buf_length: 0x%x", __func__, length, len);
 105
 106         /*
 107          * Add function to do table lookup of StructureSize by command
 108          * ie Validate the wct via smb2_struct_sizes table above
 109          */
 110
 111         if (length < sizeof(struct smb2_pdu)) {
 112                 if ((length >= sizeof(struct smb2_hdr)) && (hdr->Status != 0)) {
 113                         pdu->StructureSize2 = 0;
 114                         /*
 115                          * As with SMB/CIFS, on some error cases servers may
 116                          * not return wct properly
 117                          */
 118                         return 0;
 119                 } else {
 120                         cERROR(1, "Length less than SMB header size");
 121                 }
 122                 return 1;
 123         }
 124         if (len > CIFSMaxBufSize + MAX_SMB2_HDR_SIZE - 4) {
 125                 cERROR(1, "SMB length greater than maximum, mid=%llu", mid);
 126                 return 1;
 127         }
 128
 129         if (check_smb2_hdr(hdr, mid))
 130                 return 1;
 131
 132         if (hdr->StructureSize != SMB2_HEADER_STRUCTURE_SIZE) {
 133                 cERROR(1, "Illegal structure size %u",
 134                           le16_to_cpu(hdr->StructureSize));
 135                 return 1;
 136         }
 137
 138         command = le16_to_cpu(hdr->Command);
 139         if (command >= NUMBER_OF_SMB2_COMMANDS) {
 140                 cERROR(1, "Illegal SMB2 command %d", command);
 141                 return 1;
 142         }
 143
 144         if (smb2_rsp_struct_sizes[command] != pdu->StructureSize2) {
 145                 if (command != SMB2_OPLOCK_BREAK_HE && (hdr->Status == 0 ||
 146                     pdu->StructureSize2 != SMB2_ERROR_STRUCTURE_SIZE2)) {
 147                         /* error packets have 9 byte structure size */
 148                         cERROR(1, "Illegal response size %u for command %d",
 149                                    le16_to_cpu(pdu->StructureSize2), command);
 150                         return 1;
 151                 }
 152         }
 153
 154         if (4 + len != length) {
 155                 cERROR(1, "Total length %u RFC1002 length %u mismatch mid %llu",
 156                           length, 4 + len, mid);
 157                 return 1;
 158         }
 159
 160         clc_len = smb2_calc_size(hdr);
 161
 162         if (4 + len != clc_len) {
 163                 cFYI(1, "Calculated size %u length %u mismatch mid %llu",
 164                         clc_len, 4 + len, mid);
 165                 /* Windows 7 server returns 24 bytes more */
 166                 if (clc_len + 20 == len && command == SMB2_OPLOCK_BREAK_HE)
 167                         return 0;
 168                 /* server can return one byte more */
 169                 if (clc_len == 4 + len + 1)
 170                         return 0;
 171                 return 1;
 172         }
 173         return 0;
 174 }
 175
 176 /*
 177  * The size of the variable area depends on the offset and length fields
 178  * located in different fields for various SMB2 responses. SMB2 responses
 179  * with no variable length info, show an offset of zero for the offset field.
 180  */
 181 static const bool has_smb2_data_area[NUMBER_OF_SMB2_COMMANDS] = {
 182         /* SMB2_NEGOTIATE */ true,
 183         /* SMB2_SESSION_SETUP */ true,
 184         /* SMB2_LOGOFF */ false,
 185         /* SMB2_TREE_CONNECT */ false,
 186         /* SMB2_TREE_DISCONNECT */ false,
 187         /* SMB2_CREATE */ true,
 188         /* SMB2_CLOSE */ false,
 189         /* SMB2_FLUSH */ false,
 190         /* SMB2_READ */ true,
 191         /* SMB2_WRITE */ false,
 192         /* SMB2_LOCK */ false,
 193         /* SMB2_IOCTL */ true,
 194         /* SMB2_CANCEL */ false, /* BB CHECK this not listed in documentation */
 195         /* SMB2_ECHO */ false,
 196         /* SMB2_QUERY_DIRECTORY */ true,
 197         /* SMB2_CHANGE_NOTIFY */ true,
 198         /* SMB2_QUERY_INFO */ true,
 199         /* SMB2_SET_INFO */ false,
 200         /* SMB2_OPLOCK_BREAK */ false
 201 };
 202
 203 /*
 204  * Returns the pointer to the beginning of the data area. Length of the data
 205  * area and the offset to it (from the beginning of the smb are also returned.
 206  */
 207 char *
 208 smb2_get_data_area_len(int *off, int *len, struct smb2_hdr *hdr)
 209 {
 210         *off = 0;
 211         *len = 0;
 212
 213         /* error responses do not have data area */
 214         if (hdr->Status && hdr->Status != STATUS_MORE_PROCESSING_REQUIRED &&
 215             (((struct smb2_err_rsp *)hdr)->StructureSize) ==
 216                                                 SMB2_ERROR_STRUCTURE_SIZE2)
 217                 return NULL;
 218
 219         /*
 220          * Following commands have data areas so we have to get the location
 221          * of the data buffer offset and data buffer length for the particular
 222          * command.
 223          */
 224         switch (hdr->Command) {
 225         case SMB2_NEGOTIATE:
 226                 *off = le16_to_cpu(
 227                     ((struct smb2_negotiate_rsp *)hdr)->SecurityBufferOffset);
 228                 *len = le16_to_cpu(
 229                     ((struct smb2_negotiate_rsp *)hdr)->SecurityBufferLength);
 230                 break;
 231         case SMB2_SESSION_SETUP:
 232                 *off = le16_to_cpu(
 233                     ((struct smb2_sess_setup_rsp *)hdr)->SecurityBufferOffset);
 234                 *len = le16_to_cpu(
 235                     ((struct smb2_sess_setup_rsp *)hdr)->SecurityBufferLength);
 236                 break;
 237         case SMB2_CREATE:
 238                 *off = le32_to_cpu(
 239                     ((struct smb2_create_rsp *)hdr)->CreateContextsOffset);
 240                 *len = le32_to_cpu(
 241                     ((struct smb2_create_rsp *)hdr)->CreateContextsLength);
 242                 break;
 243         case SMB2_QUERY_INFO:
 244                 *off = le16_to_cpu(
 245                     ((struct smb2_query_info_rsp *)hdr)->OutputBufferOffset);
 246                 *len = le32_to_cpu(
 247                     ((struct smb2_query_info_rsp *)hdr)->OutputBufferLength);
 248                 break;
 249         case SMB2_READ:
 250                 *off = ((struct smb2_read_rsp *)hdr)->DataOffset;
 251                 *len = le32_to_cpu(((struct smb2_read_rsp *)hdr)->DataLength);
 252                 break;
 253         case SMB2_QUERY_DIRECTORY:
 254                 *off = le16_to_cpu(
 255                   ((struct smb2_query_directory_rsp *)hdr)->OutputBufferOffset);
 256                 *len = le32_to_cpu(
 257                   ((struct smb2_query_directory_rsp *)hdr)->OutputBufferLength);
 258                 break;
 259         case SMB2_IOCTL:
 260         case SMB2_CHANGE_NOTIFY:
 261         default:
 262                 /* BB FIXME for unimplemented cases above */
 263                 cERROR(1, "no length check for command");
 264                 break;
 265         }
 266
 267         /*
 268          * Invalid length or offset probably means data area is invalid, but
 269          * we have little choice but to ignore the data area in this case.
 270          */
 271         if (*off > 4096) {
 272                 cERROR(1, "offset %d too large, data area ignored", *off);
 273                 *len = 0;
 274                 *off = 0;
 275         } else if (*off < 0) {
 276                 cERROR(1, "negative offset %d to data invalid ignore data area",
 277                           *off);
 278                 *off = 0;
 279                 *len = 0;
 280         } else if (*len < 0) {
 281                 cERROR(1, "negative data length %d invalid, data area ignored",
 282                           *len);
 283                 *len = 0;
 284         } else if (*len > 128 * 1024) {
 285                 cERROR(1, "data area larger than 128K: %d", *len);
 286                 *len = 0;
 287         }
 288
 289         /* return pointer to beginning of data area, ie offset from SMB start */
 290         if ((*off != 0) && (*len != 0))
 291                 return hdr->ProtocolId + *off;
 292         else
 293                 return NULL;
 294 }
 295
 296 /*
 297  * Calculate the size of the SMB message based on the fixed header
 298  * portion, the number of word parameters and the data portion of the message.
 299  */
 300 unsigned int
 301 smb2_calc_size(void *buf)
 302 {
 303         struct smb2_hdr *hdr = (struct smb2_hdr *)buf;
 304         struct smb2_pdu *pdu = (struct smb2_pdu *)hdr;
 305         int offset; /* the offset from the beginning of SMB to data area */
 306         int data_length; /* the length of the variable length data area */
 307         /* Structure Size has already been checked to make sure it is 64 */
 308         int len = 4 + le16_to_cpu(pdu->hdr.StructureSize);
 309
 310         /*
 311          * StructureSize2, ie length of fixed parameter area has already
 312          * been checked to make sure it is the correct length.
 313          */
 314         len += le16_to_cpu(pdu->StructureSize2);
 315
 316         if (has_smb2_data_area[le16_to_cpu(hdr->Command)] == false)
 317                 goto calc_size_exit;
 318
 319         smb2_get_data_area_len(&offset, &data_length, hdr);
 320         cFYI(1, "SMB2 data length %d offset %d", data_length, offset);
 321
 322         if (data_length > 0) {
 323                 /*
 324                  * Check to make sure that data area begins after fixed area,
 325                  * Note that last byte of the fixed area is part of data area
 326                  * for some commands, typically those with odd StructureSize,
 327                  * so we must add one to the calculation (and 4 to account for
 328                  * the size of the RFC1001 hdr.
 329                  */
 330                 if (offset + 4 + 1 < len) {
 331                         cERROR(1, "data area offset %d overlaps SMB2 header %d",
 332                                   offset + 4 + 1, len);
 333                         data_length = 0;
 334                 } else {
 335                         len = 4 + offset + data_length;
 336                 }
 337         }
 338 calc_size_exit:
 339         cFYI(1, "SMB2 len %d", len);
 340         return len;
 341 }
 342
 343 /* Note: caller must free return buffer */
 344 __le16 *
 345 cifs_convert_path_to_utf16(const char *from, struct cifs_sb_info *cifs_sb)
 346 {
 347         int len;
 348         const char *start_of_path;
 349         __le16 *to;
 350
 351         /* Windows doesn't allow paths beginning with \ */
 352         if (from[0] == '\\')
 353                 start_of_path = from + 1;
 354         else
 355                 start_of_path = from;
 356         to = cifs_strndup_to_utf16(start_of_path, PATH_MAX, &len,
 357                                    cifs_sb->local_nls,
 358                                    cifs_sb->mnt_cifs_flags &
 359                                         CIFS_MOUNT_MAP_SPECIAL_CHR);
 360         return to;
 361 }
 362
 363 bool
 364 smb2_is_valid_oplock_break(char *buffer, struct TCP_Server_Info *server)
 365 {
 366         struct smb2_oplock_break *rsp = (struct smb2_oplock_break *)buffer;
 367         struct list_head *tmp, *tmp1, *tmp2;
 368         struct cifs_ses *ses;
 369         struct cifs_tcon *tcon;
 370         struct cifsInodeInfo *cinode;
 371         struct cifsFileInfo *cfile;
 372
 373         cFYI(1, "Checking for oplock break");
 374
 375         if (rsp->hdr.Command != SMB2_OPLOCK_BREAK)
 376                 return false;
 377
 378         if (le16_to_cpu(rsp->StructureSize) !=
 379                                 smb2_rsp_struct_sizes[SMB2_OPLOCK_BREAK_HE]) {
 380                 return false;
 381         }
 382
 383         cFYI(1, "oplock level 0x%d", rsp->OplockLevel);
 384
 385         /* look up tcon based on tid & uid */
 386         spin_lock(&cifs_tcp_ses_lock);
 387         list_for_each(tmp, &server->smb_ses_list) {
 388                 ses = list_entry(tmp, struct cifs_ses, smb_ses_list);
 389                 list_for_each(tmp1, &ses->tcon_list) {
 390                         tcon = list_entry(tmp1, struct cifs_tcon, tcon_list);
 391
 392                         cifs_stats_inc(&tcon->stats.cifs_stats.num_oplock_brks);
 393                         spin_lock(&cifs_file_list_lock);
 394                         list_for_each(tmp2, &tcon->openFileList) {
 395                                 cfile = list_entry(tmp2, struct cifsFileInfo,
 396                                                      tlist);
 397                                 if (rsp->PersistentFid !=
 398                                     cfile->fid.persistent_fid ||
 399                                     rsp->VolatileFid !=
 400                                     cfile->fid.volatile_fid)
 401                                         continue;
 402
 403                                 cFYI(1, "file id match, oplock break");
 404                                 cinode = CIFS_I(cfile->dentry->d_inode);
 405
 406                                 if (!cinode->clientCanCacheAll &&
 407                                     rsp->OplockLevel == SMB2_OPLOCK_LEVEL_NONE)
 408                                         cfile->oplock_break_cancelled = true;
 409                                 else
 410                                         cfile->oplock_break_cancelled = false;
 411
 412                                 smb2_set_oplock_level(cinode,
 413                                   rsp->OplockLevel ? SMB2_OPLOCK_LEVEL_II : 0);
 414
 415                                 queue_work(cifsiod_wq, &cfile->oplock_break);
 416
 417                                 spin_unlock(&cifs_file_list_lock);
 418                                 spin_unlock(&cifs_tcp_ses_lock);
 419                                 return true;
 420                         }
 421                         spin_unlock(&cifs_file_list_lock);
 422                         spin_unlock(&cifs_tcp_ses_lock);
 423                         cFYI(1, "No matching file for oplock break");
 424                         return true;
 425                 }
 426         }
 427         spin_unlock(&cifs_tcp_ses_lock);
 428         cFYI(1, "Can not process oplock break for non-existent connection");
 429         return false;
 430 }