Copy docs into Zeek repo directly

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

View file

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

View file

@ -0,0 +1,18 @@
:orphan:
Package: base/protocols/finger
==============================
:doc:`/scripts/base/protocols/finger/__load__.zeek`
:doc:`/scripts/base/protocols/finger/spicy-events.zeek`
Events generated by the Finger analyzer.
:doc:`/scripts/base/protocols/finger/main.zeek`
Implements base functionality for Finger analysis. We currently do not generate
a log file, but just configure the analyzer.

View file

@ -0,0 +1,45 @@
:tocdepth: 3
base/protocols/finger/main.zeek
===============================
.. zeek:namespace:: Finger
Implements base functionality for Finger analysis. We currently do not generate
a log file, but just configure the analyzer.
:Namespace: Finger
Summary
~~~~~~~
Constants
#########
========================================== =
:zeek:id:`Finger::ports`: :zeek:type:`set`
========================================== =
Redefinitions
#############
==================================================================== =
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
==================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Constants
#########
.. zeek:id:: Finger::ports
:source-code: base/protocols/finger/main.zeek 7 7
:Type: :zeek:type:`set` [:zeek:type:`port`]
:Default:
::
{
79/tcp
}

View file

@ -0,0 +1,65 @@
:tocdepth: 3
base/protocols/finger/spicy-events.zeek
=======================================
Events generated by the Finger analyzer.
Summary
~~~~~~~
Events
######
============================================= ==============================
:zeek:id:`finger_reply`: :zeek:type:`event` Generated for Finger replies.
:zeek:id:`finger_request`: :zeek:type:`event` Generated for Finger requests.
============================================= ==============================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. zeek:id:: finger_reply
:source-code: base/protocols/finger/spicy-events.zeek 31 31
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, reply_line: :zeek:type:`string`)
Generated for Finger replies.
See `Wikipedia <http://en.wikipedia.org/wiki/Finger_protocol>`__ for more
information about the Finger protocol.
:param c: The connection.
:param reply_line: The reply as returned by the server
.. zeek:see:: finger_request
.. zeek:id:: finger_request
:source-code: base/protocols/finger/spicy-events.zeek 19 19
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, full: :zeek:type:`bool`, username: :zeek:type:`string`, hostname: :zeek:type:`string`)
Generated for Finger requests.
See `Wikipedia <http://en.wikipedia.org/wiki/Finger_protocol>`__ for more
information about the Finger protocol.
:param c: The connection.
:param full: True if verbose information is requested (``/W`` switch).
:param username: The request's user name.
:param hostname: The request's host name.
.. zeek:see:: finger_reply