contrib/openbsm/man/getauid.2

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