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

Copy docs into Zeek repo directly

Browse source 
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
This commit is contained in:
Tim Wojtulewicz 2025-09-15 15:52:18 -07:00
parent 83f1e74643
commit ded98cd373
1074 changed files with 169319 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/scripts/base/packet-protocols/__load__.zeek.rst Normal file
View file

@ -0,0 +1,14 @@
:tocdepth: 3
base/packet-protocols/__load__.zeek
===================================
:Imports: :doc:`base/packet-protocols/ayiya </scripts/base/packet-protocols/ayiya/index>`, :doc:`base/packet-protocols/ethernet </scripts/base/packet-protocols/ethernet/index>`, :doc:`base/packet-protocols/fddi </scripts/base/packet-protocols/fddi/index>`, :doc:`base/packet-protocols/geneve </scripts/base/packet-protocols/geneve/index>`, :doc:`base/packet-protocols/gre </scripts/base/packet-protocols/gre/index>`, :doc:`base/packet-protocols/gtpv1 </scripts/base/packet-protocols/gtpv1/index>`, :doc:`base/packet-protocols/icmp </scripts/base/packet-protocols/icmp/index>`, :doc:`base/packet-protocols/ieee802_11 </scripts/base/packet-protocols/ieee802_11/index>`, :doc:`base/packet-protocols/ieee802_11_radio </scripts/base/packet-protocols/ieee802_11_radio/index>`, :doc:`base/packet-protocols/ip </scripts/base/packet-protocols/ip/index>`, :doc:`base/packet-protocols/iptunnel </scripts/base/packet-protocols/iptunnel/index>`, :doc:`base/packet-protocols/linux_sll </scripts/base/packet-protocols/linux_sll/index>`, :doc:`base/packet-protocols/linux_sll2 </scripts/base/packet-protocols/linux_sll2/index>`, :doc:`base/packet-protocols/llc </scripts/base/packet-protocols/llc/index>`, :doc:`base/packet-protocols/main.zeek </scripts/base/packet-protocols/main.zeek>`, :doc:`base/packet-protocols/mpls </scripts/base/packet-protocols/mpls/index>`, :doc:`base/packet-protocols/nflog </scripts/base/packet-protocols/nflog/index>`, :doc:`base/packet-protocols/novell_802_3 </scripts/base/packet-protocols/novell_802_3/index>`, :doc:`base/packet-protocols/null </scripts/base/packet-protocols/null/index>`, :doc:`base/packet-protocols/pbb </scripts/base/packet-protocols/pbb/index>`, :doc:`base/packet-protocols/ppp </scripts/base/packet-protocols/ppp/index>`, :doc:`base/packet-protocols/ppp_serial </scripts/base/packet-protocols/ppp_serial/index>`, :doc:`base/packet-protocols/pppoe </scripts/base/packet-protocols/pppoe/index>`, :doc:`base/packet-protocols/root </scripts/base/packet-protocols/root/index>`, :doc:`base/packet-protocols/skip </scripts/base/packet-protocols/skip/index>`, :doc:`base/packet-protocols/snap </scripts/base/packet-protocols/snap/index>`, :doc:`base/packet-protocols/tcp </scripts/base/packet-protocols/tcp/index>`, :doc:`base/packet-protocols/teredo </scripts/base/packet-protocols/teredo/index>`, :doc:`base/packet-protocols/udp </scripts/base/packet-protocols/udp/index>`, :doc:`base/packet-protocols/vlan </scripts/base/packet-protocols/vlan/index>`, :doc:`base/packet-protocols/vntag </scripts/base/packet-protocols/vntag/index>`, :doc:`base/packet-protocols/vxlan </scripts/base/packet-protocols/vxlan/index>`
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/ayiya/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/ayiya/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/ayiya
====================================
:doc:`/scripts/base/packet-protocols/ayiya/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ayiya/main.zeek`

22
doc/scripts/base/packet-protocols/ayiya/main.zeek.rst Normal file
View file

@ -0,0 +1,22 @@
:tocdepth: 3
base/packet-protocols/ayiya/main.zeek
=====================================
.. zeek:namespace:: PacketAnalyzer::AYIYA
:Namespace: PacketAnalyzer::AYIYA
:Imports: :doc:`base/frameworks/analyzer/main.zeek </scripts/base/frameworks/analyzer/main.zeek>`
Summary
~~~~~~~
Redefinitions
#############
==================================================================== =
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
==================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/ethernet/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/ethernet/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/ethernet
=======================================
:doc:`/scripts/base/packet-protocols/ethernet/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ethernet/main.zeek`

46
doc/scripts/base/packet-protocols/ethernet/main.zeek.rst Normal file
View file

