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

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

32
doc/scripts/policy/protocols/dhcp/msg-orig.zeek.rst Normal file
View file

@ -0,0 +1,32 @@
:tocdepth: 3
policy/protocols/dhcp/msg-orig.zeek
===================================
.. zeek:namespace:: DHCP
Add a field that logs the order of hosts sending messages
using the same DHCP transaction ID. This information is
occasionally needed on some networks to fully explain the
DHCP sequence.
:Namespace: DHCP
:Imports: :doc:`base/protocols/dhcp </scripts/base/protocols/dhcp/index>`
Summary
~~~~~~~
Redefinitions
#############
============================================ ============================================================================================================================
:zeek:type:`DHCP::Info`: :zeek:type:`record`
:New Fields: :zeek:type:`DHCP::Info`
msg_orig: :zeek:type:`vector` of :zeek:type:`addr` :zeek:attr:`&log` :zeek:attr:`&default` = ``[]`` :zeek:attr:`&optional`
The address that originated each message from the
`msg_types` field.
============================================ ============================================================================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~

38
doc/scripts/policy/protocols/dhcp/software.zeek.rst Normal file
View file

@ -0,0 +1,38 @@
:tocdepth: 3
policy/protocols/dhcp/software.zeek
===================================
.. zeek:namespace:: DHCP
Software identification and extraction for DHCP traffic.
:Namespace: DHCP
:Imports: :doc:`base/frameworks/software </scripts/base/frameworks/software/index>`, :doc:`base/protocols/dhcp </scripts/base/protocols/dhcp/index>`
Summary
~~~~~~~
Redefinitions
#############
============================================== ===============================================================================
:zeek:type:`DHCP::Info`: :zeek:type:`record`
:New Fields: :zeek:type:`DHCP::Info`
client_software: :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
Software reported by the client in the `vendor_class` option.
server_software: :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
Software reported by the server in the `vendor_class` option.
:zeek:type:`Software::Type`: :zeek:type:`enum`
* :zeek:enum:`DHCP::CLIENT`:
Identifier for web browsers in the software framework.
* :zeek:enum:`DHCP::SERVER`:
Identifier for web servers in the software framework.
============================================== ===============================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~

38
doc/scripts/policy/protocols/dhcp/sub-opts.zeek.rst Normal file
View file

@ -0,0 +1,38 @@
:tocdepth: 3
policy/protocols/dhcp/sub-opts.zeek
===================================
.. zeek:namespace:: DHCP
:Namespace: DHCP
:Imports: :doc:`base/protocols/dhcp </scripts/base/protocols/dhcp/index>`
Summary
~~~~~~~
Redefinitions
#############
============================================ ===============================================================================
:zeek:type:`DHCP::Info`: :zeek:type:`record`
:New Fields: :zeek:type:`DHCP::Info`
circuit_id: :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
Added by DHCP relay agents which terminate switched or
permanent circuits.
agent_remote_id: :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
A globally unique identifier added by relay agents to identify
the remote host end of the circuit.
subscriber_id: :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
The subscriber ID is a value independent of the physical
network configuration so that a customer's DHCP configuration
can be given to them correctly no matter where they are
physically connected.
============================================ ===============================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~