s3: Fix max indentation and max column
[Samba.git] / source3 / smbd / dir.c
blob4480ec38882161864c97380b87afb62a243a72b1
1 /*
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/>.
21 #include "includes.h"
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"
27 #include "../lib/util/memcache.h"
28 #include "../librpc/gen_ndr/open_files.h"
31 This module implements directory related functions for Samba.
34 /* "Special" directory offsets. */
35 #define END_OF_DIRECTORY_OFFSET ((long)-1)
36 #define START_OF_DIRECTORY_OFFSET ((long)0)
37 #define DOT_DOT_DIRECTORY_OFFSET ((long)0x80000000)
39 /* "Special" directory offsets in 32-bit wire format. */
40 #define WIRE_END_OF_DIRECTORY_OFFSET ((uint32_t)0xFFFFFFFF)
41 #define WIRE_START_OF_DIRECTORY_OFFSET ((uint32_t)0)
42 #define WIRE_DOT_DOT_DIRECTORY_OFFSET ((uint32_t)0x80000000)
44 /* Make directory handle internals available. */
46 struct name_cache_entry {
47 char *name;
48 long offset;
51 struct smb_Dir {
52 connection_struct *conn;
53 DIR *dir;
54 long offset;
55 struct smb_filename *dir_smb_fname;
56 size_t name_cache_size;
57 struct name_cache_entry *name_cache;
58 unsigned int name_cache_index;
59 unsigned int file_number;
60 files_struct *fsp; /* Back pointer to containing fsp, only
61 set from OpenDir_fsp(). */
64 struct dptr_struct {
65 struct dptr_struct *next, *prev;
66 int dnum;
67 uint16_t spid;
68 struct connection_struct *conn;
69 struct smb_Dir *dir_hnd;
70 bool expect_close;
71 char *wcard;
72 uint32_t attr;
73 struct smb_filename *smb_dname;
74 bool has_wild; /* Set to true if the wcard entry has MS wildcard characters in it. */
75 bool did_stat; /* Optimisation for non-wcard searches. */
76 bool priv; /* Directory handle opened with privilege. */
77 uint32_t counter;
78 struct memcache *dptr_cache;
81 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
82 files_struct *fsp,
83 const char *mask,
84 uint32_t attr);
86 static void DirCacheAdd(struct smb_Dir *dirp, const char *name, long offset);
88 #define INVALID_DPTR_KEY (-3)
90 /****************************************************************************
91 Initialise the dir bitmap.
92 ****************************************************************************/
94 bool init_dptrs(struct smbd_server_connection *sconn)
96 if (sconn->searches.dptr_bmap) {
97 return true;
100 sconn->searches.dptr_bmap = bitmap_talloc(
101 sconn, MAX_DIRECTORY_HANDLES);
103 if (sconn->searches.dptr_bmap == NULL) {
104 return false;
107 return true;
110 /****************************************************************************
111 Idle a dptr - the directory is closed but the control info is kept.
112 ****************************************************************************/
114 static void dptr_idle(struct dptr_struct *dptr)
116 if (dptr->dir_hnd) {
117 DEBUG(4,("Idling dptr dnum %d\n",dptr->dnum));
118 TALLOC_FREE(dptr->dir_hnd);
119 TALLOC_FREE(dptr->dptr_cache);
120 dptr->counter = 0;
124 /****************************************************************************
125 Idle the oldest dptr.
126 ****************************************************************************/
128 static void dptr_idleoldest(struct smbd_server_connection *sconn)
130 struct dptr_struct *dptr;
133 * Go to the end of the list.
135 dptr = DLIST_TAIL(sconn->searches.dirptrs);
137 if(!dptr) {
138 DEBUG(0,("No dptrs available to idle ?\n"));
139 return;
143 * Idle the oldest pointer.
146 for(; dptr; dptr = DLIST_PREV(dptr)) {
147 if (dptr->dir_hnd) {
148 dptr_idle(dptr);
149 return;
154 /****************************************************************************
155 Get the struct dptr_struct for a dir index.
156 ****************************************************************************/
158 static struct dptr_struct *dptr_get(struct smbd_server_connection *sconn,
159 int key, bool forclose)
161 struct dptr_struct *dptr;
162 const int dirhandles_open = sconn->searches.dirhandles_open;
164 for (dptr = sconn->searches.dirptrs; dptr != NULL; dptr = dptr->next) {
165 if(dptr->dnum != key) {
166 continue;
169 if (!forclose && (dptr->dir_hnd == NULL)) {
170 if (dirhandles_open >= MAX_OPEN_DIRECTORIES) {
171 dptr_idleoldest(sconn);
173 DBG_INFO("Reopening dptr key %d\n",key);
175 dptr->dir_hnd = OpenDir(NULL,
176 dptr->conn,
177 dptr->smb_dname,
178 dptr->wcard,
179 dptr->attr);
181 if (dptr->dir_hnd == NULL) {
182 DBG_INFO("Failed to open %s (%s)\n",
183 dptr->smb_dname->base_name,
184 strerror(errno));
185 return NULL;
188 DLIST_PROMOTE(sconn->searches.dirptrs, dptr);
189 return dptr;
191 return(NULL);
194 /****************************************************************************
195 Get the dir path for a dir index.
196 ****************************************************************************/
198 const char *dptr_path(struct smbd_server_connection *sconn, int key)
200 struct dptr_struct *dptr = dptr_get(sconn, key, false);
201 if (dptr)
202 return(dptr->smb_dname->base_name);
203 return(NULL);
206 /****************************************************************************
207 Get the dir wcard for a dir index.
208 ****************************************************************************/
210 const char *dptr_wcard(struct smbd_server_connection *sconn, int key)
212 struct dptr_struct *dptr = dptr_get(sconn, key, false);
213 if (dptr)
214 return(dptr->wcard);
215 return(NULL);
218 /****************************************************************************
219 Get the dir attrib for a dir index.
220 ****************************************************************************/
222 uint16_t dptr_attr(struct smbd_server_connection *sconn, int key)
224 struct dptr_struct *dptr = dptr_get(sconn, key, false);
225 if (dptr)
226 return(dptr->attr);
227 return(0);
230 /****************************************************************************
231 Close a dptr (internal func).
232 ****************************************************************************/
234 static void dptr_close_internal(struct dptr_struct *dptr)
236 struct smbd_server_connection *sconn = dptr->conn->sconn;
238 DEBUG(4,("closing dptr key %d\n",dptr->dnum));
240 if (sconn == NULL) {
241 goto done;
244 if (sconn->using_smb2) {
245 goto done;
248 DLIST_REMOVE(sconn->searches.dirptrs, dptr);
251 * Free the dnum in the bitmap. Remember the dnum value is always
252 * biased by one with respect to the bitmap.
255 if (!bitmap_query(sconn->searches.dptr_bmap, dptr->dnum - 1)) {
256 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
257 dptr->dnum ));
260 bitmap_clear(sconn->searches.dptr_bmap, dptr->dnum - 1);
262 done:
263 TALLOC_FREE(dptr->dir_hnd);
264 TALLOC_FREE(dptr);
267 /****************************************************************************
268 Close a dptr given a key.
269 ****************************************************************************/
271 void dptr_close(struct smbd_server_connection *sconn, int *key)
273 struct dptr_struct *dptr;
275 if(*key == INVALID_DPTR_KEY)
276 return;
278 /* OS/2 seems to use -1 to indicate "close all directories" */
279 if (*key == -1) {
280 struct dptr_struct *next;
281 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
282 next = dptr->next;
283 dptr_close_internal(dptr);
285 *key = INVALID_DPTR_KEY;
286 return;
289 dptr = dptr_get(sconn, *key, true);
291 if (!dptr) {
292 DEBUG(0,("Invalid key %d given to dptr_close\n", *key));
293 return;
296 dptr_close_internal(dptr);
298 *key = INVALID_DPTR_KEY;
301 /****************************************************************************
302 Close all dptrs for a cnum.
303 ****************************************************************************/
305 void dptr_closecnum(connection_struct *conn)
307 struct dptr_struct *dptr, *next;
308 struct smbd_server_connection *sconn = conn->sconn;
310 if (sconn == NULL) {
311 return;
314 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
315 next = dptr->next;
316 if (dptr->conn == conn) {
317 dptr_close_internal(dptr);
322 /****************************************************************************
323 Idle all dptrs for a cnum.
324 ****************************************************************************/
326 void dptr_idlecnum(connection_struct *conn)
328 struct dptr_struct *dptr;
329 struct smbd_server_connection *sconn = conn->sconn;
331 if (sconn == NULL) {
332 return;
335 for(dptr = sconn->searches.dirptrs; dptr; dptr = dptr->next) {
336 if (dptr->conn == conn && dptr->dir_hnd) {
337 dptr_idle(dptr);
342 /****************************************************************************
343 Close a dptr that matches a given path, only if it matches the spid also.
344 ****************************************************************************/
346 void dptr_closepath(struct smbd_server_connection *sconn,
347 char *path,uint16_t spid)
349 struct dptr_struct *dptr, *next;
350 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
351 next = dptr->next;
352 if (spid == dptr->spid &&
353 strequal(dptr->smb_dname->base_name,path)) {
354 dptr_close_internal(dptr);
359 /****************************************************************************
360 Try and close the oldest handle not marked for
361 expect close in the hope that the client has
362 finished with that one.
363 ****************************************************************************/
365 static void dptr_close_oldest(struct smbd_server_connection *sconn,
366 bool old)
368 struct dptr_struct *dptr;
371 * Go to the end of the list.
373 for(dptr = sconn->searches.dirptrs; dptr && dptr->next; dptr = dptr->next)
376 if(!dptr) {
377 DEBUG(0,("No old dptrs available to close oldest ?\n"));
378 return;
382 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
383 * does not have expect_close set. If 'old' is false, close
384 * one of the new dnum handles.
387 for(; dptr; dptr = DLIST_PREV(dptr)) {
388 if ((old && (dptr->dnum < 256) && !dptr->expect_close) ||
389 (!old && (dptr->dnum > 255))) {
390 dptr_close_internal(dptr);
391 return;
396 /****************************************************************************
397 Safely do an OpenDir as root, ensuring we're in the right place.
398 ****************************************************************************/
400 static struct smb_Dir *open_dir_with_privilege(connection_struct *conn,
401 struct smb_request *req,
402 const struct smb_filename *smb_dname,
403 const char *wcard,
404 uint32_t attr)
406 struct smb_Dir *dir_hnd = NULL;
407 struct smb_filename *smb_fname_cwd = NULL;
408 struct smb_filename *saved_dir_fname = vfs_GetWd(talloc_tos(), conn);
409 struct privilege_paths *priv_paths = req->priv_paths;
410 int ret;
412 if (saved_dir_fname == NULL) {
413 return NULL;
416 if (vfs_ChDir(conn, smb_dname) == -1) {
417 return NULL;
420 /* Now check the stat value is the same. */
421 smb_fname_cwd = synthetic_smb_fname(talloc_tos(),
422 ".",
423 NULL,
424 NULL,
425 smb_dname->flags);
426 if (smb_fname_cwd == NULL) {
427 goto out;
429 ret = SMB_VFS_STAT(conn, smb_fname_cwd);
430 if (ret != 0) {
431 goto out;
434 if (!check_same_stat(&smb_fname_cwd->st, &priv_paths->parent_name.st)) {
435 DEBUG(0,("open_dir_with_privilege: stat mismatch between %s "
436 "and %s\n",
437 smb_dname->base_name,
438 smb_fname_str_dbg(&priv_paths->parent_name)));
439 goto out;
442 dir_hnd = OpenDir(NULL, conn, smb_fname_cwd, wcard, attr);
444 out:
446 vfs_ChDir(conn, saved_dir_fname);
447 TALLOC_FREE(saved_dir_fname);
448 return dir_hnd;
451 /****************************************************************************
452 Create a new dir ptr. If the flag old_handle is true then we must allocate
453 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
454 one byte long. If old_handle is false we allocate from the range
455 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
456 a directory handle is never zero.
457 wcard must not be zero.
458 ****************************************************************************/
460 NTSTATUS dptr_create(connection_struct *conn,
461 struct smb_request *req,
462 files_struct *fsp,
463 const struct smb_filename *smb_dname,
464 bool old_handle,
465 bool expect_close,
466 uint16_t spid,
467 const char *wcard,
468 bool wcard_has_wild,
469 uint32_t attr,
470 struct dptr_struct **dptr_ret)
472 struct smbd_server_connection *sconn = conn->sconn;
473 struct dptr_struct *dptr = NULL;
474 struct smb_Dir *dir_hnd;
476 if (fsp && fsp->is_directory && fsp->fh->fd != -1) {
477 smb_dname = fsp->fsp_name;
480 DEBUG(5,("dptr_create dir=%s\n", smb_dname->base_name));
482 if (sconn == NULL) {
483 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
484 return NT_STATUS_INTERNAL_ERROR;
487 if (!wcard) {
488 return NT_STATUS_INVALID_PARAMETER;
491 if (fsp) {
492 if (!(fsp->access_mask & SEC_DIR_LIST)) {
493 DEBUG(5,("dptr_create: directory %s "
494 "not open for LIST access\n",
495 smb_dname->base_name));
496 return NT_STATUS_ACCESS_DENIED;
498 dir_hnd = OpenDir_fsp(NULL, conn, fsp, wcard, attr);
499 } else {
500 int ret;
501 bool backup_intent = (req && req->priv_paths);
502 NTSTATUS status;
503 struct smb_filename *smb_dname_cp =
504 cp_smb_filename(talloc_tos(), smb_dname);
506 if (smb_dname_cp == NULL) {
507 return NT_STATUS_NO_MEMORY;
510 if (req != NULL && req->posix_pathnames) {
511 ret = SMB_VFS_LSTAT(conn, smb_dname_cp);
512 } else {
513 ret = SMB_VFS_STAT(conn, smb_dname_cp);
515 if (ret == -1) {
516 status = map_nt_error_from_unix(errno);
517 TALLOC_FREE(smb_dname_cp);
518 return status;
520 if (!S_ISDIR(smb_dname_cp->st.st_ex_mode)) {
521 TALLOC_FREE(smb_dname_cp);
522 return NT_STATUS_NOT_A_DIRECTORY;
524 status = smbd_check_access_rights(conn,
525 smb_dname_cp,
526 backup_intent,
527 SEC_DIR_LIST);
528 if (!NT_STATUS_IS_OK(status)) {
529 TALLOC_FREE(smb_dname_cp);
530 return status;
532 if (backup_intent) {
533 dir_hnd = open_dir_with_privilege(conn,
534 req,
535 smb_dname_cp,
536 wcard,
537 attr);
538 } else {
539 dir_hnd = OpenDir(NULL,
540 conn,
541 smb_dname_cp,
542 wcard,
543 attr);
545 TALLOC_FREE(smb_dname_cp);
548 if (!dir_hnd) {
549 return map_nt_error_from_unix(errno);
552 if (sconn->searches.dirhandles_open >= MAX_OPEN_DIRECTORIES) {
553 dptr_idleoldest(sconn);
556 dptr = talloc_zero(NULL, struct dptr_struct);
557 if(!dptr) {
558 DEBUG(0,("talloc fail in dptr_create.\n"));
559 TALLOC_FREE(dir_hnd);
560 return NT_STATUS_NO_MEMORY;
563 dptr->smb_dname = cp_smb_filename(dptr, smb_dname);
564 if (!dptr->smb_dname) {
565 TALLOC_FREE(dptr);
566 TALLOC_FREE(dir_hnd);
567 return NT_STATUS_NO_MEMORY;
569 dptr->conn = conn;
570 dptr->dir_hnd = dir_hnd;
571 dptr->spid = spid;
572 dptr->expect_close = expect_close;
573 dptr->wcard = talloc_strdup(dptr, wcard);
574 if (!dptr->wcard) {
575 TALLOC_FREE(dptr);
576 TALLOC_FREE(dir_hnd);
577 return NT_STATUS_NO_MEMORY;
579 if ((req != NULL && req->posix_pathnames) ||
580 (wcard[0] == '.' && wcard[1] == 0)) {
581 dptr->has_wild = True;
582 } else {
583 dptr->has_wild = wcard_has_wild;
586 dptr->attr = attr;
588 if (sconn->using_smb2) {
589 goto done;
592 if(old_handle) {
595 * This is an old-style SMBsearch request. Ensure the
596 * value we return will fit in the range 1-255.
599 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
601 if(dptr->dnum == -1 || dptr->dnum > 254) {
604 * Try and close the oldest handle not marked for
605 * expect close in the hope that the client has
606 * finished with that one.
609 dptr_close_oldest(sconn, true);
611 /* Now try again... */
612 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
613 if(dptr->dnum == -1 || dptr->dnum > 254) {
614 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr->dnum));
615 TALLOC_FREE(dptr);
616 TALLOC_FREE(dir_hnd);
617 return NT_STATUS_TOO_MANY_OPENED_FILES;
620 } else {
623 * This is a new-style trans2 request. Allocate from
624 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
627 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
629 if(dptr->dnum == -1 || dptr->dnum < 255) {
632 * Try and close the oldest handle close in the hope that
633 * the client has finished with that one. This will only
634 * happen in the case of the Win98 client bug where it leaks
635 * directory handles.
638 dptr_close_oldest(sconn, false);
640 /* Now try again... */
641 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
643 if(dptr->dnum == -1 || dptr->dnum < 255) {
644 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr->dnum));
645 TALLOC_FREE(dptr);
646 TALLOC_FREE(dir_hnd);
647 return NT_STATUS_TOO_MANY_OPENED_FILES;
652 bitmap_set(sconn->searches.dptr_bmap, dptr->dnum);
654 dptr->dnum += 1; /* Always bias the dnum by one - no zero dnums allowed. */
656 DLIST_ADD(sconn->searches.dirptrs, dptr);
658 done:
659 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
660 dptr->dnum,
661 dptr->smb_dname->base_name,
662 expect_close));
664 *dptr_ret = dptr;
666 return NT_STATUS_OK;
670 /****************************************************************************
671 Wrapper functions to access the lower level directory handles.
672 ****************************************************************************/
674 void dptr_CloseDir(files_struct *fsp)
676 if (fsp->dptr) {
678 * The destructor for the struct smb_Dir
679 * (fsp->dptr->dir_hnd) now handles
680 * all resource deallocation.
682 dptr_close_internal(fsp->dptr);
683 fsp->dptr = NULL;
687 void dptr_SeekDir(struct dptr_struct *dptr, long offset)
689 SeekDir(dptr->dir_hnd, offset);
692 long dptr_TellDir(struct dptr_struct *dptr)
694 return TellDir(dptr->dir_hnd);
697 bool dptr_has_wild(struct dptr_struct *dptr)
699 return dptr->has_wild;
702 int dptr_dnum(struct dptr_struct *dptr)
704 return dptr->dnum;
707 bool dptr_get_priv(struct dptr_struct *dptr)
709 return dptr->priv;
712 void dptr_set_priv(struct dptr_struct *dptr)
714 dptr->priv = true;
717 /****************************************************************************
718 Return the next visible file name, skipping veto'd and invisible files.
719 ****************************************************************************/
721 static const char *dptr_normal_ReadDirName(struct dptr_struct *dptr,
722 long *poffset, SMB_STRUCT_STAT *pst,
723 char **ptalloced)
725 /* Normal search for the next file. */
726 const char *name;
727 char *talloced = NULL;
729 while ((name = ReadDirName(dptr->dir_hnd, poffset, pst, &talloced))
730 != NULL) {
731 if (is_visible_file(dptr->conn,
732 dptr->smb_dname->base_name,
733 name,
734 pst,
735 true)) {
736 *ptalloced = talloced;
737 return name;
739 TALLOC_FREE(talloced);
741 return NULL;
744 /****************************************************************************
745 Return the next visible file name, skipping veto'd and invisible files.
746 ****************************************************************************/
748 static char *dptr_ReadDirName(TALLOC_CTX *ctx,
749 struct dptr_struct *dptr,
750 long *poffset,
751 SMB_STRUCT_STAT *pst)
753 struct smb_filename smb_fname_base;
754 char *name = NULL;
755 const char *name_temp = NULL;
756 char *talloced = NULL;
757 char *pathreal = NULL;
758 char *found_name = NULL;
759 int ret;
761 SET_STAT_INVALID(*pst);
763 if (dptr->has_wild || dptr->did_stat) {
764 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst,
765 &talloced);
766 if (name_temp == NULL) {
767 return 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) {
778 return NULL;
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
784 * searching. */
786 dptr->did_stat = true;
788 /* First check if it should be visible. */
789 if (!is_visible_file(dptr->conn,
790 dptr->smb_dname->base_name,
791 dptr->wcard,
792 pst,
793 true)) {
794 /* This only returns false if the file was found, but
795 is explicitly not visible. Set us to end of
796 directory, but return NULL as we know we can't ever
797 find it. */
798 goto ret;
801 if (VALID_STAT(*pst)) {
802 name = talloc_strdup(ctx, dptr->wcard);
803 goto ret;
806 pathreal = talloc_asprintf(ctx,
807 "%s/%s",
808 dptr->smb_dname->base_name,
809 dptr->wcard);
810 if (!pathreal)
811 return NULL;
813 /* Create an smb_filename with stream_name == NULL. */
814 smb_fname_base = (struct smb_filename) { .base_name = pathreal };
816 if (SMB_VFS_STAT(dptr->conn, &smb_fname_base) == 0) {
817 *pst = smb_fname_base.st;
818 name = talloc_strdup(ctx, dptr->wcard);
819 goto clean;
820 } else {
821 /* If we get any other error than ENOENT or ENOTDIR
822 then the file exists we just can't stat it. */
823 if (errno != ENOENT && errno != ENOTDIR) {
824 name = talloc_strdup(ctx, dptr->wcard);
825 goto clean;
829 /* Stat failed. We know this is authoratiative if we are
830 * providing case sensitive semantics or the underlying
831 * filesystem is case sensitive.
833 if (dptr->conn->case_sensitive ||
834 !(dptr->conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH))
836 goto clean;
840 * Try case-insensitive stat if the fs has the ability. This avoids
841 * scanning the whole directory.
843 ret = SMB_VFS_GET_REAL_FILENAME(dptr->conn,
844 dptr->smb_dname->base_name,
845 dptr->wcard,
846 ctx,
847 &found_name);
848 if (ret == 0) {
849 name = found_name;
850 goto clean;
851 } else if (errno == ENOENT) {
852 /* The case-insensitive lookup was authoritative. */
853 goto clean;
856 TALLOC_FREE(pathreal);
858 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst, &talloced);
859 if (name_temp == NULL) {
860 return NULL;
862 if (talloced != NULL) {
863 return talloc_move(ctx, &talloced);
865 return talloc_strdup(ctx, name_temp);
867 clean:
868 TALLOC_FREE(pathreal);
869 ret:
870 /* We need to set the underlying dir_hnd offset to -1
871 * also as this function is usually called with the
872 * output from TellDir. */
873 dptr->dir_hnd->offset = *poffset = END_OF_DIRECTORY_OFFSET;
874 return name;
877 /****************************************************************************
878 Search for a file by name, skipping veto'ed and not visible files.
879 ****************************************************************************/
881 bool dptr_SearchDir(struct dptr_struct *dptr, const char *name, long *poffset, SMB_STRUCT_STAT *pst)
883 SET_STAT_INVALID(*pst);
885 if (!dptr->has_wild && (dptr->dir_hnd->offset == END_OF_DIRECTORY_OFFSET)) {
886 /* This is a singleton directory and we're already at the end. */
887 *poffset = END_OF_DIRECTORY_OFFSET;
888 return False;
891 return SearchDir(dptr->dir_hnd, name, poffset);
894 /****************************************************************************
895 Map a native directory offset to a 32-bit cookie.
896 ****************************************************************************/
898 static uint32_t map_dir_offset_to_wire(struct dptr_struct *dptr, long offset)
900 DATA_BLOB key;
901 DATA_BLOB val;
903 if (offset == END_OF_DIRECTORY_OFFSET) {
904 return WIRE_END_OF_DIRECTORY_OFFSET;
905 } else if(offset == START_OF_DIRECTORY_OFFSET) {
906 return WIRE_START_OF_DIRECTORY_OFFSET;
907 } else if (offset == DOT_DOT_DIRECTORY_OFFSET) {
908 return WIRE_DOT_DOT_DIRECTORY_OFFSET;
910 if (sizeof(long) == 4) {
911 /* 32-bit machine. We can cheat... */
912 return (uint32_t)offset;
914 if (dptr->dptr_cache == NULL) {
915 /* Lazy initialize cache. */
916 dptr->dptr_cache = memcache_init(dptr, 0);
917 if (dptr->dptr_cache == NULL) {
918 return WIRE_END_OF_DIRECTORY_OFFSET;
920 } else {
921 /* Have we seen this offset before ? */
922 key.data = (void *)&offset;
923 key.length = sizeof(offset);
924 if (memcache_lookup(dptr->dptr_cache,
925 SMB1_SEARCH_OFFSET_MAP,
926 key,
927 &val)) {
928 uint32_t wire_offset;
929 SMB_ASSERT(val.length == sizeof(wire_offset));
930 memcpy(&wire_offset, val.data, sizeof(wire_offset));
931 DEBUG(10,("found wire %u <-> offset %ld\n",
932 (unsigned int)wire_offset,
933 (long)offset));
934 return wire_offset;
937 /* Allocate a new wire cookie. */
938 do {
939 dptr->counter++;
940 } while (dptr->counter == WIRE_START_OF_DIRECTORY_OFFSET ||
941 dptr->counter == WIRE_END_OF_DIRECTORY_OFFSET ||
942 dptr->counter == WIRE_DOT_DOT_DIRECTORY_OFFSET);
943 /* Store it in the cache. */
944 key.data = (void *)&offset;
945 key.length = sizeof(offset);
946 val.data = (void *)&dptr->counter;
947 val.length = sizeof(dptr->counter); /* MUST BE uint32_t ! */
948 memcache_add(dptr->dptr_cache,
949 SMB1_SEARCH_OFFSET_MAP,
950 key,
951 val);
952 /* And the reverse mapping for lookup from
953 map_wire_to_dir_offset(). */
954 memcache_add(dptr->dptr_cache,
955 SMB1_SEARCH_OFFSET_MAP,
956 val,
957 key);
958 DEBUG(10,("stored wire %u <-> offset %ld\n",
959 (unsigned int)dptr->counter,
960 (long)offset));
961 return dptr->counter;
964 /****************************************************************************
965 Fill the 5 byte server reserved dptr field.
966 ****************************************************************************/
968 bool dptr_fill(struct smbd_server_connection *sconn,
969 char *buf1,unsigned int key)
971 unsigned char *buf = (unsigned char *)buf1;
972 struct dptr_struct *dptr = dptr_get(sconn, key, false);
973 uint32_t wire_offset;
974 if (!dptr) {
975 DEBUG(1,("filling null dirptr %d\n",key));
976 return(False);
978 wire_offset = map_dir_offset_to_wire(dptr,TellDir(dptr->dir_hnd));
979 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key,
980 (long)dptr->dir_hnd,(int)wire_offset));
981 buf[0] = key;
982 SIVAL(buf,1,wire_offset);
983 return(True);
986 /****************************************************************************
987 Map a 32-bit wire cookie to a native directory offset.
988 ****************************************************************************/
990 static long map_wire_to_dir_offset(struct dptr_struct *dptr, uint32_t wire_offset)
992 DATA_BLOB key;
993 DATA_BLOB val;
995 if (wire_offset == WIRE_END_OF_DIRECTORY_OFFSET) {
996 return END_OF_DIRECTORY_OFFSET;
997 } else if(wire_offset == WIRE_START_OF_DIRECTORY_OFFSET) {
998 return START_OF_DIRECTORY_OFFSET;
999 } else if (wire_offset == WIRE_DOT_DOT_DIRECTORY_OFFSET) {
1000 return DOT_DOT_DIRECTORY_OFFSET;
1002 if (sizeof(long) == 4) {
1003 /* 32-bit machine. We can cheat... */
1004 return (long)wire_offset;
1006 if (dptr->dptr_cache == NULL) {
1007 /* Logic error, cache should be initialized. */
1008 return END_OF_DIRECTORY_OFFSET;
1010 key.data = (void *)&wire_offset;
1011 key.length = sizeof(wire_offset);
1012 if (memcache_lookup(dptr->dptr_cache,
1013 SMB1_SEARCH_OFFSET_MAP,
1014 key,
1015 &val)) {
1016 /* Found mapping. */
1017 long offset;
1018 SMB_ASSERT(val.length == sizeof(offset));
1019 memcpy(&offset, val.data, sizeof(offset));
1020 DEBUG(10,("lookup wire %u <-> offset %ld\n",
1021 (unsigned int)wire_offset,
1022 (long)offset));
1023 return offset;
1025 return END_OF_DIRECTORY_OFFSET;
1028 /****************************************************************************
1029 Fetch the dir ptr and seek it given the 5 byte server field.
1030 ****************************************************************************/
1032 struct dptr_struct *dptr_fetch(struct smbd_server_connection *sconn,
1033 char *buf, int *num)
1035 unsigned int key = *(unsigned char *)buf;
1036 struct dptr_struct *dptr = dptr_get(sconn, key, false);
1037 uint32_t wire_offset;
1038 long seekoff;
1040 if (!dptr) {
1041 DEBUG(3,("fetched null dirptr %d\n",key));
1042 return(NULL);
1044 *num = key;
1045 wire_offset = IVAL(buf,1);
1046 seekoff = map_wire_to_dir_offset(dptr, wire_offset);
1047 SeekDir(dptr->dir_hnd,seekoff);
1048 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
1049 key, dptr->smb_dname->base_name, (int)seekoff));
1050 return(dptr);
1053 /****************************************************************************
1054 Fetch the dir ptr.
1055 ****************************************************************************/
1057 struct dptr_struct *dptr_fetch_lanman2(struct smbd_server_connection *sconn,
1058 int dptr_num)
1060 struct dptr_struct *dptr = dptr_get(sconn, dptr_num, false);
1062 if (!dptr) {
1063 DEBUG(3,("fetched null dirptr %d\n",dptr_num));
1064 return(NULL);
1066 DEBUG(3,("fetching dirptr %d for path %s\n",
1067 dptr_num,
1068 dptr->smb_dname->base_name));
1069 return(dptr);
1072 static bool mangle_mask_match(connection_struct *conn,
1073 const char *filename,
1074 const char *mask)
1076 char mname[13];
1078 if (!name_to_8_3(filename,mname,False,conn->params)) {
1079 return False;
1081 return mask_match_search(mname,mask,False);
1084 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
1085 struct dptr_struct *dirptr,
1086 const char *mask,
1087 uint32_t dirtype,
1088 bool dont_descend,
1089 bool ask_sharemode,
1090 bool (*match_fn)(TALLOC_CTX *ctx,
1091 void *private_data,
1092 const char *dname,
1093 const char *mask,
1094 char **_fname),
1095 bool (*mode_fn)(TALLOC_CTX *ctx,
1096 void *private_data,
1097 struct smb_filename *smb_fname,
1098 uint32_t *_mode),
1099 void *private_data,
1100 char **_fname,
1101 struct smb_filename **_smb_fname,
1102 uint32_t *_mode,
1103 long *_prev_offset)
1105 connection_struct *conn = dirptr->conn;
1106 size_t slashlen;
1107 size_t pathlen;
1108 const char *dpath = dirptr->smb_dname->base_name;
1109 bool dirptr_path_is_dot = ISDOT(dpath);
1111 *_smb_fname = NULL;
1112 *_mode = 0;
1114 pathlen = strlen(dpath);
1115 slashlen = ( dpath[pathlen-1] != '/') ? 1 : 0;
1117 while (true) {
1118 long cur_offset;
1119 long prev_offset;
1120 SMB_STRUCT_STAT sbuf = { 0 };
1121 char *dname = NULL;
1122 bool isdots;
1123 char *fname = NULL;
1124 char *pathreal = NULL;
1125 struct smb_filename smb_fname;
1126 uint32_t mode = 0;
1127 bool ok;
1129 cur_offset = dptr_TellDir(dirptr);
1130 prev_offset = cur_offset;
1131 dname = dptr_ReadDirName(ctx, dirptr, &cur_offset, &sbuf);
1133 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
1134 (long)dirptr, cur_offset));
1136 if (dname == NULL) {
1137 return false;
1140 isdots = (ISDOT(dname) || ISDOTDOT(dname));
1141 if (dont_descend && !isdots) {
1142 TALLOC_FREE(dname);
1143 continue;
1147 * fname may get mangled, dname is never mangled.
1148 * Whenever we're accessing the filesystem we use
1149 * pathreal which is composed from dname.
1152 ok = match_fn(ctx, private_data, dname, mask, &fname);
1153 if (!ok) {
1154 TALLOC_FREE(dname);
1155 continue;
1159 * This used to be
1160 * pathreal = talloc_asprintf(ctx, "%s%s%s", dirptr->path,
1161 * needslash?"/":"", dname);
1162 * but this was measurably slower than doing the memcpy.
1165 pathreal = talloc_array(
1166 ctx, char,
1167 pathlen + slashlen + talloc_get_size(dname));
1168 if (!pathreal) {
1169 TALLOC_FREE(dname);
1170 TALLOC_FREE(fname);
1171 return false;
1175 * We don't want to pass ./xxx to modules below us so don't
1176 * add the path if it is just . by itself.
1178 if (dirptr_path_is_dot) {
1179 memcpy(pathreal, dname, talloc_get_size(dname));
1180 } else {
1181 memcpy(pathreal, dpath, pathlen);
1182 pathreal[pathlen] = '/';
1183 memcpy(pathreal + slashlen + pathlen, dname,
1184 talloc_get_size(dname));
1187 /* Create smb_fname with NULL stream_name. */
1188 smb_fname = (struct smb_filename) {
1189 .base_name = pathreal, .st = sbuf
1192 ok = mode_fn(ctx, private_data, &smb_fname, &mode);
1193 if (!ok) {
1194 TALLOC_FREE(dname);
1195 TALLOC_FREE(fname);
1196 TALLOC_FREE(pathreal);
1197 continue;
1200 if (!dir_check_ftype(mode, dirtype)) {
1201 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
1202 fname, (unsigned int)mode, (unsigned int)dirtype));
1203 TALLOC_FREE(dname);
1204 TALLOC_FREE(fname);
1205 TALLOC_FREE(pathreal);
1206 continue;
1209 if (ask_sharemode) {
1210 struct timespec write_time_ts;
1211 struct file_id fileid;
1213 fileid = vfs_file_id_from_sbuf(conn,
1214 &smb_fname.st);
1215 get_file_infos(fileid, 0, NULL, &write_time_ts);
1216 if (!null_timespec(write_time_ts)) {
1217 update_stat_ex_mtime(&smb_fname.st,
1218 write_time_ts);
1222 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1223 "fname=%s (%s)\n",
1224 mask, smb_fname_str_dbg(&smb_fname),
1225 dname, fname));
1227 DirCacheAdd(dirptr->dir_hnd, dname, cur_offset);
1229 TALLOC_FREE(dname);
1231 *_smb_fname = cp_smb_filename(ctx, &smb_fname);
1232 TALLOC_FREE(pathreal);
1233 if (*_smb_fname == NULL) {
1234 return false;
1236 *_fname = fname;
1237 *_mode = mode;
1238 *_prev_offset = prev_offset;
1240 return true;
1243 return false;
1246 /****************************************************************************
1247 Get an 8.3 directory entry.
1248 ****************************************************************************/
1250 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX *ctx,
1251 void *private_data,
1252 const char *dname,
1253 const char *mask,
1254 char **_fname)
1256 connection_struct *conn = (connection_struct *)private_data;
1258 if ((strcmp(mask,"*.*") == 0) ||
1259 mask_match_search(dname, mask, false) ||
1260 mangle_mask_match(conn, dname, mask)) {
1261 char mname[13];
1262 const char *fname;
1264 * Ensure we can push the original name as UCS2. If
1265 * not, then just don't return this name.
1267 NTSTATUS status;
1268 size_t ret_len = 0;
1269 size_t len = (strlen(dname) + 2) * 4; /* Allow enough space. */
1270 uint8_t *tmp = talloc_array(talloc_tos(),
1271 uint8_t,
1272 len);
1274 status = srvstr_push(NULL,
1275 FLAGS2_UNICODE_STRINGS,
1276 tmp,
1277 dname,
1278 len,
1279 STR_TERMINATE,
1280 &ret_len);
1282 TALLOC_FREE(tmp);
1284 if (!NT_STATUS_IS_OK(status)) {
1285 return false;
1288 if (!mangle_is_8_3(dname, false, conn->params)) {
1289 bool ok = name_to_8_3(dname, mname, false,
1290 conn->params);
1291 if (!ok) {
1292 return false;
1294 fname = mname;
1295 } else {
1296 fname = dname;
1299 *_fname = talloc_strdup(ctx, fname);
1300 if (*_fname == NULL) {
1301 return false;
1304 return true;
1307 return false;
1310 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX *ctx,
1311 void *private_data,
1312 struct smb_filename *smb_fname,
1313 uint32_t *_mode)
1315 connection_struct *conn = (connection_struct *)private_data;
1317 if (!VALID_STAT(smb_fname->st)) {
1318 if ((SMB_VFS_STAT(conn, smb_fname)) != 0) {
1319 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1320 "Couldn't stat [%s]. Error "
1321 "= %s\n",
1322 smb_fname_str_dbg(smb_fname),
1323 strerror(errno)));
1324 return false;
1328 *_mode = dos_mode(conn, smb_fname);
1329 return true;
1332 bool get_dir_entry(TALLOC_CTX *ctx,
1333 struct dptr_struct *dirptr,
1334 const char *mask,
1335 uint32_t dirtype,
1336 char **_fname,
1337 off_t *_size,
1338 uint32_t *_mode,
1339 struct timespec *_date,
1340 bool check_descend,
1341 bool ask_sharemode)
1343 connection_struct *conn = dirptr->conn;
1344 char *fname = NULL;
1345 struct smb_filename *smb_fname = NULL;
1346 uint32_t mode = 0;
1347 long prev_offset;
1348 bool ok;
1350 ok = smbd_dirptr_get_entry(ctx,
1351 dirptr,
1352 mask,
1353 dirtype,
1354 check_descend,
1355 ask_sharemode,
1356 smbd_dirptr_8_3_match_fn,
1357 smbd_dirptr_8_3_mode_fn,
1358 conn,
1359 &fname,
1360 &smb_fname,
1361 &mode,
1362 &prev_offset);
1363 if (!ok) {
1364 return false;
1367 *_fname = talloc_move(ctx, &fname);
1368 *_size = smb_fname->st.st_ex_size;
1369 *_mode = mode;
1370 *_date = smb_fname->st.st_ex_mtime;
1371 TALLOC_FREE(smb_fname);
1372 return true;
1375 /*******************************************************************
1376 Check to see if a user can read a file. This is only approximate,
1377 it is used as part of the "hide unreadable" option. Don't
1378 use it for anything security sensitive.
1379 ********************************************************************/
1381 static bool user_can_read_file(connection_struct *conn,
1382 struct smb_filename *smb_fname)
1384 NTSTATUS status;
1385 uint32_t rejected_share_access = 0;
1386 uint32_t rejected_mask = 0;
1387 struct security_descriptor *sd = NULL;
1388 uint32_t access_mask = FILE_READ_DATA|
1389 FILE_READ_EA|
1390 FILE_READ_ATTRIBUTES|
1391 SEC_STD_READ_CONTROL;
1394 * Never hide files from the root user.
1395 * We use (uid_t)0 here not sec_initial_uid()
1396 * as make test uses a single user context.
1399 if (get_current_uid(conn) == (uid_t)0) {
1400 return True;
1404 * We can't directly use smbd_check_access_rights()
1405 * here, as this implicitly grants FILE_READ_ATTRIBUTES
1406 * which the Windows access-based-enumeration code
1407 * explicitly checks for on the file security descriptor.
1408 * See bug:
1410 * https://bugzilla.samba.org/show_bug.cgi?id=10252
1412 * and the smb2.acl2.ACCESSBASED test for details.
1415 rejected_share_access = access_mask & ~(conn->share_access);
1416 if (rejected_share_access) {
1417 DEBUG(10, ("rejected share access 0x%x "
1418 "on %s (0x%x)\n",
1419 (unsigned int)access_mask,
1420 smb_fname_str_dbg(smb_fname),
1421 (unsigned int)rejected_share_access ));
1422 return false;
1425 status = SMB_VFS_GET_NT_ACL(conn,
1426 smb_fname,
1427 (SECINFO_OWNER |
1428 SECINFO_GROUP |
1429 SECINFO_DACL),
1430 talloc_tos(),
1431 &sd);
1433 if (!NT_STATUS_IS_OK(status)) {
1434 DEBUG(10, ("Could not get acl "
1435 "on %s: %s\n",
1436 smb_fname_str_dbg(smb_fname),
1437 nt_errstr(status)));
1438 return false;
1441 status = se_file_access_check(sd,
1442 get_current_nttok(conn),
1443 false,
1444 access_mask,
1445 &rejected_mask);
1447 TALLOC_FREE(sd);
1449 if (NT_STATUS_EQUAL(status, NT_STATUS_ACCESS_DENIED)) {
1450 DEBUG(10,("rejected bits 0x%x read access for %s\n",
1451 (unsigned int)rejected_mask,
1452 smb_fname_str_dbg(smb_fname) ));
1453 return false;
1455 return true;
1458 /*******************************************************************
1459 Check to see if a user can write a file (and only files, we do not
1460 check dirs on this one). This is only approximate,
1461 it is used as part of the "hide unwriteable" option. Don't
1462 use it for anything security sensitive.
1463 ********************************************************************/
1465 static bool user_can_write_file(connection_struct *conn,
1466 const struct smb_filename *smb_fname)
1469 * Never hide files from the root user.
1470 * We use (uid_t)0 here not sec_initial_uid()
1471 * as make test uses a single user context.
1474 if (get_current_uid(conn) == (uid_t)0) {
1475 return True;
1478 SMB_ASSERT(VALID_STAT(smb_fname->st));
1480 /* Pseudo-open the file */
1482 if(S_ISDIR(smb_fname->st.st_ex_mode)) {
1483 return True;
1486 return can_write_to_file(conn, smb_fname);
1489 /*******************************************************************
1490 Is a file a "special" type ?
1491 ********************************************************************/
1493 static bool file_is_special(connection_struct *conn,
1494 const struct smb_filename *smb_fname)
1497 * Never hide files from the root user.
1498 * We use (uid_t)0 here not sec_initial_uid()
1499 * as make test uses a single user context.
1502 if (get_current_uid(conn) == (uid_t)0) {
1503 return False;
1506 SMB_ASSERT(VALID_STAT(smb_fname->st));
1508 if (S_ISREG(smb_fname->st.st_ex_mode) ||
1509 S_ISDIR(smb_fname->st.st_ex_mode) ||
1510 S_ISLNK(smb_fname->st.st_ex_mode))
1511 return False;
1513 return True;
1516 /*******************************************************************
1517 Should the file be seen by the client?
1518 NOTE: A successful return is no guarantee of the file's existence.
1519 ********************************************************************/
1521 bool is_visible_file(connection_struct *conn, const char *dir_path,
1522 const char *name, SMB_STRUCT_STAT *pst, bool use_veto)
1524 bool hide_unreadable = lp_hide_unreadable(SNUM(conn));
1525 bool hide_unwriteable = lp_hide_unwriteable_files(SNUM(conn));
1526 bool hide_special = lp_hide_special_files(SNUM(conn));
1527 char *entry = NULL;
1528 struct smb_filename *smb_fname_base = NULL;
1529 bool ret = false;
1531 if ((strcmp(".",name) == 0) || (strcmp("..",name) == 0)) {
1532 return True; /* . and .. are always visible. */
1535 /* If it's a vetoed file, pretend it doesn't even exist */
1536 if (use_veto && IS_VETO_PATH(conn, name)) {
1537 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name ));
1538 return False;
1541 if (hide_unreadable || hide_unwriteable || hide_special) {
1542 entry = talloc_asprintf(talloc_tos(), "%s/%s", dir_path, name);
1543 if (!entry) {
1544 ret = false;
1545 goto out;
1548 /* Create an smb_filename with stream_name == NULL. */
1549 smb_fname_base = synthetic_smb_fname(talloc_tos(),
1550 entry,
1551 NULL,
1552 pst,
1554 if (smb_fname_base == NULL) {
1555 ret = false;
1556 goto out;
1559 /* If the file name does not exist, there's no point checking
1560 * the configuration options. We succeed, on the basis that the
1561 * checks *might* have passed if the file was present.
1563 if (!VALID_STAT(*pst)) {
1564 if (SMB_VFS_STAT(conn, smb_fname_base) != 0) {
1565 ret = true;
1566 goto out;
1568 *pst = smb_fname_base->st;
1571 /* Honour _hide unreadable_ option */
1572 if (hide_unreadable &&
1573 !user_can_read_file(conn, smb_fname_base)) {
1574 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1575 entry ));
1576 ret = false;
1577 goto out;
1579 /* Honour _hide unwriteable_ option */
1580 if (hide_unwriteable && !user_can_write_file(conn,
1581 smb_fname_base)) {
1582 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1583 entry ));
1584 ret = false;
1585 goto out;
1587 /* Honour _hide_special_ option */
1588 if (hide_special && file_is_special(conn, smb_fname_base)) {
1589 DEBUG(10,("is_visible_file: file %s is special.\n",
1590 entry ));
1591 ret = false;
1592 goto out;
1596 ret = true;
1597 out:
1598 TALLOC_FREE(smb_fname_base);
1599 TALLOC_FREE(entry);
1600 return ret;
1603 static int smb_Dir_destructor(struct smb_Dir *dirp)
1605 if (dirp->dir != NULL) {
1606 SMB_VFS_CLOSEDIR(dirp->conn,dirp->dir);
1607 if (dirp->fsp != NULL) {
1609 * The SMB_VFS_CLOSEDIR above
1610 * closes the underlying fd inside
1611 * dirp->fsp.
1613 dirp->fsp->fh->fd = -1;
1614 if (dirp->fsp->dptr != NULL) {
1615 SMB_ASSERT(dirp->fsp->dptr->dir_hnd == dirp);
1616 dirp->fsp->dptr->dir_hnd = NULL;
1618 dirp->fsp = NULL;
1621 if (dirp->conn->sconn && !dirp->conn->sconn->using_smb2) {
1622 dirp->conn->sconn->searches.dirhandles_open--;
1624 return 0;
1627 /*******************************************************************
1628 Open a directory.
1629 ********************************************************************/
1631 static struct smb_Dir *OpenDir_internal(TALLOC_CTX *mem_ctx,
1632 connection_struct *conn,
1633 const struct smb_filename *smb_dname,
1634 const char *mask,
1635 uint32_t attr)
1637 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1638 struct smbd_server_connection *sconn = conn->sconn;
1640 if (!dirp) {
1641 return NULL;
1644 dirp->dir = SMB_VFS_OPENDIR(conn, smb_dname, mask, attr);
1646 if (!dirp->dir) {
1647 DEBUG(5,("OpenDir: Can't open %s. %s\n",
1648 smb_dname->base_name,
1649 strerror(errno) ));
1650 goto fail;
1653 dirp->conn = conn;
1654 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1656 if (sconn && !sconn->using_smb2) {
1657 sconn->searches.dirhandles_open++;
1659 talloc_set_destructor(dirp, smb_Dir_destructor);
1661 return dirp;
1663 fail:
1664 TALLOC_FREE(dirp);
1665 return NULL;
1668 /****************************************************************************
1669 Open a directory handle by pathname, ensuring it's under the share path.
1670 ****************************************************************************/
1672 static struct smb_Dir *open_dir_safely(TALLOC_CTX *ctx,
1673 connection_struct *conn,
1674 const struct smb_filename *smb_dname,
1675 const char *wcard,
1676 uint32_t attr)
1678 struct smb_Dir *dir_hnd = NULL;
1679 struct smb_filename *smb_fname_cwd = NULL;
1680 struct smb_filename *saved_dir_fname = vfs_GetWd(ctx, conn);
1681 NTSTATUS status;
1683 if (saved_dir_fname == NULL) {
1684 return NULL;
1687 if (vfs_ChDir(conn, smb_dname) == -1) {
1688 goto out;
1691 smb_fname_cwd = synthetic_smb_fname(talloc_tos(),
1692 ".",
1693 NULL,
1694 NULL,
1695 smb_dname->flags);
1696 if (smb_fname_cwd == NULL) {
1697 goto out;
1701 * Now the directory is pinned, use
1702 * REALPATH to ensure we can access it.
1704 status = check_name(conn, smb_fname_cwd);
1705 if (!NT_STATUS_IS_OK(status)) {
1706 goto out;
1709 dir_hnd = OpenDir_internal(ctx,
1710 conn,
1711 smb_fname_cwd,
1712 wcard,
1713 attr);
1715 if (dir_hnd == NULL) {
1716 goto out;
1720 * OpenDir_internal only gets "." as the dir name.
1721 * Store the real dir name here.
1724 dir_hnd->dir_smb_fname = cp_smb_filename(dir_hnd, smb_dname);
1725 if (!dir_hnd->dir_smb_fname) {
1726 TALLOC_FREE(dir_hnd);
1727 errno = ENOMEM;
1730 out:
1732 vfs_ChDir(conn, saved_dir_fname);
1733 TALLOC_FREE(saved_dir_fname);
1734 return dir_hnd;
1737 struct smb_Dir *OpenDir(TALLOC_CTX *mem_ctx, connection_struct *conn,
1738 const struct smb_filename *smb_dname,
1739 const char *mask,
1740 uint32_t attr)
1742 return open_dir_safely(mem_ctx,
1743 conn,
1744 smb_dname,
1745 mask,
1746 attr);
1749 /*******************************************************************
1750 Open a directory from an fsp.
1751 ********************************************************************/
1753 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
1754 files_struct *fsp,
1755 const char *mask,
1756 uint32_t attr)
1758 struct smb_Dir *dirp = talloc_zero(mem_ctx, struct smb_Dir);
1759 struct smbd_server_connection *sconn = conn->sconn;
1761 if (!dirp) {
1762 goto fail;
1765 if (!fsp->is_directory) {
1766 errno = EBADF;
1767 goto fail;
1770 if (fsp->fh->fd == -1) {
1771 errno = EBADF;
1772 goto fail;
1775 dirp->conn = conn;
1776 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1778 dirp->dir_smb_fname = cp_smb_filename(dirp, fsp->fsp_name);
1779 if (!dirp->dir_smb_fname) {
1780 errno = ENOMEM;
1781 goto fail;
1784 dirp->dir = SMB_VFS_FDOPENDIR(fsp, mask, attr);
1785 if (dirp->dir != NULL) {
1786 dirp->fsp = fsp;
1787 } else {
1788 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1789 "NULL (%s)\n",
1790 dirp->dir_smb_fname->base_name,
1791 strerror(errno)));
1792 if (errno != ENOSYS) {
1793 goto fail;
1797 if (dirp->dir == NULL) {
1798 /* FDOPENDIR is not supported. Use OPENDIR instead. */
1799 TALLOC_FREE(dirp);
1800 return open_dir_safely(mem_ctx,
1801 conn,
1802 fsp->fsp_name,
1803 mask,
1804 attr);
1807 if (sconn && !sconn->using_smb2) {
1808 sconn->searches.dirhandles_open++;
1810 talloc_set_destructor(dirp, smb_Dir_destructor);
1812 return dirp;
1814 fail:
1815 TALLOC_FREE(dirp);
1816 return NULL;
1820 /*******************************************************************
1821 Read from a directory.
1822 Return directory entry, current offset, and optional stat information.
1823 Don't check for veto or invisible files.
1824 ********************************************************************/
1826 const char *ReadDirName(struct smb_Dir *dirp, long *poffset,
1827 SMB_STRUCT_STAT *sbuf, char **ptalloced)
1829 const char *n;
1830 char *talloced = NULL;
1831 connection_struct *conn = dirp->conn;
1833 /* Cheat to allow . and .. to be the first entries returned. */
1834 if (((*poffset == START_OF_DIRECTORY_OFFSET) ||
1835 (*poffset == DOT_DOT_DIRECTORY_OFFSET)) && (dirp->file_number < 2))
1837 if (dirp->file_number == 0) {
1838 n = ".";
1839 *poffset = dirp->offset = START_OF_DIRECTORY_OFFSET;
1840 } else {
1841 n = "..";
1842 *poffset = dirp->offset = DOT_DOT_DIRECTORY_OFFSET;
1844 dirp->file_number++;
1845 *ptalloced = NULL;
1846 return n;
1849 if (*poffset == END_OF_DIRECTORY_OFFSET) {
1850 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1851 return NULL;
1854 /* A real offset, seek to it. */
1855 SeekDir(dirp, *poffset);
1857 while ((n = vfs_readdirname(conn, dirp->dir, sbuf, &talloced))) {
1858 /* Ignore . and .. - we've already returned them. */
1859 if (*n == '.') {
1860 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
1861 TALLOC_FREE(talloced);
1862 continue;
1865 *poffset = dirp->offset = SMB_VFS_TELLDIR(conn, dirp->dir);
1866 *ptalloced = talloced;
1867 dirp->file_number++;
1868 return n;
1870 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1871 *ptalloced = NULL;
1872 return NULL;
1875 /*******************************************************************
1876 Rewind to the start.
1877 ********************************************************************/
1879 void RewindDir(struct smb_Dir *dirp, long *poffset)
1881 SMB_VFS_REWINDDIR(dirp->conn, dirp->dir);
1882 dirp->file_number = 0;
1883 dirp->offset = START_OF_DIRECTORY_OFFSET;
1884 *poffset = START_OF_DIRECTORY_OFFSET;
1887 /*******************************************************************
1888 Seek a dir.
1889 ********************************************************************/
1891 void SeekDir(struct smb_Dir *dirp, long offset)
1893 if (offset != dirp->offset) {
1894 if (offset == START_OF_DIRECTORY_OFFSET) {
1895 RewindDir(dirp, &offset);
1897 * Ok we should really set the file number here
1898 * to 1 to enable ".." to be returned next. Trouble
1899 * is I'm worried about callers using SeekDir(dirp,0)
1900 * as equivalent to RewindDir(). So leave this alone
1901 * for now.
1903 } else if (offset == DOT_DOT_DIRECTORY_OFFSET) {
1904 RewindDir(dirp, &offset);
1906 * Set the file number to 2 - we want to get the first
1907 * real file entry (the one we return after "..")
1908 * on the next ReadDir.
1910 dirp->file_number = 2;
1911 } else if (offset == END_OF_DIRECTORY_OFFSET) {
1912 ; /* Don't seek in this case. */
1913 } else {
1914 SMB_VFS_SEEKDIR(dirp->conn, dirp->dir, offset);
1916 dirp->offset = offset;
1920 /*******************************************************************
1921 Tell a dir position.
1922 ********************************************************************/
1924 long TellDir(struct smb_Dir *dirp)
1926 return(dirp->offset);
1929 /*******************************************************************
1930 Add an entry into the dcache.
1931 ********************************************************************/
1933 static void DirCacheAdd(struct smb_Dir *dirp, const char *name, long offset)
1935 struct name_cache_entry *e;
1937 if (dirp->name_cache_size == 0) {
1938 return;
1941 if (dirp->name_cache == NULL) {
1942 dirp->name_cache = talloc_zero_array(
1943 dirp, struct name_cache_entry, dirp->name_cache_size);
1945 if (dirp->name_cache == NULL) {
1946 return;
1950 dirp->name_cache_index = (dirp->name_cache_index+1) %
1951 dirp->name_cache_size;
1952 e = &dirp->name_cache[dirp->name_cache_index];
1953 TALLOC_FREE(e->name);
1954 e->name = talloc_strdup(dirp, name);
1955 e->offset = offset;
1958 /*******************************************************************
1959 Find an entry by name. Leave us at the offset after it.
1960 Don't check for veto or invisible files.
1961 ********************************************************************/
1963 bool SearchDir(struct smb_Dir *dirp, const char *name, long *poffset)
1965 int i;
1966 const char *entry = NULL;
1967 char *talloced = NULL;
1968 connection_struct *conn = dirp->conn;
1970 /* Search back in the name cache. */
1971 if (dirp->name_cache_size && dirp->name_cache) {
1972 for (i = dirp->name_cache_index; i >= 0; i--) {
1973 struct name_cache_entry *e = &dirp->name_cache[i];
1974 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1975 *poffset = e->offset;
1976 SeekDir(dirp, e->offset);
1977 return True;
1980 for (i = dirp->name_cache_size - 1; i > dirp->name_cache_index; i--) {
1981 struct name_cache_entry *e = &dirp->name_cache[i];
1982 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1983 *poffset = e->offset;
1984 SeekDir(dirp, e->offset);
1985 return True;
1990 /* Not found in the name cache. Rewind directory and start from scratch. */
1991 SMB_VFS_REWINDDIR(conn, dirp->dir);
1992 dirp->file_number = 0;
1993 *poffset = START_OF_DIRECTORY_OFFSET;
1994 while ((entry = ReadDirName(dirp, poffset, NULL, &talloced))) {
1995 if (conn->case_sensitive ? (strcmp(entry, name) == 0) : strequal(entry, name)) {
1996 TALLOC_FREE(talloced);
1997 return True;
1999 TALLOC_FREE(talloced);
2001 return False;
2004 struct files_below_forall_state {
2005 char *dirpath;
2006 size_t dirpath_len;
2007 int (*fn)(struct file_id fid, const struct share_mode_data *data,
2008 void *private_data);
2009 void *private_data;
2012 static int files_below_forall_fn(struct file_id fid,
2013 const struct share_mode_data *data,
2014 void *private_data)
2016 struct files_below_forall_state *state = private_data;
2017 char tmpbuf[PATH_MAX];
2018 char *fullpath, *to_free;
2019 size_t len;
2021 len = full_path_tos(data->servicepath, data->base_name,
2022 tmpbuf, sizeof(tmpbuf),
2023 &fullpath, &to_free);
2024 if (len == -1) {
2025 return 0;
2027 if (state->dirpath_len >= len) {
2029 * Filter files above dirpath
2031 return 0;
2033 if (fullpath[state->dirpath_len] != '/') {
2035 * Filter file that don't have a path separator at the end of
2036 * dirpath's length
2038 return 0;
2041 if (memcmp(state->dirpath, fullpath, state->dirpath_len) != 0) {
2043 * Not a parent
2045 return 0;
2048 return state->fn(fid, data, state->private_data);
2051 static int files_below_forall(connection_struct *conn,
2052 const struct smb_filename *dir_name,
2053 int (*fn)(struct file_id fid,
2054 const struct share_mode_data *data,
2055 void *private_data),
2056 void *private_data)
2058 struct files_below_forall_state state = {
2059 .fn = fn,
2060 .private_data = private_data,
2062 int ret;
2063 char tmpbuf[PATH_MAX];
2064 char *to_free;
2066 state.dirpath_len = full_path_tos(conn->connectpath,
2067 dir_name->base_name,
2068 tmpbuf, sizeof(tmpbuf),
2069 &state.dirpath, &to_free);
2070 if (state.dirpath_len == -1) {
2071 return -1;
2074 ret = share_mode_forall(files_below_forall_fn, &state);
2075 TALLOC_FREE(to_free);
2076 return ret;
2079 struct have_file_open_below_state {
2080 bool found_one;
2083 static int have_file_open_below_fn(struct file_id fid,
2084 const struct share_mode_data *data,
2085 void *private_data)
2087 struct have_file_open_below_state *state = private_data;
2088 state->found_one = true;
2089 return 1;
2092 bool have_file_open_below(connection_struct *conn,
2093 const struct smb_filename *name)
2095 struct have_file_open_below_state state = {
2096 .found_one = false,
2098 int ret;
2100 if (!VALID_STAT(name->st)) {
2101 return false;
2103 if (!S_ISDIR(name->st.st_ex_mode)) {
2104 return false;
2107 ret = files_below_forall(conn, name, have_file_open_below_fn, &state);
2108 if (ret == -1) {
2109 return false;
2112 return state.found_one;
2115 /*****************************************************************
2116 Is this directory empty ?
2117 *****************************************************************/
2119 NTSTATUS can_delete_directory_fsp(files_struct *fsp)
2121 NTSTATUS status = NT_STATUS_OK;
2122 long dirpos = 0;
2123 const char *dname = NULL;
2124 const char *dirname = fsp->fsp_name->base_name;
2125 char *talloced = NULL;
2126 SMB_STRUCT_STAT st;
2127 struct connection_struct *conn = fsp->conn;
2128 struct smb_Dir *dir_hnd = OpenDir(talloc_tos(),
2129 conn,
2130 fsp->fsp_name,
2131 NULL,
2134 if (!dir_hnd) {
2135 return map_nt_error_from_unix(errno);
2138 while ((dname = ReadDirName(dir_hnd, &dirpos, &st, &talloced))) {
2139 /* Quick check for "." and ".." */
2140 if (dname[0] == '.') {
2141 if (!dname[1] || (dname[1] == '.' && !dname[2])) {
2142 TALLOC_FREE(talloced);
2143 continue;
2147 if (!is_visible_file(conn, dirname, dname, &st, True)) {
2148 TALLOC_FREE(talloced);
2149 continue;
2152 DEBUG(10,("got name %s - can't delete\n",
2153 dname ));
2154 status = NT_STATUS_DIRECTORY_NOT_EMPTY;
2155 break;
2157 TALLOC_FREE(talloced);
2158 TALLOC_FREE(dir_hnd);
2160 if (!NT_STATUS_IS_OK(status)) {
2161 return status;
2164 if (!(fsp->posix_flags & FSP_POSIX_FLAGS_RENAME) &&
2165 lp_strict_rename(SNUM(conn)) &&
2166 have_file_open_below(fsp->conn, fsp->fsp_name))
2168 return NT_STATUS_ACCESS_DENIED;
2171 return NT_STATUS_OK;