Dovehawk Zeek Module

Threat Hunting with Zeek (Bro) and MISP

This module uses Zeek's built-in Intelligence Framework to load and monitor signatures from MISP automatically. Indicators are downloaded from MISP every 4 hours and hits, called sightings, are reported back to MISP immediately. The module also includes a customized version of Jan Grashoefer's expiration code to remove indicators after they are deleted from MISP.

Indicators are downloaded and read into memory. Content signatures in signatures.sig are MISP Network Activity->zeek items downloaded from MISP. The event text should start with "MISP:" (see Sample Content Signature section for an example). Zeek must be restarted to ingest the content signatures. To do this automatically we recommend restarting Zeek using zeekctl and a restart cron described in included file INSTALL.md

Optional Slack.com web hook reporting.

Sticker 1 Sticker 2

Screencaps

Dovehawk Downloads Indicators From MISP

Dovehawk signature download

Dovehawk Sighting Uploaded

Dovehawk hit and sighting upload

MISP Sighting

MISP sightings

Slack Web Hook

Intel Item Expiration

Items expiring

Sample Content Signature

signature eicar_test_content {
  ip-proto == tcp
  payload /.*X5O\!P%@AP\[4\\PZX54\(P\^\)7CC\)7\}\$EICAR\-STANDARD\-ANTIVIRUS\-TEST\-FILE\!\$H\+H\*/
  event "MISP: eicar test file in TCP plain text"
}

Note: Zeek's default setting is to buffer the first 1024 bytes of a TCP connection so signature's should be written with that in mind.

Indicator Expiration

Indicators are downloaded automatically every 4 hours and are assigned an expiry of 4.5 hours. A check for expired indicators occurs every 4.5 hours to cleanup any expired indicators between downloads. As indicators are reingested the expiration time is reset to 4.5 hours. A message is now printed for each expired indicator.

If an indicator is hit after expiration but before the cleanup, it will trigger a hit/sighting, but the indicator is then deleted immediately so no further hits will occur.

Intervals are set in config.zeek.

Setting for expired indicator cleanup (should be less then signature_refresh_period)

redef Intel::item_expiration = 4.5 hr

Setting for MISP download interval

global signature_refresh_period = 4hr &redef;

Setting for indicator expiration: (should be slightly more than signature_refresh_period)

redef Intel::item_expiration = 4.5 hr;

Maximum number of hits for an individual item per refresh period

global MAX_HITS: int = 100;

Maximum number of DNS hits for an individual item per refresh period

global MAX_DNS_HITS: int = 2;

Maximum number of inbound IP hits for an individual item per refresh period

global MAX_SCAN_HITS: int = 2;

Ignore hits in SSL certificate when domains don't match the sni host

global IGNORE_SNI_MISMATCH: bool = T;

Ignore CURL SSL Certificate Warnings

global CURL_INSECURE: bool = T;

Official Source

https://github.com/tylabs/dovehawk/

Related Projects

MISP

Zeek Network Security Monitor

Zeek Package Manager - Zeek Packages to add on functionality.

Zeek Cluster and Recommended Hardware

MISP Sightings - Sightings are feedback on threat intelligence activity seen.

Special Thanks

The entire MISP team and Alexandre Dulaunoy @adulau for adding the zeek datatype to MISP.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

tylabs / dovehawk

readme