README revision 155364 
1OpenBSM 1.0
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, 
7this implementation is now maintained by volunteers and the generous 
8contribution of several organizations.  Coupled with a kernel audit 
9implementation, OpenBSM can be used to maintain system audit streams, and 
10is a foundation for an Audit-enabled system.
11
12  Contents
13
14OpenBSM consists of several directories:
15
16    bin/           Audit-related command line tools
17    bsm/           System include files for BSM
18    etc/           Sample /etc/security configuration files
19    libbsm/        Implementation of BSM library interfaces and man pages
20    man/           System call and configuration file man pages
21
22OpenBSM currently builds on FreeBSD and Darwin.  With Makefile adjustment
23and minor tweaks, it should build without problems on a broad range of
24POSIX-like systems.
25
26  Building
27
28OpenBSM is currently built using a series of BSD make files which should 
29work on both FreeBSD and Darwin.  One known issue is that versions of 
30Darwin prior to 10.3.8 have a nested include of "sys/audit.h" from 
31"sys/proc.h", which can result in type definition conflicts.  If running 
32with include files from an earlier version of Darwin, the nested include 
33must be manually removed in order that libbsm can be built, due to 
34potentially conflicting types resulting from an include of "sys/sysctl.h" 
35by that file.  On Darwin, the use of BSD make must be specified explicitly 
36by using "bsdmake" rather than "make", which on Darwin refers to GNU make.  
37Typical invocations from the OpenBSM tree root:
38
39FreeBSD
40
41    % make
42    # make install
43
44Darwin
45
46    % bsdmake
47    # bsdmake install
48
49  Credits
50
51The following organizations and individuals have contributed substantially 
52to the development of OpenBSM:
53
54    Apple Computer, Inc.
55    McAfee Research, McAfee, Inc.
56    SPARTA, Inc.
57    Robert Watson
58    Wayne Salamon
59    Suresh Krishnaswamy
60    Kevin Van Vechten
61    Tom Rhodes
62    Wojciech Koszek
63    Chunyang Yuan
64    Poul-Henning Kamp
65    Christian Brueffer
66    Olivier Houchard
67
68In addition, Coverity, Inc.'s Prevent(tm) static analysis tool and Gimpel
69Software's FlexeLint tool were used to identify a number of bugs in the
70OpenBSM implementation.
71
72  Contributions
73
74The TrustedBSD Project would appreciate the contribution of bug fixes, 
75enhancements, etc, under identically or substantially similar licenses to 
76those present on the remainder of the OpenBSM source code.
77
78  Location
79
80Information on OpenBSM may be found on the OpenBSM home page:
81
82    http://www.OpenBSM.org/
83
84Information on TrustedBSD may be found on the TrustedBSD home page:
85
86    http://www.TrustedBSD.org/
87
88$P4: //depot/projects/trustedbsd/openbsm/README#13 $
89