zeek/doc/scripts/base/bif/plugins/Zeek_GTPv1.events.bif.zeek.rst
Patrick Kelley 8fd444092b initial
2025-05-07 15:35:15 -04:00

174 lines
5.9 KiB
ReStructuredText

:tocdepth: 3
base/bif/plugins/Zeek_GTPv1.events.bif.zeek
===========================================
.. zeek:namespace:: GLOBAL
:Namespace: GLOBAL
Summary
~~~~~~~
Events
######
============================================================ ===================================================================
:zeek:id:`gtpv1_create_pdp_ctx_request`: :zeek:type:`event` Generated for GTPv1-C Create PDP Context Request messages.
:zeek:id:`gtpv1_create_pdp_ctx_response`: :zeek:type:`event` Generated for GTPv1-C Create PDP Context Response messages.
:zeek:id:`gtpv1_delete_pdp_ctx_request`: :zeek:type:`event` Generated for GTPv1-C Delete PDP Context Request messages.
:zeek:id:`gtpv1_delete_pdp_ctx_response`: :zeek:type:`event` Generated for GTPv1-C Delete PDP Context Response messages.
:zeek:id:`gtpv1_g_pdu_packet`: :zeek:type:`event` Generated for GTPv1 G-PDU packets.
:zeek:id:`gtpv1_message`: :zeek:type:`event` Generated for any GTP message with a GTPv1 header.
:zeek:id:`gtpv1_update_pdp_ctx_request`: :zeek:type:`event` Generated for GTPv1-C Update PDP Context Request messages.
:zeek:id:`gtpv1_update_pdp_ctx_response`: :zeek:type:`event` Generated for GTPv1-C Update PDP Context Response messages.
:zeek:id:`new_gtpv1_state`: :zeek:type:`event` Generated when a new GTP analyzer is instantiated for a connection.
============================================================ ===================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. zeek:id:: gtpv1_create_pdp_ctx_request
:source-code: base/bif/plugins/Zeek_GTPv1.events.bif.zeek 45 45
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, hdr: :zeek:type:`gtpv1_hdr`, elements: :zeek:type:`gtp_create_pdp_ctx_request_elements`)
Generated for GTPv1-C Create PDP Context Request messages.
:param c: The connection over which the message is sent.
:param hdr: The GTPv1 header.
:param elements: The set of Information Elements comprising the message.
.. zeek:id:: gtpv1_create_pdp_ctx_response
:source-code: base/bif/plugins/Zeek_GTPv1.events.bif.zeek 55 55
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, hdr: :zeek:type:`gtpv1_hdr`, elements: :zeek:type:`gtp_create_pdp_ctx_response_elements`)
Generated for GTPv1-C Create PDP Context Response messages.
:param c: The connection over which the message is sent.
:param hdr: The GTPv1 header.
:param elements: The set of Information Elements comprising the message.
.. zeek:id:: gtpv1_delete_pdp_ctx_request
:source-code: base/bif/plugins/Zeek_GTPv1.events.bif.zeek 85 85
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, hdr: :zeek:type:`gtpv1_hdr`, elements: :zeek:type:`gtp_delete_pdp_ctx_request_elements`)
Generated for GTPv1-C Delete PDP Context Request messages.
:param c: The connection over which the message is sent.
:param hdr: The GTPv1 header.
:param elements: The set of Information Elements comprising the message.
.. zeek:id:: gtpv1_delete_pdp_ctx_response
:source-code: base/bif/plugins/Zeek_GTPv1.events.bif.zeek 95 95
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, hdr: :zeek:type:`gtpv1_hdr`, elements: :zeek:type:`gtp_delete_pdp_ctx_response_elements`)
Generated for GTPv1-C Delete PDP Context Response messages.
:param c: The connection over which the message is sent.
:param hdr: The GTPv1 header.
:param elements: The set of Information Elements comprising the message.
.. zeek:id:: gtpv1_g_pdu_packet
:source-code: base/bif/plugins/Zeek_GTPv1.events.bif.zeek 35 35
:Type: :zeek:type:`event` (outer: :zeek:type:`connection`, inner_gtp: :zeek:type:`gtpv1_hdr`, inner_ip: :zeek: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.
:param outer: The GTP outer tunnel connection.
:param inner_gtp: The GTP header.
:param 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.
.. zeek:id:: gtpv1_message
:source-code: base/bif/plugins/Zeek_GTPv1.events.bif.zeek 21 21
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, hdr: :zeek:type:`gtpv1_hdr`)
Generated for any GTP message with a GTPv1 header.
:param c: The connection over which the message is sent.
:param hdr: The GTPv1 header.
.. zeek:id:: gtpv1_update_pdp_ctx_request
:source-code: base/bif/plugins/Zeek_GTPv1.events.bif.zeek 65 65
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, hdr: :zeek:type:`gtpv1_hdr`, elements: :zeek:type:`gtp_update_pdp_ctx_request_elements`)
Generated for GTPv1-C Update PDP Context Request messages.
:param c: The connection over which the message is sent.
:param hdr: The GTPv1 header.
:param elements: The set of Information Elements comprising the message.
.. zeek:id:: gtpv1_update_pdp_ctx_response
:source-code: base/bif/plugins/Zeek_GTPv1.events.bif.zeek 75 75
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, hdr: :zeek:type:`gtpv1_hdr`, elements: :zeek:type:`gtp_update_pdp_ctx_response_elements`)
Generated for GTPv1-C Update PDP Context Response messages.
:param c: The connection over which the message is sent.
:param hdr: The GTPv1 header.
:param elements: The set of Information Elements comprising the message.
.. zeek:id:: new_gtpv1_state
:source-code: base/packet-protocols/gtpv1/main.zeek 35 38
:Type: :zeek:type:`event` (c: :zeek:type:`connection`)
Generated when a new GTP analyzer is instantiated for a connection.
This event exists to install a connection removal hook to clear
internal per-connection GTPv1 state.
:param c: The connection for which the analyzer is instantiated.