share/man/man4/audit.4

   1 .\" Copyright (c) 2006 Robert N. M. Watson
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd May 5, 2006
  28 .Os
  29 .Dt AUDIT 4
  30 .Sh NAME
  31 .Nm audit
  32 .Nd Security Event Audit
  33 .Sh SYNOPSIS
  34 .Cd "options AUDIT"
  35 .Sh DESCRIPTION
  36 Security Event Audit is a facility to provide fine-grained, configurable
  37 logging of security-relevant events, and is intended to meet the requirements
  38 of the Common Criteria (CC) Common Access Protection Profile (CAPP)
  39 evaluation.
  40 The
  41 .Fx
  42 audit facility implements the de facto industry standard BSM API, file
  43 formats, and command line interface, first found in the Solaris operating
  44 system.
  45 Information on the user space implementation can be found in
  46 .Xr libbsm 3 .
  47 .Pp
  48 Audit support is enabled at boot, if present in the kernel, using an
  49 .Xr rc.conf 5
  50 flag.
  51 The audit daemon,
  52 .Xr auditd 8 ,
  53 is responsible for configuring the kernel to perform audit, pushing
  54 configuration data from the various audit configuration files into the
  55 kernel.
  56 .Ss Audit Special Device
  57 The kernel audit facility provides a special device,
  58 .Pa /dev/audit ,
  59 which is used by
  60 .Xr auditd 8
  61 to monitor for audit events, such as requests to cycle the log, low disk
  62 space conditions, and requests to terminate auditing.
  63 This device is not intended for use by applications.
  64 .Ss Audit Pipe Special Devices
  65 Audit pipe special devices, discussed in
  66 .Xr auditpipe 4 ,
  67 provide a configurable live tracking mechanism to allow applications to
  68 tee the audit trail, as well as to configure custom preselection paramaters
  69 to track users and events in a fine-grained manner.
  70 .Sh SEE ALSO
  71 .Xr auditreduce 1 ,
  72 .Xr praudit 1 ,
  73 .Xr audit 2 ,
  74 .Xr auditctl 2 ,
  75 .Xr auditon 2 ,
  76 .Xr getaudit 2 ,
  77 .Xr getauid 2 ,
  78 .Xr poll 2 ,
  79 .Xr select 2 ,
  80 .Xr setaudit 2 ,
  81 .Xr setauid 2 ,
  82 .Xr libbsm 3 ,
  83 .Xr auditpipe 4 ,
  84 .Xr audit.log 5 ,
  85 .Xr audit_class 5 ,
  86 .Xr audit_control 5 ,
  87 .Xr audit_event 5 ,
  88 .Xr audit_user 5 ,
  89 .Xr audit_warn 5 ,
  90 .Xr rc.conf 5 ,
  91 .Xr audit 8 ,
  92 .Xr auditd 8
  93 .Sh AUTHORS
  94 This software was created by McAfee Research, the security research division
  95 of McAfee, Inc., under contract to Apple Computer Inc.
  96 Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
  97 .Pp
  98 The Basic Security Module (BSM) interface to audit records and audit event
  99 stream format were defined by Sun Microsystems.
 100 .Pp
 101 This manual page was written by
 102 .An Robert Watson Aq rwatson@FreeBSD.org .
 103 .Sh HISTORY
 104 The OpenBSM implementation was created by McAfee Research, the security
 105 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
 106 It was subsequently adopted by the TrustedBSD Project as the foundation for
 107 the OpenBSM distribution.
 108 .Pp
 109 Support for kernel audit first appeared in
 110 .Fx 6.2 .
 111 .Sh BUGS
 112 The audit facility in
 113 .Fx
 114 is considered experimental, and production deployment should occur only after
 115 careful consideration of the risks of deploying experimental software.
 116 .Pp
 117 The
 118 .Fx
 119 kernel does not fully validate that audit records submitted by user
 120 applications are syntactically valid BSM; as submission of records is limited
 121 to privileged processes, this is not a critical bug.
 122 .Pp
 123 Instrumentation of auditable events in the kernel is not complete, as some
 124 system calls do not generate audit records, or generate audit records with
 125 incomplete argument information.
 126 .Pp
 127 Mandatory Access Control (MAC) labels, as provided by the
 128 .Xr mac 4
 129 facility, are not audited as part of records involving MAC decisions.