mirror of
https://github.com/zeek/zeek.git
synced 2025-10-14 04:28: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:
parent
9e5e9d04b7
commit
7e9d48f532
549 changed files with 89909 additions and 100 deletions
125
doc/scripts/policy/frameworks/dpd/detect-protocols.bro.rst
Normal file
125
doc/scripts/policy/frameworks/dpd/detect-protocols.bro.rst
Normal file
|
@ -0,0 +1,125 @@
|
|||
:tocdepth: 3
|
||||
|
||||
policy/frameworks/dpd/detect-protocols.bro
|
||||
==========================================
|
||||
.. bro:namespace:: ProtocolDetector
|
||||
|
||||
Finds connections with protocols on non-standard ports with DPD.
|
||||
|
||||
:Namespace: ProtocolDetector
|
||||
:Imports: :doc:`base/frameworks/notice </scripts/base/frameworks/notice/index>`, :doc:`base/utils/conn-ids.bro </scripts/base/utils/conn-ids.bro>`, :doc:`base/utils/site.bro </scripts/base/utils/site.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
===================================================================================== =
|
||||
:bro:id:`ProtocolDetector::minimum_duration`: :bro:type:`interval` :bro:attr:`&redef`
|
||||
:bro:id:`ProtocolDetector::minimum_volume`: :bro:type:`double` :bro:attr:`&redef`
|
||||
:bro:id:`ProtocolDetector::suppress_servers`: :bro:type:`set` :bro:attr:`&redef`
|
||||
:bro:id:`ProtocolDetector::valids`: :bro:type:`table` :bro:attr:`&redef`
|
||||
===================================================================================== =
|
||||
|
||||
Constants
|
||||
#########
|
||||
================================================================ =
|
||||
:bro:id:`ProtocolDetector::check_interval`: :bro:type:`interval`
|
||||
================================================================ =
|
||||
|
||||
State Variables
|
||||
###############
|
||||
=============================================================================================== =
|
||||
:bro:id:`ProtocolDetector::servers`: :bro:type:`table` :bro:attr:`&read_expire` = ``14.0 days``
|
||||
=============================================================================================== =
|
||||
|
||||
Types
|
||||
#####
|
||||
=================================================== =
|
||||
:bro:type:`ProtocolDetector::dir`: :bro:type:`enum`
|
||||
=================================================== =
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
========================================== =
|
||||
:bro:type:`Notice::Type`: :bro:type:`enum`
|
||||
========================================== =
|
||||
|
||||
Functions
|
||||
#########
|
||||
================================================================ =
|
||||
:bro:id:`ProtocolDetector::found_protocol`: :bro:type:`function`
|
||||
================================================================ =
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
.. bro:id:: ProtocolDetector::minimum_duration
|
||||
|
||||
:Type: :bro:type:`interval`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``30.0 secs``
|
||||
|
||||
|
||||
.. bro:id:: ProtocolDetector::minimum_volume
|
||||
|
||||
:Type: :bro:type:`double`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``4000.0``
|
||||
|
||||
|
||||
.. bro:id:: ProtocolDetector::suppress_servers
|
||||
|
||||
:Type: :bro:type:`set` [:bro:type:`Analyzer::Tag`]
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``{}``
|
||||
|
||||
|
||||
.. bro:id:: ProtocolDetector::valids
|
||||
|
||||
:Type: :bro:type:`table` [:bro:type:`Analyzer::Tag`, :bro:type:`addr`, :bro:type:`port`] of :bro:type:`ProtocolDetector::dir`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``{}``
|
||||
|
||||
|
||||
Constants
|
||||
#########
|
||||
.. bro:id:: ProtocolDetector::check_interval
|
||||
|
||||
:Type: :bro:type:`interval`
|
||||
:Default: ``5.0 secs``
|
||||
|
||||
|
||||
State Variables
|
||||
###############
|
||||
.. bro:id:: ProtocolDetector::servers
|
||||
|
||||
:Type: :bro:type:`table` [:bro:type:`addr`, :bro:type:`port`, :bro:type:`string`] of :bro:type:`set` [:bro:type:`string`]
|
||||
:Attributes: :bro:attr:`&read_expire` = ``14.0 days``
|
||||
:Default: ``{}``
|
||||
|
||||
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: ProtocolDetector::dir
|
||||
|
||||
:Type: :bro:type:`enum`
|
||||
|
||||
.. bro:enum:: ProtocolDetector::NONE ProtocolDetector::dir
|
||||
|
||||
.. bro:enum:: ProtocolDetector::INCOMING ProtocolDetector::dir
|
||||
|
||||
.. bro:enum:: ProtocolDetector::OUTGOING ProtocolDetector::dir
|
||||
|
||||
.. bro:enum:: ProtocolDetector::BOTH ProtocolDetector::dir
|
||||
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: ProtocolDetector::found_protocol
|
||||
|
||||
:Type: :bro:type:`function` (c: :bro:type:`connection`, atype: :bro:type:`Analyzer::Tag`, protocol: :bro:type:`string`) : :bro:type:`void`
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
:tocdepth: 3
|
||||
|
||||
policy/frameworks/dpd/packet-segment-logging.bro
|
||||
================================================
|
||||
.. bro:namespace:: DPD
|
||||
|
||||
This script enables logging of packet segment data when a protocol
|
||||
parsing violation is encountered. The amount of data from the
|
||||
packet logged is set by the :bro:see:`DPD::packet_segment_size` variable.
|
||||
A caveat to logging packet data is that in some cases, the packet may
|
||||
not be the packet that actually caused the protocol violation.
|
||||
|
||||
:Namespace: DPD
|
||||
:Imports: :doc:`base/frameworks/dpd </scripts/base/frameworks/dpd/index>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
====================================================================== =====================================================
|
||||
:bro:id:`DPD::packet_segment_size`: :bro:type:`int` :bro:attr:`&redef` Size of the packet segment to display in the DPD log.
|
||||
====================================================================== =====================================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
========================================= =
|
||||
:bro:type:`DPD::Info`: :bro:type:`record`
|
||||
========================================= =
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
.. bro:id:: DPD::packet_segment_size
|
||||
|
||||
:Type: :bro:type:`int`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``255``
|
||||
|
||||
Size of the packet segment to display in the DPD log.
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue