Skip to content

Add human-readable stdout display for all event types#3035

Merged
liquidsec merged 1 commit into
3.0from
event-display-format
Apr 13, 2026
Merged

Add human-readable stdout display for all event types#3035
liquidsec merged 1 commit into
3.0from
event-display-format

Conversation

@liquidsec

Copy link
Copy Markdown
Collaborator

Summary

Override _data_human() for all dict-based event types so they show concise, readable output on stdout instead of raw JSON dumps.

Before / After

FINDING

Before: {"confidence": "CONFIRMED", "description": "Found exposed admin panel", "host": "example.com", "name": "Exposed Admin", "severity": "HIGH", "url": "http://example.com/admin"}
After: Severity: [HIGH] Confidence: [CONFIRMED] Found exposed admin panel (http://example.com/admin)

With CVEs:
After: Severity: [CRITICAL] Confidence: [HIGH] Remote code execution (http://example.com/) [CVE-2024-1234, CVE-2024-5678]

TECHNOLOGY

Before: {"host": "example.com", "technology": "nginx", "url": "http://example.com/"}
After: nginx (http://example.com/)

PROTOCOL

Before: {"banner": "SSH-2.0-OpenSSH_8.9", "host": "example.com", "port": 22, "protocol": "SSH"}
After: SSH/22 - SSH-2.0-OpenSSH_8.9

WAF

Before: {"host": "example.com", "url": "http://example.com/", "waf": "cloudflare"}
After: cloudflare (http://example.com/)

ASN

Before: {"asn": 13335}
After: AS13335

CODE_REPOSITORY

Before: {"url": "https://github.com/org/repo"}
After: https://github.com/org/repo

WEB_PARAMETER

Before: {"additional_params": {}, "description": "HTTP Extracted Parameter (GET)", "host": "example.com", "name": "q", "original_value": "test", "type": "GETPARAM", "url": "http://example.com/search"}
After: [GETPARAM] q=test - HTTP Extracted Parameter (GET) (http://example.com/search)

SOCIAL

Before: {"platform": "github", "profile_name": "liquidsec", "url": "https://github.com/liquidsec"}
After: github: liquidsec (https://github.com/liquidsec)

AZURE_TENANT

Before: {"domains": ["example.com", "contoso.onmicrosoft.com"], "tenant-id": "a1b2c3d4-...", "tenant-names": ["contoso"]}
After: contoso (a1b2c3d4-...) - example.com, contoso.onmicrosoft.com

WEBSCREENSHOT

Before: {"path": "gowitness/screenshots/http-example-com-.png", "url": "http://example.com/"}
After: http://example.com/ Saved to: gowitness/screenshots/http-example-com-.png

FILESYSTEM

Before: {"magic_description": "PDF document, version 1.7", "magic_extension": "pdf", "magic_mime_type": "application/pdf", "path": "filedownload/document.pdf"}
After: filedownload/document.pdf (PDF document, version 1.7)

RAW_DNS_RECORD

Before: {"answer": "93.184.216.34", "host": "example.com", "type": "A"}
After: A example.com -> 93.184.216.34

MOBILE_APP

Before: {"id": "com.example.myapp", "url": "https://play.google.com/store/apps/details?id=com.example.myapp"}
After: com.example.myapp (https://play.google.com/store/apps/details?id=com.example.myapp)

GEOLOCATION

Before: {"city": "New York", "country_name": "United States", "latitude": 40.7128, "longitude": -74.006, "region_name": "New York", ...}
After: New York, New York, United States (40.7128, -74.006)

HTTP_RESPONSE

Before: (entire raw HTTP response body + headers as JSON)
After: [200] GET http://example.com/ - [Example Domain] (12.4KB)

STORAGE_BUCKET

Before: {"name": "my-bucket", "url": "https://my-bucket.s3.amazonaws.com/"}
After: my-bucket (https://my-bucket.s3.amazonaws.com/)

@github-actions

Copy link
Copy Markdown
Contributor

📊 Performance Benchmark Report

Comparing 3.0 (baseline) vs event-display-format (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.15ms 4.15ms +0.1%
Bloom Filter Large Scale Dns Brute Force 16.92ms 16.98ms +0.3%
Large Closest Match Lookup 359.93ms 352.78ms -2.0%
Realistic Closest Match Workload 190.30ms 188.90ms -0.7%
Event Memory Medium Scan 1782 B/event 1784 B/event +0.1%
Event Memory Large Scan 1768 B/event 1768 B/event +0.0%
Event Validation Full Scan Startup Small Batch 408.19ms 403.03ms -1.3%
Event Validation Full Scan Startup Large Batch 586.26ms 576.42ms -1.7%
Make Event Autodetection Small 30.96ms 30.81ms -0.5%
Make Event Autodetection Large 314.07ms 313.40ms -0.2%
Make Event Explicit Types 13.89ms 13.72ms -1.3%
Excavate Single Thread Small 4.013s 3.980s -0.8%
Excavate Single Thread Large 9.551s 9.655s +1.1%
Excavate Parallel Tasks Small 4.117s 4.161s +1.1%
Excavate Parallel Tasks Large 7.188s 7.210s +0.3%
Is Ip Performance 3.19ms 3.16ms -0.9%
Make Ip Type Performance 12.02ms 11.58ms -3.6%
Mixed Ip Operations 4.54ms 4.47ms -1.5%
Memory Use Web Crawl 45.5 MB 45.3 MB -0.3%
Memory Use Subdomain Enum 19.3 MB 19.4 MB +0.1%
Scan Throughput 100 7.553s 6.981s -7.6%
Scan Throughput 1000 41.699s 40.054s -3.9%
Typical Queue Shuffle 63.95µs 64.65µs +1.1%
Priority Queue Shuffle 728.78µs 736.84µs +1.1%

🎯 Performance Summary

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


🐍 Python Version 3.11.15

@codecov

codecov Bot commented Apr 13, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 57.74648% with 60 lines in your changes missing coverage. Please review.
✅ Project coverage is 91%. Comparing base (39b9d31) to head (96f5627).
⚠️ Report is 2 commits behind head on 3.0.

Files with missing lines Patch % Lines
bbot/core/event/base.py 58% 60 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff           @@
##             3.0   #3035    +/-   ##
======================================
- Coverage     91%     91%    -0%     
======================================
  Files        440     440            
  Lines      37411   37550   +139     
======================================
+ Hits       33890   33969    +79     
- Misses      3521    3581    +60     

☔ 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.

@liquidsec liquidsec merged commit 677f7c0 into 3.0 Apr 13, 2026
18 checks passed
@liquidsec liquidsec deleted the event-display-format branch April 13, 2026 20:44
@liquidsec liquidsec mentioned this pull request Jun 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants