zeek/doc/scripts/base/bif/plugins/Zeek_FileEntropy.events.bif.zeek.rst
Tim Wojtulewicz ded98cd373 Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
2025-09-26 02:58:29 +00:00

39 lines
998 B
ReStructuredText

:tocdepth: 3
base/bif/plugins/Zeek_FileEntropy.events.bif.zeek
=================================================
.. zeek:namespace:: GLOBAL
:Namespace: GLOBAL
Summary
~~~~~~~
Events
######
=========================================== ========================================================
:zeek:id:`file_entropy`: :zeek:type:`event` This event is generated each time file analysis performs
entropy testing on a file.
=========================================== ========================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. zeek:id:: file_entropy
:source-code: policy/frameworks/files/entropy-test-all-files.zeek 16 19
:Type: :zeek:type:`event` (f: :zeek:type:`fa_file`, ent: :zeek:type:`entropy_test_result`)
This event is generated each time file analysis performs
entropy testing on a file.
:param f: The file.
:param ent: The results of the entropy testing.