1.\"- 2.\" Copyright (c) 2005-2006 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/libbsm/au_class.3#3 $ 27.\" 28.Dd April 19, 2005 29.Dt AU_CLASS 3 30.Os 31.Sh NAME 32.Nm getauclassent , 33.Nm getauclassent_r , 34.Nm getauclassnam , 35.Nm getauclassnam_r , 36.Nm setauclass , 37.Nm endauclass 38.Nd "Look up information from the audit_class database" 39.Sh LIBRARY 40.Lb libbsm 41.Sh SYNOPSIS 42.In libbsm.h 43.Ft struct au_class_ent * 44.Fn getauclassent "void" 45.Ft struct au_class_ent * 46.Fn getauclassent_r "struct au_class_ent *e" 47.Ft struct au_class_ent * 48.Fn getauclassnam "const char *name" 49.Ft struct au_class_ent * 50.Fn getauclassnam_r "struct au_class_ent *e" "const char *name" 51.Ft void 52.Fn setauclass "void" 53.Ft void 54.Fn endauclass "void" 55.Sh DESCRIPTION 56These interfaces may be used to look up information from the 57.Xr audit_class 5 58database, which describes audit event classes. 59Audit event classes are described by 60.Vt struct au_class_ent . 61.Pp 62.Pp 63.Fn getauclassent 64will return the next class found in the 65.Xr audit_class 5 66database, or the first if the function has not yet been called. 67.Dv NULL 68will be returned if no further records are available. 69.Pp 70.Fn getauclassnam 71looks up a class by name. 72.Dv NULL 73will be returned if no matching class can be found. 74.Pp 75.Fn setauclass 76resets the iterator through the 77.Xr audit_class 5 78database, causing the next call to 79.Fn getauclassent 80to start again from the beginning of the file. 81.Pp 82.Fn endauclass 83closes the 84.Xr audit_class 5 85database, if open. 86.Sh SEE ALSO 87.Xr libbsm 3 , 88.Xr audit_class 5 89.Sh AUTHORS 90This software was created by Robert Watson, Wayne Salamon, and Suresh 91Krishnaswamy for McAfee Research, the security research division of McAfee, 92Inc., under contract to Apple Computer, Inc. 93.Pp 94The Basic Security Module (BSM) interface to audit records and audit event 95stream format were defined by Sun Microsystems. 96.Sh HISTORY 97The OpenBSM implementation was created by McAfee Research, the security 98division of McAfee Inc., under contract to Apple Computer, Inc., in 2004. 99It was subsequently adopted by the TrustedBSD Project as the foundation for 100the OpenBSM distribution. 101.Sh BUGS 102These routines cannot currently distinguish between an entry not being found 103and an error accessing the database. 104The implementation should be changed to return an error via 105.Va errno 106when 107.Dv NULL 108is returned. 109