zeek/doc/scripts/base/bif/plugins/Bro_NTP.events.bif.bro.rst
Jon Siwek 7e9d48f532 Remove broxygen Sphinx integration
The broxygen-generated files now live in the git repo, have tests
that check that they are up-to-date, and a script to re-generate
them on-demand.
2018-12-18 10:15:22 -06:00

50 lines
1.4 KiB
ReStructuredText

:tocdepth: 3
base/bif/plugins/Bro_NTP.events.bif.bro
=======================================
.. bro:namespace:: GLOBAL
:Namespace: GLOBAL
Summary
~~~~~~~
Events
######
======================================== ===============================
:bro:id:`ntp_message`: :bro:type:`event` Generated for all NTP messages.
======================================== ===============================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. bro:id:: ntp_message
:Type: :bro:type:`event` (u: :bro:type:`connection`, msg: :bro:type:`ntp_msg`, excess: :bro:type:`string`)
Generated for all NTP messages. Different from many other of Bro's events,
this one is generated for both client-side and server-side messages.
See `Wikipedia <http://en.wikipedia.org/wiki/Network_Time_Protocol>`__ for
more information about the NTP protocol.
:u: The connection record describing the corresponding UDP flow.
:msg: The parsed NTP message.
:excess: The raw bytes of any optional parts of the NTP packet. Bro does not
further parse any optional fields.
.. bro:see:: ntp_session_timeout
.. todo:: Bro's current default configuration does not activate the protocol
analyzer that generates this event; the corresponding script has not yet
been ported to Bro 2.x. To still enable this event, one needs to
register a port for it or add a DPD payload signature.