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
,
537 if (!NT_STATUS_IS_OK(status
)) {
541 dir_hnd
= open_dir_with_privilege(conn
,
547 dir_hnd
= OpenDir(NULL
, conn
, path
, wcard
, attr
);
552 return map_nt_error_from_unix(errno
);
555 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
) {
556 dptr_idleoldest(sconn
);
559 dptr
= talloc(NULL
, struct dptr_struct
);
561 DEBUG(0,("talloc fail in dptr_create.\n"));
562 TALLOC_FREE(dir_hnd
);
563 return NT_STATUS_NO_MEMORY
;
568 dptr
->path
= talloc_strdup(dptr
, path
);
571 TALLOC_FREE(dir_hnd
);
572 return NT_STATUS_NO_MEMORY
;
575 dptr
->dir_hnd
= dir_hnd
;
577 dptr
->expect_close
= expect_close
;
578 dptr
->wcard
= talloc_strdup(dptr
, wcard
);
581 TALLOC_FREE(dir_hnd
);
582 return NT_STATUS_NO_MEMORY
;
584 if (lp_posix_pathnames() || (wcard
[0] == '.' && wcard
[1] == 0)) {
585 dptr
->has_wild
= True
;
587 dptr
->has_wild
= wcard_has_wild
;
592 if (sconn
->using_smb2
) {
599 * This is an old-style SMBsearch request. Ensure the
600 * value we return will fit in the range 1-255.
603 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
605 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
608 * Try and close the oldest handle not marked for
609 * expect close in the hope that the client has
610 * finished with that one.
613 dptr_close_oldest(sconn
, true);
615 /* Now try again... */
616 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 0);
617 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
618 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr
->dnum
));
620 TALLOC_FREE(dir_hnd
);
621 return NT_STATUS_TOO_MANY_OPENED_FILES
;
627 * This is a new-style trans2 request. Allocate from
628 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
631 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
633 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
636 * Try and close the oldest handle close in the hope that
637 * the client has finished with that one. This will only
638 * happen in the case of the Win98 client bug where it leaks
642 dptr_close_oldest(sconn
, false);
644 /* Now try again... */
645 dptr
->dnum
= bitmap_find(sconn
->searches
.dptr_bmap
, 255);
647 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
648 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr
->dnum
));
650 TALLOC_FREE(dir_hnd
);
651 return NT_STATUS_TOO_MANY_OPENED_FILES
;
656 bitmap_set(sconn
->searches
.dptr_bmap
, dptr
->dnum
);
658 dptr
->dnum
+= 1; /* Always bias the dnum by one - no zero dnums allowed. */
660 DLIST_ADD(sconn
->searches
.dirptrs
, dptr
);
663 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
664 dptr
->dnum
,path
,expect_close
));
672 /****************************************************************************
673 Wrapper functions to access the lower level directory handles.
674 ****************************************************************************/
676 void dptr_CloseDir(files_struct
*fsp
)
680 * Ugly hack. We have defined fdopendir to return ENOSYS if dirfd also isn't
681 * present. I hate Solaris. JRA.
684 if (fsp
->fh
->fd
!= -1 &&
685 fsp
->dptr
->dir_hnd
&&
686 dirfd(fsp
->dptr
->dir_hnd
->dir
)) {
687 /* The call below closes the underlying fd. */
691 dptr_close_internal(fsp
->dptr
);
696 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
698 SeekDir(dptr
->dir_hnd
, offset
);
701 long dptr_TellDir(struct dptr_struct
*dptr
)
703 return TellDir(dptr
->dir_hnd
);
706 bool dptr_has_wild(struct dptr_struct
*dptr
)
708 return dptr
->has_wild
;
711 int dptr_dnum(struct dptr_struct
*dptr
)
716 bool dptr_get_priv(struct dptr_struct
*dptr
)
721 void dptr_set_priv(struct dptr_struct
*dptr
)
726 /****************************************************************************
727 Return the next visible file name, skipping veto'd and invisible files.
728 ****************************************************************************/
730 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
,
731 long *poffset
, SMB_STRUCT_STAT
*pst
,
734 /* Normal search for the next file. */
736 char *talloced
= NULL
;
738 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
, pst
, &talloced
))
740 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
741 *ptalloced
= talloced
;
744 TALLOC_FREE(talloced
);
749 /****************************************************************************
750 Return the next visible file name, skipping veto'd and invisible files.
751 ****************************************************************************/
753 char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
754 struct dptr_struct
*dptr
,
756 SMB_STRUCT_STAT
*pst
)
758 struct smb_filename smb_fname_base
;
760 const char *name_temp
= NULL
;
761 char *talloced
= NULL
;
762 char *pathreal
= NULL
;
763 char *found_name
= NULL
;
766 SET_STAT_INVALID(*pst
);
768 if (dptr
->has_wild
|| dptr
->did_stat
) {
769 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
,
771 if (name_temp
== NULL
) {
774 if (talloced
!= NULL
) {
775 return talloc_move(ctx
, &talloced
);
777 return talloc_strdup(ctx
, name_temp
);
780 /* If poffset is -1 then we know we returned this name before and we
781 * have no wildcards. We're at the end of the directory. */
782 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
786 /* We know the stored wcard contains no wildcard characters.
787 * See if we can match with a stat call. If we can't, then set
788 * did_stat to true to ensure we only do this once and keep
791 dptr
->did_stat
= true;
793 /* First check if it should be visible. */
794 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
,
797 /* This only returns false if the file was found, but
798 is explicitly not visible. Set us to end of
799 directory, but return NULL as we know we can't ever
804 if (VALID_STAT(*pst
)) {
805 name
= talloc_strdup(ctx
, dptr
->wcard
);
809 pathreal
= talloc_asprintf(ctx
,
816 /* Create an smb_filename with stream_name == NULL. */
817 ZERO_STRUCT(smb_fname_base
);
818 smb_fname_base
.base_name
= pathreal
;
820 if (SMB_VFS_STAT(dptr
->conn
, &smb_fname_base
) == 0) {
821 *pst
= smb_fname_base
.st
;
822 name
= talloc_strdup(ctx
, dptr
->wcard
);
825 /* If we get any other error than ENOENT or ENOTDIR
826 then the file exists we just can't stat it. */
827 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
828 name
= talloc_strdup(ctx
, dptr
->wcard
);
833 /* Stat failed. We know this is authoratiative if we are
834 * providing case sensitive semantics or the underlying
835 * filesystem is case sensitive.
837 if (dptr
->conn
->case_sensitive
||
838 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
))
844 * Try case-insensitive stat if the fs has the ability. This avoids
845 * scanning the whole directory.
847 ret
= SMB_VFS_GET_REAL_FILENAME(dptr
->conn
, dptr
->path
, dptr
->wcard
,
852 } else if (errno
== ENOENT
) {
853 /* The case-insensitive lookup was authoritative. */
857 TALLOC_FREE(pathreal
);
859 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
, &talloced
);
860 if (name_temp
== NULL
) {
863 if (talloced
!= NULL
) {
864 return talloc_move(ctx
, &talloced
);
866 return talloc_strdup(ctx
, name_temp
);
869 TALLOC_FREE(pathreal
);
871 /* We need to set the underlying dir_hnd offset to -1
872 * also as this function is usually called with the
873 * output from TellDir. */
874 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
878 /****************************************************************************
879 Search for a file by name, skipping veto'ed and not visible files.
880 ****************************************************************************/
882 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
884 SET_STAT_INVALID(*pst
);
886 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
887 /* This is a singleton directory and we're already at the end. */
888 *poffset
= END_OF_DIRECTORY_OFFSET
;
892 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
895 /****************************************************************************
896 Add the name we're returning into the underlying cache.
897 ****************************************************************************/
899 void dptr_DirCacheAdd(struct dptr_struct
*dptr
, const char *name
, long offset
)
901 DirCacheAdd(dptr
->dir_hnd
, name
, offset
);
904 /****************************************************************************
905 Initialize variables & state data at the beginning of all search SMB requests.
906 ****************************************************************************/
907 void dptr_init_search_op(struct dptr_struct
*dptr
)
909 SMB_VFS_INIT_SEARCH_OP(dptr
->conn
, dptr
->dir_hnd
->dir
);
912 /****************************************************************************
913 Fill the 5 byte server reserved dptr field.
914 ****************************************************************************/
916 bool dptr_fill(struct smbd_server_connection
*sconn
,
917 char *buf1
,unsigned int key
)
919 unsigned char *buf
= (unsigned char *)buf1
;
920 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
923 DEBUG(1,("filling null dirptr %d\n",key
));
926 offset
= (uint32
)TellDir(dptr
->dir_hnd
);
927 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
928 (long)dptr
->dir_hnd
,(int)offset
));
934 /****************************************************************************
935 Fetch the dir ptr and seek it given the 5 byte server field.
936 ****************************************************************************/
938 struct dptr_struct
*dptr_fetch(struct smbd_server_connection
*sconn
,
941 unsigned int key
= *(unsigned char *)buf
;
942 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
947 DEBUG(3,("fetched null dirptr %d\n",key
));
951 offset
= IVAL(buf
,1);
952 if (offset
== (uint32
)-1) {
953 seekoff
= END_OF_DIRECTORY_OFFSET
;
955 seekoff
= (long)offset
;
957 SeekDir(dptr
->dir_hnd
,seekoff
);
958 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
959 key
, dptr
->path
, (int)seekoff
));
963 /****************************************************************************
965 ****************************************************************************/
967 struct dptr_struct
*dptr_fetch_lanman2(struct smbd_server_connection
*sconn
,
970 struct dptr_struct
*dptr
= dptr_get(sconn
, dptr_num
, false);
973 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
976 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr
->path
));
980 /****************************************************************************
981 Check that a file matches a particular file type.
982 ****************************************************************************/
984 bool dir_check_ftype(connection_struct
*conn
, uint32 mode
, uint32 dirtype
)
988 /* Check the "may have" search bits. */
989 if (((mode
& ~dirtype
) & (FILE_ATTRIBUTE_HIDDEN
| FILE_ATTRIBUTE_SYSTEM
| FILE_ATTRIBUTE_DIRECTORY
)) != 0)
992 /* Check the "must have" bits, which are the may have bits shifted eight */
993 /* If must have bit is set, the file/dir can not be returned in search unless the matching
994 file attribute is set */
995 mask
= ((dirtype
>> 8) & (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
)); /* & 0x37 */
997 if((mask
& (mode
& (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
))) == mask
) /* check if matching attribute present */
1006 static bool mangle_mask_match(connection_struct
*conn
,
1007 const char *filename
,
1012 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
1015 return mask_match_search(mname
,mask
,False
);
1018 bool smbd_dirptr_get_entry(TALLOC_CTX
*ctx
,
1019 struct dptr_struct
*dirptr
,
1024 bool (*match_fn
)(TALLOC_CTX
*ctx
,
1029 bool (*mode_fn
)(TALLOC_CTX
*ctx
,
1031 struct smb_filename
*smb_fname
,
1035 struct smb_filename
**_smb_fname
,
1039 connection_struct
*conn
= dirptr
->conn
;
1045 needslash
= ( dirptr
->path
[strlen(dirptr
->path
) -1] != '/');
1050 SMB_STRUCT_STAT sbuf
;
1054 char *pathreal
= NULL
;
1055 struct smb_filename smb_fname
;
1060 cur_offset
= dptr_TellDir(dirptr
);
1061 prev_offset
= cur_offset
;
1062 dname
= dptr_ReadDirName(ctx
, dirptr
, &cur_offset
, &sbuf
);
1064 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
1065 (long)dirptr
, cur_offset
));
1067 if (dname
== NULL
) {
1071 isdots
= (ISDOT(dname
) || ISDOTDOT(dname
));
1072 if (dont_descend
&& !isdots
) {
1078 * fname may get mangled, dname is never mangled.
1079 * Whenever we're accessing the filesystem we use
1080 * pathreal which is composed from dname.
1083 ok
= match_fn(ctx
, private_data
, dname
, mask
, &fname
);
1089 pathreal
= talloc_asprintf(ctx
, "%s%s%s",
1099 /* Create smb_fname with NULL stream_name. */
1100 ZERO_STRUCT(smb_fname
);
1101 smb_fname
.base_name
= pathreal
;
1102 smb_fname
.st
= sbuf
;
1104 ok
= mode_fn(ctx
, private_data
, &smb_fname
, &mode
);
1108 TALLOC_FREE(pathreal
);
1112 if (!dir_check_ftype(conn
, mode
, dirtype
)) {
1113 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1114 fname
, (unsigned int)mode
, (unsigned int)dirtype
));
1117 TALLOC_FREE(pathreal
);
1121 if (ask_sharemode
) {
1122 struct timespec write_time_ts
;
1123 struct file_id fileid
;
1125 fileid
= vfs_file_id_from_sbuf(conn
,
1127 get_file_infos(fileid
, 0, NULL
, &write_time_ts
);
1128 if (!null_timespec(write_time_ts
)) {
1129 update_stat_ex_mtime(&smb_fname
.st
,
1134 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1136 mask
, smb_fname_str_dbg(&smb_fname
),
1139 DirCacheAdd(dirptr
->dir_hnd
, dname
, cur_offset
);
1143 status
= copy_smb_filename(ctx
, &smb_fname
, _smb_fname
);
1144 TALLOC_FREE(pathreal
);
1145 if (!NT_STATUS_IS_OK(status
)) {
1150 *_prev_offset
= prev_offset
;
1158 /****************************************************************************
1159 Get an 8.3 directory entry.
1160 ****************************************************************************/
1162 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX
*ctx
,
1168 connection_struct
*conn
= (connection_struct
*)private_data
;
1170 if ((strcmp(mask
,"*.*") == 0) ||
1171 mask_match_search(dname
, mask
, false) ||
1172 mangle_mask_match(conn
, dname
, mask
)) {
1176 if (!mangle_is_8_3(dname
, false, conn
->params
)) {
1177 bool ok
= name_to_8_3(dname
, mname
, false,
1187 *_fname
= talloc_strdup(ctx
, fname
);
1188 if (*_fname
== NULL
) {
1198 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX
*ctx
,
1200 struct smb_filename
*smb_fname
,
1203 connection_struct
*conn
= (connection_struct
*)private_data
;
1205 if (!VALID_STAT(smb_fname
->st
)) {
1206 if ((SMB_VFS_STAT(conn
, smb_fname
)) != 0) {
1207 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1208 "Couldn't stat [%s]. Error "
1210 smb_fname_str_dbg(smb_fname
),
1216 *_mode
= dos_mode(conn
, smb_fname
);
1220 bool get_dir_entry(TALLOC_CTX
*ctx
,
1221 struct dptr_struct
*dirptr
,
1227 struct timespec
*_date
,
1231 connection_struct
*conn
= dirptr
->conn
;
1233 struct smb_filename
*smb_fname
= NULL
;
1238 ok
= smbd_dirptr_get_entry(ctx
,
1244 smbd_dirptr_8_3_match_fn
,
1245 smbd_dirptr_8_3_mode_fn
,
1255 *_fname
= talloc_move(ctx
, &fname
);
1256 *_size
= smb_fname
->st
.st_ex_size
;
1258 *_date
= smb_fname
->st
.st_ex_mtime
;
1259 TALLOC_FREE(smb_fname
);
1263 /*******************************************************************
1264 Check to see if a user can read a file. This is only approximate,
1265 it is used as part of the "hide unreadable" option. Don't
1266 use it for anything security sensitive.
1267 ********************************************************************/
1269 static bool user_can_read_file(connection_struct
*conn
,
1270 struct smb_filename
*smb_fname
)
1273 * Never hide files from the root user.
1274 * We use (uid_t)0 here not sec_initial_uid()
1275 * as make test uses a single user context.
1278 if (get_current_uid(conn
) == (uid_t
)0) {
1282 return NT_STATUS_IS_OK(smbd_check_access_rights(conn
,
1287 /*******************************************************************
1288 Check to see if a user can write a file (and only files, we do not
1289 check dirs on this one). This is only approximate,
1290 it is used as part of the "hide unwriteable" option. Don't
1291 use it for anything security sensitive.
1292 ********************************************************************/
1294 static bool user_can_write_file(connection_struct
*conn
,
1295 const struct smb_filename
*smb_fname
)
1298 * Never hide files from the root user.
1299 * We use (uid_t)0 here not sec_initial_uid()
1300 * as make test uses a single user context.
1303 if (get_current_uid(conn
) == (uid_t
)0) {
1307 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1309 /* Pseudo-open the file */
1311 if(S_ISDIR(smb_fname
->st
.st_ex_mode
)) {
1315 return can_write_to_file(conn
, smb_fname
);
1318 /*******************************************************************
1319 Is a file a "special" type ?
1320 ********************************************************************/
1322 static bool file_is_special(connection_struct
*conn
,
1323 const struct smb_filename
*smb_fname
)
1326 * Never hide files from the root user.
1327 * We use (uid_t)0 here not sec_initial_uid()
1328 * as make test uses a single user context.
1331 if (get_current_uid(conn
) == (uid_t
)0) {
1335 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1337 if (S_ISREG(smb_fname
->st
.st_ex_mode
) ||
1338 S_ISDIR(smb_fname
->st
.st_ex_mode
) ||
1339 S_ISLNK(smb_fname
->st
.st_ex_mode
))
1345 /*******************************************************************
1346 Should the file be seen by the client?
1347 NOTE: A successful return is no guarantee of the file's existence.
1348 ********************************************************************/
1350 bool is_visible_file(connection_struct
*conn
, const char *dir_path
,
1351 const char *name
, SMB_STRUCT_STAT
*pst
, bool use_veto
)
1353 bool hide_unreadable
= lp_hideunreadable(SNUM(conn
));
1354 bool hide_unwriteable
= lp_hideunwriteable_files(SNUM(conn
));
1355 bool hide_special
= lp_hide_special_files(SNUM(conn
));
1357 struct smb_filename
*smb_fname_base
= NULL
;
1361 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1362 return True
; /* . and .. are always visible. */
1365 /* If it's a vetoed file, pretend it doesn't even exist */
1366 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1367 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1371 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1372 entry
= talloc_asprintf(talloc_tos(), "%s/%s", dir_path
, name
);
1378 /* Create an smb_filename with stream_name == NULL. */
1379 status
= create_synthetic_smb_fname(talloc_tos(), entry
, NULL
,
1380 pst
, &smb_fname_base
);
1381 if (!NT_STATUS_IS_OK(status
)) {
1386 /* If the file name does not exist, there's no point checking
1387 * the configuration options. We succeed, on the basis that the
1388 * checks *might* have passed if the file was present.
1390 if (!VALID_STAT(*pst
)) {
1391 if (SMB_VFS_STAT(conn
, smb_fname_base
) != 0) {
1395 *pst
= smb_fname_base
->st
;
1399 /* Honour _hide unreadable_ option */
1400 if (hide_unreadable
&&
1401 !user_can_read_file(conn
, smb_fname_base
)) {
1402 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1407 /* Honour _hide unwriteable_ option */
1408 if (hide_unwriteable
&& !user_can_write_file(conn
,
1410 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1415 /* Honour _hide_special_ option */
1416 if (hide_special
&& file_is_special(conn
, smb_fname_base
)) {
1417 DEBUG(10,("is_visible_file: file %s is special.\n",
1426 TALLOC_FREE(smb_fname_base
);
1431 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1435 if (dirp
->conn
->sconn
) {
1436 files_struct
*fsp
= file_find_fd(dirp
->conn
->sconn
,
1439 /* The call below closes the underlying fd. */
1444 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1446 if (dirp
->conn
->sconn
&& !dirp
->conn
->sconn
->using_smb2
) {
1447 dirp
->conn
->sconn
->searches
.dirhandles_open
--;
1452 /*******************************************************************
1454 ********************************************************************/
1456 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1461 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1462 struct smbd_server_connection
*sconn
= conn
->sconn
;
1469 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1471 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1472 if (!dirp
->dir_path
) {
1477 if (sconn
&& !sconn
->using_smb2
) {
1478 sconn
->searches
.dirhandles_open
++;
1480 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1482 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1484 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1496 /*******************************************************************
1497 Open a directory from an fsp.
1498 ********************************************************************/
1500 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1505 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1506 struct smbd_server_connection
*sconn
= conn
->sconn
;
1513 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1515 dirp
->dir_path
= talloc_strdup(dirp
, fsp
->fsp_name
->base_name
);
1516 if (!dirp
->dir_path
) {
1521 if (sconn
&& !sconn
->using_smb2
) {
1522 sconn
->searches
.dirhandles_open
++;
1524 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1526 if (fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
1527 dirp
->dir
= SMB_VFS_FDOPENDIR(fsp
, mask
, attr
);
1528 if (dirp
->dir
== NULL
) {
1529 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1533 if (errno
!= ENOSYS
) {
1539 if (dirp
->dir
== NULL
) {
1540 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1541 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1545 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp
->dir_path
,
1558 /*******************************************************************
1559 Read from a directory.
1560 Return directory entry, current offset, and optional stat information.
1561 Don't check for veto or invisible files.
1562 ********************************************************************/
1564 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
,
1565 SMB_STRUCT_STAT
*sbuf
, char **ptalloced
)
1568 char *talloced
= NULL
;
1569 connection_struct
*conn
= dirp
->conn
;
1571 /* Cheat to allow . and .. to be the first entries returned. */
1572 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) ||
1573 (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2))
1575 if (dirp
->file_number
== 0) {
1577 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1580 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1582 dirp
->file_number
++;
1585 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1586 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1589 /* A real offset, seek to it. */
1590 SeekDir(dirp
, *poffset
);
1593 while ((n
= vfs_readdirname(conn
, dirp
->dir
, sbuf
, &talloced
))) {
1594 /* Ignore . and .. - we've already returned them. */
1596 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1597 TALLOC_FREE(talloced
);
1601 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1602 *ptalloced
= talloced
;
1603 dirp
->file_number
++;
1606 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1611 /*******************************************************************
1612 Rewind to the start.
1613 ********************************************************************/
1615 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1617 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1618 dirp
->file_number
= 0;
1619 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1620 *poffset
= START_OF_DIRECTORY_OFFSET
;
1623 /*******************************************************************
1625 ********************************************************************/
1627 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1629 if (offset
!= dirp
->offset
) {
1630 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1631 RewindDir(dirp
, &offset
);
1633 * Ok we should really set the file number here
1634 * to 1 to enable ".." to be returned next. Trouble
1635 * is I'm worried about callers using SeekDir(dirp,0)
1636 * as equivalent to RewindDir(). So leave this alone
1639 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1640 RewindDir(dirp
, &offset
);
1642 * Set the file number to 2 - we want to get the first
1643 * real file entry (the one we return after "..")
1644 * on the next ReadDir.
1646 dirp
->file_number
= 2;
1647 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1648 ; /* Don't seek in this case. */
1650 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1652 dirp
->offset
= offset
;
1656 /*******************************************************************
1657 Tell a dir position.
1658 ********************************************************************/
1660 long TellDir(struct smb_Dir
*dirp
)
1662 return(dirp
->offset
);
1665 /*******************************************************************
1666 Add an entry into the dcache.
1667 ********************************************************************/
1669 void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1671 struct name_cache_entry
*e
;
1673 if (dirp
->name_cache_size
== 0) {
1677 if (dirp
->name_cache
== NULL
) {
1678 dirp
->name_cache
= talloc_zero_array(
1679 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1681 if (dirp
->name_cache
== NULL
) {
1686 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1687 dirp
->name_cache_size
;
1688 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1689 TALLOC_FREE(e
->name
);
1690 e
->name
= talloc_strdup(dirp
, name
);
1694 /*******************************************************************
1695 Find an entry by name. Leave us at the offset after it.
1696 Don't check for veto or invisible files.
1697 ********************************************************************/
1699 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1702 const char *entry
= NULL
;
1703 char *talloced
= NULL
;
1704 connection_struct
*conn
= dirp
->conn
;
1706 /* Search back in the name cache. */
1707 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1708 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1709 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1710 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1711 *poffset
= e
->offset
;
1712 SeekDir(dirp
, e
->offset
);
1716 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1717 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1718 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1719 *poffset
= e
->offset
;
1720 SeekDir(dirp
, e
->offset
);
1726 /* Not found in the name cache. Rewind directory and start from scratch. */
1727 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1728 dirp
->file_number
= 0;
1729 *poffset
= START_OF_DIRECTORY_OFFSET
;
1730 while ((entry
= ReadDirName(dirp
, poffset
, NULL
, &talloced
))) {
1731 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1732 TALLOC_FREE(talloced
);
1735 TALLOC_FREE(talloced
);
1740 /*****************************************************************
1741 Is this directory empty ?
1742 *****************************************************************/
1744 NTSTATUS
can_delete_directory(struct connection_struct
*conn
,
1745 const char *dirname
)
1747 NTSTATUS status
= NT_STATUS_OK
;
1749 const char *dname
= NULL
;
1750 char *talloced
= NULL
;
1752 struct smb_Dir
*dir_hnd
= OpenDir(talloc_tos(), conn
,
1756 return map_nt_error_from_unix(errno
);
1759 while ((dname
= ReadDirName(dir_hnd
, &dirpos
, &st
, &talloced
))) {
1760 /* Quick check for "." and ".." */
1761 if (dname
[0] == '.') {
1762 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1763 TALLOC_FREE(talloced
);
1768 if (!is_visible_file(conn
, dirname
, dname
, &st
, True
)) {
1769 TALLOC_FREE(talloced
);
1773 DEBUG(10,("can_delete_directory: got name %s - can't delete\n",
1775 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1778 TALLOC_FREE(talloced
);
1779 TALLOC_FREE(dir_hnd
);