| 1 | .\" Title: vfs_scannedonly
|
|---|
| 2 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 3 | .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
|
|---|
| 4 | .\" Date: 06/18/2010
|
|---|
| 5 | .\" Manual: System Administration tools
|
|---|
| 6 | .\" Source: Samba 3.5
|
|---|
| 7 | .\" Language: English
|
|---|
| 8 | .\"
|
|---|
| 9 | .TH "VFS_SCANNEDONLY" "8" "06/18/2010" "Samba 3\&.5" "System Administration tools"
|
|---|
| 10 | .\" -----------------------------------------------------------------
|
|---|
| 11 | .\" * (re)Define some macros
|
|---|
| 12 | .\" -----------------------------------------------------------------
|
|---|
| 13 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 14 | .\" toupper - uppercase a string (locale-aware)
|
|---|
| 15 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 16 | .de toupper
|
|---|
| 17 | .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
|
|---|
| 18 | \\$*
|
|---|
| 19 | .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
|
|---|
| 20 | ..
|
|---|
| 21 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 22 | .\" SH-xref - format a cross-reference to an SH section
|
|---|
| 23 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 24 | .de SH-xref
|
|---|
| 25 | .ie n \{\
|
|---|
| 26 | .\}
|
|---|
| 27 | .toupper \\$*
|
|---|
| 28 | .el \{\
|
|---|
| 29 | \\$*
|
|---|
| 30 | .\}
|
|---|
| 31 | ..
|
|---|
| 32 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 33 | .\" SH - level-one heading that works better for non-TTY output
|
|---|
| 34 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 35 | .de1 SH
|
|---|
| 36 | .\" put an extra blank line of space above the head in non-TTY output
|
|---|
| 37 | .if t \{\
|
|---|
| 38 | .sp 1
|
|---|
| 39 | .\}
|
|---|
| 40 | .sp \\n[PD]u
|
|---|
| 41 | .nr an-level 1
|
|---|
| 42 | .set-an-margin
|
|---|
| 43 | .nr an-prevailing-indent \\n[IN]
|
|---|
| 44 | .fi
|
|---|
| 45 | .in \\n[an-margin]u
|
|---|
| 46 | .ti 0
|
|---|
| 47 | .HTML-TAG ".NH \\n[an-level]"
|
|---|
| 48 | .it 1 an-trap
|
|---|
| 49 | .nr an-no-space-flag 1
|
|---|
| 50 | .nr an-break-flag 1
|
|---|
| 51 | \." make the size of the head bigger
|
|---|
| 52 | .ps +3
|
|---|
| 53 | .ft B
|
|---|
| 54 | .ne (2v + 1u)
|
|---|
| 55 | .ie n \{\
|
|---|
| 56 | .\" if n (TTY output), use uppercase
|
|---|
| 57 | .toupper \\$*
|
|---|
| 58 | .\}
|
|---|
| 59 | .el \{\
|
|---|
| 60 | .nr an-break-flag 0
|
|---|
| 61 | .\" if not n (not TTY), use normal case (not uppercase)
|
|---|
| 62 | \\$1
|
|---|
| 63 | .in \\n[an-margin]u
|
|---|
| 64 | .ti 0
|
|---|
| 65 | .\" if not n (not TTY), put a border/line under subheading
|
|---|
| 66 | .sp -.6
|
|---|
| 67 | \l'\n(.lu'
|
|---|
| 68 | .\}
|
|---|
| 69 | ..
|
|---|
| 70 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 71 | .\" SS - level-two heading that works better for non-TTY output
|
|---|
| 72 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 73 | .de1 SS
|
|---|
| 74 | .sp \\n[PD]u
|
|---|
| 75 | .nr an-level 1
|
|---|
| 76 | .set-an-margin
|
|---|
| 77 | .nr an-prevailing-indent \\n[IN]
|
|---|
| 78 | .fi
|
|---|
| 79 | .in \\n[IN]u
|
|---|
| 80 | .ti \\n[SN]u
|
|---|
| 81 | .it 1 an-trap
|
|---|
| 82 | .nr an-no-space-flag 1
|
|---|
| 83 | .nr an-break-flag 1
|
|---|
| 84 | .ps \\n[PS-SS]u
|
|---|
| 85 | \." make the size of the head bigger
|
|---|
| 86 | .ps +2
|
|---|
| 87 | .ft B
|
|---|
| 88 | .ne (2v + 1u)
|
|---|
| 89 | .if \\n[.$] \&\\$*
|
|---|
| 90 | ..
|
|---|
| 91 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 92 | .\" BB/BE - put background/screen (filled box) around block of text
|
|---|
| 93 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 94 | .de BB
|
|---|
| 95 | .if t \{\
|
|---|
| 96 | .sp -.5
|
|---|
| 97 | .br
|
|---|
| 98 | .in +2n
|
|---|
| 99 | .ll -2n
|
|---|
| 100 | .gcolor red
|
|---|
| 101 | .di BX
|
|---|
| 102 | .\}
|
|---|
| 103 | ..
|
|---|
| 104 | .de EB
|
|---|
| 105 | .if t \{\
|
|---|
| 106 | .if "\\$2"adjust-for-leading-newline" \{\
|
|---|
| 107 | .sp -1
|
|---|
| 108 | .\}
|
|---|
| 109 | .br
|
|---|
| 110 | .di
|
|---|
| 111 | .in
|
|---|
| 112 | .ll
|
|---|
| 113 | .gcolor
|
|---|
| 114 | .nr BW \\n(.lu-\\n(.i
|
|---|
| 115 | .nr BH \\n(dn+.5v
|
|---|
| 116 | .ne \\n(BHu+.5v
|
|---|
| 117 | .ie "\\$2"adjust-for-leading-newline" \{\
|
|---|
| 118 | \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
|
|---|
| 119 | .\}
|
|---|
| 120 | .el \{\
|
|---|
| 121 | \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
|
|---|
| 122 | .\}
|
|---|
| 123 | .in 0
|
|---|
| 124 | .sp -.5v
|
|---|
| 125 | .nf
|
|---|
| 126 | .BX
|
|---|
| 127 | .in
|
|---|
| 128 | .sp .5v
|
|---|
| 129 | .fi
|
|---|
| 130 | .\}
|
|---|
| 131 | ..
|
|---|
| 132 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 133 | .\" BM/EM - put colored marker in margin next to block of text
|
|---|
| 134 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 135 | .de BM
|
|---|
| 136 | .if t \{\
|
|---|
| 137 | .br
|
|---|
| 138 | .ll -2n
|
|---|
| 139 | .gcolor red
|
|---|
| 140 | .di BX
|
|---|
| 141 | .\}
|
|---|
| 142 | ..
|
|---|
| 143 | .de EM
|
|---|
| 144 | .if t \{\
|
|---|
| 145 | .br
|
|---|
| 146 | .di
|
|---|
| 147 | .ll
|
|---|
| 148 | .gcolor
|
|---|
| 149 | .nr BH \\n(dn
|
|---|
| 150 | .ne \\n(BHu
|
|---|
| 151 | \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
|
|---|
| 152 | .in 0
|
|---|
| 153 | .nf
|
|---|
| 154 | .BX
|
|---|
| 155 | .in
|
|---|
| 156 | .fi
|
|---|
| 157 | .\}
|
|---|
| 158 | ..
|
|---|
| 159 | .\" -----------------------------------------------------------------
|
|---|
| 160 | .\" * set default formatting
|
|---|
| 161 | .\" -----------------------------------------------------------------
|
|---|
| 162 | .\" disable hyphenation
|
|---|
| 163 | .nh
|
|---|
| 164 | .\" disable justification (adjust text to left margin only)
|
|---|
| 165 | .ad l
|
|---|
| 166 | .\" -----------------------------------------------------------------
|
|---|
| 167 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 168 | .\" -----------------------------------------------------------------
|
|---|
| 169 | .SH "Name"
|
|---|
| 170 | vfs_scannedonly \- Ensures that only files that have been scanned for viruses are visible and accessible to the end user\&.
|
|---|
| 171 | .SH "Synopsis"
|
|---|
| 172 | .fam C
|
|---|
| 173 | .HP \w'\ 'u
|
|---|
| 174 | \FCvfs objects = scannedonly\F[]
|
|---|
| 175 | .fam
|
|---|
| 176 | .SH "DESCRIPTION"
|
|---|
| 177 | .PP
|
|---|
| 178 | This VFS module is part of the
|
|---|
| 179 | \fBsamba\fR(8)
|
|---|
| 180 | suite\&.
|
|---|
| 181 | .PP
|
|---|
| 182 | The
|
|---|
| 183 | \FCvfs_scannedonly\F[]
|
|---|
| 184 | VFS module ensures that only files that have been scanned for viruses are visible and accessible to the end user\&. If non\-scanned files are found an anti\-virus scanning daemon is notified\&. The anti\-virus scanning daemon is not part of the Samba suite\&.
|
|---|
| 185 | .PP
|
|---|
| 186 | Scannedonly comes in two parts: a samba vfs module and (one or more) daemons\&. The daemon scans files\&. If a certain file is clean, a second file is created with prefix
|
|---|
| 187 | \FC\&.scanned:\F[]\&. The Samba module simply looks if such a
|
|---|
| 188 | \FC\&.scanned:\F[]
|
|---|
| 189 | file exists, and is newer than the pertinent file\&. If this is the case, the file is shown to the user\&. If this is not the case, the file is not returned in a directory listing (configurable), and cannot be opened (configurable)\&. The Samba vfs module will notify the daemon to scan this file\&.
|
|---|
| 190 | .PP
|
|---|
| 191 | So what happens for the user in the default configuration\&. The first time a directory is listed, it shows files as \'file is being scanned for viruses, but after the first time all files are shown\&. There is a utility scannedonly_prescan that can help you to prescan all directories\&. When new files are written the daemon is notified immediately after the file is complete\&.
|
|---|
| 192 | .PP
|
|---|
| 193 | If a virus is found by the daemon, a file with a warning message is created in the directory of the user, a warning is sent to the logs, and the file is renamed to have prefix
|
|---|
| 194 | \FC\&.virus:\F[]\&. Files with the
|
|---|
| 195 | \FC\&.virus:\F[]
|
|---|
| 196 | prefix are never shown to the user and all access is denied\&.
|
|---|
| 197 | .PP
|
|---|
| 198 | This module is stackable\&.
|
|---|
| 199 | .SH "CONFIGURATION"
|
|---|
| 200 | .PP
|
|---|
| 201 | \FCvfs_scannedonly\F[]
|
|---|
| 202 | relies on a anti\-virus scanning daemon that listens on the scannedonly socket (unix domain socket or UDP socket)\&.
|
|---|
| 203 | .SH "OPTIONS"
|
|---|
| 204 | .PP
|
|---|
| 205 | scannedonly:domain_socket = True
|
|---|
| 206 | .RS 4
|
|---|
| 207 | Whether to use a unix domain socket or not (false reverts to use udp)
|
|---|
| 208 | .RE
|
|---|
| 209 | .PP
|
|---|
| 210 | scannedonly:socketname = /var/lib/scannedonly/scan
|
|---|
| 211 | .RS 4
|
|---|
| 212 | The location of the unix domain socket to connect to
|
|---|
| 213 | .RE
|
|---|
| 214 | .PP
|
|---|
| 215 | scannedonly:portnum = 2020
|
|---|
| 216 | .RS 4
|
|---|
| 217 | The udp port number to connect to
|
|---|
| 218 | .RE
|
|---|
| 219 | .PP
|
|---|
| 220 | scannedonly:scanhost = localhost
|
|---|
| 221 | .RS 4
|
|---|
| 222 | When using UDP the host that runs the scanning daemon (this host needs access to the files!)
|
|---|
| 223 | .RE
|
|---|
| 224 | .PP
|
|---|
| 225 | scannedonly:show_special_files = True
|
|---|
| 226 | .RS 4
|
|---|
| 227 | Whether sockets, devices and fifo\'s (all not scanned for viruses) should be visible to the user
|
|---|
| 228 | .RE
|
|---|
| 229 | .PP
|
|---|
| 230 | scannedonly:rm_hidden_files_on_rmdir = True
|
|---|
| 231 | .RS 4
|
|---|
| 232 | Whether files that are not visible (\FC\&.scanned:\F[]
|
|---|
| 233 | files,
|
|---|
| 234 | \FC\&.failed:\F[]
|
|---|
| 235 | files and
|
|---|
| 236 | \FC\&.virus: \F[]
|
|---|
| 237 | files) should be deleted if the user tries to remove the directory\&. If false, the user will get the "directory is not empty" error\&.
|
|---|
| 238 | .RE
|
|---|
| 239 | .PP
|
|---|
| 240 | scannedonly:hide_nonscanned_files = True
|
|---|
| 241 | .RS 4
|
|---|
| 242 | If false, all non\-scanned files are visible in directory listings\&. If such files are found in a directory listing the scanning daemon is notified that scanning is required\&. Access to non\-scanned files is still denied (see scannedonly:allow_nonscanned_files)\&.
|
|---|
| 243 | .RE
|
|---|
| 244 | .PP
|
|---|
| 245 | scannedonly:scanning_message = is being scanned for viruses
|
|---|
| 246 | .RS 4
|
|---|
| 247 | If non\-scanned files are hidden (if scannedonly:hide_nonscanned_files = True), a fake 0 byte file is shown\&. The filename is the original filename with the message as suffix\&.
|
|---|
| 248 | .RE
|
|---|
| 249 | .PP
|
|---|
| 250 | scannedonly:recheck_time_open = 50
|
|---|
| 251 | .RS 4
|
|---|
| 252 | If a non\-scanned file is opened, the vfs module will wait recheck_tries_open times for recheck_time_open milliseconds for the scanning daemon to create a
|
|---|
| 253 | \FC\&.scanned:\F[]
|
|---|
| 254 | file\&. For small files that are scanned by the daemon within the time (tries * time) the behavior will be just like on\-access scanning\&.
|
|---|
| 255 | .RE
|
|---|
| 256 | .PP
|
|---|
| 257 | scannedonly:recheck_tries_open = 100
|
|---|
| 258 | .RS 4
|
|---|
| 259 | See recheck_time_open\&.
|
|---|
| 260 | .RE
|
|---|
| 261 | .PP
|
|---|
| 262 | scannedonly:recheck_time_readdir = 50
|
|---|
| 263 | .RS 4
|
|---|
| 264 | If a non\-scanned file is in a directory listing the vfs module notifies the daemon (once for all files that need scanning in that directory), and waits recheck_tries_readdir times for recheck_time_readdir milliseconds\&. Only used when hide_nonscanned_files is false\&.
|
|---|
| 265 | .RE
|
|---|
| 266 | .PP
|
|---|
| 267 | scannedonly:recheck_tries_readdir = 20
|
|---|
| 268 | .RS 4
|
|---|
| 269 | See recheck_time_readdir\&.
|
|---|
| 270 | .RE
|
|---|
| 271 | .PP
|
|---|
| 272 | scannedonly:allow_nonscanned_files = False
|
|---|
| 273 | .RS 4
|
|---|
| 274 | Allow access to non\-scanned files\&. The daemon is notified, however, and special files such as
|
|---|
| 275 | \FC\&.scanned:\F[]
|
|---|
| 276 | files\&.
|
|---|
| 277 | \FC\&.virus:\F[]
|
|---|
| 278 | files and
|
|---|
| 279 | \FC\&.failed:\F[]
|
|---|
| 280 | files are not listed\&.
|
|---|
| 281 | .RE
|
|---|
| 282 | .SH "EXAMPLES"
|
|---|
| 283 | .PP
|
|---|
| 284 | Enable anti\-virus scanning:
|
|---|
| 285 | .sp
|
|---|
| 286 | .if n \{\
|
|---|
| 287 | .RS 4
|
|---|
| 288 | .\}
|
|---|
| 289 | .fam C
|
|---|
| 290 | .ps -1
|
|---|
| 291 | .nf
|
|---|
| 292 | .if t \{\
|
|---|
| 293 | .sp -1
|
|---|
| 294 | .\}
|
|---|
| 295 | .BB lightgray adjust-for-leading-newline
|
|---|
| 296 | .sp -1
|
|---|
| 297 |
|
|---|
| 298 | \fI[homes]\fR
|
|---|
| 299 | \m[blue]\fBvfs objects = scannedonly\fR\m[]
|
|---|
| 300 | \m[blue]\fBscannedonly:hide_nonscanned_files = False\fR\m[]
|
|---|
| 301 | .EB lightgray adjust-for-leading-newline
|
|---|
| 302 | .if t \{\
|
|---|
| 303 | .sp 1
|
|---|
| 304 | .\}
|
|---|
| 305 | .fi
|
|---|
| 306 | .fam
|
|---|
| 307 | .ps +1
|
|---|
| 308 | .if n \{\
|
|---|
| 309 | .RE
|
|---|
| 310 | .\}
|
|---|
| 311 | .SH "CAVEATS"
|
|---|
| 312 | .PP
|
|---|
| 313 | This is not true on\-access scanning\&. However, it is very fast for files that have been scanned already\&.
|
|---|
| 314 | .SH "VERSION"
|
|---|
| 315 | .PP
|
|---|
| 316 | This man page is correct for version 3\&.5\&.0 of the Samba suite\&.
|
|---|
| 317 | .SH "AUTHOR"
|
|---|
| 318 | .PP
|
|---|
| 319 | The original Samba software and related utilities were created by Andrew Tridgell\&. Scannedonly was developed for Samba by Olivier Sessink\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
|
|---|
