mirror of
https://github.com/zeek/zeek.git
synced 2025-10-04 23:58:20 +00:00
Remove broxygen Sphinx integration
The broxygen-generated files now live in the git repo, have tests that check that they are up-to-date, and a script to re-generate them on-demand.
This commit is contained in:
Jon Siwek
parent
9e5e9d04b7
commit
7e9d48f532
549 changed files with 89909 additions and 100 deletions
14
doc/scripts/base/protocols/socks/__load__.bro.rst
Normal file
14
doc/scripts/base/protocols/socks/__load__.bro.rst
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/socks/__load__.bro
|
||||
=================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/protocols/socks/consts.bro </scripts/base/protocols/socks/consts.bro>`, :doc:`base/protocols/socks/main.bro </scripts/base/protocols/socks/main.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
102
doc/scripts/base/protocols/socks/consts.bro.rst
Normal file
102
doc/scripts/base/protocols/socks/consts.bro.rst
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/socks/consts.bro
|
||||
===============================
|
||||
.. bro:namespace:: SOCKS
|
||||
|
||||
|
||||
:Namespace: SOCKS
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Constants
|
||||
#########
|
||||
=============================================================================================================================== =
|
||||
:bro:id:`SOCKS::v4_status`: :bro:type:`table` :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
|
||||
:bro:id:`SOCKS::v5_authentication_methods`: :bro:type:`table` :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
|
||||
:bro:id:`SOCKS::v5_status`: :bro:type:`table` :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
|
||||
=============================================================================================================================== =
|
||||
|
||||
Types
|
||||
#####
|
||||
================================================ =
|
||||
:bro:type:`SOCKS::RequestType`: :bro:type:`enum`
|
||||
================================================ =
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Constants
|
||||
#########
|
||||
.. bro:id:: SOCKS::v4_status
|
||||
|
||||
:Type: :bro:type:`table` [:bro:type:`count`] of :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
|
||||
:Default:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
[91] = "general SOCKS server failure",
|
||||
[93] = "request failed because client's identd could not confirm the user ID string in the request",
|
||||
[92] = "request failed because client is not running identd",
|
||||
[90] = "succeeded"
|
||||
}
|
||||
|
||||
|
||||
.. bro:id:: SOCKS::v5_authentication_methods
|
||||
|
||||
:Type: :bro:type:`table` [:bro:type:`count`] of :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
|
||||
:Default:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
[2] = "Username/Password",
|
||||
[6] = "Secure Sockets Layer",
|
||||
[1] = "GSSAPI",
|
||||
[8] = "Multi-Authentication Framework",
|
||||
[7] = "NDS Authentication",
|
||||
[255] = "No Acceptable Methods",
|
||||
[5] = "Challenge-Response Authentication Method",
|
||||
[0] = "No Authentication Required",
|
||||
[3] = "Challenge-Handshake Authentication Protocol"
|
||||
}
|
||||
|
||||
|
||||
.. bro:id:: SOCKS::v5_status
|
||||
|
||||
:Type: :bro:type:`table` [:bro:type:`count`] of :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
|
||||
:Default:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
[2] = "connection not allowed by ruleset",
|
||||
[6] = "TTL expired",
|
||||
[4] = "Host unreachable",
|
||||
[1] = "general SOCKS server failure",
|
||||
[8] = "Address type not supported",
|
||||
[7] = "Command not supported",
|
||||
[5] = "Connection refused",
|
||||
[0] = "succeeded",
|
||||
[3] = "Network unreachable"
|
||||
}
|
||||
|
||||
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: SOCKS::RequestType
|
||||
|
||||
:Type: :bro:type:`enum`
|
||||
|
||||
.. bro:enum:: SOCKS::CONNECTION SOCKS::RequestType
|
||||
|
||||
.. bro:enum:: SOCKS::PORT SOCKS::RequestType
|
||||
|
||||
.. bro:enum:: SOCKS::UDP_ASSOCIATE SOCKS::RequestType
|
||||
|
||||
|
||||
|
||||
16
doc/scripts/base/protocols/socks/index.rst
Normal file
16
doc/scripts/base/protocols/socks/index.rst
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/protocols/socks
|
||||
=============================
|
||||
|
||||
Support for Socket Secure (SOCKS) protocol analysis.
|
||||
|
||||
:doc:`/scripts/base/protocols/socks/__load__.bro`
|
||||
|
||||
|
||||
:doc:`/scripts/base/protocols/socks/consts.bro`
|
||||
|
||||
|
||||
:doc:`/scripts/base/protocols/socks/main.bro`
|
||||
|
||||
|
||||
108
doc/scripts/base/protocols/socks/main.bro.rst
Normal file
108
doc/scripts/base/protocols/socks/main.bro.rst
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/socks/main.bro
|
||||
=============================
|
||||
.. bro:namespace:: SOCKS
|
||||
|
||||
|
||||
:Namespace: SOCKS
|
||||
:Imports: :doc:`base/frameworks/tunnels </scripts/base/frameworks/tunnels/index>`, :doc:`base/protocols/socks/consts.bro </scripts/base/protocols/socks/consts.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
============================================================================== ======================================
|
||||
:bro:id:`SOCKS::default_capture_password`: :bro:type:`bool` :bro:attr:`&redef` Whether passwords are captured or not.
|
||||
============================================================================== ======================================
|
||||
|
||||
Types
|
||||
#####
|
||||
=========================================== ===========================================================
|
||||
:bro:type:`SOCKS::Info`: :bro:type:`record` The record type which contains the fields of the SOCKS log.
|
||||
=========================================== ===========================================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
================================================================= =
|
||||
:bro:type:`Log::ID`: :bro:type:`enum`
|
||||
:bro:type:`connection`: :bro:type:`record`
|
||||
:bro:id:`likely_server_ports`: :bro:type:`set` :bro:attr:`&redef`
|
||||
================================================================= =
|
||||
|
||||
Events
|
||||
######
|
||||
============================================= =================================================
|
||||
:bro:id:`SOCKS::log_socks`: :bro:type:`event` Event that can be handled to access the SOCKS
|
||||
record as it is sent on to the logging framework.
|
||||
============================================= =================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
.. bro:id:: SOCKS::default_capture_password
|
||||
|
||||
:Type: :bro:type:`bool`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``F``
|
||||
|
||||
Whether passwords are captured or not.
|
||||
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: SOCKS::Info
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
ts: :bro:type:`time` :bro:attr:`&log`
|
||||
Time when the proxy connection was first detected.
|
||||
|
||||
uid: :bro:type:`string` :bro:attr:`&log`
|
||||
Unique ID for the tunnel - may correspond to connection uid
|
||||
or be non-existent.
|
||||
|
||||
id: :bro:type:`conn_id` :bro:attr:`&log`
|
||||
The connection's 4-tuple of endpoint addresses/ports.
|
||||
|
||||
version: :bro:type:`count` :bro:attr:`&log`
|
||||
Protocol version of SOCKS.
|
||||
|
||||
user: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Username used to request a login to the proxy.
|
||||
|
||||
password: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Password used to request a login to the proxy.
|
||||
|
||||
status: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Server status for the attempt at using the proxy.
|
||||
|
||||
request: :bro:type:`SOCKS::Address` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Client requested SOCKS address. Could be an address, a name
|
||||
or both.
|
||||
|
||||
request_p: :bro:type:`port` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Client requested port.
|
||||
|
||||
bound: :bro:type:`SOCKS::Address` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Server bound address. Could be an address, a name or both.
|
||||
|
||||
bound_p: :bro:type:`port` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Server bound port.
|
||||
|
||||
capture_password: :bro:type:`bool` :bro:attr:`&default` = :bro:see:`SOCKS::default_capture_password` :bro:attr:`&optional`
|
||||
Determines if the password will be captured for this request.
|
||||
|
||||
The record type which contains the fields of the SOCKS log.
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: SOCKS::log_socks
|
||||
|
||||
:Type: :bro:type:`event` (rec: :bro:type:`SOCKS::Info`)
|
||||
|
||||
Event that can be handled to access the SOCKS
|
||||
record as it is sent on to the logging framework.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue