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

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/dnp3/__load__.bro.rst
View file

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

73
doc/scripts/base/protocols/dnp3/consts.bro.rst
View file

@ -1,73 +0,0 @@
:tocdepth: 3
base/protocols/dnp3/consts.bro
==============================
.. bro:namespace:: DNP3
:Namespace: DNP3
Summary
~~~~~~~
Redefinable Options
###################
====================================================================================================================================== =======================================
:bro:id:`DNP3::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:: DNP3::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] = "WRITE",
[9] = "FREEZE_CLEAR",
[17] = "START_APPL",
[27] = "DELETE_FILE",
[6] = "DIRECT_OPERATE_NR",
[11] = "FREEZE_AT_TIME",
[14] = "WARM_RESTART",
[4] = "OPERATE",
[22] = "ASSIGN_CLASS",
[24] = "RECORD_CURRENT_TIME",
[30] = "ABORT_FILE",
[1] = "READ",
[8] = "IMMED_FREEZE_NR",
[7] = "IMMED_FREEZE",
[15] = "INITIALIZE_DATA",
[131] = "AUTHENTICATE_RESP",
[23] = "DELAY_MEASURE",
[33] = "AUTHENTICATE_REQ_NR",
[29] = "AUTHENTICATE_FILE",
[130] = "UNSOLICITED_RESPONSE",
[5] = "DIRECT_OPERATE",
[25] = "OPEN_FILE",
[32] = "AUTHENTICATE_REQ",
[19] = "SAVE_CONFIG",
[28] = "GET_FILE_INFO",
[31] = "ACTIVATE_CONFIG",
[10] = "FREEZE_CLEAR_NR",
[129] = "RESPONSE",
[0] = "CONFIRM",
[3] = "SELECT",
[12] = "FREEZE_AT_TIME_NR",
[13] = "COLD_RESTART",
[18] = "STOP_APPL",
[21] = "DISABLE_UNSOLICITED",
[16] = "INITIALIZE_APPL",
[20] = "ENABLE_UNSOLICITED",
[26] = "CLOSE_FILE"
}
Standard defined Modbus function codes.

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

@ -1,17 +0,0 @@
:orphan:
Package: base/protocols/dnp3
============================
Support for Distributed Network Protocol (DNP3) analysis.
:doc:`/scripts/base/protocols/dnp3/__load__.bro`
:doc:`/scripts/base/protocols/dnp3/main.bro`
A very basic DNP3 analysis script that just logs requests and replies.
:doc:`/scripts/base/protocols/dnp3/consts.bro`

72
doc/scripts/base/protocols/dnp3/main.bro.rst
View file

@ -1,72 +0,0 @@
:tocdepth: 3
base/protocols/dnp3/main.bro
============================
.. bro:namespace:: DNP3
A very basic DNP3 analysis script that just logs requests and replies.
:Namespace: DNP3
:Imports: :doc:`base/protocols/dnp3/consts.bro </scripts/base/protocols/dnp3/consts.bro>`
Summary
~~~~~~~
Types
#####
========================================== =
:bro:type:`DNP3::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:`DNP3::log_dnp3`: :bro:type:`event` Event that can be handled to access the DNP3 record as it is sent on
to the logging framework.
=========================================== ====================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Types
#####
.. bro:type:: DNP3::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.
fc_request: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
The name of the function message in the request.
fc_reply: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
The name of the function message in the reply.
iin: :bro:type:`count` :bro:attr:`&log` :bro:attr:`&optional`
The response's "internal indication number".
Events
######
.. bro:id:: DNP3::log_dnp3
:Type: :bro:type:`event` (rec: :bro:type:`DNP3::Info`)
Event that can be handled to access the DNP3 record as it is sent on
to the logging framework.