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 const 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 const 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 if (sconn->using_smb2) {
268 DLIST_REMOVE(sconn->searches.dirptrs, dptr);
271 * Free the dnum in the bitmap. Remember the dnum value is always
272 * biased by one with respect to the bitmap.
275 if (!bitmap_query(sconn->searches.dptr_bmap, dptr->dnum - 1)) {
276 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
280 bitmap_clear(sconn->searches.dptr_bmap, dptr->dnum - 1);
283 TALLOC_FREE(dptr->dir_hnd);
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 = talloc(NULL, struct dptr_struct);
495 DEBUG(0,("talloc fail in dptr_create.\n"));
496 TALLOC_FREE(dir_hnd);
497 return NT_STATUS_NO_MEMORY;
502 dptr->path = talloc_strdup(dptr, path);
505 TALLOC_FREE(dir_hnd);
506 return NT_STATUS_NO_MEMORY;
509 dptr->dir_hnd = dir_hnd;
511 dptr->expect_close = expect_close;
512 dptr->wcard = talloc_strdup(dptr, wcard);
515 TALLOC_FREE(dir_hnd);
516 return NT_STATUS_NO_MEMORY;
518 if (lp_posix_pathnames() || (wcard[0] == '.' && wcard[1] == 0)) {
519 dptr->has_wild = True;
521 dptr->has_wild = wcard_has_wild;
526 if (sconn->using_smb2) {
533 * This is an old-style SMBsearch request. Ensure the
534 * value we return will fit in the range 1-255.
537 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
539 if(dptr->dnum == -1 || dptr->dnum > 254) {
542 * Try and close the oldest handle not marked for
543 * expect close in the hope that the client has
544 * finished with that one.
547 dptr_close_oldest(sconn, true);
549 /* Now try again... */
550 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
551 if(dptr->dnum == -1 || dptr->dnum > 254) {
552 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr->dnum));
554 TALLOC_FREE(dir_hnd);
555 return NT_STATUS_TOO_MANY_OPENED_FILES;
561 * This is a new-style trans2 request. Allocate from
562 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
565 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
567 if(dptr->dnum == -1 || dptr->dnum < 255) {
570 * Try and close the oldest handle close in the hope that
571 * the client has finished with that one. This will only
572 * happen in the case of the Win98 client bug where it leaks
576 dptr_close_oldest(sconn, false);
578 /* Now try again... */
579 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
581 if(dptr->dnum == -1 || dptr->dnum < 255) {
582 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr->dnum));
584 TALLOC_FREE(dir_hnd);
585 return NT_STATUS_TOO_MANY_OPENED_FILES;
590 bitmap_set(sconn->searches.dptr_bmap, dptr->dnum);
592 dptr->dnum += 1; /* Always bias the dnum by one - no zero dnums allowed. */
594 DLIST_ADD(sconn->searches.dirptrs, dptr);
597 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
598 dptr->dnum,path,expect_close));
606 /****************************************************************************
607 Wrapper functions to access the lower level directory handles.
608 ****************************************************************************/
610 void dptr_CloseDir(files_struct *fsp)
614 * Ugly hack. We have defined fdopendir to return ENOSYS if dirfd also isn't
615 * present. I hate Solaris. JRA.
618 if (fsp->fh->fd != -1 &&
619 fsp->dptr->dir_hnd &&
620 dirfd(fsp->dptr->dir_hnd->dir)) {
621 /* The call below closes the underlying fd. */
625 dptr_close_internal(fsp->dptr);
630 void dptr_SeekDir(struct dptr_struct *dptr, long offset)
632 SeekDir(dptr->dir_hnd, offset);
635 long dptr_TellDir(struct dptr_struct *dptr)
637 return TellDir(dptr->dir_hnd);
640 bool dptr_has_wild(struct dptr_struct *dptr)
642 return dptr->has_wild;
645 int dptr_dnum(struct dptr_struct *dptr)
650 /****************************************************************************
651 Return the next visible file name, skipping veto'd and invisible files.
652 ****************************************************************************/
654 static const char *dptr_normal_ReadDirName(struct dptr_struct *dptr,
655 long *poffset, SMB_STRUCT_STAT *pst,
658 /* Normal search for the next file. */
660 char *talloced = NULL;
662 while ((name = ReadDirName(dptr->dir_hnd, poffset, pst, &talloced))
664 if (is_visible_file(dptr->conn, dptr->path, name, pst, True)) {
665 *ptalloced = talloced;
668 TALLOC_FREE(talloced);
673 /****************************************************************************
674 Return the next visible file name, skipping veto'd and invisible files.
675 ****************************************************************************/
677 char *dptr_ReadDirName(TALLOC_CTX *ctx,
678 struct dptr_struct *dptr,
680 SMB_STRUCT_STAT *pst)
682 struct smb_filename smb_fname_base;
684 const char *name_temp = NULL;
685 char *talloced = NULL;
686 char *pathreal = NULL;
687 char *found_name = NULL;
690 SET_STAT_INVALID(*pst);
692 if (dptr->has_wild || dptr->did_stat) {
693 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst,
695 if (name_temp == NULL) {
698 if (talloced != NULL) {
699 return talloc_move(ctx, &talloced);
701 return talloc_strdup(ctx, name_temp);
704 /* If poffset is -1 then we know we returned this name before and we
705 * have no wildcards. We're at the end of the directory. */
706 if (*poffset == END_OF_DIRECTORY_OFFSET) {
710 /* We know the stored wcard contains no wildcard characters.
711 * See if we can match with a stat call. If we can't, then set
712 * did_stat to true to ensure we only do this once and keep
715 dptr->did_stat = true;
717 /* First check if it should be visible. */
718 if (!is_visible_file(dptr->conn, dptr->path, dptr->wcard,
721 /* This only returns false if the file was found, but
722 is explicitly not visible. Set us to end of
723 directory, but return NULL as we know we can't ever
728 if (VALID_STAT(*pst)) {
729 name = talloc_strdup(ctx, dptr->wcard);
733 pathreal = talloc_asprintf(ctx,
740 /* Create an smb_filename with stream_name == NULL. */
741 ZERO_STRUCT(smb_fname_base);
742 smb_fname_base.base_name = pathreal;
744 if (SMB_VFS_STAT(dptr->conn, &smb_fname_base) == 0) {
745 *pst = smb_fname_base.st;
746 name = talloc_strdup(ctx, dptr->wcard);
749 /* If we get any other error than ENOENT or ENOTDIR
750 then the file exists we just can't stat it. */
751 if (errno != ENOENT && errno != ENOTDIR) {
752 name = talloc_strdup(ctx, dptr->wcard);
757 /* Stat failed. We know this is authoratiative if we are
758 * providing case sensitive semantics or the underlying
759 * filesystem is case sensitive.
761 if (dptr->conn->case_sensitive ||
762 !(dptr->conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH))
768 * Try case-insensitive stat if the fs has the ability. This avoids
769 * scanning the whole directory.
771 ret = SMB_VFS_GET_REAL_FILENAME(dptr->conn, dptr->path, dptr->wcard,
776 } else if (errno == ENOENT) {
777 /* The case-insensitive lookup was authoritative. */
781 TALLOC_FREE(pathreal);
783 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst, &talloced);
784 if (name_temp == NULL) {
787 if (talloced != NULL) {
788 return talloc_move(ctx, &talloced);
790 return talloc_strdup(ctx, name_temp);
793 TALLOC_FREE(pathreal);
795 /* We need to set the underlying dir_hnd offset to -1
796 * also as this function is usually called with the
797 * output from TellDir. */
798 dptr->dir_hnd->offset = *poffset = END_OF_DIRECTORY_OFFSET;
802 /****************************************************************************
803 Search for a file by name, skipping veto'ed and not visible files.
804 ****************************************************************************/
806 bool dptr_SearchDir(struct dptr_struct *dptr, const char *name, long *poffset, SMB_STRUCT_STAT *pst)
808 SET_STAT_INVALID(*pst);
810 if (!dptr->has_wild && (dptr->dir_hnd->offset == END_OF_DIRECTORY_OFFSET)) {
811 /* This is a singleton directory and we're already at the end. */
812 *poffset = END_OF_DIRECTORY_OFFSET;
816 return SearchDir(dptr->dir_hnd, name, poffset);
819 /****************************************************************************
820 Add the name we're returning into the underlying cache.
821 ****************************************************************************/
823 void dptr_DirCacheAdd(struct dptr_struct *dptr, const char *name, long offset)
825 DirCacheAdd(dptr->dir_hnd, name, offset);
828 /****************************************************************************
829 Initialize variables & state data at the beginning of all search SMB requests.
830 ****************************************************************************/
831 void dptr_init_search_op(struct dptr_struct *dptr)
833 SMB_VFS_INIT_SEARCH_OP(dptr->conn, dptr->dir_hnd->dir);
836 /****************************************************************************
837 Fill the 5 byte server reserved dptr field.
838 ****************************************************************************/
840 bool dptr_fill(struct smbd_server_connection *sconn,
841 char *buf1,unsigned int key)
843 unsigned char *buf = (unsigned char *)buf1;
844 struct dptr_struct *dptr = dptr_get(sconn, key, false);
847 DEBUG(1,("filling null dirptr %d\n",key));
850 offset = (uint32)TellDir(dptr->dir_hnd);
851 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key,
852 (long)dptr->dir_hnd,(int)offset));
858 /****************************************************************************
859 Fetch the dir ptr and seek it given the 5 byte server field.
860 ****************************************************************************/
862 struct dptr_struct *dptr_fetch(struct smbd_server_connection *sconn,
865 unsigned int key = *(unsigned char *)buf;
866 struct dptr_struct *dptr = dptr_get(sconn, key, false);
871 DEBUG(3,("fetched null dirptr %d\n",key));
875 offset = IVAL(buf,1);
876 if (offset == (uint32)-1) {
877 seekoff = END_OF_DIRECTORY_OFFSET;
879 seekoff = (long)offset;
881 SeekDir(dptr->dir_hnd,seekoff);
882 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
883 key, dptr->path, (int)seekoff));
887 /****************************************************************************
889 ****************************************************************************/
891 struct dptr_struct *dptr_fetch_lanman2(struct smbd_server_connection *sconn,
894 struct dptr_struct *dptr = dptr_get(sconn, dptr_num, false);
897 DEBUG(3,("fetched null dirptr %d\n",dptr_num));
900 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num,dptr->path));
904 /****************************************************************************
905 Check that a file matches a particular file type.
906 ****************************************************************************/
908 bool dir_check_ftype(connection_struct *conn, uint32 mode, uint32 dirtype)
912 /* Check the "may have" search bits. */
913 if (((mode & ~dirtype) & (FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM | FILE_ATTRIBUTE_DIRECTORY)) != 0)
916 /* Check the "must have" bits, which are the may have bits shifted eight */
917 /* If must have bit is set, the file/dir can not be returned in search unless the matching
918 file attribute is set */
919 mask = ((dirtype >> 8) & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM)); /* & 0x37 */
921 if((mask & (mode & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM))) == mask) /* check if matching attribute present */
930 static bool mangle_mask_match(connection_struct *conn,
931 const char *filename,
936 if (!name_to_8_3(filename,mname,False,conn->params)) {
939 return mask_match_search(mname,mask,False);
942 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
943 struct dptr_struct *dirptr,
948 bool (*match_fn)(TALLOC_CTX *ctx,
953 bool (*mode_fn)(TALLOC_CTX *ctx,
955 struct smb_filename *smb_fname,
959 struct smb_filename **_smb_fname,
963 connection_struct *conn = dirptr->conn;
969 needslash = ( dirptr->path[strlen(dirptr->path) -1] != '/');
974 SMB_STRUCT_STAT sbuf;
978 char *pathreal = NULL;
979 struct smb_filename smb_fname;
984 cur_offset = dptr_TellDir(dirptr);
985 prev_offset = cur_offset;
986 dname = dptr_ReadDirName(ctx, dirptr, &cur_offset, &sbuf);
988 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
989 (long)dirptr, cur_offset));
995 isdots = (ISDOT(dname) || ISDOTDOT(dname));
996 if (dont_descend && !isdots) {
1002 * fname may get mangled, dname is never mangled.
1003 * Whenever we're accessing the filesystem we use
1004 * pathreal which is composed from dname.
1007 ok = match_fn(ctx, private_data, dname, mask, &fname);
1013 pathreal = talloc_asprintf(ctx, "%s%s%s",
1023 /* Create smb_fname with NULL stream_name. */
1024 ZERO_STRUCT(smb_fname);
1025 smb_fname.base_name = pathreal;
1026 smb_fname.st = sbuf;
1028 ok = mode_fn(ctx, private_data, &smb_fname, &mode);
1032 TALLOC_FREE(pathreal);
1036 if (!dir_check_ftype(conn, mode, dirtype)) {
1037 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1038 fname, (unsigned int)mode, (unsigned int)dirtype));
1041 TALLOC_FREE(pathreal);
1045 if (ask_sharemode) {
1046 struct timespec write_time_ts;
1047 struct file_id fileid;
1049 fileid = vfs_file_id_from_sbuf(conn,
1051 get_file_infos(fileid, 0, NULL, &write_time_ts);
1052 if (!null_timespec(write_time_ts)) {
1053 update_stat_ex_mtime(&smb_fname.st,
1058 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1060 mask, smb_fname_str_dbg(&smb_fname),
1063 DirCacheAdd(dirptr->dir_hnd, dname, cur_offset);
1067 status = copy_smb_filename(ctx, &smb_fname, _smb_fname);
1068 TALLOC_FREE(pathreal);
1069 if (!NT_STATUS_IS_OK(status)) {
1074 *_prev_offset = prev_offset;
1082 /****************************************************************************
1083 Get an 8.3 directory entry.
1084 ****************************************************************************/
1086 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX *ctx,
1092 connection_struct *conn = (connection_struct *)private_data;
1094 if ((strcmp(mask,"*.*") == 0) ||
1095 mask_match_search(dname, mask, false) ||
1096 mangle_mask_match(conn, dname, mask)) {
1100 if (!mangle_is_8_3(dname, false, conn->params)) {
1101 bool ok = name_to_8_3(dname, mname, false,
1111 *_fname = talloc_strdup(ctx, fname);
1112 if (*_fname == NULL) {
1122 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX *ctx,
1124 struct smb_filename *smb_fname,
1127 connection_struct *conn = (connection_struct *)private_data;
1129 if (!VALID_STAT(smb_fname->st)) {
1130 if ((SMB_VFS_STAT(conn, smb_fname)) != 0) {
1131 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1132 "Couldn't stat [%s]. Error "
1134 smb_fname_str_dbg(smb_fname),
1140 *_mode = dos_mode(conn, smb_fname);
1144 bool get_dir_entry(TALLOC_CTX *ctx,
1145 struct dptr_struct *dirptr,
1151 struct timespec *_date,
1155 connection_struct *conn = dirptr->conn;
1157 struct smb_filename *smb_fname = NULL;
1162 ok = smbd_dirptr_get_entry(ctx,
1168 smbd_dirptr_8_3_match_fn,
1169 smbd_dirptr_8_3_mode_fn,
1179 *_fname = talloc_move(ctx, &fname);
1180 *_size = smb_fname->st.st_ex_size;
1182 *_date = smb_fname->st.st_ex_mtime;
1183 TALLOC_FREE(smb_fname);
1187 /*******************************************************************
1188 Check to see if a user can read a file. This is only approximate,
1189 it is used as part of the "hide unreadable" option. Don't
1190 use it for anything security sensitive.
1191 ********************************************************************/
1193 static bool user_can_read_file(connection_struct *conn,
1194 struct smb_filename *smb_fname)
1197 * Never hide files from the root user.
1198 * We use (uid_t)0 here not sec_initial_uid()
1199 * as make test uses a single user context.
1202 if (get_current_uid(conn) == (uid_t)0) {
1206 return NT_STATUS_IS_OK(smbd_check_access_rights(conn,
1211 /*******************************************************************
1212 Check to see if a user can write a file (and only files, we do not
1213 check dirs on this one). This is only approximate,
1214 it is used as part of the "hide unwriteable" option. Don't
1215 use it for anything security sensitive.
1216 ********************************************************************/
1218 static bool user_can_write_file(connection_struct *conn,
1219 const struct smb_filename *smb_fname)
1222 * Never hide files from the root user.
1223 * We use (uid_t)0 here not sec_initial_uid()
1224 * as make test uses a single user context.
1227 if (get_current_uid(conn) == (uid_t)0) {
1231 SMB_ASSERT(VALID_STAT(smb_fname->st));
1233 /* Pseudo-open the file */
1235 if(S_ISDIR(smb_fname->st.st_ex_mode)) {
1239 return can_write_to_file(conn, smb_fname);
1242 /*******************************************************************
1243 Is a file a "special" type ?
1244 ********************************************************************/
1246 static bool file_is_special(connection_struct *conn,
1247 const struct smb_filename *smb_fname)
1250 * Never hide files from the root user.
1251 * We use (uid_t)0 here not sec_initial_uid()
1252 * as make test uses a single user context.
1255 if (get_current_uid(conn) == (uid_t)0) {
1259 SMB_ASSERT(VALID_STAT(smb_fname->st));
1261 if (S_ISREG(smb_fname->st.st_ex_mode) ||
1262 S_ISDIR(smb_fname->st.st_ex_mode) ||
1263 S_ISLNK(smb_fname->st.st_ex_mode))
1269 /*******************************************************************
1270 Should the file be seen by the client?
1271 NOTE: A successful return is no guarantee of the file's existence.
1272 ********************************************************************/
1274 bool is_visible_file(connection_struct *conn, const char *dir_path,
1275 const char *name, SMB_STRUCT_STAT *pst, bool use_veto)
1277 bool hide_unreadable = lp_hideunreadable(SNUM(conn));
1278 bool hide_unwriteable = lp_hideunwriteable_files(SNUM(conn));
1279 bool hide_special = lp_hide_special_files(SNUM(conn));
1281 struct smb_filename *smb_fname_base = NULL;
1285 if ((strcmp(".",name) == 0) || (strcmp("..",name) == 0)) {
1286 return True; /* . and .. are always visible. */
1289 /* If it's a vetoed file, pretend it doesn't even exist */
1290 if (use_veto && IS_VETO_PATH(conn, name)) {
1291 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name ));
1295 if (hide_unreadable || hide_unwriteable || hide_special) {
1296 entry = talloc_asprintf(talloc_tos(), "%s/%s", dir_path, name);
1302 /* Create an smb_filename with stream_name == NULL. */
1303 status = create_synthetic_smb_fname(talloc_tos(), entry, NULL,
1304 pst, &smb_fname_base);
1305 if (!NT_STATUS_IS_OK(status)) {
1310 /* If the file name does not exist, there's no point checking
1311 * the configuration options. We succeed, on the basis that the
1312 * checks *might* have passed if the file was present.
1314 if (!VALID_STAT(*pst)) {
1315 if (SMB_VFS_STAT(conn, smb_fname_base) != 0) {
1319 *pst = smb_fname_base->st;
1323 /* Honour _hide unreadable_ option */
1324 if (hide_unreadable &&
1325 !user_can_read_file(conn, smb_fname_base)) {
1326 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1331 /* Honour _hide unwriteable_ option */
1332 if (hide_unwriteable && !user_can_write_file(conn,
1334 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1339 /* Honour _hide_special_ option */
1340 if (hide_special && file_is_special(conn, smb_fname_base)) {
1341 DEBUG(10,("is_visible_file: file %s is special.\n",
1350 TALLOC_FREE(smb_fname_base);
1355 static int smb_Dir_destructor(struct smb_Dir *dirp)
1359 if (dirp->conn->sconn) {
1360 files_struct *fsp = file_find_fd(dirp->conn->sconn,
1363 /* The call below closes the underlying fd. */
1368 SMB_VFS_CLOSEDIR(dirp->conn,dirp->dir);
1370 if (dirp->conn->sconn && !dirp->conn->sconn->using_smb2) {
1371 dirp->conn->sconn->searches.dirhandles_open--;
1376 /*******************************************************************
1378 ********************************************************************/
1380 struct smb_Dir *OpenDir(TALLOC_CTX *mem_ctx, connection_struct *conn,
1385 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1386 struct smbd_server_connection *sconn = conn->sconn;
1393 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1395 dirp->dir_path = talloc_strdup(dirp, name);
1396 if (!dirp->dir_path) {
1401 if (sconn && !sconn->using_smb2) {
1402 sconn->searches.dirhandles_open++;
1404 talloc_set_destructor(dirp, smb_Dir_destructor);
1406 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1408 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp->dir_path,
1420 /*******************************************************************
1421 Open a directory from an fsp.
1422 ********************************************************************/
1424 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
1429 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1430 struct smbd_server_connection *sconn = conn->sconn;
1437 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1439 dirp->dir_path = talloc_strdup(dirp, fsp->fsp_name->base_name);
1440 if (!dirp->dir_path) {
1445 if (sconn && !sconn->using_smb2) {
1446 sconn->searches.dirhandles_open++;
1448 talloc_set_destructor(dirp, smb_Dir_destructor);
1450 if (fsp->is_directory && fsp->fh->fd != -1) {
1451 dirp->dir = SMB_VFS_FDOPENDIR(fsp, mask, attr);
1452 if (dirp->dir == NULL) {
1453 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1457 if (errno != ENOSYS) {
1463 if (dirp->dir == NULL) {
1464 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1465 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1469 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp->dir_path,
1482 /*******************************************************************
1483 Read from a directory.
1484 Return directory entry, current offset, and optional stat information.
1485 Don't check for veto or invisible files.
1486 ********************************************************************/
1488 const char *ReadDirName(struct smb_Dir *dirp, long *poffset,
1489 SMB_STRUCT_STAT *sbuf, char **ptalloced)
1492 char *talloced = NULL;
1493 connection_struct *conn = dirp->conn;
1495 /* Cheat to allow . and .. to be the first entries returned. */
1496 if (((*poffset == START_OF_DIRECTORY_OFFSET) ||
1497 (*poffset == DOT_DOT_DIRECTORY_OFFSET)) && (dirp->file_number < 2))
1499 if (dirp->file_number == 0) {
1501 *poffset = dirp->offset = START_OF_DIRECTORY_OFFSET;
1504 *poffset = dirp->offset = DOT_DOT_DIRECTORY_OFFSET;
1506 dirp->file_number++;
1509 } else if (*poffset == END_OF_DIRECTORY_OFFSET) {
1510 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1513 /* A real offset, seek to it. */
1514 SeekDir(dirp, *poffset);
1517 while ((n = vfs_readdirname(conn, dirp->dir, sbuf, &talloced))) {
1518 /* Ignore . and .. - we've already returned them. */
1520 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
1521 TALLOC_FREE(talloced);
1525 *poffset = dirp->offset = SMB_VFS_TELLDIR(conn, dirp->dir);
1526 *ptalloced = talloced;
1527 dirp->file_number++;
1530 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1535 /*******************************************************************
1536 Rewind to the start.
1537 ********************************************************************/
1539 void RewindDir(struct smb_Dir *dirp, long *poffset)
1541 SMB_VFS_REWINDDIR(dirp->conn, dirp->dir);
1542 dirp->file_number = 0;
1543 dirp->offset = START_OF_DIRECTORY_OFFSET;
1544 *poffset = START_OF_DIRECTORY_OFFSET;
1547 /*******************************************************************
1549 ********************************************************************/
1551 void SeekDir(struct smb_Dir *dirp, long offset)
1553 if (offset != dirp->offset) {
1554 if (offset == START_OF_DIRECTORY_OFFSET) {
1555 RewindDir(dirp, &offset);
1557 * Ok we should really set the file number here
1558 * to 1 to enable ".." to be returned next. Trouble
1559 * is I'm worried about callers using SeekDir(dirp,0)
1560 * as equivalent to RewindDir(). So leave this alone
1563 } else if (offset == DOT_DOT_DIRECTORY_OFFSET) {
1564 RewindDir(dirp, &offset);
1566 * Set the file number to 2 - we want to get the first
1567 * real file entry (the one we return after "..")
1568 * on the next ReadDir.
1570 dirp->file_number = 2;
1571 } else if (offset == END_OF_DIRECTORY_OFFSET) {
1572 ; /* Don't seek in this case. */
1574 SMB_VFS_SEEKDIR(dirp->conn, dirp->dir, offset);
1576 dirp->offset = offset;
1580 /*******************************************************************
1581 Tell a dir position.
1582 ********************************************************************/
1584 long TellDir(struct smb_Dir *dirp)
1586 return(dirp->offset);
1589 /*******************************************************************
1590 Add an entry into the dcache.
1591 ********************************************************************/
1593 void DirCacheAdd(struct smb_Dir *dirp, const char *name, long offset)
1595 struct name_cache_entry *e;
1597 if (dirp->name_cache_size == 0) {
1601 if (dirp->name_cache == NULL) {
1602 dirp->name_cache = talloc_zero_array(
1603 dirp, struct name_cache_entry, dirp->name_cache_size);
1605 if (dirp->name_cache == NULL) {
1610 dirp->name_cache_index = (dirp->name_cache_index+1) %
1611 dirp->name_cache_size;
1612 e = &dirp->name_cache[dirp->name_cache_index];
1613 TALLOC_FREE(e->name);
1614 e->name = talloc_strdup(dirp, name);
1618 /*******************************************************************
1619 Find an entry by name. Leave us at the offset after it.
1620 Don't check for veto or invisible files.
1621 ********************************************************************/
1623 bool SearchDir(struct smb_Dir *dirp, const char *name, long *poffset)
1626 const char *entry = NULL;
1627 char *talloced = NULL;
1628 connection_struct *conn = dirp->conn;
1630 /* Search back in the name cache. */
1631 if (dirp->name_cache_size && dirp->name_cache) {
1632 for (i = dirp->name_cache_index; i >= 0; i--) {
1633 struct name_cache_entry *e = &dirp->name_cache[i];
1634 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1635 *poffset = e->offset;
1636 SeekDir(dirp, e->offset);
1640 for (i = dirp->name_cache_size - 1; i > dirp->name_cache_index; i--) {
1641 struct name_cache_entry *e = &dirp->name_cache[i];
1642 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1643 *poffset = e->offset;
1644 SeekDir(dirp, e->offset);
1650 /* Not found in the name cache. Rewind directory and start from scratch. */
1651 SMB_VFS_REWINDDIR(conn, dirp->dir);
1652 dirp->file_number = 0;
1653 *poffset = START_OF_DIRECTORY_OFFSET;
1654 while ((entry = ReadDirName(dirp, poffset, NULL, &talloced))) {
1655 if (conn->case_sensitive ? (strcmp(entry, name) == 0) : strequal(entry, name)) {
1656 TALLOC_FREE(talloced);
1659 TALLOC_FREE(talloced);
1664 /*****************************************************************
1665 Is this directory empty ?
1666 *****************************************************************/
1668 NTSTATUS can_delete_directory(struct connection_struct *conn,
1669 const char *dirname)
1671 NTSTATUS status = NT_STATUS_OK;
1673 const char *dname = NULL;
1674 char *talloced = NULL;
1676 struct smb_Dir *dir_hnd = OpenDir(talloc_tos(), conn,
1680 return map_nt_error_from_unix(errno);
1683 while ((dname = ReadDirName(dir_hnd, &dirpos, &st, &talloced))) {
1684 /* Quick check for "." and ".." */
1685 if (dname[0] == '.') {
1686 if (!dname[1] || (dname[1] == '.' && !dname[2])) {
1687 TALLOC_FREE(talloced);
1692 if (!is_visible_file(conn, dirname, dname, &st, True)) {
1693 TALLOC_FREE(talloced);
1697 DEBUG(10,("can_delete_directory: got name %s - can't delete\n",
1699 status = NT_STATUS_DIRECTORY_NOT_EMPTY;
1702 TALLOC_FREE(talloced);
1703 TALLOC_FREE(dir_hnd);