audit-plugins(5) — Linux manual page


AUDIT-PLUGINS:(5)      System Administration Utilities     AUDIT-PLUGINS:(5)

NAME         top

       audit-plugins - realtime event receivers

DESCRIPTION         top

       auditd can multiplex audit events in realtime. It takes audit events
       and distributes them to child programs that want to analyze events in
       realtime. When the audit daemon receives a SIGTERM or SIGHUP, it
       passes that signal to its child processes so that can reload the
       configuration or terminate.

       The child programs install a configuration file in a plugins
       directory which defaults to /etc/audit/plugins.d. This can be
       controlled by a auditd.conf config option plugin_dir if the admin
       wished to locate plugins somewhere else. But auditd will install its
       plugins in the default location.

       The plugin directory will be scanned and every pluging that is active
       will be started. If the plugin has a problem and exits, it will be
       started a maximum of max_restarts times as found in auditd.conf.

       Config file names are not allowed to have more than one '.' in the
       name or it will be treated as a backup copy and skipped. Config file
       options are given one per line with an equal sign between the keyword
       and its value. The available options are as follows:

       active The options for this are yes or no.

              The option is dictated by the plugin.  In or out are the only
              choices. You cannot make a plugin operate in a way it wasn't
              designed just by changing this option. This option is to give
              a clue to the event dispatcher about which direction events
              flow. NOTE: inbound events are not supported yet.

       path   This is the absolute path to the plugin executable. In the
              case of internal plugins, it would be the name of the plugin.

       type   This tells the dispatcher how the plugin wants to be run.
              Choices are builtin and always.  Builtin should always be
              given for plugins that are internal to the audit event
              dispatcher. These are af_unix and syslog. The option always
              should be given for most if not all plugins. The default
              setting is always.

       args   This allows you to pass arguments to the child program.
              Generally plugins do not take arguments and have their own
              config file that instructs them how they should be configured.
              At the moment, there is a limit of 2 args.

       format The valid options for this are binary and string.  Binary
              passes the data exactly as the audit event dispatcher gets it
              from the audit daemon. The string option tells the dispatcher
              to completely change the event into a string suitable for
              parsing with the audit parsing library. The default value is

FILES         top

       /etc/auditd/auditd.conf /etc/audit/plugins.d

SEE ALSO         top

       auditd.conf(5), auditd(8).

AUTHOR         top

       Steve Grubb

COLOPHON         top

       This page is part of the audit (Linux Audit) project.  Information
       about the project can be found at 
       ⟨⟩.  If you have a bug report
       for this manual page, send it to  This page
       was obtained from the project's upstream Git repository
       ⟨⟩ on 2020-07-14.
       (At that time, the date of the most recent commit that was found in
       the repository was 2020-07-13.)  If you discover any rendering prob‐
       lems in this HTML version of the page, or you believe there is a bet‐
       ter or more up-to-date source for the page, or you have corrections
       or improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to

Red Hat                           Aug 2018                 AUDIT-PLUGINS:(5)