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