Commit graph

631 commits

Author SHA1 Message Date
Robin Sommer
58fbee5701 Updating plugin docs. 2014-06-18 13:18:05 -07:00
Robin Sommer
60cf0ddf26 Polishing, mostly documentation updates. 2014-06-17 11:50:23 -07:00
Robin Sommer
ba7af428a7 Merge remote-tracking branch 'origin/master' into topic/robin/dynamic-plugins-2.3 2014-06-13 09:27:02 -07:00
Daniel Thayer
690ea30798 Merge remote-tracking branch 'origin/master' into topic/dnthayer/doc-fixes-for-2.3
Conflicts:
	doc/scripting/index.rst
2014-06-11 23:20:31 -05:00
Jon Siwek
5ebda7cc09 Fix doc/test that broke due to a Bro script change. 2014-06-11 12:34:29 -05:00
Daniel Thayer
745e287414 Fix a broken link in the docs
Use quoting in docs to avoid HTML links being generated when docs are built.
2014-06-07 13:13:44 -05:00
Daniel Thayer
95c7128d71 Update some info in the docs 2014-06-07 12:31:32 -05:00
Daniel Thayer
edc2774ba8 Removed a table from the scripting tutorial 2014-06-06 16:55:34 -05:00
Daniel Thayer
de93a5796e Update line numbers mentioned in scripting tutorial 2014-06-06 11:28:46 -05:00
Daniel Thayer
f615683460 Update line numbers for a doc example 2014-06-06 10:37:17 -05:00
Daniel Thayer
2a20e4a5e2 Move scripting tutorial out of reference section 2014-06-05 13:13:12 -05:00
Robin Sommer
551950c438 Adding environment variable BRO_PLUGIN_ACTIVATE that unconditionally
activates plugins.

Plugins are specified with a comma-separated list of names.
2014-05-29 18:15:18 -07:00
Daniel Thayer
11d2d8e549 Remove remaining references to BROMAGIC 2014-05-19 21:14:07 -05:00
Robin Sommer
256ff73115 Merge remote-tracking branch 'origin/fastpath'
* origin/fastpath:
  Update some doc tests and line numbers
2014-05-16 15:23:38 -07:00
Daniel Thayer
bb7781d2f6 Update some doc tests and line numbers 2014-05-16 16:53:56 -05:00
Daniel Thayer
9b82028f8c Update a broctl option name in cluster config doc 2014-05-16 14:43:58 -05:00
Daniel Thayer
08266b409d Minor update to cluster config docs
Forgot to add one small change in previous commit.
2014-05-16 13:59:28 -05:00
Daniel Thayer
25bd2c8d00 Minor updates to cluster config docs
Incorporated some feedback from Jeannette, and temporarily removed
the PF_RING ZC section.
2014-05-16 12:58:21 -05:00
Robin Sommer
bbd409d274 Merge remote-tracking branch 'origin/master' into topic/robin/dynamic-plugins-2.3
(Never good to name a branch after version anticipated to include it ...)
2014-05-14 16:23:04 -07:00
Daniel Thayer
99b13d3cfd Add a new section "Cluster Configuration" to the docs
Added a new section that is intended as a how-to for configuring a Bro
cluster (this section does not discuss cluster architecture or theory)
that is aimed at beginners to Bro.  Most of this content was moved here
from the BroControl doc (which is now intended as more of a reference guide
for more experienced users) and the load balancing FAQ on the website.
2014-05-02 16:57:55 -05:00
Robin Sommer
9efb549236 Merge remote-tracking branch 'origin/topic/jsiwek/file-signatures'
* origin/topic/jsiwek/file-signatures:
  File type detection changes and fix https.log {orig,resp}_fuids fields.
  Various minor changes related to file mime type detection.
  Refactor common MIME magic matching code.
  Replace libmagic w/ Bro signatures for file MIME type identification.

Conflicts:
	scripts/base/init-default.bro
	testing/btest/Baseline/coverage.bare-load-baseline/canonified_loaded_scripts.log
	testing/btest/Baseline/coverage.default-load-baseline/canonified_loaded_scripts.log

BIT-1143 #merged
2014-03-30 22:51:05 +02:00
Robin Sommer
1b2bf6e1b3 Merge remote-tracking branch 'origin/topic/dnthayer/ticket1160'
* origin/topic/dnthayer/ticket1160:
  More improvements to install/setup documentation
  Improve documentation of Bro clusters

