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 if (!lp_posix_pathnames()) {
218 stream
= strchr_m(name
, ':');
220 if (stream
!= NULL
) {
221 char *tmp
= talloc_strdup(ctx
, stream
);
224 return NT_STATUS_NO_MEMORY
;
232 * Large directory fix normalization. If we're case sensitive, and
233 * the case preserving parameters are set to "no", normalize the case of
234 * the incoming filename from the client WHETHER IT EXISTS OR NOT !
235 * This is in conflict with the current (3.0.20) man page, but is
236 * what people expect from the "large directory howto". I'll update
237 * the man page. Thanks to jht@samba.org for finding this. JRA.
240 if (conn
->case_sensitive
&& !conn
->case_preserve
&&
241 !conn
->short_case_preserve
) {
242 strnorm(name
, lp_defaultcase(SNUM(conn
)));
247 /* If we're providing case insentive semantics or
248 * the underlying filesystem is case insensitive,
249 * then a case-normalized hit in the stat-cache is
250 * authoratitive. JRA.
253 if((!conn
->case_sensitive
|| !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) &&
254 stat_cache_lookup(conn
, &name
, &dirpath
, &start
, &st
)) {
260 * Make sure "dirpath" is an allocated string, we use this for
261 * building the directories with asprintf and free it.
264 if ((dirpath
== NULL
) && (!(dirpath
= talloc_strdup(ctx
,"")))) {
265 DEBUG(0, ("talloc_strdup failed\n"));
267 return NT_STATUS_NO_MEMORY
;
271 * stat the name - if it exists then we are all done!
274 if (SMB_VFS_STAT(conn
,name
,&st
) == 0) {
275 /* Ensure we catch all names with in "/."
276 this is disallowed under Windows. */
277 const char *p
= strstr(name
, "/."); /* mb safe. */
280 /* Error code within a pathname. */
281 result
= NT_STATUS_OBJECT_PATH_NOT_FOUND
;
283 } else if (p
[2] == '\0') {
284 /* Error code at the end of a pathname. */
285 result
= NT_STATUS_OBJECT_NAME_INVALID
;
289 stat_cache_add(orig_path
, name
, conn
->case_sensitive
);
290 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
295 DEBUG(5,("unix_convert begin: name = %s, dirpath = %s, start = %s\n",
296 name
, dirpath
, start
));
299 * A special case - if we don't have any mangling chars and are case
300 * sensitive or the underlying filesystem is case insentive then searching
304 if ((conn
->case_sensitive
|| !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) &&
305 !mangle_is_mangled(name
, conn
->params
)) {
310 * is_mangled() was changed to look at an entire pathname, not
311 * just a component. JRA.
314 if (mangle_is_mangled(start
, conn
->params
)) {
315 component_was_mangled
= True
;
319 * Now we need to recursively match the name against the real
320 * directory structure.
324 * Match each part of the path name separately, trying the names
325 * as is first, then trying to scan the directory for matching names.
328 for (; start
; start
= (end
?end
+1:(char *)NULL
)) {
330 * Pinpoint the end of this section of the filename.
332 /* mb safe. '/' can't be in any encoded char. */
333 end
= strchr(start
, '/');
336 * Chop the name at this point.
342 if (pp_saved_last_component
) {
343 TALLOC_FREE(*pp_saved_last_component
);
344 *pp_saved_last_component
= talloc_strdup(ctx
,
345 end
? end
+ 1 : start
);
346 if (!*pp_saved_last_component
) {
347 DEBUG(0, ("talloc failed\n"));
348 return NT_STATUS_NO_MEMORY
;
352 /* The name cannot have a component of "." */
356 /* Error code at the end of a pathname. */
357 result
= NT_STATUS_OBJECT_NAME_INVALID
;
359 result
= determine_path_error(end
+1,
360 allow_wcard_last_component
);
365 /* The name cannot have a wildcard if it's not
366 the last component. */
368 name_has_wildcard
= ms_has_wild(start
);
370 /* Wildcard not valid anywhere. */
371 if (name_has_wildcard
&& !allow_wcard_last_component
) {
372 result
= NT_STATUS_OBJECT_NAME_INVALID
;
376 /* Wildcards never valid within a pathname. */
377 if (name_has_wildcard
&& end
) {
378 result
= NT_STATUS_OBJECT_NAME_INVALID
;
383 * Check if the name exists up to this point.
386 if (SMB_VFS_STAT(conn
,name
, &st
) == 0) {
388 * It exists. it must either be a directory or this must
389 * be the last part of the path for it to be OK.
391 if (end
&& !(st
.st_mode
& S_IFDIR
)) {
393 * An intermediate part of the name isn't
396 DEBUG(5,("Not a dir %s\n",start
));
399 * We need to return the fact that the
400 * intermediate name resolution failed. This
401 * is used to return an error of ERRbadpath
402 * rather than ERRbadfile. Some Windows
403 * applications depend on the difference between
406 result
= NT_STATUS_OBJECT_PATH_NOT_FOUND
;
412 * We just scanned for, and found the end of
413 * the path. We must return the valid stat
421 char *found_name
= NULL
;
423 /* Stat failed - ensure we don't use it. */
424 SET_STAT_INVALID(st
);
427 * Reset errno so we can detect
428 * directory open errors.
433 * Try to find this part of the path in the directory.
436 if (name_has_wildcard
||
437 !scan_directory(conn
, dirpath
,
438 start
, &found_name
)) {
443 * An intermediate part of the name
446 DEBUG(5,("Intermediate not found %s\n",
451 * We need to return the fact that the
452 * intermediate name resolution failed.
453 * This is used to return an error of
454 * ERRbadpath rather than ERRbadfile.
455 * Some Windows applications depend on
456 * the difference between these two
461 * ENOENT, ENOTDIR and ELOOP all map
462 * to NT_STATUS_OBJECT_PATH_NOT_FOUND
463 * in the filename walk.
466 if (errno
== ENOENT
||
470 NT_STATUS_OBJECT_PATH_NOT_FOUND
;
474 map_nt_error_from_unix(errno
);
479 /* ENOENT is the only valid error here. */
480 if (errno
!= ENOENT
) {
482 * ENOTDIR and ELOOP both map to
483 * NT_STATUS_OBJECT_PATH_NOT_FOUND
484 * in the filename walk.
486 if (errno
== ENOTDIR
||
489 NT_STATUS_OBJECT_PATH_NOT_FOUND
;
493 map_nt_error_from_unix(errno
);
499 * Just the last part of the name doesn't exist.
500 * We need to strupper() or strlower() it as
501 * this conversion may be used for file creation
502 * purposes. Fix inspired by
503 * Thomas Neumann <t.neumann@iku-ag.de>.
505 if (!conn
->case_preserve
||
506 (mangle_is_8_3(start
, False
,
508 !conn
->short_case_preserve
)) {
510 lp_defaultcase(SNUM(conn
)));
514 * check on the mangled stack to see if we can
515 * recover the base of the filename.
518 if (mangle_is_mangled(start
, conn
->params
)
519 && mangle_lookup_name_from_8_3(ctx
,
524 size_t start_ofs
= start
- name
;
526 if (*dirpath
!= '\0') {
527 tmp
= talloc_asprintf(ctx
,
530 TALLOC_FREE(unmangled
);
536 DEBUG(0, ("talloc failed\n"));
537 return NT_STATUS_NO_MEMORY
;
541 start
= name
+ start_ofs
;
542 end
= start
+ strlen(start
);
545 DEBUG(5,("New file %s\n",start
));
551 * Restore the rest of the string. If the string was
552 * mangled the size may have changed.
556 size_t start_ofs
= start
- name
;
558 if (*dirpath
!= '\0') {
559 tmp
= talloc_asprintf(ctx
,
564 tmp
= talloc_asprintf(ctx
,
569 DEBUG(0, ("talloc_asprintf failed\n"));
570 return NT_STATUS_NO_MEMORY
;
574 start
= name
+ start_ofs
;
575 end
= start
+ strlen(found_name
);
579 size_t start_ofs
= start
- name
;
581 if (*dirpath
!= '\0') {
582 tmp
= talloc_asprintf(ctx
,
586 tmp
= talloc_strdup(ctx
,
590 DEBUG(0, ("talloc failed\n"));
591 return NT_STATUS_NO_MEMORY
;
595 start
= name
+ start_ofs
;
598 * We just scanned for, and found the end of
599 * the path. We must return a valid stat struct
603 if (SMB_VFS_STAT(conn
,name
, &st
) == 0) {
606 SET_STAT_INVALID(st
);
610 TALLOC_FREE(found_name
);
616 * We should never provide different behaviors
617 * depending on DEVELOPER!!!
619 if (VALID_STAT(st
)) {
621 get_file_infos(vfs_file_id_from_sbuf(conn
, &st
),
622 &delete_pending
, NULL
);
623 if (delete_pending
) {
624 result
= NT_STATUS_DELETE_PENDING
;
631 * Add to the dirpath that we have resolved so far.
634 if (*dirpath
!= '\0') {
635 char *tmp
= talloc_asprintf(ctx
,
636 "%s/%s", dirpath
, start
);
638 DEBUG(0, ("talloc_asprintf failed\n"));
639 return NT_STATUS_NO_MEMORY
;
641 TALLOC_FREE(dirpath
);
645 TALLOC_FREE(dirpath
);
646 if (!(dirpath
= talloc_strdup(ctx
,start
))) {
647 DEBUG(0, ("talloc_strdup failed\n"));
648 return NT_STATUS_NO_MEMORY
;
653 * Don't cache a name with mangled or wildcard components
654 * as this can change the size.
657 if(!component_was_mangled
&& !name_has_wildcard
) {
658 stat_cache_add(orig_path
, dirpath
,
659 conn
->case_sensitive
);
663 * Restore the / that we wiped out earlier.
671 * Don't cache a name with mangled or wildcard components
672 * as this can change the size.
675 if(!component_was_mangled
&& !name_has_wildcard
) {
676 stat_cache_add(orig_path
, name
, conn
->case_sensitive
);
680 * The name has been resolved.
683 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
686 if (stream
!= NULL
) {
689 result
= build_stream_path(ctx
, conn
, orig_path
, name
, stream
,
691 if (!NT_STATUS_IS_OK(result
)) {
695 DEBUG(10, ("build_stream_path returned %s\n", tmp
));
700 *pp_conv_path
= name
;
701 TALLOC_FREE(dirpath
);
704 DEBUG(10, ("dirpath = [%s] start = [%s]\n", dirpath
, start
));
705 if (*dirpath
!= '\0') {
706 *pp_conv_path
= talloc_asprintf(ctx
,
707 "%s/%s", dirpath
, start
);
709 *pp_conv_path
= talloc_strdup(ctx
, start
);
711 if (!*pp_conv_path
) {
712 DEBUG(0, ("talloc_asprintf failed\n"));
713 return NT_STATUS_NO_MEMORY
;
716 TALLOC_FREE(dirpath
);
720 /****************************************************************************
721 Check a filename - possibly calling check_reduced_name.
722 This is called by every routine before it allows an operation on a filename.
723 It does any final confirmation necessary to ensure that the filename is
724 a valid one for the user to access.
725 ****************************************************************************/
727 NTSTATUS
check_name(connection_struct
*conn
, const char *name
)
729 if (IS_VETO_PATH(conn
, name
)) {
730 /* Is it not dot or dot dot. */
731 if (!((name
[0] == '.') && (!name
[1] ||
732 (name
[1] == '.' && !name
[2])))) {
733 DEBUG(5,("check_name: file path name %s vetoed\n",
735 return map_nt_error_from_unix(ENOENT
);
739 if (!lp_widelinks(SNUM(conn
)) || !lp_symlinks(SNUM(conn
))) {
740 NTSTATUS status
= check_reduced_name(conn
,name
);
741 if (!NT_STATUS_IS_OK(status
)) {
742 DEBUG(5,("check_name: name %s failed with %s\n",name
,
751 /****************************************************************************
752 Check if two filenames are equal.
753 This needs to be careful about whether we are case sensitive.
754 ****************************************************************************/
756 static bool fname_equal(const char *name1
, const char *name2
,
759 /* Normal filename handling */
760 if (case_sensitive
) {
761 return(strcmp(name1
,name2
) == 0);
764 return(strequal(name1
,name2
));
767 /****************************************************************************
768 Scan a directory to find a filename, matching without case sensitivity.
769 If the name looks like a mangled name then try via the mangling functions
770 ****************************************************************************/
772 static bool scan_directory(connection_struct
*conn
, const char *path
,
773 char *name
, char **found_name
)
775 struct smb_Dir
*cur_dir
;
778 char *unmangled_name
= NULL
;
780 TALLOC_CTX
*ctx
= talloc_tos();
782 mangled
= mangle_is_mangled(name
, conn
->params
);
784 /* handle null paths */
785 if ((path
== NULL
) || (*path
== 0)) {
789 /* If we have a case-sensitive filesystem, it doesn't do us any
790 * good to search for a name. If a case variation of the name was
791 * there, then the original stat(2) would have found it.
793 if (!mangled
&& !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) {
799 * The incoming name can be mangled, and if we de-mangle it
800 * here it will not compare correctly against the filename (name2)
801 * read from the directory and then mangled by the name_to_8_3()
802 * call. We need to mangle both names or neither.
805 * Fix for bug found by Dina Fine. If in case sensitive mode then
806 * the mangle cache is no good (3 letter extension could be wrong
807 * case - so don't demangle in this case - leave as mangled and
808 * allow the mangling of the directory entry read (which is done
809 * case insensitively) to match instead. This will lead to more
810 * false positive matches but we fail completely without it. JRA.
813 if (mangled
&& !conn
->case_sensitive
) {
814 mangled
= !mangle_lookup_name_from_8_3(ctx
,
819 /* Name is now unmangled. */
820 name
= unmangled_name
;
824 /* open the directory */
825 if (!(cur_dir
= OpenDir(talloc_tos(), conn
, path
, NULL
, 0))) {
826 DEBUG(3,("scan dir didn't open dir [%s]\n",path
));
827 TALLOC_FREE(unmangled_name
);
831 /* now scan for matching names */
833 while ((dname
= ReadDirName(cur_dir
, &curpos
))) {
835 /* Is it dot or dot dot. */
836 if (ISDOT(dname
) || ISDOTDOT(dname
)) {
841 * At this point dname is the unmangled name.
842 * name is either mangled or not, depending on the state
843 * of the "mangled" variable. JRA.
847 * Check mangled name against mangled name, or unmangled name
848 * against unmangled name.
851 if ((mangled
&& mangled_equal(name
,dname
,conn
->params
)) ||
852 fname_equal(name
, dname
, conn
->case_sensitive
)) {
853 /* we've found the file, change it's name and return */
854 *found_name
= talloc_strdup(ctx
,dname
);
855 TALLOC_FREE(unmangled_name
);
856 TALLOC_FREE(cur_dir
);
865 TALLOC_FREE(unmangled_name
);
866 TALLOC_FREE(cur_dir
);
871 static NTSTATUS
build_stream_path(TALLOC_CTX
*mem_ctx
,
872 connection_struct
*conn
,
873 const char *orig_path
,
874 const char *basepath
,
875 const char *streamname
,
876 SMB_STRUCT_STAT
*pst
,
882 unsigned int i
, num_streams
;
883 struct stream_struct
*streams
= NULL
;
885 result
= talloc_asprintf(mem_ctx
, "%s%s", basepath
, streamname
);
886 if (result
== NULL
) {
887 return NT_STATUS_NO_MEMORY
;
890 if (SMB_VFS_STAT(conn
, result
, &st
) == 0) {
896 if (errno
!= ENOENT
) {
897 status
= map_nt_error_from_unix(errno
);
898 DEBUG(10, ("vfs_stat failed: %s\n", nt_errstr(status
)));
902 status
= SMB_VFS_STREAMINFO(conn
, NULL
, basepath
, mem_ctx
,
903 &num_streams
, &streams
);
905 if (NT_STATUS_EQUAL(status
, NT_STATUS_OBJECT_NAME_NOT_FOUND
)) {
906 SET_STAT_INVALID(*pst
);
911 if (!NT_STATUS_IS_OK(status
)) {
912 DEBUG(10, ("vfs_streaminfo failed: %s\n", nt_errstr(status
)));
916 for (i
=0; i
<num_streams
; i
++) {
917 DEBUG(10, ("comparing [%s] and [%s]: ",
918 streamname
, streams
[i
].name
));
919 if (fname_equal(streamname
, streams
[i
].name
,
920 conn
->case_sensitive
)) {
921 DEBUGADD(10, ("equal\n"));
924 DEBUGADD(10, ("not equal\n"));
927 if (i
== num_streams
) {
928 SET_STAT_INVALID(*pst
);
930 TALLOC_FREE(streams
);
936 result
= talloc_asprintf(mem_ctx
, "%s%s", basepath
, streams
[i
].name
);
937 if (result
== NULL
) {
938 status
= NT_STATUS_NO_MEMORY
;
942 SET_STAT_INVALID(*pst
);
944 if (SMB_VFS_STAT(conn
, result
, pst
) == 0) {
945 stat_cache_add(orig_path
, result
, conn
->case_sensitive
);
949 TALLOC_FREE(streams
);
954 TALLOC_FREE(streams
);