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.\"
|
26.\"
27.Dd February 2, 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
| 26.\"
27.Dd February 2, 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
|
48.Pp
49Audit support is enabled at boot, if present in the kernel, using an
50.Xr rc.conf 5
51flag.
52The audit daemon,
53.Xr auditd 8 ,
54is responsible for configuring the kernel to perform audit, pushing
55configuration data from the various audit configuration files into the
56kernel.
57.Sh SEE ALSO
58.Xr auditreduce 1 ,
59.Xr praudit 1 ,
60.Xr audit 2 ,
61.Xr auditctl 2 ,
62.Xr auditon 2 ,
63.Xr getaudit 2 ,
64.Xr getauid 2 ,
65.Xr setaudit 2 ,
66.Xr setauid 2 ,
67.Xr libbsm 3 ,
68.Xr audit.log 5 ,
69.Xr audit_class 5 ,
70.Xr audit_control 5 ,
71.Xr audit_event 5 ,
72.Xr audit_user 5 ,
73.Xr audit_warn 5 ,
74.Xr event_code 5 ,
75.Xr rc.conf 5 ,
76.Xr audit 8 ,
77.Xr auditd 8
78.Sh AUTHORS
79This software was created by McAfee Research, the security research division
80of McAfee, Inc., under contract to Apple Computer Inc.
81Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
82.Pp
83The Basic Security Module (BSM) interface to audit records and audit event
84stream format were defined by Sun Microsystems.
85.Pp
86This manual page was written by
87.An Robert Watson Aq rwatson@FreeBSD.org .
88.Sh HISTORY
89The OpenBSM implementation was created by McAfee Research, the security
90division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
91It was subsequently adopted by the TrustedBSD Project as the foundation for
92the OpenBSM distribution.
93.Pp
94Support for kernel audit first appeared in
95.Fx 6.1 .
96.Sh BUGS
97The audit facility in
98.Fx
99is considered experimental, and production deployment should occur only after
100careful consideration of the risks of deploying experimental software.
101.Pp
102The
103.Fx
104kernel does not fully validate that audit records submitted by user
105applications are syntactically valid BSM; as submission of records is limited
106to privileged processes, this is not a critical bug.
107.Pp
108Instrumentation of auditable events in the kernel is not complete, as some
109system calls do not generate audit records, or generate audit records with
110incomplete argument information.
111.Pp
112Mandatory Access Control (MAC) labels, as provided by the
113.Xr mac 4
114facility, are not audited as part of records involving MAC decisions.
| 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.Sh SEE ALSO
57.Xr auditreduce 1 ,
58.Xr praudit 1 ,
59.Xr audit 2 ,
60.Xr auditctl 2 ,
61.Xr auditon 2 ,
62.Xr getaudit 2 ,
63.Xr getauid 2 ,
64.Xr setaudit 2 ,
65.Xr setauid 2 ,
66.Xr libbsm 3 ,
67.Xr audit.log 5 ,
68.Xr audit_class 5 ,
69.Xr audit_control 5 ,
70.Xr audit_event 5 ,
71.Xr audit_user 5 ,
72.Xr audit_warn 5 ,
73.Xr event_code 5 ,
74.Xr rc.conf 5 ,
75.Xr audit 8 ,
76.Xr auditd 8
77.Sh AUTHORS
78This software was created by McAfee Research, the security research division
79of McAfee, Inc., under contract to Apple Computer Inc.
80Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
81.Pp
82The Basic Security Module (BSM) interface to audit records and audit event
83stream format were defined by Sun Microsystems.
84.Pp
85This manual page was written by
86.An Robert Watson Aq rwatson@FreeBSD.org .
87.Sh HISTORY
88The OpenBSM implementation was created by McAfee Research, the security
89division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
90It was subsequently adopted by the TrustedBSD Project as the foundation for
91the OpenBSM distribution.
92.Pp
93Support for kernel audit first appeared in
94.Fx 6.1 .
95.Sh BUGS
96The audit facility in
97.Fx
98is considered experimental, and production deployment should occur only after
99careful consideration of the risks of deploying experimental software.
100.Pp
101The
102.Fx
103kernel does not fully validate that audit records submitted by user
104applications are syntactically valid BSM; as submission of records is limited
105to privileged processes, this is not a critical bug.
106.Pp
107Instrumentation of auditable events in the kernel is not complete, as some
108system calls do not generate audit records, or generate audit records with
109incomplete argument information.
110.Pp
111Mandatory Access Control (MAC) labels, as provided by the
112.Xr mac 4
113facility, are not audited as part of records involving MAC decisions.
|