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. This is used in an exceptional
105 case in reply_mv (so far). If saved_last_component == 0 then nothing
108 If last_component_wcard is true then a MS wildcard was detected and
109 should be allowed in the last component of the path only.
111 On exit from unix_convert, if *pst was not null, then the file stat
112 struct will be returned if the file exists and was found, if not this
113 stat struct will be filled with zeros (and this can be detected by checking
114 for nlinks = 0, which can never be true for any file).
115 ****************************************************************************/
117 NTSTATUS
unix_convert(TALLOC_CTX
*ctx
,
118 connection_struct
*conn
,
119 const char *orig_path
,
120 bool allow_wcard_last_component
,
122 char **pp_saved_last_component
,
123 SMB_STRUCT_STAT
*pst
)
127 char *dirpath
= NULL
;
130 bool component_was_mangled
= False
;
131 bool name_has_wildcard
= False
;
134 SET_STAT_INVALID(*pst
);
135 *pp_conv_path
= NULL
;
136 if(pp_saved_last_component
) {
137 *pp_saved_last_component
= NULL
;
141 /* we don't ever use the filenames on a printer share as a
142 filename - so don't convert them */
143 if (!(*pp_conv_path
= talloc_strdup(ctx
,orig_path
))) {
144 return NT_STATUS_NO_MEMORY
;
149 DEBUG(5, ("unix_convert called on file \"%s\"\n", orig_path
));
152 * Conversion to basic unix format is already done in
153 * check_path_syntax().
157 * Names must be relative to the root of the service - any leading /.
158 * and trailing /'s should have been trimmed by check_path_syntax().
162 SMB_ASSERT(*orig_path
!= '/');
166 * If we trimmed down to a single '\0' character
167 * then we should use the "." directory to avoid
168 * searching the cache, but not if we are in a
170 * As we know this is valid we can return true here.
174 if (!(name
= talloc_strdup(ctx
,"."))) {
175 return NT_STATUS_NO_MEMORY
;
177 if (SMB_VFS_STAT(conn
,name
,&st
) == 0) {
180 return map_nt_error_from_unix(errno
);
182 DEBUG(5,("conversion finished \"\" -> %s\n",name
));
186 if (orig_path
[0] == '.' && (orig_path
[1] == '/' ||
187 orig_path
[1] == '\0')) {
188 /* Start of pathname can't be "." only. */
189 if (orig_path
[1] == '\0' || orig_path
[2] == '\0') {
190 result
= NT_STATUS_OBJECT_NAME_INVALID
;
192 result
=determine_path_error(
193 &orig_path
[2], allow_wcard_last_component
);
199 * Ensure saved_last_component is valid even if file exists.
202 if(pp_saved_last_component
) {
203 end
= strrchr_m(orig_path
, '/');
205 *pp_saved_last_component
= talloc_strdup(ctx
, end
+ 1);
207 *pp_saved_last_component
= talloc_strdup(ctx
,
212 if (!(name
= talloc_strdup(ctx
, orig_path
))) {
213 DEBUG(0, ("talloc_strdup failed\n"));
214 return NT_STATUS_NO_MEMORY
;
217 stream
= strchr_m(name
, ':');
219 if (stream
!= NULL
) {
220 char *tmp
= talloc_strdup(ctx
, stream
);
223 return NT_STATUS_NO_MEMORY
;
230 * Large directory fix normalization. If we're case sensitive, and
231 * the case preserving parameters are set to "no", normalize the case of
232 * the incoming filename from the client WHETHER IT EXISTS OR NOT !
233 * This is in conflict with the current (3.0.20) man page, but is
234 * what people expect from the "large directory howto". I'll update
235 * the man page. Thanks to jht@samba.org for finding this. JRA.
238 if (conn
->case_sensitive
&& !conn
->case_preserve
&&
239 !conn
->short_case_preserve
) {
240 strnorm(name
, lp_defaultcase(SNUM(conn
)));
245 /* If we're providing case insentive semantics or
246 * the underlying filesystem is case insensitive,
247 * then a case-normalized hit in the stat-cache is
248 * authoratitive. JRA.
251 if((!conn
->case_sensitive
|| !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) &&
252 stat_cache_lookup(conn
, &name
, &dirpath
, &start
, &st
)) {
258 * Make sure "dirpath" is an allocated string, we use this for
259 * building the directories with asprintf and free it.
262 if ((dirpath
== NULL
) && (!(dirpath
= talloc_strdup(ctx
,"")))) {
263 DEBUG(0, ("talloc_strdup failed\n"));
265 return NT_STATUS_NO_MEMORY
;
269 * stat the name - if it exists then we are all done!
272 if (SMB_VFS_STAT(conn
,name
,&st
) == 0) {
273 /* Ensure we catch all names with in "/."
274 this is disallowed under Windows. */
275 const char *p
= strstr(name
, "/."); /* mb safe. */
278 /* Error code within a pathname. */
279 result
= NT_STATUS_OBJECT_PATH_NOT_FOUND
;
281 } else if (p
[2] == '\0') {
282 /* Error code at the end of a pathname. */
283 result
= NT_STATUS_OBJECT_NAME_INVALID
;
287 stat_cache_add(orig_path
, name
, conn
->case_sensitive
);
288 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
293 DEBUG(5,("unix_convert begin: name = %s, dirpath = %s, start = %s\n",
294 name
, dirpath
, start
));
297 * A special case - if we don't have any mangling chars and are case
298 * sensitive or the underlying filesystem is case insentive then searching
302 if ((conn
->case_sensitive
|| !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) &&
303 !mangle_is_mangled(name
, conn
->params
)) {
308 * is_mangled() was changed to look at an entire pathname, not
309 * just a component. JRA.
312 if (mangle_is_mangled(start
, conn
->params
)) {
313 component_was_mangled
= True
;
317 * Now we need to recursively match the name against the real
318 * directory structure.
322 * Match each part of the path name separately, trying the names
323 * as is first, then trying to scan the directory for matching names.
326 for (; start
; start
= (end
?end
+1:(char *)NULL
)) {
328 * Pinpoint the end of this section of the filename.
330 /* mb safe. '/' can't be in any encoded char. */
331 end
= strchr(start
, '/');
334 * Chop the name at this point.
340 if (pp_saved_last_component
) {
341 TALLOC_FREE(*pp_saved_last_component
);
342 *pp_saved_last_component
= talloc_strdup(ctx
,
343 end
? end
+ 1 : start
);
344 if (!*pp_saved_last_component
) {
345 DEBUG(0, ("talloc failed\n"));
346 return NT_STATUS_NO_MEMORY
;
350 /* The name cannot have a component of "." */
354 /* Error code at the end of a pathname. */
355 result
= NT_STATUS_OBJECT_NAME_INVALID
;
357 result
= determine_path_error(end
+1,
358 allow_wcard_last_component
);
363 /* The name cannot have a wildcard if it's not
364 the last component. */
366 name_has_wildcard
= ms_has_wild(start
);
368 /* Wildcard not valid anywhere. */
369 if (name_has_wildcard
&& !allow_wcard_last_component
) {
370 result
= NT_STATUS_OBJECT_NAME_INVALID
;
374 /* Wildcards never valid within a pathname. */
375 if (name_has_wildcard
&& end
) {
376 result
= NT_STATUS_OBJECT_NAME_INVALID
;
381 * Check if the name exists up to this point.
384 if (SMB_VFS_STAT(conn
,name
, &st
) == 0) {
386 * It exists. it must either be a directory or this must
387 * be the last part of the path for it to be OK.
389 if (end
&& !(st
.st_mode
& S_IFDIR
)) {
391 * An intermediate part of the name isn't
394 DEBUG(5,("Not a dir %s\n",start
));
397 * We need to return the fact that the
398 * intermediate name resolution failed. This
399 * is used to return an error of ERRbadpath
400 * rather than ERRbadfile. Some Windows
401 * applications depend on the difference between
404 result
= NT_STATUS_OBJECT_PATH_NOT_FOUND
;
410 * We just scanned for, and found the end of
411 * the path. We must return the valid stat
419 char *found_name
= NULL
;
421 /* Stat failed - ensure we don't use it. */
422 SET_STAT_INVALID(st
);
425 * Reset errno so we can detect
426 * directory open errors.
431 * Try to find this part of the path in the directory.
434 if (name_has_wildcard
||
435 !scan_directory(conn
, dirpath
,
436 start
, &found_name
)) {
441 * An intermediate part of the name
444 DEBUG(5,("Intermediate not found %s\n",
449 * We need to return the fact that the
450 * intermediate name resolution failed.
451 * This is used to return an error of
452 * ERRbadpath rather than ERRbadfile.
453 * Some Windows applications depend on
454 * the difference between these two
459 * ENOENT, ENOTDIR and ELOOP all map
460 * to NT_STATUS_OBJECT_PATH_NOT_FOUND
461 * in the filename walk.
464 if (errno
== ENOENT
||
468 NT_STATUS_OBJECT_PATH_NOT_FOUND
;
472 map_nt_error_from_unix(errno
);
477 /* ENOENT is the only valid error here. */
478 if (errno
!= ENOENT
) {
480 * ENOTDIR and ELOOP both map to
481 * NT_STATUS_OBJECT_PATH_NOT_FOUND
482 * in the filename walk.
484 if (errno
== ENOTDIR
||
487 NT_STATUS_OBJECT_PATH_NOT_FOUND
;
491 map_nt_error_from_unix(errno
);
497 * Just the last part of the name doesn't exist.
498 * We need to strupper() or strlower() it as
499 * this conversion may be used for file creation
500 * purposes. Fix inspired by
501 * Thomas Neumann <t.neumann@iku-ag.de>.
503 if (!conn
->case_preserve
||
504 (mangle_is_8_3(start
, False
,
506 !conn
->short_case_preserve
)) {
508 lp_defaultcase(SNUM(conn
)));
512 * check on the mangled stack to see if we can
513 * recover the base of the filename.
516 if (mangle_is_mangled(start
, conn
->params
)
517 && mangle_lookup_name_from_8_3(ctx
,
522 size_t start_ofs
= start
- name
;
524 if (*dirpath
!= '\0') {
525 tmp
= talloc_asprintf(ctx
,
528 TALLOC_FREE(unmangled
);
534 DEBUG(0, ("talloc failed\n"));
535 return NT_STATUS_NO_MEMORY
;
539 start
= name
+ start_ofs
;
540 end
= start
+ strlen(start
);
543 DEBUG(5,("New file %s\n",start
));
549 * Restore the rest of the string. If the string was
550 * mangled the size may have changed.
554 size_t start_ofs
= start
- name
;
556 if (*dirpath
!= '\0') {
557 tmp
= talloc_asprintf(ctx
,
562 tmp
= talloc_asprintf(ctx
,
567 DEBUG(0, ("talloc_asprintf failed\n"));
568 return NT_STATUS_NO_MEMORY
;
572 start
= name
+ start_ofs
;
573 end
= start
+ strlen(found_name
);
577 size_t start_ofs
= start
- name
;
579 if (*dirpath
!= '\0') {
580 tmp
= talloc_asprintf(ctx
,
584 tmp
= talloc_strdup(ctx
,
588 DEBUG(0, ("talloc failed\n"));
589 return NT_STATUS_NO_MEMORY
;
593 start
= name
+ start_ofs
;
596 * We just scanned for, and found the end of
597 * the path. We must return a valid stat struct
601 if (SMB_VFS_STAT(conn
,name
, &st
) == 0) {
604 SET_STAT_INVALID(st
);
608 TALLOC_FREE(found_name
);
612 if (VALID_STAT(st
) &&
613 get_delete_on_close_flag(vfs_file_id_from_sbuf(conn
,
615 result
= NT_STATUS_DELETE_PENDING
;
621 * Add to the dirpath that we have resolved so far.
624 if (*dirpath
!= '\0') {
625 char *tmp
= talloc_asprintf(ctx
,
626 "%s/%s", dirpath
, start
);
628 DEBUG(0, ("talloc_asprintf failed\n"));
629 return NT_STATUS_NO_MEMORY
;
631 TALLOC_FREE(dirpath
);
635 TALLOC_FREE(dirpath
);
636 if (!(dirpath
= talloc_strdup(ctx
,start
))) {
637 DEBUG(0, ("talloc_strdup failed\n"));
638 return NT_STATUS_NO_MEMORY
;
643 * Don't cache a name with mangled or wildcard components
644 * as this can change the size.
647 if(!component_was_mangled
&& !name_has_wildcard
) {
648 stat_cache_add(orig_path
, dirpath
,
649 conn
->case_sensitive
);
653 * Restore the / that we wiped out earlier.
661 * Don't cache a name with mangled or wildcard components
662 * as this can change the size.
665 if(!component_was_mangled
&& !name_has_wildcard
) {
666 stat_cache_add(orig_path
, name
, conn
->case_sensitive
);
670 * The name has been resolved.
673 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
676 if (stream
!= NULL
) {
679 result
= build_stream_path(ctx
, conn
, orig_path
, name
, stream
,
681 if (!NT_STATUS_IS_OK(result
)) {
685 DEBUG(10, ("build_stream_path returned %s\n", tmp
));
690 *pp_conv_path
= name
;
691 TALLOC_FREE(dirpath
);
694 DEBUG(10, ("dirpath = [%s] start = [%s]\n", dirpath
, start
));
695 if (*dirpath
!= '\0') {
696 *pp_conv_path
= talloc_asprintf(ctx
,
697 "%s/%s", dirpath
, start
);
699 *pp_conv_path
= talloc_strdup(ctx
, start
);
701 if (!*pp_conv_path
) {
702 DEBUG(0, ("talloc_asprintf failed\n"));
703 return NT_STATUS_NO_MEMORY
;
706 TALLOC_FREE(dirpath
);
710 /****************************************************************************
711 Check a filename - possibly calling check_reduced_name.
712 This is called by every routine before it allows an operation on a filename.
713 It does any final confirmation necessary to ensure that the filename is
714 a valid one for the user to access.
715 ****************************************************************************/
717 NTSTATUS
check_name(connection_struct
*conn
, const char *name
)
719 if (IS_VETO_PATH(conn
, name
)) {
720 /* Is it not dot or dot dot. */
721 if (!((name
[0] == '.') && (!name
[1] ||
722 (name
[1] == '.' && !name
[2])))) {
723 DEBUG(5,("check_name: file path name %s vetoed\n",
725 return map_nt_error_from_unix(ENOENT
);
729 if (!lp_widelinks(SNUM(conn
)) || !lp_symlinks(SNUM(conn
))) {
730 NTSTATUS status
= check_reduced_name(conn
,name
);
731 if (!NT_STATUS_IS_OK(status
)) {
732 DEBUG(5,("check_name: name %s failed with %s\n",name
,
741 /****************************************************************************
742 Check if two filenames are equal.
743 This needs to be careful about whether we are case sensitive.
744 ****************************************************************************/
746 static bool fname_equal(const char *name1
, const char *name2
,
749 /* Normal filename handling */
750 if (case_sensitive
) {
751 return(strcmp(name1
,name2
) == 0);
754 return(strequal(name1
,name2
));
757 /****************************************************************************
758 Scan a directory to find a filename, matching without case sensitivity.
759 If the name looks like a mangled name then try via the mangling functions
760 ****************************************************************************/
762 static bool scan_directory(connection_struct
*conn
, const char *path
,
763 char *name
, char **found_name
)
765 struct smb_Dir
*cur_dir
;
768 char *unmangled_name
= NULL
;
770 TALLOC_CTX
*ctx
= talloc_tos();
772 mangled
= mangle_is_mangled(name
, conn
->params
);
774 /* handle null paths */
775 if ((path
== NULL
) || (*path
== 0)) {
779 /* If we have a case-sensitive filesystem, it doesn't do us any
780 * good to search for a name. If a case variation of the name was
781 * there, then the original stat(2) would have found it.
783 if (!mangled
&& !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) {
789 * The incoming name can be mangled, and if we de-mangle it
790 * here it will not compare correctly against the filename (name2)
791 * read from the directory and then mangled by the name_to_8_3()
792 * call. We need to mangle both names or neither.
795 * Fix for bug found by Dina Fine. If in case sensitive mode then
796 * the mangle cache is no good (3 letter extension could be wrong
797 * case - so don't demangle in this case - leave as mangled and
798 * allow the mangling of the directory entry read (which is done
799 * case insensitively) to match instead. This will lead to more
800 * false positive matches but we fail completely without it. JRA.
803 if (mangled
&& !conn
->case_sensitive
) {
804 mangled
= !mangle_lookup_name_from_8_3(ctx
,
809 /* Name is now unmangled. */
810 name
= unmangled_name
;
814 /* open the directory */
815 if (!(cur_dir
= OpenDir(talloc_tos(), conn
, path
, NULL
, 0))) {
816 DEBUG(3,("scan dir didn't open dir [%s]\n",path
));
817 TALLOC_FREE(unmangled_name
);
821 /* now scan for matching names */
823 while ((dname
= ReadDirName(cur_dir
, &curpos
))) {
825 /* Is it dot or dot dot. */
826 if (ISDOT(dname
) || ISDOTDOT(dname
)) {
831 * At this point dname is the unmangled name.
832 * name is either mangled or not, depending on the state
833 * of the "mangled" variable. JRA.
837 * Check mangled name against mangled name, or unmangled name
838 * against unmangled name.
841 if ((mangled
&& mangled_equal(name
,dname
,conn
->params
)) ||
842 fname_equal(name
, dname
, conn
->case_sensitive
)) {
843 /* we've found the file, change it's name and return */
844 *found_name
= talloc_strdup(ctx
,dname
);
845 TALLOC_FREE(unmangled_name
);
846 TALLOC_FREE(cur_dir
);
855 TALLOC_FREE(unmangled_name
);
856 TALLOC_FREE(cur_dir
);
861 static NTSTATUS
build_stream_path(TALLOC_CTX
*mem_ctx
,
862 connection_struct
*conn
,
863 const char *orig_path
,
864 const char *basepath
,
865 const char *streamname
,
866 SMB_STRUCT_STAT
*pst
,
872 unsigned int i
, num_streams
;
873 struct stream_struct
*streams
= NULL
;
875 result
= talloc_asprintf(mem_ctx
, "%s%s", basepath
, streamname
);
876 if (result
== NULL
) {
877 return NT_STATUS_NO_MEMORY
;
880 if (SMB_VFS_STAT(conn
, result
, &st
) == 0) {
886 if (errno
!= ENOENT
) {
887 status
= map_nt_error_from_unix(errno
);
888 DEBUG(10, ("vfs_stat failed: %s\n", nt_errstr(status
)));
892 status
= SMB_VFS_STREAMINFO(conn
, NULL
, basepath
, mem_ctx
,
893 &num_streams
, &streams
);
895 if (NT_STATUS_EQUAL(status
, NT_STATUS_OBJECT_NAME_NOT_FOUND
)) {
896 SET_STAT_INVALID(*pst
);
901 if (!NT_STATUS_IS_OK(status
)) {
902 DEBUG(10, ("vfs_streaminfo failed: %s\n", nt_errstr(status
)));
906 for (i
=0; i
<num_streams
; i
++) {
907 DEBUG(10, ("comparing [%s] and [%s]: ",
908 streamname
, streams
[i
].name
));
909 if (fname_equal(streamname
, streams
[i
].name
,
910 conn
->case_sensitive
)) {
911 DEBUGADD(10, ("equal\n"));
914 DEBUGADD(10, ("not equal\n"));
917 if (i
== num_streams
) {
918 SET_STAT_INVALID(*pst
);
920 TALLOC_FREE(streams
);
926 result
= talloc_asprintf(mem_ctx
, "%s%s", basepath
, streams
[i
].name
);
927 if (result
== NULL
) {
928 status
= NT_STATUS_NO_MEMORY
;
932 SET_STAT_INVALID(*pst
);
934 if (SMB_VFS_STAT(conn
, result
, pst
) == 0) {
935 stat_cache_add(orig_path
, result
, conn
->case_sensitive
);
939 TALLOC_FREE(streams
);
944 TALLOC_FREE(streams
);