BIT-1160 #merged
2014-03-30 20:21:21 +02:00
Robin Sommer
6cac21a9bf Merge remote-tracking branch 'origin/fastpath'
* origin/fastpath:
  Update instructions on how to build Bro docs
2014-03-30 19:55:39 +02:00
Daniel Thayer
11d3685f88 Update instructions on how to build Bro docs
Also added a note in the main docs about building the Bro docs.
2014-03-25 13:55:20 -05:00
Jon Siwek
bebedcd873 Merge branch 'master' into topic/jsiwek/file-signatures
Conflicts:
	scripts/policy/frameworks/files/detect-MHR.bro
2014-03-24 14:35:37 -05:00
Daniel Thayer
80fe5874a5 More improvements to install/setup documentation
Addresses BIT-1160
2014-03-19 16:56:29 -05:00
Daniel Thayer
2e8d0945a4 Improve documentation of Bro clusters
Renamed the bro cluster doc to better indicate its purpose (it provides
a high-level overview rather than detailed configuration instructions).
Moved the location of the bro cluster doc in the index so that it makes
more sense (it is an introductory section, not a section about using bro).

Added links in the quick start guide and the bro cluster doc so that
readers can more easily locate more detailed information on configuring
a bro cluster.

Addresses BIT-1160
2014-03-18 16:29:27 -05:00
Jon Siwek
4fd1098949 Misc. documentation fixes.
Silences some warnings from Sphinx.
2014-03-04 13:14:32 -06:00
Jon Siwek
b22ca5d0a3 Replace libmagic w/ Bro signatures for file MIME type identification.
Notable changes:

- libmagic is no longer used at all.  All MIME type detection is
  done through new Bro signatures, and there's no longer a means to get
  verbose file type descriptions (e.g. "PNG image data, 1435 x 170").
  The majority of the default file magic signatures are derived
  from the default magic database of libmagic ~5.17.

- File magic signatures consist of two new constructs in the
  signature rule parsing grammar: "file-magic" gives a regular
  expression to match against, and "file-mime" gives the MIME type
  string of content that matches the magic and an optional strength
  value for the match.

- Modified signature/rule syntax for identifiers: they can no longer
  start with a '-', which made for ambiguous syntax when doing negative
  strength values in "file-mime".  Also brought syntax for Bro script
  identifiers in line with reality (they can't start with numbers or
  include '-' at all).

- A new Built-In Function, "file_magic", can be used to get all
  file magic matches and their corresponding strength against a given
  chunk of data

- The second parameter of the "identify_data" Built-In Function
  can no longer be used to get verbose file type descriptions, though it
  can still be used to get the strongest matching file magic signature.

- The "file_transferred" event's "descr" parameter no longer
  contains verbose file type descriptions.

- The BROMAGIC environment variable no longer changes any behavior
  in Bro as magic databases are no longer used/installed.

