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 SAFE_FREE(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;
431 if (fsp && fsp->is_directory && fsp->fh->fd != -1) {
432 path = fsp->fsp_name->base_name;
435 DEBUG(5,("dptr_create dir=%s\n", path));
438 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
439 return NT_STATUS_INTERNAL_ERROR;
443 return NT_STATUS_INVALID_PARAMETER;
447 if (!(fsp->access_mask & SEC_DIR_LIST)) {
448 DEBUG(5,("dptr_create: directory %s "
449 "not open for LIST access\n",
451 return NT_STATUS_ACCESS_DENIED;
453 dir_hnd = OpenDir_fsp(NULL, conn, fsp, wcard, attr);
456 struct smb_filename *smb_dname = NULL;
457 NTSTATUS status = create_synthetic_smb_fname(talloc_tos(),
462 if (!NT_STATUS_IS_OK(status)) {
465 if (lp_posix_pathnames()) {
466 ret = SMB_VFS_LSTAT(conn, smb_dname);
468 ret = SMB_VFS_STAT(conn, smb_dname);
471 return map_nt_error_from_unix(errno);
473 if (!S_ISDIR(smb_dname->st.st_ex_mode)) {
474 return NT_STATUS_NOT_A_DIRECTORY;
476 status = smbd_check_access_rights(conn,
479 if (!NT_STATUS_IS_OK(status)) {
482 dir_hnd = OpenDir(NULL, conn, path, wcard, attr);
486 return map_nt_error_from_unix(errno);
489 if (sconn->searches.dirhandles_open >= MAX_OPEN_DIRECTORIES) {
490 dptr_idleoldest(sconn);
493 dptr = SMB_MALLOC_P(struct dptr_struct);
495 DEBUG(0,("malloc fail in dptr_create.\n"));
496 TALLOC_FREE(dir_hnd);
497 return NT_STATUS_NO_MEMORY;
505 * This is an old-style SMBsearch request. Ensure the
506 * value we return will fit in the range 1-255.
509 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
511 if(dptr->dnum == -1 || dptr->dnum > 254) {
514 * Try and close the oldest handle not marked for
515 * expect close in the hope that the client has
516 * finished with that one.
519 dptr_close_oldest(sconn, true);
521 /* Now try again... */
522 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
523 if(dptr->dnum == -1 || dptr->dnum > 254) {
524 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr->dnum));
526 TALLOC_FREE(dir_hnd);
527 return NT_STATUS_TOO_MANY_OPENED_FILES;
533 * This is a new-style trans2 request. Allocate from
534 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
537 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
539 if(dptr->dnum == -1 || dptr->dnum < 255) {
542 * Try and close the oldest handle close in the hope that
543 * the client has finished with that one. This will only
544 * happen in the case of the Win98 client bug where it leaks
548 dptr_close_oldest(sconn, false);
550 /* Now try again... */
551 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
553 if(dptr->dnum == -1 || dptr->dnum < 255) {
554 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr->dnum));
556 TALLOC_FREE(dir_hnd);
557 return NT_STATUS_TOO_MANY_OPENED_FILES;
562 bitmap_set(sconn->searches.dptr_bmap, dptr->dnum);
564 dptr->dnum += 1; /* Always bias the dnum by one - no zero dnums allowed. */
566 dptr->path = SMB_STRDUP(path);
568 bitmap_clear(sconn->searches.dptr_bmap, dptr->dnum - 1);
570 TALLOC_FREE(dir_hnd);
571 return NT_STATUS_NO_MEMORY;
574 dptr->dir_hnd = dir_hnd;
576 dptr->expect_close = expect_close;
577 dptr->wcard = SMB_STRDUP(wcard);
579 bitmap_clear(sconn->searches.dptr_bmap, dptr->dnum - 1);
580 SAFE_FREE(dptr->path);
582 TALLOC_FREE(dir_hnd);
583 return NT_STATUS_NO_MEMORY;
585 if (lp_posix_pathnames() || (wcard[0] == '.' && wcard[1] == 0)) {
586 dptr->has_wild = True;
588 dptr->has_wild = wcard_has_wild;
593 DLIST_ADD(sconn->searches.dirptrs, dptr);
595 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
596 dptr->dnum,path,expect_close));
604 /****************************************************************************
605 Wrapper functions to access the lower level directory handles.
606 ****************************************************************************/
608 void dptr_CloseDir(files_struct *fsp)
612 * Ugly hack. We have defined fdopendir to return ENOSYS if dirfd also isn't
613 * present. I hate Solaris. JRA.
616 if (fsp->fh->fd != -1 &&
617 fsp->dptr->dir_hnd &&
618 dirfd(fsp->dptr->dir_hnd->dir)) {
619 /* The call below closes the underlying fd. */
623 dptr_close_internal(fsp->dptr);
628 void dptr_SeekDir(struct dptr_struct *dptr, long offset)
630 SeekDir(dptr->dir_hnd, offset);
633 long dptr_TellDir(struct dptr_struct *dptr)
635 return TellDir(dptr->dir_hnd);
638 bool dptr_has_wild(struct dptr_struct *dptr)
640 return dptr->has_wild;
643 int dptr_dnum(struct dptr_struct *dptr)
648 /****************************************************************************
649 Return the next visible file name, skipping veto'd and invisible files.
650 ****************************************************************************/
652 static const char *dptr_normal_ReadDirName(struct dptr_struct *dptr,
653 long *poffset, SMB_STRUCT_STAT *pst,
656 /* Normal search for the next file. */
658 char *talloced = NULL;
660 while ((name = ReadDirName(dptr->dir_hnd, poffset, pst, &talloced))
662 if (is_visible_file(dptr->conn, dptr->path, name, pst, True)) {
663 *ptalloced = talloced;
666 TALLOC_FREE(talloced);
671 /****************************************************************************
672 Return the next visible file name, skipping veto'd and invisible files.
673 ****************************************************************************/
675 char *dptr_ReadDirName(TALLOC_CTX *ctx,
676 struct dptr_struct *dptr,
678 SMB_STRUCT_STAT *pst)
680 struct smb_filename smb_fname_base;
682 const char *name_temp = NULL;
683 char *talloced = NULL;
684 char *pathreal = NULL;
685 char *found_name = NULL;
688 SET_STAT_INVALID(*pst);
690 if (dptr->has_wild || dptr->did_stat) {
691 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst,
693 if (name_temp == NULL) {
696 if (talloced != NULL) {
697 return talloc_move(ctx, &talloced);
699 return talloc_strdup(ctx, name_temp);
702 /* If poffset is -1 then we know we returned this name before and we
703 * have no wildcards. We're at the end of the directory. */
704 if (*poffset == END_OF_DIRECTORY_OFFSET) {
708 /* We know the stored wcard contains no wildcard characters.
709 * See if we can match with a stat call. If we can't, then set
710 * did_stat to true to ensure we only do this once and keep
713 dptr->did_stat = true;
715 /* First check if it should be visible. */
716 if (!is_visible_file(dptr->conn, dptr->path, dptr->wcard,
719 /* This only returns false if the file was found, but
720 is explicitly not visible. Set us to end of
721 directory, but return NULL as we know we can't ever
726 if (VALID_STAT(*pst)) {
727 name = talloc_strdup(ctx, dptr->wcard);
731 pathreal = talloc_asprintf(ctx,
738 /* Create an smb_filename with stream_name == NULL. */
739 ZERO_STRUCT(smb_fname_base);
740 smb_fname_base.base_name = pathreal;
742 if (SMB_VFS_STAT(dptr->conn, &smb_fname_base) == 0) {
743 *pst = smb_fname_base.st;
744 name = talloc_strdup(ctx, dptr->wcard);
747 /* If we get any other error than ENOENT or ENOTDIR
748 then the file exists we just can't stat it. */
749 if (errno != ENOENT && errno != ENOTDIR) {
750 name = talloc_strdup(ctx, dptr->wcard);
755 /* Stat failed. We know this is authoratiative if we are
756 * providing case sensitive semantics or the underlying
757 * filesystem is case sensitive.
759 if (dptr->conn->case_sensitive ||
760 !(dptr->conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH))
766 * Try case-insensitive stat if the fs has the ability. This avoids
767 * scanning the whole directory.
769 ret = SMB_VFS_GET_REAL_FILENAME(dptr->conn, dptr->path, dptr->wcard,
774 } else if (errno == ENOENT) {
775 /* The case-insensitive lookup was authoritative. */
779 TALLOC_FREE(pathreal);
781 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst, &talloced);
782 if (name_temp == NULL) {
785 if (talloced != NULL) {
786 return talloc_move(ctx, &talloced);
788 return talloc_strdup(ctx, name_temp);
791 TALLOC_FREE(pathreal);
793 /* We need to set the underlying dir_hnd offset to -1
794 * also as this function is usually called with the
795 * output from TellDir. */
796 dptr->dir_hnd->offset = *poffset = END_OF_DIRECTORY_OFFSET;
800 /****************************************************************************
801 Search for a file by name, skipping veto'ed and not visible files.
802 ****************************************************************************/
804 bool dptr_SearchDir(struct dptr_struct *dptr, const char *name, long *poffset, SMB_STRUCT_STAT *pst)
806 SET_STAT_INVALID(*pst);
808 if (!dptr->has_wild && (dptr->dir_hnd->offset == END_OF_DIRECTORY_OFFSET)) {
809 /* This is a singleton directory and we're already at the end. */
810 *poffset = END_OF_DIRECTORY_OFFSET;
814 return SearchDir(dptr->dir_hnd, name, poffset);
817 /****************************************************************************
818 Add the name we're returning into the underlying cache.
819 ****************************************************************************/
821 void dptr_DirCacheAdd(struct dptr_struct *dptr, const char *name, long offset)
823 DirCacheAdd(dptr->dir_hnd, name, offset);
826 /****************************************************************************
827 Initialize variables & state data at the beginning of all search SMB requests.
828 ****************************************************************************/
829 void dptr_init_search_op(struct dptr_struct *dptr)
831 SMB_VFS_INIT_SEARCH_OP(dptr->conn, dptr->dir_hnd->dir);
834 /****************************************************************************
835 Fill the 5 byte server reserved dptr field.
836 ****************************************************************************/
838 bool dptr_fill(struct smbd_server_connection *sconn,
839 char *buf1,unsigned int key)
841 unsigned char *buf = (unsigned char *)buf1;
842 struct dptr_struct *dptr = dptr_get(sconn, key, false);
845 DEBUG(1,("filling null dirptr %d\n",key));
848 offset = (uint32)TellDir(dptr->dir_hnd);
849 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key,
850 (long)dptr->dir_hnd,(int)offset));
856 /****************************************************************************
857 Fetch the dir ptr and seek it given the 5 byte server field.
858 ****************************************************************************/
860 struct dptr_struct *dptr_fetch(struct smbd_server_connection *sconn,
863 unsigned int key = *(unsigned char *)buf;
864 struct dptr_struct *dptr = dptr_get(sconn, key, false);
869 DEBUG(3,("fetched null dirptr %d\n",key));
873 offset = IVAL(buf,1);
874 if (offset == (uint32)-1) {
875 seekoff = END_OF_DIRECTORY_OFFSET;
877 seekoff = (long)offset;
879 SeekDir(dptr->dir_hnd,seekoff);
880 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
881 key, dptr->path, (int)seekoff));
885 /****************************************************************************
887 ****************************************************************************/
889 struct dptr_struct *dptr_fetch_lanman2(struct smbd_server_connection *sconn,
892 struct dptr_struct *dptr = dptr_get(sconn, dptr_num, false);
895 DEBUG(3,("fetched null dirptr %d\n",dptr_num));
898 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num,dptr->path));
902 /****************************************************************************
903 Check that a file matches a particular file type.
904 ****************************************************************************/
906 bool dir_check_ftype(connection_struct *conn, uint32 mode, uint32 dirtype)
910 /* Check the "may have" search bits. */
911 if (((mode & ~dirtype) & (FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM | FILE_ATTRIBUTE_DIRECTORY)) != 0)
914 /* Check the "must have" bits, which are the may have bits shifted eight */
915 /* If must have bit is set, the file/dir can not be returned in search unless the matching
916 file attribute is set */
917 mask = ((dirtype >> 8) & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM)); /* & 0x37 */
919 if((mask & (mode & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM))) == mask) /* check if matching attribute present */
928 static bool mangle_mask_match(connection_struct *conn,
929 const char *filename,
934 if (!name_to_8_3(filename,mname,False,conn->params)) {
937 return mask_match_search(mname,mask,False);
940 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
941 struct dptr_struct *dirptr,
946 bool (*match_fn)(TALLOC_CTX *ctx,
951 bool (*mode_fn)(TALLOC_CTX *ctx,
953 struct smb_filename *smb_fname,
957 struct smb_filename **_smb_fname,
961 connection_struct *conn = dirptr->conn;
967 needslash = ( dirptr->path[strlen(dirptr->path) -1] != '/');
972 SMB_STRUCT_STAT sbuf;
976 char *pathreal = NULL;
977 struct smb_filename smb_fname;
982 cur_offset = dptr_TellDir(dirptr);
983 prev_offset = cur_offset;
984 dname = dptr_ReadDirName(ctx, dirptr, &cur_offset, &sbuf);
986 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
987 (long)dirptr, cur_offset));
993 isdots = (ISDOT(dname) || ISDOTDOT(dname));
994 if (dont_descend && !isdots) {
1000 * fname may get mangled, dname is never mangled.
1001 * Whenever we're accessing the filesystem we use
1002 * pathreal which is composed from dname.
1005 ok = match_fn(ctx, private_data, dname, mask, &fname);
1011 pathreal = talloc_asprintf(ctx, "%s%s%s",
1021 /* Create smb_fname with NULL stream_name. */
1022 ZERO_STRUCT(smb_fname);
1023 smb_fname.base_name = pathreal;
1024 smb_fname.st = sbuf;
1026 ok = mode_fn(ctx, private_data, &smb_fname, &mode);
1030 TALLOC_FREE(pathreal);
1034 if (!dir_check_ftype(conn, mode, dirtype)) {
1035 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1036 fname, (unsigned int)mode, (unsigned int)dirtype));
1039 TALLOC_FREE(pathreal);
1043 if (ask_sharemode) {
1044 struct timespec write_time_ts;
1045 struct file_id fileid;
1047 fileid = vfs_file_id_from_sbuf(conn,
1049 get_file_infos(fileid, 0, NULL, &write_time_ts);
1050 if (!null_timespec(write_time_ts)) {
1051 update_stat_ex_mtime(&smb_fname.st,
1056 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1058 mask, smb_fname_str_dbg(&smb_fname),
1061 DirCacheAdd(dirptr->dir_hnd, dname, cur_offset);
1065 status = copy_smb_filename(ctx, &smb_fname, _smb_fname);
1066 TALLOC_FREE(pathreal);
1067 if (!NT_STATUS_IS_OK(status)) {
1072 *_prev_offset = prev_offset;
1080 /****************************************************************************
1081 Get an 8.3 directory entry.
1082 ****************************************************************************/
1084 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX *ctx,
1090 connection_struct *conn = (connection_struct *)private_data;
1092 if ((strcmp(mask,"*.*") == 0) ||
1093 mask_match_search(dname, mask, false) ||
1094 mangle_mask_match(conn, dname, mask)) {
1098 if (!mangle_is_8_3(dname, false, conn->params)) {
1099 bool ok = name_to_8_3(dname, mname, false,
1109 *_fname = talloc_strdup(ctx, fname);
1110 if (*_fname == NULL) {
1120 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX *ctx,
1122 struct smb_filename *smb_fname,
1125 connection_struct *conn = (connection_struct *)private_data;
1127 if (!VALID_STAT(smb_fname->st)) {
1128 if ((SMB_VFS_STAT(conn, smb_fname)) != 0) {
1129 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1130 "Couldn't stat [%s]. Error "
1132 smb_fname_str_dbg(smb_fname),
1138 *_mode = dos_mode(conn, smb_fname);
1142 bool get_dir_entry(TALLOC_CTX *ctx,
1143 struct dptr_struct *dirptr,
1149 struct timespec *_date,
1153 connection_struct *conn = dirptr->conn;
1155 struct smb_filename *smb_fname = NULL;
1160 ok = smbd_dirptr_get_entry(ctx,
1166 smbd_dirptr_8_3_match_fn,
1167 smbd_dirptr_8_3_mode_fn,
1177 *_fname = talloc_move(ctx, &fname);
1178 *_size = smb_fname->st.st_ex_size;
1180 *_date = smb_fname->st.st_ex_mtime;
1181 TALLOC_FREE(smb_fname);
1185 /*******************************************************************
1186 Check to see if a user can read a file. This is only approximate,
1187 it is used as part of the "hide unreadable" option. Don't
1188 use it for anything security sensitive.
1189 ********************************************************************/
1191 static bool user_can_read_file(connection_struct *conn,
1192 struct smb_filename *smb_fname)
1195 * Never hide files from the root user.
1196 * We use (uid_t)0 here not sec_initial_uid()
1197 * as make test uses a single user context.
1200 if (get_current_uid(conn) == (uid_t)0) {
1204 return NT_STATUS_IS_OK(smbd_check_access_rights(conn,
1209 /*******************************************************************
1210 Check to see if a user can write a file (and only files, we do not
1211 check dirs on this one). This is only approximate,
1212 it is used as part of the "hide unwriteable" option. Don't
1213 use it for anything security sensitive.
1214 ********************************************************************/
1216 static bool user_can_write_file(connection_struct *conn,
1217 const struct smb_filename *smb_fname)
1220 * Never hide files from the root user.
1221 * We use (uid_t)0 here not sec_initial_uid()
1222 * as make test uses a single user context.
1225 if (get_current_uid(conn) == (uid_t)0) {
1229 SMB_ASSERT(VALID_STAT(smb_fname->st));
1231 /* Pseudo-open the file */
1233 if(S_ISDIR(smb_fname->st.st_ex_mode)) {
1237 return can_write_to_file(conn, smb_fname);
1240 /*******************************************************************
1241 Is a file a "special" type ?
1242 ********************************************************************/
1244 static bool file_is_special(connection_struct *conn,
1245 const struct smb_filename *smb_fname)
1248 * Never hide files from the root user.
1249 * We use (uid_t)0 here not sec_initial_uid()
1250 * as make test uses a single user context.
1253 if (get_current_uid(conn) == (uid_t)0) {
1257 SMB_ASSERT(VALID_STAT(smb_fname->st));
1259 if (S_ISREG(smb_fname->st.st_ex_mode) ||
1260 S_ISDIR(smb_fname->st.st_ex_mode) ||
1261 S_ISLNK(smb_fname->st.st_ex_mode))
1267 /*******************************************************************
1268 Should the file be seen by the client?
1269 NOTE: A successful return is no guarantee of the file's existence.
1270 ********************************************************************/
1272 bool is_visible_file(connection_struct *conn, const char *dir_path,
1273 const char *name, SMB_STRUCT_STAT *pst, bool use_veto)
1275 bool hide_unreadable = lp_hideunreadable(SNUM(conn));
1276 bool hide_unwriteable = lp_hideunwriteable_files(SNUM(conn));
1277 bool hide_special = lp_hide_special_files(SNUM(conn));
1279 struct smb_filename *smb_fname_base = NULL;
1283 if ((strcmp(".",name) == 0) || (strcmp("..",name) == 0)) {
1284 return True; /* . and .. are always visible. */
1287 /* If it's a vetoed file, pretend it doesn't even exist */
1288 if (use_veto && IS_VETO_PATH(conn, name)) {
1289 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name ));
1293 if (hide_unreadable || hide_unwriteable || hide_special) {
1294 entry = talloc_asprintf(talloc_tos(), "%s/%s", dir_path, name);
1300 /* Create an smb_filename with stream_name == NULL. */
1301 status = create_synthetic_smb_fname(talloc_tos(), entry, NULL,
1302 pst, &smb_fname_base);
1303 if (!NT_STATUS_IS_OK(status)) {
1308 /* If the file name does not exist, there's no point checking
1309 * the configuration options. We succeed, on the basis that the
1310 * checks *might* have passed if the file was present.
1312 if (!VALID_STAT(*pst)) {
1313 if (SMB_VFS_STAT(conn, smb_fname_base) != 0) {
1317 *pst = smb_fname_base->st;
1321 /* Honour _hide unreadable_ option */
1322 if (hide_unreadable &&
1323 !user_can_read_file(conn, smb_fname_base)) {
1324 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1329 /* Honour _hide unwriteable_ option */
1330 if (hide_unwriteable && !user_can_write_file(conn,
1332 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1337 /* Honour _hide_special_ option */
1338 if (hide_special && file_is_special(conn, smb_fname_base)) {
1339 DEBUG(10,("is_visible_file: file %s is special.\n",
1348 TALLOC_FREE(smb_fname_base);
1353 static int smb_Dir_destructor(struct smb_Dir *dirp)
1357 if (dirp->conn->sconn) {
1358 files_struct *fsp = file_find_fd(dirp->conn->sconn,
1361 /* The call below closes the underlying fd. */
1366 SMB_VFS_CLOSEDIR(dirp->conn,dirp->dir);
1368 if (dirp->conn->sconn) {
1369 dirp->conn->sconn->searches.dirhandles_open--;
1374 /*******************************************************************
1376 ********************************************************************/
1378 struct smb_Dir *OpenDir(TALLOC_CTX *mem_ctx, connection_struct *conn,
1383 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1384 struct smbd_server_connection *sconn = conn->sconn;
1391 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1393 dirp->dir_path = talloc_strdup(dirp, name);
1394 if (!dirp->dir_path) {
1400 sconn->searches.dirhandles_open++;
1402 talloc_set_destructor(dirp, smb_Dir_destructor);
1404 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1406 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp->dir_path,
1418 /*******************************************************************
1419 Open a directory from an fsp.
1420 ********************************************************************/
1422 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
1427 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1428 struct smbd_server_connection *sconn = conn->sconn;
1435 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1437 dirp->dir_path = talloc_strdup(dirp, fsp->fsp_name->base_name);
1438 if (!dirp->dir_path) {
1444 sconn->searches.dirhandles_open++;
1446 talloc_set_destructor(dirp, smb_Dir_destructor);
1448 if (fsp->is_directory && fsp->fh->fd != -1) {
1449 dirp->dir = SMB_VFS_FDOPENDIR(fsp, mask, attr);
1450 if (dirp->dir == NULL) {
1451 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1455 if (errno != ENOSYS) {
1461 if (dirp->dir == NULL) {
1462 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1463 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1467 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp->dir_path,
1480 /*******************************************************************
1481 Read from a directory.
1482 Return directory entry, current offset, and optional stat information.
1483 Don't check for veto or invisible files.
1484 ********************************************************************/
1486 const char *ReadDirName(struct smb_Dir *dirp, long *poffset,
1487 SMB_STRUCT_STAT *sbuf, char **ptalloced)
1490 char *talloced = NULL;
1491 connection_struct *conn = dirp->conn;
1493 /* Cheat to allow . and .. to be the first entries returned. */
1494 if (((*poffset == START_OF_DIRECTORY_OFFSET) ||
1495 (*poffset == DOT_DOT_DIRECTORY_OFFSET)) && (dirp->file_number < 2))
1497 if (dirp->file_number == 0) {
1499 *poffset = dirp->offset = START_OF_DIRECTORY_OFFSET;
1502 *poffset = dirp->offset = DOT_DOT_DIRECTORY_OFFSET;
1504 dirp->file_number++;
1507 } else if (*poffset == END_OF_DIRECTORY_OFFSET) {
1508 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1511 /* A real offset, seek to it. */
1512 SeekDir(dirp, *poffset);
1515 while ((n = vfs_readdirname(conn, dirp->dir, sbuf, &talloced))) {
1516 /* Ignore . and .. - we've already returned them. */
1518 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
1519 TALLOC_FREE(talloced);
1523 *poffset = dirp->offset = SMB_VFS_TELLDIR(conn, dirp->dir);
1524 *ptalloced = talloced;
1525 dirp->file_number++;
1528 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1533 /*******************************************************************
1534 Rewind to the start.
1535 ********************************************************************/
1537 void RewindDir(struct smb_Dir *dirp, long *poffset)
1539 SMB_VFS_REWINDDIR(dirp->conn, dirp->dir);
1540 dirp->file_number = 0;
1541 dirp->offset = START_OF_DIRECTORY_OFFSET;
1542 *poffset = START_OF_DIRECTORY_OFFSET;
1545 /*******************************************************************
1547 ********************************************************************/
1549 void SeekDir(struct smb_Dir *dirp, long offset)
1551 if (offset != dirp->offset) {
1552 if (offset == START_OF_DIRECTORY_OFFSET) {
1553 RewindDir(dirp, &offset);
1555 * Ok we should really set the file number here
1556 * to 1 to enable ".." to be returned next. Trouble
1557 * is I'm worried about callers using SeekDir(dirp,0)
1558 * as equivalent to RewindDir(). So leave this alone
1561 } else if (offset == DOT_DOT_DIRECTORY_OFFSET) {
1562 RewindDir(dirp, &offset);
1564 * Set the file number to 2 - we want to get the first
1565 * real file entry (the one we return after "..")
1566 * on the next ReadDir.
1568 dirp->file_number = 2;
1569 } else if (offset == END_OF_DIRECTORY_OFFSET) {
1570 ; /* Don't seek in this case. */
1572 SMB_VFS_SEEKDIR(dirp->conn, dirp->dir, offset);
1574 dirp->offset = offset;
1578 /*******************************************************************
1579 Tell a dir position.
1580 ********************************************************************/
1582 long TellDir(struct smb_Dir *dirp)
1584 return(dirp->offset);
1587 /*******************************************************************
1588 Add an entry into the dcache.
1589 ********************************************************************/
1591 void DirCacheAdd(struct smb_Dir *dirp, const char *name, long offset)
1593 struct name_cache_entry *e;
1595 if (dirp->name_cache_size == 0) {
1599 if (dirp->name_cache == NULL) {
1600 dirp->name_cache = talloc_zero_array(
1601 dirp, struct name_cache_entry, dirp->name_cache_size);
1603 if (dirp->name_cache == NULL) {
1608 dirp->name_cache_index = (dirp->name_cache_index+1) %
1609 dirp->name_cache_size;
1610 e = &dirp->name_cache[dirp->name_cache_index];
1611 TALLOC_FREE(e->name);
1612 e->name = talloc_strdup(dirp, name);
1616 /*******************************************************************
1617 Find an entry by name. Leave us at the offset after it.
1618 Don't check for veto or invisible files.
1619 ********************************************************************/
1621 bool SearchDir(struct smb_Dir *dirp, const char *name, long *poffset)
1624 const char *entry = NULL;
1625 char *talloced = NULL;
1626 connection_struct *conn = dirp->conn;
1628 /* Search back in the name cache. */
1629 if (dirp->name_cache_size && dirp->name_cache) {
1630 for (i = dirp->name_cache_index; i >= 0; i--) {
1631 struct name_cache_entry *e = &dirp->name_cache[i];
1632 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1633 *poffset = e->offset;
1634 SeekDir(dirp, e->offset);
1638 for (i = dirp->name_cache_size - 1; i > dirp->name_cache_index; i--) {
1639 struct name_cache_entry *e = &dirp->name_cache[i];
1640 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1641 *poffset = e->offset;
1642 SeekDir(dirp, e->offset);
1648 /* Not found in the name cache. Rewind directory and start from scratch. */
1649 SMB_VFS_REWINDDIR(conn, dirp->dir);
1650 dirp->file_number = 0;
1651 *poffset = START_OF_DIRECTORY_OFFSET;
1652 while ((entry = ReadDirName(dirp, poffset, NULL, &talloced))) {
1653 if (conn->case_sensitive ? (strcmp(entry, name) == 0) : strequal(entry, name)) {
1654 TALLOC_FREE(talloced);
1657 TALLOC_FREE(talloced);
1662 /*****************************************************************
1663 Is this directory empty ?
1664 *****************************************************************/
1666 NTSTATUS smbd_can_delete_directory(struct connection_struct *conn,
1667 const char *dirname)
1669 NTSTATUS status = NT_STATUS_OK;
1671 const char *dname = NULL;
1672 char *talloced = NULL;
1674 struct smb_Dir *dir_hnd = OpenDir(talloc_tos(), conn,
1678 return map_nt_error_from_unix(errno);
1681 while ((dname = ReadDirName(dir_hnd, &dirpos, &st, &talloced))) {
1682 /* Quick check for "." and ".." */
1683 if (dname[0] == '.') {
1684 if (!dname[1] || (dname[1] == '.' && !dname[2])) {
1685 TALLOC_FREE(talloced);
1690 if (!is_visible_file(conn, dirname, dname, &st, True)) {
1691 TALLOC_FREE(talloced);
1695 DEBUG(10,("can_delete_directory: got name %s - can't delete\n",
1697 status = NT_STATUS_DIRECTORY_NOT_EMPTY;
1700 TALLOC_FREE(talloced);
1701 TALLOC_FREE(dir_hnd);