Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-17 14:08:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Copy docs into Zeek repo directly

Browse source 
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
This commit is contained in:
Tim Wojtulewicz 2025-09-15 15:52:18 -07:00
parent 83f1e74643
commit ded98cd373
1074 changed files with 169319 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

60
doc/scripts/base/bif/plugins/Zeek_HTTP.functions.bif.zeek.rst Normal file
View file

@ -0,0 +1,60 @@
:tocdepth: 3
base/bif/plugins/Zeek_HTTP.functions.bif.zeek
=============================================
.. zeek:namespace:: GLOBAL
:Namespace: GLOBAL
Summary
~~~~~~~
Functions
#########
======================================================= ===============================================================
:zeek:id:`skip_http_entity_data`: :zeek:type:`function` Skips the data of the HTTP entity.
:zeek:id:`unescape_URI`: :zeek:type:`function` Unescapes all characters in a URI (decode every ``%xx`` group).
======================================================= ===============================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: skip_http_entity_data
:source-code: base/bif/plugins/Zeek_HTTP.functions.bif.zeek 14 14
:Type: :zeek:type:`function` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`) : :zeek:type:`any`
Skips the data of the HTTP entity.
:param c: The HTTP connection.
:param is_orig: If true, the client data is skipped, and the server data otherwise.
.. zeek:see:: skip_smtp_data
.. zeek:id:: unescape_URI
:source-code: base/bif/plugins/Zeek_HTTP.functions.bif.zeek 30 30
:Type: :zeek:type:`function` (URI: :zeek:type:`string`) : :zeek:type:`string`
Unescapes all characters in a URI (decode every ``%xx`` group).
:param URI: The URI to unescape.
:returns: The unescaped URI with all ``%xx`` groups decoded.
.. note::
Unescaping reserved characters may cause loss of information.
:rfc:`2396`: A URI is always in an "escaped" form, since escaping or
unescaping a completed URI might change its semantics. Normally, the
only time escape encodings can safely be made is when the URI is
being created from its component parts.