README revision 185573 
1OpenBSM 1.1 alpha 1
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    libbsm/        Implementation of BSM library interfaces and man pages
23    man/           System call and configuration file man pages
24    modules/       Directory for auditfilterd module source
25    sys/           System include files for BSM
26    test/          Test token sets and geneneration program
27    tools/         Tool directory, including audump to dump databases
28
29The following programs are included with OpenBSM:
30
31    audit          Command line audit control tool
32    auditd         Audit management daemon
33    auditfilterd   Experimental event monitoring framework
34    auditreduce    Audit trail reduction tool
35    audump         Debugging tool to parse and print audit databases
36    praudit        Tool to print audit trails
37
38  Build and Installation
39
40Please see the file INSTALL for build and installation instructions.
41
42  Contributions
43
44The TrustedBSD Project would appreciate the contribution of bug fixes, 
45enhancements, etc, under identically or substantially similar licenses to 
46those present on the remainder of the OpenBSM source code.
47
48  Location
49
50Information on OpenBSM may be found on the OpenBSM home page:
51
52    http://www.OpenBSM.org/
53
54Information on TrustedBSD may be found on the TrustedBSD home page:
55
56    http://www.TrustedBSD.org/
57
58$P4: //depot/projects/trustedbsd/openbsm/README#32 $
59