2 Unix SMB/CIFS implementation.
3 filename handling routines
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 1999-2007
6 Copyright (C) Ying Chen 2000
7 Copyright (C) Volker Lendecke 2007
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * New hash table stat cache code added by Ying Chen.
29 static bool scan_directory(connection_struct
*conn
, const char *path
,
30 char *name
, char **found_name
);
31 static NTSTATUS
build_stream_path(TALLOC_CTX
*mem_ctx
,
32 connection_struct
*conn
,
33 const char *orig_path
,
35 const char *streamname
,
39 /****************************************************************************
40 Mangle the 2nd name and check if it is then equal to the first name.
41 ****************************************************************************/
43 static bool mangled_equal(const char *name1
,
45 const struct share_params
*p
)
49 if (!name_to_8_3(name2
, mname
, False
, p
)) {
52 return strequal(name1
, mname
);
55 /****************************************************************************
56 Cope with the differing wildcard and non-wildcard error cases.
57 ****************************************************************************/
59 static NTSTATUS
determine_path_error(const char *name
,
60 bool allow_wcard_last_component
)
64 if (!allow_wcard_last_component
) {
65 /* Error code within a pathname. */
66 return NT_STATUS_OBJECT_PATH_NOT_FOUND
;
69 /* We're terminating here so we
70 * can be a little slower and get
71 * the error code right. Windows
72 * treats the last part of the pathname
73 * separately I think, so if the last
74 * component is a wildcard then we treat
75 * this ./ as "end of component" */
77 p
= strchr(name
, '/');
79 if (!p
&& (ms_has_wild(name
) || ISDOT(name
))) {
80 /* Error code at the end of a pathname. */
81 return NT_STATUS_OBJECT_NAME_INVALID
;
83 /* Error code within a pathname. */
84 return NT_STATUS_OBJECT_PATH_NOT_FOUND
;
88 /****************************************************************************
89 This routine is called to convert names from the dos namespace to unix
90 namespace. It needs to handle any case conversions, mangling, format
93 We assume that we have already done a chdir() to the right "root" directory
96 The function will return an NTSTATUS error if some part of the name except for
97 the last part cannot be resolved, else NT_STATUS_OK.
99 Note NT_STATUS_OK doesn't mean the name exists or is valid, just that we didn't
100 get any fatal errors that should immediately terminate the calling
101 SMB processing whilst resolving.
103 If the saved_last_component != 0, then the unmodified last component
104 of the pathname is returned there. If saved_last_component == 0 then nothing
107 If last_component_wcard is true then a MS wildcard was detected and
108 should be allowed in the last component of the path only.
110 On exit from unix_convert, if *pst was not null, then the file stat
111 struct will be returned if the file exists and was found, if not this
112 stat struct will be filled with zeros (and this can be detected by checking
113 for nlinks = 0, which can never be true for any file).
114 ****************************************************************************/
116 NTSTATUS
unix_convert(TALLOC_CTX
*ctx
,
117 connection_struct
*conn
,
118 const char *orig_path
,
119 bool allow_wcard_last_component
,
121 char **pp_saved_last_component
,
122 SMB_STRUCT_STAT
*pst
)
126 char *dirpath
= NULL
;
129 bool component_was_mangled
= False
;
130 bool name_has_wildcard
= False
;
133 SET_STAT_INVALID(*pst
);
134 *pp_conv_path
= NULL
;
135 if(pp_saved_last_component
) {
136 *pp_saved_last_component
= NULL
;
140 /* we don't ever use the filenames on a printer share as a
141 filename - so don't convert them */
142 if (!(*pp_conv_path
= talloc_strdup(ctx
,orig_path
))) {
143 return NT_STATUS_NO_MEMORY
;
148 DEBUG(5, ("unix_convert called on file \"%s\"\n", orig_path
));
151 * Conversion to basic unix format is already done in
152 * check_path_syntax().
156 * Names must be relative to the root of the service - any leading /.
157 * and trailing /'s should have been trimmed by check_path_syntax().
161 SMB_ASSERT(*orig_path
!= '/');
165 * If we trimmed down to a single '\0' character
166 * then we should use the "." directory to avoid
167 * searching the cache, but not if we are in a
169 * As we know this is valid we can return true here.
173 if (!(name
= talloc_strdup(ctx
,"."))) {
174 return NT_STATUS_NO_MEMORY
;
176 if (SMB_VFS_STAT(conn
,name
,&st
) == 0) {
179 return map_nt_error_from_unix(errno
);
181 DEBUG(5,("conversion finished \"\" -> %s\n",name
));
185 if (orig_path
[0] == '.' && (orig_path
[1] == '/' ||
186 orig_path
[1] == '\0')) {
187 /* Start of pathname can't be "." only. */
188 if (orig_path
[1] == '\0' || orig_path
[2] == '\0') {
189 result
= NT_STATUS_OBJECT_NAME_INVALID
;
191 result
=determine_path_error(
192 &orig_path
[2], allow_wcard_last_component
);
198 * Ensure saved_last_component is valid even if file exists.
201 if(pp_saved_last_component
) {
202 end
= strrchr_m(orig_path
, '/');
204 *pp_saved_last_component
= talloc_strdup(ctx
, end
+ 1);
206 *pp_saved_last_component
= talloc_strdup(ctx
,
211 if (!(name
= talloc_strdup(ctx
, orig_path
))) {
212 DEBUG(0, ("talloc_strdup failed\n"));
213 return NT_STATUS_NO_MEMORY
;
216 if (!lp_posix_pathnames()) {
217 stream
= strchr_m(name
, ':');
219 if (stream
!= NULL
) {
220 char *tmp
= talloc_strdup(ctx
, stream
);
223 return NT_STATUS_NO_MEMORY
;
231 * Large directory fix normalization. If we're case sensitive, and
232 * the case preserving parameters are set to "no", normalize the case of
233 * the incoming filename from the client WHETHER IT EXISTS OR NOT !
234 * This is in conflict with the current (3.0.20) man page, but is
235 * what people expect from the "large directory howto". I'll update
236 * the man page. Thanks to jht@samba.org for finding this. JRA.
239 if (conn
->case_sensitive
&& !conn
->case_preserve
&&
240 !conn
->short_case_preserve
) {
241 strnorm(name
, lp_defaultcase(SNUM(conn
)));
246 /* If we're providing case insentive semantics or
247 * the underlying filesystem is case insensitive,
248 * then a case-normalized hit in the stat-cache is
249 * authoratitive. JRA.
252 if((!conn
->case_sensitive
|| !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) &&
253 stat_cache_lookup(conn
, &name
, &dirpath
, &start
, &st
)) {
259 * Make sure "dirpath" is an allocated string, we use this for
260 * building the directories with asprintf and free it.
263 if ((dirpath
== NULL
) && (!(dirpath
= talloc_strdup(ctx
,"")))) {
264 DEBUG(0, ("talloc_strdup failed\n"));
266 return NT_STATUS_NO_MEMORY
;
270 * stat the name - if it exists then we are all done!
273 if (SMB_VFS_STAT(conn
,name
,&st
) == 0) {
274 /* Ensure we catch all names with in "/."
275 this is disallowed under Windows. */
276 const char *p
= strstr(name
, "/."); /* mb safe. */
279 /* Error code within a pathname. */
280 result
= NT_STATUS_OBJECT_PATH_NOT_FOUND
;
282 } else if (p
[2] == '\0') {
283 /* Error code at the end of a pathname. */
284 result
= NT_STATUS_OBJECT_NAME_INVALID
;
288 stat_cache_add(orig_path
, name
, conn
->case_sensitive
);
289 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
294 DEBUG(5,("unix_convert begin: name = %s, dirpath = %s, start = %s\n",
295 name
, dirpath
, start
));
298 * A special case - if we don't have any mangling chars and are case
299 * sensitive or the underlying filesystem is case insentive then searching
303 if ((conn
->case_sensitive
|| !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) &&
304 !mangle_is_mangled(name
, conn
->params
)) {
309 * is_mangled() was changed to look at an entire pathname, not
310 * just a component. JRA.
313 if (mangle_is_mangled(start
, conn
->params
)) {
314 component_was_mangled
= True
;
318 * Now we need to recursively match the name against the real
319 * directory structure.
323 * Match each part of the path name separately, trying the names
324 * as is first, then trying to scan the directory for matching names.
327 for (; start
; start
= (end
?end
+1:(char *)NULL
)) {
329 * Pinpoint the end of this section of the filename.
331 /* mb safe. '/' can't be in any encoded char. */
332 end
= strchr(start
, '/');
335 * Chop the name at this point.
341 if (pp_saved_last_component
) {
342 TALLOC_FREE(*pp_saved_last_component
);
343 *pp_saved_last_component
= talloc_strdup(ctx
,
344 end
? end
+ 1 : start
);
345 if (!*pp_saved_last_component
) {
346 DEBUG(0, ("talloc failed\n"));
347 return NT_STATUS_NO_MEMORY
;
351 /* The name cannot have a component of "." */
355 /* Error code at the end of a pathname. */
356 result
= NT_STATUS_OBJECT_NAME_INVALID
;
358 result
= determine_path_error(end
+1,
359 allow_wcard_last_component
);
364 /* The name cannot have a wildcard if it's not
365 the last component. */
367 name_has_wildcard
= ms_has_wild(start
);
369 /* Wildcard not valid anywhere. */
370 if (name_has_wildcard
&& !allow_wcard_last_component
) {
371 result
= NT_STATUS_OBJECT_NAME_INVALID
;
375 /* Wildcards never valid within a pathname. */
376 if (name_has_wildcard
&& end
) {
377 result
= NT_STATUS_OBJECT_NAME_INVALID
;
382 * Check if the name exists up to this point.
385 if (SMB_VFS_STAT(conn
,name
, &st
) == 0) {
387 * It exists. it must either be a directory or this must
388 * be the last part of the path for it to be OK.
390 if (end
&& !(st
.st_mode
& S_IFDIR
)) {
392 * An intermediate part of the name isn't
395 DEBUG(5,("Not a dir %s\n",start
));
398 * We need to return the fact that the
399 * intermediate name resolution failed. This
400 * is used to return an error of ERRbadpath
401 * rather than ERRbadfile. Some Windows
402 * applications depend on the difference between
405 result
= NT_STATUS_OBJECT_PATH_NOT_FOUND
;
411 * We just scanned for, and found the end of
412 * the path. We must return the valid stat
420 char *found_name
= NULL
;
422 /* Stat failed - ensure we don't use it. */
423 SET_STAT_INVALID(st
);
426 * Reset errno so we can detect
427 * directory open errors.
432 * Try to find this part of the path in the directory.
435 if (name_has_wildcard
||
436 !scan_directory(conn
, dirpath
,
437 start
, &found_name
)) {
442 * An intermediate part of the name
445 DEBUG(5,("Intermediate not found %s\n",
450 * We need to return the fact that the
451 * intermediate name resolution failed.
452 * This is used to return an error of
453 * ERRbadpath rather than ERRbadfile.
454 * Some Windows applications depend on
455 * the difference between these two
460 * ENOENT, ENOTDIR and ELOOP all map
461 * to NT_STATUS_OBJECT_PATH_NOT_FOUND
462 * in the filename walk.
465 if (errno
== ENOENT
||
469 NT_STATUS_OBJECT_PATH_NOT_FOUND
;
473 map_nt_error_from_unix(errno
);
478 /* ENOENT is the only valid error here. */
479 if ((errno
!= 0) && (errno
!= ENOENT
)) {
481 * ENOTDIR and ELOOP both map to
482 * NT_STATUS_OBJECT_PATH_NOT_FOUND
483 * in the filename walk.
485 if (errno
== ENOTDIR
||
488 NT_STATUS_OBJECT_PATH_NOT_FOUND
;
492 map_nt_error_from_unix(errno
);
498 * Just the last part of the name doesn't exist.
499 * We need to strupper() or strlower() it as
500 * this conversion may be used for file creation
501 * purposes. Fix inspired by
502 * Thomas Neumann <t.neumann@iku-ag.de>.
504 if (!conn
->case_preserve
||
505 (mangle_is_8_3(start
, False
,
507 !conn
->short_case_preserve
)) {
509 lp_defaultcase(SNUM(conn
)));
513 * check on the mangled stack to see if we can
514 * recover the base of the filename.
517 if (mangle_is_mangled(start
, conn
->params
)
518 && mangle_lookup_name_from_8_3(ctx
,
523 size_t start_ofs
= start
- name
;
525 if (*dirpath
!= '\0') {
526 tmp
= talloc_asprintf(ctx
,
529 TALLOC_FREE(unmangled
);
535 DEBUG(0, ("talloc failed\n"));
536 return NT_STATUS_NO_MEMORY
;
540 start
= name
+ start_ofs
;
541 end
= start
+ strlen(start
);
544 DEBUG(5,("New file %s\n",start
));
550 * Restore the rest of the string. If the string was
551 * mangled the size may have changed.
555 size_t start_ofs
= start
- name
;
557 if (*dirpath
!= '\0') {
558 tmp
= talloc_asprintf(ctx
,
563 tmp
= talloc_asprintf(ctx
,
568 DEBUG(0, ("talloc_asprintf failed\n"));
569 return NT_STATUS_NO_MEMORY
;
573 start
= name
+ start_ofs
;
574 end
= start
+ strlen(found_name
);
578 size_t start_ofs
= start
- name
;
580 if (*dirpath
!= '\0') {
581 tmp
= talloc_asprintf(ctx
,
585 tmp
= talloc_strdup(ctx
,
589 DEBUG(0, ("talloc failed\n"));
590 return NT_STATUS_NO_MEMORY
;
594 start
= name
+ start_ofs
;
597 * We just scanned for, and found the end of
598 * the path. We must return a valid stat struct
602 if (SMB_VFS_STAT(conn
,name
, &st
) == 0) {
605 SET_STAT_INVALID(st
);
609 TALLOC_FREE(found_name
);
615 * We should never provide different behaviors
616 * depending on DEVELOPER!!!
618 if (VALID_STAT(st
)) {
620 get_file_infos(vfs_file_id_from_sbuf(conn
, &st
),
621 &delete_pending
, NULL
);
622 if (delete_pending
) {
623 result
= NT_STATUS_DELETE_PENDING
;
630 * Add to the dirpath that we have resolved so far.
633 if (*dirpath
!= '\0') {
634 char *tmp
= talloc_asprintf(ctx
,
635 "%s/%s", dirpath
, start
);
637 DEBUG(0, ("talloc_asprintf failed\n"));
638 return NT_STATUS_NO_MEMORY
;
640 TALLOC_FREE(dirpath
);
644 TALLOC_FREE(dirpath
);
645 if (!(dirpath
= talloc_strdup(ctx
,start
))) {
646 DEBUG(0, ("talloc_strdup failed\n"));
647 return NT_STATUS_NO_MEMORY
;
652 * Don't cache a name with mangled or wildcard components
653 * as this can change the size.
656 if(!component_was_mangled
&& !name_has_wildcard
) {
657 stat_cache_add(orig_path
, dirpath
,
658 conn
->case_sensitive
);
662 * Restore the / that we wiped out earlier.
670 * Don't cache a name with mangled or wildcard components
671 * as this can change the size.
674 if(!component_was_mangled
&& !name_has_wildcard
) {
675 stat_cache_add(orig_path
, name
, conn
->case_sensitive
);
679 * The name has been resolved.
682 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
685 if (stream
!= NULL
) {
688 result
= build_stream_path(ctx
, conn
, orig_path
, name
, stream
,
690 if (!NT_STATUS_IS_OK(result
)) {
694 DEBUG(10, ("build_stream_path returned %s\n", tmp
));
699 *pp_conv_path
= name
;
700 TALLOC_FREE(dirpath
);
703 DEBUG(10, ("dirpath = [%s] start = [%s]\n", dirpath
, start
));
704 if (*dirpath
!= '\0') {
705 *pp_conv_path
= talloc_asprintf(ctx
,
706 "%s/%s", dirpath
, start
);
708 *pp_conv_path
= talloc_strdup(ctx
, start
);
710 if (!*pp_conv_path
) {
711 DEBUG(0, ("talloc_asprintf failed\n"));
712 return NT_STATUS_NO_MEMORY
;
715 TALLOC_FREE(dirpath
);
719 /****************************************************************************
720 Check a filename - possibly calling check_reduced_name.
721 This is called by every routine before it allows an operation on a filename.
722 It does any final confirmation necessary to ensure that the filename is
723 a valid one for the user to access.
724 ****************************************************************************/
726 NTSTATUS
check_name(connection_struct
*conn
, const char *name
)
728 if (IS_VETO_PATH(conn
, name
)) {
729 /* Is it not dot or dot dot. */
730 if (!((name
[0] == '.') && (!name
[1] ||
731 (name
[1] == '.' && !name
[2])))) {
732 DEBUG(5,("check_name: file path name %s vetoed\n",
734 return map_nt_error_from_unix(ENOENT
);
738 if (!lp_widelinks(SNUM(conn
)) || !lp_symlinks(SNUM(conn
))) {
739 NTSTATUS status
= check_reduced_name(conn
,name
);
740 if (!NT_STATUS_IS_OK(status
)) {
741 DEBUG(5,("check_name: name %s failed with %s\n",name
,
750 /****************************************************************************
751 Check if two filenames are equal.
752 This needs to be careful about whether we are case sensitive.
753 ****************************************************************************/
755 static bool fname_equal(const char *name1
, const char *name2
,
758 /* Normal filename handling */
759 if (case_sensitive
) {
760 return(strcmp(name1
,name2
) == 0);
763 return(strequal(name1
,name2
));
766 /****************************************************************************
767 Scan a directory to find a filename, matching without case sensitivity.
768 If the name looks like a mangled name then try via the mangling functions
769 ****************************************************************************/
771 static bool scan_directory(connection_struct
*conn
, const char *path
,
772 char *name
, char **found_name
)
774 struct smb_Dir
*cur_dir
;
777 char *unmangled_name
= NULL
;
779 TALLOC_CTX
*ctx
= talloc_tos();
781 mangled
= mangle_is_mangled(name
, conn
->params
);
783 /* handle null paths */
784 if ((path
== NULL
) || (*path
== 0)) {
788 /* If we have a case-sensitive filesystem, it doesn't do us any
789 * good to search for a name. If a case variation of the name was
790 * there, then the original stat(2) would have found it.
792 if (!mangled
&& !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) {
798 * The incoming name can be mangled, and if we de-mangle it
799 * here it will not compare correctly against the filename (name2)
800 * read from the directory and then mangled by the name_to_8_3()
801 * call. We need to mangle both names or neither.
804 * Fix for bug found by Dina Fine. If in case sensitive mode then
805 * the mangle cache is no good (3 letter extension could be wrong
806 * case - so don't demangle in this case - leave as mangled and
807 * allow the mangling of the directory entry read (which is done
808 * case insensitively) to match instead. This will lead to more
809 * false positive matches but we fail completely without it. JRA.
812 if (mangled
&& !conn
->case_sensitive
) {
813 mangled
= !mangle_lookup_name_from_8_3(ctx
,
818 /* Name is now unmangled. */
819 name
= unmangled_name
;
823 /* open the directory */
824 if (!(cur_dir
= OpenDir(talloc_tos(), conn
, path
, NULL
, 0))) {
825 DEBUG(3,("scan dir didn't open dir [%s]\n",path
));
826 TALLOC_FREE(unmangled_name
);
830 /* now scan for matching names */
832 while ((dname
= ReadDirName(cur_dir
, &curpos
))) {
834 /* Is it dot or dot dot. */
835 if (ISDOT(dname
) || ISDOTDOT(dname
)) {
840 * At this point dname is the unmangled name.
841 * name is either mangled or not, depending on the state
842 * of the "mangled" variable. JRA.
846 * Check mangled name against mangled name, or unmangled name
847 * against unmangled name.
850 if ((mangled
&& mangled_equal(name
,dname
,conn
->params
)) ||
851 fname_equal(name
, dname
, conn
->case_sensitive
)) {
852 /* we've found the file, change it's name and return */
853 *found_name
= talloc_strdup(ctx
,dname
);
854 TALLOC_FREE(unmangled_name
);
855 TALLOC_FREE(cur_dir
);
864 TALLOC_FREE(unmangled_name
);
865 TALLOC_FREE(cur_dir
);
870 static NTSTATUS
build_stream_path(TALLOC_CTX
*mem_ctx
,
871 connection_struct
*conn
,
872 const char *orig_path
,
873 const char *basepath
,
874 const char *streamname
,
875 SMB_STRUCT_STAT
*pst
,
881 unsigned int i
, num_streams
;
882 struct stream_struct
*streams
= NULL
;
884 result
= talloc_asprintf(mem_ctx
, "%s%s", basepath
, streamname
);
885 if (result
== NULL
) {
886 return NT_STATUS_NO_MEMORY
;
889 if (SMB_VFS_STAT(conn
, result
, &st
) == 0) {
895 if (errno
!= ENOENT
) {
896 status
= map_nt_error_from_unix(errno
);
897 DEBUG(10, ("vfs_stat failed: %s\n", nt_errstr(status
)));
901 status
= SMB_VFS_STREAMINFO(conn
, NULL
, basepath
, mem_ctx
,
902 &num_streams
, &streams
);
904 if (NT_STATUS_EQUAL(status
, NT_STATUS_OBJECT_NAME_NOT_FOUND
)) {
905 SET_STAT_INVALID(*pst
);
910 if (!NT_STATUS_IS_OK(status
)) {
911 DEBUG(10, ("vfs_streaminfo failed: %s\n", nt_errstr(status
)));
915 for (i
=0; i
<num_streams
; i
++) {
916 DEBUG(10, ("comparing [%s] and [%s]: ",
917 streamname
, streams
[i
].name
));
918 if (fname_equal(streamname
, streams
[i
].name
,
919 conn
->case_sensitive
)) {
920 DEBUGADD(10, ("equal\n"));
923 DEBUGADD(10, ("not equal\n"));
926 if (i
== num_streams
) {
927 SET_STAT_INVALID(*pst
);
929 TALLOC_FREE(streams
);
935 result
= talloc_asprintf(mem_ctx
, "%s%s", basepath
, streams
[i
].name
);
936 if (result
== NULL
) {
937 status
= NT_STATUS_NO_MEMORY
;
941 SET_STAT_INVALID(*pst
);
943 if (SMB_VFS_STAT(conn
, result
, pst
) == 0) {
944 stat_cache_add(orig_path
, result
, conn
->case_sensitive
);
948 TALLOC_FREE(streams
);
953 TALLOC_FREE(streams
);