This manual page is part of Xcode Tools version 3.2

Reading manual pages

SETAUDIT(2)                                BSD System Calls Manual                               SETAUDIT(2)

NAME
     setaudit, setaudit_addr -- set audit session state

SYNOPSIS
     #include <bsm/audit.h>

     int
     setaudit(auditinfo_t *auditinfo);

     int
     setaudit_addr(auditinfo_addr_t *auditinfo_addr, u_int length);

DESCRIPTION
     The setaudit() system call sets the active audit session state for the current process via the
     auditinfo_t pointed to by auditinfo.  The setaudit_addr() system call sets extended state via
     auditinfo_addr and length.

     The auditinfo_t data structure is defined as follows:

         struct auditinfo {
              au_id_t        ai_auid;         /* Audit user ID */
              au_mask_t      ai_mask;         /* Audit masks */
              au_tid_t       ai_termid;       /* Terminal ID */
              au_asid_t      ai_asid;         /* Audit session ID */
         };
         typedef struct auditinfo        auditinfo_t;

     The ai_auid variable contains the audit identifier which is recorded in the audit log for each event
     the process caused.  The value of AU_DEFAUDITID (-1) should not be used.  The exception is if the value
     of audit identifier is known at the start of the session but will be determined and set later.  Until
     ai_auid is set to something other than AU_DEFAUDITID any audit events generated by the system with be
     filtered by the non-attributed audit mask.

     The au_mask_t data structure defines the bit mask for auditing successful and failed events out of the
     predefined list of event classes. It is defined as follows:

         struct au_mask {
              unsigned int    am_success;     /* success bits */
              unsigned int    am_failure;     /* failure bits */
         };
         typedef struct au_mask  au_mask_t;

     The au_termid_t data structure defines the Terminal ID recorded with every event caused by the process.
     It is defined as follows:

         struct au_tid {
              dev_t           port;
              u_int32_t       machine;
         };
         typedef struct au_tid   au_tid_t;

     The ai_asid variable contains the audit session ID which is recorded with every event caused by the
     process.  It can be any value in the range 1 to PID_MAX (99999).  If the value of AU_ASSIGN_ASID is
     used for ai_asid a unique session ID will be generated by the kernel.  The audit session ID will be
     returned in ai_asid field on success.

     The setaudit_addr() system call uses the expanded auditinfo_addr_t data structure supports Terminal IDs
     with larger addresses such as those used in IP version 6.  It is defined as follows:

         struct auditinfo_addr {
              au_id_t         ai_auid;        /* Audit user ID. */
              au_mask_t       ai_mask;        /* Audit masks. */
              au_tid_addr_t   ai_termid;      /* Terminal ID. */
              au_asid_t       ai_asid;        /* Audit session ID. */
              u_int64_t       ai_flags;       /* Audit session flags */
         };
         typedef struct auditinfo_addr   auditinfo_addr_t;

     The au_tid_addr_t data structure which includes a larger address storage field and an additional field
     with the type of address stored:

         struct au_tid_addr {
              dev_t           at_port;
              u_int32_t       at_type;
              u_int32_t       at_addr[4];
         };
         typedef struct au_tid_addr      au_tid_addr_t;

     The ai_flags field is opaque to the kernel and can be used to store user defined session flags.

     These system calls require an appropriate privilege to complete.

     These system calls should only be called once at the start of a new session and not again during the
     same session to update the session information.  There are some exceptions, however.  The ai_auid field
     may be updated later if initially set to the value of AU_DEFAUDITID (-1).  Likewise, the ai_termid
     fields may be updated later if the at_type field in au_tid_addr is set to AU_IPv4 and the other
     ai_tid_addr fields are all set to zero.  The ai_flags field can only be set when a new session is ini-tially initially
     tially created.  Creating a new session is done by setting the ai_asid field to an unique session value
     or AU_ASSIGN_ASID.  These system calls will fail when attempting to change the ai_auid, ai_termid, or
     ai_flags fields once set to something other than the default values.  The audit preselection masks may
     be changed at any time but are usually updated with auditon(2) using the A_SETPMASK command.

RETURN VALUES
     The setaudit() and setaudit_addr() functions return the value 0 if successful; otherwise the value -1
     is returned and the global variable errno is set to indicate the error.

ERRORS
     [EFAULT]           A failure occurred while data transferred to or from the kernel failed.

     [EINVAL]           Illegal argument was passed by a system call.

     [EPERM]            The process does not have sufficient permission to complete the operation.

SEE ALSO
     audit(2), auditon(2), getaudit(2), getauid(2), setauid(2), libbsm(3)

HISTORY
     The OpenBSM implementation was created by McAfee Research, the security division of McAfee Inc., under
     contract to Apple Computer Inc. in 2004.  It was subsequently adopted by the TrustedBSD Project as the
     foundation for the OpenBSM distribution.

AUTHORS
     This software was created by McAfee Research, the security research division of McAfee, Inc., under
     contract to Apple Computer Inc.  Additional authors include Wayne Salamon, Robert Watson, and SPARTA
     Inc.

     The Basic Security Module (BSM) interface to audit records and audit event stream format were defined
     by Sun Microsystems.

     This manual page was written by Robert Watson <[email protected]> and Stacey Son <[email protected]>.

BSD                                            March 23, 2009                                            BSD