Merge pull request #818 in SNORT/snort3 from doc_conn to master

Squashed commit of the following:

commit 98a35eebc3b3fee688a6abbed98a478493fb3e6e
Author: Russ Combs <rucombs@cisco.com>
Date:   Wed Feb 15 07:46:55 2017 -0500

    add plugin path to cmake doc build

commit 38fd4f4e696f4d3696fa9e6a344b3548ac2d67ed
Author: Russ Combs <rucombs@cisco.com>
Date:   Wed Feb 15 06:18:28 2017 -0500

    add connectors to generated reference parts of manual

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 354816a845cd136f9019225387189ffee07c534c..0b9835ed6f7318539e7efeb0b91cc2aa27aea6cc 100644 (file)
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -23,6 +23,7 @@ set (
     MODULE_SOURCES
     basic.txt
     codec.txt
+    connector.txt
     data.txt
     inspector.txt
     ips_action.txt
@@ -37,7 +38,7 @@ set (
     bugs.txt
     building.txt
     concepts.txt
-    connector.txt
+    connectors.txt
     daq.txt
     dcerpc.txt
     differences.txt

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 358ee10620adfe2f37f688dd55076d7275ba20be..451f2df01330d7e8616f4571ca89f0341a55f2fa 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -13,6 +13,7 @@ signals.txt \
 version.txt \
 basic.txt \
 codec.txt \
+connector.txt \
 inspector.txt \
 ips_action.txt \
 ips_option.txt \
@@ -30,7 +31,7 @@ bugs.txt \
 building.txt \
 concepts.txt \
 config_changes.txt \
-connector.txt \
+connectors.txt \
 daq.txt \
 dcerpc.txt \
 differences.txt \
@@ -115,6 +116,11 @@ codec.txt: $(snort)
                $(snort) $(plugin_path)  --markup --help-module $$m ; \
        done > $@
 
+connector.txt: $(snort)
+       for m in `$(snort) $(plugin_path) --list-modules connector` ; do \
+               $(snort) $(plugin_path)  --markup --help-module $$m ; \
+       done > $@
+
 inspector.txt: $(snort)
        for m in `$(snort) $(plugin_path) --list-modules inspector` ; do \
                $(snort) $(plugin_path) --markup --help-module $$m ; \

diff --git a/doc/connector.txt b/doc/connectors.txt
similarity index 93%
rename from doc/connector.txt
rename to doc/connectors.txt
index 61756a59a218c419d5af58e0d47eea4462c122e1..6be0306e404fcf1d35013b24727256c8e80762a8 100644 (file)
--- a/doc/connector.txt
+++ b/doc/connectors.txt
@@ -1,12 +1,12 @@
 Connectors are a set of modules that are used to exchange message-oriented
-data among snort threads and the external world.  A typical use-case is
+data among Snort threads and the external world.  A typical use-case is
 HA (High Availability) message exchange.  Connectors serve to decouple the
 message transport from the message creation/consumption.  Connectors expose
 a common API for several forms of message transport.
 
 Connectors are a Snort plugin type.
 
-===== Connector (parent plugin class):
+===== Connector (parent plugin class)
 
 Connectors may either be a simplex channel and perform unidirectional
 communications.  Or may be duplex and perform bidirectional communications.
@@ -25,7 +25,7 @@ There are currently two implementations of Connectors:
 * FileConnector - Write messages to files and read messages from files.
 
 
-===== TcpConnector:
+===== TcpConnector
 
 TcpConnector is a subclass of Connector and implements a DUPLEX type Connector,
 able to send and receive messages over a tcp session.
@@ -54,7 +54,7 @@ An example segment of TcpConnector configuration:
     }
 
 
-===== FileConnector:
+===== FileConnector
 
 FileConnector implements a Connector that can either read from files or write
 to files.  FileConnector's are simplex and must be configured to be
@@ -70,7 +70,7 @@ The configured 'name' string is used to construct the actual names as in:
 
 * file_connector_NAME_transmit and file_connector_NAME_receive
 
-All messages for one snort invocation are read and written to one file.
+All messages for one Snort invocation are read and written to one file.
 
 In the case of a receive FileConnector, all messages are read from the file
 prior to the start of packet processing.  This allows the messages to

diff --git a/doc/features.txt b/doc/features.txt
index c997e591600463c72b026d30923a9341db2ae35b..f4a11a8747b4a7a31bf08496b4a54d221664f5e3 100644 (file)
--- a/doc/features.txt
+++ b/doc/features.txt
@@ -25,7 +25,7 @@ include::high_availability.txt[]
 
 ==== Connector
 
-include::connector.txt[]
+include::connectors.txt[]
 
 ==== Side Channel
 

diff --git a/doc/help.cmake b/doc/help.cmake
index cbc534d6469dae33923457765dc2367c289f68f0..e3d1d694e4ea6e28e402592be11add8461ed6c13 100644 (file)
--- a/doc/help.cmake
+++ b/doc/help.cmake
@@ -2,9 +2,9 @@ function ( add_help_command generator_script output_file )
 
     add_custom_command (
         OUTPUT ${output_file}
-        COMMAND ${generator_script} $<TARGET_FILE:snort> ${output_file}
+        COMMAND ${generator_script} $<TARGET_FILE:snort> ${output_file} $ENV{SNORT_PLUGIN_PATH}
         DEPENDS snort
-        COMMENT "Documents: building ${output_file}"
+        COMMENT "Documents: building ${output_file} with $ENV{SNORT_PLUGIN_PATH}"
         )
 
 endfunction ( add_help_command )

diff --git a/doc/high_availability.txt b/doc/high_availability.txt
index 15b0b025f7f94ac4b1f3068f585e086aefdf204f..e57d842c8d0446e1bce9b2e845fcccbab07e261e 100644 (file)
--- a/doc/high_availability.txt
+++ b/doc/high_availability.txt
@@ -1,7 +1,7 @@
-HighAvailability (or HA) is a snort module that provides state coherancy
+HighAvailability (or HA) is a Snort module that provides state coherancy
 between two partner snort instances.  It uses SideChannel for messaging.
 
-There can be multiple types of HA within snort and snort plugins.  HA
+There can be multiple types of HA within Snort and Snort plugins.  HA
 implements an extensible architecture to enable plugins to subscribe to the
 base flow HA messaging.  These plugins can then include their own messages
 along with the flow cache HA messages.

diff --git a/doc/side_channel.txt b/doc/side_channel.txt
index fcb336a1c6312f1af801b7a44c2783a6fe1937b7..3a3d3320b79337ec43c9aed9a91e239351dd8815 100644 (file)
--- a/doc/side_channel.txt
+++ b/doc/side_channel.txt
@@ -1,5 +1,5 @@
-SideChannel is a snort module that uses Connectors to implement a messaging
-infrastructure that is used to communicate between snort threads and the
+SideChannel is a Snort module that uses Connectors to implement a messaging
+infrastructure that is used to communicate between Snort threads and the
 outside world.
 
 SideChannel adds functionality onto the Connector as:

diff --git a/doc/snort_manual.txt b/doc/snort_manual.txt
index e336e0249a2cf303f92404c123663a3de62b086f..3ca89957b21e2cbd6bbbdf87797d93e39f191026 100644 (file)
--- a/doc/snort_manual.txt
+++ b/doc/snort_manual.txt
@@ -46,6 +46,12 @@ protocol decoding, anomaly detection, and construction of active responses.
 
 include::codec.txt[]
 
+== Connector Modules
+
+Connectors support High Availability communication links.
+
+include::connector.txt[]
+
 == Inspector Modules
 
 These modules perform a variety of functions, including analysis of