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

Fix a number of documentation building errors

Browse source
This commit is contained in:
Johanna Amann 2016-06-27 12:41:40 -07:00
parent 94e242f2fd
commit 971f7e236f
5 changed files with 39 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/script-reference/log-files.rst
View file

@ -95,8 +95,6 @@ Network Observations
+----------------------------+---------------------------------------+---------------------------------+ +----------------------------+---------------------------------------+---------------------------------+
| Log File | Description | Field Descriptions | | Log File | Description | Field Descriptions |
+============================+=======================================+=================================+ +============================+=======================================+=================================+
| app_stats.log | Web app usage statistics | :bro:type:`AppStats::Info` |
+----------------------------+---------------------------------------+---------------------------------+
| known_certs.log | SSL certificates | :bro:type:`Known::CertsInfo` | | known_certs.log | SSL certificates | :bro:type:`Known::CertsInfo` |
+----------------------------+---------------------------------------+---------------------------------+ +----------------------------+---------------------------------------+---------------------------------+
| known_devices.log | MAC addresses of devices on the | :bro:type:`Known::DevicesInfo` | | known_devices.log | MAC addresses of devices on the | :bro:type:`Known::DevicesInfo` |

4
scripts/base/frameworks/packet-filter/netstats.bro
View file

@ -11,7 +11,7 @@ export {
## Indicates packets were dropped by the packet filter. ## Indicates packets were dropped by the packet filter.
Dropped_Packets, Dropped_Packets,
}; };
## This is the interval between individual statistics collection. ## This is the interval between individual statistics collection.
const stats_collection_interval = 5min; const stats_collection_interval = 5min;
} }
@ -29,7 +29,7 @@ event net_stats_update(last_stat: NetStats)
new_dropped, new_recvd + new_dropped, new_dropped, new_recvd + new_dropped,
new_link != 0 ? fmt(", %d on link", new_link) : "")]); new_link != 0 ? fmt(", %d on link", new_link) : "")]);
} }
schedule stats_collection_interval { net_stats_update(ns) }; schedule stats_collection_interval { net_stats_update(ns) };
} }

10
scripts/base/init-bare.bro
View file

