aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/audit/docs/audit_log_acct_message.3
diff options
context:
space:
mode:
authorAshlee Young <ashlee@wildernessvoice.com>2015-11-29 08:22:13 -0800
committerAshlee Young <ashlee@wildernessvoice.com>2015-11-29 08:22:13 -0800
commitdf5afa4fcd9725380f94ca6476248d4cc24f889a (patch)
tree65456f62397305febf7f40778c5a413a35d094ef /framework/src/audit/docs/audit_log_acct_message.3
parent76f6bf922552c00546e6e85ca471eab28f56986c (diff)
v2.4.4 audit sources
Change-Id: I9315a7408817db51edf084fb4d27fbb492785084 Signed-off-by: Ashlee Young <ashlee@wildernessvoice.com>
Diffstat (limited to 'framework/src/audit/docs/audit_log_acct_message.3')
-rw-r--r--framework/src/audit/docs/audit_log_acct_message.344
1 files changed, 44 insertions, 0 deletions
diff --git a/framework/src/audit/docs/audit_log_acct_message.3 b/framework/src/audit/docs/audit_log_acct_message.3
new file mode 100644
index 00000000..2ea6289b
--- /dev/null
+++ b/framework/src/audit/docs/audit_log_acct_message.3
@@ -0,0 +1,44 @@
+.TH "AUDIT_LOG_ACCT_MESSAGE" "3" "Oct 2010" "Red Hat" "Linux Audit API"
+.SH NAME
+audit_log_acct_message \- log a user account message
+.SH SYNOPSIS
+.B #include <libaudit.h>
+.sp
+.B int audit_log_acct_message(int audit_fd, int type, const char *pgname,
+const char *op, const char *name, unsigned int id, const char *host,
+const char *addr, const char *tty, int result)
+
+.SH DESCRIPTION
+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
+parameters are as follows:
+
+.nf
+audit_fd - The fd returned by audit_open
+type - type of message: AUDIT_USER_CHAUTHTOK for changing any account attributes.
+pgname - program's name, if NULL will attempt to figure out
+op - operation. Ex: "adding user", "changing finger info", "deleting group"
+name - user's account or group name. If not available use NULL.
+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.
+host - The hostname if known. If not available pass a NULL.
+addr - The network address of the user. If not available pass a NULL.
+tty - The tty of the user, if NULL will attempt to figure out
+result - 1 is "success" and 0 is "failed"
+.fi
+
+.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_user_comm_message (3),
+.BR audit_log_user_avc_message (3),
+.BR audit_log_semanage_message (3).
+
+.SH AUTHOR
+Steve Grubb