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,
   7 this implementation is now maintained by volunteers and the generous
   8 contribution of several organizations.  Coupled with a kernel audit
   9 implementation, OpenBSM can be used to maintain system audit streams, and
  10 is a foundation for an Audit-enabled system.
  11
  12   Contents
  13
  14 OpenBSM 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
  22 OpenBSM currently builds on FreeBSD and Darwin.  With Makefile adjustment
  23 and minor tweaks, it should build without problems on a broad range of
  24 POSIX-like systems.
  25
  26   Building
  27
  28 OpenBSM is currently built using autoconf and automake, which should allow
  29 for building on a range of operating systems, including FreeBSD, Mac OS X,
  30 and Linux.  Depending on the availability of audit facilities in the
  31 underlying operating system, some components that depend on kernel audit
  32 support are built conditionally.  Typically, build will be performed using
  33
  34     ./configure
  35     make
  36
  37 To install, use:
  38
  39     make install
  40
  41 You may wish to specify that the OpenBSM components not be installed in the
  42 base system, rather in a specific directory.  This may be done using the
  43 --prefix argument to configure.  If installing to a specific directory,
  44 remember to update your library path so that running tools from that
  45 directory the correct libbsm is used:
  46
  47     ./configure --prefix=/home/rwatson/openbsm
  48     make
  49     make install
  50     LD_LIBRARY_PATH=/home/rwatson/openbsm/libbsm ; export LD_LIBRARY_PATH
  51
  52 You will need to manually propagate openbsm/etc/* into /etc on your system;
  53 this is not done automatically so as to avoid disrupting the current
  54 configuration.  Currently, the locations of these files is not
  55 configurable.
  56
  57   Credits
  58
  59 The following organizations and individuals have contributed substantially
  60 to the development of OpenBSM:
  61
  62     Apple Computer, Inc.
  63     McAfee Research, McAfee, Inc.
  64     SPARTA, Inc.
  65     Robert Watson
  66     Wayne Salamon
  67     Suresh Krishnaswamy
  68     Kevin Van Vechten
  69     Tom Rhodes
  70     Wojciech Koszek
  71     Chunyang Yuan
  72     Poul-Henning Kamp
  73     Christian Brueffer
  74     Olivier Houchard
  75     Christian Peron
  76     Martin Fong
  77     Pawel Worach
  78     Martin Englund
  79
  80 In addition, Coverity, Inc.'s Prevent(tm) static analysis tool and Gimpel
  81 Software's FlexeLint tool were used to identify a number of bugs in the
  82 OpenBSM implementation.
  83
  84   Contributions
  85
  86 The TrustedBSD Project would appreciate the contribution of bug fixes,
  87 enhancements, etc, under identically or substantially similar licenses to
  88 those present on the remainder of the OpenBSM source code.
  89
  90   Location
  91
  92 Information on OpenBSM may be found on the OpenBSM home page:
  93
  94     http://www.OpenBSM.org/
  95
  96 Information on TrustedBSD may be found on the TrustedBSD home page:
  97
  98     http://www.TrustedBSD.org/
  99
 100 $P4: //depot/projects/trustedbsd/openbsm/README#19 $