mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 15:18:20 +00:00
ded98cd373
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
122 lines
3.8 KiB
ReStructuredText
122 lines
3.8 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/protocols/modbus/main.zeek
|
|
===============================
|
|
.. zeek:namespace:: Modbus
|
|
|
|
Base Modbus analysis script.
|
|
|
|
:Namespace: Modbus
|
|
:Imports: :doc:`base/protocols/modbus/consts.zeek </scripts/base/protocols/modbus/consts.zeek>`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Types
|
|
#####
|
|
============================================== =
|
|
:zeek:type:`Modbus::Info`: :zeek:type:`record`
|
|
============================================== =
|
|
|
|
Redefinitions
|
|
#############
|
|
==================================================================== ==========================================================
|
|
:zeek:type:`Log::ID`: :zeek:type:`enum`
|
|
|
|
* :zeek:enum:`Modbus::LOG`
|
|
:zeek:type:`connection`: :zeek:type:`record`
|
|
|
|
:New Fields: :zeek:type:`connection`
|
|
|
|
modbus: :zeek:type:`Modbus::Info` :zeek:attr:`&optional`
|
|
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
|
|
==================================================================== ==========================================================
|
|
|
|
Events
|
|
######
|
|
================================================= ===================================================================
|
|
:zeek:id:`Modbus::log_modbus`: :zeek:type:`event` Event that can be handled to access the Modbus record as it is sent
|
|
on to the logging framework.
|
|
================================================= ===================================================================
|
|
|
|
Hooks
|
|
#####
|
|
=========================================================== =
|
|
:zeek:id:`Modbus::log_policy`: :zeek:type:`Log::PolicyHook`
|
|
=========================================================== =
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Types
|
|
#####
|
|
.. zeek:type:: Modbus::Info
|
|
:source-code: base/protocols/modbus/main.zeek 12 29
|
|
|
|
:Type: :zeek:type:`record`
|
|
|
|
|
|
.. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
|
|
|
|
Time of the request.
|
|
|
|
|
|
.. zeek:field:: uid :zeek:type:`string` :zeek:attr:`&log`
|
|
|
|
Unique identifier for the connection.
|
|
|
|
|
|
.. zeek:field:: id :zeek:type:`conn_id` :zeek:attr:`&log`
|
|
|
|
Identifier for the connection.
|
|
|
|
|
|
.. zeek:field:: tid :zeek:type:`count` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
Modbus transaction ID
|
|
|
|
|
|
.. zeek:field:: unit :zeek:type:`count` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
The terminal unit identifier for the message
|
|
|
|
|
|
.. zeek:field:: func :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
The name of the function message that was sent.
|
|
|
|
|
|
.. zeek:field:: pdu_type :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
Whether this PDU was a response ("RESP") or request ("REQ")
|
|
|
|
|
|
.. zeek:field:: exception :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
The exception if the response was a failure.
|
|
|
|
|
|
.. zeek:field:: track_address :zeek:type:`count` :zeek:attr:`&default` = ``0`` :zeek:attr:`&optional`
|
|
|
|
(present if :doc:`/scripts/policy/protocols/modbus/track-memmap.zeek` is loaded)
|
|
|
|
|
|
|
|
Events
|
|
######
|
|
.. zeek:id:: Modbus::log_modbus
|
|
:source-code: base/protocols/modbus/main.zeek 33 33
|
|
|
|
:Type: :zeek:type:`event` (rec: :zeek:type:`Modbus::Info`)
|
|
|
|
Event that can be handled to access the Modbus record as it is sent
|
|
on to the logging framework.
|
|
|
|
Hooks
|
|
#####
|
|
.. zeek:id:: Modbus::log_policy
|
|
:source-code: base/protocols/modbus/main.zeek 10 10
|
|
|
|
:Type: :zeek:type:`Log::PolicyHook`
|
|
|
|
|
|
|