mirror of
https://github.com/zeek/zeek.git
synced 2025-10-10 10:38:20 +00:00
Fix typos and formatting in the conn protocol docs
This commit is contained in:
parent
72129ae7cf
commit
3850399fa2
3 changed files with 37 additions and 34 deletions
|
@ -16,12 +16,12 @@
|
||||||
module Conn;
|
module Conn;
|
||||||
|
|
||||||
export {
|
export {
|
||||||
## The prefix given to files containing extracted connections as they are
|
## The prefix given to files containing extracted connections as they
|
||||||
## opened on disk.
|
## are opened on disk.
|
||||||
const extraction_prefix = "contents" &redef;
|
const extraction_prefix = "contents" &redef;
|
||||||
|
|
||||||
## If this variable is set to ``T``, then all contents of all connections
|
## If this variable is set to ``T``, then all contents of all
|
||||||
## will be extracted.
|
## connections will be extracted.
|
||||||
const default_extract = F &redef;
|
const default_extract = F &redef;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
##! This script manages the tracking/logging of general information regarding
|
##! This script manages the tracking/logging of general information regarding
|
||||||
##! TCP, UDP, and ICMP traffic. For UDP and ICMP, "connections" are to
|
##! TCP, UDP, and ICMP traffic. For UDP and ICMP, "connections" are to
|
||||||
##! be interpreted using flow semantics (sequence of packets from a source
|
##! be interpreted using flow semantics (sequence of packets from a source
|
||||||
##! host/post to a destination host/port). Further, ICMP "ports" are to
|
##! host/port to a destination host/port). Further, ICMP "ports" are to
|
||||||
##! be interpreted as the source port meaning the ICMP message type and
|
##! be interpreted as the source port meaning the ICMP message type and
|
||||||
##! the destination port being the ICMP message code.
|
##! the destination port being the ICMP message code.
|
||||||
|
|
||||||
|
@ -23,7 +23,7 @@ export {
|
||||||
id: conn_id &log;
|
id: conn_id &log;
|
||||||
## The transport layer protocol of the connection.
|
## The transport layer protocol of the connection.
|
||||||
proto: transport_proto &log;
|
proto: transport_proto &log;
|
||||||
## An identification of an application protocol being sent over the
|
## An identification of an application protocol being sent over
|
||||||
## the connection.
|
## the connection.
|
||||||
service: string &log &optional;
|
service: string &log &optional;
|
||||||
## How long the connection lasted. For 3-way or 4-way connection
|
## How long the connection lasted. For 3-way or 4-way connection
|
||||||
|
@ -31,9 +31,10 @@ export {
|
||||||
duration: interval &log &optional;
|
duration: interval &log &optional;
|
||||||
## The number of payload bytes the originator sent. For TCP
|
## The number of payload bytes the originator sent. For TCP
|
||||||
## this is taken from sequence numbers and might be inaccurate
|
## this is taken from sequence numbers and might be inaccurate
|
||||||
## (e.g., due to large connections)
|
## (e.g., due to large connections).
|
||||||
orig_bytes: count &log &optional;
|
orig_bytes: count &log &optional;
|
||||||
## The number of payload bytes the responder sent. See ``orig_bytes``.
|
## The number of payload bytes the responder sent. See
|
||||||
|
## *orig_bytes*.
|
||||||
resp_bytes: count &log &optional;
|
resp_bytes: count &log &optional;
|
||||||
|
|
||||||
## ========== ===============================================
|
## ========== ===============================================
|
||||||
|
@ -55,20 +56,20 @@ export {
|
||||||
## ========== ===============================================
|
## ========== ===============================================
|
||||||
conn_state: string &log &optional;
|
conn_state: string &log &optional;
|
||||||
|
|
||||||
## If the connection is originated locally, this value will be T. If
|
## If the connection is originated locally, this value will be T.
|
||||||
## it was originated remotely it will be F. In the case that the
|
## If it was originated remotely it will be F. In the case that
|
||||||
## :bro:id:`Site::local_nets` variable is undefined, this field will
|
## the :bro:id:`Site::local_nets` variable is undefined, this
|
||||||
## be left empty at all times.
|
## field will be left empty at all times.
|
||||||
local_orig: bool &log &optional;
|
local_orig: bool &log &optional;
|
||||||
|
|
||||||
## Indicates the number of bytes missed in content gaps, which is
|
## Indicates the number of bytes missed in content gaps, which
|
||||||
## representative of packet loss. A value other than zero will
|
## is representative of packet loss. A value other than zero
|
||||||
## normally cause protocol analysis to fail but some analysis may
|
## will normally cause protocol analysis to fail but some
|
||||||
## have been completed prior to the packet loss.
|
## analysis may have been completed prior to the packet loss.
|
||||||
missed_bytes: count &log &default=0;
|
missed_bytes: count &log &default=0;
|
||||||
|
|
||||||
## Records the state history of connections as a string of letters.
|
## Records the state history of connections as a string of
|
||||||
## The meaning of those letters is:
|
## letters. The meaning of those letters is:
|
||||||
##
|
##
|
||||||
## ====== ====================================================
|
## ====== ====================================================
|
||||||
## Letter Meaning
|
## Letter Meaning
|
||||||
|
@ -83,24 +84,25 @@ export {
|
||||||
## i inconsistent packet (e.g. SYN+RST bits both set)
|
## i inconsistent packet (e.g. SYN+RST bits both set)
|
||||||
## ====== ====================================================
|
## ====== ====================================================
|
||||||
##
|
##
|
||||||
## If the event comes from the originator, the letter is in upper-case; if it comes
|
## If the event comes from the originator, the letter is in
|
||||||
## from the responder, it's in lower-case. Multiple packets of the same type will
|
## upper-case; if it comes from the responder, it's in
|
||||||
## only be noted once (e.g. we only record one "d" in each direction, regardless of
|
## lower-case. Multiple packets of the same type will only be
|
||||||
## how many data packets were seen.)
|
## noted once (e.g. we only record one "d" in each direction,
|
||||||
|
## regardless of how many data packets were seen.)
|
||||||
history: string &log &optional;
|
history: string &log &optional;
|
||||||
## Number of packets that the originator sent.
|
## Number of packets that the originator sent.
|
||||||
## Only set if :bro:id:`use_conn_size_analyzer` = T
|
## Only set if :bro:id:`use_conn_size_analyzer` = T.
|
||||||
orig_pkts: count &log &optional;
|
orig_pkts: count &log &optional;
|
||||||
## Number of IP level bytes that the originator sent (as seen on the wire,
|
## Number of IP level bytes that the originator sent (as seen on
|
||||||
## taken from IP total_length header field).
|
## the wire, taken from the IP total_length header field).
|
||||||
## Only set if :bro:id:`use_conn_size_analyzer` = T
|
## Only set if :bro:id:`use_conn_size_analyzer` = T.
|
||||||
orig_ip_bytes: count &log &optional;
|
orig_ip_bytes: count &log &optional;
|
||||||
## Number of packets that the responder sent.
|
## Number of packets that the responder sent.
|
||||||
## Only set if :bro:id:`use_conn_size_analyzer` = T
|
## Only set if :bro:id:`use_conn_size_analyzer` = T.
|
||||||
resp_pkts: count &log &optional;
|
resp_pkts: count &log &optional;
|
||||||
## Number og IP level bytes that the responder sent (as seen on the wire,
|
## Number of IP level bytes that the responder sent (as seen on
|
||||||
## taken from IP total_length header field).
|
## the wire, taken from the IP total_length header field).
|
||||||
## Only set if :bro:id:`use_conn_size_analyzer` = T
|
## Only set if :bro:id:`use_conn_size_analyzer` = T.
|
||||||
resp_ip_bytes: count &log &optional;
|
resp_ip_bytes: count &log &optional;
|
||||||
## If this connection was over a tunnel, indicate the
|
## If this connection was over a tunnel, indicate the
|
||||||
## *uid* values for any encapsulating parent connections
|
## *uid* values for any encapsulating parent connections
|
||||||
|
|
|
@ -11,10 +11,11 @@ export {
|
||||||
## c: The connection to watch.
|
## c: The connection to watch.
|
||||||
##
|
##
|
||||||
## callback: A callback function that takes as arguments the monitored
|
## callback: A callback function that takes as arguments the monitored
|
||||||
## *connection*, and counter *cnt* that increments each time the
|
## *connection*, and counter *cnt* that increments each time
|
||||||
## callback is called. It returns an interval indicating how long
|
## the callback is called. It returns an interval indicating
|
||||||
## in the future to schedule an event which will call the
|
## how long in the future to schedule an event which will call
|
||||||
## callback. A negative return interval causes polling to stop.
|
## the callback. A negative return interval causes polling
|
||||||
|
## to stop.
|
||||||
##
|
##
|
||||||
## cnt: The initial value of a counter which gets passed to *callback*.
|
## cnt: The initial value of a counter which gets passed to *callback*.
|
||||||
##
|
##
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue