Skip to content
This repository was archived by the owner on Oct 13, 2025. It is now read-only.

Commit f0e449e

Browse files
zeek-botzeek-bot
committed
Generate docs
1 parent ddd0c05 commit f0e449e

File tree

7 files changed

+140
-39
lines changed

7 files changed

+140
-39
lines changed

‎script-reference/autogenerated-protocol-analyzer-index.rst‎

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2695,7 +2695,7 @@ Events
26952695
dns_TSIG_addl dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_SRV_reply dns_end
26962696

26972697
.. zeek:id:: dns_EDNS_addl
2698-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 529 529
2698+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 534 534
26992699

27002700
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_edns_additional`)
27012701

@@ -2716,6 +2716,11 @@ Events
27162716

27172717
:param ans: The parsed EDNS reply.
27182718

2719+
.. note::
2720+
2721+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
2722+
is set to false.
2723+
27192724
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_HINFO_reply dns_MX_reply
27202725
dns_NS_reply dns_PTR_reply dns_SOA_reply dns_SRV_reply dns_TSIG_addl
27212726
dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end dns_mapping_altered
@@ -2725,7 +2730,7 @@ Events
27252730
dns_skip_all_addl dns_skip_all_auth dns_skip_auth
27262731

27272732
.. zeek:id:: dns_EDNS_ecs
2728-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 553 553
2733+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 563 563
27292734

27302735
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, opt: :zeek:type:`dns_edns_ecs`)
27312736

@@ -2746,6 +2751,11 @@ Events
27462751

27472752
:param opt: The parsed EDNS option.
27482753

2754+
.. note::
2755+
2756+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
2757+
is set to false.
2758+
27492759
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_HINFO_reply dns_MX_reply
27502760
dns_NS_reply dns_PTR_reply dns_SOA_reply dns_SRV_reply dns_TSIG_addl
27512761
dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end dns_mapping_altered
@@ -2755,7 +2765,7 @@ Events
27552765
dns_skip_all_addl dns_skip_all_auth dns_skip_auth
27562766

27572767
.. zeek:id:: dns_EDNS_tcp_keepalive
2758-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 579 579
2768+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 594 594
27592769

27602770
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, opt: :zeek:type:`dns_edns_tcp_keepalive`)
27612771

@@ -2778,6 +2788,11 @@ Events
27782788

27792789
:param opt: The parsed EDNS Keepalive option.
27802790

2791+
.. note::
2792+
2793+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
2794+
is set to false.
2795+
27812796
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_HINFO_reply dns_MX_reply
27822797
dns_NS_reply dns_PTR_reply dns_SOA_reply dns_SRV_reply dns_TSIG_addl
27832798
dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end dns_mapping_altered
@@ -2787,7 +2802,7 @@ Events
27872802
dns_skip_all_addl dns_skip_all_auth dns_skip_auth
27882803

27892804
.. zeek:id:: dns_EDNS_cookie
2790-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 605 605
2805+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 625 625
27912806

27922807
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, opt: :zeek:type:`dns_edns_cookie`)
27932808

@@ -2810,6 +2825,11 @@ Events
28102825

28112826
:param opt: The parsed EDNS Cookie option.
28122827

2828+
.. note::
2829+
2830+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
2831+
is set to false.
2832+
28132833
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_HINFO_reply dns_MX_reply
28142834
dns_NS_reply dns_PTR_reply dns_SOA_reply dns_SRV_reply dns_TSIG_addl
28152835
dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end dns_mapping_altered
@@ -2819,7 +2839,7 @@ Events
28192839
dns_skip_all_addl dns_skip_all_auth dns_skip_auth
28202840

28212841
.. zeek:id:: dns_TKEY
2822-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 623 623
2842+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 648 648
28232843

28242844
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_tkey`)
28252845

@@ -2840,10 +2860,15 @@ Events
28402860

28412861
:param ans: The parsed TKEY reply.
28422862

