zeek/doc/scripts/base/utils/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

39 lines
1.6 KiB
ReStructuredText

:tocdepth: 3
base/utils/files.bro
====================
:Imports: :doc:`base/utils/addrs.bro </scripts/base/utils/addrs.bro>`
Summary
~~~~~~~
Functions
#########
========================================================================= ======================================================================
:bro:id:`extract_filename_from_content_disposition`: :bro:type:`function` For CONTENT-DISPOSITION headers, this function can be used to extract
the filename.
:bro:id:`generate_extraction_filename`: :bro:type:`function` This function can be used to generate a consistent filename for when
contents of a file, stream, or connection are being extracted to disk.
========================================================================= ======================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. bro:id:: extract_filename_from_content_disposition
:Type: :bro:type:`function` (data: :bro:type:`string`) : :bro:type:`string`
For CONTENT-DISPOSITION headers, this function can be used to extract
the filename.
.. bro:id:: generate_extraction_filename
:Type: :bro:type:`function` (prefix: :bro:type:`string`, c: :bro:type:`connection`, suffix: :bro:type:`string`) : :bro:type:`string`
This function can be used to generate a consistent filename for when
contents of a file, stream, or connection are being extracted to disk.