@ -0,0 +1,46 @@
:tocdepth: 3
base/packet-protocols/ethernet/main.zeek
========================================
.. zeek:namespace:: PacketAnalyzer::ETHERNET
:Namespace: PacketAnalyzer::ETHERNET
Summary
~~~~~~~
Constants
#########
============================================================================== =
:zeek:id:`PacketAnalyzer::ETHERNET::LLC_FORWARDING_KEY`: :zeek:type:`count`
:zeek:id:`PacketAnalyzer::ETHERNET::NOVELL_FORWARDING_KEY`: :zeek:type:`count`
:zeek:id:`PacketAnalyzer::ETHERNET::SNAP_FORWARDING_KEY`: :zeek:type:`count`
============================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Constants
#########
.. zeek:id:: PacketAnalyzer::ETHERNET::LLC_FORWARDING_KEY
:source-code: base/packet-protocols/ethernet/main.zeek 9 9
:Type: :zeek:type:`count`
:Default: ``3``
.. zeek:id:: PacketAnalyzer::ETHERNET::NOVELL_FORWARDING_KEY
:source-code: base/packet-protocols/ethernet/main.zeek 8 8
:Type: :zeek:type:`count`
:Default: ``2``
.. zeek:id:: PacketAnalyzer::ETHERNET::SNAP_FORWARDING_KEY
:source-code: base/packet-protocols/ethernet/main.zeek 7 7
:Type: :zeek:type:`count`
:Default: ``1``

14
doc/scripts/base/packet-protocols/fddi/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/fddi/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/fddi
===================================
:doc:`/scripts/base/packet-protocols/fddi/__load__.zeek`
:doc:`/scripts/base/packet-protocols/fddi/main.zeek`

32
doc/scripts/base/packet-protocols/fddi/main.zeek.rst Normal file
View file

@ -0,0 +1,32 @@
:tocdepth: 3
base/packet-protocols/fddi/main.zeek
====================================
.. zeek:namespace:: PacketAnalyzer::FDDI
:Namespace: PacketAnalyzer::FDDI
Summary
~~~~~~~
Redefinable Options
###################
======================================================================================================= ================
:zeek:id:`PacketAnalyzer::FDDI::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef` Default analyzer
======================================================================================================= ================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::FDDI::default_analyzer
:source-code: base/packet-protocols/fddi/main.zeek 5 5
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_IP``
Default analyzer

14
doc/scripts/base/packet-protocols/geneve/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/geneve/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/geneve
=====================================
:doc:`/scripts/base/packet-protocols/geneve/__load__.zeek`
:doc:`/scripts/base/packet-protocols/geneve/main.zeek`

99
doc/scripts/base/packet-protocols/geneve/main.zeek.rst Normal file
View file

@ -0,0 +1,99 @@
:tocdepth: 3
base/packet-protocols/geneve/main.zeek
======================================
.. zeek:namespace:: GLOBAL
.. zeek:namespace:: PacketAnalyzer::Geneve
:Namespaces: GLOBAL, PacketAnalyzer::Geneve
Summary
~~~~~~~
Redefinable Options
###################
===================================================================================== =============================================
:zeek:id:`PacketAnalyzer::Geneve::geneve_ports`: :zeek:type:`set` :zeek:attr:`&redef` The set of UDP ports used for Geneve traffic.
===================================================================================== =============================================
Types
#####
================================================================ ================
:zeek:type:`PacketAnalyzer::Geneve::Option`: :zeek:type:`record` A Geneve option.
:zeek:type:`geneve_options_vec`: :zeek:type:`vector`
:zeek:type:`geneve_options_vec_vec`: :zeek:type:`vector`
================================================================ ================
Redefinitions
#############
==================================================================== =
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
==================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::Geneve::geneve_ports
:source-code: base/packet-protocols/geneve/main.zeek 8 8
:Type: :zeek:type:`set` [:zeek:type:`port`]
:Attributes: :zeek:attr:`&redef`
:Default:
::
{
6081/udp
}
The set of UDP ports used for Geneve traffic. Traffic using this
UDP destination port will attempt to be decapsulated. Note that if
if you customize this, you may still want to manually ensure that
:zeek:see:`likely_server_ports` also gets populated accordingly.
Types
#####
.. zeek:type:: PacketAnalyzer::Geneve::Option
:source-code: base/packet-protocols/geneve/main.zeek 11 20
:Type: :zeek:type:`record`
.. zeek:field:: class :zeek:type:`count`
The class of the option.
.. zeek:field:: critical :zeek:type:`bool`
The critical bit of the type.
.. zeek:field:: typ :zeek:type:`count`
The type field of the option with the critical bit masked.
.. zeek:field:: data :zeek:type:`string`
The data field of the option.
A Geneve option.
.. zeek:type:: geneve_options_vec
:source-code: base/packet-protocols/geneve/main.zeek 43 43
:Type: :zeek:type:`vector` of :zeek:type:`PacketAnalyzer::Geneve::Option`
.. zeek:type:: geneve_options_vec_vec
:source-code: base/packet-protocols/geneve/main.zeek 44 44
:Type: :zeek:type:`vector` of :zeek:type:`geneve_options_vec`

