Skip to content

Commit

Permalink
doc: add arp changes
Browse files Browse the repository at this point in the history
  • Loading branch information
glongo authored and victorjulien committed May 16, 2024
1 parent 01586d8 commit 8a171c9
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 0 deletions.
44 changes: 44 additions & 0 deletions doc/userguide/output/eve/eve-json-format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3011,3 +3011,47 @@ Example of DHCP log entry (extended logging enabled):
"client_id":"54:ee:75:51:e0:66",
"dns_servers":["192.168.1.50","192.168.1.49"]
}

Event type: ARP
---------------

Fields
~~~~~~

* "hw_type": network link protocol type
* "proto_type": internetwork protocol for which the request is intended
* "opcode": operation that the sender is performing (e.g. request, response)
* "src_mac": source MAC address
* "src_ip": source IP address
* "dest_mac": destination MAC address
* "dest_ip": destination IP address

Examples
~~~~~~~~

Example of ARP logging: request and response

::

"arp": {
"hw_type": "ethernet",
"proto_type": "ipv4",
"opcode": "request",
"src_mac": "00:1a:6b:6c:0c:cc",
"src_ip": "10.10.10.2",
"dest_mac": "00:00:00:00:00:00",
"dest_ip": "10.10.10.1"
}

::

"arp": {
"hw_type": "ethernet",
"proto_type": "ipv4",
"opcode": "reply",
"src_mac": "00:1a:6b:6c:0c:cc",
"src_ip": "10.10.10.2",
"dest_mac": "00:1d:09:f0:92:ab",
"dest_ip": "10.10.10.1"
}

14 changes: 14 additions & 0 deletions doc/userguide/output/eve/eve-json-output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,20 @@ enabled, then the log gets more verbose.

By using ``custom`` it is possible to select which TLS fields to log.

ARP
~~~

ARP records are logged as one entry for the request, and one entry for
the response.

YAML::

- arp:
enabled: no

The logger is disabled by default since ARP can generate a large
number of events.

Drops
~~~~~

Expand Down
2 changes: 2 additions & 0 deletions doc/userguide/partials/eve-log.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,8 @@ outputs:
# BitTorrent DHT logging.
- bittorrent-dht
- ssh
- arp:
enabled: no
- stats:
totals: yes # stats for all threads merged together
threads: no # per thread stats
Expand Down
2 changes: 2 additions & 0 deletions doc/userguide/upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ Major changes
- SDP parser and logger have been introduced.
Due to SDP being encapsulated within other protocols, such as SIP, they cannot be directly enabled or disabled.
Instead, both the SDP parser and logger depend on being invoked by another parser (or logger).
- ARP decoder and logger have been introduced.
Since ARP can be quite verbose and produce many events, the logger is disabled by default.

Upgrading 6.0 to 7.0
--------------------
Expand Down

0 comments on commit 8a171c9

Please sign in to comment.