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 struct smb_filename
*smb_dname
= NULL
;
514 NTSTATUS status
= create_synthetic_smb_fname(talloc_tos(),
519 if (!NT_STATUS_IS_OK(status
)) {
522 if (lp_posix_pathnames()) {
523 ret
= SMB_VFS_LSTAT(conn
, smb_dname
);
525 ret
= SMB_VFS_STAT(conn
, smb_dname
);
528 return map_nt_error_from_unix(errno
);
530 if (!S_ISDIR(smb_dname
->st
.st_ex_mode
)) {
531 return NT_STATUS_NOT_A_DIRECTORY
;
533 status
= smbd_check_access_rights(conn
,
536 if (!NT_STATUS_IS_OK(status
)) {
539 if (req
&& req
->priv_paths
) {
540 dir_hnd
= open_dir_with_privilege(conn
,
546 dir_hnd
= OpenDir(NULL
, conn
, path
, wcard
, attr
);
551 return map_nt_error_from_unix(errno
);
554 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
) {
555 dptr_idleoldest(sconn
);
558 dptr
= talloc(NULL
, struct dptr_struct
);
560 DEBUG(0,("talloc fail in dptr_create.\n"));
561 TALLOC_FREE(dir_hnd
);
562 return NT_STATUS_NO_MEMORY
;
567 dptr
->path
= talloc_strdup(dptr
, path
);
570 TALLOC_FREE(dir_hnd
);
571 return NT_STATUS_NO_MEMORY
;
574 dptr
->dir_hnd
= dir_hnd
;
576 dptr
->expect_close
= expect_close
;
577 dptr
->wcard
= talloc_strdup(dptr
, wcard
);
580 TALLOC_FREE(dir_hnd
);
581 return NT_STATUS_NO_MEMORY
;
583 if (lp_posix_pathnames() || (wcard
[0] == '.' && wcard
[1] == 0)) {
584 dptr
->has_wild
= True
;
586 dptr
->has_wild
= wcard_has_wild
;
591 if (sconn
->using_smb2
) {
598 * This is an old-style SMBsearch request. Ensure the
599 * value we return will fit in the range 1-255.
602 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
604 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
607 * Try and close the oldest handle not marked for
608 * expect close in the hope that the client has
609 * finished with that one.
612 dptr_close_oldest(sconn
, true);
614 /* Now try again... */
615 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
616 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
617 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr
->dnum
));
619 TALLOC_FREE(dir_hnd
);
620 return NT_STATUS_TOO_MANY_OPENED_FILES
;
626 * This is a new-style trans2 request. Allocate from
627 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
630 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
632 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
635 * Try and close the oldest handle close in the hope that
636 * the client has finished with that one. This will only
637 * happen in the case of the Win98 client bug where it leaks
641 dptr_close_oldest(sconn
, false);
643 /* Now try again... */
644 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
646 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
647 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr
->dnum
));
649 TALLOC_FREE(dir_hnd
);
650 return NT_STATUS_TOO_MANY_OPENED_FILES
;
655 bitmap_set(sconn
->searches
.dptr_bmap
, dptr
->dnum
);
657 dptr
->dnum
+= 1; /* Always bias the dnum by one - no zero dnums allowed. */
659 DLIST_ADD(sconn
->searches
.dirptrs
, dptr
);
662 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
663 dptr
->dnum
,path
,expect_close
));
671 /****************************************************************************
672 Wrapper functions to access the lower level directory handles.
673 ****************************************************************************/
675 void dptr_CloseDir(files_struct
*fsp
)
679 * Ugly hack. We have defined fdopendir to return ENOSYS if dirfd also isn't
680 * present. I hate Solaris. JRA.
683 if (fsp
->fh
->fd
!= -1 &&
684 fsp
->dptr
->dir_hnd
&&
685 dirfd(fsp
->dptr
->dir_hnd
->dir
)) {
686 /* The call below closes the underlying fd. */
690 dptr_close_internal(fsp
->dptr
);
695 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
697 SeekDir(dptr
->dir_hnd
, offset
);
700 long dptr_TellDir(struct dptr_struct
*dptr
)
702 return TellDir(dptr
->dir_hnd
);
705 bool dptr_has_wild(struct dptr_struct
*dptr
)
707 return dptr
->has_wild
;
710 int dptr_dnum(struct dptr_struct
*dptr
)
715 bool dptr_get_priv(struct dptr_struct
*dptr
)
720 void dptr_set_priv(struct dptr_struct
*dptr
)
725 /****************************************************************************
726 Return the next visible file name, skipping veto'd and invisible files.
727 ****************************************************************************/
729 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
,
730 long *poffset
, SMB_STRUCT_STAT
*pst
,
733 /* Normal search for the next file. */
735 char *talloced
= NULL
;
737 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
, pst
, &talloced
))
739 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
740 *ptalloced
= talloced
;
743 TALLOC_FREE(talloced
);
748 /****************************************************************************
749 Return the next visible file name, skipping veto'd and invisible files.
750 ****************************************************************************/
752 char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
753 struct dptr_struct
*dptr
,
755 SMB_STRUCT_STAT
*pst
)
757 struct smb_filename smb_fname_base
;
759 const char *name_temp
= NULL
;
760 char *talloced
= NULL
;
761 char *pathreal
= NULL
;
762 char *found_name
= NULL
;
765 SET_STAT_INVALID(*pst
);
767 if (dptr
->has_wild
|| dptr
->did_stat
) {
768 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
,
770 if (name_temp
== NULL
) {
773 if (talloced
!= NULL
) {
774 return talloc_move(ctx
, &talloced
);
776 return talloc_strdup(ctx
, name_temp
);
779 /* If poffset is -1 then we know we returned this name before and we
780 * have no wildcards. We're at the end of the directory. */
781 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
785 /* We know the stored wcard contains no wildcard characters.
786 * See if we can match with a stat call. If we can't, then set
787 * did_stat to true to ensure we only do this once and keep
790 dptr
->did_stat
= true;
792 /* First check if it should be visible. */
793 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
,
796 /* This only returns false if the file was found, but
797 is explicitly not visible. Set us to end of
798 directory, but return NULL as we know we can't ever
803 if (VALID_STAT(*pst
)) {
804 name
= talloc_strdup(ctx
, dptr
->wcard
);
808 pathreal
= talloc_asprintf(ctx
,
815 /* Create an smb_filename with stream_name == NULL. */
816 ZERO_STRUCT(smb_fname_base
);
817 smb_fname_base
.base_name
= pathreal
;
819 if (SMB_VFS_STAT(dptr
->conn
, &smb_fname_base
) == 0) {
820 *pst
= smb_fname_base
.st
;
821 name
= talloc_strdup(ctx
, dptr
->wcard
);
824 /* If we get any other error than ENOENT or ENOTDIR
825 then the file exists we just can't stat it. */
826 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
827 name
= talloc_strdup(ctx
, dptr
->wcard
);
832 /* Stat failed. We know this is authoratiative if we are
833 * providing case sensitive semantics or the underlying
834 * filesystem is case sensitive.
836 if (dptr
->conn
->case_sensitive
||
837 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
))
843 * Try case-insensitive stat if the fs has the ability. This avoids
844 * scanning the whole directory.
846 ret
= SMB_VFS_GET_REAL_FILENAME(dptr
->conn
, dptr
->path
, dptr
->wcard
,
851 } else if (errno
== ENOENT
) {
852 /* The case-insensitive lookup was authoritative. */
856 TALLOC_FREE(pathreal
);
858 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
, &talloced
);
859 if (name_temp
== NULL
) {
862 if (talloced
!= NULL
) {
863 return talloc_move(ctx
, &talloced
);
865 return talloc_strdup(ctx
, name_temp
);
868 TALLOC_FREE(pathreal
);
870 /* We need to set the underlying dir_hnd offset to -1
871 * also as this function is usually called with the
872 * output from TellDir. */
873 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
877 /****************************************************************************
878 Search for a file by name, skipping veto'ed and not visible files.
879 ****************************************************************************/
881 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
883 SET_STAT_INVALID(*pst
);
885 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
886 /* This is a singleton directory and we're already at the end. */
887 *poffset
= END_OF_DIRECTORY_OFFSET
;
891 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
894 /****************************************************************************
895 Add the name we're returning into the underlying cache.
896 ****************************************************************************/
898 void dptr_DirCacheAdd(struct dptr_struct
*dptr
, const char *name
, long offset
)
900 DirCacheAdd(dptr
->dir_hnd
, name
, offset
);
903 /****************************************************************************
904 Initialize variables & state data at the beginning of all search SMB requests.
905 ****************************************************************************/
906 void dptr_init_search_op(struct dptr_struct
*dptr
)
908 SMB_VFS_INIT_SEARCH_OP(dptr
->conn
, dptr
->dir_hnd
->dir
);
911 /****************************************************************************
912 Fill the 5 byte server reserved dptr field.
913 ****************************************************************************/
915 bool dptr_fill(struct smbd_server_connection
*sconn
,
916 char *buf1
,unsigned int key
)
918 unsigned char *buf
= (unsigned char *)buf1
;
919 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
922 DEBUG(1,("filling null dirptr %d\n",key
));
925 offset
= (uint32
)TellDir(dptr
->dir_hnd
);
926 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
927 (long)dptr
->dir_hnd
,(int)offset
));
933 /****************************************************************************
934 Fetch the dir ptr and seek it given the 5 byte server field.
935 ****************************************************************************/
937 struct dptr_struct
*dptr_fetch(struct smbd_server_connection
*sconn
,
940 unsigned int key
= *(unsigned char *)buf
;
941 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
946 DEBUG(3,("fetched null dirptr %d\n",key
));
950 offset
= IVAL(buf
,1);
951 if (offset
== (uint32
)-1) {
952 seekoff
= END_OF_DIRECTORY_OFFSET
;
954 seekoff
= (long)offset
;
956 SeekDir(dptr
->dir_hnd
,seekoff
);
957 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
958 key
, dptr
->path
, (int)seekoff
));
962 /****************************************************************************
964 ****************************************************************************/
966 struct dptr_struct
*dptr_fetch_lanman2(struct smbd_server_connection
*sconn
,
969 struct dptr_struct
*dptr
= dptr_get(sconn
, dptr_num
, false);
972 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
975 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr
->path
));
979 /****************************************************************************
980 Check that a file matches a particular file type.
981 ****************************************************************************/
983 bool dir_check_ftype(connection_struct
*conn
, uint32 mode
, uint32 dirtype
)
987 /* Check the "may have" search bits. */
988 if (((mode
& ~dirtype
) & (FILE_ATTRIBUTE_HIDDEN
| FILE_ATTRIBUTE_SYSTEM
| FILE_ATTRIBUTE_DIRECTORY
)) != 0)
991 /* Check the "must have" bits, which are the may have bits shifted eight */
992 /* If must have bit is set, the file/dir can not be returned in search unless the matching
993 file attribute is set */
994 mask
= ((dirtype
>> 8) & (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
)); /* & 0x37 */
996 if((mask
& (mode
& (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
))) == mask
) /* check if matching attribute present */
1005 static bool mangle_mask_match(connection_struct
*conn
,
1006 const char *filename
,
1011 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
1014 return mask_match_search(mname
,mask
,False
);
1017 bool smbd_dirptr_get_entry(TALLOC_CTX
*ctx
,
1018 struct dptr_struct
*dirptr
,
1023 bool (*match_fn
)(TALLOC_CTX
*ctx
,
1028 bool (*mode_fn
)(TALLOC_CTX
*ctx
,
1030 struct smb_filename
*smb_fname
,
1034 struct smb_filename
**_smb_fname
,
1038 connection_struct
*conn
= dirptr
->conn
;
1044 needslash
= ( dirptr
->path
[strlen(dirptr
->path
) -1] != '/');
1049 SMB_STRUCT_STAT sbuf
;
1053 char *pathreal
= NULL
;
1054 struct smb_filename smb_fname
;
1059 cur_offset
= dptr_TellDir(dirptr
);
1060 prev_offset
= cur_offset
;
1061 dname
= dptr_ReadDirName(ctx
, dirptr
, &cur_offset
, &sbuf
);
1063 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
1064 (long)dirptr
, cur_offset
));
1066 if (dname
== NULL
) {
1070 isdots
= (ISDOT(dname
) || ISDOTDOT(dname
));
1071 if (dont_descend
&& !isdots
) {
1077 * fname may get mangled, dname is never mangled.
1078 * Whenever we're accessing the filesystem we use
1079 * pathreal which is composed from dname.
1082 ok
= match_fn(ctx
, private_data
, dname
, mask
, &fname
);
1088 pathreal
= talloc_asprintf(ctx
, "%s%s%s",
1098 /* Create smb_fname with NULL stream_name. */
1099 ZERO_STRUCT(smb_fname
);
1100 smb_fname
.base_name
= pathreal
;
1101 smb_fname
.st
= sbuf
;
1103 ok
= mode_fn(ctx
, private_data
, &smb_fname
, &mode
);
1107 TALLOC_FREE(pathreal
);
1111 if (!dir_check_ftype(conn
, mode
, dirtype
)) {
1112 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1113 fname
, (unsigned int)mode
, (unsigned int)dirtype
));
1116 TALLOC_FREE(pathreal
);
1120 if (ask_sharemode
) {
1121 struct timespec write_time_ts
;
1122 struct file_id fileid
;
1124 fileid
= vfs_file_id_from_sbuf(conn
,
1126 get_file_infos(fileid
, 0, NULL
, &write_time_ts
);
1127 if (!null_timespec(write_time_ts
)) {
1128 update_stat_ex_mtime(&smb_fname
.st
,
1133 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1135 mask
, smb_fname_str_dbg(&smb_fname
),
1138 DirCacheAdd(dirptr
->dir_hnd
, dname
, cur_offset
);
1142 status
= copy_smb_filename(ctx
, &smb_fname
, _smb_fname
);
1143 TALLOC_FREE(pathreal
);
1144 if (!NT_STATUS_IS_OK(status
)) {
1149 *_prev_offset
= prev_offset
;
1157 /****************************************************************************
1158 Get an 8.3 directory entry.
1159 ****************************************************************************/
1161 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX
*ctx
,
1167 connection_struct
*conn
= (connection_struct
*)private_data
;
1169 if ((strcmp(mask
,"*.*") == 0) ||
1170 mask_match_search(dname
, mask
, false) ||
1171 mangle_mask_match(conn
, dname
, mask
)) {
1175 if (!mangle_is_8_3(dname
, false, conn
->params
)) {
1176 bool ok
= name_to_8_3(dname
, mname
, false,
1186 *_fname
= talloc_strdup(ctx
, fname
);
1187 if (*_fname
== NULL
) {
1197 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX
*ctx
,
1199 struct smb_filename
*smb_fname
,
1202 connection_struct
*conn
= (connection_struct
*)private_data
;
1204 if (!VALID_STAT(smb_fname
->st
)) {
1205 if ((SMB_VFS_STAT(conn
, smb_fname
)) != 0) {
1206 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1207 "Couldn't stat [%s]. Error "
1209 smb_fname_str_dbg(smb_fname
),
1215 *_mode
= dos_mode(conn
, smb_fname
);
1219 bool get_dir_entry(TALLOC_CTX
*ctx
,
1220 struct dptr_struct
*dirptr
,
1226 struct timespec
*_date
,
1230 connection_struct
*conn
= dirptr
->conn
;
1232 struct smb_filename
*smb_fname
= NULL
;
1237 ok
= smbd_dirptr_get_entry(ctx
,
1243 smbd_dirptr_8_3_match_fn
,
1244 smbd_dirptr_8_3_mode_fn
,
1254 *_fname
= talloc_move(ctx
, &fname
);
1255 *_size
= smb_fname
->st
.st_ex_size
;
1257 *_date
= smb_fname
->st
.st_ex_mtime
;
1258 TALLOC_FREE(smb_fname
);
1262 /*******************************************************************
1263 Check to see if a user can read a file. This is only approximate,
1264 it is used as part of the "hide unreadable" option. Don't
1265 use it for anything security sensitive.
1266 ********************************************************************/
1268 static bool user_can_read_file(connection_struct
*conn
,
1269 struct smb_filename
*smb_fname
)
1272 * Never hide files from the root user.
1273 * We use (uid_t)0 here not sec_initial_uid()
1274 * as make test uses a single user context.
1277 if (get_current_uid(conn
) == (uid_t
)0) {
1281 return NT_STATUS_IS_OK(smbd_check_access_rights(conn
,
1286 /*******************************************************************
1287 Check to see if a user can write a file (and only files, we do not
1288 check dirs on this one). This is only approximate,
1289 it is used as part of the "hide unwriteable" option. Don't
1290 use it for anything security sensitive.
1291 ********************************************************************/
1293 static bool user_can_write_file(connection_struct
*conn
,
1294 const struct smb_filename
*smb_fname
)
1297 * Never hide files from the root user.
1298 * We use (uid_t)0 here not sec_initial_uid()
1299 * as make test uses a single user context.
1302 if (get_current_uid(conn
) == (uid_t
)0) {
1306 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1308 /* Pseudo-open the file */
1310 if(S_ISDIR(smb_fname
->st
.st_ex_mode
)) {
1314 return can_write_to_file(conn
, smb_fname
);
1317 /*******************************************************************
1318 Is a file a "special" type ?
1319 ********************************************************************/
1321 static bool file_is_special(connection_struct
*conn
,
1322 const struct smb_filename
*smb_fname
)
1325 * Never hide files from the root user.
1326 * We use (uid_t)0 here not sec_initial_uid()
1327 * as make test uses a single user context.
1330 if (get_current_uid(conn
) == (uid_t
)0) {
1334 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1336 if (S_ISREG(smb_fname
->st
.st_ex_mode
) ||
1337 S_ISDIR(smb_fname
->st
.st_ex_mode
) ||
1338 S_ISLNK(smb_fname
->st
.st_ex_mode
))
1344 /*******************************************************************
1345 Should the file be seen by the client?
1346 NOTE: A successful return is no guarantee of the file's existence.
1347 ********************************************************************/
1349 bool is_visible_file(connection_struct
*conn
, const char *dir_path
,
1350 const char *name
, SMB_STRUCT_STAT
*pst
, bool use_veto
)
1352 bool hide_unreadable
= lp_hideunreadable(SNUM(conn
));
1353 bool hide_unwriteable
= lp_hideunwriteable_files(SNUM(conn
));
1354 bool hide_special
= lp_hide_special_files(SNUM(conn
));
1356 struct smb_filename
*smb_fname_base
= NULL
;
1360 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1361 return True
; /* . and .. are always visible. */
1364 /* If it's a vetoed file, pretend it doesn't even exist */
1365 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1366 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1370 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1371 entry
= talloc_asprintf(talloc_tos(), "%s/%s", dir_path
, name
);
1377 /* Create an smb_filename with stream_name == NULL. */
1378 status
= create_synthetic_smb_fname(talloc_tos(), entry
, NULL
,
1379 pst
, &smb_fname_base
);
1380 if (!NT_STATUS_IS_OK(status
)) {
1385 /* If the file name does not exist, there's no point checking
1386 * the configuration options. We succeed, on the basis that the
1387 * checks *might* have passed if the file was present.
1389 if (!VALID_STAT(*pst
)) {
1390 if (SMB_VFS_STAT(conn
, smb_fname_base
) != 0) {
1394 *pst
= smb_fname_base
->st
;
1398 /* Honour _hide unreadable_ option */
1399 if (hide_unreadable
&&
1400 !user_can_read_file(conn
, smb_fname_base
)) {
1401 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1406 /* Honour _hide unwriteable_ option */
1407 if (hide_unwriteable
&& !user_can_write_file(conn
,
1409 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1414 /* Honour _hide_special_ option */
1415 if (hide_special
&& file_is_special(conn
, smb_fname_base
)) {
1416 DEBUG(10,("is_visible_file: file %s is special.\n",
1425 TALLOC_FREE(smb_fname_base
);
1430 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1434 if (dirp
->conn
->sconn
) {
1435 files_struct
*fsp
= file_find_fd(dirp
->conn
->sconn
,
1438 /* The call below closes the underlying fd. */
1443 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1445 if (dirp
->conn
->sconn
&& !dirp
->conn
->sconn
->using_smb2
) {
1446 dirp
->conn
->sconn
->searches
.dirhandles_open
--;
1451 /*******************************************************************
1453 ********************************************************************/
1455 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1460 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1461 struct smbd_server_connection
*sconn
= conn
->sconn
;
1468 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1470 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1471 if (!dirp
->dir_path
) {
1476 if (sconn
&& !sconn
->using_smb2
) {
1477 sconn
->searches
.dirhandles_open
++;
1479 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1481 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1483 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1495 /*******************************************************************
1496 Open a directory from an fsp.
1497 ********************************************************************/
1499 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1504 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1505 struct smbd_server_connection
*sconn
= conn
->sconn
;
1512 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1514 dirp
->dir_path
= talloc_strdup(dirp
, fsp
->fsp_name
->base_name
);
1515 if (!dirp
->dir_path
) {
1520 if (sconn
&& !sconn
->using_smb2
) {
1521 sconn
->searches
.dirhandles_open
++;
1523 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1525 if (fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
1526 dirp
->dir
= SMB_VFS_FDOPENDIR(fsp
, mask
, attr
);
1527 if (dirp
->dir
== NULL
) {
1528 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1532 if (errno
!= ENOSYS
) {
1538 if (dirp
->dir
== NULL
) {
1539 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1540 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1544 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp
->dir_path
,
1557 /*******************************************************************
1558 Read from a directory.
1559 Return directory entry, current offset, and optional stat information.
1560 Don't check for veto or invisible files.
1561 ********************************************************************/
1563 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
,
1564 SMB_STRUCT_STAT
*sbuf
, char **ptalloced
)
1567 char *talloced
= NULL
;
1568 connection_struct
*conn
= dirp
->conn
;
1570 /* Cheat to allow . and .. to be the first entries returned. */
1571 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) ||
1572 (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2))
1574 if (dirp
->file_number
== 0) {
1576 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1579 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1581 dirp
->file_number
++;
1584 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1585 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1588 /* A real offset, seek to it. */
1589 SeekDir(dirp
, *poffset
);
1592 while ((n
= vfs_readdirname(conn
, dirp
->dir
, sbuf
, &talloced
))) {
1593 /* Ignore . and .. - we've already returned them. */
1595 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1596 TALLOC_FREE(talloced
);
1600 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1601 *ptalloced
= talloced
;
1602 dirp
->file_number
++;
1605 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1610 /*******************************************************************
1611 Rewind to the start.
1612 ********************************************************************/
1614 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1616 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1617 dirp
->file_number
= 0;
1618 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1619 *poffset
= START_OF_DIRECTORY_OFFSET
;
1622 /*******************************************************************
1624 ********************************************************************/
1626 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1628 if (offset
!= dirp
->offset
) {
1629 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1630 RewindDir(dirp
, &offset
);
1632 * Ok we should really set the file number here
1633 * to 1 to enable ".." to be returned next. Trouble
1634 * is I'm worried about callers using SeekDir(dirp,0)
1635 * as equivalent to RewindDir(). So leave this alone
1638 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1639 RewindDir(dirp
, &offset
);
1641 * Set the file number to 2 - we want to get the first
1642 * real file entry (the one we return after "..")
1643 * on the next ReadDir.
1645 dirp
->file_number
= 2;
1646 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1647 ; /* Don't seek in this case. */
1649 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1651 dirp
->offset
= offset
;
1655 /*******************************************************************
1656 Tell a dir position.
1657 ********************************************************************/
1659 long TellDir(struct smb_Dir
*dirp
)
1661 return(dirp
->offset
);
1664 /*******************************************************************
1665 Add an entry into the dcache.
1666 ********************************************************************/
1668 void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1670 struct name_cache_entry
*e
;
1672 if (dirp
->name_cache_size
== 0) {
1676 if (dirp
->name_cache
== NULL
) {
1677 dirp
->name_cache
= talloc_zero_array(
1678 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1680 if (dirp
->name_cache
== NULL
) {
1685 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1686 dirp
->name_cache_size
;
1687 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1688 TALLOC_FREE(e
->name
);
1689 e
->name
= talloc_strdup(dirp
, name
);
1693 /*******************************************************************
1694 Find an entry by name. Leave us at the offset after it.
1695 Don't check for veto or invisible files.
1696 ********************************************************************/
1698 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1701 const char *entry
= NULL
;
1702 char *talloced
= NULL
;
1703 connection_struct
*conn
= dirp
->conn
;
1705 /* Search back in the name cache. */
1706 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1707 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1708 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1709 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1710 *poffset
= e
->offset
;
1711 SeekDir(dirp
, e
->offset
);
1715 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1716 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1717 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1718 *poffset
= e
->offset
;
1719 SeekDir(dirp
, e
->offset
);
1725 /* Not found in the name cache. Rewind directory and start from scratch. */
1726 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1727 dirp
->file_number
= 0;
1728 *poffset
= START_OF_DIRECTORY_OFFSET
;
1729 while ((entry
= ReadDirName(dirp
, poffset
, NULL
, &talloced
))) {
1730 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1731 TALLOC_FREE(talloced
);
1734 TALLOC_FREE(talloced
);
1739 /*****************************************************************
1740 Is this directory empty ?
1741 *****************************************************************/
1743 NTSTATUS
can_delete_directory(struct connection_struct
*conn
,
1744 const char *dirname
)
1746 NTSTATUS status
= NT_STATUS_OK
;
1748 const char *dname
= NULL
;
1749 char *talloced
= NULL
;
1751 struct smb_Dir
*dir_hnd
= OpenDir(talloc_tos(), conn
,
1755 return map_nt_error_from_unix(errno
);
1758 while ((dname
= ReadDirName(dir_hnd
, &dirpos
, &st
, &talloced
))) {
1759 /* Quick check for "." and ".." */
1760 if (dname
[0] == '.') {
1761 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1762 TALLOC_FREE(talloced
);
1767 if (!is_visible_file(conn
, dirname
, dname
, &st
, True
)) {
1768 TALLOC_FREE(talloced
);
1772 DEBUG(10,("can_delete_directory: got name %s - can't delete\n",
1774 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1777 TALLOC_FREE(talloced
);
1778 TALLOC_FREE(dir_hnd
);