xref: /freebsd/contrib/openbsm/man/audit_user.5 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1.\" Copyright (c) 2004 Apple Inc.
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.\" 3.  Neither the name of Apple Inc. ("Apple") nor the names of
13.\"     its contributors may be used to endorse or promote products derived
14.\"     from this software without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
20.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
25.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26.\" POSSIBILITY OF SUCH DAMAGE.
27.\"
28.Dd January 4, 2008
29.Dt AUDIT_USER 5
30.Os
31.Sh NAME
32.Nm audit_user
33.Nd "events to be audited for given users"
34.Sh DESCRIPTION
35The
36.Nm
37file specifies which audit event classes are to be audited for the given users.
38If specified, these flags are combined with the system-wide audit flags in the
39.Xr audit_control 5
40file to determine which classes of events to audit for that user.
41These settings take effect when the user logs in.
42.Pp
43Each line maps a user name to a list of classes that should be audited and a
44list of classes that should not be audited.
45Entries are of the form:
46.Pp
47.D1 Ar username Ns : Ns Ar alwaysaudit Ns : Ns Ar neveraudit
48.Pp
49In the format above,
50.Ar alwaysaudit
51is a set of event classes that are always audited, and
52.Ar neveraudit
53is a set of event classes that should not be audited.
54These sets can indicate
55the inclusion or exclusion of multiple classes, and whether to audit successful
56or failed events.
57See
58.Xr audit_control 5
59for more information about audit flags.
60.Pp
61Example entries in this file are:
62.Bd -literal -offset indent
63root:lo,ad:no
64jdoe:-fc,ad:+fw
65.Ed
66.Pp
67These settings would cause login/logout and administrative events that
68are performed on behalf of user
69.Dq Li root
70to be audited.
71No failure events are audited.
72For the user
73.Dq Li jdoe ,
74failed file creation events are audited, administrative events are
75audited, and successful file write events are never audited.
76.Sh IMPLEMENTATION NOTES
77Per-user and global audit preselection configuration are evaluated at time of
78login, so users must log out and back in again for audit changes relating to
79preselection to take effect.
80.Pp
81Audit record preselection occurs with respect to the audit identifier
82associated with a process, rather than with respect to the UNIX user or group
83ID.
84The audit identifier is set as part of the user credential context as part of
85login, and typically does not change as a result of running setuid or setgid
86applications, such as
87.Xr su 1 .
88This has the advantage that events that occur after running
89.Xr su 1
90can be audited to the original authenticated user, as required by CAPP, but
91may be surprising if not expected.
92.Sh FILES
93.Bl -tag -width ".Pa /etc/security/audit_user" -compact
94.It Pa /etc/security/audit_user
95.El
96.Sh SEE ALSO
97.Xr login 1 ,
98.Xr su 1 ,
99.Xr audit 4 ,
100.Xr audit_class 5 ,
101.Xr audit_control 5 ,
102.Xr audit_event 5
103.Sh HISTORY
104The OpenBSM implementation was created by McAfee Research, the security
105division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
106It was subsequently adopted by the TrustedBSD Project as the foundation for
107the OpenBSM distribution.
108.Sh AUTHORS
109.An -nosplit
110This software was created by McAfee Research, the security research division
111of McAfee, Inc., under contract to Apple Computer Inc.
112Additional authors include
113.An Wayne Salamon ,
114.An Robert Watson ,
115and SPARTA Inc.
116.Pp
117The Basic Security Module (BSM) interface to audit records and audit event
118stream format were defined by Sun Microsystems.
119