2 Unix SMB/CIFS implementation.
3 Directory handling routines
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2007
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "system/filesys.h"
23 #include "smbd/smbd.h"
24 #include "smbd/globals.h"
25 #include "libcli/security/security.h"
26 #include "lib/util/bitmap.h"
29 This module implements directory related functions for Samba.
32 /* "Special" directory offsets. */
33 #define END_OF_DIRECTORY_OFFSET ((long)-1)
34 #define START_OF_DIRECTORY_OFFSET ((long)0)
35 #define DOT_DOT_DIRECTORY_OFFSET ((long)0x80000000)
37 /* Make directory handle internals available. */
39 struct name_cache_entry
{
45 connection_struct
*conn
;
49 size_t name_cache_size
;
50 struct name_cache_entry
*name_cache
;
51 unsigned int name_cache_index
;
52 unsigned int file_number
;
56 struct dptr_struct
*next
, *prev
;
59 struct connection_struct
*conn
;
60 struct smb_Dir
*dir_hnd
;
65 bool has_wild
; /* Set to true if the wcard entry has MS wildcard characters in it. */
66 bool did_stat
; /* Optimisation for non-wcard searches. */
67 bool priv
; /* Directory handle opened with privilege. */
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 const 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 const 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
);
288 /****************************************************************************
289 Close a dptr given a key.
290 ****************************************************************************/
292 void dptr_close(struct smbd_server_connection
*sconn
, int *key
)
294 struct dptr_struct
*dptr
;
296 if(*key
== INVALID_DPTR_KEY
)
299 /* OS/2 seems to use -1 to indicate "close all directories" */
301 struct dptr_struct
*next
;
302 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
304 dptr_close_internal(dptr
);
306 *key
= INVALID_DPTR_KEY
;
310 dptr
= dptr_get(sconn
, *key
, true);
313 DEBUG(0,("Invalid key %d given to dptr_close\n", *key
));
317 dptr_close_internal(dptr
);
319 *key
= INVALID_DPTR_KEY
;
322 /****************************************************************************
323 Close all dptrs for a cnum.
324 ****************************************************************************/
326 void dptr_closecnum(connection_struct
*conn
)
328 struct dptr_struct
*dptr
, *next
;
329 struct smbd_server_connection
*sconn
= conn
->sconn
;
335 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
337 if (dptr
->conn
== conn
) {
338 dptr_close_internal(dptr
);
343 /****************************************************************************
344 Idle all dptrs for a cnum.
345 ****************************************************************************/
347 void dptr_idlecnum(connection_struct
*conn
)
349 struct dptr_struct
*dptr
;
350 struct smbd_server_connection
*sconn
= conn
->sconn
;
356 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
357 if (dptr
->conn
== conn
&& dptr
->dir_hnd
) {
363 /****************************************************************************
364 Close a dptr that matches a given path, only if it matches the spid also.
365 ****************************************************************************/
367 void dptr_closepath(struct smbd_server_connection
*sconn
,
368 char *path
,uint16 spid
)
370 struct dptr_struct
*dptr
, *next
;
371 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
373 if (spid
== dptr
->spid
&& strequal(dptr
->path
,path
))
374 dptr_close_internal(dptr
);
378 /****************************************************************************
379 Try and close the oldest handle not marked for
380 expect close in the hope that the client has
381 finished with that one.
382 ****************************************************************************/
384 static void dptr_close_oldest(struct smbd_server_connection
*sconn
,
387 struct dptr_struct
*dptr
;
390 * Go to the end of the list.
392 for(dptr
= sconn
->searches
.dirptrs
; dptr
&& dptr
->next
; dptr
= dptr
->next
)
396 DEBUG(0,("No old dptrs available to close oldest ?\n"));
401 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
402 * does not have expect_close set. If 'old' is false, close
403 * one of the new dnum handles.
406 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
407 if ((old
&& (dptr
->dnum
< 256) && !dptr
->expect_close
) ||
408 (!old
&& (dptr
->dnum
> 255))) {
409 dptr_close_internal(dptr
);
415 /****************************************************************************
416 Safely do an OpenDir as root, ensuring we're in the right place.
417 ****************************************************************************/
419 static struct smb_Dir
*open_dir_with_privilege(connection_struct
*conn
,
420 struct smb_request
*req
,
426 struct smb_Dir
*dir_hnd
= NULL
;
427 struct smb_filename
*smb_fname_cwd
= NULL
;
428 char *saved_dir
= vfs_GetWd(talloc_tos(), conn
);
429 struct privilege_paths
*priv_paths
= req
->priv_paths
;
432 if (saved_dir
== NULL
) {
436 if (vfs_ChDir(conn
, path
) == -1) {
440 /* Now check the stat value is the same. */
441 status
= create_synthetic_smb_fname(talloc_tos(), ".",
445 if (!NT_STATUS_IS_OK(status
)) {
448 ret
= SMB_VFS_STAT(conn
, smb_fname_cwd
);
453 if (!check_same_stat(&smb_fname_cwd
->st
, &priv_paths
->parent_name
.st
)) {
454 DEBUG(0,("open_dir_with_privilege: stat mismatch between %s "
457 smb_fname_str_dbg(&priv_paths
->parent_name
)));
461 dir_hnd
= OpenDir(NULL
, conn
, ".", wcard
, attr
);
465 vfs_ChDir(conn
, saved_dir
);
469 /****************************************************************************
470 Create a new dir ptr. If the flag old_handle is true then we must allocate
471 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
472 one byte long. If old_handle is false we allocate from the range
473 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
474 a directory handle is never zero.
475 wcard must not be zero.
476 ****************************************************************************/
478 NTSTATUS
dptr_create(connection_struct
*conn
,
479 struct smb_request
*req
,
481 const char *path
, bool old_handle
, bool expect_close
,uint16 spid
,
482 const char *wcard
, bool wcard_has_wild
, uint32 attr
, struct dptr_struct
**dptr_ret
)
484 struct smbd_server_connection
*sconn
= conn
->sconn
;
485 struct dptr_struct
*dptr
= NULL
;
486 struct smb_Dir
*dir_hnd
;
488 if (fsp
&& fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
489 path
= fsp
->fsp_name
->base_name
;
492 DEBUG(5,("dptr_create dir=%s\n", path
));
495 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
496 return NT_STATUS_INTERNAL_ERROR
;
500 return NT_STATUS_INVALID_PARAMETER
;
504 if (!(fsp
->access_mask
& SEC_DIR_LIST
)) {
505 DEBUG(5,("dptr_create: directory %s "
506 "not open for LIST access\n",
508 return NT_STATUS_ACCESS_DENIED
;
510 dir_hnd
= OpenDir_fsp(NULL
, conn
, fsp
, wcard
, attr
);
513 bool backup_intent
= (req
&& req
->priv_paths
);
514 struct smb_filename
*smb_dname
= NULL
;
515 NTSTATUS status
= create_synthetic_smb_fname(talloc_tos(),
520 if (!NT_STATUS_IS_OK(status
)) {
523 if (lp_posix_pathnames()) {
524 ret
= SMB_VFS_LSTAT(conn
, smb_dname
);
526 ret
= SMB_VFS_STAT(conn
, smb_dname
);
529 return map_nt_error_from_unix(errno
);
531 if (!S_ISDIR(smb_dname
->st
.st_ex_mode
)) {
532 return NT_STATUS_NOT_A_DIRECTORY
;
534 status
= smbd_check_access_rights(conn
,
538 if (!NT_STATUS_IS_OK(status
)) {
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 * Ugly hack. We have defined fdopendir to return ENOSYS if dirfd also isn't
682 * present. I hate Solaris. JRA.
685 if (fsp
->fh
->fd
!= -1 &&
686 fsp
->dptr
->dir_hnd
&&
687 dirfd(fsp
->dptr
->dir_hnd
->dir
)) {
688 /* The call below closes the underlying fd. */
692 dptr_close_internal(fsp
->dptr
);
697 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
699 SeekDir(dptr
->dir_hnd
, offset
);
702 long dptr_TellDir(struct dptr_struct
*dptr
)
704 return TellDir(dptr
->dir_hnd
);
707 bool dptr_has_wild(struct dptr_struct
*dptr
)
709 return dptr
->has_wild
;
712 int dptr_dnum(struct dptr_struct
*dptr
)
717 bool dptr_get_priv(struct dptr_struct
*dptr
)
722 void dptr_set_priv(struct dptr_struct
*dptr
)
727 /****************************************************************************
728 Return the next visible file name, skipping veto'd and invisible files.
729 ****************************************************************************/
731 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
,
732 long *poffset
, SMB_STRUCT_STAT
*pst
,
735 /* Normal search for the next file. */
737 char *talloced
= NULL
;
739 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
, pst
, &talloced
))
741 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
742 *ptalloced
= talloced
;
745 TALLOC_FREE(talloced
);
750 /****************************************************************************
751 Return the next visible file name, skipping veto'd and invisible files.
752 ****************************************************************************/
754 char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
755 struct dptr_struct
*dptr
,
757 SMB_STRUCT_STAT
*pst
)
759 struct smb_filename smb_fname_base
;
761 const char *name_temp
= NULL
;
762 char *talloced
= NULL
;
763 char *pathreal
= NULL
;
764 char *found_name
= NULL
;
767 SET_STAT_INVALID(*pst
);
769 if (dptr
->has_wild
|| dptr
->did_stat
) {
770 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
,
772 if (name_temp
== NULL
) {
775 if (talloced
!= NULL
) {
776 return talloc_move(ctx
, &talloced
);
778 return talloc_strdup(ctx
, name_temp
);
781 /* If poffset is -1 then we know we returned this name before and we
782 * have no wildcards. We're at the end of the directory. */
783 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
787 /* We know the stored wcard contains no wildcard characters.
788 * See if we can match with a stat call. If we can't, then set
789 * did_stat to true to ensure we only do this once and keep
792 dptr
->did_stat
= true;
794 /* First check if it should be visible. */
795 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
,
798 /* This only returns false if the file was found, but
799 is explicitly not visible. Set us to end of
800 directory, but return NULL as we know we can't ever
805 if (VALID_STAT(*pst
)) {
806 name
= talloc_strdup(ctx
, dptr
->wcard
);
810 pathreal
= talloc_asprintf(ctx
,
817 /* Create an smb_filename with stream_name == NULL. */
818 ZERO_STRUCT(smb_fname_base
);
819 smb_fname_base
.base_name
= pathreal
;
821 if (SMB_VFS_STAT(dptr
->conn
, &smb_fname_base
) == 0) {
822 *pst
= smb_fname_base
.st
;
823 name
= talloc_strdup(ctx
, dptr
->wcard
);
826 /* If we get any other error than ENOENT or ENOTDIR
827 then the file exists we just can't stat it. */
828 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
829 name
= talloc_strdup(ctx
, dptr
->wcard
);
834 /* Stat failed. We know this is authoratiative if we are
835 * providing case sensitive semantics or the underlying
836 * filesystem is case sensitive.
838 if (dptr
->conn
->case_sensitive
||
839 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
))
845 * Try case-insensitive stat if the fs has the ability. This avoids
846 * scanning the whole directory.
848 ret
= SMB_VFS_GET_REAL_FILENAME(dptr
->conn
, dptr
->path
, dptr
->wcard
,
853 } else if (errno
== ENOENT
) {
854 /* The case-insensitive lookup was authoritative. */
858 TALLOC_FREE(pathreal
);
860 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
, &talloced
);
861 if (name_temp
== NULL
) {
864 if (talloced
!= NULL
) {
865 return talloc_move(ctx
, &talloced
);
867 return talloc_strdup(ctx
, name_temp
);
870 TALLOC_FREE(pathreal
);
872 /* We need to set the underlying dir_hnd offset to -1
873 * also as this function is usually called with the
874 * output from TellDir. */
875 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
879 /****************************************************************************
880 Search for a file by name, skipping veto'ed and not visible files.
881 ****************************************************************************/
883 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
885 SET_STAT_INVALID(*pst
);
887 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
888 /* This is a singleton directory and we're already at the end. */
889 *poffset
= END_OF_DIRECTORY_OFFSET
;
893 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
896 /****************************************************************************
897 Add the name we're returning into the underlying cache.
898 ****************************************************************************/
900 void dptr_DirCacheAdd(struct dptr_struct
*dptr
, const char *name
, long offset
)
902 DirCacheAdd(dptr
->dir_hnd
, name
, offset
);
905 /****************************************************************************
906 Initialize variables & state data at the beginning of all search SMB requests.
907 ****************************************************************************/
908 void dptr_init_search_op(struct dptr_struct
*dptr
)
910 SMB_VFS_INIT_SEARCH_OP(dptr
->conn
, dptr
->dir_hnd
->dir
);
913 /****************************************************************************
914 Fill the 5 byte server reserved dptr field.
915 ****************************************************************************/
917 bool dptr_fill(struct smbd_server_connection
*sconn
,
918 char *buf1
,unsigned int key
)
920 unsigned char *buf
= (unsigned char *)buf1
;
921 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
924 DEBUG(1,("filling null dirptr %d\n",key
));
927 offset
= (uint32
)TellDir(dptr
->dir_hnd
);
928 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
929 (long)dptr
->dir_hnd
,(int)offset
));
935 /****************************************************************************
936 Fetch the dir ptr and seek it given the 5 byte server field.
937 ****************************************************************************/
939 struct dptr_struct
*dptr_fetch(struct smbd_server_connection
*sconn
,
942 unsigned int key
= *(unsigned char *)buf
;
943 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
948 DEBUG(3,("fetched null dirptr %d\n",key
));
952 offset
= IVAL(buf
,1);
953 if (offset
== (uint32
)-1) {
954 seekoff
= END_OF_DIRECTORY_OFFSET
;
956 seekoff
= (long)offset
;
958 SeekDir(dptr
->dir_hnd
,seekoff
);
959 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
960 key
, dptr
->path
, (int)seekoff
));
964 /****************************************************************************
966 ****************************************************************************/
968 struct dptr_struct
*dptr_fetch_lanman2(struct smbd_server_connection
*sconn
,
971 struct dptr_struct
*dptr
= dptr_get(sconn
, dptr_num
, false);
974 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
977 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr
->path
));
981 /****************************************************************************
982 Check that a file matches a particular file type.
983 ****************************************************************************/
985 bool dir_check_ftype(connection_struct
*conn
, uint32 mode
, uint32 dirtype
)
989 /* Check the "may have" search bits. */
990 if (((mode
& ~dirtype
) & (FILE_ATTRIBUTE_HIDDEN
| FILE_ATTRIBUTE_SYSTEM
| FILE_ATTRIBUTE_DIRECTORY
)) != 0)
993 /* Check the "must have" bits, which are the may have bits shifted eight */
994 /* If must have bit is set, the file/dir can not be returned in search unless the matching
995 file attribute is set */
996 mask
= ((dirtype
>> 8) & (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
)); /* & 0x37 */
998 if((mask
& (mode
& (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
))) == mask
) /* check if matching attribute present */
1007 static bool mangle_mask_match(connection_struct
*conn
,
1008 const char *filename
,
1013 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
1016 return mask_match_search(mname
,mask
,False
);
1019 bool smbd_dirptr_get_entry(TALLOC_CTX
*ctx
,
1020 struct dptr_struct
*dirptr
,
1025 bool (*match_fn
)(TALLOC_CTX
*ctx
,
1030 bool (*mode_fn
)(TALLOC_CTX
*ctx
,
1032 struct smb_filename
*smb_fname
,
1036 struct smb_filename
**_smb_fname
,
1040 connection_struct
*conn
= dirptr
->conn
;
1047 pathlen
= strlen(dirptr
->path
);
1048 slashlen
= ( dirptr
->path
[pathlen
-1] != '/') ? 1 : 0;
1053 SMB_STRUCT_STAT sbuf
;
1057 char *pathreal
= NULL
;
1058 struct smb_filename smb_fname
;
1063 cur_offset
= dptr_TellDir(dirptr
);
1064 prev_offset
= cur_offset
;
1065 dname
= dptr_ReadDirName(ctx
, dirptr
, &cur_offset
, &sbuf
);
1067 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
1068 (long)dirptr
, cur_offset
));
1070 if (dname
== NULL
) {
1074 isdots
= (ISDOT(dname
) || ISDOTDOT(dname
));
1075 if (dont_descend
&& !isdots
) {
1081 * fname may get mangled, dname is never mangled.
1082 * Whenever we're accessing the filesystem we use
1083 * pathreal which is composed from dname.
1086 ok
= match_fn(ctx
, private_data
, dname
, mask
, &fname
);
1094 * pathreal = talloc_asprintf(ctx, "%s%s%s", dirptr->path,
1095 * needslash?"/":"", dname);
1096 * but this was measurably slower than doing the memcpy.
1099 pathreal
= talloc_array(
1101 pathlen
+ slashlen
+ talloc_get_size(dname
));
1108 memcpy(pathreal
, dirptr
->path
, pathlen
);
1109 pathreal
[pathlen
] = '/';
1110 memcpy(pathreal
+ slashlen
+ pathlen
, dname
,
1111 talloc_get_size(dname
));
1113 /* Create smb_fname with NULL stream_name. */
1114 ZERO_STRUCT(smb_fname
);
1115 smb_fname
.base_name
= pathreal
;
1116 smb_fname
.st
= sbuf
;
1118 ok
= mode_fn(ctx
, private_data
, &smb_fname
, &mode
);
1122 TALLOC_FREE(pathreal
);
1126 if (!dir_check_ftype(conn
, mode
, dirtype
)) {
1127 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1128 fname
, (unsigned int)mode
, (unsigned int)dirtype
));
1131 TALLOC_FREE(pathreal
);
1135 if (ask_sharemode
) {
1136 struct timespec write_time_ts
;
1137 struct file_id fileid
;
1139 fileid
= vfs_file_id_from_sbuf(conn
,
1141 get_file_infos(fileid
, 0, NULL
, &write_time_ts
);
1142 if (!null_timespec(write_time_ts
)) {
1143 update_stat_ex_mtime(&smb_fname
.st
,
1148 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1150 mask
, smb_fname_str_dbg(&smb_fname
),
1153 DirCacheAdd(dirptr
->dir_hnd
, dname
, cur_offset
);
1157 status
= copy_smb_filename(ctx
, &smb_fname
, _smb_fname
);
1158 TALLOC_FREE(pathreal
);
1159 if (!NT_STATUS_IS_OK(status
)) {
1164 *_prev_offset
= prev_offset
;
1172 /****************************************************************************
1173 Get an 8.3 directory entry.
1174 ****************************************************************************/
1176 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX
*ctx
,
1182 connection_struct
*conn
= (connection_struct
*)private_data
;
1184 if ((strcmp(mask
,"*.*") == 0) ||
1185 mask_match_search(dname
, mask
, false) ||
1186 mangle_mask_match(conn
, dname
, mask
)) {
1190 if (!mangle_is_8_3(dname
, false, conn
->params
)) {
1191 bool ok
= name_to_8_3(dname
, mname
, false,
1201 *_fname
= talloc_strdup(ctx
, fname
);
1202 if (*_fname
== NULL
) {
1212 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX
*ctx
,
1214 struct smb_filename
*smb_fname
,
1217 connection_struct
*conn
= (connection_struct
*)private_data
;
1219 if (!VALID_STAT(smb_fname
->st
)) {
1220 if ((SMB_VFS_STAT(conn
, smb_fname
)) != 0) {
1221 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1222 "Couldn't stat [%s]. Error "
1224 smb_fname_str_dbg(smb_fname
),
1230 *_mode
= dos_mode(conn
, smb_fname
);
1234 bool get_dir_entry(TALLOC_CTX
*ctx
,
1235 struct dptr_struct
*dirptr
,
1241 struct timespec
*_date
,
1245 connection_struct
*conn
= dirptr
->conn
;
1247 struct smb_filename
*smb_fname
= NULL
;
1252 ok
= smbd_dirptr_get_entry(ctx
,
1258 smbd_dirptr_8_3_match_fn
,
1259 smbd_dirptr_8_3_mode_fn
,
1269 *_fname
= talloc_move(ctx
, &fname
);
1270 *_size
= smb_fname
->st
.st_ex_size
;
1272 *_date
= smb_fname
->st
.st_ex_mtime
;
1273 TALLOC_FREE(smb_fname
);
1277 /*******************************************************************
1278 Check to see if a user can read a file. This is only approximate,
1279 it is used as part of the "hide unreadable" option. Don't
1280 use it for anything security sensitive.
1281 ********************************************************************/
1283 static bool user_can_read_file(connection_struct
*conn
,
1284 struct smb_filename
*smb_fname
)
1287 * Never hide files from the root user.
1288 * We use (uid_t)0 here not sec_initial_uid()
1289 * as make test uses a single user context.
1292 if (get_current_uid(conn
) == (uid_t
)0) {
1296 return NT_STATUS_IS_OK(smbd_check_access_rights(conn
,
1302 /*******************************************************************
1303 Check to see if a user can write a file (and only files, we do not
1304 check dirs on this one). This is only approximate,
1305 it is used as part of the "hide unwriteable" option. Don't
1306 use it for anything security sensitive.
1307 ********************************************************************/
1309 static bool user_can_write_file(connection_struct
*conn
,
1310 const struct smb_filename
*smb_fname
)
1313 * Never hide files from the root user.
1314 * We use (uid_t)0 here not sec_initial_uid()
1315 * as make test uses a single user context.
1318 if (get_current_uid(conn
) == (uid_t
)0) {
1322 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1324 /* Pseudo-open the file */
1326 if(S_ISDIR(smb_fname
->st
.st_ex_mode
)) {
1330 return can_write_to_file(conn
, smb_fname
);
1333 /*******************************************************************
1334 Is a file a "special" type ?
1335 ********************************************************************/
1337 static bool file_is_special(connection_struct
*conn
,
1338 const struct smb_filename
*smb_fname
)
1341 * Never hide files from the root user.
1342 * We use (uid_t)0 here not sec_initial_uid()
1343 * as make test uses a single user context.
1346 if (get_current_uid(conn
) == (uid_t
)0) {
1350 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1352 if (S_ISREG(smb_fname
->st
.st_ex_mode
) ||
1353 S_ISDIR(smb_fname
->st
.st_ex_mode
) ||
1354 S_ISLNK(smb_fname
->st
.st_ex_mode
))
1360 /*******************************************************************
1361 Should the file be seen by the client?
1362 NOTE: A successful return is no guarantee of the file's existence.
1363 ********************************************************************/
1365 bool is_visible_file(connection_struct
*conn
, const char *dir_path
,
1366 const char *name
, SMB_STRUCT_STAT
*pst
, bool use_veto
)
1368 bool hide_unreadable
= lp_hideunreadable(SNUM(conn
));
1369 bool hide_unwriteable
= lp_hideunwriteable_files(SNUM(conn
));
1370 bool hide_special
= lp_hide_special_files(SNUM(conn
));
1372 struct smb_filename
*smb_fname_base
= NULL
;
1376 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1377 return True
; /* . and .. are always visible. */
1380 /* If it's a vetoed file, pretend it doesn't even exist */
1381 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1382 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1386 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1387 entry
= talloc_asprintf(talloc_tos(), "%s/%s", dir_path
, name
);
1393 /* Create an smb_filename with stream_name == NULL. */
1394 status
= create_synthetic_smb_fname(talloc_tos(), entry
, NULL
,
1395 pst
, &smb_fname_base
);
1396 if (!NT_STATUS_IS_OK(status
)) {
1401 /* If the file name does not exist, there's no point checking
1402 * the configuration options. We succeed, on the basis that the
1403 * checks *might* have passed if the file was present.
1405 if (!VALID_STAT(*pst
)) {
1406 if (SMB_VFS_STAT(conn
, smb_fname_base
) != 0) {
1410 *pst
= smb_fname_base
->st
;
1414 /* Honour _hide unreadable_ option */
1415 if (hide_unreadable
&&
1416 !user_can_read_file(conn
, smb_fname_base
)) {
1417 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1422 /* Honour _hide unwriteable_ option */
1423 if (hide_unwriteable
&& !user_can_write_file(conn
,
1425 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1430 /* Honour _hide_special_ option */
1431 if (hide_special
&& file_is_special(conn
, smb_fname_base
)) {
1432 DEBUG(10,("is_visible_file: file %s is special.\n",
1441 TALLOC_FREE(smb_fname_base
);
1446 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1450 if (dirp
->conn
->sconn
) {
1451 files_struct
*fsp
= file_find_fd(dirp
->conn
->sconn
,
1454 /* The call below closes the underlying fd. */
1459 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1461 if (dirp
->conn
->sconn
&& !dirp
->conn
->sconn
->using_smb2
) {
1462 dirp
->conn
->sconn
->searches
.dirhandles_open
--;
1467 /*******************************************************************
1469 ********************************************************************/
1471 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1476 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1477 struct smbd_server_connection
*sconn
= conn
->sconn
;
1484 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1486 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1487 if (!dirp
->dir_path
) {
1492 if (sconn
&& !sconn
->using_smb2
) {
1493 sconn
->searches
.dirhandles_open
++;
1495 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1497 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1499 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1511 /*******************************************************************
1512 Open a directory from an fsp.
1513 ********************************************************************/
1515 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1520 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1521 struct smbd_server_connection
*sconn
= conn
->sconn
;
1528 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1530 dirp
->dir_path
= talloc_strdup(dirp
, fsp
->fsp_name
->base_name
);
1531 if (!dirp
->dir_path
) {
1536 if (sconn
&& !sconn
->using_smb2
) {
1537 sconn
->searches
.dirhandles_open
++;
1539 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1541 if (fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
1542 dirp
->dir
= SMB_VFS_FDOPENDIR(fsp
, mask
, attr
);
1543 if (dirp
->dir
== NULL
) {
1544 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1548 if (errno
!= ENOSYS
) {
1554 if (dirp
->dir
== NULL
) {
1555 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1556 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1560 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp
->dir_path
,
1573 /*******************************************************************
1574 Read from a directory.
1575 Return directory entry, current offset, and optional stat information.
1576 Don't check for veto or invisible files.
1577 ********************************************************************/
1579 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
,
1580 SMB_STRUCT_STAT
*sbuf
, char **ptalloced
)
1583 char *talloced
= NULL
;
1584 connection_struct
*conn
= dirp
->conn
;
1586 /* Cheat to allow . and .. to be the first entries returned. */
1587 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) ||
1588 (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2))
1590 if (dirp
->file_number
== 0) {
1592 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1595 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1597 dirp
->file_number
++;
1600 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1601 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1604 /* A real offset, seek to it. */
1605 SeekDir(dirp
, *poffset
);
1608 while ((n
= vfs_readdirname(conn
, dirp
->dir
, sbuf
, &talloced
))) {
1609 /* Ignore . and .. - we've already returned them. */
1611 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1612 TALLOC_FREE(talloced
);
1616 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1617 *ptalloced
= talloced
;
1618 dirp
->file_number
++;
1621 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1626 /*******************************************************************
1627 Rewind to the start.
1628 ********************************************************************/
1630 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1632 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1633 dirp
->file_number
= 0;
1634 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1635 *poffset
= START_OF_DIRECTORY_OFFSET
;
1638 /*******************************************************************
1640 ********************************************************************/
1642 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1644 if (offset
!= dirp
->offset
) {
1645 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1646 RewindDir(dirp
, &offset
);
1648 * Ok we should really set the file number here
1649 * to 1 to enable ".." to be returned next. Trouble
1650 * is I'm worried about callers using SeekDir(dirp,0)
1651 * as equivalent to RewindDir(). So leave this alone
1654 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1655 RewindDir(dirp
, &offset
);
1657 * Set the file number to 2 - we want to get the first
1658 * real file entry (the one we return after "..")
1659 * on the next ReadDir.
1661 dirp
->file_number
= 2;
1662 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1663 ; /* Don't seek in this case. */
1665 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1667 dirp
->offset
= offset
;
1671 /*******************************************************************
1672 Tell a dir position.
1673 ********************************************************************/
1675 long TellDir(struct smb_Dir
*dirp
)
1677 return(dirp
->offset
);
1680 /*******************************************************************
1681 Add an entry into the dcache.
1682 ********************************************************************/
1684 void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1686 struct name_cache_entry
*e
;
1688 if (dirp
->name_cache_size
== 0) {
1692 if (dirp
->name_cache
== NULL
) {
1693 dirp
->name_cache
= talloc_zero_array(
1694 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1696 if (dirp
->name_cache
== NULL
) {
1701 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1702 dirp
->name_cache_size
;
1703 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1704 TALLOC_FREE(e
->name
);
1705 e
->name
= talloc_strdup(dirp
, name
);
1709 /*******************************************************************
1710 Find an entry by name. Leave us at the offset after it.
1711 Don't check for veto or invisible files.
1712 ********************************************************************/
1714 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1717 const char *entry
= NULL
;
1718 char *talloced
= NULL
;
1719 connection_struct
*conn
= dirp
->conn
;
1721 /* Search back in the name cache. */
1722 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1723 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1724 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1725 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1726 *poffset
= e
->offset
;
1727 SeekDir(dirp
, e
->offset
);
1731 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1732 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1733 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1734 *poffset
= e
->offset
;
1735 SeekDir(dirp
, e
->offset
);
1741 /* Not found in the name cache. Rewind directory and start from scratch. */
1742 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1743 dirp
->file_number
= 0;
1744 *poffset
= START_OF_DIRECTORY_OFFSET
;
1745 while ((entry
= ReadDirName(dirp
, poffset
, NULL
, &talloced
))) {
1746 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1747 TALLOC_FREE(talloced
);
1750 TALLOC_FREE(talloced
);
1755 /*****************************************************************
1756 Is this directory empty ?
1757 *****************************************************************/
1759 NTSTATUS
can_delete_directory_fsp(files_struct
*fsp
)
1761 NTSTATUS status
= NT_STATUS_OK
;
1763 const char *dname
= NULL
;
1764 const char *dirname
= fsp
->fsp_name
->base_name
;
1765 char *talloced
= NULL
;
1767 struct connection_struct
*conn
= fsp
->conn
;
1768 struct smb_Dir
*dir_hnd
= OpenDir_fsp(talloc_tos(),
1775 return map_nt_error_from_unix(errno
);
1778 while ((dname
= ReadDirName(dir_hnd
, &dirpos
, &st
, &talloced
))) {
1779 /* Quick check for "." and ".." */
1780 if (dname
[0] == '.') {
1781 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1782 TALLOC_FREE(talloced
);
1787 if (!is_visible_file(conn
, dirname
, dname
, &st
, True
)) {
1788 TALLOC_FREE(talloced
);
1792 DEBUG(10,("got name %s - can't delete\n",
1794 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1797 TALLOC_FREE(talloced
);
1798 TALLOC_FREE(dir_hnd
);