Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.03 KB

files.zeek.rst

File metadata and controls

49 lines (33 loc) · 2.03 KB
tocdepth:3

base/protocols/ftp/files.zeek

.. zeek:namespace:: FTP

Namespace:FTP
Imports::doc:`base/frameworks/files </scripts/base/frameworks/files/index>`, :doc:`base/protocols/ftp/info.zeek </scripts/base/protocols/ftp/info.zeek>`, :doc:`base/protocols/ftp/main.zeek </scripts/base/protocols/ftp/main.zeek>`, :doc:`base/protocols/ftp/utils.zeek </scripts/base/protocols/ftp/utils.zeek>`, :doc:`base/utils/conn-ids.zeek </scripts/base/utils/conn-ids.zeek>`

Summary

Redefinitions

:zeek:type:`fa_file`: :zeek:type:`record` :zeek:attr:`&redef`
New Fields:

:zeek:type:`fa_file`

ftp: :zeek:type:`FTP::Info` :zeek:attr:`&optional`

Functions

:zeek🆔`FTP::describe_file`: :zeek:type:`function` Describe the file being transferred.
:zeek🆔`FTP::get_file_handle`: :zeek:type:`function` Default file handle provider for FTP.

Detailed Interface

Functions

.. zeek:id:: FTP::describe_file
   :source-code: base/protocols/ftp/files.zeek 29 41

   :Type: :zeek:type:`function` (f: :zeek:type:`fa_file`) : :zeek:type:`string`

   Describe the file being transferred.
.. zeek:id:: FTP::get_file_handle
   :source-code: base/protocols/ftp/files.zeek 21 27

   :Type: :zeek:type:`function` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`) : :zeek:type:`string`

   Default file handle provider for FTP.