Debian Codegraph @

docs/aureport.8

raw
1 .TH AUREPORT "8" "February 2023" "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 \-\-debug
28 Write malformed events that are skipped to stderr.
29 .TP
30 .BR \-\-eoe\-timeout \ \fIseconds\fP
31 Set the end of event parsing timeout. See \fBend_of_event_timeout\fP in \fIauditd.conf(5)\fP for details. Note that setting this value will override any configured value found in /etc/auditd/auditd.conf.
32 .TP
33 .BR \-e ,\ \-\-event
34 Report about events
35 .TP
36 .BR \-\-escape \ \fIoption\fP
37 This option determines if the output is escaped to make the content safer for certain uses. The options are \fIraw\fP , \fItty\fP , \fIshell\fP , and \fIshell_quote\fP. Each mode includes the characters of the preceding mode and escapes more characters. That is to say \fIshell\fP includes all characters escaped by \fItty\fP and adds more. \fItty\fP is the default.
38 .TP
39 .BR \-f ,\ \-\-file
40 Report about files and af_unix sockets
41 .TP
42 .B \-\-failed
43 Only select failed events for processing in the reports. The default is both success and failed events.
44 .TP
45 .BR \-h ,\ \-\-host
46 Report about hosts
47 .TP
48 .BR \-\-help
49 Print brief command summary
50 .TP
51 .BR \-i ,\ \-\-interpret
52 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.
53 .TP
54 .BR \-if ,\ \-\-input \ \fIfile\fP\ |\ \fIdirectory\fP
55 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. The path length is limited to 4064 bytes.
56 .TP
57 .B \-\-input\-logs
58 Use the log file location from auditd.conf as input for analysis. This is needed if you are using aureport from a cron job.
59 .TP
60 .BR \-\-integrity
61 Report about integrity events
62 .TP
63 .BR \-k ,\ \-\-key
64 Report about audit rule keys
65 .TP
66 .BR \-l ,\ \-\-login
67 Report about logins
68 .TP
69 .BR \-m ,\ \-\-mods
70 Report about account modifications
71 .TP
72 .BR \-ma ,\ \-\-mac
73 Report about Mandatory Access Control (MAC) events
74 .TP
75 .BR \-n ,\ \-\-anomaly
76 Report about anomaly events. These events include NIC going into promiscuous mode and programs segfaulting.
77 .TP
78 .BR \-\-node \ \fInode-name\fP
79 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.
80 .TP
81 .BR \-nc ,\ \-\-no-config
82 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.
83 .TP
84 .BR \-p ,\ \-\-pid
85 Report about processes
86 .TP
87 .BR \-r ,\ \-\-response
88 Report about responses to anomaly events
89 .TP
90 .BR \-s ,\ \-\-syscall
91 Report about syscalls
92 .TP
93 .B \-\-success
94 Only select successful events for processing in the reports. The default is both success and failed events.
95 .TP
96 .B \-\-summary
97 Run the summary report that gives a total of the elements of the main report. Not all reports have a summary.
98 .TP
99 .BR \-t ,\ \-\-log
100 This option will output a report of the start and end times for each log.
101 .TP
102 .BR \-\-tty
103 Report about tty keystrokes
104 .TP
105 .BR \-te ,\ \-\-end \ [\fIend-date\fP]\ [\fIend-time\fP]
106 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,
107 .B today
108 is assumed. If the time is omitted,
109 .B now
110 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.
111
112 You may also use the word: \fBnow\fP, \fBrecent\fP, \fBthis-hour\fP, \fBboot\fP, \fBtoday\fP, \fByesterday\fP, \fBthis\-week\fP, \fBweek\-ago\fP, \fBthis\-month\fP, \fBthis\-year\fP. \fBNow\fP means starting now. \fBRecent\fP is 10 minutes ago. \fBBoot\fP means the time of day to the second when the system last booted. \fBToday\fP means now. \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.
113 .TP
114 .BR \-tm ,\ \-\-terminal
115 Report about terminals
116 .TP
117 .BR \-ts ,\ \-\-start \ [\fIstart-date\fP]\ [\fIstart-time\fP]
118 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,
119 .B today
120 is assumed. If the time is omitted,
121 .B midnight
122 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.
123
124 You may also use the word: \fBnow\fP, \fBrecent\fP, \fBthis-hour\fP, \fBboot\fP, \fBtoday\fP, \fByesterday\fP, \fBthis\-week\fP, \fBweek\-ago\fP, \fBthis\-month\fP, \fBthis\-year\fP. \fBBoot\fP means the time of day to the second when the system last booted. \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.
125 .TP
126 .BR \-u ,\ \-\-user
127 Report about users
128 .TP
129 .BR \-v ,\ \-\-version
130 Print the version and exit
131 .TP
132 .BR \-\-virt
133 Report about Virtualization events
134 .TP
135 .BR \-x ,\ \-\-executable
136 Report about executables
137
138 .SH NOTE
139 The boot time option is a convenience function and has limitations. The time it calculates is based on time now minus /proc/uptime. If after boot the system clock has been adjusted, perhaps by ntp, then the calculation may be wrong. In that case you'll need to fully specify the time. You can check the time it would use by running:
140
141 date -d "`cut \-f1 \-d. /proc/uptime` seconds ago"
142
143 .SH "SEE ALSO"
144 .BR ausearch (8),
145 .BR auditd (8),
146 .BR auditd.conf (5).