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

Change doc/ subdir into a git submodule

Browse source 
The docs now live at https://github.com/zeek/zeek-docs
This commit is contained in:
Jon Siwek 2019-01-17 14:09:29 -06:00
parent 0d685efbf5
commit 2ff746fea7
693 changed files with 26 additions and 105609 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/scripts/base/protocols/modbus/__load__.bro.rst
View file

@ -1,14 +0,0 @@
:tocdepth: 3
base/protocols/modbus/__load__.bro
==================================
:Imports: :doc:`base/protocols/modbus/consts.bro </scripts/base/protocols/modbus/consts.bro>`, :doc:`base/protocols/modbus/main.bro </scripts/base/protocols/modbus/main.bro>`
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

101
doc/scripts/base/protocols/modbus/consts.bro.rst
View file

@ -1,101 +0,0 @@
:tocdepth: 3
base/protocols/modbus/consts.bro
================================
.. bro:namespace:: Modbus
:Namespace: Modbus
Summary
~~~~~~~
Redefinable Options
###################
========================================================================================================================================= =======================================
:bro:id:`Modbus::exception_codes`: :bro:type:`table` :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional` :bro:attr:`&redef`
:bro:id:`Modbus::function_codes`: :bro:type:`table` :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional` :bro:attr:`&redef` Standard defined Modbus function codes.
========================================================================================================================================= =======================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. bro:id:: Modbus::exception_codes
:Type: :bro:type:`table` [:bro:type:`count`] of :bro:type:`string`
:Attributes: :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional` :bro:attr:`&redef`
:Default:
::
{
[2] = "ILLEGAL_DATA_ADDRESS",
[6] = "SLAVE_DEVICE_BUSY",
[11] = "GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND",
[4] = "SLAVE_DEVICE_FAILURE",
[1] = "ILLEGAL_FUNCTION",
[8] = "MEMORY_PARITY_ERROR",
[5] = "ACKNOWLEDGE",
[10] = "GATEWAY_PATH_UNAVAILABLE",
[3] = "ILLEGAL_DATA_VALUE"
}
.. bro:id:: Modbus::function_codes
:Type: :bro:type:`table` [:bro:type:`count`] of :bro:type:`string`
:Attributes: :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional` :bro:attr:`&redef`
:Default:
::
{
[2] = "READ_DISCRETE_INPUTS",
[17] = "REPORT_SLAVE_ID",
[9] = "PROGRAM_484",
[126] = "PROGRAM_584_984_2",
[143] = "WRITE_MULTIPLE_COILS_EXCEPTION",
[152] = "READ_FIFO_QUEUE_EXCEPTION",
[6] = "WRITE_SINGLE_REGISTER",
[11] = "GET_COMM_EVENT_COUNTER",
[14] = "POLL_584_984",
[4] = "READ_INPUT_REGISTERS",
[22] = "MASK_WRITE_REGISTER",
[24] = "READ_FIFO_QUEUE",
[144] = "WRITE_MULTIPLE_REGISTERS_EXCEPTION",
[1] = "READ_COILS",
[8] = "DIAGNOSTICS",
[7] = "READ_EXCEPTION_STATUS",
[15] = "WRITE_MULTIPLE_COILS",
[131] = "READ_HOLDING_REGISTERS_EXCEPTION",
[23] = "READ_WRITE_MULTIPLE_REGISTERS",
[43] = "ENCAP_INTERFACE_TRANSPORT",
[127] = "REPORT_LOCAL_ADDRESS",
[133] = "WRITE_SINGLE_COIL_EXCEPTION",
[134] = "WRITE_SINGLE_REGISTER_EXCEPTION",
[130] = "READ_DISCRETE_INPUTS_EXCEPTION",
[149] = "WRITE_FILE_RECORD_EXCEPTION",
[5] = "WRITE_SINGLE_COIL",
[19] = "RESET_COMM_LINK_884_U84",
[125] = "FIRMWARE_REPLACEMENT",
[132] = "READ_INPUT_REGISTERS_EXCEPTION",
[10] = "POLL_484",
[129] = "READ_COILS_EXCEPTION",
[150] = "MASK_WRITE_REGISTER_EXCEPTION",
[3] = "READ_HOLDING_REGISTERS",
[12] = "GET_COMM_EVENT_LOG",
[21] = "WRITE_FILE_RECORD",
[13] = "PROGRAM_584_984",
[18] = "PROGRAM_884_U84",
[148] = "READ_FILE_RECORD_EXCEPTION",
[151] = "READ_WRITE_MULTIPLE_REGISTERS_EXCEPTION",
[16] = "WRITE_MULTIPLE_REGISTERS",
[20] = "READ_FILE_RECORD",
[40] = "PROGRAM_CONCEPT",
[135] = "READ_EXCEPTION_STATUS_EXCEPTION"
}
Standard defined Modbus function codes.

17
doc/scripts/base/protocols/modbus/index.rst
View file

@ -1,17 +0,0 @@
:orphan:
Package: base/protocols/modbus
==============================
Support for Modbus protocol analysis.
:doc:`/scripts/base/protocols/modbus/__load__.bro`
:doc:`/scripts/base/protocols/modbus/consts.bro`
:doc:`/scripts/base/protocols/modbus/main.bro`
Base Modbus analysis script.

73
doc/scripts/base/protocols/modbus/main.bro.rst
View file

@ -1,73 +0,0 @@
: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.