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

Fix typos and formatting in various other framework docs

Browse source
This commit is contained in:
Daniel Thayer 2013-10-10 23:18:27 -05:00
parent 960ddc22d1
commit 50aca717d0
4 changed files with 16 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

18
scripts/base/frameworks/analyzer/main.bro
View file

@ -5,8 +5,8 @@
##! particular analyzer for new connections. ##! particular analyzer for new connections.
##! ##!
##! Protocol analyzers are identified by unique tags of type ##! Protocol analyzers are identified by unique tags of type
##! :bro:type:`Analyzer::Tag`, such as :bro:enum:`Analyzer::ANALYZER_HTTP` and ##! :bro:type:`Analyzer::Tag`, such as :bro:enum:`Analyzer::ANALYZER_HTTP`.
##! :bro:enum:`Analyzer::ANALYZER_HTTP`. These tags are defined internally by ##! These tags are defined internally by
##! the analyzers themselves, and documented in their analyzer-specific ##! the analyzers themselves, and documented in their analyzer-specific
##! description along with the events that they generate. ##! description along with the events that they generate.
@ -15,8 +15,8 @@
module Analyzer; module Analyzer;
export { export {
## If true, all available analyzers are initially disabled at startup. One ## If true, all available analyzers are initially disabled at startup.
## can then selectively enable them with ## One can then selectively enable them with
## :bro:id:`Analyzer::enable_analyzer`. ## :bro:id:`Analyzer::enable_analyzer`.
global disable_all = F &redef; global disable_all = F &redef;
@ -45,7 +45,7 @@ export {
## ##
## ports: The set of well-known ports to associate with the analyzer. ## ports: The set of well-known ports to associate with the analyzer.
## ##
## Returns: True if the ports were sucessfully registered. ## Returns: True if the ports were successfully registered.
global register_for_ports: function(tag: Analyzer::Tag, ports: set[port]) : bool; global register_for_ports: function(tag: Analyzer::Tag, ports: set[port]) : bool;
## Registers an individual well-known port for an analyzer. If a future ## Registers an individual well-known port for an analyzer. If a future
@ -57,7 +57,7 @@ export {
## ##
## p: The well-known port to associate with the analyzer. ## p: The well-known port to associate with the analyzer.
## ##
## Returns: True if the port was sucessfully registered. ## Returns: True if the port was successfully registered.
global register_for_port: function(tag: Analyzer::Tag, p: port) : bool; global register_for_port: function(tag: Analyzer::Tag, p: port) : bool;
## Returns a set of all well-known ports currently registered for a ## Returns a set of all well-known ports currently registered for a
@ -88,8 +88,8 @@ export {
## Returns: The analyzer tag corresponding to the name. ## Returns: The analyzer tag corresponding to the name.
global get_tag: function(name: string): Analyzer::Tag; global get_tag: function(name: string): Analyzer::Tag;
## Schedules an analyzer for a future connection originating from a given IP ## Schedules an analyzer for a future connection originating from a
## address and port. ## given IP address and port.
## ##
## orig: The IP address originating a connection in the future. ## orig: The IP address originating a connection in the future.
## 0.0.0.0 can be used as a wildcard to match any originator address. ## 0.0.0.0 can be used as a wildcard to match any originator address.
@ -103,7 +103,7 @@ export {
## tout: A timeout interval after which the scheduling request will be ## tout: A timeout interval after which the scheduling request will be
## discarded if the connection has not yet been seen. ## discarded if the connection has not yet been seen.
## ##
## Returns: True if succesful. ## Returns: True if successful.
global schedule_analyzer: function(orig: addr, resp: addr, resp_p: port, global schedule_analyzer: function(orig: addr, resp: addr, resp_p: port,
analyzer: Analyzer::Tag, tout: interval) : bool; analyzer: Analyzer::Tag, tout: interval) : bool;

3
scripts/base/frameworks/control/main.bro
View file

@ -57,7 +57,8 @@ export {
## Returns the current net_stats. ## Returns the current net_stats.
global net_stats_response: event(s: string); global net_stats_response: event(s: string);
## Inform the remote Bro instance that it's configuration may have been updated. ## Inform the remote Bro instance that it's configuration may have been
## updated.
global configuration_update_request: event(); global configuration_update_request: event();
## This event is a wrapper and alias for the ## This event is a wrapper and alias for the
## :bro:id:`Control::configuration_update_request` event. ## :bro:id:`Control::configuration_update_request` event.

2
scripts/base/frameworks/reporter/main.bro
View file

@ -7,7 +7,7 @@
##! :bro:see:`Reporter::errors_to_stderr`. ##! :bro:see:`Reporter::errors_to_stderr`.
##! ##!
##! Note that this framework deals with the handling of internally generated ##! Note that this framework deals with the handling of internally generated
##! reporter messages, for the interface in to actually creating interface ##! reporter messages, for the interface
##! into actually creating reporter messages from the scripting layer, use ##! into actually creating reporter messages from the scripting layer, use
##! the built-in functions in :doc:`/scripts/base/bif/reporter.bif`. ##! the built-in functions in :doc:`/scripts/base/bif/reporter.bif`.

8
scripts/base/frameworks/tunnels/main.bro
View file

@ -29,8 +29,8 @@ export {
## The unique identifier for the tunnel, which may correspond ## The unique identifier for the tunnel, which may correspond
## to a :bro:type:`connection`'s *uid* field for non-IP-in-IP tunnels. ## to a :bro:type:`connection`'s *uid* field for non-IP-in-IP tunnels.
## This is optional because there could be numerous connections ## This is optional because there could be numerous connections
## for payload proxies like SOCKS but we should treat it as a single ## for payload proxies like SOCKS but we should treat it as a
## tunnel. ## single tunnel.
uid: string &log &optional; uid: string &log &optional;
## The tunnel "connection" 4-tuple of endpoint addresses/ports. ## The tunnel "connection" 4-tuple of endpoint addresses/ports.
## For an IP tunnel, the ports will be 0. ## For an IP tunnel, the ports will be 0.
@ -76,8 +76,8 @@ export {
## connections before it is considered inactive/expired. ## connections before it is considered inactive/expired.
const expiration_interval = 1hrs &redef; const expiration_interval = 1hrs &redef;
## Currently active tunnels. That is, tunnels for which new, encapsulated ## Currently active tunnels. That is, tunnels for which new,
## connections have been seen in the interval indicated by ## encapsulated connections have been seen in the interval indicated by
## :bro:see:`Tunnel::expiration_interval`. ## :bro:see:`Tunnel::expiration_interval`.
global active: table[conn_id] of Info = table() &read_expire=expiration_interval &expire_func=expire; global active: table[conn_id] of Info = table() &read_expire=expiration_interval &expire_func=expire;
} }