contrib/openbsm/README

   1 OpenBSM 1.0
   2
   3   Introduction
   4
   5 OpenBSM provides an open source implementation of Sun's BSM Audit API.
   6 Originally created under contract to Apple Computer by McAfee Research, this
   7 implementation is now maintained by volunteers and the generous contribution
   8 of several organizations.  Coupled with a kernel audit implementation,
   9 OpenBSM can be used to maintain system audit streams, and is a foundation for
  10 an Audit-enabled system.  Portions of OpenBSM, including include files and
  11 token-building routines, are reusable in a kernel audit implementation, and
  12 may be found in the FreeBSD and Mac OS X kernels.
  13
  14   Contents
  15
  16 OpenBSM consists of several directories:
  17
  18     bin/           Audit-related command line tools
  19     bsm/           System 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     test/          Test token sets and geneneration program
  26     tools/         Tool directory, including audump to dump databases
  27
  28 The following programs are included with OpenBSM:
  29
  30     audit          Command line audit control tool
  31     auditd         Audit management daemon
  32     auditfilterd   Experimental event monitoring framework
  33     auditreduce    Audit trail reduction tool
  34     audump         Debugging tool to parse and print audit databases
  35     praudit        Tool to print audit trails
  36
  37   Building
  38
  39 OpenBSM is currently built using autoconf and automake, which should allow
  40 for building on a range of operating systems, including FreeBSD, Mac OS X,
  41 and Linux.  Depending on the availability of audit facilities in the
  42 underlying operating system, some components that depend on kernel audit
  43 support are built conditionally.  Typically, build will be performed using:
  44
  45     ./configure
  46     make
  47
  48 To install, use:
  49
  50     make install
  51
  52 You may wish to specify that the OpenBSM components not be installed in the
  53 base system, rather in a specific directory.  This may be done using the
  54 --prefix argument to configure.  If installing to a specific directory,
  55 remember to update your library path so that running tools from that
  56 directory the correct libbsm is used:
  57
  58     ./configure --prefix=/home/rwatson/openbsm
  59     make
  60     make install
  61     LD_LIBRARY_PATH=/home/rwatson/openbsm/libbsm ; export LD_LIBRARY_PATH
  62
  63 You will need to manually propagate openbsm/etc/* into /etc on your system;
  64 this is not done automatically so as to avoid disrupting the current
  65 configuration.  Currently, the locations of these files is not configurable.
  66
  67   Credits
  68
  69 The following organizations and individuals have contributed substantially to
  70 the development of OpenBSM:
  71
  72     Apple Computer, Inc.
  73     McAfee Research, McAfee, Inc.
  74     SPARTA, Inc.
  75     Robert Watson
  76     Wayne Salamon
  77     Suresh Krishnaswamy
  78     Kevin Van Vechten
  79     Tom Rhodes
  80     Wojciech Koszek
  81     Chunyang Yuan
  82     Poul-Henning Kamp
  83     Christian Brueffer
  84     Olivier Houchard
  85     Christian Peron
  86     Martin Fong
  87     Pawel Worach
  88     Martin Englund
  89     Ruslan Ermilov
  90     Martin Voros
  91     Diego Giagio
  92     Alex Samorukov
  93
  94 In addition, Coverity, Inc.'s Prevent(tm) static analysis tool and Gimpel
  95 Software's FlexeLint tool were used to identify a number of bugs in the
  96 OpenBSM implementation.
  97
  98   Contributions
  99
 100 The TrustedBSD Project would appreciate the contribution of bug fixes,
 101 enhancements, etc, under identically or substantially similar licenses to
 102 those present on the remainder of the OpenBSM source code.
 103
 104   Location
 105
 106 Information on OpenBSM may be found on the OpenBSM home page:
 107
 108     http://www.OpenBSM.org/
 109
 110 Information on TrustedBSD may be found on the TrustedBSD home page:
 111
 112     http://www.TrustedBSD.org/
 113
 114 $P4: //depot/projects/trustedbsd/openbsm/README#24 $