xref: /freebsd/contrib/openbsm/bin/auditreduce/auditreduce.1 (revision bb97b41819ea5a5e5315006cdad6902bfa2b7eb6)
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/bin/auditreduce/auditreduce.1#10 $
29.\"
30.Dd January 24, 2004
31.Dt AUDITREDUCE 1
32.Os
33.Sh NAME
34.Nm auditreduce
35.Nd "select records from audit trail files"
36.Sh SYNOPSIS
37.Nm auditreduce
38.Op Fl A
39.Op Fl a Ar YYYYMMDD[HH[MM[SS]]]
40.Op Fl b Ar YYYYMMDD[HH[MM[SS]]]
41.Op Fl c Ar flags
42.Op Fl d Ar YYYYMMDD
43.Op Fl e Ar euid
44.Op Fl f Ar egid
45.Op Fl g Ar rgid
46.Op Fl r Ar ruid
47.Op Fl u Ar auid
48.Op Fl j Ar id
49.Op Fl m Ar event
50.Op Fl o Ar object=value
51.Op Ar file ...
52.Sh DESCRIPTION
53The
54.Nm
55utility selects records from the audit trail files based on the specified
56criteria.
57Matching audit records are printed to the standard output in
58their raw binary form.
59If no filename is specified, the standard input is used
60by default.
61Use the
62.Nm praudit
63utility to print the selected audit records in human-readable form.
64See
65.Xr praudit 1
66for more information.
67.Pp
68The options are as follows:
69.Bl -tag -width Ds
70.It Fl A
71Select all records.
72.It Fl a Ar YYYYMMDD[HH[MM[SS]]]
73Select records that occurred after or on the given datetime.
74.It Fl b Ar YYYYMMDD[HH[MM[SS]]]
75Select records that occurred before the given datetime.
76.It Fl c Ar flags
77Select records matching the given audit classes specified as a comma
78separated list of audit flags.
79See
80.Xr audit_control 5
81for a description of audit flags.
82.It Fl d Ar YYYYMMDD
83Select records that occurred on a given date.
84This option cannot be used with
85.Fl a
86or
87.Fl b .
88.It Fl e Ar euid
89Select records with the given effective user id or name.
90.It Fl f Ar egid
91Select records with the given effective group id or name.
92.It Fl g Ar rgid
93Select records with the given real group id or name.
94.It Fl r Ar ruid
95Select records with the given real user id or name.
96.It Fl u Ar auid
97Select records with the given audit id.
98.It Fl j Ar id
99Select records having a subject token with matching ID.
100.It Fl m Ar event
101Select records with the given event name or number.
102See
103.Xr audit_event 5
104for a description of audit event names and numbers.
105.It Fl o Ar object=value
106.Bl -tag -width Ds
107.It Nm file
108Select records containing the given path name.
109file="/usr" matches paths
110starting with
111.Pa usr .
112file="~/usr" matches paths not starting with
113.Pa usr .
114.It Nm msgqid
115Select records containing the given message queue id.
116.It Nm pid
117Select records containing the given process id.
118.It Nm semid
119Select records containing the given semaphore id.
120.It Nm shmid
121Select records containing the given shared memory id.
122.El
123.El
124.Sh Examples
125.Pp
126To select all records associated with effective user ID root from the audit
127log
128.Pa /var/audit/20031016184719.20031017122634 :
129.Pp
130.Nm
131-e root /var/audit/20031016184719.20031017122634
132.Pp
133To select all
134.Xr setlogin 2
135events from that log:
136.Pp
137.Nm
138-m AUE_SETLOGIN /var/audit/20031016184719.20031017122634
139.Sh SEE ALSO
140.Xr praudit 1 ,
141.Xr audit_control 5 ,
142.Xr audit_event 5
143.Sh AUTHORS
144This software was created by McAfee Research, the security research division
145of McAfee, Inc., under contract to Apple Computer Inc.
146Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
147.Pp
148The Basic Security Module (BSM) interface to audit records and audit event
149stream format were defined by Sun Microsystems.
150.Sh HISTORY
151The OpenBSM implementation was created by McAfee Research, the security
152division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
153It was subsequently adopted by the TrustedBSD Project as the foundation for
154the OpenBSM distribution.
155