mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 23:28:20 +00:00
7e9d48f532
The broxygen-generated files now live in the git repo, have tests that check that they are up-to-date, and a script to re-generate them on-demand.
73 lines
2.2 KiB
ReStructuredText
73 lines
2.2 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/protocols/modbus/main.bro
|
|
==============================
|
|
.. bro:namespace:: Modbus
|
|
|
|
Base Modbus analysis script.
|
|
|
|
:Namespace: Modbus
|
|
:Imports: :doc:`base/protocols/modbus/consts.bro </scripts/base/protocols/modbus/consts.bro>`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Types
|
|
#####
|
|
============================================ =
|
|
:bro:type:`Modbus::Info`: :bro:type:`record`
|
|
============================================ =
|
|
|
|
Redefinitions
|
|
#############
|
|
================================================================= =
|
|
:bro:type:`Log::ID`: :bro:type:`enum`
|
|
:bro:type:`connection`: :bro:type:`record`
|
|
:bro:id:`likely_server_ports`: :bro:type:`set` :bro:attr:`&redef`
|
|
================================================================= =
|
|
|
|
Events
|
|
######
|
|
=============================================== ===================================================================
|
|
:bro:id:`Modbus::log_modbus`: :bro:type:`event` Event that can be handled to access the Modbus record as it is sent
|
|
on to the logging framework.
|
|
=============================================== ===================================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Types
|
|
#####
|
|
.. bro:type:: Modbus::Info
|
|
|
|
:Type: :bro:type:`record`
|
|
|
|
ts: :bro:type:`time` :bro:attr:`&log`
|
|
Time of the request.
|
|
|
|
uid: :bro:type:`string` :bro:attr:`&log`
|
|
Unique identifier for the connection.
|
|
|
|
id: :bro:type:`conn_id` :bro:attr:`&log`
|
|
Identifier for the connection.
|
|
|
|
func: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
|
The name of the function message that was sent.
|
|
|
|
exception: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
|
The exception if the response was a failure.
|
|
|
|
track_address: :bro:type:`count` :bro:attr:`&default` = ``0`` :bro:attr:`&optional`
|
|
(present if :doc:`/scripts/policy/protocols/modbus/track-memmap.bro` is loaded)
|
|
|
|
|
|
|
|
Events
|
|
######
|
|
.. bro:id:: Modbus::log_modbus
|
|
|
|
:Type: :bro:type:`event` (rec: :bro:type:`Modbus::Info`)
|
|
|
|
Event that can be handled to access the Modbus record as it is sent
|
|
on to the logging framework.
|
|
|
|
|