source3/lib/filename_util.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Filename utility functions.
   4    Copyright (C) Tim Prouty 2009
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19 #include "includes.h"
  20
  21 /**
  22  * XXX: This is temporary and there should be no callers of this outside of
  23  * this file once smb_filename is plumbed through all path based operations.
  24  * The one legitimate caller currently is smb_fname_str_dbg(), which this
  25  * could be made static for.
  26  */
  27 NTSTATUS get_full_smb_filename(TALLOC_CTX *ctx,
  28                                const struct smb_filename *smb_fname,
  29                                char **full_name)
  30 {
  31         if (smb_fname->stream_name) {
  32                 /* stream_name must always be NULL if there is no stream. */
  33                 SMB_ASSERT(smb_fname->stream_name[0] != '\0');
  34
  35                 *full_name = talloc_asprintf(ctx, "%s%s", smb_fname->base_name,
  36                                              smb_fname->stream_name);
  37         } else {
  38                 *full_name = talloc_strdup(ctx, smb_fname->base_name);
  39         }
  40
  41         if (!*full_name) {
  42                 return NT_STATUS_NO_MEMORY;
  43         }
  44
  45         return NT_STATUS_OK;
  46 }
  47
  48 /**
  49  * There are actually legitimate callers of this such as functions that
  50  * enumerate streams using the vfs_streaminfo interface and then want to
  51  * operate on each stream.
  52  */
  53 struct smb_filename *synthetic_smb_fname(TALLOC_CTX *mem_ctx,
  54                                          const char *base_name,
  55                                          const char *stream_name,
  56                                          const SMB_STRUCT_STAT *psbuf,
  57                                          NTTIME twrp,
  58                                          uint32_t flags)
  59 {
  60         struct smb_filename smb_fname_loc = { 0, };
  61
  62         /* Setup the base_name/stream_name. */
  63         smb_fname_loc.base_name = discard_const_p(char, base_name);
  64         smb_fname_loc.stream_name = discard_const_p(char, stream_name);
  65         smb_fname_loc.flags = flags;
  66         smb_fname_loc.twrp = twrp;
  67
  68         /* Copy the psbuf if one was given. */
  69         if (psbuf)
  70                 smb_fname_loc.st = *psbuf;
  71
  72         /* Let cp_smb_filename() do the heavy lifting. */
  73         return cp_smb_filename(mem_ctx, &smb_fname_loc);
  74 }
  75
  76 /**
  77  * Utility function used by VFS calls that must *NOT* operate
  78  * on a stream filename, only the base_name.
  79  */
  80 struct smb_filename *cp_smb_filename_nostream(TALLOC_CTX *mem_ctx,
  81                                         const struct smb_filename *smb_fname_in)
  82 {
  83         struct smb_filename *smb_fname = cp_smb_filename(mem_ctx,
  84                                                         smb_fname_in);
  85         if (smb_fname == NULL) {
  86                 return NULL;
  87         }
  88         TALLOC_FREE(smb_fname->stream_name);
  89         return smb_fname;
  90 }
  91
  92 /**
  93  * There are a few legitimate users of this.
  94  */
  95 struct smb_filename *synthetic_smb_fname_split(TALLOC_CTX *ctx,
  96                                                 const char *fname,
  97                                                 bool posix_path)
  98 {
  99         char *stream_name = NULL;
 100         char *base_name = NULL;
 101         struct smb_filename *ret;
 102         bool ok;
 103
 104         if (posix_path) {
 105                 /* No stream name looked for. */
 106                 return synthetic_smb_fname(ctx,
 107                                 fname,
 108                                 NULL,
 109                                 NULL,
 110                                 0,
 111                                 SMB_FILENAME_POSIX_PATH);
 112         }
 113
 114         ok = split_stream_filename(ctx,
 115                                 fname,
 116                                 &base_name,
 117                                 &stream_name);
 118         if (!ok) {
 119                 return NULL;
 120         }
 121
 122         ret = synthetic_smb_fname(ctx,
 123                                   base_name,
 124                                   stream_name,
 125                                   NULL,
 126                                   0,
 127                                   0);
 128         TALLOC_FREE(base_name);
 129         TALLOC_FREE(stream_name);
 130         return ret;
 131 }
 132
 133 /**
 134  * Return a string using the talloc_tos()
 135  */
 136 const char *smb_fname_str_dbg(const struct smb_filename *smb_fname)
 137 {
 138         char *fname = NULL;
 139         time_t t;
 140         struct tm tm;
 141         struct tm *ptm = NULL;
 142         fstring tstr;
 143         ssize_t slen;
 144         NTSTATUS status;
 145
 146         if (smb_fname == NULL) {
 147                 return "";
 148         }
 149         status = get_full_smb_filename(talloc_tos(), smb_fname, &fname);
 150         if (!NT_STATUS_IS_OK(status)) {
 151                 return "";
 152         }
 153         if (smb_fname->twrp == 0) {
 154                 return fname;
 155         }
 156
 157         t = nt_time_to_unix(smb_fname->twrp);
 158         ptm = gmtime_r(&t, &tm);
 159         if (ptm == NULL) {
 160                 return "";
 161         }
 162
 163         slen = strftime(tstr, sizeof(tstr), GMT_FORMAT, &tm);
 164         if (slen == 0) {
 165                 return "";
 166         }
 167
 168         fname = talloc_asprintf(talloc_tos(),
 169                                 "%s {%s}",
 170                                 fname,
 171                                 tstr);
 172         if (fname == NULL) {
 173                 return "";
 174         }
 175         return fname;
 176 }
 177
 178 /**
 179  * Return a debug string of the path name of an fsp using the talloc_tos().
 180  */
 181 const char *fsp_str_dbg(const struct files_struct *fsp)
 182 {
 183         return smb_fname_str_dbg(fsp->fsp_name);
 184 }
 185
 186 /**
 187  * Create a debug string for the fnum of an fsp.
 188  *
 189  * This is allocated to talloc_tos() or a string constant
 190  * in certain corner cases. The returned string should
 191  * hence not be free'd directly but only via the talloc stack.
 192  */
 193 const char *fsp_fnum_dbg(const struct files_struct *fsp)
 194 {
 195         char *str;
 196
 197         if (fsp == NULL) {
 198                 return "fnum [fsp is NULL]";
 199         }
 200
 201         if (fsp->fnum == FNUM_FIELD_INVALID) {
 202                 return "fnum [invalid value]";
 203         }
 204
 205         str = talloc_asprintf(talloc_tos(), "fnum %llu",
 206                               (unsigned long long)fsp->fnum);
 207         if (str == NULL) {
 208                 DEBUG(1, ("%s: talloc_asprintf failed\n", __FUNCTION__));
 209                 return "fnum [talloc failed!]";
 210         }
 211
 212         return str;
 213 }
 214
 215 struct smb_filename *cp_smb_filename(TALLOC_CTX *mem_ctx,
 216                                      const struct smb_filename *in)
 217 {
 218         struct smb_filename *out;
 219         size_t base_len = 0;
 220         size_t stream_len = 0;
 221         int num = 0;
 222
 223         /* stream_name must always be NULL if there is no stream. */
 224         if (in->stream_name) {
 225                 SMB_ASSERT(in->stream_name[0] != '\0');
 226         }
 227
 228         if (in->base_name != NULL) {
 229                 base_len = strlen(in->base_name) + 1;
 230                 num += 1;
 231         }
 232         if (in->stream_name != NULL) {
 233                 stream_len = strlen(in->stream_name) + 1;
 234                 num += 1;
 235         }
 236
 237         out = talloc_pooled_object(mem_ctx, struct smb_filename,
 238                                 num, stream_len + base_len);
 239         if (out == NULL) {
 240                 return NULL;
 241         }
 242         ZERO_STRUCTP(out);
 243
 244         /*
 245          * The following allocations cannot fail as we
 246          * pre-allocated space for them in the out pooled
 247          * object.
 248          */
 249         if (in->base_name != NULL) {
 250                 out->base_name = talloc_memdup(
 251                                 out, in->base_name, base_len);
 252                 talloc_set_name_const(out->base_name,
 253                                       out->base_name);
 254         }
 255         if (in->stream_name != NULL) {
 256                 out->stream_name = talloc_memdup(
 257                                 out, in->stream_name, stream_len);
 258                 talloc_set_name_const(out->stream_name,
 259                                       out->stream_name);
 260         }
 261         out->flags = in->flags;
 262         out->st = in->st;
 263         out->twrp = in->twrp;
 264         return out;
 265 }
 266
 267 /**
 268  * Return allocated parent directory and basename of path
 269  *
 270  * Note: if requesting name, it is returned as talloc child of the
 271  * parent. Freeing the parent is thus sufficient to free both.
 272  */
 273 bool parent_smb_fname(TALLOC_CTX *mem_ctx,
 274                       const struct smb_filename *path,
 275                       struct smb_filename **_parent,
 276                       struct smb_filename  **_name)
 277 {
 278         TALLOC_CTX *frame = talloc_stackframe();
 279         struct smb_filename *parent = NULL;
 280         struct smb_filename *name = NULL;
 281         char *p = NULL;
 282
 283         parent = cp_smb_filename(frame, path);
 284         if (parent == NULL) {
 285                 TALLOC_FREE(frame);
 286                 return false;
 287         }
 288         TALLOC_FREE(parent->stream_name);
 289         SET_STAT_INVALID(parent->st);
 290
 291         p = strrchr_m(parent->base_name, '/'); /* Find final '/', if any */
 292         if (p == NULL) {
 293                 TALLOC_FREE(parent->base_name);
 294                 parent->base_name = talloc_strdup(parent, ".");
 295                 if (parent->base_name == NULL) {
 296                         TALLOC_FREE(frame);
 297                         return false;
 298                 }
 299                 p = path->base_name;
 300         } else {
 301                 *p = '\0';
 302                 p++;
 303         }
 304
 305         if (_name == NULL) {
 306                 *_parent = talloc_move(mem_ctx, &parent);
 307                 TALLOC_FREE(frame);
 308                 return true;
 309         }
 310
 311         name = cp_smb_filename(frame, path);
 312         if (name == NULL) {
 313                 TALLOC_FREE(frame);
 314                 return false;
 315         }
 316         TALLOC_FREE(name->base_name);
 317
 318         name->base_name = talloc_strdup(mem_ctx, p);
 319         if (name == NULL) {
 320                 TALLOC_FREE(frame);
 321                 return false;
 322         }
 323
 324         *_parent = talloc_move(mem_ctx, &parent);
 325         *_name = talloc_move(*_parent, &name);
 326         TALLOC_FREE(frame);
 327         return true;
 328 }
 329
 330 static void assert_valid_stream_smb_fname(const struct smb_filename *smb_fname)
 331 {
 332         /* stream_name must always be NULL if there is no stream. */
 333         if (smb_fname->stream_name) {
 334                 SMB_ASSERT(smb_fname->stream_name[0] != '\0');
 335         }
 336
 337         if (smb_fname->flags & SMB_FILENAME_POSIX_PATH) {
 338                 SMB_ASSERT(smb_fname->stream_name == NULL);
 339         }
 340 }
 341
 342 /****************************************************************************
 343  Simple check to determine if a smb_fname is a real named stream or the
 344  default stream.
 345  ***************************************************************************/
 346
 347 bool is_ntfs_stream_smb_fname(const struct smb_filename *smb_fname)
 348 {
 349         assert_valid_stream_smb_fname(smb_fname);
 350
 351         if (smb_fname->stream_name == NULL) {
 352                 return false;
 353         }
 354
 355         return true;
 356 }
 357
 358 /****************************************************************************
 359  Simple check to determine if a smb_fname is pointing to a normal file or
 360  a named stream that is not the default stream "::$DATA".
 361
 362   foo           -> false
 363   foo::$DATA    -> false
 364   foo:bar       -> true
 365   foo:bar:$DATA -> true
 366
 367  ***************************************************************************/
 368
 369 bool is_named_stream(const struct smb_filename *smb_fname)
 370 {
 371         assert_valid_stream_smb_fname(smb_fname);
 372
 373         if (smb_fname->stream_name == NULL) {
 374                 return false;
 375         }
 376
 377         if (strequal_m(smb_fname->stream_name, "::$DATA")) {
 378                 return false;
 379         }
 380
 381         return true;
 382 }
 383
 384 /****************************************************************************
 385  Returns true if the filename's stream == "::$DATA"
 386  ***************************************************************************/
 387 bool is_ntfs_default_stream_smb_fname(const struct smb_filename *smb_fname)
 388 {
 389         assert_valid_stream_smb_fname(smb_fname);
 390
 391         if (smb_fname->stream_name == NULL) {
 392                 return false;
 393         }
 394
 395         return strequal_m(smb_fname->stream_name, "::$DATA");
 396 }
 397
 398 /****************************************************************************
 399  Filter out Windows invalid EA names (list probed from Windows 2012).
 400 ****************************************************************************/
 401
 402 static char bad_ea_name_chars[] = "\"*+,/:;<=>?[\\]|";
 403
 404 bool is_invalid_windows_ea_name(const char *name)
 405 {
 406         int i;
 407         /* EA name is pulled as ascii so we can examine
 408            individual bytes here. */
 409         for (i = 0; name[i] != 0; i++) {
 410                 int val = (name[i] & 0xff);
 411                 if (val < ' ' || strchr(bad_ea_name_chars, val)) {
 412                         return true;
 413                 }
 414         }
 415         return false;
 416 }
 417
 418 bool ea_list_has_invalid_name(struct ea_list *ea_list)
 419 {
 420         for (;ea_list; ea_list = ea_list->next) {
 421                 if (is_invalid_windows_ea_name(ea_list->ea.name)) {
 422                         return true;
 423                 }
 424         }
 425         return false;
 426 }
 427
 428 /****************************************************************************
 429  Split an incoming name into tallocd filename and stream components.
 430  Returns true on success, false on out of memory.
 431 ****************************************************************************/
 432
 433 bool split_stream_filename(TALLOC_CTX *ctx,
 434                                 const char *filename_in,
 435                                 char **filename_out,
 436                                 char **streamname_out)
 437 {
 438         const char *stream_name = NULL;
 439         char *stream_out = NULL;
 440         char *file_out = NULL;
 441
 442         stream_name = strchr_m(filename_in, ':');
 443
 444         if (stream_name) {
 445                 stream_out = talloc_strdup(ctx, stream_name);
 446                 if (stream_out == NULL) {
 447                         return false;
 448                 }
 449                 file_out = talloc_strndup(ctx,
 450                                         filename_in,
 451                                         PTR_DIFF(stream_name, filename_in));
 452         } else {
 453                 file_out = talloc_strdup(ctx, filename_in);
 454         }
 455
 456         if (file_out == NULL) {
 457                 TALLOC_FREE(stream_out);
 458                 return false;
 459         }
 460
 461         if (filename_out) {
 462                 *filename_out = file_out;
 463         }
 464         if (streamname_out) {
 465                 *streamname_out = stream_out;
 466         }
 467         return true;
 468 }