2863+
.. note::
2864+
2865+
Note that ``ans`` will only be populated if :zeek:see:`dns_skip_all_addl`
2866+
is set to false.
2867+
28432868
.. zeek:see:: dns_TSIG_addl
28442869

28452870
.. zeek:id:: dns_TSIG_addl
2846-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 647 647
2871+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 677 677
28472872

28482873
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_tsig_additional`)
28492874

@@ -2864,6 +2889,11 @@ Events
28642889

28652890
:param ans: The parsed TSIG reply.
28662891

2892+
.. note::
2893+
2894+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
2895+
is set to false.
2896+
28672897
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_EDNS_addl
28682898
dns_HINFO_reply dns_MX_reply dns_NS_reply dns_PTR_reply dns_SOA_reply
28692899
dns_SRV_reply dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end
@@ -3065,7 +3095,7 @@ Events
30653095
:param loc: The parsed RDATA of LOC type record.
30663096

30673097
.. zeek:id:: dns_SVCB
3068-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 791 791
3098+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 821 821
30693099

30703100
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_answer`, svcb: :zeek:type:`dns_svcb_rr`)
30713101

@@ -3088,7 +3118,7 @@ Events
30883118
:param svcb: The parsed RDATA of SVCB type record.
30893119

30903120
.. zeek:id:: dns_HTTPS
3091-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 808 808
3121+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 838 838
30923122

30933123
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_answer`, https: :zeek:type:`dns_svcb_rr`)
30943124

@@ -3112,7 +3142,7 @@ Events
31123142
:param https: The parsed RDATA of HTTPS type record.
31133143

31143144
.. zeek:id:: dns_end
3115-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 831 831
3145+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 861 861
31163146

31173147
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`)
31183148

‎script-reference/autogenerated-script-index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,7 @@
380380
base/protocols/dns/__load__.zeek </scripts/base/protocols/dns/__load__.zeek>
381381
base/protocols/dns/consts.zeek </scripts/base/protocols/dns/consts.zeek>
382382
base/protocols/dns/main.zeek </scripts/base/protocols/dns/main.zeek>
383+
base/protocols/dns/check-event-handlers.zeek </scripts/base/protocols/dns/check-event-handlers.zeek>
383384
base/protocols/finger/__load__.zeek </scripts/base/protocols/finger/__load__.zeek>
384385
base/protocols/finger/spicy-events.zeek </scripts/base/protocols/finger/spicy-events.zeek>
385386
base/protocols/finger/main.zeek </scripts/base/protocols/finger/main.zeek>

‎scripts/base/bif/plugins/Zeek_DNS.events.bif.zeek.rst‎

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ Events
284284
:param ds: The parsed RDATA of DS record.
285285

286286
.. zeek:id:: dns_EDNS_addl
287-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 529 529
287+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 534 534
288288

