bsd/man/man2/getauid.2

   1 .\"
   2 .\" Copyright (c) 2008-2009 Apple Inc. All rights reserved.
   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 .\"
  23 .Dd March 5, 2009
  24 .Dt GETAUID 2
  25 .Os
  26 .Sh NAME
  27 .Nm getauid
  28 .Nd "retrieve audit user ID"
  29 .Sh SYNOPSIS
  30 .In bsm/audit.h
  31 .Ft int
  32 .Fn getauid "au_id_t *auid"
  33 .Sh DESCRIPTION
  34 The
  35 .Fn getauid
  36 system call
  37 retrieves the active audit user ID for the current process via the
  38 .Vt au_id_t
  39 pointed to by
  40 .Fa auid .
  41 .Sh RETURN VALUES
  42 .Rv -std
  43 .Sh ERRORS
  44 The
  45 .Fn getauid
  46 function will fail if:
  47 .Bl -tag -width Er
  48 .It Bq Er EFAULT
  49 A failure occurred while data transferred from
  50 the kernel failed.
  51 .El
  52 .Sh SEE ALSO
  53 .Xr audit 2 ,
  54 .Xr auditon 2 ,
  55 .Xr getaudit 2 ,
  56 .Xr getaudit_addr 2 ,
  57 .Xr setaudit 2 ,
  58 .Xr setaudit_addr 2 ,
  59 .Xr setauid 2 ,
  60 .Xr libbsm 3
  61 .Sh HISTORY
  62 The OpenBSM implementation was created by McAfee Research, the security
  63 division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
  64 It was subsequently adopted by the TrustedBSD Project as the foundation for
  65 the OpenBSM distribution.
  66 .Sh AUTHORS
  67 .An -nosplit
  68 This software was created by McAfee Research, the security research division
  69 of McAfee, Inc., under contract to Apple Computer Inc.
  70 Additional authors include
  71 .An Wayne Salamon ,
  72 .An Robert Watson ,
  73 and SPARTA Inc.
  74 .Pp
  75 The Basic Security Module (BSM) interface to audit records and audit event
  76 stream format were defined by Sun Microsystems.
  77 .Pp
  78 This manual page was written by
  79 .An Robert Watson Aq rwatson@FreeBSD.org .