xref: /freebsd/contrib/openbsm/man/setauid.2 (revision b00ab754)
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.Dd April 19, 2005
28.Dt SETAUID 2
29.Os
30.Sh NAME
31.Nm setauid
32.Nd "set audit session ID"
33.Sh SYNOPSIS
34.In bsm/audit.h
35.Ft int
36.Fn setauid "au_id_t *auid"
37.Sh DESCRIPTION
38The
39.Fn setauid
40system call
41sets the active audit session ID for the current process from the
42.Vt au_id_t
43pointed to by
44.Fa auid .
45.Pp
46This system call requires an appropriate privilege to complete.
47.Sh RETURN VALUES
48.Rv -std
49.Sh ERRORS
50The
51.Fn setauid
52function will fail if:
53.Bl -tag -width Er
54.It Bq Er EFAULT
55A failure occurred while data transferred to
56the kernel failed.
57.It Bq Er EPERM
58The process does not have sufficient permission to complete
59the operation.
60.El
61.Sh SEE ALSO
62.Xr audit 2 ,
63.Xr auditon 2 ,
64.Xr getaudit 2 ,
65.Xr getaudit_addr 2 ,
66.Xr getauid 2 ,
67.Xr setaudit 2 ,
68.Xr setaudit_addr 2 ,
69.Xr libbsm 3
70.Sh HISTORY
71The OpenBSM implementation was created by McAfee Research, the security
72division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
73It was subsequently adopted by the TrustedBSD Project as the foundation for
74the OpenBSM distribution.
75.Sh AUTHORS
76.An -nosplit
77This software was created by McAfee Research, the security research division
78of McAfee, Inc., under contract to Apple Computer Inc.
79Additional authors include
80.An Wayne Salamon ,
81.An Robert Watson ,
82and SPARTA Inc.
83.Pp
84The Basic Security Module (BSM) interface to audit records and audit event
85stream format were defined by Sun Microsystems.
86.Pp
87This manual page was written by
88.An Robert Watson Aq rwatson@FreeBSD.org .
89