Fix typos and formatting in the dhcp protocol docs

Also added a link to an RFC and a Bro script (and corrected the name of the
script being referenced).
This commit is contained in:
Daniel Thayer 2013-10-15 16:19:06 -05:00
parent f0f1918954
commit e36fcf0190
3 changed files with 9 additions and 8 deletions

View file

@ -5,7 +5,7 @@ module DHCP;
export { export {
## Types of DHCP messages. See RFC 1533. ## Types of DHCP messages. See :rfc:`1533`.
const message_types = { const message_types = {
[1] = "DHCP_DISCOVER", [1] = "DHCP_DISCOVER",
[2] = "DHCP_OFFER", [2] = "DHCP_OFFER",

View file

@ -3,7 +3,8 @@
##! noisy on most networks, and focuses on the end-result: assigned leases. ##! noisy on most networks, and focuses on the end-result: assigned leases.
##! ##!
##! If you'd like to track known DHCP devices and to log the hostname ##! If you'd like to track known DHCP devices and to log the hostname
##! supplied by the client, see policy/protocols/dhcp/known-devices.bro ##! supplied by the client, see
##! :doc:`/scripts/policy/protocols/dhcp/known-devices-and-hostnames`.
@load ./utils.bro @load ./utils.bro
@ -18,7 +19,7 @@ export {
## associated connection is observed. ## associated connection is observed.
ts: time &log; ts: time &log;
## A unique identifier of the connection over which DHCP is ## A unique identifier of the connection over which DHCP is
## occuring. ## occurring.
uid: string &log; uid: string &log;
## The connection's 4-tuple of endpoint addresses/ports. ## The connection's 4-tuple of endpoint addresses/ports.
id: conn_id &log; id: conn_id &log;
@ -28,7 +29,7 @@ export {
assigned_ip: addr &log &optional; assigned_ip: addr &log &optional;
## IP address lease interval. ## IP address lease interval.
lease_time: interval &log &optional; lease_time: interval &log &optional;
## A random number choosen by the client for this transaction. ## A random number chosen by the client for this transaction.
trans_id: count &log; trans_id: count &log;
}; };
@ -37,7 +38,7 @@ export {
global log_dhcp: event(rec: Info); global log_dhcp: event(rec: Info);
} }
# Add the dhcp info to the connection record # Add the dhcp info to the connection record.
redef record connection += { redef record connection += {
dhcp: Info &optional; dhcp: Info &optional;
}; };

View file

@ -3,11 +3,11 @@
module DHCP; module DHCP;
export { export {
## Reverse the octets of an IPv4 IP. ## Reverse the octets of an IPv4 address.
## ##
## ip: An :bro:type:`addr` IPv4 address. ## ip: An IPv4 address.
## ##
## Returns: A reversed addr. ## Returns: A reversed IPv4 address.
global reverse_ip: function(ip: addr): addr; global reverse_ip: function(ip: addr): addr;
} }