]> git.saurik.com Git - apple/xnu.git/blame - bsd/man/man2/getauid.2
xnu-1699.32.7.tar.gz
[apple/xnu.git] / bsd / man / man2 / getauid.2
CommitLineData
2d21ac55 1.\"
b0d623f7 2.\" Copyright (c) 2008-2009 Apple Inc. All rights reserved.
2d21ac55
A
3.\"
4.\" @APPLE_LICENSE_HEADER_START@
5.\"
6.\" This file contains Original Code and/or Modifications of Original Code
7.\" as defined in and that are subject to the Apple Public Source License
8.\" Version 2.0 (the 'License'). You may not use this file except in
9.\" compliance with the License. Please obtain a copy of the License at
10.\" http://www.opensource.apple.com/apsl/ and read it before using this
11.\" file.
12.\"
13.\" The Original Code and all software distributed under the License are
14.\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17.\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18.\" Please see the License for the specific language governing rights and
19.\" limitations under the License.
20.\"
21.\" @APPLE_LICENSE_HEADER_END@
22.\"
b0d623f7 23.Dd March 5, 2009
2d21ac55 24.Dt GETAUID 2
b0d623f7 25.Os
2d21ac55
A
26.Sh NAME
27.Nm getauid
6d2010ae 28.Nd "retrieve audit user ID"
2d21ac55 29.Sh SYNOPSIS
b0d623f7 30.In bsm/audit.h
2d21ac55 31.Ft int
b0d623f7 32.Fn getauid "au_id_t *auid"
2d21ac55
A
33.Sh DESCRIPTION
34The
35.Fn getauid
b0d623f7 36system call
6d2010ae 37retrieves the active audit user ID for the current process via the
b0d623f7
A
38.Vt au_id_t
39pointed to by
40.Fa auid .
2d21ac55 41.Sh RETURN VALUES
b0d623f7
A
42.Rv -std
43.Sh ERRORS
44The
45.Fn getauid
46function will fail if:
47.Bl -tag -width Er
48.It Bq Er EFAULT
49A failure occurred while data transferred from
50the kernel failed.
51.El
2d21ac55
A
52.Sh SEE ALSO
53.Xr audit 2 ,
54.Xr auditon 2 ,
2d21ac55 55.Xr getaudit 2 ,
b0d623f7
A
56.Xr getaudit_addr 2 ,
57.Xr setaudit 2 ,
58.Xr setaudit_addr 2 ,
59.Xr setauid 2 ,
60.Xr libbsm 3
2d21ac55 61.Sh HISTORY
b0d623f7
A
62The OpenBSM implementation was created by McAfee Research, the security
63division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
64It was subsequently adopted by the TrustedBSD Project as the foundation for
65the OpenBSM distribution.
66.Sh AUTHORS
67.An -nosplit
68This software was created by McAfee Research, the security research division
69of McAfee, Inc., under contract to Apple Computer Inc.
70Additional authors include
71.An Wayne Salamon ,
72.An Robert Watson ,
73and SPARTA Inc.
74.Pp
75The Basic Security Module (BSM) interface to audit records and audit event
76stream format were defined by Sun Microsystems.
77.Pp
78This manual page was written by
79.An Robert Watson Aq rwatson@FreeBSD.org .