mirror of
https://github.com/zeek/zeek.git
synced 2025-10-15 04:58:21 +00:00
Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
This commit is contained in:
Tim Wojtulewicz
parent
83f1e74643
commit
ded98cd373
1074 changed files with 169319 additions and 0 deletions
14
doc/scripts/base/protocols/dce-rpc/__load__.zeek.rst
Normal file
14
doc/scripts/base/protocols/dce-rpc/__load__.zeek.rst
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/dce-rpc/__load__.zeek
|
||||
====================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/protocols/dce-rpc/consts.zeek </scripts/base/protocols/dce-rpc/consts.zeek>`, :doc:`base/protocols/dce-rpc/main.zeek </scripts/base/protocols/dce-rpc/main.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
2848
doc/scripts/base/protocols/dce-rpc/consts.zeek.rst
Normal file
2848
doc/scripts/base/protocols/dce-rpc/consts.zeek.rst
Normal file
File diff suppressed because it is too large
Load diff
17
doc/scripts/base/protocols/dce-rpc/index.rst
Normal file
17
doc/scripts/base/protocols/dce-rpc/index.rst
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/protocols/dce-rpc
|
||||
===============================
|
||||
|
||||
Support for DCE/RPC (Distributed Computing Environment/Remote Procedure
|
||||
Calls) protocol analysis.
|
||||
|
||||
:doc:`/scripts/base/protocols/dce-rpc/__load__.zeek`
|
||||
|
||||
|
||||
:doc:`/scripts/base/protocols/dce-rpc/consts.zeek`
|
||||
|
||||
|
||||
:doc:`/scripts/base/protocols/dce-rpc/main.zeek`
|
||||
|
||||
|
||||
194
doc/scripts/base/protocols/dce-rpc/main.zeek.rst
Normal file
194
doc/scripts/base/protocols/dce-rpc/main.zeek.rst
Normal file
|
|
@ -0,0 +1,194 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/dce-rpc/main.zeek
|
||||
================================
|
||||
.. zeek:namespace:: DCE_RPC
|
||||
|
||||
|
||||
:Namespace: DCE_RPC
|
||||
:Imports: :doc:`base/protocols/conn/removal-hooks.zeek </scripts/base/protocols/conn/removal-hooks.zeek>`, :doc:`base/protocols/dce-rpc/consts.zeek </scripts/base/protocols/dce-rpc/consts.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
============================================================================== ===============================================================
|
||||
:zeek:id:`DCE_RPC::ignored_operations`: :zeek:type:`table` :zeek:attr:`&redef` These are DCE-RPC operations that are ignored, typically due to
|
||||
the operations being noisy and low value on most networks.
|
||||
============================================================================== ===============================================================
|
||||
|
||||
Types
|
||||
#####
|
||||
======================================================= =
|
||||
:zeek:type:`DCE_RPC::BackingState`: :zeek:type:`record`
|
||||
:zeek:type:`DCE_RPC::Info`: :zeek:type:`record`
|
||||
:zeek:type:`DCE_RPC::State`: :zeek:type:`record`
|
||||
======================================================= =
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
======================================================================= =======================================================================================================================
|
||||
:zeek:id:`DPD::ignore_violations`: :zeek:type:`set` :zeek:attr:`&redef`
|
||||
:zeek:type:`Log::ID`: :zeek:type:`enum`
|
||||
|
||||
* :zeek:enum:`DCE_RPC::LOG`
|
||||
:zeek:type:`connection`: :zeek:type:`record`
|
||||
|
||||
:New Fields: :zeek:type:`connection`
|
||||
|
||||
dce_rpc: :zeek:type:`DCE_RPC::Info` :zeek:attr:`&optional`
|
||||
|
||||
dce_rpc_state: :zeek:type:`DCE_RPC::State` :zeek:attr:`&optional`
|
||||
|
||||
dce_rpc_backing: :zeek:type:`table` [:zeek:type:`count`] of :zeek:type:`DCE_RPC::BackingState` :zeek:attr:`&optional`
|
||||
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
|
||||
======================================================================= =======================================================================================================================
|
||||
|
||||
Hooks
|
||||
#####
|
||||
==================================================================== ==========================
|
||||
:zeek:id:`DCE_RPC::finalize_dce_rpc`: :zeek:type:`Conn::RemovalHook` DCE_RPC finalization hook.
|
||||
:zeek:id:`DCE_RPC::log_policy`: :zeek:type:`Log::PolicyHook`
|
||||
==================================================================== ==========================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Runtime Options
|
||||
###############
|
||||
.. zeek:id:: DCE_RPC::ignored_operations
|
||||
:source-code: base/protocols/dce-rpc/main.zeek 45 45
|
||||
|
||||
:Type: :zeek:type:`table` [:zeek:type:`string`] of :zeek:type:`set` [:zeek:type:`string`]
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
["spoolss"] = {
|
||||
"RpcSplOpenPrinter",
|
||||
"RpcClosePrinter"
|
||||
},
|
||||
["wkssvc"] = {
|
||||
"NetrWkstaGetInfo"
|
||||
},
|
||||
["winreg"] = {
|
||||
"BaseRegCloseKey",
|
||||
"BaseRegGetVersion",
|
||||
"BaseRegOpenKey",
|
||||
"BaseRegDeleteKeyEx",
|
||||
"BaseRegEnumKey",
|
||||
"OpenLocalMachine",
|
||||
"BaseRegQueryValue",
|
||||
"OpenClassesRoot"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
These are DCE-RPC operations that are ignored, typically due to
|
||||
the operations being noisy and low value on most networks.
|
||||
|
||||
Types
|
||||
#####
|
||||
.. zeek:type:: DCE_RPC::BackingState
|
||||
:source-code: base/protocols/dce-rpc/main.zeek 59 62
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
||||
.. zeek:field:: info :zeek:type:`DCE_RPC::Info`
|
||||
|
||||
|
||||
.. zeek:field:: state :zeek:type:`DCE_RPC::State`
|
||||
|
||||
|
||||
|
||||
.. zeek:type:: DCE_RPC::Info
|
||||
:source-code: base/protocols/dce-rpc/main.zeek 11 41
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
||||
.. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
|
||||
|
||||
Timestamp for when the event happened.
|
||||
|
||||
|
||||
.. zeek:field:: uid :zeek:type:`string` :zeek:attr:`&log`
|
||||
|
||||
Unique ID for the connection.
|
||||
|
||||
|
||||
.. zeek:field:: id :zeek:type:`conn_id` :zeek:attr:`&log`
|
||||
|
||||
The connection's 4-tuple of endpoint addresses/ports.
|
||||
|
||||
|
||||
.. zeek:field:: rtt :zeek:type:`interval` :zeek:attr:`&log` :zeek:attr:`&optional`
|
||||
|
||||
Round trip time from the request to the response.
|
||||
If either the request or response wasn't seen,
|
||||
this will be null.
|
||||
|
||||
|
||||
.. zeek:field:: named_pipe :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
||||
|
||||
Remote pipe name.
|
||||
|
||||
Note that this value is from the "sec_addr" field in the
|
||||
protocol. Zeek uses the "named_pipe" name for historical reasons,
|
||||
but it may also contain local port numbers rather than named pipes.
|
||||
|
||||
If you prefer to use the "secondary address" name, consider
|
||||
using :zeek:see:`Log::default_field_name_map`, a ``Log::Filter``'s
|
||||
:zeek:field:`Log::Filter$field_name_map` field, or removing
|
||||
the :zeek:attr:`&log` attribute from this field, adding a
|
||||
new :zeek:field:`sec_addr` field and populating it in a custom
|
||||
:zeek:see:`dce_rpc_bind_ack` event handler based on the
|
||||
:zeek:field:`named_pipe` value.
|
||||
|
||||
|
||||
.. zeek:field:: endpoint :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
||||
|
||||
Endpoint name looked up from the uuid.
|
||||
|
||||
|
||||
.. zeek:field:: operation :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
|
||||
|
||||
Operation seen in the call.
|
||||
|
||||
|
||||
|
||||
.. zeek:type:: DCE_RPC::State
|
||||
:source-code: base/protocols/dce-rpc/main.zeek 51 55
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
||||
.. zeek:field:: uuid :zeek:type:`string` :zeek:attr:`&optional`
|
||||
|
||||
|
||||
.. zeek:field:: named_pipe :zeek:type:`string` :zeek:attr:`&optional`
|
||||
|
||||
|
||||
.. zeek:field:: ctx_to_uuid :zeek:type:`table` [:zeek:type:`count`] of :zeek:type:`string` :zeek:attr:`&optional`
|
||||
|
||||
|
||||
|
||||
Hooks
|
||||
#####
|
||||
.. zeek:id:: DCE_RPC::finalize_dce_rpc
|
||||
:source-code: base/protocols/dce-rpc/main.zeek 248 280
|
||||
|
||||
:Type: :zeek:type:`Conn::RemovalHook`
|
||||
|
||||
DCE_RPC finalization hook. Remaining DCE_RPC info may get logged when it's called.
|
||||
|
||||
.. zeek:id:: DCE_RPC::log_policy
|
||||
:source-code: base/protocols/dce-rpc/main.zeek 9 9
|
||||
|
||||
:Type: :zeek:type:`Log::PolicyHook`
|
||||
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue