s4-python: Add missing prototypes.
[Samba.git] / source3 / modules / vfs_scannedonly.c
blob123bf65fd4b14e2115117a3196853b417ec4ae43
1 /*
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.
20 * ABOUT SCANNEDONLY
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
37 * easily scriptable)
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).
50 #include "includes.h"
52 #include "config.h"
54 #define SENDBUFFERSIZE 1450
56 #ifndef SUN_LEN
57 #define SUN_LEN(sunp) ((size_t)((struct sockaddr_un *)0)->sun_path \
58 + strlen((sunp)->sun_path))
59 #endif
62 struct Tscannedonly {
63 int socket;
64 int domain_socket;
65 int portnum;
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;
76 char *socketname;
77 char *scanhost;
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 {
88 char *base;
89 int notify_loop_done;
90 SMB_STRUCT_DIR *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,
99 const char *path)
101 char *name;
102 int len, pathlen;
104 name = strrchr(path, '/');
105 if (!name) {
106 return NULL;
108 pathlen = name - path;
109 name++;
110 len = strlen(name);
111 if (len <= so->scanning_message_len) {
112 return NULL;
115 if (strcmp(name + (len - so->scanning_message_len),
116 so->scanning_message) != 0) {
117 return NULL;
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,
126 const char *base,
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);
137 } else {
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)
146 const char *base;
147 char *tmp, *cachefile, *shortname;
148 tmp = strrchr(fullpath, '/');
149 if (tmp) {
150 base = talloc_strndup(ctx, fullpath, (tmp - fullpath) + 1);
151 shortname = tmp + 1;
152 } else {
153 base = "";
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));
159 return cachefile;
162 static char *construct_full_path(TALLOC_CTX *ctx, vfs_handle_struct * handle,
163 const char *somepath, bool ending_slash)
165 char *tmp;
167 if (!somepath) {
168 return NULL;
170 if (somepath[0] == '/') {
171 if (ending_slash) {
172 return name_w_ending_slash(ctx,somepath);
174 return talloc_strdup(ctx,somepath);
176 tmp=(char *)somepath;
177 if (tmp[0]=='.'&&tmp[1]=='/') {
178 tmp+=2;
180 /* vfs_GetWd() seems to return a path with a slash */
181 if (ending_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",
198 so->socketname));
199 return -1;
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",
207 so->socketname));
208 return -1;
210 DEBUG(SCANNEDONLY_DEBUG,("bound %s to socket %d\n",
211 saun.sun_path, so->socket));
213 } else {
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));
218 return -1;
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. */
225 int sndsize;
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",
230 sndsize));
231 sndsize = 262144;
232 if (setsockopt(so->socket, SOL_SOCKET, SO_RCVBUF,
233 (char *)&sndsize,
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);
241 return 0;
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') {
249 return;
252 do {
253 loop--;
254 len = strlen(so->gsendbuffer);
255 ret = send(so->socket, so->gsendbuffer, len, 0);
256 if (ret == len) {
257 so->gsendbuffer[0] = '\0';
258 break;
260 if (ret == -1) {
261 DEBUG(3,("scannedonly flush_sendbuffer: "
262 "error sending on socket %d to scanner:"
263 " %s (%d)\n",
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 */
269 /* try again */
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 */
274 loop = 1;
275 DEBUG(3,("scannedonly flush_sendbuffer: "
276 "error sending data to scanner: %s "
277 "(%d)\n", strerror(errno), errno));
279 } else {
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 */
284 int pos = 0;
285 while (pos < len) {
286 char *tmp = strchr(so->gsendbuffer+pos, '\n');
287 if (tmp && tmp - so->gsendbuffer < ret)
288 pos = tmp - so->gsendbuffer + 1;
289 else
290 break;
292 memmove(so->gsendbuffer, so->gsendbuffer + pos,
293 SENDBUFFERSIZE - ret);
294 /* now try again */
296 } while (loop > 0);
298 if (so->gsendbuffer[0] != '\0') {
299 DEBUG(2,
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)
309 char *tmp;
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);
315 } else {
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]!='.') {
333 return false;
335 if (strncmp(shortname, so->p_scanned, strlen(so->p_scanned)) == 0) {
336 return true;
338 if (strncmp(shortname, so->p_virus, strlen(so->p_virus)) == 0) {
339 return true;
341 if (strncmp(shortname, so->p_failed, strlen(so->p_failed)) == 0) {
342 return true;
344 return false;
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()
355 or NULL
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();
379 char *cachefile;
380 int retval = -1;
381 int didloop;
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)) {
387 return true;
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));
393 return false;
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);
399 if (retval != 0) {
400 /* failed to stat this file?!? --> hide it */
401 DEBUG(SCANNEDONLY_DEBUG,("no valid stat, return"
402 " allow_nonexistant=%d\n",
403 allow_nonexistant));
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,
421 shortname,
422 base_name,
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_ctime,
430 &cache_smb_fname->st.st_ex_ctime)) {
431 talloc_free(cache_smb_fname);
432 return true;
434 /* no cachefile or too old */
435 SMB_VFS_NEXT_UNLINK(handle, cache_smb_fname);
436 retval = -1;
439 notify_scanner(handle, smb_fname->base_name);
441 didloop = 0;
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 */
445 long offset;
446 SMB_STRUCT_DIRENT *dire;
448 offset = SMB_VFS_NEXT_TELLDIR(handle, sDIR->DIR);
449 dire = SMB_VFS_NEXT_READDIR(handle, sDIR->DIR, NULL);
450 while (dire) {
451 char *fpath2;
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,
458 &smb_fname2);
459 scannedonly_allow_access(handle, NULL,
460 smb_fname2,
461 dire->d_name,
462 base_name, 0, 0, 0, 0, 0);
463 talloc_free(fpath2);
464 talloc_free(smb_fname2);
465 dire = SMB_VFS_NEXT_READDIR(handle, sDIR->DIR,NULL);
467 sDIR->notify_loop_done = 1;
468 didloop = 1;
469 SMB_VFS_NEXT_SEEKDIR(handle, sDIR->DIR, offset);
471 if (recheck_time > 0
472 && ((recheck_size > 0
473 && smb_fname->st.st_ex_size < (1024 * recheck_size))
474 || didloop)) {
475 int i = 0;
476 flush_sendbuffer(handle);
477 while (retval != 0 /*&& errno == ENOENT */
478 && i < recheck_tries) {
479 DEBUG(SCANNEDONLY_DEBUG,
480 ("scannedonly_allow_access, wait (try=%d "
481 "(max %d), %d ms) for %s\n",
482 i, recheck_tries,
483 recheck_time, cache_smb_fname->base_name));
484 smb_msleep(recheck_time);
485 retval = SMB_VFS_NEXT_STAT(handle, cache_smb_fname);
486 i++;
489 /* still no cachefile, or still too old, return 0 */
490 if (retval != 0
491 || !timespec_is_newer(&smb_fname->st.st_ex_ctime,
492 &cache_smb_fname->st.st_ex_ctime)) {
493 DEBUG(SCANNEDONLY_DEBUG,
494 ("retval=%d, return 0\n",retval));
495 return false;
497 return true;
500 /*********************/
501 /* VFS functions */
502 /*********************/
504 static SMB_STRUCT_DIR *scannedonly_opendir(vfs_handle_struct * handle,
505 const char *fname,
506 const char *mask, uint32 attr)
508 SMB_STRUCT_DIR *DIRp;
509 struct scannedonly_DIR *sDIR;
511 DIRp = SMB_VFS_NEXT_OPENDIR(handle, fname, mask, attr);
512 if (!DIRp) {
513 return NULL;
516 sDIR = TALLOC_P(NULL, struct scannedonly_DIR);
517 if (fname[0] != '/') {
518 sDIR->base = construct_full_path(sDIR,handle, fname, true);
519 } else {
520 sDIR->base = name_w_ending_slash(sDIR, fname);
522 DEBUG(SCANNEDONLY_DEBUG,
523 ("scannedonly_opendir, fname=%s, base=%s\n",fname,sDIR->base));
524 sDIR->DIR = DIRp;
525 sDIR->notify_loop_done = 0;
526 return (SMB_STRUCT_DIR *) sDIR;
529 static SMB_STRUCT_DIRENT *scannedonly_readdir(vfs_handle_struct *handle,
530 SMB_STRUCT_DIR * dirp,
531 SMB_STRUCT_STAT *sbuf)
533 SMB_STRUCT_DIRENT *result;
534 int allowed = 0;
535 char *tmp;
536 struct smb_filename *smb_fname;
537 char *notify_name;
538 int namelen;
539 SMB_STRUCT_DIRENT *newdirent;
540 TALLOC_CTX *ctx=talloc_tos();
542 struct scannedonly_DIR *sDIR = (struct scannedonly_DIR *)dirp;
543 if (!dirp) {
544 return NULL;
547 result = SMB_VFS_NEXT_READDIR(handle, sDIR->DIR, sbuf);
549 if (!result)
550 return NULL;
552 if (is_scannedonly_file(STRUCTSCANO(handle->data), result->d_name)) {
553 DEBUG(SCANNEDONLY_DEBUG,
554 ("scannedonly_readdir, %s is a scannedonly file, "
555 "skip to next entry\n", result->d_name));
556 return scannedonly_readdir(handle, dirp, NULL);
558 tmp = talloc_asprintf(ctx, "%s%s", sDIR->base, result->d_name);
559 DEBUG(SCANNEDONLY_DEBUG,
560 ("scannedonly_readdir, check access to %s (sbuf=%p)\n",
561 tmp,sbuf));
563 /* even if we don't hide nonscanned files or we allow non scanned
564 files we call allow_access because it will notify the daemon to
565 scan these files */
566 create_synthetic_smb_fname(ctx, tmp,NULL,
567 sbuf?VALID_STAT(*sbuf)?sbuf:NULL:NULL,
568 &smb_fname);
569 allowed = scannedonly_allow_access(
570 handle, sDIR, smb_fname,
571 result->d_name,
572 sDIR->base, 0,
573 STRUCTSCANO(handle->data)->hide_nonscanned_files
574 ? STRUCTSCANO(handle->data)->recheck_time_readdir
575 : 0,
576 STRUCTSCANO(handle->data)->recheck_tries_readdir,
579 DEBUG(SCANNEDONLY_DEBUG,
580 ("scannedonly_readdir access to %s (%s) = %d\n", tmp,
581 result->d_name, allowed));
582 if (allowed) {
583 return result;
585 DEBUG(SCANNEDONLY_DEBUG,
586 ("hide_nonscanned_files=%d, allow_nonscanned_files=%d\n",
587 STRUCTSCANO(handle->data)->hide_nonscanned_files,
588 STRUCTSCANO(handle->data)->allow_nonscanned_files
591 if (!STRUCTSCANO(handle->data)->hide_nonscanned_files
592 || STRUCTSCANO(handle->data)->allow_nonscanned_files) {
593 return result;
596 DEBUG(SCANNEDONLY_DEBUG,
597 ("scannedonly_readdir, readdir listing for %s not "
598 "allowed, notify user\n", result->d_name));
599 notify_name = talloc_asprintf(
600 ctx,"%s %s",result->d_name,
601 STRUCTSCANO(handle->data)->scanning_message);
602 namelen = strlen(notify_name);
603 newdirent = (SMB_STRUCT_DIRENT *)TALLOC_ARRAY(
604 ctx, char, sizeof(SMB_STRUCT_DIRENT) + namelen + 1);
605 if (!newdirent) {
606 return NULL;
608 memcpy(newdirent, result, sizeof(SMB_STRUCT_DIRENT));
609 memcpy(&newdirent->d_name, notify_name, namelen + 1);
610 DEBUG(SCANNEDONLY_DEBUG,
611 ("scannedonly_readdir, return newdirent at %p with "
612 "notification %s\n", newdirent, newdirent->d_name));
613 return newdirent;
616 static void scannedonly_seekdir(struct vfs_handle_struct *handle,
617 SMB_STRUCT_DIR * dirp, long offset)
619 struct scannedonly_DIR *sDIR = (struct scannedonly_DIR *)dirp;
620 SMB_VFS_NEXT_SEEKDIR(handle, sDIR->DIR, offset);
623 static long scannedonly_telldir(struct vfs_handle_struct *handle,
624 SMB_STRUCT_DIR * dirp)
626 struct scannedonly_DIR *sDIR = (struct scannedonly_DIR *)dirp;
627 return SMB_VFS_NEXT_TELLDIR(handle, sDIR->DIR);
630 static void scannedonly_rewinddir(struct vfs_handle_struct *handle,
631 SMB_STRUCT_DIR * dirp)
633 struct scannedonly_DIR *sDIR = (struct scannedonly_DIR *)dirp;
634 SMB_VFS_NEXT_REWINDDIR(handle, sDIR->DIR);
637 static int scannedonly_closedir(vfs_handle_struct * handle,
638 SMB_STRUCT_DIR * dirp)
640 int retval;
641 struct scannedonly_DIR *sDIR = (struct scannedonly_DIR *)dirp;
642 flush_sendbuffer(handle);
643 retval = SMB_VFS_NEXT_CLOSEDIR(handle, sDIR->DIR);
644 TALLOC_FREE(sDIR);
645 return retval;
648 static int scannedonly_stat(vfs_handle_struct * handle,
649 struct smb_filename *smb_fname)
651 int ret;
652 ret = SMB_VFS_NEXT_STAT(handle, smb_fname);
653 DEBUG(SCANNEDONLY_DEBUG, ("scannedonly_stat: %s returned %d\n",
654 smb_fname->base_name, ret));
655 if (ret != 0 && errno == ENOENT) {
656 TALLOC_CTX *ctx=talloc_tos();
657 char *test_base_name, *tmp_base_name = smb_fname->base_name;
658 /* possibly this was a fake name (file is being scanned for
659 viruses.txt): check for that and create the real name and
660 stat the real name */
661 test_base_name = real_path_from_notify_path(
662 ctx,
663 STRUCTSCANO(handle->data),
664 smb_fname->base_name);
665 if (test_base_name) {
666 smb_fname->base_name = test_base_name;
667 ret = SMB_VFS_NEXT_STAT(handle, smb_fname);
668 DEBUG(5, ("_stat: %s returned %d\n",
669 test_base_name, ret));
670 smb_fname->base_name = tmp_base_name;
673 return ret;
676 static int scannedonly_lstat(vfs_handle_struct * handle,
677 struct smb_filename *smb_fname)
679 int ret;
680 ret = SMB_VFS_NEXT_LSTAT(handle, smb_fname);
681 DEBUG(SCANNEDONLY_DEBUG, ("scannedonly_lstat: %s returned %d\n",
682 smb_fname->base_name, ret));
683 if (ret != 0 && errno == ENOENT) {
684 TALLOC_CTX *ctx=talloc_tos();
685 char *test_base_name, *tmp_base_name = smb_fname->base_name;
686 /* possibly this was a fake name (file is being scanned for
687 viruses.txt): check for that and create the real name and
688 stat the real name */
689 test_base_name = real_path_from_notify_path(
690 ctx, STRUCTSCANO(handle->data), smb_fname->base_name);
691 if (test_base_name) {
692 smb_fname->base_name = test_base_name;
693 ret = SMB_VFS_NEXT_LSTAT(handle, smb_fname);
694 DEBUG(5, ("_lstat: %s returned %d\n",
695 test_base_name, ret));
696 smb_fname->base_name = tmp_base_name;
699 return ret;
702 static int scannedonly_open(vfs_handle_struct * handle,
703 struct smb_filename *smb_fname,
704 files_struct * fsp, int flags, mode_t mode)
706 const char *base;
707 char *tmp, *shortname;
708 int allowed, write_access = 0;
709 TALLOC_CTX *ctx=talloc_tos();
710 /* if open for writing ignore it */
711 if ((flags & O_ACCMODE) == O_WRONLY) {
712 return SMB_VFS_NEXT_OPEN(handle, smb_fname, fsp, flags, mode);
714 if ((flags & O_ACCMODE) == O_RDWR) {
715 write_access = 1;
717 /* check if this file is scanned already */
718 tmp = strrchr(smb_fname->base_name, '/');
719 if (tmp) {
720 base = talloc_strndup(ctx,smb_fname->base_name,
721 (tmp - smb_fname->base_name) + 1);
722 shortname = tmp + 1;
723 } else {
724 base = "";
725 shortname = (char *)smb_fname->base_name;
727 allowed = scannedonly_allow_access(
728 handle, NULL, smb_fname, shortname,
729 base,
730 write_access,
731 STRUCTSCANO(handle->data)->recheck_time_open,
732 STRUCTSCANO(handle->data)->recheck_tries_open,
733 STRUCTSCANO(handle->data)->recheck_size_open,
735 flush_sendbuffer(handle);
736 DEBUG(SCANNEDONLY_DEBUG, ("scannedonly_open: allow=%d for %s\n",
737 allowed, smb_fname->base_name));
738 if (allowed
739 || STRUCTSCANO(handle->data)->allow_nonscanned_files) {
740 return SMB_VFS_NEXT_OPEN(handle, smb_fname, fsp, flags, mode);
742 errno = EACCES;
743 return -1;
746 static int scannedonly_close(vfs_handle_struct * handle, files_struct * fsp)
748 /* we only have to notify the scanner
749 for files that were open readwrite or writable. */
750 if (fsp->can_write) {
751 TALLOC_CTX *ctx = talloc_tos();
752 notify_scanner(handle, construct_full_path(
753 ctx,handle,
754 fsp->fsp_name->base_name,false));
755 flush_sendbuffer(handle);
757 return SMB_VFS_NEXT_CLOSE(handle, fsp);
760 static int scannedonly_rename(vfs_handle_struct * handle,
761 const struct smb_filename *smb_fname_src,
762 const struct smb_filename *smb_fname_dst)
764 /* rename the cache file before we pass the actual rename on */
765 struct smb_filename *smb_fname_src_tmp = NULL;
766 struct smb_filename *smb_fname_dst_tmp = NULL;
767 char *cachefile_src, *cachefile_dst;
768 bool needscandst=false;
769 int ret;
770 TALLOC_CTX *ctx = talloc_tos();
772 /* Setup temporary smb_filename structs. */
773 cachefile_src = cachefile_name_f_fullpath(
774 ctx,
775 smb_fname_src->base_name,
776 STRUCTSCANO(handle->data)->p_scanned);
777 cachefile_dst = cachefile_name_f_fullpath(
778 ctx,
779 smb_fname_dst->base_name,
780 STRUCTSCANO(handle->data)->p_scanned);
781 create_synthetic_smb_fname(ctx, cachefile_src,NULL,NULL,
782 &smb_fname_src_tmp);
783 create_synthetic_smb_fname(ctx, cachefile_dst,NULL,NULL,
784 &smb_fname_dst_tmp);
786 ret = SMB_VFS_NEXT_RENAME(handle, smb_fname_src_tmp, smb_fname_dst_tmp);
787 if (ret == ENOENT) {
788 needscandst=true;
789 } else if (ret != 0) {
790 DEBUG(SCANNEDONLY_DEBUG,
791 ("failed to rename %s into %s error %d: %s\n", cachefile_src,
792 cachefile_dst, ret, strerror(ret)));
793 needscandst=true;
795 ret = SMB_VFS_NEXT_RENAME(handle, smb_fname_src, smb_fname_dst);
796 if (ret == 0 && needscandst) {
797 notify_scanner(handle, smb_fname_dst->base_name);
798 flush_sendbuffer(handle);
800 return ret;
803 static int scannedonly_unlink(vfs_handle_struct * handle,
804 const struct smb_filename *smb_fname)
806 /* unlink the 'scanned' file too */
807 struct smb_filename *smb_fname_cache = NULL;
808 char * cachefile;
809 TALLOC_CTX *ctx = talloc_tos();
811 cachefile = cachefile_name_f_fullpath(
812 ctx,
813 smb_fname->base_name,
814 STRUCTSCANO(handle->data)->p_scanned);
815 create_synthetic_smb_fname(ctx, cachefile,NULL,NULL,
816 &smb_fname_cache);
817 if (SMB_VFS_NEXT_UNLINK(handle, smb_fname_cache) != 0) {
818 DEBUG(SCANNEDONLY_DEBUG, ("_unlink: failed to unlink %s\n",
819 smb_fname_cache->base_name));
821 return SMB_VFS_NEXT_UNLINK(handle, smb_fname);
824 static int scannedonly_rmdir(vfs_handle_struct * handle, const char *path)
826 /* if there are only .scanned: .virus: or .failed: files, we delete
827 those, because the client cannot see them */
828 DIR *dirp;
829 SMB_STRUCT_DIRENT *dire;
830 TALLOC_CTX *ctx = talloc_tos();
831 bool only_deletable_files = true, have_files = false;
832 char *path_w_slash;
834 if (!STRUCTSCANO(handle->data)->rm_hidden_files_on_rmdir)
835 return SMB_VFS_NEXT_RMDIR(handle, path);
837 path_w_slash = name_w_ending_slash(ctx,path);
838 dirp = SMB_VFS_NEXT_OPENDIR(handle, path, NULL, 0);
839 if (!dirp) {
840 return -1;
842 while ((dire = SMB_VFS_NEXT_READDIR(handle, dirp, NULL)) != NULL) {
843 if (ISDOT(dire->d_name) || ISDOTDOT(dire->d_name)) {
844 continue;
846 have_files = true;
847 if (!is_scannedonly_file(STRUCTSCANO(handle->data),
848 dire->d_name)) {
849 struct smb_filename *smb_fname = NULL;
850 char *fullpath;
851 int retval;
853 if (STRUCTSCANO(handle->data)->show_special_files) {
854 only_deletable_files = false;
855 break;
857 /* stat the file and see if it is a
858 special file */
859 fullpath = talloc_asprintf(ctx, "%s%s", path_w_slash,
860 dire->d_name);
861 create_synthetic_smb_fname(ctx, fullpath,NULL,NULL,
862 &smb_fname);
863 retval = SMB_VFS_NEXT_STAT(handle, smb_fname);
864 if (retval == 0
865 && S_ISREG(smb_fname->st.st_ex_mode)) {
866 only_deletable_files = false;
868 TALLOC_FREE(fullpath);
869 TALLOC_FREE(smb_fname);
870 break;
873 DEBUG(SCANNEDONLY_DEBUG,
874 ("path=%s, have_files=%d, only_deletable_files=%d\n",
875 path, have_files, only_deletable_files));
876 if (have_files && only_deletable_files) {
877 DEBUG(SCANNEDONLY_DEBUG,
878 ("scannedonly_rmdir, remove leftover scannedonly "
879 "files from %s\n", path_w_slash));
880 SMB_VFS_NEXT_REWINDDIR(handle, dirp);
881 while ((dire = SMB_VFS_NEXT_READDIR(handle, dirp, NULL))
882 != NULL) {
883 char *fullpath;
884 struct smb_filename *smb_fname = NULL;
885 if (ISDOT(dire->d_name) || ISDOTDOT(dire->d_name)) {
886 continue;
888 fullpath = talloc_asprintf(ctx, "%s%s", path_w_slash,
889 dire->d_name);
890 create_synthetic_smb_fname(ctx, fullpath,NULL,NULL,
891 &smb_fname);
892 DEBUG(SCANNEDONLY_DEBUG, ("unlink %s\n", fullpath));
893 SMB_VFS_NEXT_UNLINK(handle, smb_fname);
894 TALLOC_FREE(fullpath);
895 TALLOC_FREE(smb_fname);
898 SMB_VFS_NEXT_CLOSEDIR(handle, dirp);
899 return SMB_VFS_NEXT_RMDIR(handle, path);
902 static void free_scannedonly_data(void **data)
904 SAFE_FREE(*data);
907 static int scannedonly_connect(struct vfs_handle_struct *handle,
908 const char *service, const char *user)
911 struct Tscannedonly *so;
913 so = SMB_MALLOC_P(struct Tscannedonly);
914 handle->data = (void *)so;
915 handle->free_data = free_scannedonly_data;
916 so->gsendbuffer[0]='\0';
917 so->domain_socket =
918 lp_parm_bool(SNUM(handle->conn), "scannedonly",
919 "domain_socket", True);
920 so->socketname =
921 (char *)lp_parm_const_string(SNUM(handle->conn),
922 "scannedonly", "socketname",
923 "/var/lib/scannedonly/scan");
924 so->portnum =
925 lp_parm_int(SNUM(handle->conn), "scannedonly", "portnum",
926 2020);
927 so->scanhost =
928 (char *)lp_parm_const_string(SNUM(handle->conn),
929 "scannedonly", "scanhost",
930 "localhost");
932 so->show_special_files =
933 lp_parm_bool(SNUM(handle->conn), "scannedonly",
934 "show_special_files", True);
935 so->rm_hidden_files_on_rmdir =
936 lp_parm_bool(SNUM(handle->conn), "scannedonly",
937 "rm_hidden_files_on_rmdir", True);
938 so->hide_nonscanned_files =
939 lp_parm_bool(SNUM(handle->conn), "scannedonly",
940 "hide_nonscanned_files", False);
941 so->allow_nonscanned_files =
942 lp_parm_bool(SNUM(handle->conn), "scannedonly",
943 "allow_nonscanned_files", False);
944 so->scanning_message =
945 (char *)lp_parm_const_string(SNUM(handle->conn),
946 "scannedonly",
947 "scanning_message",
948 "is being scanned for viruses");
949 so->scanning_message_len = strlen(so->scanning_message);
950 so->recheck_time_open =
951 lp_parm_int(SNUM(handle->conn), "scannedonly",
952 "recheck_time_open", 50);
953 so->recheck_tries_open =
954 lp_parm_int(SNUM(handle->conn), "scannedonly",
955 "recheck_tries_open", 100);
956 so->recheck_size_open =
957 lp_parm_int(SNUM(handle->conn), "scannedonly",
958 "recheck_size_open", 100);
959 so->recheck_time_readdir =
960 lp_parm_int(SNUM(handle->conn), "scannedonly",
961 "recheck_time_readdir", 50);
962 so->recheck_tries_readdir =
963 lp_parm_int(SNUM(handle->conn), "scannedonly",
964 "recheck_tries_readdir", 20);
966 so->p_scanned =
967 (char *)lp_parm_const_string(SNUM(handle->conn),
968 "scannedonly",
969 "pref_scanned",
970 ".scanned:");
971 so->p_virus =
972 (char *)lp_parm_const_string(SNUM(handle->conn),
973 "scannedonly",
974 "pref_virus",
975 ".virus:");
976 so->p_failed =
977 (char *)lp_parm_const_string(SNUM(handle->conn),
978 "scannedonly",
979 "pref_failed",
980 ".failed:");
981 connect_to_scanner(handle);
983 return SMB_VFS_NEXT_CONNECT(handle, service, user);
986 /* VFS operations structure */
987 static struct vfs_fn_pointers vfs_scannedonly_fns = {
988 .opendir = scannedonly_opendir,
989 .readdir = scannedonly_readdir,
990 .seekdir = scannedonly_seekdir,
991 .telldir = scannedonly_telldir,
992 .rewind_dir = scannedonly_rewinddir,
993 .closedir = scannedonly_closedir,
994 .rmdir = scannedonly_rmdir,
995 .stat = scannedonly_stat,
996 .lstat = scannedonly_lstat,
997 .open = scannedonly_open,
998 .close_fn = scannedonly_close,
999 .rename = scannedonly_rename,
1000 .unlink = scannedonly_unlink,
1001 .connect_fn = scannedonly_connect
1004 NTSTATUS vfs_scannedonly_init(void)
1006 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "scannedonly",
1007 &vfs_scannedonly_fns);