2 Unix SMB/CIFS implementation.
3 Directory handling routines
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2007
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "system/filesys.h"
23 #include "smbd/smbd.h"
24 #include "smbd/globals.h"
25 #include "libcli/security/security.h"
26 #include "lib/util/bitmap.h"
29 This module implements directory related functions for Samba.
32 /* "Special" directory offsets. */
33 #define END_OF_DIRECTORY_OFFSET ((long)-1)
34 #define START_OF_DIRECTORY_OFFSET ((long)0)
35 #define DOT_DOT_DIRECTORY_OFFSET ((long)0x80000000)
37 /* Make directory handle internals available. */
39 struct name_cache_entry {
45 connection_struct *conn;
49 size_t name_cache_size;
50 struct name_cache_entry *name_cache;
51 unsigned int name_cache_index;
52 unsigned int file_number;
56 struct dptr_struct *next, *prev;
59 struct connection_struct *conn;
60 struct smb_Dir *dir_hnd;
65 bool has_wild; /* Set to true if the wcard entry has MS wildcard characters in it. */
66 bool did_stat; /* Optimisation for non-wcard searches. */
69 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
74 #define INVALID_DPTR_KEY (-3)
76 /****************************************************************************
78 ****************************************************************************/
80 bool make_dir_struct(TALLOC_CTX *ctx,
90 char *mask2 = talloc_strdup(ctx, mask);
96 if ((mode & FILE_ATTRIBUTE_DIRECTORY) != 0) {
100 memset(buf+1,' ',11);
101 if ((p = strchr_m(mask2,'.')) != NULL) {
103 push_ascii(buf+1,mask2,8, 0);
104 push_ascii(buf+9,p+1,3, 0);
107 push_ascii(buf+1,mask2,11, 0);
110 memset(buf+21,'\0',DIR_STRUCT_SIZE-21);
112 srv_put_dos_date(buf,22,date);
113 SSVAL(buf,26,size & 0xFFFF);
114 SSVAL(buf,28,(size >> 16)&0xFFFF);
115 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
116 Strange, but verified on W2K3. Needed for OS/2. JRA. */
117 push_ascii(buf+30,fname,12, uc ? STR_UPPER : 0);
118 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf+30, fname));
122 /****************************************************************************
123 Initialise the dir bitmap.
124 ****************************************************************************/
126 bool init_dptrs(struct smbd_server_connection *sconn)
128 if (sconn->searches.dptr_bmap) {
132 sconn->searches.dptr_bmap = bitmap_talloc(
133 sconn, MAX_DIRECTORY_HANDLES);
135 if (sconn->searches.dptr_bmap == NULL) {
142 /****************************************************************************
143 Idle a dptr - the directory is closed but the control info is kept.
144 ****************************************************************************/
146 static void dptr_idle(struct dptr_struct *dptr)
149 DEBUG(4,("Idling dptr dnum %d\n",dptr->dnum));
150 TALLOC_FREE(dptr->dir_hnd);
154 /****************************************************************************
155 Idle the oldest dptr.
156 ****************************************************************************/
158 static void dptr_idleoldest(struct smbd_server_connection *sconn)
160 struct dptr_struct *dptr;
163 * Go to the end of the list.
165 dptr = DLIST_TAIL(sconn->searches.dirptrs);
168 DEBUG(0,("No dptrs available to idle ?\n"));
173 * Idle the oldest pointer.
176 for(; dptr; dptr = DLIST_PREV(dptr)) {
184 /****************************************************************************
185 Get the struct dptr_struct for a dir index.
186 ****************************************************************************/
188 static struct dptr_struct *dptr_get(struct smbd_server_connection *sconn,
189 int key, bool forclose)
191 struct dptr_struct *dptr;
193 for(dptr = sconn->searches.dirptrs; dptr; dptr = dptr->next) {
194 if(dptr->dnum == key) {
195 if (!forclose && !dptr->dir_hnd) {
196 if (sconn->searches.dirhandles_open >= MAX_OPEN_DIRECTORIES)
197 dptr_idleoldest(sconn);
198 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key));
199 if (!(dptr->dir_hnd = OpenDir(
200 NULL, dptr->conn, dptr->path,
201 dptr->wcard, dptr->attr))) {
202 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr->path,
207 DLIST_PROMOTE(sconn->searches.dirptrs,dptr);
214 /****************************************************************************
215 Get the dir path for a dir index.
216 ****************************************************************************/
218 char *dptr_path(struct smbd_server_connection *sconn, int key)
220 struct dptr_struct *dptr = dptr_get(sconn, key, false);
226 /****************************************************************************
227 Get the dir wcard for a dir index.
228 ****************************************************************************/
230 char *dptr_wcard(struct smbd_server_connection *sconn, int key)
232 struct dptr_struct *dptr = dptr_get(sconn, key, false);
238 /****************************************************************************
239 Get the dir attrib for a dir index.
240 ****************************************************************************/
242 uint16 dptr_attr(struct smbd_server_connection *sconn, int key)
244 struct dptr_struct *dptr = dptr_get(sconn, key, false);
250 /****************************************************************************
251 Close a dptr (internal func).
252 ****************************************************************************/
254 static void dptr_close_internal(struct dptr_struct *dptr)
256 struct smbd_server_connection *sconn = dptr->conn->sconn;
258 DEBUG(4,("closing dptr key %d\n",dptr->dnum));
264 DLIST_REMOVE(sconn->searches.dirptrs, dptr);
267 * Free the dnum in the bitmap. Remember the dnum value is always
268 * biased by one with respect to the bitmap.
271 if (!bitmap_query(sconn->searches.dptr_bmap, dptr->dnum - 1)) {
272 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
276 bitmap_clear(sconn->searches.dptr_bmap, dptr->dnum - 1);
279 TALLOC_FREE(dptr->dir_hnd);
281 /* Lanman 2 specific code */
282 SAFE_FREE(dptr->wcard);
283 string_set(&dptr->path,"");
287 /****************************************************************************
288 Close a dptr given a key.
289 ****************************************************************************/
291 void dptr_close(struct smbd_server_connection *sconn, int *key)
293 struct dptr_struct *dptr;
295 if(*key == INVALID_DPTR_KEY)
298 /* OS/2 seems to use -1 to indicate "close all directories" */
300 struct dptr_struct *next;
301 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
303 dptr_close_internal(dptr);
305 *key = INVALID_DPTR_KEY;
309 dptr = dptr_get(sconn, *key, true);
312 DEBUG(0,("Invalid key %d given to dptr_close\n", *key));
316 dptr_close_internal(dptr);
318 *key = INVALID_DPTR_KEY;
321 /****************************************************************************
322 Close all dptrs for a cnum.
323 ****************************************************************************/
325 void dptr_closecnum(connection_struct *conn)
327 struct dptr_struct *dptr, *next;
328 struct smbd_server_connection *sconn = conn->sconn;
334 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
336 if (dptr->conn == conn) {
337 dptr_close_internal(dptr);
342 /****************************************************************************
343 Idle all dptrs for a cnum.
344 ****************************************************************************/
346 void dptr_idlecnum(connection_struct *conn)
348 struct dptr_struct *dptr;
349 struct smbd_server_connection *sconn = conn->sconn;
355 for(dptr = sconn->searches.dirptrs; dptr; dptr = dptr->next) {
356 if (dptr->conn == conn && dptr->dir_hnd) {
362 /****************************************************************************
363 Close a dptr that matches a given path, only if it matches the spid also.
364 ****************************************************************************/
366 void dptr_closepath(struct smbd_server_connection *sconn,
367 char *path,uint16 spid)
369 struct dptr_struct *dptr, *next;
370 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
372 if (spid == dptr->spid && strequal(dptr->path,path))
373 dptr_close_internal(dptr);
377 /****************************************************************************
378 Try and close the oldest handle not marked for
379 expect close in the hope that the client has
380 finished with that one.
381 ****************************************************************************/
383 static void dptr_close_oldest(struct smbd_server_connection *sconn,
386 struct dptr_struct *dptr;
389 * Go to the end of the list.
391 for(dptr = sconn->searches.dirptrs; dptr && dptr->next; dptr = dptr->next)
395 DEBUG(0,("No old dptrs available to close oldest ?\n"));
400 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
401 * does not have expect_close set. If 'old' is false, close
402 * one of the new dnum handles.
405 for(; dptr; dptr = DLIST_PREV(dptr)) {
406 if ((old && (dptr->dnum < 256) && !dptr->expect_close) ||
407 (!old && (dptr->dnum > 255))) {
408 dptr_close_internal(dptr);
414 /****************************************************************************
415 Create a new dir ptr. If the flag old_handle is true then we must allocate
416 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
417 one byte long. If old_handle is false we allocate from the range
418 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
419 a directory handle is never zero.
420 wcard must not be zero.
421 ****************************************************************************/
423 NTSTATUS dptr_create(connection_struct *conn, files_struct *fsp,
424 const char *path, bool old_handle, bool expect_close,uint16 spid,
425 const char *wcard, bool wcard_has_wild, uint32 attr, struct dptr_struct **dptr_ret)
427 struct smbd_server_connection *sconn = conn->sconn;
428 struct dptr_struct *dptr = NULL;
429 struct smb_Dir *dir_hnd;
432 if (fsp && fsp->is_directory && fsp->fh->fd != -1) {
433 path = fsp->fsp_name->base_name;
436 DEBUG(5,("dptr_create dir=%s\n", path));
439 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
440 return NT_STATUS_INTERNAL_ERROR;
444 return NT_STATUS_INVALID_PARAMETER;
448 dir_hnd = OpenDir_fsp(NULL, conn, fsp, wcard, attr);
450 dir_hnd = OpenDir(NULL, conn, path, wcard, attr);
454 return map_nt_error_from_unix(errno);
457 if (sconn->searches.dirhandles_open >= MAX_OPEN_DIRECTORIES) {
458 dptr_idleoldest(sconn);
461 dptr = SMB_MALLOC_P(struct dptr_struct);
463 DEBUG(0,("malloc fail in dptr_create.\n"));
464 TALLOC_FREE(dir_hnd);
465 return NT_STATUS_NO_MEMORY;
473 * This is an old-style SMBsearch request. Ensure the
474 * value we return will fit in the range 1-255.
477 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
479 if(dptr->dnum == -1 || dptr->dnum > 254) {
482 * Try and close the oldest handle not marked for
483 * expect close in the hope that the client has
484 * finished with that one.
487 dptr_close_oldest(sconn, true);
489 /* Now try again... */
490 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
491 if(dptr->dnum == -1 || dptr->dnum > 254) {
492 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr->dnum));
494 TALLOC_FREE(dir_hnd);
495 return NT_STATUS_TOO_MANY_OPENED_FILES;
501 * This is a new-style trans2 request. Allocate from
502 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
505 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
507 if(dptr->dnum == -1 || dptr->dnum < 255) {
510 * Try and close the oldest handle close in the hope that
511 * the client has finished with that one. This will only
512 * happen in the case of the Win98 client bug where it leaks
516 dptr_close_oldest(sconn, false);
518 /* Now try again... */
519 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
521 if(dptr->dnum == -1 || dptr->dnum < 255) {
522 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr->dnum));
524 TALLOC_FREE(dir_hnd);
525 return NT_STATUS_TOO_MANY_OPENED_FILES;
530 bitmap_set(sconn->searches.dptr_bmap, dptr->dnum);
532 dptr->dnum += 1; /* Always bias the dnum by one - no zero dnums allowed. */
534 string_set(&dptr->path,path);
536 dptr->dir_hnd = dir_hnd;
538 dptr->expect_close = expect_close;
539 dptr->wcard = SMB_STRDUP(wcard);
541 bitmap_clear(sconn->searches.dptr_bmap, dptr->dnum - 1);
543 TALLOC_FREE(dir_hnd);
544 return NT_STATUS_NO_MEMORY;
546 if (lp_posix_pathnames() || (wcard[0] == '.' && wcard[1] == 0)) {
547 dptr->has_wild = True;
549 dptr->has_wild = wcard_has_wild;
554 DLIST_ADD(sconn->searches.dirptrs, dptr);
556 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
557 dptr->dnum,path,expect_close));
565 /****************************************************************************
566 Wrapper functions to access the lower level directory handles.
567 ****************************************************************************/
569 void dptr_CloseDir(files_struct *fsp)
573 * Ugly hack. We have defined fdopendir to return ENOSYS if dirfd also isn't
574 * present. I hate Solaris. JRA.
577 if (fsp->fh->fd != -1 &&
578 fsp->dptr->dir_hnd &&
579 dirfd(fsp->dptr->dir_hnd->dir)) {
580 /* The call below closes the underlying fd. */
584 dptr_close_internal(fsp->dptr);
589 void dptr_SeekDir(struct dptr_struct *dptr, long offset)
591 SeekDir(dptr->dir_hnd, offset);
594 long dptr_TellDir(struct dptr_struct *dptr)
596 return TellDir(dptr->dir_hnd);
599 bool dptr_has_wild(struct dptr_struct *dptr)
601 return dptr->has_wild;
604 int dptr_dnum(struct dptr_struct *dptr)
609 /****************************************************************************
610 Return the next visible file name, skipping veto'd and invisible files.
611 ****************************************************************************/
613 static const char *dptr_normal_ReadDirName(struct dptr_struct *dptr,
614 long *poffset, SMB_STRUCT_STAT *pst,
617 /* Normal search for the next file. */
619 char *talloced = NULL;
621 while ((name = ReadDirName(dptr->dir_hnd, poffset, pst, &talloced))
623 if (is_visible_file(dptr->conn, dptr->path, name, pst, True)) {
624 *ptalloced = talloced;
627 TALLOC_FREE(talloced);
632 /****************************************************************************
633 Return the next visible file name, skipping veto'd and invisible files.
634 ****************************************************************************/
636 char *dptr_ReadDirName(TALLOC_CTX *ctx,
637 struct dptr_struct *dptr,
639 SMB_STRUCT_STAT *pst)
641 struct smb_filename smb_fname_base;
643 const char *name_temp = NULL;
644 char *talloced = NULL;
645 char *pathreal = NULL;
646 char *found_name = NULL;
649 SET_STAT_INVALID(*pst);
651 if (dptr->has_wild || dptr->did_stat) {
652 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst,
654 if (name_temp == NULL) {
657 if (talloced != NULL) {
658 return talloc_move(ctx, &talloced);
660 return talloc_strdup(ctx, name_temp);
663 /* If poffset is -1 then we know we returned this name before and we
664 * have no wildcards. We're at the end of the directory. */
665 if (*poffset == END_OF_DIRECTORY_OFFSET) {
669 /* We know the stored wcard contains no wildcard characters.
670 * See if we can match with a stat call. If we can't, then set
671 * did_stat to true to ensure we only do this once and keep
674 dptr->did_stat = true;
676 /* First check if it should be visible. */
677 if (!is_visible_file(dptr->conn, dptr->path, dptr->wcard,
680 /* This only returns false if the file was found, but
681 is explicitly not visible. Set us to end of
682 directory, but return NULL as we know we can't ever
687 if (VALID_STAT(*pst)) {
688 name = talloc_strdup(ctx, dptr->wcard);
692 pathreal = talloc_asprintf(ctx,
699 /* Create an smb_filename with stream_name == NULL. */
700 ZERO_STRUCT(smb_fname_base);
701 smb_fname_base.base_name = pathreal;
703 if (SMB_VFS_STAT(dptr->conn, &smb_fname_base) == 0) {
704 *pst = smb_fname_base.st;
705 name = talloc_strdup(ctx, dptr->wcard);
708 /* If we get any other error than ENOENT or ENOTDIR
709 then the file exists we just can't stat it. */
710 if (errno != ENOENT && errno != ENOTDIR) {
711 name = talloc_strdup(ctx, dptr->wcard);
716 /* Stat failed. We know this is authoratiative if we are
717 * providing case sensitive semantics or the underlying
718 * filesystem is case sensitive.
720 if (dptr->conn->case_sensitive ||
721 !(dptr->conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH))
727 * Try case-insensitive stat if the fs has the ability. This avoids
728 * scanning the whole directory.
730 ret = SMB_VFS_GET_REAL_FILENAME(dptr->conn, dptr->path, dptr->wcard,
735 } else if (errno == ENOENT) {
736 /* The case-insensitive lookup was authoritative. */
740 TALLOC_FREE(pathreal);
742 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst, &talloced);
743 if (name_temp == NULL) {
746 if (talloced != NULL) {
747 return talloc_move(ctx, &talloced);
749 return talloc_strdup(ctx, name_temp);
752 TALLOC_FREE(pathreal);
754 /* We need to set the underlying dir_hnd offset to -1
755 * also as this function is usually called with the
756 * output from TellDir. */
757 dptr->dir_hnd->offset = *poffset = END_OF_DIRECTORY_OFFSET;
761 /****************************************************************************
762 Search for a file by name, skipping veto'ed and not visible files.
763 ****************************************************************************/
765 bool dptr_SearchDir(struct dptr_struct *dptr, const char *name, long *poffset, SMB_STRUCT_STAT *pst)
767 SET_STAT_INVALID(*pst);
769 if (!dptr->has_wild && (dptr->dir_hnd->offset == END_OF_DIRECTORY_OFFSET)) {
770 /* This is a singleton directory and we're already at the end. */
771 *poffset = END_OF_DIRECTORY_OFFSET;
775 return SearchDir(dptr->dir_hnd, name, poffset);
778 /****************************************************************************
779 Add the name we're returning into the underlying cache.
780 ****************************************************************************/
782 void dptr_DirCacheAdd(struct dptr_struct *dptr, const char *name, long offset)
784 DirCacheAdd(dptr->dir_hnd, name, offset);
787 /****************************************************************************
788 Initialize variables & state data at the beginning of all search SMB requests.
789 ****************************************************************************/
790 void dptr_init_search_op(struct dptr_struct *dptr)
792 SMB_VFS_INIT_SEARCH_OP(dptr->conn, dptr->dir_hnd->dir);
795 /****************************************************************************
796 Fill the 5 byte server reserved dptr field.
797 ****************************************************************************/
799 bool dptr_fill(struct smbd_server_connection *sconn,
800 char *buf1,unsigned int key)
802 unsigned char *buf = (unsigned char *)buf1;
803 struct dptr_struct *dptr = dptr_get(sconn, key, false);
806 DEBUG(1,("filling null dirptr %d\n",key));
809 offset = (uint32)TellDir(dptr->dir_hnd);
810 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key,
811 (long)dptr->dir_hnd,(int)offset));
817 /****************************************************************************
818 Fetch the dir ptr and seek it given the 5 byte server field.
819 ****************************************************************************/
821 struct dptr_struct *dptr_fetch(struct smbd_server_connection *sconn,
824 unsigned int key = *(unsigned char *)buf;
825 struct dptr_struct *dptr = dptr_get(sconn, key, false);
830 DEBUG(3,("fetched null dirptr %d\n",key));
834 offset = IVAL(buf,1);
835 if (offset == (uint32)-1) {
836 seekoff = END_OF_DIRECTORY_OFFSET;
838 seekoff = (long)offset;
840 SeekDir(dptr->dir_hnd,seekoff);
841 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
842 key, dptr->path, (int)seekoff));
846 /****************************************************************************
848 ****************************************************************************/
850 struct dptr_struct *dptr_fetch_lanman2(struct smbd_server_connection *sconn,
853 struct dptr_struct *dptr = dptr_get(sconn, dptr_num, false);
856 DEBUG(3,("fetched null dirptr %d\n",dptr_num));
859 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num,dptr->path));
863 /****************************************************************************
864 Check that a file matches a particular file type.
865 ****************************************************************************/
867 bool dir_check_ftype(connection_struct *conn, uint32 mode, uint32 dirtype)
871 /* Check the "may have" search bits. */
872 if (((mode & ~dirtype) & (FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM | FILE_ATTRIBUTE_DIRECTORY)) != 0)
875 /* Check the "must have" bits, which are the may have bits shifted eight */
876 /* If must have bit is set, the file/dir can not be returned in search unless the matching
877 file attribute is set */
878 mask = ((dirtype >> 8) & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM)); /* & 0x37 */
880 if((mask & (mode & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM))) == mask) /* check if matching attribute present */
889 static bool mangle_mask_match(connection_struct *conn,
890 const char *filename,
895 if (!name_to_8_3(filename,mname,False,conn->params)) {
898 return mask_match_search(mname,mask,False);
901 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
902 struct dptr_struct *dirptr,
907 bool (*match_fn)(TALLOC_CTX *ctx,
912 bool (*mode_fn)(TALLOC_CTX *ctx,
914 struct smb_filename *smb_fname,
918 struct smb_filename **_smb_fname,
922 connection_struct *conn = dirptr->conn;
928 needslash = ( dirptr->path[strlen(dirptr->path) -1] != '/');
933 SMB_STRUCT_STAT sbuf;
937 char *pathreal = NULL;
938 struct smb_filename smb_fname;
943 cur_offset = dptr_TellDir(dirptr);
944 prev_offset = cur_offset;
945 dname = dptr_ReadDirName(ctx, dirptr, &cur_offset, &sbuf);
947 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
948 (long)dirptr, cur_offset));
954 isdots = (ISDOT(dname) || ISDOTDOT(dname));
955 if (dont_descend && !isdots) {
961 * fname may get mangled, dname is never mangled.
962 * Whenever we're accessing the filesystem we use
963 * pathreal which is composed from dname.
966 ok = match_fn(ctx, private_data, dname, mask, &fname);
972 pathreal = talloc_asprintf(ctx, "%s%s%s",
982 /* Create smb_fname with NULL stream_name. */
983 ZERO_STRUCT(smb_fname);
984 smb_fname.base_name = pathreal;
987 ok = mode_fn(ctx, private_data, &smb_fname, &mode);
991 TALLOC_FREE(pathreal);
995 if (!dir_check_ftype(conn, mode, dirtype)) {
996 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
997 fname, (unsigned int)mode, (unsigned int)dirtype));
1000 TALLOC_FREE(pathreal);
1004 if (ask_sharemode) {
1005 struct timespec write_time_ts;
1006 struct file_id fileid;
1008 fileid = vfs_file_id_from_sbuf(conn,
1010 get_file_infos(fileid, 0, NULL, &write_time_ts);
1011 if (!null_timespec(write_time_ts)) {
1012 update_stat_ex_mtime(&smb_fname.st,
1017 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1019 mask, smb_fname_str_dbg(&smb_fname),
1022 DirCacheAdd(dirptr->dir_hnd, dname, cur_offset);
1026 status = copy_smb_filename(ctx, &smb_fname, _smb_fname);
1027 TALLOC_FREE(pathreal);
1028 if (!NT_STATUS_IS_OK(status)) {
1033 *_prev_offset = prev_offset;
1041 /****************************************************************************
1042 Get an 8.3 directory entry.
1043 ****************************************************************************/
1045 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX *ctx,
1051 connection_struct *conn = (connection_struct *)private_data;
1053 if ((strcmp(mask,"*.*") == 0) ||
1054 mask_match_search(dname, mask, false) ||
1055 mangle_mask_match(conn, dname, mask)) {
1059 if (!mangle_is_8_3(dname, false, conn->params)) {
1060 bool ok = name_to_8_3(dname, mname, false,
1070 *_fname = talloc_strdup(ctx, fname);
1071 if (*_fname == NULL) {
1081 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX *ctx,
1083 struct smb_filename *smb_fname,
1086 connection_struct *conn = (connection_struct *)private_data;
1088 if (!VALID_STAT(smb_fname->st)) {
1089 if ((SMB_VFS_STAT(conn, smb_fname)) != 0) {
1090 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1091 "Couldn't stat [%s]. Error "
1093 smb_fname_str_dbg(smb_fname),
1099 *_mode = dos_mode(conn, smb_fname);
1103 bool get_dir_entry(TALLOC_CTX *ctx,
1104 struct dptr_struct *dirptr,
1110 struct timespec *_date,
1114 connection_struct *conn = dirptr->conn;
1116 struct smb_filename *smb_fname = NULL;
1121 ok = smbd_dirptr_get_entry(ctx,
1127 smbd_dirptr_8_3_match_fn,
1128 smbd_dirptr_8_3_mode_fn,
1138 *_fname = talloc_move(ctx, &fname);
1139 *_size = smb_fname->st.st_ex_size;
1141 *_date = smb_fname->st.st_ex_mtime;
1142 TALLOC_FREE(smb_fname);
1146 /*******************************************************************
1147 Check to see if a user can read a file. This is only approximate,
1148 it is used as part of the "hide unreadable" option. Don't
1149 use it for anything security sensitive.
1150 ********************************************************************/
1152 static bool user_can_read_file(connection_struct *conn,
1153 struct smb_filename *smb_fname)
1156 * Never hide files from the root user.
1157 * We use (uid_t)0 here not sec_initial_uid()
1158 * as make test uses a single user context.
1161 if (get_current_uid(conn) == (uid_t)0) {
1165 return can_access_file_acl(conn, smb_fname, FILE_READ_DATA);
1168 /*******************************************************************
1169 Check to see if a user can write a file (and only files, we do not
1170 check dirs on this one). This is only approximate,
1171 it is used as part of the "hide unwriteable" option. Don't
1172 use it for anything security sensitive.
1173 ********************************************************************/
1175 static bool user_can_write_file(connection_struct *conn,
1176 const struct smb_filename *smb_fname)
1179 * Never hide files from the root user.
1180 * We use (uid_t)0 here not sec_initial_uid()
1181 * as make test uses a single user context.
1184 if (get_current_uid(conn) == (uid_t)0) {
1188 SMB_ASSERT(VALID_STAT(smb_fname->st));
1190 /* Pseudo-open the file */
1192 if(S_ISDIR(smb_fname->st.st_ex_mode)) {
1196 return can_write_to_file(conn, smb_fname);
1199 /*******************************************************************
1200 Is a file a "special" type ?
1201 ********************************************************************/
1203 static bool file_is_special(connection_struct *conn,
1204 const struct smb_filename *smb_fname)
1207 * Never hide files from the root user.
1208 * We use (uid_t)0 here not sec_initial_uid()
1209 * as make test uses a single user context.
1212 if (get_current_uid(conn) == (uid_t)0) {
1216 SMB_ASSERT(VALID_STAT(smb_fname->st));
1218 if (S_ISREG(smb_fname->st.st_ex_mode) ||
1219 S_ISDIR(smb_fname->st.st_ex_mode) ||
1220 S_ISLNK(smb_fname->st.st_ex_mode))
1226 /*******************************************************************
1227 Should the file be seen by the client?
1228 NOTE: A successful return is no guarantee of the file's existence.
1229 ********************************************************************/
1231 bool is_visible_file(connection_struct *conn, const char *dir_path,
1232 const char *name, SMB_STRUCT_STAT *pst, bool use_veto)
1234 bool hide_unreadable = lp_hideunreadable(SNUM(conn));
1235 bool hide_unwriteable = lp_hideunwriteable_files(SNUM(conn));
1236 bool hide_special = lp_hide_special_files(SNUM(conn));
1238 struct smb_filename *smb_fname_base = NULL;
1242 if ((strcmp(".",name) == 0) || (strcmp("..",name) == 0)) {
1243 return True; /* . and .. are always visible. */
1246 /* If it's a vetoed file, pretend it doesn't even exist */
1247 if (use_veto && IS_VETO_PATH(conn, name)) {
1248 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name ));
1252 if (hide_unreadable || hide_unwriteable || hide_special) {
1253 entry = talloc_asprintf(talloc_tos(), "%s/%s", dir_path, name);
1259 /* Create an smb_filename with stream_name == NULL. */
1260 status = create_synthetic_smb_fname(talloc_tos(), entry, NULL,
1261 pst, &smb_fname_base);
1262 if (!NT_STATUS_IS_OK(status)) {
1267 /* If the file name does not exist, there's no point checking
1268 * the configuration options. We succeed, on the basis that the
1269 * checks *might* have passed if the file was present.
1271 if (!VALID_STAT(*pst)) {
1272 if (SMB_VFS_STAT(conn, smb_fname_base) != 0) {
1276 *pst = smb_fname_base->st;
1280 /* Honour _hide unreadable_ option */
1281 if (hide_unreadable &&
1282 !user_can_read_file(conn, smb_fname_base)) {
1283 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1288 /* Honour _hide unwriteable_ option */
1289 if (hide_unwriteable && !user_can_write_file(conn,
1291 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1296 /* Honour _hide_special_ option */
1297 if (hide_special && file_is_special(conn, smb_fname_base)) {
1298 DEBUG(10,("is_visible_file: file %s is special.\n",
1307 TALLOC_FREE(smb_fname_base);
1312 static int smb_Dir_destructor(struct smb_Dir *dirp)
1316 if (dirp->conn->sconn) {
1317 files_struct *fsp = file_find_fd(dirp->conn->sconn,
1320 /* The call below closes the underlying fd. */
1325 SMB_VFS_CLOSEDIR(dirp->conn,dirp->dir);
1327 if (dirp->conn->sconn) {
1328 dirp->conn->sconn->searches.dirhandles_open--;
1333 /*******************************************************************
1335 ********************************************************************/
1337 struct smb_Dir *OpenDir(TALLOC_CTX *mem_ctx, connection_struct *conn,
1342 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1343 struct smbd_server_connection *sconn = conn->sconn;
1350 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1352 dirp->dir_path = talloc_strdup(dirp, name);
1353 if (!dirp->dir_path) {
1359 sconn->searches.dirhandles_open++;
1361 talloc_set_destructor(dirp, smb_Dir_destructor);
1363 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1365 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp->dir_path,
1377 /*******************************************************************
1378 Open a directory from an fsp.
1379 ********************************************************************/
1381 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
1386 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1387 struct smbd_server_connection *sconn = conn->sconn;
1394 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1396 dirp->dir_path = talloc_strdup(dirp, fsp->fsp_name->base_name);
1397 if (!dirp->dir_path) {
1403 sconn->searches.dirhandles_open++;
1405 talloc_set_destructor(dirp, smb_Dir_destructor);
1407 if (fsp->is_directory && fsp->fh->fd != -1) {
1408 dirp->dir = SMB_VFS_FDOPENDIR(fsp, mask, attr);
1409 if (dirp->dir == NULL) {
1410 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1414 if (errno != ENOSYS) {
1420 if (dirp->dir == NULL) {
1421 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1422 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1426 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp->dir_path,
1439 /*******************************************************************
1440 Read from a directory.
1441 Return directory entry, current offset, and optional stat information.
1442 Don't check for veto or invisible files.
1443 ********************************************************************/
1445 const char *ReadDirName(struct smb_Dir *dirp, long *poffset,
1446 SMB_STRUCT_STAT *sbuf, char **ptalloced)
1449 char *talloced = NULL;
1450 connection_struct *conn = dirp->conn;
1452 /* Cheat to allow . and .. to be the first entries returned. */
1453 if (((*poffset == START_OF_DIRECTORY_OFFSET) ||
1454 (*poffset == DOT_DOT_DIRECTORY_OFFSET)) && (dirp->file_number < 2))
1456 if (dirp->file_number == 0) {
1458 *poffset = dirp->offset = START_OF_DIRECTORY_OFFSET;
1461 *poffset = dirp->offset = DOT_DOT_DIRECTORY_OFFSET;
1463 dirp->file_number++;
1466 } else if (*poffset == END_OF_DIRECTORY_OFFSET) {
1467 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1470 /* A real offset, seek to it. */
1471 SeekDir(dirp, *poffset);
1474 while ((n = vfs_readdirname(conn, dirp->dir, sbuf, &talloced))) {
1475 /* Ignore . and .. - we've already returned them. */
1477 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
1478 TALLOC_FREE(talloced);
1482 *poffset = dirp->offset = SMB_VFS_TELLDIR(conn, dirp->dir);
1483 *ptalloced = talloced;
1484 dirp->file_number++;
1487 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1492 /*******************************************************************
1493 Rewind to the start.
1494 ********************************************************************/
1496 void RewindDir(struct smb_Dir *dirp, long *poffset)
1498 SMB_VFS_REWINDDIR(dirp->conn, dirp->dir);
1499 dirp->file_number = 0;
1500 dirp->offset = START_OF_DIRECTORY_OFFSET;
1501 *poffset = START_OF_DIRECTORY_OFFSET;
1504 /*******************************************************************
1506 ********************************************************************/
1508 void SeekDir(struct smb_Dir *dirp, long offset)
1510 if (offset != dirp->offset) {
1511 if (offset == START_OF_DIRECTORY_OFFSET) {
1512 RewindDir(dirp, &offset);
1514 * Ok we should really set the file number here
1515 * to 1 to enable ".." to be returned next. Trouble
1516 * is I'm worried about callers using SeekDir(dirp,0)
1517 * as equivalent to RewindDir(). So leave this alone
1520 } else if (offset == DOT_DOT_DIRECTORY_OFFSET) {
1521 RewindDir(dirp, &offset);
1523 * Set the file number to 2 - we want to get the first
1524 * real file entry (the one we return after "..")
1525 * on the next ReadDir.
1527 dirp->file_number = 2;
1528 } else if (offset == END_OF_DIRECTORY_OFFSET) {
1529 ; /* Don't seek in this case. */
1531 SMB_VFS_SEEKDIR(dirp->conn, dirp->dir, offset);
1533 dirp->offset = offset;
1537 /*******************************************************************
1538 Tell a dir position.
1539 ********************************************************************/
1541 long TellDir(struct smb_Dir *dirp)
1543 return(dirp->offset);
1546 /*******************************************************************
1547 Add an entry into the dcache.
1548 ********************************************************************/
1550 void DirCacheAdd(struct smb_Dir *dirp, const char *name, long offset)
1552 struct name_cache_entry *e;
1554 if (dirp->name_cache_size == 0) {
1558 if (dirp->name_cache == NULL) {
1559 dirp->name_cache = talloc_zero_array(
1560 dirp, struct name_cache_entry, dirp->name_cache_size);
1562 if (dirp->name_cache == NULL) {
1567 dirp->name_cache_index = (dirp->name_cache_index+1) %
1568 dirp->name_cache_size;
1569 e = &dirp->name_cache[dirp->name_cache_index];
1570 TALLOC_FREE(e->name);
1571 e->name = talloc_strdup(dirp, name);
1575 /*******************************************************************
1576 Find an entry by name. Leave us at the offset after it.
1577 Don't check for veto or invisible files.
1578 ********************************************************************/
1580 bool SearchDir(struct smb_Dir *dirp, const char *name, long *poffset)
1583 const char *entry = NULL;
1584 char *talloced = NULL;
1585 connection_struct *conn = dirp->conn;
1587 /* Search back in the name cache. */
1588 if (dirp->name_cache_size && dirp->name_cache) {
1589 for (i = dirp->name_cache_index; i >= 0; i--) {
1590 struct name_cache_entry *e = &dirp->name_cache[i];
1591 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1592 *poffset = e->offset;
1593 SeekDir(dirp, e->offset);
1597 for (i = dirp->name_cache_size - 1; i > dirp->name_cache_index; i--) {
1598 struct name_cache_entry *e = &dirp->name_cache[i];
1599 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1600 *poffset = e->offset;
1601 SeekDir(dirp, e->offset);
1607 /* Not found in the name cache. Rewind directory and start from scratch. */
1608 SMB_VFS_REWINDDIR(conn, dirp->dir);
1609 dirp->file_number = 0;
1610 *poffset = START_OF_DIRECTORY_OFFSET;
1611 while ((entry = ReadDirName(dirp, poffset, NULL, &talloced))) {
1612 if (conn->case_sensitive ? (strcmp(entry, name) == 0) : strequal(entry, name)) {
1613 TALLOC_FREE(talloced);
1616 TALLOC_FREE(talloced);
1621 /*****************************************************************
1622 Is this directory empty ?
1623 *****************************************************************/
1625 NTSTATUS smbd_can_delete_directory(struct connection_struct *conn,
1626 const char *dirname)
1628 NTSTATUS status = NT_STATUS_OK;
1630 const char *dname = NULL;
1631 char *talloced = NULL;
1633 struct smb_Dir *dir_hnd = OpenDir(talloc_tos(), conn,
1637 return map_nt_error_from_unix(errno);
1640 while ((dname = ReadDirName(dir_hnd, &dirpos, &st, &talloced))) {
1641 /* Quick check for "." and ".." */
1642 if (dname[0] == '.') {
1643 if (!dname[1] || (dname[1] == '.' && !dname[2])) {
1644 TALLOC_FREE(talloced);
1649 if (!is_visible_file(conn, dirname, dname, &st, True)) {
1650 TALLOC_FREE(talloced);
1654 DEBUG(10,("can_delete_directory: got name %s - can't delete\n",
1656 status = NT_STATUS_DIRECTORY_NOT_EMPTY;
1659 TALLOC_FREE(talloced);
1660 TALLOC_FREE(dir_hnd);