- Reverted back to minimum requirement of CMake 2.6.3 from 2.8.0
  (it's back to being the same requirement as the Bro v2.2 release).
  The bump was to accomodate building libmagic as an external project,
  which is no longer needed.

Addresses BIT-1143.
2014-03-04 11:12:06 -06:00
Seth Hall
70316a3f14 Merge remote-tracking branch 'origin/topic/jsiwek/dns-improvements'
* origin/topic/jsiwek/dns-improvements:
  Rewrite DNS state tracking which matches queries and replies.
  Change dns.log to include only standard DNS queries.
  Improve DNS analysis.
2014-02-09 23:50:43 -05:00
Robin Sommer
54ba3198f6 Merge remote-tracking branch 'origin/topic/jdopheid/bro_documentation'
* origin/topic/jdopheid/bro_documentation:
  Updates to httpmonitor and mimestats documentation.
  Updates to Logs and Cluster documentation
  Updates to Bro IDS documentation

BIT-1127 #merged
2014-02-07 09:12:44 -08:00
Robin Sommer
c671491149 Merge remote-tracking branch 'origin/topic/jdopheid/bro/edits_to_installation_and_getting_started'
* origin/topic/jdopheid/bro/edits_to_installation_and_getting_started:
  Added some grammar and spelling corrections to Installation and Quick Start Guide.
  Minor grammar edits to Installation and Quick Start pages

BIT-1123 #merged
2014-01-31 11:43:25 -08:00
Jeannette Dopheide
121db68c30 Updates to httpmonitor and mimestats documentation. 2014-01-30 13:23:58 -06:00
Jeannette Dopheide
2e2cb0ffc9 Updates to Logs and Cluster documentation 2014-01-30 13:22:25 -06:00
Jeannette Dopheide
c7cacb56b8 Updates to Bro IDS documentation 2014-01-30 13:13:26 -06:00
Jeannette Dopheide
4c52c378d5 Added some grammar and spelling corrections to Installation and Quick Start Guide. 2014-01-29 11:23:31 -06:00
Jon Siwek
31866f8f59 Change dns.log to include only standard DNS queries.
The scope of dns.log is now only standard queries (OPCODE == 0).  Other
kinds of queries (e.g. inverse query) were not handled correctly and
could interfere with the state tracking of the default DNS scripts.
2014-01-28 13:56:22 -06:00
Jeannette Dopheide
af95026348 Minor grammar edits to Installation and Quick Start pages 2014-01-27 15:23:24 -06:00
Robin Sommer
3f47c5bc87 Merge remote-tracking branch 'origin/master' into topic/robin/dynamic-plugins-2.3 2014-01-24 20:26:00 -08:00
Jon Siwek
e18084b68d Add unit tests for new Bro Manual docs. 2014-01-21 16:01:55 -06:00
Jon Siwek
c5ab33d88f Reformat line width of some docs (i.e. fmt -72). 2014-01-21 11:43:35 -06:00
Jon Siwek
e88ac7221d Pass over doc xref links and linking style. 2014-01-21 11:32:55 -06:00
Jon Siwek
7822ebcb2e Merge branch 'master' into topic/jsiwek/review-rafael-bro-manual-changes 2014-01-21 10:46:38 -06:00
Robin Sommer
ea01a1be30 Reworking plugin interface to not rely on macros.
The Plugin.cc file is now just a standard class, with the interface
changed a bit to make it more easy to write. However, there're still
some conventions that one must follow to make everything work (like
using the right namespace structure).

This commit also includes the option to compile built-in plugins
dynamically instead of statically by adding
SET(BRO_PLUGIN_BUILD_DYNAMIC TRUE) to their CMake config. This hasn't
been tested much yet, and I'm still undecided if it's somethign we
would want to do by default--but we could now if wanted. :)

Also some minor other cleanup of plugin APIs and built infrastructure.

All tested on MacOS only currently.
2014-01-20 13:39:11 -08:00
Jon Siwek
c48c531629 Integrate libmagic 5.16 via CMake ExternalProject.
- Bumps CMake requirement to CMake 2.8.
- Bro now always relies on builtin/shipped magic library/database.
2014-01-15 14:19:29 -06:00
Daniel Thayer
0a90ddc1dd Merge remote-tracking branch 'origin/master' into topic/dnthayer/doc-updates 2013-12-18 14:35:22 -06:00
Daniel Thayer
415fe678e2 Fixed typo in the Quick Start Guide
Also clarified the instructions about modifying crontab.
2013-12-18 14:31:56 -06:00
Robin Sommer
87a1618309 Start of a plugin writing how-to.
See doc/devel/plugins.rst. It includes a simple example and background
on how things work.
2013-12-16 11:57:57 -08:00
Jon Siwek
dedc39d784 Minor Broxygen improvements, addresses BIT-1098.
- Internals: move type alias table to private static BroType member.

- Sphinx extension: now uses absolute path to bro binary.

- reST ouput formatting: remove "param" from function desriptions
  and change package overview docs so script link+summaries render
  consistently.
2013-12-06 09:35:35 -06:00
Robin Sommer
3abf626908 Merge remote-tracking branch 'origin/topic/jsiwek/broxygen'
BIT-1098

* origin/topic/jsiwek/broxygen:
  Fix Broxygen-related compile errors.
  Add a Broxygen coverage test.
  Internal Broxygen organization/documentation/polish.
  Add unit tests for Broxygen config file targets.
  Change Broxygen config file format.
  Broxygen doc-related test updates.  Fix two regressions.
  A couple documentation fixes.
  Integrate new Broxygen functionality into Sphinx.
  Implement majority of Broxygen features delegated to Bro.
  Broxygen can now read a config file specifying particular targets.
  Remove unneeded Broxygen comments in scan.bro.
  Replace safe_basename/safe_dirname w/ SafeBasename/SafeDirname.
  Add BIF interface for retrieving comments/docs.
  Quick optimization to Broxygen doc gathering.
  Flesh out Broxygen doc-gathering skeleton.
  Refactor search_for_file() util function.
  Initial skeleton of new Broxygen infrastructure.
2013-12-04 11:14:19 -08:00