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 NTSTATUS
build_stream_path(TALLOC_CTX
*mem_ctx
,
30 connection_struct
*conn
,
31 const char *orig_path
,
33 const char *streamname
,
37 /****************************************************************************
38 Mangle the 2nd name and check if it is then equal to the first name.
39 ****************************************************************************/
41 static bool mangled_equal(const char *name1
,
43 const struct share_params
*p
)
47 if (!name_to_8_3(name2
, mname
, False
, p
)) {
50 return strequal(name1
, mname
);
53 /****************************************************************************
54 Cope with the differing wildcard and non-wildcard error cases.
55 ****************************************************************************/
57 static NTSTATUS
determine_path_error(const char *name
,
58 bool allow_wcard_last_component
)
62 if (!allow_wcard_last_component
) {
63 /* Error code within a pathname. */
64 return NT_STATUS_OBJECT_PATH_NOT_FOUND
;
67 /* We're terminating here so we
68 * can be a little slower and get
69 * the error code right. Windows
70 * treats the last part of the pathname
71 * separately I think, so if the last
72 * component is a wildcard then we treat
73 * this ./ as "end of component" */
75 p
= strchr(name
, '/');
77 if (!p
&& (ms_has_wild(name
) || ISDOT(name
))) {
78 /* Error code at the end of a pathname. */
79 return NT_STATUS_OBJECT_NAME_INVALID
;
81 /* Error code within a pathname. */
82 return NT_STATUS_OBJECT_PATH_NOT_FOUND
;
86 /****************************************************************************
87 This routine is called to convert names from the dos namespace to unix
88 namespace. It needs to handle any case conversions, mangling, format
91 We assume that we have already done a chdir() to the right "root" directory
94 The function will return an NTSTATUS error if some part of the name except for
95 the last part cannot be resolved, else NT_STATUS_OK.
97 Note NT_STATUS_OK doesn't mean the name exists or is valid, just that we didn't
98 get any fatal errors that should immediately terminate the calling
99 SMB processing whilst resolving.
101 If the saved_last_component != 0, then the unmodified last component
102 of the pathname is returned there. If saved_last_component == 0 then nothing
105 If last_component_wcard is true then a MS wildcard was detected and
106 should be allowed in the last component of the path only.
108 On exit from unix_convert, if *pst was not null, then the file stat
109 struct will be returned if the file exists and was found, if not this
110 stat struct will be filled with zeros (and this can be detected by checking
111 for nlinks = 0, which can never be true for any file).
112 ****************************************************************************/
114 NTSTATUS
unix_convert(TALLOC_CTX
*ctx
,
115 connection_struct
*conn
,
116 const char *orig_path
,
117 bool allow_wcard_last_component
,
119 char **pp_saved_last_component
,
120 SMB_STRUCT_STAT
*pst
)
124 char *dirpath
= NULL
;
127 bool component_was_mangled
= False
;
128 bool name_has_wildcard
= False
;
129 bool posix_pathnames
= 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
);
197 if (!(name
= talloc_strdup(ctx
, orig_path
))) {
198 DEBUG(0, ("talloc_strdup failed\n"));
199 return NT_STATUS_NO_MEMORY
;
203 * Large directory fix normalization. If we're case sensitive, and
204 * the case preserving parameters are set to "no", normalize the case of
205 * the incoming filename from the client WHETHER IT EXISTS OR NOT !
206 * This is in conflict with the current (3.0.20) man page, but is
207 * what people expect from the "large directory howto". I'll update
208 * the man page. Thanks to jht@samba.org for finding this. JRA.
211 if (conn
->case_sensitive
&& !conn
->case_preserve
&&
212 !conn
->short_case_preserve
) {
213 strnorm(name
, lp_defaultcase(SNUM(conn
)));
217 * Ensure saved_last_component is valid even if file exists.
220 if(pp_saved_last_component
) {
221 end
= strrchr_m(name
, '/');
223 *pp_saved_last_component
= talloc_strdup(ctx
, end
+ 1);
225 *pp_saved_last_component
= talloc_strdup(ctx
,
230 posix_pathnames
= lp_posix_pathnames();
232 if (!posix_pathnames
) {
233 stream
= strchr_m(name
, ':');
235 if (stream
!= NULL
) {
236 char *tmp
= talloc_strdup(ctx
, stream
);
239 return NT_STATUS_NO_MEMORY
;
248 /* If we're providing case insentive semantics or
249 * the underlying filesystem is case insensitive,
250 * then a case-normalized hit in the stat-cache is
251 * authoratitive. JRA.
254 if((!conn
->case_sensitive
|| !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) &&
255 stat_cache_lookup(conn
, &name
, &dirpath
, &start
, &st
)) {
261 * Make sure "dirpath" is an allocated string, we use this for
262 * building the directories with asprintf and free it.
265 if ((dirpath
== NULL
) && (!(dirpath
= talloc_strdup(ctx
,"")))) {
266 DEBUG(0, ("talloc_strdup failed\n"));
268 return NT_STATUS_NO_MEMORY
;
272 * stat the name - if it exists then we are all done!
275 if (posix_pathnames
) {
276 ret
= SMB_VFS_LSTAT(conn
,name
,&st
);
278 ret
= SMB_VFS_STAT(conn
,name
,&st
);
282 /* Ensure we catch all names with in "/."
283 this is disallowed under Windows. */
284 const char *p
= strstr(name
, "/."); /* mb safe. */
287 /* Error code within a pathname. */
288 result
= NT_STATUS_OBJECT_PATH_NOT_FOUND
;
290 } else if (p
[2] == '\0') {
291 /* Error code at the end of a pathname. */
292 result
= NT_STATUS_OBJECT_NAME_INVALID
;
296 stat_cache_add(orig_path
, name
, conn
->case_sensitive
);
297 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
302 DEBUG(5,("unix_convert begin: name = %s, dirpath = %s, start = %s\n",
303 name
, dirpath
, start
));
306 * A special case - if we don't have any mangling chars and are case
307 * sensitive or the underlying filesystem is case insentive then searching
311 if ((conn
->case_sensitive
|| !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) &&
312 !mangle_is_mangled(name
, conn
->params
)) {
317 * is_mangled() was changed to look at an entire pathname, not
318 * just a component. JRA.
321 if (mangle_is_mangled(start
, conn
->params
)) {
322 component_was_mangled
= True
;
326 * Now we need to recursively match the name against the real
327 * directory structure.
331 * Match each part of the path name separately, trying the names
332 * as is first, then trying to scan the directory for matching names.
335 for (; start
; start
= (end
?end
+1:(char *)NULL
)) {
337 * Pinpoint the end of this section of the filename.
339 /* mb safe. '/' can't be in any encoded char. */
340 end
= strchr(start
, '/');
343 * Chop the name at this point.
349 if (pp_saved_last_component
) {
350 TALLOC_FREE(*pp_saved_last_component
);
351 *pp_saved_last_component
= talloc_strdup(ctx
,
352 end
? end
+ 1 : start
);
353 if (!*pp_saved_last_component
) {
354 DEBUG(0, ("talloc failed\n"));
355 return NT_STATUS_NO_MEMORY
;
359 /* The name cannot have a component of "." */
363 /* Error code at the end of a pathname. */
364 result
= NT_STATUS_OBJECT_NAME_INVALID
;
366 result
= determine_path_error(end
+1,
367 allow_wcard_last_component
);
372 /* The name cannot have a wildcard if it's not
373 the last component. */
375 name_has_wildcard
= ms_has_wild(start
);
377 /* Wildcard not valid anywhere. */
378 if (name_has_wildcard
&& !allow_wcard_last_component
) {
379 result
= NT_STATUS_OBJECT_NAME_INVALID
;
383 /* Wildcards never valid within a pathname. */
384 if (name_has_wildcard
&& end
) {
385 result
= NT_STATUS_OBJECT_NAME_INVALID
;
390 * Check if the name exists up to this point.
393 if (posix_pathnames
) {
394 ret
= SMB_VFS_LSTAT(conn
,name
, &st
);
396 ret
= SMB_VFS_STAT(conn
,name
, &st
);
401 * It exists. it must either be a directory or this must
402 * be the last part of the path for it to be OK.
404 if (end
&& !(st
.st_mode
& S_IFDIR
)) {
406 * An intermediate part of the name isn't
409 DEBUG(5,("Not a dir %s\n",start
));
412 * We need to return the fact that the
413 * intermediate name resolution failed. This
414 * is used to return an error of ERRbadpath
415 * rather than ERRbadfile. Some Windows
416 * applications depend on the difference between
419 result
= NT_STATUS_OBJECT_PATH_NOT_FOUND
;
425 * We just scanned for, and found the end of
426 * the path. We must return the valid stat
434 char *found_name
= NULL
;
436 /* Stat failed - ensure we don't use it. */
437 SET_STAT_INVALID(st
);
440 * Reset errno so we can detect
441 * directory open errors.
446 * Try to find this part of the path in the directory.
449 if (name_has_wildcard
||
450 (SMB_VFS_GET_REAL_FILENAME(
451 conn
, dirpath
, start
,
452 talloc_tos(), &found_name
) == -1)) {
457 * An intermediate part of the name
460 DEBUG(5,("Intermediate not found %s\n",
465 * We need to return the fact that the
466 * intermediate name resolution failed.
467 * This is used to return an error of
468 * ERRbadpath rather than ERRbadfile.
469 * Some Windows applications depend on
470 * the difference between these two
475 * ENOENT, ENOTDIR and ELOOP all map
476 * to NT_STATUS_OBJECT_PATH_NOT_FOUND
477 * in the filename walk.
480 if (errno
== ENOENT
||
484 NT_STATUS_OBJECT_PATH_NOT_FOUND
;
488 map_nt_error_from_unix(errno
);
493 /* ENOENT is the only valid error here. */
494 if ((errno
!= 0) && (errno
!= ENOENT
)) {
496 * ENOTDIR and ELOOP both map to
497 * NT_STATUS_OBJECT_PATH_NOT_FOUND
498 * in the filename walk.
500 if (errno
== ENOTDIR
||
503 NT_STATUS_OBJECT_PATH_NOT_FOUND
;
507 map_nt_error_from_unix(errno
);
513 * Just the last part of the name doesn't exist.
514 * We need to strupper() or strlower() it as
515 * this conversion may be used for file creation
516 * purposes. Fix inspired by
517 * Thomas Neumann <t.neumann@iku-ag.de>.
519 if (!conn
->case_preserve
||
520 (mangle_is_8_3(start
, False
,
522 !conn
->short_case_preserve
)) {
524 lp_defaultcase(SNUM(conn
)));
528 * check on the mangled stack to see if we can
529 * recover the base of the filename.
532 if (mangle_is_mangled(start
, conn
->params
)
533 && mangle_lookup_name_from_8_3(ctx
,
538 size_t start_ofs
= start
- name
;
540 if (*dirpath
!= '\0') {
541 tmp
= talloc_asprintf(ctx
,
544 TALLOC_FREE(unmangled
);
550 DEBUG(0, ("talloc failed\n"));
551 return NT_STATUS_NO_MEMORY
;
555 start
= name
+ start_ofs
;
556 end
= start
+ strlen(start
);
559 DEBUG(5,("New file %s\n",start
));
565 * Restore the rest of the string. If the string was
566 * mangled the size may have changed.
570 size_t start_ofs
= start
- name
;
572 if (*dirpath
!= '\0') {
573 tmp
= talloc_asprintf(ctx
,
578 tmp
= talloc_asprintf(ctx
,
583 DEBUG(0, ("talloc_asprintf failed\n"));
584 return NT_STATUS_NO_MEMORY
;
588 start
= name
+ start_ofs
;
589 end
= start
+ strlen(found_name
);
593 size_t start_ofs
= start
- name
;
595 if (*dirpath
!= '\0') {
596 tmp
= talloc_asprintf(ctx
,
600 tmp
= talloc_strdup(ctx
,
604 DEBUG(0, ("talloc failed\n"));
605 return NT_STATUS_NO_MEMORY
;
609 start
= name
+ start_ofs
;
612 * We just scanned for, and found the end of
613 * the path. We must return a valid stat struct
617 if (posix_pathnames
) {
618 ret
= SMB_VFS_LSTAT(conn
,name
, &st
);
620 ret
= SMB_VFS_STAT(conn
,name
, &st
);
626 SET_STAT_INVALID(st
);
630 TALLOC_FREE(found_name
);
636 * We should never provide different behaviors
637 * depending on DEVELOPER!!!
639 if (VALID_STAT(st
)) {
641 get_file_infos(vfs_file_id_from_sbuf(conn
, &st
),
642 &delete_pending
, NULL
);
643 if (delete_pending
) {
644 result
= NT_STATUS_DELETE_PENDING
;
651 * Add to the dirpath that we have resolved so far.
654 if (*dirpath
!= '\0') {
655 char *tmp
= talloc_asprintf(ctx
,
656 "%s/%s", dirpath
, start
);
658 DEBUG(0, ("talloc_asprintf failed\n"));
659 return NT_STATUS_NO_MEMORY
;
661 TALLOC_FREE(dirpath
);
665 TALLOC_FREE(dirpath
);
666 if (!(dirpath
= talloc_strdup(ctx
,start
))) {
667 DEBUG(0, ("talloc_strdup failed\n"));
668 return NT_STATUS_NO_MEMORY
;
673 * Don't cache a name with mangled or wildcard components
674 * as this can change the size.
677 if(!component_was_mangled
&& !name_has_wildcard
) {
678 stat_cache_add(orig_path
, dirpath
,
679 conn
->case_sensitive
);
683 * Restore the / that we wiped out earlier.
691 * Don't cache a name with mangled or wildcard components
692 * as this can change the size.
695 if(!component_was_mangled
&& !name_has_wildcard
) {
696 stat_cache_add(orig_path
, name
, conn
->case_sensitive
);
700 * The name has been resolved.
703 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
706 if (stream
!= NULL
) {
709 result
= build_stream_path(ctx
, conn
, orig_path
, name
, stream
,
711 if (!NT_STATUS_IS_OK(result
)) {
715 DEBUG(10, ("build_stream_path returned %s\n", tmp
));
720 *pp_conv_path
= name
;
721 TALLOC_FREE(dirpath
);
724 DEBUG(10, ("dirpath = [%s] start = [%s]\n", dirpath
, start
));
725 if (*dirpath
!= '\0') {
726 *pp_conv_path
= talloc_asprintf(ctx
,
727 "%s/%s", dirpath
, start
);
729 *pp_conv_path
= talloc_strdup(ctx
, start
);
731 if (!*pp_conv_path
) {
732 DEBUG(0, ("talloc_asprintf failed\n"));
733 return NT_STATUS_NO_MEMORY
;
736 TALLOC_FREE(dirpath
);
740 /****************************************************************************
741 Check a filename - possibly calling check_reduced_name.
742 This is called by every routine before it allows an operation on a filename.
743 It does any final confirmation necessary to ensure that the filename is
744 a valid one for the user to access.
745 ****************************************************************************/
747 NTSTATUS
check_name(connection_struct
*conn
, const char *name
)
749 if (IS_VETO_PATH(conn
, name
)) {
750 /* Is it not dot or dot dot. */
751 if (!((name
[0] == '.') && (!name
[1] ||
752 (name
[1] == '.' && !name
[2])))) {
753 DEBUG(5,("check_name: file path name %s vetoed\n",
755 return map_nt_error_from_unix(ENOENT
);
759 if (!lp_widelinks(SNUM(conn
)) || !lp_symlinks(SNUM(conn
))) {
760 NTSTATUS status
= check_reduced_name(conn
,name
);
761 if (!NT_STATUS_IS_OK(status
)) {
762 DEBUG(5,("check_name: name %s failed with %s\n",name
,
771 /****************************************************************************
772 Check if two filenames are equal.
773 This needs to be careful about whether we are case sensitive.
774 ****************************************************************************/
776 static bool fname_equal(const char *name1
, const char *name2
,
779 /* Normal filename handling */
780 if (case_sensitive
) {
781 return(strcmp(name1
,name2
) == 0);
784 return(strequal(name1
,name2
));
787 /****************************************************************************
788 Scan a directory to find a filename, matching without case sensitivity.
789 If the name looks like a mangled name then try via the mangling functions
790 ****************************************************************************/
792 int get_real_filename(connection_struct
*conn
, const char *path
,
793 const char *name
, TALLOC_CTX
*mem_ctx
,
796 struct smb_Dir
*cur_dir
;
799 char *unmangled_name
= NULL
;
802 mangled
= mangle_is_mangled(name
, conn
->params
);
804 /* handle null paths */
805 if ((path
== NULL
) || (*path
== 0)) {
809 /* If we have a case-sensitive filesystem, it doesn't do us any
810 * good to search for a name. If a case variation of the name was
811 * there, then the original stat(2) would have found it.
813 if (!mangled
&& !(conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) {
819 * The incoming name can be mangled, and if we de-mangle it
820 * here it will not compare correctly against the filename (name2)
821 * read from the directory and then mangled by the name_to_8_3()
822 * call. We need to mangle both names or neither.
825 * Fix for bug found by Dina Fine. If in case sensitive mode then
826 * the mangle cache is no good (3 letter extension could be wrong
827 * case - so don't demangle in this case - leave as mangled and
828 * allow the mangling of the directory entry read (which is done
829 * case insensitively) to match instead. This will lead to more
830 * false positive matches but we fail completely without it. JRA.
833 if (mangled
&& !conn
->case_sensitive
) {
834 mangled
= !mangle_lookup_name_from_8_3(talloc_tos(), name
,
838 /* Name is now unmangled. */
839 name
= unmangled_name
;
843 /* open the directory */
844 if (!(cur_dir
= OpenDir(talloc_tos(), conn
, path
, NULL
, 0))) {
845 DEBUG(3,("scan dir didn't open dir [%s]\n",path
));
846 TALLOC_FREE(unmangled_name
);
850 /* now scan for matching names */
852 while ((dname
= ReadDirName(cur_dir
, &curpos
, NULL
))) {
854 /* Is it dot or dot dot. */
855 if (ISDOT(dname
) || ISDOTDOT(dname
)) {
860 * At this point dname is the unmangled name.
861 * name is either mangled or not, depending on the state
862 * of the "mangled" variable. JRA.
866 * Check mangled name against mangled name, or unmangled name
867 * against unmangled name.
870 if ((mangled
&& mangled_equal(name
,dname
,conn
->params
)) ||
871 fname_equal(name
, dname
, conn
->case_sensitive
)) {
872 /* we've found the file, change it's name and return */
873 *found_name
= talloc_strdup(mem_ctx
, dname
);
874 TALLOC_FREE(unmangled_name
);
875 TALLOC_FREE(cur_dir
);
884 TALLOC_FREE(unmangled_name
);
885 TALLOC_FREE(cur_dir
);
890 static NTSTATUS
build_stream_path(TALLOC_CTX
*mem_ctx
,
891 connection_struct
*conn
,
892 const char *orig_path
,
893 const char *basepath
,
894 const char *streamname
,
895 SMB_STRUCT_STAT
*pst
,
901 unsigned int i
, num_streams
;
902 struct stream_struct
*streams
= NULL
;
904 result
= talloc_asprintf(mem_ctx
, "%s%s", basepath
, streamname
);
905 if (result
== NULL
) {
906 return NT_STATUS_NO_MEMORY
;
909 if (SMB_VFS_STAT(conn
, result
, &st
) == 0) {
915 if (errno
!= ENOENT
) {
916 status
= map_nt_error_from_unix(errno
);
917 DEBUG(10, ("vfs_stat failed: %s\n", nt_errstr(status
)));
921 status
= SMB_VFS_STREAMINFO(conn
, NULL
, basepath
, mem_ctx
,
922 &num_streams
, &streams
);
924 if (NT_STATUS_EQUAL(status
, NT_STATUS_OBJECT_NAME_NOT_FOUND
)) {
925 SET_STAT_INVALID(*pst
);
930 if (!NT_STATUS_IS_OK(status
)) {
931 DEBUG(10, ("vfs_streaminfo failed: %s\n", nt_errstr(status
)));
935 for (i
=0; i
<num_streams
; i
++) {
936 DEBUG(10, ("comparing [%s] and [%s]: ",
937 streamname
, streams
[i
].name
));
938 if (fname_equal(streamname
, streams
[i
].name
,
939 conn
->case_sensitive
)) {
940 DEBUGADD(10, ("equal\n"));
943 DEBUGADD(10, ("not equal\n"));
946 if (i
== num_streams
) {
947 SET_STAT_INVALID(*pst
);
949 TALLOC_FREE(streams
);
955 result
= talloc_asprintf(mem_ctx
, "%s%s", basepath
, streams
[i
].name
);
956 if (result
== NULL
) {
957 status
= NT_STATUS_NO_MEMORY
;
961 SET_STAT_INVALID(*pst
);
963 if (SMB_VFS_STAT(conn
, result
, pst
) == 0) {
964 stat_cache_add(orig_path
, result
, conn
->case_sensitive
);
968 TALLOC_FREE(streams
);
973 TALLOC_FREE(streams
);