Debian Codegraph @

upstream/debian-trixie/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 int audit_log_user_comm_message(int audit_fd, int type, const char *message,
8 const char *comm, const char *hostname, const char *addr, const char *tty,
9 int result)
10
11 .SH DESCRIPTION
12 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:
13
14 .nf
15 audit_fd - The fd returned by audit_open
16 type - type of message, ex: AUDIT_USYS_CONFIG, AUDIT_USER_LOGIN
17 message - the message text being sent
18 comm - the program command line name, NULL if unknown
19 hostname - the hostname if known, NULL if unknown
20 addr - The network address of the user, NULL if unknown
21 tty - The tty of the user, if NULL will attempt to figure out
22 result - 1 is "success" and 0 is "failed"
23 .fi
24
25 .SH "RETURN VALUE"
26
27 It returns the sequence number which is > 0 on success or <= 0 on error.
28
29 .SH "ERRORS"
30
31 This function returns \-1 on failure. Examine errno for more info.
32
33 .SH "SEE ALSO"
34
35 .BR audit_log_user_message (3),
36 .BR audit_log_acct_message (3),
37 .BR audit_log_user_avc_message (3),
38 .BR audit_log_semanage_message (3).
39
40 .SH AUTHOR
41 Steve Grubb