source: trunk/server/docs/htmldocs/manpages/vfs_full_audit.8.html@ 745

Last change on this file since 745 was 745, checked in by Silvan Scherrer, 13 years ago

Samba Server: updated trunk to 3.6.0
File size: 8.1 KB
Line 
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_full_audit</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="vfs_full_audit"><a name="vfs_full_audit.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_full_audit &#8212; record Samba VFS operations in the system log</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = full_audit</code></p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id266340"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the
2 <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_full_audit</code> VFS module records selected
3 client operations to the system log using
4 <a class="citerefentry" href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a>.</p><p><code class="literal">vfs_full_audit</code> is able to record the
5 complete set of Samba VFS operations:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>aio_cancel</td></tr><tr><td>aio_error</td></tr><tr><td>aio_fsync</td></tr><tr><td>aio_read</td></tr><tr><td>aio_return</td></tr><tr><td>aio_suspend</td></tr><tr><td>aio_write</td></tr><tr><td>chdir</td></tr><tr><td>chflags</td></tr><tr><td>chmod</td></tr><tr><td>chmod_acl</td></tr><tr><td>chown</td></tr><tr><td>close</td></tr><tr><td>closedir</td></tr><tr><td>connect</td></tr><tr><td>disconnect</td></tr><tr><td>disk_free</td></tr><tr><td>fchmod</td></tr><tr><td>fchmod_acl</td></tr><tr><td>fchown</td></tr><tr><td>fget_nt_acl</td></tr><tr><td>fgetxattr</td></tr><tr><td>flistxattr</td></tr><tr><td>fremovexattr</td></tr><tr><td>fset_nt_acl</td></tr><tr><td>fsetxattr</td></tr><tr><td>fstat</td></tr><tr><td>fsync</td></tr><tr><td>ftruncate</td></tr><tr><td>get_nt_acl</td></tr><tr><td>get_quota</td></tr><tr><td>get_shadow_copy_data</td></tr><tr><td>getlock</td></tr><tr><td>getwd</td></tr><tr><td>getxattr</td></tr><tr><td>kernel_flock</td></tr><tr><td>lgetxattr</td></tr><tr><td>link</td></tr><tr><td>linux_setlease</td></tr><tr><td>listxattr</td></tr><tr><td>llistxattr</td></tr><tr><td>lock</td></tr><tr><td>lremovexattr</td></tr><tr><td>lseek</td></tr><tr><td>lsetxattr</td></tr><tr><td>lstat</td></tr><tr><td>mkdir</td></tr><tr><td>mknod</td></tr><tr><td>open</td></tr><tr><td>opendir</td></tr><tr><td>pread</td></tr><tr><td>pwrite</td></tr><tr><td>read</td></tr><tr><td>readdir</td></tr><tr><td>readlink</td></tr><tr><td>realpath</td></tr><tr><td>removexattr</td></tr><tr><td>rename</td></tr><tr><td>rewinddir</td></tr><tr><td>rmdir</td></tr><tr><td>seekdir</td></tr><tr><td>sendfile</td></tr><tr><td>set_nt_acl</td></tr><tr><td>set_quota</td></tr><tr><td>setxattr</td></tr><tr><td>stat</td></tr><tr><td>statvfs</td></tr><tr><td>symlink</td></tr><tr><td>sys_acl_add_perm</td></tr><tr><td>sys_acl_clear_perms</td></tr><tr><td>sys_acl_create_entry</td></tr><tr><td>sys_acl_delete_def_file</td></tr><tr><td>sys_acl_free_acl</td></tr><tr><td>sys_acl_free_qualifier</td></tr><tr><td>sys_acl_free_text</td></tr><tr><td>sys_acl_get_entry</td></tr><tr><td>sys_acl_get_fd</td></tr><tr><td>sys_acl_get_file</td></tr><tr><td>sys_acl_get_perm</td></tr><tr><td>sys_acl_get_permset</td></tr><tr><td>sys_acl_get_qualifier</td></tr><tr><td>sys_acl_get_tag_type</td></tr><tr><td>sys_acl_init</td></tr><tr><td>sys_acl_set_fd</td></tr><tr><td>sys_acl_set_file</td></tr><tr><td>sys_acl_set_permset</td></tr><tr><td>sys_acl_set_qualifier</td></tr><tr><td>sys_acl_set_tag_type</td></tr><tr><td>sys_acl_to_text</td></tr><tr><td>sys_acl_valid</td></tr><tr><td>telldir</td></tr><tr><td>unlink</td></tr><tr><td>utime</td></tr><tr><td>write</td></tr></table><p>In addition to these operations,
6 <code class="literal">vfs_full_audit</code> recognizes the special operation
7 names "all" and "none ", which refer to all
8 the VFS operations and none of the VFS operations respectively.
9 </p><p><code class="literal">vfs_full_audit</code> records operations in fixed
10 format consisting of fields separated by '|' characters. The
11 format is: </p><pre class="programlisting">
12 smbd_audit: PREFIX|OPERATION|RESULT|FILE
13 </pre><p>The record fields are:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="literal">PREFIX</code> - the result of the full_audit:prefix string after variable substitutions</p></li><li class="listitem"><p><code class="literal">OPERATION</code> - the name of the VFS operation</p></li><li class="listitem"><p><code class="literal">RESULT</code> - whether the operation succeeded or failed</p></li><li class="listitem"><p><code class="literal">FILE</code> - the name of the file or directory the operation was performed on</p></li></ul></div><p>This module is stackable.</p></div><div class="refsect1" title="OPTIONS"><a name="id307089"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">vfs_full_audit:prefix = STRING</span></dt><dd><p>Prepend audit messages with STRING. STRING is
14 processed for standard substitution variables listed in
15 <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>. The default
16 prefix is "%u|%I". </p></dd><dt><span class="term">vfs_full_audit:success = LIST</span></dt><dd><p>LIST is a list of VFS operations that should be
17 recorded if they succeed. Operations are specified using
18 the names listed above. Operations can be unset by prefixing
19 the names with "!".
20 </p></dd><dt><span class="term">vfs_full_audit:failure = LIST</span></dt><dd><p>LIST is a list of VFS operations that should be
21 recorded if they failed. Operations are specified using
22 the names listed above. Operations can be unset by prefixing
23 the names with "!".
24 </p></dd><dt><span class="term">full_audit:facility = FACILITY</span></dt><dd><p>Log messages to the named
25 <a class="citerefentry" href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a> facility.
26
27 </p></dd><dt><span class="term">full_audit:priority = PRIORITY</span></dt><dd><p>Log messages with the named
28 <a class="citerefentry" href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a> priority.
29 </p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id307189"></a><h2>EXAMPLES</h2><p>Log file and directory open operations on the [records]
30 share using the LOCAL7 facility and ALERT priority, including
31 the username and IP address. Logging excludes the open VFS function
32 on failures:</p><pre class="programlisting">
33 <em class="parameter"><code>[records]</code></em>
34 <a class="link" href="smb.conf.5.html#PATH" target="_top">path = /data/records</a>
35 <a class="link" href="smb.conf.5.html#VFSOBJECTS" target="_top">vfs objects = full_audit</a>
36 <a class="link" href="smb.conf.5.html#FULL_AUDIT:PREFIX" target="_top">full_audit:prefix = %u|%I</a>
37 <a class="link" href="smb.conf.5.html#FULL_AUDIT:SUCCESS" target="_top">full_audit:success = open opendir</a>
38 <a class="link" href="smb.conf.5.html#FULL_AUDIT:FAILURE" target="_top">full_audit:failure = all !open</a>
39 <a class="link" href="smb.conf.5.html#FULL_AUDIT:FACILITY" target="_top">full_audit:facility = LOCAL7</a>
40 <a class="link" href="smb.conf.5.html#FULL_AUDIT:PRIORITY" target="_top">full_audit:priority = ALERT</a>
41</pre></div><div class="refsect1" title="VERSION"><a name="id307366"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite.
42 </p></div><div class="refsect1" title="AUTHOR"><a name="id307375"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
43 were created by Andrew Tridgell. Samba is now developed
44 by the Samba Team as an Open Source project similar
45 to the way the Linux kernel is developed.</p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.