freebsd-nq/contrib/openbsm
Christian S.J. Peron 3008333d44 Fixup some incorrect information and some comments. These changes
were cherry picked up the upstream OpenBSD repository. At some point we
will look at doing another import, but the diffs are substantial and will
require some careful testing.

Differential Revision:	https://reviews.freebsd.org/D25021
MFC after:	2 weeks
Submitted by:	gbe
Reviewed by:	myself, bcr
2020-07-28 20:06:16 +00:00
..
bin Fixup some incorrect information and some comments. These changes 2020-07-28 20:06:16 +00:00
bsm
compat
config
etc Jail and capability mode for shm_rename; add audit support for shm_rename 2019-11-18 13:31:16 +00:00
libauditd Fixup some incorrect information and some comments. These changes 2020-07-28 20:06:16 +00:00
libbsm Fixup some incorrect information and some comments. These changes 2020-07-28 20:06:16 +00:00
m4
man Fixup some incorrect information and some comments. These changes 2020-07-28 20:06:16 +00:00
modules
sys Fixup some incorrect information and some comments. These changes 2020-07-28 20:06:16 +00:00
test
tools
.travis.yml
aclocal.m4
autogen.sh
configure
configure.ac
CREDITS Fixup some incorrect information and some comments. These changes 2020-07-28 20:06:16 +00:00
FREEBSD-upgrade
INSTALL
LICENSE
Makefile.am
Makefile.in
NEWS
README
TODO
VERSION

OpenBSM

  Introduction

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 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.  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.
Portions of OpenBSM, including include files and token-building routines, are
reusable in a kernel audit implementation, and may be found in the FreeBSD
and Mac OS X kernels.

  Contents

OpenBSM consists of several directories:

    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
    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 header files for BSM
    test/          Test token sets and geneneration program
    tools/         Tool directory, including audump to dump databases

The following programs are included with OpenBSM:

    audit          Command line audit control tool
    auditd         Audit management daemon
    auditdistd     Audit trail distribution daemon
    auditfilterd   Experimental event monitoring framework
    auditreduce    Audit trail reduction tool
    audump         Debugging tool to parse and print audit databases
    praudit        Tool to print audit trails

  Build and Installation

Please see the file INSTALL for build and installation instructions.

  Contributions

The TrustedBSD Project would appreciate the contribution of bug fixes, 
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

Information on OpenBSM may be found on the OpenBSM home page:

    http://www.OpenBSM.org/

Information on TrustedBSD may be found on the TrustedBSD home page:

    http://www.TrustedBSD.org/