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;
53 files_struct *fsp; /* Back pointer to containing fsp, only
54 set from OpenDir_fsp(). */
58 struct dptr_struct *next, *prev;
61 struct connection_struct *conn;
62 struct smb_Dir *dir_hnd;
67 bool has_wild; /* Set to true if the wcard entry has MS wildcard characters in it. */
68 bool did_stat; /* Optimisation for non-wcard searches. */
69 bool priv; /* Directory handle opened with privilege. */
72 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
77 static void DirCacheAdd(struct smb_Dir *dirp, const char *name, long offset);
79 #define INVALID_DPTR_KEY (-3)
81 /****************************************************************************
83 ****************************************************************************/
85 bool make_dir_struct(TALLOC_CTX *ctx,
95 char *mask2 = talloc_strdup(ctx, mask);
101 if ((mode & FILE_ATTRIBUTE_DIRECTORY) != 0) {
105 memset(buf+1,' ',11);
106 if ((p = strchr_m(mask2,'.')) != NULL) {
108 push_ascii(buf+1,mask2,8, 0);
109 push_ascii(buf+9,p+1,3, 0);
112 push_ascii(buf+1,mask2,11, 0);
115 memset(buf+21,'\0',DIR_STRUCT_SIZE-21);
117 srv_put_dos_date(buf,22,date);
118 SSVAL(buf,26,size & 0xFFFF);
119 SSVAL(buf,28,(size >> 16)&0xFFFF);
120 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
121 Strange, but verified on W2K3. Needed for OS/2. JRA. */
122 push_ascii(buf+30,fname,12, uc ? STR_UPPER : 0);
123 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf+30, fname));
127 /****************************************************************************
128 Initialise the dir bitmap.
129 ****************************************************************************/
131 bool init_dptrs(struct smbd_server_connection *sconn)
133 if (sconn->searches.dptr_bmap) {
137 sconn->searches.dptr_bmap = bitmap_talloc(
138 sconn, MAX_DIRECTORY_HANDLES);
140 if (sconn->searches.dptr_bmap == NULL) {
147 /****************************************************************************
148 Idle a dptr - the directory is closed but the control info is kept.
149 ****************************************************************************/
151 static void dptr_idle(struct dptr_struct *dptr)
154 DEBUG(4,("Idling dptr dnum %d\n",dptr->dnum));
155 TALLOC_FREE(dptr->dir_hnd);
159 /****************************************************************************
160 Idle the oldest dptr.
161 ****************************************************************************/
163 static void dptr_idleoldest(struct smbd_server_connection *sconn)
165 struct dptr_struct *dptr;
168 * Go to the end of the list.
170 dptr = DLIST_TAIL(sconn->searches.dirptrs);
173 DEBUG(0,("No dptrs available to idle ?\n"));
178 * Idle the oldest pointer.
181 for(; dptr; dptr = DLIST_PREV(dptr)) {
189 /****************************************************************************
190 Get the struct dptr_struct for a dir index.
191 ****************************************************************************/
193 static struct dptr_struct *dptr_get(struct smbd_server_connection *sconn,
194 int key, bool forclose)
196 struct dptr_struct *dptr;
198 for(dptr = sconn->searches.dirptrs; dptr; dptr = dptr->next) {
199 if(dptr->dnum == key) {
200 if (!forclose && !dptr->dir_hnd) {
201 if (sconn->searches.dirhandles_open >= MAX_OPEN_DIRECTORIES)
202 dptr_idleoldest(sconn);
203 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key));
204 if (!(dptr->dir_hnd = OpenDir(
205 NULL, dptr->conn, dptr->path,
206 dptr->wcard, dptr->attr))) {
207 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr->path,
212 DLIST_PROMOTE(sconn->searches.dirptrs,dptr);
219 /****************************************************************************
220 Get the dir path for a dir index.
221 ****************************************************************************/
223 const char *dptr_path(struct smbd_server_connection *sconn, int key)
225 struct dptr_struct *dptr = dptr_get(sconn, key, false);
231 /****************************************************************************
232 Get the dir wcard for a dir index.
233 ****************************************************************************/
235 const char *dptr_wcard(struct smbd_server_connection *sconn, int key)
237 struct dptr_struct *dptr = dptr_get(sconn, key, false);
243 /****************************************************************************
244 Get the dir attrib for a dir index.
245 ****************************************************************************/
247 uint16 dptr_attr(struct smbd_server_connection *sconn, int key)
249 struct dptr_struct *dptr = dptr_get(sconn, key, false);
255 /****************************************************************************
256 Close a dptr (internal func).
257 ****************************************************************************/
259 static void dptr_close_internal(struct dptr_struct *dptr)
261 struct smbd_server_connection *sconn = dptr->conn->sconn;
263 DEBUG(4,("closing dptr key %d\n",dptr->dnum));
269 if (sconn->using_smb2) {
273 DLIST_REMOVE(sconn->searches.dirptrs, dptr);
276 * Free the dnum in the bitmap. Remember the dnum value is always
277 * biased by one with respect to the bitmap.
280 if (!bitmap_query(sconn->searches.dptr_bmap, dptr->dnum - 1)) {
281 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
285 bitmap_clear(sconn->searches.dptr_bmap, dptr->dnum - 1);
288 TALLOC_FREE(dptr->dir_hnd);
292 /****************************************************************************
293 Close a dptr given a key.
294 ****************************************************************************/
296 void dptr_close(struct smbd_server_connection *sconn, int *key)
298 struct dptr_struct *dptr;
300 if(*key == INVALID_DPTR_KEY)
303 /* OS/2 seems to use -1 to indicate "close all directories" */
305 struct dptr_struct *next;
306 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
308 dptr_close_internal(dptr);
310 *key = INVALID_DPTR_KEY;
314 dptr = dptr_get(sconn, *key, true);
317 DEBUG(0,("Invalid key %d given to dptr_close\n", *key));
321 dptr_close_internal(dptr);
323 *key = INVALID_DPTR_KEY;
326 /****************************************************************************
327 Close all dptrs for a cnum.
328 ****************************************************************************/
330 void dptr_closecnum(connection_struct *conn)
332 struct dptr_struct *dptr, *next;
333 struct smbd_server_connection *sconn = conn->sconn;
339 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
341 if (dptr->conn == conn) {
342 dptr_close_internal(dptr);
347 /****************************************************************************
348 Idle all dptrs for a cnum.
349 ****************************************************************************/
351 void dptr_idlecnum(connection_struct *conn)
353 struct dptr_struct *dptr;
354 struct smbd_server_connection *sconn = conn->sconn;
360 for(dptr = sconn->searches.dirptrs; dptr; dptr = dptr->next) {
361 if (dptr->conn == conn && dptr->dir_hnd) {
367 /****************************************************************************
368 Close a dptr that matches a given path, only if it matches the spid also.
369 ****************************************************************************/
371 void dptr_closepath(struct smbd_server_connection *sconn,
372 char *path,uint16 spid)
374 struct dptr_struct *dptr, *next;
375 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
377 if (spid == dptr->spid && strequal(dptr->path,path))
378 dptr_close_internal(dptr);
382 /****************************************************************************
383 Try and close the oldest handle not marked for
384 expect close in the hope that the client has
385 finished with that one.
386 ****************************************************************************/
388 static void dptr_close_oldest(struct smbd_server_connection *sconn,
391 struct dptr_struct *dptr;
394 * Go to the end of the list.
396 for(dptr = sconn->searches.dirptrs; dptr && dptr->next; dptr = dptr->next)
400 DEBUG(0,("No old dptrs available to close oldest ?\n"));
405 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
406 * does not have expect_close set. If 'old' is false, close
407 * one of the new dnum handles.
410 for(; dptr; dptr = DLIST_PREV(dptr)) {
411 if ((old && (dptr->dnum < 256) && !dptr->expect_close) ||
412 (!old && (dptr->dnum > 255))) {
413 dptr_close_internal(dptr);
419 /****************************************************************************
420 Safely do an OpenDir as root, ensuring we're in the right place.
421 ****************************************************************************/
423 static struct smb_Dir *open_dir_with_privilege(connection_struct *conn,
424 struct smb_request *req,
430 struct smb_Dir *dir_hnd = NULL;
431 struct smb_filename *smb_fname_cwd = NULL;
432 char *saved_dir = vfs_GetWd(talloc_tos(), conn);
433 struct privilege_paths *priv_paths = req->priv_paths;
436 if (saved_dir == NULL) {
440 if (vfs_ChDir(conn, path) == -1) {
444 /* Now check the stat value is the same. */
445 status = create_synthetic_smb_fname(talloc_tos(), ".",
449 if (!NT_STATUS_IS_OK(status)) {
452 ret = SMB_VFS_STAT(conn, smb_fname_cwd);
457 if (!check_same_stat(&smb_fname_cwd->st, &priv_paths->parent_name.st)) {
458 DEBUG(0,("open_dir_with_privilege: stat mismatch between %s "
461 smb_fname_str_dbg(&priv_paths->parent_name)));
465 dir_hnd = OpenDir(NULL, conn, ".", wcard, attr);
469 vfs_ChDir(conn, saved_dir);
473 /****************************************************************************
474 Create a new dir ptr. If the flag old_handle is true then we must allocate
475 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
476 one byte long. If old_handle is false we allocate from the range
477 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
478 a directory handle is never zero.
479 wcard must not be zero.
480 ****************************************************************************/
482 NTSTATUS dptr_create(connection_struct *conn,
483 struct smb_request *req,
485 const char *path, bool old_handle, bool expect_close,uint16 spid,
486 const char *wcard, bool wcard_has_wild, uint32 attr, struct dptr_struct **dptr_ret)
488 struct smbd_server_connection *sconn = conn->sconn;
489 struct dptr_struct *dptr = NULL;
490 struct smb_Dir *dir_hnd;
492 if (fsp && fsp->is_directory && fsp->fh->fd != -1) {
493 path = fsp->fsp_name->base_name;
496 DEBUG(5,("dptr_create dir=%s\n", path));
499 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
500 return NT_STATUS_INTERNAL_ERROR;
504 return NT_STATUS_INVALID_PARAMETER;
508 if (!(fsp->access_mask & SEC_DIR_LIST)) {
509 DEBUG(5,("dptr_create: directory %s "
510 "not open for LIST access\n",
512 return NT_STATUS_ACCESS_DENIED;
514 dir_hnd = OpenDir_fsp(NULL, conn, fsp, wcard, attr);
517 bool backup_intent = (req && req->priv_paths);
518 struct smb_filename *smb_dname = NULL;
519 NTSTATUS status = create_synthetic_smb_fname(talloc_tos(),
524 if (!NT_STATUS_IS_OK(status)) {
527 if (lp_posix_pathnames()) {
528 ret = SMB_VFS_LSTAT(conn, smb_dname);
530 ret = SMB_VFS_STAT(conn, smb_dname);
533 return map_nt_error_from_unix(errno);
535 if (!S_ISDIR(smb_dname->st.st_ex_mode)) {
536 return NT_STATUS_NOT_A_DIRECTORY;
538 status = smbd_check_access_rights(conn,
542 if (!NT_STATUS_IS_OK(status)) {
546 dir_hnd = open_dir_with_privilege(conn,
552 dir_hnd = OpenDir(NULL, conn, path, wcard, attr);
557 return map_nt_error_from_unix(errno);
560 if (sconn->searches.dirhandles_open >= MAX_OPEN_DIRECTORIES) {
561 dptr_idleoldest(sconn);
564 dptr = talloc(NULL, struct dptr_struct);
566 DEBUG(0,("talloc fail in dptr_create.\n"));
567 TALLOC_FREE(dir_hnd);
568 return NT_STATUS_NO_MEMORY;
573 dptr->path = talloc_strdup(dptr, path);
576 TALLOC_FREE(dir_hnd);
577 return NT_STATUS_NO_MEMORY;
580 dptr->dir_hnd = dir_hnd;
582 dptr->expect_close = expect_close;
583 dptr->wcard = talloc_strdup(dptr, wcard);
586 TALLOC_FREE(dir_hnd);
587 return NT_STATUS_NO_MEMORY;
589 if (lp_posix_pathnames() || (wcard[0] == '.' && wcard[1] == 0)) {
590 dptr->has_wild = True;
592 dptr->has_wild = wcard_has_wild;
597 if (sconn->using_smb2) {
604 * This is an old-style SMBsearch request. Ensure the
605 * value we return will fit in the range 1-255.
608 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
610 if(dptr->dnum == -1 || dptr->dnum > 254) {
613 * Try and close the oldest handle not marked for
614 * expect close in the hope that the client has
615 * finished with that one.
618 dptr_close_oldest(sconn, true);
620 /* Now try again... */
621 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
622 if(dptr->dnum == -1 || dptr->dnum > 254) {
623 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr->dnum));
625 TALLOC_FREE(dir_hnd);
626 return NT_STATUS_TOO_MANY_OPENED_FILES;
632 * This is a new-style trans2 request. Allocate from
633 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
636 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
638 if(dptr->dnum == -1 || dptr->dnum < 255) {
641 * Try and close the oldest handle close in the hope that
642 * the client has finished with that one. This will only
643 * happen in the case of the Win98 client bug where it leaks
647 dptr_close_oldest(sconn, false);
649 /* Now try again... */
650 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
652 if(dptr->dnum == -1 || dptr->dnum < 255) {
653 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr->dnum));
655 TALLOC_FREE(dir_hnd);
656 return NT_STATUS_TOO_MANY_OPENED_FILES;
661 bitmap_set(sconn->searches.dptr_bmap, dptr->dnum);
663 dptr->dnum += 1; /* Always bias the dnum by one - no zero dnums allowed. */
665 DLIST_ADD(sconn->searches.dirptrs, dptr);
668 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
669 dptr->dnum,path,expect_close));
677 /****************************************************************************
678 Wrapper functions to access the lower level directory handles.
679 ****************************************************************************/
681 void dptr_CloseDir(files_struct *fsp)
685 * The destructor for the struct smb_Dir
686 * (fsp->dptr->dir_hnd) now handles
687 * all resource deallocation.
689 dptr_close_internal(fsp->dptr);
693 void dptr_SeekDir(struct dptr_struct *dptr, long offset)
695 SeekDir(dptr->dir_hnd, offset);
698 long dptr_TellDir(struct dptr_struct *dptr)
700 return TellDir(dptr->dir_hnd);
703 bool dptr_has_wild(struct dptr_struct *dptr)
705 return dptr->has_wild;
708 int dptr_dnum(struct dptr_struct *dptr)
713 bool dptr_get_priv(struct dptr_struct *dptr)
718 void dptr_set_priv(struct dptr_struct *dptr)
723 /****************************************************************************
724 Return the next visible file name, skipping veto'd and invisible files.
725 ****************************************************************************/
727 static const char *dptr_normal_ReadDirName(struct dptr_struct *dptr,
728 long *poffset, SMB_STRUCT_STAT *pst,
731 /* Normal search for the next file. */
733 char *talloced = NULL;
735 while ((name = ReadDirName(dptr->dir_hnd, poffset, pst, &talloced))
737 if (is_visible_file(dptr->conn, dptr->path, name, pst, True)) {
738 *ptalloced = talloced;
741 TALLOC_FREE(talloced);
746 /****************************************************************************
747 Return the next visible file name, skipping veto'd and invisible files.
748 ****************************************************************************/
750 char *dptr_ReadDirName(TALLOC_CTX *ctx,
751 struct dptr_struct *dptr,
753 SMB_STRUCT_STAT *pst)
755 struct smb_filename smb_fname_base;
757 const char *name_temp = NULL;
758 char *talloced = NULL;
759 char *pathreal = NULL;
760 char *found_name = NULL;
763 SET_STAT_INVALID(*pst);
765 if (dptr->has_wild || dptr->did_stat) {
766 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst,
768 if (name_temp == NULL) {
771 if (talloced != NULL) {
772 return talloc_move(ctx, &talloced);
774 return talloc_strdup(ctx, name_temp);
777 /* If poffset is -1 then we know we returned this name before and we
778 * have no wildcards. We're at the end of the directory. */
779 if (*poffset == END_OF_DIRECTORY_OFFSET) {
783 /* We know the stored wcard contains no wildcard characters.
784 * See if we can match with a stat call. If we can't, then set
785 * did_stat to true to ensure we only do this once and keep
788 dptr->did_stat = true;
790 /* First check if it should be visible. */
791 if (!is_visible_file(dptr->conn, dptr->path, dptr->wcard,
794 /* This only returns false if the file was found, but
795 is explicitly not visible. Set us to end of
796 directory, but return NULL as we know we can't ever
801 if (VALID_STAT(*pst)) {
802 name = talloc_strdup(ctx, dptr->wcard);
806 pathreal = talloc_asprintf(ctx,
813 /* Create an smb_filename with stream_name == NULL. */
814 ZERO_STRUCT(smb_fname_base);
815 smb_fname_base.base_name = pathreal;
817 if (SMB_VFS_STAT(dptr->conn, &smb_fname_base) == 0) {
818 *pst = smb_fname_base.st;
819 name = talloc_strdup(ctx, dptr->wcard);
822 /* If we get any other error than ENOENT or ENOTDIR
823 then the file exists we just can't stat it. */
824 if (errno != ENOENT && errno != ENOTDIR) {
825 name = talloc_strdup(ctx, dptr->wcard);
830 /* Stat failed. We know this is authoratiative if we are
831 * providing case sensitive semantics or the underlying
832 * filesystem is case sensitive.
834 if (dptr->conn->case_sensitive ||
835 !(dptr->conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH))
841 * Try case-insensitive stat if the fs has the ability. This avoids
842 * scanning the whole directory.
844 ret = SMB_VFS_GET_REAL_FILENAME(dptr->conn, dptr->path, dptr->wcard,
849 } else if (errno == ENOENT) {
850 /* The case-insensitive lookup was authoritative. */
854 TALLOC_FREE(pathreal);
856 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst, &talloced);
857 if (name_temp == NULL) {
860 if (talloced != NULL) {
861 return talloc_move(ctx, &talloced);
863 return talloc_strdup(ctx, name_temp);
866 TALLOC_FREE(pathreal);
868 /* We need to set the underlying dir_hnd offset to -1
869 * also as this function is usually called with the
870 * output from TellDir. */
871 dptr->dir_hnd->offset = *poffset = END_OF_DIRECTORY_OFFSET;
875 /****************************************************************************
876 Search for a file by name, skipping veto'ed and not visible files.
877 ****************************************************************************/
879 bool dptr_SearchDir(struct dptr_struct *dptr, const char *name, long *poffset, SMB_STRUCT_STAT *pst)
881 SET_STAT_INVALID(*pst);
883 if (!dptr->has_wild && (dptr->dir_hnd->offset == END_OF_DIRECTORY_OFFSET)) {
884 /* This is a singleton directory and we're already at the end. */
885 *poffset = END_OF_DIRECTORY_OFFSET;
889 return SearchDir(dptr->dir_hnd, name, poffset);
892 /****************************************************************************
893 Initialize variables & state data at the beginning of all search SMB requests.
894 ****************************************************************************/
895 void dptr_init_search_op(struct dptr_struct *dptr)
897 SMB_VFS_INIT_SEARCH_OP(dptr->conn, dptr->dir_hnd->dir);
900 /****************************************************************************
901 Fill the 5 byte server reserved dptr field.
902 ****************************************************************************/
904 bool dptr_fill(struct smbd_server_connection *sconn,
905 char *buf1,unsigned int key)
907 unsigned char *buf = (unsigned char *)buf1;
908 struct dptr_struct *dptr = dptr_get(sconn, key, false);
911 DEBUG(1,("filling null dirptr %d\n",key));
914 offset = (uint32)TellDir(dptr->dir_hnd);
915 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key,
916 (long)dptr->dir_hnd,(int)offset));
922 /****************************************************************************
923 Fetch the dir ptr and seek it given the 5 byte server field.
924 ****************************************************************************/
926 struct dptr_struct *dptr_fetch(struct smbd_server_connection *sconn,
929 unsigned int key = *(unsigned char *)buf;
930 struct dptr_struct *dptr = dptr_get(sconn, key, false);
935 DEBUG(3,("fetched null dirptr %d\n",key));
939 offset = IVAL(buf,1);
940 if (offset == (uint32)-1) {
941 seekoff = END_OF_DIRECTORY_OFFSET;
943 seekoff = (long)offset;
945 SeekDir(dptr->dir_hnd,seekoff);
946 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
947 key, dptr->path, (int)seekoff));
951 /****************************************************************************
953 ****************************************************************************/
955 struct dptr_struct *dptr_fetch_lanman2(struct smbd_server_connection *sconn,
958 struct dptr_struct *dptr = dptr_get(sconn, dptr_num, false);
961 DEBUG(3,("fetched null dirptr %d\n",dptr_num));
964 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num,dptr->path));
968 /****************************************************************************
969 Check that a file matches a particular file type.
970 ****************************************************************************/
972 bool dir_check_ftype(connection_struct *conn, uint32 mode, uint32 dirtype)
976 /* Check the "may have" search bits. */
977 if (((mode & ~dirtype) & (FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM | FILE_ATTRIBUTE_DIRECTORY)) != 0)
980 /* Check the "must have" bits, which are the may have bits shifted eight */
981 /* If must have bit is set, the file/dir can not be returned in search unless the matching
982 file attribute is set */
983 mask = ((dirtype >> 8) & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM)); /* & 0x37 */
985 if((mask & (mode & (FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_SYSTEM))) == mask) /* check if matching attribute present */
994 static bool mangle_mask_match(connection_struct *conn,
995 const char *filename,
1000 if (!name_to_8_3(filename,mname,False,conn->params)) {
1003 return mask_match_search(mname,mask,False);
1006 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
1007 struct dptr_struct *dirptr,
1012 bool (*match_fn)(TALLOC_CTX *ctx,
1017 bool (*mode_fn)(TALLOC_CTX *ctx,
1019 struct smb_filename *smb_fname,
1023 struct smb_filename **_smb_fname,
1027 connection_struct *conn = dirptr->conn;
1034 pathlen = strlen(dirptr->path);
1035 slashlen = ( dirptr->path[pathlen-1] != '/') ? 1 : 0;
1040 SMB_STRUCT_STAT sbuf;
1044 char *pathreal = NULL;
1045 struct smb_filename smb_fname;
1049 cur_offset = dptr_TellDir(dirptr);
1050 prev_offset = cur_offset;
1051 dname = dptr_ReadDirName(ctx, dirptr, &cur_offset, &sbuf);
1053 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
1054 (long)dirptr, cur_offset));
1056 if (dname == NULL) {
1060 isdots = (ISDOT(dname) || ISDOTDOT(dname));
1061 if (dont_descend && !isdots) {
1067 * fname may get mangled, dname is never mangled.
1068 * Whenever we're accessing the filesystem we use
1069 * pathreal which is composed from dname.
1072 ok = match_fn(ctx, private_data, dname, mask, &fname);
1080 * pathreal = talloc_asprintf(ctx, "%s%s%s", dirptr->path,
1081 * needslash?"/":"", dname);
1082 * but this was measurably slower than doing the memcpy.
1085 pathreal = talloc_array(
1087 pathlen + slashlen + talloc_get_size(dname));
1094 memcpy(pathreal, dirptr->path, pathlen);
1095 pathreal[pathlen] = '/';
1096 memcpy(pathreal + slashlen + pathlen, dname,
1097 talloc_get_size(dname));
1099 /* Create smb_fname with NULL stream_name. */
1100 ZERO_STRUCT(smb_fname);
1101 smb_fname.base_name = pathreal;
1102 smb_fname.st = sbuf;
1104 ok = mode_fn(ctx, private_data, &smb_fname, &mode);
1108 TALLOC_FREE(pathreal);
1112 if (!dir_check_ftype(conn, mode, dirtype)) {
1113 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1114 fname, (unsigned int)mode, (unsigned int)dirtype));
1117 TALLOC_FREE(pathreal);
1121 if (ask_sharemode) {
1122 struct timespec write_time_ts;
1123 struct file_id fileid;
1125 fileid = vfs_file_id_from_sbuf(conn,
1127 get_file_infos(fileid, 0, NULL, &write_time_ts);
1128 if (!null_timespec(write_time_ts)) {
1129 update_stat_ex_mtime(&smb_fname.st,
1134 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1136 mask, smb_fname_str_dbg(&smb_fname),
1139 DirCacheAdd(dirptr->dir_hnd, dname, cur_offset);
1143 *_smb_fname = cp_smb_filename(ctx, &smb_fname);
1144 TALLOC_FREE(pathreal);
1145 if (*_smb_fname == NULL) {
1150 *_prev_offset = prev_offset;
1158 /****************************************************************************
1159 Get an 8.3 directory entry.
1160 ****************************************************************************/
1162 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX *ctx,
1168 connection_struct *conn = (connection_struct *)private_data;
1170 if ((strcmp(mask,"*.*") == 0) ||
1171 mask_match_search(dname, mask, false) ||
1172 mangle_mask_match(conn, dname, mask)) {
1176 if (!mangle_is_8_3(dname, false, conn->params)) {
1177 bool ok = name_to_8_3(dname, mname, false,
1187 *_fname = talloc_strdup(ctx, fname);
1188 if (*_fname == NULL) {
1198 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX *ctx,
1200 struct smb_filename *smb_fname,
1203 connection_struct *conn = (connection_struct *)private_data;
1205 if (!VALID_STAT(smb_fname->st)) {
1206 if ((SMB_VFS_STAT(conn, smb_fname)) != 0) {
1207 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1208 "Couldn't stat [%s]. Error "
1210 smb_fname_str_dbg(smb_fname),
1216 *_mode = dos_mode(conn, smb_fname);
1220 bool get_dir_entry(TALLOC_CTX *ctx,
1221 struct dptr_struct *dirptr,
1227 struct timespec *_date,
1231 connection_struct *conn = dirptr->conn;
1233 struct smb_filename *smb_fname = NULL;
1238 ok = smbd_dirptr_get_entry(ctx,
1244 smbd_dirptr_8_3_match_fn,
1245 smbd_dirptr_8_3_mode_fn,
1255 *_fname = talloc_move(ctx, &fname);
1256 *_size = smb_fname->st.st_ex_size;
1258 *_date = smb_fname->st.st_ex_mtime;
1259 TALLOC_FREE(smb_fname);
1263 /*******************************************************************
1264 Check to see if a user can read a file. This is only approximate,
1265 it is used as part of the "hide unreadable" option. Don't
1266 use it for anything security sensitive.
1267 ********************************************************************/
1269 static bool user_can_read_file(connection_struct *conn,
1270 struct smb_filename *smb_fname)
1273 * Never hide files from the root user.
1274 * We use (uid_t)0 here not sec_initial_uid()
1275 * as make test uses a single user context.
1278 if (get_current_uid(conn) == (uid_t)0) {
1282 return NT_STATUS_IS_OK(smbd_check_access_rights(conn,
1288 /*******************************************************************
1289 Check to see if a user can write a file (and only files, we do not
1290 check dirs on this one). This is only approximate,
1291 it is used as part of the "hide unwriteable" option. Don't
1292 use it for anything security sensitive.
1293 ********************************************************************/
1295 static bool user_can_write_file(connection_struct *conn,
1296 const struct smb_filename *smb_fname)
1299 * Never hide files from the root user.
1300 * We use (uid_t)0 here not sec_initial_uid()
1301 * as make test uses a single user context.
1304 if (get_current_uid(conn) == (uid_t)0) {
1308 SMB_ASSERT(VALID_STAT(smb_fname->st));
1310 /* Pseudo-open the file */
1312 if(S_ISDIR(smb_fname->st.st_ex_mode)) {
1316 return can_write_to_file(conn, smb_fname);
1319 /*******************************************************************
1320 Is a file a "special" type ?
1321 ********************************************************************/
1323 static bool file_is_special(connection_struct *conn,
1324 const struct smb_filename *smb_fname)
1327 * Never hide files from the root user.
1328 * We use (uid_t)0 here not sec_initial_uid()
1329 * as make test uses a single user context.
1332 if (get_current_uid(conn) == (uid_t)0) {
1336 SMB_ASSERT(VALID_STAT(smb_fname->st));
1338 if (S_ISREG(smb_fname->st.st_ex_mode) ||
1339 S_ISDIR(smb_fname->st.st_ex_mode) ||
1340 S_ISLNK(smb_fname->st.st_ex_mode))
1346 /*******************************************************************
1347 Should the file be seen by the client?
1348 NOTE: A successful return is no guarantee of the file's existence.
1349 ********************************************************************/
1351 bool is_visible_file(connection_struct *conn, const char *dir_path,
1352 const char *name, SMB_STRUCT_STAT *pst, bool use_veto)
1354 bool hide_unreadable = lp_hideunreadable(SNUM(conn));
1355 bool hide_unwriteable = lp_hideunwriteable_files(SNUM(conn));
1356 bool hide_special = lp_hide_special_files(SNUM(conn));
1358 struct smb_filename *smb_fname_base = NULL;
1362 if ((strcmp(".",name) == 0) || (strcmp("..",name) == 0)) {
1363 return True; /* . and .. are always visible. */
1366 /* If it's a vetoed file, pretend it doesn't even exist */
1367 if (use_veto && IS_VETO_PATH(conn, name)) {
1368 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name ));
1372 if (hide_unreadable || hide_unwriteable || hide_special) {
1373 entry = talloc_asprintf(talloc_tos(), "%s/%s", dir_path, name);
1379 /* Create an smb_filename with stream_name == NULL. */
1380 status = create_synthetic_smb_fname(talloc_tos(), entry, NULL,
1381 pst, &smb_fname_base);
1382 if (!NT_STATUS_IS_OK(status)) {
1387 /* If the file name does not exist, there's no point checking
1388 * the configuration options. We succeed, on the basis that the
1389 * checks *might* have passed if the file was present.
1391 if (!VALID_STAT(*pst)) {
1392 if (SMB_VFS_STAT(conn, smb_fname_base) != 0) {
1396 *pst = smb_fname_base->st;
1400 /* Honour _hide unreadable_ option */
1401 if (hide_unreadable &&
1402 !user_can_read_file(conn, smb_fname_base)) {
1403 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1408 /* Honour _hide unwriteable_ option */
1409 if (hide_unwriteable && !user_can_write_file(conn,
1411 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1416 /* Honour _hide_special_ option */
1417 if (hide_special && file_is_special(conn, smb_fname_base)) {
1418 DEBUG(10,("is_visible_file: file %s is special.\n",
1427 TALLOC_FREE(smb_fname_base);
1432 static int smb_Dir_destructor(struct smb_Dir *dirp)
1434 if (dirp->dir != NULL) {
1435 SMB_VFS_CLOSEDIR(dirp->conn,dirp->dir);
1436 if (dirp->fsp != NULL) {
1438 * The SMB_VFS_CLOSEDIR above
1439 * closes the underlying fd inside
1442 dirp->fsp->fh->fd = -1;
1443 if (dirp->fsp->dptr != NULL) {
1444 SMB_ASSERT(dirp->fsp->dptr->dir_hnd == dirp);
1445 dirp->fsp->dptr->dir_hnd = NULL;
1450 if (dirp->conn->sconn && !dirp->conn->sconn->using_smb2) {
1451 dirp->conn->sconn->searches.dirhandles_open--;
1456 /*******************************************************************
1458 ********************************************************************/
1460 struct smb_Dir *OpenDir(TALLOC_CTX *mem_ctx, connection_struct *conn,
1465 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1466 struct smbd_server_connection *sconn = conn->sconn;
1473 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1475 dirp->dir_path = talloc_strdup(dirp, name);
1476 if (!dirp->dir_path) {
1481 if (sconn && !sconn->using_smb2) {
1482 sconn->searches.dirhandles_open++;
1484 talloc_set_destructor(dirp, smb_Dir_destructor);
1486 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1488 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp->dir_path,
1500 /*******************************************************************
1501 Open a directory from an fsp.
1502 ********************************************************************/
1504 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
1509 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1510 struct smbd_server_connection *sconn = conn->sconn;
1517 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1519 dirp->dir_path = talloc_strdup(dirp, fsp->fsp_name->base_name);
1520 if (!dirp->dir_path) {
1525 if (sconn && !sconn->using_smb2) {
1526 sconn->searches.dirhandles_open++;
1528 talloc_set_destructor(dirp, smb_Dir_destructor);
1530 if (fsp->is_directory && fsp->fh->fd != -1) {
1531 dirp->dir = SMB_VFS_FDOPENDIR(fsp, mask, attr);
1532 if (dirp->dir != NULL) {
1535 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1539 if (errno != ENOSYS) {
1545 if (dirp->dir == NULL) {
1546 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1547 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1551 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp->dir_path,
1564 /*******************************************************************
1565 Read from a directory.
1566 Return directory entry, current offset, and optional stat information.
1567 Don't check for veto or invisible files.
1568 ********************************************************************/
1570 const char *ReadDirName(struct smb_Dir *dirp, long *poffset,
1571 SMB_STRUCT_STAT *sbuf, char **ptalloced)
1574 char *talloced = NULL;
1575 connection_struct *conn = dirp->conn;
1577 /* Cheat to allow . and .. to be the first entries returned. */
1578 if (((*poffset == START_OF_DIRECTORY_OFFSET) ||
1579 (*poffset == DOT_DOT_DIRECTORY_OFFSET)) && (dirp->file_number < 2))
1581 if (dirp->file_number == 0) {
1583 *poffset = dirp->offset = START_OF_DIRECTORY_OFFSET;
1586 *poffset = dirp->offset = DOT_DOT_DIRECTORY_OFFSET;
1588 dirp->file_number++;
1591 } else if (*poffset == END_OF_DIRECTORY_OFFSET) {
1592 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1595 /* A real offset, seek to it. */
1596 SeekDir(dirp, *poffset);
1599 while ((n = vfs_readdirname(conn, dirp->dir, sbuf, &talloced))) {
1600 /* Ignore . and .. - we've already returned them. */
1602 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
1603 TALLOC_FREE(talloced);
1607 *poffset = dirp->offset = SMB_VFS_TELLDIR(conn, dirp->dir);
1608 *ptalloced = talloced;
1609 dirp->file_number++;
1612 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1617 /*******************************************************************
1618 Rewind to the start.
1619 ********************************************************************/
1621 void RewindDir(struct smb_Dir *dirp, long *poffset)
1623 SMB_VFS_REWINDDIR(dirp->conn, dirp->dir);
1624 dirp->file_number = 0;
1625 dirp->offset = START_OF_DIRECTORY_OFFSET;
1626 *poffset = START_OF_DIRECTORY_OFFSET;
1629 /*******************************************************************
1631 ********************************************************************/
1633 void SeekDir(struct smb_Dir *dirp, long offset)
1635 if (offset != dirp->offset) {
1636 if (offset == START_OF_DIRECTORY_OFFSET) {
1637 RewindDir(dirp, &offset);
1639 * Ok we should really set the file number here
1640 * to 1 to enable ".." to be returned next. Trouble
1641 * is I'm worried about callers using SeekDir(dirp,0)
1642 * as equivalent to RewindDir(). So leave this alone
1645 } else if (offset == DOT_DOT_DIRECTORY_OFFSET) {
1646 RewindDir(dirp, &offset);
1648 * Set the file number to 2 - we want to get the first
1649 * real file entry (the one we return after "..")
1650 * on the next ReadDir.
1652 dirp->file_number = 2;
1653 } else if (offset == END_OF_DIRECTORY_OFFSET) {
1654 ; /* Don't seek in this case. */
1656 SMB_VFS_SEEKDIR(dirp->conn, dirp->dir, offset);
1658 dirp->offset = offset;
1662 /*******************************************************************
1663 Tell a dir position.
1664 ********************************************************************/
1666 long TellDir(struct smb_Dir *dirp)
1668 return(dirp->offset);
1671 /*******************************************************************
1672 Add an entry into the dcache.
1673 ********************************************************************/
1675 static void DirCacheAdd(struct smb_Dir *dirp, const char *name, long offset)
1677 struct name_cache_entry *e;
1679 if (dirp->name_cache_size == 0) {
1683 if (dirp->name_cache == NULL) {
1684 dirp->name_cache = talloc_zero_array(
1685 dirp, struct name_cache_entry, dirp->name_cache_size);
1687 if (dirp->name_cache == NULL) {
1692 dirp->name_cache_index = (dirp->name_cache_index+1) %
1693 dirp->name_cache_size;
1694 e = &dirp->name_cache[dirp->name_cache_index];
1695 TALLOC_FREE(e->name);
1696 e->name = talloc_strdup(dirp, name);
1700 /*******************************************************************
1701 Find an entry by name. Leave us at the offset after it.
1702 Don't check for veto or invisible files.
1703 ********************************************************************/
1705 bool SearchDir(struct smb_Dir *dirp, const char *name, long *poffset)
1708 const char *entry = NULL;
1709 char *talloced = NULL;
1710 connection_struct *conn = dirp->conn;
1712 /* Search back in the name cache. */
1713 if (dirp->name_cache_size && dirp->name_cache) {
1714 for (i = dirp->name_cache_index; i >= 0; i--) {
1715 struct name_cache_entry *e = &dirp->name_cache[i];
1716 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1717 *poffset = e->offset;
1718 SeekDir(dirp, e->offset);
1722 for (i = dirp->name_cache_size - 1; i > dirp->name_cache_index; i--) {
1723 struct name_cache_entry *e = &dirp->name_cache[i];
1724 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1725 *poffset = e->offset;
1726 SeekDir(dirp, e->offset);
1732 /* Not found in the name cache. Rewind directory and start from scratch. */
1733 SMB_VFS_REWINDDIR(conn, dirp->dir);
1734 dirp->file_number = 0;
1735 *poffset = START_OF_DIRECTORY_OFFSET;
1736 while ((entry = ReadDirName(dirp, poffset, NULL, &talloced))) {
1737 if (conn->case_sensitive ? (strcmp(entry, name) == 0) : strequal(entry, name)) {
1738 TALLOC_FREE(talloced);
1741 TALLOC_FREE(talloced);
1746 /*****************************************************************
1747 Is this directory empty ?
1748 *****************************************************************/
1750 NTSTATUS can_delete_directory_fsp(files_struct *fsp)
1752 NTSTATUS status = NT_STATUS_OK;
1754 const char *dname = NULL;
1755 const char *dirname = fsp->fsp_name->base_name;
1756 char *talloced = NULL;
1758 struct connection_struct *conn = fsp->conn;
1759 struct smb_Dir *dir_hnd = OpenDir_fsp(talloc_tos(),
1766 return map_nt_error_from_unix(errno);
1769 while ((dname = ReadDirName(dir_hnd, &dirpos, &st, &talloced))) {
1770 /* Quick check for "." and ".." */
1771 if (dname[0] == '.') {
1772 if (!dname[1] || (dname[1] == '.' && !dname[2])) {
1773 TALLOC_FREE(talloced);
1778 if (!is_visible_file(conn, dirname, dname, &st, True)) {
1779 TALLOC_FREE(talloced);
1783 DEBUG(10,("got name %s - can't delete\n",
1785 status = NT_STATUS_DIRECTORY_NOT_EMPTY;
1788 TALLOC_FREE(talloced);
1789 TALLOC_FREE(dir_hnd);