289289
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_edns_additional`)
290290

@@ -305,6 +305,11 @@ Events
305305

306306
:param ans: The parsed EDNS reply.
307307

308+
.. note::
309+
310+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
311+
is set to false.
312+
308313
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_HINFO_reply dns_MX_reply
309314
dns_NS_reply dns_PTR_reply dns_SOA_reply dns_SRV_reply dns_TSIG_addl
310315
dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end dns_mapping_altered
@@ -314,7 +319,7 @@ Events
314319
dns_skip_all_addl dns_skip_all_auth dns_skip_auth
315320

316321
.. zeek:id:: dns_EDNS_cookie
317-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 605 605
322+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 625 625
318323

319324
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, opt: :zeek:type:`dns_edns_cookie`)
320325

@@ -337,6 +342,11 @@ Events
337342

338343
:param opt: The parsed EDNS Cookie option.
339344

345+
.. note::
346+
347+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
348+
is set to false.
349+
340350
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_HINFO_reply dns_MX_reply
341351
dns_NS_reply dns_PTR_reply dns_SOA_reply dns_SRV_reply dns_TSIG_addl
342352
dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end dns_mapping_altered
@@ -346,7 +356,7 @@ Events
346356
dns_skip_all_addl dns_skip_all_auth dns_skip_auth
347357

348358
.. zeek:id:: dns_EDNS_ecs
349-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 553 553
359+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 563 563
350360

351361
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, opt: :zeek:type:`dns_edns_ecs`)
352362

@@ -367,6 +377,11 @@ Events
367377

368378
:param opt: The parsed EDNS option.
369379

380+
.. note::
381+
382+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
383+
is set to false.
384+
370385
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_HINFO_reply dns_MX_reply
371386
dns_NS_reply dns_PTR_reply dns_SOA_reply dns_SRV_reply dns_TSIG_addl
372387
dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end dns_mapping_altered
@@ -376,7 +391,7 @@ Events
376391
dns_skip_all_addl dns_skip_all_auth dns_skip_auth
377392

378393
.. zeek:id:: dns_EDNS_tcp_keepalive
379-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 579 579
394+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 594 594
380395

381396
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, opt: :zeek:type:`dns_edns_tcp_keepalive`)
382397

@@ -399,6 +414,11 @@ Events
399414

400415
:param opt: The parsed EDNS Keepalive option.
401416

417+
.. note::
418+
419+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
420+
is set to false.
421+
402422
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_HINFO_reply dns_MX_reply
403423
dns_NS_reply dns_PTR_reply dns_SOA_reply dns_SRV_reply dns_TSIG_addl
404424
dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end dns_mapping_altered
@@ -438,7 +458,7 @@ Events
438458
dns_skip_all_addl dns_skip_all_auth dns_skip_auth
439459

440460
.. zeek:id:: dns_HTTPS
441-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 808 808
461+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 838 838
442462

443463
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_answer`, https: :zeek:type:`dns_svcb_rr`)
444464

@@ -805,7 +825,7 @@ Events
805825
:param binds: The parsed RDATA of BIND-Signing state record.
806826

807827
.. zeek:id:: dns_SVCB
808-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 791 791
828+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 821 821
809829

810830
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_answer`, svcb: :zeek:type:`dns_svcb_rr`)
811831

@@ -828,7 +848,7 @@ Events
828848
:param svcb: The parsed RDATA of SVCB type record.
829849

830850
.. zeek:id:: dns_TKEY
831-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 623 623
851+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 648 648
832852

833853
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_tkey`)
834854

@@ -849,10 +869,15 @@ Events
849869

850870
:param ans: The parsed TKEY reply.
851871

872+
.. note::
873+
874+
Note that ``ans`` will only be populated if :zeek:see:`dns_skip_all_addl`
875+
is set to false.
876+
852877
.. zeek:see:: dns_TSIG_addl
853878
854879
.. zeek:id:: dns_TSIG_addl
855-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 647 647
880+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 677 677
856881

857882
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`, ans: :zeek:type:`dns_tsig_additional`)
858883

@@ -873,6 +898,11 @@ Events
873898

874899
:param ans: The parsed TSIG reply.
875900

901+
.. note::
902+
903+
Note that this event will only be raised if :zeek:see:`dns_skip_all_addl`
904+
is set to false.
905+
876906
.. zeek:see:: dns_AAAA_reply dns_A_reply dns_CNAME_reply dns_EDNS_addl
877907
dns_HINFO_reply dns_MX_reply dns_NS_reply dns_PTR_reply dns_SOA_reply
878908
dns_SRV_reply dns_TXT_reply dns_SPF_reply dns_WKS_reply dns_end
@@ -945,7 +975,7 @@ Events
945975
dns_skip_addl dns_skip_all_addl dns_skip_all_auth dns_skip_auth
946976

947977
.. zeek:id:: dns_end
948-
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 831 831
978+
:source-code: base/bif/plugins/Zeek_DNS.events.bif.zeek 861 861
949979

950980
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, msg: :zeek:type:`dns_msg`)
951981

0 commit comments

Comments
 (0)