BBOT 3.0 - blazed_elijah

[TheTechromancer]

Summary

BBOT 3.0 "blazed_elijah" contains changes needed to store BBOT data in a persistent database. The idea is to release it alongside BBOT server, a tiny CLI-only database. This will be paired with a series of blog posts showing how BBOT server can be used on the command line to script out bug bounty hunting, threat intel, and ASM (i.e. running scheduled scans, exporting to CSV, diffing results over time, etc.).

Together, BBOT 3.0 and BBOT server will give us a solid foundation to build a bunch of other useful tooling, like asset inventory. Sometime in the future, it may also be useful to frontend.

Breaking changes

1. .data and .data_json event fields

The main breaking change in BBOT 3.0 is that the name of the .data field is different based on whether it's a str or dict.

• .data: string
• .data_json: dictionary

The siem_friendly option has been removed, since BBOT data is now SIEM-friendly by default.

2. Generic names for findings + vulnerabilities

A name field has been added to findings and vulns, which holds a generic description common to all vulns of the same type. This makes it easier to collapse and categorize them.

Features

• New Module: MongoDB Output #1992
• New Module: Elastic Output #2010
• New Module: RabbitMQ Output #2013
• New Module: Kafka Output #2011
• New Module: ZeroMQ Output #2015
• New Module: NATS Output #2017

Potential changes

• Can "internal" and "omitted" events be merged? #1592

[codecov]

Codecov Report

❌ Patch coverage is 67.92956% with 601 lines in your changes missing coverage. Please review.
✅ Project coverage is 92%. Comparing base (a4201ba) to head (28e4603).
⚠️ Report is 387 commits behind head on dev.

Files with missing lines	Patch %	Lines
...est/benchmarks/test_event_validation_benchmarks.py	9%	197 Missing ⚠️
bbot/test/benchmarks/test_excavate_benchmarks.py	15%	108 Missing ⚠️
bbot/test/benchmarks/test_ipaddress_benchmarks.py	18%	71 Missing ⚠️
...ot/test/benchmarks/test_bloom_filter_benchmarks.py	21%	42 Missing ⚠️
...t/test/benchmarks/test_closest_match_benchmarks.py	29%	27 Missing ⚠️
...est/benchmarks/test_weighted_shuffle_benchmarks.py	35%	25 Missing ⚠️
bbot/modules/base.py	49%	14 Missing ⚠️
bbot/constants.py	71%	11 Missing ⚠️
bbot/modules/retirejs.py	89%	11 Missing ⚠️
bbot/scanner/scanner.py	86%	11 Missing ⚠️
... and 24 more

Additional details and impacted files

@@           Coverage Diff           @@
##             dev   #2007     +/-   ##
=======================================
- Coverage     93%     92%     -1%     
=======================================
  Files        400     425     +25     
  Lines      33202   34426   +1224     
=======================================
+ Hits       30693   31381    +688     
- Misses      2509    3045    +536     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions]

📊 Performance Benchmark Report

Comparing dev (baseline) vs 3.0 (current)

📈 Detailed Results (All Benchmarks)

📋 Complete results for all benchmarks - includes both significant and insignificant changes

🧪 Test Name	📏 Base	📏 Current	📈 Change	🎯 Status
Bloom Filter Dns Mutation Tracking Performance	4.12ms	4.25ms	+3.2% ⚪	✅
Bloom Filter Large Scale Dns Brute Force	17.84ms	17.95ms	+0.6% ⚪	✅
Large Closest Match Lookup	358.70ms	347.12ms	-3.2% ⚪	✅
Realistic Closest Match Workload	194.89ms	190.18ms	-2.4% ⚪	✅
Event Validation Full Scan Startup Small Batch	451.00ms	474.57ms	+5.2% ⚪	✅
Event Validation Full Scan Startup Large Batch	802.32ms	828.54ms	+3.3% ⚪	✅
Make Event Autodetection Small	31.57ms	31.33ms	-0.8% ⚪	✅
Make Event Autodetection Large	320.45ms	324.37ms	+1.2% ⚪	✅
Make Event Explicit Types	13.95ms	14.13ms	+1.3% ⚪	✅
Excavate Single Thread Small	4.069s	4.130s	+1.5% ⚪	✅
Excavate Single Thread Large	9.555s	9.593s	+0.4% ⚪	✅
Excavate Parallel Tasks Small	4.250s	4.314s	+1.5% ⚪	✅
Excavate Parallel Tasks Large	7.265s	7.362s	+1.3% ⚪	✅
Is Ip Performance	3.20ms	3.15ms	-1.4% ⚪	✅
Make Ip Type Performance	11.34ms	11.56ms	+2.0% ⚪	✅
Mixed Ip Operations	4.43ms	4.49ms	+1.5% ⚪	✅
Typical Queue Shuffle	62.26µs	63.39µs	+1.8% ⚪	✅
Priority Queue Shuffle	703.64µs	701.16µs	-0.4% ⚪	✅

🎯 Performance Summary

✅ No significant performance changes detected (all changes <10%)

---

🐍 Python Version 3.11.13