README revision 186647 
1OpenBSM 1.1 alpha 4
2
3  Introduction
4
5OpenBSM provides an open source implementation of Sun's BSM Audit API. 
6Originally created under contract to Apple Computer by McAfee Research, this
7implementation is now maintained by volunteers and the generous contribution
8of several organizations.  Coupled with a kernel audit implementation,
9OpenBSM can be used to maintain system audit streams, and is a foundation for
10an Audit-enabled system.  Portions of OpenBSM, including include files and
11token-building routines, are reusable in a kernel audit implementation, and
12may be found in the FreeBSD and Mac OS X kernels.
13
14  Contents
15
16OpenBSM consists of several directories:
17
18    bin/           Audit-related command line tools
19    bsm/           Library include files for BSM
20    compat/        Compatibility code to build on various OS's
21    etc/           Sample /etc/security configuration files
22    libauditd      Common audit management functions for auditd and launchd
23    libbsm/        Implementation of BSM library interfaces and man pages
24    man/           System call and configuration file man pages
25    modules/       Directory for auditfilterd module source
26    sys/           System include files for BSM
27    test/          Test token sets and geneneration program
28    tools/         Tool directory, including audump to dump databases
29
30The following programs are included with OpenBSM:
31
32    audit          Command line audit control tool
33    auditd         Audit management daemon
34    auditfilterd   Experimental event monitoring framework
35    auditreduce    Audit trail reduction tool
36    audump         Debugging tool to parse and print audit databases
37    praudit        Tool to print audit trails
38
39  Build and Installation
40
41Please see the file INSTALL for build and installation instructions.
42
43  Contributions
44
45The TrustedBSD Project would appreciate the contribution of bug fixes, 
46enhancements, etc, under identically or substantially similar licenses to 
47those present on the remainder of the OpenBSM source code.
48
49  Location
50
51Information on OpenBSM may be found on the OpenBSM home page:
52
53    http://www.OpenBSM.org/
54
55Information on TrustedBSD may be found on the TrustedBSD home page:
56
57    http://www.TrustedBSD.org/
58
59$P4: //depot/projects/trustedbsd/openbsm/README#34 $
60