Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_full_audit.8

raw
1 '\" t
2 .\" Title: vfs_full_audit
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "VFS_FULL_AUDIT" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 vfs_full_audit \- record Samba VFS operations in the system log
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = full_audit
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 The
42 vfs_full_audit
43 VFS module records selected client operations to the system log using
44 \fBsyslog\fR(3)\&.
45 .PP
46 vfs_full_audit
47 is able to record the complete set of Samba VFS operations:
48 .RS 4
49 aio_force
50 .RE
51 .RS 4
52 audit_file
53 .RE
54 .RS 4
55 brl_lock_windows
56 .RE
57 .RS 4
58 brl_unlock_windows
59 .RE
60 .RS 4
61 chdir
62 .RE
63 .RS 4
64 close
65 .RE
66 .RS 4
67 closedir
68 .RE
69 .RS 4
70 connect
71 .RE
72 .RS 4
73 connectpath
74 .RE
75 .RS 4
76 create_dfs_pathat
77 .RE
78 .RS 4
79 create_file
80 .RE
81 .RS 4
82 disconnect
83 .RE
84 .RS 4
85 disk_free
86 .RE
87 .RS 4
88 durable_cookie
89 .RE
90 .RS 4
91 durable_disconnect
92 .RE
93 .RS 4
94 durable_reconnect
95 .RE
96 .RS 4
97 fallocate
98 .RE
99 .RS 4
100 fchflags
101 .RE
102 .RS 4
103 fchmod
104 .RE
105 .RS 4
106 fchown
107 .RE
108 .RS 4
109 fcntl
110 .RE
111 .RS 4
112 fdopendir
113 .RE
114 .RS 4
115 fget_compression
116 .RE
117 .RS 4
118 fget_dos_attributes
119 .RE
120 .RS 4
121 fget_nt_acl
122 .RE
123 .RS 4
124 fgetxattr
125 .RE
126 .RS 4
127 file_id_create
128 .RE
129 .RS 4
130 filesystem_sharemode
131 .RE
132 .RS 4
133 flistxattr
134 .RE
135 .RS 4
136 fntimes
137 .RE
138 .RS 4
139 freaddir_attr
140 .RE
141 .RS 4
142 fremovexattr
143 .RE
144 .RS 4
145 fs_capabilities
146 .RE
147 .RS 4
148 fsctl
149 .RE
150 .RS 4
151 fset_dos_attributes
152 .RE
153 .RS 4
154 fset_nt_acl
155 .RE
156 .RS 4
157 fsetxattr
158 .RE
159 .RS 4
160 fs_file_id
161 .RE
162 .RS 4
163 fstat
164 .RE
165 .RS 4
166 fstatat
167 .RE
168 .RS 4
169 fstreaminfo
170 .RE
171 .RS 4
172 fsync_recv
173 .RE
174 .RS 4
175 fsync_send
176 .RE
177 .RS 4
178 ftruncate
179 .RE
180 .RS 4
181 get_alloc_size
182 .RE
183 .RS 4
184 get_dfs_referrals
185 .RE
186 .RS 4
187 get_dos_attributes_recv
188 .RE
189 .RS 4
190 get_dos_attributes_send
191 .RE
192 .RS 4
193 getlock
194 .RE
195 .RS 4
196 get_quota
197 .RE
198 .RS 4
199 get_real_filename
200 .RE
201 .RS 4
202 get_real_filename_at
203 .RE
204 .RS 4
205 get_shadow_copy_data
206 .RE
207 .RS 4
208 getwd
209 .RE
210 .RS 4
211 getxattrat_recv
212 .RE
213 .RS 4
214 getxattrat_send
215 .RE
216 .RS 4
217 is_offline
218 .RE
219 .RS 4
220 lchown
221 .RE
222 .RS 4
223 linkat
224 .RE
225 .RS 4
226 linux_setlease
227 .RE
228 .RS 4
229 lock
230 .RE
231 .RS 4
232 lseek
233 .RE
234 .RS 4
235 lstat
236 .RE
237 .RS 4
238 mkdirat
239 .RE
240 .RS 4
241 mknodat
242 .RE
243 .RS 4
244 ntimes
245 .RE
246 .RS 4
247 offload_read_recv
248 .RE
249 .RS 4
250 offload_read_send
251 .RE
252 .RS 4
253 offload_write_recv
254 .RE
255 .RS 4
256 offload_write_send
257 .RE
258 .RS 4
259 open
260 .RE
261 .RS 4
262 openat
263 .RE
264 .RS 4
265 parent_pathname
266 .RE
267 .RS 4
268 pread
269 .RE
270 .RS 4
271 pread_recv
272 .RE
273 .RS 4
274 pread_send
275 .RE
276 .RS 4
277 pwrite
278 .RE
279 .RS 4
280 pwrite_recv
281 .RE
282 .RS 4
283 pwrite_send
284 .RE
285 .RS 4
286 read
287 .RE
288 .RS 4
289 read_dfs_pathat
290 .RE
291 .RS 4
292 readdir
293 .RE
294 .RS 4
295 readlinkat
296 .RE
297 .RS 4
298 realpath
299 .RE
300 .RS 4
301 recvfile
302 .RE
303 .RS 4
304 removexattr
305 .RE
306 .RS 4
307 renameat
308 .RE
309 .RS 4
310 rewinddir
311 .RE
312 .RS 4
313 sendfile
314 .RE
315 .RS 4
316 set_compression
317 .RE
318 .RS 4
319 set_offline
320 .RE
321 .RS 4
322 set_quota
323 .RE
324 .RS 4
325 snap_check_path
326 .RE
327 .RS 4
328 snap_create
329 .RE
330 .RS 4
331 snap_delete
332 .RE
333 .RS 4
334 stat
335 .RE
336 .RS 4
337 statvfs
338 .RE
339 .RS 4
340 strict_lock_check
341 .RE
342 .RS 4
343 symlinkat
344 .RE
345 .RS 4
346 sys_acl_blob_get_fd
347 .RE
348 .RS 4
349 sys_acl_delete_def_fd
350 .RE
351 .RS 4
352 sys_acl_get_fd
353 .RE
354 .RS 4
355 sys_acl_set_fd
356 .RE
357 .RS 4
358 translate_name
359 .RE
360 .RS 4
361 unlinkat
362 .RE
363 .RS 4
364 write
365 .RE
366 .PP
367 In addition to these operations,
368 vfs_full_audit
369 recognizes the special operation names "all" and "none ", which refer to all the VFS operations and none of the VFS operations respectively\&.
370 .PP
371 If an unknown operation name is used (for example an operation name is miss\-spelled), the module will fail to load and clients will be refused connections to a share using this module\&.
372 .PP
373 vfs_full_audit
374 records operations in fixed format consisting of fields separated by \*(Aq|\*(Aq characters\&. The format is:
375 .sp
376 .if n \{\
377 .RS 4
378 .\}
379 .nf
380 smbd_audit: PREFIX|OPERATION|RESULT|FILE
381 .fi
382 .if n \{\
383 .RE
384 .\}
385 .PP
386 The record fields are:
387 .RS
388 .sp
389 .RS 4
390 .ie n \{\
391 \h'-04'\(bu\h'+03'\c
392 .\}
393 .el \{\
394 .sp -1
395 .IP \(bu 2.3
396 .\}
397 PREFIX
398 \- the result of the full_audit:prefix string after variable substitutions
399 .RE
400 .sp
401 .RS 4
402 .ie n \{\
403 \h'-04'\(bu\h'+03'\c
404 .\}
405 .el \{\
406 .sp -1
407 .IP \(bu 2.3
408 .\}
409 OPERATION
410 \- the name of the VFS operation
411 .RE
412 .sp
413 .RS 4
414 .ie n \{\
415 \h'-04'\(bu\h'+03'\c
416 .\}
417 .el \{\
418 .sp -1
419 .IP \(bu 2.3
420 .\}
421 RESULT
422 \- whether the operation succeeded or failed
423 .RE
424 .sp
425 .RS 4
426 .ie n \{\
427 \h'-04'\(bu\h'+03'\c
428 .\}
429 .el \{\
430 .sp -1
431 .IP \(bu 2.3
432 .\}
433 FILE
434 \- the name of the file or directory the operation was performed on
435 .RE
436 .sp
437 .RE
438 .PP
439 This module is stackable\&.
440 .SH "OPTIONS"
441 .PP
442 full_audit:prefix = STRING
443 .RS 4
444 Prepend audit messages with STRING\&. STRING is processed for standard substitution variables listed in
445 \fBsmb.conf\fR(5)\&. The default prefix is "%u|%I"\&.
446 .RE
447 .PP
448 full_audit:success = LIST
449 .RS 4
450 LIST is a list of VFS operations that should be recorded if they succeed\&. Operations are specified using the names listed above\&. Operations can be unset by prefixing the names with "!"\&. The default is none operations\&.
451 .RE
452 .PP
453 full_audit:failure = LIST
454 .RS 4
455 LIST is a list of VFS operations that should be recorded if they failed\&. Operations are specified using the names listed above\&. Operations can be unset by prefixing the names with "!"\&. The default is none operations\&.
456 .RE
457 .PP
458 full_audit:facility = FACILITY
459 .RS 4
460 Log messages to the named
461 \fBsyslog\fR(3)
462 facility\&.
463 .RE
464 .PP
465 full_audit:priority = PRIORITY
466 .RS 4
467 Log messages with the named
468 \fBsyslog\fR(3)
469 priority\&.
470 .RE
471 .PP
472 full_audit:syslog = true/false
473 .RS 4
474 Log messages to syslog (default) or as a debug level 1 message\&.
475 .RE
476 .PP
477 full_audit:log_secdesc = true/false
478 .RS 4
479 Log an sddl form of the security descriptor coming in when a client sets an acl\&. Defaults to false\&.
480 .RE
481 .SH "EXAMPLES"
482 .PP
483 Log file and directory open operations on the [records] share using the LOCAL7 facility and ALERT priority, including the username and IP address\&. Logging excludes the open VFS function on failures:
484 .sp
485 .if n \{\
486 .RS 4
487 .\}
488 .nf
489 \fI[records]\fR
490 \m[blue]\fBpath = /data/records\fR\m[]
491 \m[blue]\fBvfs objects = full_audit\fR\m[]
492 \m[blue]\fBfull_audit:prefix = %u|%I\fR\m[]
493 \m[blue]\fBfull_audit:success = open opendir\fR\m[]
494 \m[blue]\fBfull_audit:failure = all !open\fR\m[]
495 \m[blue]\fBfull_audit:facility = LOCAL7\fR\m[]
496 \m[blue]\fBfull_audit:priority = ALERT\fR\m[]
497 .fi
498 .if n \{\
499 .RE
500 .\}
501 .SH "VERSION"
502 .PP
503 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
504 .SH "AUTHOR"
505 .PP
506 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.