14
doc/scripts/base/packet-protocols/gre/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/gre/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/gre
==================================
:doc:`/scripts/base/packet-protocols/gre/__load__.zeek`
:doc:`/scripts/base/packet-protocols/gre/main.zeek`

47
doc/scripts/base/packet-protocols/gre/main.zeek.rst Normal file
View file

@ -0,0 +1,47 @@
:tocdepth: 3
base/packet-protocols/gre/main.zeek
===================================
.. zeek:namespace:: PacketAnalyzer::GRE
:Namespace: PacketAnalyzer::GRE
Summary
~~~~~~~
Redefinable Options
###################
====================================================================================================== =
:zeek:id:`PacketAnalyzer::GRE::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef`
:zeek:id:`PacketAnalyzer::GRE::gre_ports`: :zeek:type:`set` :zeek:attr:`&redef`
====================================================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::GRE::default_analyzer
:source-code: base/packet-protocols/gre/main.zeek 4 4
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_IPTUNNEL``
.. zeek:id:: PacketAnalyzer::GRE::gre_ports
:source-code: base/packet-protocols/gre/main.zeek 5 5
:Type: :zeek:type:`set` [:zeek:type:`port`]
:Attributes: :zeek:attr:`&redef`
:Default:
::
{
4754/udp
}

14
doc/scripts/base/packet-protocols/gtpv1/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/gtpv1/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/gtpv1
====================================
:doc:`/scripts/base/packet-protocols/gtpv1/__load__.zeek`
:doc:`/scripts/base/packet-protocols/gtpv1/main.zeek`

39
doc/scripts/base/packet-protocols/gtpv1/main.zeek.rst Normal file
View file

@ -0,0 +1,39 @@
:tocdepth: 3
base/packet-protocols/gtpv1/main.zeek
=====================================
.. zeek:namespace:: PacketAnalyzer::GTPV1
:Namespace: PacketAnalyzer::GTPV1
:Imports: :doc:`base/bif/plugins/Zeek_GTPv1.events.bif.zeek </scripts/base/bif/plugins/Zeek_GTPv1.events.bif.zeek>`, :doc:`base/bif/plugins/Zeek_GTPv1.functions.bif.zeek </scripts/base/bif/plugins/Zeek_GTPv1.functions.bif.zeek>`, :doc:`base/frameworks/analyzer/main.zeek </scripts/base/frameworks/analyzer/main.zeek>`, :doc:`base/protocols/conn/removal-hooks.zeek </scripts/base/protocols/conn/removal-hooks.zeek>`
Summary
~~~~~~~
Redefinable Options
###################
======================================================================================================== ================
:zeek:id:`PacketAnalyzer::GTPV1::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef` Default analyzer
======================================================================================================== ================
Redefinitions
#############
==================================================================== =
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
==================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::GTPV1::default_analyzer
:source-code: base/packet-protocols/gtpv1/main.zeek 17 17
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_IP``
Default analyzer

14
doc/scripts/base/packet-protocols/icmp/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/icmp/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/icmp
===================================
:doc:`/scripts/base/packet-protocols/icmp/__load__.zeek`
:doc:`/scripts/base/packet-protocols/icmp/main.zeek`

15
doc/scripts/base/packet-protocols/icmp/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/icmp/main.zeek
====================================
.. zeek:namespace:: PacketAnalyzer::ICMP
:Namespace: PacketAnalyzer::ICMP
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/ieee802_11/__load__.zeek.rst Normal file
View file

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

18
doc/scripts/base/packet-protocols/ieee802_11/index.rst Normal file
View file

@ -0,0 +1,18 @@
:orphan:
Package: base/packet-protocols/ieee802_11
=========================================
:doc:`/scripts/base/packet-protocols/ieee802_11/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ieee802_11/main.zeek`
:doc:`/scripts/base/packet-protocols/ieee802_11_radio/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ieee802_11_radio/main.zeek`

15
doc/scripts/base/packet-protocols/ieee802_11/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/ieee802_11/main.zeek
==========================================
.. zeek:namespace:: PacketAnalyzer::IEEE802_11
:Namespace: PacketAnalyzer::IEEE802_11
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/ieee802_11_radio/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/ieee802_11_radio/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/ieee802_11_radio
===============================================
:doc:`/scripts/base/packet-protocols/ieee802_11_radio/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ieee802_11_radio/main.zeek`

15
doc/scripts/base/packet-protocols/ieee802_11_radio/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/ieee802_11_radio/main.zeek
================================================
.. zeek:namespace:: PacketAnalyzer::IEEE802_11_RADIO
:Namespace: PacketAnalyzer::IEEE802_11_RADIO
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

198
doc/scripts/base/packet-protocols/index.rst Normal file
View file

