zeek/doc/scripts/base/bif/plugins/Bro_GTPv1.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

151 lines
4.6 KiB
ReStructuredText

:tocdepth: 3
base/bif/plugins/Bro_GTPv1.events.bif.bro
=========================================
.. bro:namespace:: GLOBAL
:Namespace: GLOBAL
Summary
~~~~~~~
Events
######
========================================================== ===========================================================
:bro:id:`gtpv1_create_pdp_ctx_request`: :bro:type:`event` Generated for GTPv1-C Create PDP Context Request messages.
:bro:id:`gtpv1_create_pdp_ctx_response`: :bro:type:`event` Generated for GTPv1-C Create PDP Context Response messages.
:bro:id:`gtpv1_delete_pdp_ctx_request`: :bro:type:`event` Generated for GTPv1-C Delete PDP Context Request messages.
:bro:id:`gtpv1_delete_pdp_ctx_response`: :bro:type:`event` Generated for GTPv1-C Delete PDP Context Response messages.
:bro:id:`gtpv1_g_pdu_packet`: :bro:type:`event` Generated for GTPv1 G-PDU packets.
:bro:id:`gtpv1_message`: :bro:type:`event` Generated for any GTP message with a GTPv1 header.
:bro:id:`gtpv1_update_pdp_ctx_request`: :bro:type:`event` Generated for GTPv1-C Update PDP Context Request messages.
:bro:id:`gtpv1_update_pdp_ctx_response`: :bro:type:`event` Generated for GTPv1-C Update PDP Context Response messages.
========================================================== ===========================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. bro:id:: gtpv1_create_pdp_ctx_request
:Type: :bro:type:`event` (c: :bro:type:`connection`, hdr: :bro:type:`gtpv1_hdr`, elements: :bro:type:`gtp_create_pdp_ctx_request_elements`)
Generated for GTPv1-C Create PDP Context Request messages.
:c: The connection over which the message is sent.
:hdr: The GTPv1 header.
:elements: The set of Information Elements comprising the message.
.. bro:id:: gtpv1_create_pdp_ctx_response
:Type: :bro:type:`event` (c: :bro:type:`connection`, hdr: :bro:type:`gtpv1_hdr`, elements: :bro:type:`gtp_create_pdp_ctx_response_elements`)
Generated for GTPv1-C Create PDP Context Response messages.
:c: The connection over which the message is sent.
:hdr: The GTPv1 header.
:elements: The set of Information Elements comprising the message.
.. bro:id:: gtpv1_delete_pdp_ctx_request
:Type: :bro:type:`event` (c: :bro:type:`connection`, hdr: :bro:type:`gtpv1_hdr`, elements: :bro:type:`gtp_delete_pdp_ctx_request_elements`)
Generated for GTPv1-C Delete PDP Context Request messages.
:c: The connection over which the message is sent.
:hdr: The GTPv1 header.
:elements: The set of Information Elements comprising the message.
.. bro:id:: gtpv1_delete_pdp_ctx_response
:Type: :bro:type:`event` (c: :bro:type:`connection`, hdr: :bro:type:`gtpv1_hdr`, elements: :bro:type:`gtp_delete_pdp_ctx_response_elements`)
Generated for GTPv1-C Delete PDP Context Response messages.
:c: The connection over which the message is sent.
:hdr: The GTPv1 header.
:elements: The set of Information Elements comprising the message.
.. bro:id:: gtpv1_g_pdu_packet
:Type: :bro:type:`event` (outer: :bro:type:`connection`, inner_gtp: :bro:type:`gtpv1_hdr`, inner_ip: :bro:type:`pkt_hdr`)
Generated for GTPv1 G-PDU packets. That is, packets with a UDP payload
that includes a GTP header followed by an IPv4 or IPv6 packet.
:outer: The GTP outer tunnel connection.
:inner_gtp: The GTP header.
:inner_ip: The inner IP and transport layer packet headers.
.. note:: Since this event may be raised on a per-packet basis, handling
it may become particularly expensive for real-time analysis.
.. bro:id:: gtpv1_message
:Type: :bro:type:`event` (c: :bro:type:`connection`, hdr: :bro:type:`gtpv1_hdr`)
Generated for any GTP message with a GTPv1 header.
:c: The connection over which the message is sent.
:hdr: The GTPv1 header.
.. bro:id:: gtpv1_update_pdp_ctx_request
:Type: :bro:type:`event` (c: :bro:type:`connection`, hdr: :bro:type:`gtpv1_hdr`, elements: :bro:type:`gtp_update_pdp_ctx_request_elements`)
Generated for GTPv1-C Update PDP Context Request messages.
:c: The connection over which the message is sent.
:hdr: The GTPv1 header.
:elements: The set of Information Elements comprising the message.
.. bro:id:: gtpv1_update_pdp_ctx_response
:Type: :bro:type:`event` (c: :bro:type:`connection`, hdr: :bro:type:`gtpv1_hdr`, elements: :bro:type:`gtp_update_pdp_ctx_response_elements`)
Generated for GTPv1-C Update PDP Context Response messages.
:c: The connection over which the message is sent.
:hdr: The GTPv1 header.
:elements: The set of Information Elements comprising the message.