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 /* "Special" directory offsets in 32-bit wire format. */
38 #define WIRE_END_OF_DIRECTORY_OFFSET ((uint32_t)0xFFFFFFFF)
39 #define WIRE_START_OF_DIRECTORY_OFFSET ((uint32_t)0)
40 #define WIRE_DOT_DOT_DIRECTORY_OFFSET ((uint32_t)0x80000000)
42 /* Make directory handle internals available. */
44 struct name_cache_entry
{
50 connection_struct
*conn
;
54 size_t name_cache_size
;
55 struct name_cache_entry
*name_cache
;
56 unsigned int name_cache_index
;
57 unsigned int file_number
;
58 files_struct
*fsp
; /* Back pointer to containing fsp, only
59 set from OpenDir_fsp(). */
63 struct dptr_struct
*next
, *prev
;
66 struct connection_struct
*conn
;
67 struct smb_Dir
*dir_hnd
;
72 bool has_wild
; /* Set to true if the wcard entry has MS wildcard characters in it. */
73 bool did_stat
; /* Optimisation for non-wcard searches. */
74 bool priv
; /* Directory handle opened with privilege. */
77 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
82 static void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
);
84 #define INVALID_DPTR_KEY (-3)
86 /****************************************************************************
88 ****************************************************************************/
90 bool make_dir_struct(TALLOC_CTX
*ctx
,
100 char *mask2
= talloc_strdup(ctx
, mask
);
106 if ((mode
& FILE_ATTRIBUTE_DIRECTORY
) != 0) {
110 memset(buf
+1,' ',11);
111 if ((p
= strchr_m(mask2
,'.')) != NULL
) {
113 push_ascii(buf
+1,mask2
,8, 0);
114 push_ascii(buf
+9,p
+1,3, 0);
117 push_ascii(buf
+1,mask2
,11, 0);
120 memset(buf
+21,'\0',DIR_STRUCT_SIZE
-21);
122 srv_put_dos_date(buf
,22,date
);
123 SSVAL(buf
,26,size
& 0xFFFF);
124 SSVAL(buf
,28,(size
>> 16)&0xFFFF);
125 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
126 Strange, but verified on W2K3. Needed for OS/2. JRA. */
127 push_ascii(buf
+30,fname
,12, uc
? STR_UPPER
: 0);
128 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf
+30, fname
));
132 /****************************************************************************
133 Initialise the dir bitmap.
134 ****************************************************************************/
136 bool init_dptrs(struct smbd_server_connection
*sconn
)
138 if (sconn
->searches
.dptr_bmap
) {
142 sconn
->searches
.dptr_bmap
= bitmap_talloc(
143 sconn
, MAX_DIRECTORY_HANDLES
);
145 if (sconn
->searches
.dptr_bmap
== NULL
) {
152 /****************************************************************************
153 Idle a dptr - the directory is closed but the control info is kept.
154 ****************************************************************************/
156 static void dptr_idle(struct dptr_struct
*dptr
)
159 DEBUG(4,("Idling dptr dnum %d\n",dptr
->dnum
));
160 TALLOC_FREE(dptr
->dir_hnd
);
164 /****************************************************************************
165 Idle the oldest dptr.
166 ****************************************************************************/
168 static void dptr_idleoldest(struct smbd_server_connection
*sconn
)
170 struct dptr_struct
*dptr
;
173 * Go to the end of the list.
175 dptr
= DLIST_TAIL(sconn
->searches
.dirptrs
);
178 DEBUG(0,("No dptrs available to idle ?\n"));
183 * Idle the oldest pointer.
186 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
194 /****************************************************************************
195 Get the struct dptr_struct for a dir index.
196 ****************************************************************************/
198 static struct dptr_struct
*dptr_get(struct smbd_server_connection
*sconn
,
199 int key
, bool forclose
)
201 struct dptr_struct
*dptr
;
203 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
204 if(dptr
->dnum
== key
) {
205 if (!forclose
&& !dptr
->dir_hnd
) {
206 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
)
207 dptr_idleoldest(sconn
);
208 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key
));
209 if (!(dptr
->dir_hnd
= OpenDir(
210 NULL
, dptr
->conn
, dptr
->path
,
211 dptr
->wcard
, dptr
->attr
))) {
212 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr
->path
,
217 DLIST_PROMOTE(sconn
->searches
.dirptrs
,dptr
);
224 /****************************************************************************
225 Get the dir path for a dir index.
226 ****************************************************************************/
228 const char *dptr_path(struct smbd_server_connection
*sconn
, int key
)
230 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
236 /****************************************************************************
237 Get the dir wcard for a dir index.
238 ****************************************************************************/
240 const char *dptr_wcard(struct smbd_server_connection
*sconn
, int key
)
242 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
248 /****************************************************************************
249 Get the dir attrib for a dir index.
250 ****************************************************************************/
252 uint16
dptr_attr(struct smbd_server_connection
*sconn
, int key
)
254 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
260 /****************************************************************************
261 Close a dptr (internal func).
262 ****************************************************************************/
264 static void dptr_close_internal(struct dptr_struct
*dptr
)
266 struct smbd_server_connection
*sconn
= dptr
->conn
->sconn
;
268 DEBUG(4,("closing dptr key %d\n",dptr
->dnum
));
274 if (sconn
->using_smb2
) {
278 DLIST_REMOVE(sconn
->searches
.dirptrs
, dptr
);
281 * Free the dnum in the bitmap. Remember the dnum value is always
282 * biased by one with respect to the bitmap.
285 if (!bitmap_query(sconn
->searches
.dptr_bmap
, dptr
->dnum
- 1)) {
286 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
290 bitmap_clear(sconn
->searches
.dptr_bmap
, dptr
->dnum
- 1);
293 TALLOC_FREE(dptr
->dir_hnd
);
297 /****************************************************************************
298 Close a dptr given a key.
299 ****************************************************************************/
301 void dptr_close(struct smbd_server_connection
*sconn
, int *key
)
303 struct dptr_struct
*dptr
;
305 if(*key
== INVALID_DPTR_KEY
)
308 /* OS/2 seems to use -1 to indicate "close all directories" */
310 struct dptr_struct
*next
;
311 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
313 dptr_close_internal(dptr
);
315 *key
= INVALID_DPTR_KEY
;
319 dptr
= dptr_get(sconn
, *key
, true);
322 DEBUG(0,("Invalid key %d given to dptr_close\n", *key
));
326 dptr_close_internal(dptr
);
328 *key
= INVALID_DPTR_KEY
;
331 /****************************************************************************
332 Close all dptrs for a cnum.
333 ****************************************************************************/
335 void dptr_closecnum(connection_struct
*conn
)
337 struct dptr_struct
*dptr
, *next
;
338 struct smbd_server_connection
*sconn
= conn
->sconn
;
344 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
346 if (dptr
->conn
== conn
) {
347 dptr_close_internal(dptr
);
352 /****************************************************************************
353 Idle all dptrs for a cnum.
354 ****************************************************************************/
356 void dptr_idlecnum(connection_struct
*conn
)
358 struct dptr_struct
*dptr
;
359 struct smbd_server_connection
*sconn
= conn
->sconn
;
365 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
366 if (dptr
->conn
== conn
&& dptr
->dir_hnd
) {
372 /****************************************************************************
373 Close a dptr that matches a given path, only if it matches the spid also.
374 ****************************************************************************/
376 void dptr_closepath(struct smbd_server_connection
*sconn
,
377 char *path
,uint16 spid
)
379 struct dptr_struct
*dptr
, *next
;
380 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
382 if (spid
== dptr
->spid
&& strequal(dptr
->path
,path
))
383 dptr_close_internal(dptr
);
387 /****************************************************************************
388 Try and close the oldest handle not marked for
389 expect close in the hope that the client has
390 finished with that one.
391 ****************************************************************************/
393 static void dptr_close_oldest(struct smbd_server_connection
*sconn
,
396 struct dptr_struct
*dptr
;
399 * Go to the end of the list.
401 for(dptr
= sconn
->searches
.dirptrs
; dptr
&& dptr
->next
; dptr
= dptr
->next
)
405 DEBUG(0,("No old dptrs available to close oldest ?\n"));
410 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
411 * does not have expect_close set. If 'old' is false, close
412 * one of the new dnum handles.
415 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
416 if ((old
&& (dptr
->dnum
< 256) && !dptr
->expect_close
) ||
417 (!old
&& (dptr
->dnum
> 255))) {
418 dptr_close_internal(dptr
);
424 /****************************************************************************
425 Safely do an OpenDir as root, ensuring we're in the right place.
426 ****************************************************************************/
428 static struct smb_Dir
*open_dir_with_privilege(connection_struct
*conn
,
429 struct smb_request
*req
,
434 struct smb_Dir
*dir_hnd
= NULL
;
435 struct smb_filename
*smb_fname_cwd
;
436 char *saved_dir
= vfs_GetWd(talloc_tos(), conn
);
437 struct privilege_paths
*priv_paths
= req
->priv_paths
;
440 if (saved_dir
== NULL
) {
444 if (vfs_ChDir(conn
, path
) == -1) {
448 /* Now check the stat value is the same. */
449 smb_fname_cwd
= synthetic_smb_fname(talloc_tos(), ".", NULL
, NULL
);
451 if (smb_fname_cwd
== NULL
) {
454 ret
= SMB_VFS_STAT(conn
, smb_fname_cwd
);
459 if (!check_same_stat(&smb_fname_cwd
->st
, &priv_paths
->parent_name
.st
)) {
460 DEBUG(0,("open_dir_with_privilege: stat mismatch between %s "
463 smb_fname_str_dbg(&priv_paths
->parent_name
)));
467 dir_hnd
= OpenDir(NULL
, conn
, ".", wcard
, attr
);
471 vfs_ChDir(conn
, saved_dir
);
475 /****************************************************************************
476 Create a new dir ptr. If the flag old_handle is true then we must allocate
477 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
478 one byte long. If old_handle is false we allocate from the range
479 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
480 a directory handle is never zero.
481 wcard must not be zero.
482 ****************************************************************************/
484 NTSTATUS
dptr_create(connection_struct
*conn
,
485 struct smb_request
*req
,
487 const char *path
, bool old_handle
, bool expect_close
,uint16 spid
,
488 const char *wcard
, bool wcard_has_wild
, uint32 attr
, struct dptr_struct
**dptr_ret
)
490 struct smbd_server_connection
*sconn
= conn
->sconn
;
491 struct dptr_struct
*dptr
= NULL
;
492 struct smb_Dir
*dir_hnd
;
494 if (fsp
&& fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
495 path
= fsp
->fsp_name
->base_name
;
498 DEBUG(5,("dptr_create dir=%s\n", path
));
501 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
502 return NT_STATUS_INTERNAL_ERROR
;
506 return NT_STATUS_INVALID_PARAMETER
;
510 if (!(fsp
->access_mask
& SEC_DIR_LIST
)) {
511 DEBUG(5,("dptr_create: directory %s "
512 "not open for LIST access\n",
514 return NT_STATUS_ACCESS_DENIED
;
516 dir_hnd
= OpenDir_fsp(NULL
, conn
, fsp
, wcard
, attr
);
519 bool backup_intent
= (req
&& req
->priv_paths
);
520 struct smb_filename
*smb_dname
;
523 smb_dname
= synthetic_smb_fname(talloc_tos(), path
,
525 if (smb_dname
== NULL
) {
526 return NT_STATUS_NO_MEMORY
;
528 if (lp_posix_pathnames()) {
529 ret
= SMB_VFS_LSTAT(conn
, smb_dname
);
531 ret
= SMB_VFS_STAT(conn
, smb_dname
);
534 return map_nt_error_from_unix(errno
);
536 if (!S_ISDIR(smb_dname
->st
.st_ex_mode
)) {
537 return NT_STATUS_NOT_A_DIRECTORY
;
539 status
= smbd_check_access_rights(conn
,
543 if (!NT_STATUS_IS_OK(status
)) {
547 dir_hnd
= open_dir_with_privilege(conn
,
553 dir_hnd
= OpenDir(NULL
, conn
, path
, wcard
, attr
);
558 return map_nt_error_from_unix(errno
);
561 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
) {
562 dptr_idleoldest(sconn
);
565 dptr
= talloc(NULL
, struct dptr_struct
);
567 DEBUG(0,("talloc fail in dptr_create.\n"));
568 TALLOC_FREE(dir_hnd
);
569 return NT_STATUS_NO_MEMORY
;
574 dptr
->path
= talloc_strdup(dptr
, path
);
577 TALLOC_FREE(dir_hnd
);
578 return NT_STATUS_NO_MEMORY
;
581 dptr
->dir_hnd
= dir_hnd
;
583 dptr
->expect_close
= expect_close
;
584 dptr
->wcard
= talloc_strdup(dptr
, wcard
);
587 TALLOC_FREE(dir_hnd
);
588 return NT_STATUS_NO_MEMORY
;
590 if (lp_posix_pathnames() || (wcard
[0] == '.' && wcard
[1] == 0)) {
591 dptr
->has_wild
= True
;
593 dptr
->has_wild
= wcard_has_wild
;
598 if (sconn
->using_smb2
) {
605 * This is an old-style SMBsearch request. Ensure the
606 * value we return will fit in the range 1-255.
609 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
611 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
614 * Try and close the oldest handle not marked for
615 * expect close in the hope that the client has
616 * finished with that one.
619 dptr_close_oldest(sconn
, true);
621 /* Now try again... */
622 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
623 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
624 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr
->dnum
));
626 TALLOC_FREE(dir_hnd
);
627 return NT_STATUS_TOO_MANY_OPENED_FILES
;
633 * This is a new-style trans2 request. Allocate from
634 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
637 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
639 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
642 * Try and close the oldest handle close in the hope that
643 * the client has finished with that one. This will only
644 * happen in the case of the Win98 client bug where it leaks
648 dptr_close_oldest(sconn
, false);
650 /* Now try again... */
651 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
653 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
654 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr
->dnum
));
656 TALLOC_FREE(dir_hnd
);
657 return NT_STATUS_TOO_MANY_OPENED_FILES
;
662 bitmap_set(sconn
->searches
.dptr_bmap
, dptr
->dnum
);
664 dptr
->dnum
+= 1; /* Always bias the dnum by one - no zero dnums allowed. */
666 DLIST_ADD(sconn
->searches
.dirptrs
, dptr
);
669 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
670 dptr
->dnum
,path
,expect_close
));
678 /****************************************************************************
679 Wrapper functions to access the lower level directory handles.
680 ****************************************************************************/
682 void dptr_CloseDir(files_struct
*fsp
)
686 * The destructor for the struct smb_Dir
687 * (fsp->dptr->dir_hnd) now handles
688 * all resource deallocation.
690 dptr_close_internal(fsp
->dptr
);
695 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
697 SeekDir(dptr
->dir_hnd
, offset
);
700 long dptr_TellDir(struct dptr_struct
*dptr
)
702 return TellDir(dptr
->dir_hnd
);
705 bool dptr_has_wild(struct dptr_struct
*dptr
)
707 return dptr
->has_wild
;
710 int dptr_dnum(struct dptr_struct
*dptr
)
715 bool dptr_get_priv(struct dptr_struct
*dptr
)
720 void dptr_set_priv(struct dptr_struct
*dptr
)
725 /****************************************************************************
726 Return the next visible file name, skipping veto'd and invisible files.
727 ****************************************************************************/
729 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
,
730 long *poffset
, SMB_STRUCT_STAT
*pst
,
733 /* Normal search for the next file. */
735 char *talloced
= NULL
;
737 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
, pst
, &talloced
))
739 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
740 *ptalloced
= talloced
;
743 TALLOC_FREE(talloced
);
748 /****************************************************************************
749 Return the next visible file name, skipping veto'd and invisible files.
750 ****************************************************************************/
752 char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
753 struct dptr_struct
*dptr
,
755 SMB_STRUCT_STAT
*pst
)
757 struct smb_filename smb_fname_base
;
759 const char *name_temp
= NULL
;
760 char *talloced
= NULL
;
761 char *pathreal
= NULL
;
762 char *found_name
= NULL
;
765 SET_STAT_INVALID(*pst
);
767 if (dptr
->has_wild
|| dptr
->did_stat
) {
768 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
,
770 if (name_temp
== NULL
) {
773 if (talloced
!= NULL
) {
774 return talloc_move(ctx
, &talloced
);
776 return talloc_strdup(ctx
, name_temp
);
779 /* If poffset is -1 then we know we returned this name before and we
780 * have no wildcards. We're at the end of the directory. */
781 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
785 /* We know the stored wcard contains no wildcard characters.
786 * See if we can match with a stat call. If we can't, then set
787 * did_stat to true to ensure we only do this once and keep
790 dptr
->did_stat
= true;
792 /* First check if it should be visible. */
793 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
,
796 /* This only returns false if the file was found, but
797 is explicitly not visible. Set us to end of
798 directory, but return NULL as we know we can't ever
803 if (VALID_STAT(*pst
)) {
804 name
= talloc_strdup(ctx
, dptr
->wcard
);
808 pathreal
= talloc_asprintf(ctx
,
815 /* Create an smb_filename with stream_name == NULL. */
816 ZERO_STRUCT(smb_fname_base
);
817 smb_fname_base
.base_name
= pathreal
;
819 if (SMB_VFS_STAT(dptr
->conn
, &smb_fname_base
) == 0) {
820 *pst
= smb_fname_base
.st
;
821 name
= talloc_strdup(ctx
, dptr
->wcard
);
824 /* If we get any other error than ENOENT or ENOTDIR
825 then the file exists we just can't stat it. */
826 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
827 name
= talloc_strdup(ctx
, dptr
->wcard
);
832 /* Stat failed. We know this is authoratiative if we are
833 * providing case sensitive semantics or the underlying
834 * filesystem is case sensitive.
836 if (dptr
->conn
->case_sensitive
||
837 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
))
843 * Try case-insensitive stat if the fs has the ability. This avoids
844 * scanning the whole directory.
846 ret
= SMB_VFS_GET_REAL_FILENAME(dptr
->conn
, dptr
->path
, dptr
->wcard
,
851 } else if (errno
== ENOENT
) {
852 /* The case-insensitive lookup was authoritative. */
856 TALLOC_FREE(pathreal
);
858 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
, &talloced
);
859 if (name_temp
== NULL
) {
862 if (talloced
!= NULL
) {
863 return talloc_move(ctx
, &talloced
);
865 return talloc_strdup(ctx
, name_temp
);
868 TALLOC_FREE(pathreal
);
870 /* We need to set the underlying dir_hnd offset to -1
871 * also as this function is usually called with the
872 * output from TellDir. */
873 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
877 /****************************************************************************
878 Search for a file by name, skipping veto'ed and not visible files.
879 ****************************************************************************/
881 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
883 SET_STAT_INVALID(*pst
);
885 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
886 /* This is a singleton directory and we're already at the end. */
887 *poffset
= END_OF_DIRECTORY_OFFSET
;
891 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
894 /****************************************************************************
895 Initialize variables & state data at the beginning of all search SMB requests.
896 ****************************************************************************/
897 void dptr_init_search_op(struct dptr_struct
*dptr
)
899 SMB_VFS_INIT_SEARCH_OP(dptr
->conn
, dptr
->dir_hnd
->dir
);
902 /****************************************************************************
903 Map a native directory offset to a 32-bit cookie.
904 ****************************************************************************/
906 static uint32_t map_dir_offset_to_wire(struct dptr_struct
*dptr
, long offset
)
908 if (offset
== END_OF_DIRECTORY_OFFSET
) {
909 return WIRE_END_OF_DIRECTORY_OFFSET
;
910 } else if(offset
== START_OF_DIRECTORY_OFFSET
) {
911 return WIRE_START_OF_DIRECTORY_OFFSET
;
912 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
913 return WIRE_DOT_DOT_DIRECTORY_OFFSET
;
915 return (uint32_t)offset
;
918 /****************************************************************************
919 Fill the 5 byte server reserved dptr field.
920 ****************************************************************************/
922 bool dptr_fill(struct smbd_server_connection
*sconn
,
923 char *buf1
,unsigned int key
)
925 unsigned char *buf
= (unsigned char *)buf1
;
926 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
927 uint32_t wire_offset
;
929 DEBUG(1,("filling null dirptr %d\n",key
));
932 wire_offset
= map_dir_offset_to_wire(dptr
,TellDir(dptr
->dir_hnd
));
933 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
934 (long)dptr
->dir_hnd
,(int)wire_offset
));
936 SIVAL(buf
,1,wire_offset
);
940 /****************************************************************************
941 Map a 32-bit wire cookie to a native directory offset.
942 ****************************************************************************/
944 static long map_wire_to_dir_offset(struct dptr_struct
*dptr
, uint32_t wire_offset
)
946 if (wire_offset
== WIRE_END_OF_DIRECTORY_OFFSET
) {
947 return END_OF_DIRECTORY_OFFSET
;
948 } else if(wire_offset
== WIRE_START_OF_DIRECTORY_OFFSET
) {
949 return START_OF_DIRECTORY_OFFSET
;
950 } else if (wire_offset
== WIRE_DOT_DOT_DIRECTORY_OFFSET
) {
951 return DOT_DOT_DIRECTORY_OFFSET
;
953 return (long)wire_offset
;
956 /****************************************************************************
957 Fetch the dir ptr and seek it given the 5 byte server field.
958 ****************************************************************************/
960 struct dptr_struct
*dptr_fetch(struct smbd_server_connection
*sconn
,
963 unsigned int key
= *(unsigned char *)buf
;
964 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
965 uint32_t wire_offset
;
969 DEBUG(3,("fetched null dirptr %d\n",key
));
973 wire_offset
= IVAL(buf
,1);
974 seekoff
= map_wire_to_dir_offset(dptr
, wire_offset
);
975 SeekDir(dptr
->dir_hnd
,seekoff
);
976 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
977 key
, dptr
->path
, (int)seekoff
));
981 /****************************************************************************
983 ****************************************************************************/
985 struct dptr_struct
*dptr_fetch_lanman2(struct smbd_server_connection
*sconn
,
988 struct dptr_struct
*dptr
= dptr_get(sconn
, dptr_num
, false);
991 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
994 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr
->path
));
998 static bool mangle_mask_match(connection_struct
*conn
,
999 const char *filename
,
1004 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
1007 return mask_match_search(mname
,mask
,False
);
1010 bool smbd_dirptr_get_entry(TALLOC_CTX
*ctx
,
1011 struct dptr_struct
*dirptr
,
1016 bool (*match_fn
)(TALLOC_CTX
*ctx
,
1021 bool (*mode_fn
)(TALLOC_CTX
*ctx
,
1023 struct smb_filename
*smb_fname
,
1027 struct smb_filename
**_smb_fname
,
1031 connection_struct
*conn
= dirptr
->conn
;
1038 pathlen
= strlen(dirptr
->path
);
1039 slashlen
= ( dirptr
->path
[pathlen
-1] != '/') ? 1 : 0;
1044 SMB_STRUCT_STAT sbuf
;
1048 char *pathreal
= NULL
;
1049 struct smb_filename smb_fname
;
1053 cur_offset
= dptr_TellDir(dirptr
);
1054 prev_offset
= cur_offset
;
1055 dname
= dptr_ReadDirName(ctx
, dirptr
, &cur_offset
, &sbuf
);
1057 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
1058 (long)dirptr
, cur_offset
));
1060 if (dname
== NULL
) {
1064 isdots
= (ISDOT(dname
) || ISDOTDOT(dname
));
1065 if (dont_descend
&& !isdots
) {
1071 * fname may get mangled, dname is never mangled.
1072 * Whenever we're accessing the filesystem we use
1073 * pathreal which is composed from dname.
1076 ok
= match_fn(ctx
, private_data
, dname
, mask
, &fname
);
1084 * pathreal = talloc_asprintf(ctx, "%s%s%s", dirptr->path,
1085 * needslash?"/":"", dname);
1086 * but this was measurably slower than doing the memcpy.
1089 pathreal
= talloc_array(
1091 pathlen
+ slashlen
+ talloc_get_size(dname
));
1098 memcpy(pathreal
, dirptr
->path
, pathlen
);
1099 pathreal
[pathlen
] = '/';
1100 memcpy(pathreal
+ slashlen
+ pathlen
, dname
,
1101 talloc_get_size(dname
));
1103 /* Create smb_fname with NULL stream_name. */
1104 ZERO_STRUCT(smb_fname
);
1105 smb_fname
.base_name
= pathreal
;
1106 smb_fname
.st
= sbuf
;
1108 ok
= mode_fn(ctx
, private_data
, &smb_fname
, &mode
);
1112 TALLOC_FREE(pathreal
);
1116 if (!dir_check_ftype(mode
, dirtype
)) {
1117 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1118 fname
, (unsigned int)mode
, (unsigned int)dirtype
));
1121 TALLOC_FREE(pathreal
);
1125 if (ask_sharemode
) {
1126 struct timespec write_time_ts
;
1127 struct file_id fileid
;
1129 fileid
= vfs_file_id_from_sbuf(conn
,
1131 get_file_infos(fileid
, 0, NULL
, &write_time_ts
);
1132 if (!null_timespec(write_time_ts
)) {
1133 update_stat_ex_mtime(&smb_fname
.st
,
1138 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1140 mask
, smb_fname_str_dbg(&smb_fname
),
1143 DirCacheAdd(dirptr
->dir_hnd
, dname
, cur_offset
);
1147 *_smb_fname
= cp_smb_filename(ctx
, &smb_fname
);
1148 TALLOC_FREE(pathreal
);
1149 if (*_smb_fname
== NULL
) {
1154 *_prev_offset
= prev_offset
;
1162 /****************************************************************************
1163 Get an 8.3 directory entry.
1164 ****************************************************************************/
1166 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX
*ctx
,
1172 connection_struct
*conn
= (connection_struct
*)private_data
;
1174 if ((strcmp(mask
,"*.*") == 0) ||
1175 mask_match_search(dname
, mask
, false) ||
1176 mangle_mask_match(conn
, dname
, mask
)) {
1180 if (!mangle_is_8_3(dname
, false, conn
->params
)) {
1181 bool ok
= name_to_8_3(dname
, mname
, false,
1191 *_fname
= talloc_strdup(ctx
, fname
);
1192 if (*_fname
== NULL
) {
1202 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX
*ctx
,
1204 struct smb_filename
*smb_fname
,
1207 connection_struct
*conn
= (connection_struct
*)private_data
;
1209 if (!VALID_STAT(smb_fname
->st
)) {
1210 if ((SMB_VFS_STAT(conn
, smb_fname
)) != 0) {
1211 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1212 "Couldn't stat [%s]. Error "
1214 smb_fname_str_dbg(smb_fname
),
1220 *_mode
= dos_mode(conn
, smb_fname
);
1224 bool get_dir_entry(TALLOC_CTX
*ctx
,
1225 struct dptr_struct
*dirptr
,
1231 struct timespec
*_date
,
1235 connection_struct
*conn
= dirptr
->conn
;
1237 struct smb_filename
*smb_fname
= NULL
;
1242 ok
= smbd_dirptr_get_entry(ctx
,
1248 smbd_dirptr_8_3_match_fn
,
1249 smbd_dirptr_8_3_mode_fn
,
1259 *_fname
= talloc_move(ctx
, &fname
);
1260 *_size
= smb_fname
->st
.st_ex_size
;
1262 *_date
= smb_fname
->st
.st_ex_mtime
;
1263 TALLOC_FREE(smb_fname
);
1267 /*******************************************************************
1268 Check to see if a user can read a file. This is only approximate,
1269 it is used as part of the "hide unreadable" option. Don't
1270 use it for anything security sensitive.
1271 ********************************************************************/
1273 static bool user_can_read_file(connection_struct
*conn
,
1274 struct smb_filename
*smb_fname
)
1277 * Never hide files from the root user.
1278 * We use (uid_t)0 here not sec_initial_uid()
1279 * as make test uses a single user context.
1282 if (get_current_uid(conn
) == (uid_t
)0) {
1286 return NT_STATUS_IS_OK(smbd_check_access_rights(conn
,
1292 /*******************************************************************
1293 Check to see if a user can write a file (and only files, we do not
1294 check dirs on this one). This is only approximate,
1295 it is used as part of the "hide unwriteable" option. Don't
1296 use it for anything security sensitive.
1297 ********************************************************************/
1299 static bool user_can_write_file(connection_struct
*conn
,
1300 const struct smb_filename
*smb_fname
)
1303 * Never hide files from the root user.
1304 * We use (uid_t)0 here not sec_initial_uid()
1305 * as make test uses a single user context.
1308 if (get_current_uid(conn
) == (uid_t
)0) {
1312 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1314 /* Pseudo-open the file */
1316 if(S_ISDIR(smb_fname
->st
.st_ex_mode
)) {
1320 return can_write_to_file(conn
, smb_fname
);
1323 /*******************************************************************
1324 Is a file a "special" type ?
1325 ********************************************************************/
1327 static bool file_is_special(connection_struct
*conn
,
1328 const struct smb_filename
*smb_fname
)
1331 * Never hide files from the root user.
1332 * We use (uid_t)0 here not sec_initial_uid()
1333 * as make test uses a single user context.
1336 if (get_current_uid(conn
) == (uid_t
)0) {
1340 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1342 if (S_ISREG(smb_fname
->st
.st_ex_mode
) ||
1343 S_ISDIR(smb_fname
->st
.st_ex_mode
) ||
1344 S_ISLNK(smb_fname
->st
.st_ex_mode
))
1350 /*******************************************************************
1351 Should the file be seen by the client?
1352 NOTE: A successful return is no guarantee of the file's existence.
1353 ********************************************************************/
1355 bool is_visible_file(connection_struct
*conn
, const char *dir_path
,
1356 const char *name
, SMB_STRUCT_STAT
*pst
, bool use_veto
)
1358 bool hide_unreadable
= lp_hideunreadable(SNUM(conn
));
1359 bool hide_unwriteable
= lp_hideunwriteable_files(SNUM(conn
));
1360 bool hide_special
= lp_hide_special_files(SNUM(conn
));
1362 struct smb_filename
*smb_fname_base
= NULL
;
1365 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1366 return True
; /* . and .. are always visible. */
1369 /* If it's a vetoed file, pretend it doesn't even exist */
1370 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1371 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1375 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1376 entry
= talloc_asprintf(talloc_tos(), "%s/%s", dir_path
, name
);
1382 /* Create an smb_filename with stream_name == NULL. */
1383 smb_fname_base
= synthetic_smb_fname(talloc_tos(), entry
, NULL
,
1385 if (smb_fname_base
== NULL
) {
1390 /* If the file name does not exist, there's no point checking
1391 * the configuration options. We succeed, on the basis that the
1392 * checks *might* have passed if the file was present.
1394 if (!VALID_STAT(*pst
)) {
1395 if (SMB_VFS_STAT(conn
, smb_fname_base
) != 0) {
1399 *pst
= smb_fname_base
->st
;
1403 /* Honour _hide unreadable_ option */
1404 if (hide_unreadable
&&
1405 !user_can_read_file(conn
, smb_fname_base
)) {
1406 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1411 /* Honour _hide unwriteable_ option */
1412 if (hide_unwriteable
&& !user_can_write_file(conn
,
1414 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1419 /* Honour _hide_special_ option */
1420 if (hide_special
&& file_is_special(conn
, smb_fname_base
)) {
1421 DEBUG(10,("is_visible_file: file %s is special.\n",
1430 TALLOC_FREE(smb_fname_base
);
1435 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1437 if (dirp
->dir
!= NULL
) {
1438 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1439 if (dirp
->fsp
!= NULL
) {
1441 * The SMB_VFS_CLOSEDIR above
1442 * closes the underlying fd inside
1445 dirp
->fsp
->fh
->fd
= -1;
1446 if (dirp
->fsp
->dptr
!= NULL
) {
1447 SMB_ASSERT(dirp
->fsp
->dptr
->dir_hnd
== dirp
);
1448 dirp
->fsp
->dptr
->dir_hnd
= NULL
;
1453 if (dirp
->conn
->sconn
&& !dirp
->conn
->sconn
->using_smb2
) {
1454 dirp
->conn
->sconn
->searches
.dirhandles_open
--;
1459 /*******************************************************************
1461 ********************************************************************/
1463 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1468 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1469 struct smbd_server_connection
*sconn
= conn
->sconn
;
1476 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1478 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1479 if (!dirp
->dir_path
) {
1484 if (sconn
&& !sconn
->using_smb2
) {
1485 sconn
->searches
.dirhandles_open
++;
1487 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1489 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1491 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1503 /*******************************************************************
1504 Open a directory from an fsp.
1505 ********************************************************************/
1507 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1512 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1513 struct smbd_server_connection
*sconn
= conn
->sconn
;
1520 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1522 dirp
->dir_path
= talloc_strdup(dirp
, fsp
->fsp_name
->base_name
);
1523 if (!dirp
->dir_path
) {
1528 if (sconn
&& !sconn
->using_smb2
) {
1529 sconn
->searches
.dirhandles_open
++;
1531 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1533 if (fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
1534 dirp
->dir
= SMB_VFS_FDOPENDIR(fsp
, mask
, attr
);
1535 if (dirp
->dir
!= NULL
) {
1538 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1542 if (errno
!= ENOSYS
) {
1548 if (dirp
->dir
== NULL
) {
1549 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1550 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1554 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp
->dir_path
,
1567 /*******************************************************************
1568 Read from a directory.
1569 Return directory entry, current offset, and optional stat information.
1570 Don't check for veto or invisible files.
1571 ********************************************************************/
1573 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
,
1574 SMB_STRUCT_STAT
*sbuf
, char **ptalloced
)
1577 char *talloced
= NULL
;
1578 connection_struct
*conn
= dirp
->conn
;
1580 /* Cheat to allow . and .. to be the first entries returned. */
1581 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) ||
1582 (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2))
1584 if (dirp
->file_number
== 0) {
1586 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1589 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1591 dirp
->file_number
++;
1594 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1595 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1598 /* A real offset, seek to it. */
1599 SeekDir(dirp
, *poffset
);
1602 while ((n
= vfs_readdirname(conn
, dirp
->dir
, sbuf
, &talloced
))) {
1603 /* Ignore . and .. - we've already returned them. */
1605 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1606 TALLOC_FREE(talloced
);
1610 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1611 *ptalloced
= talloced
;
1612 dirp
->file_number
++;
1615 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1620 /*******************************************************************
1621 Rewind to the start.
1622 ********************************************************************/
1624 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1626 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1627 dirp
->file_number
= 0;
1628 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1629 *poffset
= START_OF_DIRECTORY_OFFSET
;
1632 /*******************************************************************
1634 ********************************************************************/
1636 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1638 if (offset
!= dirp
->offset
) {
1639 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1640 RewindDir(dirp
, &offset
);
1642 * Ok we should really set the file number here
1643 * to 1 to enable ".." to be returned next. Trouble
1644 * is I'm worried about callers using SeekDir(dirp,0)
1645 * as equivalent to RewindDir(). So leave this alone
1648 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1649 RewindDir(dirp
, &offset
);
1651 * Set the file number to 2 - we want to get the first
1652 * real file entry (the one we return after "..")
1653 * on the next ReadDir.
1655 dirp
->file_number
= 2;
1656 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1657 ; /* Don't seek in this case. */
1659 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1661 dirp
->offset
= offset
;
1665 /*******************************************************************
1666 Tell a dir position.
1667 ********************************************************************/
1669 long TellDir(struct smb_Dir
*dirp
)
1671 return(dirp
->offset
);
1674 /*******************************************************************
1675 Add an entry into the dcache.
1676 ********************************************************************/
1678 static void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1680 struct name_cache_entry
*e
;
1682 if (dirp
->name_cache_size
== 0) {
1686 if (dirp
->name_cache
== NULL
) {
1687 dirp
->name_cache
= talloc_zero_array(
1688 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1690 if (dirp
->name_cache
== NULL
) {
1695 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1696 dirp
->name_cache_size
;
1697 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1698 TALLOC_FREE(e
->name
);
1699 e
->name
= talloc_strdup(dirp
, name
);
1703 /*******************************************************************
1704 Find an entry by name. Leave us at the offset after it.
1705 Don't check for veto or invisible files.
1706 ********************************************************************/
1708 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1711 const char *entry
= NULL
;
1712 char *talloced
= NULL
;
1713 connection_struct
*conn
= dirp
->conn
;
1715 /* Search back in the name cache. */
1716 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1717 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1718 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1719 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1720 *poffset
= e
->offset
;
1721 SeekDir(dirp
, e
->offset
);
1725 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1726 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1727 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1728 *poffset
= e
->offset
;
1729 SeekDir(dirp
, e
->offset
);
1735 /* Not found in the name cache. Rewind directory and start from scratch. */
1736 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1737 dirp
->file_number
= 0;
1738 *poffset
= START_OF_DIRECTORY_OFFSET
;
1739 while ((entry
= ReadDirName(dirp
, poffset
, NULL
, &talloced
))) {
1740 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1741 TALLOC_FREE(talloced
);
1744 TALLOC_FREE(talloced
);
1749 /*****************************************************************
1750 Is this directory empty ?
1751 *****************************************************************/
1753 NTSTATUS
can_delete_directory_fsp(files_struct
*fsp
)
1755 NTSTATUS status
= NT_STATUS_OK
;
1757 const char *dname
= NULL
;
1758 const char *dirname
= fsp
->fsp_name
->base_name
;
1759 char *talloced
= NULL
;
1761 struct connection_struct
*conn
= fsp
->conn
;
1762 struct smb_Dir
*dir_hnd
= OpenDir_fsp(talloc_tos(),
1769 return map_nt_error_from_unix(errno
);
1772 while ((dname
= ReadDirName(dir_hnd
, &dirpos
, &st
, &talloced
))) {
1773 /* Quick check for "." and ".." */
1774 if (dname
[0] == '.') {
1775 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1776 TALLOC_FREE(talloced
);
1781 if (!is_visible_file(conn
, dirname
, dname
, &st
, True
)) {
1782 TALLOC_FREE(talloced
);
1786 DEBUG(10,("got name %s - can't delete\n",
1788 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1791 TALLOC_FREE(talloced
);
1792 TALLOC_FREE(dir_hnd
);