zeek/doc/scripts/base/protocols/smb/files.bro.rst
Jon Siwek 7e9d48f532 Remove broxygen Sphinx integration
The broxygen-generated files now live in the git repo, have tests
that check that they are up-to-date, and a script to re-generate
them on-demand.
2018-12-18 10:15:22 -06:00

37 lines
1 KiB
ReStructuredText

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