docs-xml/manpages/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">&doc.version;</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>chdir</member>
  42         <member>chflags</member>
  43         <member>chmod</member>
  44         <member>chown</member>
  45         <member>close</member>
  46         <member>closedir</member>
  47         <member>connect</member>
  48         <member>copy_chunk_send</member>
  49         <member>copy_chunk_recv</member>
  50         <member>disconnect</member>
  51         <member>disk_free</member>
  52         <member>fchmod</member>
  53         <member>fchmod_acl</member>
  54         <member>fchown</member>
  55         <member>fget_nt_acl</member>
  56         <member>fgetxattr</member>
  57         <member>flistxattr</member>
  58         <member>fremovexattr</member>
  59         <member>fset_nt_acl</member>
  60         <member>fsetxattr</member>
  61         <member>fstat</member>
  62         <member>fsync</member>
  63         <member>ftruncate</member>
  64         <member>get_compression</member>
  65         <member>get_nt_acl</member>
  66         <member>get_quota</member>
  67         <member>get_shadow_copy_data</member>
  68         <member>getlock</member>
  69         <member>getwd</member>
  70         <member>getxattr</member>
  71         <member>kernel_flock</member>
  72         <member>link</member>
  73         <member>linux_setlease</member>
  74         <member>listxattr</member>
  75         <member>lock</member>
  76         <member>lseek</member>
  77         <member>lstat</member>
  78         <member>mkdir</member>
  79         <member>mknod</member>
  80         <member>open</member>
  81         <member>opendir</member>
  82         <member>pread</member>
  83         <member>pwrite</member>
  84         <member>read</member>
  85         <member>readdir</member>
  86         <member>readlink</member>
  87         <member>realpath</member>
  88         <member>removexattr</member>
  89         <member>rename</member>
  90         <member>rewinddir</member>
  91         <member>rmdir</member>
  92         <member>seekdir</member>
  93         <member>sendfile</member>
  94         <member>set_compression</member>
  95         <member>set_nt_acl</member>
  96         <member>set_quota</member>
  97         <member>setxattr</member>
  98         <member>snap_check_path</member>
  99         <member>snap_create</member>
 100         <member>snap_delete</member>
 101         <member>stat</member>
 102         <member>statvfs</member>
 103         <member>symlink</member>
 104         <member>sys_acl_delete_def_file</member>
 105         <member>sys_acl_get_fd</member>
 106         <member>sys_acl_get_file</member>
 107         <member>sys_acl_set_fd</member>
 108         <member>sys_acl_set_file</member>
 109         <member>telldir</member>
 110         <member>unlink</member>
 111         <member>utime</member>
 112         <member>write</member>
 113         </simplelist>
 114
 115         <para>In addition to these operations,
 116         <command>vfs_full_audit</command> recognizes the special operation
 117         names &quot;all&quot; and &quot;none &quot;, which refer to all
 118         the VFS operations and none of the VFS operations respectively.
 119         </para>
 120
 121         <para><command>vfs_full_audit</command> records operations in fixed
 122         format consisting of fields separated by '|' characters. The
 123         format is: </para>
 124         <programlisting>
 125                 smbd_audit: PREFIX|OPERATION|RESULT|FILE
 126         </programlisting>
 127
 128         <para>The record fields are:</para>
 129
 130         <itemizedlist>
 131         <listitem><para><command>PREFIX</command> - the result of the full_audit:prefix string after variable substitutions</para></listitem>
 132         <listitem><para><command>OPERATION</command> - the name of the VFS operation</para></listitem>
 133         <listitem><para><command>RESULT</command> - whether the operation succeeded or failed</para></listitem>
 134         <listitem><para><command>FILE</command> - the name of the file or directory the operation was performed on</para></listitem>
 135
 136         </itemizedlist>
 137
 138         <para>This module is stackable.</para>
 139
 140 </refsect1>
 141
 142
 143 <refsect1>
 144         <title>OPTIONS</title>
 145
 146         <variablelist>
 147
 148                 <varlistentry>
 149                 <term>full_audit:prefix = STRING</term>
 150                 <listitem>
 151                 <para>Prepend audit messages with STRING. STRING is
 152                 processed for standard substitution variables listed in
 153                 <citerefentry><refentrytitle>smb.conf</refentrytitle>
 154                 <manvolnum>5</manvolnum></citerefentry>. The default
 155                 prefix is &quot;%u|%I&quot;. </para>
 156
 157                 </listitem>
 158                 </varlistentry>
 159
 160                 <varlistentry>
 161                 <term>full_audit:success = LIST</term>
 162                 <listitem>
 163                 <para>LIST is a list of VFS operations that should be
 164                 recorded if they succeed. Operations are specified using
 165                 the names listed above. Operations can be unset by prefixing
 166                 the names with "!". The default is all operations.
 167                 </para>
 168
 169                 </listitem>
 170                 </varlistentry>
 171
 172                 <varlistentry>
 173                 <term>full_audit:failure = LIST</term>
 174                 <listitem>
 175                 <para>LIST is a list of VFS operations that should be
 176                 recorded if they failed. Operations are specified using
 177                 the names listed above. Operations can be unset by prefixing
 178                 the names with "!". The default is all operations.
 179                 </para>
 180
 181                 </listitem>
 182                 </varlistentry>
 183
 184                 <varlistentry>
 185                 <term>full_audit:facility = FACILITY</term>
 186                 <listitem>
 187                 <para>Log messages to the named
 188                 <citerefentry><refentrytitle>syslog</refentrytitle>
 189                 <manvolnum>3</manvolnum></citerefentry> facility.
 190
 191                 </para>
 192
 193                 </listitem>
 194                 </varlistentry>
 195
 196                 <varlistentry>
 197                 <term>full_audit:priority = PRIORITY</term>
 198                 <listitem>
 199                 <para>Log messages with the named
 200                 <citerefentry><refentrytitle>syslog</refentrytitle>
 201                 <manvolnum>3</manvolnum></citerefentry> priority.
 202                 </para>
 203
 204                 </listitem>
 205                 </varlistentry>
 206
 207                 <varlistentry>
 208                 <term>full_audit:syslog = true/false</term>
 209                 <listitem>
 210                 <para>Log messages to syslog (default) or as a debug level 1
 211                 message.
 212                 </para>
 213                 </listitem>
 214                 </varlistentry>
 215
 216                 <varlistentry>
 217                 <term>full_audit:log_secdesc = true/false</term>
 218                 <listitem>
 219                 <para>Log an sddl form of the security descriptor coming in
 220                 when a client sets an acl. Defaults to false.
 221                 </para>
 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 part of version &doc.version; 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>