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