mirror of
https://github.com/zeek/zeek.git
synced 2025-10-09 18:18:19 +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
38
doc/scripts/base/misc/find-checksum-offloading.bro.rst
Normal file
38
doc/scripts/base/misc/find-checksum-offloading.bro.rst
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/misc/find-checksum-offloading.bro
|
||||
======================================
|
||||
.. bro:namespace:: ChecksumOffloading
|
||||
|
||||
Discover cases where the local interface is sniffed and outbound packets
|
||||
have checksum offloading. Load this script to receive a notice if it's
|
||||
likely that checksum offload effects are being seen on a live interface or
|
||||
in a packet trace file.
|
||||
|
||||
:Namespace: ChecksumOffloading
|
||||
:Imports: :doc:`base/frameworks/notice </scripts/base/frameworks/notice/index>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
===================================================================================== =========================================================
|
||||
:bro:id:`ChecksumOffloading::check_interval`: :bro:type:`interval` :bro:attr:`&redef` The interval which is used for checking packet statistics
|
||||
to see if checksum offloading is affecting analysis.
|
||||
===================================================================================== =========================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. bro:id:: ChecksumOffloading::check_interval
|
||||
|
||||
:Type: :bro:type:`interval`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``10.0 secs``
|
||||
|
||||
The interval which is used for checking packet statistics
|
||||
to see if checksum offloading is affecting analysis.
|
||||
|
||||
|
||||
37
doc/scripts/base/misc/find-filtered-trace.bro.rst
Normal file
37
doc/scripts/base/misc/find-filtered-trace.bro.rst
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/misc/find-filtered-trace.bro
|
||||
=================================
|
||||
.. bro:namespace:: FilteredTraceDetection
|
||||
|
||||
Discovers trace files that contain TCP traffic consisting only of
|
||||
control packets (e.g. it's been filtered to contain only SYN/FIN/RST
|
||||
packets and no content). On finding such a trace, a warning is
|
||||
emitted that suggests toggling the :bro:see:`detect_filtered_trace`
|
||||
option may be desired if the user does not want Bro to report
|
||||
missing TCP segments.
|
||||
|
||||
:Namespace: FilteredTraceDetection
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
State Variables
|
||||
###############
|
||||
============================================================================= =================================================================
|
||||
:bro:id:`FilteredTraceDetection::enable`: :bro:type:`bool` :bro:attr:`&redef` Flag to enable filtered trace file detection and warning message.
|
||||
============================================================================= =================================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
State Variables
|
||||
###############
|
||||
.. bro:id:: FilteredTraceDetection::enable
|
||||
|
||||
:Type: :bro:type:`bool`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``T``
|
||||
|
||||
Flag to enable filtered trace file detection and warning message.
|
||||
|
||||
|
||||
134
doc/scripts/base/misc/version.bro.rst
Normal file
134
doc/scripts/base/misc/version.bro.rst
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/misc/version.bro
|
||||
=====================
|
||||
.. bro:namespace:: Version
|
||||
|
||||
Provide information about the currently running Bro version.
|
||||
The most convenient way to access this are the Version::number
|
||||
and Version::info constants.
|
||||
|
||||
:Namespace: Version
|
||||
:Imports: :doc:`base/frameworks/reporter </scripts/base/frameworks/reporter/index>`, :doc:`base/utils/strings.bro </scripts/base/utils/strings.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Constants
|
||||
#########
|
||||
================================================================ ===================================================================================
|
||||
:bro:id:`Version::info`: :bro:type:`Version::VersionDescription` `VersionDescription` record pertaining to the currently running version of Bro.
|
||||
:bro:id:`Version::number`: :bro:type:`count` version number of the currently running version of Bro as a numeric representation.
|
||||
================================================================ ===================================================================================
|
||||
|
||||
Types
|
||||
#####
|
||||
=========================================================== =======================================
|
||||
:bro:type:`Version::VersionDescription`: :bro:type:`record` A type exactly describing a Bro version
|
||||
=========================================================== =======================================
|
||||
|
||||
Functions
|
||||
#########
|
||||
================================================= ===================================================================================
|
||||
:bro:id:`Version::at_least`: :bro:type:`function` Test if the current running version of Bro is greater or equal to the given version
|
||||
string.
|
||||
:bro:id:`Version::parse`: :bro:type:`function` Parse a given version string.
|
||||
================================================= ===================================================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Constants
|
||||
#########
|
||||
.. bro:id:: Version::info
|
||||
|
||||
:Type: :bro:type:`Version::VersionDescription`
|
||||
:Default:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
version_number=20600
|
||||
major=2
|
||||
minor=6
|
||||
patch=0
|
||||
commit=27
|
||||
beta=F
|
||||
debug=T
|
||||
version_string="2.6-27-debug"
|
||||
}
|
||||
|
||||
`VersionDescription` record pertaining to the currently running version of Bro.
|
||||
|
||||
.. bro:id:: Version::number
|
||||
|
||||
:Type: :bro:type:`count`
|
||||
:Default: ``20600``
|
||||
|
||||
version number of the currently running version of Bro as a numeric representation.
|
||||
The format of the number is ABBCC with A being the major version,
|
||||
bb being the minor version (2 digits) and CC being the patchlevel (2 digits).
|
||||
As an example, Bro 2.4.1 results in the number 20401
|
||||
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: Version::VersionDescription
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
version_number: :bro:type:`count`
|
||||
Number representing the version which can be used for easy comparison.
|
||||
The format of the number is ABBCC with A being the major version,
|
||||
bb being the minor version (2 digits) and CC being the patchlevel (2 digits).
|
||||
As an example, Bro 2.4.1 results in the number 20401.
|
||||
|
||||
major: :bro:type:`count`
|
||||
Major version number (e.g. 2 for 2.5)
|
||||
|
||||
minor: :bro:type:`count`
|
||||
Minor version number (e.g. 5 for 2.5)
|
||||
|
||||
patch: :bro:type:`count`
|
||||
Patch version number (e.g. 0 for 2.5 or 1 for 2.4.1)
|
||||
|
||||
commit: :bro:type:`count`
|
||||
Commit number for development versions, e.g. 12 for 2.4-12. 0 for non-development versions
|
||||
|
||||
beta: :bro:type:`bool`
|
||||
If set to true, the version is a beta build of Bro
|
||||
|
||||
debug: :bro:type:`bool`
|
||||
If set to true, the version is a debug build
|
||||
|
||||
version_string: :bro:type:`string`
|
||||
String representation of this version
|
||||
|
||||
A type exactly describing a Bro version
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: Version::at_least
|
||||
|
||||
:Type: :bro:type:`function` (version_string: :bro:type:`string`) : :bro:type:`bool`
|
||||
|
||||
Test if the current running version of Bro is greater or equal to the given version
|
||||
string.
|
||||
|
||||
|
||||
:version_string: Version to check against the current running version.
|
||||
|
||||
|
||||
:returns: True if running version greater or equal to the given version.
|
||||
|
||||
.. bro:id:: Version::parse
|
||||
|
||||
:Type: :bro:type:`function` (version_string: :bro:type:`string`) : :bro:type:`Version::VersionDescription`
|
||||
|
||||
Parse a given version string.
|
||||
|
||||
|
||||
:version_string: Bro version string.
|
||||
|
||||
|
||||
:returns: `VersionDescription` record.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue