mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +00:00
Cleaning up some distribution files.
This commit is contained in:
parent
fe77d385e0
commit
d660eb89cd
4 changed files with 44 additions and 77 deletions
18
COPYING
18
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.
|
through Lawrence Berkeley National Laboratory. All rights reserved.
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
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.
|
POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
Note that some files in the Bro distribution carry their own copyright
|
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
|
notices. In addition, other components, such as the build system, may have
|
||||||
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
|
|
||||||
separate copyrights.
|
separate copyrights.
|
||||||
|
|
93
INSTALL
93
INSTALL
|
@ -8,53 +8,31 @@ Prerequisites
|
||||||
Bro relies on the following libraries and tools, which need to be installed
|
Bro relies on the following libraries and tools, which need to be installed
|
||||||
before you begin:
|
before you begin:
|
||||||
|
|
||||||
* A C/C++ compiler
|
* CMake 2.6 or greater http://www.cmake.org
|
||||||
|
|
||||||
* Libpcap headers and libraries
|
* Libpcap (headers and libraries) http://www.tcpdump.org
|
||||||
Network traffic capture library
|
|
||||||
|
|
||||||
* Flex (Fast Lexical Analyzer)
|
* OpenSSL (headers and libraries) http://www.openssl.org
|
||||||
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.
|
|
||||||
|
|
||||||
Bro can also make uses of some optional libraries if they are found at
|
Bro can also make uses of some optional libraries if they are found at
|
||||||
installation time:
|
installation time:
|
||||||
|
|
||||||
* Libmagic
|
* Libmagic For identifying file types (e.g., in FTP transfers).
|
||||||
For identifying file types (e.g., in FTP transfers).
|
|
||||||
|
|
||||||
* LibGeoIP
|
* LibGeoIP For geo-locating IP addresses.
|
||||||
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
|
Installation
|
||||||
============
|
============
|
||||||
|
@ -65,26 +43,30 @@ To build and install into ``/usr/local/bro``::
|
||||||
> make
|
> make
|
||||||
> make install
|
> make install
|
||||||
|
|
||||||
This will perform an out-of-source build into a directory called
|
This will first build Bro into a directory inside the distribution
|
||||||
``build/``, using default build options. It then installs the Bro binary
|
called ``build/``, using default build options. It then installs al
|
||||||
into ``/usr/local/bro/bin``. Depending on the Bro package you
|
required files into ``/usr/local/bro``, including the Bro binary in
|
||||||
downloaded, there may be auxiliary tools and libraries available in the
|
``/usr/local/bro/bin/bro``.
|
||||||
``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.
|
|
||||||
|
|
||||||
You can specify a different installation directory with::
|
You can specify a different installation directory with::
|
||||||
|
|
||||||
> ./configure --prefix=<dir>
|
> ./configure --prefix=<dir>
|
||||||
|
|
||||||
Note that ``/usr`` and ``/opt/bro`` are standard prefixes for binary
|
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.
|
unless you are creating such a package.
|
||||||
|
|
||||||
Run ``./configure --help`` for more options.
|
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
|
Running Bro
|
||||||
===========
|
===========
|
||||||
|
|
||||||
|
@ -94,13 +76,14 @@ available here:
|
||||||
|
|
||||||
http://www.bro-ids.org/documentation/quickstart.html
|
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
|
For developers that wish to run Bro directly from the ``build/``
|
||||||
will have to first set ``BROPATH`` to look for scripts inside the build
|
directory after performing ``make``, but without performing ``make
|
||||||
directory. Sourcing either ``build/bro-path-dev.sh`` or
|
install``, they will have to first set ``BROPATH`` to look for scripts
|
||||||
``build/bro-path-dev.csh`` as appropriate for the current shell
|
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
|
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
|
> ./configure
|
||||||
> make
|
> make
|
||||||
|
|
8
README
8
README
|
@ -3,11 +3,9 @@ Bro Network Security Monitor
|
||||||
============================
|
============================
|
||||||
|
|
||||||
Bro is a powerful framework for network analysis and security
|
Bro is a powerful framework for network analysis and security
|
||||||
monitoring.
|
monitoring. Please see the INSTALL file for installation instructions
|
||||||
|
and pointers for getting started. For more documentation, research
|
||||||
Please see the INSTALL file for installation instructions and pointers
|
publications, and community contact information see Bro's home page:
|
||||||
for getting started. For more documentation, research publications, or
|
|
||||||
community contact information see Bro's home page:
|
|
||||||
|
|
||||||
http://www.bro-ids.org
|
http://www.bro-ids.org
|
||||||
|
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
Subproject commit d0ba6f2e2ebb0d1a35a4b7e44f7ac74edc13eefc
|
Subproject commit 33d9c6d2203563f91d00cb959373b1eb0118d077
|
Loading…
Add table
Add a link
Reference in a new issue