@ -463,7 +463,7 @@ type SYN_packet: record {
## Packet capture statistics. All counts are cumulative. ## Packet capture statistics. All counts are cumulative.
## ##
## .. bro:see:: net_stats ## .. bro:see:: get_net_stats
type NetStats: record { type NetStats: record {
pkts_recvd: count &default=0; ##< Packets received by Bro. pkts_recvd: count &default=0; ##< Packets received by Bro.
pkts_dropped: count &default=0; ##< Packets reported dropped by the system. pkts_dropped: count &default=0; ##< Packets reported dropped by the system.
@ -706,7 +706,7 @@ global capture_filters: table[string] of string &redef;
global restrict_filters: table[string] of string &redef; global restrict_filters: table[string] of string &redef;
## Enum type identifying dynamic BPF filters. These are used by ## Enum type identifying dynamic BPF filters. These are used by
## :bro:see:`precompile_pcap_filter` and :bro:see:`precompile_pcap_filter`. ## :bro:see:`Pcap::precompile_pcap_filter` and :bro:see:`Pcap::precompile_pcap_filter`.
type PcapFilterID: enum { None }; type PcapFilterID: enum { None };
## Deprecated. ## Deprecated.
@ -1542,7 +1542,7 @@ type l2_hdr: record {
}; };
## A raw packet header, consisting of L2 header and everything in ## A raw packet header, consisting of L2 header and everything in
## :bro:id:`pkt_hdr`. . ## :bro:see:`pkt_hdr`. .
## ##
## .. bro:see:: raw_packet pkt_hdr ## .. bro:see:: raw_packet pkt_hdr
type raw_pkt_hdr: record { type raw_pkt_hdr: record {
@ -3514,11 +3514,11 @@ global load_sample_freq = 20 &redef;
## be reported via :bro:see:`content_gap`. ## be reported via :bro:see:`content_gap`.
const detect_filtered_trace = F &redef; const detect_filtered_trace = F &redef;
## Whether we want :bro:see:`content_gap` and :bro:see:`get_gap_summary` for partial ## Whether we want :bro:see:`content_gap` for partial
## connections. A connection is partial if it is missing a full handshake. Note ## connections. A connection is partial if it is missing a full handshake. Note
## that gap reports for partial connections might not be reliable. ## that gap reports for partial connections might not be reliable.
## ##
## .. bro:see:: content_gap get_gap_summary partial_connection ## .. bro:see:: content_gap partial_connection
const report_gaps_for_partial = F &redef; const report_gaps_for_partial = F &redef;
## Flag to prevent Bro from exiting automatically when input is exhausted. ## Flag to prevent Bro from exiting automatically when input is exhausted.

48
src/bro.bif
View file

@ -4328,8 +4328,8 @@ function enable_raw_output%(f: file%): any
## ##
## Returns: True (unconditionally). ## Returns: True (unconditionally).
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_pcap_filter ## Pcap::install_pcap_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter
## uninstall_src_net_filter ## uninstall_src_net_filter
@ -4337,7 +4337,7 @@ function enable_raw_output%(f: file%): any
## install_dst_net_filter ## install_dst_net_filter
## uninstall_dst_addr_filter ## uninstall_dst_addr_filter
## uninstall_dst_net_filter ## uninstall_dst_net_filter
## pcap_error ## Pcap::error
## ##
## .. todo:: The return value should be changed to any. ## .. todo:: The return value should be changed to any.
function install_src_addr_filter%(ip: addr, tcp_flags: count, prob: double%) : bool function install_src_addr_filter%(ip: addr, tcp_flags: count, prob: double%) : bool
@ -4358,8 +4358,8 @@ function install_src_addr_filter%(ip: addr, tcp_flags: count, prob: double%) : b
## ##
## Returns: True (unconditionally). ## Returns: True (unconditionally).
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_pcap_filter ## Pcap::install_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter
## uninstall_src_net_filter ## uninstall_src_net_filter
@ -4367,7 +4367,7 @@ function install_src_addr_filter%(ip: addr, tcp_flags: count, prob: double%) : b
## install_dst_net_filter ## install_dst_net_filter
## uninstall_dst_addr_filter ## uninstall_dst_addr_filter
## uninstall_dst_net_filter ## uninstall_dst_net_filter
## pcap_error ## Pcap::error
## ##
## .. todo:: The return value should be changed to any. ## .. todo:: The return value should be changed to any.
function install_src_net_filter%(snet: subnet, tcp_flags: count, prob: double%) : bool function install_src_net_filter%(snet: subnet, tcp_flags: count, prob: double%) : bool
@ -4382,8 +4382,8 @@ function install_src_net_filter%(snet: subnet, tcp_flags: count, prob: double%)
## ##
## Returns: True on success. ## Returns: True on success.
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_pcap_filter ## Pcap::install_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_net_filter ## uninstall_src_net_filter
@ -4391,7 +4391,7 @@ function install_src_net_filter%(snet: subnet, tcp_flags: count, prob: double%)
## install_dst_net_filter ## install_dst_net_filter
## uninstall_dst_addr_filter ## uninstall_dst_addr_filter
## uninstall_dst_net_filter ## uninstall_dst_net_filter
## pcap_error ## Pcap::error
function uninstall_src_addr_filter%(ip: addr%) : bool function uninstall_src_addr_filter%(ip: addr%) : bool
%{ %{
return new Val(sessions->GetPacketFilter()->RemoveSrc(ip->AsAddr()), TYPE_BOOL); return new Val(sessions->GetPacketFilter()->RemoveSrc(ip->AsAddr()), TYPE_BOOL);
@ -4403,8 +4403,8 @@ function uninstall_src_addr_filter%(ip: addr%) : bool
## ##
## Returns: True on success. ## Returns: True on success.
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_pcap_filter ## Pcap::install_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter
@ -4412,7 +4412,7 @@ function uninstall_src_addr_filter%(ip: addr%) : bool
## install_dst_net_filter ## install_dst_net_filter
## uninstall_dst_addr_filter ## uninstall_dst_addr_filter
## uninstall_dst_net_filter ## uninstall_dst_net_filter
## pcap_error ## Pcap::error
function uninstall_src_net_filter%(snet: subnet%) : bool function uninstall_src_net_filter%(snet: subnet%) : bool
%{ %{
return new Val(sessions->GetPacketFilter()->RemoveSrc(snet), TYPE_BOOL); return new Val(sessions->GetPacketFilter()->RemoveSrc(snet), TYPE_BOOL);
@ -4433,8 +4433,8 @@ function uninstall_src_net_filter%(snet: subnet%) : bool
## ##
## Returns: True (unconditionally). ## Returns: True (unconditionally).
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_pcap_filter ## Pcap::install_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter
@ -4442,7 +4442,7 @@ function uninstall_src_net_filter%(snet: subnet%) : bool
## install_dst_net_filter ## install_dst_net_filter
## uninstall_dst_addr_filter ## uninstall_dst_addr_filter
## uninstall_dst_net_filter ## uninstall_dst_net_filter
## pcap_error ## Pcap::error
## ##
## .. todo:: The return value should be changed to any. ## .. todo:: The return value should be changed to any.
function install_dst_addr_filter%(ip: addr, tcp_flags: count, prob: double%) : bool function install_dst_addr_filter%(ip: addr, tcp_flags: count, prob: double%) : bool
@ -4463,8 +4463,8 @@ function install_dst_addr_filter%(ip: addr, tcp_flags: count, prob: double%) : b
## ##
## Returns: True (unconditionally). ## Returns: True (unconditionally).
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_pcap_filter ## Pcap::install_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter
@ -4472,7 +4472,7 @@ function install_dst_addr_filter%(ip: addr, tcp_flags: count, prob: double%) : b
## install_dst_addr_filter ## install_dst_addr_filter
## uninstall_dst_addr_filter ## uninstall_dst_addr_filter
## uninstall_dst_net_filter ## uninstall_dst_net_filter
## pcap_error ## Pcap::error
## ##
## .. todo:: The return value should be changed to any. ## .. todo:: The return value should be changed to any.
function install_dst_net_filter%(snet: subnet, tcp_flags: count, prob: double%) : bool function install_dst_net_filter%(snet: subnet, tcp_flags: count, prob: double%) : bool
@ -4487,8 +4487,8 @@ function install_dst_net_filter%(snet: subnet, tcp_flags: count, prob: double%)
## ##
## Returns: True on success. ## Returns: True on success.
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_pcap_filter ## Pcap::install_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter
@ -4496,7 +4496,7 @@ function install_dst_net_filter%(snet: subnet, tcp_flags: count, prob: double%)
## install_dst_addr_filter ## install_dst_addr_filter
## install_dst_net_filter ## install_dst_net_filter
## uninstall_dst_net_filter ## uninstall_dst_net_filter
## pcap_error ## Pcap::error
function uninstall_dst_addr_filter%(ip: addr%) : bool function uninstall_dst_addr_filter%(ip: addr%) : bool
%{ %{
return new Val(sessions->GetPacketFilter()->RemoveDst(ip->AsAddr()), TYPE_BOOL); return new Val(sessions->GetPacketFilter()->RemoveDst(ip->AsAddr()), TYPE_BOOL);
@ -4508,8 +4508,8 @@ function uninstall_dst_addr_filter%(ip: addr%) : bool
## ##
## Returns: True on success. ## Returns: True on success.
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_pcap_filter ## Pcap::install_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter
@ -4517,7 +4517,7 @@ function uninstall_dst_addr_filter%(ip: addr%) : bool
## install_dst_addr_filter ## install_dst_addr_filter
## install_dst_net_filter ## install_dst_net_filter
## uninstall_dst_addr_filter ## uninstall_dst_addr_filter
## pcap_error ## Pcap::error
function uninstall_dst_net_filter%(snet: subnet%) : bool function uninstall_dst_net_filter%(snet: subnet%) : bool
%{ %{
return new Val(sessions->GetPacketFilter()->RemoveDst(snet), TYPE_BOOL); return new Val(sessions->GetPacketFilter()->RemoveDst(snet), TYPE_BOOL);

16
src/iosource/pcap/functions.bif
View file

@ -9,7 +9,7 @@ module Pcap;
## ##
## Returns: True if *s* is valid and precompiles successfully. ## Returns: True if *s* is valid and precompiles successfully.
## ##
## .. bro:see:: install_pcap_filter ## .. bro:see:: Pcap::install_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter
@ -18,7 +18,7 @@ module Pcap;
## install_dst_net_filter ## install_dst_net_filter
## uninstall_dst_addr_filter ## uninstall_dst_addr_filter
## uninstall_dst_net_filter ## uninstall_dst_net_filter
## pcap_error ## Pcap::error
function precompile_pcap_filter%(id: PcapFilterID, s: string%): bool function precompile_pcap_filter%(id: PcapFilterID, s: string%): bool
%{ %{
if ( id->AsEnum() >= 100 ) if ( id->AsEnum() >= 100 )
@ -48,14 +48,14 @@ function precompile_pcap_filter%(id: PcapFilterID, s: string%): bool
%} %}
## Installs a PCAP filter that has been precompiled with ## Installs a PCAP filter that has been precompiled with
## :bro:id:`precompile_pcap_filter`. ## :bro:id:`Pcap::precompile_pcap_filter`.
## ##
## id: The PCAP filter id of a precompiled filter. ## id: The PCAP filter id of a precompiled filter.
## ##
## Returns: True if the filter associated with *id* has been installed ## Returns: True if the filter associated with *id* has been installed
## successfully. ## successfully.
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter
@ -64,8 +64,8 @@ function precompile_pcap_filter%(id: PcapFilterID, s: string%): bool
## install_dst_net_filter ## install_dst_net_filter
## uninstall_dst_addr_filter ## uninstall_dst_addr_filter
## uninstall_dst_net_filter ## uninstall_dst_net_filter
## pcap_error ## Pcap::error
function install_pcap_filter%(id: PcapFilterID%): bool function Pcap::install_pcap_filter%(id: PcapFilterID%): bool
%{ %{
bool success = true; bool success = true;
@ -87,8 +87,8 @@ function install_pcap_filter%(id: PcapFilterID%): bool
## ##
## Returns: A descriptive error message of the PCAP function that failed. ## Returns: A descriptive error message of the PCAP function that failed.
## ##
## .. bro:see:: precompile_pcap_filter ## .. bro:see:: Pcap::precompile_pcap_filter
## install_pcap_filter ## Pcap::install_pcap_filter
## install_src_addr_filter ## install_src_addr_filter
## install_src_net_filter ## install_src_net_filter
## uninstall_src_addr_filter ## uninstall_src_addr_filter