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

45 lines
1.3 KiB
ReStructuredText

:tocdepth: 3
base/bif/plugins/Zeek_File.events.bif.zeek
==========================================
.. zeek:namespace:: GLOBAL
:Namespace: GLOBAL
Summary
~~~~~~~
Events
######
=============================================== ========================================================================
:zeek:id:`file_transferred`: :zeek:type:`event` Generated when a TCP connection associated w/ file data transfer is seen
(e.g.
=============================================== ========================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. zeek:id:: file_transferred
:source-code: base/protocols/ftp/main.zeek 450 458
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, prefix: :zeek:type:`string`, descr: :zeek:type:`string`, mime_type: :zeek:type:`string`)
Generated when a TCP connection associated w/ file data transfer is seen
(e.g. as happens w/ FTP or IRC).
:param c: The connection over which file data is transferred.
:param prefix: Up to 1024 bytes of the file data.
:param descr: Deprecated/unused argument.
:param mime_type: MIME type of the file or "<unknown>" if no file magic signatures
matched.