From 15236dd7124de3367b76f5779990c7b9ae8cb0a8 Mon Sep 17 00:00:00 2001 From: zeek-bot Date: Wed, 31 Jan 2024 00:15:01 +0000 Subject: [PATCH] Generate docs --- .../autogenerated-protocol-analyzer-index.rst | 10 +++++----- scripts/base/protocols/quic/main.zeek.rst | 13 ++++++++----- scripts/base/protocols/quic/spicy-events.zeek.rst | 10 +++++----- 3 files changed, 18 insertions(+), 15 deletions(-) diff --git a/script-reference/autogenerated-protocol-analyzer-index.rst b/script-reference/autogenerated-protocol-analyzer-index.rst index 24c63a77c..38ba070ef 100644 --- a/script-reference/autogenerated-protocol-analyzer-index.rst +++ b/script-reference/autogenerated-protocol-analyzer-index.rst @@ -9272,7 +9272,7 @@ Events ++++++ .. zeek:id:: QUIC::initial_packet - :source-code: base/protocols/quic/main.zeek 129 133 + :source-code: base/protocols/quic/main.zeek 134 138 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`) @@ -9295,7 +9295,7 @@ Events .. zeek:id:: QUIC::retry_packet - :source-code: base/protocols/quic/main.zeek 148 158 + :source-code: base/protocols/quic/main.zeek 153 163 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`, retry_token: :zeek:type:`string`, retry_integrity_tag: :zeek:type:`string`) @@ -9323,7 +9323,7 @@ Events :param integrity_tag: The Retry Integrity Tag field. .. zeek:id:: QUIC::handshake_packet - :source-code: base/protocols/quic/main.zeek 135 139 + :source-code: base/protocols/quic/main.zeek 140 144 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`) @@ -9345,7 +9345,7 @@ Events :param scid: The Source Connection ID field. .. zeek:id:: QUIC::zero_rtt_packet - :source-code: base/protocols/quic/main.zeek 141 145 + :source-code: base/protocols/quic/main.zeek 146 150 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`) @@ -9367,7 +9367,7 @@ Events :param scid: The Source Connection ID field. .. zeek:id:: QUIC::connection_close_frame - :source-code: base/protocols/quic/main.zeek 175 185 + :source-code: base/protocols/quic/main.zeek 180 190 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`, error_code: :zeek:type:`count`, reason_phrase: :zeek:type:`string`) diff --git a/scripts/base/protocols/quic/main.zeek.rst b/scripts/base/protocols/quic/main.zeek.rst index 76b1fe889..37edf405a 100644 --- a/scripts/base/protocols/quic/main.zeek.rst +++ b/scripts/base/protocols/quic/main.zeek.rst @@ -55,7 +55,7 @@ Detailed Interface Runtime Options ############### .. zeek:id:: QUIC::max_history_length - :source-code: base/protocols/quic/main.zeek 74 74 + :source-code: base/protocols/quic/main.zeek 77 77 :Type: :zeek:type:`count` :Attributes: :zeek:attr:`&redef` @@ -66,7 +66,7 @@ Runtime Options Types ##### .. zeek:type:: QUIC::Info - :source-code: base/protocols/quic/main.zeek 13 65 + :source-code: base/protocols/quic/main.zeek 13 68 :Type: :zeek:type:`record` @@ -88,6 +88,9 @@ Types random and unpredictable, but used for packet protection by client and server. + client_scid: :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional` + Client's Source Connection ID from the first INITIAL packet. + server_scid: :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional` Server chosen Connection ID usually from server's first INITIAL packet. This is to be used by the client in @@ -126,7 +129,7 @@ Types Events ###### .. zeek:id:: QUIC::log_quic - :source-code: base/protocols/quic/main.zeek 67 67 + :source-code: base/protocols/quic/main.zeek 70 70 :Type: :zeek:type:`event` (rec: :zeek:type:`QUIC::Info`) @@ -134,13 +137,13 @@ Events Hooks ##### .. zeek:id:: QUIC::finalize_quic - :source-code: base/protocols/quic/main.zeek 222 228 + :source-code: base/protocols/quic/main.zeek 227 233 :Type: :zeek:type:`Conn::RemovalHook` .. zeek:id:: QUIC::log_policy - :source-code: base/protocols/quic/main.zeek 69 69 + :source-code: base/protocols/quic/main.zeek 72 72 :Type: :zeek:type:`Log::PolicyHook` diff --git a/scripts/base/protocols/quic/spicy-events.zeek.rst b/scripts/base/protocols/quic/spicy-events.zeek.rst index 4bd29aa03..131b2f8bb 100644 --- a/scripts/base/protocols/quic/spicy-events.zeek.rst +++ b/scripts/base/protocols/quic/spicy-events.zeek.rst @@ -26,7 +26,7 @@ Detailed Interface Events ###### .. zeek:id:: QUIC::connection_close_frame - :source-code: base/protocols/quic/main.zeek 175 185 + :source-code: base/protocols/quic/main.zeek 180 190 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`, error_code: :zeek:type:`count`, reason_phrase: :zeek:type:`string`) @@ -56,7 +56,7 @@ Events .. note:: Packets with CONNECTION_CLOSE frames are usually encrypted after connection establishment and not visible to Zeek. .. zeek:id:: QUIC::handshake_packet - :source-code: base/protocols/quic/main.zeek 135 139 + :source-code: base/protocols/quic/main.zeek 140 144 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`) @@ -78,7 +78,7 @@ Events :param scid: The Source Connection ID field. .. zeek:id:: QUIC::initial_packet - :source-code: base/protocols/quic/main.zeek 129 133 + :source-code: base/protocols/quic/main.zeek 134 138 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`) @@ -101,7 +101,7 @@ Events .. zeek:id:: QUIC::retry_packet - :source-code: base/protocols/quic/main.zeek 148 158 + :source-code: base/protocols/quic/main.zeek 153 163 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`, retry_token: :zeek:type:`string`, retry_integrity_tag: :zeek:type:`string`) @@ -129,7 +129,7 @@ Events :param integrity_tag: The Retry Integrity Tag field. .. zeek:id:: QUIC::zero_rtt_packet - :source-code: base/protocols/quic/main.zeek 141 145 + :source-code: base/protocols/quic/main.zeek 146 150 :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`)