Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
AUDIT_CONTROL(5)          FreeBSD File Formats Manual         AUDIT_CONTROL(5)

     audit_control -- contains audit system parameters

     The audit_control file contains several audit system parameters.  Each
     line of this file is of the form:


     The parameters are:

     dir     The directory where audit log files are stored.  There may be
             more than one of these entries.  Changes to this entry can only
             be enacted by restarting the audit system.  See audit(1) for a
             description of how to restart the audit system.

     flags   Specifies which audit event classes are audited for all users.
             audit_user(5) describes how to audit events for individual users.
             See the information below for the format of the audit flags.

             Contains the audit flags that define what classes of events are
             audited when an action cannot be attributed to a specific user.

             The minimum free space required on the file system audit logs are
             being written to.  When the free space falls below this limit a
             warning will be issued.  Not currently used as the value of 20
             percent is chosen by the kernel.

     policy  A list of global audit policy flags specifying various behaviors,
             such as fail stop, auditing of paths and arguments, etc.

     filesz  Maximum trail size in bytes; if set to a non-0 value, the audit
             daemon will rotate the audit trail file at around this size.
             Sizes less than the minimum trail size (default of 512K) will be
             rejected as invalid.  If 0, trail files will not be automatically
             rotated based on file size.

     Audit flags are a comma-delimited list of audit classes as defined in the
     audit_class file.  See audit_class(5) for details.  Event classes may be
     preceded by a prefix which changes their interpretation.  The following
     prefixes may be used for each class:

           (none)  Record both successful and failed events
           +       Record successful events
           -       Record failed events
           ^       Record neither successful nor failed events
           ^+      Do not record successful events
           ^-      Do not record failed events

     The policy flags field is a comma-delimited list of policy flags from the
     following list:

           cnt       Allow processes to continue running even though events
                     are not being audited.  If not set, processes will be
                     suspended when the audit store space is exhausted.  Cur-
                     rently, this is not a recoverable state.
           ahlt      Fail stop the system if unable to audit an event--this
                     consists of first draining pending records to disk, and
                     then halting the operating system.
           argv      Audit command line arguments to execve(2).
           arge      Audit environmental variable arguments to execve(2).
           seq       Include a unique audit sequence number token in generated
                     audit records (not implemented on FreeBSD or Darwin).
           group     Include supplementary groups list in generated audit
                     records (not implemented on FreeBSD or Darwin; supplemen-
                     tary groups are never included in records on these sys-
           trail     Append a trailer token to each audit record (not imple-
                     mented on FreeBSD or Darwin; trailers are always included
                     in records on these systems).
           path      Include secondary file paths in audit records (not imple-
                     mented on FreeBSD or Darwin; secondary paths are never
                     included in records on these systems).
           zonename  Include a zone ID token with each audit record (not
                     implemented on FreeBSD or Darwin; FreeBSD audit records
                     do not currently include the jail ID or name.)
           perzone   Enable auditing for each local zone (not implemented on
                     FreeBSD or Darwin; on FreeBSD, audit records are col-
                     lected from all jails and placed in a single global
                     trail, and only limited audit controls are permitted
                     within a jail.)

     It is recommended that installations set the cnt flag but not ahlt flag
     unless it is intended that audit logs exceeding available disk space halt
     the system.

     The following settings appear in the default audit_control file:


     The flags parameter above specifies the system-wide mask corresponding to
     login/logout events.  The policy parameter specifies that the system
     should neither fail stop nor suspend processes when the audit store
     fills.  The trail file will not be automatically rotated by the audit
     daemon based on file size.


     audit_class(5), audit_user(5), audit(8), auditd(8)

     This software was created by McAfee Research, the security research divi-
     sion of McAfee, Inc., under contract to Apple Computer Inc.  Additional
     authors include Wayne Salamon, Robert Watson, and SPARTA Inc.

     The Basic Security Module (BSM) interface to audit records and audit
     event stream format were defined by Sun Microsystems.

     The OpenBSM implementation was created by McAfee Research, the security
     division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
     It was subsequently adopted by the TrustedBSD Project as the foundation
     for the OpenBSM distribution.

FreeBSD 6.2                     January 4, 2006                    FreeBSD 6.2


Want to link to this manual page? Use this URL:

home | help