githubmirror/audit-userspace

docs/auditd.8
107 строк4 KB
Attila Lakatos
Correct the auditd manpage regarding stop rules (#387)
17 июл 2024, 22:42
17 июл 2024, 22:42a02fd68
.TH "AUDITD" "8" "Sept 2021" "Red Hat" "System Administration Utilities"
.SH NAME
auditd \- The Linux Audit daemon
.SH SYNOPSIS
.B auditd
.RB [ \-f ]\ [ \-l ]\ [ \-n ]\ [ \-s\ disable|enable|nochange ]\ [ \-c\ <config_dir> ]
.SH DESCRIPTION
\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
.B ausearch
or
.B aureport
utilities. Configuring the audit system or loading rules is done with the
.B auditctl
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
.B augenrules
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
.B auditd.conf
file.
.SH OPTIONS
.TP
.B \-f
leave the audit daemon in the foreground for debugging. Messages also go to stderr rather than the audit log.
.TP
.B \-l
allow the audit daemon to follow symlinks for config files.
.TP
.B \-n
no fork. This is useful for running off of inittab or systemd.
.TP
.B \-s=\fIENABLE_STATE\fR
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'.
.TP
.B \-c
Specify alternate config file directory. Note that this same directory will
be passed to the dispatcher. (default: /etc/audit/)
.SH SIGNALS
.TP
.B SIGHUP
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.

.TP
.B SIGTERM
caused auditd to discontinue processing audit events, write a shutdown audit event, and exit.

.TP
.B SIGUSR1
causes auditd to immediately rotate the logs. It will consult the max_log_file_action to see if it should keep the logs or not.

.TP
.B SIGUSR2
causes auditd to attempt to resume logging and passing events to plugins. This is usually needed after logging has been suspended or the internal queue is overflowed. Either of these conditions depends on the applicable configuration settings.
.TP
.B SIGCONT
causes auditd to dump a report of internal state to /var/run/auditd.state.

.SH EXIT CODES
.TP
.B 1
Cannot adjust priority, daemonize, open audit netlink, write the pid file, start up plugins, resolve the machine name, set audit pid, or other initialization tasks.

.TP
.B 2
Invalid or excessive command line arguments

.TP
.B 4
The audit daemon doesn't have sufficient privilege

.TP
.B 6
There is an error in the configuration file

.SH FILES
.B /etc/audit/auditd.conf
- configuration file for audit daemon
.P
.B /etc/audit/audit.rules
- audit rules to be loaded at startup
.P
.B /etc/audit/rules.d/
- directory holding individual sets of rules to be compiled into one file by augenrules.
.P
.B /etc/audit/plugins.d/
- directory holding individual plugin configuration files.
.P
.B /etc/audit/audit-stop.rules
- These rules are loaded when the audit daemon stops.
.P
.B /var/run/auditd.state
- report about internal state.

.SH NOTES
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.

The audit daemon can receive audit events from other audit daemons via the audisp\-remote 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.

.SH "SEE ALSO"
.BR auditd.conf (5),
.BR auditd\-plugins (5),
.BR ausearch (8),
.BR aureport (8),
.BR auditctl (8),
.BR augenrules (8),
.BR audit.rules (7).

.SH AUTHOR
Steve Grubb