aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 11 insertions, 10 deletions
diff --git a/README b/README
index e60c502849b6..3ae324abb2c2 100644
--- a/README
+++ b/README
@@ -2,15 +2,16 @@ OpenBSM
Introduction
-OpenBSM is an open source implementation of Sun's BSM event auditing file
+OpenBSM is an open-source implementation of Sun's BSM event auditing file
format and API. Originally created for Apple Computer by McAfee Research,
-OpenBSM is now maintained by volunteers and through the generous contribution
+OpenBSM is now maintained by volunteers and through the generous contributions
of several organizations.
OpenBSM includes several command line tools, including auditreduce(8) and
praudit(8) for reducing and printing audit trails, as well as the libbsm(3)
library to manage configuration files, generate audit records, and parse and
-print audit trails.
+print audit trails. It also includes the auditd(8) audit configuration
+daemon, and the auditdistd(8) audit-trail distribution daemon.
Coupled with a kernel audit implementation, OpenBSM can be used to maintain
system audit streams, and is a foundation for a full audit-enabled system.
@@ -22,15 +23,15 @@ and Mac OS X kernels.
OpenBSM consists of several directories:
- bin/ Audit-related command line tools
- bsm/ Library include files for BSM
+ bin/ Audit-related command line tools and daemons
+ bsm/ Library header files for BSM
compat/ Compatibility code to build on various operating systems
etc/ Sample /etc/security configuration files
- libauditd Common audit management functions for auditd and launchd
+ libauditd/ Common audit management functions for auditd and launchd
libbsm/ Implementation of BSM library interfaces and man pages
man/ System call and configuration file man pages
modules/ Directory for auditfilterd module source
- sys/ System include files for BSM
+ sys/ System header files for BSM
test/ Test token sets and geneneration program
tools/ Tool directory, including audump to dump databases
@@ -51,9 +52,9 @@ Please see the file INSTALL for build and installation instructions.
Contributions
The TrustedBSD Project would appreciate the contribution of bug fixes,
-enhancements, etc, under identically or substantially similar licenses to
-those present on the remainder of the OpenBSM source code. Please see the
-file CREDITS to learn more about who has contributed to the project.
+enhancements, etc, under the same license found in the top-level LICENSE file.
+Please see the file CREDITS to learn more about who has contributed to the
+project.
Location