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"
28 This module implements directory related functions for Samba.
31 /* "Special" directory offsets. */
32 #define END_OF_DIRECTORY_OFFSET ((long)-1)
33 #define START_OF_DIRECTORY_OFFSET ((long)0)
34 #define DOT_DOT_DIRECTORY_OFFSET ((long)0x80000000)
36 /* Make directory handle internals available. */
38 struct name_cache_entry
{
44 connection_struct
*conn
;
48 size_t name_cache_size
;
49 struct name_cache_entry
*name_cache
;
50 unsigned int name_cache_index
;
51 unsigned int file_number
;
52 files_struct
*fsp
; /* Back pointer to containing fsp, only
53 set from OpenDir_fsp(). */
57 struct dptr_struct
*next
, *prev
;
60 struct connection_struct
*conn
;
61 struct smb_Dir
*dir_hnd
;
66 bool has_wild
; /* Set to true if the wcard entry has MS wildcard characters in it. */
67 bool did_stat
; /* Optimisation for non-wcard searches. */
70 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
75 #define INVALID_DPTR_KEY (-3)
77 /****************************************************************************
79 ****************************************************************************/
81 bool make_dir_struct(TALLOC_CTX
*ctx
,
91 char *mask2
= talloc_strdup(ctx
, mask
);
97 if ((mode
& FILE_ATTRIBUTE_DIRECTORY
) != 0) {
101 memset(buf
+1,' ',11);
102 if ((p
= strchr_m(mask2
,'.')) != NULL
) {
104 push_ascii(buf
+1,mask2
,8, 0);
105 push_ascii(buf
+9,p
+1,3, 0);
108 push_ascii(buf
+1,mask2
,11, 0);
111 memset(buf
+21,'\0',DIR_STRUCT_SIZE
-21);
113 srv_put_dos_date(buf
,22,date
);
114 SSVAL(buf
,26,size
& 0xFFFF);
115 SSVAL(buf
,28,(size
>> 16)&0xFFFF);
116 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
117 Strange, but verified on W2K3. Needed for OS/2. JRA. */
118 push_ascii(buf
+30,fname
,12, uc
? STR_UPPER
: 0);
119 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf
+30, fname
));
123 /****************************************************************************
124 Initialise the dir bitmap.
125 ****************************************************************************/
127 bool init_dptrs(struct smbd_server_connection
*sconn
)
129 if (sconn
->searches
.dptr_bmap
) {
133 sconn
->searches
.dptr_bmap
= bitmap_talloc(
134 sconn
, MAX_DIRECTORY_HANDLES
);
136 if (sconn
->searches
.dptr_bmap
== NULL
) {
143 /****************************************************************************
144 Idle a dptr - the directory is closed but the control info is kept.
145 ****************************************************************************/
147 static void dptr_idle(struct dptr_struct
*dptr
)
150 DEBUG(4,("Idling dptr dnum %d\n",dptr
->dnum
));
151 TALLOC_FREE(dptr
->dir_hnd
);
155 /****************************************************************************
156 Idle the oldest dptr.
157 ****************************************************************************/
159 static void dptr_idleoldest(struct smbd_server_connection
*sconn
)
161 struct dptr_struct
*dptr
;
164 * Go to the end of the list.
166 dptr
= DLIST_TAIL(sconn
->searches
.dirptrs
);
169 DEBUG(0,("No dptrs available to idle ?\n"));
174 * Idle the oldest pointer.
177 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
185 /****************************************************************************
186 Get the struct dptr_struct for a dir index.
187 ****************************************************************************/
189 static struct dptr_struct
*dptr_get(struct smbd_server_connection
*sconn
,
190 int key
, bool forclose
)
192 struct dptr_struct
*dptr
;
194 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
195 if(dptr
->dnum
== key
) {
196 if (!forclose
&& !dptr
->dir_hnd
) {
197 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
)
198 dptr_idleoldest(sconn
);
199 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key
));
200 if (!(dptr
->dir_hnd
= OpenDir(
201 NULL
, dptr
->conn
, dptr
->path
,
202 dptr
->wcard
, dptr
->attr
))) {
203 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr
->path
,
208 DLIST_PROMOTE(sconn
->searches
.dirptrs
,dptr
);
215 /****************************************************************************
216 Get the dir path for a dir index.
217 ****************************************************************************/
219 char *dptr_path(struct smbd_server_connection
*sconn
, int key
)
221 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
227 /****************************************************************************
228 Get the dir wcard for a dir index.
229 ****************************************************************************/
231 char *dptr_wcard(struct smbd_server_connection
*sconn
, int key
)
233 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
239 /****************************************************************************
240 Get the dir attrib for a dir index.
241 ****************************************************************************/
243 uint16
dptr_attr(struct smbd_server_connection
*sconn
, int key
)
245 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
251 /****************************************************************************
252 Close a dptr (internal func).
253 ****************************************************************************/
255 static void dptr_close_internal(struct dptr_struct
*dptr
)
257 struct smbd_server_connection
*sconn
= dptr
->conn
->sconn
;
259 DEBUG(4,("closing dptr key %d\n",dptr
->dnum
));
265 if (sconn
->using_smb2
) {
269 DLIST_REMOVE(sconn
->searches
.dirptrs
, dptr
);
272 * Free the dnum in the bitmap. Remember the dnum value is always
273 * biased by one with respect to the bitmap.
276 if (!bitmap_query(sconn
->searches
.dptr_bmap
, dptr
->dnum
- 1)) {
277 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
281 bitmap_clear(sconn
->searches
.dptr_bmap
, dptr
->dnum
- 1);
284 TALLOC_FREE(dptr
->dir_hnd
);
286 /* Lanman 2 specific code */
287 SAFE_FREE(dptr
->wcard
);
288 SAFE_FREE(dptr
->path
);
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 Create a new dir ptr. If the flag old_handle is true then we must allocate
421 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
422 one byte long. If old_handle is false we allocate from the range
423 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
424 a directory handle is never zero.
425 wcard must not be zero.
426 ****************************************************************************/
428 NTSTATUS
dptr_create(connection_struct
*conn
, files_struct
*fsp
,
429 const char *path
, bool old_handle
, bool expect_close
,uint16 spid
,
430 const char *wcard
, bool wcard_has_wild
, uint32 attr
, struct dptr_struct
**dptr_ret
)
432 struct smbd_server_connection
*sconn
= conn
->sconn
;
433 struct dptr_struct
*dptr
= NULL
;
434 struct smb_Dir
*dir_hnd
;
437 if (fsp
&& fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
438 path
= fsp
->fsp_name
->base_name
;
441 DEBUG(5,("dptr_create dir=%s\n", path
));
444 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
445 return NT_STATUS_INTERNAL_ERROR
;
449 return NT_STATUS_INVALID_PARAMETER
;
453 dir_hnd
= OpenDir_fsp(NULL
, conn
, fsp
, wcard
, attr
);
455 status
= check_name(conn
,path
);
456 if (!NT_STATUS_IS_OK(status
)) {
459 dir_hnd
= OpenDir(NULL
, conn
, path
, wcard
, attr
);
463 return map_nt_error_from_unix(errno
);
466 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
) {
467 dptr_idleoldest(sconn
);
470 dptr
= SMB_MALLOC_P(struct dptr_struct
);
472 DEBUG(0,("malloc fail in dptr_create.\n"));
473 TALLOC_FREE(dir_hnd
);
474 return NT_STATUS_NO_MEMORY
;
479 dptr
->path
= SMB_STRDUP(path
);
482 TALLOC_FREE(dir_hnd
);
483 return NT_STATUS_NO_MEMORY
;
486 dptr
->dir_hnd
= dir_hnd
;
488 dptr
->expect_close
= expect_close
;
489 dptr
->wcard
= SMB_STRDUP(wcard
);
491 SAFE_FREE(dptr
->path
);
493 TALLOC_FREE(dir_hnd
);
494 return NT_STATUS_NO_MEMORY
;
496 if (lp_posix_pathnames() || (wcard
[0] == '.' && wcard
[1] == 0)) {
497 dptr
->has_wild
= True
;
499 dptr
->has_wild
= wcard_has_wild
;
504 if (sconn
->using_smb2
) {
511 * This is an old-style SMBsearch request. Ensure the
512 * value we return will fit in the range 1-255.
515 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
517 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
520 * Try and close the oldest handle not marked for
521 * expect close in the hope that the client has
522 * finished with that one.
525 dptr_close_oldest(sconn
, true);
527 /* Now try again... */
528 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
529 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
530 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr
->dnum
));
531 SAFE_FREE(dptr
->path
);
532 SAFE_FREE(dptr
->wcard
);
534 TALLOC_FREE(dir_hnd
);
535 return NT_STATUS_TOO_MANY_OPENED_FILES
;
541 * This is a new-style trans2 request. Allocate from
542 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
545 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
547 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
550 * Try and close the oldest handle close in the hope that
551 * the client has finished with that one. This will only
552 * happen in the case of the Win98 client bug where it leaks
556 dptr_close_oldest(sconn
, false);
558 /* Now try again... */
559 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
561 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
562 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr
->dnum
));
563 SAFE_FREE(dptr
->path
);
564 SAFE_FREE(dptr
->wcard
);
566 TALLOC_FREE(dir_hnd
);
567 return NT_STATUS_TOO_MANY_OPENED_FILES
;
572 bitmap_set(sconn
->searches
.dptr_bmap
, dptr
->dnum
);
574 dptr
->dnum
+= 1; /* Always bias the dnum by one - no zero dnums allowed. */
576 DLIST_ADD(sconn
->searches
.dirptrs
, dptr
);
579 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
580 dptr
->dnum
,path
,expect_close
));
588 /****************************************************************************
589 Wrapper functions to access the lower level directory handles.
590 ****************************************************************************/
592 void dptr_CloseDir(files_struct
*fsp
)
596 * Ugly hack. We have defined fdopendir to return ENOSYS if dirfd also isn't
597 * present. I hate Solaris. JRA.
600 if (fsp
->fh
->fd
!= -1 &&
601 fsp
->dptr
->dir_hnd
&&
602 dirfd(fsp
->dptr
->dir_hnd
->dir
)) {
603 /* The call below closes the underlying fd. */
607 dptr_close_internal(fsp
->dptr
);
612 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
614 SeekDir(dptr
->dir_hnd
, offset
);
617 long dptr_TellDir(struct dptr_struct
*dptr
)
619 return TellDir(dptr
->dir_hnd
);
622 bool dptr_has_wild(struct dptr_struct
*dptr
)
624 return dptr
->has_wild
;
627 int dptr_dnum(struct dptr_struct
*dptr
)
632 /****************************************************************************
633 Return the next visible file name, skipping veto'd and invisible files.
634 ****************************************************************************/
636 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
,
637 long *poffset
, SMB_STRUCT_STAT
*pst
,
640 /* Normal search for the next file. */
642 char *talloced
= NULL
;
644 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
, pst
, &talloced
))
646 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
647 *ptalloced
= talloced
;
650 TALLOC_FREE(talloced
);
655 /****************************************************************************
656 Return the next visible file name, skipping veto'd and invisible files.
657 ****************************************************************************/
659 char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
660 struct dptr_struct
*dptr
,
662 SMB_STRUCT_STAT
*pst
)
664 struct smb_filename smb_fname_base
;
666 const char *name_temp
= NULL
;
667 char *talloced
= NULL
;
668 char *pathreal
= NULL
;
669 char *found_name
= NULL
;
672 SET_STAT_INVALID(*pst
);
674 if (dptr
->has_wild
|| dptr
->did_stat
) {
675 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
,
677 if (name_temp
== NULL
) {
680 if (talloced
!= NULL
) {
681 return talloc_move(ctx
, &talloced
);
683 return talloc_strdup(ctx
, name_temp
);
686 /* If poffset is -1 then we know we returned this name before and we
687 * have no wildcards. We're at the end of the directory. */
688 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
692 /* We know the stored wcard contains no wildcard characters.
693 * See if we can match with a stat call. If we can't, then set
694 * did_stat to true to ensure we only do this once and keep
697 dptr
->did_stat
= true;
699 /* First check if it should be visible. */
700 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
,
703 /* This only returns false if the file was found, but
704 is explicitly not visible. Set us to end of
705 directory, but return NULL as we know we can't ever
710 if (VALID_STAT(*pst
)) {
711 name
= talloc_strdup(ctx
, dptr
->wcard
);
715 pathreal
= talloc_asprintf(ctx
,
722 /* Create an smb_filename with stream_name == NULL. */
723 ZERO_STRUCT(smb_fname_base
);
724 smb_fname_base
.base_name
= pathreal
;
726 if (SMB_VFS_STAT(dptr
->conn
, &smb_fname_base
) == 0) {
727 *pst
= smb_fname_base
.st
;
728 name
= talloc_strdup(ctx
, dptr
->wcard
);
731 /* If we get any other error than ENOENT or ENOTDIR
732 then the file exists we just can't stat it. */
733 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
734 name
= talloc_strdup(ctx
, dptr
->wcard
);
739 /* Stat failed. We know this is authoratiative if we are
740 * providing case sensitive semantics or the underlying
741 * filesystem is case sensitive.
743 if (dptr
->conn
->case_sensitive
||
744 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
))
750 * Try case-insensitive stat if the fs has the ability. This avoids
751 * scanning the whole directory.
753 ret
= SMB_VFS_GET_REAL_FILENAME(dptr
->conn
, dptr
->path
, dptr
->wcard
,
758 } else if (errno
== ENOENT
) {
759 /* The case-insensitive lookup was authoritative. */
763 TALLOC_FREE(pathreal
);
765 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
, &talloced
);
766 if (name_temp
== NULL
) {
769 if (talloced
!= NULL
) {
770 return talloc_move(ctx
, &talloced
);
772 return talloc_strdup(ctx
, name_temp
);
775 TALLOC_FREE(pathreal
);
777 /* We need to set the underlying dir_hnd offset to -1
778 * also as this function is usually called with the
779 * output from TellDir. */
780 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
784 /****************************************************************************
785 Search for a file by name, skipping veto'ed and not visible files.
786 ****************************************************************************/
788 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
790 SET_STAT_INVALID(*pst
);
792 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
793 /* This is a singleton directory and we're already at the end. */
794 *poffset
= END_OF_DIRECTORY_OFFSET
;
798 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
801 /****************************************************************************
802 Add the name we're returning into the underlying cache.
803 ****************************************************************************/
805 void dptr_DirCacheAdd(struct dptr_struct
*dptr
, const char *name
, long offset
)
807 DirCacheAdd(dptr
->dir_hnd
, name
, offset
);
810 /****************************************************************************
811 Initialize variables & state data at the beginning of all search SMB requests.
812 ****************************************************************************/
813 void dptr_init_search_op(struct dptr_struct
*dptr
)
815 SMB_VFS_INIT_SEARCH_OP(dptr
->conn
, dptr
->dir_hnd
->dir
);
818 /****************************************************************************
819 Fill the 5 byte server reserved dptr field.
820 ****************************************************************************/
822 bool dptr_fill(struct smbd_server_connection
*sconn
,
823 char *buf1
,unsigned int key
)
825 unsigned char *buf
= (unsigned char *)buf1
;
826 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
829 DEBUG(1,("filling null dirptr %d\n",key
));
832 offset
= (uint32
)TellDir(dptr
->dir_hnd
);
833 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
834 (long)dptr
->dir_hnd
,(int)offset
));
840 /****************************************************************************
841 Fetch the dir ptr and seek it given the 5 byte server field.
842 ****************************************************************************/
844 struct dptr_struct
*dptr_fetch(struct smbd_server_connection
*sconn
,
847 unsigned int key
= *(unsigned char *)buf
;
848 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
853 DEBUG(3,("fetched null dirptr %d\n",key
));
857 offset
= IVAL(buf
,1);
858 if (offset
== (uint32
)-1) {
859 seekoff
= END_OF_DIRECTORY_OFFSET
;
861 seekoff
= (long)offset
;
863 SeekDir(dptr
->dir_hnd
,seekoff
);
864 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
865 key
, dptr
->path
, (int)seekoff
));
869 /****************************************************************************
871 ****************************************************************************/
873 struct dptr_struct
*dptr_fetch_lanman2(struct smbd_server_connection
*sconn
,
876 struct dptr_struct
*dptr
= dptr_get(sconn
, dptr_num
, false);
879 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
882 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr
->path
));
886 /****************************************************************************
887 Check that a file matches a particular file type.
888 ****************************************************************************/
890 bool dir_check_ftype(connection_struct
*conn
, uint32 mode
, uint32 dirtype
)
894 /* Check the "may have" search bits. */
895 if (((mode
& ~dirtype
) & (FILE_ATTRIBUTE_HIDDEN
| FILE_ATTRIBUTE_SYSTEM
| FILE_ATTRIBUTE_DIRECTORY
)) != 0)
898 /* Check the "must have" bits, which are the may have bits shifted eight */
899 /* If must have bit is set, the file/dir can not be returned in search unless the matching
900 file attribute is set */
901 mask
= ((dirtype
>> 8) & (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
)); /* & 0x37 */
903 if((mask
& (mode
& (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
))) == mask
) /* check if matching attribute present */
912 static bool mangle_mask_match(connection_struct
*conn
,
913 const char *filename
,
918 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
921 return mask_match_search(mname
,mask
,False
);
924 bool smbd_dirptr_get_entry(TALLOC_CTX
*ctx
,
925 struct dptr_struct
*dirptr
,
930 bool (*match_fn
)(TALLOC_CTX
*ctx
,
935 bool (*mode_fn
)(TALLOC_CTX
*ctx
,
937 struct smb_filename
*smb_fname
,
941 struct smb_filename
**_smb_fname
,
945 connection_struct
*conn
= dirptr
->conn
;
952 pathlen
= strlen(dirptr
->path
);
953 slashlen
= ( dirptr
->path
[pathlen
-1] != '/') ? 1 : 0;
958 SMB_STRUCT_STAT sbuf
;
962 char *pathreal
= NULL
;
963 struct smb_filename smb_fname
;
968 cur_offset
= dptr_TellDir(dirptr
);
969 prev_offset
= cur_offset
;
970 dname
= dptr_ReadDirName(ctx
, dirptr
, &cur_offset
, &sbuf
);
972 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
973 (long)dirptr
, cur_offset
));
979 isdots
= (ISDOT(dname
) || ISDOTDOT(dname
));
980 if (dont_descend
&& !isdots
) {
986 * fname may get mangled, dname is never mangled.
987 * Whenever we're accessing the filesystem we use
988 * pathreal which is composed from dname.
991 ok
= match_fn(ctx
, private_data
, dname
, mask
, &fname
);
999 * pathreal = talloc_asprintf(ctx, "%s%s%s", dirptr->path,
1000 * needslash?"/":"", dname);
1001 * but this was measurably slower than doing the memcpy.
1004 pathreal
= talloc_array(
1006 pathlen
+ slashlen
+ talloc_get_size(dname
));
1013 memcpy(pathreal
, dirptr
->path
, pathlen
);
1014 pathreal
[pathlen
] = '/';
1015 memcpy(pathreal
+ slashlen
+ pathlen
, dname
,
1016 talloc_get_size(dname
));
1018 /* Create smb_fname with NULL stream_name. */
1019 ZERO_STRUCT(smb_fname
);
1020 smb_fname
.base_name
= pathreal
;
1021 smb_fname
.st
= sbuf
;
1023 ok
= mode_fn(ctx
, private_data
, &smb_fname
, &mode
);
1027 TALLOC_FREE(pathreal
);
1031 if (!dir_check_ftype(conn
, mode
, dirtype
)) {
1032 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1033 fname
, (unsigned int)mode
, (unsigned int)dirtype
));
1036 TALLOC_FREE(pathreal
);
1040 if (ask_sharemode
) {
1041 struct timespec write_time_ts
;
1042 struct file_id fileid
;
1044 fileid
= vfs_file_id_from_sbuf(conn
,
1046 get_file_infos(fileid
, 0, NULL
, &write_time_ts
);
1047 if (!null_timespec(write_time_ts
)) {
1048 update_stat_ex_mtime(&smb_fname
.st
,
1053 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1055 mask
, smb_fname_str_dbg(&smb_fname
),
1058 DirCacheAdd(dirptr
->dir_hnd
, dname
, cur_offset
);
1062 status
= copy_smb_filename(ctx
, &smb_fname
, _smb_fname
);
1063 TALLOC_FREE(pathreal
);
1064 if (!NT_STATUS_IS_OK(status
)) {
1069 *_prev_offset
= prev_offset
;
1077 /****************************************************************************
1078 Get an 8.3 directory entry.
1079 ****************************************************************************/
1081 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX
*ctx
,
1087 connection_struct
*conn
= (connection_struct
*)private_data
;
1089 if ((strcmp(mask
,"*.*") == 0) ||
1090 mask_match_search(dname
, mask
, false) ||
1091 mangle_mask_match(conn
, dname
, mask
)) {
1095 if (!mangle_is_8_3(dname
, false, conn
->params
)) {
1096 bool ok
= name_to_8_3(dname
, mname
, false,
1106 *_fname
= talloc_strdup(ctx
, fname
);
1107 if (*_fname
== NULL
) {
1117 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX
*ctx
,
1119 struct smb_filename
*smb_fname
,
1122 connection_struct
*conn
= (connection_struct
*)private_data
;
1124 if (!VALID_STAT(smb_fname
->st
)) {
1125 if ((SMB_VFS_STAT(conn
, smb_fname
)) != 0) {
1126 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1127 "Couldn't stat [%s]. Error "
1129 smb_fname_str_dbg(smb_fname
),
1135 *_mode
= dos_mode(conn
, smb_fname
);
1139 bool get_dir_entry(TALLOC_CTX
*ctx
,
1140 struct dptr_struct
*dirptr
,
1146 struct timespec
*_date
,
1150 connection_struct
*conn
= dirptr
->conn
;
1152 struct smb_filename
*smb_fname
= NULL
;
1157 ok
= smbd_dirptr_get_entry(ctx
,
1163 smbd_dirptr_8_3_match_fn
,
1164 smbd_dirptr_8_3_mode_fn
,
1174 *_fname
= talloc_move(ctx
, &fname
);
1175 *_size
= smb_fname
->st
.st_ex_size
;
1177 *_date
= smb_fname
->st
.st_ex_mtime
;
1178 TALLOC_FREE(smb_fname
);
1182 /*******************************************************************
1183 Check to see if a user can read a file. This is only approximate,
1184 it is used as part of the "hide unreadable" option. Don't
1185 use it for anything security sensitive.
1186 ********************************************************************/
1188 static bool user_can_read_file(connection_struct
*conn
,
1189 struct smb_filename
*smb_fname
)
1192 * Never hide files from the root user.
1193 * We use (uid_t)0 here not sec_initial_uid()
1194 * as make test uses a single user context.
1197 if (get_current_uid(conn
) == (uid_t
)0) {
1201 return can_access_file_acl(conn
, smb_fname
, FILE_READ_DATA
);
1204 /*******************************************************************
1205 Check to see if a user can write a file (and only files, we do not
1206 check dirs on this one). This is only approximate,
1207 it is used as part of the "hide unwriteable" option. Don't
1208 use it for anything security sensitive.
1209 ********************************************************************/
1211 static bool user_can_write_file(connection_struct
*conn
,
1212 const struct smb_filename
*smb_fname
)
1215 * Never hide files from the root user.
1216 * We use (uid_t)0 here not sec_initial_uid()
1217 * as make test uses a single user context.
1220 if (get_current_uid(conn
) == (uid_t
)0) {
1224 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1226 /* Pseudo-open the file */
1228 if(S_ISDIR(smb_fname
->st
.st_ex_mode
)) {
1232 return can_write_to_file(conn
, smb_fname
);
1235 /*******************************************************************
1236 Is a file a "special" type ?
1237 ********************************************************************/
1239 static bool file_is_special(connection_struct
*conn
,
1240 const struct smb_filename
*smb_fname
)
1243 * Never hide files from the root user.
1244 * We use (uid_t)0 here not sec_initial_uid()
1245 * as make test uses a single user context.
1248 if (get_current_uid(conn
) == (uid_t
)0) {
1252 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1254 if (S_ISREG(smb_fname
->st
.st_ex_mode
) ||
1255 S_ISDIR(smb_fname
->st
.st_ex_mode
) ||
1256 S_ISLNK(smb_fname
->st
.st_ex_mode
))
1262 /*******************************************************************
1263 Should the file be seen by the client?
1264 NOTE: A successful return is no guarantee of the file's existence.
1265 ********************************************************************/
1267 bool is_visible_file(connection_struct
*conn
, const char *dir_path
,
1268 const char *name
, SMB_STRUCT_STAT
*pst
, bool use_veto
)
1270 bool hide_unreadable
= lp_hideunreadable(SNUM(conn
));
1271 bool hide_unwriteable
= lp_hideunwriteable_files(SNUM(conn
));
1272 bool hide_special
= lp_hide_special_files(SNUM(conn
));
1274 struct smb_filename
*smb_fname_base
= NULL
;
1278 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1279 return True
; /* . and .. are always visible. */
1282 /* If it's a vetoed file, pretend it doesn't even exist */
1283 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1284 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1288 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1289 entry
= talloc_asprintf(talloc_tos(), "%s/%s", dir_path
, name
);
1295 /* Create an smb_filename with stream_name == NULL. */
1296 status
= create_synthetic_smb_fname(talloc_tos(), entry
, NULL
,
1297 pst
, &smb_fname_base
);
1298 if (!NT_STATUS_IS_OK(status
)) {
1303 /* If the file name does not exist, there's no point checking
1304 * the configuration options. We succeed, on the basis that the
1305 * checks *might* have passed if the file was present.
1307 if (!VALID_STAT(*pst
)) {
1308 if (SMB_VFS_STAT(conn
, smb_fname_base
) != 0) {
1312 *pst
= smb_fname_base
->st
;
1316 /* Honour _hide unreadable_ option */
1317 if (hide_unreadable
&&
1318 !user_can_read_file(conn
, smb_fname_base
)) {
1319 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1324 /* Honour _hide unwriteable_ option */
1325 if (hide_unwriteable
&& !user_can_write_file(conn
,
1327 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1332 /* Honour _hide_special_ option */
1333 if (hide_special
&& file_is_special(conn
, smb_fname_base
)) {
1334 DEBUG(10,("is_visible_file: file %s is special.\n",
1343 TALLOC_FREE(smb_fname_base
);
1348 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1352 if (dirp
->conn
->sconn
) {
1353 files_struct
*fsp
= file_find_fd(dirp
->conn
->sconn
,
1356 /* The call below closes the underlying fd. */
1361 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1363 if (dirp
->conn
->sconn
&& !dirp
->conn
->sconn
->using_smb2
) {
1364 dirp
->conn
->sconn
->searches
.dirhandles_open
--;
1369 /*******************************************************************
1371 ********************************************************************/
1373 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1378 struct smb_Dir
*dirp
= TALLOC_ZERO_P(mem_ctx
, struct smb_Dir
);
1379 struct smbd_server_connection
*sconn
= conn
->sconn
;
1386 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1388 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1389 if (!dirp
->dir_path
) {
1394 if (sconn
&& !sconn
->using_smb2
) {
1395 sconn
->searches
.dirhandles_open
++;
1397 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1399 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1401 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1413 /*******************************************************************
1414 Open a directory from an fsp.
1415 ********************************************************************/
1417 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1422 struct smb_Dir
*dirp
= TALLOC_ZERO_P(mem_ctx
, struct smb_Dir
);
1423 struct smbd_server_connection
*sconn
= conn
->sconn
;
1430 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1432 dirp
->dir_path
= talloc_strdup(dirp
, fsp
->fsp_name
->base_name
);
1433 if (!dirp
->dir_path
) {
1438 if (sconn
&& !sconn
->using_smb2
) {
1439 sconn
->searches
.dirhandles_open
++;
1441 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1443 if (fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
1444 dirp
->dir
= SMB_VFS_FDOPENDIR(fsp
, mask
, attr
);
1445 if (dirp
->dir
!= NULL
) {
1448 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1452 if (errno
!= ENOSYS
) {
1458 if (dirp
->dir
== NULL
) {
1459 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1460 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1464 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp
->dir_path
,
1477 /*******************************************************************
1478 Read from a directory.
1479 Return directory entry, current offset, and optional stat information.
1480 Don't check for veto or invisible files.
1481 ********************************************************************/
1483 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
,
1484 SMB_STRUCT_STAT
*sbuf
, char **ptalloced
)
1487 char *talloced
= NULL
;
1488 connection_struct
*conn
= dirp
->conn
;
1490 /* Cheat to allow . and .. to be the first entries returned. */
1491 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) ||
1492 (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2))
1494 if (dirp
->file_number
== 0) {
1496 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1499 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1501 dirp
->file_number
++;
1504 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1505 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1508 /* A real offset, seek to it. */
1509 SeekDir(dirp
, *poffset
);
1512 while ((n
= vfs_readdirname(conn
, dirp
->dir
, sbuf
, &talloced
))) {
1513 /* Ignore . and .. - we've already returned them. */
1515 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1516 TALLOC_FREE(talloced
);
1520 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1521 *ptalloced
= talloced
;
1522 dirp
->file_number
++;
1525 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1530 /*******************************************************************
1531 Rewind to the start.
1532 ********************************************************************/
1534 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1536 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1537 dirp
->file_number
= 0;
1538 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1539 *poffset
= START_OF_DIRECTORY_OFFSET
;
1542 /*******************************************************************
1544 ********************************************************************/
1546 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1548 if (offset
!= dirp
->offset
) {
1549 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1550 RewindDir(dirp
, &offset
);
1552 * Ok we should really set the file number here
1553 * to 1 to enable ".." to be returned next. Trouble
1554 * is I'm worried about callers using SeekDir(dirp,0)
1555 * as equivalent to RewindDir(). So leave this alone
1558 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1559 RewindDir(dirp
, &offset
);
1561 * Set the file number to 2 - we want to get the first
1562 * real file entry (the one we return after "..")
1563 * on the next ReadDir.
1565 dirp
->file_number
= 2;
1566 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1567 ; /* Don't seek in this case. */
1569 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1571 dirp
->offset
= offset
;
1575 /*******************************************************************
1576 Tell a dir position.
1577 ********************************************************************/
1579 long TellDir(struct smb_Dir
*dirp
)
1581 return(dirp
->offset
);
1584 /*******************************************************************
1585 Add an entry into the dcache.
1586 ********************************************************************/
1588 void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1590 struct name_cache_entry
*e
;
1592 if (dirp
->name_cache_size
== 0) {
1596 if (dirp
->name_cache
== NULL
) {
1597 dirp
->name_cache
= TALLOC_ZERO_ARRAY(
1598 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1600 if (dirp
->name_cache
== NULL
) {
1605 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1606 dirp
->name_cache_size
;
1607 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1608 TALLOC_FREE(e
->name
);
1609 e
->name
= talloc_strdup(dirp
, name
);
1613 /*******************************************************************
1614 Find an entry by name. Leave us at the offset after it.
1615 Don't check for veto or invisible files.
1616 ********************************************************************/
1618 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1621 const char *entry
= NULL
;
1622 char *talloced
= NULL
;
1623 connection_struct
*conn
= dirp
->conn
;
1625 /* Search back in the name cache. */
1626 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1627 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1628 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1629 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1630 *poffset
= e
->offset
;
1631 SeekDir(dirp
, e
->offset
);
1635 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1636 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1637 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1638 *poffset
= e
->offset
;
1639 SeekDir(dirp
, e
->offset
);
1645 /* Not found in the name cache. Rewind directory and start from scratch. */
1646 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1647 dirp
->file_number
= 0;
1648 *poffset
= START_OF_DIRECTORY_OFFSET
;
1649 while ((entry
= ReadDirName(dirp
, poffset
, NULL
, &talloced
))) {
1650 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1651 TALLOC_FREE(talloced
);
1654 TALLOC_FREE(talloced
);
1659 /*****************************************************************
1660 Is this directory empty ?
1661 *****************************************************************/
1663 NTSTATUS
can_delete_directory_fsp(files_struct
*fsp
)
1665 NTSTATUS status
= NT_STATUS_OK
;
1667 const char *dname
= NULL
;
1668 char *talloced
= NULL
;
1670 struct connection_struct
*conn
= fsp
->conn
;
1671 struct smb_Dir
*dir_hnd
= OpenDir_fsp(talloc_tos(),
1678 return map_nt_error_from_unix(errno
);
1681 while ((dname
= ReadDirName(dir_hnd
, &dirpos
, &st
, &talloced
))) {
1682 /* Quick check for "." and ".." */
1683 if (dname
[0] == '.') {
1684 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1685 TALLOC_FREE(talloced
);
1690 if (!is_visible_file(conn
, fsp
->fsp_name
->base_name
, dname
, &st
, True
)) {
1691 TALLOC_FREE(talloced
);
1695 DEBUG(10,("can_delete_directory_fsp: got name %s - can't delete\n",
1697 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1700 TALLOC_FREE(talloced
);
1701 TALLOC_FREE(dir_hnd
);