ca0716f571
1.0 alpha 1, an implementation of the documented Sun Basic Security Module (BSM) Audit API and file format, as well as local extensions to support the Mac OS X and FreeBSD operating systems. Also included are command line tools for audit trail reduction and conversion to text, as well as documentation of the commands, file format, and APIs. This distribution is the foundation for the TrustedBSD Audit implementation, and is a pre-release. This is the first in a series of commits to introduce support for Common Criteria CAPP security event audit support. This software has been made possible through the generous contributions of Apple Computer, Inc., SPARTA, Inc., as well as members of the TrustedBSD Project, including Wayne Salamon <wsalamon> and Tom Rhodes <trhodes>. The original OpenBSM implementation was created by McAfee Research under contract to Apple Computer, Inc., as part of their CC CAPP security evaluation. Many thanks to: wsalamon, trhodes Obtained from: TrustedBSD Project
109 lines
3.6 KiB
Groff
109 lines
3.6 KiB
Groff
.\"-
|
|
.\" Copyright (c) 2005-2006 Robert N. M. Watson
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_class.3#3 $
|
|
.\"
|
|
.Dd April 19, 2005
|
|
.Dt AU_CLASS 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm getauclassent ,
|
|
.Nm getauclassent_r ,
|
|
.Nm getauclassnam ,
|
|
.Nm getauclassnam_r ,
|
|
.Nm setauclass ,
|
|
.Nm endauclass
|
|
.Nd "Look up information from the audit_class database"
|
|
.Sh LIBRARY
|
|
.Lb libbsm
|
|
.Sh SYNOPSIS
|
|
.In libbsm.h
|
|
.Ft struct au_class_ent *
|
|
.Fn getauclassent "void"
|
|
.Ft struct au_class_ent *
|
|
.Fn getauclassent_r "struct au_class_ent *e"
|
|
.Ft struct au_class_ent *
|
|
.Fn getauclassnam "const char *name"
|
|
.Ft struct au_class_ent *
|
|
.Fn getauclassnam_r "struct au_class_ent *e" "const char *name"
|
|
.Ft void
|
|
.Fn setauclass "void"
|
|
.Ft void
|
|
.Fn endauclass "void"
|
|
.Sh DESCRIPTION
|
|
These interfaces may be used to look up information from the
|
|
.Xr audit_class 5
|
|
database, which describes audit event classes.
|
|
Audit event classes are described by
|
|
.Vt struct au_class_ent .
|
|
.Pp
|
|
.Pp
|
|
.Fn getauclassent
|
|
will return the next class found in the
|
|
.Xr audit_class 5
|
|
database, or the first if the function has not yet been called.
|
|
.Dv NULL
|
|
will be returned if no further records are available.
|
|
.Pp
|
|
.Fn getauclassnam
|
|
looks up a class by name.
|
|
.Dv NULL
|
|
will be returned if no matching class can be found.
|
|
.Pp
|
|
.Fn setauclass
|
|
resets the iterator through the
|
|
.Xr audit_class 5
|
|
database, causing the next call to
|
|
.Fn getauclassent
|
|
to start again from the beginning of the file.
|
|
.Pp
|
|
.Fn endauclass
|
|
closes the
|
|
.Xr audit_class 5
|
|
database, if open.
|
|
.Sh SEE ALSO
|
|
.Xr libbsm 3 ,
|
|
.Xr audit_class 5
|
|
.Sh AUTHORS
|
|
This software was created by Robert Watson, Wayne Salamon, and Suresh
|
|
Krishnaswamy for McAfee Research, the security research division of McAfee,
|
|
Inc., under contract to Apple Computer, Inc.
|
|
.Pp
|
|
The Basic Security Module (BSM) interface to audit records and audit event
|
|
stream format were defined by Sun Microsystems.
|
|
.Sh HISTORY
|
|
The OpenBSM implementation was created by McAfee Research, the security
|
|
division of McAfee Inc., under contract to Apple Computer, Inc., in 2004.
|
|
It was subsequently adopted by the TrustedBSD Project as the foundation for
|
|
the OpenBSM distribution.
|
|
.Sh BUGS
|
|
These routines cannot currently distinguish between an entry not being found
|
|
and an error accessing the database.
|
|
The implementation should be changed to return an error via
|
|
.Va errno
|
|
when
|
|
.Dv NULL
|
|
is returned.
|