| 1 | '\" t
|
|---|
| 2 | .\" Title: vfs_full_audit
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 09/18/2013
|
|---|
| 6 | .\" Manual: System Administration tools
|
|---|
| 7 | .\" Source: Samba 3.6
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "VFS_FULL_AUDIT" "8" "09/18/2013" "Samba 3\&.6" "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_cancel
|
|---|
| 50 | .RE
|
|---|
| 51 | .RS 4
|
|---|
| 52 | aio_error
|
|---|
| 53 | .RE
|
|---|
| 54 | .RS 4
|
|---|
| 55 | aio_fsync
|
|---|
| 56 | .RE
|
|---|
| 57 | .RS 4
|
|---|
| 58 | aio_read
|
|---|
| 59 | .RE
|
|---|
| 60 | .RS 4
|
|---|
| 61 | aio_return
|
|---|
| 62 | .RE
|
|---|
| 63 | .RS 4
|
|---|
| 64 | aio_suspend
|
|---|
| 65 | .RE
|
|---|
| 66 | .RS 4
|
|---|
| 67 | aio_write
|
|---|
| 68 | .RE
|
|---|
| 69 | .RS 4
|
|---|
| 70 | chdir
|
|---|
| 71 | .RE
|
|---|
| 72 | .RS 4
|
|---|
| 73 | chflags
|
|---|
| 74 | .RE
|
|---|
| 75 | .RS 4
|
|---|
| 76 | chmod
|
|---|
| 77 | .RE
|
|---|
| 78 | .RS 4
|
|---|
| 79 | chmod_acl
|
|---|
| 80 | .RE
|
|---|
| 81 | .RS 4
|
|---|
| 82 | chown
|
|---|
| 83 | .RE
|
|---|
| 84 | .RS 4
|
|---|
| 85 | close
|
|---|
| 86 | .RE
|
|---|
| 87 | .RS 4
|
|---|
| 88 | closedir
|
|---|
| 89 | .RE
|
|---|
| 90 | .RS 4
|
|---|
| 91 | connect
|
|---|
| 92 | .RE
|
|---|
| 93 | .RS 4
|
|---|
| 94 | disconnect
|
|---|
| 95 | .RE
|
|---|
| 96 | .RS 4
|
|---|
| 97 | disk_free
|
|---|
| 98 | .RE
|
|---|
| 99 | .RS 4
|
|---|
| 100 | fchmod
|
|---|
| 101 | .RE
|
|---|
| 102 | .RS 4
|
|---|
| 103 | fchmod_acl
|
|---|
| 104 | .RE
|
|---|
| 105 | .RS 4
|
|---|
| 106 | fchown
|
|---|
| 107 | .RE
|
|---|
| 108 | .RS 4
|
|---|
| 109 | fget_nt_acl
|
|---|
| 110 | .RE
|
|---|
| 111 | .RS 4
|
|---|
| 112 | fgetxattr
|
|---|
| 113 | .RE
|
|---|
| 114 | .RS 4
|
|---|
| 115 | flistxattr
|
|---|
| 116 | .RE
|
|---|
| 117 | .RS 4
|
|---|
| 118 | fremovexattr
|
|---|
| 119 | .RE
|
|---|
| 120 | .RS 4
|
|---|
| 121 | fset_nt_acl
|
|---|
| 122 | .RE
|
|---|
| 123 | .RS 4
|
|---|
| 124 | fsetxattr
|
|---|
| 125 | .RE
|
|---|
| 126 | .RS 4
|
|---|
| 127 | fstat
|
|---|
| 128 | .RE
|
|---|
| 129 | .RS 4
|
|---|
| 130 | fsync
|
|---|
| 131 | .RE
|
|---|
| 132 | .RS 4
|
|---|
| 133 | ftruncate
|
|---|
| 134 | .RE
|
|---|
| 135 | .RS 4
|
|---|
| 136 | get_nt_acl
|
|---|
| 137 | .RE
|
|---|
| 138 | .RS 4
|
|---|
| 139 | get_quota
|
|---|
| 140 | .RE
|
|---|
| 141 | .RS 4
|
|---|
| 142 | get_shadow_copy_data
|
|---|
| 143 | .RE
|
|---|
| 144 | .RS 4
|
|---|
| 145 | getlock
|
|---|
| 146 | .RE
|
|---|
| 147 | .RS 4
|
|---|
| 148 | getwd
|
|---|
| 149 | .RE
|
|---|
| 150 | .RS 4
|
|---|
| 151 | getxattr
|
|---|
| 152 | .RE
|
|---|
| 153 | .RS 4
|
|---|
| 154 | kernel_flock
|
|---|
| 155 | .RE
|
|---|
| 156 | .RS 4
|
|---|
| 157 | lgetxattr
|
|---|
| 158 | .RE
|
|---|
| 159 | .RS 4
|
|---|
| 160 | link
|
|---|
| 161 | .RE
|
|---|
| 162 | .RS 4
|
|---|
| 163 | linux_setlease
|
|---|
| 164 | .RE
|
|---|
| 165 | .RS 4
|
|---|
| 166 | listxattr
|
|---|
| 167 | .RE
|
|---|
| 168 | .RS 4
|
|---|
| 169 | llistxattr
|
|---|
| 170 | .RE
|
|---|
| 171 | .RS 4
|
|---|
| 172 | lock
|
|---|
| 173 | .RE
|
|---|
| 174 | .RS 4
|
|---|
| 175 | lremovexattr
|
|---|
| 176 | .RE
|
|---|
| 177 | .RS 4
|
|---|
| 178 | lseek
|
|---|
| 179 | .RE
|
|---|
| 180 | .RS 4
|
|---|
| 181 | lsetxattr
|
|---|
| 182 | .RE
|
|---|
| 183 | .RS 4
|
|---|
| 184 | lstat
|
|---|
| 185 | .RE
|
|---|
| 186 | .RS 4
|
|---|
| 187 | mkdir
|
|---|
| 188 | .RE
|
|---|
| 189 | .RS 4
|
|---|
| 190 | mknod
|
|---|
| 191 | .RE
|
|---|
| 192 | .RS 4
|
|---|
| 193 | open
|
|---|
| 194 | .RE
|
|---|
| 195 | .RS 4
|
|---|
| 196 | opendir
|
|---|
| 197 | .RE
|
|---|
| 198 | .RS 4
|
|---|
| 199 | pread
|
|---|
| 200 | .RE
|
|---|
| 201 | .RS 4
|
|---|
| 202 | pwrite
|
|---|
| 203 | .RE
|
|---|
| 204 | .RS 4
|
|---|
| 205 | read
|
|---|
| 206 | .RE
|
|---|
| 207 | .RS 4
|
|---|
| 208 | readdir
|
|---|
| 209 | .RE
|
|---|
| 210 | .RS 4
|
|---|
| 211 | readlink
|
|---|
| 212 | .RE
|
|---|
| 213 | .RS 4
|
|---|
| 214 | realpath
|
|---|
| 215 | .RE
|
|---|
| 216 | .RS 4
|
|---|
| 217 | removexattr
|
|---|
| 218 | .RE
|
|---|
| 219 | .RS 4
|
|---|
| 220 | rename
|
|---|
| 221 | .RE
|
|---|
| 222 | .RS 4
|
|---|
| 223 | rewinddir
|
|---|
| 224 | .RE
|
|---|
| 225 | .RS 4
|
|---|
| 226 | rmdir
|
|---|
| 227 | .RE
|
|---|
| 228 | .RS 4
|
|---|
| 229 | seekdir
|
|---|
| 230 | .RE
|
|---|
| 231 | .RS 4
|
|---|
| 232 | sendfile
|
|---|
| 233 | .RE
|
|---|
| 234 | .RS 4
|
|---|
| 235 | set_nt_acl
|
|---|
| 236 | .RE
|
|---|
| 237 | .RS 4
|
|---|
| 238 | set_quota
|
|---|
| 239 | .RE
|
|---|
| 240 | .RS 4
|
|---|
| 241 | setxattr
|
|---|
| 242 | .RE
|
|---|
| 243 | .RS 4
|
|---|
| 244 | stat
|
|---|
| 245 | .RE
|
|---|
| 246 | .RS 4
|
|---|
| 247 | statvfs
|
|---|
| 248 | .RE
|
|---|
| 249 | .RS 4
|
|---|
| 250 | symlink
|
|---|
| 251 | .RE
|
|---|
| 252 | .RS 4
|
|---|
| 253 | sys_acl_add_perm
|
|---|
| 254 | .RE
|
|---|
| 255 | .RS 4
|
|---|
| 256 | sys_acl_clear_perms
|
|---|
| 257 | .RE
|
|---|
| 258 | .RS 4
|
|---|
| 259 | sys_acl_create_entry
|
|---|
| 260 | .RE
|
|---|
| 261 | .RS 4
|
|---|
| 262 | sys_acl_delete_def_file
|
|---|
| 263 | .RE
|
|---|
| 264 | .RS 4
|
|---|
| 265 | sys_acl_free_acl
|
|---|
| 266 | .RE
|
|---|
| 267 | .RS 4
|
|---|
| 268 | sys_acl_free_qualifier
|
|---|
| 269 | .RE
|
|---|
| 270 | .RS 4
|
|---|
| 271 | sys_acl_free_text
|
|---|
| 272 | .RE
|
|---|
| 273 | .RS 4
|
|---|
| 274 | sys_acl_get_entry
|
|---|
| 275 | .RE
|
|---|
| 276 | .RS 4
|
|---|
| 277 | sys_acl_get_fd
|
|---|
| 278 | .RE
|
|---|
| 279 | .RS 4
|
|---|
| 280 | sys_acl_get_file
|
|---|
| 281 | .RE
|
|---|
| 282 | .RS 4
|
|---|
| 283 | sys_acl_get_perm
|
|---|
| 284 | .RE
|
|---|
| 285 | .RS 4
|
|---|
| 286 | sys_acl_get_permset
|
|---|
| 287 | .RE
|
|---|
| 288 | .RS 4
|
|---|
| 289 | sys_acl_get_qualifier
|
|---|
| 290 | .RE
|
|---|
| 291 | .RS 4
|
|---|
| 292 | sys_acl_get_tag_type
|
|---|
| 293 | .RE
|
|---|
| 294 | .RS 4
|
|---|
| 295 | sys_acl_init
|
|---|
| 296 | .RE
|
|---|
| 297 | .RS 4
|
|---|
| 298 | sys_acl_set_fd
|
|---|
| 299 | .RE
|
|---|
| 300 | .RS 4
|
|---|
| 301 | sys_acl_set_file
|
|---|
| 302 | .RE
|
|---|
| 303 | .RS 4
|
|---|
| 304 | sys_acl_set_permset
|
|---|
| 305 | .RE
|
|---|
| 306 | .RS 4
|
|---|
| 307 | sys_acl_set_qualifier
|
|---|
| 308 | .RE
|
|---|
| 309 | .RS 4
|
|---|
| 310 | sys_acl_set_tag_type
|
|---|
| 311 | .RE
|
|---|
| 312 | .RS 4
|
|---|
| 313 | sys_acl_to_text
|
|---|
| 314 | .RE
|
|---|
| 315 | .RS 4
|
|---|
| 316 | sys_acl_valid
|
|---|
| 317 | .RE
|
|---|
| 318 | .RS 4
|
|---|
| 319 | telldir
|
|---|
| 320 | .RE
|
|---|
| 321 | .RS 4
|
|---|
| 322 | unlink
|
|---|
| 323 | .RE
|
|---|
| 324 | .RS 4
|
|---|
| 325 | utime
|
|---|
| 326 | .RE
|
|---|
| 327 | .RS 4
|
|---|
| 328 | write
|
|---|
| 329 | .RE
|
|---|
| 330 | .PP
|
|---|
| 331 | In addition to these operations,
|
|---|
| 332 | vfs_full_audit
|
|---|
| 333 | recognizes the special operation names "all" and "none ", which refer to all the VFS operations and none of the VFS operations respectively\&.
|
|---|
| 334 | .PP
|
|---|
| 335 | vfs_full_audit
|
|---|
| 336 | records operations in fixed format consisting of fields separated by \*(Aq|\*(Aq characters\&. The format is:
|
|---|
| 337 | .sp
|
|---|
| 338 | .if n \{\
|
|---|
| 339 | .RS 4
|
|---|
| 340 | .\}
|
|---|
| 341 | .nf
|
|---|
| 342 | smbd_audit: PREFIX|OPERATION|RESULT|FILE
|
|---|
| 343 |
|
|---|
| 344 | .fi
|
|---|
| 345 | .if n \{\
|
|---|
| 346 | .RE
|
|---|
| 347 | .\}
|
|---|
| 348 | .PP
|
|---|
| 349 | The record fields are:
|
|---|
| 350 | .sp
|
|---|
| 351 | .RS 4
|
|---|
| 352 | .ie n \{\
|
|---|
| 353 | \h'-04'\(bu\h'+03'\c
|
|---|
| 354 | .\}
|
|---|
| 355 | .el \{\
|
|---|
| 356 | .sp -1
|
|---|
| 357 | .IP \(bu 2.3
|
|---|
| 358 | .\}
|
|---|
| 359 | PREFIX
|
|---|
| 360 | \- the result of the full_audit:prefix string after variable substitutions
|
|---|
| 361 | .RE
|
|---|
| 362 | .sp
|
|---|
| 363 | .RS 4
|
|---|
| 364 | .ie n \{\
|
|---|
| 365 | \h'-04'\(bu\h'+03'\c
|
|---|
| 366 | .\}
|
|---|
| 367 | .el \{\
|
|---|
| 368 | .sp -1
|
|---|
| 369 | .IP \(bu 2.3
|
|---|
| 370 | .\}
|
|---|
| 371 | OPERATION
|
|---|
| 372 | \- the name of the VFS operation
|
|---|
| 373 | .RE
|
|---|
| 374 | .sp
|
|---|
| 375 | .RS 4
|
|---|
| 376 | .ie n \{\
|
|---|
| 377 | \h'-04'\(bu\h'+03'\c
|
|---|
| 378 | .\}
|
|---|
| 379 | .el \{\
|
|---|
| 380 | .sp -1
|
|---|
| 381 | .IP \(bu 2.3
|
|---|
| 382 | .\}
|
|---|
| 383 | RESULT
|
|---|
| 384 | \- whether the operation succeeded or failed
|
|---|
| 385 | .RE
|
|---|
| 386 | .sp
|
|---|
| 387 | .RS 4
|
|---|
| 388 | .ie n \{\
|
|---|
| 389 | \h'-04'\(bu\h'+03'\c
|
|---|
| 390 | .\}
|
|---|
| 391 | .el \{\
|
|---|
| 392 | .sp -1
|
|---|
| 393 | .IP \(bu 2.3
|
|---|
| 394 | .\}
|
|---|
| 395 | FILE
|
|---|
| 396 | \- the name of the file or directory the operation was performed on
|
|---|
| 397 | .RE
|
|---|
| 398 | .sp
|
|---|
| 399 | .RE
|
|---|
| 400 | .PP
|
|---|
| 401 | This module is stackable\&.
|
|---|
| 402 | .SH "OPTIONS"
|
|---|
| 403 | .PP
|
|---|
| 404 | vfs_full_audit:prefix = STRING
|
|---|
| 405 | .RS 4
|
|---|
| 406 | Prepend audit messages with STRING\&. STRING is processed for standard substitution variables listed in
|
|---|
| 407 | \fBsmb.conf\fR(5)\&. The default prefix is "%u|%I"\&.
|
|---|
| 408 | .RE
|
|---|
| 409 | .PP
|
|---|
| 410 | vfs_full_audit:success = LIST
|
|---|
| 411 | .RS 4
|
|---|
| 412 | 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 "!"\&.
|
|---|
| 413 | .RE
|
|---|
| 414 | .PP
|
|---|
| 415 | vfs_full_audit:failure = LIST
|
|---|
| 416 | .RS 4
|
|---|
| 417 | 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 "!"\&.
|
|---|
| 418 | .RE
|
|---|
| 419 | .PP
|
|---|
| 420 | full_audit:facility = FACILITY
|
|---|
| 421 | .RS 4
|
|---|
| 422 | Log messages to the named
|
|---|
| 423 | \fBsyslog\fR(3)
|
|---|
| 424 | facility\&.
|
|---|
| 425 | .RE
|
|---|
| 426 | .PP
|
|---|
| 427 | full_audit:priority = PRIORITY
|
|---|
| 428 | .RS 4
|
|---|
| 429 | Log messages with the named
|
|---|
| 430 | \fBsyslog\fR(3)
|
|---|
| 431 | priority\&.
|
|---|
| 432 | .RE
|
|---|
| 433 | .SH "EXAMPLES"
|
|---|
| 434 | .PP
|
|---|
| 435 | 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:
|
|---|
| 436 | .sp
|
|---|
| 437 | .if n \{\
|
|---|
| 438 | .RS 4
|
|---|
| 439 | .\}
|
|---|
| 440 | .nf
|
|---|
| 441 | \fI[records]\fR
|
|---|
| 442 | \m[blue]\fBpath = /data/records\fR\m[]
|
|---|
| 443 | \m[blue]\fBvfs objects = full_audit\fR\m[]
|
|---|
| 444 | \m[blue]\fBfull_audit:prefix = %u|%I\fR\m[]
|
|---|
| 445 | \m[blue]\fBfull_audit:success = open opendir\fR\m[]
|
|---|
| 446 | \m[blue]\fBfull_audit:failure = all !open\fR\m[]
|
|---|
| 447 | \m[blue]\fBfull_audit:facility = LOCAL7\fR\m[]
|
|---|
| 448 | \m[blue]\fBfull_audit:priority = ALERT\fR\m[]
|
|---|
| 449 | .fi
|
|---|
| 450 | .if n \{\
|
|---|
| 451 | .RE
|
|---|
| 452 | .\}
|
|---|
| 453 | .SH "VERSION"
|
|---|
| 454 | .PP
|
|---|
| 455 | This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
|
|---|
| 456 | .SH "AUTHOR"
|
|---|
| 457 | .PP
|
|---|
| 458 | 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\&.
|
|---|
