mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 14:48:21 +00:00
ded98cd373
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
82 lines
2.8 KiB
ReStructuredText
82 lines
2.8 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/protocols/http/utils.zeek
|
|
==============================
|
|
.. zeek:namespace:: HTTP
|
|
|
|
Utilities specific for HTTP processing.
|
|
|
|
:Namespace: HTTP
|
|
:Imports: :doc:`base/protocols/http/main.zeek </scripts/base/protocols/http/main.zeek>`, :doc:`base/utils/addrs.zeek </scripts/base/utils/addrs.zeek>`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Functions
|
|
#########
|
|
====================================================== ====================================================================
|
|
:zeek:id:`HTTP::build_url`: :zeek:type:`function` Creates a URL from an :zeek:type:`HTTP::Info` record.
|
|
:zeek:id:`HTTP::build_url_http`: :zeek:type:`function` Creates a URL from an :zeek:type:`HTTP::Info` record.
|
|
:zeek:id:`HTTP::describe`: :zeek:type:`function` Create an extremely shortened representation of a log line.
|
|
:zeek:id:`HTTP::extract_keys`: :zeek:type:`function` Given a string containing a series of key-value pairs separated
|
|
by "=", this function can be used to parse out all of the key names.
|
|
====================================================== ====================================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Functions
|
|
#########
|
|
.. zeek:id:: HTTP::build_url
|
|
:source-code: base/protocols/http/utils.zeek 55 66
|
|
|
|
:Type: :zeek:type:`function` (rec: :zeek:type:`HTTP::Info`) : :zeek:type:`string`
|
|
|
|
Creates a URL from an :zeek:type:`HTTP::Info` record. This should
|
|
handle edge cases such as proxied requests appropriately.
|
|
|
|
|
|
:param rec: An :zeek:type:`HTTP::Info` record.
|
|
|
|
|
|
:returns: A URL, not prefixed by ``"http://"``.
|
|
|
|
.. zeek:id:: HTTP::build_url_http
|
|
:source-code: base/protocols/http/utils.zeek 68 71
|
|
|
|
:Type: :zeek:type:`function` (rec: :zeek:type:`HTTP::Info`) : :zeek:type:`string`
|
|
|
|
Creates a URL from an :zeek:type:`HTTP::Info` record. This should
|
|
handle edge cases such as proxied requests appropriately.
|
|
|
|
|
|
:param rec: An :zeek:type:`HTTP::Info` record.
|
|
|
|
|
|
:returns: A URL prefixed with ``"http://"``.
|
|
|
|
.. zeek:id:: HTTP::describe
|
|
:source-code: base/protocols/http/utils.zeek 73 76
|
|
|
|
:Type: :zeek:type:`function` (rec: :zeek:type:`HTTP::Info`) : :zeek:type:`string`
|
|
|
|
Create an extremely shortened representation of a log line.
|
|
|
|
.. zeek:id:: HTTP::extract_keys
|
|
:source-code: base/protocols/http/utils.zeek 41 53
|
|
|
|
:Type: :zeek:type:`function` (data: :zeek:type:`string`, kv_splitter: :zeek:type:`pattern`) : :zeek:type:`string_vec`
|
|
|
|
Given a string containing a series of key-value pairs separated
|
|
by "=", this function can be used to parse out all of the key names.
|
|
|
|
|
|
:param data: The raw data, such as a URL or cookie value.
|
|
|
|
|
|
:param kv_splitter: A regular expression representing the separator between
|
|
key-value pairs.
|
|
|
|
|
|
:returns: A vector of strings containing the keys.
|
|
|
|
|