@ -0,0 +1,198 @@
:orphan:
Package: base/packet-protocols
==============================
:doc:`/scripts/base/packet-protocols/__load__.zeek`
:doc:`/scripts/base/packet-protocols/main.zeek`
:doc:`/scripts/base/packet-protocols/root/__load__.zeek`
:doc:`/scripts/base/packet-protocols/root/main.zeek`
:doc:`/scripts/base/packet-protocols/ip/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ip/main.zeek`
:doc:`/scripts/base/packet-protocols/skip/__load__.zeek`
:doc:`/scripts/base/packet-protocols/skip/main.zeek`
:doc:`/scripts/base/packet-protocols/ethernet/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ethernet/main.zeek`
:doc:`/scripts/base/packet-protocols/fddi/__load__.zeek`
:doc:`/scripts/base/packet-protocols/fddi/main.zeek`
:doc:`/scripts/base/packet-protocols/ieee802_11/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ieee802_11/main.zeek`
:doc:`/scripts/base/packet-protocols/ieee802_11_radio/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ieee802_11_radio/main.zeek`
:doc:`/scripts/base/packet-protocols/linux_sll/__load__.zeek`
:doc:`/scripts/base/packet-protocols/linux_sll/main.zeek`
:doc:`/scripts/base/packet-protocols/linux_sll2/__load__.zeek`
:doc:`/scripts/base/packet-protocols/linux_sll2/main.zeek`
:doc:`/scripts/base/packet-protocols/nflog/__load__.zeek`
:doc:`/scripts/base/packet-protocols/nflog/main.zeek`
:doc:`/scripts/base/packet-protocols/null/__load__.zeek`
:doc:`/scripts/base/packet-protocols/null/main.zeek`
:doc:`/scripts/base/packet-protocols/ppp/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ppp/main.zeek`
:doc:`/scripts/base/packet-protocols/ppp_serial/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ppp_serial/main.zeek`
:doc:`/scripts/base/packet-protocols/pppoe/__load__.zeek`
:doc:`/scripts/base/packet-protocols/pppoe/main.zeek`
:doc:`/scripts/base/packet-protocols/vlan/__load__.zeek`
:doc:`/scripts/base/packet-protocols/vlan/main.zeek`
:doc:`/scripts/base/packet-protocols/mpls/__load__.zeek`
:doc:`/scripts/base/packet-protocols/mpls/main.zeek`
:doc:`/scripts/base/packet-protocols/pbb/__load__.zeek`
:doc:`/scripts/base/packet-protocols/pbb/main.zeek`
:doc:`/scripts/base/packet-protocols/vntag/__load__.zeek`
:doc:`/scripts/base/packet-protocols/vntag/main.zeek`
:doc:`/scripts/base/packet-protocols/udp/__load__.zeek`
:doc:`/scripts/base/packet-protocols/udp/main.zeek`
:doc:`/scripts/base/packet-protocols/tcp/__load__.zeek`
:doc:`/scripts/base/packet-protocols/tcp/main.zeek`
:doc:`/scripts/base/packet-protocols/icmp/__load__.zeek`
:doc:`/scripts/base/packet-protocols/icmp/main.zeek`
:doc:`/scripts/base/packet-protocols/llc/__load__.zeek`
:doc:`/scripts/base/packet-protocols/llc/main.zeek`
:doc:`/scripts/base/packet-protocols/novell_802_3/__load__.zeek`
:doc:`/scripts/base/packet-protocols/novell_802_3/main.zeek`
:doc:`/scripts/base/packet-protocols/snap/__load__.zeek`
:doc:`/scripts/base/packet-protocols/snap/main.zeek`
:doc:`/scripts/base/packet-protocols/gre/__load__.zeek`
:doc:`/scripts/base/packet-protocols/gre/main.zeek`
:doc:`/scripts/base/packet-protocols/iptunnel/__load__.zeek`
:doc:`/scripts/base/packet-protocols/iptunnel/main.zeek`
:doc:`/scripts/base/packet-protocols/ayiya/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ayiya/main.zeek`
:doc:`/scripts/base/packet-protocols/geneve/__load__.zeek`
:doc:`/scripts/base/packet-protocols/geneve/main.zeek`
:doc:`/scripts/base/packet-protocols/vxlan/__load__.zeek`
:doc:`/scripts/base/packet-protocols/vxlan/main.zeek`
:doc:`/scripts/base/packet-protocols/teredo/__load__.zeek`
:doc:`/scripts/base/packet-protocols/teredo/main.zeek`
:doc:`/scripts/base/packet-protocols/gtpv1/__load__.zeek`
:doc:`/scripts/base/packet-protocols/gtpv1/main.zeek`

14
doc/scripts/base/packet-protocols/ip/__load__.zeek.rst Normal file
View file

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

18
doc/scripts/base/packet-protocols/ip/index.rst Normal file
View file

@ -0,0 +1,18 @@
:orphan:
Package: base/packet-protocols/ip
=================================
:doc:`/scripts/base/packet-protocols/ip/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ip/main.zeek`
:doc:`/scripts/base/packet-protocols/iptunnel/__load__.zeek`
:doc:`/scripts/base/packet-protocols/iptunnel/main.zeek`

32
doc/scripts/base/packet-protocols/ip/main.zeek.rst Normal file
View file

