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 "smbd/globals.h"
23 #include "libcli/security/security.h"
26 This module implements directory related functions for Samba.
29 /* "Special" directory offsets. */
30 #define END_OF_DIRECTORY_OFFSET ((long)-1)
31 #define START_OF_DIRECTORY_OFFSET ((long)0)
32 #define DOT_DOT_DIRECTORY_OFFSET ((long)0x80000000)
34 /* Make directory handle internals available. */
36 struct name_cache_entry
{
42 connection_struct
*conn
;
46 size_t name_cache_size
;
47 struct name_cache_entry
*name_cache
;
48 unsigned int name_cache_index
;
49 unsigned int file_number
;
53 struct dptr_struct
*next
, *prev
;
56 struct connection_struct
*conn
;
57 struct smb_Dir
*dir_hnd
;
62 bool has_wild
; /* Set to true if the wcard entry has MS wildcard characters in it. */
63 bool did_stat
; /* Optimisation for non-wcard searches. */
67 #define INVALID_DPTR_KEY (-3)
69 /****************************************************************************
71 ****************************************************************************/
73 bool make_dir_struct(TALLOC_CTX
*ctx
,
83 char *mask2
= talloc_strdup(ctx
, mask
);
89 if ((mode
& aDIR
) != 0) {
94 if ((p
= strchr_m(mask2
,'.')) != NULL
) {
96 push_ascii(buf
+1,mask2
,8, 0);
97 push_ascii(buf
+9,p
+1,3, 0);
100 push_ascii(buf
+1,mask2
,11, 0);
103 memset(buf
+21,'\0',DIR_STRUCT_SIZE
-21);
105 srv_put_dos_date(buf
,22,date
);
106 SSVAL(buf
,26,size
& 0xFFFF);
107 SSVAL(buf
,28,(size
>> 16)&0xFFFF);
108 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
109 Strange, but verified on W2K3. Needed for OS/2. JRA. */
110 push_ascii(buf
+30,fname
,12, uc
? STR_UPPER
: 0);
111 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf
+30, fname
));
115 /****************************************************************************
116 Initialise the dir bitmap.
117 ****************************************************************************/
119 bool init_dptrs(struct smbd_server_connection
*sconn
)
121 if (sconn
->smb1
.searches
.dptr_bmap
) {
125 sconn
->smb1
.searches
.dptr_bmap
= bitmap_talloc(
126 sconn
, MAX_DIRECTORY_HANDLES
);
128 if (sconn
->smb1
.searches
.dptr_bmap
== NULL
) {
135 /****************************************************************************
136 Idle a dptr - the directory is closed but the control info is kept.
137 ****************************************************************************/
139 static void dptr_idle(struct dptr_struct
*dptr
)
142 DEBUG(4,("Idling dptr dnum %d\n",dptr
->dnum
));
143 TALLOC_FREE(dptr
->dir_hnd
);
147 /****************************************************************************
148 Idle the oldest dptr.
149 ****************************************************************************/
151 static void dptr_idleoldest(struct smbd_server_connection
*sconn
)
153 struct dptr_struct
*dptr
;
156 * Go to the end of the list.
158 dptr
= DLIST_TAIL(sconn
->smb1
.searches
.dirptrs
);
161 DEBUG(0,("No dptrs available to idle ?\n"));
166 * Idle the oldest pointer.
169 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
177 /****************************************************************************
178 Get the struct dptr_struct for a dir index.
179 ****************************************************************************/
181 static struct dptr_struct
*dptr_get(struct smbd_server_connection
*sconn
,
182 int key
, bool forclose
)
184 struct dptr_struct
*dptr
;
186 for(dptr
= sconn
->smb1
.searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
187 if(dptr
->dnum
== key
) {
188 if (!forclose
&& !dptr
->dir_hnd
) {
189 if (sconn
->smb1
.searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
)
190 dptr_idleoldest(sconn
);
191 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key
));
192 if (!(dptr
->dir_hnd
= OpenDir(
193 NULL
, dptr
->conn
, dptr
->path
,
194 dptr
->wcard
, dptr
->attr
))) {
195 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr
->path
,
200 DLIST_PROMOTE(sconn
->smb1
.searches
.dirptrs
,dptr
);
207 /****************************************************************************
208 Get the dir path for a dir index.
209 ****************************************************************************/
211 char *dptr_path(struct smbd_server_connection
*sconn
, int key
)
213 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
219 /****************************************************************************
220 Get the dir wcard for a dir index.
221 ****************************************************************************/
223 char *dptr_wcard(struct smbd_server_connection
*sconn
, int key
)
225 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
231 /****************************************************************************
232 Get the dir attrib for a dir index.
233 ****************************************************************************/
235 uint16
dptr_attr(struct smbd_server_connection
*sconn
, int key
)
237 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
243 /****************************************************************************
244 Close a dptr (internal func).
245 ****************************************************************************/
247 static void dptr_close_internal(struct dptr_struct
*dptr
)
249 struct smbd_server_connection
*sconn
= dptr
->conn
->sconn
;
251 DEBUG(4,("closing dptr key %d\n",dptr
->dnum
));
257 DLIST_REMOVE(sconn
->smb1
.searches
.dirptrs
, dptr
);
260 * Free the dnum in the bitmap. Remember the dnum value is always
261 * biased by one with respect to the bitmap.
264 if (!bitmap_query(sconn
->smb1
.searches
.dptr_bmap
, dptr
->dnum
- 1)) {
265 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
269 bitmap_clear(sconn
->smb1
.searches
.dptr_bmap
, dptr
->dnum
- 1);
272 TALLOC_FREE(dptr
->dir_hnd
);
274 /* Lanman 2 specific code */
275 SAFE_FREE(dptr
->wcard
);
276 string_set(&dptr
->path
,"");
280 /****************************************************************************
281 Close a dptr given a key.
282 ****************************************************************************/
284 void dptr_close(struct smbd_server_connection
*sconn
, int *key
)
286 struct dptr_struct
*dptr
;
288 if(*key
== INVALID_DPTR_KEY
)
291 /* OS/2 seems to use -1 to indicate "close all directories" */
293 struct dptr_struct
*next
;
294 for(dptr
= sconn
->smb1
.searches
.dirptrs
; dptr
; dptr
= next
) {
296 dptr_close_internal(dptr
);
298 *key
= INVALID_DPTR_KEY
;
302 dptr
= dptr_get(sconn
, *key
, true);
305 DEBUG(0,("Invalid key %d given to dptr_close\n", *key
));
309 dptr_close_internal(dptr
);
311 *key
= INVALID_DPTR_KEY
;
314 /****************************************************************************
315 Close all dptrs for a cnum.
316 ****************************************************************************/
318 void dptr_closecnum(connection_struct
*conn
)
320 struct dptr_struct
*dptr
, *next
;
321 struct smbd_server_connection
*sconn
= conn
->sconn
;
327 for(dptr
= sconn
->smb1
.searches
.dirptrs
; dptr
; dptr
= next
) {
329 if (dptr
->conn
== conn
) {
330 dptr_close_internal(dptr
);
335 /****************************************************************************
336 Idle all dptrs for a cnum.
337 ****************************************************************************/
339 void dptr_idlecnum(connection_struct
*conn
)
341 struct dptr_struct
*dptr
;
342 struct smbd_server_connection
*sconn
= conn
->sconn
;
348 for(dptr
= sconn
->smb1
.searches
.dirptrs
; dptr
; dptr
= dptr
->next
) {
349 if (dptr
->conn
== conn
&& dptr
->dir_hnd
) {
355 /****************************************************************************
356 Close a dptr that matches a given path, only if it matches the spid also.
357 ****************************************************************************/
359 void dptr_closepath(struct smbd_server_connection
*sconn
,
360 char *path
,uint16 spid
)
362 struct dptr_struct
*dptr
, *next
;
363 for(dptr
= sconn
->smb1
.searches
.dirptrs
; dptr
; dptr
= next
) {
365 if (spid
== dptr
->spid
&& strequal(dptr
->path
,path
))
366 dptr_close_internal(dptr
);
370 /****************************************************************************
371 Try and close the oldest handle not marked for
372 expect close in the hope that the client has
373 finished with that one.
374 ****************************************************************************/
376 static void dptr_close_oldest(struct smbd_server_connection
*sconn
,
379 struct dptr_struct
*dptr
;
382 * Go to the end of the list.
384 for(dptr
= sconn
->smb1
.searches
.dirptrs
; dptr
&& dptr
->next
; dptr
= dptr
->next
)
388 DEBUG(0,("No old dptrs available to close oldest ?\n"));
393 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
394 * does not have expect_close set. If 'old' is false, close
395 * one of the new dnum handles.
398 for(; dptr
; dptr
= DLIST_PREV(dptr
)) {
399 if ((old
&& (dptr
->dnum
< 256) && !dptr
->expect_close
) ||
400 (!old
&& (dptr
->dnum
> 255))) {
401 dptr_close_internal(dptr
);
407 /****************************************************************************
408 Create a new dir ptr. If the flag old_handle is true then we must allocate
409 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
410 one byte long. If old_handle is false we allocate from the range
411 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
412 a directory handle is never zero.
413 wcard must not be zero.
414 ****************************************************************************/
416 NTSTATUS
dptr_create(connection_struct
*conn
, const char *path
, bool old_handle
, bool expect_close
,uint16 spid
,
417 const char *wcard
, bool wcard_has_wild
, uint32 attr
, struct dptr_struct
**dptr_ret
)
419 struct smbd_server_connection
*sconn
= conn
->sconn
;
420 struct dptr_struct
*dptr
= NULL
;
421 struct smb_Dir
*dir_hnd
;
424 DEBUG(5,("dptr_create dir=%s\n", path
));
427 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
428 return NT_STATUS_INTERNAL_ERROR
;
432 return NT_STATUS_INVALID_PARAMETER
;
435 status
= check_name(conn
,path
);
436 if (!NT_STATUS_IS_OK(status
)) {
440 dir_hnd
= OpenDir(NULL
, conn
, path
, wcard
, attr
);
442 return map_nt_error_from_unix(errno
);
445 if (sconn
->smb1
.searches
.dirhandles_open
>= MAX_OPEN_DIRECTORIES
) {
446 dptr_idleoldest(sconn
);
449 dptr
= SMB_MALLOC_P(struct dptr_struct
);
451 DEBUG(0,("malloc fail in dptr_create.\n"));
452 TALLOC_FREE(dir_hnd
);
453 return NT_STATUS_NO_MEMORY
;
461 * This is an old-style SMBsearch request. Ensure the
462 * value we return will fit in the range 1-255.
465 dptr
->dnum
= bitmap_find(sconn
->smb1
.searches
.dptr_bmap
, 0);
467 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
470 * Try and close the oldest handle not marked for
471 * expect close in the hope that the client has
472 * finished with that one.
475 dptr_close_oldest(sconn
, true);
477 /* Now try again... */
478 dptr
->dnum
= bitmap_find(sconn
->smb1
.searches
.dptr_bmap
, 0);
479 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
480 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr
->dnum
));
482 TALLOC_FREE(dir_hnd
);
483 return NT_STATUS_TOO_MANY_OPENED_FILES
;
489 * This is a new-style trans2 request. Allocate from
490 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
493 dptr
->dnum
= bitmap_find(sconn
->smb1
.searches
.dptr_bmap
, 255);
495 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
498 * Try and close the oldest handle close in the hope that
499 * the client has finished with that one. This will only
500 * happen in the case of the Win98 client bug where it leaks
504 dptr_close_oldest(sconn
, false);
506 /* Now try again... */
507 dptr
->dnum
= bitmap_find(sconn
->smb1
.searches
.dptr_bmap
, 255);
509 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
510 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr
->dnum
));
512 TALLOC_FREE(dir_hnd
);
513 return NT_STATUS_TOO_MANY_OPENED_FILES
;
518 bitmap_set(sconn
->smb1
.searches
.dptr_bmap
, dptr
->dnum
);
520 dptr
->dnum
+= 1; /* Always bias the dnum by one - no zero dnums allowed. */
522 string_set(&dptr
->path
,path
);
524 dptr
->dir_hnd
= dir_hnd
;
526 dptr
->expect_close
= expect_close
;
527 dptr
->wcard
= SMB_STRDUP(wcard
);
529 bitmap_clear(sconn
->smb1
.searches
.dptr_bmap
, dptr
->dnum
- 1);
531 TALLOC_FREE(dir_hnd
);
532 return NT_STATUS_NO_MEMORY
;
534 if (lp_posix_pathnames() || (wcard
[0] == '.' && wcard
[1] == 0)) {
535 dptr
->has_wild
= True
;
537 dptr
->has_wild
= wcard_has_wild
;
542 DLIST_ADD(sconn
->smb1
.searches
.dirptrs
, dptr
);
544 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
545 dptr
->dnum
,path
,expect_close
));
553 /****************************************************************************
554 Wrapper functions to access the lower level directory handles.
555 ****************************************************************************/
557 int dptr_CloseDir(struct dptr_struct
*dptr
)
559 dptr_close_internal(dptr
);
563 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
565 SeekDir(dptr
->dir_hnd
, offset
);
568 long dptr_TellDir(struct dptr_struct
*dptr
)
570 return TellDir(dptr
->dir_hnd
);
573 bool dptr_has_wild(struct dptr_struct
*dptr
)
575 return dptr
->has_wild
;
578 int dptr_dnum(struct dptr_struct
*dptr
)
583 /****************************************************************************
584 Return the next visible file name, skipping veto'd and invisible files.
585 ****************************************************************************/
587 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
,
588 long *poffset
, SMB_STRUCT_STAT
*pst
,
591 /* Normal search for the next file. */
593 char *talloced
= NULL
;
595 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
, pst
, &talloced
))
597 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
598 *ptalloced
= talloced
;
601 TALLOC_FREE(talloced
);
606 /****************************************************************************
607 Return the next visible file name, skipping veto'd and invisible files.
608 ****************************************************************************/
610 char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
611 struct dptr_struct
*dptr
,
613 SMB_STRUCT_STAT
*pst
)
615 struct smb_filename smb_fname_base
;
617 const char *name_temp
= NULL
;
618 char *talloced
= NULL
;
619 char *pathreal
= NULL
;
620 char *found_name
= NULL
;
623 SET_STAT_INVALID(*pst
);
625 if (dptr
->has_wild
|| dptr
->did_stat
) {
626 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
,
628 if (name_temp
== NULL
) {
631 if (talloced
!= NULL
) {
632 return talloc_move(ctx
, &talloced
);
634 return talloc_strdup(ctx
, name_temp
);
637 /* If poffset is -1 then we know we returned this name before and we
638 * have no wildcards. We're at the end of the directory. */
639 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
643 /* We know the stored wcard contains no wildcard characters.
644 * See if we can match with a stat call. If we can't, then set
645 * did_stat to true to ensure we only do this once and keep
648 dptr
->did_stat
= true;
650 /* First check if it should be visible. */
651 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
,
654 /* This only returns false if the file was found, but
655 is explicitly not visible. Set us to end of
656 directory, but return NULL as we know we can't ever
661 if (VALID_STAT(*pst
)) {
662 name
= talloc_strdup(ctx
, dptr
->wcard
);
666 pathreal
= talloc_asprintf(ctx
,
673 /* Create an smb_filename with stream_name == NULL. */
674 ZERO_STRUCT(smb_fname_base
);
675 smb_fname_base
.base_name
= pathreal
;
677 if (SMB_VFS_STAT(dptr
->conn
, &smb_fname_base
) == 0) {
678 *pst
= smb_fname_base
.st
;
679 name
= talloc_strdup(ctx
, dptr
->wcard
);
682 /* If we get any other error than ENOENT or ENOTDIR
683 then the file exists we just can't stat it. */
684 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
685 name
= talloc_strdup(ctx
, dptr
->wcard
);
690 /* Stat failed. We know this is authoratiative if we are
691 * providing case sensitive semantics or the underlying
692 * filesystem is case sensitive.
694 if (dptr
->conn
->case_sensitive
||
695 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
))
701 * Try case-insensitive stat if the fs has the ability. This avoids
702 * scanning the whole directory.
704 ret
= SMB_VFS_GET_REAL_FILENAME(dptr
->conn
, dptr
->path
, dptr
->wcard
,
709 } else if (errno
== ENOENT
) {
710 /* The case-insensitive lookup was authoritative. */
714 TALLOC_FREE(pathreal
);
716 name_temp
= dptr_normal_ReadDirName(dptr
, poffset
, pst
, &talloced
);
717 if (name_temp
== NULL
) {
720 if (talloced
!= NULL
) {
721 return talloc_move(ctx
, &talloced
);
723 return talloc_strdup(ctx
, name_temp
);
726 TALLOC_FREE(pathreal
);
728 /* We need to set the underlying dir_hnd offset to -1
729 * also as this function is usually called with the
730 * output from TellDir. */
731 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
735 /****************************************************************************
736 Search for a file by name, skipping veto'ed and not visible files.
737 ****************************************************************************/
739 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
741 SET_STAT_INVALID(*pst
);
743 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
744 /* This is a singleton directory and we're already at the end. */
745 *poffset
= END_OF_DIRECTORY_OFFSET
;
749 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
752 /****************************************************************************
753 Add the name we're returning into the underlying cache.
754 ****************************************************************************/
756 void dptr_DirCacheAdd(struct dptr_struct
*dptr
, const char *name
, long offset
)
758 DirCacheAdd(dptr
->dir_hnd
, name
, offset
);
761 /****************************************************************************
762 Initialize variables & state data at the beginning of all search SMB requests.
763 ****************************************************************************/
764 void dptr_init_search_op(struct dptr_struct
*dptr
)
766 SMB_VFS_INIT_SEARCH_OP(dptr
->conn
, dptr
->dir_hnd
->dir
);
769 /****************************************************************************
770 Fill the 5 byte server reserved dptr field.
771 ****************************************************************************/
773 bool dptr_fill(struct smbd_server_connection
*sconn
,
774 char *buf1
,unsigned int key
)
776 unsigned char *buf
= (unsigned char *)buf1
;
777 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
780 DEBUG(1,("filling null dirptr %d\n",key
));
783 offset
= (uint32
)TellDir(dptr
->dir_hnd
);
784 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
785 (long)dptr
->dir_hnd
,(int)offset
));
791 /****************************************************************************
792 Fetch the dir ptr and seek it given the 5 byte server field.
793 ****************************************************************************/
795 struct dptr_struct
*dptr_fetch(struct smbd_server_connection
*sconn
,
798 unsigned int key
= *(unsigned char *)buf
;
799 struct dptr_struct
*dptr
= dptr_get(sconn
, key
, false);
804 DEBUG(3,("fetched null dirptr %d\n",key
));
808 offset
= IVAL(buf
,1);
809 if (offset
== (uint32
)-1) {
810 seekoff
= END_OF_DIRECTORY_OFFSET
;
812 seekoff
= (long)offset
;
814 SeekDir(dptr
->dir_hnd
,seekoff
);
815 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
816 key
, dptr
->path
, (int)seekoff
));
820 /****************************************************************************
822 ****************************************************************************/
824 struct dptr_struct
*dptr_fetch_lanman2(struct smbd_server_connection
*sconn
,
827 struct dptr_struct
*dptr
= dptr_get(sconn
, dptr_num
, false);
830 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
833 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr
->path
));
837 /****************************************************************************
838 Check that a file matches a particular file type.
839 ****************************************************************************/
841 bool dir_check_ftype(connection_struct
*conn
, uint32 mode
, uint32 dirtype
)
845 /* Check the "may have" search bits. */
846 if (((mode
& ~dirtype
) & (aHIDDEN
| aSYSTEM
| aDIR
)) != 0)
849 /* Check the "must have" bits, which are the may have bits shifted eight */
850 /* If must have bit is set, the file/dir can not be returned in search unless the matching
851 file attribute is set */
852 mask
= ((dirtype
>> 8) & (aDIR
|aARCH
|aRONLY
|aHIDDEN
|aSYSTEM
)); /* & 0x37 */
854 if((mask
& (mode
& (aDIR
|aARCH
|aRONLY
|aHIDDEN
|aSYSTEM
))) == mask
) /* check if matching attribute present */
863 static bool mangle_mask_match(connection_struct
*conn
,
864 const char *filename
,
869 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
872 return mask_match_search(mname
,mask
,False
);
875 bool smbd_dirptr_get_entry(TALLOC_CTX
*ctx
,
876 struct dptr_struct
*dirptr
,
881 bool (*match_fn
)(TALLOC_CTX
*ctx
,
886 bool (*mode_fn
)(TALLOC_CTX
*ctx
,
888 struct smb_filename
*smb_fname
,
892 struct smb_filename
**_smb_fname
,
896 connection_struct
*conn
= dirptr
->conn
;
902 needslash
= ( dirptr
->path
[strlen(dirptr
->path
) -1] != '/');
907 SMB_STRUCT_STAT sbuf
;
911 char *pathreal
= NULL
;
912 struct smb_filename smb_fname
;
917 cur_offset
= dptr_TellDir(dirptr
);
918 prev_offset
= cur_offset
;
919 dname
= dptr_ReadDirName(ctx
, dirptr
, &cur_offset
, &sbuf
);
921 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
922 (long)dirptr
, cur_offset
));
928 isdots
= (ISDOT(dname
) || ISDOTDOT(dname
));
929 if (dont_descend
&& !isdots
) {
935 * fname may get mangled, dname is never mangled.
936 * Whenever we're accessing the filesystem we use
937 * pathreal which is composed from dname.
940 ok
= match_fn(ctx
, private_data
, dname
, mask
, &fname
);
946 pathreal
= talloc_asprintf(ctx
, "%s%s%s",
956 /* Create smb_fname with NULL stream_name. */
957 ZERO_STRUCT(smb_fname
);
958 smb_fname
.base_name
= pathreal
;
961 ok
= mode_fn(ctx
, private_data
, &smb_fname
, &mode
);
965 TALLOC_FREE(pathreal
);
969 if (!dir_check_ftype(conn
, mode
, dirtype
)) {
970 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
971 fname
, (unsigned int)mode
, (unsigned int)dirtype
));
974 TALLOC_FREE(pathreal
);
979 struct timespec write_time_ts
;
980 struct file_id fileid
;
982 fileid
= vfs_file_id_from_sbuf(conn
,
984 get_file_infos(fileid
, NULL
, &write_time_ts
);
985 if (!null_timespec(write_time_ts
)) {
986 update_stat_ex_mtime(&smb_fname
.st
,
991 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
993 mask
, smb_fname_str_dbg(&smb_fname
),
996 DirCacheAdd(dirptr
->dir_hnd
, dname
, cur_offset
);
1000 status
= copy_smb_filename(ctx
, &smb_fname
, _smb_fname
);
1001 TALLOC_FREE(pathreal
);
1002 if (!NT_STATUS_IS_OK(status
)) {
1007 *_prev_offset
= prev_offset
;
1015 /****************************************************************************
1016 Get an 8.3 directory entry.
1017 ****************************************************************************/
1019 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX
*ctx
,
1025 connection_struct
*conn
= (connection_struct
*)private_data
;
1027 if ((strcmp(mask
,"*.*") == 0) ||
1028 mask_match_search(dname
, mask
, false) ||
1029 mangle_mask_match(conn
, dname
, mask
)) {
1033 if (!mangle_is_8_3(dname
, false, conn
->params
)) {
1034 bool ok
= name_to_8_3(dname
, mname
, false,
1044 *_fname
= talloc_strdup(ctx
, fname
);
1045 if (*_fname
== NULL
) {
1055 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX
*ctx
,
1057 struct smb_filename
*smb_fname
,
1060 connection_struct
*conn
= (connection_struct
*)private_data
;
1062 if (!VALID_STAT(smb_fname
->st
)) {
1063 if ((SMB_VFS_STAT(conn
, smb_fname
)) != 0) {
1064 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1065 "Couldn't stat [%s]. Error "
1067 smb_fname_str_dbg(smb_fname
),
1073 *_mode
= dos_mode(conn
, smb_fname
);
1077 bool get_dir_entry(TALLOC_CTX
*ctx
,
1078 struct dptr_struct
*dirptr
,
1084 struct timespec
*_date
,
1088 connection_struct
*conn
= dirptr
->conn
;
1090 struct smb_filename
*smb_fname
= NULL
;
1095 ok
= smbd_dirptr_get_entry(ctx
,
1101 smbd_dirptr_8_3_match_fn
,
1102 smbd_dirptr_8_3_mode_fn
,
1112 *_fname
= talloc_move(ctx
, &fname
);
1113 *_size
= smb_fname
->st
.st_ex_size
;
1115 *_date
= smb_fname
->st
.st_ex_mtime
;
1116 TALLOC_FREE(smb_fname
);
1120 /*******************************************************************
1121 Check to see if a user can read a file. This is only approximate,
1122 it is used as part of the "hide unreadable" option. Don't
1123 use it for anything security sensitive.
1124 ********************************************************************/
1126 static bool user_can_read_file(connection_struct
*conn
,
1127 struct smb_filename
*smb_fname
)
1130 * Never hide files from the root user.
1131 * We use (uid_t)0 here not sec_initial_uid()
1132 * as make test uses a single user context.
1135 if (get_current_uid(conn
) == (uid_t
)0) {
1139 return can_access_file_acl(conn
, smb_fname
, FILE_READ_DATA
);
1142 /*******************************************************************
1143 Check to see if a user can write a file (and only files, we do not
1144 check dirs on this one). This is only approximate,
1145 it is used as part of the "hide unwriteable" option. Don't
1146 use it for anything security sensitive.
1147 ********************************************************************/
1149 static bool user_can_write_file(connection_struct
*conn
,
1150 const struct smb_filename
*smb_fname
)
1153 * Never hide files from the root user.
1154 * We use (uid_t)0 here not sec_initial_uid()
1155 * as make test uses a single user context.
1158 if (get_current_uid(conn
) == (uid_t
)0) {
1162 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1164 /* Pseudo-open the file */
1166 if(S_ISDIR(smb_fname
->st
.st_ex_mode
)) {
1170 return can_write_to_file(conn
, smb_fname
);
1173 /*******************************************************************
1174 Is a file a "special" type ?
1175 ********************************************************************/
1177 static bool file_is_special(connection_struct
*conn
,
1178 const struct smb_filename
*smb_fname
)
1181 * Never hide files from the root user.
1182 * We use (uid_t)0 here not sec_initial_uid()
1183 * as make test uses a single user context.
1186 if (get_current_uid(conn
) == (uid_t
)0) {
1190 SMB_ASSERT(VALID_STAT(smb_fname
->st
));
1192 if (S_ISREG(smb_fname
->st
.st_ex_mode
) ||
1193 S_ISDIR(smb_fname
->st
.st_ex_mode
) ||
1194 S_ISLNK(smb_fname
->st
.st_ex_mode
))
1200 /*******************************************************************
1201 Should the file be seen by the client?
1202 NOTE: A successful return is no guarantee of the file's existence.
1203 ********************************************************************/
1205 bool is_visible_file(connection_struct
*conn
, const char *dir_path
,
1206 const char *name
, SMB_STRUCT_STAT
*pst
, bool use_veto
)
1208 bool hide_unreadable
= lp_hideunreadable(SNUM(conn
));
1209 bool hide_unwriteable
= lp_hideunwriteable_files(SNUM(conn
));
1210 bool hide_special
= lp_hide_special_files(SNUM(conn
));
1212 struct smb_filename
*smb_fname_base
= NULL
;
1216 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1217 return True
; /* . and .. are always visible. */
1220 /* If it's a vetoed file, pretend it doesn't even exist */
1221 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1222 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1226 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1227 entry
= talloc_asprintf(talloc_tos(), "%s/%s", dir_path
, name
);
1233 /* Create an smb_filename with stream_name == NULL. */
1234 status
= create_synthetic_smb_fname(talloc_tos(), entry
, NULL
,
1235 pst
, &smb_fname_base
);
1236 if (!NT_STATUS_IS_OK(status
)) {
1241 /* If the file name does not exist, there's no point checking
1242 * the configuration options. We succeed, on the basis that the
1243 * checks *might* have passed if the file was present.
1245 if (!VALID_STAT(*pst
)) {
1246 if (SMB_VFS_STAT(conn
, smb_fname_base
) != 0) {
1250 *pst
= smb_fname_base
->st
;
1254 /* Honour _hide unreadable_ option */
1255 if (hide_unreadable
&&
1256 !user_can_read_file(conn
, smb_fname_base
)) {
1257 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1262 /* Honour _hide unwriteable_ option */
1263 if (hide_unwriteable
&& !user_can_write_file(conn
,
1265 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1270 /* Honour _hide_special_ option */
1271 if (hide_special
&& file_is_special(conn
, smb_fname_base
)) {
1272 DEBUG(10,("is_visible_file: file %s is special.\n",
1281 TALLOC_FREE(smb_fname_base
);
1286 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1289 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1291 if (dirp
->conn
->sconn
) {
1292 dirp
->conn
->sconn
->smb1
.searches
.dirhandles_open
--;
1297 /*******************************************************************
1299 ********************************************************************/
1301 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1302 const char *name
, const char *mask
, uint32 attr
)
1304 struct smb_Dir
*dirp
= TALLOC_ZERO_P(mem_ctx
, struct smb_Dir
);
1305 struct smbd_server_connection
*sconn
= conn
->sconn
;
1312 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1314 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1315 if (!dirp
->dir_path
) {
1321 sconn
->smb1
.searches
.dirhandles_open
++;
1323 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1325 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1327 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1339 /*******************************************************************
1340 Read from a directory.
1341 Return directory entry, current offset, and optional stat information.
1342 Don't check for veto or invisible files.
1343 ********************************************************************/
1345 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
,
1346 SMB_STRUCT_STAT
*sbuf
, char **ptalloced
)
1349 char *talloced
= NULL
;
1350 connection_struct
*conn
= dirp
->conn
;
1352 /* Cheat to allow . and .. to be the first entries returned. */
1353 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) ||
1354 (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2))
1356 if (dirp
->file_number
== 0) {
1358 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1361 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1363 dirp
->file_number
++;
1366 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1367 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1370 /* A real offset, seek to it. */
1371 SeekDir(dirp
, *poffset
);
1374 while ((n
= vfs_readdirname(conn
, dirp
->dir
, sbuf
, &talloced
))) {
1375 /* Ignore . and .. - we've already returned them. */
1377 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1378 TALLOC_FREE(talloced
);
1382 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1383 *ptalloced
= talloced
;
1384 dirp
->file_number
++;
1387 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1392 /*******************************************************************
1393 Rewind to the start.
1394 ********************************************************************/
1396 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1398 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1399 dirp
->file_number
= 0;
1400 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1401 *poffset
= START_OF_DIRECTORY_OFFSET
;
1404 /*******************************************************************
1406 ********************************************************************/
1408 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1410 if (offset
!= dirp
->offset
) {
1411 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1412 RewindDir(dirp
, &offset
);
1414 * Ok we should really set the file number here
1415 * to 1 to enable ".." to be returned next. Trouble
1416 * is I'm worried about callers using SeekDir(dirp,0)
1417 * as equivalent to RewindDir(). So leave this alone
1420 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1421 RewindDir(dirp
, &offset
);
1423 * Set the file number to 2 - we want to get the first
1424 * real file entry (the one we return after "..")
1425 * on the next ReadDir.
1427 dirp
->file_number
= 2;
1428 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1429 ; /* Don't seek in this case. */
1431 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1433 dirp
->offset
= offset
;
1437 /*******************************************************************
1438 Tell a dir position.
1439 ********************************************************************/
1441 long TellDir(struct smb_Dir
*dirp
)
1443 return(dirp
->offset
);
1446 /*******************************************************************
1447 Add an entry into the dcache.
1448 ********************************************************************/
1450 void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1452 struct name_cache_entry
*e
;
1454 if (dirp
->name_cache_size
== 0) {
1458 if (dirp
->name_cache
== NULL
) {
1459 dirp
->name_cache
= TALLOC_ZERO_ARRAY(
1460 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1462 if (dirp
->name_cache
== NULL
) {
1467 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1468 dirp
->name_cache_size
;
1469 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1470 TALLOC_FREE(e
->name
);
1471 e
->name
= talloc_strdup(dirp
, name
);
1475 /*******************************************************************
1476 Find an entry by name. Leave us at the offset after it.
1477 Don't check for veto or invisible files.
1478 ********************************************************************/
1480 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1483 const char *entry
= NULL
;
1484 char *talloced
= NULL
;
1485 connection_struct
*conn
= dirp
->conn
;
1487 /* Search back in the name cache. */
1488 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1489 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1490 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1491 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1492 *poffset
= e
->offset
;
1493 SeekDir(dirp
, e
->offset
);
1497 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1498 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1499 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1500 *poffset
= e
->offset
;
1501 SeekDir(dirp
, e
->offset
);
1507 /* Not found in the name cache. Rewind directory and start from scratch. */
1508 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1509 dirp
->file_number
= 0;
1510 *poffset
= START_OF_DIRECTORY_OFFSET
;
1511 while ((entry
= ReadDirName(dirp
, poffset
, NULL
, &talloced
))) {
1512 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1513 TALLOC_FREE(talloced
);
1516 TALLOC_FREE(talloced
);
1521 /*****************************************************************
1522 Is this directory empty ?
1523 *****************************************************************/
1525 NTSTATUS
can_delete_directory(struct connection_struct
*conn
,
1526 const char *dirname
)
1528 NTSTATUS status
= NT_STATUS_OK
;
1530 const char *dname
= NULL
;
1531 char *talloced
= NULL
;
1533 struct smb_Dir
*dir_hnd
= OpenDir(talloc_tos(), conn
, dirname
,
1537 return map_nt_error_from_unix(errno
);
1540 while ((dname
= ReadDirName(dir_hnd
, &dirpos
, &st
, &talloced
))) {
1541 /* Quick check for "." and ".." */
1542 if (dname
[0] == '.') {
1543 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1544 TALLOC_FREE(talloced
);
1549 if (!is_visible_file(conn
, dirname
, dname
, &st
, True
)) {
1550 TALLOC_FREE(talloced
);
1554 DEBUG(10,("can_delete_directory: got name %s - can't delete\n",
1556 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1559 TALLOC_FREE(talloced
);
1560 TALLOC_FREE(dir_hnd
);