zeek/doc/scripts/policy/frameworks/dpd/packet-segment-logging.zeek.rst
Patrick Kelley 8fd444092b initial
2025-05-07 15:35:15 -04:00

50 lines
2.0 KiB
ReStructuredText

:tocdepth: 3
policy/frameworks/dpd/packet-segment-logging.zeek
=================================================
.. zeek: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 :zeek: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
Summary
~~~~~~~
Runtime Options
###############
========================================================================= =====================================================
:zeek:id:`DPD::packet_segment_size`: :zeek:type:`int` :zeek:attr:`&redef` Size of the packet segment to display in the DPD log.
========================================================================= =====================================================
Redefinitions
#############
=========================================== ==============================================================================
:zeek:type:`DPD::Info`: :zeek:type:`record`
:New Fields: :zeek:type:`DPD::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.
=========================================== ==============================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Runtime Options
###############
.. zeek:id:: DPD::packet_segment_size
:source-code: policy/frameworks/dpd/packet-segment-logging.zeek 17 17
:Type: :zeek:type:`int`
:Attributes: :zeek:attr:`&redef`
:Default: ``255``
Size of the packet segment to display in the DPD log.