Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 14:48:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Fix typos and formatting in the http protocol docs

Browse source 
Also adjusted line numbers in scripting doc due to changes in http/main.bro
This commit is contained in:
Daniel Thayer 2013-10-16 13:13:53 -05:00
parent 98181e829b
commit fe60404f0f
5 changed files with 21 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/scripting/index.rst
View file

@ -351,7 +351,7 @@ decrypted from HTTP streams is stored in
excerpt from :doc:`/scripts/base/protocols/http/main` below. excerpt from :doc:`/scripts/base/protocols/http/main` below.
.. btest-include:: ${BRO_SRC_ROOT}/scripts/base/protocols/http/main.bro .. btest-include:: ${BRO_SRC_ROOT}/scripts/base/protocols/http/main.bro
:lines: 8-10,19,20,118 :lines: 8-10,19-21,120
Because the constant was declared with the ``&redef`` attribute, if we Because the constant was declared with the ``&redef`` attribute, if we
needed to turn this option on globally, we could do so by adding the needed to turn this option on globally, we could do so by adding the

6
scripts/base/protocols/http/entities.bro
View file

@ -28,9 +28,11 @@ export {
## The current entity. ## The current entity.
current_entity: Entity &optional; current_entity: Entity &optional;
## Current number of MIME entities in the HTTP request message body. ## Current number of MIME entities in the HTTP request message
## body.
orig_mime_depth: count &default=0; orig_mime_depth: count &default=0;
## Current number of MIME entities in the HTTP response message body. ## Current number of MIME entities in the HTTP response message
## body.
resp_mime_depth: count &default=0; resp_mime_depth: count &default=0;
}; };
} }

10
scripts/base/protocols/http/main.bro
View file

@ -16,7 +16,8 @@ export {
EMPTY EMPTY
}; };
## This setting changes if passwords used in Basic-Auth are captured or not. ## This setting changes if passwords used in Basic-Auth are captured or
## not.
const default_capture_password = F &redef; const default_capture_password = F &redef;
type Info: record { type Info: record {
@ -36,8 +37,8 @@ export {
## URI used in the request. ## URI used in the request.
uri: string &log &optional; uri: string &log &optional;
## Value of the "referer" header. The comment is deliberately ## Value of the "referer" header. The comment is deliberately
## misspelled like the standard declares, but the name used here is ## misspelled like the standard declares, but the name used here
## "referrer" spelled correctly. ## is "referrer" spelled correctly.
referrer: string &log &optional; referrer: string &log &optional;
## Value of the User-Agent header from the client. ## Value of the User-Agent header from the client.
user_agent: string &log &optional; user_agent: string &log &optional;
@ -55,7 +56,8 @@ export {
info_code: count &log &optional; info_code: count &log &optional;
## Last seen 1xx informational reply message returned by the server. ## Last seen 1xx informational reply message returned by the server.
info_msg: string &log &optional; info_msg: string &log &optional;
## Filename given in the Content-Disposition header sent by the server. ## Filename given in the Content-Disposition header sent by the
## server.
filename: string &log &optional; filename: string &log &optional;
## A set of indicators of various attributes discovered and ## A set of indicators of various attributes discovered and
## related to a particular request/response pair. ## related to a particular request/response pair.

16
scripts/base/protocols/http/utils.bro
View file

@ -6,8 +6,8 @@
module HTTP; module HTTP;
export { export {
## Given a string containing a series of key-value pairs separated by "=", ## Given a string containing a series of key-value pairs separated
## this function can be used to parse out all of the key names. ## by "=", this function can be used to parse out all of the key names.
## ##
## data: The raw data, such as a URL or cookie value. ## data: The raw data, such as a URL or cookie value.
## ##
@ -17,20 +17,20 @@ export {
## Returns: A vector of strings containing the keys. ## Returns: A vector of strings containing the keys.
global extract_keys: function(data: string, kv_splitter: pattern): string_vec; global extract_keys: function(data: string, kv_splitter: pattern): string_vec;
## Creates a URL from an :bro:type:`HTTP::Info` record. This should handle ## Creates a URL from an :bro:type:`HTTP::Info` record. This should
## edge cases such as proxied requests appropriately. ## handle edge cases such as proxied requests appropriately.
## ##
## rec: An :bro:type:`HTTP::Info` record. ## rec: An :bro:type:`HTTP::Info` record.
## ##
## Returns: A URL, not prefixed by "http://". ## Returns: A URL, not prefixed by ``"http://"``.
global build_url: function(rec: Info): string; global build_url: function(rec: Info): string;
## Creates a URL from an :bro:type:`HTTP::Info` record. This should handle ## Creates a URL from an :bro:type:`HTTP::Info` record. This should
## edge cases such as proxied requests appropriately. ## handle edge cases such as proxied requests appropriately.
## ##
## rec: An :bro:type:`HTTP::Info` record. ## rec: An :bro:type:`HTTP::Info` record.
## ##
## Returns: A URL prefixed with "http://". ## Returns: A URL prefixed with ``"http://"``.
global build_url_http: function(rec: Info): string; global build_url_http: function(rec: Info): string;
## Create an extremely shortened representation of a log line. ## Create an extremely shortened representation of a log line.

3
testing/btest/doc/sphinx/include-scripts_base_protocols_http_main_bro.btest
View file

@ -5,6 +5,7 @@ main.bro
module HTTP; module HTTP;
export { export {
## This setting changes if passwords used in Basic-Auth are captured or not. ## This setting changes if passwords used in Basic-Auth are captured or
## not.
const default_capture_password = F &redef; const default_capture_password = F &redef;
} }