contrib/openbsm/man/getaudit.2

   1 .\"-
   2 .\" Copyright (c) 2005 Robert N. M. Watson
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $P4: //depot/projects/trustedbsd/openbsm/man/getaudit.2#7 $
  27 .\"
  28 .Dd April 19, 2005
  29 .Dt GETAUDIT 2
  30 .Os
  31 .Sh NAME
  32 .Nm getaudit ,
  33 .Nm getaudit_addr
  34 .Nd "retrieve audit session state"
  35 .Sh SYNOPSIS
  36 .In bsm/audit.h
  37 .Ft int
  38 .Fn getaudit "auditinfo_t *auditinfo"
  39 .Ft int
  40 .Fn getaudit_addr "auditinfo_addr_t *auditinfo_addr" "u_int length"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn getaudit
  44 system call
  45 retrieves the active audit session state for the current process via the
  46 .Vt auditinfo_t
  47 pointed to by
  48 .Fa auditinfo .
  49 The
  50 .Fn getaudit_addr
  51 system call
  52 retrieves extended state via
  53 .Fa auditinfo_addr
  54 and
  55 .Fa length .
  56 .Pp
  57 These system calls require an appropriate privilege to complete.
  58 .Sh RETURN VALUES
  59 .Rv -std getaudit getaudit_addr
  60 .Sh SEE ALSO
  61 .Xr audit 2 ,
  62 .Xr auditon 2 ,
  63 .Xr getauid 2 ,
  64 .Xr setaudit 2 ,
  65 .Xr setauid 2 ,
  66 .Xr libbsm 3
  67 .Sh HISTORY
  68 The OpenBSM implementation was created by McAfee Research, the security
  69 division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
  70 It was subsequently adopted by the TrustedBSD Project as the foundation for
  71 the OpenBSM distribution.
  72 .Sh AUTHORS
  73 .An -nosplit
  74 This software was created by McAfee Research, the security research division
  75 of McAfee, Inc., under contract to Apple Computer Inc.
  76 Additional authors include
  77 .An Wayne Salamon ,
  78 .An Robert Watson ,
  79 and SPARTA Inc.
  80 .Pp
  81 The Basic Security Module (BSM) interface to audit records and audit event
  82 stream format were defined by Sun Microsystems.
  83 .Pp
  84 This manual page was written by
  85 .An Robert Watson Aq rwatson@FreeBSD.org .