xref: /freebsd/contrib/openbsm/man/audit_user.5 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1.\" Copyright (c) 2004 Apple Computer, 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 Computer, 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.\" $P4: //depot/projects/trustedbsd/openbsm/man/audit_user.5#12 $
29.\"
30.Dd February 5, 2006
31.Dt AUDIT_USER 5
32.Os
33.Sh NAME
34.Nm audit_user
35.Nd "events to be audited for given users"
36.Sh DESCRIPTION
37The
38.Nm
39file specifies which audit event classes are to be audited for the given users.
40If specified, these flags are combined with the system-wide audit flags in the
41.Xr audit_control 5
42file to determine which classes of events to audit for that user.
43These settings take effect when the user logs in.
44.Pp
45Each line maps a user name to a list of classes that should be audited and a
46list of classes that should not be audited.
47Entries are of the form:
48.Pp
49.D1 Ar username Ns : Ns Ar alwaysaudit Ns : Ns Ar neveraudit
50.Pp
51In the format above,
52.Ar alwaysaudit
53is a set of event classes that are always audited, and
54.Ar neveraudit
55is a set of event classes that should not be audited.
56These sets can indicate
57the inclusion or exclusion of multiple classes, and whether to audit successful
58or failed events.
59See
60.Xr audit_control 5
61for more information about audit flags.
62.Pp
63Example entries in this file are:
64.Bd -literal -offset indent
65root:lo,ad:no
66jdoe:-fc,ad:+fw
67.Ed
68.Pp
69These settings would cause login/logout and administrative events that
70succeed on behalf of user
71.Dq Li root
72to be audited.
73No failure events are audited.
74For the user
75.Dq Li jdoe ,
76failed file creation events are audited, administrative events are
77audited, and successful file write events are never audited.
78.Sh IMPLEMENTATION NOTES
79Per-user and global audit preselection configuration are evaluated at time of
80login, so users must log out and back in again for audit changes relating to
81preselection to take effect.
82.Pp
83Audit record preselection occurs with respect to the audit identifier
84associated with a process, rather than with respect to the UNIX user or group
85ID.
86The audit identifier is set as part of the user credential context as part of
87login, and typically does not change as a result of running setuid or setgid
88applications, such as
89.Xr su 1 .
90This has the advantage that events that occur after running
91.Xr su 1
92can be audited to the original authenticated user, as required by CAPP, but
93may be surprising if not expected.
94.Sh FILES
95.Bl -tag -width ".Pa /etc/security/audit_user" -compact
96.It Pa /etc/security/audit_user
97.El
98.Sh SEE ALSO
99.Xr login 1 ,
100.Xr su 1 ,
101.Xr audit 4 ,
102.Xr audit_class 5 ,
103.Xr audit_control 5 ,
104.Xr audit_event 5
105.Sh HISTORY
106The OpenBSM implementation was created by McAfee Research, the security
107division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
108It was subsequently adopted by the TrustedBSD Project as the foundation for
109the OpenBSM distribution.
110.Sh AUTHORS
111.An -nosplit
112This software was created by McAfee Research, the security research division
113of McAfee, Inc., under contract to Apple Computer Inc.
114Additional authors include
115.An Wayne Salamon ,
116.An Robert Watson ,
117and SPARTA Inc.
118.Pp
119The Basic Security Module (BSM) interface to audit records and audit event
120stream format were defined by Sun Microsystems.
121