Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / aureport.8
1 .TH AUREPORT: "8" "Sept 2014" "Red Hat" "System Administration Utilities"
2 .SH NAME
3 aureport \- a tool that produces summary reports of audit daemon logs
4 .SH SYNOPSIS
5 .B aureport
6 .RI [ options ]
7 .SH DESCRIPTION
8 \fBaureport\fP is a tool that produces summary reports of the audit system logs. The aureport utility can also take input from stdin as long as the input is the raw log data. The reports have a column label at the top to help with interpretation of the various fields. Except for the main summary report, all reports have the audit event number. You can subsequently lookup the full event with ausearch \fB\-a\fP \fIevent number\fP. You may need to specify start & stop times if you get multiple hits. The reports produced by aureport can be used as building blocks for more complicated analysis.
9
10 .SH OPTIONS
11 .TP
12 .BR \-au ,\  \-\-auth
13 Report about authentication attempts
14 .TP
15 .BR \-a ,\  \-\-avc
16 Report about avc messages
17 .TP
18 .BR \-\-comm
19 Report about commands run
20 .TP
21 .BR \-c ,\  \-\-config
22 Report about config changes
23 .TP
24 .BR \-cr ,\  \-\-crypto
25 Report about crypto events
26 .TP
27 .BR \-e ,\  \-\-event
28 Report about events
29 .TP
30 .BR \-f ,\  \-\-file
31 Report about files
32 .TP
33 .B \-\-failed
34 Only select failed events for processing in the reports. The default is both success and failed events.
35 .TP
36 .BR \-h ,\  \-\-host
37 Report about hosts
38 .TP
39 .BR \-\-help
40 Print brief command summary
41 .TP
42 .BR \-i ,\  \-\-interpret
43 Interpret  numeric  entities into text. For example, uid is converted to account name. The conversion is done using the current resources  of  the machine where the search is being run. If you have renamed the accounts, or don't have the  same  accounts  on your machine, you could get misleading results.
44 .TP
45 .BR \-if ,\  \-\-input \ \fIfile\fP\ |\ \fIdirectory\fP
46 Use the given \fIfile\fP or \fIdirectory\fP instead of the logs. This is to aid analysis where the logs have been moved to another machine or only part of a log was saved.
47 .TP
48 .B \-\-input\-logs
49 Use the log file location from auditd.conf as input for analysis. This is needed if you are using aureport from a cron job.
50 .TP
51 .BR \-\-integrity
52 Report about integrity events
53 .TP
54 .BR \-k ,\  \-\-key
55 Report about audit rule keys
56 .TP
57 .BR \-l ,\  \-\-login
58 Report about logins
59 .TP
60 .BR \-m ,\  \-\-mods
61 Report about account modifications
62 .TP
63 .BR \-ma ,\  \-\-mac
64 Report about Mandatory Access Control (MAC) events
65 .TP
66 .BR \-n ,\  \-\-anomaly
67 Report about anomaly events. These events include NIC going into promiscuous mode and programs segfaulting.
68 .TP
69 .BR \-\-node \ \fInode-name\fP
70 Only select events originating from \fInode name\fP string for processing in the reports. The default is to include all nodes. Multiple nodes are allowed.
71 .TP
72 .BR \-nc ,\  \-\-no-config
73 Do not include the CONFIG_CHANGE event. This is particularly useful for the key report because audit rules have key labels in many cases. Using this option gets rid of these false positives.
74 .TP
75 .BR \-p ,\  \-\-pid
76 Report about processes
77 .TP
78 .BR \-r ,\  \-\-response
79 Report about responses to anomaly events
80 .TP
81 .BR \-s ,\  \-\-syscall
82 Report about syscalls
83 .TP
84 .B \-\-success
85 Only select successful events for processing in the reports. The default is both success and failed events.
86 .TP
87 .B \-\-summary
88 Run the summary report that gives a total of the elements of the main report. Not all reports have a summary.
89 .TP
90 .BR \-t ,\  \-\-log
91 This option will output a report of the start and end times for each log.
92 .TP
93 .BR \-\-tty
94 Report about tty keystrokes
95 .TP
96 .BR \-te ,\  \-\-end \ [\fIend-date\fP]\ [\fIend-time\fP]
97 Search for events with time stamps equal to or before the given end time. The format of end time depends on your locale. If the date is omitted,
98 .B today
99 is assumed. If the time is omitted, 
100 .B now
101 is assumed. Use 24 hour clock time rather than AM or PM to specify time. An example date using the en_US.utf8 locale is 09/03/2009. An example of time is 18:00:00. The date format accepted is influenced by the LC_TIME environmental variable.
102
103 You may also use the word: \fBnow\fP, \fBrecent\fP, \fBtoday\fP, \fByesterday\fP, \fBthis\-week\fP, \fBweek\-ago\fP, \fBthis\-month\fP, \fBthis\-year\fP. \fBToday\fP means starting now. \fBRecent\fP is 10 minutes ago. \fBYesterday\fP is 1 second after midnight the previous day. \fBThis\-week\fP means starting 1 second after midnight on day 0 of the week determined by your locale (see \fBlocaltime\fP). \fBWeek\-ago\fP means 1 second after midnight exactly 7 days ago. \fBThis\-month\fP means 1 second after midnight on day 1 of the month. \fBThis\-year\fP means the 1 second after midnight on the first day of the first month.
104 .TP
105 .BR \-tm ,\  \-\-terminal
106 Report about terminals
107 .TP
108 .BR \-ts ,\  \-\-start \ [\fIstart-date\fP]\ [\fIstart-time\fP]
109 Search for events with time stamps equal to or after the given end time. The format of end time depends on your locale. If the date is omitted, 
110 .B today
111 is assumed. If the time is omitted, 
112 .B midnight
113 is assumed. Use 24 hour clock time rather than AM or PM to specify time. An example date using the en_US.utf8 locale is 09/03/2009. An example of time is 18:00:00. The date format accepted is influenced by the LC_TIME environmental variable.
114
115 You may also use the word: \fBnow\fP, \fBrecent\fP, \fBtoday\fP, \fByesterday\fP, \fBthis\-week\fP, \fBweek\-ago\fP, \fBthis\-month\fP, \fBthis\-year\fP. \fBToday\fP means starting at 1 second after midnight. \fBRecent\fP is 10 minutes ago. \fBYesterday\fP is 1 second after midnight the previous day. \fBThis\-week\fP means starting 1 second after midnight on day 0 of the week determined by your locale (see \fBlocaltime\fP). \fBWeek\-ago\fP means starting 1 second after midnight exactly 7 days ago. \fBThis\-month\fP means 1 second after midnight on day 1 of the month. \fBThis\-year\fP means the 1 second after midnight on the first day of the first month.
116 .TP
117 .BR \-u ,\  \-\-user
118 Report about users
119 .TP
120 .BR \-v ,\  \-\-version
121 Print the version and exit
122 .TP
123 .BR \-\-virt
124 Report about Virtualization events
125 .TP
126 .BR \-x ,\  \-\-executable
127 Report about executables
128
129 .SH "SEE ALSO"
130 .BR ausearch (8),
131 .BR auditd (8).