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_append_buffer(
 169                 fname, " {%s}", tstr);
 170         if (fname == NULL) {
 171                 return "";
 172         }
 173         return fname;
 174 }
 175
 176 /**
 177  * Return a debug string of the path name of an fsp using the talloc_tos().
 178  */
 179 const char *fsp_str_dbg(const struct files_struct *fsp)
 180 {
 181         const char *name = NULL;
 182
 183         name = smb_fname_str_dbg(fsp->fsp_name);
 184         if (name == NULL) {
 185                 return "";
 186         }
 187
 188         return name;
 189 }
 190
 191 /**
 192  * Create a debug string for the fnum of an fsp.
 193  *
 194  * This is allocated to talloc_tos() or a string constant
 195  * in certain corner cases. The returned string should
 196  * hence not be free'd directly but only via the talloc stack.
 197  */
 198 const char *fsp_fnum_dbg(const struct files_struct *fsp)
 199 {
 200         char *str;
 201
 202         if (fsp == NULL) {
 203                 return "fnum [fsp is NULL]";
 204         }
 205
 206         if (fsp->fnum == FNUM_FIELD_INVALID) {
 207                 return "fnum [invalid value]";
 208         }
 209
 210         str = talloc_asprintf(talloc_tos(), "fnum %llu",
 211                               (unsigned long long)fsp->fnum);
 212         if (str == NULL) {
 213                 DEBUG(1, ("%s: talloc_asprintf failed\n", __FUNCTION__));
 214                 return "fnum [talloc failed!]";
 215         }
 216
 217         return str;
 218 }
 219
 220 struct smb_filename *cp_smb_filename(TALLOC_CTX *mem_ctx,
 221                                      const struct smb_filename *in)
 222 {
 223         struct smb_filename *out;
 224         size_t base_len = 0;
 225         size_t stream_len = 0;
 226         int num = 0;
 227
 228         /* stream_name must always be NULL if there is no stream. */
 229         if (in->stream_name) {
 230                 SMB_ASSERT(in->stream_name[0] != '\0');
 231         }
 232
 233         if (in->base_name != NULL) {
 234                 base_len = strlen(in->base_name) + 1;
 235                 num += 1;
 236         }
 237         if (in->stream_name != NULL) {
 238                 stream_len = strlen(in->stream_name) + 1;
 239                 num += 1;
 240         }
 241
 242         out = talloc_pooled_object(mem_ctx, struct smb_filename,
 243                                 num, stream_len + base_len);
 244         if (out == NULL) {
 245                 return NULL;
 246         }
 247         ZERO_STRUCTP(out);
 248
 249         /*
 250          * The following allocations cannot fail as we
 251          * pre-allocated space for them in the out pooled
 252          * object.
 253          */
 254         if (in->base_name != NULL) {
 255                 out->base_name = talloc_memdup(
 256                                 out, in->base_name, base_len);
 257                 talloc_set_name_const(out->base_name,
 258                                       out->base_name);
 259         }
 260         if (in->stream_name != NULL) {
 261                 out->stream_name = talloc_memdup(
 262                                 out, in->stream_name, stream_len);
 263                 talloc_set_name_const(out->stream_name,
 264                                       out->stream_name);
 265         }
 266         out->flags = in->flags;
 267         out->st = in->st;
 268         out->twrp = in->twrp;
 269         return out;
 270 }
 271
 272 /**
 273  * Return allocated parent directory and basename of path
 274  *
 275  * Note: if requesting name, it is returned as talloc child of the
 276  * parent. Freeing the parent is thus sufficient to free both.
 277  */
 278 bool parent_smb_fname(TALLOC_CTX *mem_ctx,
 279                       const struct smb_filename *path,
 280                       struct smb_filename **_parent,
 281                       struct smb_filename  **_name)
 282 {
 283         TALLOC_CTX *frame = talloc_stackframe();
 284         struct smb_filename *parent = NULL;
 285         struct smb_filename *name = NULL;
 286         char *p = NULL;
 287
 288         parent = cp_smb_filename(frame, path);
 289         if (parent == NULL) {
 290                 TALLOC_FREE(frame);
 291                 return false;
 292         }
 293         TALLOC_FREE(parent->stream_name);
 294         SET_STAT_INVALID(parent->st);
 295
 296         p = strrchr_m(parent->base_name, '/'); /* Find final '/', if any */
 297         if (p == NULL) {
 298                 TALLOC_FREE(parent->base_name);
 299                 parent->base_name = talloc_strdup(parent, ".");
 300                 if (parent->base_name == NULL) {
 301                         TALLOC_FREE(frame);
 302                         return false;
 303                 }
 304                 p = path->base_name;
 305         } else {
 306                 *p = '\0';
 307                 p++;
 308         }
 309
 310         if (_name == NULL) {
 311                 *_parent = talloc_move(mem_ctx, &parent);
 312                 TALLOC_FREE(frame);
 313                 return true;
 314         }
 315
 316         name = cp_smb_filename(frame, path);
 317         if (name == NULL) {
 318                 TALLOC_FREE(frame);
 319                 return false;
 320         }
 321         TALLOC_FREE(name->base_name);
 322
 323         name->base_name = talloc_strdup(mem_ctx, p);
 324         if (name == NULL) {
 325                 TALLOC_FREE(frame);
 326                 return false;
 327         }
 328
 329         *_parent = talloc_move(mem_ctx, &parent);
 330         *_name = talloc_move(*_parent, &name);
 331         TALLOC_FREE(frame);
 332         return true;
 333 }
 334
 335 static void assert_valid_stream_smb_fname(const struct smb_filename *smb_fname)
 336 {
 337         /* stream_name must always be NULL if there is no stream. */
 338         if (smb_fname->stream_name) {
 339                 SMB_ASSERT(smb_fname->stream_name[0] != '\0');
 340         }
 341
 342         if (smb_fname->flags & SMB_FILENAME_POSIX_PATH) {
 343                 SMB_ASSERT(smb_fname->stream_name == NULL);
 344         }
 345 }
 346
 347 /****************************************************************************
 348  Simple check to determine if a smb_fname is a real named stream or the
 349  default stream.
 350  ***************************************************************************/
 351
 352 bool is_ntfs_stream_smb_fname(const struct smb_filename *smb_fname)
 353 {
 354         assert_valid_stream_smb_fname(smb_fname);
 355
 356         if (smb_fname->stream_name == NULL) {
 357                 return false;
 358         }
 359
 360         return true;
 361 }
 362
 363 /****************************************************************************
 364  Simple check to determine if a smb_fname is pointing to a normal file or
 365  a named stream that is not the default stream "::$DATA".
 366
 367   foo           -> false
 368   foo::$DATA    -> false
 369   foo:bar       -> true
 370   foo:bar:$DATA -> true
 371
 372  ***************************************************************************/
 373
 374 bool is_named_stream(const struct smb_filename *smb_fname)
 375 {
 376         assert_valid_stream_smb_fname(smb_fname);
 377
 378         if (smb_fname->stream_name == NULL) {
 379                 return false;
 380         }
 381
 382         if (strequal_m(smb_fname->stream_name, "::$DATA")) {
 383                 return false;
 384         }
 385
 386         return true;
 387 }
 388
 389 /****************************************************************************
 390  Returns true if the filename's stream == "::$DATA"
 391  ***************************************************************************/
 392 bool is_ntfs_default_stream_smb_fname(const struct smb_filename *smb_fname)
 393 {
 394         assert_valid_stream_smb_fname(smb_fname);
 395
 396         if (smb_fname->stream_name == NULL) {
 397                 return false;
 398         }
 399
 400         return strequal_m(smb_fname->stream_name, "::$DATA");
 401 }
 402
 403 /****************************************************************************
 404  Filter out Windows invalid EA names (list probed from Windows 2012).
 405 ****************************************************************************/
 406
 407 static char bad_ea_name_chars[] = "\"*+,/:;<=>?[\\]|";
 408
 409 bool is_invalid_windows_ea_name(const char *name)
 410 {
 411         int i;
 412         /* EA name is pulled as ascii so we can examine
 413            individual bytes here. */
 414         for (i = 0; name[i] != 0; i++) {
 415                 int val = (name[i] & 0xff);
 416                 if (val < ' ' || strchr(bad_ea_name_chars, val)) {
 417                         return true;
 418                 }
 419         }
 420         return false;
 421 }
 422
 423 bool ea_list_has_invalid_name(struct ea_list *ea_list)
 424 {
 425         for (;ea_list; ea_list = ea_list->next) {
 426                 if (is_invalid_windows_ea_name(ea_list->ea.name)) {
 427                         return true;
 428                 }
 429         }
 430         return false;
 431 }
 432
 433 /****************************************************************************
 434  Split an incoming name into tallocd filename and stream components.
 435  Returns true on success, false on out of memory.
 436 ****************************************************************************/
 437
 438 bool split_stream_filename(TALLOC_CTX *ctx,
 439                                 const char *filename_in,
 440                                 char **filename_out,
 441                                 char **streamname_out)
 442 {
 443         const char *stream_name = NULL;
 444         char *stream_out = NULL;
 445         char *file_out = NULL;
 446
 447         stream_name = strchr_m(filename_in, ':');
 448
 449         if (stream_name) {
 450                 stream_out = talloc_strdup(ctx, stream_name);
 451                 if (stream_out == NULL) {
 452                         return false;
 453                 }
 454                 file_out = talloc_strndup(ctx,
 455                                         filename_in,
 456                                         PTR_DIFF(stream_name, filename_in));
 457         } else {
 458                 file_out = talloc_strdup(ctx, filename_in);
 459         }
 460
 461         if (file_out == NULL) {
 462                 TALLOC_FREE(stream_out);
 463                 return false;
 464         }
 465
 466         if (filename_out) {
 467                 *filename_out = file_out;
 468         }
 469         if (streamname_out) {
 470                 *streamname_out = stream_out;
 471         }
 472         return true;
 473 }