docs-xml/manpages-3/vfs_full_audit.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_full_audit.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_full_audit</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">3.6</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_full_audit</refname>
  16         <refpurpose>record Samba VFS operations in the system log</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = full_audit</command>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This VFS module is part of the
  29         <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para>The <command>vfs_full_audit</command> VFS module records selected
  33         client operations to the system log using
  34         <citerefentry><refentrytitle>syslog</refentrytitle>
  35         <manvolnum>3</manvolnum></citerefentry>.</para>
  36
  37         <para><command>vfs_full_audit</command> is able to record the
  38         complete set of Samba VFS operations:</para>
  39
  40         <simplelist>
  41         <member>aio_cancel</member>
  42         <member>aio_error</member>
  43         <member>aio_fsync</member>
  44         <member>aio_read</member>
  45         <member>aio_return</member>
  46         <member>aio_suspend</member>
  47         <member>aio_write</member>
  48         <member>chdir</member>
  49         <member>chflags</member>
  50         <member>chmod</member>
  51         <member>chmod_acl</member>
  52         <member>chown</member>
  53         <member>close</member>
  54         <member>closedir</member>
  55         <member>connect</member>
  56         <member>disconnect</member>
  57         <member>disk_free</member>
  58         <member>fchmod</member>
  59         <member>fchmod_acl</member>
  60         <member>fchown</member>
  61         <member>fget_nt_acl</member>
  62         <member>fgetxattr</member>
  63         <member>flistxattr</member>
  64         <member>fremovexattr</member>
  65         <member>fset_nt_acl</member>
  66         <member>fsetxattr</member>
  67         <member>fstat</member>
  68         <member>fsync</member>
  69         <member>ftruncate</member>
  70         <member>get_nt_acl</member>
  71         <member>get_quota</member>
  72         <member>get_shadow_copy_data</member>
  73         <member>getlock</member>
  74         <member>getwd</member>
  75         <member>getxattr</member>
  76         <member>kernel_flock</member>
  77         <member>link</member>
  78         <member>linux_setlease</member>
  79         <member>listxattr</member>
  80         <member>lock</member>
  81         <member>lseek</member>
  82         <member>lstat</member>
  83         <member>mkdir</member>
  84         <member>mknod</member>
  85         <member>open</member>
  86         <member>opendir</member>
  87         <member>pread</member>
  88         <member>pwrite</member>
  89         <member>read</member>
  90         <member>readdir</member>
  91         <member>readlink</member>
  92         <member>realpath</member>
  93         <member>removexattr</member>
  94         <member>rename</member>
  95         <member>rewinddir</member>
  96         <member>rmdir</member>
  97         <member>seekdir</member>
  98         <member>sendfile</member>
  99         <member>set_nt_acl</member>
 100         <member>set_quota</member>
 101         <member>setxattr</member>
 102         <member>stat</member>
 103         <member>statvfs</member>
 104         <member>symlink</member>
 105         <member>sys_acl_add_perm</member>
 106         <member>sys_acl_clear_perms</member>
 107         <member>sys_acl_create_entry</member>
 108         <member>sys_acl_delete_def_file</member>
 109         <member>sys_acl_free_acl</member>
 110         <member>sys_acl_free_qualifier</member>
 111         <member>sys_acl_free_text</member>
 112         <member>sys_acl_get_entry</member>
 113         <member>sys_acl_get_fd</member>
 114         <member>sys_acl_get_file</member>
 115         <member>sys_acl_get_perm</member>
 116         <member>sys_acl_get_permset</member>
 117         <member>sys_acl_get_qualifier</member>
 118         <member>sys_acl_get_tag_type</member>
 119         <member>sys_acl_init</member>
 120         <member>sys_acl_set_fd</member>
 121         <member>sys_acl_set_file</member>
 122         <member>sys_acl_set_permset</member>
 123         <member>sys_acl_set_qualifier</member>
 124         <member>sys_acl_set_tag_type</member>
 125         <member>sys_acl_to_text</member>
 126         <member>sys_acl_valid</member>
 127         <member>telldir</member>
 128         <member>unlink</member>
 129         <member>utime</member>
 130         <member>write</member>
 131         </simplelist>
 132
 133         <para>In addition to these operations,
 134         <command>vfs_full_audit</command> recognizes the special operation
 135         names &quot;all&quot; and &quot;none &quot;, which refer to all
 136         the VFS operations and none of the VFS operations respectively.
 137         </para>
 138
 139         <para><command>vfs_full_audit</command> records operations in fixed
 140         format consisting of fields separated by '|' characters. The
 141         format is: </para>
 142         <programlisting>
 143                 smbd_audit: PREFIX|OPERATION|RESULT|FILE
 144         </programlisting>
 145
 146         <para>The record fields are:</para>
 147
 148         <itemizedlist>
 149         <listitem><para><command>PREFIX</command> - the result of the full_audit:prefix string after variable substitutions</para></listitem>
 150         <listitem><para><command>OPERATION</command> - the name of the VFS operation</para></listitem>
 151         <listitem><para><command>RESULT</command> - whether the operation succeeded or failed</para></listitem>
 152         <listitem><para><command>FILE</command> - the name of the file or directory the operation was performed on</para></listitem>
 153
 154         </itemizedlist>
 155
 156         <para>This module is stackable.</para>
 157
 158 </refsect1>
 159
 160
 161 <refsect1>
 162         <title>OPTIONS</title>
 163
 164         <variablelist>
 165
 166                 <varlistentry>
 167                 <term>vfs_full_audit:prefix = STRING</term>
 168                 <listitem>
 169                 <para>Prepend audit messages with STRING. STRING is
 170                 processed for standard substitution variables listed in
 171                 <citerefentry><refentrytitle>smb.conf</refentrytitle>
 172                 <manvolnum>5</manvolnum></citerefentry>. The default
 173                 prefix is &quot;%u|%I&quot;. </para>
 174
 175                 </listitem>
 176                 </varlistentry>
 177
 178                 <varlistentry>
 179                 <term>vfs_full_audit:success = LIST</term>
 180                 <listitem>
 181                 <para>LIST is a list of VFS operations that should be
 182                 recorded if they succeed. Operations are specified using
 183                 the names listed above. Operations can be unset by prefixing
 184                 the names with "!".
 185                 </para>
 186
 187                 </listitem>
 188                 </varlistentry>
 189
 190                 <varlistentry>
 191                 <term>vfs_full_audit:failure = LIST</term>
 192                 <listitem>
 193                 <para>LIST is a list of VFS operations that should be
 194                 recorded if they failed. Operations are specified using
 195                 the names listed above. Operations can be unset by prefixing
 196                 the names with "!".
 197                 </para>
 198
 199                 </listitem>
 200                 </varlistentry>
 201
 202                 <varlistentry>
 203                 <term>full_audit:facility = FACILITY</term>
 204                 <listitem>
 205                 <para>Log messages to the named
 206                 <citerefentry><refentrytitle>syslog</refentrytitle>
 207                 <manvolnum>3</manvolnum></citerefentry> facility.
 208
 209                 </para>
 210
 211                 </listitem>
 212                 </varlistentry>
 213
 214                 <varlistentry>
 215                 <term>full_audit:priority = PRIORITY</term>
 216                 <listitem>
 217                 <para>Log messages with the named
 218                 <citerefentry><refentrytitle>syslog</refentrytitle>
 219                 <manvolnum>3</manvolnum></citerefentry> priority.
 220                 </para>
 221
 222                 </listitem>
 223                 </varlistentry>
 224
 225         </variablelist>
 226 </refsect1>
 227
 228 <refsect1>
 229         <title>EXAMPLES</title>
 230
 231         <para>Log file and directory open operations on the [records]
 232         share using the LOCAL7 facility and ALERT priority, including
 233         the username and IP address. Logging excludes the open VFS function
 234         on failures:</para>
 235
 236 <programlisting>
 237         <smbconfsection name="[records]"/>
 238         <smbconfoption name="path">/data/records</smbconfoption>
 239         <smbconfoption name="vfs objects">full_audit</smbconfoption>
 240         <smbconfoption name="full_audit:prefix">%u|%I</smbconfoption>
 241         <smbconfoption name="full_audit:success">open opendir</smbconfoption>
 242         <smbconfoption name="full_audit:failure">all !open</smbconfoption>
 243         <smbconfoption name="full_audit:facility">LOCAL7</smbconfoption>
 244         <smbconfoption name="full_audit:priority">ALERT</smbconfoption>
 245 </programlisting>
 246
 247 </refsect1>
 248
 249 <refsect1>
 250         <title>VERSION</title>
 251         <para>This man page is correct for version 3.0.25 of the Samba suite.
 252         </para>
 253 </refsect1>
 254
 255 <refsect1>
 256         <title>AUTHOR</title>
 257
 258         <para>The original Samba software and related utilities
 259         were created by Andrew Tridgell. Samba is now developed
 260         by the Samba Team as an Open Source project similar
 261         to the way the Linux kernel is developed.</para>
 262
 263 </refsect1>
 264
 265 </refentry>