@ -0,0 +1,32 @@
:tocdepth: 3
base/packet-protocols/ip/main.zeek
==================================
.. zeek:namespace:: PacketAnalyzer::IP
:Namespace: PacketAnalyzer::IP
Summary
~~~~~~~
Redefinable Options
###################
===================================================================================================== ================
:zeek:id:`PacketAnalyzer::IP::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef` Default analyzer
===================================================================================================== ================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::IP::default_analyzer
:source-code: base/packet-protocols/ip/main.zeek 5 5
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_UNKNOWN_IP_TRANSPORT``
Default analyzer

14
doc/scripts/base/packet-protocols/iptunnel/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/iptunnel/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/iptunnel
=======================================
:doc:`/scripts/base/packet-protocols/iptunnel/__load__.zeek`
:doc:`/scripts/base/packet-protocols/iptunnel/main.zeek`

31
doc/scripts/base/packet-protocols/iptunnel/main.zeek.rst Normal file
View file

@ -0,0 +1,31 @@
:tocdepth: 3
base/packet-protocols/iptunnel/main.zeek
========================================
.. zeek:namespace:: PacketAnalyzer::IPTUNNEL
:Namespace: PacketAnalyzer::IPTUNNEL
Summary
~~~~~~~
Redefinable Options
###################
=========================================================================================================== =
:zeek:id:`PacketAnalyzer::IPTUNNEL::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef`
=========================================================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::IPTUNNEL::default_analyzer
:source-code: base/packet-protocols/iptunnel/main.zeek 4 4
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_IP``

14
doc/scripts/base/packet-protocols/linux_sll/__load__.zeek.rst Normal file
View file

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

18
doc/scripts/base/packet-protocols/linux_sll/index.rst Normal file
View file

@ -0,0 +1,18 @@
:orphan:
Package: base/packet-protocols/linux_sll
========================================
:doc:`/scripts/base/packet-protocols/linux_sll/__load__.zeek`
:doc:`/scripts/base/packet-protocols/linux_sll/main.zeek`
:doc:`/scripts/base/packet-protocols/linux_sll2/__load__.zeek`
:doc:`/scripts/base/packet-protocols/linux_sll2/main.zeek`

15
doc/scripts/base/packet-protocols/linux_sll/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/linux_sll/main.zeek
=========================================
.. zeek:namespace:: PacketAnalyzer::LINUXSLL
:Namespace: PacketAnalyzer::LINUXSLL
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/linux_sll2/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/linux_sll2/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/linux_sll2
=========================================
:doc:`/scripts/base/packet-protocols/linux_sll2/__load__.zeek`
:doc:`/scripts/base/packet-protocols/linux_sll2/main.zeek`

15
doc/scripts/base/packet-protocols/linux_sll2/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/linux_sll2/main.zeek
==========================================
.. zeek:namespace:: PacketAnalyzer::LINUXSLL2
:Namespace: PacketAnalyzer::LINUXSLL2
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/llc/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/llc/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/llc
==================================
:doc:`/scripts/base/packet-protocols/llc/__load__.zeek`
:doc:`/scripts/base/packet-protocols/llc/main.zeek`

15
doc/scripts/base/packet-protocols/llc/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/llc/main.zeek
===================================
.. zeek:namespace:: PacketAnalyzer::LLC
:Namespace: PacketAnalyzer::LLC
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

63
doc/scripts/base/packet-protocols/main.zeek.rst Normal file
View file

@ -0,0 +1,63 @@
:tocdepth: 3
base/packet-protocols/main.zeek
===============================
.. zeek:namespace:: PacketAnalyzer
:Namespace: PacketAnalyzer
:Imports: :doc:`base/frameworks/analyzer/main.zeek </scripts/base/frameworks/analyzer/main.zeek>`
Summary
~~~~~~~
Functions
#########
==================================================================== ========================================================
:zeek:id:`PacketAnalyzer::register_for_port`: :zeek:type:`function` Registers an individual well-known port for an analyzer.
:zeek:id:`PacketAnalyzer::register_for_ports`: :zeek:type:`function` Registers a set of well-known ports for an analyzer.
==================================================================== ========================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: PacketAnalyzer::register_for_port
:source-code: base/packet-protocols/main.zeek 52 61
:Type: :zeek:type:`function` (parent: :zeek:type:`PacketAnalyzer::Tag`, child: :zeek:type:`PacketAnalyzer::Tag`, p: :zeek:type:`port`) : :zeek:type:`bool`
Registers an individual well-known port for an analyzer. If a future
connection on this port is seen, the analyzer will be automatically
assigned to parsing it. The function *adds* to all ports already
registered, it doesn't replace them.
:param tag: The tag of the analyzer.
:param p: The well-known port to associate with the analyzer.
:returns: True if the port was successfully registered.
.. zeek:id:: PacketAnalyzer::register_for_ports
:source-code: base/packet-protocols/main.zeek 37 48
:Type: :zeek:type:`function` (parent: :zeek:type:`PacketAnalyzer::Tag`, child: :zeek:type:`PacketAnalyzer::Tag`, ports: :zeek:type:`set` [:zeek:type:`port`]) : :zeek:type:`bool`
Registers a set of well-known ports for an analyzer. If a future
connection on one of these ports is seen, the analyzer will be
automatically assigned to parsing it. The function *adds* to all ports
already registered, it doesn't replace them.
:param tag: The tag of the analyzer.
:param ports: The set of well-known ports to associate with the analyzer.
:returns: True if the ports were successfully registered.

