Debian Codegraph @

upstream/debian-unstable/man3/audit_log_user_comm_message.3

raw
1 .TH "AUDIT_LOG_USER_COMM_MESSAGE" "3" "July 2016" "Red Hat" "Linux Audit API"
2 .SH NAME
3 audit_log_user_comm_message \- log a user message from a console app
4 .SH SYNOPSIS
5 .B #include <libaudit.h>
6 .sp
7 .BI "int audit_log_user_comm_message(int" audit_fd, int" type, const char *" message, const char *" comm, const char *" hostname, const char *" addr, const char *" tty, int" result);"
8
9 .SH DESCRIPTION
10 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:
11
12 .nf
13 \fIaudit_fd\fP - The fd returned by audit_open
14 \fItype\fP - type of message, ex: AUDIT_USYS_CONFIG, AUDIT_USER_LOGIN
15 \fImessage\fP - the message text being sent
16 \fIcomm\fP - the program command line name, NULL if unknown
17 \fIhostname\fP - the hostname if known, NULL if unknown
18 \fIaddr\fP - The network address of the user, NULL if unknown
19 \fItty\fP - The tty of the user, if NULL will attempt to figure out
20 \fIresult\fP - 1 is "success" and 0 is "failed"
21 .fi
22
23 .SH "RETURN VALUE"
24
25 It returns the sequence number which is > 0 on success or <= 0 on error.
26
27 .SH "ERRORS"
28
29 This function returns \-1 on failure. Examine errno for more info.
30
31 .SH "SEE ALSO"
32
33 .BR audit_log_user_message (3),
34 .BR audit_log_acct_message (3),
35 .BR audit_log_user_avc_message (3),
36 .BR audit_log_semanage_message (3).
37
38 .SH AUTHOR
39 Steve Grubb