2 Unix SMB/CIFS implementation.
4 POSIX NTVFS backend - filename resolution
6 Copyright (C) Andrew Tridgell 2004
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.
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.
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/>.
23 this is the core code for converting a filename from the format as
24 given by a client to a posix filename, including any case-matching
25 required, and checks for legal characters
30 #include "vfs_posix.h"
31 #include "system/dir.h"
32 #include "param/param.h"
35 compare two filename components. This is where the name mangling hook will go
37 static int component_compare(struct pvfs_state *pvfs, const char *comp, const char *name)
41 ret = strcasecmp_m(comp, name);
44 char *shortname = pvfs_short_name_component(pvfs, name);
46 ret = strcasecmp_m(comp, shortname);
47 talloc_free(shortname);
55 search for a filename in a case insensitive fashion
57 TODO: add a cache for previously resolved case-insensitive names
58 TODO: add mangled name support
60 static NTSTATUS pvfs_case_search(struct pvfs_state *pvfs,
61 struct pvfs_filename *name,
64 /* break into a series of components */
67 char *p, *partial_name;
70 /* break up the full name info pathname components */
72 p = name->full_name + strlen(pvfs->base_directory) + 1;
80 components = talloc_array(name, char *, num_components);
81 p = name->full_name + strlen(pvfs->base_directory);
84 components[0] = name->full_name;
86 for (i=1;i<num_components;i++) {
90 if (pvfs_is_reserved_name(pvfs, components[i])) {
91 return NT_STATUS_ACCESS_DENIED;
95 partial_name = talloc_strdup(name, components[0]);
97 return NT_STATUS_NO_MEMORY;
100 /* for each component, check if it exists as-is, and if not then
101 do a directory scan */
102 for (i=1;i<num_components;i++) {
106 char *long_component;
108 /* possibly remap from the short name cache */
109 long_component = pvfs_mangled_lookup(pvfs, name, components[i]);
110 if (long_component) {
111 components[i] = long_component;
114 test_name = talloc_asprintf(name, "%s/%s", partial_name, components[i]);
116 return NT_STATUS_NO_MEMORY;
119 /* check if this component exists as-is */
120 if (stat(test_name, &name->st) == 0) {
121 if (i<num_components-1 && !S_ISDIR(name->st.st_mode)) {
122 return NT_STATUS_OBJECT_PATH_NOT_FOUND;
124 talloc_free(partial_name);
125 partial_name = test_name;
126 if (i == num_components - 1) {
132 /* the filesystem might be case insensitive, in which
133 case a search is pointless unless the name is
135 if ((pvfs->flags & PVFS_FLAG_CI_FILESYSTEM) &&
136 !pvfs_is_mangled_component(pvfs, components[i])) {
137 if (i < num_components-1) {
138 return NT_STATUS_OBJECT_PATH_NOT_FOUND;
140 partial_name = test_name;
144 dir = opendir(partial_name);
146 return pvfs_map_errno(pvfs, errno);
149 while ((de = readdir(dir))) {
150 if (component_compare(pvfs, components[i], de->d_name) == 0) {
156 if (i < num_components-1) {
158 return NT_STATUS_OBJECT_PATH_NOT_FOUND;
161 components[i] = talloc_strdup(name, de->d_name);
163 test_name = talloc_asprintf(name, "%s/%s", partial_name, components[i]);
164 talloc_free(partial_name);
165 partial_name = test_name;
171 if (stat(partial_name, &name->st) == 0) {
176 talloc_free(name->full_name);
177 name->full_name = partial_name;
180 return pvfs_fill_dos_info(pvfs, name, flags, -1);
187 parse a alternate data stream name
189 static NTSTATUS parse_stream_name(struct pvfs_filename *name, const char *s)
192 name->stream_name = talloc_strdup(name, s+1);
193 if (name->stream_name == NULL) {
194 return NT_STATUS_NO_MEMORY;
196 p = strchr_m(name->stream_name, ':');
198 name->stream_id = pvfs_name_hash(name->stream_name,
199 strlen(name->stream_name));
202 if (strcasecmp_m(p, ":$DATA") != 0) {
203 return NT_STATUS_OBJECT_NAME_INVALID;
206 if (strcmp(name->stream_name, "") == 0) {
208 * we don't set stream_name to NULL, here
209 * as this would be wrong for directories
211 * pvfs_fill_dos_info() will set it to NULL
212 * if it's not a directory.
216 name->stream_id = pvfs_name_hash(name->stream_name,
217 strlen(name->stream_name));
225 convert a CIFS pathname to a unix pathname. Note that this does NOT
226 take into account case insensitivity, and in fact does not access
227 the filesystem at all. It is merely a reformatting and charset
230 errors are returned if the filename is illegal given the flags
232 static NTSTATUS pvfs_unix_path(struct pvfs_state *pvfs, const char *cifs_name,
233 uint_t flags, struct pvfs_filename *name)
235 char *ret, *p, *p_start;
238 name->original_name = talloc_strdup(name, cifs_name);
239 name->stream_name = NULL;
241 name->has_wildcard = false;
243 while (*cifs_name == '\\') {
247 if (*cifs_name == 0) {
248 name->full_name = talloc_asprintf(name, "%s/.", pvfs->base_directory);
249 if (name->full_name == NULL) {
250 return NT_STATUS_NO_MEMORY;
255 ret = talloc_asprintf(name, "%s/%s", pvfs->base_directory, cifs_name);
257 return NT_STATUS_NO_MEMORY;
260 p = ret + strlen(pvfs->base_directory) + 1;
262 /* now do an in-place conversion of '\' to '/', checking
263 for legal characters */
268 codepoint_t c = next_codepoint(lp_iconv_convenience(pvfs->ntvfs->ctx->lp_ctx), p, &c_size);
271 if (name->has_wildcard) {
272 /* wildcards are only allowed in the last part
274 return NT_STATUS_ILLEGAL_CHARACTER;
276 if (p > p_start && (p[1] == '\\' || p[1] == '\0')) {
277 /* see if it is definately a "\\" or
278 * a trailing "\". If it is then fail here,
279 * and let the next layer up try again after
280 * pvfs_reduce_name() if it wants to. This is
281 * much more efficient on average than always
282 * scanning for these separately
284 return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
290 if (!(flags & PVFS_RESOLVE_STREAMS)) {
291 return NT_STATUS_ILLEGAL_CHARACTER;
293 if (name->has_wildcard) {
294 return NT_STATUS_ILLEGAL_CHARACTER;
296 status = parse_stream_name(name, p);
297 if (!NT_STATUS_IS_OK(status)) {
307 if (!(flags & PVFS_RESOLVE_WILDCARD)) {
308 return NT_STATUS_OBJECT_NAME_INVALID;
310 name->has_wildcard = true;
314 return NT_STATUS_ILLEGAL_CHARACTER;
316 /* see if it is definately a .. or
317 . component. If it is then fail here, and
318 let the next layer up try again after
319 pvfs_reduce_name() if it wants to. This is
320 much more efficient on average than always
321 scanning for these separately */
323 (p[2] == 0 || p[2] == '\\') &&
324 (p == p_start || p[-1] == '/')) {
325 return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
327 if ((p[1] == 0 || p[1] == '\\') &&
328 (p == p_start || p[-1] == '/')) {
329 return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
337 name->full_name = ret;
344 reduce a name that contains .. components or repeated \ separators
345 return NULL if it can't be reduced
347 static NTSTATUS pvfs_reduce_name(TALLOC_CTX *mem_ctx,
348 struct smb_iconv_convenience *iconv_convenience,
349 const char **fname, uint_t flags)
353 int i, num_components, err_count;
357 s = talloc_strdup(mem_ctx, *fname);
358 if (s == NULL) return NT_STATUS_NO_MEMORY;
360 for (num_components=1, p=s; *p; p += c_size) {
361 c = next_codepoint(iconv_convenience, p, &c_size);
362 if (c == '\\') num_components++;
365 components = talloc_array(s, char *, num_components+1);
366 if (components == NULL) {
368 return NT_STATUS_NO_MEMORY;
372 for (i=0, p=s; *p; p += c_size) {
373 c = next_codepoint(iconv_convenience, p, &c_size);
376 components[++i] = p+1;
379 components[i+1] = NULL;
384 '.' components are not allowed, but the rules for what error
385 code to give don't seem to make sense. This is a close
388 for (err_count=i=0;components[i];i++) {
389 if (strcmp(components[i], "") == 0) {
392 if (ISDOT(components[i]) || err_count) {
397 if (flags & PVFS_RESOLVE_WILDCARD) err_count--;
400 return NT_STATUS_OBJECT_NAME_INVALID;
402 return NT_STATUS_OBJECT_PATH_NOT_FOUND;
406 /* remove any null components */
407 for (i=0;components[i];i++) {
408 if (strcmp(components[i], "") == 0) {
409 memmove(&components[i], &components[i+1],
410 sizeof(char *)*(num_components-i));
414 if (ISDOTDOT(components[i])) {
415 if (i < 1) return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
416 memmove(&components[i-1], &components[i+1],
417 sizeof(char *)*(num_components-i));
423 if (components[0] == NULL) {
425 *fname = talloc_strdup(mem_ctx, "\\");
429 for (len=i=0;components[i];i++) {
430 len += strlen(components[i]) + 1;
433 /* rebuild the name */
434 ret = talloc_size(mem_ctx, len+1);
437 return NT_STATUS_NO_MEMORY;
440 for (len=0,i=0;components[i];i++) {
441 size_t len1 = strlen(components[i]);
443 memcpy(ret+len+1, components[i], len1);
457 resolve a name from relative client format to a struct pvfs_filename
458 the memory for the filename is made as a talloc child of 'name'
461 PVFS_RESOLVE_NO_WILDCARD = wildcards are considered illegal characters
462 PVFS_RESOLVE_STREAMS = stream names are allowed
464 TODO: ../ collapsing, and outside share checking
466 NTSTATUS pvfs_resolve_name(struct pvfs_state *pvfs, TALLOC_CTX *mem_ctx,
467 const char *cifs_name,
468 uint_t flags, struct pvfs_filename **name)
472 *name = talloc(mem_ctx, struct pvfs_filename);
474 return NT_STATUS_NO_MEMORY;
477 (*name)->exists = false;
478 (*name)->stream_exists = false;
480 if (!(pvfs->fs_attribs & FS_ATTR_NAMED_STREAMS)) {
481 flags &= ~PVFS_RESOLVE_STREAMS;
484 /* do the basic conversion to a unix formatted path,
485 also checking for allowable characters */
486 status = pvfs_unix_path(pvfs, cifs_name, flags, *name);
488 if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_PATH_SYNTAX_BAD)) {
489 /* it might contain .. components which need to be reduced */
490 status = pvfs_reduce_name(*name, lp_iconv_convenience(pvfs->ntvfs->ctx->lp_ctx), &cifs_name, flags);
491 if (!NT_STATUS_IS_OK(status)) {
494 status = pvfs_unix_path(pvfs, cifs_name, flags, *name);
497 if (!NT_STATUS_IS_OK(status)) {
501 /* if it has a wildcard then no point doing a stat() of the
502 full name. Instead We need check if the directory exists
504 if ((*name)->has_wildcard) {
506 char *dir_name, *saved_name;
507 p = strrchr((*name)->full_name, '/');
509 /* root directory wildcard is OK */
512 dir_name = talloc_strndup(*name, (*name)->full_name, (p-(*name)->full_name));
513 if (stat(dir_name, &(*name)->st) == 0) {
514 talloc_free(dir_name);
517 /* we need to search for a matching name */
518 saved_name = (*name)->full_name;
519 (*name)->full_name = dir_name;
520 status = pvfs_case_search(pvfs, *name, flags);
521 if (!NT_STATUS_IS_OK(status)) {
522 /* the directory doesn't exist */
523 (*name)->full_name = saved_name;
526 /* it does exist, but might need a case change */
527 if (dir_name != (*name)->full_name) {
528 (*name)->full_name = talloc_asprintf(*name, "%s%s",
529 (*name)->full_name, p);
530 NT_STATUS_HAVE_NO_MEMORY((*name)->full_name);
532 (*name)->full_name = saved_name;
533 talloc_free(dir_name);
538 /* if we can stat() the full name now then we are done */
539 if (stat((*name)->full_name, &(*name)->st) == 0) {
540 (*name)->exists = true;
541 return pvfs_fill_dos_info(pvfs, *name, flags, -1);
544 /* search for a matching filename */
545 status = pvfs_case_search(pvfs, *name, flags);
552 do a partial resolve, returning a pvfs_filename structure given a
553 base path and a relative component. It is an error if the file does
554 not exist. No case-insensitive matching is done.
556 this is used in places like directory searching where we need a pvfs_filename
557 to pass to a function, but already know the unix base directory and component
559 NTSTATUS pvfs_resolve_partial(struct pvfs_state *pvfs, TALLOC_CTX *mem_ctx,
560 const char *unix_dir, const char *fname,
561 uint_t flags, struct pvfs_filename **name)
565 *name = talloc(mem_ctx, struct pvfs_filename);
567 return NT_STATUS_NO_MEMORY;
570 (*name)->full_name = talloc_asprintf(*name, "%s/%s", unix_dir, fname);
571 if ((*name)->full_name == NULL) {
572 return NT_STATUS_NO_MEMORY;
575 if (stat((*name)->full_name, &(*name)->st) == -1) {
576 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
579 (*name)->exists = true;
580 (*name)->stream_exists = true;
581 (*name)->has_wildcard = false;
582 (*name)->original_name = talloc_strdup(*name, fname);
583 (*name)->stream_name = NULL;
584 (*name)->stream_id = 0;
586 status = pvfs_fill_dos_info(pvfs, *name, flags, -1);
593 fill in the pvfs_filename info for an open file, given the current
594 info for a (possibly) non-open file. This is used by places that need
595 to update the pvfs_filename stat information, and by pvfs_open()
597 NTSTATUS pvfs_resolve_name_fd(struct pvfs_state *pvfs, int fd,
598 struct pvfs_filename *name, uint_t flags)
600 dev_t device = (dev_t)0;
604 device = name->st.st_dev;
605 inode = name->st.st_ino;
609 if (stat(name->full_name, &name->st) == -1) {
610 return NT_STATUS_INVALID_HANDLE;
613 if (fstat(fd, &name->st) == -1) {
614 return NT_STATUS_INVALID_HANDLE;
619 (device != name->st.st_dev || inode != name->st.st_ino)) {
620 /* the file we are looking at has changed! this could
621 be someone trying to exploit a race
622 condition. Certainly we don't want to continue
623 operating on this file */
624 DEBUG(0,("pvfs: WARNING: file '%s' changed during resolve - failing\n",
626 return NT_STATUS_UNEXPECTED_IO_ERROR;
631 return pvfs_fill_dos_info(pvfs, name, flags, fd);
635 fill in the pvfs_filename info for an open file, given the current
636 info for a (possibly) non-open file. This is used by places that need
637 to update the pvfs_filename stat information, and the path
638 after a possible rename on a different handle.
640 NTSTATUS pvfs_resolve_name_handle(struct pvfs_state *pvfs,
641 struct pvfs_file_handle *h)
645 if (h->have_opendb_entry) {
646 struct odb_lock *lck;
647 const char *name = NULL;
649 lck = odb_lock(h, h->pvfs->odb_context, &h->odb_locking_key);
651 DEBUG(0,("%s: failed to lock file '%s' in opendb\n",
652 __FUNCTION__, h->name->full_name));
653 /* we were supposed to do a blocking lock, so something
655 return NT_STATUS_INTERNAL_DB_CORRUPTION;
658 status = odb_get_path(lck, &name);
659 if (NT_STATUS_IS_OK(status)) {
661 * This relies an the fact that
662 * renames of open files are only
663 * allowed by setpathinfo() and setfileinfo()
664 * and there're only renames within the same
665 * directory supported
667 if (strcmp(h->name->full_name, name) != 0) {
668 const char *orig_dir;
669 const char *new_file;
670 const char *new_orig;
673 delim = strrchr(name, '/');
676 return NT_STATUS_INTERNAL_ERROR;
679 new_file = delim + 1;
680 delim = strrchr(h->name->original_name, '\\');
683 orig_dir = h->name->original_name;
684 new_orig = talloc_asprintf(h->name, "%s\\%s",
688 return NT_STATUS_NO_MEMORY;
691 new_orig = talloc_strdup(h->name, new_file);
694 return NT_STATUS_NO_MEMORY;
698 talloc_free(h->name->original_name);
699 talloc_free(h->name->full_name);
700 h->name->full_name = talloc_steal(h->name, name);
701 h->name->original_name = new_orig;
709 * TODO: pass PVFS_RESOLVE_NO_OPENDB and get
710 * the write time from odb_lock() above.
712 status = pvfs_resolve_name_fd(pvfs, h->fd, h->name, 0);
713 NT_STATUS_NOT_OK_RETURN(status);
715 if (!null_nttime(h->write_time.close_time)) {
716 h->name->dos.write_time = h->write_time.close_time;
724 resolve the parent of a given name
726 NTSTATUS pvfs_resolve_parent(struct pvfs_state *pvfs, TALLOC_CTX *mem_ctx,
727 const struct pvfs_filename *child,
728 struct pvfs_filename **name)
733 *name = talloc(mem_ctx, struct pvfs_filename);
735 return NT_STATUS_NO_MEMORY;
738 (*name)->full_name = talloc_strdup(*name, child->full_name);
739 if ((*name)->full_name == NULL) {
740 return NT_STATUS_NO_MEMORY;
743 p = strrchr_m((*name)->full_name, '/');
745 return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
748 /* this handles the root directory */
749 if (p == (*name)->full_name) {
755 if (stat((*name)->full_name, &(*name)->st) == -1) {
756 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
759 (*name)->exists = true;
760 (*name)->stream_exists = true;
761 (*name)->has_wildcard = false;
762 /* we can't get the correct 'original_name', but for the purposes
763 of this call this is close enough */
764 (*name)->original_name = talloc_reference(*name, child->original_name);
765 (*name)->stream_name = NULL;
766 (*name)->stream_id = 0;
768 status = pvfs_fill_dos_info(pvfs, *name, PVFS_RESOLVE_NO_OPENDB, -1);