d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4a63252f49
freebsd-skq/share/man/man4/audit.4

140 lines
4.4 KiB
Groff
Raw Normal View History

Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.\" Copyright (c) 2006 Robert N. M. Watson
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Upgrade audit(4) from experimental to production status for FreeBSD 8.0. While there remain some incomplete aspects of the implementation (such as incomplete auditing of some system calls), the implementation has been burned in for a few years, as well as in GENERIC for a few years. Obtained from: TrustedBSD Project
2009-05-31 09:03:14 +00:00
.Dd May 31, 2009
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Dt AUDIT 4
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors)
2010-04-14 19:08:06 +00:00
.Os
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Sh NAME
.Nm audit
.Nd Security Event Audit
.Sh SYNOPSIS
.Cd "options AUDIT"
.Sh DESCRIPTION
Security Event Audit is a facility to provide fine-grained, configurable
logging of security-relevant events, and is intended to meet the requirements
of the Common Criteria (CC) Common Access Protection Profile (CAPP)
evaluation.
The
.Fx
Revise markup.
2006-09-30 15:14:49 +00:00
.Nm
facility implements the de facto industry standard BSM API, file
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
formats, and command line interface, first found in the Solaris operating
system.
Information on the user space implementation can be found in
Fix a sentence.
2006-02-03 11:10:50 +00:00
.Xr libbsm 3 .
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Pp
Audit support is enabled at boot, if present in the kernel, using an
.Xr rc.conf 5
flag.
The audit daemon,
.Xr auditd 8 ,
Revise markup.
2006-09-30 15:14:49 +00:00
is responsible for configuring the kernel to perform
.Nm ,
pushing
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
configuration data from the various audit configuration files into the
kernel.
Add information on audit pipe special devices, which allow user processes to "tee" the BSM record stream for the purposes of live monitoring, intrusion detection, etc. Support for audit pipes will be committed in the near future. Obtained from: TrustedBSD Project
2006-02-06 18:41:00 +00:00
.Ss Audit Special Device
Revise markup.
2006-09-30 15:14:49 +00:00
The kernel
.Nm
facility provides a special device,
Add information on audit pipe special devices, which allow user processes to "tee" the BSM record stream for the purposes of live monitoring, intrusion detection, etc. Support for audit pipes will be committed in the near future. Obtained from: TrustedBSD Project
2006-02-06 18:41:00 +00:00
.Pa /dev/audit ,
which is used by
.Xr auditd 8
Revise markup.
2006-09-30 15:14:49 +00:00
to monitor for
.Nm
events, such as requests to cycle the log, low disk
Add information on audit pipe special devices, which allow user processes to "tee" the BSM record stream for the purposes of live monitoring, intrusion detection, etc. Support for audit pipes will be committed in the near future. Obtained from: TrustedBSD Project
2006-02-06 18:41:00 +00:00
space conditions, and requests to terminate auditing.
This device is not intended for use by applications.
.Ss Audit Pipe Special Devices
Break out description of the audit pipe facility from audit.4 into a new man page, auditpipe.4, which describes the behavior of audit pipes, the ioctls, preselection, etc. Obtained from: TrustedBSD Project
2006-06-05 15:26:09 +00:00
Audit pipe special devices, discussed in
.Xr auditpipe 4 ,
provide a configurable live tracking mechanism to allow applications to
Spelling fixes.
2006-12-14 16:40:57 +00:00
tee the audit trail, as well as to configure custom preselection parameters
Break out description of the audit pipe facility from audit.4 into a new man page, auditpipe.4, which describes the behavior of audit pipes, the ioctls, preselection, etc. Obtained from: TrustedBSD Project
2006-06-05 15:26:09 +00:00
to track users and events in a fine-grained manner.
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Sh SEE ALSO
.Xr auditreduce 1 ,
.Xr praudit 1 ,
.Xr audit 2 ,
.Xr auditctl 2 ,
.Xr auditon 2 ,
.Xr getaudit 2 ,
.Xr getauid 2 ,
Add information on audit pipe special devices, which allow user processes to "tee" the BSM record stream for the purposes of live monitoring, intrusion detection, etc. Support for audit pipes will be committed in the near future. Obtained from: TrustedBSD Project
2006-02-06 18:41:00 +00:00
.Xr poll 2 ,
.Xr select 2 ,
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Xr setaudit 2 ,
.Xr setauid 2 ,
.Xr libbsm 3 ,
Break out description of the audit pipe facility from audit.4 into a new man page, auditpipe.4, which describes the behavior of audit pipes, the ioctls, preselection, etc. Obtained from: TrustedBSD Project
2006-06-05 15:26:09 +00:00
.Xr auditpipe 4 ,
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Xr audit_class 5 ,
.Xr audit_control 5 ,
.Xr audit_event 5 ,
Revise markup.
2006-09-30 15:14:49 +00:00
.Xr audit.log 5 ,
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Xr audit_user 5 ,
.Xr audit_warn 5 ,
.Xr rc.conf 5 ,
.Xr audit 8 ,
.Xr auditd 8
Revise markup.
2006-09-30 15:14:49 +00:00
.Sh HISTORY
The
.Tn 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.
.Pp
Support for kernel
.Nm
first appeared in
.Fx 6.2 .
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Sh AUTHORS
Revise markup.
2006-09-30 15:14:49 +00:00
.An -nosplit
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
This software was created by McAfee Research, the security research division
of McAfee, Inc., under contract to Apple Computer Inc.
Revise markup.
2006-09-30 15:14:49 +00:00
Additional authors include
.An Wayne Salamon ,
.An Robert Watson ,
and SPARTA Inc.
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Pp
The Basic Security Module (BSM) interface to audit records and audit event
stream format were defined by Sun Microsystems.
.Pp
This manual page was written by
.An Robert Watson Aq rwatson@FreeBSD.org .
.Sh BUGS
Revise markup.
2006-09-30 15:14:49 +00:00
The
Add audit.4 man page, providing basic documentation for configuring the kernel audit facility, warnings about the experimental nature of this implementation, and pointers at a large number of other audit related man pages. Obtained from: TrustedBSD Project
2006-02-02 10:32:27 +00:00
.Fx
kernel does not fully validate that audit records submitted by user
applications are syntactically valid BSM; as submission of records is limited
to privileged processes, this is not a critical bug.
.Pp
Instrumentation of auditable events in the kernel is not complete, as some
system calls do not generate audit records, or generate audit records with
incomplete argument information.
.Pp
Mandatory Access Control (MAC) labels, as provided by the
.Xr mac 4
facility, are not audited as part of records involving MAC decisions.
Reference in New Issue Copy Permalink