docs/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 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>vfs_full_audit</refname>
  13         <refpurpose>record Samba VFS operations in the system log</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>vfs objects = full_audit</command>
  19         </cmdsynopsis>
  20 </refsynopsisdiv>
  21
  22 <refsect1>
  23         <title>DESCRIPTION</title>
  24
  25         <para>This VFS module is part of the
  26         <citerefentry><refentrytitle>samba</refentrytitle>
  27         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  28
  29         <para>The <command>vfs_full_audit</command> VFS module records selected
  30         client operations to the system log using
  31         <citerefentry><refentrytitle>syslog</refentrytitle>
  32         <manvolnum>3</manvolnum></citerefentry>.</para>
  33
  34         <para><command>vfs_full_audit</command> is able to record the
  35         complete set of Samba VFS operations:</para>
  36
  37         <simplelist>
  38         <member>connect</member>
  39         <member>disconnect</member>
  40         <member>disk_free</member>
  41         <member>get_quota</member>
  42         <member>set_quota</member>
  43         <member>get_shadow_copy_data</member>
  44         <member>statvfs</member>
  45         <member>opendir</member>
  46         <member>readdir</member>
  47         <member>seekdir</member>
  48         <member>telldir</member>
  49         <member>rewinddir</member>
  50         <member>mkdir</member>
  51         <member>rmdir</member>
  52         <member>closedir</member>
  53         <member>open</member>
  54         <member>close</member>
  55         <member>read</member>
  56         <member>pread</member>
  57         <member>write</member>
  58         <member>pwrite</member>
  59         <member>lseek</member>
  60         <member>sendfile</member>
  61         <member>rename</member>
  62         <member>fsync</member>
  63         <member>stat</member>
  64         <member>fstat</member>
  65         <member>lstat</member>
  66         <member>unlink</member>
  67         <member>chmod</member>
  68         <member>fchmod</member>
  69         <member>chown</member>
  70         <member>fchown</member>
  71         <member>chdir</member>
  72         <member>getwd</member>
  73         <member>utime</member>
  74         <member>ftruncate</member>
  75         <member>lock</member>
  76         <member>kernel_flock</member>
  77         <member>linux_setlease</member>
  78         <member>getlock</member>
  79         <member>symlink</member>
  80         <member>readlink</member>
  81         <member>link</member>
  82         <member>mknod</member>
  83         <member>realpath</member>
  84         <member>fget_nt_acl</member>
  85         <member>get_nt_acl</member>
  86         <member>fset_nt_acl</member>
  87         <member>set_nt_acl</member>
  88         <member>chmod_acl</member>
  89         <member>fchmod_acl</member>
  90         <member>sys_acl_get_entry</member>
  91         <member>sys_acl_get_tag_type</member>
  92         <member>sys_acl_get_permset</member>
  93         <member>sys_acl_get_qualifier</member>
  94         <member>sys_acl_get_file</member>
  95         <member>sys_acl_get_fd</member>
  96         <member>sys_acl_clear_perms</member>
  97         <member>sys_acl_add_perm</member>
  98         <member>sys_acl_to_text</member>
  99         <member>sys_acl_init</member>
 100         <member>sys_acl_create_entry</member>
 101         <member>sys_acl_set_tag_type</member>
 102         <member>sys_acl_set_qualifier</member>
 103         <member>sys_acl_set_permset</member>
 104         <member>sys_acl_valid</member>
 105         <member>sys_acl_set_file</member>
 106         <member>sys_acl_set_fd</member>
 107         <member>sys_acl_delete_def_file</member>
 108         <member>sys_acl_get_perm</member>
 109         <member>sys_acl_free_text</member>
 110         <member>sys_acl_free_acl</member>
 111         <member>sys_acl_free_qualifier</member>
 112         <member>getxattr</member>
 113         <member>lgetxattr</member>
 114         <member>fgetxattr</member>
 115         <member>listxattr</member>
 116         <member>llistxattr</member>
 117         <member>flistxattr</member>
 118         <member>removexattr</member>
 119         <member>lremovexattr</member>
 120         <member>fremovexattr</member>
 121         <member>setxattr</member>
 122         <member>lsetxattr</member>
 123         <member>fsetxattr</member>
 124         <member>aio_read</member>
 125         <member>aio_write</member>
 126         <member>aio_return</member>
 127         <member>aio_cancel</member>
 128         <member>aio_error</member>
 129         <member>aio_fsync</member>
 130         <member>aio_suspend</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.
 184                 </para>
 185
 186                 </listitem>
 187                 </varlistentry>
 188
 189                 <varlistentry>
 190                 <term>vfs_full_audit:failure = LIST</term>
 191                 <listitem>
 192                 <para>LIST is a list of VFS operations that should be
 193                 recorded if they failed. Operations are specified using
 194                 the names listed above.
 195                 </para>
 196
 197                 </listitem>
 198                 </varlistentry>
 199
 200                 <varlistentry>
 201                 <term>full_audit:facility = FACILITY</term>
 202                 <listitem>
 203                 <para>Log messages to the named
 204                 <citerefentry><refentrytitle>syslog</refentrytitle>
 205                 <manvolnum>3</manvolnum></citerefentry> facility.
 206
 207                 </para>
 208
 209                 </listitem>
 210                 </varlistentry>
 211
 212                 <varlistentry>
 213                 <term>full_audit:priority = PRIORITY</term>
 214                 <listitem>
 215                 <para>Log messages with the named
 216                 <citerefentry><refentrytitle>syslog</refentrytitle>
 217                 <manvolnum>3</manvolnum></citerefentry> priority.
 218                 </para>
 219
 220                 </listitem>
 221                 </varlistentry>
 222
 223         </variablelist>
 224 </refsect1>
 225
 226 <refsect1>
 227         <title>EXAMPLES</title>
 228
 229         <para>Log file and directory open operations on the [records]
 230         share using the LOCAL7 facility and ALERT priority, including
 231         the username and IP address:</para>
 232
 233 <programlisting>
 234         <smbconfsection name="[records]"/>
 235         <smbconfoption name="path">/data/records</smbconfoption>
 236         <smbconfoption name="vfs objects">full_audit</smbconfoption>
 237         <smbconfoption name="full_audit:prefix">%u|%I</smbconfoption>
 238         <smbconfoption name="full_audit:success">open opendir</smbconfoption>
 239         <smbconfoption name="full_audit:failure">all</smbconfoption>
 240         <smbconfoption name="full_audit:facility">LOCAL7</smbconfoption>
 241         <smbconfoption name="full_audit:priority">ALERT</smbconfoption>
 242 </programlisting>
 243
 244 </refsect1>
 245
 246 <refsect1>
 247         <title>VERSION</title>
 248         <para>This man page is correct for version 3.0.25 of the Samba suite.
 249         </para>
 250 </refsect1>
 251
 252 <refsect1>
 253         <title>AUTHOR</title>
 254
 255         <para>The original Samba software and related utilities
 256         were created by Andrew Tridgell. Samba is now developed
 257         by the Samba Team as an Open Source project similar
 258         to the way the Linux kernel is developed.</para>
 259
 260 </refsect1>
 261
 262 </refentry>