mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 15:18:20 +00:00
Remove broxygen Sphinx integration
The broxygen-generated files now live in the git repo, have tests that check that they are up-to-date, and a script to re-generate them on-demand.
This commit is contained in:
Jon Siwek
parent
9e5e9d04b7
commit
7e9d48f532
549 changed files with 89909 additions and 100 deletions
|
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/netcontrol/plugins/__load__.bro
|
||||
===============================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/frameworks/netcontrol/plugins/acld.bro </scripts/base/frameworks/netcontrol/plugins/acld.bro>`, :doc:`base/frameworks/netcontrol/plugins/broker.bro </scripts/base/frameworks/netcontrol/plugins/broker.bro>`, :doc:`base/frameworks/netcontrol/plugins/debug.bro </scripts/base/frameworks/netcontrol/plugins/debug.bro>`, :doc:`base/frameworks/netcontrol/plugins/openflow.bro </scripts/base/frameworks/netcontrol/plugins/openflow.bro>`, :doc:`base/frameworks/netcontrol/plugins/packetfilter.bro </scripts/base/frameworks/netcontrol/plugins/packetfilter.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
162
doc/scripts/base/frameworks/netcontrol/plugins/acld.bro.rst
Normal file
162
doc/scripts/base/frameworks/netcontrol/plugins/acld.bro.rst
Normal file
|
|
@ -0,0 +1,162 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/netcontrol/plugins/acld.bro
|
||||
===========================================
|
||||
.. bro:namespace:: NetControl
|
||||
|
||||
Acld plugin for the netcontrol framework.
|
||||
|
||||
:Namespace: NetControl
|
||||
:Imports: :doc:`base/frameworks/broker </scripts/base/frameworks/broker/index>`, :doc:`base/frameworks/netcontrol/main.bro </scripts/base/frameworks/netcontrol/main.bro>`, :doc:`base/frameworks/netcontrol/plugin.bro </scripts/base/frameworks/netcontrol/plugin.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Types
|
||||
#####
|
||||
====================================================== =
|
||||
:bro:type:`NetControl::AclRule`: :bro:type:`record`
|
||||
:bro:type:`NetControl::AcldConfig`: :bro:type:`record`
|
||||
====================================================== =
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
======================================================= =
|
||||
:bro:type:`NetControl::PluginState`: :bro:type:`record`
|
||||
======================================================= =
|
||||
|
||||
Events
|
||||
######
|
||||
========================================================== =======================================
|
||||
:bro:id:`NetControl::acld_add_rule`: :bro:type:`event` Events that are sent from us to Broker.
|
||||
:bro:id:`NetControl::acld_remove_rule`: :bro:type:`event`
|
||||
:bro:id:`NetControl::acld_rule_added`: :bro:type:`event` Events that are sent from Broker to us.
|
||||
:bro:id:`NetControl::acld_rule_error`: :bro:type:`event`
|
||||
:bro:id:`NetControl::acld_rule_exists`: :bro:type:`event`
|
||||
:bro:id:`NetControl::acld_rule_removed`: :bro:type:`event`
|
||||
========================================================== =======================================
|
||||
|
||||
Hooks
|
||||
#####
|
||||
======================================================== ==============================================================
|
||||
:bro:id:`NetControl::acld_rule_policy`: :bro:type:`hook` Hook that is called after a rule is converted to an acld rule.
|
||||
======================================================== ==============================================================
|
||||
|
||||
Functions
|
||||
#########
|
||||
======================================================= =============================
|
||||
:bro:id:`NetControl::create_acld`: :bro:type:`function` Instantiates the acld plugin.
|
||||
======================================================= =============================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: NetControl::AclRule
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
command: :bro:type:`string`
|
||||
|
||||
cookie: :bro:type:`count`
|
||||
|
||||
arg: :bro:type:`string`
|
||||
|
||||
comment: :bro:type:`string` :bro:attr:`&optional`
|
||||
|
||||
|
||||
.. bro:type:: NetControl::AcldConfig
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
acld_topic: :bro:type:`string`
|
||||
The acld topic to send events to.
|
||||
|
||||
acld_host: :bro:type:`addr`
|
||||
Broker host to connect to.
|
||||
|
||||
acld_port: :bro:type:`port`
|
||||
Broker port to connect to.
|
||||
|
||||
monitor: :bro:type:`bool` :bro:attr:`&default` = ``F`` :bro:attr:`&optional`
|
||||
Do we accept rules for the monitor path? Default false.
|
||||
|
||||
forward: :bro:type:`bool` :bro:attr:`&default` = ``T`` :bro:attr:`&optional`
|
||||
Do we accept rules for the forward path? Default true.
|
||||
|
||||
check_pred: :bro:type:`function` (p: :bro:type:`NetControl::PluginState`, r: :bro:type:`NetControl::Rule`) : :bro:type:`bool` :bro:attr:`&optional`
|
||||
Predicate that is called on rule insertion or removal.
|
||||
|
||||
|
||||
:p: Current plugin state.
|
||||
|
||||
|
||||
:r: The rule to be inserted or removed.
|
||||
|
||||
|
||||
:returns: T if the rule can be handled by the current backend, F otherwise.
|
||||
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: NetControl::acld_add_rule
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, ar: :bro:type:`NetControl::AclRule`)
|
||||
|
||||
Events that are sent from us to Broker.
|
||||
|
||||
.. bro:id:: NetControl::acld_remove_rule
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, ar: :bro:type:`NetControl::AclRule`)
|
||||
|
||||
|
||||
.. bro:id:: NetControl::acld_rule_added
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, msg: :bro:type:`string`)
|
||||
|
||||
Events that are sent from Broker to us.
|
||||
|
||||
.. bro:id:: NetControl::acld_rule_error
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, msg: :bro:type:`string`)
|
||||
|
||||
|
||||
.. bro:id:: NetControl::acld_rule_exists
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, msg: :bro:type:`string`)
|
||||
|
||||
|
||||
.. bro:id:: NetControl::acld_rule_removed
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, msg: :bro:type:`string`)
|
||||
|
||||
|
||||
Hooks
|
||||
#####
|
||||
.. bro:id:: NetControl::acld_rule_policy
|
||||
|
||||
:Type: :bro:type:`hook` (p: :bro:type:`NetControl::PluginState`, r: :bro:type:`NetControl::Rule`, ar: :bro:type:`NetControl::AclRule`) : :bro:type:`bool`
|
||||
|
||||
Hook that is called after a rule is converted to an acld rule.
|
||||
The hook may modify the rule before it is sent to acld.
|
||||
Setting the acld command to F will cause the rule to be rejected
|
||||
by the plugin.
|
||||
|
||||
|
||||
:p: Current plugin state.
|
||||
|
||||
|
||||
:r: The rule to be inserted or removed.
|
||||
|
||||
|
||||
:ar: The acld rule to be inserted or removed.
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: NetControl::create_acld
|
||||
|
||||
:Type: :bro:type:`function` (config: :bro:type:`NetControl::AcldConfig`) : :bro:type:`NetControl::PluginState`
|
||||
|
||||
Instantiates the acld plugin.
|
||||
|
||||
|
||||
129
doc/scripts/base/frameworks/netcontrol/plugins/broker.bro.rst
Normal file
129
doc/scripts/base/frameworks/netcontrol/plugins/broker.bro.rst
Normal file
|
|
@ -0,0 +1,129 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/netcontrol/plugins/broker.bro
|
||||
=============================================
|
||||
.. bro:namespace:: NetControl
|
||||
|
||||
Broker plugin for the NetControl framework. Sends the raw data structures
|
||||
used in NetControl on to Broker to allow for easy handling, e.g., of
|
||||
command-line scripts.
|
||||
|
||||
:Namespace: NetControl
|
||||
:Imports: :doc:`base/frameworks/broker </scripts/base/frameworks/broker/index>`, :doc:`base/frameworks/netcontrol/main.bro </scripts/base/frameworks/netcontrol/main.bro>`, :doc:`base/frameworks/netcontrol/plugin.bro </scripts/base/frameworks/netcontrol/plugin.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Types
|
||||
#####
|
||||
======================================================== ===============================================================================================
|
||||
:bro:type:`NetControl::BrokerConfig`: :bro:type:`record` This record specifies the configuration that is passed to :bro:see:`NetControl::create_broker`.
|
||||
======================================================== ===============================================================================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
======================================================= =
|
||||
:bro:type:`NetControl::PluginState`: :bro:type:`record`
|
||||
======================================================= =
|
||||
|
||||
Events
|
||||
######
|
||||
============================================================ =
|
||||
:bro:id:`NetControl::broker_add_rule`: :bro:type:`event`
|
||||
:bro:id:`NetControl::broker_remove_rule`: :bro:type:`event`
|
||||
:bro:id:`NetControl::broker_rule_added`: :bro:type:`event`
|
||||
:bro:id:`NetControl::broker_rule_error`: :bro:type:`event`
|
||||
:bro:id:`NetControl::broker_rule_exists`: :bro:type:`event`
|
||||
:bro:id:`NetControl::broker_rule_removed`: :bro:type:`event`
|
||||
:bro:id:`NetControl::broker_rule_timeout`: :bro:type:`event`
|
||||
============================================================ =
|
||||
|
||||
Functions
|
||||
#########
|
||||
========================================================= ===============================
|
||||
:bro:id:`NetControl::create_broker`: :bro:type:`function` Instantiates the broker plugin.
|
||||
========================================================= ===============================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: NetControl::BrokerConfig
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
topic: :bro:type:`string` :bro:attr:`&optional`
|
||||
The broker topic to send events to.
|
||||
|
||||
host: :bro:type:`addr` :bro:attr:`&optional`
|
||||
Broker host to connect to.
|
||||
|
||||
bport: :bro:type:`port` :bro:attr:`&optional`
|
||||
Broker port to connect to.
|
||||
|
||||
monitor: :bro:type:`bool` :bro:attr:`&default` = ``T`` :bro:attr:`&optional`
|
||||
Do we accept rules for the monitor path? Default true.
|
||||
|
||||
forward: :bro:type:`bool` :bro:attr:`&default` = ``T`` :bro:attr:`&optional`
|
||||
Do we accept rules for the forward path? Default true.
|
||||
|
||||
check_pred: :bro:type:`function` (p: :bro:type:`NetControl::PluginState`, r: :bro:type:`NetControl::Rule`) : :bro:type:`bool` :bro:attr:`&optional`
|
||||
Predicate that is called on rule insertion or removal.
|
||||
|
||||
|
||||
:p: Current plugin state.
|
||||
|
||||
|
||||
:r: The rule to be inserted or removed.
|
||||
|
||||
|
||||
:returns: T if the rule can be handled by the current backend, F otherwise.
|
||||
|
||||
This record specifies the configuration that is passed to :bro:see:`NetControl::create_broker`.
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: NetControl::broker_add_rule
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`)
|
||||
|
||||
|
||||
.. bro:id:: NetControl::broker_remove_rule
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, reason: :bro:type:`string`)
|
||||
|
||||
|
||||
.. bro:id:: NetControl::broker_rule_added
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, msg: :bro:type:`string`)
|
||||
|
||||
|
||||
.. bro:id:: NetControl::broker_rule_error
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, msg: :bro:type:`string`)
|
||||
|
||||
|
||||
.. bro:id:: NetControl::broker_rule_exists
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, msg: :bro:type:`string`)
|
||||
|
||||
|
||||
.. bro:id:: NetControl::broker_rule_removed
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, msg: :bro:type:`string`)
|
||||
|
||||
|
||||
.. bro:id:: NetControl::broker_rule_timeout
|
||||
|
||||
:Type: :bro:type:`event` (id: :bro:type:`count`, r: :bro:type:`NetControl::Rule`, i: :bro:type:`NetControl::FlowInfo`)
|
||||
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: NetControl::create_broker
|
||||
|
||||
:Type: :bro:type:`function` (config: :bro:type:`NetControl::BrokerConfig`, can_expire: :bro:type:`bool`) : :bro:type:`NetControl::PluginState`
|
||||
|
||||
Instantiates the broker plugin.
|
||||
|
||||
|
||||
37
doc/scripts/base/frameworks/netcontrol/plugins/debug.bro.rst
Normal file
37
doc/scripts/base/frameworks/netcontrol/plugins/debug.bro.rst
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/netcontrol/plugins/debug.bro
|
||||
============================================
|
||||
.. bro:namespace:: NetControl
|
||||
|
||||
Debugging plugin for the NetControl framework, providing insight into
|
||||
executed operations.
|
||||
|
||||
:Namespace: NetControl
|
||||
:Imports: :doc:`base/frameworks/netcontrol/main.bro </scripts/base/frameworks/netcontrol/main.bro>`, :doc:`base/frameworks/netcontrol/plugin.bro </scripts/base/frameworks/netcontrol/plugin.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Functions
|
||||
#########
|
||||
======================================================== =========================================================
|
||||
:bro:id:`NetControl::create_debug`: :bro:type:`function` Instantiates a debug plugin for the NetControl framework.
|
||||
======================================================== =========================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: NetControl::create_debug
|
||||
|
||||
:Type: :bro:type:`function` (do_something: :bro:type:`bool`) : :bro:type:`NetControl::PluginState`
|
||||
|
||||
Instantiates a debug plugin for the NetControl framework. The debug
|
||||
plugin simply logs the operations it receives.
|
||||
|
||||
|
||||
:do_something: If true, the plugin will claim it supports all operations; if
|
||||
false, it will indicate it doesn't support any.
|
||||
|
||||
|
||||
36
doc/scripts/base/frameworks/netcontrol/plugins/index.rst
Normal file
36
doc/scripts/base/frameworks/netcontrol/plugins/index.rst
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/frameworks/netcontrol/plugins
|
||||
===========================================
|
||||
|
||||
Plugins for the NetControl framework.
|
||||
|
||||
:doc:`/scripts/base/frameworks/netcontrol/plugins/__load__.bro`
|
||||
|
||||
|
||||
:doc:`/scripts/base/frameworks/netcontrol/plugins/debug.bro`
|
||||
|
||||
Debugging plugin for the NetControl framework, providing insight into
|
||||
executed operations.
|
||||
|
||||
:doc:`/scripts/base/frameworks/netcontrol/plugins/openflow.bro`
|
||||
|
||||
OpenFlow plugin for the NetControl framework.
|
||||
|
||||
:doc:`/scripts/base/frameworks/netcontrol/plugins/packetfilter.bro`
|
||||
|
||||
NetControl plugin for the process-level PacketFilter that comes with
|
||||
Bro. Since the PacketFilter in Bro is quite limited in scope
|
||||
and can only add/remove filters for addresses, this is quite
|
||||
limited in scope at the moment.
|
||||
|
||||
:doc:`/scripts/base/frameworks/netcontrol/plugins/broker.bro`
|
||||
|
||||
Broker plugin for the NetControl framework. Sends the raw data structures
|
||||
used in NetControl on to Broker to allow for easy handling, e.g., of
|
||||
command-line scripts.
|
||||
|
||||
:doc:`/scripts/base/frameworks/netcontrol/plugins/acld.bro`
|
||||
|
||||
Acld plugin for the netcontrol framework.
|
||||
|
||||
158
doc/scripts/base/frameworks/netcontrol/plugins/openflow.bro.rst
Normal file
158
doc/scripts/base/frameworks/netcontrol/plugins/openflow.bro.rst
Normal file
|
|
@ -0,0 +1,158 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/netcontrol/plugins/openflow.bro
|
||||
===============================================
|
||||
.. bro:namespace:: NetControl
|
||||
|
||||
OpenFlow plugin for the NetControl framework.
|
||||
|
||||
:Namespace: NetControl
|
||||
:Imports: :doc:`base/frameworks/netcontrol/main.bro </scripts/base/frameworks/netcontrol/main.bro>`, :doc:`base/frameworks/netcontrol/plugin.bro </scripts/base/frameworks/netcontrol/plugin.bro>`, :doc:`base/frameworks/openflow </scripts/base/frameworks/openflow/index>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
======================================================================================= ===============================================================================
|
||||
:bro:id:`NetControl::openflow_flow_timeout`: :bro:type:`interval` :bro:attr:`&redef` The time interval after we consider a flow timed out.
|
||||
:bro:id:`NetControl::openflow_message_timeout`: :bro:type:`interval` :bro:attr:`&redef` The time interval after which an openflow message is considered to be timed out
|
||||
and we delete it from our internal tracking.
|
||||
======================================================================================= ===============================================================================
|
||||
|
||||
Types
|
||||
#####
|
||||
==================================================== =================================================================================================
|
||||
:bro:type:`NetControl::OfConfig`: :bro:type:`record` This record specifies the configuration that is passed to :bro:see:`NetControl::create_openflow`.
|
||||
:bro:type:`NetControl::OfTable`: :bro:type:`record`
|
||||
==================================================== =================================================================================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
======================================================= =
|
||||
:bro:type:`NetControl::PluginState`: :bro:type:`record`
|
||||
======================================================= =
|
||||
|
||||
Functions
|
||||
#########
|
||||
=========================================================== =============================================================
|
||||
:bro:id:`NetControl::create_openflow`: :bro:type:`function` Instantiates an openflow plugin for the NetControl framework.
|
||||
=========================================================== =============================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. bro:id:: NetControl::openflow_flow_timeout
|
||||
|
||||
:Type: :bro:type:`interval`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``1.0 day``
|
||||
|
||||
The time interval after we consider a flow timed out. This should be fairly high (or
|
||||
even disabled) if you expect a lot of long flows. However, one also will have state
|
||||
buildup for quite a while if keeping this around...
|
||||
|
||||
.. bro:id:: NetControl::openflow_message_timeout
|
||||
|
||||
:Type: :bro:type:`interval`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``20.0 secs``
|
||||
|
||||
The time interval after which an openflow message is considered to be timed out
|
||||
and we delete it from our internal tracking.
|
||||
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: NetControl::OfConfig
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
monitor: :bro:type:`bool` :bro:attr:`&default` = ``T`` :bro:attr:`&optional`
|
||||
Accept rules that target the monitor path.
|
||||
|
||||
forward: :bro:type:`bool` :bro:attr:`&default` = ``T`` :bro:attr:`&optional`
|
||||
Accept rules that target the forward path.
|
||||
|
||||
idle_timeout: :bro:type:`count` :bro:attr:`&default` = ``0`` :bro:attr:`&optional`
|
||||
Default OpenFlow idle timeout.
|
||||
|
||||
table_id: :bro:type:`count` :bro:attr:`&optional`
|
||||
Default OpenFlow table ID.
|
||||
|
||||
priority_offset: :bro:type:`int` :bro:attr:`&default` = ``0`` :bro:attr:`&optional`
|
||||
Add this to all rule priorities. Can be useful if you want the openflow priorities be offset from the netcontrol priorities without having to write a filter function.
|
||||
|
||||
check_pred: :bro:type:`function` (p: :bro:type:`NetControl::PluginState`, r: :bro:type:`NetControl::Rule`) : :bro:type:`bool` :bro:attr:`&optional`
|
||||
Predicate that is called on rule insertion or removal.
|
||||
|
||||
|
||||
:p: Current plugin state.
|
||||
|
||||
|
||||
:r: The rule to be inserted or removed.
|
||||
|
||||
|
||||
:returns: T if the rule can be handled by the current backend, F otherwise.
|
||||
|
||||
match_pred: :bro:type:`function` (p: :bro:type:`NetControl::PluginState`, e: :bro:type:`NetControl::Entity`, m: :bro:type:`vector` of :bro:type:`OpenFlow::ofp_match`) : :bro:type:`vector` of :bro:type:`OpenFlow::ofp_match` :bro:attr:`&optional`
|
||||
This predicate is called each time an OpenFlow match record is created.
|
||||
The predicate can modify the match structure before it is sent on to the
|
||||
device.
|
||||
|
||||
|
||||
:p: Current plugin state.
|
||||
|
||||
|
||||
:r: The rule to be inserted or removed.
|
||||
|
||||
|
||||
:m: The openflow match structures that were generated for this rules.
|
||||
|
||||
|
||||
:returns: The modified OpenFlow match structures that will be used in place of the structures passed in m.
|
||||
|
||||
flow_mod_pred: :bro:type:`function` (p: :bro:type:`NetControl::PluginState`, r: :bro:type:`NetControl::Rule`, m: :bro:type:`OpenFlow::ofp_flow_mod`) : :bro:type:`OpenFlow::ofp_flow_mod` :bro:attr:`&optional`
|
||||
This predicate is called before a FlowMod message is sent to the OpenFlow
|
||||
device. It can modify the FlowMod message before it is passed on.
|
||||
|
||||
|
||||
:p: Current plugin state.
|
||||
|
||||
|
||||
:r: The rule to be inserted or removed.
|
||||
|
||||
|
||||
:m: The OpenFlow FlowMod message.
|
||||
|
||||
|
||||
:returns: The modified FlowMod message that is used in lieu of m.
|
||||
|
||||
This record specifies the configuration that is passed to :bro:see:`NetControl::create_openflow`.
|
||||
|
||||
.. bro:type:: NetControl::OfTable
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
p: :bro:type:`NetControl::PluginState`
|
||||
|
||||
r: :bro:type:`NetControl::Rule`
|
||||
|
||||
c: :bro:type:`count` :bro:attr:`&default` = ``0`` :bro:attr:`&optional`
|
||||
|
||||
packet_count: :bro:type:`count` :bro:attr:`&default` = ``0`` :bro:attr:`&optional`
|
||||
|
||||
byte_count: :bro:type:`count` :bro:attr:`&default` = ``0`` :bro:attr:`&optional`
|
||||
|
||||
duration_sec: :bro:type:`double` :bro:attr:`&default` = ``0.0`` :bro:attr:`&optional`
|
||||
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: NetControl::create_openflow
|
||||
|
||||
:Type: :bro:type:`function` (controller: :bro:type:`OpenFlow::Controller`, config: :bro:type:`NetControl::OfConfig` :bro:attr:`&default` = ``[]`` :bro:attr:`&optional`) : :bro:type:`NetControl::PluginState`
|
||||
|
||||
Instantiates an openflow plugin for the NetControl framework.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/netcontrol/plugins/packetfilter.bro
|
||||
===================================================
|
||||
.. bro:namespace:: NetControl
|
||||
|
||||
NetControl plugin for the process-level PacketFilter that comes with
|
||||
Bro. Since the PacketFilter in Bro is quite limited in scope
|
||||
and can only add/remove filters for addresses, this is quite
|
||||
limited in scope at the moment.
|
||||
|
||||
:Namespace: NetControl
|
||||
:Imports: :doc:`base/frameworks/netcontrol/plugin.bro </scripts/base/frameworks/netcontrol/plugin.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Functions
|
||||
#########
|
||||
=============================================================== =====================================
|
||||
:bro:id:`NetControl::create_packetfilter`: :bro:type:`function` Instantiates the packetfilter plugin.
|
||||
=============================================================== =====================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: NetControl::create_packetfilter
|
||||
|
||||
:Type: :bro:type:`function` () : :bro:type:`NetControl::PluginState`
|
||||
|
||||
Instantiates the packetfilter plugin.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue