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;
131 SET_STAT_INVALID(*pst);
132 *pp_conv_path = NULL;
133 if(pp_saved_last_component) {
134 *pp_saved_last_component = NULL;
138 /* we don't ever use the filenames on a printer share as a
139 filename - so don't convert them */
140 if (!(*pp_conv_path = talloc_strdup(ctx,orig_path))) {
141 return NT_STATUS_NO_MEMORY;
146 DEBUG(5, ("unix_convert called on file \"%s\"\n", orig_path));
149 * Conversion to basic unix format is already done in
150 * check_path_syntax().
154 * Names must be relative to the root of the service - any leading /.
155 * and trailing /'s should have been trimmed by check_path_syntax().
159 SMB_ASSERT(*orig_path != '/');
163 * If we trimmed down to a single '\0' character
164 * then we should use the "." directory to avoid
165 * searching the cache, but not if we are in a
167 * As we know this is valid we can return true here.
171 if (!(name = talloc_strdup(ctx,"."))) {
172 return NT_STATUS_NO_MEMORY;
174 if (SMB_VFS_STAT(conn,name,&st) == 0) {
177 return map_nt_error_from_unix(errno);
179 DEBUG(5,("conversion finished \"\" -> %s\n",name));
183 if (orig_path[0] == '.' && (orig_path[1] == '/' ||
184 orig_path[1] == '\0')) {
185 /* Start of pathname can't be "." only. */
186 if (orig_path[1] == '\0' || orig_path[2] == '\0') {
187 result = NT_STATUS_OBJECT_NAME_INVALID;
189 result =determine_path_error(
190 &orig_path[2], allow_wcard_last_component);
195 if (!(name = talloc_strdup(ctx, orig_path))) {
196 DEBUG(0, ("talloc_strdup failed\n"));
197 return NT_STATUS_NO_MEMORY;
201 * Large directory fix normalization. If we're case sensitive, and
202 * the case preserving parameters are set to "no", normalize the case of
203 * the incoming filename from the client WHETHER IT EXISTS OR NOT !
204 * This is in conflict with the current (3.0.20) man page, but is
205 * what people expect from the "large directory howto". I'll update
206 * the man page. Thanks to jht@samba.org for finding this. JRA.
209 if (conn->case_sensitive && !conn->case_preserve &&
210 !conn->short_case_preserve) {
211 strnorm(name, lp_defaultcase(SNUM(conn)));
215 * Ensure saved_last_component is valid even if file exists.
218 if(pp_saved_last_component) {
219 end = strrchr_m(name, '/');
221 *pp_saved_last_component = talloc_strdup(ctx, end + 1);
223 *pp_saved_last_component = talloc_strdup(ctx,
228 if (!lp_posix_pathnames()) {
229 stream = strchr_m(name, ':');
231 if (stream != NULL) {
232 char *tmp = talloc_strdup(ctx, stream);
235 return NT_STATUS_NO_MEMORY;
244 /* If we're providing case insentive semantics or
245 * the underlying filesystem is case insensitive,
246 * then a case-normalized hit in the stat-cache is
247 * authoratitive. JRA.
250 if((!conn->case_sensitive || !(conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH)) &&
251 stat_cache_lookup(conn, &name, &dirpath, &start, &st)) {
257 * Make sure "dirpath" is an allocated string, we use this for
258 * building the directories with asprintf and free it.
261 if ((dirpath == NULL) && (!(dirpath = talloc_strdup(ctx,"")))) {
262 DEBUG(0, ("talloc_strdup failed\n"));
264 return NT_STATUS_NO_MEMORY;
268 * stat the name - if it exists then we are all done!
271 if (SMB_VFS_STAT(conn,name,&st) == 0) {
272 /* Ensure we catch all names with in "/."
273 this is disallowed under Windows. */
274 const char *p = strstr(name, "/."); /* mb safe. */
277 /* Error code within a pathname. */
278 result = NT_STATUS_OBJECT_PATH_NOT_FOUND;
280 } else if (p[2] == '\0') {
281 /* Error code at the end of a pathname. */
282 result = NT_STATUS_OBJECT_NAME_INVALID;
286 stat_cache_add(orig_path, name, conn->case_sensitive);
287 DEBUG(5,("conversion finished %s -> %s\n",orig_path, name));
292 DEBUG(5,("unix_convert begin: name = %s, dirpath = %s, start = %s\n",
293 name, dirpath, start));
296 * A special case - if we don't have any mangling chars and are case
297 * sensitive or the underlying filesystem is case insentive then searching
301 if ((conn->case_sensitive || !(conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH)) &&
302 !mangle_is_mangled(name, conn->params)) {
307 * is_mangled() was changed to look at an entire pathname, not
308 * just a component. JRA.
311 if (mangle_is_mangled(start, conn->params)) {
312 component_was_mangled = True;
316 * Now we need to recursively match the name against the real
317 * directory structure.
321 * Match each part of the path name separately, trying the names
322 * as is first, then trying to scan the directory for matching names.
325 for (; start ; start = (end?end+1:(char *)NULL)) {
327 * Pinpoint the end of this section of the filename.
329 /* mb safe. '/' can't be in any encoded char. */
330 end = strchr(start, '/');
333 * Chop the name at this point.
339 if (pp_saved_last_component) {
340 TALLOC_FREE(*pp_saved_last_component);
341 *pp_saved_last_component = talloc_strdup(ctx,
342 end ? end + 1 : start);
343 if (!*pp_saved_last_component) {
344 DEBUG(0, ("talloc failed\n"));
345 return NT_STATUS_NO_MEMORY;
349 /* The name cannot have a component of "." */
353 /* Error code at the end of a pathname. */
354 result = NT_STATUS_OBJECT_NAME_INVALID;
356 result = determine_path_error(end+1,
357 allow_wcard_last_component);
362 /* The name cannot have a wildcard if it's not
363 the last component. */
365 name_has_wildcard = ms_has_wild(start);
367 /* Wildcard not valid anywhere. */
368 if (name_has_wildcard && !allow_wcard_last_component) {
369 result = NT_STATUS_OBJECT_NAME_INVALID;
373 /* Wildcards never valid within a pathname. */
374 if (name_has_wildcard && end) {
375 result = NT_STATUS_OBJECT_NAME_INVALID;
380 * Check if the name exists up to this point.
383 if (SMB_VFS_STAT(conn,name, &st) == 0) {
385 * It exists. it must either be a directory or this must
386 * be the last part of the path for it to be OK.
388 if (end && !(st.st_mode & S_IFDIR)) {
390 * An intermediate part of the name isn't
393 DEBUG(5,("Not a dir %s\n",start));
396 * We need to return the fact that the
397 * intermediate name resolution failed. This
398 * is used to return an error of ERRbadpath
399 * rather than ERRbadfile. Some Windows
400 * applications depend on the difference between
403 result = NT_STATUS_OBJECT_PATH_NOT_FOUND;
409 * We just scanned for, and found the end of
410 * the path. We must return the valid stat
418 char *found_name = NULL;
420 /* Stat failed - ensure we don't use it. */
421 SET_STAT_INVALID(st);
424 * Reset errno so we can detect
425 * directory open errors.
430 * Try to find this part of the path in the directory.
433 if (name_has_wildcard ||
434 (SMB_VFS_GET_REAL_FILENAME(
435 conn, dirpath, start,
436 talloc_tos(), &found_name) == -1)) {
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 != 0) && (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);
614 * We should never provide different behaviors
615 * depending on DEVELOPER!!!
617 if (VALID_STAT(st)) {
619 get_file_infos(vfs_file_id_from_sbuf(conn, &st),
620 &delete_pending, NULL);
621 if (delete_pending) {
622 result = NT_STATUS_DELETE_PENDING;
629 * Add to the dirpath that we have resolved so far.
632 if (*dirpath != '\0') {
633 char *tmp = talloc_asprintf(ctx,
634 "%s/%s", dirpath, start);
636 DEBUG(0, ("talloc_asprintf failed\n"));
637 return NT_STATUS_NO_MEMORY;
639 TALLOC_FREE(dirpath);
643 TALLOC_FREE(dirpath);
644 if (!(dirpath = talloc_strdup(ctx,start))) {
645 DEBUG(0, ("talloc_strdup failed\n"));
646 return NT_STATUS_NO_MEMORY;
651 * Don't cache a name with mangled or wildcard components
652 * as this can change the size.
655 if(!component_was_mangled && !name_has_wildcard) {
656 stat_cache_add(orig_path, dirpath,
657 conn->case_sensitive);
661 * Restore the / that we wiped out earlier.
669 * Don't cache a name with mangled or wildcard components
670 * as this can change the size.
673 if(!component_was_mangled && !name_has_wildcard) {
674 stat_cache_add(orig_path, name, conn->case_sensitive);
678 * The name has been resolved.
681 DEBUG(5,("conversion finished %s -> %s\n",orig_path, name));
684 if (stream != NULL) {
687 result = build_stream_path(ctx, conn, orig_path, name, stream,
689 if (!NT_STATUS_IS_OK(result)) {
693 DEBUG(10, ("build_stream_path returned %s\n", tmp));
698 *pp_conv_path = name;
699 TALLOC_FREE(dirpath);
702 DEBUG(10, ("dirpath = [%s] start = [%s]\n", dirpath, start));
703 if (*dirpath != '\0') {
704 *pp_conv_path = talloc_asprintf(ctx,
705 "%s/%s", dirpath, start);
707 *pp_conv_path = talloc_strdup(ctx, start);
709 if (!*pp_conv_path) {
710 DEBUG(0, ("talloc_asprintf failed\n"));
711 return NT_STATUS_NO_MEMORY;
714 TALLOC_FREE(dirpath);
718 /****************************************************************************
719 Check a filename - possibly calling check_reduced_name.
720 This is called by every routine before it allows an operation on a filename.
721 It does any final confirmation necessary to ensure that the filename is
722 a valid one for the user to access.
723 ****************************************************************************/
725 NTSTATUS check_name(connection_struct *conn, const char *name)
727 if (IS_VETO_PATH(conn, name)) {
728 /* Is it not dot or dot dot. */
729 if (!((name[0] == '.') && (!name[1] ||
730 (name[1] == '.' && !name[2])))) {
731 DEBUG(5,("check_name: file path name %s vetoed\n",
733 return map_nt_error_from_unix(ENOENT);
737 if (!lp_widelinks(SNUM(conn)) || !lp_symlinks(SNUM(conn))) {
738 NTSTATUS status = check_reduced_name(conn,name);
739 if (!NT_STATUS_IS_OK(status)) {
740 DEBUG(5,("check_name: name %s failed with %s\n",name,
749 /****************************************************************************
750 Check if two filenames are equal.
751 This needs to be careful about whether we are case sensitive.
752 ****************************************************************************/
754 static bool fname_equal(const char *name1, const char *name2,
757 /* Normal filename handling */
758 if (case_sensitive) {
759 return(strcmp(name1,name2) == 0);
762 return(strequal(name1,name2));
765 /****************************************************************************
766 Scan a directory to find a filename, matching without case sensitivity.
767 If the name looks like a mangled name then try via the mangling functions
768 ****************************************************************************/
770 int get_real_filename(connection_struct *conn, const char *path,
771 const char *name, TALLOC_CTX *mem_ctx,
774 struct smb_Dir *cur_dir;
777 char *unmangled_name = NULL;
780 mangled = mangle_is_mangled(name, conn->params);
782 /* handle null paths */
783 if ((path == NULL) || (*path == 0)) {
787 /* If we have a case-sensitive filesystem, it doesn't do us any
788 * good to search for a name. If a case variation of the name was
789 * there, then the original stat(2) would have found it.
791 if (!mangled && !(conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH)) {
797 * The incoming name can be mangled, and if we de-mangle it
798 * here it will not compare correctly against the filename (name2)
799 * read from the directory and then mangled by the name_to_8_3()
800 * call. We need to mangle both names or neither.
803 * Fix for bug found by Dina Fine. If in case sensitive mode then
804 * the mangle cache is no good (3 letter extension could be wrong
805 * case - so don't demangle in this case - leave as mangled and
806 * allow the mangling of the directory entry read (which is done
807 * case insensitively) to match instead. This will lead to more
808 * false positive matches but we fail completely without it. JRA.
811 if (mangled && !conn->case_sensitive) {
812 mangled = !mangle_lookup_name_from_8_3(talloc_tos(), name,
816 /* Name is now unmangled. */
817 name = unmangled_name;
821 /* open the directory */
822 if (!(cur_dir = OpenDir(talloc_tos(), conn, path, NULL, 0))) {
823 DEBUG(3,("scan dir didn't open dir [%s]\n",path));
824 TALLOC_FREE(unmangled_name);
828 /* now scan for matching names */
830 while ((dname = ReadDirName(cur_dir, &curpos))) {
832 /* Is it dot or dot dot. */
833 if (ISDOT(dname) || ISDOTDOT(dname)) {
838 * At this point dname is the unmangled name.
839 * name is either mangled or not, depending on the state
840 * of the "mangled" variable. JRA.
844 * Check mangled name against mangled name, or unmangled name
845 * against unmangled name.
848 if ((mangled && mangled_equal(name,dname,conn->params)) ||
849 fname_equal(name, dname, conn->case_sensitive)) {
850 /* we've found the file, change it's name and return */
851 *found_name = talloc_strdup(mem_ctx, dname);
852 TALLOC_FREE(unmangled_name);
853 TALLOC_FREE(cur_dir);
862 TALLOC_FREE(unmangled_name);
863 TALLOC_FREE(cur_dir);
868 static NTSTATUS build_stream_path(TALLOC_CTX *mem_ctx,
869 connection_struct *conn,
870 const char *orig_path,
871 const char *basepath,
872 const char *streamname,
873 SMB_STRUCT_STAT *pst,
879 unsigned int i, num_streams;
880 struct stream_struct *streams = NULL;
882 result = talloc_asprintf(mem_ctx, "%s%s", basepath, streamname);
883 if (result == NULL) {
884 return NT_STATUS_NO_MEMORY;
887 if (SMB_VFS_STAT(conn, result, &st) == 0) {
893 if (errno != ENOENT) {
894 status = map_nt_error_from_unix(errno);
895 DEBUG(10, ("vfs_stat failed: %s\n", nt_errstr(status)));
899 status = SMB_VFS_STREAMINFO(conn, NULL, basepath, mem_ctx,
900 &num_streams, &streams);
902 if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
903 SET_STAT_INVALID(*pst);
908 if (!NT_STATUS_IS_OK(status)) {
909 DEBUG(10, ("vfs_streaminfo failed: %s\n", nt_errstr(status)));
913 for (i=0; i<num_streams; i++) {
914 DEBUG(10, ("comparing [%s] and [%s]: ",
915 streamname, streams[i].name));
916 if (fname_equal(streamname, streams[i].name,
917 conn->case_sensitive)) {
918 DEBUGADD(10, ("equal\n"));
921 DEBUGADD(10, ("not equal\n"));
924 if (i == num_streams) {
925 SET_STAT_INVALID(*pst);
927 TALLOC_FREE(streams);
933 result = talloc_asprintf(mem_ctx, "%s%s", basepath, streams[i].name);
934 if (result == NULL) {
935 status = NT_STATUS_NO_MEMORY;
939 SET_STAT_INVALID(*pst);
941 if (SMB_VFS_STAT(conn, result, pst) == 0) {
942 stat_cache_add(orig_path, result, conn->case_sensitive);
946 TALLOC_FREE(streams);
951 TALLOC_FREE(streams);