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 bool backup_intent
= (req
&& req
->priv_paths
);
516 struct smb_filename
*smb_dname
= NULL
;
517 NTSTATUS status
= create_synthetic_smb_fname(talloc_tos(),
522 if (!NT_STATUS_IS_OK(status
)) {
525 if (lp_posix_pathnames()) {
526 ret
= SMB_VFS_LSTAT(conn
, smb_dname
);
528 ret
= SMB_VFS_STAT(conn
, smb_dname
);
531 return map_nt_error_from_unix(errno
);
533 if (!S_ISDIR(smb_dname
->st
.st_ex_mode
)) {
534 return NT_STATUS_NOT_A_DIRECTORY
;
536 status
= smbd_check_access_rights(conn
,
540 if (!NT_STATUS_IS_OK(status
)) {
544 dir_hnd
= open_dir_with_privilege(conn
,
550 dir_hnd
= OpenDir(NULL
, conn
, path
, wcard
, attr
);
555 return map_nt_error_from_unix(errno
);
558 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
) {
559 dptr_idleoldest(sconn
);
562 dptr
= talloc(NULL
, struct dptr_struct
);
564 DEBUG(0,("talloc fail in dptr_create.\n"));
565 TALLOC_FREE(dir_hnd
);
566 return NT_STATUS_NO_MEMORY
;
571 dptr
->path
= talloc_strdup(dptr
, path
);
574 TALLOC_FREE(dir_hnd
);
575 return NT_STATUS_NO_MEMORY
;
578 dptr
->dir_hnd
= dir_hnd
;
580 dptr
->expect_close
= expect_close
;
581 dptr
->wcard
= talloc_strdup(dptr
, wcard
);
584 TALLOC_FREE(dir_hnd
);
585 return NT_STATUS_NO_MEMORY
;
587 if (lp_posix_pathnames() || (wcard
[0] == '.' && wcard
[1] == 0)) {
588 dptr
->has_wild
= True
;
590 dptr
->has_wild
= wcard_has_wild
;
595 if (sconn
->using_smb2
) {
602 * This is an old-style SMBsearch request. Ensure the
603 * value we return will fit in the range 1-255.
606 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
608 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
611 * Try and close the oldest handle not marked for
612 * expect close in the hope that the client has
613 * finished with that one.
616 dptr_close_oldest(sconn
, true);
618 /* Now try again... */
619 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
620 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
621 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr
->dnum
));
623 TALLOC_FREE(dir_hnd
);
624 return NT_STATUS_TOO_MANY_OPENED_FILES
;
630 * This is a new-style trans2 request. Allocate from
631 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
634 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
636 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
639 * Try and close the oldest handle close in the hope that
640 * the client has finished with that one. This will only
641 * happen in the case of the Win98 client bug where it leaks
645 dptr_close_oldest(sconn
, false);
647 /* Now try again... */
648 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
650 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
651 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr
->dnum
));
653 TALLOC_FREE(dir_hnd
);
654 return NT_STATUS_TOO_MANY_OPENED_FILES
;
659 bitmap_set(sconn
->searches
.dptr_bmap
, dptr
->dnum
);
661 dptr
->dnum
+= 1; /* Always bias the dnum by one - no zero dnums allowed. */
663 DLIST_ADD(sconn
->searches
.dirptrs
, dptr
);
666 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
667 dptr
->dnum
,path
,expect_close
));
675 /****************************************************************************
676 Wrapper functions to access the lower level directory handles.
677 ****************************************************************************/
679 void dptr_CloseDir(files_struct
*fsp
)
683 * Ugly hack. We have defined fdopendir to return ENOSYS if dirfd also isn't
684 * present. I hate Solaris. JRA.
687 if (fsp
->fh
->fd
!= -1 &&
688 fsp
->dptr
->dir_hnd
&&
689 dirfd(fsp
->dptr
->dir_hnd
->dir
)) {
690 /* The call below closes the underlying fd. */
694 dptr_close_internal(fsp
->dptr
);
699 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
701 SeekDir(dptr
->dir_hnd
, offset
);
704 long dptr_TellDir(struct dptr_struct
*dptr
)
706 return TellDir(dptr
->dir_hnd
);
709 bool dptr_has_wild(struct dptr_struct
*dptr
)
711 return dptr
->has_wild
;
714 int dptr_dnum(struct dptr_struct
*dptr
)
719 bool dptr_get_priv(struct dptr_struct
*dptr
)
724 void dptr_set_priv(struct dptr_struct
*dptr
)
729 /****************************************************************************
730 Return the next visible file name, skipping veto'd and invisible files.
731 ****************************************************************************/
733 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
,
734 long *poffset
, SMB_STRUCT_STAT
*pst
,
737 /* Normal search for the next file. */
739 char *talloced
= NULL
;
741 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
, pst
, &talloced
))
743 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
744 *ptalloced
= talloced
;
747 TALLOC_FREE(talloced
);
752 /****************************************************************************
753 Return the next visible file name, skipping veto'd and invisible files.
754 ****************************************************************************/
756 char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
757 struct dptr_struct
*dptr
,
759 SMB_STRUCT_STAT
*pst
)
761 struct smb_filename smb_fname_base
;
763 const char *name_temp
= NULL
;
764 char *talloced
= NULL
;
765 char *pathreal
= NULL
;
766 char *found_name
= NULL
;
769 SET_STAT_INVALID(*pst
);
771 if (dptr
->has_wild
|| dptr
->did_stat
) {
772 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
,
774 if (name_temp
== NULL
) {
777 if (talloced
!= NULL
) {
778 return talloc_move(ctx
, &talloced
);
780 return talloc_strdup(ctx
, name_temp
);
783 /* If poffset is -1 then we know we returned this name before and we
784 * have no wildcards. We're at the end of the directory. */
785 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
789 /* We know the stored wcard contains no wildcard characters.
790 * See if we can match with a stat call. If we can't, then set
791 * did_stat to true to ensure we only do this once and keep
794 dptr
->did_stat
= true;
796 /* First check if it should be visible. */
797 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
,
800 /* This only returns false if the file was found, but
801 is explicitly not visible. Set us to end of
802 directory, but return NULL as we know we can't ever
807 if (VALID_STAT(*pst
)) {
808 name
= talloc_strdup(ctx
, dptr
->wcard
);
812 pathreal
= talloc_asprintf(ctx
,
819 /* Create an smb_filename with stream_name == NULL. */
820 ZERO_STRUCT(smb_fname_base
);
821 smb_fname_base
.base_name
= pathreal
;
823 if (SMB_VFS_STAT(dptr
->conn
, &smb_fname_base
) == 0) {
824 *pst
= smb_fname_base
.st
;
825 name
= talloc_strdup(ctx
, dptr
->wcard
);
828 /* If we get any other error than ENOENT or ENOTDIR
829 then the file exists we just can't stat it. */
830 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
831 name
= talloc_strdup(ctx
, dptr
->wcard
);
836 /* Stat failed. We know this is authoratiative if we are
837 * providing case sensitive semantics or the underlying
838 * filesystem is case sensitive.
840 if (dptr
->conn
->case_sensitive
||
841 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
))
847 * Try case-insensitive stat if the fs has the ability. This avoids
848 * scanning the whole directory.
850 ret
= SMB_VFS_GET_REAL_FILENAME(dptr
->conn
, dptr
->path
, dptr
->wcard
,
855 } else if (errno
== ENOENT
) {
856 /* The case-insensitive lookup was authoritative. */
860 TALLOC_FREE(pathreal
);
862 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
, &talloced
);
863 if (name_temp
== NULL
) {
866 if (talloced
!= NULL
) {
867 return talloc_move(ctx
, &talloced
);
869 return talloc_strdup(ctx
, name_temp
);
872 TALLOC_FREE(pathreal
);
874 /* We need to set the underlying dir_hnd offset to -1
875 * also as this function is usually called with the
876 * output from TellDir. */
877 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
881 /****************************************************************************
882 Search for a file by name, skipping veto'ed and not visible files.
883 ****************************************************************************/
885 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
887 SET_STAT_INVALID(*pst
);
889 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
890 /* This is a singleton directory and we're already at the end. */
891 *poffset
= END_OF_DIRECTORY_OFFSET
;
895 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
898 /****************************************************************************
899 Add the name we're returning into the underlying cache.
900 ****************************************************************************/
902 void dptr_DirCacheAdd(struct dptr_struct
*dptr
, const char *name
, long offset
)
904 DirCacheAdd(dptr
->dir_hnd
, name
, offset
);
907 /****************************************************************************
908 Initialize variables & state data at the beginning of all search SMB requests.
909 ****************************************************************************/
910 void dptr_init_search_op(struct dptr_struct
*dptr
)
912 SMB_VFS_INIT_SEARCH_OP(dptr
->conn
, dptr
->dir_hnd
->dir
);
915 /****************************************************************************
916 Fill the 5 byte server reserved dptr field.
917 ****************************************************************************/
919 bool dptr_fill(struct smbd_server_connection
*sconn
,
920 char *buf1
,unsigned int key
)
922 unsigned char *buf
= (unsigned char *)buf1
;
923 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
926 DEBUG(1,("filling null dirptr %d\n",key
));
929 offset
= (uint32
)TellDir(dptr
->dir_hnd
);
930 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
931 (long)dptr
->dir_hnd
,(int)offset
));
937 /****************************************************************************
938 Fetch the dir ptr and seek it given the 5 byte server field.
939 ****************************************************************************/
941 struct dptr_struct
*dptr_fetch(struct smbd_server_connection
*sconn
,
944 unsigned int key
= *(unsigned char *)buf
;
945 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
950 DEBUG(3,("fetched null dirptr %d\n",key
));
954 offset
= IVAL(buf
,1);
955 if (offset
== (uint32
)-1) {
956 seekoff
= END_OF_DIRECTORY_OFFSET
;
958 seekoff
= (long)offset
;
960 SeekDir(dptr
->dir_hnd
,seekoff
);
961 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
962 key
, dptr
->path
, (int)seekoff
));
966 /****************************************************************************
968 ****************************************************************************/
970 struct dptr_struct
*dptr_fetch_lanman2(struct smbd_server_connection
*sconn
,
973 struct dptr_struct
*dptr
= dptr_get(sconn
, dptr_num
, false);
976 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
979 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr
->path
));
983 /****************************************************************************
984 Check that a file matches a particular file type.
985 ****************************************************************************/
987 bool dir_check_ftype(connection_struct
*conn
, uint32 mode
, uint32 dirtype
)
991 /* Check the "may have" search bits. */
992 if (((mode
& ~dirtype
) & (FILE_ATTRIBUTE_HIDDEN
| FILE_ATTRIBUTE_SYSTEM
| FILE_ATTRIBUTE_DIRECTORY
)) != 0)
995 /* Check the "must have" bits, which are the may have bits shifted eight */
996 /* If must have bit is set, the file/dir can not be returned in search unless the matching
997 file attribute is set */
998 mask
= ((dirtype
>> 8) & (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
)); /* & 0x37 */
1000 if((mask
& (mode
& (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
))) == mask
) /* check if matching attribute present */
1009 static bool mangle_mask_match(connection_struct
*conn
,
1010 const char *filename
,
1015 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
1018 return mask_match_search(mname
,mask
,False
);
1021 bool smbd_dirptr_get_entry(TALLOC_CTX
*ctx
,
1022 struct dptr_struct
*dirptr
,
1027 bool (*match_fn
)(TALLOC_CTX
*ctx
,
1032 bool (*mode_fn
)(TALLOC_CTX
*ctx
,
1034 struct smb_filename
*smb_fname
,
1038 struct smb_filename
**_smb_fname
,
1042 connection_struct
*conn
= dirptr
->conn
;
1049 pathlen
= strlen(dirptr
->path
);
1050 slashlen
= ( dirptr
->path
[pathlen
-1] != '/') ? 1 : 0;
1055 SMB_STRUCT_STAT sbuf
;
1059 char *pathreal
= NULL
;
1060 struct smb_filename smb_fname
;
1065 cur_offset
= dptr_TellDir(dirptr
);
1066 prev_offset
= cur_offset
;
1067 dname
= dptr_ReadDirName(ctx
, dirptr
, &cur_offset
, &sbuf
);
1069 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
1070 (long)dirptr
, cur_offset
));
1072 if (dname
== NULL
) {
1076 isdots
= (ISDOT(dname
) || ISDOTDOT(dname
));
1077 if (dont_descend
&& !isdots
) {
1083 * fname may get mangled, dname is never mangled.
1084 * Whenever we're accessing the filesystem we use
1085 * pathreal which is composed from dname.
1088 ok
= match_fn(ctx
, private_data
, dname
, mask
, &fname
);
1096 * pathreal = talloc_asprintf(ctx, "%s%s%s", dirptr->path,
1097 * needslash?"/":"", dname);
1098 * but this was measurably slower than doing the memcpy.
1101 pathreal
= talloc_array(
1103 pathlen
+ slashlen
+ talloc_get_size(dname
));
1110 memcpy(pathreal
, dirptr
->path
, pathlen
);
1111 pathreal
[pathlen
] = '/';
1112 memcpy(pathreal
+ slashlen
+ pathlen
, dname
,
1113 talloc_get_size(dname
));
1115 /* Create smb_fname with NULL stream_name. */
1116 ZERO_STRUCT(smb_fname
);
1117 smb_fname
.base_name
= pathreal
;
1118 smb_fname
.st
= sbuf
;
1120 ok
= mode_fn(ctx
, private_data
, &smb_fname
, &mode
);
1124 TALLOC_FREE(pathreal
);
1128 if (!dir_check_ftype(conn
, mode
, dirtype
)) {
1129 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1130 fname
, (unsigned int)mode
, (unsigned int)dirtype
));
1133 TALLOC_FREE(pathreal
);
1137 if (ask_sharemode
) {
1138 struct timespec write_time_ts
;
1139 struct file_id fileid
;
1141 fileid
= vfs_file_id_from_sbuf(conn
,
1143 get_file_infos(fileid
, 0, NULL
, &write_time_ts
);
1144 if (!null_timespec(write_time_ts
)) {
1145 update_stat_ex_mtime(&smb_fname
.st
,
1150 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1152 mask
, smb_fname_str_dbg(&smb_fname
),
1155 DirCacheAdd(dirptr
->dir_hnd
, dname
, cur_offset
);
1159 status
= copy_smb_filename(ctx
, &smb_fname
, _smb_fname
);
1160 TALLOC_FREE(pathreal
);
1161 if (!NT_STATUS_IS_OK(status
)) {
1166 *_prev_offset
= prev_offset
;
1174 /****************************************************************************
1175 Get an 8.3 directory entry.
1176 ****************************************************************************/
1178 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX
*ctx
,
1184 connection_struct
*conn
= (connection_struct
*)private_data
;
1186 if ((strcmp(mask
,"*.*") == 0) ||
1187 mask_match_search(dname
, mask
, false) ||
1188 mangle_mask_match(conn
, dname
, mask
)) {
1192 if (!mangle_is_8_3(dname
, false, conn
->params
)) {
1193 bool ok
= name_to_8_3(dname
, mname
, false,
1203 *_fname
= talloc_strdup(ctx
, fname
);
1204 if (*_fname
== NULL
) {
1214 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX
*ctx
,
1216 struct smb_filename
*smb_fname
,
1219 connection_struct
*conn
= (connection_struct
*)private_data
;
1221 if (!VALID_STAT(smb_fname
->st
)) {
1222 if ((SMB_VFS_STAT(conn
, smb_fname
)) != 0) {
1223 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1224 "Couldn't stat [%s]. Error "
1226 smb_fname_str_dbg(smb_fname
),
1232 *_mode
= dos_mode(conn
, smb_fname
);
1236 bool get_dir_entry(TALLOC_CTX
*ctx
,
1237 struct dptr_struct
*dirptr
,
1243 struct timespec
*_date
,
1247 connection_struct
*conn
= dirptr
->conn
;
1249 struct smb_filename
*smb_fname
= NULL
;
1254 ok
= smbd_dirptr_get_entry(ctx
,
1260 smbd_dirptr_8_3_match_fn
,
1261 smbd_dirptr_8_3_mode_fn
,
1271 *_fname
= talloc_move(ctx
, &fname
);
1272 *_size
= smb_fname
->st
.st_ex_size
;
1274 *_date
= smb_fname
->st
.st_ex_mtime
;
1275 TALLOC_FREE(smb_fname
);
1279 /*******************************************************************
1280 Check to see if a user can read a file. This is only approximate,
1281 it is used as part of the "hide unreadable" option. Don't
1282 use it for anything security sensitive.
1283 ********************************************************************/
1285 static bool user_can_read_file(connection_struct
*conn
,
1286 struct smb_filename
*smb_fname
)
1289 * Never hide files from the root user.
1290 * We use (uid_t)0 here not sec_initial_uid()
1291 * as make test uses a single user context.
1294 if (get_current_uid(conn
) == (uid_t
)0) {
1298 return NT_STATUS_IS_OK(smbd_check_access_rights(conn
,
1304 /*******************************************************************
1305 Check to see if a user can write a file (and only files, we do not
1306 check dirs on this one). This is only approximate,
1307 it is used as part of the "hide unwriteable" option. Don't
1308 use it for anything security sensitive.
1309 ********************************************************************/
1311 static bool user_can_write_file(connection_struct
*conn
,
1312 const struct smb_filename
*smb_fname
)
1315 * Never hide files from the root user.
1316 * We use (uid_t)0 here not sec_initial_uid()
1317 * as make test uses a single user context.
1320 if (get_current_uid(conn
) == (uid_t
)0) {
1324 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1326 /* Pseudo-open the file */
1328 if(S_ISDIR(smb_fname
->st
.st_ex_mode
)) {
1332 return can_write_to_file(conn
, smb_fname
);
1335 /*******************************************************************
1336 Is a file a "special" type ?
1337 ********************************************************************/
1339 static bool file_is_special(connection_struct
*conn
,
1340 const struct smb_filename
*smb_fname
)
1343 * Never hide files from the root user.
1344 * We use (uid_t)0 here not sec_initial_uid()
1345 * as make test uses a single user context.
1348 if (get_current_uid(conn
) == (uid_t
)0) {
1352 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1354 if (S_ISREG(smb_fname
->st
.st_ex_mode
) ||
1355 S_ISDIR(smb_fname
->st
.st_ex_mode
) ||
1356 S_ISLNK(smb_fname
->st
.st_ex_mode
))
1362 /*******************************************************************
1363 Should the file be seen by the client?
1364 NOTE: A successful return is no guarantee of the file's existence.
1365 ********************************************************************/
1367 bool is_visible_file(connection_struct
*conn
, const char *dir_path
,
1368 const char *name
, SMB_STRUCT_STAT
*pst
, bool use_veto
)
1370 bool hide_unreadable
= lp_hideunreadable(SNUM(conn
));
1371 bool hide_unwriteable
= lp_hideunwriteable_files(SNUM(conn
));
1372 bool hide_special
= lp_hide_special_files(SNUM(conn
));
1374 struct smb_filename
*smb_fname_base
= NULL
;
1378 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1379 return True
; /* . and .. are always visible. */
1382 /* If it's a vetoed file, pretend it doesn't even exist */
1383 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1384 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1388 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1389 entry
= talloc_asprintf(talloc_tos(), "%s/%s", dir_path
, name
);
1395 /* Create an smb_filename with stream_name == NULL. */
1396 status
= create_synthetic_smb_fname(talloc_tos(), entry
, NULL
,
1397 pst
, &smb_fname_base
);
1398 if (!NT_STATUS_IS_OK(status
)) {
1403 /* If the file name does not exist, there's no point checking
1404 * the configuration options. We succeed, on the basis that the
1405 * checks *might* have passed if the file was present.
1407 if (!VALID_STAT(*pst
)) {
1408 if (SMB_VFS_STAT(conn
, smb_fname_base
) != 0) {
1412 *pst
= smb_fname_base
->st
;
1416 /* Honour _hide unreadable_ option */
1417 if (hide_unreadable
&&
1418 !user_can_read_file(conn
, smb_fname_base
)) {
1419 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1424 /* Honour _hide unwriteable_ option */
1425 if (hide_unwriteable
&& !user_can_write_file(conn
,
1427 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1432 /* Honour _hide_special_ option */
1433 if (hide_special
&& file_is_special(conn
, smb_fname_base
)) {
1434 DEBUG(10,("is_visible_file: file %s is special.\n",
1443 TALLOC_FREE(smb_fname_base
);
1448 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1450 if (dirp
->dir
!= NULL
) {
1451 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1452 if (dirp
->fsp
!= NULL
) {
1454 * The SMB_VFS_CLOSEDIR above
1455 * closes the underlying fd inside
1458 dirp
->fsp
->fh
->fd
= -1;
1459 if (dirp
->fsp
->dptr
!= NULL
) {
1460 SMB_ASSERT(dirp
->fsp
->dptr
->dir_hnd
== dirp
);
1461 dirp
->fsp
->dptr
->dir_hnd
= NULL
;
1466 if (dirp
->conn
->sconn
&& !dirp
->conn
->sconn
->using_smb2
) {
1467 dirp
->conn
->sconn
->searches
.dirhandles_open
--;
1472 /*******************************************************************
1474 ********************************************************************/
1476 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1481 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1482 struct smbd_server_connection
*sconn
= conn
->sconn
;
1489 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1491 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1492 if (!dirp
->dir_path
) {
1497 if (sconn
&& !sconn
->using_smb2
) {
1498 sconn
->searches
.dirhandles_open
++;
1500 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1502 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1504 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1516 /*******************************************************************
1517 Open a directory from an fsp.
1518 ********************************************************************/
1520 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1525 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1526 struct smbd_server_connection
*sconn
= conn
->sconn
;
1533 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1535 dirp
->dir_path
= talloc_strdup(dirp
, fsp
->fsp_name
->base_name
);
1536 if (!dirp
->dir_path
) {
1541 if (sconn
&& !sconn
->using_smb2
) {
1542 sconn
->searches
.dirhandles_open
++;
1544 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1546 if (fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
1547 dirp
->dir
= SMB_VFS_FDOPENDIR(fsp
, mask
, attr
);
1548 if (dirp
->dir
!= NULL
) {
1551 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1555 if (errno
!= ENOSYS
) {
1561 if (dirp
->dir
== NULL
) {
1562 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1563 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1567 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp
->dir_path
,
1580 /*******************************************************************
1581 Read from a directory.
1582 Return directory entry, current offset, and optional stat information.
1583 Don't check for veto or invisible files.
1584 ********************************************************************/
1586 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
,
1587 SMB_STRUCT_STAT
*sbuf
, char **ptalloced
)
1590 char *talloced
= NULL
;
1591 connection_struct
*conn
= dirp
->conn
;
1593 /* Cheat to allow . and .. to be the first entries returned. */
1594 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) ||
1595 (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2))
1597 if (dirp
->file_number
== 0) {
1599 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1602 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1604 dirp
->file_number
++;
1607 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1608 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1611 /* A real offset, seek to it. */
1612 SeekDir(dirp
, *poffset
);
1615 while ((n
= vfs_readdirname(conn
, dirp
->dir
, sbuf
, &talloced
))) {
1616 /* Ignore . and .. - we've already returned them. */
1618 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1619 TALLOC_FREE(talloced
);
1623 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1624 *ptalloced
= talloced
;
1625 dirp
->file_number
++;
1628 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1633 /*******************************************************************
1634 Rewind to the start.
1635 ********************************************************************/
1637 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1639 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1640 dirp
->file_number
= 0;
1641 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1642 *poffset
= START_OF_DIRECTORY_OFFSET
;
1645 /*******************************************************************
1647 ********************************************************************/
1649 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1651 if (offset
!= dirp
->offset
) {
1652 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1653 RewindDir(dirp
, &offset
);
1655 * Ok we should really set the file number here
1656 * to 1 to enable ".." to be returned next. Trouble
1657 * is I'm worried about callers using SeekDir(dirp,0)
1658 * as equivalent to RewindDir(). So leave this alone
1661 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1662 RewindDir(dirp
, &offset
);
1664 * Set the file number to 2 - we want to get the first
1665 * real file entry (the one we return after "..")
1666 * on the next ReadDir.
1668 dirp
->file_number
= 2;
1669 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1670 ; /* Don't seek in this case. */
1672 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1674 dirp
->offset
= offset
;
1678 /*******************************************************************
1679 Tell a dir position.
1680 ********************************************************************/
1682 long TellDir(struct smb_Dir
*dirp
)
1684 return(dirp
->offset
);
1687 /*******************************************************************
1688 Add an entry into the dcache.
1689 ********************************************************************/
1691 void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1693 struct name_cache_entry
*e
;
1695 if (dirp
->name_cache_size
== 0) {
1699 if (dirp
->name_cache
== NULL
) {
1700 dirp
->name_cache
= talloc_zero_array(
1701 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1703 if (dirp
->name_cache
== NULL
) {
1708 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1709 dirp
->name_cache_size
;
1710 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1711 TALLOC_FREE(e
->name
);
1712 e
->name
= talloc_strdup(dirp
, name
);
1716 /*******************************************************************
1717 Find an entry by name. Leave us at the offset after it.
1718 Don't check for veto or invisible files.
1719 ********************************************************************/
1721 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1724 const char *entry
= NULL
;
1725 char *talloced
= NULL
;
1726 connection_struct
*conn
= dirp
->conn
;
1728 /* Search back in the name cache. */
1729 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1730 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1731 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1732 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1733 *poffset
= e
->offset
;
1734 SeekDir(dirp
, e
->offset
);
1738 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1739 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1740 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1741 *poffset
= e
->offset
;
1742 SeekDir(dirp
, e
->offset
);
1748 /* Not found in the name cache. Rewind directory and start from scratch. */
1749 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1750 dirp
->file_number
= 0;
1751 *poffset
= START_OF_DIRECTORY_OFFSET
;
1752 while ((entry
= ReadDirName(dirp
, poffset
, NULL
, &talloced
))) {
1753 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1754 TALLOC_FREE(talloced
);
1757 TALLOC_FREE(talloced
);
1762 /*****************************************************************
1763 Is this directory empty ?
1764 *****************************************************************/
1766 NTSTATUS
can_delete_directory_fsp(files_struct
*fsp
)
1768 NTSTATUS status
= NT_STATUS_OK
;
1770 const char *dname
= NULL
;
1771 const char *dirname
= fsp
->fsp_name
->base_name
;
1772 char *talloced
= NULL
;
1774 struct connection_struct
*conn
= fsp
->conn
;
1775 struct smb_Dir
*dir_hnd
= OpenDir_fsp(talloc_tos(),
1782 return map_nt_error_from_unix(errno
);
1785 while ((dname
= ReadDirName(dir_hnd
, &dirpos
, &st
, &talloced
))) {
1786 /* Quick check for "." and ".." */
1787 if (dname
[0] == '.') {
1788 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1789 TALLOC_FREE(talloced
);
1794 if (!is_visible_file(conn
, dirname
, dname
, &st
, True
)) {
1795 TALLOC_FREE(talloced
);
1799 DEBUG(10,("got name %s - can't delete\n",
1801 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1804 TALLOC_FREE(talloced
);
1805 TALLOC_FREE(dir_hnd
);