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

Remove broxygen Sphinx integration

Browse source 
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.
This commit is contained in:
Jon Siwek 2018-12-17 16:25:41 -06:00
parent 9e5e9d04b7
commit 7e9d48f532
549 changed files with 89909 additions and 100 deletions
Download patch file Download diff file Expand all files Collapse all files

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

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

29
doc/scripts/base/protocols/irc/dcc-send.bro.rst Normal file
View file

@ -0,0 +1,29 @@
:tocdepth: 3
base/protocols/irc/dcc-send.bro
===============================
.. bro:namespace:: IRC
File extraction and introspection for DCC transfers over IRC.
There is a major problem with this script in the cluster context because
we might see A send B a message that a DCC connection is to be expected,
but that connection will actually be between B and C which could be
analyzed on a different worker.
:Namespace: IRC
:Imports: :doc:`base/frameworks/cluster </scripts/base/frameworks/cluster/index>`, :doc:`base/protocols/irc/main.bro </scripts/base/protocols/irc/main.bro>`, :doc:`base/utils/files.bro </scripts/base/utils/files.bro>`
Summary
~~~~~~~
Redefinitions
#############
========================================= =
:bro:type:`IRC::Info`: :bro:type:`record`
========================================= =
Detailed Interface
~~~~~~~~~~~~~~~~~~

37
doc/scripts/base/protocols/irc/files.bro.rst Normal file
View file

@ -0,0 +1,37 @@
:tocdepth: 3
base/protocols/irc/files.bro
============================
.. bro:namespace:: IRC
:Namespace: IRC
:Imports: :doc:`base/frameworks/files </scripts/base/frameworks/files/index>`, :doc:`base/protocols/irc/dcc-send.bro </scripts/base/protocols/irc/dcc-send.bro>`, :doc:`base/utils/conn-ids.bro </scripts/base/utils/conn-ids.bro>`
Summary
~~~~~~~
Redefinitions
#############
========================================================== =
:bro:type:`IRC::Info`: :bro:type:`record`
:bro:type:`fa_file`: :bro:type:`record` :bro:attr:`&redef`
========================================================== =
Functions
#########
==================================================== =====================================
:bro:id:`IRC::get_file_handle`: :bro:type:`function` Default file handle provider for IRC.
==================================================== =====================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. bro:id:: IRC::get_file_handle
:Type: :bro:type:`function` (c: :bro:type:`connection`, is_orig: :bro:type:`bool`) : :bro:type:`string`
Default file handle provider for IRC.

29
doc/scripts/base/protocols/irc/index.rst Normal file
View file

@ -0,0 +1,29 @@
:orphan:
Package: base/protocols/irc
===========================
Support for Internet Relay Chat (IRC) protocol analysis.
:doc:`/scripts/base/protocols/irc/__load__.bro`
:doc:`/scripts/base/protocols/irc/main.bro`
Implements the core IRC analysis support. The logging model is to log
IRC commands along with the associated response and some additional
metadata about the connection if it's available.
:doc:`/scripts/base/protocols/irc/dcc-send.bro`
File extraction and introspection for DCC transfers over IRC.
There is a major problem with this script in the cluster context because
we might see A send B a message that a DCC connection is to be expected,
but that connection will actually be between B and C which could be
analyzed on a different worker.
:doc:`/scripts/base/protocols/irc/files.bro`

99
doc/scripts/base/protocols/irc/main.bro.rst Normal file
View file

@ -0,0 +1,99 @@
:tocdepth: 3
base/protocols/irc/main.bro
===========================
.. bro:namespace:: IRC
Implements the core IRC analysis support. The logging model is to log
IRC commands along with the associated response and some additional
metadata about the connection if it's available.
:Namespace: IRC
Summary
~~~~~~~
Types
#####
========================================= =
:bro:type:`IRC::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:`IRC::irc_log`: :bro:type:`event` Event that can be handled to access the IRC record as it is sent on
to the logging framework.
========================================= ====================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Types
#####
.. bro:type:: IRC::Info
:Type: :bro:type:`record`
ts: :bro:type:`time` :bro:attr:`&log`
Timestamp when the command was seen.
uid: :bro:type:`string` :bro:attr:`&log`
Unique ID for the connection.
id: :bro:type:`conn_id` :bro:attr:`&log`
The connection's 4-tuple of endpoint addresses/ports.
nick: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
Nickname given for the connection.
user: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
Username given for the connection.
command: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
Command given by the client.
value: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
Value for the command given by the client.
addl: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
Any additional data for the command.
dcc_file_name: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
(present if :doc:`/scripts/base/protocols/irc/dcc-send.bro` is loaded)
DCC filename requested.
dcc_file_size: :bro:type:`count` :bro:attr:`&log` :bro:attr:`&optional`
(present if :doc:`/scripts/base/protocols/irc/dcc-send.bro` is loaded)
Size of the DCC transfer as indicated by the sender.
dcc_mime_type: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
(present if :doc:`/scripts/base/protocols/irc/dcc-send.bro` is loaded)
Sniffed mime type of the file.
fuid: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
(present if :doc:`/scripts/base/protocols/irc/files.bro` is loaded)
File unique ID.
Events
######
.. bro:id:: IRC::irc_log
:Type: :bro:type:`event` (rec: :bro:type:`IRC::Info`)
Event that can be handled to access the IRC record as it is sent on
to the logging framework.