2 * scannedonly VFS module for Samba 3.5
4 * Copyright 2007,2008,2009,2010 (C) Olivier Sessink
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 * scannedonly implements a 'filter' like vfs module that talks over a
23 * unix domain socket or over UDP to a anti-virus engine.
25 * files that are clean have a corresponding .scanned:{filename} file
26 * in the same directory. So why the .scanned: files? They take up
27 * only an inode, because they are 0 bytes. To test if the file is
28 * scanned only a stat() call on the filesystem is needed which is
29 * very quick compared to a database lookup. All modern filesystems
30 * use database technology such as balanced trees for lookups anyway.
31 * The number of inodes in modern filesystems is also not limiting
32 * anymore. The .scanned: files are also easy scriptable. You can
33 * remove them with a simple find command or create them with a
34 * simple touch command. Extended filesystem attributes have similar
35 * properties, but are not supported on all filesystems, so that
36 * would limit the usage of the module (and attributes are not as
39 * files that are not clean are sent to the AV-engine. Only the
40 * filename is sent over the socket. The protocol is very simple:
41 * a newline separated list of filenames inside each datagram.
43 * a file AV-scan may be requested multiple times, the AV-engine
44 * should also check if the file has been scanned already. Requests
45 * can also be dropped by the AV-engine (and we thus don't need the
46 * reliability of TCP).
54 #define SENDBUFFERSIZE 1450
57 #define SUN_LEN(sunp) ((size_t)((struct sockaddr_un *)0)->sun_path \
58 + strlen((sunp)->sun_path))
66 int scanning_message_len
;
67 int recheck_time_open
;
68 int recheck_tries_open
;
69 int recheck_size_open
;
70 int recheck_time_readdir
;
71 int recheck_tries_readdir
;
72 bool show_special_files
;
73 bool rm_hidden_files_on_rmdir
;
74 bool hide_nonscanned_files
;
75 bool allow_nonscanned_files
;
78 char *scanning_message
;
79 char *p_scanned
; /* prefix for scanned files */
80 char *p_virus
; /* prefix for virus containing files */
81 char *p_failed
; /* prefix for failed to scan files */
82 char gsendbuffer
[SENDBUFFERSIZE
+ 1];
85 #define STRUCTSCANO(var) ((struct Tscannedonly *)var)
87 struct scannedonly_DIR
{
92 #define SCANNEDONLY_DEBUG 9
93 /*********************/
94 /* utility functions */
95 /*********************/
97 static char *real_path_from_notify_path(TALLOC_CTX
*ctx
,
98 struct Tscannedonly
*so
,
104 name
= strrchr(path
, '/');
108 pathlen
= name
- path
;
111 if (len
<= so
->scanning_message_len
) {
115 if (strcmp(name
+ (len
- so
->scanning_message_len
),
116 so
->scanning_message
) != 0) {
120 return talloc_strndup(ctx
,path
,
121 pathlen
+ len
- so
->scanning_message_len
);
124 static char *cachefile_name(TALLOC_CTX
*ctx
,
125 const char *shortname
,
127 const char *p_scanned
)
129 return talloc_asprintf(ctx
, "%s%s%s", base
, p_scanned
, shortname
);
132 static char *name_w_ending_slash(TALLOC_CTX
*ctx
, const char *name
)
134 int len
= strlen(name
);
135 if (name
[len
- 1] == '/') {
136 return talloc_strdup(ctx
,name
);
138 return talloc_asprintf(ctx
, "%s/", name
);
142 static char *cachefile_name_f_fullpath(TALLOC_CTX
*ctx
,
143 const char *fullpath
,
144 const char *p_scanned
)
147 char *tmp
, *cachefile
, *shortname
;
148 tmp
= strrchr(fullpath
, '/');
150 base
= talloc_strndup(ctx
, fullpath
, (tmp
- fullpath
) + 1);
154 shortname
= (char *)fullpath
;
156 cachefile
= cachefile_name(ctx
, shortname
, base
, p_scanned
);
157 DEBUG(SCANNEDONLY_DEBUG
,
158 ("cachefile_name_f_fullpath cachefile=%s\n", cachefile
));
162 static char *construct_full_path(TALLOC_CTX
*ctx
, vfs_handle_struct
* handle
,
163 const char *somepath
, bool ending_slash
)
170 if (somepath
[0] == '/') {
172 return name_w_ending_slash(ctx
,somepath
);
174 return talloc_strdup(ctx
,somepath
);
176 tmp
=(char *)somepath
;
177 if (tmp
[0]=='.'&&tmp
[1]=='/') {
180 /* vfs_GetWd() seems to return a path with a slash */
182 return talloc_asprintf(ctx
, "%s/%s/",
183 vfs_GetWd(ctx
, handle
->conn
),tmp
);
185 return talloc_asprintf(ctx
, "%s/%s",
186 vfs_GetWd(ctx
, handle
->conn
),tmp
);
189 static int connect_to_scanner(vfs_handle_struct
* handle
)
191 struct Tscannedonly
*so
= (struct Tscannedonly
*)handle
->data
;
193 if (so
->domain_socket
) {
194 struct sockaddr_un saun
;
195 DEBUG(SCANNEDONLY_DEBUG
, ("socket=%s\n", so
->socketname
));
196 if ((so
->socket
= socket(AF_UNIX
, SOCK_DGRAM
, 0)) < 0) {
197 DEBUG(2, ("failed to create socket %s\n",
201 saun
.sun_family
= AF_UNIX
;
202 strncpy(saun
.sun_path
, so
->socketname
,
203 sizeof(saun
.sun_path
) - 1);
204 if (connect(so
->socket
, (struct sockaddr
*)(void *)&saun
,
205 SUN_LEN(&saun
)) < 0) {
206 DEBUG(2, ("failed to connect to socket %s\n",
210 DEBUG(SCANNEDONLY_DEBUG
,("bound %s to socket %d\n",
211 saun
.sun_path
, so
->socket
));
214 so
->socket
= open_udp_socket(so
->scanhost
, so
->portnum
);
215 if (so
->socket
< 0) {
216 DEBUG(2,("failed to open UDP socket to %s:%d\n",
217 so
->scanhost
,so
->portnum
));
222 {/* increasing the socket buffer is done because we have large bursts
223 of UDP packets or DGRAM's on a domain socket whenever we hit a
224 large directory with lots of unscanned files. */
226 socklen_t size
= sizeof(int);
227 getsockopt(so
->socket
, SOL_SOCKET
, SO_RCVBUF
,
228 (char *)&sndsize
, &size
);
229 DEBUG(SCANNEDONLY_DEBUG
, ("current socket buffer size=%d\n",
232 if (setsockopt(so
->socket
, SOL_SOCKET
, SO_RCVBUF
,
234 (int)sizeof(sndsize
)) != 0) {
235 DEBUG(SCANNEDONLY_DEBUG
,
236 ("error setting socket buffer %s (%d)\n",
237 strerror(errno
), errno
));
240 set_blocking(so
->socket
, false);
244 static void flush_sendbuffer(vfs_handle_struct
* handle
)
246 struct Tscannedonly
*so
= (struct Tscannedonly
*)handle
->data
;
247 int ret
, len
, loop
= 10;
248 if (so
->gsendbuffer
[0] == '\0') {
254 len
= strlen(so
->gsendbuffer
);
255 ret
= send(so
->socket
, so
->gsendbuffer
, len
, 0);
257 so
->gsendbuffer
[0] = '\0';
261 DEBUG(3,("scannedonly flush_sendbuffer: "
262 "error sending on socket %d to scanner:"
264 so
->socket
, strerror(errno
), errno
));
265 if (errno
== ECONNREFUSED
|| errno
== ENOTCONN
266 || errno
== ECONNRESET
) {
267 if (connect_to_scanner(handle
) == -1)
268 break; /* connecting fails, abort */
270 } else if (errno
!= EINTR
) {
271 /* on EINTR we just try again, all remaining
272 other errors we log the error
273 and try again ONCE */
275 DEBUG(3,("scannedonly flush_sendbuffer: "
276 "error sending data to scanner: %s "
277 "(%d)\n", strerror(errno
), errno
));
280 /* --> partial write: Resend all filenames that were
281 not or not completely written. a partial filename
282 written means the filename will not arrive correctly,
283 so resend it completely */
286 char *tmp
= strchr(so
->gsendbuffer
+pos
, '\n');
287 if (tmp
&& tmp
- so
->gsendbuffer
< ret
)
288 pos
= tmp
- so
->gsendbuffer
+ 1;
292 memmove(so
->gsendbuffer
, so
->gsendbuffer
+ pos
,
293 SENDBUFFERSIZE
- ret
);
298 if (so
->gsendbuffer
[0] != '\0') {
300 ("scannedonly flush_sendbuffer: "
301 "failed to send files to AV scanner, "
302 "discarding files."));
303 so
->gsendbuffer
[0] = '\0';
307 static void notify_scanner(vfs_handle_struct
* handle
, const char *scanfile
)
310 int tmplen
, gsendlen
;
311 struct Tscannedonly
*so
= (struct Tscannedonly
*)handle
->data
;
312 TALLOC_CTX
*ctx
=talloc_tos();
313 if (scanfile
[0] != '/') {
314 tmp
= construct_full_path(ctx
,handle
, scanfile
, false);
316 tmp
= (char *)scanfile
;
318 tmplen
= strlen(tmp
);
319 gsendlen
= strlen(so
->gsendbuffer
);
320 DEBUG(SCANNEDONLY_DEBUG
,
321 ("scannedonly notify_scanner: tmp=%s, tmplen=%d, gsendlen=%d\n",
322 tmp
, tmplen
, gsendlen
));
323 if (gsendlen
+ tmplen
>= SENDBUFFERSIZE
) {
324 flush_sendbuffer(handle
);
326 strlcat(so
->gsendbuffer
, tmp
, SENDBUFFERSIZE
+ 1);
327 strlcat(so
->gsendbuffer
, "\n", SENDBUFFERSIZE
+ 1);
330 static bool is_scannedonly_file(struct Tscannedonly
*so
, const char *shortname
)
332 if (shortname
[0]!='.') {
335 if (strncmp(shortname
, so
->p_scanned
, strlen(so
->p_scanned
)) == 0) {
338 if (strncmp(shortname
, so
->p_virus
, strlen(so
->p_virus
)) == 0) {
341 if (strncmp(shortname
, so
->p_failed
, strlen(so
->p_failed
)) == 0) {
347 static bool timespec_is_newer(struct timespec
*base
, struct timespec
*test
)
349 return timespec_compare(base
,test
) < 0;
353 vfs_handle_struct *handle the scannedonly handle
354 scannedonly_DIR * sDIR the scannedonly struct if called from _readdir()
356 fullpath is a full path starting from / or a relative path to the
357 current working directory
358 shortname is the filename without directory components
359 basename, is the directory without file name component
360 allow_nonexistant return TRUE if stat() on the requested file fails
361 recheck_time, the time in milliseconds to wait for the daemon to
362 create a .scanned file
363 recheck_tries, the number of tries to wait
364 recheck_size, size in Kb of files that should not be waited for
365 loop : boolean if we should try to loop over all files in the directory
366 and send a notify to the scanner for all files that need scanning
368 static bool scannedonly_allow_access(vfs_handle_struct
* handle
,
369 struct scannedonly_DIR
*sDIR
,
370 struct smb_filename
*smb_fname
,
371 const char *shortname
,
372 const char *base_name
,
373 int allow_nonexistant
,
374 int recheck_time
, int recheck_tries
,
375 int recheck_size
, int loop
)
377 struct smb_filename
*cache_smb_fname
;
378 TALLOC_CTX
*ctx
=talloc_tos();
382 DEBUG(SCANNEDONLY_DEBUG
,
383 ("smb_fname->base_name=%s, shortname=%s, base_name=%s\n"
384 ,smb_fname
->base_name
,shortname
,base_name
));
386 if (ISDOT(shortname
) || ISDOTDOT(shortname
)) {
389 if (is_scannedonly_file(STRUCTSCANO(handle
->data
), shortname
)) {
390 DEBUG(SCANNEDONLY_DEBUG
,
391 ("scannedonly_allow_access, %s is a scannedonly file, "
392 "return 0\n", shortname
));
396 if (!VALID_STAT(smb_fname
->st
)) {
397 DEBUG(SCANNEDONLY_DEBUG
,("stat %s\n",smb_fname
->base_name
));
398 retval
= SMB_VFS_NEXT_STAT(handle
, smb_fname
);
400 /* failed to stat this file?!? --> hide it */
401 DEBUG(SCANNEDONLY_DEBUG
,("no valid stat, return"
402 " allow_nonexistant=%d\n",
404 return allow_nonexistant
;
407 if (!S_ISREG(smb_fname
->st
.st_ex_mode
)) {
408 DEBUG(SCANNEDONLY_DEBUG
,
409 ("%s is not a regular file, ISDIR=%d\n",
410 smb_fname
->base_name
,
411 S_ISDIR(smb_fname
->st
.st_ex_mode
)));
412 return (STRUCTSCANO(handle
->data
)->
413 show_special_files
||
414 S_ISDIR(smb_fname
->st
.st_ex_mode
));
416 if (smb_fname
->st
.st_ex_size
== 0) {
417 DEBUG(SCANNEDONLY_DEBUG
,("empty file, return 1\n"));
418 return true; /* empty files cannot contain viruses ! */
420 cachefile
= cachefile_name(ctx
,
423 STRUCTSCANO(handle
->data
)->p_scanned
);
424 create_synthetic_smb_fname(ctx
, cachefile
,NULL
,NULL
,&cache_smb_fname
);
425 if (!VALID_STAT(cache_smb_fname
->st
)) {
426 retval
= SMB_VFS_NEXT_STAT(handle
, cache_smb_fname
);
428 if (retval
== 0 && VALID_STAT(cache_smb_fname
->st
)) {
429 if (timespec_is_newer(&smb_fname
->st
.st_ex_mtime
,
430 &cache_smb_fname
->st
.st_ex_mtime
)) {
431 talloc_free(cache_smb_fname
);
434 /* no cachefile or too old */
435 SMB_VFS_NEXT_UNLINK(handle
, cache_smb_fname
);
439 notify_scanner(handle
, smb_fname
->base_name
);
442 if (loop
&& sDIR
&& !sDIR
->notify_loop_done
) {
443 /* check the rest of the directory and notify the
444 scanner if some file needs scanning */
446 SMB_STRUCT_DIRENT
*dire
;
448 offset
= SMB_VFS_NEXT_TELLDIR(handle
, sDIR
->DIR);
449 dire
= SMB_VFS_NEXT_READDIR(handle
, sDIR
->DIR, NULL
);
452 struct smb_filename
*smb_fname2
;
453 fpath2
= talloc_asprintf(ctx
, "%s%s", base_name
,dire
->d_name
);
454 DEBUG(SCANNEDONLY_DEBUG
,
455 ("scannedonly_allow_access in loop, "
456 "found %s\n", fpath2
));
457 create_synthetic_smb_fname(ctx
, fpath2
,NULL
,NULL
,
459 scannedonly_allow_access(handle
, NULL
,
462 base_name
, 0, 0, 0, 0, 0);
464 talloc_free(smb_fname2
);
465 dire
= SMB_VFS_NEXT_READDIR(handle
, sDIR
->DIR,NULL
);
467 sDIR
->notify_loop_done
= 1;
469 SMB_VFS_NEXT_SEEKDIR(handle
, sDIR
->DIR, offset
);
472 && ((recheck_size
> 0
473 && smb_fname
->st
.st_ex_size
< (1024 * recheck_size
))
476 flush_sendbuffer(handle
);
477 while (retval
!= 0 /*&& errno == ENOENT */
478 && i
< recheck_tries
) {
479 struct timespec req
= { 0, recheck_time
* 10000 };
480 DEBUG(SCANNEDONLY_DEBUG
,
481 ("scannedonly_allow_access, wait (try=%d "
482 "(max %d), %d ms) for %s\n",
484 recheck_time
, cache_smb_fname
->base_name
));
485 nanosleep(&req
, NULL
);
486 retval
= SMB_VFS_NEXT_STAT(handle
, cache_smb_fname
);
490 /* still no cachefile, or still too old, return 0 */
492 || !timespec_is_newer(&smb_fname
->st
.st_ex_mtime
,
493 &cache_smb_fname
->st
.st_ex_mtime
)) {
494 DEBUG(SCANNEDONLY_DEBUG
,
495 ("retval=%d, return 0\n",retval
));
501 /*********************/
503 /*********************/
505 static SMB_STRUCT_DIR
*scannedonly_opendir(vfs_handle_struct
* handle
,
507 const char *mask
, uint32 attr
)
509 SMB_STRUCT_DIR
*DIRp
;
510 struct scannedonly_DIR
*sDIR
;
512 DIRp
= SMB_VFS_NEXT_OPENDIR(handle
, fname
, mask
, attr
);
517 sDIR
= TALLOC_P(NULL
, struct scannedonly_DIR
);
518 if (fname
[0] != '/') {
519 sDIR
->base
= construct_full_path(sDIR
,handle
, fname
, true);
521 sDIR
->base
= name_w_ending_slash(sDIR
, fname
);
523 DEBUG(SCANNEDONLY_DEBUG
,
524 ("scannedonly_opendir, fname=%s, base=%s\n",fname
,sDIR
->base
));
526 sDIR
->notify_loop_done
= 0;
527 return (SMB_STRUCT_DIR
*) sDIR
;
530 static SMB_STRUCT_DIRENT
*scannedonly_readdir(vfs_handle_struct
*handle
,
531 SMB_STRUCT_DIR
* dirp
,
532 SMB_STRUCT_STAT
*sbuf
)
534 SMB_STRUCT_DIRENT
*result
;
537 struct smb_filename
*smb_fname
;
540 SMB_STRUCT_DIRENT
*newdirent
;
541 TALLOC_CTX
*ctx
=talloc_tos();
543 struct scannedonly_DIR
*sDIR
= (struct scannedonly_DIR
*)dirp
;
548 result
= SMB_VFS_NEXT_READDIR(handle
, sDIR
->DIR, sbuf
);
553 if (is_scannedonly_file(STRUCTSCANO(handle
->data
), result
->d_name
)) {
554 DEBUG(SCANNEDONLY_DEBUG
,
555 ("scannedonly_readdir, %s is a scannedonly file, "
556 "skip to next entry\n", result
->d_name
));
557 return scannedonly_readdir(handle
, dirp
, NULL
);
559 tmp
= talloc_asprintf(ctx
, "%s%s", sDIR
->base
, result
->d_name
);
560 DEBUG(SCANNEDONLY_DEBUG
,
561 ("scannedonly_readdir, check access to %s (sbuf=%p)\n",
564 /* even if we don't hide nonscanned files or we allow non scanned
565 files we call allow_access because it will notify the daemon to
567 create_synthetic_smb_fname(ctx
, tmp
,NULL
,
568 sbuf
?VALID_STAT(*sbuf
)?sbuf
:NULL
:NULL
,
570 allowed
= scannedonly_allow_access(
571 handle
, sDIR
, smb_fname
,
574 STRUCTSCANO(handle
->data
)->hide_nonscanned_files
575 ? STRUCTSCANO(handle
->data
)->recheck_time_readdir
577 STRUCTSCANO(handle
->data
)->recheck_tries_readdir
,
580 DEBUG(SCANNEDONLY_DEBUG
,
581 ("scannedonly_readdir access to %s (%s) = %d\n", tmp
,
582 result
->d_name
, allowed
));
586 DEBUG(SCANNEDONLY_DEBUG
,
587 ("hide_nonscanned_files=%d, allow_nonscanned_files=%d\n",
588 STRUCTSCANO(handle
->data
)->hide_nonscanned_files
,
589 STRUCTSCANO(handle
->data
)->allow_nonscanned_files
592 if (!STRUCTSCANO(handle
->data
)->hide_nonscanned_files
593 || STRUCTSCANO(handle
->data
)->allow_nonscanned_files
) {
597 DEBUG(SCANNEDONLY_DEBUG
,
598 ("scannedonly_readdir, readdir listing for %s not "
599 "allowed, notify user\n", result
->d_name
));
600 notify_name
= talloc_asprintf(
601 ctx
,"%s %s",result
->d_name
,
602 STRUCTSCANO(handle
->data
)->scanning_message
);
603 namelen
= strlen(notify_name
);
604 newdirent
= (SMB_STRUCT_DIRENT
*)TALLOC_ARRAY(
605 ctx
, char, sizeof(SMB_STRUCT_DIRENT
) + namelen
+ 1);
609 memcpy(newdirent
, result
, sizeof(SMB_STRUCT_DIRENT
));
610 memcpy(&newdirent
->d_name
, notify_name
, namelen
+ 1);
611 DEBUG(SCANNEDONLY_DEBUG
,
612 ("scannedonly_readdir, return newdirent at %p with "
613 "notification %s\n", newdirent
, newdirent
->d_name
));
617 static void scannedonly_seekdir(struct vfs_handle_struct
*handle
,
618 SMB_STRUCT_DIR
* dirp
, long offset
)
620 struct scannedonly_DIR
*sDIR
= (struct scannedonly_DIR
*)dirp
;
621 SMB_VFS_NEXT_SEEKDIR(handle
, sDIR
->DIR, offset
);
624 static long scannedonly_telldir(struct vfs_handle_struct
*handle
,
625 SMB_STRUCT_DIR
* dirp
)
627 struct scannedonly_DIR
*sDIR
= (struct scannedonly_DIR
*)dirp
;
628 return SMB_VFS_NEXT_TELLDIR(handle
, sDIR
->DIR);
631 static void scannedonly_rewinddir(struct vfs_handle_struct
*handle
,
632 SMB_STRUCT_DIR
* dirp
)
634 struct scannedonly_DIR
*sDIR
= (struct scannedonly_DIR
*)dirp
;
635 SMB_VFS_NEXT_REWINDDIR(handle
, sDIR
->DIR);
638 static int scannedonly_closedir(vfs_handle_struct
* handle
,
639 SMB_STRUCT_DIR
* dirp
)
642 struct scannedonly_DIR
*sDIR
= (struct scannedonly_DIR
*)dirp
;
643 flush_sendbuffer(handle
);
644 retval
= SMB_VFS_NEXT_CLOSEDIR(handle
, sDIR
->DIR);
649 static int scannedonly_stat(vfs_handle_struct
* handle
,
650 struct smb_filename
*smb_fname
)
653 ret
= SMB_VFS_NEXT_STAT(handle
, smb_fname
);
654 DEBUG(SCANNEDONLY_DEBUG
, ("scannedonly_stat: %s returned %d\n",
655 smb_fname
->base_name
, ret
));
656 if (ret
!= 0 && errno
== ENOENT
) {
657 TALLOC_CTX
*ctx
=talloc_tos();
658 char *test_base_name
, *tmp_base_name
= smb_fname
->base_name
;
659 /* possibly this was a fake name (file is being scanned for
660 viruses.txt): check for that and create the real name and
661 stat the real name */
662 test_base_name
= real_path_from_notify_path(
664 STRUCTSCANO(handle
->data
),
665 smb_fname
->base_name
);
666 if (test_base_name
) {
667 smb_fname
->base_name
= test_base_name
;
668 ret
= SMB_VFS_NEXT_STAT(handle
, smb_fname
);
669 DEBUG(5, ("_stat: %s returned %d\n",
670 test_base_name
, ret
));
671 smb_fname
->base_name
= tmp_base_name
;
677 static int scannedonly_lstat(vfs_handle_struct
* handle
,
678 struct smb_filename
*smb_fname
)
681 ret
= SMB_VFS_NEXT_LSTAT(handle
, smb_fname
);
682 DEBUG(SCANNEDONLY_DEBUG
, ("scannedonly_lstat: %s returned %d\n",
683 smb_fname
->base_name
, ret
));
684 if (ret
!= 0 && errno
== ENOENT
) {
685 TALLOC_CTX
*ctx
=talloc_tos();
686 char *test_base_name
, *tmp_base_name
= smb_fname
->base_name
;
687 /* possibly this was a fake name (file is being scanned for
688 viruses.txt): check for that and create the real name and
689 stat the real name */
690 test_base_name
= real_path_from_notify_path(
691 ctx
, STRUCTSCANO(handle
->data
), smb_fname
->base_name
);
692 if (test_base_name
) {
693 smb_fname
->base_name
= test_base_name
;
694 ret
= SMB_VFS_NEXT_LSTAT(handle
, smb_fname
);
695 DEBUG(5, ("_lstat: %s returned %d\n",
696 test_base_name
, ret
));
697 smb_fname
->base_name
= tmp_base_name
;
703 static int scannedonly_open(vfs_handle_struct
* handle
,
704 struct smb_filename
*smb_fname
,
705 files_struct
* fsp
, int flags
, mode_t mode
)
708 char *tmp
, *shortname
;
709 int allowed
, write_access
= 0;
710 TALLOC_CTX
*ctx
=talloc_tos();
711 /* if open for writing ignore it */
712 if ((flags
& O_ACCMODE
) == O_WRONLY
) {
713 return SMB_VFS_NEXT_OPEN(handle
, smb_fname
, fsp
, flags
, mode
);
715 if ((flags
& O_ACCMODE
) == O_RDWR
) {
718 /* check if this file is scanned already */
719 tmp
= strrchr(smb_fname
->base_name
, '/');
721 base
= talloc_strndup(ctx
,smb_fname
->base_name
,
722 (tmp
- smb_fname
->base_name
) + 1);
726 shortname
= (char *)smb_fname
->base_name
;
728 allowed
= scannedonly_allow_access(
729 handle
, NULL
, smb_fname
, shortname
,
732 STRUCTSCANO(handle
->data
)->recheck_time_open
,
733 STRUCTSCANO(handle
->data
)->recheck_tries_open
,
734 STRUCTSCANO(handle
->data
)->recheck_size_open
,
736 flush_sendbuffer(handle
);
737 DEBUG(SCANNEDONLY_DEBUG
, ("scannedonly_open: allow=%d for %s\n",
738 allowed
, smb_fname
->base_name
));
740 || STRUCTSCANO(handle
->data
)->allow_nonscanned_files
) {
741 return SMB_VFS_NEXT_OPEN(handle
, smb_fname
, fsp
, flags
, mode
);
747 static int scannedonly_close(vfs_handle_struct
* handle
, files_struct
* fsp
)
749 /* we only have to notify the scanner
750 for files that were open readwrite or writable. */
751 if (fsp
->can_write
) {
752 TALLOC_CTX
*ctx
= talloc_tos();
753 notify_scanner(handle
, construct_full_path(
755 fsp
->fsp_name
->base_name
,false));
756 flush_sendbuffer(handle
);
758 return SMB_VFS_NEXT_CLOSE(handle
, fsp
);
761 static int scannedonly_rename(vfs_handle_struct
* handle
,
762 const struct smb_filename
*smb_fname_src
,
763 const struct smb_filename
*smb_fname_dst
)
765 /* rename the cache file before we pass the actual rename on */
766 struct smb_filename
*smb_fname_src_tmp
= NULL
;
767 struct smb_filename
*smb_fname_dst_tmp
= NULL
;
768 char *cachefile_src
, *cachefile_dst
;
769 bool needscandst
=false;
771 TALLOC_CTX
*ctx
= talloc_tos();
773 /* Setup temporary smb_filename structs. */
774 cachefile_src
= cachefile_name_f_fullpath(
776 smb_fname_src
->base_name
,
777 STRUCTSCANO(handle
->data
)->p_scanned
);
778 cachefile_dst
= cachefile_name_f_fullpath(
780 smb_fname_dst
->base_name
,
781 STRUCTSCANO(handle
->data
)->p_scanned
);
782 create_synthetic_smb_fname(ctx
, cachefile_src
,NULL
,NULL
,
784 create_synthetic_smb_fname(ctx
, cachefile_dst
,NULL
,NULL
,
787 ret
= SMB_VFS_NEXT_RENAME(handle
, smb_fname_src_tmp
, smb_fname_dst_tmp
);
790 } else if (ret
!= 0) {
791 DEBUG(SCANNEDONLY_DEBUG
,
792 ("failed to rename %s into %s error %d: %s\n", cachefile_src
,
793 cachefile_dst
, ret
, strerror(ret
)));
796 ret
= SMB_VFS_NEXT_RENAME(handle
, smb_fname_src
, smb_fname_dst
);
797 if (ret
== 0 && needscandst
) {
798 notify_scanner(handle
, smb_fname_dst
->base_name
);
799 flush_sendbuffer(handle
);
804 static int scannedonly_unlink(vfs_handle_struct
* handle
,
805 const struct smb_filename
*smb_fname
)
807 /* unlink the 'scanned' file too */
808 struct smb_filename
*smb_fname_cache
= NULL
;
810 TALLOC_CTX
*ctx
= talloc_tos();
812 cachefile
= cachefile_name_f_fullpath(
814 smb_fname
->base_name
,
815 STRUCTSCANO(handle
->data
)->p_scanned
);
816 create_synthetic_smb_fname(ctx
, cachefile
,NULL
,NULL
,
818 if (SMB_VFS_NEXT_UNLINK(handle
, smb_fname_cache
) != 0) {
819 DEBUG(SCANNEDONLY_DEBUG
, ("_unlink: failed to unlink %s\n",
820 smb_fname_cache
->base_name
));
822 return SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
825 static int scannedonly_rmdir(vfs_handle_struct
* handle
, const char *path
)
827 /* if there are only .scanned: .virus: or .failed: files, we delete
828 those, because the client cannot see them */
830 SMB_STRUCT_DIRENT
*dire
;
831 TALLOC_CTX
*ctx
= talloc_tos();
832 bool only_deletable_files
= true, have_files
= false;
835 if (!STRUCTSCANO(handle
->data
)->rm_hidden_files_on_rmdir
)
836 return SMB_VFS_NEXT_RMDIR(handle
, path
);
838 path_w_slash
= name_w_ending_slash(ctx
,path
);
839 dirp
= SMB_VFS_NEXT_OPENDIR(handle
, path
, NULL
, 0);
843 while ((dire
= SMB_VFS_NEXT_READDIR(handle
, dirp
, NULL
)) != NULL
) {
844 if (ISDOT(dire
->d_name
) || ISDOTDOT(dire
->d_name
)) {
848 if (!is_scannedonly_file(STRUCTSCANO(handle
->data
),
850 struct smb_filename
*smb_fname
= NULL
;
854 if (STRUCTSCANO(handle
->data
)->show_special_files
) {
855 only_deletable_files
= false;
858 /* stat the file and see if it is a
860 fullpath
= talloc_asprintf(ctx
, "%s%s", path_w_slash
,
862 create_synthetic_smb_fname(ctx
, fullpath
,NULL
,NULL
,
864 retval
= SMB_VFS_NEXT_STAT(handle
, smb_fname
);
866 && S_ISREG(smb_fname
->st
.st_ex_mode
)) {
867 only_deletable_files
= false;
869 TALLOC_FREE(fullpath
);
870 TALLOC_FREE(smb_fname
);
874 DEBUG(SCANNEDONLY_DEBUG
,
875 ("path=%s, have_files=%d, only_deletable_files=%d\n",
876 path
, have_files
, only_deletable_files
));
877 if (have_files
&& only_deletable_files
) {
878 DEBUG(SCANNEDONLY_DEBUG
,
879 ("scannedonly_rmdir, remove leftover scannedonly "
880 "files from %s\n", path_w_slash
));
881 SMB_VFS_NEXT_REWINDDIR(handle
, dirp
);
882 while ((dire
= SMB_VFS_NEXT_READDIR(handle
, dirp
, NULL
))
885 struct smb_filename
*smb_fname
= NULL
;
886 if (ISDOT(dire
->d_name
) || ISDOTDOT(dire
->d_name
)) {
889 fullpath
= talloc_asprintf(ctx
, "%s%s", path_w_slash
,
891 create_synthetic_smb_fname(ctx
, fullpath
,NULL
,NULL
,
893 DEBUG(SCANNEDONLY_DEBUG
, ("unlink %s\n", fullpath
));
894 SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
895 TALLOC_FREE(fullpath
);
896 TALLOC_FREE(smb_fname
);
899 SMB_VFS_NEXT_CLOSEDIR(handle
, dirp
);
900 return SMB_VFS_NEXT_RMDIR(handle
, path
);
903 static void free_scannedonly_data(void **data
)
908 static int scannedonly_connect(struct vfs_handle_struct
*handle
,
909 const char *service
, const char *user
)
912 struct Tscannedonly
*so
;
914 so
= SMB_MALLOC_P(struct Tscannedonly
);
915 handle
->data
= (void *)so
;
916 handle
->free_data
= free_scannedonly_data
;
917 so
->gsendbuffer
[0]='\0';
919 lp_parm_bool(SNUM(handle
->conn
), "scannedonly",
920 "domain_socket", True
);
922 (char *)lp_parm_const_string(SNUM(handle
->conn
),
923 "scannedonly", "socketname",
924 "/var/lib/scannedonly/scan");
926 lp_parm_int(SNUM(handle
->conn
), "scannedonly", "portnum",
929 (char *)lp_parm_const_string(SNUM(handle
->conn
),
930 "scannedonly", "scanhost",
933 so
->show_special_files
=
934 lp_parm_bool(SNUM(handle
->conn
), "scannedonly",
935 "show_special_files", True
);
936 so
->rm_hidden_files_on_rmdir
=
937 lp_parm_bool(SNUM(handle
->conn
), "scannedonly",
938 "rm_hidden_files_on_rmdir", True
);
939 so
->hide_nonscanned_files
=
940 lp_parm_bool(SNUM(handle
->conn
), "scannedonly",
941 "hide_nonscanned_files", False
);
942 so
->allow_nonscanned_files
=
943 lp_parm_bool(SNUM(handle
->conn
), "scannedonly",
944 "allow_nonscanned_files", False
);
945 so
->scanning_message
=
946 (char *)lp_parm_const_string(SNUM(handle
->conn
),
949 "is being scanned for viruses");
950 so
->scanning_message_len
= strlen(so
->scanning_message
);
951 so
->recheck_time_open
=
952 lp_parm_int(SNUM(handle
->conn
), "scannedonly",
953 "recheck_time_open", 50);
954 so
->recheck_tries_open
=
955 lp_parm_int(SNUM(handle
->conn
), "scannedonly",
956 "recheck_tries_open", 100);
957 so
->recheck_size_open
=
958 lp_parm_int(SNUM(handle
->conn
), "scannedonly",
959 "recheck_size_open", 100);
960 so
->recheck_time_readdir
=
961 lp_parm_int(SNUM(handle
->conn
), "scannedonly",
962 "recheck_time_readdir", 50);
963 so
->recheck_tries_readdir
=
964 lp_parm_int(SNUM(handle
->conn
), "scannedonly",
965 "recheck_tries_readdir", 20);
968 (char *)lp_parm_const_string(SNUM(handle
->conn
),
973 (char *)lp_parm_const_string(SNUM(handle
->conn
),
978 (char *)lp_parm_const_string(SNUM(handle
->conn
),
982 connect_to_scanner(handle
);
984 return SMB_VFS_NEXT_CONNECT(handle
, service
, user
);
987 /* VFS operations structure */
988 static struct vfs_fn_pointers vfs_scannedonly_fns
= {
989 .opendir
= scannedonly_opendir
,
990 .readdir
= scannedonly_readdir
,
991 .seekdir
= scannedonly_seekdir
,
992 .telldir
= scannedonly_telldir
,
993 .rewind_dir
= scannedonly_rewinddir
,
994 .closedir
= scannedonly_closedir
,
995 .rmdir
= scannedonly_rmdir
,
996 .stat
= scannedonly_stat
,
997 .lstat
= scannedonly_lstat
,
998 .open
= scannedonly_open
,
999 .close_fn
= scannedonly_close
,
1000 .rename
= scannedonly_rename
,
1001 .unlink
= scannedonly_unlink
,
1002 .connect_fn
= scannedonly_connect
1005 NTSTATUS
vfs_scannedonly_init(void)
1007 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "scannedonly",
1008 &vfs_scannedonly_fns
);