Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / audit_log_acct_message.3
1 .TH "AUDIT_LOG_ACCT_MESSAGE" "3" "Oct 2010" "Red Hat" "Linux Audit API"
2 .SH NAME
3 audit_log_acct_message \- log a user account message
4 .SH SYNOPSIS
5 .B #include <libaudit.h>
6 .sp
7 .B int audit_log_acct_message(int audit_fd, int type, const char *pgname,
8 const char *op, const char *name, unsigned int id, const char *host,
9 const char *addr, const char *tty, int result)
10
11 .SH DESCRIPTION
12 This function will log a message to the audit system using a predefined message format. It should be used for all account manipulation operations. The function
13 parameters are as follows:
14
15 .nf
16 audit_fd - The fd returned by audit_open
17 type - type of message: AUDIT_USER_CHAUTHTOK for changing any account attributes.
18 pgname - program's name, if NULL will attempt to figure out
19 op  -  operation. Ex: "adding user", "changing finger info", "deleting group"
20 name - user's account or group name. If not available use NULL.
21 id  -  uid or gid that the operation is being performed on. If the user is unknown, pass a \-1 and fill in the name parameter. This is used only when user is NULL.
22 host - The hostname if known. If not available pass a NULL.
23 addr - The network address of the user. If not available pass a NULL.
24 tty  - The tty of the user, if NULL will attempt to figure out
25 result - 1 is "success" and 0 is "failed"
26 .fi
27
28 .SH "RETURN VALUE"
29
30 It returns the sequence number which is > 0 on success or <= 0 on error.
31
32 .SH "ERRORS"
33
34 This function returns \-1 on failure. Examine errno for more info.
35
36 .SH "SEE ALSO"
37
38 .BR audit_log_user_message (3),
39 .BR audit_log_user_comm_message (3),
40 .BR audit_log_user_avc_message (3),
41 .BR audit_log_semanage_message (3).
42
43 .SH AUTHOR
44 Steve Grubb