libcli/smb/util.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    client file operations
   4    Copyright (C) Andrew Tridgell 1994-1998
   5    Copyright (C) Jeremy Allison 2001-2002
   6    Copyright (C) James Myers 2003
   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 #include "includes.h"
  23 #include "libcli/smb/smb_common.h"
  24 #include "system/filesys.h"
  25
  26 /**
  27  Return a string representing a CIFS attribute for a file.
  28 **/
  29 char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib)
  30 {
  31         int i, len;
  32         const struct {
  33                 char c;
  34                 uint16_t attr;
  35         } attr_strs[] = {
  36                 {'V', FILE_ATTRIBUTE_VOLUME},
  37                 {'D', FILE_ATTRIBUTE_DIRECTORY},
  38                 {'A', FILE_ATTRIBUTE_ARCHIVE},
  39                 {'H', FILE_ATTRIBUTE_HIDDEN},
  40                 {'S', FILE_ATTRIBUTE_SYSTEM},
  41                 {'N', FILE_ATTRIBUTE_NORMAL},
  42                 {'R', FILE_ATTRIBUTE_READONLY},
  43                 {'d', FILE_ATTRIBUTE_DEVICE},
  44                 {'t', FILE_ATTRIBUTE_TEMPORARY},
  45                 {'s', FILE_ATTRIBUTE_SPARSE},
  46                 {'r', FILE_ATTRIBUTE_REPARSE_POINT},
  47                 {'c', FILE_ATTRIBUTE_COMPRESSED},
  48                 {'o', FILE_ATTRIBUTE_OFFLINE},
  49                 {'n', FILE_ATTRIBUTE_NONINDEXED},
  50                 {'e', FILE_ATTRIBUTE_ENCRYPTED}
  51         };
  52         char *ret;
  53
  54         ret = talloc_array(mem_ctx, char, ARRAY_SIZE(attr_strs)+1);
  55         if (!ret) {
  56                 return NULL;
  57         }
  58
  59         for (len=i=0; i<ARRAY_SIZE(attr_strs); i++) {
  60                 if (attrib & attr_strs[i].attr) {
  61                         ret[len++] = attr_strs[i].c;
  62                 }
  63         }
  64
  65         ret[len] = 0;
  66
  67         talloc_set_name_const(ret, ret);
  68
  69         return ret;
  70 }
  71
  72 /****************************************************************************
  73  Map standard UNIX permissions onto wire representations.
  74 ****************************************************************************/
  75
  76 uint32_t unix_perms_to_wire(mode_t perms)
  77 {
  78         unsigned int ret = 0;
  79
  80         ret |= ((perms & S_IXOTH) ?  UNIX_X_OTH : 0);
  81         ret |= ((perms & S_IWOTH) ?  UNIX_W_OTH : 0);
  82         ret |= ((perms & S_IROTH) ?  UNIX_R_OTH : 0);
  83         ret |= ((perms & S_IXGRP) ?  UNIX_X_GRP : 0);
  84         ret |= ((perms & S_IWGRP) ?  UNIX_W_GRP : 0);
  85         ret |= ((perms & S_IRGRP) ?  UNIX_R_GRP : 0);
  86         ret |= ((perms & S_IXUSR) ?  UNIX_X_USR : 0);
  87         ret |= ((perms & S_IWUSR) ?  UNIX_W_USR : 0);
  88         ret |= ((perms & S_IRUSR) ?  UNIX_R_USR : 0);
  89 #ifdef S_ISVTX
  90         ret |= ((perms & S_ISVTX) ?  UNIX_STICKY : 0);
  91 #endif
  92 #ifdef S_ISGID
  93         ret |= ((perms & S_ISGID) ?  UNIX_SET_GID : 0);
  94 #endif
  95 #ifdef S_ISUID
  96         ret |= ((perms & S_ISUID) ?  UNIX_SET_UID : 0);
  97 #endif
  98         return ret;
  99 }
 100
 101 /****************************************************************************
 102  Map wire permissions to standard UNIX.
 103 ****************************************************************************/
 104
 105 mode_t wire_perms_to_unix(uint32_t perms)
 106 {
 107         mode_t ret = (mode_t)0;
 108
 109         ret |= ((perms & UNIX_X_OTH) ? S_IXOTH : 0);
 110         ret |= ((perms & UNIX_W_OTH) ? S_IWOTH : 0);
 111         ret |= ((perms & UNIX_R_OTH) ? S_IROTH : 0);
 112         ret |= ((perms & UNIX_X_GRP) ? S_IXGRP : 0);
 113         ret |= ((perms & UNIX_W_GRP) ? S_IWGRP : 0);
 114         ret |= ((perms & UNIX_R_GRP) ? S_IRGRP : 0);
 115         ret |= ((perms & UNIX_X_USR) ? S_IXUSR : 0);
 116         ret |= ((perms & UNIX_W_USR) ? S_IWUSR : 0);
 117         ret |= ((perms & UNIX_R_USR) ? S_IRUSR : 0);
 118 #ifdef S_ISVTX
 119         ret |= ((perms & UNIX_STICKY) ? S_ISVTX : 0);
 120 #endif
 121 #ifdef S_ISGID
 122         ret |= ((perms & UNIX_SET_GID) ? S_ISGID : 0);
 123 #endif
 124 #ifdef S_ISUID
 125         ret |= ((perms & UNIX_SET_UID) ? S_ISUID : 0);
 126 #endif
 127         return ret;
 128 }
 129
 130 /****************************************************************************
 131  Return the file type from the wire filetype for UNIX extensions.
 132 ****************************************************************************/
 133
 134 mode_t unix_filetype_from_wire(uint32_t wire_type)
 135 {
 136         switch (wire_type) {
 137                 case UNIX_TYPE_FILE:
 138                         return S_IFREG;
 139                 case UNIX_TYPE_DIR:
 140                         return S_IFDIR;
 141 #ifdef S_IFLNK
 142                 case UNIX_TYPE_SYMLINK:
 143                         return S_IFLNK;
 144 #endif
 145 #ifdef S_IFCHR
 146                 case UNIX_TYPE_CHARDEV:
 147                         return S_IFCHR;
 148 #endif
 149 #ifdef S_IFBLK
 150                 case UNIX_TYPE_BLKDEV:
 151                         return S_IFBLK;
 152 #endif
 153 #ifdef S_IFIFO
 154                 case UNIX_TYPE_FIFO:
 155                         return S_IFIFO;
 156 #endif
 157 #ifdef S_IFSOCK
 158                 case UNIX_TYPE_SOCKET:
 159                         return S_IFSOCK;
 160 #endif
 161                 default:
 162                         return (mode_t)0;
 163         }
 164 }
 165
 166 bool smb_buffer_oob(uint32_t bufsize, uint32_t offset, uint32_t length)
 167 {
 168         if ((offset + length < offset) || (offset + length < length)) {
 169                 /* wrap */
 170                 return true;
 171         }
 172         if ((offset > bufsize) || (offset + length > bufsize)) {
 173                 /* overflow */
 174                 return true;
 175         }
 176         return false;
 177 }
 178
 179 /***********************************************************
 180  Common function for pushing stings, used by smb_bytes_push_str()
 181  and trans_bytes_push_str(). Only difference is the align_odd
 182  parameter setting.
 183 ***********************************************************/
 184
 185 static uint8_t *internal_bytes_push_str(uint8_t *buf, bool ucs2,
 186                                         const char *str, size_t str_len,
 187                                         bool align_odd,
 188                                         size_t *pconverted_size)
 189 {
 190         TALLOC_CTX *frame = talloc_stackframe();
 191         size_t buflen;
 192         char *converted;
 193         size_t converted_size;
 194
 195         /*
 196          * This check prevents us from
 197          * (re)alloc buf on a NULL TALLOC_CTX.
 198          */
 199         if (buf == NULL) {
 200                 TALLOC_FREE(frame);
 201                 return NULL;
 202         }
 203
 204         buflen = talloc_get_size(buf);
 205
 206         if (ucs2 &&
 207             ((align_odd && (buflen % 2 == 0)) ||
 208              (!align_odd && (buflen % 2 == 1)))) {
 209                 /*
 210                  * We're pushing into an SMB buffer, align odd
 211                  */
 212                 buf = talloc_realloc(NULL, buf, uint8_t, buflen + 1);
 213                 if (buf == NULL) {
 214                         TALLOC_FREE(frame);
 215                         return NULL;
 216                 }
 217                 buf[buflen] = '\0';
 218                 buflen += 1;
 219         }
 220
 221         if (!convert_string_talloc(frame, CH_UNIX,
 222                                    ucs2 ? CH_UTF16LE : CH_DOS,
 223                                    str, str_len, &converted,
 224                                    &converted_size)) {
 225                 TALLOC_FREE(frame);
 226                 return NULL;
 227         }
 228
 229         buf = talloc_realloc(NULL, buf, uint8_t,
 230                              buflen + converted_size);
 231         if (buf == NULL) {
 232                 TALLOC_FREE(frame);
 233                 return NULL;
 234         }
 235
 236         memcpy(buf + buflen, converted, converted_size);
 237
 238         TALLOC_FREE(converted);
 239
 240         if (pconverted_size) {
 241                 *pconverted_size = converted_size;
 242         }
 243
 244         TALLOC_FREE(frame);
 245         return buf;
 246 }
 247
 248 /***********************************************************
 249  Push a string into an SMB buffer, with odd byte alignment
 250  if it's a UCS2 string.
 251 ***********************************************************/
 252
 253 uint8_t *smb_bytes_push_str(uint8_t *buf, bool ucs2,
 254                             const char *str, size_t str_len,
 255                             size_t *pconverted_size)
 256 {
 257         return internal_bytes_push_str(buf, ucs2, str, str_len,
 258                                        true, pconverted_size);
 259 }
 260
 261 uint8_t *smb_bytes_push_bytes(uint8_t *buf, uint8_t prefix,
 262                               const uint8_t *bytes, size_t num_bytes)
 263 {
 264         size_t buflen;
 265
 266         /*
 267          * This check prevents us from
 268          * (re)alloc buf on a NULL TALLOC_CTX.
 269          */
 270         if (buf == NULL) {
 271                 return NULL;
 272         }
 273         buflen = talloc_get_size(buf);
 274
 275         buf = talloc_realloc(NULL, buf, uint8_t,
 276                              buflen + 1 + num_bytes);
 277         if (buf == NULL) {
 278                 return NULL;
 279         }
 280         buf[buflen] = prefix;
 281         memcpy(&buf[buflen+1], bytes, num_bytes);
 282         return buf;
 283 }
 284
 285 /***********************************************************
 286  Same as smb_bytes_push_str(), but without the odd byte
 287  align for ucs2 (we're pushing into a param or data block).
 288  static for now, although this will probably change when
 289  other modules use async trans calls.
 290 ***********************************************************/
 291
 292 uint8_t *trans2_bytes_push_str(uint8_t *buf, bool ucs2,
 293                                const char *str, size_t str_len,
 294                                size_t *pconverted_size)
 295 {
 296         return internal_bytes_push_str(buf, ucs2, str, str_len,
 297                                        false, pconverted_size);
 298 }
 299
 300 uint8_t *trans2_bytes_push_bytes(uint8_t *buf,
 301                                  const uint8_t *bytes, size_t num_bytes)
 302 {
 303         size_t buflen;
 304
 305         if (buf == NULL) {
 306                 return NULL;
 307         }
 308         buflen = talloc_get_size(buf);
 309
 310         buf = talloc_realloc(NULL, buf, uint8_t,
 311                              buflen + num_bytes);
 312         if (buf == NULL) {
 313                 return NULL;
 314         }
 315         memcpy(&buf[buflen], bytes, num_bytes);
 316         return buf;
 317 }
 318
 319 static NTSTATUS internal_bytes_pull_str(TALLOC_CTX *mem_ctx, char **_str,
 320                                         bool ucs2, bool align_odd,
 321                                         const uint8_t *buf, size_t buf_len,
 322                                         size_t *pbuf_consumed)
 323 {
 324         size_t pad = 0;
 325         char *str = NULL;
 326         size_t str_len = 0;
 327         bool ok;
 328
 329         *_str = NULL;
 330         if (pbuf_consumed != NULL) {
 331                 *pbuf_consumed = 0;
 332         }
 333
 334         if (ucs2 &&
 335             ((align_odd && (buf_len % 2 == 0)) ||
 336              (!align_odd && (buf_len % 2 == 1)))) {
 337                 if (buf_len < 1) {
 338                         return NT_STATUS_BUFFER_TOO_SMALL;
 339                 }
 340                 pad = 1;
 341                 buf_len -= pad;
 342                 buf += pad;
 343         }
 344
 345         if (ucs2) {
 346                 buf_len = utf16_len_n(buf, buf_len);
 347         } else {
 348                 size_t tmp = strnlen((const char *)buf, buf_len);
 349                 if (tmp < buf_len) {
 350                         tmp += 1;
 351                 }
 352                 buf_len = tmp;
 353         }
 354
 355         ok = convert_string_talloc(mem_ctx,
 356                                    ucs2 ? CH_UTF16LE : CH_DOS,
 357                                    CH_UNIX,
 358                                    buf, buf_len,
 359                                    &str, &str_len);
 360         if (!ok) {
 361                 return map_nt_error_from_unix_common(errno);
 362         }
 363
 364         if (pbuf_consumed != NULL) {
 365                 *pbuf_consumed = buf_len + pad;
 366         }
 367         *_str = str;
 368         return NT_STATUS_OK;;
 369 }
 370
 371 NTSTATUS smb_bytes_pull_str(TALLOC_CTX *mem_ctx, char **_str, bool ucs2,
 372                             const uint8_t *buf, size_t buf_len,
 373                             size_t *_buf_consumed)
 374 {
 375         return internal_bytes_pull_str(mem_ctx, _str, ucs2, true,
 376                                        buf, buf_len, _buf_consumed);
 377 }