Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

vfs_full_audit (8)

Name

vfs_full_audit - record Samba VFS operations in the system log

Synopsis

vfs objects = full_audit

Description

System Administration tools                                  VFS_FULL_AUDIT(8)



NAME
       vfs_full_audit - record Samba VFS operations in the system log

SYNOPSIS
       vfs objects = full_audit

DESCRIPTION
       This VFS module is part of the samba(7) suite.

       The vfs_full_audit VFS module records selected client operations to the
       system log using syslog(3).

       vfs_full_audit is able to record the complete set of Samba VFS
       operations:
           aio_force
           audit_file
           brl_lock_windows
           brl_unlock_windows
           chdir
           chflags
           chmod
           close
           closedir
           connect
           connectpath
           create_dfs_pathat
           create_file
           disconnect
           disk_free
           durable_cookie
           durable_disconnect
           durable_reconnect
           fallocate
           fchmod
           fchown
           fdopendir
           fget_dos_attributes
           fget_nt_acl_at
           fgetxattr
           file_id_create
           flistxattr
           fremovexattr
           fs_capabilities
           fsctl
           fset_dos_attributes
           fset_nt_acl
           fsetxattr
           fs_file_id
           fstat
           fsync
           fsync_recv
           fsync_send
           ftruncate
           get_alloc_size
           get_compression
           get_dfs_referrals
           get_dos_attributes
           get_dos_attributes_recv
           get_dos_attributes_send
           getlock
           get_nt_acl
           get_quota
           get_real_filename
           get_shadow_copy_data
           getwd
           getxattr
           getxattrat_recv
           getxattrat_send
           is_offline
           kernel_flock
           lchown
           linkat
           linux_setlease
           listxattr
           lock
           lseek
           lstat
           mkdirat
           mknodat
           ntimes
           offload_read_recv
           offload_read_send
           offload_write_recv
           offload_write_send
           open
           pread
           pread_recv
           pread_send
           pwrite
           pwrite_recv
           pwrite_send
           read
           readdir
           readdir_attr
           readlinkat
           realpath
           recvfile
           removexattr
           renameat
           rewinddir
           seekdir
           sendfile
           set_compression
           set_dos_attributes
           set_offline
           set_quota
           setxattr
           snap_check_path
           snap_create
           snap_delete
           stat
           statvfs
           streaminfo
           strict_lock_check
           symlinkat
           sys_acl_blob_get_fd
           sys_acl_blob_get_file
           sys_acl_delete_def_file
           sys_acl_get_fd
           sys_acl_get_file
           sys_acl_set_fd
           sys_acl_set_file
           telldir
           translate_name
           unlinkat
           write

       In addition to these operations, vfs_full_audit recognizes the special
       operation names "all" and "none ", which refer to all the VFS
       operations and none of the VFS operations respectively.

       vfs_full_audit records operations in fixed format consisting of fields
       separated by '|' characters. The format is:

                     smbd_audit: PREFIX|OPERATION|RESULT|FILE


       The record fields are:

              o   PREFIX - the result of the full_audit:prefix string after
                  variable substitutions

              o   OPERATION - the name of the VFS operation

              o   RESULT - whether the operation succeeded or failed

              o   FILE - the name of the file or directory the operation was
                  performed on


       This module is stackable.

OPTIONS
       full_audit:prefix = STRING
           Prepend audit messages with STRING. STRING is processed for
           standard substitution variables listed in smb.conf(5). The default
           prefix is "%u|%I".

       full_audit:success = LIST
           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.

       full_audit:failure = LIST
           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.

       full_audit:facility = FACILITY
           Log messages to the named syslog(3) facility.

       full_audit:priority = PRIORITY
           Log messages with the named syslog(3) priority.

       full_audit:syslog = true/false
           Log messages to syslog (default) or as a debug level 1 message.

       full_audit:log_secdesc = true/false
           Log an sddl form of the security descriptor coming in when a client
           sets an acl. Defaults to false.

EXAMPLES
       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:

                   [records]
                path = /data/records
                vfs objects = full_audit
                full_audit:prefix = %u|%I
                full_audit:success = open opendir
                full_audit:failure = all !open
                full_audit:facility = LOCAL7
                full_audit:priority = ALERT

VERSION
       This man page is part of version 4.13.14 of the Samba suite.

AUTHOR
       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.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | service/network/samba |
       +---------------+-----------------------+
       |Stability      | Volatile              |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://download.samba.org/pub/samba/stable/samba-4.13.14.tar.gz.

       Further information about this software can be found on the open source
       community website at http://www.samba.org/.



Samba 4.13.14                     12/22/2021                 VFS_FULL_AUDIT(8)