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

Change doc/ subdir into a git submodule

Browse source 
The docs now live at https://github.com/zeek/zeek-docs
This commit is contained in:
Jon Siwek 2019-01-17 14:09:29 -06:00
parent 0d685efbf5
commit 2ff746fea7
693 changed files with 26 additions and 105609 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/scripts/base/protocols/syslog/__load__.bro.rst
View file

@ -1,14 +0,0 @@
:tocdepth: 3
base/protocols/syslog/__load__.bro
==================================
:Imports: :doc:`base/protocols/syslog/consts.bro </scripts/base/protocols/syslog/consts.bro>`, :doc:`base/protocols/syslog/main.bro </scripts/base/protocols/syslog/main.bro>`
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

83
doc/scripts/base/protocols/syslog/consts.bro.rst
View file

@ -1,83 +0,0 @@
:tocdepth: 3
base/protocols/syslog/consts.bro
================================
.. bro:namespace:: Syslog
Constants definitions for syslog.
:Namespace: Syslog
Summary
~~~~~~~
Constants
#########
===================================================================================================================== ======================================================================
:bro:id:`Syslog::facility_codes`: :bro:type:`table` :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional` Mapping between the constants and string values for syslog facilities.
:bro:id:`Syslog::severity_codes`: :bro:type:`table` :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional` Mapping between the constants and string values for syslog severities.
===================================================================================================================== ======================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Constants
#########
.. bro:id:: Syslog::facility_codes
:Type: :bro:type:`table` [:bro:type:`count`] of :bro:type:`string`
:Attributes: :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
:Default:
::
{
[2] = "MAIL",
[9] = "CRON",
[17] = "LOCAL1",
[6] = "LPR",
[11] = "FTP",
[14] = "ALERT",
[4] = "AUTH",
[22] = "LOCAL6",
[1] = "USER",
[8] = "UUCP",
[7] = "NEWS",
[15] = "CLOCK",
[23] = "LOCAL7",
[5] = "SYSLOG",
[19] = "LOCAL3",
[10] = "AUTHPRIV",
[0] = "KERN",
[3] = "DAEMON",
[12] = "NTP",
[13] = "AUDIT",
[18] = "LOCAL2",
[21] = "LOCAL5",
[16] = "LOCAL0",
[20] = "LOCAL4"
}
Mapping between the constants and string values for syslog facilities.
.. bro:id:: Syslog::severity_codes
:Type: :bro:type:`table` [:bro:type:`count`] of :bro:type:`string`
:Attributes: :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
:Default:
::
{
[2] = "CRIT",
[6] = "INFO",
[4] = "WARNING",
[1] = "ALERT",
[7] = "DEBUG",
[5] = "NOTICE",
[0] = "EMERG",
[3] = "ERR"
}
Mapping between the constants and string values for syslog severities.

19
doc/scripts/base/protocols/syslog/index.rst
View file

@ -1,19 +0,0 @@
:orphan:
Package: base/protocols/syslog
==============================
Support for Syslog protocol analysis.
:doc:`/scripts/base/protocols/syslog/__load__.bro`
:doc:`/scripts/base/protocols/syslog/consts.bro`
Constants definitions for syslog.
:doc:`/scripts/base/protocols/syslog/main.bro`
Core script support for logging syslog messages. This script represents
one syslog message as one logged record.

61
doc/scripts/base/protocols/syslog/main.bro.rst
View file

@ -1,61 +0,0 @@
:tocdepth: 3
base/protocols/syslog/main.bro
==============================
.. bro:namespace:: Syslog
Core script support for logging syslog messages. This script represents
one syslog message as one logged record.
:Namespace: Syslog
:Imports: :doc:`base/protocols/syslog/consts.bro </scripts/base/protocols/syslog/consts.bro>`
Summary
~~~~~~~
Types
#####
============================================ ============================================================
:bro:type:`Syslog::Info`: :bro:type:`record` The record type which contains the fields of the syslog log.
============================================ ============================================================
Redefinitions
#############
================================================================= =
:bro:type:`Log::ID`: :bro:type:`enum`
:bro:type:`connection`: :bro:type:`record`
:bro:id:`likely_server_ports`: :bro:type:`set` :bro:attr:`&redef`
================================================================= =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Types
#####
.. bro:type:: Syslog::Info
:Type: :bro:type:`record`
ts: :bro:type:`time` :bro:attr:`&log`
Timestamp when the syslog message was seen.
uid: :bro:type:`string` :bro:attr:`&log`
Unique ID for the connection.
id: :bro:type:`conn_id` :bro:attr:`&log`
The connection's 4-tuple of endpoint addresses/ports.
proto: :bro:type:`transport_proto` :bro:attr:`&log`
Protocol over which the message was seen.
facility: :bro:type:`string` :bro:attr:`&log`
Syslog facility for the message.
severity: :bro:type:`string` :bro:attr:`&log`
Syslog severity for the message.
message: :bro:type:`string` :bro:attr:`&log`
The plain text message.
The record type which contains the fields of the syslog log.