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