howto/VFS.xml

   1 <chapter id="VFS">
   2 <chapterinfo>
   3         &author.jelmer;
   4         &author.jht;
   5         &author.tpot;
   6         <author><firstname>Simo</firstname><surname>Sorce</surname><contrib>original vfs_skel README</contrib></author>
   7         <author><firstname>Alexander</firstname><surname>Bokovoy</surname><contrib>original vfs_netatalk docs</contrib></author>
   8         <author><firstname>Stefan</firstname><surname>Metzmacher</surname><contrib>Update for multiple modules</contrib></author>
   9 </chapterinfo>
  10 <title>Stackable VFS modules</title>
  11
  12 <sect1>
  13 <title>Features and Benefits</title>
  14
  15 <para>
  16 Since Samba-3, there is support for stackable VFS (Virtual File System) modules.
  17 Samba passes each request to access the UNIX file system through the loaded VFS modules.
  18 This chapter covers all the modules that come with the Samba source and references to
  19 some external modules.
  20 </para>
  21
  22
  23 </sect1>
  24
  25 <sect1>
  26 <title>Discussion</title>
  27
  28 <para>
  29 If not supplied with your platform distribution binary Samba package you may have problems
  30 compiling these modules, as shared libraries are compiled and linked in different ways
  31 on different systems. They currently have been tested against GNU/Linux and IRIX.
  32 </para>
  33
  34 <para>
  35 To use the VFS modules, create a share similar to the one below. The
  36 important parameter is the <smbconfoption><name>vfs objects</name></smbconfoption> parameter where
  37 you can list one or more VFS modules by name. For example, to log all access
  38 to files and put deleted files in a recycle bin, see <link linkend="vfsrecyc">next configuration</link>:
  39
  40 <smbconfexample id="vfsrecyc">
  41         <title>smb.conf with VFS modules</title>
  42         <smbconfsection>[audit]</smbconfsection>
  43 <smbconfoption><name>comment</name><value>Audited /data directory</value></smbconfoption>
  44 <smbconfoption><name>path</name><value>/data</value></smbconfoption>
  45 <smbconfoption><name>vfs objects</name><value>audit recycle</value></smbconfoption>
  46 <smbconfoption><name>writable</name><value>yes</value></smbconfoption>
  47 <smbconfoption><name>browseable</name><value>yes</value></smbconfoption>
  48         </smbconfexample>
  49 </para>
  50
  51 <para>
  52 The modules are used in the order in which they are specified.
  53 Let's say that you want to both have a virus scanner module and a recycle
  54 bin module. It is wise to put the virus scanner module as the first one so
  55 that it is the first that get run an may detect a virus immediately, before
  56 any action is performed on that file.
  57 <smbconfoption><name>vfs objects</name><value>vscan-clamav recycle</value></smbconfoption>
  58 </para>
  59
  60 <para>
  61 Samba will attempt to load modules from the <filename>/lib</filename> directory in the root directory of the
  62 Samba installation (usually <filename>/usr/lib/samba/vfs</filename> or <filename>/usr/local/samba/lib/vfs
  63 </filename>).
  64 </para>
  65
  66 <para>
  67 Some modules can be used twice for the same share.
  68 This can be done using a configuration similar to the one shown in <link linkend="multimodule">the following example</link>.
  69
  70 <smbconfexample id="multimodule">
  71         <title>smb.conf with multiple VFS modules</title>
  72 <smbconfsection>[test]</smbconfsection>
  73 <smbconfoption><name>comment</name><value>VFS TEST</value></smbconfoption>
  74 <smbconfoption><name>path</name><value>/data</value></smbconfoption>
  75 <smbconfoption><name>writeable</name><value>yes</value></smbconfoption>
  76 <smbconfoption><name>browseable</name><value>yes</value></smbconfoption>
  77 <smbconfoption><name>vfs objects</name><value>example:example1 example example:test</value></smbconfoption>
  78 <smbconfoption><name>example1: parameter</name><value>1</value></smbconfoption>
  79 <smbconfoption><name>example:  parameter</name><value>5</value></smbconfoption>
  80 <smbconfoption><name>test:        parameter</name><value>7</value></smbconfoption>
  81 </smbconfexample>
  82 </para>
  83
  84 </sect1>
  85
  86 <sect1>
  87 <title>Included Modules</title>
  88
  89         <sect2>
  90         <title>audit</title>
  91
  92                 <para>
  93                 A simple module to audit file access to the syslog
  94                 facility. The following operations are logged:
  95                 <itemizedlist>
  96                         <listitem>share</listitem>
  97                         <listitem>connect/disconnect</listitem>
  98                         <listitem>directory opens/create/remove</listitem>
  99                         <listitem>file open/close/rename/unlink/chmod</listitem>
 100                 </itemizedlist>
 101                 </para>
 102
 103         </sect2>
 104
 105         <sect2>
 106         <title>extd_audit</title>
 107
 108                 <para>
 109                 This module is identical with the <command>audit</command> module above except
 110                 that it sends audit logs to both syslog as well as the <command>smbd</command> log files. The
 111                 <smbconfoption><name>log level</name></smbconfoption> for this module is set in the &smb.conf; file.
 112                 </para>
 113
 114                 <para>
 115                 Valid settings and the information that will be recorded are shown in <link linkend="xtdaudit">the next table</link>.
 116                 </para>
 117
 118                 <table frame="all" id="xtdaudit">
 119                         <title>Extended Auditing Log Information</title>
 120                 <tgroup cols="2" align="center">
 121                         <thead>
 122                         <row><entry align="center">Log Level</entry><entry>Log Details - File and Directory Operations</entry></row>
 123                         </thead>
 124                         <tbody>
 125                         <row><entry align="center">0</entry><entry align="left">Creation / Deletion</entry></row>
 126                         <row><entry align="center">1</entry><entry align="left">Create / Delete / Rename / Permission Changes</entry></row>
 127                         <row><entry align="center">2</entry><entry align="left">Create / Delete / Rename / Perm Change / Open / Close</entry></row>
 128                         </tbody>
 129                 </tgroup>
 130                 </table>
 131
 132         </sect2>
 133
 134         <sect2 id="fakeperms">
 135         <title>fake_perms</title>
 136
 137                 <para>
 138                 This module was created to allow Roaming Profile files and directories to be set (on the Samba server
 139                 under UNIX) as read only. This module will, if installed on the Profiles share, report to the client
 140                 that the Profile files and directories are writable. This satisfies the client even though the files
 141                 will never be overwritten as the client logs out or shuts down.
 142                 </para>
 143
 144         </sect2>
 145
 146         <sect2>
 147         <title>recycle</title>
 148
 149                 <para>
 150                 A Recycle Bin-like module. Where used, unlink calls will be intercepted and files moved
 151                 to the recycle directory instead of being deleted. This gives the same effect as the
 152                 <guiicon>Recycle Bin</guiicon> on Windows computers.
 153                 </para>
 154
 155                 <para>
 156                 The <guiicon>Recycle Bin</guiicon> will not appear in <application>Windows Explorer</application> views of the network file system
 157                 (share) nor on any mapped drive. Instead, a directory called <filename>.recycle</filename> will be
 158                 automatically created when the first file is deleted. Users can recover files from the
 159                 <filename>.recycle</filename> directory. If the <parameter>recycle:keeptree</parameter> has been
 160                 specified, deleted files will be found in a path identical with that from which the file was deleted.
 161                 </para>
 162
 163                 <para>Supported options for the <command>recycle</command> module are as follow:
 164                 <variablelist>
 165                         <varlistentry>
 166                         <term>recycle:repository</term>
 167                                 <listitem><para>
 168                                 Relative path of the directory where deleted files should be moved.
 169                                 </para></listitem>
 170                         </varlistentry>
 171
 172                         <varlistentry>
 173                         <term>recycle:keeptree</term>
 174                                 <listitem><para>
 175                                 Specifies whether the directory structure should be kept or if the files in the directory that is being
 176                                 deleted should be kept separately in the recycle bin.
 177                                 </para></listitem>
 178                         </varlistentry>
 179
 180                         <varlistentry>
 181                         <term>recycle:versions</term>
 182                                 <listitem><para>
 183                                 If this option is set, two files
 184                                 with the same name that are deleted will both
 185                                 be kept in the recycle bin. Newer deleted versions
 186                                 of a file will be called <quote>Copy #x of <replaceable>filename</replaceable></quote>.
 187                                 </para></listitem>
 188                         </varlistentry>
 189
 190                         <varlistentry>
 191                         <term>recycle:touch</term>
 192                                 <listitem><para>
 193                                 Specifies whether a file's access date should be touched when the file is moved to the recycle bin.
 194                                 </para></listitem>
 195                         </varlistentry>
 196
 197                         <varlistentry>
 198                         <term>recycle:maxsize</term>
 199                                 <listitem><para>
 200                                 Files that are larger than the number of bytes specified by this parameter will not be put into the recycle bin.
 201                                 </para></listitem>
 202                         </varlistentry>
 203
 204                         <varlistentry>
 205                         <term>recycle:exclude</term>
 206                                 <listitem><para>
 207                                 List of files that should not be put into the recycle bin when deleted, but deleted in the regular way.
 208                                 </para></listitem>
 209                         </varlistentry>
 210
 211                         <varlistentry>
 212                         <term>recycle:exclude_dir</term>
 213                                 <listitem><para>
 214                                 Contains a list of directories. When files from these directories are
 215                                 deleted, they are not put into the
 216                                 recycle bin but are deleted in the
 217                                 regular way.
 218                                 </para></listitem>
 219                         </varlistentry>
 220
 221                         <varlistentry>
 222                         <term>recycle:noversions</term>
 223                                 <listitem><para>
 224                                 Opposite of <parameter>recycle:versions</parameter>. If both options are specified, this one takes precedence.
 225                                 </para></listitem>
 226                         </varlistentry>
 227                 </variablelist>
 228                 </para>
 229
 230         </sect2>
 231
 232         <sect2>
 233         <title>netatalk</title>
 234
 235                 <para>
 236                 A netatalk module will ease co-existence of Samba and netatalk file sharing services.
 237                 </para>
 238
 239                 <para>Advantages compared to the old netatalk module:
 240                 <itemizedlist>
 241                         <listitem><para>Does not care about creating .AppleDouble forks, just keeps them in sync.</para></listitem>
 242                         <listitem><para>If a share in &smb.conf; does not contain .AppleDouble item in hide or veto list, it will be added automatically.</para></listitem>
 243                 </itemizedlist>
 244                 </para>
 245
 246         </sect2>
 247
 248 </sect1>
 249
 250 <sect1>
 251 <title>VFS Modules Available Elsewhere</title>
 252
 253 <para>
 254 This section contains a listing of various other VFS modules that
 255 have been posted but do not currently reside in the Samba CVS
 256 tree for one reason or another (e.g., it is easy for the maintainer
 257 to have his or her own CVS tree).
 258 </para>
 259
 260 <para>
 261 No statements about the stability or functionality of any module
 262 should be implied due to its presence here.
 263 </para>
 264
 265         <sect2>
 266         <title>DatabaseFS</title>
 267
 268                 <para>
 269                 URL: <ulink noescape="1" url="http://www.css.tayloru.edu/~elorimer/databasefs/index.php">http://www.css.tayloru.edu/~elorimer/databasefs/index.php</ulink>
 270                 </para>
 271
 272                 <para>By <ulink url="mailto:elorimer@css.tayloru.edu">Eric Lorimer.</ulink></para>
 273
 274                 <para>
 275                 I have created a VFS module that implements a fairly complete read-only
 276                 filesystem. It presents information from a database as a filesystem in
 277                 a modular and generic way to allow different databases to be used
 278                 (originally designed for organizing MP3s under directories such as
 279                 <quote>Artists,</quote> <quote>Song Keywords,</quote> and so on. I have since easily
 280                 applied it to a student
 281                 roster database.) The directory structure is stored in the
 282                 database itself and the module makes no assumptions about the database
 283                 structure beyond the table it requires to run.
 284                 </para>
 285
 286                 <para>
 287                 Any feedback would be appreciated: comments, suggestions, patches,
 288                 and so on. If nothing else, hopefully it might prove useful for someone
 289                 else who wishes to create a virtual filesystem.
 290                 </para>
 291
 292         </sect2>
 293
 294         <sect2>
 295         <title>vscan</title>
 296
 297         <para>URL: <ulink noescape="1" url="http://www.openantivirus.org/">http://www.openantivirus.org/</ulink></para>
 298
 299                 <para>
 300                 <filename>samba-vscan</filename> is a proof-of-concept module for Samba, which
 301                 uses the VFS (virtual file system) features of Samba 2.2.x/3.0
 302                 alphaX. Of course, Samba has to be compiled with VFS support.
 303                 <filename>samba-vscan</filename> supports various virus scanners and is maintained
 304                 by Rainer Link.
 305                 </para>
 306
 307         </sect2>
 308 </sect1>
 309
 310 </chapter>