zeek/doc/scripts/base/protocols/smb/files.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
1.2 KiB
ReStructuredText

:tocdepth: 3
base/protocols/smb/files.zeek
=============================
.. zeek:namespace:: SMB
:Namespace: SMB
:Imports: :doc:`base/frameworks/files </scripts/base/frameworks/files/index>`, :doc:`base/protocols/smb/main.zeek </scripts/base/protocols/smb/main.zeek>`
Summary
~~~~~~~
Functions
#########
====================================================== =====================================
:zeek:id:`SMB::describe_file`: :zeek:type:`function` Default file describer for SMB.
:zeek:id:`SMB::get_file_handle`: :zeek:type:`function` Default file handle provider for SMB.
====================================================== =====================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: SMB::describe_file
:source-code: base/protocols/smb/files.zeek 36 48
:Type: :zeek:type:`function` (f: :zeek:type:`fa_file`) : :zeek:type:`string`
Default file describer for SMB.
.. zeek:id:: SMB::get_file_handle
:source-code: base/protocols/smb/files.zeek 14 34
:Type: :zeek:type:`function` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`) : :zeek:type:`string`
Default file handle provider for SMB.