mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 23:28:20 +00:00
ded98cd373
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
170 lines
5.8 KiB
ReStructuredText
170 lines
5.8 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
policy/protocols/modbus/track-memmap.zeek
|
|
=========================================
|
|
.. zeek:namespace:: Modbus
|
|
|
|
This script tracks the memory map of holding (read/write) registers and logs
|
|
changes as they are discovered.
|
|
|
|
.. todo:: Not all register read and write functions are supported yet.
|
|
|
|
:Namespace: Modbus
|
|
:Imports: :doc:`base/protocols/modbus </scripts/base/protocols/modbus/index>`, :doc:`base/utils/directions-and-hosts.zeek </scripts/base/utils/directions-and-hosts.zeek>`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Runtime Options
|
|
###############
|
|
====================================================================== ==================================================
|
|
:zeek:id:`Modbus::track_memmap`: :zeek:type:`Host` :zeek:attr:`&redef` The hosts that should have memory mapping enabled.
|
|
====================================================================== ==================================================
|
|
|
|
State Variables
|
|
###############
|
|
======================================================= =======================================================
|
|
:zeek:id:`Modbus::device_registers`: :zeek:type:`table` The memory map of slaves is tracked with this variable.
|
|
======================================================= =======================================================
|
|
|
|
Types
|
|
#####
|
|
======================================================= =====================================================================
|
|
:zeek:type:`Modbus::MemmapInfo`: :zeek:type:`record`
|
|
:zeek:type:`Modbus::RegisterValue`: :zeek:type:`record`
|
|
:zeek:type:`Modbus::Registers`: :zeek:type:`table` Indexed on the device register value and yielding the register value.
|
|
======================================================= =====================================================================
|
|
|
|
Redefinitions
|
|
#############
|
|
============================================== ========================================================================================
|
|
:zeek:type:`Log::ID`: :zeek:type:`enum`
|
|
|
|
* :zeek:enum:`Modbus::REGISTER_CHANGE_LOG`
|
|
:zeek:type:`Modbus::Info`: :zeek:type:`record`
|
|
|
|
:New Fields: :zeek:type:`Modbus::Info`
|
|
|
|
track_address: :zeek:type:`count` :zeek:attr:`&default` = ``0`` :zeek:attr:`&optional`
|
|
============================================== ========================================================================================
|
|
|
|
Events
|
|
######
|
|
======================================================= =====================================================================
|
|
:zeek:id:`Modbus::changed_register`: :zeek:type:`event` This event is generated every time a register is seen to be different
|
|
than it was previously seen to be.
|
|
======================================================= =====================================================================
|
|
|
|
Hooks
|
|
#####
|
|
=========================================================================== =
|
|
:zeek:id:`Modbus::log_policy_register_change`: :zeek:type:`Log::PolicyHook`
|
|
=========================================================================== =
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Runtime Options
|
|
###############
|
|
.. zeek:id:: Modbus::track_memmap
|
|
:source-code: policy/protocols/modbus/track-memmap.zeek 17 17
|
|
|
|
:Type: :zeek:type:`Host`
|
|
:Attributes: :zeek:attr:`&redef`
|
|
:Default: ``ALL_HOSTS``
|
|
|
|
The hosts that should have memory mapping enabled.
|
|
|
|
State Variables
|
|
###############
|
|
.. zeek:id:: Modbus::device_registers
|
|
:source-code: policy/protocols/modbus/track-memmap.zeek 46 46
|
|
|
|
:Type: :zeek:type:`table` [:zeek:type:`addr`] of :zeek:type:`Modbus::Registers`
|
|
:Default: ``{}``
|
|
|
|
The memory map of slaves is tracked with this variable.
|
|
|
|
Types
|
|
#####
|
|
.. zeek:type:: Modbus::MemmapInfo
|
|
:source-code: policy/protocols/modbus/track-memmap.zeek 19 35
|
|
|
|
:Type: :zeek:type:`record`
|
|
|
|
|
|
.. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
|
|
|
|
Timestamp for the detected register change.
|
|
|
|
|
|
.. zeek:field:: uid :zeek:type:`string` :zeek:attr:`&log`
|
|
|
|
Unique ID for the connection.
|
|
|
|
|
|
.. zeek:field:: id :zeek:type:`conn_id` :zeek:attr:`&log`
|
|
|
|
Connection ID.
|
|
|
|
|
|
.. zeek:field:: register :zeek:type:`count` :zeek:attr:`&log`
|
|
|
|
The device memory offset.
|
|
|
|
|
|
.. zeek:field:: old_val :zeek:type:`count` :zeek:attr:`&log`
|
|
|
|
The old value stored in the register.
|
|
|
|
|
|
.. zeek:field:: new_val :zeek:type:`count` :zeek:attr:`&log`
|
|
|
|
The new value stored in the register.
|
|
|
|
|
|
.. zeek:field:: delta :zeek:type:`interval` :zeek:attr:`&log`
|
|
|
|
The time delta between when the *old_val* and *new_val* were
|
|
seen.
|
|
|
|
|
|
|
|
.. zeek:type:: Modbus::RegisterValue
|
|
:source-code: policy/protocols/modbus/track-memmap.zeek 37 40
|
|
|
|
:Type: :zeek:type:`record`
|
|
|
|
|
|
.. zeek:field:: last_set :zeek:type:`time`
|
|
|
|
|
|
.. zeek:field:: value :zeek:type:`count`
|
|
|
|
|
|
|
|
.. zeek:type:: Modbus::Registers
|
|
:source-code: policy/protocols/modbus/track-memmap.zeek 43 43
|
|
|
|
:Type: :zeek:type:`table` [:zeek:type:`count`] of :zeek:type:`Modbus::RegisterValue`
|
|
|
|
Indexed on the device register value and yielding the register value.
|
|
|
|
Events
|
|
######
|
|
.. zeek:id:: Modbus::changed_register
|
|
:source-code: policy/protocols/modbus/track-memmap.zeek 103 108
|
|
|
|
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, register: :zeek:type:`count`, old_val: :zeek:type:`count`, new_val: :zeek:type:`count`, delta: :zeek:type:`interval`)
|
|
|
|
This event is generated every time a register is seen to be different
|
|
than it was previously seen to be.
|
|
|
|
Hooks
|
|
#####
|
|
.. zeek:id:: Modbus::log_policy_register_change
|
|
:source-code: policy/protocols/modbus/track-memmap.zeek 14 14
|
|
|
|
:Type: :zeek:type:`Log::PolicyHook`
|
|
|
|
|
|
|