xref: /freebsd/contrib/openbsm/bin/praudit/praudit.1 (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/bin/praudit/praudit.1#12 $
29.\"
30.Dd November 5, 2006
31.Dt PRAUDIT 1
32.Os
33.Sh NAME
34.Nm praudit
35.Nd "print the contents of audit trail files"
36.Sh SYNOPSIS
37.Nm
38.Op Fl lpx
39.Op Fl r | s
40.Op Fl d Ar del
41.Op Ar
42.Sh DESCRIPTION
43The
44.Nm
45utility prints the contents of the audit trail files to the standard output in
46human-readable form.
47If no
48.Ar file
49argument is specified, the standard input is used
50by default.
51.Pp
52The options are as follows:
53.Bl -tag -width indent
54.It Fl d Ar del
55Specifies the delimiter.
56The default delimiter is the comma.
57.It Fl l
58Prints the entire record on the same line.
59If this option is not specified,
60every token is displayed on a different line.
61.It Fl p
62Specify this option if input to
63.Nm
64is piped from the
65.Xr tail 1
66utility.
67This causes
68.Nm
69to sync to the start of the next record.
70.It Fl r
71Prints the records in their raw, numeric form.
72This option is exclusive from
73.Fl s .
74.It Fl s
75Prints the tokens in their short form.
76Short text representations for
77record and event type are displayed.
78This option is exclusive from
79.Fl r .
80.It Fl x
81Print audit records in the XML output format.
82.El
83.Pp
84If the raw or short forms are not specified, the default is to print the tokens
85in their long form.
86Events are displayed as per their descriptions given in
87.Pa /etc/security/audit_event ;
88UIDs and GIDs are expanded to their names;
89dates and times are displayed in human-readable format.
90.Sh FILES
91.Bl -tag -width ".Pa /etc/security/audit_control" -compact
92.It Pa /etc/security/audit_class
93Descriptions of audit event classes.
94.It Pa /etc/security/audit_event
95Descriptions of audit events.
96.El
97.Sh SEE ALSO
98.Xr auditreduce 1 ,
99.Xr audit 4 ,
100.Xr auditpipe 4 ,
101.Xr audit_class 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