14
doc/scripts/base/packet-protocols/mpls/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/mpls/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/mpls
===================================
:doc:`/scripts/base/packet-protocols/mpls/__load__.zeek`
:doc:`/scripts/base/packet-protocols/mpls/main.zeek`

32
doc/scripts/base/packet-protocols/mpls/main.zeek.rst Normal file
View file

@ -0,0 +1,32 @@
:tocdepth: 3
base/packet-protocols/mpls/main.zeek
====================================
.. zeek:namespace:: PacketAnalyzer::MPLS
:Namespace: PacketAnalyzer::MPLS
Summary
~~~~~~~
Redefinable Options
###################
======================================================================================================= ================
:zeek:id:`PacketAnalyzer::MPLS::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef` Default analyzer
======================================================================================================= ================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::MPLS::default_analyzer
:source-code: base/packet-protocols/mpls/main.zeek 5 5
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_IP``
Default analyzer

14
doc/scripts/base/packet-protocols/nflog/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/nflog/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/nflog
====================================
:doc:`/scripts/base/packet-protocols/nflog/__load__.zeek`
:doc:`/scripts/base/packet-protocols/nflog/main.zeek`

15
doc/scripts/base/packet-protocols/nflog/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/nflog/main.zeek
=====================================
.. zeek:namespace:: PacketAnalyzer::NFLOG
:Namespace: PacketAnalyzer::NFLOG
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/novell_802_3/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/novell_802_3/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/novell_802_3
===========================================
:doc:`/scripts/base/packet-protocols/novell_802_3/__load__.zeek`
:doc:`/scripts/base/packet-protocols/novell_802_3/main.zeek`

15
doc/scripts/base/packet-protocols/novell_802_3/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/novell_802_3/main.zeek
============================================
.. zeek:namespace:: PacketAnalyzer::NOVELL_802_3
:Namespace: PacketAnalyzer::NOVELL_802_3
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/null/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/null/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/null
===================================
:doc:`/scripts/base/packet-protocols/null/__load__.zeek`
:doc:`/scripts/base/packet-protocols/null/main.zeek`

15
doc/scripts/base/packet-protocols/null/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/null/main.zeek
====================================
.. zeek:namespace:: PacketAnalyzer::NULL
:Namespace: PacketAnalyzer::NULL
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/pbb/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/pbb/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/pbb
==================================
:doc:`/scripts/base/packet-protocols/pbb/__load__.zeek`
:doc:`/scripts/base/packet-protocols/pbb/main.zeek`

32
doc/scripts/base/packet-protocols/pbb/main.zeek.rst Normal file
View file

@ -0,0 +1,32 @@
:tocdepth: 3
base/packet-protocols/pbb/main.zeek
===================================
.. zeek:namespace:: PacketAnalyzer::PBB
:Namespace: PacketAnalyzer::PBB
Summary
~~~~~~~
Redefinable Options
###################
====================================================================================================== ================
:zeek:id:`PacketAnalyzer::PBB::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef` Default analyzer
====================================================================================================== ================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::PBB::default_analyzer
:source-code: base/packet-protocols/pbb/main.zeek 5 5
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_ETHERNET``
Default analyzer

14
doc/scripts/base/packet-protocols/ppp/__load__.zeek.rst Normal file
View file

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

24
doc/scripts/base/packet-protocols/ppp/index.rst Normal file
View file

@ -0,0 +1,24 @@
:orphan:
Package: base/packet-protocols/ppp
==================================
:doc:`/scripts/base/packet-protocols/ppp/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ppp/main.zeek`
:doc:`/scripts/base/packet-protocols/ppp_serial/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ppp_serial/main.zeek`
:doc:`/scripts/base/packet-protocols/pppoe/__load__.zeek`
:doc:`/scripts/base/packet-protocols/pppoe/main.zeek`

15
doc/scripts/base/packet-protocols/ppp/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/ppp/main.zeek
===================================
.. zeek:namespace:: PacketAnalyzer::PPP
:Namespace: PacketAnalyzer::PPP
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/ppp_serial/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/ppp_serial/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/ppp_serial
=========================================
:doc:`/scripts/base/packet-protocols/ppp_serial/__load__.zeek`
:doc:`/scripts/base/packet-protocols/ppp_serial/main.zeek`

