mirror of
https://github.com/zeek/zeek.git
synced 2025-10-07 09:08: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
14
doc/scripts/base/frameworks/dpd/__load__.bro.rst
Normal file
14
doc/scripts/base/frameworks/dpd/__load__.bro.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/dpd/__load__.bro
|
||||
================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/frameworks/dpd/main.bro </scripts/base/frameworks/dpd/main.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
16
doc/scripts/base/frameworks/dpd/index.rst
Normal file
16
doc/scripts/base/frameworks/dpd/index.rst
Normal file
|
@ -0,0 +1,16 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/frameworks/dpd
|
||||
============================
|
||||
|
||||
The DPD (dynamic protocol detection) activates port-independent protocol
|
||||
detection and selectively disables analyzers if protocol violations occur.
|
||||
|
||||
:doc:`/scripts/base/frameworks/dpd/__load__.bro`
|
||||
|
||||
|
||||
:doc:`/scripts/base/frameworks/dpd/main.bro`
|
||||
|
||||
Activates port-independent protocol detection and selectively disables
|
||||
analyzers if protocol violations occur.
|
||||
|
99
doc/scripts/base/frameworks/dpd/main.bro.rst
Normal file
99
doc/scripts/base/frameworks/dpd/main.bro.rst
Normal file
|
@ -0,0 +1,99 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/dpd/main.bro
|
||||
============================
|
||||
.. bro:namespace:: DPD
|
||||
|
||||
Activates port-independent protocol detection and selectively disables
|
||||
analyzers if protocol violations occur.
|
||||
|
||||
:Namespace: DPD
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
============================================================================ ===============================================================
|
||||
:bro:id:`DPD::ignore_violations`: :bro:type:`set` :bro:attr:`&redef` Analyzers which you don't want to throw
|
||||
:bro:id:`DPD::ignore_violations_after`: :bro:type:`count` :bro:attr:`&redef` Ignore violations which go this many bytes into the connection.
|
||||
============================================================================ ===============================================================
|
||||
|
||||
Types
|
||||
#####
|
||||
========================================= ======================================================================
|
||||
:bro:type:`DPD::Info`: :bro:type:`record` The record type defining the columns to log in the DPD logging stream.
|
||||
========================================= ======================================================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
========================================== ======================================
|
||||
:bro:type:`Log::ID`: :bro:type:`enum` Add the DPD logging stream identifier.
|
||||
:bro:type:`connection`: :bro:type:`record`
|
||||
========================================== ======================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
.. bro:id:: DPD::ignore_violations
|
||||
|
||||
:Type: :bro:type:`set` [:bro:type:`Analyzer::Tag`]
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
Analyzer::ANALYZER_DCE_RPC,
|
||||
Analyzer::ANALYZER_NTLM
|
||||
}
|
||||
|
||||
Analyzers which you don't want to throw
|
||||
|
||||
.. bro:id:: DPD::ignore_violations_after
|
||||
|
||||
:Type: :bro:type:`count`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``10240``
|
||||
|
||||
Ignore violations which go this many bytes into the connection.
|
||||
Set to 0 to never ignore protocol violations.
|
||||
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: DPD::Info
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
ts: :bro:type:`time` :bro:attr:`&log`
|
||||
Timestamp for when protocol analysis failed.
|
||||
|
||||
uid: :bro:type:`string` :bro:attr:`&log`
|
||||
Connection unique ID.
|
||||
|
||||
id: :bro:type:`conn_id` :bro:attr:`&log`
|
||||
Connection ID containing the 4-tuple which identifies endpoints.
|
||||
|
||||
proto: :bro:type:`transport_proto` :bro:attr:`&log`
|
||||
Transport protocol for the violation.
|
||||
|
||||
analyzer: :bro:type:`string` :bro:attr:`&log`
|
||||
The analyzer that generated the violation.
|
||||
|
||||
failure_reason: :bro:type:`string` :bro:attr:`&log`
|
||||
The textual reason for the analysis failure.
|
||||
|
||||
disabled_aids: :bro:type:`set` [:bro:type:`count`]
|
||||
Disabled analyzer IDs. This is only for internal tracking
|
||||
so as to not attempt to disable analyzers multiple times.
|
||||
|
||||
packet_segment: :bro:type:`string` :bro:attr:`&optional` :bro:attr:`&log`
|
||||
(present if :doc:`/scripts/policy/frameworks/dpd/packet-segment-logging.bro` is loaded)
|
||||
|
||||
A chunk of the payload that most likely resulted in the
|
||||
protocol violation.
|
||||
|
||||
The record type defining the columns to log in the DPD logging stream.
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue