docs/audispd.8

   1 .TH AUDISPD: "8" "Sept 2007" "Red Hat" "System Administration Utilities"
   2 .SH NAME
   3 audispd \- an event multiplexor
   4 .SH SYNOPSIS
   5 .B audispd
   6 .SH DESCRIPTION
   7 \fBaudispd\fP is an audit event multiplexor. It has to be started by the audit daemon in order to get events. 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 the dispatcher, too. The dispatcher in turn passes those signals to its child processes.
   8
   9 The child programs install a configuration file in a plugins directory, \fI/etc/audisp/plugins.d\fP. Filenames are not allowed to have more than one '.' in the name or it will be treated as a backup copy and skipped. Options are given one per line with an equal sign between the keyword and its value. The available options are as follows:
  10
  11 .TP
  12 .I active
  13 The options for this are
  14 .IR yes
  15 or
  16 .IR no.
  17 .TP
  18 .I direction
  19 The option is dictated by the plugin.
  20 .IR In
  21 or
  22 .IR out
  23 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.
  24 .TP
  25 .I path
  26 This is the absolute path to the plugin executable. In the case of internal plugins, it would be the name of the plugin.
  27 .TP
  28 .I type
  29 This tells the dispatcher how the plugin wants to be run. Choices are
  30 .IR builtin
  31 and
  32 .IR always.
  33 .IR Builtin
  34 should always be given for plugins that are internal to the audit event dispatcher. These are af_unix and syslog. The option
  35 .IR always
  36 should be given for most if not all plugins. The default setting is
  37 .IR always.
  38 .TP
  39 .I args
  40 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.
  41 .TP
  42 .I format
  43 The valid options for this are
  44 .IR binary
  45 and
  46 .IR string.
  47 .IR Binary
  48 passes the data exactly as the audit event dispatcher gets it from the audit daemon. The
  49 .IR string
  50 option tells the dispatcher to completely change the event into a string suitable for parsing with the audit parsing library. The default value is
  51 .IR string.
  52
  53 .SH FILES
  54 /etc/audisp/audispd.conf
  55 /etc/audisp/plugins.d
  56 .SH "SEE ALSO"
  57 .BR audispd.conf (5),
  58 .BR auditd (8).
  59 .SH AUTHOR
  60 Steve Grubb