mirror of
https://github.com/zeek/zeek.git
synced 2025-10-06 00:28:21 +00:00
Change doc/ subdir into a git submodule
The docs now live at https://github.com/zeek/zeek-docs
This commit is contained in:
Jon Siwek
parent
0d685efbf5
commit
2ff746fea7
693 changed files with 26 additions and 105609 deletions
|
|
@ -1,14 +0,0 @@
|
|||
: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
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
: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
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
: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.
|
||||
|
||||
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
: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`
|
||||
|
||||
|
||||
|
|
@ -1,99 +0,0 @@
|
|||
: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.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue