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 #define INVALID_DPTR_KEY (-3)
79 /****************************************************************************
81 ****************************************************************************/
83 bool make_dir_struct(TALLOC_CTX
*ctx
,
93 char *mask2
= talloc_strdup(ctx
, mask
);
99 if ((mode
& FILE_ATTRIBUTE_DIRECTORY
) != 0) {
103 memset(buf
+1,' ',11);
104 if ((p
= strchr_m(mask2
,'.')) != NULL
) {
106 push_ascii(buf
+1,mask2
,8, 0);
107 push_ascii(buf
+9,p
+1,3, 0);
110 push_ascii(buf
+1,mask2
,11, 0);
113 memset(buf
+21,'\0',DIR_STRUCT_SIZE
-21);
115 srv_put_dos_date(buf
,22,date
);
116 SSVAL(buf
,26,size
& 0xFFFF);
117 SSVAL(buf
,28,(size
>> 16)&0xFFFF);
118 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
119 Strange, but verified on W2K3. Needed for OS/2. JRA. */
120 push_ascii(buf
+30,fname
,12, uc
? STR_UPPER
: 0);
121 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf
+30, fname
));
125 /****************************************************************************
126 Initialise the dir bitmap.
127 ****************************************************************************/
129 bool init_dptrs(struct smbd_server_connection
*sconn
)
131 if (sconn
->searches
.dptr_bmap
) {
135 sconn
->searches
.dptr_bmap
= bitmap_talloc(
136 sconn
, MAX_DIRECTORY_HANDLES
);
138 if (sconn
->searches
.dptr_bmap
== NULL
) {
145 /****************************************************************************
146 Idle a dptr - the directory is closed but the control info is kept.
147 ****************************************************************************/
149 static void dptr_idle(struct dptr_struct
*dptr
)
152 DEBUG(4,("Idling dptr dnum %d\n",dptr
->dnum
));
153 TALLOC_FREE(dptr
->dir_hnd
);
157 /****************************************************************************
158 Idle the oldest dptr.
159 ****************************************************************************/
161 static void dptr_idleoldest(struct smbd_server_connection
*sconn
)
163 struct dptr_struct
*dptr
;
166 * Go to the end of the list.
168 dptr
= DLIST_TAIL(sconn
->searches
.dirptrs
);
171 DEBUG(0,("No dptrs available to idle ?\n"));
176 * Idle the oldest pointer.
179 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
187 /****************************************************************************
188 Get the struct dptr_struct for a dir index.
189 ****************************************************************************/
191 static struct dptr_struct
*dptr_get(struct smbd_server_connection
*sconn
,
192 int key
, bool forclose
)
194 struct dptr_struct
*dptr
;
196 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
197 if(dptr
->dnum
== key
) {
198 if (!forclose
&& !dptr
->dir_hnd
) {
199 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
)
200 dptr_idleoldest(sconn
);
201 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key
));
202 if (!(dptr
->dir_hnd
= OpenDir(
203 NULL
, dptr
->conn
, dptr
->path
,
204 dptr
->wcard
, dptr
->attr
))) {
205 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr
->path
,
210 DLIST_PROMOTE(sconn
->searches
.dirptrs
,dptr
);
217 /****************************************************************************
218 Get the dir path for a dir index.
219 ****************************************************************************/
221 const char *dptr_path(struct smbd_server_connection
*sconn
, int key
)
223 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
229 /****************************************************************************
230 Get the dir wcard for a dir index.
231 ****************************************************************************/
233 const char *dptr_wcard(struct smbd_server_connection
*sconn
, int key
)
235 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
241 /****************************************************************************
242 Get the dir attrib for a dir index.
243 ****************************************************************************/
245 uint16
dptr_attr(struct smbd_server_connection
*sconn
, int key
)
247 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
253 /****************************************************************************
254 Close a dptr (internal func).
255 ****************************************************************************/
257 static void dptr_close_internal(struct dptr_struct
*dptr
)
259 struct smbd_server_connection
*sconn
= dptr
->conn
->sconn
;
261 DEBUG(4,("closing dptr key %d\n",dptr
->dnum
));
267 if (sconn
->using_smb2
) {
271 DLIST_REMOVE(sconn
->searches
.dirptrs
, dptr
);
274 * Free the dnum in the bitmap. Remember the dnum value is always
275 * biased by one with respect to the bitmap.
278 if (!bitmap_query(sconn
->searches
.dptr_bmap
, dptr
->dnum
- 1)) {
279 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
283 bitmap_clear(sconn
->searches
.dptr_bmap
, dptr
->dnum
- 1);
286 TALLOC_FREE(dptr
->dir_hnd
);
290 /****************************************************************************
291 Close a dptr given a key.
292 ****************************************************************************/
294 void dptr_close(struct smbd_server_connection
*sconn
, int *key
)
296 struct dptr_struct
*dptr
;
298 if(*key
== INVALID_DPTR_KEY
)
301 /* OS/2 seems to use -1 to indicate "close all directories" */
303 struct dptr_struct
*next
;
304 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
306 dptr_close_internal(dptr
);
308 *key
= INVALID_DPTR_KEY
;
312 dptr
= dptr_get(sconn
, *key
, true);
315 DEBUG(0,("Invalid key %d given to dptr_close\n", *key
));
319 dptr_close_internal(dptr
);
321 *key
= INVALID_DPTR_KEY
;
324 /****************************************************************************
325 Close all dptrs for a cnum.
326 ****************************************************************************/
328 void dptr_closecnum(connection_struct
*conn
)
330 struct dptr_struct
*dptr
, *next
;
331 struct smbd_server_connection
*sconn
= conn
->sconn
;
337 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
339 if (dptr
->conn
== conn
) {
340 dptr_close_internal(dptr
);
345 /****************************************************************************
346 Idle all dptrs for a cnum.
347 ****************************************************************************/
349 void dptr_idlecnum(connection_struct
*conn
)
351 struct dptr_struct
*dptr
;
352 struct smbd_server_connection
*sconn
= conn
->sconn
;
358 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
359 if (dptr
->conn
== conn
&& dptr
->dir_hnd
) {
365 /****************************************************************************
366 Close a dptr that matches a given path, only if it matches the spid also.
367 ****************************************************************************/
369 void dptr_closepath(struct smbd_server_connection
*sconn
,
370 char *path
,uint16 spid
)
372 struct dptr_struct
*dptr
, *next
;
373 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
375 if (spid
== dptr
->spid
&& strequal(dptr
->path
,path
))
376 dptr_close_internal(dptr
);
380 /****************************************************************************
381 Try and close the oldest handle not marked for
382 expect close in the hope that the client has
383 finished with that one.
384 ****************************************************************************/
386 static void dptr_close_oldest(struct smbd_server_connection
*sconn
,
389 struct dptr_struct
*dptr
;
392 * Go to the end of the list.
394 for(dptr
= sconn
->searches
.dirptrs
; dptr
&& dptr
->next
; dptr
= dptr
->next
)
398 DEBUG(0,("No old dptrs available to close oldest ?\n"));
403 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
404 * does not have expect_close set. If 'old' is false, close
405 * one of the new dnum handles.
408 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
409 if ((old
&& (dptr
->dnum
< 256) && !dptr
->expect_close
) ||
410 (!old
&& (dptr
->dnum
> 255))) {
411 dptr_close_internal(dptr
);
417 /****************************************************************************
418 Safely do an OpenDir as root, ensuring we're in the right place.
419 ****************************************************************************/
421 static struct smb_Dir
*open_dir_with_privilege(connection_struct
*conn
,
422 struct smb_request
*req
,
428 struct smb_Dir
*dir_hnd
= NULL
;
429 struct smb_filename
*smb_fname_cwd
= NULL
;
430 char *saved_dir
= vfs_GetWd(talloc_tos(), conn
);
431 struct privilege_paths
*priv_paths
= req
->priv_paths
;
434 if (saved_dir
== NULL
) {
438 if (vfs_ChDir(conn
, path
) == -1) {
442 /* Now check the stat value is the same. */
443 status
= create_synthetic_smb_fname(talloc_tos(), ".",
447 if (!NT_STATUS_IS_OK(status
)) {
450 ret
= SMB_VFS_STAT(conn
, smb_fname_cwd
);
455 if (!check_same_stat(&smb_fname_cwd
->st
, &priv_paths
->parent_name
.st
)) {
456 DEBUG(0,("open_dir_with_privilege: stat mismatch between %s "
459 smb_fname_str_dbg(&priv_paths
->parent_name
)));
463 dir_hnd
= OpenDir(NULL
, conn
, ".", wcard
, attr
);
467 vfs_ChDir(conn
, saved_dir
);
471 /****************************************************************************
472 Create a new dir ptr. If the flag old_handle is true then we must allocate
473 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
474 one byte long. If old_handle is false we allocate from the range
475 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
476 a directory handle is never zero.
477 wcard must not be zero.
478 ****************************************************************************/
480 NTSTATUS
dptr_create(connection_struct
*conn
,
481 struct smb_request
*req
,
483 const char *path
, bool old_handle
, bool expect_close
,uint16 spid
,
484 const char *wcard
, bool wcard_has_wild
, uint32 attr
, struct dptr_struct
**dptr_ret
)
486 struct smbd_server_connection
*sconn
= conn
->sconn
;
487 struct dptr_struct
*dptr
= NULL
;
488 struct smb_Dir
*dir_hnd
;
490 if (fsp
&& fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
491 path
= fsp
->fsp_name
->base_name
;
494 DEBUG(5,("dptr_create dir=%s\n", path
));
497 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
498 return NT_STATUS_INTERNAL_ERROR
;
502 return NT_STATUS_INVALID_PARAMETER
;
506 if (!(fsp
->access_mask
& SEC_DIR_LIST
)) {
507 DEBUG(5,("dptr_create: directory %s "
508 "not open for LIST access\n",
510 return NT_STATUS_ACCESS_DENIED
;
512 dir_hnd
= OpenDir_fsp(NULL
, conn
, fsp
, wcard
, attr
);
515 struct smb_filename
*smb_dname
= NULL
;
516 NTSTATUS status
= create_synthetic_smb_fname(talloc_tos(),
521 if (!NT_STATUS_IS_OK(status
)) {
524 if (lp_posix_pathnames()) {
525 ret
= SMB_VFS_LSTAT(conn
, smb_dname
);
527 ret
= SMB_VFS_STAT(conn
, smb_dname
);
530 return map_nt_error_from_unix(errno
);
532 if (!S_ISDIR(smb_dname
->st
.st_ex_mode
)) {
533 return NT_STATUS_NOT_A_DIRECTORY
;
535 status
= smbd_check_access_rights(conn
,
538 if (!NT_STATUS_IS_OK(status
)) {
541 if (req
&& req
->priv_paths
) {
542 dir_hnd
= open_dir_with_privilege(conn
,
548 dir_hnd
= OpenDir(NULL
, conn
, path
, wcard
, attr
);
553 return map_nt_error_from_unix(errno
);
556 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
) {
557 dptr_idleoldest(sconn
);
560 dptr
= talloc(NULL
, struct dptr_struct
);
562 DEBUG(0,("talloc fail in dptr_create.\n"));
563 TALLOC_FREE(dir_hnd
);
564 return NT_STATUS_NO_MEMORY
;
569 dptr
->path
= talloc_strdup(dptr
, path
);
572 TALLOC_FREE(dir_hnd
);
573 return NT_STATUS_NO_MEMORY
;
576 dptr
->dir_hnd
= dir_hnd
;
578 dptr
->expect_close
= expect_close
;
579 dptr
->wcard
= talloc_strdup(dptr
, wcard
);
582 TALLOC_FREE(dir_hnd
);
583 return NT_STATUS_NO_MEMORY
;
585 if (lp_posix_pathnames() || (wcard
[0] == '.' && wcard
[1] == 0)) {
586 dptr
->has_wild
= True
;
588 dptr
->has_wild
= wcard_has_wild
;
593 if (sconn
->using_smb2
) {
600 * This is an old-style SMBsearch request. Ensure the
601 * value we return will fit in the range 1-255.
604 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
606 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
609 * Try and close the oldest handle not marked for
610 * expect close in the hope that the client has
611 * finished with that one.
614 dptr_close_oldest(sconn
, true);
616 /* Now try again... */
617 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
618 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
619 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr
->dnum
));
621 TALLOC_FREE(dir_hnd
);
622 return NT_STATUS_TOO_MANY_OPENED_FILES
;
628 * This is a new-style trans2 request. Allocate from
629 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
632 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
634 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
637 * Try and close the oldest handle close in the hope that
638 * the client has finished with that one. This will only
639 * happen in the case of the Win98 client bug where it leaks
643 dptr_close_oldest(sconn
, false);
645 /* Now try again... */
646 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
648 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
649 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr
->dnum
));
651 TALLOC_FREE(dir_hnd
);
652 return NT_STATUS_TOO_MANY_OPENED_FILES
;
657 bitmap_set(sconn
->searches
.dptr_bmap
, dptr
->dnum
);
659 dptr
->dnum
+= 1; /* Always bias the dnum by one - no zero dnums allowed. */
661 DLIST_ADD(sconn
->searches
.dirptrs
, dptr
);
664 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
665 dptr
->dnum
,path
,expect_close
));
673 /****************************************************************************
674 Wrapper functions to access the lower level directory handles.
675 ****************************************************************************/
677 void dptr_CloseDir(files_struct
*fsp
)
681 * The destructor for the struct smb_Dir
682 * (fsp->dptr->dir_hnd) now handles
683 * all resource deallocation.
685 dptr_close_internal(fsp
->dptr
);
690 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
692 SeekDir(dptr
->dir_hnd
, offset
);
695 long dptr_TellDir(struct dptr_struct
*dptr
)
697 return TellDir(dptr
->dir_hnd
);
700 bool dptr_has_wild(struct dptr_struct
*dptr
)
702 return dptr
->has_wild
;
705 int dptr_dnum(struct dptr_struct
*dptr
)
710 bool dptr_get_priv(struct dptr_struct
*dptr
)
715 void dptr_set_priv(struct dptr_struct
*dptr
)
720 /****************************************************************************
721 Return the next visible file name, skipping veto'd and invisible files.
722 ****************************************************************************/
724 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
,
725 long *poffset
, SMB_STRUCT_STAT
*pst
,
728 /* Normal search for the next file. */
730 char *talloced
= NULL
;
732 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
, pst
, &talloced
))
734 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
735 *ptalloced
= talloced
;
738 TALLOC_FREE(talloced
);
743 /****************************************************************************
744 Return the next visible file name, skipping veto'd and invisible files.
745 ****************************************************************************/
747 char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
748 struct dptr_struct
*dptr
,
750 SMB_STRUCT_STAT
*pst
)
752 struct smb_filename smb_fname_base
;
754 const char *name_temp
= NULL
;
755 char *talloced
= NULL
;
756 char *pathreal
= NULL
;
757 char *found_name
= NULL
;
760 SET_STAT_INVALID(*pst
);
762 if (dptr
->has_wild
|| dptr
->did_stat
) {
763 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
,
765 if (name_temp
== NULL
) {
768 if (talloced
!= NULL
) {
769 return talloc_move(ctx
, &talloced
);
771 return talloc_strdup(ctx
, name_temp
);
774 /* If poffset is -1 then we know we returned this name before and we
775 * have no wildcards. We're at the end of the directory. */
776 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
780 /* We know the stored wcard contains no wildcard characters.
781 * See if we can match with a stat call. If we can't, then set
782 * did_stat to true to ensure we only do this once and keep
785 dptr
->did_stat
= true;
787 /* First check if it should be visible. */
788 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
,
791 /* This only returns false if the file was found, but
792 is explicitly not visible. Set us to end of
793 directory, but return NULL as we know we can't ever
798 if (VALID_STAT(*pst
)) {
799 name
= talloc_strdup(ctx
, dptr
->wcard
);
803 pathreal
= talloc_asprintf(ctx
,
810 /* Create an smb_filename with stream_name == NULL. */
811 ZERO_STRUCT(smb_fname_base
);
812 smb_fname_base
.base_name
= pathreal
;
814 if (SMB_VFS_STAT(dptr
->conn
, &smb_fname_base
) == 0) {
815 *pst
= smb_fname_base
.st
;
816 name
= talloc_strdup(ctx
, dptr
->wcard
);
819 /* If we get any other error than ENOENT or ENOTDIR
820 then the file exists we just can't stat it. */
821 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
822 name
= talloc_strdup(ctx
, dptr
->wcard
);
827 /* Stat failed. We know this is authoratiative if we are
828 * providing case sensitive semantics or the underlying
829 * filesystem is case sensitive.
831 if (dptr
->conn
->case_sensitive
||
832 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
))
838 * Try case-insensitive stat if the fs has the ability. This avoids
839 * scanning the whole directory.
841 ret
= SMB_VFS_GET_REAL_FILENAME(dptr
->conn
, dptr
->path
, dptr
->wcard
,
846 } else if (errno
== ENOENT
) {
847 /* The case-insensitive lookup was authoritative. */
851 TALLOC_FREE(pathreal
);
853 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
, &talloced
);
854 if (name_temp
== NULL
) {
857 if (talloced
!= NULL
) {
858 return talloc_move(ctx
, &talloced
);
860 return talloc_strdup(ctx
, name_temp
);
863 TALLOC_FREE(pathreal
);
865 /* We need to set the underlying dir_hnd offset to -1
866 * also as this function is usually called with the
867 * output from TellDir. */
868 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
872 /****************************************************************************
873 Search for a file by name, skipping veto'ed and not visible files.
874 ****************************************************************************/
876 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
878 SET_STAT_INVALID(*pst
);
880 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
881 /* This is a singleton directory and we're already at the end. */
882 *poffset
= END_OF_DIRECTORY_OFFSET
;
886 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
889 /****************************************************************************
890 Add the name we're returning into the underlying cache.
891 ****************************************************************************/
893 void dptr_DirCacheAdd(struct dptr_struct
*dptr
, const char *name
, long offset
)
895 DirCacheAdd(dptr
->dir_hnd
, name
, offset
);
898 /****************************************************************************
899 Initialize variables & state data at the beginning of all search SMB requests.
900 ****************************************************************************/
901 void dptr_init_search_op(struct dptr_struct
*dptr
)
903 SMB_VFS_INIT_SEARCH_OP(dptr
->conn
, dptr
->dir_hnd
->dir
);
906 /****************************************************************************
907 Fill the 5 byte server reserved dptr field.
908 ****************************************************************************/
910 bool dptr_fill(struct smbd_server_connection
*sconn
,
911 char *buf1
,unsigned int key
)
913 unsigned char *buf
= (unsigned char *)buf1
;
914 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
917 DEBUG(1,("filling null dirptr %d\n",key
));
920 offset
= (uint32
)TellDir(dptr
->dir_hnd
);
921 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
922 (long)dptr
->dir_hnd
,(int)offset
));
928 /****************************************************************************
929 Fetch the dir ptr and seek it given the 5 byte server field.
930 ****************************************************************************/
932 struct dptr_struct
*dptr_fetch(struct smbd_server_connection
*sconn
,
935 unsigned int key
= *(unsigned char *)buf
;
936 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
941 DEBUG(3,("fetched null dirptr %d\n",key
));
945 offset
= IVAL(buf
,1);
946 if (offset
== (uint32
)-1) {
947 seekoff
= END_OF_DIRECTORY_OFFSET
;
949 seekoff
= (long)offset
;
951 SeekDir(dptr
->dir_hnd
,seekoff
);
952 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
953 key
, dptr
->path
, (int)seekoff
));
957 /****************************************************************************
959 ****************************************************************************/
961 struct dptr_struct
*dptr_fetch_lanman2(struct smbd_server_connection
*sconn
,
964 struct dptr_struct
*dptr
= dptr_get(sconn
, dptr_num
, false);
967 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
970 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr
->path
));
974 /****************************************************************************
975 Check that a file matches a particular file type.
976 ****************************************************************************/
978 bool dir_check_ftype(connection_struct
*conn
, uint32 mode
, uint32 dirtype
)
982 /* Check the "may have" search bits. */
983 if (((mode
& ~dirtype
) & (FILE_ATTRIBUTE_HIDDEN
| FILE_ATTRIBUTE_SYSTEM
| FILE_ATTRIBUTE_DIRECTORY
)) != 0)
986 /* Check the "must have" bits, which are the may have bits shifted eight */
987 /* If must have bit is set, the file/dir can not be returned in search unless the matching
988 file attribute is set */
989 mask
= ((dirtype
>> 8) & (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
)); /* & 0x37 */
991 if((mask
& (mode
& (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
))) == mask
) /* check if matching attribute present */
1000 static bool mangle_mask_match(connection_struct
*conn
,
1001 const char *filename
,
1006 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
1009 return mask_match_search(mname
,mask
,False
);
1012 bool smbd_dirptr_get_entry(TALLOC_CTX
*ctx
,
1013 struct dptr_struct
*dirptr
,
1018 bool (*match_fn
)(TALLOC_CTX
*ctx
,
1023 bool (*mode_fn
)(TALLOC_CTX
*ctx
,
1025 struct smb_filename
*smb_fname
,
1029 struct smb_filename
**_smb_fname
,
1033 connection_struct
*conn
= dirptr
->conn
;
1040 pathlen
= strlen(dirptr
->path
);
1041 slashlen
= ( dirptr
->path
[pathlen
-1] != '/') ? 1 : 0;
1046 SMB_STRUCT_STAT sbuf
;
1050 char *pathreal
= NULL
;
1051 struct smb_filename smb_fname
;
1056 cur_offset
= dptr_TellDir(dirptr
);
1057 prev_offset
= cur_offset
;
1058 dname
= dptr_ReadDirName(ctx
, dirptr
, &cur_offset
, &sbuf
);
1060 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
1061 (long)dirptr
, cur_offset
));
1063 if (dname
== NULL
) {
1067 isdots
= (ISDOT(dname
) || ISDOTDOT(dname
));
1068 if (dont_descend
&& !isdots
) {
1074 * fname may get mangled, dname is never mangled.
1075 * Whenever we're accessing the filesystem we use
1076 * pathreal which is composed from dname.
1079 ok
= match_fn(ctx
, private_data
, dname
, mask
, &fname
);
1087 * pathreal = talloc_asprintf(ctx, "%s%s%s", dirptr->path,
1088 * needslash?"/":"", dname);
1089 * but this was measurably slower than doing the memcpy.
1092 pathreal
= talloc_array(
1094 pathlen
+ slashlen
+ talloc_get_size(dname
));
1101 memcpy(pathreal
, dirptr
->path
, pathlen
);
1102 pathreal
[pathlen
] = '/';
1103 memcpy(pathreal
+ slashlen
+ pathlen
, dname
,
1104 talloc_get_size(dname
));
1106 /* Create smb_fname with NULL stream_name. */
1107 ZERO_STRUCT(smb_fname
);
1108 smb_fname
.base_name
= pathreal
;
1109 smb_fname
.st
= sbuf
;
1111 ok
= mode_fn(ctx
, private_data
, &smb_fname
, &mode
);
1115 TALLOC_FREE(pathreal
);
1119 if (!dir_check_ftype(conn
, mode
, dirtype
)) {
1120 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1121 fname
, (unsigned int)mode
, (unsigned int)dirtype
));
1124 TALLOC_FREE(pathreal
);
1128 if (ask_sharemode
) {
1129 struct timespec write_time_ts
;
1130 struct file_id fileid
;
1132 fileid
= vfs_file_id_from_sbuf(conn
,
1134 get_file_infos(fileid
, 0, NULL
, &write_time_ts
);
1135 if (!null_timespec(write_time_ts
)) {
1136 update_stat_ex_mtime(&smb_fname
.st
,
1141 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1143 mask
, smb_fname_str_dbg(&smb_fname
),
1146 DirCacheAdd(dirptr
->dir_hnd
, dname
, cur_offset
);
1150 status
= copy_smb_filename(ctx
, &smb_fname
, _smb_fname
);
1151 TALLOC_FREE(pathreal
);
1152 if (!NT_STATUS_IS_OK(status
)) {
1157 *_prev_offset
= prev_offset
;
1165 /****************************************************************************
1166 Get an 8.3 directory entry.
1167 ****************************************************************************/
1169 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX
*ctx
,
1175 connection_struct
*conn
= (connection_struct
*)private_data
;
1177 if ((strcmp(mask
,"*.*") == 0) ||
1178 mask_match_search(dname
, mask
, false) ||
1179 mangle_mask_match(conn
, dname
, mask
)) {
1183 if (!mangle_is_8_3(dname
, false, conn
->params
)) {
1184 bool ok
= name_to_8_3(dname
, mname
, false,
1194 *_fname
= talloc_strdup(ctx
, fname
);
1195 if (*_fname
== NULL
) {
1205 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX
*ctx
,
1207 struct smb_filename
*smb_fname
,
1210 connection_struct
*conn
= (connection_struct
*)private_data
;
1212 if (!VALID_STAT(smb_fname
->st
)) {
1213 if ((SMB_VFS_STAT(conn
, smb_fname
)) != 0) {
1214 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1215 "Couldn't stat [%s]. Error "
1217 smb_fname_str_dbg(smb_fname
),
1223 *_mode
= dos_mode(conn
, smb_fname
);
1227 bool get_dir_entry(TALLOC_CTX
*ctx
,
1228 struct dptr_struct
*dirptr
,
1234 struct timespec
*_date
,
1238 connection_struct
*conn
= dirptr
->conn
;
1240 struct smb_filename
*smb_fname
= NULL
;
1245 ok
= smbd_dirptr_get_entry(ctx
,
1251 smbd_dirptr_8_3_match_fn
,
1252 smbd_dirptr_8_3_mode_fn
,
1262 *_fname
= talloc_move(ctx
, &fname
);
1263 *_size
= smb_fname
->st
.st_ex_size
;
1265 *_date
= smb_fname
->st
.st_ex_mtime
;
1266 TALLOC_FREE(smb_fname
);
1270 /*******************************************************************
1271 Check to see if a user can read a file. This is only approximate,
1272 it is used as part of the "hide unreadable" option. Don't
1273 use it for anything security sensitive.
1274 ********************************************************************/
1276 static bool user_can_read_file(connection_struct
*conn
,
1277 struct smb_filename
*smb_fname
)
1280 * Never hide files from the root user.
1281 * We use (uid_t)0 here not sec_initial_uid()
1282 * as make test uses a single user context.
1285 if (get_current_uid(conn
) == (uid_t
)0) {
1289 return NT_STATUS_IS_OK(smbd_check_access_rights(conn
,
1294 /*******************************************************************
1295 Check to see if a user can write a file (and only files, we do not
1296 check dirs on this one). This is only approximate,
1297 it is used as part of the "hide unwriteable" option. Don't
1298 use it for anything security sensitive.
1299 ********************************************************************/
1301 static bool user_can_write_file(connection_struct
*conn
,
1302 const struct smb_filename
*smb_fname
)
1305 * Never hide files from the root user.
1306 * We use (uid_t)0 here not sec_initial_uid()
1307 * as make test uses a single user context.
1310 if (get_current_uid(conn
) == (uid_t
)0) {
1314 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1316 /* Pseudo-open the file */
1318 if(S_ISDIR(smb_fname
->st
.st_ex_mode
)) {
1322 return can_write_to_file(conn
, smb_fname
);
1325 /*******************************************************************
1326 Is a file a "special" type ?
1327 ********************************************************************/
1329 static bool file_is_special(connection_struct
*conn
,
1330 const struct smb_filename
*smb_fname
)
1333 * Never hide files from the root user.
1334 * We use (uid_t)0 here not sec_initial_uid()
1335 * as make test uses a single user context.
1338 if (get_current_uid(conn
) == (uid_t
)0) {
1342 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1344 if (S_ISREG(smb_fname
->st
.st_ex_mode
) ||
1345 S_ISDIR(smb_fname
->st
.st_ex_mode
) ||
1346 S_ISLNK(smb_fname
->st
.st_ex_mode
))
1352 /*******************************************************************
1353 Should the file be seen by the client?
1354 NOTE: A successful return is no guarantee of the file's existence.
1355 ********************************************************************/
1357 bool is_visible_file(connection_struct
*conn
, const char *dir_path
,
1358 const char *name
, SMB_STRUCT_STAT
*pst
, bool use_veto
)
1360 bool hide_unreadable
= lp_hideunreadable(SNUM(conn
));
1361 bool hide_unwriteable
= lp_hideunwriteable_files(SNUM(conn
));
1362 bool hide_special
= lp_hide_special_files(SNUM(conn
));
1364 struct smb_filename
*smb_fname_base
= NULL
;
1368 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1369 return True
; /* . and .. are always visible. */
1372 /* If it's a vetoed file, pretend it doesn't even exist */
1373 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1374 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1378 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1379 entry
= talloc_asprintf(talloc_tos(), "%s/%s", dir_path
, name
);
1385 /* Create an smb_filename with stream_name == NULL. */
1386 status
= create_synthetic_smb_fname(talloc_tos(), entry
, NULL
,
1387 pst
, &smb_fname_base
);
1388 if (!NT_STATUS_IS_OK(status
)) {
1393 /* If the file name does not exist, there's no point checking
1394 * the configuration options. We succeed, on the basis that the
1395 * checks *might* have passed if the file was present.
1397 if (!VALID_STAT(*pst
)) {
1398 if (SMB_VFS_STAT(conn
, smb_fname_base
) != 0) {
1402 *pst
= smb_fname_base
->st
;
1406 /* Honour _hide unreadable_ option */
1407 if (hide_unreadable
&&
1408 !user_can_read_file(conn
, smb_fname_base
)) {
1409 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1414 /* Honour _hide unwriteable_ option */
1415 if (hide_unwriteable
&& !user_can_write_file(conn
,
1417 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1422 /* Honour _hide_special_ option */
1423 if (hide_special
&& file_is_special(conn
, smb_fname_base
)) {
1424 DEBUG(10,("is_visible_file: file %s is special.\n",
1433 TALLOC_FREE(smb_fname_base
);
1438 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1440 if (dirp
->dir
!= NULL
) {
1441 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1442 if (dirp
->fsp
!= NULL
) {
1444 * The SMB_VFS_CLOSEDIR above
1445 * closes the underlying fd inside
1448 dirp
->fsp
->fh
->fd
= -1;
1449 if (dirp
->fsp
->dptr
!= NULL
) {
1450 SMB_ASSERT(dirp
->fsp
->dptr
->dir_hnd
== dirp
);
1451 dirp
->fsp
->dptr
->dir_hnd
= NULL
;
1456 if (dirp
->conn
->sconn
&& !dirp
->conn
->sconn
->using_smb2
) {
1457 dirp
->conn
->sconn
->searches
.dirhandles_open
--;
1462 /*******************************************************************
1464 ********************************************************************/
1466 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1471 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1472 struct smbd_server_connection
*sconn
= conn
->sconn
;
1479 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1481 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1482 if (!dirp
->dir_path
) {
1487 if (sconn
&& !sconn
->using_smb2
) {
1488 sconn
->searches
.dirhandles_open
++;
1490 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1492 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1494 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1506 /*******************************************************************
1507 Open a directory from an fsp.
1508 ********************************************************************/
1510 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1515 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1516 struct smbd_server_connection
*sconn
= conn
->sconn
;
1523 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1525 dirp
->dir_path
= talloc_strdup(dirp
, fsp
->fsp_name
->base_name
);
1526 if (!dirp
->dir_path
) {
1531 if (sconn
&& !sconn
->using_smb2
) {
1532 sconn
->searches
.dirhandles_open
++;
1534 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1536 if (fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
1537 dirp
->dir
= SMB_VFS_FDOPENDIR(fsp
, mask
, attr
);
1538 if (dirp
->dir
!= NULL
) {
1541 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1545 if (errno
!= ENOSYS
) {
1551 if (dirp
->dir
== NULL
) {
1552 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1553 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1557 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp
->dir_path
,
1570 /*******************************************************************
1571 Read from a directory.
1572 Return directory entry, current offset, and optional stat information.
1573 Don't check for veto or invisible files.
1574 ********************************************************************/
1576 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
,
1577 SMB_STRUCT_STAT
*sbuf
, char **ptalloced
)
1580 char *talloced
= NULL
;
1581 connection_struct
*conn
= dirp
->conn
;
1583 /* Cheat to allow . and .. to be the first entries returned. */
1584 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) ||
1585 (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2))
1587 if (dirp
->file_number
== 0) {
1589 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1592 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1594 dirp
->file_number
++;
1597 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1598 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1601 /* A real offset, seek to it. */
1602 SeekDir(dirp
, *poffset
);
1605 while ((n
= vfs_readdirname(conn
, dirp
->dir
, sbuf
, &talloced
))) {
1606 /* Ignore . and .. - we've already returned them. */
1608 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1609 TALLOC_FREE(talloced
);
1613 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1614 *ptalloced
= talloced
;
1615 dirp
->file_number
++;
1618 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1623 /*******************************************************************
1624 Rewind to the start.
1625 ********************************************************************/
1627 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1629 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1630 dirp
->file_number
= 0;
1631 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1632 *poffset
= START_OF_DIRECTORY_OFFSET
;
1635 /*******************************************************************
1637 ********************************************************************/
1639 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1641 if (offset
!= dirp
->offset
) {
1642 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1643 RewindDir(dirp
, &offset
);
1645 * Ok we should really set the file number here
1646 * to 1 to enable ".." to be returned next. Trouble
1647 * is I'm worried about callers using SeekDir(dirp,0)
1648 * as equivalent to RewindDir(). So leave this alone
1651 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1652 RewindDir(dirp
, &offset
);
1654 * Set the file number to 2 - we want to get the first
1655 * real file entry (the one we return after "..")
1656 * on the next ReadDir.
1658 dirp
->file_number
= 2;
1659 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1660 ; /* Don't seek in this case. */
1662 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1664 dirp
->offset
= offset
;
1668 /*******************************************************************
1669 Tell a dir position.
1670 ********************************************************************/
1672 long TellDir(struct smb_Dir
*dirp
)
1674 return(dirp
->offset
);
1677 /*******************************************************************
1678 Add an entry into the dcache.
1679 ********************************************************************/
1681 void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1683 struct name_cache_entry
*e
;
1685 if (dirp
->name_cache_size
== 0) {
1689 if (dirp
->name_cache
== NULL
) {
1690 dirp
->name_cache
= talloc_zero_array(
1691 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1693 if (dirp
->name_cache
== NULL
) {
1698 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1699 dirp
->name_cache_size
;
1700 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1701 TALLOC_FREE(e
->name
);
1702 e
->name
= talloc_strdup(dirp
, name
);
1706 /*******************************************************************
1707 Find an entry by name. Leave us at the offset after it.
1708 Don't check for veto or invisible files.
1709 ********************************************************************/
1711 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1714 const char *entry
= NULL
;
1715 char *talloced
= NULL
;
1716 connection_struct
*conn
= dirp
->conn
;
1718 /* Search back in the name cache. */
1719 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1720 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1721 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1722 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1723 *poffset
= e
->offset
;
1724 SeekDir(dirp
, e
->offset
);
1728 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1729 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1730 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1731 *poffset
= e
->offset
;
1732 SeekDir(dirp
, e
->offset
);
1738 /* Not found in the name cache. Rewind directory and start from scratch. */
1739 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1740 dirp
->file_number
= 0;
1741 *poffset
= START_OF_DIRECTORY_OFFSET
;
1742 while ((entry
= ReadDirName(dirp
, poffset
, NULL
, &talloced
))) {
1743 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1744 TALLOC_FREE(talloced
);
1747 TALLOC_FREE(talloced
);
1752 /*****************************************************************
1753 Is this directory empty ?
1754 *****************************************************************/
1756 NTSTATUS
can_delete_directory_fsp(files_struct
*fsp
)
1758 NTSTATUS status
= NT_STATUS_OK
;
1760 const char *dname
= NULL
;
1761 const char *dirname
= fsp
->fsp_name
->base_name
;
1762 char *talloced
= NULL
;
1764 struct connection_struct
*conn
= fsp
->conn
;
1765 struct smb_Dir
*dir_hnd
= OpenDir_fsp(talloc_tos(),
1772 return map_nt_error_from_unix(errno
);
1775 while ((dname
= ReadDirName(dir_hnd
, &dirpos
, &st
, &talloced
))) {
1776 /* Quick check for "." and ".." */
1777 if (dname
[0] == '.') {
1778 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1779 TALLOC_FREE(talloced
);
1784 if (!is_visible_file(conn
, dirname
, dname
, &st
, True
)) {
1785 TALLOC_FREE(talloced
);
1789 DEBUG(10,("got name %s - can't delete\n",
1791 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1794 TALLOC_FREE(talloced
);
1795 TALLOC_FREE(dir_hnd
);