mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 07:08:19 +00:00
ded98cd373
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
147 lines
4.5 KiB
ReStructuredText
147 lines
4.5 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/protocols/irc/main.zeek
|
|
============================
|
|
.. zeek: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
|
|
#####
|
|
=========================================== =
|
|
:zeek:type:`IRC::Info`: :zeek:type:`record`
|
|
=========================================== =
|
|
|
|
Redefinitions
|
|
#############
|
|
==================================================================== ====================================================
|
|
:zeek:type:`Log::ID`: :zeek:type:`enum`
|
|
|
|
* :zeek:enum:`IRC::LOG`
|
|
:zeek:type:`connection`: :zeek:type:`record`
|
|
|
|
:New Fields: :zeek:type:`connection`
|
|
|
|
irc: :zeek:type:`IRC::Info` :zeek:attr:`&optional`
|
|
IRC session information.
|
|
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
|
|
==================================================================== ====================================================
|
|
|
|
Events
|
|
######
|
|
=========================================== ===================================================================
|
|
:zeek:id:`IRC::irc_log`: :zeek:type:`event` Event that can be handled to access the IRC record as it is sent on
|
|
to the logging framework.
|
|
=========================================== ===================================================================
|
|
|
|
Hooks
|
|
#####
|
|
======================================================== =
|
|
:zeek:id:`IRC::log_policy`: :zeek:type:`Log::PolicyHook`
|
|
======================================================== =
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Types
|
|
#####
|
|
.. zeek:type:: IRC::Info
|
|
:source-code: base/protocols/irc/main.zeek 13 31
|
|
|
|
:Type: :zeek:type:`record`
|
|
|
|
|
|
.. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
|
|
|
|
Timestamp when the command was seen.
|
|
|
|
|
|
.. zeek:field:: uid :zeek:type:`string` :zeek:attr:`&log`
|
|
|
|
Unique ID for the connection.
|
|
|
|
|
|
.. zeek:field:: id :zeek:type:`conn_id` :zeek:attr:`&log`
|
|
|
|
The connection's 4-tuple of endpoint addresses/ports.
|
|
|
|
|
|
.. zeek:field:: nick :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
Nickname given for the connection.
|
|
|
|
|
|
.. zeek:field:: user :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
Username given for the connection.
|
|
|
|
|
|
.. zeek:field:: command :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
Command given by the client.
|
|
|
|
|
|
.. zeek:field:: value :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
Value for the command given by the client.
|
|
|
|
|
|
.. zeek:field:: addl :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
Any additional data for the command.
|
|
|
|
|
|
.. zeek:field:: dcc_file_name :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
(present if :doc:`/scripts/base/protocols/irc/dcc-send.zeek` is loaded)
|
|
|
|
DCC filename requested.
|
|
|
|
|
|
.. zeek:field:: dcc_file_size :zeek:type:`count` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
(present if :doc:`/scripts/base/protocols/irc/dcc-send.zeek` is loaded)
|
|
|
|
Size of the DCC transfer as indicated by the sender.
|
|
|
|
|
|
.. zeek:field:: dcc_mime_type :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
(present if :doc:`/scripts/base/protocols/irc/dcc-send.zeek` is loaded)
|
|
|
|
Sniffed mime type of the file.
|
|
|
|
|
|
.. zeek:field:: fuid :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
(present if :doc:`/scripts/base/protocols/irc/files.zeek` is loaded)
|
|
|
|
File unique ID.
|
|
|
|
|
|
|
|
Events
|
|
######
|
|
.. zeek:id:: IRC::irc_log
|
|
:source-code: base/protocols/irc/main.zeek 35 35
|
|
|
|
:Type: :zeek:type:`event` (rec: :zeek:type:`IRC::Info`)
|
|
|
|
Event that can be handled to access the IRC record as it is sent on
|
|
to the logging framework.
|
|
|
|
Hooks
|
|
#####
|
|
.. zeek:id:: IRC::log_policy
|
|
:source-code: base/protocols/irc/main.zeek 11 11
|
|
|
|
:Type: :zeek:type:`Log::PolicyHook`
|
|
|
|
|
|
|