mirror of
https://github.com/zeek/zeek.git
synced 2025-10-15 04:58:21 +00:00
ded98cd373
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
123 lines
3.8 KiB
ReStructuredText
123 lines
3.8 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/frameworks/netcontrol/shunt.zeek
|
|
=====================================
|
|
.. zeek:namespace:: NetControl
|
|
|
|
Implementation of the shunt functionality for NetControl.
|
|
|
|
:Namespace: NetControl
|
|
:Imports: :doc:`base/frameworks/netcontrol/main.zeek </scripts/base/frameworks/netcontrol/main.zeek>`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Types
|
|
#####
|
|
======================================================= =
|
|
:zeek:type:`NetControl::ShuntInfo`: :zeek:type:`record`
|
|
======================================================= =
|
|
|
|
Redefinitions
|
|
#############
|
|
======================================= ================================
|
|
:zeek:type:`Log::ID`: :zeek:type:`enum`
|
|
|
|
* :zeek:enum:`NetControl::SHUNT`
|
|
======================================= ================================
|
|
|
|
Events
|
|
######
|
|
=============================================================== ==========================================================================
|
|
:zeek:id:`NetControl::log_netcontrol_shunt`: :zeek:type:`event` Event that can be handled to access the :zeek:type:`NetControl::ShuntInfo`
|
|
record as it is sent on to the logging framework.
|
|
=============================================================== ==========================================================================
|
|
|
|
Hooks
|
|
#####
|
|
===================================================================== =
|
|
:zeek:id:`NetControl::log_policy_shunt`: :zeek:type:`Log::PolicyHook`
|
|
===================================================================== =
|
|
|
|
Functions
|
|
#########
|
|
======================================================== ==========================================================
|
|
:zeek:id:`NetControl::shunt_flow`: :zeek:type:`function` Stops forwarding a uni-directional flow's packets to Zeek.
|
|
======================================================== ==========================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Types
|
|
#####
|
|
.. zeek:type:: NetControl::ShuntInfo
|
|
:source-code: base/frameworks/netcontrol/shunt.zeek 23 34
|
|
|
|
:Type: :zeek:type:`record`
|
|
|
|
|
|
.. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
|
|
|
|
Time at which the recorded activity occurred.
|
|
|
|
|
|
.. zeek:field:: rule_id :zeek:type:`string` :zeek:attr:`&log`
|
|
|
|
ID of the rule; unique during each Zeek run.
|
|
|
|
|
|
.. zeek:field:: f :zeek:type:`flow_id` :zeek:attr:`&log`
|
|
|
|
Flow ID of the shunted flow.
|
|
|
|
|
|
.. zeek:field:: expire :zeek:type:`interval` :zeek:attr:`&log`
|
|
|
|
Expiry time of the shunt.
|
|
|
|
|
|
.. zeek:field:: location :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
|
|
|
Location where the underlying action was triggered.
|
|
|
|
|
|
|
|
Events
|
|
######
|
|
.. zeek:id:: NetControl::log_netcontrol_shunt
|
|
:source-code: base/frameworks/netcontrol/shunt.zeek 38 38
|
|
|
|
:Type: :zeek:type:`event` (rec: :zeek:type:`NetControl::ShuntInfo`)
|
|
|
|
Event that can be handled to access the :zeek:type:`NetControl::ShuntInfo`
|
|
record as it is sent on to the logging framework.
|
|
|
|
Hooks
|
|
#####
|
|
.. zeek:id:: NetControl::log_policy_shunt
|
|
:source-code: base/frameworks/netcontrol/shunt.zeek 10 10
|
|
|
|
:Type: :zeek:type:`Log::PolicyHook`
|
|
|
|
|
|
Functions
|
|
#########
|
|
.. zeek:id:: NetControl::shunt_flow
|
|
:source-code: base/frameworks/netcontrol/shunt.zeek 46 70
|
|
|
|
:Type: :zeek:type:`function` (f: :zeek:type:`flow_id`, t: :zeek:type:`interval`, location: :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`) : :zeek:type:`string`
|
|
|
|
Stops forwarding a uni-directional flow's packets to Zeek.
|
|
|
|
|
|
:param f: The flow to shunt.
|
|
|
|
|
|
:param t: How long to leave the shunt in place, with 0 being indefinitely.
|
|
|
|
|
|
:param location: An optional string describing where the shunt was triggered.
|
|
|
|
|
|
:returns: The id of the inserted rule on success and zero on failure.
|
|
|
|
|