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>lremovexattr</member>
  82         <member>lseek</member>
  83         <member>lstat</member>
  84         <member>mkdir</member>
  85         <member>mknod</member>
  86         <member>open</member>
  87         <member>opendir</member>
  88         <member>pread</member>
  89         <member>pwrite</member>
  90         <member>read</member>
  91         <member>readdir</member>
  92         <member>readlink</member>
  93         <member>realpath</member>
  94         <member>removexattr</member>
  95         <member>rename</member>
  96         <member>rewinddir</member>
  97         <member>rmdir</member>
  98         <member>seekdir</member>
  99         <member>sendfile</member>
 100         <member>set_nt_acl</member>
 101         <member>set_quota</member>
 102         <member>setxattr</member>
 103         <member>stat</member>
 104         <member>statvfs</member>
 105         <member>symlink</member>
 106         <member>sys_acl_add_perm</member>
 107         <member>sys_acl_clear_perms</member>
 108         <member>sys_acl_create_entry</member>
 109         <member>sys_acl_delete_def_file</member>
 110         <member>sys_acl_free_acl</member>
 111         <member>sys_acl_free_qualifier</member>
 112         <member>sys_acl_free_text</member>
 113         <member>sys_acl_get_entry</member>
 114         <member>sys_acl_get_fd</member>
 115         <member>sys_acl_get_file</member>
 116         <member>sys_acl_get_perm</member>
 117         <member>sys_acl_get_permset</member>
 118         <member>sys_acl_get_qualifier</member>
 119         <member>sys_acl_get_tag_type</member>
 120         <member>sys_acl_init</member>
 121         <member>sys_acl_set_fd</member>
 122         <member>sys_acl_set_file</member>
 123         <member>sys_acl_set_permset</member>
 124         <member>sys_acl_set_qualifier</member>
 125         <member>sys_acl_set_tag_type</member>
 126         <member>sys_acl_to_text</member>
 127         <member>sys_acl_valid</member>
 128         <member>telldir</member>
 129         <member>unlink</member>
 130         <member>utime</member>
 131         <member>write</member>
 132         </simplelist>
 133
 134         <para>In addition to these operations,
 135         <command>vfs_full_audit</command> recognizes the special operation
 136         names &quot;all&quot; and &quot;none &quot;, which refer to all
 137         the VFS operations and none of the VFS operations respectively.
 138         </para>
 139
 140         <para><command>vfs_full_audit</command> records operations in fixed
 141         format consisting of fields separated by '|' characters. The
 142         format is: </para>
 143         <programlisting>
 144                 smbd_audit: PREFIX|OPERATION|RESULT|FILE
 145         </programlisting>
 146
 147         <para>The record fields are:</para>
 148
 149         <itemizedlist>
 150         <listitem><para><command>PREFIX</command> - the result of the full_audit:prefix string after variable substitutions</para></listitem>
 151         <listitem><para><command>OPERATION</command> - the name of the VFS operation</para></listitem>
 152         <listitem><para><command>RESULT</command> - whether the operation succeeded or failed</para></listitem>
 153         <listitem><para><command>FILE</command> - the name of the file or directory the operation was performed on</para></listitem>
 154
 155         </itemizedlist>
 156
 157         <para>This module is stackable.</para>
 158
 159 </refsect1>
 160
 161
 162 <refsect1>
 163         <title>OPTIONS</title>
 164
 165         <variablelist>
 166
 167                 <varlistentry>
 168                 <term>vfs_full_audit:prefix = STRING</term>
 169                 <listitem>
 170                 <para>Prepend audit messages with STRING. STRING is
 171                 processed for standard substitution variables listed in
 172                 <citerefentry><refentrytitle>smb.conf</refentrytitle>
 173                 <manvolnum>5</manvolnum></citerefentry>. The default
 174                 prefix is &quot;%u|%I&quot;. </para>
 175
 176                 </listitem>
 177                 </varlistentry>
 178
 179                 <varlistentry>
 180                 <term>vfs_full_audit:success = LIST</term>
 181                 <listitem>
 182                 <para>LIST is a list of VFS operations that should be
 183                 recorded if they succeed. Operations are specified using
 184                 the names listed above. Operations can be unset by prefixing
 185                 the names with "!".
 186                 </para>
 187
 188                 </listitem>
 189                 </varlistentry>
 190
 191                 <varlistentry>
 192                 <term>vfs_full_audit:failure = LIST</term>
 193                 <listitem>
 194                 <para>LIST is a list of VFS operations that should be
 195                 recorded if they failed. Operations are specified using
 196                 the names listed above. Operations can be unset by prefixing
 197                 the names with "!".
 198                 </para>
 199
 200                 </listitem>
 201                 </varlistentry>
 202
 203                 <varlistentry>
 204                 <term>full_audit:facility = FACILITY</term>
 205                 <listitem>
 206                 <para>Log messages to the named
 207                 <citerefentry><refentrytitle>syslog</refentrytitle>
 208                 <manvolnum>3</manvolnum></citerefentry> facility.
 209
 210                 </para>
 211
 212                 </listitem>
 213                 </varlistentry>
 214
 215                 <varlistentry>
 216                 <term>full_audit:priority = PRIORITY</term>
 217                 <listitem>
 218                 <para>Log messages with the named
 219                 <citerefentry><refentrytitle>syslog</refentrytitle>
 220                 <manvolnum>3</manvolnum></citerefentry> priority.
 221                 </para>
 222
 223                 </listitem>
 224                 </varlistentry>
 225
 226         </variablelist>
 227 </refsect1>
 228
 229 <refsect1>
 230         <title>EXAMPLES</title>
 231
 232         <para>Log file and directory open operations on the [records]
 233         share using the LOCAL7 facility and ALERT priority, including
 234         the username and IP address. Logging excludes the open VFS function
 235         on failures:</para>
 236
 237 <programlisting>
 238         <smbconfsection name="[records]"/>
 239         <smbconfoption name="path">/data/records</smbconfoption>
 240         <smbconfoption name="vfs objects">full_audit</smbconfoption>
 241         <smbconfoption name="full_audit:prefix">%u|%I</smbconfoption>
 242         <smbconfoption name="full_audit:success">open opendir</smbconfoption>
 243         <smbconfoption name="full_audit:failure">all !open</smbconfoption>
 244         <smbconfoption name="full_audit:facility">LOCAL7</smbconfoption>
 245         <smbconfoption name="full_audit:priority">ALERT</smbconfoption>
 246 </programlisting>
 247
 248 </refsect1>
 249
 250 <refsect1>
 251         <title>VERSION</title>
 252         <para>This man page is correct for version 3.0.25 of the Samba suite.
 253         </para>
 254 </refsect1>
 255
 256 <refsect1>
 257         <title>AUTHOR</title>
 258
 259         <para>The original Samba software and related utilities
 260         were created by Andrew Tridgell. Samba is now developed
 261         by the Samba Team as an Open Source project similar
 262         to the way the Linux kernel is developed.</para>
 263
 264 </refsect1>
 265
 266 </refentry>