docs/audit_log_user_comm_message.3 - master - githubmirror/audit-userspace

docs/audit_log_user_comm_message.3

55 строк2 KB

Sergio Correia

libaudit: truncate overlong comm values instead of rejecting them

24 июл 2026, 19:06

24 июл 2026, 19:06d7ea982

.TH "AUDIT_LOG_USER_COMM_MESSAGE" "3" "July 2016" "Red Hat" "Linux Audit API"
.SH NAME
audit_log_user_comm_message \- log a user message from a console app
.SH SYNOPSIS
.nf
.B #include <libaudit.h>
.PP
.BI "int audit_log_user_comm_message(int " audit_fd ,
.BI "                                int " type ,
.BI "                                const char *" message ,
.BI "                                const char *" comm ,
.BI "                                const char *" hostname ,
.BI "                                const char *" addr ,
.BI "                                const char *" tty ,
.BI "                                int " result ");"
.fi

.SH DESCRIPTION
This function will log a message to the audit system using a predefined message format. This function should be used by all non-ELF console apps that do not manipulate accounts, groups, or need to log execution of a script. An example would be a Python script recording an event. The function parameters are as follows:

.nf
\fIaudit_fd\fP - The fd returned by audit_open
\fItype\fP - type of message, ex: AUDIT_USYS_CONFIG, AUDIT_USER_LOGIN
\fImessage\fP - the message text being sent
\fIcomm\fP - the task command name from /proc/self/comm, NULL if unknown
\fIhostname\fP - the hostname if known, NULL if unknown
\fIaddr\fP - The network address of the user, NULL if unknown
\fItty\fP - The tty of the user, if NULL will attempt to figure out
\fIresult\fP - 1 is "success" and 0 is "failed"
.fi

The kernel task command name is limited to 15 bytes because
.B TASK_COMM_LEN
is 16 bytes including the terminating null byte. A non-NULL
.I comm
value longer than 15 bytes is truncated to 15 bytes and a warning
is logged.

.SH "RETURN VALUE"

It returns the sequence number which is > 0 on success or <= 0 on error.

.SH "ERRORS"

This function returns \-1 on failure. Examine errno for more info.

.SH "SEE ALSO"

.BR audit_log_user_message (3),
.BR audit_log_acct_message (3),
.BR audit_log_user_avc_message (3),
.BR audit_log_semanage_message (3).

.SH AUTHOR
Steve Grubb