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

Fix formatting in the protocol BiFs docs

Browse source
This commit is contained in:
Daniel Thayer 2013-10-18 19:36:37 -05:00
parent 8bfb81ca6f
commit 023ea4b588
2 changed files with 17 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

26
src/analyzer/protocol/ftp/functions.bif
View file

@ -116,11 +116,12 @@ static Val* parse_eftp(const char* line)
} }
%%} %%}
## Converts a string representation of the FTP PORT command to an ``ftp_port``. ## Converts a string representation of the FTP PORT command to an
## :bro:type:`ftp_port`.
## ##
## s: The string of the FTP PORT command, e.g., ``"10,0,0,1,4,31"``. ## s: The string of the FTP PORT command, e.g., ``"10,0,0,1,4,31"``.
## ##
## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]`` ## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]``.
## ##
## .. bro:see:: parse_eftp_port parse_ftp_pasv parse_ftp_epsv fmt_ftp_port ## .. bro:see:: parse_eftp_port parse_ftp_pasv parse_ftp_epsv fmt_ftp_port
function parse_ftp_port%(s: string%): ftp_port function parse_ftp_port%(s: string%): ftp_port
@ -128,14 +129,14 @@ function parse_ftp_port%(s: string%): ftp_port
return parse_port(s->CheckString()); return parse_port(s->CheckString());
%} %}
## Converts a string representation of the FTP EPRT command to an ``ftp_port``. ## Converts a string representation of the FTP EPRT command (see :rfc:`2428`)
## See `RFC 2428 <http://tools.ietf.org/html/rfc2428>`_. ## to an :bro:type:`ftp_port`. The format is
## The format is ``EPRT<space><d><net-prt><d><net-addr><d><tcp-port><d>``, ## ``"EPRT<space><d><net-prt><d><net-addr><d><tcp-port><d>"``,
## where ``<d>`` is a delimiter in the ASCII range 33-126 (usually ``|``). ## where ``<d>`` is a delimiter in the ASCII range 33-126 (usually ``|``).
## ##
## s: The string of the FTP EPRT command, e.g., ``"|1|10.0.0.1|1055|"``. ## s: The string of the FTP EPRT command, e.g., ``"|1|10.0.0.1|1055|"``.
## ##
## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]`` ## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]``.
## ##
## .. bro:see:: parse_ftp_port parse_ftp_pasv parse_ftp_epsv fmt_ftp_port ## .. bro:see:: parse_ftp_port parse_ftp_pasv parse_ftp_epsv fmt_ftp_port
function parse_eftp_port%(s: string%): ftp_port function parse_eftp_port%(s: string%): ftp_port
@ -143,11 +144,11 @@ function parse_eftp_port%(s: string%): ftp_port
return parse_eftp(s->CheckString()); return parse_eftp(s->CheckString());
%} %}
## Converts the result of the FTP PASV command to an ``ftp_port``. ## Converts the result of the FTP PASV command to an :bro:type:`ftp_port`.
## ##
## str: The string containing the result of the FTP PASV command. ## str: The string containing the result of the FTP PASV command.
## ##
## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]`` ## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]``.
## ##
## .. bro:see:: parse_ftp_port parse_eftp_port parse_ftp_epsv fmt_ftp_port ## .. bro:see:: parse_ftp_port parse_eftp_port parse_ftp_epsv fmt_ftp_port
function parse_ftp_pasv%(str: string%): ftp_port function parse_ftp_pasv%(str: string%): ftp_port
@ -168,14 +169,13 @@ function parse_ftp_pasv%(str: string%): ftp_port
return parse_port(line); return parse_port(line);
%} %}
## Converts the result of the FTP EPSV command to an ``ftp_port``. ## Converts the result of the FTP EPSV command (see :rfc:`2428`) to an
## See `RFC 2428 <http://tools.ietf.org/html/rfc2428>`_. ## :bro:type:`ftp_port`. The format is ``"<text> (<d><d><d><tcp-port><d>)"``,
## The format is ``<text> (<d><d><d><tcp-port><d>)``, where ``<d>`` is a ## where ``<d>`` is a delimiter in the ASCII range 33-126 (usually ``|``).
## delimiter in the ASCII range 33-126 (usually ``|``).
## ##
## str: The string containing the result of the FTP EPSV command. ## str: The string containing the result of the FTP EPSV command.
## ##
## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]`` ## Returns: The FTP PORT, e.g., ``[h=10.0.0.1, p=1055/tcp, valid=T]``.
## ##
## .. bro:see:: parse_ftp_port parse_eftp_port parse_ftp_pasv fmt_ftp_port ## .. bro:see:: parse_ftp_port parse_eftp_port parse_ftp_pasv fmt_ftp_port
function parse_ftp_epsv%(str: string%): ftp_port function parse_ftp_epsv%(str: string%): ftp_port

9
src/analyzer/protocol/tcp/functions.bif
View file

@ -93,13 +93,12 @@ function get_gap_summary%(%): gap_info
## ##
## - ``CONTENTS_NONE``: Stop recording the connection's content. ## - ``CONTENTS_NONE``: Stop recording the connection's content.
## - ``CONTENTS_ORIG``: Record the data sent by the connection ## - ``CONTENTS_ORIG``: Record the data sent by the connection
## originator (often the client). ## originator (often the client).
## - ``CONTENTS_RESP``: Record the data sent by the connection ## - ``CONTENTS_RESP``: Record the data sent by the connection
## responder (often the server). ## responder (often the server).
## - ``CONTENTS_BOTH``: Record the data sent in both directions. ## - ``CONTENTS_BOTH``: Record the data sent in both directions.
## Results in the two directions being ## Results in the two directions being intermixed in the file,
## intermixed in the file, in the order the ## in the order the data was seen by Bro.
## data was seen by Bro.
## ##
## f: The file handle of the file to write the contents to. ## f: The file handle of the file to write the contents to.
## ##