diff --git a/COPYING b/COPYING index f9bba2b90e..38ca99eff5 100644 --- a/COPYING +++ b/COPYING @@ -1,4 +1,4 @@ -Copyright (c) 1995-2010, The Regents of the University of California, +Copyright (c) 1995-2011, The Regents of the University of California, through Lawrence Berkeley National Laboratory. All rights reserved. Redistribution and use in source and binary forms, with or without @@ -30,19 +30,5 @@ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Note that some files in the Bro distribution carry their own copyright -notices. The above applies to the Bro scripts in policy/ (other than as -noted below) and the source files in src/, other than: - - policy/sigs/p0fsyn.osf - src/H3.h - src/OSFinger.cc - src/OSFinger.h - src/bsd-getopt-long.c - src/bsd-getopt-long.h - src/md5.c - src/md5.h - src/patricia.c - src/patricia.h - -In addition, other components, such as the build system, may have +notices. In addition, other components, such as the build system, may have separate copyrights. diff --git a/INSTALL b/INSTALL index c34e441324..17cc85aa58 100644 --- a/INSTALL +++ b/INSTALL @@ -8,53 +8,31 @@ Prerequisites Bro relies on the following libraries and tools, which need to be installed before you begin: - * A C/C++ compiler + * CMake 2.6 or greater http://www.cmake.org - * Libpcap headers and libraries - Network traffic capture library + * Libpcap (headers and libraries) http://www.tcpdump.org - * Flex (Fast Lexical Analyzer) - Flex is already installed on most systems, so with luck you can - skip having to install it yourself. - - * Bison (GNU Parser Generator) - This comes with many systems, but if you get errors compiling - parse.y, you will need to install it. - - * Perl - Used only during the Bro build process - - * sed - Used only during the Bro build process - - * BIND8 headers and libraries - These are usually already installed as well. - - * OpenSSL headers and libraries - For analysis of SSL certificates by the HTTP analyzer, and - for encrypted Bro-to-Bro communication. These are likely installed, - though some platforms may require installation of a 'devel' package - for the headers. - - * CMake 2.6 or greater - CMake is a cross-platform, open-source build system, typically - not installed by default. See http://www.cmake.org for more - information regarding CMake and the installation steps below for - how to use it to build this distribution. CMake generates native - Makefiles that depend on GNU Make by default. + * OpenSSL (headers and libraries) http://www.openssl.org Bro can also make uses of some optional libraries if they are found at installation time: - * Libmagic - For identifying file types (e.g., in FTP transfers). + * Libmagic For identifying file types (e.g., in FTP transfers). - * LibGeoIP - For geo-locating IP addresses. + * LibGeoIP For geo-locating IP addresses. + + * Libz For decompressing HTTP bodies by the HTTP analyzer, and for + compressed Bro-to-Bro communication. + + +Bro also needs the following tools, but on most systems they will +already come preinstalled: + + * BIND8 (headers and libraries) + * Bison (GNU Parser Generator) + * Flex (Fast Lexical Analyzer) + * Perl (Used only during the Bro build process) - * Libz - For decompressing HTTP bodies by the HTTP analyzer, and for - compressed Bro-to-Bro communication. Installation ============ @@ -65,26 +43,30 @@ To build and install into ``/usr/local/bro``:: > make > make install -This will perform an out-of-source build into a directory called -``build/``, using default build options. It then installs the Bro binary -into ``/usr/local/bro/bin``. Depending on the Bro package you -downloaded, there may be auxiliary tools and libraries available in the -``aux/`` directory. All of them except for ``aux/bro-aux`` will also be -built and installed by doing ``make install``. To install the programs -that come in the ``aux/bro-aux`` directory, additionally use ``make -install-aux``. There are ``--disable`` options that can be given to the -configure script to turn off unwanted auxiliary projects. +This will first build Bro into a directory inside the distribution +called ``build/``, using default build options. It then installs al +required files into ``/usr/local/bro``, including the Bro binary in +``/usr/local/bro/bin/bro``. You can specify a different installation directory with:: > ./configure --prefix= Note that ``/usr`` and ``/opt/bro`` are standard prefixes for binary -packages to be installed, so those are typically not good choices +Bro packages to be installed, so those are typically not good choices unless you are creating such a package. Run ``./configure --help`` for more options. +Depending on the Bro package you downloaded, there may be auxiliary +tools and libraries available in the ``aux/`` directory. All of them +except for ``aux/bro-aux`` will also be built and installed by doing +``make install``. To install the programs that come in the +``aux/bro-aux`` directory, additionally use ``make install-aux``. +There are ``--disable`` options that can be given to the configure +script to turn off unwanted auxiliary projects. + + Running Bro =========== @@ -94,13 +76,14 @@ available here: http://www.bro-ids.org/documentation/quickstart.html -For developers that wish to run Bro from the the ``build/`` directory -after performing ``make``, but without performing ``make install``, they -will have to first set ``BROPATH`` to look for scripts inside the build -directory. Sourcing either ``build/bro-path-dev.sh`` or -``build/bro-path-dev.csh`` as appropriate for the current shell + +For developers that wish to run Bro directly from the ``build/`` +directory after performing ``make``, but without performing ``make +install``, they will have to first set ``BROPATH`` to look for scripts +inside the build directory. Sourcing either ``build/bro-path-dev.sh`` +or ``build/bro-path-dev.csh`` as appropriate for the current shell accomplishes this and also augments your ``PATH`` so you can use Bro -without qualifying the path to it. e.g.:: +without qualifying the path to it: > ./configure > make diff --git a/README b/README index 387201d3c7..7d5dbff90b 100644 --- a/README +++ b/README @@ -3,11 +3,9 @@ Bro Network Security Monitor ============================ Bro is a powerful framework for network analysis and security -monitoring. - -Please see the INSTALL file for installation instructions and pointers -for getting started. For more documentation, research publications, or -community contact information see Bro's home page: +monitoring. Please see the INSTALL file for installation instructions +and pointers for getting started. For more documentation, research +publications, and community contact information see Bro's home page: http://www.bro-ids.org diff --git a/aux/broctl b/aux/broctl index d0ba6f2e2e..33d9c6d220 160000 --- a/aux/broctl +++ b/aux/broctl @@ -1 +1 @@ -Subproject commit d0ba6f2e2ebb0d1a35a4b7e44f7ac74edc13eefc +Subproject commit 33d9c6d2203563f91d00cb959373b1eb0118d077