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 smb_iconv_convenience *ic,
190 struct pvfs_filename *name,
195 return NT_STATUS_OBJECT_NAME_INVALID;
197 name->stream_name = talloc_strdup(name, s+1);
198 if (name->stream_name == NULL) {
199 return NT_STATUS_NO_MEMORY;
202 p = name->stream_name;
206 codepoint_t c = next_codepoint_convenience(ic, p, &c_size);
211 return NT_STATUS_OBJECT_NAME_INVALID;
216 return NT_STATUS_OBJECT_NAME_INVALID;
218 if (strcasecmp_m(p, "$DATA") != 0) {
219 if (strchr_m(p, ':')) {
220 return NT_STATUS_OBJECT_NAME_INVALID;
222 return NT_STATUS_INVALID_PARAMETER;
232 if (strcmp(name->stream_name, "") == 0) {
234 * we don't set stream_name to NULL, here
235 * as this would be wrong for directories
237 * pvfs_fill_dos_info() will set it to NULL
238 * if it's not a directory.
242 name->stream_id = pvfs_name_hash(name->stream_name,
243 strlen(name->stream_name));
251 convert a CIFS pathname to a unix pathname. Note that this does NOT
252 take into account case insensitivity, and in fact does not access
253 the filesystem at all. It is merely a reformatting and charset
256 errors are returned if the filename is illegal given the flags
258 static NTSTATUS pvfs_unix_path(struct pvfs_state *pvfs, const char *cifs_name,
259 uint_t flags, struct pvfs_filename *name)
261 char *ret, *p, *p_start;
262 struct smb_iconv_convenience *ic = NULL;
265 name->original_name = talloc_strdup(name, cifs_name);
266 name->stream_name = NULL;
268 name->has_wildcard = false;
270 while (*cifs_name == '\\') {
274 if (*cifs_name == 0) {
275 name->full_name = talloc_asprintf(name, "%s/.", pvfs->base_directory);
276 if (name->full_name == NULL) {
277 return NT_STATUS_NO_MEMORY;
282 ret = talloc_asprintf(name, "%s/%s", pvfs->base_directory, cifs_name);
284 return NT_STATUS_NO_MEMORY;
287 p = ret + strlen(pvfs->base_directory) + 1;
289 /* now do an in-place conversion of '\' to '/', checking
290 for legal characters */
293 ic = lp_iconv_convenience(pvfs->ntvfs->ctx->lp_ctx);
296 codepoint_t c = next_codepoint_convenience(ic, p, &c_size);
299 return NT_STATUS_OBJECT_NAME_INVALID;
304 if (name->has_wildcard) {
305 /* wildcards are only allowed in the last part
307 return NT_STATUS_OBJECT_NAME_INVALID;
309 if (p > p_start && (p[1] == '\\' || p[1] == '\0')) {
310 /* see if it is definately a "\\" or
311 * a trailing "\". If it is then fail here,
312 * and let the next layer up try again after
313 * pvfs_reduce_name() if it wants to. This is
314 * much more efficient on average than always
315 * scanning for these separately
317 return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
323 if (!(flags & PVFS_RESOLVE_STREAMS)) {
324 return NT_STATUS_OBJECT_NAME_INVALID;
326 if (name->has_wildcard) {
327 return NT_STATUS_OBJECT_NAME_INVALID;
329 status = parse_stream_name(ic, name, p);
330 if (!NT_STATUS_IS_OK(status)) {
340 if (!(flags & PVFS_RESOLVE_WILDCARD)) {
341 return NT_STATUS_OBJECT_NAME_INVALID;
343 name->has_wildcard = true;
347 return NT_STATUS_OBJECT_NAME_INVALID;
349 /* see if it is definately a .. or
350 . component. If it is then fail here, and
351 let the next layer up try again after
352 pvfs_reduce_name() if it wants to. This is
353 much more efficient on average than always
354 scanning for these separately */
356 (p[2] == 0 || p[2] == '\\') &&
357 (p == p_start || p[-1] == '/')) {
358 return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
360 if ((p[1] == 0 || p[1] == '\\') &&
361 (p == p_start || p[-1] == '/')) {
362 return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
370 name->full_name = ret;
377 reduce a name that contains .. components or repeated \ separators
378 return NULL if it can't be reduced
380 static NTSTATUS pvfs_reduce_name(TALLOC_CTX *mem_ctx,
381 struct smb_iconv_convenience *iconv_convenience,
382 const char **fname, uint_t flags)
386 int i, num_components, err_count;
390 s = talloc_strdup(mem_ctx, *fname);
391 if (s == NULL) return NT_STATUS_NO_MEMORY;
393 for (num_components=1, p=s; *p; p += c_size) {
394 c = next_codepoint_convenience(iconv_convenience, p, &c_size);
395 if (c == '\\') num_components++;
398 components = talloc_array(s, char *, num_components+1);
399 if (components == NULL) {
401 return NT_STATUS_NO_MEMORY;
405 for (i=0, p=s; *p; p += c_size) {
406 c = next_codepoint_convenience(iconv_convenience, p, &c_size);
409 components[++i] = p+1;
412 components[i+1] = NULL;
417 '.' components are not allowed, but the rules for what error
418 code to give don't seem to make sense. This is a close
421 for (err_count=i=0;components[i];i++) {
422 if (strcmp(components[i], "") == 0) {
425 if (ISDOT(components[i]) || err_count) {
430 if (flags & PVFS_RESOLVE_WILDCARD) err_count--;
433 return NT_STATUS_OBJECT_NAME_INVALID;
435 return NT_STATUS_OBJECT_PATH_NOT_FOUND;
439 /* remove any null components */
440 for (i=0;components[i];i++) {
441 if (strcmp(components[i], "") == 0) {
442 memmove(&components[i], &components[i+1],
443 sizeof(char *)*(num_components-i));
447 if (ISDOTDOT(components[i])) {
448 if (i < 1) return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
449 memmove(&components[i-1], &components[i+1],
450 sizeof(char *)*(num_components-i));
456 if (components[0] == NULL) {
458 *fname = talloc_strdup(mem_ctx, "\\");
462 for (len=i=0;components[i];i++) {
463 len += strlen(components[i]) + 1;
466 /* rebuild the name */
467 ret = talloc_size(mem_ctx, len+1);
470 return NT_STATUS_NO_MEMORY;
473 for (len=0,i=0;components[i];i++) {
474 size_t len1 = strlen(components[i]);
476 memcpy(ret+len+1, components[i], len1);
490 resolve a name from relative client format to a struct pvfs_filename
491 the memory for the filename is made as a talloc child of 'name'
494 PVFS_RESOLVE_NO_WILDCARD = wildcards are considered illegal characters
495 PVFS_RESOLVE_STREAMS = stream names are allowed
497 TODO: ../ collapsing, and outside share checking
499 NTSTATUS pvfs_resolve_name(struct pvfs_state *pvfs, TALLOC_CTX *mem_ctx,
500 const char *cifs_name,
501 uint_t flags, struct pvfs_filename **name)
505 *name = talloc(mem_ctx, struct pvfs_filename);
507 return NT_STATUS_NO_MEMORY;
510 (*name)->exists = false;
511 (*name)->stream_exists = false;
513 if (!(pvfs->fs_attribs & FS_ATTR_NAMED_STREAMS)) {
514 flags &= ~PVFS_RESOLVE_STREAMS;
517 /* do the basic conversion to a unix formatted path,
518 also checking for allowable characters */
519 status = pvfs_unix_path(pvfs, cifs_name, flags, *name);
521 if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_PATH_SYNTAX_BAD)) {
522 /* it might contain .. components which need to be reduced */
523 status = pvfs_reduce_name(*name, lp_iconv_convenience(pvfs->ntvfs->ctx->lp_ctx), &cifs_name, flags);
524 if (!NT_STATUS_IS_OK(status)) {
527 status = pvfs_unix_path(pvfs, cifs_name, flags, *name);
530 if (!NT_STATUS_IS_OK(status)) {
534 /* if it has a wildcard then no point doing a stat() of the
535 full name. Instead We need check if the directory exists
537 if ((*name)->has_wildcard) {
539 char *dir_name, *saved_name;
540 p = strrchr((*name)->full_name, '/');
542 /* root directory wildcard is OK */
545 dir_name = talloc_strndup(*name, (*name)->full_name, (p-(*name)->full_name));
546 if (stat(dir_name, &(*name)->st) == 0) {
547 talloc_free(dir_name);
550 /* we need to search for a matching name */
551 saved_name = (*name)->full_name;
552 (*name)->full_name = dir_name;
553 status = pvfs_case_search(pvfs, *name, flags);
554 if (!NT_STATUS_IS_OK(status)) {
555 /* the directory doesn't exist */
556 (*name)->full_name = saved_name;
559 /* it does exist, but might need a case change */
560 if (dir_name != (*name)->full_name) {
561 (*name)->full_name = talloc_asprintf(*name, "%s%s",
562 (*name)->full_name, p);
563 NT_STATUS_HAVE_NO_MEMORY((*name)->full_name);
565 (*name)->full_name = saved_name;
566 talloc_free(dir_name);
571 /* if we can stat() the full name now then we are done */
572 if (stat((*name)->full_name, &(*name)->st) == 0) {
573 (*name)->exists = true;
574 return pvfs_fill_dos_info(pvfs, *name, flags, -1);
577 /* search for a matching filename */
578 status = pvfs_case_search(pvfs, *name, flags);
585 do a partial resolve, returning a pvfs_filename structure given a
586 base path and a relative component. It is an error if the file does
587 not exist. No case-insensitive matching is done.
589 this is used in places like directory searching where we need a pvfs_filename
590 to pass to a function, but already know the unix base directory and component
592 NTSTATUS pvfs_resolve_partial(struct pvfs_state *pvfs, TALLOC_CTX *mem_ctx,
593 const char *unix_dir, const char *fname,
594 uint_t flags, struct pvfs_filename **name)
598 *name = talloc(mem_ctx, struct pvfs_filename);
600 return NT_STATUS_NO_MEMORY;
603 (*name)->full_name = talloc_asprintf(*name, "%s/%s", unix_dir, fname);
604 if ((*name)->full_name == NULL) {
605 return NT_STATUS_NO_MEMORY;
608 if (stat((*name)->full_name, &(*name)->st) == -1) {
609 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
612 (*name)->exists = true;
613 (*name)->stream_exists = true;
614 (*name)->has_wildcard = false;
615 (*name)->original_name = talloc_strdup(*name, fname);
616 (*name)->stream_name = NULL;
617 (*name)->stream_id = 0;
619 status = pvfs_fill_dos_info(pvfs, *name, flags, -1);
626 fill in the pvfs_filename info for an open file, given the current
627 info for a (possibly) non-open file. This is used by places that need
628 to update the pvfs_filename stat information, and by pvfs_open()
630 NTSTATUS pvfs_resolve_name_fd(struct pvfs_state *pvfs, int fd,
631 struct pvfs_filename *name, uint_t flags)
633 dev_t device = (dev_t)0;
637 device = name->st.st_dev;
638 inode = name->st.st_ino;
642 if (stat(name->full_name, &name->st) == -1) {
643 return NT_STATUS_INVALID_HANDLE;
646 if (fstat(fd, &name->st) == -1) {
647 return NT_STATUS_INVALID_HANDLE;
652 (device != name->st.st_dev || inode != name->st.st_ino)) {
653 /* the file we are looking at has changed! this could
654 be someone trying to exploit a race
655 condition. Certainly we don't want to continue
656 operating on this file */
657 DEBUG(0,("pvfs: WARNING: file '%s' changed during resolve - failing\n",
659 return NT_STATUS_UNEXPECTED_IO_ERROR;
664 return pvfs_fill_dos_info(pvfs, name, flags, fd);
668 fill in the pvfs_filename info for an open file, given the current
669 info for a (possibly) non-open file. This is used by places that need
670 to update the pvfs_filename stat information, and the path
671 after a possible rename on a different handle.
673 NTSTATUS pvfs_resolve_name_handle(struct pvfs_state *pvfs,
674 struct pvfs_file_handle *h)
678 if (h->have_opendb_entry) {
679 struct odb_lock *lck;
680 const char *name = NULL;
682 lck = odb_lock(h, h->pvfs->odb_context, &h->odb_locking_key);
684 DEBUG(0,("%s: failed to lock file '%s' in opendb\n",
685 __FUNCTION__, h->name->full_name));
686 /* we were supposed to do a blocking lock, so something
688 return NT_STATUS_INTERNAL_DB_CORRUPTION;
691 status = odb_get_path(lck, &name);
692 if (NT_STATUS_IS_OK(status)) {
694 * This relies an the fact that
695 * renames of open files are only
696 * allowed by setpathinfo() and setfileinfo()
697 * and there're only renames within the same
698 * directory supported
700 if (strcmp(h->name->full_name, name) != 0) {
701 const char *orig_dir;
702 const char *new_file;
703 const char *new_orig;
706 delim = strrchr(name, '/');
709 return NT_STATUS_INTERNAL_ERROR;
712 new_file = delim + 1;
713 delim = strrchr(h->name->original_name, '\\');
716 orig_dir = h->name->original_name;
717 new_orig = talloc_asprintf(h->name, "%s\\%s",
721 return NT_STATUS_NO_MEMORY;
724 new_orig = talloc_strdup(h->name, new_file);
727 return NT_STATUS_NO_MEMORY;
731 talloc_free(h->name->original_name);
732 talloc_free(h->name->full_name);
733 h->name->full_name = talloc_steal(h->name, name);
734 h->name->original_name = new_orig;
742 * TODO: pass PVFS_RESOLVE_NO_OPENDB and get
743 * the write time from odb_lock() above.
745 status = pvfs_resolve_name_fd(pvfs, h->fd, h->name, 0);
746 NT_STATUS_NOT_OK_RETURN(status);
748 if (!null_nttime(h->write_time.close_time)) {
749 h->name->dos.write_time = h->write_time.close_time;
757 resolve the parent of a given name
759 NTSTATUS pvfs_resolve_parent(struct pvfs_state *pvfs, TALLOC_CTX *mem_ctx,
760 const struct pvfs_filename *child,
761 struct pvfs_filename **name)
766 *name = talloc(mem_ctx, struct pvfs_filename);
768 return NT_STATUS_NO_MEMORY;
771 (*name)->full_name = talloc_strdup(*name, child->full_name);
772 if ((*name)->full_name == NULL) {
773 return NT_STATUS_NO_MEMORY;
776 p = strrchr_m((*name)->full_name, '/');
778 return NT_STATUS_OBJECT_PATH_SYNTAX_BAD;
781 /* this handles the root directory */
782 if (p == (*name)->full_name) {
788 if (stat((*name)->full_name, &(*name)->st) == -1) {
789 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
792 (*name)->exists = true;
793 (*name)->stream_exists = true;
794 (*name)->has_wildcard = false;
795 /* we can't get the correct 'original_name', but for the purposes
796 of this call this is close enough */
797 (*name)->original_name = talloc_reference(*name, child->original_name);
798 (*name)->stream_name = NULL;
799 (*name)->stream_id = 0;
801 status = pvfs_fill_dos_info(pvfs, *name, PVFS_RESOLVE_NO_OPENDB, -1);