15
doc/scripts/base/packet-protocols/ppp_serial/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/ppp_serial/main.zeek
==========================================
.. zeek:namespace:: PacketAnalyzer::PPP_SERIAL
:Namespace: PacketAnalyzer::PPP_SERIAL
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/pppoe/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/pppoe/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/pppoe
====================================
:doc:`/scripts/base/packet-protocols/pppoe/__load__.zeek`
:doc:`/scripts/base/packet-protocols/pppoe/main.zeek`

15
doc/scripts/base/packet-protocols/pppoe/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/pppoe/main.zeek
=====================================
.. zeek:namespace:: PacketAnalyzer::PPPOE
:Namespace: PacketAnalyzer::PPPOE
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/root/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/root/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/root
===================================
:doc:`/scripts/base/packet-protocols/root/__load__.zeek`
:doc:`/scripts/base/packet-protocols/root/main.zeek`

32
doc/scripts/base/packet-protocols/root/main.zeek.rst Normal file
View file

@ -0,0 +1,32 @@
:tocdepth: 3
base/packet-protocols/root/main.zeek
====================================
.. zeek:namespace:: PacketAnalyzer::ROOT
:Namespace: PacketAnalyzer::ROOT
Summary
~~~~~~~
Redefinable Options
###################
======================================================================================================= ===================================================================
:zeek:id:`PacketAnalyzer::ROOT::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef` Default analyzer (if we don't know the link type, we assume raw IP)
======================================================================================================= ===================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::ROOT::default_analyzer
:source-code: base/packet-protocols/root/main.zeek 5 5
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_IP``
Default analyzer (if we don't know the link type, we assume raw IP)

14
doc/scripts/base/packet-protocols/skip/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/skip/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/skip
===================================
:doc:`/scripts/base/packet-protocols/skip/__load__.zeek`
:doc:`/scripts/base/packet-protocols/skip/main.zeek`

42
doc/scripts/base/packet-protocols/skip/main.zeek.rst Normal file
View file

@ -0,0 +1,42 @@
:tocdepth: 3
base/packet-protocols/skip/main.zeek
====================================
.. zeek:namespace:: PacketAnalyzer::SKIP
:Namespace: PacketAnalyzer::SKIP
Summary
~~~~~~~
Redefinable Options
###################
======================================================================================================= ================
:zeek:id:`PacketAnalyzer::SKIP::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef` Default analyzer
:zeek:id:`PacketAnalyzer::SKIP::skip_bytes`: :zeek:type:`count` :zeek:attr:`&redef` Bytes to skip.
======================================================================================================= ================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::SKIP::default_analyzer
:source-code: base/packet-protocols/skip/main.zeek 5 5
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_IP``
Default analyzer
.. zeek:id:: PacketAnalyzer::SKIP::skip_bytes
:source-code: base/packet-protocols/skip/main.zeek 8 8
:Type: :zeek:type:`count`
:Attributes: :zeek:attr:`&redef`
:Default: ``0``
Bytes to skip.

14
doc/scripts/base/packet-protocols/snap/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/snap/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/snap
===================================
:doc:`/scripts/base/packet-protocols/snap/__load__.zeek`
:doc:`/scripts/base/packet-protocols/snap/main.zeek`

15
doc/scripts/base/packet-protocols/snap/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/snap/main.zeek
====================================
.. zeek:namespace:: PacketAnalyzer::SNAP
:Namespace: PacketAnalyzer::SNAP
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/tcp/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/tcp/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/tcp
==================================
:doc:`/scripts/base/packet-protocols/tcp/__load__.zeek`
:doc:`/scripts/base/packet-protocols/tcp/main.zeek`

15
doc/scripts/base/packet-protocols/tcp/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/tcp/main.zeek
===================================
.. zeek:namespace:: PacketAnalyzer::TCP
:Namespace: PacketAnalyzer::TCP
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/teredo/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/teredo/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/teredo
=====================================
:doc:`/scripts/base/packet-protocols/teredo/__load__.zeek`
:doc:`/scripts/base/packet-protocols/teredo/main.zeek`

39
doc/scripts/base/packet-protocols/teredo/main.zeek.rst Normal file
View file

@ -0,0 +1,39 @@
:tocdepth: 3
base/packet-protocols/teredo/main.zeek
======================================
.. zeek:namespace:: PacketAnalyzer::TEREDO
:Namespace: PacketAnalyzer::TEREDO
:Imports: :doc:`base/bif/plugins/Zeek_Teredo.events.bif.zeek </scripts/base/bif/plugins/Zeek_Teredo.events.bif.zeek>`, :doc:`base/bif/plugins/Zeek_Teredo.functions.bif.zeek </scripts/base/bif/plugins/Zeek_Teredo.functions.bif.zeek>`, :doc:`base/frameworks/analyzer/main.zeek </scripts/base/frameworks/analyzer/main.zeek>`, :doc:`base/protocols/conn/removal-hooks.zeek </scripts/base/protocols/conn/removal-hooks.zeek>`
Summary
~~~~~~~
Redefinable Options
###################
========================================================================================================= ================
:zeek:id:`PacketAnalyzer::TEREDO::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef` Default analyzer
========================================================================================================= ================
Redefinitions
#############
==================================================================== =
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
==================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::TEREDO::default_analyzer
:source-code: base/packet-protocols/teredo/main.zeek 17 17
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_IP``
Default analyzer

14
doc/scripts/base/packet-protocols/udp/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/udp/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/udp
==================================
:doc:`/scripts/base/packet-protocols/udp/__load__.zeek`
:doc:`/scripts/base/packet-protocols/udp/main.zeek`

15
doc/scripts/base/packet-protocols/udp/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/udp/main.zeek
===================================
.. zeek:namespace:: PacketAnalyzer::UDP
:Namespace: PacketAnalyzer::UDP
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/vlan/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/vlan/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/vlan
===================================
:doc:`/scripts/base/packet-protocols/vlan/__load__.zeek`
:doc:`/scripts/base/packet-protocols/vlan/main.zeek`

46
doc/scripts/base/packet-protocols/vlan/main.zeek.rst Normal file
View file

@ -0,0 +1,46 @@
:tocdepth: 3
base/packet-protocols/vlan/main.zeek
====================================
.. zeek:namespace:: PacketAnalyzer::VLAN
:Namespace: PacketAnalyzer::VLAN
Summary
~~~~~~~
Constants
#########
========================================================================== =
:zeek:id:`PacketAnalyzer::VLAN::LLC_FORWARDING_KEY`: :zeek:type:`count`
:zeek:id:`PacketAnalyzer::VLAN::NOVELL_FORWARDING_KEY`: :zeek:type:`count`
:zeek:id:`PacketAnalyzer::VLAN::SNAP_FORWARDING_KEY`: :zeek:type:`count`
========================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Constants
#########
.. zeek:id:: PacketAnalyzer::VLAN::LLC_FORWARDING_KEY
:source-code: base/packet-protocols/vlan/main.zeek 9 9
:Type: :zeek:type:`count`
:Default: ``3``
.. zeek:id:: PacketAnalyzer::VLAN::NOVELL_FORWARDING_KEY
:source-code: base/packet-protocols/vlan/main.zeek 8 8
:Type: :zeek:type:`count`
:Default: ``2``
.. zeek:id:: PacketAnalyzer::VLAN::SNAP_FORWARDING_KEY
:source-code: base/packet-protocols/vlan/main.zeek 7 7
:Type: :zeek:type:`count`
:Default: ``1``

14
doc/scripts/base/packet-protocols/vntag/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/vntag/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/vntag
====================================
:doc:`/scripts/base/packet-protocols/vntag/__load__.zeek`
:doc:`/scripts/base/packet-protocols/vntag/main.zeek`

15
doc/scripts/base/packet-protocols/vntag/main.zeek.rst Normal file
View file

@ -0,0 +1,15 @@
:tocdepth: 3
base/packet-protocols/vntag/main.zeek
=====================================
.. zeek:namespace:: PacketAnalyzer::VNTAG
:Namespace: PacketAnalyzer::VNTAG
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

14
doc/scripts/base/packet-protocols/vxlan/__load__.zeek.rst Normal file
View file

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

12
doc/scripts/base/packet-protocols/vxlan/index.rst Normal file
View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/vxlan
====================================
:doc:`/scripts/base/packet-protocols/vxlan/__load__.zeek`
:doc:`/scripts/base/packet-protocols/vxlan/main.zeek`

57
doc/scripts/base/packet-protocols/vxlan/main.zeek.rst Normal file
View file

@ -0,0 +1,57 @@
:tocdepth: 3
base/packet-protocols/vxlan/main.zeek
=====================================
.. zeek:namespace:: PacketAnalyzer::VXLAN
:Namespace: PacketAnalyzer::VXLAN
Summary
~~~~~~~
Redefinable Options
###################
======================================================================================================== ============================================
:zeek:id:`PacketAnalyzer::VXLAN::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef`
:zeek:id:`PacketAnalyzer::VXLAN::vxlan_ports`: :zeek:type:`set` :zeek:attr:`&redef` The set of UDP ports used for VXLAN traffic.
======================================================================================================== ============================================
Redefinitions
#############
==================================================================== =
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
==================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::VXLAN::default_analyzer
:source-code: base/packet-protocols/vxlan/main.zeek 6 6
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_ETHERNET``
.. zeek:id:: PacketAnalyzer::VXLAN::vxlan_ports
:source-code: base/packet-protocols/vxlan/main.zeek 12 12
:Type: :zeek:type:`set` [:zeek:type:`port`]
:Attributes: :zeek:attr:`&redef`
:Default:
::
{
4789/udp
}
The set of UDP ports used for VXLAN traffic. Traffic using this
UDP destination port will attempt to be decapsulated. Note that if
if you customize this, you may still want to manually ensure that
:zeek:see:`likely_server_ports` also gets populated accordingly.