1.\"- 2.\" Copyright (c) 2005 Robert N. M. Watson 3.\" Copyright (c) 2008 Apple Inc. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" $P4: //depot/projects/trustedbsd/openbsm/man/setaudit.2#12 $ 28.\" 29.Dd April 19, 2005 30.Dt SETAUDIT 2 31.Os 32.Sh NAME 33.Nm setaudit , 34.Nm setaudit_addr 35.Nd "set audit session state" 36.Sh SYNOPSIS 37.In bsm/audit.h 38.Ft int 39.Fn setaudit "auditinfo_t *auditinfo" 40.Ft int 41.Fn setaudit_addr "auditinfo_addr_t *auditinfo_addr" "u_int length" 42.Sh DESCRIPTION 43The 44.Fn setaudit 45system call 46sets the active audit session state for the current process via the 47.Vt auditinfo_t 48pointed to by 49.Fa auditinfo . 50The 51.Fn setaudit_addr 52system call 53sets extended state via 54.Fa auditinfo_addr 55and 56.Fa length . 57.Pp 58The 59.Fa auditinfo_t 60data structure is defined as follows: 61.Bd -literal -offset 4n 62struct auditinfo { 63 au_id_t ai_auid; /* Audit user ID */ 64 au_mask_t ai_mask; /* Audit masks */ 65 au_tid_t ai_termid; /* Terminal ID */ 66 au_asid_t ai_asid; /* Audit session ID */ 67}; 68typedef struct auditinfo auditinfo_t; 69.Ed 70.Pp 71The 72.Fa ai_auid 73variable contains the audit identifier which is recorded in the audit log for 74each event the process caused. 75.Pp 76The 77.Fa au_mask_t 78data structure defines the bit mask for auditing successful and failed events 79out of the predefined list of event classes. It is defined as follows: 80.Bd -literal -offset 4n 81struct au_mask { 82 unsigned int am_success; /* success bits */ 83 unsigned int am_failure; /* failure bits */ 84}; 85typedef struct au_mask au_mask_t; 86.Ed 87.Pp 88The 89.Fa au_termid_t 90data structure defines the Terminal ID recorded with every event caused by the 91process. It is defined as follows: 92.Bd -literal -offset 4n 93struct au_tid { 94 dev_t port; 95 u_int32_t machine; 96}; 97typedef struct au_tid au_tid_t; 98.Ed 99.Pp 100The 101.Fa ai_asid 102variable contains the audit session ID which is recorded with every event 103caused by the process. 104.Pp 105The 106.Fn setaudit_addr 107system call 108uses the expanded 109.Fa auditinfo_addr_t 110data structure supports Terminal IDs with larger addresses such as those used 111in IP version 6. It is defined as follows: 112.Bd -literal -offset 4n 113struct auditinfo_addr { 114 au_id_t ai_auid; /* Audit user ID. */ 115 au_mask_t ai_mask; /* Audit masks. */ 116 au_tid_addr_t ai_termid; /* Terminal ID. */ 117 au_asid_t ai_asid; /* Audit session ID. */ 118}; 119typedef struct auditinfo_addr auditinfo_addr_t; 120.Ed 121.Pp 122The 123.Fa au_tid_addr_t 124data structure which includes a larger address storage field and an additional 125field with the type of address stored: 126.Bd -literal -offset 4n 127struct au_tid_addr { 128 dev_t at_port; 129 u_int32_t at_type; 130 u_int32_t at_addr[4]; 131}; 132typedef struct au_tid_addr au_tid_addr_t; 133.Ed 134.Pp 135These system calls require an appropriate privilege to complete. 136.Sh RETURN VALUES 137.Rv -std setaudit setaudit_addr 138.Sh ERRORS 139.Bl -tag -width Er 140.It Bq Er EFAULT 141A failure occurred while data transferred to or from 142the kernel failed. 143.It Bq Er EINVAL 144Illegal argument was passed by a system call. 145.It Bq Er EPERM 146The process does not have sufficient permission to complete 147the operation. 148.El 149.Sh SEE ALSO 150.Xr audit 2 , 151.Xr auditon 2 , 152.Xr getaudit 2 , 153.Xr getauid 2 , 154.Xr setauid 2 , 155.Xr libbsm 3 156.Sh HISTORY 157The OpenBSM implementation was created by McAfee Research, the security 158division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004. 159It was subsequently adopted by the TrustedBSD Project as the foundation for 160the OpenBSM distribution. 161.Sh AUTHORS 162.An -nosplit 163This software was created by McAfee Research, the security research division 164of McAfee, Inc., under contract to Apple Computer Inc. 165Additional authors include 166.An Wayne Salamon , 167.An Robert Watson , 168and SPARTA Inc. 169.Pp 170The Basic Security Module (BSM) interface to audit records and audit event 171stream format were defined by Sun Microsystems. 172.Pp 173This manual page was written by 174.An Robert Watson Aq rwatson@FreeBSD.org . 175