mirror of
https://github.com/zeek/zeek.git
synced 2025-10-12 19:48:20 +00:00
Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
This commit is contained in:
parent
83f1e74643
commit
ded98cd373
1074 changed files with 169319 additions and 0 deletions
14
doc/scripts/policy/misc/detect-traceroute/__load__.zeek.rst
Normal file
14
doc/scripts/policy/misc/detect-traceroute/__load__.zeek.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
policy/misc/detect-traceroute/__load__.zeek
|
||||
===========================================
|
||||
|
||||
|
||||
:Imports: :doc:`policy/misc/detect-traceroute/main.zeek </scripts/policy/misc/detect-traceroute/main.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
17
doc/scripts/policy/misc/detect-traceroute/index.rst
Normal file
17
doc/scripts/policy/misc/detect-traceroute/index.rst
Normal file
|
@ -0,0 +1,17 @@
|
|||
:orphan:
|
||||
|
||||
Package: policy/misc/detect-traceroute
|
||||
======================================
|
||||
|
||||
Detect hosts that are running traceroute.
|
||||
|
||||
:doc:`/scripts/policy/misc/detect-traceroute/__load__.zeek`
|
||||
|
||||
|
||||
:doc:`/scripts/policy/misc/detect-traceroute/main.zeek`
|
||||
|
||||
This script detects a large number of ICMP Time Exceeded messages heading
|
||||
toward hosts that have sent low TTL packets. It generates a notice when the
|
||||
number of ICMP Time Exceeded messages for a source-destination pair exceeds
|
||||
a threshold.
|
||||
|
147
doc/scripts/policy/misc/detect-traceroute/main.zeek.rst
Normal file
147
doc/scripts/policy/misc/detect-traceroute/main.zeek.rst
Normal file
|
@ -0,0 +1,147 @@
|
|||
:tocdepth: 3
|
||||
|
||||
policy/misc/detect-traceroute/main.zeek
|
||||
=======================================
|
||||
.. zeek:namespace:: Traceroute
|
||||
|
||||
This script detects a large number of ICMP Time Exceeded messages heading
|
||||
toward hosts that have sent low TTL packets. It generates a notice when the
|
||||
number of ICMP Time Exceeded messages for a source-destination pair exceeds
|
||||
a threshold.
|
||||
|
||||
:Namespace: Traceroute
|
||||
:Imports: :doc:`base/frameworks/signatures </scripts/base/frameworks/signatures/index>`, :doc:`base/frameworks/sumstats </scripts/base/frameworks/sumstats/index>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
============================================================================================= ===================================================================
|
||||
:zeek:id:`Traceroute::icmp_time_exceeded_interval`: :zeek:type:`interval` :zeek:attr:`&redef` Interval at which to watch for the
|
||||
:zeek:id:`Traceroute::icmp_time_exceeded_threshold` variable to be
|
||||
crossed.
|
||||
:zeek:id:`Traceroute::icmp_time_exceeded_threshold`: :zeek:type:`double` :zeek:attr:`&redef` Defines the threshold for ICMP Time Exceeded messages for a src-dst
|
||||
pair.
|
||||
:zeek:id:`Traceroute::require_low_ttl_packets`: :zeek:type:`bool` :zeek:attr:`&redef` By default this script requires that any host detected running
|
||||
traceroutes first send low TTL packets (TTL < 10) to the traceroute
|
||||
destination host.
|
||||
============================================================================================= ===================================================================
|
||||
|
||||
Types
|
||||
#####
|
||||
================================================== ======================================
|
||||
:zeek:type:`Traceroute::Info`: :zeek:type:`record` The log record for the traceroute log.
|
||||
================================================== ======================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
============================================================================ =====================================================
|
||||
:zeek:type:`Log::ID`: :zeek:type:`enum`
|
||||
|
||||
* :zeek:enum:`Traceroute::LOG`
|
||||
:zeek:type:`Notice::Type`: :zeek:type:`enum`
|
||||
|
||||
* :zeek:enum:`Traceroute::Detected`:
|
||||
Indicates that a host was seen running traceroutes.
|
||||
:zeek:id:`Signatures::ignored_ids`: :zeek:type:`pattern` :zeek:attr:`&redef`
|
||||
============================================================================ =====================================================
|
||||
|
||||
Events
|
||||
######
|
||||
========================================================= =
|
||||
:zeek:id:`Traceroute::log_traceroute`: :zeek:type:`event`
|
||||
========================================================= =
|
||||
|
||||
Hooks
|
||||
#####
|
||||
=============================================================== =
|
||||
:zeek:id:`Traceroute::log_policy`: :zeek:type:`Log::PolicyHook`
|
||||
=============================================================== =
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. zeek:id:: Traceroute::icmp_time_exceeded_interval
|
||||
:source-code: policy/misc/detect-traceroute/main.zeek 41 41
|
||||
|
||||
:Type: :zeek:type:`interval`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``3.0 mins``
|
||||
|
||||
Interval at which to watch for the
|
||||
:zeek:id:`Traceroute::icmp_time_exceeded_threshold` variable to be
|
||||
crossed. At the end of each interval the counter is reset.
|
||||
|
||||
.. zeek:id:: Traceroute::icmp_time_exceeded_threshold
|
||||
:source-code: policy/misc/detect-traceroute/main.zeek 36 36
|
||||
|
||||
:Type: :zeek:type:`double`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``3.0``
|
||||
|
||||
Defines the threshold for ICMP Time Exceeded messages for a src-dst
|
||||
pair. This threshold only comes into play after a host is found to
|
||||
be sending low TTL packets.
|
||||
|
||||
.. zeek:id:: Traceroute::require_low_ttl_packets
|
||||
:source-code: policy/misc/detect-traceroute/main.zeek 31 31
|
||||
|
||||
:Type: :zeek:type:`bool`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``T``
|
||||
|
||||
By default this script requires that any host detected running
|
||||
traceroutes first send low TTL packets (TTL < 10) to the traceroute
|
||||
destination host. Changing this setting to F will relax the
|
||||
detection a bit by solely relying on ICMP time-exceeded messages to
|
||||
detect traceroute.
|
||||
|
||||
Types
|
||||
#####
|
||||
.. zeek:type:: Traceroute::Info
|
||||
:source-code: policy/misc/detect-traceroute/main.zeek 44 53
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
||||
.. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
|
||||
|
||||
Timestamp
|
||||
|
||||
|
||||
.. zeek:field:: src :zeek:type:`addr` :zeek:attr:`&log`
|
||||
|
||||
Address initiating the traceroute.
|
||||
|
||||
|
||||
.. zeek:field:: dst :zeek:type:`addr` :zeek:attr:`&log`
|
||||
|
||||
Destination address of the traceroute.
|
||||
|
||||
|
||||
.. zeek:field:: proto :zeek:type:`string` :zeek:attr:`&log`
|
||||
|
||||
Protocol used for the traceroute.
|
||||
|
||||
|
||||
The log record for the traceroute log.
|
||||
|
||||
Events
|
||||
######
|
||||
.. zeek:id:: Traceroute::log_traceroute
|
||||
:source-code: policy/misc/detect-traceroute/main.zeek 55 55
|
||||
|
||||
:Type: :zeek:type:`event` (rec: :zeek:type:`Traceroute::Info`)
|
||||
|
||||
|
||||
Hooks
|
||||
#####
|
||||
.. zeek:id:: Traceroute::log_policy
|
||||
:source-code: policy/misc/detect-traceroute/main.zeek 17 17
|
||||
|
||||
:Type: :zeek:type:`Log::PolicyHook`
|
||||
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue