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#7 $ 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 bsm/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 62The 63.Fn getauclassent 64function 65will return the next class found in the 66.Xr audit_class 5 67database, or the first if the function has not yet been called. 68.Dv NULL 69will be returned if no further records are available. 70.Pp 71The 72.Fn getauclassnam 73function 74looks up a class by name. 75.Dv NULL 76will be returned if no matching class can be found. 77.Pp 78The 79.Fn setauclass 80function 81resets the iterator through the 82.Xr audit_class 5 83database, causing the next call to 84.Fn getauclassent 85to start again from the beginning of the file. 86.Pp 87The 88.Fn endauclass 89function 90closes the 91.Xr audit_class 5 92database, if open. 93.Sh SEE ALSO 94.Xr libbsm 3 , 95.Xr audit_class 5 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 AUTHORS 102.An -nosplit 103This software was created by 104.An Robert Watson , 105.An Wayne Salamon , 106and 107.An Suresh Krishnaswamy 108for McAfee Research, the security research division of McAfee, 109Inc., under contract to Apple Computer, Inc. 110.Pp 111The Basic Security Module (BSM) interface to audit records and audit event 112stream format were defined by Sun Microsystems. 113.Sh BUGS 114These routines cannot currently distinguish between an entry not being found 115and an error accessing the database. 116The implementation should be changed to return an error via 117.Va errno 118when 119.Dv NULL 120is returned. 121