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