CVE-2022-2031 tests/krb5: Allow requesting a TGT to a different sname and realm
[Samba.git] / source3 / modules / vfs_recycle.c
blobb794ebc2d8c17ea0387211cf1f34d30d3d27e614
1 /*
2 * Recycle bin VFS module for Samba.
4 * Copyright (C) 2001, Brandon Stone, Amherst College, <bbstone@amherst.edu>.
5 * Copyright (C) 2002, Jeremy Allison - modified to make a VFS module.
6 * Copyright (C) 2002, Alexander Bokovoy - cascaded VFS adoption,
7 * Copyright (C) 2002, Juergen Hasch - added some options.
8 * Copyright (C) 2002, Simo Sorce
9 * Copyright (C) 2002, Stefan (metze) Metzmacher
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <http://www.gnu.org/licenses/>.
25 #include "includes.h"
26 #include "smbd/smbd.h"
27 #include "system/filesys.h"
28 #include "../librpc/gen_ndr/ndr_netlogon.h"
29 #include "auth.h"
30 #include "source3/lib/substitute.h"
32 #define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
34 static int vfs_recycle_debug_level = DBGC_VFS;
36 #undef DBGC_CLASS
37 #define DBGC_CLASS vfs_recycle_debug_level
39 static const char *recycle_repository(vfs_handle_struct *handle)
41 const char *tmp_str = NULL;
43 tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");
45 DEBUG(10, ("recycle: repository = %s\n", tmp_str));
47 return tmp_str;
50 static bool recycle_keep_dir_tree(vfs_handle_struct *handle)
52 bool ret;
54 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
56 DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
58 return ret;
61 static bool recycle_versions(vfs_handle_struct *handle)
63 bool ret;
65 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
67 DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
69 return ret;
72 static bool recycle_touch(vfs_handle_struct *handle)
74 bool ret;
76 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
78 DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
80 return ret;
83 static bool recycle_touch_mtime(vfs_handle_struct *handle)
85 bool ret;
87 ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
89 DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
91 return ret;
94 static const char **recycle_exclude(vfs_handle_struct *handle)
96 const char **tmp_lp;
98 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
100 DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
102 return tmp_lp;
105 static const char **recycle_exclude_dir(vfs_handle_struct *handle)
107 const char **tmp_lp;
109 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);
111 DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
113 return tmp_lp;
116 static const char **recycle_noversions(vfs_handle_struct *handle)
118 const char **tmp_lp;
120 tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
122 DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
124 return tmp_lp;
127 static off_t recycle_maxsize(vfs_handle_struct *handle)
129 off_t maxsize;
131 maxsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
132 "recycle", "maxsize", NULL));
134 DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)maxsize));
136 return maxsize;
139 static off_t recycle_minsize(vfs_handle_struct *handle)
141 off_t minsize;
143 minsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
144 "recycle", "minsize", NULL));
146 DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize));
148 return minsize;
151 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
153 int dirmode;
154 const char *buff;
156 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
158 if (buff != NULL ) {
159 sscanf(buff, "%o", &dirmode);
160 } else {
161 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
164 DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
165 return (mode_t)dirmode;
168 static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
170 int dirmode;
171 const char *buff;
173 buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
175 if (buff != NULL ) {
176 sscanf(buff, "%o", &dirmode);
177 } else {
178 dirmode=recycle_directory_mode(handle);
181 DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
182 return (mode_t)dirmode;
185 static bool recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
187 struct smb_filename smb_fname = {
188 .base_name = discard_const_p(char, dname)
191 if (SMB_VFS_STAT(handle->conn, &smb_fname) == 0) {
192 if (S_ISDIR(smb_fname.st.st_ex_mode)) {
193 return True;
197 return False;
200 static bool recycle_file_exist(vfs_handle_struct *handle,
201 const struct smb_filename *smb_fname)
203 struct smb_filename *smb_fname_tmp = NULL;
204 bool ret = false;
206 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
207 if (smb_fname_tmp == NULL) {
208 return false;
211 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) == 0) {
212 if (S_ISREG(smb_fname_tmp->st.st_ex_mode)) {
213 ret = true;
217 TALLOC_FREE(smb_fname_tmp);
218 return ret;
222 * Return file size
223 * @param conn connection
224 * @param fname file name
225 * @return size in bytes
227 static off_t recycle_get_file_size(vfs_handle_struct *handle,
228 const struct smb_filename *smb_fname)
230 struct smb_filename *smb_fname_tmp = NULL;
231 off_t size;
233 smb_fname_tmp = cp_smb_filename(talloc_tos(), smb_fname);
234 if (smb_fname_tmp == NULL) {
235 size = (off_t)0;
236 goto out;
239 if (SMB_VFS_STAT(handle->conn, smb_fname_tmp) != 0) {
240 DBG_DEBUG("stat for %s returned %s\n",
241 smb_fname_str_dbg(smb_fname_tmp), strerror(errno));
242 size = (off_t)0;
243 goto out;
246 size = smb_fname_tmp->st.st_ex_size;
247 out:
248 TALLOC_FREE(smb_fname_tmp);
249 return size;
253 * Create directory tree
254 * @param conn connection
255 * @param dname Directory tree to be created
256 * @return Returns True for success
258 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
260 size_t len;
261 mode_t mode;
262 char *new_dir = NULL;
263 char *tmp_str = NULL;
264 char *token;
265 char *tok_str;
266 bool ret = False;
267 char *saveptr;
269 mode = recycle_directory_mode(handle);
271 tmp_str = SMB_STRDUP(dname);
272 ALLOC_CHECK(tmp_str, done);
273 tok_str = tmp_str;
275 len = strlen(dname)+1;
276 new_dir = (char *)SMB_MALLOC(len + 1);
277 ALLOC_CHECK(new_dir, done);
278 *new_dir = '\0';
279 if (dname[0] == '/') {
280 /* Absolute path. */
281 if (strlcat(new_dir,"/",len+1) >= len+1) {
282 goto done;
286 /* Create directory tree if necessary */
287 for(token = strtok_r(tok_str, "/", &saveptr); token;
288 token = strtok_r(NULL, "/", &saveptr)) {
289 if (strlcat(new_dir, token, len+1) >= len+1) {
290 goto done;
292 if (recycle_directory_exist(handle, new_dir))
293 DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
294 else {
295 struct smb_filename *smb_fname = NULL;
296 int retval;
298 DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
300 smb_fname = synthetic_smb_fname(talloc_tos(),
301 new_dir,
302 NULL,
303 NULL,
306 if (smb_fname == NULL) {
307 goto done;
310 retval = SMB_VFS_NEXT_MKDIRAT(handle,
311 handle->conn->cwd_fsp,
312 smb_fname,
313 mode);
314 if (retval != 0) {
315 DBG_WARNING("recycle: mkdirat failed "
316 "for %s with error: %s\n",
317 new_dir,
318 strerror(errno));
319 TALLOC_FREE(smb_fname);
320 ret = False;
321 goto done;
323 TALLOC_FREE(smb_fname);
325 if (strlcat(new_dir, "/", len+1) >= len+1) {
326 goto done;
328 mode = recycle_subdir_mode(handle);
331 ret = True;
332 done:
333 SAFE_FREE(tmp_str);
334 SAFE_FREE(new_dir);
335 return ret;
339 * Check if any of the components of "exclude_list" are contained in path.
340 * Return True if found
343 static bool matchdirparam(const char **dir_exclude_list, char *path)
345 char *startp = NULL, *endp = NULL;
347 if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
348 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
349 return False;
353 * Walk the components of path, looking for matches with the
354 * exclude list on each component.
357 for (startp = path; startp; startp = endp) {
358 int i;
360 while (*startp == '/') {
361 startp++;
363 endp = strchr(startp, '/');
364 if (endp) {
365 *endp = '\0';
368 for(i=0; dir_exclude_list[i] ; i++) {
369 if(unix_wild_match(dir_exclude_list[i], startp)) {
370 /* Repair path. */
371 if (endp) {
372 *endp = '/';
374 return True;
378 /* Repair path. */
379 if (endp) {
380 *endp = '/';
384 return False;
388 * Check if needle is contained in haystack, * and ? patterns are resolved
389 * @param haystack list of parameters separated by delimimiter character
390 * @param needle string to be matched exectly to haystack including pattern matching
391 * @return True if found
393 static bool matchparam(const char **haystack_list, const char *needle)
395 int i;
397 if (haystack_list == NULL || haystack_list[0] == NULL ||
398 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
399 return False;
402 for(i=0; haystack_list[i] ; i++) {
403 if(unix_wild_match(haystack_list[i], needle)) {
404 return True;
408 return False;
412 * Touch access or modify date
414 static void recycle_do_touch(vfs_handle_struct *handle,
415 const struct smb_filename *smb_fname,
416 bool touch_mtime)
418 struct smb_filename *smb_fname_tmp = NULL;
419 struct smb_file_time ft;
420 int ret, err;
421 NTSTATUS status;
423 init_smb_file_time(&ft);
425 status = synthetic_pathref(talloc_tos(),
426 handle->conn->cwd_fsp,
427 smb_fname->base_name,
428 smb_fname->stream_name,
429 NULL,
430 smb_fname->twrp,
431 smb_fname->flags,
432 &smb_fname_tmp);
433 if (!NT_STATUS_IS_OK(status)) {
434 DBG_DEBUG("synthetic_pathref for '%s' failed: %s\n",
435 smb_fname_str_dbg(smb_fname), nt_errstr(status));
436 return;
439 /* atime */
440 ft.atime = timespec_current();
441 /* mtime */
442 ft.mtime = touch_mtime ? ft.atime : smb_fname_tmp->st.st_ex_mtime;
444 become_root();
445 ret = SMB_VFS_NEXT_FNTIMES(handle, smb_fname_tmp->fsp, &ft);
446 err = errno;
447 unbecome_root();
448 if (ret == -1 ) {
449 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
450 smb_fname_str_dbg(smb_fname_tmp), strerror(err)));
453 TALLOC_FREE(smb_fname_tmp);
457 * Check if file should be recycled
459 static int recycle_unlink_internal(vfs_handle_struct *handle,
460 struct files_struct *dirfsp,
461 const struct smb_filename *smb_fname,
462 int flags)
464 const struct loadparm_substitution *lp_sub =
465 loadparm_s3_global_substitution();
466 connection_struct *conn = handle->conn;
467 struct smb_filename *full_fname = NULL;
468 char *path_name = NULL;
469 char *temp_name = NULL;
470 char *final_name = NULL;
471 struct smb_filename *smb_fname_final = NULL;
472 const char *base;
473 char *repository = NULL;
474 int i = 1;
475 off_t maxsize, minsize;
476 off_t file_size; /* space_avail; */
477 bool exist;
478 int rc = -1;
480 repository = talloc_sub_full(NULL, lp_servicename(talloc_tos(), lp_sub, SNUM(conn)),
481 conn->session_info->unix_info->unix_name,
482 conn->connectpath,
483 conn->session_info->unix_token->gid,
484 conn->session_info->unix_info->sanitized_username,
485 conn->session_info->info->domain_name,
486 recycle_repository(handle));
487 ALLOC_CHECK(repository, done);
488 /* shouldn't we allow absolute path names here? --metze */
489 /* Yes :-). JRA. */
490 trim_char(repository, '\0', '/');
492 if(!repository || *(repository) == '\0') {
493 DEBUG(3, ("recycle: repository path not set, purging %s...\n",
494 smb_fname_str_dbg(smb_fname)));
495 rc = SMB_VFS_NEXT_UNLINKAT(handle,
496 dirfsp,
497 smb_fname,
498 flags);
499 goto done;
502 full_fname = full_path_from_dirfsp_atname(talloc_tos(),
503 dirfsp,
504 smb_fname);
505 if (full_fname == NULL) {
506 return -1;
509 /* we don't recycle the recycle bin... */
510 if (strncmp(full_fname->base_name, repository,
511 strlen(repository)) == 0) {
512 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
513 rc = SMB_VFS_NEXT_UNLINKAT(handle,
514 dirfsp,
515 smb_fname,
516 flags);
517 goto done;
520 file_size = recycle_get_file_size(handle, full_fname);
521 /* it is wrong to purge filenames only because they are empty imho
522 * --- simo
524 if(fsize == 0) {
525 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
526 rc = SMB_VFS_NEXT_UNLINKAT(handle,
527 dirfsp,
528 file_name,
529 flags);
530 goto done;
534 /* FIXME: this is wrong, we should check the whole size of the recycle bin is
535 * not greater then maxsize, not the size of the single file, also it is better
536 * to remove older files
538 maxsize = recycle_maxsize(handle);
539 if(maxsize > 0 && file_size > maxsize) {
540 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, "
541 "purging... \n", smb_fname_str_dbg(full_fname)));
542 rc = SMB_VFS_NEXT_UNLINKAT(handle,
543 dirfsp,
544 smb_fname,
545 flags);
546 goto done;
548 minsize = recycle_minsize(handle);
549 if(minsize > 0 && file_size < minsize) {
550 DEBUG(3, ("recycle: File %s lowers minimum recycle size, "
551 "purging... \n", smb_fname_str_dbg(full_fname)));
552 rc = SMB_VFS_NEXT_UNLINKAT(handle,
553 dirfsp,
554 smb_fname,
555 flags);
556 goto done;
559 /* FIXME: this is wrong: moving files with rename does not change the disk space
560 * allocation
562 space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
563 DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
564 if(space_avail < file_size) {
565 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
566 rc = SMB_VFS_NEXT_UNLINKAT(handle,
567 dirfsp,
568 file_name,
569 flags);
570 goto done;
574 /* extract filename and path */
575 if (!parent_dirname(talloc_tos(), full_fname->base_name, &path_name, &base)) {
576 rc = -1;
577 errno = ENOMEM;
578 goto done;
581 /* original filename with path */
582 DEBUG(10, ("recycle: fname = %s\n", smb_fname_str_dbg(full_fname)));
583 /* original path */
584 DEBUG(10, ("recycle: fpath = %s\n", path_name));
585 /* filename without path */
586 DEBUG(10, ("recycle: base = %s\n", base));
588 if (matchparam(recycle_exclude(handle), base)) {
589 DEBUG(3, ("recycle: file %s is excluded \n", base));
590 rc = SMB_VFS_NEXT_UNLINKAT(handle,
591 dirfsp,
592 smb_fname,
593 flags);
594 goto done;
597 if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
598 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
599 rc = SMB_VFS_NEXT_UNLINKAT(handle,
600 dirfsp,
601 smb_fname,
602 flags);
603 goto done;
606 if (recycle_keep_dir_tree(handle) == True) {
607 if (asprintf(&temp_name, "%s/%s", repository, path_name) == -1) {
608 ALLOC_CHECK(temp_name, done);
610 } else {
611 temp_name = SMB_STRDUP(repository);
613 ALLOC_CHECK(temp_name, done);
615 exist = recycle_directory_exist(handle, temp_name);
616 if (exist) {
617 DEBUG(10, ("recycle: Directory already exists\n"));
618 } else {
619 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
620 if (recycle_create_dir(handle, temp_name) == False) {
621 DEBUG(3, ("recycle: Could not create directory, "
622 "purging %s...\n",
623 smb_fname_str_dbg(full_fname)));
624 rc = SMB_VFS_NEXT_UNLINKAT(handle,
625 dirfsp,
626 smb_fname,
627 flags);
628 goto done;
632 if (asprintf(&final_name, "%s/%s", temp_name, base) == -1) {
633 ALLOC_CHECK(final_name, done);
636 /* Create smb_fname with final base name and orig stream name. */
637 smb_fname_final = synthetic_smb_fname(talloc_tos(),
638 final_name,
639 full_fname->stream_name,
640 NULL,
641 full_fname->twrp,
642 full_fname->flags);
643 if (smb_fname_final == NULL) {
644 rc = SMB_VFS_NEXT_UNLINKAT(handle,
645 dirfsp,
646 smb_fname,
647 flags);
648 goto done;
651 /* new filename with path */
652 DEBUG(10, ("recycle: recycled file name: %s\n",
653 smb_fname_str_dbg(smb_fname_final)));
655 /* check if we should delete file from recycle bin */
656 if (recycle_file_exist(handle, smb_fname_final)) {
657 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
658 DEBUG(3, ("recycle: Removing old file %s from recycle "
659 "bin\n", smb_fname_str_dbg(smb_fname_final)));
660 if (SMB_VFS_NEXT_UNLINKAT(handle,
661 dirfsp->conn->cwd_fsp,
662 smb_fname_final,
663 flags) != 0) {
664 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
669 /* rename file we move to recycle bin */
670 i = 1;
671 while (recycle_file_exist(handle, smb_fname_final)) {
672 SAFE_FREE(final_name);
673 if (asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base) == -1) {
674 ALLOC_CHECK(final_name, done);
676 TALLOC_FREE(smb_fname_final->base_name);
677 smb_fname_final->base_name = talloc_strdup(smb_fname_final,
678 final_name);
679 if (smb_fname_final->base_name == NULL) {
680 rc = SMB_VFS_NEXT_UNLINKAT(handle,
681 dirfsp,
682 smb_fname,
683 flags);
684 goto done;
688 DEBUG(10, ("recycle: Moving %s to %s\n", smb_fname_str_dbg(full_fname),
689 smb_fname_str_dbg(smb_fname_final)));
690 rc = SMB_VFS_NEXT_RENAMEAT(handle,
691 dirfsp,
692 smb_fname,
693 handle->conn->cwd_fsp,
694 smb_fname_final);
695 if (rc != 0) {
696 DEBUG(3, ("recycle: Move error %d (%s), purging file %s "
697 "(%s)\n", errno, strerror(errno),
698 smb_fname_str_dbg(full_fname),
699 smb_fname_str_dbg(smb_fname_final)));
700 rc = SMB_VFS_NEXT_UNLINKAT(handle,
701 dirfsp,
702 smb_fname,
703 flags);
704 goto done;
707 /* touch access date of moved file */
708 if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
709 recycle_do_touch(handle, smb_fname_final,
710 recycle_touch_mtime(handle));
712 done:
713 TALLOC_FREE(path_name);
714 SAFE_FREE(temp_name);
715 SAFE_FREE(final_name);
716 TALLOC_FREE(full_fname);
717 TALLOC_FREE(smb_fname_final);
718 TALLOC_FREE(repository);
719 return rc;
722 static int recycle_unlinkat(vfs_handle_struct *handle,
723 struct files_struct *dirfsp,
724 const struct smb_filename *smb_fname,
725 int flags)
727 int ret;
729 if (flags & AT_REMOVEDIR) {
730 ret = SMB_VFS_NEXT_UNLINKAT(handle,
731 dirfsp,
732 smb_fname,
733 flags);
734 } else {
735 ret = recycle_unlink_internal(handle,
736 dirfsp,
737 smb_fname,
738 flags);
740 return ret;
743 static struct vfs_fn_pointers vfs_recycle_fns = {
744 .unlinkat_fn = recycle_unlinkat
747 static_decl_vfs;
748 NTSTATUS vfs_recycle_init(TALLOC_CTX *ctx)
750 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle",
751 &vfs_recycle_fns);
753 if (!NT_STATUS_IS_OK(ret))
754 return ret;
756 vfs_recycle_debug_level = debug_add_class("recycle");
757 if (vfs_recycle_debug_level == -1) {
758 vfs_recycle_debug_level = DBGC_VFS;
759 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
760 } else {
761 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
764 return ret;