Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-17 14:08:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Copy docs into Zeek repo directly

Browse source 
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
This commit is contained in:
Tim Wojtulewicz 2025-09-15 15:52:18 -07:00
parent 83f1e74643
commit ded98cd373
1074 changed files with 169319 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

56
doc/scripts/policy/frameworks/analyzer/packet-segment-logging.zeek.rst Normal file
View file

@ -0,0 +1,56 @@
:tocdepth: 3
policy/frameworks/analyzer/packet-segment-logging.zeek
======================================================
.. zeek:namespace:: Analyzer::Logging
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 :zeek:see:`Analyzer::Logging::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: Analyzer::Logging
Summary
~~~~~~~
Runtime Options
###############
======================================================================================= =====================================================
:zeek:id:`Analyzer::Logging::packet_segment_size`: :zeek:type:`int` :zeek:attr:`&redef` Size of the packet segment to display in the DPD log.
======================================================================================= =====================================================
Redefinitions
#############
========================================================= ==============================================================================
:zeek:type:`Analyzer::Logging::Info`: :zeek:type:`record`
:New Fields: :zeek:type:`Analyzer::Logging::Info`
packet_segment: :zeek:type:`string` :zeek:attr:`&optional` :zeek:attr:`&log`
A chunk of the payload that most likely resulted in the
analyzer violation.
:zeek:type:`connection`: :zeek:type:`record`
:New Fields: :zeek:type:`connection`
packet_segment: :zeek:type:`string` :zeek:attr:`&optional` :zeek:attr:`&log`
A chunk of the payload that most likely resulted in a
analyzer violation.
========================================================= ==============================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Runtime Options
###############
.. zeek:id:: Analyzer::Logging::packet_segment_size
:source-code: policy/frameworks/analyzer/packet-segment-logging.zeek 23 23
:Type: :zeek:type:`int`
:Attributes: :zeek:attr:`&redef`
:Default: ``255``
Size of the packet segment to display in the DPD log.