source: branches/samba-3.3.x/docs/manpages/vfs_full_audit.8@ 342

Last change on this file since 342 was 342, checked in by Herwig Bauernfeind, 15 years ago

Update 3.3 to 3.3.9

File size: 9.8 KB
Line 
1.\" Title: vfs_full_audit
2.\" Author: [see the "AUTHOR" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 10/12/2009
5.\" Manual: System Administration tools
6.\" Source: Samba 3.3
7.\" Language: English
8.\"
9.TH "VFS_FULL_AUDIT" "8" "10/12/2009" "Samba 3\&.3" "System Administration tools"
10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros
12.\" -----------------------------------------------------------------
13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14.\" toupper - uppercase a string (locale-aware)
15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.de toupper
17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18\\$*
19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20..
21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.\" SH-xref - format a cross-reference to an SH section
23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24.de SH-xref
25.ie n \{\
26.\}
27.toupper \\$*
28.el \{\
29\\$*
30.\}
31..
32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33.\" SH - level-one heading that works better for non-TTY output
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.de1 SH
36.\" put an extra blank line of space above the head in non-TTY output
37.if t \{\
38.sp 1
39.\}
40.sp \\n[PD]u
41.nr an-level 1
42.set-an-margin
43.nr an-prevailing-indent \\n[IN]
44.fi
45.in \\n[an-margin]u
46.ti 0
47.HTML-TAG ".NH \\n[an-level]"
48.it 1 an-trap
49.nr an-no-space-flag 1
50.nr an-break-flag 1
51\." make the size of the head bigger
52.ps +3
53.ft B
54.ne (2v + 1u)
55.ie n \{\
56.\" if n (TTY output), use uppercase
57.toupper \\$*
58.\}
59.el \{\
60.nr an-break-flag 0
61.\" if not n (not TTY), use normal case (not uppercase)
62\\$1
63.in \\n[an-margin]u
64.ti 0
65.\" if not n (not TTY), put a border/line under subheading
66.sp -.6
67\l'\n(.lu'
68.\}
69..
70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71.\" SS - level-two heading that works better for non-TTY output
72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73.de1 SS
74.sp \\n[PD]u
75.nr an-level 1
76.set-an-margin
77.nr an-prevailing-indent \\n[IN]
78.fi
79.in \\n[IN]u
80.ti \\n[SN]u
81.it 1 an-trap
82.nr an-no-space-flag 1
83.nr an-break-flag 1
84.ps \\n[PS-SS]u
85\." make the size of the head bigger
86.ps +2
87.ft B
88.ne (2v + 1u)
89.if \\n[.$] \&\\$*
90..
91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92.\" BB/BE - put background/screen (filled box) around block of text
93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94.de BB
95.if t \{\
96.sp -.5
97.br
98.in +2n
99.ll -2n
100.gcolor red
101.di BX
102.\}
103..
104.de EB
105.if t \{\
106.if "\\$2"adjust-for-leading-newline" \{\
107.sp -1
108.\}
109.br
110.di
111.in
112.ll
113.gcolor
114.nr BW \\n(.lu-\\n(.i
115.nr BH \\n(dn+.5v
116.ne \\n(BHu+.5v
117.ie "\\$2"adjust-for-leading-newline" \{\
118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119.\}
120.el \{\
121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122.\}
123.in 0
124.sp -.5v
125.nf
126.BX
127.in
128.sp .5v
129.fi
130.\}
131..
132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133.\" BM/EM - put colored marker in margin next to block of text
134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135.de BM
136.if t \{\
137.br
138.ll -2n
139.gcolor red
140.di BX
141.\}
142..
143.de EM
144.if t \{\
145.br
146.di
147.ll
148.gcolor
149.nr BH \\n(dn
150.ne \\n(BHu
151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152.in 0
153.nf
154.BX
155.in
156.fi
157.\}
158..
159.\" -----------------------------------------------------------------
160.\" * set default formatting
161.\" -----------------------------------------------------------------
162.\" disable hyphenation
163.nh
164.\" disable justification (adjust text to left margin only)
165.ad l
166.\" -----------------------------------------------------------------
167.\" * MAIN CONTENT STARTS HERE *
168.\" -----------------------------------------------------------------
169.SH "Name"
170vfs_full_audit \- record Samba VFS operations in the system log
171.SH "Synopsis"
172.fam C
173.HP \w'\ 'u
174\FCvfs objects = full_audit\F[]
175.fam
176.SH "DESCRIPTION"
177.PP
178This VFS module is part of the
179\fBsamba\fR(7)
180suite\&.
181.PP
182The
183\FCvfs_full_audit\F[]
184VFS module records selected client operations to the system log using
185\fBsyslog\fR(3)\&.
186.PP
187\FCvfs_full_audit\F[]
188is able to record the complete set of Samba VFS operations:
189.RS 4
190aio_cancel
191.RE
192.RS 4
193aio_error
194.RE
195.RS 4
196aio_fsync
197.RE
198.RS 4
199aio_read
200.RE
201.RS 4
202aio_return
203.RE
204.RS 4
205aio_suspend
206.RE
207.RS 4
208aio_write
209.RE
210.RS 4
211chdir
212.RE
213.RS 4
214chflags
215.RE
216.RS 4
217chmod
218.RE
219.RS 4
220chmod_acl
221.RE
222.RS 4
223chown
224.RE
225.RS 4
226close
227.RE
228.RS 4
229closedir
230.RE
231.RS 4
232connect
233.RE
234.RS 4
235disconnect
236.RE
237.RS 4
238disk_free
239.RE
240.RS 4
241fchmod
242.RE
243.RS 4
244fchmod_acl
245.RE
246.RS 4
247fchown
248.RE
249.RS 4
250fget_nt_acl
251.RE
252.RS 4
253fgetxattr
254.RE
255.RS 4
256flistxattr
257.RE
258.RS 4
259fremovexattr
260.RE
261.RS 4
262fset_nt_acl
263.RE
264.RS 4
265fsetxattr
266.RE
267.RS 4
268fstat
269.RE
270.RS 4
271fsync
272.RE
273.RS 4
274ftruncate
275.RE
276.RS 4
277get_nt_acl
278.RE
279.RS 4
280get_quota
281.RE
282.RS 4
283get_shadow_copy_data
284.RE
285.RS 4
286getlock
287.RE
288.RS 4
289getwd
290.RE
291.RS 4
292getxattr
293.RE
294.RS 4
295kernel_flock
296.RE
297.RS 4
298lgetxattr
299.RE
300.RS 4
301link
302.RE
303.RS 4
304linux_setlease
305.RE
306.RS 4
307listxattr
308.RE
309.RS 4
310llistxattr
311.RE
312.RS 4
313lock
314.RE
315.RS 4
316lremovexattr
317.RE
318.RS 4
319lseek
320.RE
321.RS 4
322lsetxattr
323.RE
324.RS 4
325lstat
326.RE
327.RS 4
328mkdir
329.RE
330.RS 4
331mknod
332.RE
333.RS 4
334open
335.RE
336.RS 4
337opendir
338.RE
339.RS 4
340pread
341.RE
342.RS 4
343pwrite
344.RE
345.RS 4
346read
347.RE
348.RS 4
349readdir
350.RE
351.RS 4
352readlink
353.RE
354.RS 4
355realpath
356.RE
357.RS 4
358removexattr
359.RE
360.RS 4
361rename
362.RE
363.RS 4
364rewinddir
365.RE
366.RS 4
367rmdir
368.RE
369.RS 4
370seekdir
371.RE
372.RS 4
373sendfile
374.RE
375.RS 4
376set_nt_acl
377.RE
378.RS 4
379set_quota
380.RE
381.RS 4
382setxattr
383.RE
384.RS 4
385stat
386.RE
387.RS 4
388statvfs
389.RE
390.RS 4
391symlink
392.RE
393.RS 4
394sys_acl_add_perm
395.RE
396.RS 4
397sys_acl_clear_perms
398.RE
399.RS 4
400sys_acl_create_entry
401.RE
402.RS 4
403sys_acl_delete_def_file
404.RE
405.RS 4
406sys_acl_free_acl
407.RE
408.RS 4
409sys_acl_free_qualifier
410.RE
411.RS 4
412sys_acl_free_text
413.RE
414.RS 4
415sys_acl_get_entry
416.RE
417.RS 4
418sys_acl_get_fd
419.RE
420.RS 4
421sys_acl_get_file
422.RE
423.RS 4
424sys_acl_get_perm
425.RE
426.RS 4
427sys_acl_get_permset
428.RE
429.RS 4
430sys_acl_get_qualifier
431.RE
432.RS 4
433sys_acl_get_tag_type
434.RE
435.RS 4
436sys_acl_init
437.RE
438.RS 4
439sys_acl_set_fd
440.RE
441.RS 4
442sys_acl_set_file
443.RE
444.RS 4
445sys_acl_set_permset
446.RE
447.RS 4
448sys_acl_set_qualifier
449.RE
450.RS 4
451sys_acl_set_tag_type
452.RE
453.RS 4
454sys_acl_to_text
455.RE
456.RS 4
457sys_acl_valid
458.RE
459.RS 4
460telldir
461.RE
462.RS 4
463unlink
464.RE
465.RS 4
466utime
467.RE
468.RS 4
469write
470.RE
471.PP
472In addition to these operations,
473\FCvfs_full_audit\F[]
474recognizes the special operation names "all" and "none ", which refer to all the VFS operations and none of the VFS operations respectively\&.
475.PP
476\FCvfs_full_audit\F[]
477records operations in fixed format consisting of fields separated by \'|\' characters\&. The format is:
478.sp
479.if n \{\
480.RS 4
481.\}
482.fam C
483.ps -1
484.nf
485.if t \{\
486.sp -1
487.\}
488.BB lightgray adjust-for-leading-newline
489.sp -1
490
491 smbd_audit: PREFIX|OPERATION|RESULT|FILE
492
493.EB lightgray adjust-for-leading-newline
494.if t \{\
495.sp 1
496.\}
497.fi
498.fam
499.ps +1
500.if n \{\
501.RE
502.\}
503.PP
504The record fields are:
505.sp
506.RS 4
507.ie n \{\
508\h'-04'\(bu\h'+03'\c
509.\}
510.el \{\
511.sp -1
512.IP \(bu 2.3
513.\}
514\FCPREFIX\F[]
515\- the result of the full_audit:prefix string after variable substitutions
516.RE
517.sp
518.RS 4
519.ie n \{\
520\h'-04'\(bu\h'+03'\c
521.\}
522.el \{\
523.sp -1
524.IP \(bu 2.3
525.\}
526\FCOPERATION\F[]
527\- the name of the VFS operation
528.RE
529.sp
530.RS 4
531.ie n \{\
532\h'-04'\(bu\h'+03'\c
533.\}
534.el \{\
535.sp -1
536.IP \(bu 2.3
537.\}
538\FCRESULT\F[]
539\- whether the operation succeeded or failed
540.RE
541.sp
542.RS 4
543.ie n \{\
544\h'-04'\(bu\h'+03'\c
545.\}
546.el \{\
547.sp -1
548.IP \(bu 2.3
549.\}
550\FCFILE\F[]
551\- the name of the file or directory the operation was performed on
552.sp
553.RE
554.PP
555This module is stackable\&.
556.SH "OPTIONS"
557.PP
558vfs_full_audit:prefix = STRING
559.RS 4
560Prepend audit messages with STRING\&. STRING is processed for standard substitution variables listed in
561\fBsmb.conf\fR(5)\&. The default prefix is "%u|%I"\&.
562.RE
563.PP
564vfs_full_audit:success = LIST
565.RS 4
566LIST is a list of VFS operations that should be recorded if they succeed\&. Operations are specified using the names listed above\&.
567.RE
568.PP
569vfs_full_audit:failure = LIST
570.RS 4
571LIST is a list of VFS operations that should be recorded if they failed\&. Operations are specified using the names listed above\&.
572.RE
573.PP
574full_audit:facility = FACILITY
575.RS 4
576Log messages to the named
577\fBsyslog\fR(3)
578facility\&.
579.RE
580.PP
581full_audit:priority = PRIORITY
582.RS 4
583Log messages with the named
584\fBsyslog\fR(3)
585priority\&.
586.RE
587.SH "EXAMPLES"
588.PP
589Log file and directory open operations on the [records] share using the LOCAL7 facility and ALERT priority, including the username and IP address:
590.sp
591.if n \{\
592.RS 4
593.\}
594.fam C
595.ps -1
596.nf
597.if t \{\
598.sp -1
599.\}
600.BB lightgray adjust-for-leading-newline
601.sp -1
602
603 \fI[records]\fR
604 \m[blue]\fBpath = /data/records\fR\m[]
605 \m[blue]\fBvfs objects = full_audit\fR\m[]
606 \m[blue]\fBfull_audit:prefix = %u|%I\fR\m[]
607 \m[blue]\fBfull_audit:success = open opendir\fR\m[]
608 \m[blue]\fBfull_audit:failure = all\fR\m[]
609 \m[blue]\fBfull_audit:facility = LOCAL7\fR\m[]
610 \m[blue]\fBfull_audit:priority = ALERT\fR\m[]
611.EB lightgray adjust-for-leading-newline
612.if t \{\
613.sp 1
614.\}
615.fi
616.fam
617.ps +1
618.if n \{\
619.RE
620.\}
621.SH "VERSION"
622.PP
623This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
624.SH "AUTHOR"
625.PP
626The 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\&.
Note: See TracBrowser for help on using the repository browser.