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 static void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
);
79 #define INVALID_DPTR_KEY (-3)
81 /****************************************************************************
83 ****************************************************************************/
85 bool make_dir_struct(TALLOC_CTX
*ctx
,
95 char *mask2
= talloc_strdup(ctx
, mask
);
101 if ((mode
& FILE_ATTRIBUTE_DIRECTORY
) != 0) {
105 memset(buf
+1,' ',11);
106 if ((p
= strchr_m(mask2
,'.')) != NULL
) {
108 push_ascii(buf
+1,mask2
,8, 0);
109 push_ascii(buf
+9,p
+1,3, 0);
112 push_ascii(buf
+1,mask2
,11, 0);
115 memset(buf
+21,'\0',DIR_STRUCT_SIZE
-21);
117 srv_put_dos_date(buf
,22,date
);
118 SSVAL(buf
,26,size
& 0xFFFF);
119 SSVAL(buf
,28,(size
>> 16)&0xFFFF);
120 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
121 Strange, but verified on W2K3. Needed for OS/2. JRA. */
122 push_ascii(buf
+30,fname
,12, uc
? STR_UPPER
: 0);
123 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf
+30, fname
));
127 /****************************************************************************
128 Initialise the dir bitmap.
129 ****************************************************************************/
131 bool init_dptrs(struct smbd_server_connection
*sconn
)
133 if (sconn
->searches
.dptr_bmap
) {
137 sconn
->searches
.dptr_bmap
= bitmap_talloc(
138 sconn
, MAX_DIRECTORY_HANDLES
);
140 if (sconn
->searches
.dptr_bmap
== NULL
) {
147 /****************************************************************************
148 Idle a dptr - the directory is closed but the control info is kept.
149 ****************************************************************************/
151 static void dptr_idle(struct dptr_struct
*dptr
)
154 DEBUG(4,("Idling dptr dnum %d\n",dptr
->dnum
));
155 TALLOC_FREE(dptr
->dir_hnd
);
159 /****************************************************************************
160 Idle the oldest dptr.
161 ****************************************************************************/
163 static void dptr_idleoldest(struct smbd_server_connection
*sconn
)
165 struct dptr_struct
*dptr
;
168 * Go to the end of the list.
170 dptr
= DLIST_TAIL(sconn
->searches
.dirptrs
);
173 DEBUG(0,("No dptrs available to idle ?\n"));
178 * Idle the oldest pointer.
181 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
189 /****************************************************************************
190 Get the struct dptr_struct for a dir index.
191 ****************************************************************************/
193 static struct dptr_struct
*dptr_get(struct smbd_server_connection
*sconn
,
194 int key
, bool forclose
)
196 struct dptr_struct
*dptr
;
198 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
199 if(dptr
->dnum
== key
) {
200 if (!forclose
&& !dptr
->dir_hnd
) {
201 if (sconn
->searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
)
202 dptr_idleoldest(sconn
);
203 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key
));
204 if (!(dptr
->dir_hnd
= OpenDir(
205 NULL
, dptr
->conn
, dptr
->path
,
206 dptr
->wcard
, dptr
->attr
))) {
207 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr
->path
,
212 DLIST_PROMOTE(sconn
->searches
.dirptrs
,dptr
);
219 /****************************************************************************
220 Get the dir path for a dir index.
221 ****************************************************************************/
223 const char *dptr_path(struct smbd_server_connection
*sconn
, int key
)
225 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
231 /****************************************************************************
232 Get the dir wcard for a dir index.
233 ****************************************************************************/
235 const char *dptr_wcard(struct smbd_server_connection
*sconn
, int key
)
237 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
243 /****************************************************************************
244 Get the dir attrib for a dir index.
245 ****************************************************************************/
247 uint16
dptr_attr(struct smbd_server_connection
*sconn
, int key
)
249 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
255 /****************************************************************************
256 Close a dptr (internal func).
257 ****************************************************************************/
259 static void dptr_close_internal(struct dptr_struct
*dptr
)
261 struct smbd_server_connection
*sconn
= dptr
->conn
->sconn
;
263 DEBUG(4,("closing dptr key %d\n",dptr
->dnum
));
269 if (sconn
->using_smb2
) {
273 DLIST_REMOVE(sconn
->searches
.dirptrs
, dptr
);
276 * Free the dnum in the bitmap. Remember the dnum value is always
277 * biased by one with respect to the bitmap.
280 if (!bitmap_query(sconn
->searches
.dptr_bmap
, dptr
->dnum
- 1)) {
281 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
285 bitmap_clear(sconn
->searches
.dptr_bmap
, dptr
->dnum
- 1);
288 TALLOC_FREE(dptr
->dir_hnd
);
292 /****************************************************************************
293 Close a dptr given a key.
294 ****************************************************************************/
296 void dptr_close(struct smbd_server_connection
*sconn
, int *key
)
298 struct dptr_struct
*dptr
;
300 if(*key
== INVALID_DPTR_KEY
)
303 /* OS/2 seems to use -1 to indicate "close all directories" */
305 struct dptr_struct
*next
;
306 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
308 dptr_close_internal(dptr
);
310 *key
= INVALID_DPTR_KEY
;
314 dptr
= dptr_get(sconn
, *key
, true);
317 DEBUG(0,("Invalid key %d given to dptr_close\n", *key
));
321 dptr_close_internal(dptr
);
323 *key
= INVALID_DPTR_KEY
;
326 /****************************************************************************
327 Close all dptrs for a cnum.
328 ****************************************************************************/
330 void dptr_closecnum(connection_struct
*conn
)
332 struct dptr_struct
*dptr
, *next
;
333 struct smbd_server_connection
*sconn
= conn
->sconn
;
339 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
341 if (dptr
->conn
== conn
) {
342 dptr_close_internal(dptr
);
347 /****************************************************************************
348 Idle all dptrs for a cnum.
349 ****************************************************************************/
351 void dptr_idlecnum(connection_struct
*conn
)
353 struct dptr_struct
*dptr
;
354 struct smbd_server_connection
*sconn
= conn
->sconn
;
360 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
361 if (dptr
->conn
== conn
&& dptr
->dir_hnd
) {
367 /****************************************************************************
368 Close a dptr that matches a given path, only if it matches the spid also.
369 ****************************************************************************/
371 void dptr_closepath(struct smbd_server_connection
*sconn
,
372 char *path
,uint16 spid
)
374 struct dptr_struct
*dptr
, *next
;
375 for(dptr
= sconn
->searches
.dirptrs
; dptr
; dptr
= next
) {
377 if (spid
== dptr
->spid
&& strequal(dptr
->path
,path
))
378 dptr_close_internal(dptr
);
382 /****************************************************************************
383 Try and close the oldest handle not marked for
384 expect close in the hope that the client has
385 finished with that one.
386 ****************************************************************************/
388 static void dptr_close_oldest(struct smbd_server_connection
*sconn
,
391 struct dptr_struct
*dptr
;
394 * Go to the end of the list.
396 for(dptr
= sconn
->searches
.dirptrs
; dptr
&& dptr
->next
; dptr
= dptr
->next
)
400 DEBUG(0,("No old dptrs available to close oldest ?\n"));
405 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
406 * does not have expect_close set. If 'old' is false, close
407 * one of the new dnum handles.
410 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
411 if ((old
&& (dptr
->dnum
< 256) && !dptr
->expect_close
) ||
412 (!old
&& (dptr
->dnum
> 255))) {
413 dptr_close_internal(dptr
);
419 /****************************************************************************
420 Safely do an OpenDir as root, ensuring we're in the right place.
421 ****************************************************************************/
423 static struct smb_Dir
*open_dir_with_privilege(connection_struct
*conn
,
424 struct smb_request
*req
,
430 struct smb_Dir
*dir_hnd
= NULL
;
431 struct smb_filename
*smb_fname_cwd
;
432 char *saved_dir
= vfs_GetWd(talloc_tos(), conn
);
433 struct privilege_paths
*priv_paths
= req
->priv_paths
;
436 if (saved_dir
== NULL
) {
440 if (vfs_ChDir(conn
, path
) == -1) {
444 /* Now check the stat value is the same. */
445 smb_fname_cwd
= synthetic_smb_fname(talloc_tos(), ".", NULL
, NULL
);
447 if (smb_fname_cwd
== NULL
) {
448 status
= NT_STATUS_NO_MEMORY
;
451 ret
= SMB_VFS_STAT(conn
, smb_fname_cwd
);
456 if (!check_same_stat(&smb_fname_cwd
->st
, &priv_paths
->parent_name
.st
)) {
457 DEBUG(0,("open_dir_with_privilege: stat mismatch between %s "
460 smb_fname_str_dbg(&priv_paths
->parent_name
)));
464 dir_hnd
= OpenDir(NULL
, conn
, ".", wcard
, attr
);
468 vfs_ChDir(conn
, saved_dir
);
472 /****************************************************************************
473 Create a new dir ptr. If the flag old_handle is true then we must allocate
474 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
475 one byte long. If old_handle is false we allocate from the range
476 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
477 a directory handle is never zero.
478 wcard must not be zero.
479 ****************************************************************************/
481 NTSTATUS
dptr_create(connection_struct
*conn
,
482 struct smb_request
*req
,
484 const char *path
, bool old_handle
, bool expect_close
,uint16 spid
,
485 const char *wcard
, bool wcard_has_wild
, uint32 attr
, struct dptr_struct
**dptr_ret
)
487 struct smbd_server_connection
*sconn
= conn
->sconn
;
488 struct dptr_struct
*dptr
= NULL
;
489 struct smb_Dir
*dir_hnd
;
491 if (fsp
&& fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
492 path
= fsp
->fsp_name
->base_name
;
495 DEBUG(5,("dptr_create dir=%s\n", path
));
498 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
499 return NT_STATUS_INTERNAL_ERROR
;
503 return NT_STATUS_INVALID_PARAMETER
;
507 if (!(fsp
->access_mask
& SEC_DIR_LIST
)) {
508 DEBUG(5,("dptr_create: directory %s "
509 "not open for LIST access\n",
511 return NT_STATUS_ACCESS_DENIED
;
513 dir_hnd
= OpenDir_fsp(NULL
, conn
, fsp
, wcard
, attr
);
516 bool backup_intent
= (req
&& req
->priv_paths
);
517 struct smb_filename
*smb_dname
;
520 smb_dname
= synthetic_smb_fname(talloc_tos(), path
,
522 if (smb_dname
== NULL
) {
523 return NT_STATUS_NO_MEMORY
;
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 * The destructor for the struct smb_Dir
684 * (fsp->dptr->dir_hnd) now handles
685 * all resource deallocation.
687 dptr_close_internal(fsp
->dptr
);
691 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
693 SeekDir(dptr
->dir_hnd
, offset
);
696 long dptr_TellDir(struct dptr_struct
*dptr
)
698 return TellDir(dptr
->dir_hnd
);
701 bool dptr_has_wild(struct dptr_struct
*dptr
)
703 return dptr
->has_wild
;
706 int dptr_dnum(struct dptr_struct
*dptr
)
711 bool dptr_get_priv(struct dptr_struct
*dptr
)
716 void dptr_set_priv(struct dptr_struct
*dptr
)
721 /****************************************************************************
722 Return the next visible file name, skipping veto'd and invisible files.
723 ****************************************************************************/
725 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
,
726 long *poffset
, SMB_STRUCT_STAT
*pst
,
729 /* Normal search for the next file. */
731 char *talloced
= NULL
;
733 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
, pst
, &talloced
))
735 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
736 *ptalloced
= talloced
;
739 TALLOC_FREE(talloced
);
744 /****************************************************************************
745 Return the next visible file name, skipping veto'd and invisible files.
746 ****************************************************************************/
748 char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
749 struct dptr_struct
*dptr
,
751 SMB_STRUCT_STAT
*pst
)
753 struct smb_filename smb_fname_base
;
755 const char *name_temp
= NULL
;
756 char *talloced
= NULL
;
757 char *pathreal
= NULL
;
758 char *found_name
= NULL
;
761 SET_STAT_INVALID(*pst
);
763 if (dptr
->has_wild
|| dptr
->did_stat
) {
764 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
,
766 if (name_temp
== NULL
) {
769 if (talloced
!= NULL
) {
770 return talloc_move(ctx
, &talloced
);
772 return talloc_strdup(ctx
, name_temp
);
775 /* If poffset is -1 then we know we returned this name before and we
776 * have no wildcards. We're at the end of the directory. */
777 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
781 /* We know the stored wcard contains no wildcard characters.
782 * See if we can match with a stat call. If we can't, then set
783 * did_stat to true to ensure we only do this once and keep
786 dptr
->did_stat
= true;
788 /* First check if it should be visible. */
789 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
,
792 /* This only returns false if the file was found, but
793 is explicitly not visible. Set us to end of
794 directory, but return NULL as we know we can't ever
799 if (VALID_STAT(*pst
)) {
800 name
= talloc_strdup(ctx
, dptr
->wcard
);
804 pathreal
= talloc_asprintf(ctx
,
811 /* Create an smb_filename with stream_name == NULL. */
812 ZERO_STRUCT(smb_fname_base
);
813 smb_fname_base
.base_name
= pathreal
;
815 if (SMB_VFS_STAT(dptr
->conn
, &smb_fname_base
) == 0) {
816 *pst
= smb_fname_base
.st
;
817 name
= talloc_strdup(ctx
, dptr
->wcard
);
820 /* If we get any other error than ENOENT or ENOTDIR
821 then the file exists we just can't stat it. */
822 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
823 name
= talloc_strdup(ctx
, dptr
->wcard
);
828 /* Stat failed. We know this is authoratiative if we are
829 * providing case sensitive semantics or the underlying
830 * filesystem is case sensitive.
832 if (dptr
->conn
->case_sensitive
||
833 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
))
839 * Try case-insensitive stat if the fs has the ability. This avoids
840 * scanning the whole directory.
842 ret
= SMB_VFS_GET_REAL_FILENAME(dptr
->conn
, dptr
->path
, dptr
->wcard
,
847 } else if (errno
== ENOENT
) {
848 /* The case-insensitive lookup was authoritative. */
852 TALLOC_FREE(pathreal
);
854 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
, &talloced
);
855 if (name_temp
== NULL
) {
858 if (talloced
!= NULL
) {
859 return talloc_move(ctx
, &talloced
);
861 return talloc_strdup(ctx
, name_temp
);
864 TALLOC_FREE(pathreal
);
866 /* We need to set the underlying dir_hnd offset to -1
867 * also as this function is usually called with the
868 * output from TellDir. */
869 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
873 /****************************************************************************
874 Search for a file by name, skipping veto'ed and not visible files.
875 ****************************************************************************/
877 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
879 SET_STAT_INVALID(*pst
);
881 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
882 /* This is a singleton directory and we're already at the end. */
883 *poffset
= END_OF_DIRECTORY_OFFSET
;
887 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
890 /****************************************************************************
891 Initialize variables & state data at the beginning of all search SMB requests.
892 ****************************************************************************/
893 void dptr_init_search_op(struct dptr_struct
*dptr
)
895 SMB_VFS_INIT_SEARCH_OP(dptr
->conn
, dptr
->dir_hnd
->dir
);
898 /****************************************************************************
899 Fill the 5 byte server reserved dptr field.
900 ****************************************************************************/
902 bool dptr_fill(struct smbd_server_connection
*sconn
,
903 char *buf1
,unsigned int key
)
905 unsigned char *buf
= (unsigned char *)buf1
;
906 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
909 DEBUG(1,("filling null dirptr %d\n",key
));
912 offset
= (uint32
)TellDir(dptr
->dir_hnd
);
913 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
914 (long)dptr
->dir_hnd
,(int)offset
));
920 /****************************************************************************
921 Fetch the dir ptr and seek it given the 5 byte server field.
922 ****************************************************************************/
924 struct dptr_struct
*dptr_fetch(struct smbd_server_connection
*sconn
,
927 unsigned int key
= *(unsigned char *)buf
;
928 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
933 DEBUG(3,("fetched null dirptr %d\n",key
));
937 offset
= IVAL(buf
,1);
938 if (offset
== (uint32
)-1) {
939 seekoff
= END_OF_DIRECTORY_OFFSET
;
941 seekoff
= (long)offset
;
943 SeekDir(dptr
->dir_hnd
,seekoff
);
944 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
945 key
, dptr
->path
, (int)seekoff
));
949 /****************************************************************************
951 ****************************************************************************/
953 struct dptr_struct
*dptr_fetch_lanman2(struct smbd_server_connection
*sconn
,
956 struct dptr_struct
*dptr
= dptr_get(sconn
, dptr_num
, false);
959 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
962 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr
->path
));
966 /****************************************************************************
967 Check that a file matches a particular file type.
968 ****************************************************************************/
970 bool dir_check_ftype(connection_struct
*conn
, uint32 mode
, uint32 dirtype
)
974 /* Check the "may have" search bits. */
975 if (((mode
& ~dirtype
) & (FILE_ATTRIBUTE_HIDDEN
| FILE_ATTRIBUTE_SYSTEM
| FILE_ATTRIBUTE_DIRECTORY
)) != 0)
978 /* Check the "must have" bits, which are the may have bits shifted eight */
979 /* If must have bit is set, the file/dir can not be returned in search unless the matching
980 file attribute is set */
981 mask
= ((dirtype
>> 8) & (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
)); /* & 0x37 */
983 if((mask
& (mode
& (FILE_ATTRIBUTE_DIRECTORY
|FILE_ATTRIBUTE_ARCHIVE
|FILE_ATTRIBUTE_READONLY
|FILE_ATTRIBUTE_HIDDEN
|FILE_ATTRIBUTE_SYSTEM
))) == mask
) /* check if matching attribute present */
992 static bool mangle_mask_match(connection_struct
*conn
,
993 const char *filename
,
998 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
1001 return mask_match_search(mname
,mask
,False
);
1004 bool smbd_dirptr_get_entry(TALLOC_CTX
*ctx
,
1005 struct dptr_struct
*dirptr
,
1010 bool (*match_fn
)(TALLOC_CTX
*ctx
,
1015 bool (*mode_fn
)(TALLOC_CTX
*ctx
,
1017 struct smb_filename
*smb_fname
,
1021 struct smb_filename
**_smb_fname
,
1025 connection_struct
*conn
= dirptr
->conn
;
1032 pathlen
= strlen(dirptr
->path
);
1033 slashlen
= ( dirptr
->path
[pathlen
-1] != '/') ? 1 : 0;
1038 SMB_STRUCT_STAT sbuf
;
1042 char *pathreal
= NULL
;
1043 struct smb_filename smb_fname
;
1047 cur_offset
= dptr_TellDir(dirptr
);
1048 prev_offset
= cur_offset
;
1049 dname
= dptr_ReadDirName(ctx
, dirptr
, &cur_offset
, &sbuf
);
1051 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
1052 (long)dirptr
, cur_offset
));
1054 if (dname
== NULL
) {
1058 isdots
= (ISDOT(dname
) || ISDOTDOT(dname
));
1059 if (dont_descend
&& !isdots
) {
1065 * fname may get mangled, dname is never mangled.
1066 * Whenever we're accessing the filesystem we use
1067 * pathreal which is composed from dname.
1070 ok
= match_fn(ctx
, private_data
, dname
, mask
, &fname
);
1078 * pathreal = talloc_asprintf(ctx, "%s%s%s", dirptr->path,
1079 * needslash?"/":"", dname);
1080 * but this was measurably slower than doing the memcpy.
1083 pathreal
= talloc_array(
1085 pathlen
+ slashlen
+ talloc_get_size(dname
));
1092 memcpy(pathreal
, dirptr
->path
, pathlen
);
1093 pathreal
[pathlen
] = '/';
1094 memcpy(pathreal
+ slashlen
+ pathlen
, dname
,
1095 talloc_get_size(dname
));
1097 /* Create smb_fname with NULL stream_name. */
1098 ZERO_STRUCT(smb_fname
);
1099 smb_fname
.base_name
= pathreal
;
1100 smb_fname
.st
= sbuf
;
1102 ok
= mode_fn(ctx
, private_data
, &smb_fname
, &mode
);
1106 TALLOC_FREE(pathreal
);
1110 if (!dir_check_ftype(conn
, mode
, dirtype
)) {
1111 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1112 fname
, (unsigned int)mode
, (unsigned int)dirtype
));
1115 TALLOC_FREE(pathreal
);
1119 if (ask_sharemode
) {
1120 struct timespec write_time_ts
;
1121 struct file_id fileid
;
1123 fileid
= vfs_file_id_from_sbuf(conn
,
1125 get_file_infos(fileid
, 0, NULL
, &write_time_ts
);
1126 if (!null_timespec(write_time_ts
)) {
1127 update_stat_ex_mtime(&smb_fname
.st
,
1132 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1134 mask
, smb_fname_str_dbg(&smb_fname
),
1137 DirCacheAdd(dirptr
->dir_hnd
, dname
, cur_offset
);
1141 *_smb_fname
= cp_smb_filename(ctx
, &smb_fname
);
1142 TALLOC_FREE(pathreal
);
1143 if (*_smb_fname
== NULL
) {
1148 *_prev_offset
= prev_offset
;
1156 /****************************************************************************
1157 Get an 8.3 directory entry.
1158 ****************************************************************************/
1160 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX
*ctx
,
1166 connection_struct
*conn
= (connection_struct
*)private_data
;
1168 if ((strcmp(mask
,"*.*") == 0) ||
1169 mask_match_search(dname
, mask
, false) ||
1170 mangle_mask_match(conn
, dname
, mask
)) {
1174 if (!mangle_is_8_3(dname
, false, conn
->params
)) {
1175 bool ok
= name_to_8_3(dname
, mname
, false,
1185 *_fname
= talloc_strdup(ctx
, fname
);
1186 if (*_fname
== NULL
) {
1196 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX
*ctx
,
1198 struct smb_filename
*smb_fname
,
1201 connection_struct
*conn
= (connection_struct
*)private_data
;
1203 if (!VALID_STAT(smb_fname
->st
)) {
1204 if ((SMB_VFS_STAT(conn
, smb_fname
)) != 0) {
1205 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1206 "Couldn't stat [%s]. Error "
1208 smb_fname_str_dbg(smb_fname
),
1214 *_mode
= dos_mode(conn
, smb_fname
);
1218 bool get_dir_entry(TALLOC_CTX
*ctx
,
1219 struct dptr_struct
*dirptr
,
1225 struct timespec
*_date
,
1229 connection_struct
*conn
= dirptr
->conn
;
1231 struct smb_filename
*smb_fname
= NULL
;
1236 ok
= smbd_dirptr_get_entry(ctx
,
1242 smbd_dirptr_8_3_match_fn
,
1243 smbd_dirptr_8_3_mode_fn
,
1253 *_fname
= talloc_move(ctx
, &fname
);
1254 *_size
= smb_fname
->st
.st_ex_size
;
1256 *_date
= smb_fname
->st
.st_ex_mtime
;
1257 TALLOC_FREE(smb_fname
);
1261 /*******************************************************************
1262 Check to see if a user can read a file. This is only approximate,
1263 it is used as part of the "hide unreadable" option. Don't
1264 use it for anything security sensitive.
1265 ********************************************************************/
1267 static bool user_can_read_file(connection_struct
*conn
,
1268 struct smb_filename
*smb_fname
)
1271 * Never hide files from the root user.
1272 * We use (uid_t)0 here not sec_initial_uid()
1273 * as make test uses a single user context.
1276 if (get_current_uid(conn
) == (uid_t
)0) {
1280 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
;
1359 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1360 return True
; /* . and .. are always visible. */
1363 /* If it's a vetoed file, pretend it doesn't even exist */
1364 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1365 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1369 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1370 entry
= talloc_asprintf(talloc_tos(), "%s/%s", dir_path
, name
);
1376 /* Create an smb_filename with stream_name == NULL. */
1377 smb_fname_base
= synthetic_smb_fname(talloc_tos(), entry
, NULL
,
1379 if (smb_fname_base
== NULL
) {
1384 /* If the file name does not exist, there's no point checking
1385 * the configuration options. We succeed, on the basis that the
1386 * checks *might* have passed if the file was present.
1388 if (!VALID_STAT(*pst
)) {
1389 if (SMB_VFS_STAT(conn
, smb_fname_base
) != 0) {
1393 *pst
= smb_fname_base
->st
;
1397 /* Honour _hide unreadable_ option */
1398 if (hide_unreadable
&&
1399 !user_can_read_file(conn
, smb_fname_base
)) {
1400 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1405 /* Honour _hide unwriteable_ option */
1406 if (hide_unwriteable
&& !user_can_write_file(conn
,
1408 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1413 /* Honour _hide_special_ option */
1414 if (hide_special
&& file_is_special(conn
, smb_fname_base
)) {
1415 DEBUG(10,("is_visible_file: file %s is special.\n",
1424 TALLOC_FREE(smb_fname_base
);
1429 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1431 if (dirp
->dir
!= NULL
) {
1432 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1433 if (dirp
->fsp
!= NULL
) {
1435 * The SMB_VFS_CLOSEDIR above
1436 * closes the underlying fd inside
1439 dirp
->fsp
->fh
->fd
= -1;
1440 if (dirp
->fsp
->dptr
!= NULL
) {
1441 SMB_ASSERT(dirp
->fsp
->dptr
->dir_hnd
== dirp
);
1442 dirp
->fsp
->dptr
->dir_hnd
= NULL
;
1447 if (dirp
->conn
->sconn
&& !dirp
->conn
->sconn
->using_smb2
) {
1448 dirp
->conn
->sconn
->searches
.dirhandles_open
--;
1453 /*******************************************************************
1455 ********************************************************************/
1457 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1462 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1463 struct smbd_server_connection
*sconn
= conn
->sconn
;
1470 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1472 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1473 if (!dirp
->dir_path
) {
1478 if (sconn
&& !sconn
->using_smb2
) {
1479 sconn
->searches
.dirhandles_open
++;
1481 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1483 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1485 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1497 /*******************************************************************
1498 Open a directory from an fsp.
1499 ********************************************************************/
1501 static struct smb_Dir
*OpenDir_fsp(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1506 struct smb_Dir
*dirp
= talloc_zero(mem_ctx
, struct smb_Dir
);
1507 struct smbd_server_connection
*sconn
= conn
->sconn
;
1514 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1516 dirp
->dir_path
= talloc_strdup(dirp
, fsp
->fsp_name
->base_name
);
1517 if (!dirp
->dir_path
) {
1522 if (sconn
&& !sconn
->using_smb2
) {
1523 sconn
->searches
.dirhandles_open
++;
1525 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1527 if (fsp
->is_directory
&& fsp
->fh
->fd
!= -1) {
1528 dirp
->dir
= SMB_VFS_FDOPENDIR(fsp
, mask
, attr
);
1529 if (dirp
->dir
!= NULL
) {
1532 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1536 if (errno
!= ENOSYS
) {
1542 if (dirp
->dir
== NULL
) {
1543 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1544 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1548 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp
->dir_path
,
1561 /*******************************************************************
1562 Read from a directory.
1563 Return directory entry, current offset, and optional stat information.
1564 Don't check for veto or invisible files.
1565 ********************************************************************/
1567 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
,
1568 SMB_STRUCT_STAT
*sbuf
, char **ptalloced
)
1571 char *talloced
= NULL
;
1572 connection_struct
*conn
= dirp
->conn
;
1574 /* Cheat to allow . and .. to be the first entries returned. */
1575 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) ||
1576 (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2))
1578 if (dirp
->file_number
== 0) {
1580 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1583 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1585 dirp
->file_number
++;
1588 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1589 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1592 /* A real offset, seek to it. */
1593 SeekDir(dirp
, *poffset
);
1596 while ((n
= vfs_readdirname(conn
, dirp
->dir
, sbuf
, &talloced
))) {
1597 /* Ignore . and .. - we've already returned them. */
1599 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1600 TALLOC_FREE(talloced
);
1604 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1605 *ptalloced
= talloced
;
1606 dirp
->file_number
++;
1609 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1614 /*******************************************************************
1615 Rewind to the start.
1616 ********************************************************************/
1618 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1620 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1621 dirp
->file_number
= 0;
1622 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1623 *poffset
= START_OF_DIRECTORY_OFFSET
;
1626 /*******************************************************************
1628 ********************************************************************/
1630 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1632 if (offset
!= dirp
->offset
) {
1633 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1634 RewindDir(dirp
, &offset
);
1636 * Ok we should really set the file number here
1637 * to 1 to enable ".." to be returned next. Trouble
1638 * is I'm worried about callers using SeekDir(dirp,0)
1639 * as equivalent to RewindDir(). So leave this alone
1642 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1643 RewindDir(dirp
, &offset
);
1645 * Set the file number to 2 - we want to get the first
1646 * real file entry (the one we return after "..")
1647 * on the next ReadDir.
1649 dirp
->file_number
= 2;
1650 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1651 ; /* Don't seek in this case. */
1653 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1655 dirp
->offset
= offset
;
1659 /*******************************************************************
1660 Tell a dir position.
1661 ********************************************************************/
1663 long TellDir(struct smb_Dir
*dirp
)
1665 return(dirp
->offset
);
1668 /*******************************************************************
1669 Add an entry into the dcache.
1670 ********************************************************************/
1672 static void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1674 struct name_cache_entry
*e
;
1676 if (dirp
->name_cache_size
== 0) {
1680 if (dirp
->name_cache
== NULL
) {
1681 dirp
->name_cache
= talloc_zero_array(
1682 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1684 if (dirp
->name_cache
== NULL
) {
1689 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1690 dirp
->name_cache_size
;
1691 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1692 TALLOC_FREE(e
->name
);
1693 e
->name
= talloc_strdup(dirp
, name
);
1697 /*******************************************************************
1698 Find an entry by name. Leave us at the offset after it.
1699 Don't check for veto or invisible files.
1700 ********************************************************************/
1702 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1705 const char *entry
= NULL
;
1706 char *talloced
= NULL
;
1707 connection_struct
*conn
= dirp
->conn
;
1709 /* Search back in the name cache. */
1710 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1711 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1712 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1713 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1714 *poffset
= e
->offset
;
1715 SeekDir(dirp
, e
->offset
);
1719 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1720 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1721 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1722 *poffset
= e
->offset
;
1723 SeekDir(dirp
, e
->offset
);
1729 /* Not found in the name cache. Rewind directory and start from scratch. */
1730 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1731 dirp
->file_number
= 0;
1732 *poffset
= START_OF_DIRECTORY_OFFSET
;
1733 while ((entry
= ReadDirName(dirp
, poffset
, NULL
, &talloced
))) {
1734 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1735 TALLOC_FREE(talloced
);
1738 TALLOC_FREE(talloced
);
1743 /*****************************************************************
1744 Is this directory empty ?
1745 *****************************************************************/
1747 NTSTATUS
can_delete_directory_fsp(files_struct
*fsp
)
1749 NTSTATUS status
= NT_STATUS_OK
;
1751 const char *dname
= NULL
;
1752 const char *dirname
= fsp
->fsp_name
->base_name
;
1753 char *talloced
= NULL
;
1755 struct connection_struct
*conn
= fsp
->conn
;
1756 struct smb_Dir
*dir_hnd
= OpenDir_fsp(talloc_tos(),
1763 return map_nt_error_from_unix(errno
);
1766 while ((dname
= ReadDirName(dir_hnd
, &dirpos
, &st
, &talloced
))) {
1767 /* Quick check for "." and ".." */
1768 if (dname
[0] == '.') {
1769 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1770 TALLOC_FREE(talloced
);
1775 if (!is_visible_file(conn
, dirname
, dname
, &st
, True
)) {
1776 TALLOC_FREE(talloced
);
1780 DEBUG(10,("got name %s - can't delete\n",
1782 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1785 TALLOC_FREE(talloced
);
1786 TALLOC_FREE(dir_hnd
);