From 329fce6ccb24120f8d028afa410d55bdc3bff505 Mon Sep 17 00:00:00 2001 From: Darryl Nixon Date: Wed, 6 Sep 2023 19:31:24 -0700 Subject: [PATCH] * feat(README.md): update bronzeburner description * fix(README.md): move bronzeburner logo to img directory --- README.md | 14 ++++++++++++-- bronzeburner.png => img/bronzeburner.png | Bin 2 files changed, 12 insertions(+), 2 deletions(-) rename bronzeburner.png => img/bronzeburner.png (100%) diff --git a/README.md b/README.md index 8594f84..5da5f8f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
-bronzeburner logo +bronzeburner logo # bronzeburner @@ -16,7 +16,17 @@ use it to monitor your enterprise's ports over time
## About -*bronzeburner* words +*bronzeburner* is a utility for any sized corporation to help manage exposed services and ports against threats both internal and exterinal. +As firewalls are modified or replaced, rules can be misconfigured so that addresses or ports are available externally that perhaps shouldn't be. + +Initially, bronzeburner was going to be a passive perimeter monitor using nfqueue (and alternatively, XDP) to inspect communications. After +implementing this, I realized it did not meet the requirements for the assignment which requires a proactive approach. bronzeburner was rewritten +as a classic network scanner which instruments `rustscan`, expertly parses its output, and inserts it into a time series database most information +security workers should be familiar with. + +This instrumentation approach is a bit more basic but enables users to customize their querying, alerting, and filtering requirements themselves using +InfluxDB, Grafana, or any other data sink. As a traditional scanner, it can be run from any location within a network or even from outside, perhaps from a remote +cloud VM. ## Installation diff --git a/bronzeburner.png b/img/bronzeburner.png similarity index 100% rename from bronzeburner.png rename to img/bronzeburner.png