mirror of
https://github.com/zeek/zeek.git
synced 2025-10-05 08:08:19 +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/sip/__load__.bro.rst
Normal file
14
doc/scripts/base/protocols/sip/__load__.bro.rst
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/sip/__load__.bro
|
||||
===============================
|
||||
|
||||
|
||||
:Imports: :doc:`base/protocols/sip/main.bro </scripts/base/protocols/sip/main.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
16
doc/scripts/base/protocols/sip/index.rst
Normal file
16
doc/scripts/base/protocols/sip/index.rst
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/protocols/sip
|
||||
===========================
|
||||
|
||||
Support for Session Initiation Protocol (SIP) analysis.
|
||||
|
||||
:doc:`/scripts/base/protocols/sip/__load__.bro`
|
||||
|
||||
|
||||
:doc:`/scripts/base/protocols/sip/main.bro`
|
||||
|
||||
Implements base functionality for SIP analysis. The logging model is
|
||||
to log request/response pairs and all relevant metadata together in
|
||||
a single record.
|
||||
|
||||
180
doc/scripts/base/protocols/sip/main.bro.rst
Normal file
180
doc/scripts/base/protocols/sip/main.bro.rst
Normal file
|
|
@ -0,0 +1,180 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/sip/main.bro
|
||||
===========================
|
||||
.. bro:namespace:: SIP
|
||||
|
||||
Implements base functionality for SIP analysis. The logging model is
|
||||
to log request/response pairs and all relevant metadata together in
|
||||
a single record.
|
||||
|
||||
:Namespace: SIP
|
||||
:Imports: :doc:`base/utils/files.bro </scripts/base/utils/files.bro>`, :doc:`base/utils/numbers.bro </scripts/base/utils/numbers.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
============================================================== ======================
|
||||
:bro:id:`SIP::sip_methods`: :bro:type:`set` :bro:attr:`&redef` A list of SIP methods.
|
||||
============================================================== ======================
|
||||
|
||||
Types
|
||||
#####
|
||||
========================================== =========================================================
|
||||
:bro:type:`SIP::Info`: :bro:type:`record` The record type which contains the fields of the SIP log.
|
||||
:bro:type:`SIP::State`: :bro:type:`record`
|
||||
========================================== =========================================================
|
||||
|
||||
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:`SIP::log_sip`: :bro:type:`event` Event that can be handled to access the SIP record as it is sent on
|
||||
to the logging framework.
|
||||
========================================= ===================================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
.. bro:id:: SIP::sip_methods
|
||||
|
||||
:Type: :bro:type:`set` [:bro:type:`string`]
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"NOTIFY",
|
||||
"ACK",
|
||||
"SUBSCRIBE",
|
||||
"CANCEL",
|
||||
"OPTIONS",
|
||||
"REGISTER",
|
||||
"INVITE",
|
||||
"BYE"
|
||||
}
|
||||
|
||||
A list of SIP methods. Other methods will generate a weird. Note
|
||||
that the SIP analyzer will only accept methods consisting solely
|
||||
of letters ``[A-Za-z]``.
|
||||
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: SIP::Info
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
ts: :bro:type:`time` :bro:attr:`&log`
|
||||
Timestamp for when the request happened.
|
||||
|
||||
uid: :bro:type:`string` :bro:attr:`&log`
|
||||
Unique ID for the connection.
|
||||
|
||||
id: :bro:type:`conn_id` :bro:attr:`&log`
|
||||
The connection's 4-tuple of endpoint addresses/ports.
|
||||
|
||||
trans_depth: :bro:type:`count` :bro:attr:`&log`
|
||||
Represents the pipelined depth into the connection of this
|
||||
request/response transaction.
|
||||
|
||||
method: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Verb used in the SIP request (INVITE, REGISTER etc.).
|
||||
|
||||
uri: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
URI used in the request.
|
||||
|
||||
date: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the Date: header from the client
|
||||
|
||||
request_from: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the request From: header
|
||||
Note: The tag= value that's usually appended to the sender
|
||||
is stripped off and not logged.
|
||||
|
||||
request_to: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the To: header
|
||||
|
||||
response_from: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the response From: header
|
||||
Note: The ``tag=`` value that's usually appended to the sender
|
||||
is stripped off and not logged.
|
||||
|
||||
response_to: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the response To: header
|
||||
|
||||
reply_to: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the Reply-To: header
|
||||
|
||||
call_id: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the Call-ID: header from the client
|
||||
|
||||
seq: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the CSeq: header from the client
|
||||
|
||||
subject: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the Subject: header from the client
|
||||
|
||||
request_path: :bro:type:`vector` of :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
The client message transmission path, as extracted from the headers.
|
||||
|
||||
response_path: :bro:type:`vector` of :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
The server message transmission path, as extracted from the headers.
|
||||
|
||||
user_agent: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the User-Agent: header from the client
|
||||
|
||||
status_code: :bro:type:`count` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Status code returned by the server.
|
||||
|
||||
status_msg: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Status message returned by the server.
|
||||
|
||||
warning: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the Warning: header
|
||||
|
||||
request_body_len: :bro:type:`count` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the Content-Length: header from the client
|
||||
|
||||
response_body_len: :bro:type:`count` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the Content-Length: header from the server
|
||||
|
||||
content_type: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Contents of the Content-Type: header from the server
|
||||
|
||||
The record type which contains the fields of the SIP log.
|
||||
|
||||
.. bro:type:: SIP::State
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
pending: :bro:type:`table` [:bro:type:`count`] of :bro:type:`SIP::Info`
|
||||
Pending requests.
|
||||
|
||||
current_request: :bro:type:`count` :bro:attr:`&default` = ``0`` :bro:attr:`&optional`
|
||||
Current request in the pending queue.
|
||||
|
||||
current_response: :bro:type:`count` :bro:attr:`&default` = ``0`` :bro:attr:`&optional`
|
||||
Current response in the pending queue.
|
||||
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: SIP::log_sip
|
||||
|
||||
:Type: :bro:type:`event` (rec: :bro:type:`SIP::Info`)
|
||||
|
||||
Event that can be handled to access the SIP record as it is sent on
|
||||
to the logging framework.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue