xref: /freebsd/contrib/openbsm/man/getaudit.2 (revision acd3428b7d3e94cef0e1881c868cb4b131d4ff41)
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#5 $
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.Fn getaudit
43retrieves the active audit session state for the current process via the
44.Vt auditinfo_t
45pointed to by
46.Va auditinfo .
47.Fn getaudit_addr
48retrieves extended state via
49.Va auditinfo_addr
50and
51.Va length .
52.Pp
53This system call requires appropriate privilege to complete.
54.Sh RETURN VALUES
55.Nm
56returns 0 on success, or returns -1 on failure, providing additional error
57information via
58.Va errno .
59.Sh SEE ALSO
60.Xr audit 2 ,
61.Xr auditon 2 ,
62.Xr getauid 2 ,
63.Xr setauid 2 ,
64.Xr setaudit 2 ,
65.Xr libbsm 3
66.Sh AUTHORS
67This software was created by McAfee Research, the security research division
68of McAfee, Inc., under contract to Apple Computer Inc.
69Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
70.Pp
71The Basic Security Module (BSM) interface to audit records and audit event
72stream format were defined by Sun Microsystems.
73.Pp
74This manual page was written by
75.An Robert Watson Aq rwatson@FreeBSD.org .
76.Sh HISTORY
77The OpenBSM implementation was created by McAfee Research, the security
78division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
79It was subsequently adopted by the TrustedBSD Project as the foundation for
80the OpenBSM distribution.
81