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.\"
| 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: head/share/man/man4/audit.4 155392 2006-02-06 18:41:00Z rwatson $
| 25.\" $FreeBSD: head/share/man/man4/audit.4 155395 2006-02-06 19:28:02Z brueffer $
|
26.\" 27.Dd February 6, 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 36Security Event Audit is a facility to provide fine-grained, configurable 37logging of security-relevant events, and is intended to meet the requirements 38of the Common Criteria (CC) Common Access Protection Profile (CAPP) 39evaluation. 40The 41.Fx 42audit facility implements the de facto industry standard BSM API, file 43formats, and command line interface, first found in the Solaris operating 44system. 45Information on the user space implementation can be found in 46.Xr libbsm 3 . 47.Pp 48Audit support is enabled at boot, if present in the kernel, using an 49.Xr rc.conf 5 50flag. 51The audit daemon, 52.Xr auditd 8 , 53is responsible for configuring the kernel to perform audit, pushing 54configuration data from the various audit configuration files into the 55kernel. 56.Ss Audit Special Device 57The kernel audit facility provides a special device, 58.Pa /dev/audit , 59which is used by 60.Xr auditd 8 61to monitor for audit events, such as requests to cycle the log, low disk 62space conditions, and requests to terminate auditing. 63This device is not intended for use by applications. 64.Ss Audit Pipe Special Devices
| 26.\" 27.Dd February 6, 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 36Security Event Audit is a facility to provide fine-grained, configurable 37logging of security-relevant events, and is intended to meet the requirements 38of the Common Criteria (CC) Common Access Protection Profile (CAPP) 39evaluation. 40The 41.Fx 42audit facility implements the de facto industry standard BSM API, file 43formats, and command line interface, first found in the Solaris operating 44system. 45Information on the user space implementation can be found in 46.Xr libbsm 3 . 47.Pp 48Audit support is enabled at boot, if present in the kernel, using an 49.Xr rc.conf 5 50flag. 51The audit daemon, 52.Xr auditd 8 , 53is responsible for configuring the kernel to perform audit, pushing 54configuration data from the various audit configuration files into the 55kernel. 56.Ss Audit Special Device 57The kernel audit facility provides a special device, 58.Pa /dev/audit , 59which is used by 60.Xr auditd 8 61to monitor for audit events, such as requests to cycle the log, low disk 62space conditions, and requests to terminate auditing. 63This device is not intended for use by applications. 64.Ss Audit Pipe Special Devices
|
65The kernel audit facility also a clonable special device,
| 65The kernel audit facility also provides a clonable special device,
|
66.Pa /dev/auditpipe , 67which allows appropriately privileged applications to gain direct access to 68the BSM audit stream without accessing audit trail files. 69As audit trail files are owned by the audit daemon until terminated, they 70are an unreliable way for applications to access live audit data; this
| 66.Pa /dev/auditpipe , 67which allows appropriately privileged applications to gain direct access to 68the BSM audit stream without accessing audit trail files. 69As audit trail files are owned by the audit daemon until terminated, they 70are an unreliable way for applications to access live audit data; this
|
71special device inserts a "tee" in the audit event stream.
| 71special device inserts a 72.Qq tee 73in the audit event stream.
|
72This facility is appropriate for use by live monitoring tools, including 73intrusion detection. 74As the device is clonable, more than one instance of the device may be opened 75at a time; each device instance will provide access to all records. 76.Pp 77The audit pipe device provides discreet BSM audit records; if the read buffer 78passed by the application is too small to hold the next record in the 79sequence, it will be dropped. 80Unlike audit data written to the audit trail, the reliability of record 81delivery is not guaranteed. 82In particular, when an audit pipe queue fills, records will be dropped. 83Audit pipe devices are blocking by default, but support non-blocking I/O, 84asynchronous I/O using SIGIO, and support for polled operation via 85.Xr select 2 86and 87.Xr poll 2 . 88.Sh SEE ALSO 89.Xr auditreduce 1 , 90.Xr praudit 1 , 91.Xr audit 2 , 92.Xr auditctl 2 , 93.Xr auditon 2 , 94.Xr getaudit 2 , 95.Xr getauid 2 , 96.Xr poll 2 , 97.Xr select 2 , 98.Xr setaudit 2 , 99.Xr setauid 2 , 100.Xr libbsm 3 , 101.Xr audit.log 5 , 102.Xr audit_class 5 , 103.Xr audit_control 5 , 104.Xr audit_event 5 , 105.Xr audit_user 5 , 106.Xr audit_warn 5 , 107.Xr rc.conf 5 , 108.Xr audit 8 , 109.Xr auditd 8 110.Sh AUTHORS 111This software was created by McAfee Research, the security research division 112of McAfee, Inc., under contract to Apple Computer Inc. 113Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc. 114.Pp 115The Basic Security Module (BSM) interface to audit records and audit event 116stream format were defined by Sun Microsystems. 117.Pp 118This manual page was written by 119.An Robert Watson Aq rwatson@FreeBSD.org . 120.Sh HISTORY 121The OpenBSM implementation was created by McAfee Research, the security 122division of McAfee Inc., under contract to Apple Computer Inc. in 2004. 123It was subsequently adopted by the TrustedBSD Project as the foundation for 124the OpenBSM distribution. 125.Pp 126Support for kernel audit first appeared in 127.Fx 6.1 . 128.Sh BUGS 129The audit facility in 130.Fx 131is considered experimental, and production deployment should occur only after 132careful consideration of the risks of deploying experimental software. 133.Pp 134The 135.Fx 136kernel does not fully validate that audit records submitted by user 137applications are syntactically valid BSM; as submission of records is limited 138to privileged processes, this is not a critical bug. 139.Pp 140Instrumentation of auditable events in the kernel is not complete, as some 141system calls do not generate audit records, or generate audit records with 142incomplete argument information. 143.Pp 144Mandatory Access Control (MAC) labels, as provided by the 145.Xr mac 4 146facility, are not audited as part of records involving MAC decisions.
| 74This facility is appropriate for use by live monitoring tools, including 75intrusion detection. 76As the device is clonable, more than one instance of the device may be opened 77at a time; each device instance will provide access to all records. 78.Pp 79The audit pipe device provides discreet BSM audit records; if the read buffer 80passed by the application is too small to hold the next record in the 81sequence, it will be dropped. 82Unlike audit data written to the audit trail, the reliability of record 83delivery is not guaranteed. 84In particular, when an audit pipe queue fills, records will be dropped. 85Audit pipe devices are blocking by default, but support non-blocking I/O, 86asynchronous I/O using SIGIO, and support for polled operation via 87.Xr select 2 88and 89.Xr poll 2 . 90.Sh SEE ALSO 91.Xr auditreduce 1 , 92.Xr praudit 1 , 93.Xr audit 2 , 94.Xr auditctl 2 , 95.Xr auditon 2 , 96.Xr getaudit 2 , 97.Xr getauid 2 , 98.Xr poll 2 , 99.Xr select 2 , 100.Xr setaudit 2 , 101.Xr setauid 2 , 102.Xr libbsm 3 , 103.Xr audit.log 5 , 104.Xr audit_class 5 , 105.Xr audit_control 5 , 106.Xr audit_event 5 , 107.Xr audit_user 5 , 108.Xr audit_warn 5 , 109.Xr rc.conf 5 , 110.Xr audit 8 , 111.Xr auditd 8 112.Sh AUTHORS 113This software was created by McAfee Research, the security research division 114of McAfee, Inc., under contract to Apple Computer Inc. 115Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc. 116.Pp 117The Basic Security Module (BSM) interface to audit records and audit event 118stream format were defined by Sun Microsystems. 119.Pp 120This manual page was written by 121.An Robert Watson Aq rwatson@FreeBSD.org . 122.Sh HISTORY 123The OpenBSM implementation was created by McAfee Research, the security 124division of McAfee Inc., under contract to Apple Computer Inc. in 2004. 125It was subsequently adopted by the TrustedBSD Project as the foundation for 126the OpenBSM distribution. 127.Pp 128Support for kernel audit first appeared in 129.Fx 6.1 . 130.Sh BUGS 131The audit facility in 132.Fx 133is considered experimental, and production deployment should occur only after 134careful consideration of the risks of deploying experimental software. 135.Pp 136The 137.Fx 138kernel does not fully validate that audit records submitted by user 139applications are syntactically valid BSM; as submission of records is limited 140to privileged processes, this is not a critical bug. 141.Pp 142Instrumentation of auditable events in the kernel is not complete, as some 143system calls do not generate audit records, or generate audit records with 144incomplete argument information. 145.Pp 146Mandatory Access Control (MAC) labels, as provided by the 147.Xr mac 4 148facility, are not audited as part of records involving MAC decisions.
|