Skip to content

Commit 5173c0c

Browse files
committed
af_unix: Update documentation on the new output format arg
1 parent 913b0e6 commit 5173c0c

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

audisp/plugins/af_unix/af_unix.conf

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ active = no
88
direction = out
99
path = /sbin/audisp-af_unix
1010
type = always
11-
args = 0640 /var/run/audispd_events
12-
format = string
11+
args = 0640 /var/run/audispd_events string
12+
format = binary

audisp/plugins/af_unix/audisp-af_unix.8

+5-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ audisp-af_unix \- plugin to push audit events to an af_unix socket
99
.B args
1010
line of the
1111
.B af_unix.conf
12-
file expects two arguments: the access mode and the path to the socket. The default values are 0640 and /var/run/audispd_events respectively.
12+
file expects three arguments: access mode, socket path, and output format. The access mode determines the permissions for the socket and defaults to 0640. The socket path specifies where the socket will be created, with the default location being /var/run/audispd_events. The output format determines the format in which events are delivered to the socket and supports two options: "string" and "binary". The "string" format delivers events in a human-readable form, while the "binary" format delivers events in their binary representation, which is essential for applications that need to process events in binary and reconstruct headers accurately. If the output format is not specified, the plugin defaults to the "string" format.
13+
14+
The
15+
.B af_unix.conf
16+
file must also include the line \fBformat = binary\fP. This setting specifies the input format that the \fBaudisp-af_unix\fP plugin expects from the audit event dispatcher. It ensures that the input delivered to the plugin is in binary format, enabling the plugin to reconstruct headers in their proper binary structure.
1317

1418
.SH FILES
1519
/etc/audit/plugins/af_unix.conf

0 commit comments

Comments
 (0)