Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / auditd.8
1 .TH "AUDITD" "8" "Sept 2013" "Red Hat" "System Administration Utilities"
2 .SH NAME
3 auditd \- The Linux Audit daemon
4 .SH SYNOPSIS
5 .B auditd
6 .RB [ \-f ]\ [ \-l ]\ [ \-n ]\ [ \-s\ disable|enable|nochange ]
7 .SH DESCRIPTION
8 \fBauditd\fP is the userspace component to the Linux Auditing System. It's responsible for writing audit records to the disk. Viewing the logs is done with the
9 .B ausearch
10 or
11 .B aureport
12 utilities. Configuring the audit system or loading rules is done with the
13 .B auditctl
14 utility. During startup, the rules in \fI/etc/audit/audit.rules\fP are read by \fBauditctl\fP and loaded into the kernel. Alternately, there is also an
15 .B augenrules
16 program that reads rules located in \fI/etc/audit/rules.d/\fP and compiles them into an audit.rules file. The audit daemon itself has some configuration options that the admin may wish to customize. They are found in the
17 .B auditd.conf
18 file.
19 .SH OPTIONS
20 .TP
21 .B \-f
22 leave the audit daemon in the foreground for debugging. Messages also go to stderr rather than the audit log.
23 .TP
24 .B \-l
25 allow the audit daemon to follow symlinks for config files.
26 .TP
27 .B \-n
28 no fork. This is useful for running off of inittab or systemd.
29 .TP
30 .B \-s=\fIENABLE_STATE\fR
31 specify when starting if auditd should change the current value for the kernel enabled flag. Valid values for ENABLE_STATE are "disable", "enable" or "nochange". The default is to enable (and disable when auditd terminates). The value of the enabled flag may be changed during the lifetime of auditd using 'auditctl \-e'.
32 .SH SIGNALS
33 .TP
34 SIGHUP
35 causes auditd to reconfigure. This means that auditd re-reads the configuration file. If there are no syntax errors, it will proceed to implement the requested changes. If the reconfigure is successful, a DAEMON_CONFIG event is recorded in the logs. If not successful, error handling is controlled by space_left_action, admin_space_left_action, disk_full_action, and disk_error_action parameters in auditd.conf.
36
37 .TP
38 SIGTERM
39 caused auditd to discontinue processing audit events, write a shutdown audit event, and exit.
40
41 .TP
42 SIGUSR1
43 causes auditd to immediately rotate the logs. It will consult the max_log_size_action to see if it should keep the logs or not.
44
45 .TP
46 SIGUSR2
47 causes auditd to attempt to resume logging. This is usually needed after logging has been suspended.
48
49 .SH FILES
50 .B /etc/audit/auditd.conf
51 - configuration file for audit daemon
52 .P
53 .B /etc/audit/audit.rules
54 - audit rules to be loaded at startup
55 .P
56 .B /etc/audit/rules.d/
57 - directory holding individual sets of rules to be compiled into one file by augenrules.
58
59 .SH NOTES
60 A boot param of audit=1 should be added to ensure that all processes that run before the audit daemon starts is marked as auditable by the kernel. Not doing that will make a few processes impossible to properly audit.
61
62 The audit daemon can receive audit events from other audit daemons via the audisp\-remote audispd plugin. The audit daemon may be linked with tcp_wrappers to control which machines can connect. If this is the case, you can add an entry to hosts.allow and deny.
63
64 .SH "SEE ALSO"
65 .BR auditd.conf (5),
66 .BR audispd (8),
67 .BR ausearch (8),
68 .BR aureport (8),
69 .BR auditctl (8),
70 .BR augenrules (8),
71 .BR audit.rules (7).
72
73 .SH AUTHOR
74 Steve Grubb