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

Fix typos and formatting in the software framework docs

Browse source
This commit is contained in:
Daniel Thayer 2013-10-10 23:16:19 -05:00
parent 0753853726
commit 960ddc22d1
1 changed files with 17 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

33
scripts/base/frameworks/software/main.bro
View file

@ -1,5 +1,5 @@
##! This script provides the framework for software version detection and ##! This script provides the framework for software version detection and
##! parsing but doesn't actually do any detection on it's own. It relys on ##! parsing but doesn't actually do any detection on it's own. It relies on
##! other protocol specific scripts to parse out software from the protocols ##! other protocol specific scripts to parse out software from the protocols
##! that they analyze. The entry point for providing new software detections ##! that they analyze. The entry point for providing new software detections
##! to this framework is through the :bro:id:`Software::found` function. ##! to this framework is through the :bro:id:`Software::found` function.
@ -23,15 +23,15 @@ export {
## A structure to represent the numeric version of software. ## A structure to represent the numeric version of software.
type Version: record { type Version: record {
## Major version number ## Major version number.
major: count &optional; major: count &optional;
## Minor version number ## Minor version number.
minor: count &optional; minor: count &optional;
## Minor subversion number ## Minor subversion number.
minor2: count &optional; minor2: count &optional;
## Minor updates number ## Minor updates number.
minor3: count &optional; minor3: count &optional;
## Additional version string (e.g. "beta42") ## Additional version string (e.g. "beta42").
addl: string &optional; addl: string &optional;
} &log; } &log;
@ -41,7 +41,8 @@ export {
ts: time &log &optional; ts: time &log &optional;
## The IP address detected running the software. ## The IP address detected running the software.
host: addr &log; host: addr &log;
## The Port on which the software is running. Only sensible for server software. ## The port on which the software is running. Only sensible for
## server software.
host_p: port &log &optional; host_p: port &log &optional;
## The type of software detected (e.g. :bro:enum:`HTTP::SERVER`). ## The type of software detected (e.g. :bro:enum:`HTTP::SERVER`).
software_type: Type &log &default=UNKNOWN; software_type: Type &log &default=UNKNOWN;
@ -49,9 +50,9 @@ export {
name: string &log &optional; name: string &log &optional;
## Version of the software. ## Version of the software.
version: Version &log &optional; version: Version &log &optional;
## The full unparsed version string found because the version parsing ## The full unparsed version string found because the version
## doesn't always work reliably in all cases and this acts as a ## parsing doesn't always work reliably in all cases and this
## fallback in the logs. ## acts as a fallback in the logs.
unparsed_version: string &log &optional; unparsed_version: string &log &optional;
## This can indicate that this software being detected should ## This can indicate that this software being detected should
@ -59,13 +60,13 @@ export {
## default, only software that is "interesting" due to a change ## default, only software that is "interesting" due to a change
## in version or it being currently unknown is sent to the ## in version or it being currently unknown is sent to the
## logging framework. This can be set to T to force the record ## logging framework. This can be set to T to force the record
## to be sent to the logging framework if some amount of this tracking ## to be sent to the logging framework if some amount of this
## needs to happen in a specific way to the software. ## tracking needs to happen in a specific way to the software.
force_log: bool &default=F; force_log: bool &default=F;
}; };
## Hosts whose software should be detected and tracked. ## Hosts whose software should be detected and tracked.
## Choices are: LOCAL_HOSTS, REMOTE_HOSTS, ALL_HOSTS, NO_HOSTS ## Choices are: LOCAL_HOSTS, REMOTE_HOSTS, ALL_HOSTS, NO_HOSTS.
const asset_tracking = LOCAL_HOSTS &redef; const asset_tracking = LOCAL_HOSTS &redef;
## Other scripts should call this function when they detect software. ## Other scripts should call this function when they detect software.
@ -79,14 +80,14 @@ export {
## Compare two version records. ## Compare two version records.
## ##
## Returns: -1 for v1 < v2, 0 for v1 == v2, 1 for v1 > v2. ## Returns: -1 for v1 < v2, 0 for v1 == v2, 1 for v1 > v2.
## If the numerical version numbers match, the addl string ## If the numerical version numbers match, the *addl* string
## is compared lexicographically. ## is compared lexicographically.
global cmp_versions: function(v1: Version, v2: Version): int; global cmp_versions: function(v1: Version, v2: Version): int;
## Type to represent a collection of :bro:type:`Software::Info` records. ## Type to represent a collection of :bro:type:`Software::Info` records.
## It's indexed with the name of a piece of software such as "Firefox" ## It's indexed with the name of a piece of software such as "Firefox"
## and it yields a :bro:type:`Software::Info` record with more information ## and it yields a :bro:type:`Software::Info` record with more
## about the software. ## information about the software.
type SoftwareSet: table[string] of Info; type SoftwareSet: table[string] of Info;
## The set of software associated with an address. Data expires from ## The set of software associated with an address. Data expires from