1VFS_FULL_AUDIT(8) System Administration tools VFS_FULL_AUDIT(8)
2
6 vfs_full_audit - record Samba VFS operations in the system log
7
9 vfs objects = full_audit
10
12 This VFS module is part of the samba(7) suite.
13 The vfs_full_audit VFS module records selected client operations to the
15 system log using syslog(3).
16 vfs_full_audit is able to record the complete set of Samba VFS
18 operations:
19 aio_force
20 audit_file
21 brl_lock_windows
22 brl_unlock_windows
23 chdir
24 close
25 closedir
26 connect
27 connectpath
28 create_dfs_pathat
29 create_file
30 disconnect
31 disk_free
32 durable_cookie
33 durable_disconnect
34 durable_reconnect
35 fallocate
36 fchflags
37 fchmod
38 fchown
39 fcntl
40 fdopendir
41 fget_compression
42 fget_dos_attributes
43 fget_nt_acl
44 fgetxattr
45 file_id_create
46 filesystem_sharemode
47 flistxattr
48 fntimes
49 freaddir_attr
50 fremovexattr
51 fs_capabilities
52 fsctl
53 fset_dos_attributes
54 fset_nt_acl
55 fsetxattr
56 fs_file_id
57 fstat
58 fstatat
59 fstreaminfo
60 fsync_recv
61 fsync_send
62 ftruncate
63 get_alloc_size
64 get_dfs_referrals
65 get_dos_attributes_recv
66 get_dos_attributes_send
67 getlock
68 get_quota
69 get_real_filename
70 get_real_filename_at
71 get_shadow_copy_data
72 getwd
73 getxattrat_recv
74 getxattrat_send
75 is_offline
76 lchown
77 linkat
78 linux_setlease
79 lock
80 lseek
81 lstat
82 mkdirat
83 mknodat
84 ntimes
85 offload_read_recv
86 offload_read_send
87 offload_write_recv
88 offload_write_send
89 open
90 openat
91 parent_pathname
92 pread
93 pread_recv
94 pread_send
95 pwrite
96 pwrite_recv
97 pwrite_send
98 read
99 read_dfs_pathat
100 readdir
101 readlinkat
102 realpath
103 recvfile
104 removexattr
105 renameat
106 rewinddir
107 sendfile
108 set_compression
109 set_offline
110 set_quota
111 snap_check_path
112 snap_create
113 snap_delete
114 stat
115 statvfs
116 strict_lock_check
117 symlinkat
118 sys_acl_blob_get_fd
119 sys_acl_delete_def_fd
120 sys_acl_get_fd
121 sys_acl_set_fd
122 translate_name
123 unlinkat
124 write
125 In addition to these operations, vfs_full_audit recognizes the special
127 operation names "all" and "none ", which refer to all the VFS
128 operations and none of the VFS operations respectively.
129 If an unknown operation name is used (for example an operation name is
131 miss-spelled), the module will fail to load and clients will be refused
132 connections to a share using this module.
133 vfs_full_audit records operations in fixed format consisting of fields
135 separated by '|' characters. The format is:
136 smbd_audit: PREFIX|OPERATION|RESULT|FILE
138 The record fields are:
141 • PREFIX - the result of the full_audit:prefix string after
143 variable substitutions
144 • OPERATION - the name of the VFS operation
146 • RESULT - whether the operation succeeded or failed
148 • FILE - the name of the file or directory the operation was
150 performed on
151 This module is stackable.
154
156 full_audit:prefix = STRING
157 Prepend audit messages with STRING. STRING is processed for
158 standard substitution variables listed in smb.conf(5). The default
159 prefix is "%u|%I".
160 full_audit:success = LIST
162 LIST is a list of VFS operations that should be recorded if they
163 succeed. Operations are specified using the names listed above.
164 Operations can be unset by prefixing the names with "!". The
165 default is none operations.
166 full_audit:failure = LIST
168 LIST is a list of VFS operations that should be recorded if they
169 failed. Operations are specified using the names listed above.
170 Operations can be unset by prefixing the names with "!". The
171 default is none operations.
172 full_audit:facility = FACILITY
174 Log messages to the named syslog(3) facility.
175 full_audit:priority = PRIORITY
177 Log messages with the named syslog(3) priority.
178 full_audit:syslog = true/false
180 Log messages to syslog (default) or as a debug level 1 message.
181 full_audit:log_secdesc = true/false
183 Log an sddl form of the security descriptor coming in when a client
184 sets an acl. Defaults to false.
185
187 Log file and directory open operations on the [records] share using the
188 LOCAL7 facility and ALERT priority, including the username and IP
189 address. Logging excludes the open VFS function on failures:
190 [records]
192 path = /data/records
193 vfs objects = full_audit
194 full_audit:prefix = %u|%I
195 full_audit:success = open opendir
196 full_audit:failure = all !open
197 full_audit:facility = LOCAL7
198 full_audit:priority = ALERT
199
201 This man page is part of version 4.19.3 of the Samba suite.
202
204 The original Samba software and related utilities were created by
205 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
206 Source project similar to the way the Linux kernel is developed.
207Samba 4.19.3 11/27/2023 VFS_FULL_AUDIT(8)