1OpenBSM 2 3 Introduction 4 5OpenBSM is an open-source implementation of Sun's BSM event auditing file 6format and API. Originally created for Apple Computer by McAfee Research, 7OpenBSM is now maintained by volunteers and through the generous contributions 8of several organizations. 9 10OpenBSM includes several command line tools, including auditreduce(8) and 11praudit(8) for reducing and printing audit trails, as well as the libbsm(3) 12library to manage configuration files, generate audit records, and parse and 13print audit trails. It also includes the auditd(8) audit configuration 14daemon, and the auditdistd(8) audit-trail distribution daemon. 15 16Coupled with a kernel audit implementation, OpenBSM can be used to maintain 17system audit streams, and is a foundation for a full audit-enabled system. 18Portions of OpenBSM, including include files and token-building routines, are 19reusable in a kernel audit implementation, and may be found in the FreeBSD 20and Mac OS X kernels. 21 22 Contents 23 24OpenBSM consists of several directories: 25 26 bin/ Audit-related command line tools and daemons 27 bsm/ Library header files for BSM 28 compat/ Compatibility code to build on various operating systems 29 etc/ Sample /etc/security configuration files 30 libauditd/ Common audit management functions for auditd and launchd 31 libbsm/ Implementation of BSM library interfaces and man pages 32 man/ System call and configuration file man pages 33 modules/ Directory for auditfilterd module source 34 sys/ System header files for BSM 35 test/ Test token sets and geneneration program 36 tools/ Tool directory, including audump to dump databases 37 38The following programs are included with OpenBSM: 39 40 audit Command line audit control tool 41 auditd Audit management daemon 42 auditdistd Audit trail distribution daemon 43 auditfilterd Experimental event monitoring framework 44 auditreduce Audit trail reduction tool 45 audump Debugging tool to parse and print audit databases 46 praudit Tool to print audit trails 47 48 Build and Installation 49 50Please see the file INSTALL for build and installation instructions. 51 52 Contributions 53 54The TrustedBSD Project would appreciate the contribution of bug fixes, 55enhancements, etc, under the same license found in the top-level LICENSE file. 56Please see the file CREDITS to learn more about who has contributed to the 57project. 58 59 Location 60 61Information on OpenBSM may be found on the OpenBSM home page: 62 63 http://www.OpenBSM.org/ 64 65Information on TrustedBSD may be found on the TrustedBSD home page: 66 67 http://www.TrustedBSD.org/ 68